browser_ppapi_host_impl.h revision a02191e04bc25c4935f804f2c080ae28663d096d
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" 142385ea399aae016c0806a4f9ef3c9cfe3d2a39dfBen Murdoch#include "base/memory/ref_counted.h" 155d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#include "base/memory/weak_ptr.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/browser/renderer_host/pepper/content_browser_pepper_host_factory.h" 17424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)#include "content/browser/renderer_host/pepper/ssl_context_helper.h" 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/common/content_export.h" 19424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles)#include "content/common/pepper_renderer_instance_data.h" 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/browser/browser_ppapi_host.h" 212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "content/public/common/process_type.h" 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ipc/ipc_channel_proxy.h" 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ppapi/host/ppapi_host.h" 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace content { 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class CONTENT_EXPORT BrowserPpapiHostImpl : public BrowserPpapiHost { 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The creator is responsible for calling set_plugin_process_handle as soon 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // as it is known (we start the process asynchronously so it won't be known 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // when this object is created). 322a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // |external_plugin| signfies that this is a proxy created for an embedder's 332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // plugin, i.e. using BrowserPpapiHost::CreateExternalPluginProcess. 34a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch BrowserPpapiHostImpl(IPC::Sender* sender, 35a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch const ppapi::PpapiPermissions& permissions, 36a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch const std::string& plugin_name, 37a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch const base::FilePath& plugin_path, 38a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch const base::FilePath& profile_data_directory, 39a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch bool in_process, 40a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch bool external_plugin); 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~BrowserPpapiHostImpl(); 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // BrowserPpapiHost. 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ppapi::host::PpapiHost* GetPpapiHost() OVERRIDE; 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual base::ProcessHandle GetPluginProcessHandle() const OVERRIDE; 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool IsValidInstance(PP_Instance instance) const OVERRIDE; 47a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch virtual bool GetRenderFrameIDsForInstance(PP_Instance instance, 48a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch int* render_process_id, 49a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch int* render_frame_id) const 50a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch OVERRIDE; 512a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual const std::string& GetPluginName() OVERRIDE; 527d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles) virtual const base::FilePath& GetPluginPath() OVERRIDE; 532a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual const base::FilePath& GetProfileDataDirectory() OVERRIDE; 542a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual GURL GetDocumentURLForInstance(PP_Instance instance) OVERRIDE; 552a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) virtual GURL GetPluginURLForInstance(PP_Instance instance) OVERRIDE; 565d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) virtual void SetOnKeepaliveCallback( 575d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const BrowserPpapiHost::OnKeepaliveCallback& callback) OVERRIDE; 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_plugin_process_handle(base::ProcessHandle handle) { 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) plugin_process_handle_ = handle; 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 638bcbed890bc3ce4d7a057a8f32cab53fa534672eTorne (Richard Coles) bool external_plugin() const { return external_plugin_; } 642a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // These two functions are notifications that an instance has been created 662a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // or destroyed. They allow us to maintain a mapping of PP_Instance to data 672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // associated with the instance including view IDs in the browser process. 682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void AddInstance(PP_Instance instance, 692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const PepperRendererInstanceData& instance_data); 702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void DeleteInstance(PP_Instance instance); 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_refptr<IPC::ChannelProxy::MessageFilter> message_filter() { 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return message_filter_; 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 76424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) const scoped_refptr<SSLContextHelper>& ssl_context_helper() const { 77424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) return ssl_context_helper_; 78424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) } 79424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class BrowserPpapiHostTest; 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Implementing MessageFilter on BrowserPpapiHostImpl makes it ref-counted, 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // preventing us from returning these to embedders without holding a 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // reference. To avoid that, define a message filter object. 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class HostMessageFilter : public IPC::ChannelProxy::MessageFilter { 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 885d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) HostMessageFilter(ppapi::host::PpapiHost* ppapi_host, 895d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) BrowserPpapiHostImpl* browser_ppapi_host_impl); 905d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // IPC::ChannelProxy::MessageFilter. 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool OnMessageReceived(const IPC::Message& msg) OVERRIDE; 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnHostDestroyed(); 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 975d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) virtual ~HostMessageFilter(); 985d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 995d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void OnKeepalive(); 1005d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void OnHostMsgLogInterfaceUsage(int hash) const; 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1025d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Non owning pointers cleared in OnHostDestroyed() 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ppapi::host::PpapiHost* ppapi_host_; 1045d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) BrowserPpapiHostImpl* browser_ppapi_host_impl_; 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1075d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Reports plugin activity to the callback set with SetOnKeepaliveCallback. 1085d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void OnKeepalive(); 1095d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1102a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) scoped_ptr<ppapi::host::PpapiHost> ppapi_host_; 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::ProcessHandle plugin_process_handle_; 1122a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) std::string plugin_name_; 1137d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles) base::FilePath plugin_path_; 1142a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) base::FilePath profile_data_directory_; 1152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1161e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // If true, this refers to a plugin running in the renderer process. 1171e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) bool in_process_; 1181e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) 1192a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // If true, this is an external plugin, i.e. created by the embedder using 1202a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // BrowserPpapiHost::CreateExternalPluginProcess. 1212a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool external_plugin_; 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 123424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) scoped_refptr<SSLContextHelper> ssl_context_helper_; 124424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) 1252a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Tracks all PP_Instances in this plugin and associated renderer-related 1262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // data. 1272a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) typedef std::map<PP_Instance, PepperRendererInstanceData> InstanceMap; 1282a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) InstanceMap instance_map_; 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_refptr<HostMessageFilter> message_filter_; 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1325d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) BrowserPpapiHost::OnKeepaliveCallback on_keepalive_callback_; 1335d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(BrowserPpapiHostImpl); 1355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace content 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // CONTENT_BROWSER_RENDERER_HOST_PEPPER_BROWSER_PPAPI_HOST_IMPL_H_ 140