| // Copyright 2015 The Chromium Authors |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #ifndef CONTENT_PUBLIC_BROWSER_PERMISSION_CONTROLLER_DELEGATE_H_ |
| #define CONTENT_PUBLIC_BROWSER_PERMISSION_CONTROLLER_DELEGATE_H_ |
| |
| #include <optional> |
| |
| #include "base/types/id_type.h" |
| #include "content/common/content_export.h" |
| #include "content/public/browser/permission_result.h" |
| #include "third_party/blink/public/mojom/permissions/permission_status.mojom.h" |
| #include "ui/gfx/geometry/rect.h" |
| |
| class GURL; |
| |
| namespace url { |
| class Origin; |
| } |
| |
| namespace blink { |
| enum class PermissionType; |
| } |
| |
| namespace content { |
| class RenderFrameHost; |
| class RenderProcessHost; |
| class WebContents; |
| struct PermissionRequestDescription; |
| |
| class CONTENT_EXPORT PermissionControllerDelegate { |
| public: |
| // Identifier for an active subscription. |
| using SubscriptionId = base::IdType64<PermissionControllerDelegate>; |
| |
| virtual ~PermissionControllerDelegate() = default; |
| |
| // Requests multiple permissions on behalf of a frame identified by |
| // |render_frame_host|. When the permission request is handled, whether it |
| // failed, timed out or succeeded, the |callback| will be run. The order of |
| // statuses in the returned vector will correspond to the order of requested |
| // permission types. |
| // TODO(crbug.com/40275129): `RequestPermissions` and |
| // `RequestPermissionsFromCurrentDocument` do exactly the same things. Merge |
| // them together. |
| virtual void RequestPermissions( |
| RenderFrameHost* render_frame_host, |
| const PermissionRequestDescription& request_description, |
| base::OnceCallback<void(const std::vector<PermissionStatus>&)> |
| callback) = 0; |
| |
| // Requests permissions from the current document in the given |
| // RenderFrameHost. Use this over `RequestPermission` whenever possible as |
| // this API takes into account the lifecycle state of a given document (i.e. |
| // whether it's in back-forward cache or being prerendered) in addition to its |
| // origin. |
| virtual void RequestPermissionsFromCurrentDocument( |
| RenderFrameHost* render_frame_host, |
| const PermissionRequestDescription& request_description, |
| base::OnceCallback<void(const std::vector<PermissionStatus>&)> |
| callback) = 0; |
| |
| // Returns the permission status of a given requesting_origin/embedding_origin |
| // tuple. This is not taking a RenderFrameHost because the call might happen |
| // outside of a frame context. Prefer GetPermissionStatusForCurrentDocument |
| // (below) whenever possible. |
| virtual PermissionStatus GetPermissionStatus( |
| blink::PermissionType permission, |
| const GURL& requesting_origin, |
| const GURL& embedding_origin) = 0; |
| |
| virtual PermissionResult GetPermissionResultForOriginWithoutContext( |
| blink::PermissionType permission, |
| const url::Origin& requesting_origin, |
| const url::Origin& embedding_origin) = 0; |
| |
| // Returns the permission status for the current document in the given |
| // RenderFrameHost. Use this over `GetPermissionStatus` whenever possible as |
| // this API takes into account the lifecycle state of a given document (i.e. |
| // whether it's in back-forward cache or being prerendered) in addition to its |
| // origin. |
| virtual PermissionStatus GetPermissionStatusForCurrentDocument( |
| blink::PermissionType permission, |
| RenderFrameHost* render_frame_host) = 0; |
| |
| // The method does the same as `GetPermissionStatusForCurrentDocument` but |
| // additionally returns a source or reason for the permission status. |
| virtual PermissionResult GetPermissionResultForCurrentDocument( |
| blink::PermissionType permission, |
| RenderFrameHost* render_frame_host); |
| |
| // Returns the status of the given `permission` for a worker on |
| // `worker_origin` running in `render_process_host`, also performing |
| // additional checks such as Permission Policy. Use this over |
| // GetPermissionStatus whenever possible. |
| virtual PermissionStatus GetPermissionStatusForWorker( |
| blink::PermissionType permission, |
| RenderProcessHost* render_process_host, |
| const GURL& worker_origin) = 0; |
| |
| // Returns the permission status for `requesting_origin` in the given |
| // `RenderFrameHost`. Other APIs interpret `requesting_origin` as the last |
| // committed origin of the requesting frame. This API takes |
| // `requesting_origin` as a separate parameter because it does not equal the |
| // last committed origin of the requesting frame. It is designed to be used |
| // only for `TOP_LEVEL_STORAGE_ACCESS`. |
| virtual PermissionStatus GetPermissionStatusForEmbeddedRequester( |
| blink::PermissionType permission, |
| RenderFrameHost* render_frame_host, |
| const url::Origin& requesting_origin) = 0; |
| |
| // Sets the permission back to its default for the requesting_origin/ |
| // embedding_origin tuple. |
| virtual void ResetPermission(blink::PermissionType permission, |
| const GURL& requesting_origin, |
| const GURL& embedding_origin) = 0; |
| |
| // Runs the given |callback| whenever the |permission| associated with the |
| // given |render_frame_host| changes. |render_process_host| should be passed |
| // instead if the request is from a worker. Returns the ID to be used to |
| // unsubscribe, which can be `is_null()` if the subscribe was not successful. |
| // Exactly one of |render_process_host| and |render_frame_host| should be |
| // set, RenderProcessHost will be inferred from |render_frame_host|. |
| virtual SubscriptionId SubscribeToPermissionStatusChange( |
| blink::PermissionType permission, |
| content::RenderProcessHost* render_process_host, |
| content::RenderFrameHost* render_frame_host, |
| const GURL& requesting_origin, |
| base::RepeatingCallback<void(PermissionStatus)> callback) = 0; |
| |
| // Unregisters from permission status change notifications. The |
| // |subscription_id| must match the value returned by the |
| // SubscribeToPermissionStatusChange call. Unsubscribing an already |
| // unsubscribed |subscription_id| or an `is_null()` ID is a no-op. |
| virtual void UnsubscribeFromPermissionStatusChange( |
| SubscriptionId subscription_id) = 0; |
| |
| // If there's currently a permission UI presenting for the given WebContents, |
| // returns bounds of the view as an exclusion area. We will use these bounds |
| // to avoid situations where users may make bad decisions based on incorrect |
| // contextual information (due to content or widgets overlaying the exclusion |
| // area) |
| virtual std::optional<gfx::Rect> GetExclusionAreaBoundsInScreen( |
| WebContents* web_contents) const; |
| |
| // Returns whether permission can be overridden. |
| virtual bool IsPermissionOverridable( |
| blink::PermissionType permission, |
| const std::optional<url::Origin>& origin); |
| }; |
| |
| } // namespace content |
| |
| namespace std { |
| |
| template <> |
| struct hash<content::PermissionControllerDelegate::SubscriptionId> { |
| std::size_t operator()( |
| const content::PermissionControllerDelegate::SubscriptionId& v) const { |
| content::PermissionControllerDelegate::SubscriptionId::Hasher hasher; |
| return hasher(v); |
| } |
| }; |
| |
| } // namespace std |
| |
| #endif // CONTENT_PUBLIC_BROWSER_PERMISSION_CONTROLLER_DELEGATE_H_ |