// Copyright 2014 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 EXTENSIONS_BROWSER_EXTENSION_PREFS_H_ #define EXTENSIONS_BROWSER_EXTENSION_PREFS_H_ #include <set> #include <string> #include <vector> #include "base/memory/linked_ptr.h" #include "base/memory/scoped_ptr.h" #include "base/observer_list.h" #include "base/prefs/scoped_user_pref_update.h" #include "base/time/time.h" #include "base/values.h" #include "components/keyed_service/core/keyed_service.h" #include "extensions/browser/app_sorting.h" #include "extensions/browser/blacklist_state.h" #include "extensions/browser/extension_scoped_prefs.h" #include "extensions/common/constants.h" #include "extensions/common/extension.h" #include "extensions/common/url_pattern_set.h" #include "sync/api/string_ordinal.h" class ExtensionPrefValueMap; class PrefService; namespace content { class BrowserContext; } namespace user_prefs { class PrefRegistrySyncable; } namespace extensions { class AppSorting; class ExtensionPrefsObserver; class ExtensionPrefsUninstallExtension; class URLPatternSet; // Class for managing global and per-extension preferences. // // This class distinguishes the following kinds of preferences: // - global preferences: // internal state for the extension system in general, not associated // with an individual extension, such as lastUpdateTime. // - per-extension preferences: // meta-preferences describing properties of the extension like // installation time, whether the extension is enabled, etc. // - extension controlled preferences: // browser preferences that an extension controls. For example, an // extension could use the proxy API to specify the browser's proxy // preference. Extension-controlled preferences are stored in // PrefValueStore::extension_prefs(), which this class populates and // maintains as the underlying extensions change. class ExtensionPrefs : public ExtensionScopedPrefs, public KeyedService { public: typedef std::vector<linked_ptr<ExtensionInfo> > ExtensionsInfo; // Vector containing identifiers for preferences. typedef std::set<std::string> PrefKeySet; // This enum is used to store the reason an extension's install has been // delayed. Do not remove items or re-order this enum as it is used in // preferences. enum DelayReason { DELAY_REASON_NONE = 0, DELAY_REASON_GC = 1, DELAY_REASON_WAIT_FOR_IDLE = 2, DELAY_REASON_WAIT_FOR_IMPORTS = 3, }; // Creates base::Time classes. The default implementation is just to return // the current time, but tests can inject alternative implementations. class TimeProvider { public: TimeProvider(); virtual ~TimeProvider(); // By default, returns the current time (base::Time::Now()). virtual base::Time GetCurrentTime() const; private: DISALLOW_COPY_AND_ASSIGN(TimeProvider); }; // A wrapper around a ScopedUserPrefUpdate, which allows us to access the // entry of a particular key for an extension. Use this if you need a mutable // record of a dictionary or list in the current settings. Otherwise, prefer // ReadPrefAsT() and UpdateExtensionPref() methods. template <typename T, base::Value::Type type_enum_value> class ScopedUpdate { public: ScopedUpdate(ExtensionPrefs* prefs, const std::string& extension_id, const std::string& key); virtual ~ScopedUpdate(); // Returns a mutable value for the key (ownership remains with the prefs), // if one exists. Otherwise, returns NULL. virtual T* Get(); // Creates and returns a mutable value for the key (the prefs own the new // value), if one does not already exist. Otherwise, returns the current // value. virtual T* Create(); private: DISALLOW_COPY_AND_ASSIGN(ScopedUpdate); DictionaryPrefUpdate update_; const std::string extension_id_; const std::string key_; }; typedef ScopedUpdate<base::DictionaryValue, base::Value::TYPE_DICTIONARY> ScopedDictionaryUpdate; typedef ScopedUpdate<base::ListValue, base::Value::TYPE_LIST> ScopedListUpdate; // Creates an ExtensionPrefs object. // Does not take ownership of |prefs| or |extension_pref_value_map|. // If |extensions_disabled| is true, extension controlled preferences and // content settings do not become effective. ExtensionPrefsObservers should be // included in |early_observers| if they need to observe events which occur // during initialization of the ExtensionPrefs object. static ExtensionPrefs* Create( PrefService* prefs, const base::FilePath& root_dir, ExtensionPrefValueMap* extension_pref_value_map, scoped_ptr<AppSorting> app_sorting, bool extensions_disabled, const std::vector<ExtensionPrefsObserver*>& early_observers); // A version of Create which allows injection of a custom base::Time provider. // Use this as needed for testing. static ExtensionPrefs* Create( PrefService* prefs, const base::FilePath& root_dir, ExtensionPrefValueMap* extension_pref_value_map, scoped_ptr<AppSorting> app_sorting, bool extensions_disabled, const std::vector<ExtensionPrefsObserver*>& early_observers, scoped_ptr<TimeProvider> time_provider); virtual ~ExtensionPrefs(); // Convenience function to get the ExtensionPrefs for a BrowserContext. static ExtensionPrefs* Get(content::BrowserContext* context); // Returns all installed extensions from extension preferences provided by // |pref_service|. This is exposed for ProtectedPrefsWatcher because it needs // access to the extension ID list before the ExtensionService is initialized. static ExtensionIdList GetExtensionsFrom(const PrefService* pref_service); // Add or remove an observer from the ExtensionPrefs. void AddObserver(ExtensionPrefsObserver* observer); void RemoveObserver(ExtensionPrefsObserver* observer); // Returns true if the specified external extension was uninstalled by the // user. bool IsExternalExtensionUninstalled(const std::string& id) const; // Checks whether |extension_id| is disabled. If there's no state pref for // the extension, this will return false. Generally you should use // ExtensionService::IsExtensionEnabled instead. bool IsExtensionDisabled(const std::string& id) const; // Get/Set the order that the browser actions appear in the toolbar. ExtensionIdList GetToolbarOrder(); void SetToolbarOrder(const ExtensionIdList& extension_ids); // Gets the set of known disabled extension IDs into |id_set_out|. Returns // false iff the set of known disabled extension IDs hasn't been set yet. bool GetKnownDisabled(ExtensionIdSet* id_set_out); // Sets the set of known disabled extension IDs. void SetKnownDisabled(const ExtensionIdSet& extension_ids); // Called when an extension is installed, so that prefs get created. // |blacklisted_for_malware| should be set if the extension was included in a // blacklist due to being malware. If |page_ordinal| is an invalid ordinal, // then a page will be found for the App. void OnExtensionInstalled(const Extension* extension, Extension::State initial_state, bool blacklisted_for_malware, const syncer::StringOrdinal& page_ordinal, const std::string& install_parameter); // Called when an extension is uninstalled, so that prefs get cleaned up. void OnExtensionUninstalled(const std::string& extension_id, const Manifest::Location& location, bool external_uninstall); // Called to change the extension's state when it is enabled/disabled. void SetExtensionState(const std::string& extension_id, Extension::State); // Called to change the extension's BlacklistState. Currently only used for // non-malicious extensions. // TODO(oleg): replace SetExtensionBlacklisted by this function. void SetExtensionBlacklistState(const std::string& extension_id, BlacklistState state); // Checks whether |extension_id| is marked as greylisted. // TODO(oleg): Replace IsExtensionBlacklisted by this method. BlacklistState GetExtensionBlacklistState(const std::string& extension_id); // Populates |out| with the ids of all installed extensions. void GetExtensions(ExtensionIdList* out); // ExtensionScopedPrefs methods: virtual void UpdateExtensionPref(const std::string& id, const std::string& key, base::Value* value) OVERRIDE; virtual void DeleteExtensionPrefs(const std::string& id) OVERRIDE; virtual bool ReadPrefAsBoolean(const std::string& extension_id, const std::string& pref_key, bool* out_value) const OVERRIDE; virtual bool ReadPrefAsInteger(const std::string& extension_id, const std::string& pref_key, int* out_value) const OVERRIDE; virtual bool ReadPrefAsString(const std::string& extension_id, const std::string& pref_key, std::string* out_value) const OVERRIDE; virtual bool ReadPrefAsList(const std::string& extension_id, const std::string& pref_key, const base::ListValue** out_value) const OVERRIDE; virtual bool ReadPrefAsDictionary( const std::string& extension_id, const std::string& pref_key, const base::DictionaryValue** out_value) const OVERRIDE; virtual bool HasPrefForExtension(const std::string& extension_id) const OVERRIDE; // 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, bool did_escalate); // Getter and setters for disabled reason. int GetDisableReasons(const std::string& extension_id) const; void AddDisableReason(const std::string& extension_id, Extension::DisableReason disable_reason); void RemoveDisableReason(const std::string& extension_id, Extension::DisableReason disable_reason); void ClearDisableReasons(const std::string& extension_id); // Gets the set of extensions that have been blacklisted in prefs. This will // return only the blocked extensions, not the "greylist" extensions. // TODO(oleg): Make method names consistent here, in extension service and in // blacklist. std::set<std::string> GetBlacklistedExtensions(); // Sets whether the extension with |id| is blacklisted. void SetExtensionBlacklisted(const std::string& extension_id, bool is_blacklisted); // Returns the version string for the currently installed extension, or // the empty string if not found. std::string GetVersionString(const std::string& extension_id); // Re-writes the extension manifest into the prefs. // Called to change the extension's manifest when it's re-localized. void UpdateManifest(const Extension* extension); // Returns extension path based on extension ID, or empty FilePath on error. base::FilePath GetExtensionPath(const std::string& extension_id); // Returns base extensions install directory. const base::FilePath& install_directory() const { return install_directory_; } // Returns whether the extension with |id| has its blacklist bit set. // // WARNING: this only checks the extension's entry in prefs, so by definition // can only check extensions that prefs knows about. There may be other // sources of blacklist information, such as safebrowsing. You probably want // to use Blacklist::GetBlacklistedIDs rather than this method. bool IsExtensionBlacklisted(const std::string& id) const; // Increment the count of how many times we prompted the user to acknowledge // the given extension, and return the new count. int IncrementAcknowledgePromptCount(const std::string& extension_id); // Whether the user has acknowledged an external extension. bool IsExternalExtensionAcknowledged(const std::string& extension_id); void AcknowledgeExternalExtension(const std::string& extension_id); // Whether the user has acknowledged a blacklisted extension. bool IsBlacklistedExtensionAcknowledged(const std::string& extension_id); void AcknowledgeBlacklistedExtension(const std::string& extension_id); // Whether the external extension was installed during the first run // of this profile. bool IsExternalInstallFirstRun(const std::string& extension_id); void SetExternalInstallFirstRun(const std::string& extension_id); // Whether the user has been notified about extension with |extension_id| // being wiped out. bool HasWipeoutBeenAcknowledged(const std::string& extension_id); void SetWipeoutAcknowledged(const std::string& extension_id, bool value); // Whether the user has been notified about extension with |extension_id| // taking over some aspect of the user's settings (homepage, startup pages, // or search engine). bool HasSettingsApiBubbleBeenAcknowledged(const std::string& extension_id); void SetSettingsApiBubbleBeenAcknowledged(const std::string& extension_id, bool value); // Returns true if the extension notification code has already run for the // first time for this profile. Currently we use this flag to mean that any // extensions that would trigger notifications should get silently // acknowledged. This is a fuse. Calling it the first time returns false. // Subsequent calls return true. It's not possible through an API to ever // reset it. Don't call it unless you mean it! bool SetAlertSystemFirstRun(); // Checks if extensions are blacklisted by default, by policy. // The ManagementPolicy::Provider methods also take this into account, and // should be used instead when the extension ID is known. bool ExtensionsBlacklistedByDefault() const; // Returns the last value set via SetLastPingDay. If there isn't such a // pref, the returned Time will return true for is_null(). base::Time LastPingDay(const std::string& extension_id) const; // The time stored is based on the server's perspective of day start time, not // the client's. void SetLastPingDay(const std::string& extension_id, const base::Time& time); // Similar to the 2 above, but for the extensions blacklist. base::Time BlacklistLastPingDay() const; void SetBlacklistLastPingDay(const base::Time& time); // Similar to LastPingDay/SetLastPingDay, but for sending "days since active" // ping. base::Time LastActivePingDay(const std::string& extension_id); void SetLastActivePingDay(const std::string& extension_id, const base::Time& time); // A bit we use for determining if we should send the "days since active" // ping. A value of true means the item has been active (launched) since the // last update check. bool GetActiveBit(const std::string& extension_id); void SetActiveBit(const std::string& extension_id, bool active); // Returns the granted permission set for the extension with |extension_id|, // and NULL if no preferences were found for |extension_id|. // This passes ownership of the returned set to the caller. PermissionSet* GetGrantedPermissions(const std::string& extension_id); // Adds |permissions| to the granted permissions set for the extension with // |extension_id|. The new granted permissions set will be the union of // |permissions| and the already granted permissions. void AddGrantedPermissions(const std::string& extension_id, const PermissionSet* permissions); // As above, but subtracts the given |permissions| from the granted set. void RemoveGrantedPermissions(const std::string& extension_id, const PermissionSet* permissions); // Gets the active permission set for the specified extension. This may // differ from the permissions in the manifest due to the optional // permissions API. This passes ownership of the set to the caller. PermissionSet* GetActivePermissions(const std::string& extension_id); // Sets the active |permissions| for the extension with |extension_id|. void SetActivePermissions(const std::string& extension_id, const PermissionSet* permissions); // Records whether or not this extension is currently running. void SetExtensionRunning(const std::string& extension_id, bool is_running); // Returns whether or not this extension is marked as running. This is used to // restart apps across browser restarts. bool IsExtensionRunning(const std::string& extension_id); // Set/Get whether or not the app is active. Used to force a launch of apps // that don't handle onRestarted() on a restart. We can only safely do that if // the app was active when it was last running. void SetIsActive(const std::string& extension_id, bool is_active); bool IsActive(const std::string& extension_id); // Returns true if the user enabled this extension to be loaded in incognito // mode. // // IMPORTANT: you probably want to use extensions::util::IsIncognitoEnabled // instead of this method. bool IsIncognitoEnabled(const std::string& extension_id) const; void SetIsIncognitoEnabled(const std::string& extension_id, bool enabled); // Returns true if the user has chosen to allow this extension to inject // scripts into pages with file URLs. // // IMPORTANT: you probably want to use extensions::util::AllowFileAccess // instead of this method. bool AllowFileAccess(const std::string& extension_id) const; void SetAllowFileAccess(const std::string& extension_id, bool allow); bool HasAllowFileAccessSetting(const std::string& extension_id) const; // Saves ExtensionInfo for each installed extension with the path to the // version directory and the location. Blacklisted extensions won't be saved // and neither will external extensions the user has explicitly uninstalled. // Caller takes ownership of returned structure. scoped_ptr<ExtensionsInfo> GetInstalledExtensionsInfo() const; // Same as above, but only includes external extensions the user has // explicitly uninstalled. scoped_ptr<ExtensionsInfo> GetUninstalledExtensionsInfo() const; // Returns the ExtensionInfo from the prefs for the given extension. If the // extension is not present, NULL is returned. scoped_ptr<ExtensionInfo> GetInstalledExtensionInfo( const std::string& extension_id) const; // We've downloaded an updated .crx file for the extension, but are waiting // to install it. void SetDelayedInstallInfo(const Extension* extension, Extension::State initial_state, bool blacklisted_for_malware, DelayReason delay_reason, const syncer::StringOrdinal& page_ordinal, const std::string& install_parameter); // Removes any delayed install information we have for the given // |extension_id|. Returns true if there was info to remove; false otherwise. bool RemoveDelayedInstallInfo(const std::string& extension_id); // Update the prefs to finish the update for an extension. bool FinishDelayedInstallInfo(const std::string& extension_id); // Returns the ExtensionInfo from the prefs for delayed install information // for |extension_id|, if we have any. Otherwise returns NULL. scoped_ptr<ExtensionInfo> GetDelayedInstallInfo( const std::string& extension_id) const; DelayReason GetDelayedInstallReason(const std::string& extension_id) const; // Returns information about all the extensions that have delayed install // information. scoped_ptr<ExtensionsInfo> GetAllDelayedInstallInfo() const; // Returns information about evicted ephemeral apps. scoped_ptr<ExtensionsInfo> GetEvictedEphemeralAppsInfo() const; // Return information about a specific evicted ephemeral app. Can return NULL // if no such evicted app exists or is currently installed. scoped_ptr<ExtensionInfo> GetEvictedEphemeralAppInfo( const std::string& extension_id) const; // Permanently remove the preferences for an evicted ephemeral app. void RemoveEvictedEphemeralApp(const std::string& extension_id); // Returns true if the user repositioned the app on the app launcher via drag // and drop. bool WasAppDraggedByUser(const std::string& extension_id); // Sets a flag indicating that the user repositioned the app on the app // launcher by drag and dropping it. void SetAppDraggedByUser(const std::string& extension_id); // Returns true if there is an extension which controls the preference value // for |pref_key| *and* it is specific to incognito mode. bool HasIncognitoPrefValue(const std::string& pref_key); // Returns the creation flags mask for the extension. int GetCreationFlags(const std::string& extension_id) const; // Returns the creation flags mask for a delayed install extension. int GetDelayedInstallCreationFlags(const std::string& extension_id) const; // Returns true if the extension was installed from the Chrome Web Store. bool IsFromWebStore(const std::string& extension_id) const; // Returns true if the extension was installed from an App generated from a // bookmark. bool IsFromBookmark(const std::string& extension_id) const; // Returns true if the extension was installed as a default app. bool WasInstalledByDefault(const std::string& extension_id) const; // Returns true if the extension was installed as an oem app. bool WasInstalledByOem(const std::string& extension_id) const; // Helper method to acquire the installation time of an extension. // Returns base::Time() if the installation time could not be parsed or // found. base::Time GetInstallTime(const std::string& extension_id) const; // Gets/sets the last launch time of an extension. base::Time GetLastLaunchTime(const std::string& extension_id) const; void SetLastLaunchTime(const std::string& extension_id, const base::Time& time); static void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry); bool extensions_disabled() const { return extensions_disabled_; } // The underlying PrefService. PrefService* pref_service() const { return prefs_; } // The underlying AppSorting. AppSorting* app_sorting() const { return app_sorting_.get(); } // Describes the URLs that are able to install extensions. See // pref_names::kAllowedInstallSites for more information. URLPatternSet GetAllowedInstallSites(); // Schedules garbage collection of an extension's on-disk data on the next // start of this ExtensionService. Applies only to extensions with isolated // storage. void SetNeedsStorageGarbageCollection(bool value); bool NeedsStorageGarbageCollection(); // Used by AppWindowGeometryCache to persist its cache. These methods // should not be called directly. const base::DictionaryValue* GetGeometryCache( const std::string& extension_id) const; void SetGeometryCache(const std::string& extension_id, scoped_ptr<base::DictionaryValue> cache); // Used for verification of installed extension ids. For the Set method, pass // null to remove the preference. const base::DictionaryValue* GetInstallSignature(); void SetInstallSignature(const base::DictionaryValue* signature); // The installation parameter associated with the extension. std::string GetInstallParam(const std::string& extension_id) const; void SetInstallParam(const std::string& extension_id, const std::string& install_parameter); private: friend class ExtensionPrefsBlacklistedExtensions; // Unit test. friend class ExtensionPrefsUninstallExtension; // Unit test. enum DisableReasonChange { DISABLE_REASON_ADD, DISABLE_REASON_REMOVE, DISABLE_REASON_CLEAR }; // See the Create methods. ExtensionPrefs(PrefService* prefs, const base::FilePath& root_dir, ExtensionPrefValueMap* extension_pref_value_map, scoped_ptr<AppSorting> app_sorting, scoped_ptr<TimeProvider> time_provider, bool extensions_disabled, const std::vector<ExtensionPrefsObserver*>& early_observers); // 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(base::DictionaryValue* dict); // Helper function used by GetInstalledExtensionInfo() and // GetDelayedInstallInfo() to construct an ExtensionInfo from the provided // |extension| dictionary. scoped_ptr<ExtensionInfo> GetInstalledInfoHelper( const std::string& extension_id, const base::DictionaryValue* extension) const; // Interprets the list pref, |pref_key| in |extension_id|'s preferences, as a // URLPatternSet. The |valid_schemes| specify how to parse the URLPatterns. bool ReadPrefAsURLPatternSet(const std::string& extension_id, const std::string& pref_key, URLPatternSet* result, int valid_schemes); // Converts |new_value| to a list of strings and sets the |pref_key| pref // belonging to |extension_id|. void SetExtensionPrefURLPatternSet(const std::string& extension_id, const std::string& pref_key, const URLPatternSet& new_value); // Read the boolean preference entry and return true if the preference exists // and the preference's value is true; false otherwise. bool ReadPrefAsBooleanAndReturn(const std::string& extension_id, const std::string& key) const; // Interprets |pref_key| in |extension_id|'s preferences as an // PermissionSet, and passes ownership of the set to the caller. PermissionSet* ReadPrefAsPermissionSet(const std::string& extension_id, const std::string& pref_key); // Converts the |new_value| to its value and sets the |pref_key| pref // belonging to |extension_id|. void SetExtensionPrefPermissionSet(const std::string& extension_id, const std::string& pref_key, const PermissionSet* new_value); // Returns an immutable dictionary for extension |id|'s prefs, or NULL if it // doesn't exist. const base::DictionaryValue* GetExtensionPref(const std::string& id) const; // Modifies the extensions disable reasons to add a new reason, remove an // existing reason, or clear all reasons. Notifies observers if the set of // DisableReasons has changed. // If |change| is DISABLE_REASON_CLEAR, then |reason| is ignored. void ModifyDisableReason(const std::string& extension_id, Extension::DisableReason reason, DisableReasonChange change); // Fix missing preference entries in the extensions that are were introduced // in a later Chrome version. void FixMissingPrefs(const ExtensionIdList& extension_ids); // Installs the persistent extension preferences into |prefs_|'s extension // pref store. Does nothing if extensions_disabled_ is true. void InitPrefStore(); // Migrates the permissions data in the pref store. void MigratePermissions(const ExtensionIdList& extension_ids); // Migrates the disable reasons from a single enum to a bit mask. void MigrateDisableReasons(const ExtensionIdList& extension_ids); // Checks whether there is a state pref for the extension and if so, whether // it matches |check_state|. bool DoesExtensionHaveState(const std::string& id, Extension::State check_state) const; // Reads the list of strings for |pref| from user prefs into // |id_container_out|. Returns false if the pref wasn't found in the user // pref store. template <class ExtensionIdContainer> bool GetUserExtensionPrefIntoContainer( const char* pref, ExtensionIdContainer* id_container_out); // Writes the list of strings contained in |strings| to |pref| in prefs. template <class ExtensionIdContainer> void SetExtensionPrefFromContainer(const char* pref, const ExtensionIdContainer& strings); // Helper function to populate |extension_dict| with the values needed // by a newly installed extension. Work is broken up between this // function and FinishExtensionInfoPrefs() to accomodate delayed // installations. void PopulateExtensionInfoPrefs(const Extension* extension, const base::Time install_time, Extension::State initial_state, bool blacklisted_for_malware, const std::string& install_parameter, base::DictionaryValue* extension_dict); void InitExtensionControlledPrefs(ExtensionPrefValueMap* value_map); // Helper function to complete initialization of the values in // |extension_dict| for an extension install. Also see // PopulateExtensionInfoPrefs(). void FinishExtensionInfoPrefs( const std::string& extension_id, const base::Time install_time, bool needs_sort_ordinal, const syncer::StringOrdinal& suggested_page_ordinal, base::DictionaryValue* extension_dict); // The pref service specific to this set of extension prefs. Owned by the // BrowserContext. PrefService* prefs_; // Base extensions install directory. base::FilePath install_directory_; // Weak pointer, owned by BrowserContext. ExtensionPrefValueMap* extension_pref_value_map_; // Contains all the logic for handling the order for various extension // properties. scoped_ptr<AppSorting> app_sorting_; scoped_ptr<TimeProvider> time_provider_; bool extensions_disabled_; ObserverList<ExtensionPrefsObserver> observer_list_; DISALLOW_COPY_AND_ASSIGN(ExtensionPrefs); }; } // namespace extensions #endif // EXTENSIONS_BROWSER_EXTENSION_PREFS_H_