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 CHROME_BROWSER_PLUGINS_PLUGIN_PREFS_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CHROME_BROWSER_PLUGINS_PLUGIN_PREFS_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <map> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <set> 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <vector> 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 132a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/files/file_path.h" 142a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/prefs/pref_change_registrar.h" 152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/prefs/pref_service.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/synchronization/lock.h" 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chrome/browser/plugins/plugin_finder.h" 18a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)#include "components/keyed_service/content/refcounted_browser_context_keyed_service.h" 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Profile; 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace base { 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ListValue; 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 26ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochnamespace content { 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct WebPluginInfo; 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This class stores information about whether a plug-in or a plug-in group is 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// enabled or disabled. 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Except where otherwise noted, it can be used on every thread. 3390dce4d38c5ff5333bea97d859d4e484e27edf0cTorne (Richard Coles)class PluginPrefs : public RefcountedBrowserContextKeyedService { 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum PolicyStatus { 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) NO_POLICY = 0, // Neither enabled or disabled by policy. 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) POLICY_ENABLED, 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) POLICY_DISABLED, 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the instance associated with |profile|, creating it if necessary. 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static scoped_refptr<PluginPrefs> GetForProfile(Profile* profile); 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Usually the PluginPrefs associated with a TestingProfile is NULL. 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This method overrides that for a given TestingProfile, returning the newly 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // created PluginPrefs object. 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static scoped_refptr<PluginPrefs> GetForTestingProfile(Profile* profile); 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Creates a new instance. This method should only be used for testing. 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PluginPrefs(); 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Associates this instance with |prefs|. This enables or disables 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // plugin groups as defined by the user's preferences. 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This method should only be called on the UI thread. 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetPrefs(PrefService* prefs); 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Enable or disable a plugin group. 58a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) void EnablePluginGroup(bool enable, const base::string16& group_name); 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Enables or disables a specific plug-in file, if possible. 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If the plug-in state can't be changed (because of a policy for example) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // then enabling/disabling the plug-in is ignored and |callback| is run 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // with 'false' passed to it. Otherwise the plug-in state is changed 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // and |callback| is run with 'true' passed to it. 652a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void EnablePlugin(bool enable, const base::FilePath& file_path, 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::Callback<void(bool)>& callback); 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns whether there is a policy enabling or disabling plug-ins of the 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // given name. 70a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) PolicyStatus PolicyStatusForPlugin(const base::string16& name) const; 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns whether the plugin is enabled or not. 73ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch bool IsPluginEnabled(const content::WebPluginInfo& plugin) const; 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void set_profile(Profile* profile) { profile_ = profile; } 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // RefCountedProfileKeyedBase method override. 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void ShutdownOnUIThread() OVERRIDE; 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class base::RefCountedThreadSafe<PluginPrefs>; 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class PluginPrefsTest; 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // PluginState stores a mapping from plugin path to enable/disable state. We 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // don't simply use a std::map, because we would like to keep the state of 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // some plugins in sync with each other. 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class PluginState { 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PluginState(); 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~PluginState(); 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns whether |plugin| is found. If |plugin| cannot be found, 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |*enabled| won't be touched. 942a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool Get(const base::FilePath& plugin, bool* enabled) const; 952a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) void Set(const base::FilePath& plugin, bool enabled); 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 982a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) base::FilePath ConvertMapKey(const base::FilePath& plugin) const; 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1002a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) std::map<base::FilePath, bool> state_; 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~PluginPrefs(); 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1052a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Called to update one of the policy_xyz patterns below when a 1062a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // preference changes. 1075d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) void UpdatePatternsAndNotify(std::set<base::string16>* patterns, 1082a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const std::string& pref_name); 1092a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Allows unit tests to directly set enforced plug-in patterns. 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetPolicyEnforcedPluginPatterns( 1125d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const std::set<base::string16>& disabled_patterns, 1135d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const std::set<base::string16>& disabled_exception_patterns, 1145d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const std::set<base::string16>& enabled_patterns); 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Callback for after the plugin groups have been loaded. 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void EnablePluginGroupInternal( 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool enabled, 119a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) const base::string16& group_name, 120ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch const std::vector<content::WebPluginInfo>& plugins); 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void EnablePluginInternal( 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool enabled, 1232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) const base::FilePath& path, 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PluginFinder* plugin_finder, 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::Callback<void(bool)>& callback, 126ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch const std::vector<content::WebPluginInfo>& plugins); 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called on the UI thread with the plugin data to save the preferences. 129ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch void OnUpdatePreferences(const std::vector<content::WebPluginInfo>& plugins); 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sends the notification that plugin data has changed. 1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void NotifyPluginStatusChanged(); 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static void ListValueToStringSet(const base::ListValue* src, 1355d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) std::set<base::string16>* dest); 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Checks if |name| matches any of the patterns in |pattern_set|. 138a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) static bool IsStringMatchedInSet(const base::string16& name, 1395d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const std::set<base::string16>& pattern_set); 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Guards access to the following data structures. 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) mutable base::Lock lock_; 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PluginState plugin_state_; 1455d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) std::map<base::string16, bool> plugin_group_state_; 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1475d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) std::set<base::string16> policy_disabled_plugin_patterns_; 1485d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) std::set<base::string16> policy_disabled_plugin_exception_patterns_; 1495d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) std::set<base::string16> policy_enabled_plugin_patterns_; 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Weak pointer, owns us. Only used as a notification source. 1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Profile* profile_; 1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Weak pointer, owned by the profile. 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PrefService* prefs_; 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PrefChangeRegistrar registrar_; 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(PluginPrefs); 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // CHROME_BROWSER_PLUGINS_PLUGIN_PREFS_H_ 163