File: file_system_access_watch_scope.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (94 lines) | stat: -rw-r--r-- 3,364 bytes parent folder | download | duplicates (5)
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
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CONTENT_BROWSER_FILE_SYSTEM_ACCESS_FILE_SYSTEM_ACCESS_WATCH_SCOPE_H_
#define CONTENT_BROWSER_FILE_SYSTEM_ACCESS_FILE_SYSTEM_ACCESS_WATCH_SCOPE_H_

#include "content/common/content_export.h"
#include "content/public/browser/file_system_access_permission_context.h"
#include "storage/browser/file_system/file_system_url.h"

namespace content {

// Describes the extent of the file system that is being observed, which can be
// a single file, a directory and its contents, or a directory and all its
// subdirectories.
class CONTENT_EXPORT FileSystemAccessWatchScope {
 public:
  enum class WatchType {
    kAllBucketFileSystems,
    kFile,
    kDirectoryNonRecursive,
    kDirectoryRecursive,
  };

  // TODO(crbug.com/341239594): Consider using something like a PassKey
  // to restrict access to these initializers.
  static FileSystemAccessWatchScope GetScopeForFileWatch(
      const storage::FileSystemURL& file_url);
  static FileSystemAccessWatchScope GetScopeForDirectoryWatch(
      const storage::FileSystemURL& directory_url,
      bool is_recursive);
  static FileSystemAccessWatchScope GetScopeForAllBucketFileSystems();

  ~FileSystemAccessWatchScope();

  // Copyable and movable.
  FileSystemAccessWatchScope(const FileSystemAccessWatchScope&);
  FileSystemAccessWatchScope(FileSystemAccessWatchScope&&) noexcept;
  FileSystemAccessWatchScope& operator=(const FileSystemAccessWatchScope&);
  FileSystemAccessWatchScope& operator=(FileSystemAccessWatchScope&&) noexcept;

  // Returns true if `url` is contained within this `Scope`.
  bool Contains(const storage::FileSystemURL& url) const;
  // Returns true if `scope` is contained within this `Scope`.
  bool Contains(const FileSystemAccessWatchScope& scope) const;

  bool IsRecursive() const {
    switch (watch_type_) {
      case WatchType::kFile:
      case WatchType::kDirectoryNonRecursive:
        return false;
      case WatchType::kAllBucketFileSystems:
      case WatchType::kDirectoryRecursive:
        return true;
    }
  }

  // This method may only be called when `watch_type_` is not
  // `WatchType::kAllBucketFileSystems`.
  const storage::FileSystemURL& root_url() const {
    CHECK(root_url_.is_valid());
    return root_url_;
  }

  WatchType GetWatchType() const { return watch_type_; }

  FileSystemAccessPermissionContext::HandleType handle_type() const {
    switch (watch_type_) {
      case WatchType::kFile:
        return FileSystemAccessPermissionContext::HandleType::kFile;
      case WatchType::kAllBucketFileSystems:
      case WatchType::kDirectoryNonRecursive:
      case WatchType::kDirectoryRecursive:
        return FileSystemAccessPermissionContext::HandleType::kDirectory;
    }
  }

  bool operator==(const FileSystemAccessWatchScope& other) const = default;

  auto operator<=>(const FileSystemAccessWatchScope& other) const = default;

 private:
  FileSystemAccessWatchScope(storage::FileSystemURL root_url,
                             WatchType watch_type);

  // Invalid iff `watch_type_` is `WatchType::kAllBucketFileSystems`.
  storage::FileSystemURL root_url_;
  WatchType watch_type_;
};

}  // namespace content

#endif  // CONTENT_BROWSER_FILE_SYSTEM_ACCESS_FILE_SYSTEM_ACCESS_WATCH_SCOPE_H_