File: connector_upload_request.h

package info (click to toggle)
chromium 139.0.7258.127-2
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 6,122,156 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 (176 lines) | stat: -rw-r--r-- 6,813 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
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
// 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_SAFE_BROWSING_CLOUD_CONTENT_SCANNING_CONNECTOR_UPLOAD_REQUEST_H_
#define CHROME_BROWSER_SAFE_BROWSING_CLOUD_CONTENT_SCANNING_CONNECTOR_UPLOAD_REQUEST_H_

#include "base/files/file_path.h"
#include "base/functional/callback.h"
#include "base/memory/read_only_shared_memory_region.h"
#include "base/memory/scoped_refptr.h"
#include "chrome/browser/safe_browsing/cloud_content_scanning/binary_upload_service.h"
#include "chrome/browser/safe_browsing/cloud_content_scanning/connector_data_pipe_getter.h"
#include "components/file_access/scoped_file_access.h"
#include "net/traffic_annotation/network_traffic_annotation.h"
#include "services/network/public/cpp/shared_url_loader_factory.h"
#include "services/network/public/cpp/simple_url_loader.h"
#include "url/gurl.h"

namespace network {
class SharedURLLoaderFactory;
class SimpleURLLoader;
}  // namespace network

namespace safe_browsing {

class ConnectorUploadRequestFactory;

// This class encapsulates the base class of uploading metadata and file.
// This class is neither movable nor copyable.
class ConnectorUploadRequest {
 public:
  using Callback = base::OnceCallback<
      void(bool success, int http_status, const std::string& response_data)>;

  // Makes the passed `factory` the factory used to instantiate a
  // MultipartUploadRequest. Useful for tests.
  static void RegisterFactoryForTests(ConnectorUploadRequestFactory* factory) {
    factory_ = factory;
  }

  // Creates a ConnectorUploadRequest, which will upload `metadata` and `data`
  // to the given `base_url`.
  ConnectorUploadRequest(
      scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
      const GURL& base_url,
      const std::string& metadata,
      const std::string& data,
      const std::string& histogram_suffix,
      const net::NetworkTrafficAnnotationTag& traffic_annotation,
      Callback callback);

  // Creates a ConnectorUploadRequest, which will upload `metadata` and the file
  // corresponding to `path` to the given `base_url`.
  ConnectorUploadRequest(
      scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
      const GURL& base_url,
      const std::string& metadata,
      const base::FilePath& path,
      uint64_t file_size,
      bool is_obfuscated,
      const std::string& histogram_suffix,
      const net::NetworkTrafficAnnotationTag& traffic_annotation,
      Callback callback);

  // Creates a  ConnectorUploadRequest, which will upload `metadata` and the
  // page in `page_region` to the given `base_url`.
  ConnectorUploadRequest(
      scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
      const GURL& base_url,
      const std::string& metadata,
      base::ReadOnlySharedMemoryRegion page_region,
      const std::string& histogram_suffix,
      const net::NetworkTrafficAnnotationTag& traffic_annotation,
      Callback callback);

  ConnectorUploadRequest(const ConnectorUploadRequest&) = delete;
  ConnectorUploadRequest& operator=(const ConnectorUploadRequest&) = delete;
  ConnectorUploadRequest(ConnectorUploadRequest&&) = delete;
  ConnectorUploadRequest& operator=(ConnectorUploadRequest&&) = delete;

  virtual ~ConnectorUploadRequest();

  ConnectorDataPipeGetter* data_pipe_getter_for_testing() {
    return data_pipe_getter_.get();
  }

  void set_access_token(const std::string& access_token);

  // Start the upload. This must be called on the UI thread. When complete, this
  // will call `callback_` on the UI thread.
  virtual void Start() = 0;

  // Return the upload protocol and scanning type of the request. E.g.,
  // "Multipart - Pending", "Multipart - Complete", "Resumable - Pending",
  // "Resumable - Metadata only scan", "Resumable - Full content scan".
  virtual std::string GetUploadInfo() = 0;

 protected:
  static ConnectorUploadRequestFactory* factory_;

  GURL base_url_;
  std::string metadata_;

  // Indicates what the source of the data to upload is.
  const enum { STRING = 0, FILE = 1, PAGE = 2 } data_source_;

  // String of content to upload. Only populated for STRING requests.
  std::string data_;

  // Path to read the file to upload. Only populated for FILE requests.
  base::FilePath path_;

  // Memory to upload. Only populated for PAGE requests.
  base::ReadOnlySharedMemoryRegion page_region_;

  // Size of the file or page region.
  uint64_t data_size_ = 0;

  // Whether the file has been obfuscated. Only populated for FILE requests.
  bool is_obfuscated_ = false;

  // Data pipe getter used to stream a file or a page. Only populated for the
  // corresponding requests.
  std::unique_ptr<ConnectorDataPipeGetter> data_pipe_getter_;

  // Suffix to be used for common histograms broken out by consumer.
  std::string histogram_suffix_;

  Callback callback_;

  scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory_;
  std::unique_ptr<network::SimpleURLLoader> url_loader_;
  net::NetworkTrafficAnnotationTag traffic_annotation_;

  std::string access_token_;

  std::unique_ptr<file_access::ScopedFileAccess> scoped_file_access_;
};

class ConnectorUploadRequestFactory {
 public:
  virtual ~ConnectorUploadRequestFactory() = default;
  virtual std::unique_ptr<ConnectorUploadRequest> CreateStringRequest(
      scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
      const GURL& base_url,
      const std::string& metadata,
      const std::string& data,
      const std::string& histogram_suffix,
      const net::NetworkTrafficAnnotationTag& traffic_annotation,
      ConnectorUploadRequest::Callback callback) = 0;
  virtual std::unique_ptr<ConnectorUploadRequest> CreateFileRequest(
      scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
      const GURL& base_url,
      const std::string& metadata,
      BinaryUploadService::Result get_data_result,
      const base::FilePath& path,
      uint64_t file_size,
      bool is_obfuscated,
      const std::string& histogram_suffix,
      const net::NetworkTrafficAnnotationTag& traffic_annotation,
      ConnectorUploadRequest::Callback callback) = 0;
  virtual std::unique_ptr<ConnectorUploadRequest> CreatePageRequest(
      scoped_refptr<network::SharedURLLoaderFactory> url_loader_factory,
      const GURL& base_url,
      const std::string& metadata,
      BinaryUploadService::Result get_data_result,
      base::ReadOnlySharedMemoryRegion page_region,
      const std::string& histogram_suffix,
      const net::NetworkTrafficAnnotationTag& traffic_annotation,
      ConnectorUploadRequest::Callback callback) = 0;
};

}  // namespace safe_browsing

#endif  // CHROME_BROWSER_SAFE_BROWSING_CLOUD_CONTENT_SCANNING_CONNECTOR_UPLOAD_REQUEST_H_