1 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef CHROME_BROWSER_EXTENSIONS_API_EXECUTE_CODE_FUNCTION_H_
6 #define CHROME_BROWSER_EXTENSIONS_API_EXECUTE_CODE_FUNCTION_H_
8 #include "chrome/browser/extensions/chrome_extension_function.h"
9 #include "chrome/common/extensions/api/tabs.h"
10 #include "extensions/browser/script_executor.h"
12 namespace extensions {
14 // Base class for javascript code injection.
15 // This is used by both chrome.webview.executeScript and
16 // chrome.tabs.executeScript.
17 class ExecuteCodeFunction : public ChromeAsyncExtensionFunction {
19 ExecuteCodeFunction();
22 virtual ~ExecuteCodeFunction();
24 // ExtensionFunction implementation.
25 virtual bool HasPermission() OVERRIDE;
26 virtual bool RunAsync() OVERRIDE;
28 // Initialize |details_| if it hasn't already been.
29 virtual bool Init() = 0;
30 virtual bool ShouldInsertCSS() const = 0;
31 virtual bool CanExecuteScriptOnPage() = 0;
32 virtual ScriptExecutor* GetScriptExecutor() = 0;
33 virtual bool IsWebView() const = 0;
34 virtual const GURL& GetWebViewSrc() const = 0;
35 virtual void OnExecuteCodeFinished(const std::string& error,
37 const base::ListValue& result);
39 // The injection details.
40 scoped_ptr<api::tabs::InjectDetails> details_;
43 // Called when contents from the file whose path is specified in JSON
44 // arguments has been loaded.
45 void DidLoadFile(bool success, const std::string& data);
47 // Runs on FILE thread. Loads message bundles for the extension and
48 // localizes the CSS data. Calls back DidLoadAndLocalizeFile on the UI thread.
49 void GetFileURLAndLocalizeCSS(
50 ScriptExecutor::ScriptType script_type,
51 const std::string& data,
52 const std::string& extension_id,
53 const base::FilePath& extension_path,
54 const std::string& extension_default_locale);
56 // Called when contents from the loaded file have been localized.
57 void DidLoadAndLocalizeFile(bool success, const std::string& data);
59 // Run in UI thread. Code string contains the code to be executed. Returns
60 // true on success. If true is returned, this does an AddRef.
61 bool Execute(const std::string& code_string);
63 // Contains extension resource built from path of file which is
64 // specified in JSON arguments.
65 ExtensionResource resource_;
67 // The URL of the file being injected into the page.
71 } // namespace extensions
73 #endif // CHROME_BROWSER_EXTENSIONS_API_EXECUTE_CODE_FUNCTION_H_