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 "chrome/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   virtual ~PermissionQueueController();
  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   // Cancels all infobar requests that match |group_id|.
  44   void CancelInfoBarRequests(int group_id);
  45
  46   // Called by the InfoBarDelegate to notify permission has been set.
  47   // It'll notify and dismiss any other pending InfoBar request for the same
  48   // |requesting_frame| and embedder.
  49   void OnPermissionSet(const PermissionRequestID& id,
  50                        const GURL& requesting_frame,
  51                        const GURL& embedder,
  52                        bool update_content_setting,
  53                        bool allowed);
  54
  55  protected:
  56   // content::NotificationObserver:
  57   virtual void Observe(int type,
  58                        const content::NotificationSource& source,
  59                        const content::NotificationDetails& details) OVERRIDE;
  60
  61  private:
  62   class PendingInfobarRequest;
  63   class RequestEquals;
  64
  65   typedef std::vector<PendingInfobarRequest> PendingInfobarRequests;
  66
  67   // Returns true if a geolocation infobar is already visible for the tab
  68   // corresponding to |id|.
  69   bool AlreadyShowingInfoBarForTab(const PermissionRequestID& id) const;
  70
  71   // Shows the next pending infobar for the tab corresponding to |id|, if any.
  72   // Note that this may not be the pending request whose ID is |id| if other
  73   // requests are higher in the queue.  If we can't show infobars because there
  74   // is no InfoBarService for this tab, removes all queued requests for this
  75   // tab.
  76   void ShowQueuedInfoBarForTab(const PermissionRequestID& id);
  77
  78   void ClearPendingInfobarRequestsForTab(const PermissionRequestID& id);
  79
  80   void RegisterForInfoBarNotifications(InfoBarService* infobar_service);
  81   void UnregisterForInfoBarNotifications(InfoBarService* infobar_service);
  82
  83   void UpdateContentSetting(
  84       const GURL& requesting_frame, const GURL& embedder, bool allowed);
  85
  86   content::NotificationRegistrar registrar_;
  87
  88   Profile* const profile_;
  89   ContentSettingsType type_;
  90   PendingInfobarRequests pending_infobar_requests_;
  91   bool in_shutdown_;
  92
  93   DISALLOW_COPY_AND_ASSIGN(PermissionQueueController);
  94 };
  95
  96 #endif  // CHROME_BROWSER_CONTENT_SETTINGS_PERMISSION_QUEUE_CONTROLLER_H_