chrome/browser/extensions/permissions_updater.h

   1 // Copyright (c) 2012 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_EXTENSIONS_PERMISSIONS_UPDATER_H__
   6 #define CHROME_BROWSER_EXTENSIONS_PERMISSIONS_UPDATER_H__
   7
   8 #include <string>
   9
  10 #include "base/memory/ref_counted.h"
  11 #include "extensions/browser/extension_event_histogram_value.h"
  12
  13 namespace base {
  14 class DictionaryValue;
  15 }
  16
  17 namespace content {
  18 class BrowserContext;
  19 }
  20
  21 namespace extensions {
  22
  23 class Extension;
  24 class ExtensionPrefs;
  25 class PermissionSet;
  26
  27 // Updates an Extension's active and granted permissions in persistent storage
  28 // and notifies interested parties of the changes.
  29 class PermissionsUpdater {
  30  public:
  31   enum InitFlag {
  32     INIT_FLAG_NONE = 0,
  33     INIT_FLAG_TRANSIENT = 1 << 0,
  34   };
  35
  36   explicit PermissionsUpdater(content::BrowserContext* browser_context);
  37   PermissionsUpdater(content::BrowserContext* browser_context,
  38                      InitFlag init_flag);
  39   ~PermissionsUpdater();
  40
  41   // Adds the set of |permissions| to the |extension|'s active permission set
  42   // and sends the relevant messages and notifications. This method assumes the
  43   // user has already been prompted, if necessary, for the extra permissions.
  44   void AddPermissions(const Extension* extension,
  45                       const PermissionSet* permissions);
  46
  47   // Removes the set of |permissions| from the |extension|'s active permission
  48   // set and sends the relevant messages and notifications.
  49   void RemovePermissions(const Extension* extension,
  50                          const PermissionSet* permissions);
  51
  52   // Adds all permissions in the |extension|'s active permissions to its
  53   // granted permission set.
  54   void GrantActivePermissions(const Extension* extension);
  55
  56   // Initializes the |extension|'s active permission set to include only
  57   // permissions currently requested by the extension and all the permissions
  58   // required by the extension.
  59   void InitializePermissions(const Extension* extension);
  60
  61   // Grants any withheld all-hosts (or all-hosts-like) permissions.
  62   void GrantWithheldImpliedAllHosts(const Extension* extension);
  63
  64   // Revokes any requests all-hosts (or all-hosts-like) permissions.
  65   void WithholdImpliedAllHosts(const Extension* extension);
  66
  67  private:
  68   enum EventType {
  69     ADDED,
  70     REMOVED,
  71   };
  72
  73   // Sets the |extension|'s active permissions to |active| and records the
  74   // change in the prefs. If |withheld| is non-null, also sets the extension's
  75   // withheld permissions to |withheld|. Otherwise, |withheld| permissions are
  76   // not changed.
  77   void SetPermissions(const Extension* extension,
  78                       const scoped_refptr<const PermissionSet>& active,
  79                       scoped_refptr<const PermissionSet> withheld);
  80
  81   // Dispatches specified event to the extension.
  82   void DispatchEvent(const std::string& extension_id,
  83                      events::HistogramValue histogram_value,
  84                      const char* event_name,
  85                      const PermissionSet* changed_permissions);
  86
  87   // Issues the relevant events, messages and notifications when the
  88   // |extension|'s permissions have |changed| (|changed| is the delta).
  89   // Specifically, this sends the EXTENSION_PERMISSIONS_UPDATED notification,
  90   // the ExtensionMsg_UpdatePermissions IPC message, and fires the
  91   // onAdded/onRemoved events in the extension.
  92   void NotifyPermissionsUpdated(EventType event_type,
  93                                 const Extension* extension,
  94                                 const PermissionSet* changed);
  95
  96   // The associated BrowserContext.
  97   content::BrowserContext* browser_context_;
  98
  99   // Initialization flag that determines whether prefs is consulted about the
 100   // extension. Transient extensions should not have entries in prefs.
 101   InitFlag init_flag_;
 102 };
 103
 104 }  // namespace extensions
 105
 106 #endif  // CHROME_BROWSER_EXTENSIONS_PERMISSIONS_UPDATER_H__