Chromium Code Reviews| OLD | NEW |
|---|---|
| 1 // Copyright (c) 2013 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2013 The Chromium Authors. All rights reserved. |
| 2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
| 3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
| 4 | 4 |
| 5 #ifndef EXTENSIONS_COMMON_MANIFEST_HANDLER_H_ | 5 #ifndef EXTENSIONS_COMMON_MANIFEST_HANDLER_H_ |
| 6 #define EXTENSIONS_COMMON_MANIFEST_HANDLER_H_ | 6 #define EXTENSIONS_COMMON_MANIFEST_HANDLER_H_ |
| 7 | 7 |
| 8 #include <set> | 8 #include <set> |
| 9 #include <string> | 9 #include <string> |
| 10 #include <vector> | 10 #include <vector> |
| 11 | 11 |
| 12 #include "base/lazy_instance.h" | 12 #include "base/lazy_instance.h" |
| 13 #include "base/memory/linked_ptr.h" | 13 #include "base/memory/linked_ptr.h" |
| 14 #include "base/strings/string16.h" | 14 #include "base/strings/string16.h" |
| 15 #include "extensions/common/manifest.h" | 15 #include "extensions/common/manifest.h" |
| 16 | 16 |
| 17 namespace extensions { | 17 namespace extensions { |
| 18 class Extension; | 18 class Extension; |
| 19 class ManifestPermission; | |
| 20 class ManifestPermissionSet; | |
| 19 | 21 |
| 20 // An interface for clients that recognize and parse keys in extension | 22 // An interface for clients that recognize and parse keys in extension |
| 21 // manifests. | 23 // manifests. |
| 22 class ManifestHandler { | 24 class ManifestHandler { |
| 23 public: | 25 public: |
| 24 ManifestHandler(); | 26 ManifestHandler(); |
| 25 virtual ~ManifestHandler(); | 27 virtual ~ManifestHandler(); |
| 26 | 28 |
| 27 // Attempts to parse the extension's manifest. | 29 // Attempts to parse the extension's manifest. |
| 28 // Returns true on success or false on failure; if false, |error| will | 30 // Returns true on success or false on failure; if false, |error| will |
| (...skipping 28 matching lines...) Expand all Loading... | |
| 57 virtual const std::vector<std::string> PrerequisiteKeys() const; | 59 virtual const std::vector<std::string> PrerequisiteKeys() const; |
| 58 | 60 |
| 59 // Associate us with our keys() in the manifest. A handler can register | 61 // Associate us with our keys() in the manifest. A handler can register |
| 60 // for multiple keys. The global registry takes ownership of this; | 62 // for multiple keys. The global registry takes ownership of this; |
| 61 // if it has an existing handler for |key|, it replaces it with this. | 63 // if it has an existing handler for |key|, it replaces it with this. |
| 62 // Manifest handlers must be registered at process startup in | 64 // Manifest handlers must be registered at process startup in |
| 63 // chrome_manifest_handlers.cc: | 65 // chrome_manifest_handlers.cc: |
| 64 // (new MyManifestHandler)->Register(); | 66 // (new MyManifestHandler)->Register(); |
| 65 void Register(); | 67 void Register(); |
| 66 | 68 |
| 69 virtual ManifestPermission* CreatePermission(); | |
|
Yoyo Zhou
2013/11/12 02:39:29
These new functions need documentation.
rpaquay
2013/11/12 21:40:31
Done.
| |
| 70 virtual ManifestPermission* CreateInitialRequiredPermission( | |
| 71 const Extension* extension); | |
| 72 | |
| 67 // Calling FinalizeRegistration indicates that there are no more | 73 // Calling FinalizeRegistration indicates that there are no more |
| 68 // manifest handlers to be registered. | 74 // manifest handlers to be registered. |
| 69 static void FinalizeRegistration(); | 75 static void FinalizeRegistration(); |
| 70 | 76 |
| 71 static bool IsRegistrationFinalized(); | 77 static bool IsRegistrationFinalized(); |
| 72 | 78 |
| 73 // Call Parse on all registered manifest handlers that should parse | 79 // Call Parse on all registered manifest handlers that should parse |
| 74 // this extension. | 80 // this extension. |
| 75 static bool ParseExtension(Extension* extension, string16* error); | 81 static bool ParseExtension(Extension* extension, string16* error); |
| 76 | 82 |
| 77 // Call Validate on all registered manifest handlers for this extension. | 83 // Call Validate on all registered manifest handlers for this extension. |
| 78 static bool ValidateExtension(const Extension* extension, | 84 static bool ValidateExtension(const Extension* extension, |
| 79 std::string* error, | 85 std::string* error, |
| 80 std::vector<InstallWarning>* warnings); | 86 std::vector<InstallWarning>* warnings); |
| 81 | 87 |
| 88 static ManifestPermission* CreatePermission(const std::string& name); | |
| 89 | |
| 90 static void AddExtensionRequiredPermissions( | |
| 91 const Extension* extension, ManifestPermissionSet* permission_set); | |
| 92 | |
| 82 protected: | 93 protected: |
| 83 // A convenience method for handlers that only register for 1 key, | 94 // A convenience method for handlers that only register for 1 key, |
| 84 // so that they can define keys() { return SingleKey(kKey); } | 95 // so that they can define keys() { return SingleKey(kKey); } |
| 85 static const std::vector<std::string> SingleKey(const std::string& key); | 96 static const std::vector<std::string> SingleKey(const std::string& key); |
| 86 | 97 |
| 87 private: | 98 private: |
| 88 // The keys to register us for (in Register). | 99 // The keys to register us for (in Register). |
| 89 virtual const std::vector<std::string> Keys() const = 0; | 100 virtual const std::vector<std::string> Keys() const = 0; |
| 90 }; | 101 }; |
| 91 | 102 |
| 92 // The global registry for manifest handlers. | 103 // The global registry for manifest handlers. |
| 93 class ManifestHandlerRegistry { | 104 class ManifestHandlerRegistry { |
| 94 private: | 105 private: |
| 95 friend class ManifestHandler; | 106 friend class ManifestHandler; |
| 96 friend class ScopedTestingManifestHandlerRegistry; | 107 friend class ScopedTestingManifestHandlerRegistry; |
| 97 friend struct base::DefaultLazyInstanceTraits<ManifestHandlerRegistry>; | 108 friend struct base::DefaultLazyInstanceTraits<ManifestHandlerRegistry>; |
| 98 | 109 |
| 99 ManifestHandlerRegistry(); | 110 ManifestHandlerRegistry(); |
| 100 ~ManifestHandlerRegistry(); | 111 ~ManifestHandlerRegistry(); |
| 101 | 112 |
| 102 void Finalize(); | 113 void Finalize(); |
| 103 | 114 |
| 104 void RegisterManifestHandler(const std::string& key, | 115 void RegisterManifestHandler(const std::string& key, |
| 105 linked_ptr<ManifestHandler> handler); | 116 linked_ptr<ManifestHandler> handler); |
| 106 bool ParseExtension(Extension* extension, string16* error); | 117 bool ParseExtension(Extension* extension, string16* error); |
| 107 bool ValidateExtension(const Extension* extension, | 118 bool ValidateExtension(const Extension* extension, |
| 108 std::string* error, | 119 std::string* error, |
| 109 std::vector<InstallWarning>* warnings); | 120 std::vector<InstallWarning>* warnings); |
| 110 | 121 |
| 122 ManifestPermission* CreatePermission(const std::string& name); | |
| 123 | |
| 124 void AddExtensionRequiredPermissions(const Extension* extension, | |
| 125 ManifestPermissionSet* permission_set); | |
| 126 | |
| 111 // Overrides the current global ManifestHandlerRegistry with | 127 // Overrides the current global ManifestHandlerRegistry with |
| 112 // |registry|, returning the current one. | 128 // |registry|, returning the current one. |
| 113 static ManifestHandlerRegistry* SetForTesting( | 129 static ManifestHandlerRegistry* SetForTesting( |
| 114 ManifestHandlerRegistry* new_registry); | 130 ManifestHandlerRegistry* new_registry); |
| 115 | 131 |
| 116 typedef std::map<std::string, linked_ptr<ManifestHandler> > | 132 typedef std::map<std::string, linked_ptr<ManifestHandler> > |
| 117 ManifestHandlerMap; | 133 ManifestHandlerMap; |
| 118 typedef std::map<ManifestHandler*, int> ManifestHandlerPriorityMap; | 134 typedef std::map<ManifestHandler*, int> ManifestHandlerPriorityMap; |
| 119 | 135 |
| 120 // Puts the manifest handlers in order such that each handler comes after | 136 // Puts the manifest handlers in order such that each handler comes after |
| 121 // any handlers for their PrerequisiteKeys. If there is no handler for | 137 // any handlers for their PrerequisiteKeys. If there is no handler for |
| 122 // a prerequisite key, that dependency is simply ignored. | 138 // a prerequisite key, that dependency is simply ignored. |
| 123 // CHECKs that there are no manifest handlers with circular dependencies. | 139 // CHECKs that there are no manifest handlers with circular dependencies. |
| 124 void SortManifestHandlers(); | 140 void SortManifestHandlers(); |
| 125 | 141 |
| 126 // All registered manifest handlers. | 142 // All registered manifest handlers. |
| 127 ManifestHandlerMap handlers_; | 143 ManifestHandlerMap handlers_; |
| 128 | 144 |
| 129 // The priority for each manifest handler. Handlers with lower priority | 145 // The priority for each manifest handler. Handlers with lower priority |
| 130 // values are evaluated first. | 146 // values are evaluated first. |
| 131 ManifestHandlerPriorityMap priority_map_; | 147 ManifestHandlerPriorityMap priority_map_; |
| 132 | 148 |
| 133 bool is_finalized_; | 149 bool is_finalized_; |
| 134 }; | 150 }; |
| 135 | 151 |
| 136 } // namespace extensions | 152 } // namespace extensions |
| 137 | 153 |
| 138 #endif // EXTENSIONS_COMMON_MANIFEST_HANDLER_H_ | 154 #endif // EXTENSIONS_COMMON_MANIFEST_HANDLER_H_ |
| OLD | NEW |