File: select_file_dialog_extension.h

package info (click to toggle)
chromium 120.0.6099.224-1~deb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 6,112,112 kB
  • sloc: cpp: 32,907,025; ansic: 8,148,123; javascript: 3,679,536; python: 2,031,248; asm: 959,718; java: 804,675; xml: 617,256; sh: 111,417; objc: 100,835; perl: 88,443; cs: 53,032; makefile: 29,579; fortran: 24,137; php: 21,162; tcl: 21,147; sql: 20,809; ruby: 17,735; pascal: 12,864; yacc: 8,045; lisp: 3,388; lex: 1,323; ada: 727; awk: 329; jsp: 267; csh: 117; exp: 43; sed: 37
file content (211 lines) | stat: -rw-r--r-- 8,439 bytes parent folder | download
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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
// 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_UI_VIEWS_SELECT_FILE_DIALOG_EXTENSION_H_
#define CHROME_BROWSER_UI_VIEWS_SELECT_FILE_DIALOG_EXTENSION_H_

#include <memory>
#include <string>
#include <vector>

#include "base/gtest_prod_util.h"
#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "chrome/browser/chromeos/policy/dlp/dlp_file_destination.h"
#include "third_party/abseil-cpp/absl/types/optional.h"
#include "ui/color/color_provider_source_observer.h"
#include "ui/gfx/native_widget_types.h"  // gfx::NativeWindow
#include "ui/shell_dialogs/select_file_dialog.h"
#include "url/gurl.h"

class Profile;

namespace aura {
class Window;
}  // namespace aura

namespace content {
class RenderFrameHost;
class WebContents;
}  // namespace content

namespace ui {
struct SelectedFileInfo;
class SelectFilePolicy;
}  // namespace ui

// Shows a dialog box for selecting a file or a folder, using the
// file manager extension implementation.
class SelectFileDialogExtension : public ui::SelectFileDialog {
 public:
  // Opaque ID type for identifying the tab spawned each dialog, unique for
  // every WebContents or every Android task ID.
  typedef std::string RoutingID;

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

  static SelectFileDialogExtension* Create(
      ui::SelectFileDialog::Listener* listener,
      std::unique_ptr<ui::SelectFilePolicy> policy);

  // ui::SelectFileDialog:
  bool IsRunning(gfx::NativeWindow owner_window) const override;
  void ListenerDestroyed() override;

  // Routes callback to appropriate SelectFileDialog::Listener based on the
  // owning |web_contents|.
  static void OnFileSelected(RoutingID routing_id,
                             const ui::SelectedFileInfo& file,
                             int index);
  static void OnMultiFilesSelected(
      RoutingID routing_id,
      const std::vector<ui::SelectedFileInfo>& files);
  static void OnFileSelectionCanceled(RoutingID routing_id);

  // Helper method that given parameters that are passed to the
  // SelectFileWithFileManagerParams method creates a URL for launching File
  // Manager as a dialog.
  static GURL MakeDialogURL(Type type,
                            const std::u16string& title,
                            const base::FilePath& default_path,
                            const FileTypeInfo* file_types,
                            int file_type_index,
                            const std::string& search_query,
                            bool show_android_picker_apps,
                            std::vector<std::string> volume_filter,
                            Profile* profile);

  // Allows access to the extension's main frame for injecting javascript.
  content::RenderFrameHost* GetPrimaryMainFrame();

  // Call SelectFile with params specific to Chrome OS file manager.
  // |owner| specifies the window and app type that opened the dialog.
  // |show_android_picker_apps| determines whether to show Android picker apps
  //     in the select file dialog.
  struct Owner {
    Owner();
    ~Owner();
    Owner(const Owner&);
    Owner& operator=(const Owner&);
    Owner(Owner&&);
    Owner& operator=(Owner&&);

    // The native window that opened the dialog.
    raw_ptr<aura::Window, LeakedDanglingUntriaged | ExperimentalAsh> window =
        nullptr;
    // Android task ID if the owner window is an Android app.
    absl::optional<int> android_task_id;
    // Lacros window ID if the owner window is a Lacros browser. This field
    // can be nullopt even when is_lacros is true, for dialogs that are not
    // owned by a particular window, aka "modeless" dialog.
    absl::optional<std::string> lacros_window_id;
    // Set to true only if SelectFileAsh opened the dialog.
    bool is_lacros = false;
    // The URL or Component type of the caller that opened the dialog (Save
    // As/File Picker).
    absl::optional<policy::DlpFileDestination> dialog_caller;
  };
  void SelectFileWithFileManagerParams(Type type,
                                       const std::u16string& title,
                                       const base::FilePath& default_path,
                                       const FileTypeInfo* file_types,
                                       int file_type_index,
                                       void* params,
                                       const Owner& owner,
                                       const std::string& search_query,
                                       bool show_android_picker_apps,
                                       bool use_media_store_filter = false);

