| // Copyright 2015 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_PERMISSIONS_PERMISSION_MANAGER_H_ |
| #define CHROME_BROWSER_PERMISSIONS_PERMISSION_MANAGER_H_ |
| |
| #include <unordered_map> |
| |
| #include "base/callback_forward.h" |
| #include "base/containers/id_map.h" |
| #include "base/macros.h" |
| #include "chrome/browser/permissions/permission_util.h" |
| #include "components/content_settings/core/browser/content_settings_observer.h" |
| #include "components/content_settings/core/common/content_settings.h" |
| #include "components/keyed_service/core/keyed_service.h" |
| #include "content/public/browser/permission_manager.h" |
| |
| class PermissionContextBase; |
| struct PermissionResult; |
| class Profile; |
| |
| namespace content { |
| enum class PermissionType; |
| }; // namespace content |
| |
| class PermissionManager : public KeyedService, |
| public content::PermissionManager, |
| public content_settings::Observer { |
| public: |
| static PermissionManager* Get(Profile* profile); |
| |
| explicit PermissionManager(Profile* profile); |
| ~PermissionManager() override; |
| |
| // Converts from |url|'s actual origin to the "canonical origin" that should |
| // be used for the purpose of requesting/storing permissions. For example, the |
| // origin of the local NTP gets mapped to the Google base URL instead. All the |
| // public methods below, such as RequestPermission or GetPermissionStatus, |
| // take the actual origin and do the canonicalization internally. You only |
| // need to call this directly if you do something else with the origin, such |
| // as display it in the UI. |
| GURL GetCanonicalOrigin(const GURL& url) const; |
| |
| // Callers from within chrome/ should use the methods which take the |
| // ContentSettingsType enum. The methods which take PermissionType values |
| // are for the content::PermissionManager overrides and shouldn't be used |
| // from chrome/. |
| |
| int RequestPermission(ContentSettingsType permission, |
| content::RenderFrameHost* render_frame_host, |
| const GURL& requesting_origin, |
| bool user_gesture, |
| const base::Callback<void(ContentSetting)>& callback); |
| int RequestPermissions( |
| const std::vector<ContentSettingsType>& permissions, |
| content::RenderFrameHost* render_frame_host, |
| const GURL& requesting_origin, |
| bool user_gesture, |
| const base::Callback<void(const std::vector<ContentSetting>&)>& callback); |
| |
| PermissionResult GetPermissionStatus(ContentSettingsType permission, |
| const GURL& requesting_origin, |
| const GURL& embedding_origin); |
| |
| // Returns the permission status for a given frame. This should be preferred |
| // over GetPermissionStatus as additional checks can be performed when we know |
| // the exact context the request is coming from. |
| // TODO(raymes): Currently we still pass the |requesting_origin| as a separate |
| // parameter because we can't yet guarantee that it matches the last committed |
| // origin of the RenderFrameHost. See crbug.com/698985. |
| PermissionResult GetPermissionStatusForFrame( |
| ContentSettingsType permission, |
| content::RenderFrameHost* render_frame_host, |
| const GURL& requesting_origin); |
| |
| // content::PermissionManager implementation. |
| int RequestPermission( |
| content::PermissionType permission, |
| content::RenderFrameHost* render_frame_host, |
| const GURL& requesting_origin, |
| bool user_gesture, |
| const base::Callback<void(blink::mojom::PermissionStatus)>& callback) |
| override; |
| int RequestPermissions( |
| const std::vector<content::PermissionType>& permissions, |
| content::RenderFrameHost* render_frame_host, |
| const GURL& requesting_origin, |
| bool user_gesture, |
| const base::Callback< |
| void(const std::vector<blink::mojom::PermissionStatus>&)>& callback) |
| override; |
| void CancelPermissionRequest(int request_id) override; |
| void ResetPermission(content::PermissionType permission, |
| const GURL& requesting_origin, |
| const GURL& embedding_origin) override; |
| blink::mojom::PermissionStatus GetPermissionStatus( |
| content::PermissionType permission, |
| const GURL& requesting_origin, |
| const GURL& embedding_origin) override; |
| int SubscribePermissionStatusChange( |
| content::PermissionType permission, |
| const GURL& requesting_origin, |
| const GURL& embedding_origin, |
| const base::Callback<void(blink::mojom::PermissionStatus)>& callback) |
| override; |
| void UnsubscribePermissionStatusChange(int subscription_id) override; |
| |
| // TODO(raymes): Rather than exposing this, use the denial reason from |
| // GetPermissionStatus in callers to determine whether a permission is |
| // denied due to the kill switch. |
| bool IsPermissionKillSwitchOn(ContentSettingsType); |
| |
| private: |
| friend class PermissionManagerTest; |
| friend class GeolocationPermissionContextTests; |
| |
| class PendingRequest; |
| using PendingRequestsMap = base::IDMap<std::unique_ptr<PendingRequest>>; |
| |
| class PermissionResponseCallback; |
| |
| struct Subscription; |
| using SubscriptionsMap = base::IDMap<std::unique_ptr<Subscription>>; |
| |
| // KeyedService implementation |
| void Shutdown() override; |
| |
| PermissionContextBase* GetPermissionContext(ContentSettingsType type); |
| |
| // Called when a permission was decided for a given PendingRequest. The |
| // PendingRequest is identified by its |request_id| and the permission is |
| // identified by its |permission_id|. If the PendingRequest contains more than |
| // one permission, it will wait for the remaining permissions to be resolved. |
| // When all the permissions have been resolved, the PendingRequest's callback |
| // is run. |
| void OnPermissionsRequestResponseStatus(int request_id, |
| int permission_id, |
| ContentSetting status); |
| |
| // content_settings::Observer implementation. |
| void OnContentSettingChanged(const ContentSettingsPattern& primary_pattern, |
| const ContentSettingsPattern& secondary_pattern, |
| ContentSettingsType content_type, |
| std::string resource_identifier) override; |
| |
| PermissionResult GetPermissionStatusHelper( |
| ContentSettingsType permission, |
| content::RenderFrameHost* render_frame_host, |
| const GURL& requesting_origin, |
| const GURL& embedding_origin); |
| |
| Profile* profile_; |
| PendingRequestsMap pending_requests_; |
| SubscriptionsMap subscriptions_; |
| |
| std::unordered_map<ContentSettingsType, |
| std::unique_ptr<PermissionContextBase>, |
| ContentSettingsTypeHash> |
| permission_contexts_; |
| |
| DISALLOW_COPY_AND_ASSIGN(PermissionManager); |
| }; |
| |
| #endif // CHROME_BROWSER_PERMISSIONS_PERMISSION_MANAGER_H_ |