Clean up PluginGroup and related code.

webkit/glue/plugins/plugin_list.h

 // Copyright (c) 2010 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef WEBKIT_GLUE_PLUGINS_PLUGIN_LIST_H_
 #define WEBKIT_GLUE_PLUGINS_PLUGIN_LIST_H_
 
-#include <map>
 #include <set>
 #include <string>
 #include <vector>
-#include <set>
 
 #include "base/basictypes.h"
 #include "base/file_path.h"
 #include "base/linked_ptr.h"
 #include "base/lock.h"
 #include "third_party/npapi/bindings/nphostapi.h"
 #include "webkit/glue/plugins/plugin_group.h"
 #include "webkit/glue/plugins/webplugininfo.h"
 
 class GURL;
@@ skipping 127 matching lines @@
                      const std::string& mime_type,
                      bool allow_wildcard,
                      WebPluginInfo* info,
                      std::string* actual_mime_type);
 
   // Get plugin info by plugin path (including disabled plugins). Returns true
   // if the plugin is found and WebPluginInfo has been filled in |info|.
   bool GetPluginInfoByPath(const FilePath& plugin_path,
                            WebPluginInfo* info);
 
-  typedef std::map<std::string, linked_ptr<PluginGroup> > PluginMap;
+  // Populates the given vector with all available plugin groups.
+  void GetPluginGroups(bool load_if_necessary,
+                       std::vector<PluginGroup>* plugin_groups);
 
-  // Fill the map from identifier to plugin group for all plugin groups.  If
-  // |load_if_necessary| is set, the plugins will be loaded if they haven't
-  // already been loaded, or if Refresh() has been called in the meantime;
-  // otherwise a possibly empty or stale list may be returned.
-  void GetPluginGroups(bool load_if_necessary, PluginMap* plugin_groups);
+  // Returns the PluginGroup corresponding to the given WebPluginInfo. If no
+  // such group exists, it is created and added to the cache.
+  // Beware: when calling this from the Browser prrocess, the group that the

[Bernhard Bauer, 2010/12/07 10:32:05]

Nit: process

[Jakob Kummerow, 2010/12/07 11:43:08]

Done.

+  // returned pointer points to might disappear suddenly.

[Bernhard Bauer, 2010/12/07 10:32:05]

Also, please elaborate on under what circumstances the group might disappear (if
RefreshPlugins is called and then GetPlugins/GetEnabledPlugins/GetPluginGroups),
and that it's the caller's responsibility to make sure that doesn't happen.

[Jakob Kummerow, 2010/12/07 11:43:08]

Done.

+  const PluginGroup* GetPluginGroup(const WebPluginInfo& web_plugin_info);
+
+  // Returns the name of the PluginGroup with the given identifier.
+  // If no such group exists, an empty string is returned.
+  string16 GetPluginGroupName(std::string identifier);
+
+  // Returns the identifier string of the PluginGroup corresponding to the given
+  // WebPluginInfo. If no such group exists, it is created and added to the
+  // cache.
+  std::string GetPluginGroupIdentifier(const WebPluginInfo& web_plugin_info);
 
   // Load a specific plugin with full path.
   void LoadPlugin(const FilePath& filename,
                   std::vector<WebPluginInfo>* plugins);
 
   // Enable a specific plugin, specified by path. Returns |true| iff a plugin
   // currently in the plugin list was actually enabled as a result; regardless
   // of return value, if a plugin is found in the future with the given name, it
   // will be enabled. Note that plugins are enabled by default as far as
   // |PluginList| is concerned.
@@ skipping 17 matching lines @@
   // be loaded on a web page and instead show a UI to update to the latest
   // version.
   void DisableOutdatedPluginGroups();
 
   ~PluginList();
 
  private:
   // Constructors are private for singletons
   PluginList();
 
+  // Creates PluginGroups for the group definitions in PluginGroup.cc, and adds

[Bernhard Bauer, 2010/12/07 10:32:05]

Nit: The file is called plugin_group.cc.

[Jakob Kummerow, 2010/12/07 11:43:08]

Done.

+  // them to the PluginGroup cache of this PluginList.
+  void AddHardcodedPluginGroups();
+
+  // Adds the given WebPluginInfo to its corresponding group, creating it if
+  // necessary, and returns the group.
+  PluginGroup* AddToPluginGroups(const WebPluginInfo& web_plugin_info);
+
   // Load all plugins from the default plugins directory
   void LoadPlugins(bool refresh);
 
   // Load all plugins from a specific directory.
   // |plugins| is updated with loaded plugin information.
   // |visited_plugins| is updated with paths to all plugins that were considered
   //   (including those we didn't load)
   void LoadPluginsFromDir(const FilePath& path,
                           std::vector<WebPluginInfo>* plugins,
                           std::set<FilePath>* visited_plugins);
 
   // Returns true if we should load the given plugin, or false otherwise.
   // plugins is the list of plugins we have crawled in the current plugin
   // loading run.
   bool ShouldLoadPlugin(const WebPluginInfo& info,
                         std::vector<WebPluginInfo>* plugins);
 
   // Return whether a plug-in group with the given name should be disabled,
   // either because it already is on the list of disabled groups, or because it
   // is blacklisted by a policy. In the latter case, add the plugin group to the
   // list of disabled groups as well.
   bool ShouldDisableGroup(const string16& group_name);
 
-  // Like GetPluginGroups above, but works on a given vector of plugins.
-  static void GetPluginGroups(const std::vector<WebPluginInfo>* plugins,
-                              PluginMap* plugin_groups);
-
   // Returns true if the given WebPluginInfo supports "mime-type".
   // mime_type should be all lower case.
   static bool SupportsType(const WebPluginInfo& info,
                            const std::string &mime_type,
                            bool allow_wildcard);
 
   // Returns true if the given WebPluginInfo supports a given file extension.
   // extension should be all lower case.
   // If mime_type is not NULL, it will be set to the mime type if found.
   // The mime type which corresponds to the extension is optionally returned
@@ skipping 43 matching lines @@
 
   // Extra plugin directories that we want to search when loading.
   std::vector<FilePath> extra_plugin_dirs_;
 
   // Holds information about internal plugins.
   std::vector<PluginVersionInfo> internal_plugins_;
 
   // Path names of plugins to disable (the default is to enable them all).
   std::set<FilePath> disabled_plugins_;
 
-  // Group names disable (the default is to enable them all).
+  // Group names to disable (the default is to enable them all).
   std::set<string16> disabled_groups_;
 
   bool disable_outdated_plugins_;
 
+  // Holds the currently available plugin groups.
+  PluginGroup::PluginMap plugin_groups_;
+
+  int next_priority_;
+
   // Need synchronization for the above members since this object can be
   // accessed on multiple threads.
   Lock lock_;
 
   friend struct base::DefaultLazyInstanceTraits<PluginList>;
 
   DISALLOW_COPY_AND_ASSIGN(PluginList);
 };
 
 }  // namespace NPAPI
 
 #endif  // WEBKIT_GLUE_PLUGINS_PLUGIN_LIST_H_