File: files_scan_data.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 (97 lines) | stat: -rw-r--r-- 3,949 bytes parent folder | download | duplicates (9)
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
// 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 COMPONENTS_ENTERPRISE_COMMON_FILES_SCAN_DATA_H_
#define COMPONENTS_ENTERPRISE_COMMON_FILES_SCAN_DATA_H_

#include <map>
#include <set>
#include <vector>

#include "base/files/file_path.h"
#include "base/functional/callback.h"
#include "base/memory/weak_ptr.h"
#include "ui/base/clipboard/file_info.h"

namespace enterprise_connectors {

// Helper class to handle files going through content analysis by expanding
// directories, aggregating verdicts, etc.
class FilesScanData final {
 public:
  // Represents an expansion of the paths in `base_paths_` where each directory
  // has been traversed to include each sub-file as a key. The map value
  // represents the index in `base_paths_` for the parent entry of that file.
  // For instance this means that for a `base_paths_` of [ "a.txt", "dir/"],
  // `ExpandedPathsIndexes` might be populated with { "a.txt": 0,
  // "dir/sub_1.txt": 1, "dir/sub_2.txt": 1 }.
  using ExpandedPathsIndexes = std::map<base::FilePath, size_t>;

  // Used internally by FilesScanData to return information about the path
  // expansion.  This structure is public because it is used by the anonymous
  // GetPathsToScan() function in the implementation file.
  struct PathsToScanResult {
    PathsToScanResult(
        std::vector<base::FilePath> base_paths,
        FilesScanData::ExpandedPathsIndexes expanded_paths_indexes,
        std::vector<base::FilePath> paths);
    PathsToScanResult(const PathsToScanResult&) = delete;
    PathsToScanResult(PathsToScanResult&&);
    PathsToScanResult& operator=(const PathsToScanResult&) = delete;
    PathsToScanResult& operator=(PathsToScanResult&&);
    ~PathsToScanResult();

    std::vector<base::FilePath> base_paths;
    FilesScanData::ExpandedPathsIndexes expanded_paths_indexes;
    std::vector<base::FilePath> paths;
  };

  FilesScanData();
  explicit FilesScanData(std::vector<ui::FileInfo> paths);
  explicit FilesScanData(std::vector<base::FilePath> paths);
  FilesScanData(const FilesScanData&) = delete;
  FilesScanData& operator=(const FilesScanData&) = delete;
  ~FilesScanData();

  // Starts a task on a background thread to traverse `base_paths_` directories
  // and build of map of all sub-files. The result is stored into
  // `expanded_paths_indexes_` and `expanded_paths_`.
  void ExpandPaths(base::OnceClosure done_closure);

  // Returns a set indicating which paths in `base_paths_` should be blocked
  // due to content analysis violations based on `expanded_paths_` verdicts. The
  // size of `allowed_paths` and its indexes are expected to match
  // `expanded_paths_`.
  std::set<size_t> IndexesToBlock(const std::vector<bool>& allowed_paths);

  // Once ExpandPaths() is called, accessing base paths is not allowed until
  // the done closure is called.  After take_base_paths() is called, further
  // calls to get the base paths will return empty vectors.
  const std::vector<base::FilePath>& base_paths() const;
  std::vector<base::FilePath> take_base_paths();

  const ExpandedPathsIndexes& expanded_paths_indexes() const;
  const std::vector<base::FilePath>& expanded_paths() const;

 private:
  void OnExpandPathsDone(PathsToScanResult result);

  // The file paths given as input for a scan. This does not include any
  // expansion of directories.
  std::vector<base::FilePath> base_paths_;

  // The following members contain the result of an `ExpandPaths()` call.
  ExpandedPathsIndexes expanded_paths_indexes_;
  std::vector<base::FilePath> expanded_paths_;

  // Called after the `ExpandPaths()` operation is done to tell callers its
  // results can be used.
  base::OnceClosure expand_paths_done_closure_;

  base::WeakPtrFactory<FilesScanData> weak_ptr_factory_{this};
};

}  // namespace enterprise_connectors

#endif  // COMPONENTS_ENTERPRISE_COMMON_FILES_SCAN_DATA_H_