-
Notifications
You must be signed in to change notification settings - Fork 15k
/
hid_chooser_controller.h
131 lines (105 loc) · 5.34 KB
/
hid_chooser_controller.h
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
// Copyright (c) 2021 Microsoft, Inc.
// Use of this source code is governed by the MIT license that can be
// found in the LICENSE file.
#ifndef ELECTRON_SHELL_BROWSER_HID_HID_CHOOSER_CONTROLLER_H_
#define ELECTRON_SHELL_BROWSER_HID_HID_CHOOSER_CONTROLLER_H_
#include <map>
#include <string>
#include <vector>
#include "base/memory/weak_ptr.h"
#include "base/scoped_observation.h"
#include "content/public/browser/global_routing_id.h"
#include "content/public/browser/hid_chooser.h"
#include "content/public/browser/web_contents.h"
#include "content/public/browser/web_contents_observer.h"
#include "services/device/public/mojom/hid.mojom-forward.h"
#include "shell/browser/api/electron_api_session.h"
#include "shell/browser/hid/electron_hid_delegate.h"
#include "shell/browser/hid/hid_chooser_context.h"
#include "shell/common/gin_converters/frame_converter.h"
#include "third_party/blink/public/mojom/hid/hid.mojom.h"
namespace content {
class RenderFrameHost;
} // namespace content
namespace electron {
class ElectronHidDelegate;
class HidChooserContext;
// HidChooserController provides data for the WebHID API permission prompt.
class HidChooserController
: public content::WebContentsObserver,
public electron::HidChooserContext::DeviceObserver {
public:
// Construct a chooser controller for Human Interface Devices (HID).
// |render_frame_host| is used to initialize the chooser strings and to access
// the requesting and embedding origins. |callback| is called when the chooser
// is closed, either by selecting an item or by dismissing the chooser dialog.
// The callback is called with the selected device, or nullptr if no device is
// selected.
HidChooserController(
content::RenderFrameHost* render_frame_host,
std::vector<blink::mojom::HidDeviceFilterPtr> filters,
std::vector<blink::mojom::HidDeviceFilterPtr> exclusion_filters,
content::HidChooser::Callback callback,
content::WebContents* web_contents,
base::WeakPtr<ElectronHidDelegate> hid_delegate);
HidChooserController(HidChooserController&) = delete;
HidChooserController& operator=(HidChooserController&) = delete;
~HidChooserController() override;
// static
static const std::string& PhysicalDeviceIdFromDeviceInfo(
const device::mojom::HidDeviceInfo& device);
// HidChooserContext::DeviceObserver:
void OnDeviceAdded(const device::mojom::HidDeviceInfo& device_info) override;
void OnDeviceRemoved(
const device::mojom::HidDeviceInfo& device_info) override;
void OnDeviceChanged(
const device::mojom::HidDeviceInfo& device_info) override;
void OnHidManagerConnectionError() override;
void OnHidChooserContextShutdown() override;
// content::WebContentsObserver:
void RenderFrameDeleted(content::RenderFrameHost* render_frame_host) override;
private:
api::Session* GetSession();
void OnGotDevices(std::vector<device::mojom::HidDeviceInfoPtr> devices);
bool DisplayDevice(const device::mojom::HidDeviceInfo& device) const;
bool FilterMatchesAny(const device::mojom::HidDeviceInfo& device) const;
bool IsExcluded(const device::mojom::HidDeviceInfo& device) const;
// Add |device_info| to |device_map_|. The device is added to the chooser item
// representing the physical device. If the chooser item does not yet exist, a
// new item is appended. Returns true if an item was appended.
bool AddDeviceInfo(const device::mojom::HidDeviceInfo& device_info);
// Remove |device_info| from |device_map_|. The device info is removed from
// the chooser item representing the physical device. If this would cause the
// item to be empty, the chooser item is removed. Does nothing if the device
// is not in the chooser item. Returns true if an item was removed.
bool RemoveDeviceInfo(const device::mojom::HidDeviceInfo& device_info);
// Update the information for the device described by |device_info| in the
// |device_map_|.
void UpdateDeviceInfo(const device::mojom::HidDeviceInfo& device_info);
void RunCallback(std::vector<device::mojom::HidDeviceInfoPtr> devices);
void OnDeviceChosen(gin::Arguments* args);
std::vector<blink::mojom::HidDeviceFilterPtr> filters_;
std::vector<blink::mojom::HidDeviceFilterPtr> exclusion_filters_;
content::HidChooser::Callback callback_;
const url::Origin origin_;
const int frame_tree_node_id_;
// The lifetime of the chooser context is tied to the browser context used to
// create it, and may be destroyed while the chooser is still active.
base::WeakPtr<HidChooserContext> chooser_context_;
// Information about connected devices and their HID interfaces. A single
// physical device may expose multiple HID interfaces. Keys are physical
// device IDs, values are collections of HidDeviceInfo objects representing
// the HID interfaces hosted by the physical device.
std::map<std::string, std::vector<device::mojom::HidDeviceInfoPtr>>
device_map_;
// An ordered list of physical device IDs that determines the order of items
// in the chooser.
std::vector<std::string> items_;
base::ScopedObservation<HidChooserContext, HidChooserContext::DeviceObserver>
observation_{this};
base::WeakPtr<ElectronHidDelegate> hid_delegate_;
content::GlobalRenderFrameHostId render_frame_host_id_;
base::WeakPtrFactory<HidChooserController> weak_factory_{this};
};
} // namespace electron
#endif // ELECTRON_SHELL_BROWSER_HID_HID_CHOOSER_CONTROLLER_H_