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
|
// Copyright 2014 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 EXTENSIONS_BROWSER_EXTENSION_WEB_CONTENTS_OBSERVER_H_
#define EXTENSIONS_BROWSER_EXTENSION_WEB_CONTENTS_OBSERVER_H_
#include <string>
#include "base/compiler_specific.h"
#include "base/macros.h"
#include "content/public/browser/web_contents_observer.h"
#include "extensions/browser/extension_function_dispatcher.h"
namespace content {
class BrowserContext;
class RenderViewHost;
class WebContents;
}
namespace extensions {
class Extension;
// A web contents observer used for renderer and extension processes. Grants the
// renderer access to certain URL scheme patterns for extensions and notifies
// the renderer that the extension was loaded.
//
// Extension system embedders must create an instance for every extension
// WebContents. It must be a subclass so that creating an instance via
// content::WebContentsUserData::CreateForWebContents() provides an object of
// the correct type. For an example, see ChromeExtensionWebContentsObserver.
//
// This class is responsible for maintaining the registrations of extension
// frames with the ProcessManager. Only frames in an extension process are
// registered. If out-of-process frames are enabled, every frame hosts a
// chrome-extension: page. Otherwise non-extension frames may erroneously be
// registered, but only briefly until they are correctly classified. This is
// achieved using the following notifications:
// 1. RenderFrameCreated - registers all new frames in extension processes.
// 2. DidCommitProvisionalLoadForFrame - unregisters non-extension frames.
// 3. DidNavigateAnyFrame - registers extension frames if they had been
// unregistered.
//
// Without OOPIF, non-extension frames created by the Chrome extension are also
// registered at RenderFrameCreated. When the non-extension page is committed,
// we detect that the unexpected URL and unregister the frame.
// With OOPIF only the first notification is sufficient in most cases, except
// for sandboxed frames with a unique origin.
class ExtensionWebContentsObserver
: public content::WebContentsObserver,
public ExtensionFunctionDispatcher::Delegate {
public:
// Returns the ExtensionWebContentsObserver for the given |web_contents|.
static ExtensionWebContentsObserver* GetForWebContents(
content::WebContents* web_contents);
ExtensionFunctionDispatcher* dispatcher() { return &dispatcher_; }
protected:
explicit ExtensionWebContentsObserver(content::WebContents* web_contents);
~ExtensionWebContentsObserver() override;
content::BrowserContext* browser_context() { return browser_context_; }
// Initializes a new render frame. Subclasses should invoke this
// implementation if extending.
virtual void InitializeRenderFrame(
content::RenderFrameHost* render_frame_host);
// ExtensionFunctionDispatcher::Delegate overrides.
content::WebContents* GetAssociatedWebContents() const override;
// content::WebContentsObserver overrides.
// A subclass should invoke this method to finish extension process setup.
void RenderViewCreated(content::RenderViewHost* render_view_host) override;
void RenderFrameCreated(content::RenderFrameHost* render_frame_host) override;
void RenderFrameDeleted(content::RenderFrameHost* render_frame_host) override;
void DidCommitProvisionalLoadForFrame(
content::RenderFrameHost* render_frame_host,
const GURL& url,
ui::PageTransition transition_type) override;
void DidNavigateAnyFrame(content::RenderFrameHost* render_frame_host,
const content::LoadCommittedDetails& details,
const content::FrameNavigateParams& params) override;
// Subclasses should call this first before doing their own message handling.
bool OnMessageReceived(const IPC::Message& message,
content::RenderFrameHost* render_frame_host) override;
// Per the documentation in WebContentsObserver, these two methods are invoked
// when a Pepper plugin instance is attached/detached in the page DOM.
void PepperInstanceCreated() override;
void PepperInstanceDeleted() override;
// Returns the extension id associated with the given |render_frame_host|, or
// the empty string if there is none.
std::string GetExtensionIdFromFrame(
content::RenderFrameHost* render_frame_host) const;
// Returns the extension associated with the given |render_frame_host|, or
// null if there is none.
// If |verify_url| is false, only the SiteInstance is taken into account.
// If |verify_url| is true, the frame's last committed URL is also used to
// improve the classification of the frame.
const Extension* GetExtensionFromFrame(
content::RenderFrameHost* render_frame_host,
bool verify_url) const;
// TODO(devlin): Remove these once callers are updated to use the FromFrame
// equivalents.
// Returns the extension or app associated with a render view host. Returns
// NULL if the render view host is not for a valid extension.
const Extension* GetExtension(content::RenderViewHost* render_view_host);
// Returns the extension or app ID associated with a render view host. Returns
// the empty string if the render view host is not for a valid extension.
static std::string GetExtensionId(content::RenderViewHost* render_view_host);
private:
void OnRequest(content::RenderFrameHost* render_frame_host,
const ExtensionHostMsg_Request_Params& params);
// A helper function for initializing render frames at the creation of the
// observer.
void InitializeFrameHelper(content::RenderFrameHost* render_frame_host);
// The BrowserContext associated with the WebContents being observed.
content::BrowserContext* browser_context_;
ExtensionFunctionDispatcher dispatcher_;
DISALLOW_COPY_AND_ASSIGN(ExtensionWebContentsObserver);
};
} // namespace extensions
#endif // EXTENSIONS_BROWSER_EXTENSION_WEB_CONTENTS_OBSERVER_H_
|
