browser_ppapi_host_impl.h revision 2a99a7e74a7f215066514fe81d2bfa6639d9eddd
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved.
25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be
35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file.
45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef CONTENT_BROWSER_RENDERER_HOST_PEPPER_BROWSER_PPAPI_HOST_IMPL_H_
65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CONTENT_BROWSER_RENDERER_HOST_PEPPER_BROWSER_PPAPI_HOST_IMPL_H_
75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <map>
92a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include <string>
105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h"
125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/compiler_specific.h"
132a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/files/file_path.h"
145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/browser/renderer_host/pepper/content_browser_pepper_host_factory.h"
155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/common/content_export.h"
165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/browser/browser_ppapi_host.h"
172a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "content/public/common/process_type.h"
185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ipc/ipc_channel_proxy.h"
195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ppapi/host/ppapi_host.h"
205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace content {
225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)struct PepperRendererInstanceData;
242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)
255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class CONTENT_EXPORT BrowserPpapiHostImpl : public BrowserPpapiHost {
265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public:
275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // The creator is responsible for calling set_plugin_process_handle as soon
285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // as it is known (we start the process asynchronously so it won't be known
295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // when this object is created).
302a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  // |external_plugin| signfies that this is a proxy created for an embedder's
312a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  // plugin, i.e. using BrowserPpapiHost::CreateExternalPluginProcess.
325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  BrowserPpapiHostImpl(IPC::Sender* sender,
332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)                       const ppapi::PpapiPermissions& permissions,
342a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)                       const std::string& plugin_name,
352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)                       const base::FilePath& profile_data_directory,
362a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)                       bool external_plugin);
375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  virtual ~BrowserPpapiHostImpl();
385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // BrowserPpapiHost.
405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  virtual ppapi::host::PpapiHost* GetPpapiHost() OVERRIDE;
415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  virtual base::ProcessHandle GetPluginProcessHandle() const OVERRIDE;
425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  virtual bool IsValidInstance(PP_Instance instance) const OVERRIDE;
435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  virtual bool GetRenderViewIDsForInstance(PP_Instance instance,
445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                           int* render_process_id,
455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                                           int* render_view_id) const OVERRIDE;
462a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  virtual const std::string& GetPluginName() OVERRIDE;
472a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  virtual const base::FilePath& GetProfileDataDirectory() OVERRIDE;
482a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  virtual GURL GetDocumentURLForInstance(PP_Instance instance) OVERRIDE;
492a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  virtual GURL GetPluginURLForInstance(PP_Instance instance) OVERRIDE;
505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  void set_plugin_process_handle(base::ProcessHandle handle) {
525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    plugin_process_handle_ = handle;
535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
552a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  bool external_plugin() { return external_plugin_; }
562a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)
575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // These two functions are notifications that an instance has been created
582a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  // or destroyed. They allow us to maintain a mapping of PP_Instance to data
592a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  // associated with the instance including view IDs in the browser process.
602a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  void AddInstance(PP_Instance instance,
612a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)                   const PepperRendererInstanceData& instance_data);
622a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  void DeleteInstance(PP_Instance instance);
635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  scoped_refptr<IPC::ChannelProxy::MessageFilter> message_filter() {
655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    return message_filter_;
665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private:
695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  friend class BrowserPpapiHostTest;
705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Implementing MessageFilter on BrowserPpapiHostImpl makes it ref-counted,
725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // preventing us from returning these to embedders without holding a
735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // reference. To avoid that, define a message filter object.
745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  class HostMessageFilter : public IPC::ChannelProxy::MessageFilter {
755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)   public:
765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    explicit HostMessageFilter(ppapi::host::PpapiHost* ppapi_host)
775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)        : ppapi_host_(ppapi_host) {}
785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    // IPC::ChannelProxy::MessageFilter.
795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    virtual bool OnMessageReceived(const IPC::Message& msg) OVERRIDE;
805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    void OnHostDestroyed();
825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)   private:
845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    virtual ~HostMessageFilter() {}
855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    ppapi::host::PpapiHost* ppapi_host_;
875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  };
885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
892a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  scoped_ptr<ppapi::host::PpapiHost> ppapi_host_;
905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  base::ProcessHandle plugin_process_handle_;
912a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  std::string plugin_name_;
922a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  base::FilePath profile_data_directory_;
932a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)
942a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  // If true, this is an external plugin, i.e. created by the embedder using
952a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  // BrowserPpapiHost::CreateExternalPluginProcess.
962a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  bool external_plugin_;
975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
982a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  // Tracks all PP_Instances in this plugin and associated renderer-related
992a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  // data.
1002a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  typedef std::map<PP_Instance, PepperRendererInstanceData> InstanceMap;
1012a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  InstanceMap instance_map_;
1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  scoped_refptr<HostMessageFilter> message_filter_;
1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  DISALLOW_COPY_AND_ASSIGN(BrowserPpapiHostImpl);
1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)};
1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}  // namespace content
1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif  // CONTENT_BROWSER_RENDERER_HOST_PEPPER_BROWSER_PPAPI_HOST_IMPL_H_
111