chrome/browser/plugins/plugin_prefs.cc

   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 #include "chrome/browser/plugins/plugin_prefs.h"
   6
   7 #include <string>
   8
   9 #include "base/bind.h"
  10 #include "base/command_line.h"
  11 #include "base/location.h"
  12 #include "base/memory/scoped_ptr.h"
  13 #include "base/path_service.h"
  14 #include "base/prefs/scoped_user_pref_update.h"
  15 #include "base/single_thread_task_runner.h"
  16 #include "base/strings/pattern.h"
  17 #include "base/strings/string_util.h"
  18 #include "base/strings/utf_string_conversions.h"
  19 #include "base/thread_task_runner_handle.h"
  20 #include "base/values.h"
  21 #include "build/build_config.h"
  22 #include "chrome/browser/browser_process.h"
  23 #include "chrome/browser/chrome_notification_types.h"
  24 #include "chrome/browser/plugins/plugin_installer.h"
  25 #include "chrome/browser/plugins/plugin_metadata.h"
  26 #include "chrome/browser/plugins/plugin_prefs_factory.h"
  27 #include "chrome/browser/profiles/profile.h"
  28 #include "chrome/common/chrome_constants.h"
  29 #include "chrome/common/chrome_paths.h"
  30 #include "chrome/common/chrome_switches.h"
  31 #include "chrome/common/pref_names.h"
  32 #include "components/keyed_service/core/keyed_service.h"
  33 #include "content/public/browser/browser_thread.h"
  34 #include "content/public/browser/notification_service.h"
  35 #include "content/public/browser/plugin_service.h"
  36 #include "content/public/common/webplugininfo.h"
  37
  38 #if !defined(DISABLE_NACL)
  39 #include "components/nacl/common/nacl_constants.h"
  40 #endif
  41
  42 using content::BrowserThread;
  43 using content::PluginService;
  44
  45 namespace {
  46
  47 bool IsComponentUpdatedPepperFlash(const base::FilePath& plugin) {
  48   if (plugin.BaseName().value() == chrome::kPepperFlashPluginFilename) {
  49     base::FilePath component_updated_pepper_flash_dir;
  50     if (PathService::Get(chrome::DIR_COMPONENT_UPDATED_PEPPER_FLASH_PLUGIN,
  51                          &component_updated_pepper_flash_dir) &&
  52         component_updated_pepper_flash_dir.IsParent(plugin)) {
  53       return true;
  54     }
  55   }
  56
  57   return false;
  58 }
  59
  60 }  // namespace
  61
  62 PluginPrefs::PluginState::PluginState() {
  63 }
  64
  65 PluginPrefs::PluginState::~PluginState() {
  66 }
  67
  68 bool PluginPrefs::PluginState::Get(const base::FilePath& plugin,
  69                                    bool* enabled) const {
  70   base::FilePath key = ConvertMapKey(plugin);
  71   std::map<base::FilePath, bool>::const_iterator iter = state_.find(key);
  72   if (iter != state_.end()) {
  73     *enabled = iter->second;
  74     return true;
  75   }
  76   return false;
  77 }
  78
  79 void PluginPrefs::PluginState::Set(const base::FilePath& plugin, bool enabled) {
  80   state_[ConvertMapKey(plugin)] = enabled;
  81 }
  82
  83 base::FilePath PluginPrefs::PluginState::ConvertMapKey(
  84     const base::FilePath& plugin) const {
  85   // Keep the state of component-updated and bundled Pepper Flash in sync.
  86   if (IsComponentUpdatedPepperFlash(plugin)) {
  87     base::FilePath bundled_pepper_flash;
  88     if (PathService::Get(chrome::FILE_PEPPER_FLASH_PLUGIN,
  89                          &bundled_pepper_flash)) {
  90       return bundled_pepper_flash;
  91     }
  92   }
  93
  94   return plugin;
  95 }
  96
  97 // static
  98 scoped_refptr<PluginPrefs> PluginPrefs::GetForProfile(Profile* profile) {
  99   return PluginPrefsFactory::GetPrefsForProfile(profile);
 100 }
 101
 102 // static
 103 scoped_refptr<PluginPrefs> PluginPrefs::GetForTestingProfile(
 104     Profile* profile) {
 105   return static_cast<PluginPrefs*>(
 106       PluginPrefsFactory::GetInstance()->SetTestingFactoryAndUse(
 107           profile, &PluginPrefsFactory::CreateForTestingProfile).get());
 108 }
 109
 110 void PluginPrefs::EnablePluginGroup(bool enabled,
 111                                     const base::string16& group_name) {
 112   PluginService::GetInstance()->GetPlugins(
 113       base::Bind(&PluginPrefs::EnablePluginGroupInternal,
 114                  this, enabled, group_name));
 115 }
 116
 117 void PluginPrefs::EnablePluginGroupInternal(
 118     bool enabled,
 119     const base::string16& group_name,
 120     const std::vector<content::WebPluginInfo>& plugins) {
 121   base::AutoLock auto_lock(lock_);
 122   PluginFinder* finder = PluginFinder::GetInstance();
 123
 124   // Set the desired state for the group.
 125   plugin_group_state_[group_name] = enabled;
 126
 127   // Update the state for all plugins in the group.
 128   for (size_t i = 0; i < plugins.size(); ++i) {
 129     scoped_ptr<PluginMetadata> plugin(finder->GetPluginMetadata(plugins[i]));
 130     if (group_name != plugin->name())
 131       continue;
 132     plugin_state_.Set(plugins[i].path, enabled);
 133   }
 134
 135   BrowserThread::PostTask(BrowserThread::UI, FROM_HERE,
 136       base::Bind(&PluginPrefs::OnUpdatePreferences, this, plugins));
 137   BrowserThread::PostTask(BrowserThread::UI, FROM_HERE,
 138       base::Bind(&PluginPrefs::NotifyPluginStatusChanged, this));
 139 }
 140
 141 void PluginPrefs::EnablePlugin(
 142     bool enabled, const base::FilePath& path,
 143     const base::Callback<void(bool)>& callback) {
 144   PluginFinder* finder = PluginFinder::GetInstance();
 145   content::WebPluginInfo plugin;
 146   bool can_enable = true;
 147   if (PluginService::GetInstance()->GetPluginInfoByPath(path, &plugin)) {
 148     scoped_ptr<PluginMetadata> plugin_metadata(
 149         finder->GetPluginMetadata(plugin));
 150     PolicyStatus plugin_status = PolicyStatusForPlugin(plugin.name);
 151     PolicyStatus group_status = PolicyStatusForPlugin(plugin_metadata->name());
 152     if (enabled) {
 153       if (plugin_status == POLICY_DISABLED || group_status == POLICY_DISABLED)
 154         can_enable = false;
 155     } else {
 156       if (plugin_status == POLICY_ENABLED || group_status == POLICY_ENABLED)
 157         can_enable = false;
 158     }
 159   } else {
 160     NOTREACHED();
 161   }
 162
 163   if (!can_enable) {
 164     base::ThreadTaskRunnerHandle::Get()->PostTask(FROM_HERE,
 165                                                   base::Bind(callback, false));
 166     return;
 167   }
 168
 169   PluginService::GetInstance()->GetPlugins(
 170       base::Bind(&PluginPrefs::EnablePluginInternal, this,
 171                  enabled, path, finder, callback));
 172 }
 173
 174 void PluginPrefs::EnablePluginInternal(
 175     bool enabled,
 176     const base::FilePath& path,
 177     PluginFinder* plugin_finder,
 178     const base::Callback<void(bool)>& callback,
 179     const std::vector<content::WebPluginInfo>& plugins) {
 180   {
 181     // Set the desired state for the plugin.
 182     base::AutoLock auto_lock(lock_);
 183     plugin_state_.Set(path, enabled);
 184   }
 185
 186   base::string16 group_name;
 187   for (size_t i = 0; i < plugins.size(); ++i) {
 188     if (plugins[i].path == path) {
 189       scoped_ptr<PluginMetadata> plugin_metadata(
 190           plugin_finder->GetPluginMetadata(plugins[i]));
 191       // set the group name for this plugin.
 192       group_name = plugin_metadata->name();
 193       DCHECK_EQ(enabled, IsPluginEnabled(plugins[i]));
 194       break;
 195     }
 196   }
 197
 198   bool all_disabled = true;
 199   for (size_t i = 0; i < plugins.size(); ++i) {
 200     scoped_ptr<PluginMetadata> plugin_metadata(
 201         plugin_finder->GetPluginMetadata(plugins[i]));
 202     DCHECK(!plugin_metadata->name().empty());
 203     if (group_name == plugin_metadata->name()) {
 204       all_disabled = all_disabled && !IsPluginEnabled(plugins[i]);
 205     }
 206   }
 207
 208   if (!group_name.empty()) {
 209     // Update the state for the corresponding plugin group.
 210     base::AutoLock auto_lock(lock_);
 211     plugin_group_state_[group_name] = !all_disabled;
 212   }
 213
 214   BrowserThread::PostTask(BrowserThread::UI, FROM_HERE,
 215       base::Bind(&PluginPrefs::OnUpdatePreferences, this, plugins));
 216   BrowserThread::PostTask(BrowserThread::UI, FROM_HERE,
 217       base::Bind(&PluginPrefs::NotifyPluginStatusChanged, this));
 218   callback.Run(true);
 219 }
 220
 221 PluginPrefs::PolicyStatus PluginPrefs::PolicyStatusForPlugin(
 222     const base::string16& name) const {
 223   base::AutoLock auto_lock(lock_);
 224   if (IsStringMatchedInSet(name, policy_enabled_plugin_patterns_)) {
 225     return POLICY_ENABLED;
 226   } else if (IsStringMatchedInSet(name, policy_disabled_plugin_patterns_) &&
 227              !IsStringMatchedInSet(
 228                  name, policy_disabled_plugin_exception_patterns_)) {
 229     return POLICY_DISABLED;
 230   } else {
 231     return NO_POLICY;
 232   }
 233 }
 234
 235 bool PluginPrefs::IsPluginEnabled(const content::WebPluginInfo& plugin) const {
 236   scoped_ptr<PluginMetadata> plugin_metadata(
 237       PluginFinder::GetInstance()->GetPluginMetadata(plugin));
 238   base::string16 group_name = plugin_metadata->name();
 239
 240   // Check if the plugin or its group is enabled by policy.
 241   PolicyStatus plugin_status = PolicyStatusForPlugin(plugin.name);
 242   PolicyStatus group_status = PolicyStatusForPlugin(group_name);
 243   if (plugin_status == POLICY_ENABLED || group_status == POLICY_ENABLED)
 244     return true;
 245
 246   // Check if the plugin or its group is disabled by policy.
 247   if (plugin_status == POLICY_DISABLED || group_status == POLICY_DISABLED)
 248     return false;
 249
 250 #if !defined(DISABLE_NACL)
 251   // If enabling NaCl, make sure the plugin is also enabled. See bug
 252   // http://code.google.com/p/chromium/issues/detail?id=81010 for more
 253   // information.
 254   // TODO(dspringer): When NaCl is on by default, remove this code.
 255   if ((plugin.name == base::ASCIIToUTF16(nacl::kNaClPluginName)) &&
 256       base::CommandLine::ForCurrentProcess()->HasSwitch(
 257           switches::kEnableNaCl)) {
 258     return true;
 259   }
 260 #endif
 261
 262   base::AutoLock auto_lock(lock_);
 263   // Check user preferences for the plugin.
 264   bool plugin_enabled = false;
 265   if (plugin_state_.Get(plugin.path, &plugin_enabled))
 266     return plugin_enabled;
 267
 268   // Check user preferences for the plugin group.
 269   std::map<base::string16, bool>::const_iterator group_it(
 270       plugin_group_state_.find(group_name));
 271   if (group_it != plugin_group_state_.end())
 272     return group_it->second;
 273
 274   // Default to enabled.
 275   return true;
 276 }
 277
 278 void PluginPrefs::UpdatePatternsAndNotify(std::set<base::string16>* patterns,
 279                                           const std::string& pref_name) {
 280   base::AutoLock auto_lock(lock_);
 281   ListValueToStringSet(prefs_->GetList(pref_name.c_str()), patterns);
 282
 283   NotifyPluginStatusChanged();
 284 }
 285
 286 /*static*/
 287 bool PluginPrefs::IsStringMatchedInSet(
 288     const base::string16& name,
 289     const std::set<base::string16>& pattern_set) {
 290   std::set<base::string16>::const_iterator pattern(pattern_set.begin());
 291   while (pattern != pattern_set.end()) {
 292     if (base::MatchPattern(name, *pattern))
 293       return true;
 294     ++pattern;
 295   }
 296
 297   return false;
 298 }
 299
 300 /* static */
 301 void PluginPrefs::ListValueToStringSet(const base::ListValue* src,
 302                                        std::set<base::string16>* dest) {
 303   DCHECK(src);
 304   DCHECK(dest);
 305   dest->clear();
 306   base::ListValue::const_iterator end(src->end());
 307   for (base::ListValue::const_iterator current(src->begin());
 308        current != end; ++current) {
 309     base::string16 plugin_name;
 310     if ((*current)->GetAsString(&plugin_name)) {
 311       dest->insert(plugin_name);
 312     }
 313   }
 314 }
 315
 316 void PluginPrefs::SetPrefs(PrefService* prefs) {
 317   prefs_ = prefs;
 318   bool update_internal_dir = false;
 319   base::FilePath last_internal_dir =
 320       prefs_->GetFilePath(prefs::kPluginsLastInternalDirectory);
 321   base::FilePath cur_internal_dir;
 322   if (PathService::Get(chrome::DIR_INTERNAL_PLUGINS, &cur_internal_dir) &&
 323       cur_internal_dir != last_internal_dir) {
 324     update_internal_dir = true;
 325     prefs_->SetFilePath(
 326         prefs::kPluginsLastInternalDirectory, cur_internal_dir);
 327   }
 328
 329   bool migrate_to_pepper_flash = false;
 330 #if defined(OS_WIN) || defined(OS_MACOSX)
 331   // If NPAPI Flash is enabled while Pepper Flash is disabled, we would like to
 332   // turn Pepper Flash on. And we want to do it once, when NPAPI is disabled in
 333   // Chrome 45.
 334   // TODO(wfh): Remove this code once it has been run by most users, around
 335   // Chrome 49 or Chrome 50. See crbug.com/514250.
 336   if (!prefs_->GetBoolean(prefs::kNpapiFlashMigratedToPepperFlash)) {
 337     prefs_->SetBoolean(prefs::kNpapiFlashMigratedToPepperFlash, true);
 338     migrate_to_pepper_flash = true;
 339   }
 340 #endif
 341
 342   {  // Scoped update of prefs::kPluginsPluginsList.
 343     ListPrefUpdate update(prefs_, prefs::kPluginsPluginsList);
 344     base::ListValue* saved_plugins_list = update.Get();
 345     if (saved_plugins_list && !saved_plugins_list->empty()) {
 346       // The following four variables are only valid when
 347       // |migrate_to_pepper_flash| is set to true.
 348       base::FilePath npapi_flash;
 349       base::FilePath pepper_flash;
 350       base::DictionaryValue* pepper_flash_node = NULL;
 351       bool npapi_flash_enabled = false;
 352       if (migrate_to_pepper_flash) {
 353         PathService::Get(chrome::FILE_FLASH_SYSTEM_PLUGIN, &npapi_flash);
 354         PathService::Get(chrome::FILE_PEPPER_FLASH_PLUGIN, &pepper_flash);
 355       }
 356
 357       for (base::ListValue::iterator it = saved_plugins_list->begin();
 358            it != saved_plugins_list->end();
 359            ++it) {
 360         if (!(*it)->IsType(base::Value::TYPE_DICTIONARY)) {
 361           LOG(WARNING) << "Invalid entry in " << prefs::kPluginsPluginsList;
 362           continue;  // Oops, don't know what to do with this item.
 363         }
 364
 365         base::DictionaryValue* plugin =
 366             static_cast<base::DictionaryValue*>(*it);
 367         base::string16 group_name;
 368         bool enabled;
 369         if (!plugin->GetBoolean("enabled", &enabled))
 370           enabled = true;
 371
 372         base::FilePath::StringType path;
 373         // The plugin list constains all the plugin files in addition to the
 374         // plugin groups.
 375         if (plugin->GetString("path", &path)) {
 376           // Files have a path attribute, groups don't.
 377           base::FilePath plugin_path(path);
 378
 379           // The path to the internal plugin directory changes everytime Chrome
 380           // is auto-updated, since it contains the current version number. For
 381           // example, it changes from foobar\Chrome\Application\21.0.1180.83 to
 382           // foobar\Chrome\Application\21.0.1180.89.
 383           // However, we would like the settings of internal plugins to persist
 384           // across Chrome updates. Therefore, we need to recognize those paths
 385           // that are within the previous internal plugin directory, and update
 386           // them in the prefs accordingly.
 387           if (update_internal_dir) {
 388             base::FilePath relative_path;
 389
 390             // Extract the part of |plugin_path| that is relative to
 391             // |last_internal_dir|. For example, |relative_path| will be
 392             // foo\bar.dll if |plugin_path| is <last_internal_dir>\foo\bar.dll.
 393             //
 394             // Every iteration the last path component from |plugin_path| is
 395             // removed and prepended to |relative_path| until we get up to
 396             // |last_internal_dir|.
 397             while (last_internal_dir.IsParent(plugin_path)) {
 398               relative_path = plugin_path.BaseName().Append(relative_path);
 399
 400               base::FilePath old_path = plugin_path;
 401               plugin_path = plugin_path.DirName();
 402               // To be extra sure that we won't end up in an infinite loop.
 403               if (old_path == plugin_path) {
 404                 NOTREACHED();
 405                 break;
 406               }
 407             }
 408
 409             // If |relative_path| is empty, |plugin_path| is not within
 410             // |last_internal_dir|. We don't need to update it.
 411             if (!relative_path.empty()) {
 412               plugin_path = cur_internal_dir.Append(relative_path);
 413               path = plugin_path.value();
 414               plugin->SetString("path", path);
 415             }
 416           }
 417
 418           if (migrate_to_pepper_flash && base::FilePath::CompareEqualIgnoreCase(
 419                                              path, npapi_flash.value())) {
 420             npapi_flash_enabled = enabled;
 421           } else if (migrate_to_pepper_flash &&
 422                      base::FilePath::CompareEqualIgnoreCase(
 423                          path, pepper_flash.value())) {
 424             if (!enabled)
 425               pepper_flash_node = plugin;
 426           }
 427
 428           plugin_state_.Set(plugin_path, enabled);
 429         } else if (!enabled && plugin->GetString("name", &group_name)) {
 430           // Otherwise this is a list of groups.
 431           plugin_group_state_[group_name] = false;
 432         }
 433       }
 434
 435       if (npapi_flash_enabled && pepper_flash_node) {
 436         DCHECK(migrate_to_pepper_flash);
 437         pepper_flash_node->SetBoolean("enabled", true);
 438         plugin_state_.Set(pepper_flash, true);
 439       }
 440     } else {
 441       // If the saved plugin list is empty, then the call to UpdatePreferences()
 442       // below failed in an earlier run, possibly because the user closed the
 443       // browser too quickly.
 444
 445       // Only want one PDF plugin enabled at a time. See http://crbug.com/50105
 446       // for background.
 447       plugin_group_state_[base::ASCIIToUTF16(
 448           PluginMetadata::kAdobeReaderGroupName)] = false;
 449     }
 450   }  // Scoped update of prefs::kPluginsPluginsList.
 451
 452   // Build the set of policy enabled/disabled plugin patterns once and cache it.
 453   // Don't do this in the constructor, there's no profile available there.
 454   ListValueToStringSet(prefs_->GetList(prefs::kPluginsDisabledPlugins),
 455                        &policy_disabled_plugin_patterns_);
 456   ListValueToStringSet(
 457       prefs_->GetList(prefs::kPluginsDisabledPluginsExceptions),
 458       &policy_disabled_plugin_exception_patterns_);
 459   ListValueToStringSet(prefs_->GetList(prefs::kPluginsEnabledPlugins),
 460                        &policy_enabled_plugin_patterns_);
 461
 462   registrar_.Init(prefs_);
 463
 464   // Because pointers to our own members will remain unchanged for the
 465   // lifetime of |registrar_| (which we also own), we can bind their
 466   // pointer values directly in the callbacks to avoid string-based
 467   // lookups at notification time.
 468   registrar_.Add(prefs::kPluginsDisabledPlugins,
 469                  base::Bind(&PluginPrefs::UpdatePatternsAndNotify,
 470                             base::Unretained(this),
 471                             &policy_disabled_plugin_patterns_));
 472   registrar_.Add(prefs::kPluginsDisabledPluginsExceptions,
 473                  base::Bind(&PluginPrefs::UpdatePatternsAndNotify,
 474                             base::Unretained(this),
 475                             &policy_disabled_plugin_exception_patterns_));
 476   registrar_.Add(prefs::kPluginsEnabledPlugins,
 477                  base::Bind(&PluginPrefs::UpdatePatternsAndNotify,
 478                             base::Unretained(this),
 479                             &policy_enabled_plugin_patterns_));
 480
 481   NotifyPluginStatusChanged();
 482 }
 483
 484 void PluginPrefs::ShutdownOnUIThread() {
 485   prefs_ = NULL;
 486   registrar_.RemoveAll();
 487 }
 488
 489 PluginPrefs::PluginPrefs() : profile_(NULL),
 490                              prefs_(NULL) {
 491 }
 492
 493 PluginPrefs::~PluginPrefs() {
 494 }
 495
 496 void PluginPrefs::SetPolicyEnforcedPluginPatterns(
 497     const std::set<base::string16>& disabled_patterns,
 498     const std::set<base::string16>& disabled_exception_patterns,
 499     const std::set<base::string16>& enabled_patterns) {
 500   policy_disabled_plugin_patterns_ = disabled_patterns;
 501   policy_disabled_plugin_exception_patterns_ = disabled_exception_patterns;
 502   policy_enabled_plugin_patterns_ = enabled_patterns;
 503 }
 504
 505 void PluginPrefs::OnUpdatePreferences(
 506     const std::vector<content::WebPluginInfo>& plugins) {
 507   if (!prefs_)
 508     return;
 509
 510   PluginFinder* finder = PluginFinder::GetInstance();
 511   ListPrefUpdate update(prefs_, prefs::kPluginsPluginsList);
 512   base::ListValue* plugins_list = update.Get();
 513   plugins_list->Clear();
 514
 515   base::FilePath internal_dir;
 516   if (PathService::Get(chrome::DIR_INTERNAL_PLUGINS, &internal_dir))
 517     prefs_->SetFilePath(prefs::kPluginsLastInternalDirectory, internal_dir);
 518
 519   base::AutoLock auto_lock(lock_);
 520
 521   // Add the plugin files.
 522   std::set<base::string16> group_names;
 523   for (size_t i = 0; i < plugins.size(); ++i) {
 524     base::DictionaryValue* summary = new base::DictionaryValue();
 525     summary->SetString("path", plugins[i].path.value());
 526     summary->SetString("name", plugins[i].name);
 527     summary->SetString("version", plugins[i].version);
 528     bool enabled = true;
 529     plugin_state_.Get(plugins[i].path, &enabled);
 530     summary->SetBoolean("enabled", enabled);
 531     plugins_list->Append(summary);
 532
 533     scoped_ptr<PluginMetadata> plugin_metadata(
 534         finder->GetPluginMetadata(plugins[i]));
 535     // Insert into a set of all group names.
 536     group_names.insert(plugin_metadata->name());
 537   }
 538
 539   // Add the plugin groups.
 540   for (std::set<base::string16>::const_iterator it = group_names.begin();
 541       it != group_names.end(); ++it) {
 542     base::DictionaryValue* summary = new base::DictionaryValue();
 543     summary->SetString("name", *it);
 544     bool enabled = true;
 545     std::map<base::string16, bool>::iterator gstate_it =
 546         plugin_group_state_.find(*it);
 547     if (gstate_it != plugin_group_state_.end())
 548       enabled = gstate_it->second;
 549     summary->SetBoolean("enabled", enabled);
 550     plugins_list->Append(summary);
 551   }
 552 }
 553
 554 void PluginPrefs::NotifyPluginStatusChanged() {
 555   DCHECK_CURRENTLY_ON(BrowserThread::UI);
 556   content::NotificationService::current()->Notify(
 557       chrome::NOTIFICATION_PLUGIN_ENABLE_STATUS_CHANGED,
 558       content::Source<Profile>(profile_),
 559       content::NotificationService::NoDetails());
 560 }