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 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
|
// Copyright 2022 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_WEBUI_ASH_CLOUD_UPLOAD_CLOUD_UPLOAD_DIALOG_H_
#define CHROME_BROWSER_UI_WEBUI_ASH_CLOUD_UPLOAD_CLOUD_UPLOAD_DIALOG_H_
#include <optional>
#include <vector>
#include "base/gtest_prod_util.h"
#include "base/memory/raw_ptr.h"
#include "base/timer/elapsed_timer.h"
#include "chrome/browser/ash/file_manager/file_tasks.h"
#include "chrome/browser/ash/file_system_provider/mount_path_util.h"
#include "chrome/browser/ash/file_system_provider/provided_file_system_interface.h"
#include "chrome/browser/ash/file_system_provider/provider_interface.h"
#include "chrome/browser/platform_util.h"
#include "chrome/browser/ui/browser_list_observer.h"
#include "chrome/browser/ui/webui/ash/cloud_upload/cloud_open_metrics.h"
#include "chrome/browser/ui/webui/ash/cloud_upload/cloud_upload.mojom.h"
#include "chrome/browser/ui/webui/ash/cloud_upload/cloud_upload_util.h"
#include "chrome/browser/ui/webui/ash/cloud_upload/drive_upload_handler.h"
#include "chrome/browser/ui/webui/ash/cloud_upload/one_drive_upload_handler.h"
#include "chrome/browser/ui/webui/ash/system_web_dialog/system_web_dialog_delegate.h"
#include "chromeos/ash/components/drivefs/mojom/drivefs.mojom-forward.h"
#include "components/drive/file_errors.h"
#include "storage/browser/file_system/file_system_url.h"
#include "ui/base/mojom/ui_base_types.mojom-shared.h"
#include "ui/gfx/geometry/size.h"
#include "ui/gfx/native_widget_types.h"
class Profile;
namespace ash {
class BrowserDelegate;
} // namespace ash
namespace extensions::app_file_handler_util {
class MimeTypeCollector;
} // namespace extensions::app_file_handler_util
namespace file_manager::file_tasks {
FORWARD_DECLARE_TEST(DriveTest, OpenFileInDrive);
FORWARD_DECLARE_TEST(OneDriveTest, OpenFileFromODFS);
FORWARD_DECLARE_TEST(OneDriveTest, OpenFileNotFromODFS);
FORWARD_DECLARE_TEST(OneDriveTest,
FailToOpenFileFromODFSReauthenticationRequired);
FORWARD_DECLARE_TEST(OneDriveTest, FailToOpenFileFromODFSOtherAccessError);
FORWARD_DECLARE_TEST(OneDriveTest, OpenFileFromAndroidOneDriveViaODFS);
FORWARD_DECLARE_TEST(OneDriveTest,
OpenFileFromAndroidOneDriveViaODFSDiffCaseEmail);
FORWARD_DECLARE_TEST(OneDriveTest,
FailToOpenFileFromAndroidOneDriveViaODFSDiffEmail);
FORWARD_DECLARE_TEST(OneDriveTest, FailToOpenFileFromAndroidOneDriveNotOnODFS);
FORWARD_DECLARE_TEST(
OneDriveTest,
FailToOpenFileFromAndroidOneDriveDirectoryNotAccessibleToODFS);
FORWARD_DECLARE_TEST(OneDriveTest, FailToOpenFileFromODFSWhenMS365NotInstalled);
} // namespace file_manager::file_tasks
namespace ash::cloud_upload {
struct ODFSFileSystemAndPath {
raw_ptr<file_system_provider::ProvidedFileSystemInterface> file_system;
base::FilePath file_path_within_odfs;
};
// The string conversions of ash::cloud_upload::mojom::UserAction.
inline constexpr char kUserActionCancel[] = "cancel";
inline constexpr char kUserActionCancelGoogleDrive[] = "cancel-drive";
inline constexpr char kUserActionCancelOneDrive[] = "cancel-onedrive";
inline constexpr char kUserActionSetUpOneDrive[] = "setup-onedrive";
inline constexpr char kUserActionUploadToGoogleDrive[] = "upload-drive";
inline constexpr char kUserActionUploadToOneDrive[] = "upload-onedrive";
inline constexpr char kUserActionConfirmOrUploadToGoogleDrive[] =
"confirm-or-upload-google-drive";
inline constexpr char kUserActionConfirmOrUploadToOneDrive[] =
"confirm-or-upload-onedrive";
// Options for which setup or move confirmation sub-page/flow we want to show.
enum class SetupOrMoveDialogPage {
// The user can choose between apps for handling office files.
kFileHandlerDialog,
// Set up OneDrive (multi-page).
kOneDriveSetup,
// Confirm that the user wants to move the file to OneDrive.
kMoveConfirmationOneDrive,
// Confirm that the user wants to move the file to Google Drive.
kMoveConfirmationGoogleDrive,
};
class CloudUploadDialog;
// The business logic for running setup, moving files to a cloud provider, and
// opening files on cloud providers. Spawns instances of `CloudUploadDialog` if
// necessary to run setup or get confirmation from the user.
class CloudOpenTask : public BrowserListObserver,
public base::RefCounted<CloudOpenTask> {
public:
CloudOpenTask(const CloudOpenTask&) = delete;
CloudOpenTask& operator=(const CloudOpenTask&) = delete;
// This is the main public entry-point to the functionality in this file.
// Opens the `file_urls` from the `cloud_provider`. Runs setup for Office
// files if it has not been run before. Uploads the files to the cloud if
// needed. Returns false if `file_urls` was empty or the setup/upload process
// failed before any async step started. `CloudOpenTask` is refcounted and
// lives until the task is complete or has failed, via bound `this` pointers
// in the closures used for async steps.
static bool Execute(Profile* profile,
const std::vector<storage::FileSystemURL>& file_urls,
const ::file_manager::file_tasks::TaskDescriptor& task,
const CloudProvider cloud_provider,
std::unique_ptr<CloudOpenMetrics> cloud_open_metrics);
// Set the local tasks that are passed to the File Handler dialog. Normally
// tasks are calculated internally by this class before displaying this
// dialog. Some tests don't display the dialog, but only test post-dialog
// logic.
void SetTasksForTest(
const std::vector<::file_manager::file_tasks::TaskDescriptor>& tasks);
// BrowserListObserver implementation.
// Use this to check if a new Files app window has been launched when there
// wasn't already one to be used as the modal parent. This is triggered by
// ShowDialog().
void OnBrowserAdded(Browser* browser) override;
// Use this to check if the Files app window the dialog is modal to has
// closed.
void OnBrowserClosing(Browser* browser) override;
FRIEND_TEST_ALL_PREFIXES(FileHandlerDialogBrowserTest,
OnSetupDialogCompleteOpensFileTasks);
FRIEND_TEST_ALL_PREFIXES(FileHandlerDialogBrowserTest,
OnSetupDialogCompleteNoCrash);
FRIEND_TEST_ALL_PREFIXES(FixUpFlowBrowserTest,
OneDriveSetUpChangesDefaultTaskWhenSetUpIncomplete);
FRIEND_TEST_ALL_PREFIXES(
FixUpFlowBrowserTest,
OneDriveSetUpDoesNotChangeDefaultTaskWhenSetUpComplete);
FRIEND_TEST_ALL_PREFIXES(::file_manager::file_tasks::DriveTest,
OpenFileInDrive);
FRIEND_TEST_ALL_PREFIXES(::file_manager::file_tasks::OneDriveTest,
OpenFileFromODFS);
FRIEND_TEST_ALL_PREFIXES(::file_manager::file_tasks::OneDriveTest,
OpenFileNotFromODFS);
FRIEND_TEST_ALL_PREFIXES(::file_manager::file_tasks::OneDriveTest,
FailToOpenFileFromODFSReauthenticationRequired);
FRIEND_TEST_ALL_PREFIXES(::file_manager::file_tasks::OneDriveTest,
FailToOpenFileFromODFSOtherAccessError);
FRIEND_TEST_ALL_PREFIXES(::file_manager::file_tasks::OneDriveTest,
OpenFileFromAndroidOneDriveViaODFS);
FRIEND_TEST_ALL_PREFIXES(::file_manager::file_tasks::OneDriveTest,
OpenFileFromAndroidOneDriveViaODFSDiffCaseEmail);
FRIEND_TEST_ALL_PREFIXES(::file_manager::file_tasks::OneDriveTest,
FailToOpenFileFromAndroidOneDriveViaODFSDiffEmail);
FRIEND_TEST_ALL_PREFIXES(::file_manager::file_tasks::OneDriveTest,
FailToOpenFileFromAndroidOneDriveNotOnODFS);
FRIEND_TEST_ALL_PREFIXES(
::file_manager::file_tasks::OneDriveTest,
FailToOpenFileFromAndroidOneDriveDirectoryNotAccessibleToODFS);
FRIEND_TEST_ALL_PREFIXES(::file_manager::file_tasks::OneDriveTest,
FailToOpenFileFromODFSWhenMS365NotInstalled);
private:
friend class RefCounted<CloudOpenTask>; // Allow destruction by RefCounted<>.
friend class CloudOpenTaskBrowserTest;
CloudOpenTask(Profile* profile,
std::vector<storage::FileSystemURL> file_urls,
const ::file_manager::file_tasks::TaskDescriptor& task,
const SourceType source_type,
const CloudProvider cloud_provider,
std::unique_ptr<CloudOpenMetrics> cloud_open_metrics);
~CloudOpenTask() override;
// See the .cc implementation for comments on private methods.
bool ExecuteInternal();
bool MaybeRunFixupFlow();
bool OpenOrMoveFiles();
void OpenAlreadyHostedDriveUrls();
void OnGoogleDriveGetMetadata(drive::FileError error,
drivefs::mojom::FileMetadataPtr metadata);
void OpenUploadedDriveUrl(const GURL& url,
const OfficeTaskResult task_result);
void OpenODFSUrls(const OfficeTaskResult task_result_uma);
void CheckEmailAndOpenAndroidOneDriveURLs(
base::expected<cloud_upload::ODFSMetadata, base::File::Error>
metadata_or_error);
void OpenAndroidOneDriveUrl(
const storage::FileSystemURL& android_onedrive_url);
bool ShouldShowConfirmationDialog();
bool ConfirmMoveOrStartUpload();
void StartUpload();
void StartNextGoogleDriveUpload();
void StartNextOneDriveUpload();
// Callbacks from `DriveUploadHandler` and `OneDriveUploadHandler`. URL passed
// to these callbacks will be `std::nullopt` and size will be 0 if upload
// fails.
void FinishedDriveUpload(OfficeTaskResult task_result,
std::optional<GURL> url,
int64_t size);
void FinishedOneDriveUpload(base::WeakPtr<Profile> profile_weak_ptr,
OfficeTaskResult task_result,
std::optional<storage::FileSystemURL> url,
int64_t size);
void LogGoogleDriveOpenResultUMA(OfficeTaskResult success_task_result,
OfficeDriveOpenErrors open_result);
void LogOneDriveOpenResultUMA(OfficeTaskResult success_task_result,
OfficeOneDriveOpenErrors open_result);
bool InitAndShowSetupOrMoveDialog(SetupOrMoveDialogPage dialog_page);
mojom::DialogArgsPtr CreateDialogArgs(SetupOrMoveDialogPage dialog_page);
void ShowDialog(SetupOrMoveDialogPage dialog_page,
mojom::DialogArgsPtr args,
std::unique_ptr<::file_manager::file_tasks::ResultingTasks>
resulting_tasks);
void SetTaskArgs(mojom::DialogArgsPtr& args,
std::unique_ptr<::file_manager::file_tasks::ResultingTasks>
resulting_tasks);
void OnSetupDialogComplete(const std::string& user_response);
void OnMoveConfirmationComplete(const std::string& user_response);
void LaunchLocalFileTask(const std::string& string_task_position);
void LocalTaskExecuted(
const ::file_manager::file_tasks::TaskDescriptor& task,
extensions::api::file_manager_private::TaskResult result,
std::string error_message);
void FindTasksForDialog(::file_manager::file_tasks::FindTasksCallback
find_all_types_of_tasks_callback);
void ConstructEntriesAndFindTasks(
const std::vector<base::FilePath>& file_paths,
const std::vector<GURL>& gurls,
std::unique_ptr<extensions::app_file_handler_util::MimeTypeCollector>
mime_collector,
::file_manager::file_tasks::FindTasksCallback
find_all_types_of_tasks_callback,
std::unique_ptr<std::vector<std::string>> mime_types);
void RecordUploadLatencyUMA();
raw_ptr<Profile> profile_;
std::vector<storage::FileSystemURL> file_urls_;
// File being currently uploaded.
size_t file_urls_idx_ = 0;
const ::file_manager::file_tasks::TaskDescriptor task_;
SourceType source_type_;
CloudProvider cloud_provider_;
std::unique_ptr<CloudOpenMetrics> cloud_open_metrics_;
std::unique_ptr<DriveUploadHandler> drive_upload_handler_;
std::unique_ptr<OneDriveUploadHandler> one_drive_upload_handler_;
std::vector<::file_manager::file_tasks::TaskDescriptor> local_tasks_;
raw_ptr<CloudUploadDialog> pending_dialog_ = nullptr;
base::ElapsedTimer upload_timer_;
int64_t upload_total_size_ = 0;
// True when there is at least one upload error.
bool has_upload_errors_ = false;
OfficeFilesTransferRequired transfer_required_ =
OfficeFilesTransferRequired::kNotRequired;
bool need_new_files_app_ = false;
raw_ptr<BrowserDelegate> files_app_browser_;
bool files_app_closed_ = false;
};
// Returns True if OneDrive is the selected `cloud_provider` but either ODFS
// is not mounted or the Office PWA is not installed. Returns False otherwise.
bool ShouldFixUpOffice(Profile* profile, const CloudProvider cloud_provider);
// Returns True if the url is on the Android OneDrive DocumentsProvider.
bool UrlIsOnAndroidOneDrive(Profile* profile, const FileSystemURL& url);
// Return the email from the Root Document Id of the Android OneDrive
// DocumentsProvider.
std::optional<std::string> GetEmailFromAndroidOneDriveRootDoc(
const std::string& root_document_id);
// Converts the |android_onedrive_file_url| for a file in OneDrive to the
// equivalent ODFS file path which is then parsed to detect the corresponding
// ODFS ProvidedFileSystemInterface and relative file path. There may or may not
// exist a file for the returned relative file path. The conversion can be done
// for files in OneDrive that can be accessed via Android OneDrive or ODFS.
// These are the users' own files - in the Android OneDrive "Files" directory.
// Fails if an equivalent ODFS file path can't be constructed.
std::optional<ODFSFileSystemAndPath> AndroidOneDriveUrlToODFS(
Profile* profile,
const FileSystemURL& android_onedrive_file_url);
// Launches the 'Connect OneDrive' dialog which is triggered from the Services
// menu in Files app. This is a simplified version of setup where we just
// connect to OneDrive. There is no 'done' callback because files app doesn't
// need it.
bool ShowConnectOneDriveDialog(gfx::NativeWindow modal_parent);
// Launches the setup flow to set up opening Office files in Microsoft 365.
void LaunchMicrosoft365Setup(Profile* profile, gfx::NativeWindow modal_parent);
// Defines the web dialog used to help users upload Office files to the cloud.
class CloudUploadDialog : public SystemWebDialogDelegate {
public:
using UploadRequestCallback =
base::OnceCallback<void(const std::string& user_response)>;
CloudUploadDialog(const CloudUploadDialog&) = delete;
CloudUploadDialog& operator=(const CloudUploadDialog&) = delete;
CloudUploadDialog(mojom::DialogArgsPtr args,
UploadRequestCallback callback,
bool office_move_confirmation_shown);
void OnDialogShown(content::WebUI* webui) override;
void OnDialogClosed(const std::string& json_retval) override;
protected:
~CloudUploadDialog() override;
ui::mojom::ModalType GetDialogModalType() const override;
bool ShouldCloseDialogOnEscape() const override;
bool ShouldShowCloseButton() const override;
void GetDialogSize(gfx::Size* size) const override;
private:
FRIEND_TEST_ALL_PREFIXES(FixUpFlowBrowserTest,
OneDriveSetUpChangesDefaultTaskWhenSetUpIncomplete);
FRIEND_TEST_ALL_PREFIXES(
FixUpFlowBrowserTest,
OneDriveSetUpDoesNotChangeDefaultTaskWhenSetUpComplete);
mojom::DialogArgsPtr dialog_args_;
UploadRequestCallback callback_;
bool office_move_confirmation_shown_;
};
} // namespace ash::cloud_upload
#endif // CHROME_BROWSER_UI_WEBUI_ASH_CLOUD_UPLOAD_CLOUD_UPLOAD_DIALOG_H_
|