File: share_info_file_handler.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; 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,806; 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 (197 lines) | stat: -rw-r--r-- 7,662 bytes parent folder | download | duplicates (8)
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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
// Copyright 2021 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_ARC_NEARBY_SHARE_SHARE_INFO_FILE_HANDLER_H_
#define CHROME_BROWSER_ASH_ARC_NEARBY_SHARE_SHARE_INFO_FILE_HANDLER_H_

#include <cstdint>
#include <list>
#include <memory>
#include <vector>

#include "base/files/scoped_temp_dir.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/task/sequenced_task_runner.h"
#include "base/time/time.h"
#include "chrome/browser/ash/arc/nearby_share/share_info_file_stream_adapter.h"
#include "chromeos/ash/experiences/arc/mojom/nearby_share.mojom.h"
#include "content/public/browser/browser_thread.h"

class GURL;
class Profile;

namespace storage {
class FileSystemContext;
class FileSystemURL;
}  // namespace storage

namespace content {
class BrowserContext;
}  // namespace content

namespace file_manager {
namespace util {
struct FileSystemURLAndHandle;
}  // namespace util
}  // namespace file_manager

namespace arc {

// ShareInfoFileHandler will process share intent from Android and only handle
// share info and respective FileInfo objects for files. The class will process
// Android ContentProvider URIs and convert them FileSystemURLs used by Chrome
// OS virtual filesystem backends.  It contains a list of file stream adapters
// and dispatches them in a separate task from the main pool to obtain the raw
// bytes of the virtual files. All file IO operations are performed on a
// separate task.  This class is created on the UI thread but deleted on the
// IO thread.  FileShareConfig is a convenience subclass for containing related
// files information needed to create a Chrome share intent.
class ShareInfoFileHandler
    : public base::RefCountedThreadSafe<ShareInfoFileHandler> {
 public:
  // Signifies whether all shared files have started streaming successfully.
  using StartedCallback = base::OnceCallback<void(void)>;

  // |result| signifies state of shared files after streaming has completed.
  using CompletedCallback =
      base::OnceCallback<void(std::optional<base::File::Error> result)>;

  // |value| is a percentage from 0 to 1 in double format (e.g. 0.50 for 50%).
  using ProgressBarUpdateCallback = base::RepeatingCallback<void(double value)>;

  // |profile| is the current user profile.
  // |share_info| represents the data being shared.
  // |directory| is the top level share directory. The owner of this class
  // object will be required to clean up |directory| including any
  // subdirectories and files within it.
  // |task_runner| is used for any cleanup which requires disk IO.
  ShareInfoFileHandler(Profile* profile,
                       mojom::ShareIntentInfo* share_info,
                       base::FilePath directory,
                       scoped_refptr<base::SequencedTaskRunner> task_runner);

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

  // Returns FileSystemURL for a given |context| and |url|.
  static file_manager::util::FileSystemURLAndHandle GetFileSystemURL(
      content::BrowserContext* context,
      const GURL& url);

  const std::vector<base::FilePath>& GetFilePaths() const;
  const std::vector<std::string>& GetMimeTypes() const;
  uint64_t GetTotalSizeOfFiles() const { return file_config_.total_size; }
  size_t GetNumberOfFiles() const { return file_config_.num_files; }
  const base::FilePath& GetShareDirectory() const {
    return file_config_.directory;
  }

  // Start streaming virtual files to destination file descriptors in
  // preparation for Nearby Share.  Callbacks are run on the UI thread.
  // |started_callback| is called when all files have successfully started
  // streaming.
  // |completed_callback| is called when file streaming is completed with
  // either error or success.
  // |update_callback| is for updating a progress bar view value if needed
  // (e.g. views::ProgressBar::SetValue(double)).
  void StartPreparingFiles(StartedCallback started_callback,
                           CompletedCallback completed_callback,
                           ProgressBarUpdateCallback update_callback);

 private:
  friend class base::RefCountedThreadSafe<ShareInfoFileHandler>;

  ~ShareInfoFileHandler();

  // Create local unique share directory for cache files.
  base::FilePath CreateShareDirectory();

  // Called when share directory path is created and can start streaming files.
  void OnShareDirectoryPathCreated(base::FilePath share_dir);

  // Create file with create and write flags and return scoped fd.
  base::ScopedFD CreateFileForWrite(const base::FilePath& file_path);

  // Called when destination file descriptor is created and ready for file
  // contents to be streamed into it.
  void OnFileDescriptorCreated(const GURL& url,
                               const base::FilePath& dest_file_path,
                               const int64_t file_size,
                               base::ScopedFD dest_fd);

  // Called when the raw bytes of files have completed streaming from ARC
  // virtual filesystem to Chrome local path.
  void OnFileStreamReadCompleted(
      const std::string& url_str,
      std::list<scoped_refptr<ShareInfoFileStreamAdapter>>::iterator it_adapter,
      const std::string& file_system_id,
      const int64_t bytes_read,
      bool result);

  // Called back once file streaming time exceeds the maximum duration.
  void OnFileStreamingTimeout(const std::string& timeout_message);

  // Notify caller that sharing is completed via |completed_callback_| with
  // result which could be FILE_OK or some file error.
  void NotifyFileSharingCompleted(base::File::Error result);

  struct FileShareConfig {
    FileShareConfig();
    FileShareConfig(FileShareConfig&&) = delete;
    FileShareConfig& operator=(FileShareConfig&&) = delete;
    FileShareConfig(const FileShareConfig&) = delete;
    FileShareConfig& operator=(const FileShareConfig&) = delete;
    ~FileShareConfig();

    std::vector<base::FilePath> paths;
    std::vector<GURL> external_urls;
    std::vector<std::string> mime_types;
    std::vector<std::string> names;
    std::vector<int64_t> sizes;

    // Top level directory for all files.
    base::FilePath directory;

    // Total size in bytes for all files.
    uint64_t total_size = 0;

    // Number of files.
    size_t num_files = 0;
  };

  std::list<scoped_refptr<ShareInfoFileStreamAdapter>> file_stream_adapters_;
  std::list<scoped_refptr<storage::FileSystemContext>> contexts_;
  FileShareConfig file_config_;
  StartedCallback started_callback_;
  CompletedCallback completed_callback_;
  ProgressBarUpdateCallback update_callback_;

  // Updated by multiple stream adapters on UI thread.
  uint64_t num_bytes_read_ = 0;
  size_t num_files_streamed_ = 0;

  // Track whether a file sharing flow has started .
  bool file_sharing_started_ = false;

  // Unowned pointer to profile.
  const raw_ptr<Profile> profile_;

  // Runner for tasks that may require disk IO.
  const scoped_refptr<base::SequencedTaskRunner> task_runner_;

  // Timeout timer for asynchronous file streaming tasks.
  base::OneShotTimer file_streaming_timer_;

  // Time when the file streaming is started.
  base::TimeTicks file_streaming_started_;

  // Note: This should remain the last member so it'll be destroyed and
  // invalidate its weak pointers before any other members are destroyed.
  base::WeakPtrFactory<ShareInfoFileHandler> weak_ptr_factory_{this};
};

}  // namespace arc

#endif  // CHROME_BROWSER_ASH_ARC_NEARBY_SHARE_SHARE_INFO_FILE_HANDLER_H_