| // Copyright 2016 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_UI_WEBUI_SITE_SETTINGS_HELPER_H_ |
| #define CHROME_BROWSER_UI_WEBUI_SITE_SETTINGS_HELPER_H_ |
| |
| #include <map> |
| #include <memory> |
| #include <set> |
| #include <string> |
| #include <utility> |
| #include <vector> |
| |
| #include "components/content_settings/core/common/content_settings.h" |
| #include "components/content_settings/core/common/content_settings_pattern.h" |
| #include "components/content_settings/core/common/content_settings_types.h" |
| #include "content/public/browser/web_ui.h" |
| #include "extensions/common/extension.h" |
| |
| class ChooserContextBase; |
| class HostContentSettingsMap; |
| class Profile; |
| |
| namespace base { |
| class DictionaryValue; |
| class ListValue; |
| } // namespace base |
| |
| namespace extensions { |
| class ExtensionRegistry; |
| } |
| |
| namespace site_settings { |
| |
| // Maps from a secondary pattern to a setting. |
| typedef std::map<ContentSettingsPattern, ContentSetting> OnePatternSettings; |
| // Maps from a primary pattern/source pair to a OnePatternSettings. All the |
| // mappings in OnePatternSettings share the given primary pattern and source. |
| typedef std::map<std::pair<ContentSettingsPattern, std::string>, |
| OnePatternSettings> |
| AllPatternsSettings; |
| |
| // TODO(https://crbug.com/854329): Once the Site Settings WebUI is capable of |
| // displaying the new chooser exception object format, remove the typedefs that |
| // are currently used for organizing the chooser exceptions. |
| // Maps from a primary URL pattern/source pair to a set of secondary URL |
| // patterns. |
| using ChooserExceptionDetails = |
| std::map<std::pair<GURL, std::string>, std::set<GURL>>; |
| |
| // Maps from a chooser exception name/object pair to a ChooserExceptionDetails. |
| // This will group and sort the exceptions by the UI string and object for |
| // display. |
| using AllChooserObjects = |
| std::map<std::pair<std::string, base::Value>, ChooserExceptionDetails>; |
| |
| constexpr char kChooserType[] = "chooserType"; |
| constexpr char kDisplayName[] = "displayName"; |
| constexpr char kEmbeddingOrigin[] = "embeddingOrigin"; |
| constexpr char kIncognito[] = "incognito"; |
| constexpr char kObject[] = "object"; |
| constexpr char kOrigin[] = "origin"; |
| constexpr char kOriginForFavicon[] = "originForFavicon"; |
| constexpr char kSetting[] = "setting"; |
| constexpr char kSites[] = "sites"; |
| constexpr char kSource[] = "source"; |
| |
| // Group types. |
| constexpr char kGroupTypeUsb[] = "usb-devices"; |
| |
| enum class SiteSettingSource { |
| kAdsFilterBlacklist, |
| kDefault, |
| kDrmDisabled, |
| kEmbargo, |
| kExtension, |
| kInsecureOrigin, |
| kKillSwitch, |
| kPolicy, |
| kPreference, |
| kNumSources, |
| }; |
| |
| // Returns whether a group name has been registered for the given type. |
| bool HasRegisteredGroupName(ContentSettingsType type); |
| |
| // Converts a ContentSettingsType to/from its group name identifier. |
| ContentSettingsType ContentSettingsTypeFromGroupName(const std::string& name); |
| std::string ContentSettingsTypeToGroupName(ContentSettingsType type); |
| |
| // Converts a SiteSettingSource to its string identifier. |
| std::string SiteSettingSourceToString(const SiteSettingSource source); |
| |
| // Helper function to construct a dictionary for an exception. |
| std::unique_ptr<base::DictionaryValue> GetExceptionForPage( |
| const ContentSettingsPattern& pattern, |
| const ContentSettingsPattern& secondary_pattern, |
| const std::string& display_name, |
| const ContentSetting& setting, |
| const std::string& provider_name, |
| bool incognito); |
| |
| // Helper function to construct a dictionary for a hosted app exception. |
| void AddExceptionForHostedApp(const std::string& url_pattern, |
| const extensions::Extension& app, |
| base::ListValue* exceptions); |
| |
| // Fills in |exceptions| with Values for the given |type| from |map|. |
| // If |filter| is not null then only exceptions with matching primary patterns |
| // will be returned. |
| void GetExceptionsFromHostContentSettingsMap( |
| const HostContentSettingsMap* map, |
| ContentSettingsType type, |
| const extensions::ExtensionRegistry* extension_registry, |
| content::WebUI* web_ui, |
| bool incognito, |
| const std::string* filter, |
| base::ListValue* exceptions); |
| |
| // Fills in object saying what the current settings is for the category (such as |
| // enabled or blocked) and the source of that setting (such preference, policy, |
| // or extension). |
| void GetContentCategorySetting(const HostContentSettingsMap* map, |
| ContentSettingsType content_type, |
| base::DictionaryValue* object); |
| |
| // Retrieves the current setting for a given origin, category pair, the source |
| // of that setting, and its display name, which will be different if it's an |
| // extension. Note this is similar to GetContentCategorySetting() above but this |
| // goes through the PermissionManager (preferred, see https://crbug.com/739241). |
| ContentSetting GetContentSettingForOrigin( |
| Profile* profile, |
| const HostContentSettingsMap* map, |
| const GURL& origin, |
| ContentSettingsType content_type, |
| std::string* source_string, |
| const extensions::ExtensionRegistry* extension_registry, |
| std::string* display_name); |
| |
| // Returns exceptions constructed from the policy-set allowed URLs |
| // for the content settings |type| mic or camera. |
| void GetPolicyAllowedUrls( |
| ContentSettingsType type, |
| std::vector<std::unique_ptr<base::DictionaryValue>>* exceptions, |
| const extensions::ExtensionRegistry* extension_registry, |
| content::WebUI* web_ui, |
| bool incognito); |
| |
| // This struct facilitates lookup of a chooser context factory function by name |
| // for a given content settings type and is declared early so that it can used |
| // by functions below. |
| struct ChooserTypeNameEntry { |
| ChooserContextBase* (*get_context)(Profile*); |
| const char* name; |
| }; |
| |
| struct ContentSettingsTypeNameEntry { |
| ContentSettingsType type; |
| const char* name; |
| }; |
| |
| const ChooserTypeNameEntry* ChooserTypeFromGroupName(const std::string& name); |
| |
| // Fills in |exceptions| with Values for the given |chooser_type| from map. |
| void GetChooserExceptionsFromProfile(Profile* profile, |
| bool incognito, |
| const ChooserTypeNameEntry& chooser_type, |
| base::ListValue* exceptions); |
| |
| // TODO(https://crbug.com/854329): Once the Site Settings WebUI is capable of |
| // displaying the new chooser exception object format, replace the existing |
| // chooser exception methods with these methods. |
| |
| // Creates a chooser exception object for the object with |display_name|. The |
| // object contains the following properties |
| // * displayName: string, |
| // * object: Object, |
| // * chooserType: string, |
| // * sites: Array<SiteException> |
| // The structure of the SiteException objects is the same as the objects |
| // returned by GetExceptionForPage(). |
| std::unique_ptr<base::DictionaryValue> CreateChooserExceptionObject( |
| const std::string& display_name, |
| const base::Value& object, |
| const std::string& chooser_type, |
| const ChooserExceptionDetails& chooser_exception_details, |
| bool incognito); |
| |
| // Returns an array of chooser exception objects. |
| std::unique_ptr<base::ListValue> GetChooserExceptionListFromProfile( |
| Profile* profile, |
| bool incognito, |
| const ChooserTypeNameEntry& chooser_type); |
| |
| } // namespace site_settings |
| |
| #endif // CHROME_BROWSER_UI_WEBUI_SITE_SETTINGS_HELPER_H_ |