extensions/common/permissions/permission_message.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 EXTENSIONS_COMMON_PERMISSIONS_PERMISSION_MESSAGE_H_
   6 #define EXTENSIONS_COMMON_PERMISSIONS_PERMISSION_MESSAGE_H_
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "base/basictypes.h"
  12 #include "base/strings/string16.h"
  13
  14 namespace extensions {
  15
  16 // When prompting the user to install or approve permissions, we display
  17 // messages describing the effects of the permissions rather than listing the
  18 // permissions themselves. Each PermissionMessage represents one of the
  19 // messages shown to the user.
  20 class PermissionMessage {
  21  public:
  22   // Do not reorder this enumeration. If you need to add a new enum, add it just
  23   // prior to kEnumBoundary.
  24   // TODO(sashab): Deprecate these IDs - use whatever APIPermission::ID becomes
  25   // instead.
  26   enum ID {
  27     kUnknown,
  28     kNone,
  29     kBookmarks,
  30     kGeolocation,
  31     kBrowsingHistory,
  32     kTabs,
  33     kManagement,
  34     kDebugger,
  35     kDesktopCapture,
  36     kHid,
  37     kHosts1,
  38     kHosts2,
  39     kHosts3,
  40     kHosts4OrMore,
  41     kHostsAll,
  42     kFullAccess,
  43     kClipboard,
  44     kTtsEngine,
  45     kContentSettings,
  46     kPrivacy,
  47     kSupervisedUser,
  48     kInput,
  49     kAudioCapture,
  50     kVideoCapture,
  51     kDownloads,
  52     kDeleted_FileSystemWrite,
  53     kMediaGalleriesAllGalleriesRead,
  54     kSerial,
  55     kSocketAnyHost,
  56     kSocketDomainHosts,
  57     kSocketSpecificHosts,
  58     kBluetooth,
  59     kUsb,
  60     kSystemIndicator,
  61     kUsbDevice,
  62     kMediaGalleriesAllGalleriesCopyTo,
  63     kSystemInfoDisplay,
  64     kNativeMessaging,
  65     kSyncFileSystem,
  66     kAudio,
  67     kFavicon,
  68     kMusicManagerPrivate,
  69     kWebConnectable,
  70     kActivityLogPrivate,
  71     kBluetoothDevices,
  72     kDownloadsOpen,
  73     kNetworkingPrivate,
  74     kDeclarativeWebRequest,
  75     kFileSystemDirectory,
  76     kFileSystemWriteDirectory,
  77     kSignedInDevices,
  78     kWallpaper,
  79     kNetworkState,
  80     kHomepage,
  81     kSearchProvider,
  82     kStartupPages,
  83     kMediaGalleriesAllGalleriesDelete,
  84     kScreenlockPrivate,
  85     kOverrideBookmarksUI,
  86     kAutomation,
  87     kAccessibilityFeaturesModify,
  88     kAccessibilityFeaturesRead,
  89     kBluetoothPrivate,
  90     kIdentityEmail,
  91     kExperienceSamplingPrivate,
  92     kCopresence,
  93     kTopSites,
  94     kU2fDevices,
  95     kDocumentScan,
  96     kNetworkingConfig,
  97     kPlatformKeys,
  98     kMDns,
  99     kVpnProvider,
 100     kHosts1ReadOnly,
 101     kHosts2ReadOnly,
 102     kHosts3ReadOnly,
 103     kHosts4OrMoreReadOnly,
 104     kHostsAllReadOnly,
 105     kInterceptAllKeys,
 106     kSettingsPrivate,
 107     kPrinterProvider,
 108     // Last entry: Add new entries above and ensure to update the
 109     // "ExtensionPermission2" enum in tools/metrics/histograms/histograms.xml.
 110     kEnumBoundary,
 111   };
 112   static_assert(PermissionMessage::kNone > PermissionMessage::kUnknown,
 113                 "kNone should not greater than kUnknown");
 114
 115   // Creates the corresponding permission message.
 116   PermissionMessage(ID id, const base::string16& message);
 117   PermissionMessage(ID id,
 118                     const base::string16& message,
 119                     const base::string16& details);
 120   ~PermissionMessage();
 121
 122   // Gets the id of the permission message, which can be used in UMA
 123   // histograms.
 124   ID id() const { return id_; }
 125
 126   // Gets a localized message describing this permission. Please note that
 127   // the message will be empty for message types TYPE_NONE and TYPE_UNKNOWN.
 128   const base::string16& message() const { return message_; }
 129
 130   // Gets a localized message describing the details for this permission. Please
 131   // note that the message will be empty for message types TYPE_NONE and
 132   // TYPE_UNKNOWN.
 133   const base::string16& details() const { return details_; }
 134
 135   // Comparator to work with std::set.
 136   bool operator<(const PermissionMessage& that) const {
 137     return id_ < that.id_;
 138   }
 139   // Comparator to work with base::STLSetDifference.
 140   bool operator>(const PermissionMessage& that) const {
 141     return id_ > that.id_;
 142   }
 143
 144  private:
 145   ID id_;
 146   base::string16 message_;
 147   base::string16 details_;
 148 };
 149
 150 typedef std::vector<PermissionMessage> PermissionMessages;
 151 typedef std::vector<PermissionMessage::ID> PermissionMessageIDs;
 152
 153 }  // namespace extensions
 154
 155 #endif  // EXTENSIONS_COMMON_PERMISSIONS_PERMISSION_MESSAGE_H_