blob: 4b6976d31a3a517db169b5ce3bf8e8895f0af109 [file] [log] [blame]
[email protected]3b48dbc2012-01-06 16:34:171// Copyright (c) 2012 The Chromium Authors. All rights reserved.
[email protected]a0421732011-02-23 03:55:402// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5// This class responds to requests from renderers for the list of plugins, and
6// also a proxy object for plugin instances.
7
[email protected]e67385f2011-12-21 06:00:568#ifndef CONTENT_BROWSER_PLUGIN_SERVICE_IMPL_H_
9#define CONTENT_BROWSER_PLUGIN_SERVICE_IMPL_H_
[email protected]a0421732011-02-23 03:55:4010#pragma once
11
[email protected]47214d882012-02-29 06:28:4812#include <map>
[email protected]7dba43dc2011-11-10 01:57:5813#include <set>
[email protected]47214d882012-02-29 06:28:4814#include <vector>
[email protected]a0421732011-02-23 03:55:4015
16#include "base/basictypes.h"
[email protected]bdd6deb2011-12-21 03:03:2417#include "base/compiler_specific.h"
[email protected]3b63f8f42011-03-28 01:54:1518#include "base/memory/scoped_vector.h"
19#include "base/memory/singleton.h"
[email protected]a0421732011-02-23 03:55:4020#include "base/synchronization/waitable_event_watcher.h"
[email protected]47214d882012-02-29 06:28:4821#include "base/time.h"
[email protected]a0421732011-02-23 03:55:4022#include "build/build_config.h"
[email protected]a0421732011-02-23 03:55:4023#include "content/browser/plugin_process_host.h"
24#include "content/browser/ppapi_plugin_process_host.h"
[email protected]8d128d62011-09-13 22:11:5725#include "content/common/content_export.h"
[email protected]6c2381d2011-10-19 02:52:5326#include "content/public/browser/notification_observer.h"
27#include "content/public/browser/notification_registrar.h"
[email protected]3a5180ae2011-12-21 02:39:3828#include "content/public/browser/plugin_service.h"
[email protected]a0421732011-02-23 03:55:4029#include "googleurl/src/gurl.h"
30#include "ipc/ipc_channel_handle.h"
[email protected]a0421732011-02-23 03:55:4031
32#if defined(OS_WIN)
[email protected]3b63f8f42011-03-28 01:54:1533#include "base/memory/scoped_ptr.h"
[email protected]a0421732011-02-23 03:55:4034#include "base/win/registry.h"
35#endif
36
[email protected]3b48dbc2012-01-06 16:34:1737#if defined(OS_POSIX) && !defined(OS_OPENBSD)
[email protected]493c8002011-04-14 16:56:0138#include "base/files/file_path_watcher.h"
[email protected]a0421732011-02-23 03:55:4039#endif
40
[email protected]a0421732011-02-23 03:55:4041class PluginDirWatcherDelegate;
[email protected]d4af1e72011-10-21 17:45:4342class PluginLoaderPosix;
[email protected]a0421732011-02-23 03:55:4043
[email protected]d33e7cc2011-09-23 01:43:5644namespace base {
45class MessageLoopProxy;
46}
47
[email protected]dfba8762011-09-02 12:49:5448namespace content {
[email protected]45a22e62011-10-12 09:48:0249class BrowserContext;
[email protected]dfba8762011-09-02 12:49:5450class ResourceContext;
[email protected]738a7212011-10-21 17:33:5251struct PepperPluginInfo;
[email protected]dfba8762011-09-02 12:49:5452class PluginServiceFilter;
[email protected]88ca4912011-10-12 14:00:4353struct PluginServiceFilterParams;
[email protected]dfba8762011-09-02 12:49:5454}
55
[email protected]d33e7cc2011-09-23 01:43:5656namespace webkit {
57namespace npapi {
58class PluginGroup;
59class PluginList;
60}
61}
62
[email protected]e67385f2011-12-21 06:00:5663class CONTENT_EXPORT PluginServiceImpl
[email protected]bdd6deb2011-12-21 03:03:2464 : NON_EXPORTED_BASE(public content::PluginService),
[email protected]3a5180ae2011-12-21 02:39:3865 public base::WaitableEventWatcher::Delegate,
[email protected]6c2381d2011-10-19 02:52:5366 public content::NotificationObserver {
[email protected]a0421732011-02-23 03:55:4067 public:
[email protected]e67385f2011-12-21 06:00:5668 // Returns the PluginServiceImpl singleton.
69 static PluginServiceImpl* GetInstance();
[email protected]a0421732011-02-23 03:55:4070
[email protected]3a5180ae2011-12-21 02:39:3871 // content::PluginService implementation:
72 virtual void Init() OVERRIDE;
73 virtual void StartWatchingPlugins() OVERRIDE;
[email protected]3a5180ae2011-12-21 02:39:3874 virtual bool GetPluginInfoArray(
75 const GURL& url,
76 const std::string& mime_type,
77 bool allow_wildcard,
78 std::vector<webkit::WebPluginInfo>* info,
79 std::vector<std::string>* actual_mime_types) OVERRIDE;
80 virtual bool GetPluginInfo(int render_process_id,
81 int render_view_id,
[email protected]df02aca2012-02-09 21:03:2082 content::ResourceContext* context,
[email protected]3a5180ae2011-12-21 02:39:3883 const GURL& url,
84 const GURL& page_url,
85 const std::string& mime_type,
86 bool allow_wildcard,
87 bool* is_stale,
88 webkit::WebPluginInfo* info,
89 std::string* actual_mime_type) OVERRIDE;
90 virtual bool GetPluginInfoByPath(const FilePath& plugin_path,
91 webkit::WebPluginInfo* info) OVERRIDE;
92 virtual void GetPlugins(const GetPluginsCallback& callback) OVERRIDE;
93 virtual void GetPluginGroups(
94 const GetPluginGroupsCallback& callback) OVERRIDE;
95 virtual content::PepperPluginInfo* GetRegisteredPpapiPluginInfo(
96 const FilePath& plugin_path) OVERRIDE;
97 virtual void SetFilter(content::PluginServiceFilter* filter) OVERRIDE;
98 virtual content::PluginServiceFilter* GetFilter() OVERRIDE;
[email protected]b6a2f8de2012-01-31 17:28:4999 virtual void ForcePluginShutdown(const FilePath& plugin_path) OVERRIDE;
[email protected]47214d882012-02-29 06:28:48100 virtual bool IsPluginUnstable(const FilePath& plugin_path) OVERRIDE;
[email protected]3a5180ae2011-12-21 02:39:38101 virtual void RefreshPlugins() OVERRIDE;
102 virtual void AddExtraPluginPath(const FilePath& path) OVERRIDE;
[email protected]c6f3dea2012-01-14 02:23:11103 virtual void AddExtraPluginDir(const FilePath& path) OVERRIDE;
[email protected]3a5180ae2011-12-21 02:39:38104 virtual void RemoveExtraPluginPath(const FilePath& path) OVERRIDE;
105 virtual void UnregisterInternalPlugin(const FilePath& path) OVERRIDE;
106 virtual void RegisterInternalPlugin(
[email protected]c6f3dea2012-01-14 02:23:11107 const webkit::WebPluginInfo& info, bool add_at_beginning) OVERRIDE;
[email protected]3a5180ae2011-12-21 02:39:38108 virtual string16 GetPluginGroupName(const std::string& plugin_name) OVERRIDE;
109 virtual webkit::npapi::PluginList* GetPluginList() OVERRIDE;
[email protected]e67385f2011-12-21 06:00:56110 virtual void SetPluginListForTesting(
111 webkit::npapi::PluginList* plugin_list) OVERRIDE;
[email protected]dfba8762011-09-02 12:49:54112
[email protected]a0421732011-02-23 03:55:40113 // Returns the plugin process host corresponding to the plugin process that
114 // has been started by this service. This will start a process to host the
115 // 'plugin_path' if needed. If the process fails to start, the return value
116 // is NULL. Must be called on the IO thread.
117 PluginProcessHost* FindOrStartNpapiPluginProcess(
118 const FilePath& plugin_path);
119 PpapiPluginProcessHost* FindOrStartPpapiPluginProcess(
[email protected]d259a8e2011-05-18 22:31:09120 const FilePath& plugin_path,
[email protected]a50432d2011-09-30 16:32:14121 PpapiPluginProcessHost::PluginClient* client);
122 PpapiPluginProcessHost* FindOrStartPpapiBrokerProcess(
[email protected]eb415bf0e2011-04-14 02:45:42123 const FilePath& plugin_path);
[email protected]a0421732011-02-23 03:55:40124
125 // Opens a channel to a plugin process for the given mime type, starting
126 // a new plugin process if necessary. This must be called on the IO thread
127 // or else a deadlock can occur.
128 void OpenChannelToNpapiPlugin(int render_process_id,
129 int render_view_id,
130 const GURL& url,
[email protected]dfba8762011-09-02 12:49:54131 const GURL& page_url,
[email protected]a0421732011-02-23 03:55:40132 const std::string& mime_type,
133 PluginProcessHost::Client* client);
134 void OpenChannelToPpapiPlugin(const FilePath& path,
[email protected]a50432d2011-09-30 16:32:14135 PpapiPluginProcessHost::PluginClient* client);
[email protected]eb415bf0e2011-04-14 02:45:42136 void OpenChannelToPpapiBroker(const FilePath& path,
[email protected]a50432d2011-09-30 16:32:14137 PpapiPluginProcessHost::BrokerClient* client);
[email protected]a0421732011-02-23 03:55:40138
[email protected]4befe7592011-09-14 22:49:09139 // Cancels opening a channel to a NPAPI plugin.
140 void CancelOpenChannelToNpapiPlugin(PluginProcessHost::Client* client);
141
[email protected]47214d882012-02-29 06:28:48142 // Used to monitor plug-in stability.
143 void RegisterPluginCrash(const FilePath& plugin_path);
144
[email protected]a0421732011-02-23 03:55:40145 private:
[email protected]e67385f2011-12-21 06:00:56146 friend struct DefaultSingletonTraits<PluginServiceImpl>;
[email protected]a0421732011-02-23 03:55:40147
[email protected]e67385f2011-12-21 06:00:56148 // Creates the PluginServiceImpl object, but doesn't actually build the plugin
[email protected]a0421732011-02-23 03:55:40149 // list yet. It's generated lazily.
[email protected]e67385f2011-12-21 06:00:56150 PluginServiceImpl();
151 virtual ~PluginServiceImpl();
[email protected]a0421732011-02-23 03:55:40152
153 // base::WaitableEventWatcher::Delegate implementation.
[email protected]edc64de2011-11-17 20:07:38154 virtual void OnWaitableEventSignaled(
155 base::WaitableEvent* waitable_event) OVERRIDE;
[email protected]a0421732011-02-23 03:55:40156
[email protected]6c2381d2011-10-19 02:52:53157 // content::NotificationObserver implementation
[email protected]edc64de2011-11-17 20:07:38158 virtual void Observe(int type,
159 const content::NotificationSource& source,
160 const content::NotificationDetails& details) OVERRIDE;
[email protected]a0421732011-02-23 03:55:40161
[email protected]b6a2f8de2012-01-31 17:28:49162 // Returns the plugin process host corresponding to the plugin process that
163 // has been started by this service. Returns NULL if no process has been
164 // started.
165 PluginProcessHost* FindNpapiPluginProcess(const FilePath& plugin_path);
166 PpapiPluginProcessHost* FindPpapiPluginProcess(const FilePath& plugin_path);
167 PpapiPluginProcessHost* FindPpapiBrokerProcess(const FilePath& broker_path);
168
[email protected]a0421732011-02-23 03:55:40169 void RegisterPepperPlugins();
170
[email protected]d33e7cc2011-09-23 01:43:56171 // Function that is run on the FILE thread to load the plugins synchronously.
172 void GetPluginsInternal(base::MessageLoopProxy* target_loop,
173 const GetPluginsCallback& callback);
174
[email protected]88ca4912011-10-12 14:00:43175 // Binding directly to GetAllowedPluginForOpenChannelToPlugin() isn't possible
176 // because more arity is needed <http://crbug.com/98542>. This just forwards.
177 void ForwardGetAllowedPluginForOpenChannelToPlugin(
178 const content::PluginServiceFilterParams& params,
179 const GURL& url,
180 const std::string& mime_type,
181 PluginProcessHost::Client* client,
182 const std::vector<webkit::WebPluginInfo>&);
[email protected]a0421732011-02-23 03:55:40183 // Helper so we can do the plugin lookup on the FILE thread.
184 void GetAllowedPluginForOpenChannelToPlugin(
185 int render_process_id,
186 int render_view_id,
187 const GURL& url,
[email protected]dfba8762011-09-02 12:49:54188 const GURL& page_url,
[email protected]a0421732011-02-23 03:55:40189 const std::string& mime_type,
[email protected]87c4be42011-09-16 01:10:59190 PluginProcessHost::Client* client,
[email protected]df02aca2012-02-09 21:03:20191 content::ResourceContext* resource_context);
[email protected]a0421732011-02-23 03:55:40192
193 // Helper so we can finish opening the channel after looking up the
194 // plugin.
195 void FinishOpenChannelToPlugin(
196 const FilePath& plugin_path,
197 PluginProcessHost::Client* client);
198
[email protected]3b48dbc2012-01-06 16:34:17199#if defined(OS_POSIX) && !defined(OS_OPENBSD)
[email protected]a0421732011-02-23 03:55:40200 // Registers a new FilePathWatcher for a given path.
201 static void RegisterFilePathWatcher(
[email protected]493c8002011-04-14 16:56:01202 base::files::FilePathWatcher* watcher,
[email protected]a0421732011-02-23 03:55:40203 const FilePath& path,
[email protected]493c8002011-04-14 16:56:01204 base::files::FilePathWatcher::Delegate* delegate);
[email protected]a0421732011-02-23 03:55:40205#endif
206
[email protected]ee066172011-11-10 23:20:05207 // The plugin list instance.
208 webkit::npapi::PluginList* plugin_list_;
209
[email protected]6c2381d2011-10-19 02:52:53210 content::NotificationRegistrar registrar_;
[email protected]a0421732011-02-23 03:55:40211
[email protected]a0421732011-02-23 03:55:40212#if defined(OS_WIN)
213 // Registry keys for getting notifications when new plugins are installed.
214 base::win::RegKey hkcu_key_;
215 base::win::RegKey hklm_key_;
216 scoped_ptr<base::WaitableEvent> hkcu_event_;
217 scoped_ptr<base::WaitableEvent> hklm_event_;
218 base::WaitableEventWatcher hkcu_watcher_;
219 base::WaitableEventWatcher hklm_watcher_;
220#endif
221
[email protected]3b48dbc2012-01-06 16:34:17222#if defined(OS_POSIX) && !defined(OS_OPENBSD)
[email protected]493c8002011-04-14 16:56:01223 ScopedVector<base::files::FilePathWatcher> file_watchers_;
[email protected]a0421732011-02-23 03:55:40224 scoped_refptr<PluginDirWatcherDelegate> file_watcher_delegate_;
225#endif
226
[email protected]738a7212011-10-21 17:33:52227 std::vector<content::PepperPluginInfo> ppapi_plugins_;
[email protected]a0421732011-02-23 03:55:40228
[email protected]dfba8762011-09-02 12:49:54229 // Weak pointer; outlives us.
230 content::PluginServiceFilter* filter_;
[email protected]a0421732011-02-23 03:55:40231
[email protected]4befe7592011-09-14 22:49:09232 std::set<PluginProcessHost::Client*> pending_plugin_clients_;
233
[email protected]d4af1e72011-10-21 17:45:43234#if defined(OS_POSIX)
235 scoped_refptr<PluginLoaderPosix> plugin_loader_;
236#endif
237
[email protected]47214d882012-02-29 06:28:48238 // Used to detect if a given plug-in is crashing over and over.
239 std::map<FilePath, std::vector<base::Time> > crash_times_;
240
[email protected]e67385f2011-12-21 06:00:56241 DISALLOW_COPY_AND_ASSIGN(PluginServiceImpl);
[email protected]a0421732011-02-23 03:55:40242};
243
[email protected]e67385f2011-12-21 06:00:56244#endif // CONTENT_BROWSER_PLUGIN_SERVICE_IMPL_H_