Fix for Bug 50726 "Save extension list and "winning" prefs from extensions"

chrome/browser/extensions/extension_prefs.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 CHROME_BROWSER_EXTENSIONS_EXTENSION_PREFS_H_
 #define CHROME_BROWSER_EXTENSIONS_EXTENSION_PREFS_H_
 #pragma once
 
 #include <set>
 #include <string>
 #include <vector>
 
 #include "base/linked_ptr.h"
 #include "base/time.h"
 #include "chrome/browser/prefs/pref_service.h"
 #include "chrome/common/extensions/extension.h"
 #include "googleurl/src/gurl.h"
 
 // Class for managing global and per-extension preferences.
 // This class is instantiated by ExtensionsService, so it should be accessed
 // from there.
+//
+// This class distinguishes the following kinds of preferences:
+// - global preferences:
+//       not associated with extensions
+// - per-extension preferences:
+//       meta-preferences describing properties of the extension like
+//       installation time, whether the extension is enabled, etc.
+// - extension controlled preferences:
+//       global preferences that an individual extension wants to set

[Mattias Nissler (ping if slow), 2010/11/18 16:30:33]

Maybe not that these are arbitrary preferences (from other subsystems) that the
extension wants to override.

[battre (please use the other), 2010/11/18 16:47:33]

Done.

+//

[Mattias Nissler (ping if slow), 2010/11/18 16:30:33]

Remove newline.

[battre (please use the other), 2010/11/18 16:47:33]

