File: migration_coordinator.cc

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (488 lines) | stat: -rw-r--r-- 17,481 bytes parent folder | download | duplicates (3)
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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifdef UNSAFE_BUFFERS_BUILD
// TODO(crbug.com/40285824): Remove this and convert code to safer constructs.
#pragma allow_unsafe_buffers
#endif

#include "chrome/browser/ash/policy/skyvault/migration_coordinator.h"

#include <memory>
#include <optional>

#include "base/base_paths.h"
#include "base/check_is_test.h"
#include "base/files/file_path.h"
#include "base/files/file_util.h"
#include "base/functional/bind.h"
#include "base/functional/callback.h"
#include "base/functional/callback_helpers.h"
#include "base/logging.h"
#include "base/notreached.h"
#include "base/strings/string_util.h"
#include "base/strings/utf_string_conversions.h"
#include "base/task/single_thread_task_runner.h"
#include "chrome/browser/ash/file_manager/fileapi_util.h"
#include "chrome/browser/ash/file_manager/io_task_controller.h"
#include "chrome/browser/ash/file_manager/volume_manager.h"
#include "chrome/browser/ash/policy/skyvault/drive_skyvault_uploader.h"
#include "chrome/browser/ash/policy/skyvault/histogram_helper.h"
#include "chrome/browser/ash/policy/skyvault/local_files_migration_constants.h"
#include "chrome/browser/ash/policy/skyvault/odfs_skyvault_uploader.h"
#include "chrome/browser/ash/policy/skyvault/policy_utils.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/grit/generated_resources.h"
#include "components/strings/grit/components_strings.h"
#include "storage/browser/file_system/file_system_url.h"
#include "ui/base/l10n/l10n_util.h"
#include "url/origin.h"

