content/renderer/pepper/plugin_power_saver_helper.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 CONTENT_RENDERER_PEPPER_PLUGIN_POWER_SAVER_HELPER_H_
   6 #define CONTENT_RENDERER_PEPPER_PLUGIN_POWER_SAVER_HELPER_H_
   7
   8 #include <set>
   9 #include <vector>
  10
  11 #include "base/callback.h"
  12 #include "content/common/content_export.h"
  13 #include "content/public/renderer/render_frame_observer.h"
  14 #include "url/gurl.h"
  15
  16 namespace blink {
  17 struct WebPluginParams;
  18 struct WebRect;
  19 }
  20
  21 namespace content {
  22
  23 class CONTENT_EXPORT PluginPowerSaverHelper : public RenderFrameObserver {
  24  public:
  25   explicit PluginPowerSaverHelper(RenderFrame* render_frame);
  26   ~PluginPowerSaverHelper() override;
  27
  28   // See RenderFrame for documentation.
  29   void RegisterPeripheralPlugin(const GURL& content_origin,
  30                                 const base::Closure& unthrottle_callback);
  31
  32   // Returns true if this plugin should have power saver enabled.
  33   //
  34   // Power Saver is enabled for plugin content that are cross-origin and
  35   // heuristically determined to be not essential to the web page content.
  36   //
  37   // Plugin content is defined to be cross-origin when the plugin source's
  38   // origin differs from the top level frame's origin. For example:
  39   //  - Cross-origin:  a.com -> b.com/plugin.swf
  40   //  - Cross-origin:  a.com -> b.com/iframe.html -> b.com/plugin.swf
  41   //  - Same-origin:   a.com -> b.com/iframe-to-a.html -> a.com/plugin.swf
  42   //
  43   // |page_frame_url| is the URL of the frame containing the plugin, which may
  44   // be different from the URL of the top level document.
  45   //
  46   // |poster_image| may be NULL. It is set to the absolute URL of the poster
  47   // image if it exists and this method returns true. Otherwise, an empty GURL.
  48   //
  49   // |cross_origin_main_content| may be NULL. It is set to true if the
  50   // plugin content is cross-origin but still the "main attraction" of the page.
  51   bool ShouldThrottleContent(const GURL& content_origin,
  52                              const std::string& plugin_module_name,
  53                              int width,
  54                              int height,
  55                              bool* cross_origin_main_content) const;
  56
  57   // Whitelists a |content_origin| so its content will never be throttled in
  58   // this RenderFrame. Whitelist is cleared by top level navigation.
  59   void WhitelistContentOrigin(const GURL& content_origin);
  60
  61  private:
  62   struct PeripheralPlugin {
  63     PeripheralPlugin(const GURL& content_origin,
  64                      const base::Closure& unthrottle_callback);
  65     ~PeripheralPlugin();
  66
  67     GURL content_origin;
  68     base::Closure unthrottle_callback;
  69   };
  70
  71   enum OverrideForTesting {
  72     Normal,
  73     Never,
  74     IgnoreList,
  75     Always
  76   };
  77
  78   // RenderFrameObserver implementation.
  79   void DidCommitProvisionalLoad(bool is_new_navigation,
  80                                 bool is_same_page_navigation) override;
  81   bool OnMessageReceived(const IPC::Message& message) override;
  82
  83   void OnUpdatePluginContentOriginWhitelist(
  84       const std::set<GURL>& origin_whitelist);
  85
  86   OverrideForTesting override_for_testing_;
  87
  88   // Local copy of the whitelist for the entire tab.
  89   std::set<GURL> origin_whitelist_;
  90
  91   // Set of peripheral plugins eligible to be unthrottled ex post facto.
  92   std::vector<PeripheralPlugin> peripheral_plugins_;
  93
  94   DISALLOW_COPY_AND_ASSIGN(PluginPowerSaverHelper);
  95 };
  96
  97 }  // namespace content
  98
  99 #endif  // CONTENT_RENDERER_PEPPER_PLUGIN_POWER_SAVER_HELPER_H_