content/public/browser/permission_manager.h

   1 // Copyright 2015 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CONTENT_PUBLIC_BROWSER_PERMISSION_MANAGER_H_
   6 #define CONTENT_PUBLIC_BROWSER_PERMISSION_MANAGER_H_
   7
   8 #include "content/common/content_export.h"
   9 #include "content/public/common/permission_status.mojom.h"
  10
  11 class GURL;
  12
  13 namespace content {
  14 enum class PermissionType;
  15 class RenderFrameHost;
  16
  17 // This class allows the content layer to manipulate permissions. It has to be
  18 // implemented by the embedder which ultimately handles the permission
  19 // management for the content layer.
  20 class CONTENT_EXPORT PermissionManager {
  21  public:
  22   virtual ~PermissionManager() = default;
  23
  24   // Requests a permission on behalf of a frame identified by render_frame_host.
  25   // The |request_id| is an identifier that can later be used if the request is
  26   // cancelled (see CancelPermissionRequest).
  27   // When the permission request is handled, whether it failed, timed out or
  28   // succeeded, the |callback| will be run.
  29   virtual void RequestPermission(
  30       PermissionType permission,
  31       RenderFrameHost* render_frame_host,
  32       int request_id,
  33       const GURL& requesting_origin,
  34       bool user_gesture,
  35       const base::Callback<void(PermissionStatus)>& callback) = 0;
  36
  37   // Cancels a previously requested permission. The given parameter must match
  38   // the ones passed to the RequestPermission call.
  39   virtual void CancelPermissionRequest(PermissionType permission,
  40                                        RenderFrameHost* render_frame_host,
  41                                        int request_id,
  42                                        const GURL& requesting_origin) = 0;
  43
  44   // Returns the permission status of a given requesting_origin/embedding_origin
  45   // tuple. This is not taking a RenderFrameHost because the call might happen
  46   // outside of a frame context.
  47   virtual PermissionStatus GetPermissionStatus(
  48       PermissionType permission,
  49       const GURL& requesting_origin,
  50       const GURL& embedding_origin) = 0;
  51
  52   // Sets the permission back to its default for the requesting_origin/
  53   // embedding_origin tuple.
  54   virtual void ResetPermission(PermissionType permission,
  55                                const GURL& requesting_origin,
  56                                const GURL& embedding_origin) = 0;
  57
  58   // Registers a permission usage.
  59   // TODO(mlamouri): see if we can remove this from the PermissionManager.
  60   virtual void RegisterPermissionUsage(PermissionType permission,
  61                                        const GURL& requesting_origin,
  62                                        const GURL& embedding_origin) = 0;
  63
  64   // Runs the given |callback| whenever the |permission| associated with the
  65   // pair { requesting_origin, embedding_origin } changes.
  66   // Returns the subscription_id to be used to unsubscribe.
  67   virtual int SubscribePermissionStatusChange(
  68       PermissionType permission,
  69       const GURL& requesting_origin,
  70       const GURL& embedding_origin,
  71       const base::Callback<void(PermissionStatus)>& callback) = 0;
  72
  73   // Unregisters from permission status change notifications.
  74   // The |subscription_id| must match the value returned by the
  75   // SubscribePermissionStatusChange call.
  76   virtual void UnsubscribePermissionStatusChange(int subscription_id) = 0;
  77 };
  78
  79 }  // namespace content
  80
  81 #endif // CONTENT_PUBLIC_BROWSER_PERMISSION_MANAGER_H_