content/browser/renderer_host/pepper/browser_ppapi_host_impl.h

   1 // Copyright (c) 2012 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_BROWSER_RENDERER_HOST_PEPPER_BROWSER_PPAPI_HOST_IMPL_H_
   6 #define CONTENT_BROWSER_RENDERER_HOST_PEPPER_BROWSER_PPAPI_HOST_IMPL_H_
   7
   8 #include <map>
   9 #include <string>
  10
  11 #include "base/basictypes.h"
  12 #include "base/compiler_specific.h"
  13 #include "base/containers/scoped_ptr_hash_map.h"
  14 #include "base/files/file_path.h"
  15 #include "base/memory/ref_counted.h"
  16 #include "base/memory/weak_ptr.h"
  17 #include "base/observer_list.h"
  18 #include "base/process/process.h"
  19 #include "content/browser/renderer_host/pepper/content_browser_pepper_host_factory.h"
  20 #include "content/browser/renderer_host/pepper/ssl_context_helper.h"
  21 #include "content/common/content_export.h"
  22 #include "content/common/pepper_renderer_instance_data.h"
  23 #include "content/public/browser/browser_ppapi_host.h"
  24 #include "content/public/common/process_type.h"
  25 #include "ipc/message_filter.h"
  26 #include "ppapi/host/ppapi_host.h"
  27
  28 #if !defined(ENABLE_PLUGINS)
  29 #error "Plugins should be enabled"
  30 #endif
  31
  32 namespace content {
  33
  34 class CONTENT_EXPORT BrowserPpapiHostImpl : public BrowserPpapiHost {
  35  public:
  36   class InstanceObserver {
  37    public:
  38     // Called when the plugin instance is throttled or unthrottled because of
  39     // the Plugin Power Saver feature. Invoked on the IO thread.
  40     virtual void OnThrottleStateChanged(bool is_throttled) = 0;
  41
  42     // Called right before the instance is destroyed.
  43     virtual void OnHostDestroyed() = 0;
  44   };
  45
  46   // The creator is responsible for calling set_plugin_process as soon as it is
  47   // known (we start the process asynchronously so it won't be known when this
  48    // object is created).
  49   // |external_plugin| signfies that this is a proxy created for an embedder's
  50   // plugin, i.e. using BrowserPpapiHost::CreateExternalPluginProcess.
  51   BrowserPpapiHostImpl(IPC::Sender* sender,
  52                        const ppapi::PpapiPermissions& permissions,
  53                        const std::string& plugin_name,
  54                        const base::FilePath& plugin_path,
  55                        const base::FilePath& profile_data_directory,
  56                        bool in_process,
  57                        bool external_plugin);
  58   ~BrowserPpapiHostImpl() override;
  59
  60   // BrowserPpapiHost.
  61   ppapi::host::PpapiHost* GetPpapiHost() override;
  62   const base::Process& GetPluginProcess() const override;
  63   bool IsValidInstance(PP_Instance instance) const override;
  64   bool GetRenderFrameIDsForInstance(PP_Instance instance,
  65                                     int* render_process_id,
  66                                     int* render_frame_id) const override;
  67   const std::string& GetPluginName() override;
  68   const base::FilePath& GetPluginPath() override;
  69   const base::FilePath& GetProfileDataDirectory() override;
  70   GURL GetDocumentURLForInstance(PP_Instance instance) override;
  71   GURL GetPluginURLForInstance(PP_Instance instance) override;
  72   void SetOnKeepaliveCallback(
  73       const BrowserPpapiHost::OnKeepaliveCallback& callback) override;
  74
  75   void set_plugin_process(base::Process process) {
  76     plugin_process_ = process.Pass();
  77   }
  78
  79   bool external_plugin() const { return external_plugin_; }
  80
  81   // These two functions are notifications that an instance has been created
  82   // or destroyed. They allow us to maintain a mapping of PP_Instance to data
  83   // associated with the instance including view IDs in the browser process.
  84   void AddInstance(PP_Instance instance,
  85                    const PepperRendererInstanceData& renderer_instance_data);
  86   void DeleteInstance(PP_Instance instance);
  87
  88   void AddInstanceObserver(PP_Instance instance, InstanceObserver* observer);
  89   void RemoveInstanceObserver(PP_Instance instance, InstanceObserver* observer);
  90
  91   void OnThrottleStateChanged(PP_Instance instance, bool is_throttled);
  92   bool IsThrottled(PP_Instance instance) const;
  93
  94   scoped_refptr<IPC::MessageFilter> message_filter() {
  95     return message_filter_;
  96   }
  97
  98   const scoped_refptr<SSLContextHelper>& ssl_context_helper() const {
  99     return ssl_context_helper_;
 100   }
 101
 102  private:
 103   friend class BrowserPpapiHostTest;
 104
 105   // Implementing MessageFilter on BrowserPpapiHostImpl makes it ref-counted,
 106   // preventing us from returning these to embedders without holding a
 107   // reference. To avoid that, define a message filter object.
 108   class HostMessageFilter : public IPC::MessageFilter {
 109    public:
 110     HostMessageFilter(ppapi::host::PpapiHost* ppapi_host,
 111                       BrowserPpapiHostImpl* browser_ppapi_host_impl);
 112
 113     // IPC::MessageFilter.
 114     bool OnMessageReceived(const IPC::Message& msg) override;
 115
 116     void OnHostDestroyed();
 117
 118    private:
 119     ~HostMessageFilter() override;
 120
 121     void OnKeepalive();
 122     void OnHostMsgLogInterfaceUsage(int hash) const;
 123
 124     // Non owning pointers cleared in OnHostDestroyed()
 125     ppapi::host::PpapiHost* ppapi_host_;
 126     BrowserPpapiHostImpl* browser_ppapi_host_impl_;
 127   };
 128
 129   struct InstanceData {
 130     InstanceData(const PepperRendererInstanceData& renderer_data);
 131     ~InstanceData();
 132
 133     PepperRendererInstanceData renderer_data;
 134     bool is_throttled;
 135
 136     ObserverList<InstanceObserver> observer_list;
 137   };
 138
 139   // Reports plugin activity to the callback set with SetOnKeepaliveCallback.
 140   void OnKeepalive();
 141
 142   scoped_ptr<ppapi::host::PpapiHost> ppapi_host_;
 143   base::Process plugin_process_;
 144   std::string plugin_name_;
 145   base::FilePath plugin_path_;
 146   base::FilePath profile_data_directory_;
 147
 148   // If true, this refers to a plugin running in the renderer process.
 149   bool in_process_;
 150
 151   // If true, this is an external plugin, i.e. created by the embedder using
 152   // BrowserPpapiHost::CreateExternalPluginProcess.
 153   bool external_plugin_;
 154
 155   scoped_refptr<SSLContextHelper> ssl_context_helper_;
 156
 157   // Tracks all PP_Instances in this plugin and associated data.
 158   base::ScopedPtrHashMap<PP_Instance, InstanceData> instance_map_;
 159
 160   scoped_refptr<HostMessageFilter> message_filter_;
 161
 162   BrowserPpapiHost::OnKeepaliveCallback on_keepalive_callback_;
 163
 164   DISALLOW_COPY_AND_ASSIGN(BrowserPpapiHostImpl);
 165 };
 166
 167 }  // namespace content
 168
 169 #endif  // CONTENT_BROWSER_RENDERER_HOST_PEPPER_BROWSER_PPAPI_HOST_IMPL_H_