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
212
213
214
215
216
217
218
219
220
|
// Copyright (c) 2012 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.
// Defines the Chrome Extensions WebNavigation API functions for observing and
// intercepting navigation events, as specified in the extension JSON API.
#ifndef CHROME_BROWSER_EXTENSIONS_API_WEB_NAVIGATION_WEB_NAVIGATION_API_H_
#define CHROME_BROWSER_EXTENSIONS_API_WEB_NAVIGATION_WEB_NAVIGATION_API_H_
#include <map>
#include <set>
#include "base/compiler_specific.h"
#include "base/macros.h"
#include "chrome/browser/extensions/api/web_navigation/frame_navigation_state.h"
#include "chrome/browser/extensions/chrome_extension_function.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/ui/browser_tab_strip_tracker.h"
#include "chrome/browser/ui/browser_tab_strip_tracker_delegate.h"
#include "chrome/browser/ui/tabs/tab_strip_model.h"
#include "content/public/browser/notification_observer.h"
#include "content/public/browser/notification_registrar.h"
#include "content/public/browser/web_contents_observer.h"
#include "content/public/browser/web_contents_user_data.h"
#include "extensions/browser/browser_context_keyed_api_factory.h"
#include "extensions/browser/event_router.h"
#include "url/gurl.h"
struct RetargetingDetails;
namespace extensions {
// Tab contents observer that forwards navigation events to the event router.
class WebNavigationTabObserver
: public content::WebContentsObserver,
public content::WebContentsUserData<WebNavigationTabObserver> {
public:
~WebNavigationTabObserver() override;
// Returns the object for the given |web_contents|.
static WebNavigationTabObserver* Get(content::WebContents* web_contents);
const FrameNavigationState& frame_navigation_state() const {
return navigation_state_;
}
// content::WebContentsObserver implementation.
void RenderFrameDeleted(content::RenderFrameHost* render_frame_host) override;
void FrameDeleted(content::RenderFrameHost* render_frame_host) override;
void RenderFrameHostChanged(content::RenderFrameHost* old_host,
content::RenderFrameHost* new_host) override;
void DidStartNavigation(
content::NavigationHandle* navigation_handle) override;
void DidFinishNavigation(
content::NavigationHandle* navigation_handle) override;
void DocumentLoadedInFrame(
content::RenderFrameHost* render_frame_host) override;
void DidFinishLoad(content::RenderFrameHost* render_frame_host,
const GURL& validated_url) override;
void DidFailLoad(content::RenderFrameHost* render_frame_host,
const GURL& validated_url,
int error_code,
const base::string16& error_description,
bool was_ignored_by_handler) override;
void DidOpenRequestedURL(content::WebContents* new_contents,
content::RenderFrameHost* source_render_frame_host,
const GURL& url,
const content::Referrer& referrer,
WindowOpenDisposition disposition,
ui::PageTransition transition) override;
void WebContentsDestroyed() override;
private:
explicit WebNavigationTabObserver(content::WebContents* web_contents);
friend class content::WebContentsUserData<WebNavigationTabObserver>;
void HandleCommit(content::NavigationHandle* navigation_handle);
void HandleError(content::NavigationHandle* navigation_handle);
// True if the transition and target url correspond to a reference fragment
// navigation.
bool IsReferenceFragmentNavigation(content::RenderFrameHost* frame_host,
const GURL& url);
// Creates and sends onErrorOccurred events for all on-going navigations. If
// |render_view_host| is non-NULL, only generates events for frames in this
// render view host. If |frame_host_to_skip| is given, no events are sent for
// that
// frame.
void SendErrorEvents(content::WebContents* web_contents,
content::RenderViewHost* render_view_host,
content::RenderFrameHost* frame_host_to_skip);
// Tracks the state of the frames we are sending events for.
FrameNavigationState navigation_state_;
// Used for tracking registrations to redirect notifications.
content::NotificationRegistrar registrar_;
DISALLOW_COPY_AND_ASSIGN(WebNavigationTabObserver);
};
// Observes navigation notifications and routes them as events to the extension
// system.
class WebNavigationEventRouter : public TabStripModelObserver,
public BrowserTabStripTrackerDelegate,
public content::NotificationObserver {
public:
explicit WebNavigationEventRouter(Profile* profile);
~WebNavigationEventRouter() override;
private:
// Used to cache the information about newly created WebContents objects.
struct PendingWebContents{
PendingWebContents();
PendingWebContents(content::WebContents* source_web_contents,
content::RenderFrameHost* source_frame_host,
content::WebContents* target_web_contents,
const GURL& target_url);
~PendingWebContents();
content::WebContents* source_web_contents;
content::RenderFrameHost* source_frame_host;
content::WebContents* target_web_contents;
GURL target_url;
};
// BrowserTabStripTrackerDelegate implementation.
bool ShouldTrackBrowser(Browser* browser) override;
// TabStripModelObserver implementation.
void TabReplacedAt(TabStripModel* tab_strip_model,
content::WebContents* old_contents,
content::WebContents* new_contents,
int index) override;
// content::NotificationObserver implementation.
void Observe(int type,
const content::NotificationSource& source,
const content::NotificationDetails& details) override;
// Handler for the NOTIFICATION_RETARGETING event. The method takes the
// details of such an event and stores them for the later
// NOTIFICATION_TAB_ADDED event.
void Retargeting(const RetargetingDetails* details);
// Handler for the NOTIFICATION_TAB_ADDED event. The method takes the details
// of such an event and creates a JSON formated extension event from it.
void TabAdded(content::WebContents* tab);
// Handler for NOTIFICATION_WEB_CONTENTS_DESTROYED. If |tab| is in
// |pending_web_contents_|, it is removed.
void TabDestroyed(content::WebContents* tab);
// Mapping pointers to WebContents objects to information about how they got
// created.
std::map<content::WebContents*, PendingWebContents> pending_web_contents_;
// Used for tracking registrations to navigation notifications.
content::NotificationRegistrar registrar_;
// The profile that owns us via ExtensionService.
Profile* profile_;
BrowserTabStripTracker browser_tab_strip_tracker_;
DISALLOW_COPY_AND_ASSIGN(WebNavigationEventRouter);
};
// API function that returns the state of a given frame.
class WebNavigationGetFrameFunction : public ChromeSyncExtensionFunction {
~WebNavigationGetFrameFunction() override {}
bool RunSync() override;
DECLARE_EXTENSION_FUNCTION("webNavigation.getFrame", WEBNAVIGATION_GETFRAME)
};
// API function that returns the states of all frames in a given tab.
class WebNavigationGetAllFramesFunction : public ChromeSyncExtensionFunction {
~WebNavigationGetAllFramesFunction() override {}
bool RunSync() override;
DECLARE_EXTENSION_FUNCTION("webNavigation.getAllFrames",
WEBNAVIGATION_GETALLFRAMES)
};
class WebNavigationAPI : public BrowserContextKeyedAPI,
public extensions::EventRouter::Observer {
public:
explicit WebNavigationAPI(content::BrowserContext* context);
~WebNavigationAPI() override;
// KeyedService implementation.
void Shutdown() override;
// BrowserContextKeyedAPI implementation.
static BrowserContextKeyedAPIFactory<WebNavigationAPI>* GetFactoryInstance();
// EventRouter::Observer implementation.
void OnListenerAdded(const extensions::EventListenerInfo& details) override;
private:
friend class BrowserContextKeyedAPIFactory<WebNavigationAPI>;
content::BrowserContext* browser_context_;
// BrowserContextKeyedAPI implementation.
static const char* service_name() {
return "WebNavigationAPI";
}
static const bool kServiceIsNULLWhileTesting = true;
// Created lazily upon OnListenerAdded.
scoped_ptr<WebNavigationEventRouter> web_navigation_event_router_;
DISALLOW_COPY_AND_ASSIGN(WebNavigationAPI);
};
} // namespace extensions
#endif // CHROME_BROWSER_EXTENSIONS_API_WEB_NAVIGATION_WEB_NAVIGATION_API_H_
|
