Move each permission classes to its own files in extensions/permissions

chrome/common/extensions/extension_permission_set.h

-// Copyright (c) 2012 The Chromium Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file.
-
-#ifndef CHROME_COMMON_EXTENSIONS_EXTENSION_PERMISSION_SET_H_
-#define CHROME_COMMON_EXTENSIONS_EXTENSION_PERMISSION_SET_H_
-#pragma once
-
-#include <map>
-#include <set>
-#include <string>
-#include <vector>
-
-#include "base/gtest_prod_util.h"
-#include "base/memory/ref_counted.h"
-#include "base/memory/singleton.h"
-#include "base/string16.h"
-#include "chrome/common/extensions/url_pattern_set.h"
-
-// TODO(jstritar): Move each class to its own file in extensions/permissions.
-
-class ExtensionPermissionsInfo;
-
-namespace extensions {
-class Extension;
-}
-
-// When prompting the user to install or approve permissions, we display
-// messages describing the effects of the permissions rather than listing the
-// permissions themselves. Each ExtensionPermissionMessage represents one of the
-// messages shown to the user.
-class ExtensionPermissionMessage {
- public:
-  // Do not reorder this enumeration. If you need to add a new enum, add it just
-  // prior to kEnumBoundary.
-  enum ID {
-    kUnknown,
-    kNone,
-    kBookmarks,
-    kGeolocation,
-    kBrowsingHistory,
-    kTabs,
-    kManagement,
-    kDebugger,
-    kHosts1,
-    kHosts2,
-    kHosts3,
-    kHosts4OrMore,
-    kHostsAll,
-    kFullAccess,
-    kClipboard,
-    kTtsEngine,
-    kContentSettings,
-    kAllPageContent,
-    kPrivacy,
-    kManagedMode,
-    kInput,
-    kAudioCapture,
-    kVideoCapture,
-    kDownloads,
-    kEnumBoundary
-  };
-
-  // Creates the corresponding permission message for a list of hosts. This is
-  // simply a convenience method around the constructor, since the messages
-  // change depending on what hosts are present.
-  static ExtensionPermissionMessage CreateFromHostList(
-      const std::set<std::string>& hosts);
-
-  // Creates the corresponding permission message.
-  ExtensionPermissionMessage(ID id, const string16& message);
-  ~ExtensionPermissionMessage();
-
-  // Gets the id of the permission message, which can be used in UMA
-  // histograms.
-  ID id() const { return id_; }
-
-  // Gets a localized message describing this permission. Please note that
-  // the message will be empty for message types TYPE_NONE and TYPE_UNKNOWN.
-  const string16& message() const { return message_; }
-
-  // Comparator to work with std::set.
-  bool operator<(const ExtensionPermissionMessage& that) const {
-    return id_ < that.id_;
-  }
-
- private:
-  ID id_;
-  string16 message_;
-};
-
-typedef std::vector<ExtensionPermissionMessage> ExtensionPermissionMessages;
-
-// The ExtensionAPIPermission is an immutable class that describes a single
-// named permission (API permission).
-class ExtensionAPIPermission {
- public:
-  enum ID {
-    // Error codes.
-    kInvalid = -2,
-    kUnknown = -1,
-
-    // Real permissions.
-    kActiveTab,
-    kAlarms,
-    kAppNotifications,
-    kAudioCapture,
-    kBackground,
-    kBookmark,
-    kBrowsingData,
-    kChromeAuthPrivate,
-    kChromeosInfoPrivate,
-    kClipboardRead,
-    kClipboardWrite,
-    kContentSettings,
-    kContextMenus,
-    kCookie,
-    kDebugger,
-    kDeclarative,
-    kDeclarativeWebRequest,
-    kDevtools,
-    kEchoPrivate,
-    kDownloads,
-    kExperimental,
-    kFileBrowserHandler,
-    kFileBrowserHandlerInternal,
-    kFileBrowserPrivate,
-    kFileSystem,
-    kGeolocation,
-    kHistory,
-    kIdle,
-    kInput,
-    kInputMethodPrivate,
-    kKeybinding,
-    kManagedModePrivate,
-    kManagement,
-    kMediaPlayerPrivate,
-    kMetricsPrivate,
-    kNotification,
-    kPageCapture,
-    kPlugin,
-    kPrivacy,
-    kProxy,
-    kSocket,
-    kStorage,
-    kSystemPrivate,
-    kTab,
-    kTerminalPrivate,
-    kTopSites,
-    kTts,
-    kTtsEngine,
-    kUnlimitedStorage,
-    kUsb,
-    kVideoCapture,
-    kWebNavigation,
-    kWebRequest,
-    kWebRequestBlocking,
-    kWebRequestInternal,
-    kWebSocketProxyPrivate,
-    kWebstorePrivate,
-    kEnumBoundary
-  };
-
-  enum Flag {
-    kFlagNone = 0,
-
-    // Indicates if the permission implies full access (native code).
-    kFlagImpliesFullAccess = 1 << 0,
-
-    // Indicates if the permission implies full URL access.
-    kFlagImpliesFullURLAccess = 1 << 1,
-
-    // Indicates that extensions cannot specify the permission as optional.
-    kFlagCannotBeOptional = 1 << 3
-  };
-
-  typedef std::set<ID> IDSet;
-
-  ~ExtensionAPIPermission();
-
-  // Returns the localized permission message associated with this api.
-  ExtensionPermissionMessage GetMessage() const;
-
-  int flags() const { return flags_; }
-
-  ID id() const { return id_; }
-
-  // Returns the message id associated with this permission.
-  ExtensionPermissionMessage::ID message_id() const {
-    return message_id_;
-  }
-
-  // Returns the name of this permission.
-  const char* name() const { return name_; }
-
-  // Returns true if this permission implies full access (e.g., native code).
-  bool implies_full_access() const {
-    return (flags_ & kFlagImpliesFullAccess) != 0;
-  }
-
-  // Returns true if this permission implies full URL access.
-  bool implies_full_url_access() const {
-    return (flags_ & kFlagImpliesFullURLAccess) != 0;
-  }
-
-  // Returns true if this permission can be added and removed via the
-  // optional permissions extension API.
-  bool supports_optional() const {
-    return (flags_ & kFlagCannotBeOptional) == 0;
-  }
-
- private:
-  // Instances should only be constructed from within ExtensionPermissionsInfo.
-  friend class ExtensionPermissionsInfo;
-
-  explicit ExtensionAPIPermission(
-      ID id,
-      const char* name,
-      int l10n_message_id,
-      ExtensionPermissionMessage::ID message_id,
-      int flags);
-
-  // Register ALL the permissions!
-  static void RegisterAllPermissions(ExtensionPermissionsInfo* info);
-
-  ID id_;
-  const char* name_;
-  int flags_;
-  int l10n_message_id_;
-  ExtensionPermissionMessage::ID message_id_;
-};
-
-typedef std::set<ExtensionAPIPermission::ID> ExtensionAPIPermissionSet;
-
-// Singleton that holds the extension permission instances and provides static
-// methods for accessing them.
-class ExtensionPermissionsInfo {
- public:
-  // Returns a pointer to the singleton instance.
-  static ExtensionPermissionsInfo* GetInstance();
-
-  // Returns the permission with the given |id|, and NULL if it doesn't exist.
-  ExtensionAPIPermission* GetByID(ExtensionAPIPermission::ID id);
-
-  // Returns the permission with the given |name|, and NULL if none
-  // exists.
-  ExtensionAPIPermission* GetByName(const std::string& name);
-
-  // Returns a set containing all valid api permission ids.
-  ExtensionAPIPermissionSet GetAll();
-
-  // Converts all the permission names in |permission_names| to permission ids.
-  ExtensionAPIPermissionSet GetAllByName(
-      const std::set<std::string>& permission_names);
-
-  // Gets the total number of API permissions.
-  size_t get_permission_count() { return permission_count_; }
-
- private:
-  friend class ExtensionAPIPermission;
-
-  ~ExtensionPermissionsInfo();
-  ExtensionPermissionsInfo();
-
-  // Registers an |alias| for a given permission |name|.
-  void RegisterAlias(const char* name, const char* alias);
-
-  // Registers a permission with the specified attributes and flags.
-  ExtensionAPIPermission* RegisterPermission(
-      ExtensionAPIPermission::ID id,
-      const char* name,
-      int l10n_message_id,
-      ExtensionPermissionMessage::ID message_id,
-      int flags);
-
-  // Maps permission ids to permissions.
-  typedef std::map<ExtensionAPIPermission::ID, ExtensionAPIPermission*> IDMap;
-
-  // Maps names and aliases to permissions.
-  typedef std::map<std::string, ExtensionAPIPermission*> NameMap;
-
-  IDMap id_map_;
-  NameMap name_map_;
-
-  size_t hosted_app_permission_count_;
-  size_t permission_count_;
-
-  friend struct DefaultSingletonTraits<ExtensionPermissionsInfo>;
-  DISALLOW_COPY_AND_ASSIGN(ExtensionPermissionsInfo);
-};
-
-typedef std::set<std::string> ExtensionOAuth2Scopes;
-
-// The ExtensionPermissionSet is an immutable class that encapsulates an
-// extension's permissions. The class exposes set operations for combining and
-// manipulating the permissions.
-class ExtensionPermissionSet
-    : public base::RefCountedThreadSafe<ExtensionPermissionSet> {
- public:
-  // Creates an empty permission set (e.g. default permissions).
-  ExtensionPermissionSet();
-
-  // Creates a new permission set based on the |extension| manifest data, and
-  // the api and host permissions (|apis| and |hosts|). The effective hosts
-  // of the newly created permission set will be inferred from the |extension|
-  // manifest, |apis| and |hosts|.
-  ExtensionPermissionSet(const extensions::Extension* extension,
-                         const ExtensionAPIPermissionSet& apis,
-                         const URLPatternSet& explicit_hosts,
-                         const ExtensionOAuth2Scopes& scopes);
-
-
-  // Creates a new permission set based on the specified data.
-  ExtensionPermissionSet(const ExtensionAPIPermissionSet& apis,
-                         const URLPatternSet& explicit_hosts,
-                         const URLPatternSet& scriptable_hosts);
-
-  // Creates a new permission set that has oauth scopes in it.
-  ExtensionPermissionSet(const ExtensionAPIPermissionSet& apis,
-                         const URLPatternSet& explicit_hosts,
-                         const URLPatternSet& scriptable_hosts,
-                         const ExtensionOAuth2Scopes& scopes);
-
-  // Creates a new permission set containing only oauth scopes.
-  explicit ExtensionPermissionSet(const ExtensionOAuth2Scopes& scopes);
-
-  // Creates a new permission set equal to |set1| - |set2|, passing ownership of
-  // the new set to the caller.
-  static ExtensionPermissionSet* CreateDifference(
-      const ExtensionPermissionSet* set1, const ExtensionPermissionSet* set2);
-
-  // Creates a new permission set equal to the intersection of |set1| and
-  // |set2|, passing ownership of the new set to the caller.
-  static ExtensionPermissionSet* CreateIntersection(
-      const ExtensionPermissionSet* set1, const ExtensionPermissionSet* set2);
-
-  // Creates a new permission set equal to the union of |set1| and |set2|.
-  // Passes ownership of the new set to the caller.
-  static ExtensionPermissionSet* CreateUnion(
-      const ExtensionPermissionSet* set1, const ExtensionPermissionSet* set2);
-
-  bool operator==(const ExtensionPermissionSet& rhs) const;
-
-  // Returns true if |set| is a subset of this.
-  bool Contains(const ExtensionPermissionSet& set) const;
-
-  // Gets the API permissions in this set as a set of strings.
-  std::set<std::string> GetAPIsAsStrings() const;
-
-  // Gets the API permissions in this set, plus any that have implicit access
-  // (such as APIs that require no permissions, or APIs with functions that
-  // require no permissions).
-  // TODO(kalman): return scoped_ptr to avoid copying.
-  std::set<std::string> GetAPIsWithAnyAccessAsStrings() const;
-
-  // Returns whether this namespace has any functions which the extension has
-  // permission to use.  For example, even though the extension may not have
-  // the "tabs" permission, "tabs.create" requires no permissions so
-  // HasAnyAPIPermission("tabs") will return true.
-  bool HasAnyAccessToAPI(const std::string& api_name) const;
-
-  // Gets a list of the distinct hosts for displaying to the user.
-  // NOTE: do not use this for comparing permissions, since this disgards some
-  // information.
-  std::set<std::string> GetDistinctHostsForDisplay() const;
-
-  // Gets the localized permission messages that represent this set.
-  ExtensionPermissionMessages GetPermissionMessages() const;
-
-  // Gets the localized permission messages that represent this set (represented
-  // as strings).
-  std::vector<string16> GetWarningMessages() const;
-
-  // Returns true if this is an empty set (e.g., the default permission set).
-  bool IsEmpty() const;
-
-  // Returns true if the set has the specified API permission.
-  bool HasAPIPermission(ExtensionAPIPermission::ID permission) const;
-
-  // Returns true if the permissions in this set grant access to the specified
-  // |function_name|.
-  bool HasAccessToFunction(const std::string& function_name) const;
-
-  // Returns true if this includes permission to access |origin|.
-  bool HasExplicitAccessToOrigin(const GURL& origin) const;
-
-  // Returns true if this permission set includes access to script |url|.
-  bool HasScriptableAccessToURL(const GURL& url) const;
-
-  // Returns true if this permission set includes effective access to all
-  // origins.
-  bool HasEffectiveAccessToAllHosts() const;
-
-  // Returns true if this permission set includes effective access to |url|.
-  bool HasEffectiveAccessToURL(const GURL& url) const;
-
-  // Returns ture if this permission set effectively represents full access
-  // (e.g. native code).
-  bool HasEffectiveFullAccess() const;
-
-  // Returns true if |permissions| has a greater privilege level than this
-  // permission set (e.g., this permission set has less permissions).
-  bool HasLessPrivilegesThan(const ExtensionPermissionSet* permissions) const;
-
-  const ExtensionAPIPermissionSet& apis() const { return apis_; }
-
-  const URLPatternSet& effective_hosts() const { return effective_hosts_; }
-
-  const URLPatternSet& explicit_hosts() const { return explicit_hosts_; }
-
-  const URLPatternSet& scriptable_hosts() const { return scriptable_hosts_; }
-
-  const ExtensionOAuth2Scopes& scopes() const { return scopes_; }
-
- private:
-  FRIEND_TEST_ALL_PREFIXES(ExtensionPermissionsTest,
-                           HasLessHostPrivilegesThan);
-  FRIEND_TEST_ALL_PREFIXES(ExtensionPermissionsTest,
-                           GetWarningMessages_AudioVideo);
-  friend class base::RefCountedThreadSafe<ExtensionPermissionSet>;
-
-  ~ExtensionPermissionSet();
-
-  static std::set<std::string> GetDistinctHosts(
-      const URLPatternSet& host_patterns,
-      bool include_rcd,
-      bool exclude_file_scheme);
-
-  // Initializes the set based on |extension|'s manifest data.
-  void InitImplicitExtensionPermissions(const extensions::Extension* extension);
-
-  // Initializes the effective host permission based on the data in this set.
-  void InitEffectiveHosts();
-
-  // Gets the permission messages for the API permissions.
-  std::set<ExtensionPermissionMessage> GetSimplePermissionMessages() const;
-
-  // Returns true if |permissions| has an elevated API privilege level than
-  // this set.
-  bool HasLessAPIPrivilegesThan(
-      const ExtensionPermissionSet* permissions) const;
-
-  // Returns true if |permissions| has more host permissions compared to this
-  // set.
-  bool HasLessHostPrivilegesThan(
-      const ExtensionPermissionSet* permissions) const;
-
-  // Returns true if |permissions| has more oauth2 scopes compared to this set.
-  bool HasLessScopesThan(const ExtensionPermissionSet* permissions) const;
-
-  // The api list is used when deciding if an extension can access certain
-  // extension APIs and features.
-  ExtensionAPIPermissionSet apis_;
-
-  // The list of hosts that can be accessed directly from the extension.
-  // TODO(jstritar): Rename to "hosts_"?
-  URLPatternSet explicit_hosts_;
-
-  // The list of hosts that can be scripted by content scripts.
-  // TODO(jstritar): Rename to "user_script_hosts_"?
-  URLPatternSet scriptable_hosts_;
-
-  // The list of hosts this effectively grants access to.
-  URLPatternSet effective_hosts_;
-
-  // A set of oauth2 scopes that are used by the identity API to create OAuth2
-  // tokens for accessing the Google Account of the signed-in sync account.
-  ExtensionOAuth2Scopes scopes_;
-};
-
-#endif  // CHROME_COMMON_EXTENSIONS_EXTENSION_PERMISSION_SET_H_