chrome/browser/ash/policy/skyvault/policy_utils.h

// 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.

#ifndef CHROME_BROWSER_ASH_POLICY_SKYVAULT_POLICY_UTILS_H_
#define CHROME_BROWSER_ASH_POLICY_SKYVAULT_POLICY_UTILS_H_

#include <optional>

#include "base/files/file_path.h"
#include "base/time/time.h"

class Profile;

namespace policy::local_user_files {

extern const char kGoogleDrivePolicyVariableName[],
    kOneDrivePolicyVariableName[];

// Enum describing where the admin configured the files to be saved.
enum class FileSaveDestination {
  kNotSpecified = 0,
  kDownloads = 1,
  kGoogleDrive = 2,
  kOneDrive = 3,
  kMaxValue = kOneDrive,
};

// Supported migration destination options.
enum class MigrationDestination {
  kNotSpecified,
  kGoogleDrive,
  kOneDrive,
  kDelete,
  kMaxValue = kDelete,
};

// Categories of errors that can occur during the file upload process.
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
//
// LINT.IfChange(MigrationUploadError)
enum class MigrationUploadError {
  kUnexpectedError = 0,     // An unexpected error occurred, e.g. no profile.
  kServiceUnavailable = 1,  // The cloud provider is not accessible.
  kCreateFolderFailed = 2,  // Creating a folder in Google Drive failed.
  kSyncFailed = 3,          // Syncing the file to Google Drive failed.
  kCloudQuotaFull = 4,      // No space on the cloud provider.
  kFileNotFound = 5,        // File deleted before finishing the upload.
  kInvalidURL = 6,          // OneDrive rejected the request.
  kCopyFailed = 7,          // Generic catch-all copy error.
  kDeleteFailed = 8,        // Deleting the file after upload failed.
  kAuthRequired = 9,        // OneDrive reauthentication required.
  kMoveFailed = 10,         // Generic catch-all move error.
  kCancelled = 11,          // Upload explicitly cancelled.
  kNetworkError = 12,       // Interruption due to disconnected network.
  kReconnectTimeout = 13,   // Upload failed after a reconnection timeout.
  kMaxValue = kReconnectTimeout,
};
// LINT.ThenChange(//tools/metrics/histograms/metadata/enterprise/enums.xml:EnterpriseSkyVaultMigrationUploadError)

// The event or action that triggers an upload to the cloud.
enum class UploadTrigger {
  kDownload = 0,
  kScreenCapture = 1,
  kMigration = 2,
  kMaxValue = kMigration,
};

// Possible states of the migration. Persisted to a pref.
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
//
// LINT.IfChange(State)
enum class State {
  kUninitialized = 0,
  kPending = 1,
  kInProgress = 2,
  kCleanup = 3,
  kCompleted = 4,
  kFailure = 5,
  kMaxValue = kFailure,
};
// LINT.ThenChange(//tools/metrics/histograms/metadata/enterprise/enums.xml:EnterpriseSkyVaultMigrationState)

// The context, or the part of the migration process in which an unexpected
// state transition happens.
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
//
// LINT.IfChange(StateErrorContext)
enum class StateErrorContext {
  kShowDialog = 0,  //
  kDialogClick = 1,
  kSkipTimeout = 2,
  kTimeout = 3,
  kListFiles = 4,
  kMigrationStart = 5,
  kMigrationDone = 6,
  kCleanupStart = 7,
  kCleanupDone = 8,
  kMaxValue = kCleanupDone,
};
// LINT.ThenChange(//tools/metrics/histograms/metadata/enterprise/enums.xml:EnterpriseSkyVaultMigrationStateErrorContext)

// Possible actions a user can take in the migration dialog.
// These values are persisted to logs. Entries should not be renumbered and
// numeric values should never be reused.
//
// LINT.IfChange(DialogAction)
enum class DialogAction {
  kUploadNow = 0,    // `Upload now` button clicked
  kUploadLater = 1,  // No action or `Upload in <delay>` button clicked
  kMaxValue = kUploadLater,
};
// LINT.ThenChange(//tools/metrics/histograms/metadata/enterprise/enums.xml:EnterpriseSkyVaultMigrationDialogAction)

// Returns whether local user files are enabled on the device by the flag and
// policy.
bool LocalUserFilesAllowed();

// Returns the `MigrationDestination` indicating where local files should be
// moved, or that they should be deleted. Returns `kNotSpecified` if the
// migration policy is unset or explicitly set to "read-only".
MigrationDestination GetMigrationDestination();

// Returns true if `destination` is set to a cloud location.
bool IsCloudDestination(MigrationDestination destination);

// Get the destination where downloads are saved.
FileSaveDestination GetDownloadsDestination(Profile* profile);

// Get the destination where screen captures are saved.
FileSaveDestination GetScreenCaptureDestination(Profile* profile);

// Returns whether `download` should be saved to tmp/ directory.
bool DownloadToTemp(Profile* profile);

// Returns the path of MyFiles folder for `profile`.
base::FilePath GetMyFilesPath(Profile* profile);

// Returns the scheduled start time for local file migration or deletion.
std::optional<base::Time> GetMigrationStartTime(Profile* profile);

}  // namespace policy::local_user_files

#endif  // CHROME_BROWSER_ASH_POLICY_SKYVAULT_POLICY_UTILS_H_