forked from chromium/chromium
-
Notifications
You must be signed in to change notification settings - Fork 0
/
popup_blocker_tab_helper.h
109 lines (79 loc) · 3.6 KB
/
popup_blocker_tab_helper.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
// Copyright 2013 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_BLOCKED_CONTENT_POPUP_BLOCKER_TAB_HELPER_H_
#define COMPONENTS_BLOCKED_CONTENT_POPUP_BLOCKER_TAB_HELPER_H_
#include <stddef.h>
#include <stdint.h>
#include <map>
#include <memory>
#include "components/blocked_content/popup_blocker.h"
#include "components/blocked_content/url_list_manager.h"
#include "content/public/browser/web_contents_observer.h"
#include "content/public/browser/web_contents_user_data.h"
#include "ui/base/window_open_disposition.h"
#include "url/gurl.h"
namespace blocked_content {
class PopupNavigationDelegate;
// Per-tab class to manage blocked popups.
class PopupBlockerTabHelper
: public content::WebContentsObserver,
public content::WebContentsUserData<PopupBlockerTabHelper> {
public:
// Mapping from popup IDs to blocked popup requests.
typedef std::map<int32_t, GURL> PopupIdMap;
// This enum is backed by a histogram. Make sure enums.xml is updated if this
// is updated.
enum class Action : int {
// A popup was initiated and was sent to the popup blocker for
// consideration.
kInitiated = 0,
// A popup was blocked by the popup blocker.
kBlocked = 1,
// A previously blocked popup was clicked through. For popups blocked
// without a user gesture.
kClickedThroughNoGesture = 2,
// A previously blocked popup was clicked through. For popups blocked
// due to the abusive popup blocker.
kClickedThroughAbusive = 3,
// Add new elements before this value.
kMaxValue = kClickedThroughAbusive
};
PopupBlockerTabHelper(const PopupBlockerTabHelper&) = delete;
PopupBlockerTabHelper& operator=(const PopupBlockerTabHelper&) = delete;
~PopupBlockerTabHelper() override;
// Returns the number of blocked popups.
size_t GetBlockedPopupsCount() const;
PopupIdMap GetBlockedPopupRequests();
// Creates the blocked popup with |popup_id| in given |dispostion|.
// Note that if |disposition| is WindowOpenDisposition::CURRENT_TAB,
// blocked popup will be opened as it was specified by renderer.
void ShowBlockedPopup(int32_t popup_id, WindowOpenDisposition disposition);
// All blocked popups will be opened with the disposition defaulted to
// WindowOpenDisposition::CURRENT_TAB. Used only on Android.
void ShowAllBlockedPopups();
// Adds a new blocked popup to the UI.
void AddBlockedPopup(std::unique_ptr<PopupNavigationDelegate> delegate,
const blink::mojom::WindowFeatures& window_features,
PopupBlockType block_type);
// content::WebContentsObserver overrides:
void DidFinishNavigation(
content::NavigationHandle* navigation_handle) override;
// Logs a histogram measuring popup blocker actions.
static void LogAction(Action action);
blocked_content::UrlListManager* manager() { return &manager_; }
private:
struct BlockedRequest;
friend class content::WebContentsUserData<PopupBlockerTabHelper>;
explicit PopupBlockerTabHelper(content::WebContents* web_contents);
// Called when the blocked popup notification is hidden.
void HidePopupNotification();
blocked_content::UrlListManager manager_;
// Note, this container should be sorted based on the position in the popup
// list, so it is keyed by an id which is continually increased.
std::map<int32_t, std::unique_ptr<BlockedRequest>> blocked_popups_;
int32_t next_id_ = 0;
WEB_CONTENTS_USER_DATA_KEY_DECL();
};
} // namespace blocked_content
#endif // COMPONENTS_BLOCKED_CONTENT_POPUP_BLOCKER_TAB_HELPER_H_