1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "content/browser/file_system_access/file_system_access_observer_host.h"
#include <algorithm>
#include <memory>
#include <variant>
#include "base/files/file_util.h"
#include "base/metrics/histogram_functions.h"
#include "build/build_config.h"
#include "content/browser/file_system_access/file_system_access_directory_handle_impl.h"
#include "content/browser/file_system_access/file_system_access_error.h"
#include "content/browser/file_system_access/file_system_access_file_handle_impl.h"
#include "content/browser/file_system_access/file_system_access_manager_impl.h"
#include "content/browser/file_system_access/file_system_access_observer_observation.h"
#include "content/browser/file_system_access/file_system_access_transfer_token_impl.h"
#include "content/browser/file_system_access/file_system_access_watcher_manager.h"
#include "content/browser/renderer_host/render_frame_host_impl.h"
#include "content/public/browser/file_system_access_permission_context.h"
#include "mojo/public/cpp/bindings/pending_receiver.h"
#include "services/metrics/public/cpp/ukm_source_id.h"
#include "storage/browser/file_system/file_system_operation_runner.h"
#include "storage/browser/file_system/file_system_url.h"
#include "third_party/blink/public/mojom/file_system_access/file_system_access_observer.mojom.h"
#include "third_party/blink/public/mojom/permissions/permission_status.mojom-shared.h"
namespace content {
using HandleType = FileSystemAccessPermissionContext::HandleType;
FileSystemAccessObserverHost::FileSystemAccessObserverHost(
FileSystemAccessManagerImpl* manager,
FileSystemAccessWatcherManager* watcher_manager,
const BindingContext& binding_context,
mojo::PendingReceiver<blink::mojom::FileSystemAccessObserverHost>
host_receiver)
: manager_(manager),
watcher_manager_(watcher_manager),
binding_context_(binding_context),
host_receiver_(this, std::move(host_receiver)) {
CHECK(manager_);
CHECK(watcher_manager_);
// `base::Unretained` is safe here because this instance owns
// `host_receiver_`.
host_receiver_.set_disconnect_handler(
base::BindOnce(&FileSystemAccessObserverHost::OnHostReceiverDisconnect,
base::Unretained(this)));
}
FileSystemAccessObserverHost::~FileSystemAccessObserverHost() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
}
void FileSystemAccessObserverHost::Observe(
mojo::PendingRemote<blink::mojom::FileSystemAccessTransferToken> token,
bool is_recursive,
ObserveCallback callback) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
CHECK(manager_);
manager_->ResolveTransferToken(
std::move(token),
base::BindOnce(
&FileSystemAccessObserverHost::DidResolveTransferTokenToObserve,
weak_factory_.GetWeakPtr(), is_recursive, std::move(callback)));
}
void FileSystemAccessObserverHost::DidResolveTransferTokenToObserve(
bool is_recursive,
ObserveCallback callback,
FileSystemAccessTransferTokenImpl* resolved_token) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (!resolved_token) {
std::move(callback).Run(
file_system_access_error::FromStatus(
blink::mojom::FileSystemAccessStatus::kInvalidArgument),
mojo::NullReceiver());
return;
}
if (resolved_token->GetReadGrant()->GetStatus() !=
blink::mojom::PermissionStatus::GRANTED) {
std::move(callback).Run(
file_system_access_error::FromStatus(
blink::mojom::FileSystemAccessStatus::kPermissionDenied),
mojo::NullReceiver());
return;
}
FileSystemAccessPermissionContext::HandleType handle_type =
resolved_token->type();
std::variant<std::unique_ptr<FileSystemAccessDirectoryHandleImpl>,
std::unique_ptr<FileSystemAccessFileHandleImpl>>
handle;
switch (handle_type) {
case FileSystemAccessPermissionContext::HandleType::kDirectory:
handle = resolved_token->CreateDirectoryHandle(binding_context());
break;
case FileSystemAccessPermissionContext::HandleType::kFile:
handle = resolved_token->CreateFileHandle(binding_context());
break;
}
// We only need to check if the path is a symlink or junction on local file
// system.
bool file_could_be_symlink =
resolved_token->url().type() == storage::kFileSystemTypeLocal;
#if BUILDFLAG(IS_FUCHSIA)
// Fuchsia does not support symlinks.
file_could_be_symlink = false;
#endif
if (!file_could_be_symlink) {
DidCheckIfSymlinkOrJunction(std::move(handle), std::move(callback),
resolved_token->url(), is_recursive,
handle_type, file_could_be_symlink);
return;
}
base::FilePath path = resolved_token->url().path();
base::ThreadPool::PostTaskAndReplyWithResult(
FROM_HERE, {base::MayBlock()},
base::BindOnce(
[](base::FilePath path) -> bool {
base::FilePath check_path;
// `base::NormalizeFilePath()` resolves any file path elements like
// symbolic links or junctions by returning the target file path.
if (!base::NormalizeFilePath(path, &check_path)) {
check_path = path;
}
DCHECK(path.empty() == check_path.empty());
return check_path != path;
},
std::move(path)),
base::BindOnce(&FileSystemAccessObserverHost::DidCheckIfSymlinkOrJunction,
weak_factory_.GetWeakPtr(), std::move(handle),
std::move(callback), resolved_token->url(), is_recursive,
handle_type));
}
void FileSystemAccessObserverHost::DidCheckIfSymlinkOrJunction(
std::variant<std::unique_ptr<FileSystemAccessDirectoryHandleImpl>,
std::unique_ptr<FileSystemAccessFileHandleImpl>> handle,
ObserveCallback callback,
storage::FileSystemURL url,
bool is_recursive,
FileSystemAccessPermissionContext::HandleType handle_type,
bool is_symlink_or_junction) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (url.type() == storage::kFileSystemTypeLocal) {
base::UmaHistogramBoolean(
"Storage.FileSystemAccess.AttemptToObserveSymlinkOrJunction",
is_symlink_or_junction);
}
// Observing symlink and junction is not supported for Origin Trial.
// TODO(crbug.com/363195541): Add support for symlinks and junctions for
// feature launch.
if (is_symlink_or_junction) {
std::move(callback).Run(
blink::mojom::FileSystemAccessError::New(
blink::mojom::FileSystemAccessStatus::kFileError,
base::File::FILE_ERROR_INVALID_OPERATION,
"Symlinks or junctions cannot be observed"),
mojo::NullReceiver());
return;
}
manager_->DoFileSystemOperation(
FROM_HERE,
handle_type == FileSystemAccessPermissionContext::HandleType::kDirectory
? &storage::FileSystemOperationRunner::DirectoryExists
: &storage::FileSystemOperationRunner::FileExists,
base::BindOnce(&FileSystemAccessObserverHost::DidCheckItemExists,
weak_factory_.GetWeakPtr(), std::move(handle),
std::move(callback), url, is_recursive),
url);
}
void FileSystemAccessObserverHost::DidCheckItemExists(
std::variant<std::unique_ptr<FileSystemAccessDirectoryHandleImpl>,
std::unique_ptr<FileSystemAccessFileHandleImpl>> handle,
ObserveCallback callback,
storage::FileSystemURL url,
bool is_recursive,
base::File::Error result) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (result != base::File::FILE_OK) {
std::move(callback).Run(file_system_access_error::FromFileError(result),
mojo::NullReceiver());
return;
}
// TODO(crbug.com/384635679): Support getting UKM source ID for web workers.
RenderFrameHostImpl* rfh =
RenderFrameHostImpl::FromID(binding_context_.frame_id);
ukm::SourceId source_id =
rfh ? rfh->GetPageUkmSourceId() : ukm::kInvalidSourceId;
switch (handle.index()) {
case 0u:
watcher_manager()->GetDirectoryObservation(
binding_context_.storage_key, std::move(url), is_recursive, source_id,
base::BindOnce(&FileSystemAccessObserverHost::GotObservation,
weak_factory_.GetWeakPtr(), std::move(handle),
std::move(callback)));
break;
case 1u:
watcher_manager()->GetFileObservation(
binding_context_.storage_key, std::move(url), source_id,
base::BindOnce(&FileSystemAccessObserverHost::GotObservation,
weak_factory_.GetWeakPtr(), std::move(handle),
std::move(callback)));
break;
}
}
void FileSystemAccessObserverHost::Unobserve(
mojo::PendingRemote<blink::mojom::FileSystemAccessTransferToken> token) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
CHECK(manager_);
if (observations_.empty()) {
return;
}
manager_->ResolveTransferToken(
std::move(token),
base::BindOnce(
&FileSystemAccessObserverHost::DidResolveTransferTokenToUnobserve,
weak_factory_.GetWeakPtr()));
}
void FileSystemAccessObserverHost::DidResolveTransferTokenToUnobserve(
FileSystemAccessTransferTokenImpl* resolved_token) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (!resolved_token) {
return;
}
// TODO(crbug.com/321980367): Better handle overlapping observations.
base::EraseIf(observations_, [&](const auto& observation) {
return observation->handle_url() == resolved_token->url();
});
}
void FileSystemAccessObserverHost::GotObservation(
std::variant<std::unique_ptr<FileSystemAccessDirectoryHandleImpl>,
std::unique_ptr<FileSystemAccessFileHandleImpl>> handle,
ObserveCallback callback,
base::expected<std::unique_ptr<FileSystemAccessObservationGroup::Observer>,
blink::mojom::FileSystemAccessErrorPtr>
observation_or_error) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
if (!observation_or_error.has_value()) {
std::move(callback).Run(std::move(observation_or_error.error()),
mojo::NullReceiver());
return;
}
mojo::PendingRemote<blink::mojom::FileSystemAccessObserver> observer_remote;
mojo::PendingReceiver<blink::mojom::FileSystemAccessObserver>
observer_receiver = observer_remote.InitWithNewPipeAndPassReceiver();
auto observer_observation =
std::make_unique<FileSystemAccessObserverObservation>(
this, std::move(observation_or_error.value()),
std::move(observer_remote), std::move(handle));
observations_.insert(std::move(observer_observation));
std::move(callback).Run(file_system_access_error::Ok(),
std::move(observer_receiver));
}
void FileSystemAccessObserverHost::RemoveObservation(
FileSystemAccessObserverObservation* observation) {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
size_t count_removed = observations_.erase(observation);
CHECK_EQ(count_removed, 1u);
}
void FileSystemAccessObserverHost::OnHostReceiverDisconnect() {
DCHECK_CALLED_ON_VALID_SEQUENCE(sequence_checker_);
observations_.clear();
host_receiver_.reset();
// Destroys `this`.
watcher_manager_->RemoveObserverHost(this);
}
} // namespace content
|