extensions/renderer/programmatic_script_injector.h

   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
   3 // found in the LICENSE file.
   4
   5 #ifndef EXTENSIONS_RENDERER_PROGRAMMATIC_SCRIPT_INJECTOR_H_
   6 #define EXTENSIONS_RENDERER_PROGRAMMATIC_SCRIPT_INJECTOR_H_
   7
   8 #include "base/macros.h"
   9 #include "base/memory/scoped_ptr.h"
  10 #include "extensions/renderer/script_injection.h"
  11 #include "url/gurl.h"
  12
  13 struct ExtensionMsg_ExecuteCode_Params;
  14
  15 namespace blink {
  16 class WebFrame;
  17 }
  18
  19 namespace content {
  20 class RenderView;
  21 }
  22
  23 namespace extensions {
  24
  25 // A ScriptInjector to handle tabs.executeScript().
  26 class ProgrammaticScriptInjector : public ScriptInjector {
  27  public:
  28   ProgrammaticScriptInjector(const ExtensionMsg_ExecuteCode_Params& params,
  29                              blink::WebFrame* web_frame);
  30   ~ProgrammaticScriptInjector() override;
  31
  32  private:
  33   // ScriptInjector implementation.
  34   UserScript::InjectionType script_type() const override;
  35   bool ShouldExecuteInChildFrames() const override;
  36   bool ShouldExecuteInMainWorld() const override;
  37   bool IsUserGesture() const override;
  38   bool ExpectsResults() const override;
  39   bool ShouldInjectJs(UserScript::RunLocation run_location) const override;
  40   bool ShouldInjectCss(UserScript::RunLocation run_location) const override;
  41   PermissionsData::AccessType CanExecuteOnFrame(
  42       const InjectionHost* injection_host,
  43       blink::WebFrame* web_frame,
  44       int tab_id,
  45       const GURL& top_url) const override;
  46   std::vector<blink::WebScriptSource> GetJsSources(
  47       UserScript::RunLocation run_location) const override;
  48   std::vector<std::string> GetCssSources(
  49       UserScript::RunLocation run_location) const override;
  50   void OnInjectionComplete(scoped_ptr<base::ListValue> execution_results,
  51                            ScriptsRunInfo* scripts_run_info,
  52                            UserScript::RunLocation run_location) override;
  53   void OnWillNotInject(InjectFailureReason reason) override;
  54
  55   // Return the run location for this injector.
  56   UserScript::RunLocation GetRunLocation() const;
  57
  58   // Notify the browser that the script was injected (or never will be), and
  59   // send along any results or errors.
  60   void Finish(const std::string& error);
  61
  62   // The parameters for injecting the script.
  63   scoped_ptr<ExtensionMsg_ExecuteCode_Params> params_;
  64
  65   // The url of the frame into which we are injecting.
  66   GURL url_;
  67
  68   // The RenderView to which we send the response upon completion.
  69   content::RenderView* render_view_;
  70
  71   // The results of the script execution.
  72   scoped_ptr<base::ListValue> results_;
  73
  74   // Whether or not this script injection has finished.
  75   bool finished_;
  76
  77   DISALLOW_COPY_AND_ASSIGN(ProgrammaticScriptInjector);
  78 };
  79
  80 }  // namespace extensions
  81
  82 #endif  // EXTENSIONS_RENDERER_PROGRAMMATIC_SCRIPT_INJECTOR_H_