File: file_system_util.h

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 (109 lines) | stat: -rw-r--r-- 4,267 bytes parent folder | download | duplicates (6)
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
// Copyright 2012 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_DRIVE_FILE_SYSTEM_UTIL_H_
#define CHROME_BROWSER_ASH_DRIVE_FILE_SYSTEM_UTIL_H_

#include <ostream>

#include "base/files/file_path.h"

class Profile;

namespace drive {

class DriveIntegrationService;

namespace util {

// Returns DriveIntegrationService instance, if Drive is enabled.
// Otherwise, nullptr.
DriveIntegrationService* GetIntegrationServiceByProfile(Profile*);

// Returns true if the given path is under the Drive mount point.
bool IsUnderDriveMountPoint(const base::FilePath& path);

// Gets the cache root path (i.e. <user_profile_dir>/GCache/v1) from the
// profile.
base::FilePath GetCacheRootPath(const Profile* profile);

// Returns true if Drive is available for the given Profile.
bool IsDriveAvailableForProfile(const Profile* profile);

// Returns true if Drive is currently enabled for the given Profile.
bool IsDriveEnabledForProfile(const Profile* profile);

// Drive availability for a given profile.
enum class DriveAvailability {
  kAvailable,
  kNotAvailableWhenDisableDrivePreferenceSet,
  kNotAvailableForAccountType,
  kNotAvailableForUninitialisedLoginState,
  kNotAvailableInIncognito,
  kNotAvailableForTestImage,
};

// Returns the Drive availability for a given profile. Checks if Drive is
// enabled or if Drive is available for the given profile.
DriveAvailability CheckDriveEnabledAndDriveAvailabilityForProfile(
    const Profile* const profile);

// Returns true if the bulk-pinning feature should be available and visible in
// the given Profile. Several conditions need to be met for the bulk-pinning
// feature to be available. This does not indicate whether the bulk-pinning
// feature has been activated (turned on) by the user. It merely indicates
// whether the bulk-pinning feature is available and can be turned on by the
// user if they choose to.
[[nodiscard]] bool IsDriveFsBulkPinningAvailable(const Profile* profile);
[[nodiscard]] bool IsDriveFsBulkPinningAvailable();
[[nodiscard]] bool IsOobeDrivePinningAvailable(const Profile* profile);
[[nodiscard]] bool IsOobeDrivePinningAvailable();
[[nodiscard]] bool IsOobeDrivePinningScreenEnabled();

// Returns true if the mirror sync feature should be available and visible in
// the given Profile. This does not indicate whether the mirror sync
// feature has been activated (turned on) by the user. It merely indicates
// whether the mirror sync feature is available and can be turned on by the
// user if they choose to.
[[nodiscard]] bool IsDriveFsMirrorSyncAvailable(const Profile* profile);

// Connection status to Drive.
enum class ConnectionStatus {
  // Disconnected because Drive service is unavailable for this account (either
  // disabled by a flag or the account has no Google account (e.g., guests)).
  kNoService,
  // Disconnected because no network is available.
  kNoNetwork,
  // Disconnected because authentication is not ready.
  kNotReady,
  // Connected by metered network (eg cellular network, or metered WiFi.)
  // Background sync is disabled.
  kMetered,
  // Connected without limitation (WiFi, Ethernet, or cellular with the
  // disable-sync preference turned off.)
  kConnected,
};

std::ostream& operator<<(std::ostream& out, ConnectionStatus status);

// Sets the Drive connection status for testing purposes.
void SetDriveConnectionStatusForTesting(ConnectionStatus status);

// Returns the Drive connection status for the `profile`. Also returns the
// device's online state in `is_online`. This could be different from the
// connection status if drivefs is not running for some reason.
ConnectionStatus GetDriveConnectionStatus(Profile* profile,
                                          bool* is_online = nullptr);

// Returns true if the supplied mime type is of a pinnable type. This indicates
// the file can be made available offline.
bool IsPinnableGDocMimeType(const std::string& mime_type);

// Computes the total content cache size (minus the chunks.db* metadata files).
int64_t ComputeDriveFsContentCacheSize(const base::FilePath& path);

}  // namespace util
}  // namespace drive

#endif  // CHROME_BROWSER_ASH_DRIVE_FILE_SYSTEM_UTIL_H_