 protected:
  // ui::SelectFileDialog:
  void SelectFileImpl(Type type,
                      const std::u16string& title,
                      const base::FilePath& default_path,
                      const FileTypeInfo* file_types,
                      int file_type_index,
                      const base::FilePath::StringType& default_extension,
                      gfx::NativeWindow owning_window,
                      void* params,
                      const GURL* caller) override;
  bool HasMultipleFileTypeChoicesImpl() override;

 private:
  friend class BaseSelectFileDialogExtensionBrowserTest;
  friend class SelectFileDialogExtensionTest;
  friend class SelectFileDialogExtensionTestFactory;
  friend class SystemFilesAppDialogDelegate;
  FRIEND_TEST_ALL_PREFIXES(SelectFileDialogExtensionTest, FileSelected);
  FRIEND_TEST_ALL_PREFIXES(SelectFileDialogExtensionTest,
                           FileSelectionCanceled);
  FRIEND_TEST_ALL_PREFIXES(SelectFileDialogExtensionTest, SelfDeleting);
  FRIEND_TEST_ALL_PREFIXES(SelectFileDialogExtensionBrowserTest,
                           DialogCallerSetWhenPassed);

  // For the benefit of SystemFilesAppDialogDelegate.
  void OnSystemDialogShown(content::WebContents* content,
                           const std::string& id);
  void OnSystemDialogWillClose();

  // Object is ref-counted, use Create().
  explicit SelectFileDialogExtension(
      SelectFileDialog::Listener* listener,
      std::unique_ptr<ui::SelectFilePolicy> policy);
  ~SelectFileDialogExtension() override;

  // Applies DLP policies if there's any, then notifies listeners accordingly.
  void ApplyPolicyAndNotifyListener(
      absl::optional<policy::DlpFileDestination> dialog_caller);

  // Invokes the appropriate file selection callback on our listener.
  void NotifyListener(std::vector<ui::SelectedFileInfo> selection_files);

  // Adds this to the list of pending dialogs, used for testing.
  void AddPending(RoutingID routing_id);

  // Check if the list of pending dialogs contains dialog for |routing_id|.
  static bool PendingExists(RoutingID routing_id);

  // Returns true if |extension_dialog_| is resizable; the dialog must be
  // non-null at the time of this call.
  bool IsResizeable() const;

  bool has_multiple_file_type_choices_ = false;

  // If System Files App is enabled it stores the web contents associated with
  // System File App dialog. Not owned by this class. Set only while System
  // Files App dialog is opened.
  raw_ptr<content::WebContents, LeakedDanglingUntriaged | ExperimentalAsh>
      system_files_app_web_contents_;

  // ID of the tab that spawned this dialog, used to route callbacks.
  RoutingID routing_id_;

  // Pointer to the profile the dialog is running in.
  raw_ptr<Profile, LeakedDanglingUntriaged | ExperimentalAsh> profile_ =
      nullptr;

  // Information about the dialog's owner, such as the window or app type.
  Owner owner_;

  // Dialog type.
  Type type_;

  // We defer the callback into SelectFileDialog::Listener until the window
  // closes, to match the semantics of file selection on Windows and Mac.
  // These are the data passed to the listener.
  enum SelectionType {
    CANCEL = 0,
    SINGLE_FILE,
    MULTIPLE_FILES
  };
  SelectionType selection_type_ = CANCEL;
  std::vector<ui::SelectedFileInfo> selection_files_;
  int selection_index_ = 0;
  bool can_resize_ = true;
  raw_ptr<void, LeakedDanglingUntriaged | ExperimentalAsh> params_ = nullptr;
  base::WeakPtrFactory<SelectFileDialogExtension> weak_factory_{this};
};

#endif  // CHROME_BROWSER_UI_VIEWS_SELECT_FILE_DIALOG_EXTENSION_H_