namespace policy::local_user_files {

namespace {

// Called after `uploader` is fully stopped.
void OnMigrationStopped(std::unique_ptr<MigrationCloudUploader> uploader,
                        base::OnceClosure cb) {
  VLOG(1) << "Local files migration stopped";
  if (cb) {
    std::move(cb).Run();
  }
}

// Returns the file's path relative to MyFiles.
base::FilePath GetPathRelativeToMyFiles(Profile* profile,
                                        const base::FilePath& file_path) {
  base::FilePath my_files_path = GetMyFilesPath(profile);
  base::FilePath rel_path;
  my_files_path.AppendRelativePath(file_path.DirName(), &rel_path);
  return rel_path;
}

bool ErrorCanBeIgnored(MigrationUploadError error) {
  return error == MigrationUploadError::kDeleteFailed ||
         error == MigrationUploadError::kFileNotFound;
}

std::string FormatErrorMessage(MigrationDestination destination,
                               MigrationUploadError error) {
  CHECK(IsCloudDestination(destination));
  switch (error) {
    case MigrationUploadError::kCloudQuotaFull:
      return base::UTF16ToUTF8(base::ReplaceStringPlaceholders(
          l10n_util::GetStringUTF16(
              IDS_POLICY_SKYVAULT_MIGRATION_UPLOAD_ERROR_NO_SPACE),
          l10n_util::GetStringUTF16(
              destination == MigrationDestination::kGoogleDrive
                  ? IDS_OFFICE_CLOUD_PROVIDER_GOOGLE_DRIVE_SHORT
                  : IDS_OFFICE_CLOUD_PROVIDER_ONEDRIVE_SHORT),
          /*offset=*/nullptr));
    case MigrationUploadError::kFileNotFound:
      return l10n_util::GetStringUTF8(
          IDS_POLICY_SKYVAULT_MIGRATION_UPLOAD_ERROR_FILE_NOT_EXIST);
    case MigrationUploadError::kAuthRequired:
      return l10n_util::GetStringUTF8(
          IDS_POLICY_SKYVAULT_MIGRATION_UPLOAD_ERROR_ODFS_SIGN_IN);
    case MigrationUploadError::kNetworkError:
    case MigrationUploadError::kReconnectTimeout:
      return l10n_util::GetStringUTF8(
          IDS_POLICY_SKYVAULT_MIGRATION_UPLOAD_ERROR_NO_INTERNET);
    case MigrationUploadError::kCopyFailed:
    case MigrationUploadError::kCreateFolderFailed:
    case MigrationUploadError::kSyncFailed:
    case MigrationUploadError::kDeleteFailed:
    case MigrationUploadError::kMoveFailed:
    case MigrationUploadError::kCancelled:
    case MigrationUploadError::kUnexpectedError:
    case MigrationUploadError::kServiceUnavailable:
    case MigrationUploadError::kInvalidURL:
      return l10n_util::GetStringUTF8(
          IDS_POLICY_SKYVAULT_MIGRATION_UPLOAD_ERROR_GENERIC);
  }
}

void CloseFile(base::File file) {
  file.Close();
}

base::File CreateOrOpenLogFile(Profile* profile, base::FilePath path) {
  base::File error_log_file_ =
      base::File(path, base::File::FLAG_OPEN_ALWAYS | base::File::FLAG_APPEND);
  if (!error_log_file_.IsValid()) {
    PLOG(ERROR) << "Failed to open migration error log file.";
  }
  return error_log_file_;
}

void LogError(base::File& error_log_file,
              MigrationDestination destination,
              base::FilePath file_path,
              MigrationUploadError error) {
  if (!error_log_file.IsValid()) {
    LOG(ERROR) << "Cannot log error: log file invalid.";
    return;
  }

  std::string log_entry =
      absl::StrFormat("%s - %s\n", file_path.AsUTF8Unsafe(),
                      FormatErrorMessage(destination, error));
  error_log_file.WriteAtCurrentPos(log_entry.c_str(), log_entry.size());
}

}  // namespace

MigrationCoordinator::MigrationCoordinator(Profile* profile)
    : profile_(profile) {
  error_log_path_ =
      base::FilePath(kErrorLogFileBasePath).Append(kErrorLogFileName);
}

MigrationCoordinator::~MigrationCoordinator() = default;

void MigrationCoordinator::Run(MigrationDestination destination,
                               std::vector<base::FilePath> files,
                               const std::string& upload_root,
                               MigrationDoneCallback callback) {
  CHECK(!uploader_);

  MigrationDoneCallback wrapped_callback =
      base::BindOnce(&MigrationCoordinator::OnMigrationDone,
                     weak_ptr_factory_.GetWeakPtr(), std::move(callback));
  switch (destination) {
    case MigrationDestination::kGoogleDrive:
      uploader_ = std::make_unique<GoogleDriveMigrationUploader>(
          profile_, std::move(files), upload_root, error_log_path_,
          std::move(wrapped_callback));
      break;
    case MigrationDestination::kOneDrive:
      uploader_ = std::make_unique<OneDriveMigrationUploader>(
          profile_, std::move(files), upload_root, error_log_path_,
          std::move(wrapped_callback));
      break;
    case MigrationDestination::kDelete:
    case MigrationDestination::kNotSpecified:
      NOTREACHED() << "Run() should only be called if destination is set to a "
                      "cloud location";
  }
  uploader_->Run();
}

void MigrationCoordinator::Cancel(MigrationStoppedCallback callback) {
  if (uploader_) {
    MigrationCloudUploader* uploader_ptr = uploader_.get();
    uploader_ptr->Cancel(base::BindOnce(&OnMigrationStopped,
                                        std::move(uploader_),
                                        std::move(cancelled_cb_for_testing_)));
  }

  base::ThreadPool::PostTaskAndReplyWithResult(
      FROM_HERE, {base::MayBlock()},
      base::BindOnce(&base::DeleteFile, error_log_path_), std::move(callback));
}

bool MigrationCoordinator::IsRunning() const {
  return uploader_ != nullptr;
}

void MigrationCoordinator::SetCancelledCallbackForTesting(
    base::OnceClosure cb) {
  CHECK_IS_TEST();
  cancelled_cb_for_testing_ = std::move(cb);
}

void MigrationCoordinator::SetErrorLogPathForTesting(
    const base::FilePath& path) {
  CHECK_IS_TEST();
  error_log_path_ = path;
}

void MigrationCoordinator::OnMigrationDone(
    MigrationDoneCallback callback,
    std::map<base::FilePath, MigrationUploadError> errors,
    base::FilePath upload_root_path,
    base::FilePath error_log_path) {
  uploader_.reset();
  std::move(callback).Run(std::move(errors), upload_root_path, error_log_path);
}

MigrationCloudUploader::MigrationCloudUploader(
    Profile* profile,
    std::vector<base::FilePath> files,
    const std::string& upload_root,
    const base::FilePath& error_log_path,
    MigrationDoneCallback callback)
    : profile_(profile),
      files_(std::move(files)),
      upload_root_(upload_root),
      done_callback_(std::move(callback)),
      error_log_path_(error_log_path),
      log_task_runner_(base::ThreadPool::CreateSequencedTaskRunner(
          {base::MayBlock(), base::TaskPriority::BEST_EFFORT,
           base::TaskShutdownBehavior::BLOCK_SHUTDOWN})) {}

MigrationCloudUploader::~MigrationCloudUploader() {
  log_task_runner_->PostTask(
      FROM_HERE, base::BindOnce(&CloseFile, std::move(error_log_file_)));
}

void MigrationCloudUploader::Run() {
  if (files_.empty()) {
    if (done_callback_) {
      std::move(done_callback_).Run({}, base::FilePath(), base::FilePath());
    }
    return;
  }

  log_task_runner_->PostTaskAndReplyWithResult(
      FROM_HERE,
      base::BindOnce(&CreateOrOpenLogFile, profile_, error_log_path_),
      base::BindOnce(&MigrationCloudUploader::OnLogFileReady,
                     weak_ptr_factory_.GetWeakPtr()));
}

OneDriveMigrationUploader::OneDriveMigrationUploader(
    Profile* profile,
    std::vector<base::FilePath> files,
    const std::string& upload_root,
    const base::FilePath& error_log_path,
    MigrationDoneCallback callback)
    : MigrationCloudUploader(profile,
                             std::move(files),
                             upload_root,
                             error_log_path,
                             std::move(callback)) {}

OneDriveMigrationUploader::~OneDriveMigrationUploader() = default;

void OneDriveMigrationUploader::OnLogFileReady(base::File log_file) {
  error_log_file_ = std::move(log_file);
  // TODO(aidazolic): Consider if we can start all jobs at the same time, or we
  // need chunking.
  for (const auto& file_path : files_) {
    base::FilePath relative_path =
        GetPathRelativeToMyFiles(profile_, file_path);
    auto uploader = ash::cloud_upload::OdfsSkyvaultUploader::Upload(
        profile_, file_path, relative_path, upload_root_,
        UploadTrigger::kMigration,
        // No need to show progress updates.
        /*progress_callback=*/base::DoNothing(),
        /*upload_callback=*/
        base::BindOnce(&OneDriveMigrationUploader::OnUploadDone,
                       weak_ptr_factory_.GetWeakPtr(), file_path));
    uploaders_.insert({file_path, std::move(uploader)});
  }
}

void OneDriveMigrationUploader::Cancel(base::OnceClosure callback) {
  cancelled_callback_ = std::move(callback);
  cancelled_ = true;
  // Create a copy of the keys to iterate over. This is necessary because
  // calling Cancel() on the uploader may trigger OnUploadDone(), which
  // modifies the |uploaders_| map, potentially invalidating iterators.
  std::vector<base::FilePath> file_paths;
  for (const auto& uploader : uploaders_) {
    file_paths.push_back(uploader.first);
  }

  for (const auto& path : file_paths) {
    uploaders_[path]->Cancel();
  }
}

void OneDriveMigrationUploader::OnUploadDone(
    const base::FilePath& file_path,
    storage::FileSystemURL url,
    std::optional<MigrationUploadError> error,
    base::FilePath upload_root_path) {
  if (upload_root_path_.empty()) {
    upload_root_path_ = upload_root_path;
  }

  if (!error.has_value()) {
    OnErrorLogged(file_path);
    return;
  }

  SkyVaultMigrationUploadErrorHistogram(MigrationDestination::kOneDrive,
                                        error.value());

  if (!ErrorCanBeIgnored(error.value())) {
    errors_.insert({file_path, error.value()});
  }

  if (error.value() == MigrationUploadError::kNetworkError) {
    // Just retry, uploaders handle waiting for connectivity.
    base::FilePath relative_path =
        GetPathRelativeToMyFiles(profile_, file_path);
    // Safe to replace; original OdfsSkyvaultUploader is destroyed when its
    // Upload method completes.
    uploaders_.insert_or_assign(
        file_path,
        ash::cloud_upload::OdfsSkyvaultUploader::Upload(
            profile_, file_path, relative_path, upload_root_,
            UploadTrigger::kMigration,
            // No need to show progress updates.
            /*progress_callback=*/base::DoNothing(),
            /*upload_callback=*/
            base::BindOnce(&OneDriveMigrationUploader::OnUploadDone,
                           weak_ptr_factory_.GetWeakPtr(), file_path)));
    return;
  }

  if (!error_log_file_.IsValid()) {
    LOG(ERROR) << "Cannot log error: log file invalid";
    OnErrorLogged(file_path);
    return;
  }

  log_task_runner_->PostTaskAndReply(
      FROM_HERE,
      base::BindOnce(&LogError, std::ref(error_log_file_),
                     MigrationDestination::kOneDrive, file_path, error.value()),
      base::BindOnce(&OneDriveMigrationUploader::OnErrorLogged,
                     weak_ptr_factory_.GetWeakPtr(), file_path));
}

void OneDriveMigrationUploader::OnErrorLogged(const base::FilePath& file_path) {
  uploaders_.erase(file_path);

  if (!uploaders_.empty()) {
    // Some files are still being uploaded.
    return;
  }

  if (cancelled_) {
    CHECK(cancelled_callback_);
    std::move(cancelled_callback_).Run();
    return;
  }
  CHECK(done_callback_);
  // TODO(aidazolic): What to do if the log file isn't valid?
  std::move(done_callback_)
      .Run(std::move(errors_), upload_root_path_, error_log_path_);
}

GoogleDriveMigrationUploader::GoogleDriveMigrationUploader(
    Profile* profile,
    std::vector<base::FilePath> files,
    const std::string& upload_root,
    const base::FilePath& error_log_path,
    MigrationDoneCallback callback)
    : MigrationCloudUploader(profile,
                             std::move(files),
                             upload_root,
                             error_log_path,
                             std::move(callback)) {}

GoogleDriveMigrationUploader::~GoogleDriveMigrationUploader() = default;

void GoogleDriveMigrationUploader::OnLogFileReady(base::File log_file) {
  error_log_file_ = std::move(log_file);
  // TODO(aidazolic): Consider if we can start all jobs at the same time, or we
  // need chunking.
  for (const auto& file_path : files_) {
    base::FilePath target_path = GetPathRelativeToMyFiles(profile_, file_path);
    std::unique_ptr<DriveSkyvaultUploader> uploader =
        std::make_unique<DriveSkyvaultUploader>(
            profile_, file_path, target_path, upload_root_,
            base::BindOnce(&GoogleDriveMigrationUploader::OnUploadDone,
                           weak_ptr_factory_.GetWeakPtr(), file_path));

    auto uploader_ptr = uploader.get();
    uploaders_.insert({file_path, std::move(uploader)});
    uploader_ptr->Run();
  }
}

void GoogleDriveMigrationUploader::Cancel(base::OnceClosure callback) {
  cancelled_callback_ = std::move(callback);
  cancelled_ = true;
  // Create a copy of the keys to iterate over. This is necessary because
  // calling Cancel() on the uploader may trigger OnUploadDone(), which
  // modifies the |uploaders_| map, potentially invalidating iterators.
  std::vector<base::FilePath> file_paths;
  for (const auto& uploader : uploaders_) {
    file_paths.push_back(uploader.first);
  }

  for (const auto& path : file_paths) {
    uploaders_[path]->Cancel();
  }
}

void GoogleDriveMigrationUploader::OnUploadDone(
    const base::FilePath& file_path,
    std::optional<MigrationUploadError> error,
    base::FilePath upload_root_path) {
  // Record the destination path the first time we receive it.
  if (upload_root_path_.empty()) {
    upload_root_path_ = upload_root_path;
  }

  if (!error.has_value()) {
    OnErrorLogged(file_path);
    return;
  }

  SkyVaultMigrationUploadErrorHistogram(MigrationDestination::kGoogleDrive,
                                        error.value());

  if (!ErrorCanBeIgnored(error.value())) {
    errors_.insert({file_path, error.value()});
  }

  if (error.value() == MigrationUploadError::kNetworkError) {
    // Just retry, uploaders handle waiting for connectivity.
    base::FilePath target_path = GetPathRelativeToMyFiles(profile_, file_path);
    std::unique_ptr<DriveSkyvaultUploader> uploader =
        std::make_unique<DriveSkyvaultUploader>(
            profile_, file_path, target_path, upload_root_,
            base::BindOnce(&GoogleDriveMigrationUploader::OnUploadDone,
                           weak_ptr_factory_.GetWeakPtr(), file_path));

    auto uploader_ptr = uploader.get();
    // Safe to replace; original DriveSkyvaultUploader is destroyed when its
    // unique_ptr is removed from the map.
    uploaders_.insert_or_assign(file_path, std::move(uploader));
    uploader_ptr->Run();
    return;
  }

  if (!error_log_file_.IsValid()) {
    LOG(ERROR) << "Cannot log error: log file invalid";
    OnErrorLogged(file_path);
    return;
  }

  log_task_runner_->PostTaskAndReply(
      FROM_HERE,
      base::BindOnce(&LogError, std::ref(error_log_file_),
                     MigrationDestination::kGoogleDrive, file_path,
                     error.value()),
      base::BindOnce(&GoogleDriveMigrationUploader::OnErrorLogged,
                     weak_ptr_factory_.GetWeakPtr(), file_path));
}

void GoogleDriveMigrationUploader::OnErrorLogged(
    const base::FilePath& file_path) {
  uploaders_.erase(file_path);

  if (!uploaders_.empty()) {
    // Some files are still being uploaded.
    return;
  }

  if (cancelled_) {
    CHECK(cancelled_callback_);
    std::move(cancelled_callback_).Run();
    return;
  }
  CHECK(done_callback_);
  // TODO(aidazolic): What to do if the log file isn't valid?
  std::move(done_callback_)
      .Run(std::move(errors_), upload_root_path_, error_log_path_);
}

}  // namespace policy::local_user_files