// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_BROWSER_UI_ASH_HOLDING_SPACE_HOLDING_SPACE_FILE_SYSTEM_DELEGATE_H_
#define CHROME_BROWSER_UI_ASH_HOLDING_SPACE_HOLDING_SPACE_FILE_SYSTEM_DELEGATE_H_
#include <memory>
#include <vector>
#include "ash/components/arc/mojom/file_system.mojom-forward.h"
#include "ash/components/arc/session/connection_holder.h"
#include "ash/components/arc/session/connection_observer.h"
#include "base/functional/callback.h"
#include "base/scoped_observation.h"
#include "base/task/sequenced_task_runner.h"
#include "base/timer/timer.h"
#include "chrome/browser/ash/file_manager/volume_manager.h"
#include "chrome/browser/ash/file_manager/volume_manager_observer.h"
#include "chrome/browser/ash/fileapi/file_change_service.h"
#include "chrome/browser/ash/fileapi/file_change_service_observer.h"
#include "chrome/browser/ui/ash/holding_space/holding_space_keyed_service_delegate.h"
#include "chrome/browser/ui/ash/holding_space/holding_space_util.h"
#include "chromeos/ash/components/drivefs/drivefs_host.h"
class GURL;
namespace base {
class FilePath;
} // namespace base
namespace storage {
class FileSystemURL;
} // namespace storage
namespace ash {
// A delegate of `HoldingSpaceKeyedService` tasked with verifying validity of
// files backing holding space items. The delegate:
// * Fully initializes partially initialized items loaded from persistent
// storage once the validity of the backing file path was verified.
// * Monitors the file system for removal, rename, and move of files backing
// holding space items.
class HoldingSpaceFileSystemDelegate
: public HoldingSpaceKeyedServiceDelegate,
public FileChangeServiceObserver,
public arc::ConnectionObserver<arc::mojom::FileSystemInstance>,
public drivefs::DriveFsHost::Observer,
public file_manager::VolumeManagerObserver {
public:
HoldingSpaceFileSystemDelegate(HoldingSpaceKeyedService* service,
HoldingSpaceModel* model);
HoldingSpaceFileSystemDelegate(const HoldingSpaceFileSystemDelegate&) =
delete;
HoldingSpaceFileSystemDelegate& operator=(
const HoldingSpaceFileSystemDelegate&) = delete;
~HoldingSpaceFileSystemDelegate() override;
private:
class FileSystemWatcher;
// HoldingSpaceKeyedServiceDelegate:
void Init() override;
void OnHoldingSpaceItemsAdded(
const std::vector<const HoldingSpaceItem*>& items) override;
void OnHoldingSpaceItemsRemoved(
const std::vector<const HoldingSpaceItem*>& items) override;
void OnHoldingSpaceItemUpdated(
const HoldingSpaceItem* item,
const HoldingSpaceItemUpdatedFields& updated_fields) override;
void OnHoldingSpaceItemInitialized(const HoldingSpaceItem* item) override;
// file_manager::VolumeManagerObserver:
void OnVolumeMounted(MountError error_code,
const file_manager::Volume& volume) override;
void OnVolumeUnmounted(MountError error_code,
const file_manager::Volume& volume) override;
// FileChangeServiceObserver:
void OnFileCreatedFromShowSaveFilePicker(
const GURL& file_picker_binding_context,
const storage::FileSystemURL& url) override;
void OnFileModified(const storage::FileSystemURL& url) override;
void OnFileMoved(const storage::FileSystemURL& src,
const storage::FileSystemURL& dst) override;
// arc::ConnectionObserver<arc::mojom::FileSystemInstance>:
void OnConnectionReady() override;
// drivefs::DriveFsHost::Observer:
void OnFilesChanged(
const std::vector<drivefs::mojom::FileChange>& changes) override;
// Invoked when the specified `file_path` has changed.
void OnFilePathChanged(const base::FilePath& file_path, bool error);
// Invoked when the specified `file_path` has been modified.
void OnFilePathModified(const base::FilePath& file_path);
// Invoked when the specified file path has moved from `src` to `dst`.
void OnFilePathMoved(const base::FilePath& src, const base::FilePath& dst);
// Adds file path validity requirement to `pending_file_path_validity_checks_`
// and schedules a path validity check task (if another task is not already
// scheduled).
void ScheduleFilePathValidityCheck(
holding_space_util::FilePathWithValidityRequirement requirement);
// Runs validity checks for file paths in
// `pending_file_path_validity_checks_`. The checks are performed
// asynchronously (with callback `OnFilePathValidityChecksComplete()`).
void RunPendingFilePathValidityChecks();
// Callback for a batch of file path validity checks - it updates the model
// depending on the determined file path state.
void OnFilePathValidityChecksComplete(
std::vector<base::FilePath> valid_paths,
std::vector<base::FilePath> invalid_paths);
// Adds/removes a watch for the specified `file_path`.
// Note that `AddWatchForParent()` will add a watch for the `file_path`'s
// parent directory. Also note that `MaybeRemoveWatch()` will only remove the
// watch for `file_path` if no backing file for a holding space item exists
// which is directly parented by it.
void AddWatchForParent(const base::FilePath& file_path);
void MaybeRemoveWatch(const base::FilePath& file_path);
// Removes items that are (transitively) parented by `parent_path` from the
// holding space model.
void RemoveItemsParentedByPath(const base::FilePath& parent_path);
// Clears all non-initialized items from holding space model - runs with a
// delay after profile initialization to clean up items from volumes that have
// not been mounted during startup.
void ClearNonInitializedItems();
// The `file_system_watcher_` is tasked with watching the file system for
// changes on behalf of the delegate. It does so on a non-UI sequence. As
// such, all communication with `file_system_watcher_` must be posted via the
// `file_system_watcher_runner_`. In return, the `file_system_watcher_` will
// post its responses back onto the UI thread.
std::unique_ptr<FileSystemWatcher> file_system_watcher_;
scoped_refptr<base::SequencedTaskRunner> file_system_watcher_runner_;
// List of file path validity checks that need to be run.
holding_space_util::FilePathsWithValidityRequirements
pending_file_path_validity_checks_;
// Whether a task to run validity checks in
// `pending_file_path_validity_checks_` is scheduled.
bool file_path_validity_checks_scheduled_ = false;
// A timer to run clean-up task for items that have not been initialized
// within a reasonable amount of time from start-up. (E.g. if the volume they
// belong to has not been yet mounted).
base::OneShotTimer clear_non_initialized_items_timer_;
base::ScopedObservation<
arc::ConnectionHolder<arc::mojom::FileSystemInstance,
arc::mojom::FileSystemHost>,
arc::ConnectionObserver<arc::mojom::FileSystemInstance>>
arc_file_system_observer_{this};
base::ScopedObservation<FileChangeService, FileChangeServiceObserver>
file_change_service_observer_{this};
base::ScopedObservation<file_manager::VolumeManager,
file_manager::VolumeManagerObserver>
volume_manager_observer_{this};
base::WeakPtrFactory<HoldingSpaceFileSystemDelegate> weak_factory_{this};
};
} // namespace ash
#endif // CHROME_BROWSER_UI_ASH_HOLDING_SPACE_HOLDING_SPACE_FILE_SYSTEM_DELEGATE_H_
Codebase Browser
chromium