chrome/browser/content_settings/permission_queue_controller.h

   1 // Copyright 2013 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 CHROME_BROWSER_CONTENT_SETTINGS_PERMISSION_QUEUE_CONTROLLER_H_
   6 #define CHROME_BROWSER_CONTENT_SETTINGS_PERMISSION_QUEUE_CONTROLLER_H_
   7
   8 #include "base/bind.h"
   9 #include "components/content_settings/core/common/content_settings_types.h"
  10 #include "content/public/browser/notification_observer.h"
  11 #include "content/public/browser/notification_registrar.h"
  12
  13 class GURL;
  14 class PermissionRequestID;
  15 class InfoBarService;
  16 class Profile;
  17
  18 // This class controls an infobar queue per profile, and it's used by
  19 // GeolocationPermissionContext, and so on.
  20 // An alternate approach would be to have this queue per tab, and use
  21 // notifications to broadcast when permission is set / listen to notification to
  22 // cancel pending requests. This may be specially useful if there are other
  23 // things listening for such notifications.
  24 // For the time being this class is self-contained and it doesn't seem pulling
  25 // the notification infrastructure would simplify.
  26 class PermissionQueueController : public content::NotificationObserver {
  27  public:
  28   typedef base::Callback<void(bool /* allowed */)> PermissionDecidedCallback;
  29
  30   PermissionQueueController(Profile* profile, ContentSettingsType type);
  31   ~PermissionQueueController() override;
  32
  33   // The InfoBar will be displayed immediately if the tab is not already
  34   // displaying one, otherwise it'll be queued.
  35   void CreateInfoBarRequest(const PermissionRequestID& id,
  36                             const GURL& requesting_frame,
  37                             const GURL& embedder,
  38                             PermissionDecidedCallback callback);
  39
  40   // Cancels a specific infobar request.
  41   void CancelInfoBarRequest(const PermissionRequestID& id);
  42
  43   // Called by the InfoBarDelegate to notify permission has been set.
  44   // It'll notify and dismiss any other pending InfoBar request for the same
  45   // |requesting_frame| and embedder.
  46   void OnPermissionSet(const PermissionRequestID& id,
  47                        const GURL& requesting_frame,
  48                        const GURL& embedder,
  49                        bool update_content_setting,
  50                        bool allowed);
  51
  52   // Performs the update to content settings for a particular request frame
  53   // context.
  54   void UpdateContentSetting(
  55       const GURL& requesting_frame, const GURL& embedder, bool allowed);
  56
  57  protected:
  58   // content::NotificationObserver:
  59   void Observe(int type,
  60                const content::NotificationSource& source,
  61                const content::NotificationDetails& details) override;
  62
  63  private:
  64   class PendingInfobarRequest;
  65   class RequestEquals;
  66
  67   typedef std::vector<PendingInfobarRequest> PendingInfobarRequests;
  68
  69   // Returns true if a geolocation infobar is already visible for the tab
  70   // corresponding to |id|.
  71   bool AlreadyShowingInfoBarForTab(const PermissionRequestID& id) const;
  72
  73   // Shows the next pending infobar for the tab corresponding to |id|, if any.
  74   // Note that this may not be the pending request whose ID is |id| if other
  75   // requests are higher in the queue.  If we can't show infobars because there
  76   // is no InfoBarService for this tab, removes all queued requests for this
  77   // tab.
  78   void ShowQueuedInfoBarForTab(const PermissionRequestID& id);
  79
  80   void ClearPendingInfobarRequestsForTab(const PermissionRequestID& id);
  81
  82   void RegisterForInfoBarNotifications(InfoBarService* infobar_service);
  83   void UnregisterForInfoBarNotifications(InfoBarService* infobar_service);
  84
  85   content::NotificationRegistrar registrar_;
  86
  87   Profile* const profile_;
  88   ContentSettingsType type_;
  89   PendingInfobarRequests pending_infobar_requests_;
  90   bool in_shutdown_;
  91
  92   DISALLOW_COPY_AND_ASSIGN(PermissionQueueController);
  93 };
  94
  95 #endif  // CHROME_BROWSER_CONTENT_SETTINGS_PERMISSION_QUEUE_CONTROLLER_H_