Done.

 class ExtensionPrefs {
  public:
   // Key name for a preference that keeps track of per-extension settings. This
   // is a dictionary object read from the Preferences file, keyed off of
   // extension ids.
   static const char kExtensionsPref[];
 
   typedef std::vector<linked_ptr<ExtensionInfo> > ExtensionsInfo;
 
   // This enum is used for the launch type the user wants to use for an
@@ skipping 34 matching lines @@
   void OnExtensionInstalled(const Extension* extension,
                             Extension::State initial_state,
                             bool initial_incognito_enabled);
 
   // Called when an extension is uninstalled, so that prefs get cleaned up.
   void OnExtensionUninstalled(const std::string& extension_id,
                               const Extension::Location& location,
                               bool external_uninstall);
 
   // Returns the state (enabled/disabled) of the given extension.
-  Extension::State GetExtensionState(const std::string& extension_id);
+  Extension::State GetExtensionState(const std::string& extension_id) const;
 
   // Called to change the extension's state when it is enabled/disabled.
   void SetExtensionState(const Extension* extension, Extension::State);
 
   // Did the extension ask to escalate its permission during an upgrade?
   bool DidExtensionEscalatePermissions(const std::string& id);
 
   // If |did_escalate| is true, the preferences for |extension| will be set to
   // require the install warning when the user tries to enable.
   void SetDidExtensionEscalatePermissions(const Extension* extension,
@@ skipping 100 matching lines @@
   // highest current application launch index found.
   int GetNextAppLaunchIndex();
 
   // The extension's update URL data.  If not empty, the ExtensionUpdater
   // will append a ap= parameter to the URL when checking if a new version
   // of the extension is available.
   void SetUpdateUrlData(const std::string& extension_id,
                         const std::string& data);
   std::string GetUpdateUrlData(const std::string& extension_id);
 
+  // Sets a preference value that is controlled by the extension. In other
+  // words, this is not a pref value *about* the extension but something
+  // global the extension wants to override.
+  void SetExtensionControlledPref(const std::string& extension_id,
+                                  const std::string& pref_key,
+                                  Value* value);
+
   static void RegisterUserPrefs(PrefService* prefs);
 
   // The underlying PrefService.
   PrefService* pref_service() const { return prefs_; }
 
+ protected:
+  // For unit testing

[Mattias Nissler (ping if slow), 2010/11/18 16:30:33]

Missing period.

And I think this deserves a more elaborate comment that explains why we would
want to ask the ExtensionPrefs object for a timestamp.

[battre (please use the other), 2010/11/18 16:47:33]

Done.

+  base::Time GetCurrentTime() const;
+
  private:
   // Converts absolute paths in the pref to paths relative to the
   // install_directory_.
   void MakePathsRelative();
 
   // Converts internal relative paths to be absolute. Used for export to
   // consumers who expect full paths.
   void MakePathsAbsolute(DictionaryValue* dict);
 
   // Sets the pref |key| for extension |id| to |value|.
@@ skipping 21 matching lines @@
   bool ReadExtensionPrefInteger(const std::string& extension_id,
                                 const std::string& pref_key,
                                 int* out_value);
 
   // Ensures and returns a mutable dictionary for extension |id|'s prefs.
   DictionaryValue* GetOrCreateExtensionPref(const std::string& id);
 
   // Same as above, but returns NULL if it doesn't exist.
   DictionaryValue* GetExtensionPref(const std::string& id) const;
 
+  // Returns the dictionary of preferences controlled by the specified extension
+  // or NULL if unknown. All entries in the dictionary contain non-expanded
+  // paths.
+  DictionaryValue* GetExtensionControlledPrefs(const std::string& id) const;
+
   // Serializes the data and schedules a persistent save via the |PrefService|.
   // Additionally fires a PREF_CHANGED notification with the top-level
   // |kExtensionsPref| path set.
   // TODO(andybons): Switch this to EXTENSION_PREF_CHANGED to be more granular.
   // TODO(andybons): Use a ScopedPrefUpdate to update observers on changes to
   // the mutable extension dictionary.
   void SavePrefsAndNotify();
 
   // Checks if kPrefBlacklist is set to true in the DictionaryValue.
   // Return false if the value is false or kPrefBlacklist does not exist.
   // This is used to decide if an extension is blacklisted.
   bool IsBlacklistBitSet(DictionaryValue* ext);
 
   // Helper methods for the public last ping day functions.
   base::Time LastPingDayImpl(const DictionaryValue* dictionary) const;
   void SetLastPingDayImpl(const base::Time& time, DictionaryValue* dictionary);
 
+  // Helper method to acquire the installation time of an extension
+  base::Time GetInstallTime(const DictionaryValue* extension) const;

[Mattias Nissler (ping if slow), 2010/11/18 16:30:33]

Why is that parameter a DictionaryValue*? I'd expect an extension ID.

[battre (please use the other), 2010/11/18 16:47:33]

It is a simple helper method and we need to compare DictionaryValue* elements by
their time. I could add a function std::string GetExtensionId(const
DicationaryValue* extension) and pass the return value to the new
GetInstallTime(std::string) function. But would you recommend to do that?

+
+  // Installs the persistent extension preferences into prefs_'s extension

[Mattias Nissler (ping if slow), 2010/11/18 16:30:33]

|pref_|'s

[battre (please use the other), 2010/11/18 16:47:33]

Done.

+  // pref store.
+  void InstallPersistedExtensionControlledPrefs();
+
+  // Returns the extension controlled preference value of the extension that was
+  // installed most recently.
+  const Value* WinningExtensionControlledPrefValue(const std::string& key)

[Mattias Nissler (ping if slow), 2010/11/18 16:30:33]

Again, why a Value* and not an extension ID?

[battre (please use the other), 2010/11/18 16:47:33]

this time it is "...Controlle*d*PrefValue", not "Controll*ing*PrefValue". We
could add more indirections. Ask for the winning extension id and then based on
this on its value. Do you prefer this?

+      const;
+
+  // Store the WinningExtensionControlledPrefValue in the PrefValueStore's

[Mattias Nissler (ping if slow), 2010/11/18 16:30:33]

what value? ;) Maybe say it in prose :)

[battre (please use the other), 2010/11/18 16:47:33]

Done.

+  // extension pref store and send notifications to provider in case of
+  // a changed value.
+  void UpdateWinningPref(const std::string& pref_key);
+
+  // Retrieves a list of preference keys that the specified extension
+  // intents to manage.
+  void GetExtensionControlledPrefKeys(const std::string& extension_id,
+                                      std::vector<std::string> *out) const;
+
   // The pref service specific to this set of extension prefs.
   PrefService* prefs_;
 
   // Base extensions install directory.
   FilePath install_directory_;
 
   // The URLs of all of the toolstrips.
   URLList shelf_order_;
 
   DISALLOW_COPY_AND_ASSIGN(ExtensionPrefs);
 };
 
 #endif  // CHROME_BROWSER_EXTENSIONS_EXTENSION_PREFS_H_