OLD | NEW |
---|---|
1 // Copyright 2014 The Chromium Authors. All rights reserved. | 1 // Copyright 2014 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef EXTENSIONS_RENDERER_SCRIPT_INJECTION_H_ | 5 #ifndef EXTENSIONS_RENDERER_SCRIPT_INJECTION_H_ |
6 #define EXTENSIONS_RENDERER_SCRIPT_INJECTION_H_ | 6 #define EXTENSIONS_RENDERER_SCRIPT_INJECTION_H_ |
7 | 7 |
8 #include "base/basictypes.h" | 8 #include "base/basictypes.h" |
9 #include "base/macros.h" | 9 #include "base/macros.h" |
10 #include "extensions/common/user_script.h" | 10 #include "extensions/common/user_script.h" |
11 #include "extensions/renderer/script_injector.h" | 11 #include "extensions/renderer/script_injector.h" |
12 | 12 |
13 namespace blink { | 13 namespace blink { |
14 class WebLocalFrame; | 14 class WebLocalFrame; |
15 } | 15 } |
16 | 16 |
17 namespace extensions { | 17 namespace extensions { |
18 class Extension; | |
19 struct ScriptsRunInfo; | 18 struct ScriptsRunInfo; |
20 | 19 |
21 // A script wrapper which is aware of whether or not it is allowed to execute, | 20 // A script wrapper which is aware of whether or not it is allowed to execute, |
22 // and contains the implementation to do so. | 21 // and contains the implementation to do so. |
23 class ScriptInjection { | 22 class ScriptInjection { |
24 public: | 23 public: |
25 // Return the id of the extension associated with the given world. | 24 // Return the id of the host associated with the given world. |
26 static std::string GetExtensionIdForIsolatedWorld(int world_id); | 25 static HostID GetHostIdForIsolatedWorld(int world_id); |
27 | 26 |
28 // Remove the isolated world associated with the given extension. | 27 // Remove the isolated world associated with the given host. |
29 static void RemoveIsolatedWorld(const std::string& extension_id); | 28 static void RemoveIsolatedWorld(const std::string& host_id); |
30 | 29 |
31 ScriptInjection(scoped_ptr<ScriptInjector> injector, | 30 ScriptInjection(scoped_ptr<ScriptInjector> injector, |
32 blink::WebLocalFrame* web_frame, | 31 blink::WebLocalFrame* web_frame, |
33 const std::string& extension_id, | 32 const HostID& host_id, |
33 int instance_id, | |
34 UserScript::RunLocation run_location, | 34 UserScript::RunLocation run_location, |
35 int tab_id); | 35 int tab_id); |
36 ~ScriptInjection(); | 36 ~ScriptInjection(); |
37 | 37 |
38 // Try to inject the script at the |current_location|. This returns true if | 38 // Try to inject the script at the |current_location|. This returns true if |
39 // the script has either injected or will never inject (i.e., if the object | 39 // the script has either injected or will never inject (i.e., if the object |
40 // is done), and false if injection is delayed (either for permission purposes | 40 // is done), and false if injection is delayed (either for permission purposes |
41 // or because |current_location| is not the designated |run_location_|). | 41 // or because |current_location| is not the designated |run_location_|). |
42 // NOTE: |extension| may be NULL, if the extension is removed! | 42 // NOTE: |host| may be NULL, if the host is removed! |
43 bool TryToInject(UserScript::RunLocation current_location, | 43 bool TryToInject(UserScript::RunLocation current_location, |
44 const Extension* extension, | 44 const Host* host, |
45 ScriptsRunInfo* scripts_run_info); | 45 ScriptsRunInfo* scripts_run_info); |
46 | 46 |
47 // Called when permission for the given injection has been granted. | 47 // Called when permission for the given injection has been granted. |
48 // Returns true if the injection ran. | 48 // Returns true if the injection ran. |
49 bool OnPermissionGranted(const Extension* extension, | 49 bool OnPermissionGranted(const Host* host, |
50 ScriptsRunInfo* scripts_run_info); | 50 ScriptsRunInfo* scripts_run_info); |
51 | 51 |
52 // Accessors. | 52 // Accessors. |
53 blink::WebLocalFrame* web_frame() const { return web_frame_; } | 53 blink::WebLocalFrame* web_frame() const { return web_frame_; } |
54 const std::string& extension_id() const { return extension_id_; } | 54 const HostID& host_id() const { return host_id_; } |
55 int64 request_id() const { return request_id_; } | 55 int64 request_id() const { return request_id_; } |
56 | 56 |
57 private: | 57 private: |
58 // Send a message to the browser requesting permission to execute. | 58 // Send a message to the browser requesting permission to execute. |
59 void RequestPermission(); | 59 void RequestPermission(); |
60 | 60 |
61 // Injects the script, optionally populating |scripts_run_info|. | 61 // Injects the script, optionally populating |scripts_run_info|. |
62 void Inject(const Extension* extension, ScriptsRunInfo* scripts_run_info); | 62 void Inject(const Host* host, ScriptsRunInfo* scripts_run_info); |
63 | 63 |
64 // Inject any JS scripts into the |frame|, optionally populating | 64 // Inject any JS scripts into the |frame|, optionally populating |
65 // |execution_results|. | 65 // |execution_results|. |
66 void InjectJs(const Extension* extension, | 66 void InjectJs(const Host* host, |
67 blink::WebLocalFrame* frame, | 67 blink::WebLocalFrame* frame, |
68 base::ListValue* execution_results); | 68 base::ListValue* execution_results); |
69 | 69 |
70 // Inject any CSS source into the |frame|. | 70 // Inject any CSS source into the |frame|. |
71 void InjectCss(blink::WebLocalFrame* frame); | 71 void InjectCss(blink::WebLocalFrame* frame); |
72 | 72 |
73 // Notify that we will not inject, and mark it as acknowledged. | 73 // Notify that we will not inject, and mark it as acknowledged. |
74 void NotifyWillNotInject(ScriptInjector::InjectFailureReason reason); | 74 void NotifyWillNotInject(ScriptInjector::InjectFailureReason reason); |
75 | 75 |
76 // The injector for this injection. | 76 // The injector for this injection. |
77 scoped_ptr<ScriptInjector> injector_; | 77 scoped_ptr<ScriptInjector> injector_; |
78 | 78 |
79 // The (main) WebFrame into which this should inject the script. | 79 // The (main) WebFrame into which this should inject the script. |
80 blink::WebLocalFrame* web_frame_; | 80 blink::WebLocalFrame* web_frame_; |
81 | 81 |
82 // The id of the associated extension. | 82 // The id of the associated host. |
83 std::string extension_id_; | 83 HostID host_id_; |
84 | |
85 // The id of the instance on which the host will inject the script. | |
86 // If the instance is a regular tab, the |instance_id| is 0; | |
87 // If the instance is a <webview>, the |instance_id| is a unique positive | |
Devlin
2015/02/04 17:01:14
nit: lowercase "if" and fix line wrapping.
Xi Han
2015/02/05 16:06:20
Done.
| |
88 // number. | |
89 int instance_id_; | |
84 | 90 |
85 // The location in the document load at which we inject the script. | 91 // The location in the document load at which we inject the script. |
86 UserScript::RunLocation run_location_; | 92 UserScript::RunLocation run_location_; |
87 | 93 |
88 // The tab id associated with the frame. | 94 // The tab id associated with the frame. |
89 int tab_id_; | 95 int tab_id_; |
90 | 96 |
91 // This injection's request id. This will be -1 unless the injection is | 97 // This injection's request id. This will be -1 unless the injection is |
92 // currently waiting on permission. | 98 // currently waiting on permission. |
93 int64 request_id_; | 99 int64 request_id_; |
94 | 100 |
95 // Whether or not the injection is complete, either via injecting the script | 101 // Whether or not the injection is complete, either via injecting the script |
96 // or because it will never complete. | 102 // or because it will never complete. |
97 bool complete_; | 103 bool complete_; |
98 | 104 |
99 DISALLOW_COPY_AND_ASSIGN(ScriptInjection); | 105 DISALLOW_COPY_AND_ASSIGN(ScriptInjection); |
100 }; | 106 }; |
101 | 107 |
102 } // namespace extensions | 108 } // namespace extensions |
103 | 109 |
104 #endif // EXTENSIONS_RENDERER_SCRIPT_INJECTION_H_ | 110 #endif // EXTENSIONS_RENDERER_SCRIPT_INJECTION_H_ |
OLD | NEW |