| OLD | NEW |
| 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 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 | 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 CHROME_COMMON_EXTENSIONS_EXTENSION_SET_H_ | 5 #ifndef EXTENSIONS_COMMON_EXTENSION_SET_H_ |
| 6 #define CHROME_COMMON_EXTENSIONS_EXTENSION_SET_H_ | 6 #define EXTENSIONS_COMMON_EXTENSION_SET_H_ |
| 7 | 7 |
| 8 #include <iterator> | 8 #include <iterator> |
| 9 #include <map> | 9 #include <map> |
| 10 #include <string> | 10 #include <string> |
| 11 | 11 |
| 12 #include "base/callback_forward.h" | 12 #include "base/callback_forward.h" |
| 13 #include "base/gtest_prod_util.h" | 13 #include "base/gtest_prod_util.h" |
| 14 #include "base/memory/ref_counted.h" | 14 #include "base/memory/ref_counted.h" |
| 15 #include "extensions/common/extension.h" | 15 #include "extensions/common/extension.h" |
| 16 #include "url/gurl.h" | 16 #include "url/gurl.h" |
| 17 | 17 |
| 18 namespace extensions { |
| 19 |
| 18 // The one true extension container. Extensions are identified by their id. | 20 // The one true extension container. Extensions are identified by their id. |
| 19 // Only one extension can be in the set with a given ID. | 21 // Only one extension can be in the set with a given ID. |
| 20 class ExtensionSet { | 22 class ExtensionSet { |
| 21 public: | 23 public: |
| 22 typedef std::pair<base::FilePath, std::string> ExtensionPathAndDefaultLocale; | 24 typedef std::pair<base::FilePath, std::string> ExtensionPathAndDefaultLocale; |
| 23 typedef std::map<std::string, scoped_refptr<const extensions::Extension> > | 25 typedef std::map<std::string, scoped_refptr<const Extension> > ExtensionMap; |
| 24 ExtensionMap; | 26 typedef base::Callback<void(const ExtensionIdSet&)> |
| 25 typedef base::Callback<void(const extensions::ExtensionIdSet&)> | |
| 26 ModificationCallback; | 27 ModificationCallback; |
| 27 | 28 |
| 28 // Iteration over the values of the map (given that it's an ExtensionSet, | 29 // Iteration over the values of the map (given that it's an ExtensionSet, |
| 29 // it should iterate like a set iterator). | 30 // it should iterate like a set iterator). |
| 30 class const_iterator : | 31 class const_iterator : public std::iterator<std::input_iterator_tag, |
| 31 public std::iterator<std::input_iterator_tag, | 32 scoped_refptr<const Extension> > { |
| 32 scoped_refptr<const extensions::Extension> > { | |
| 33 public: | 33 public: |
| 34 const_iterator(); | 34 const_iterator(); |
| 35 const_iterator(const const_iterator& other); | 35 const_iterator(const const_iterator& other); |
| 36 explicit const_iterator(ExtensionMap::const_iterator it); | 36 explicit const_iterator(ExtensionMap::const_iterator it); |
| 37 ~const_iterator(); | 37 ~const_iterator(); |
| 38 const_iterator& operator++() { | 38 const_iterator& operator++() { |
| 39 ++it_; | 39 ++it_; |
| 40 return *this; | 40 return *this; |
| 41 } | 41 } |
| 42 const_iterator operator++(int) { | 42 const_iterator operator++(int) { |
| 43 const const_iterator old(*this); | 43 const const_iterator old(*this); |
| 44 ++it_; | 44 ++it_; |
| 45 return old; | 45 return old; |
| 46 } | 46 } |
| 47 const scoped_refptr<const extensions::Extension>& operator*() const { | 47 const scoped_refptr<const Extension>& operator*() const { |
| 48 return it_->second; | 48 return it_->second; |
| 49 } | 49 } |
| 50 const scoped_refptr<const extensions::Extension>* operator->() const { | 50 const scoped_refptr<const Extension>* operator->() const { |
| 51 return &it_->second; | 51 return &it_->second; |
| 52 } | 52 } |
| 53 bool operator!=(const const_iterator& other) const { | 53 bool operator!=(const const_iterator& other) const { |
| 54 return it_ != other.it_; | 54 return it_ != other.it_; |
| 55 } | 55 } |
| 56 bool operator==(const const_iterator& other) const { | 56 bool operator==(const const_iterator& other) const { |
| 57 return it_ == other.it_; | 57 return it_ == other.it_; |
| 58 } | 58 } |
| 59 | 59 |
| 60 private: | 60 private: |
| 61 ExtensionMap::const_iterator it_; | 61 ExtensionMap::const_iterator it_; |
| 62 }; | 62 }; |
| 63 | 63 |
| 64 ExtensionSet(); | 64 ExtensionSet(); |
| 65 ~ExtensionSet(); | 65 ~ExtensionSet(); |
| 66 | 66 |
| 67 size_t size() const; | 67 size_t size() const; |
| 68 bool is_empty() const; | 68 bool is_empty() const; |
| 69 | 69 |
| 70 // Iteration support. | 70 // Iteration support. |
| 71 const_iterator begin() const { return const_iterator(extensions_.begin()); } | 71 const_iterator begin() const { return const_iterator(extensions_.begin()); } |
| 72 const_iterator end() const { return const_iterator(extensions_.end()); } | 72 const_iterator end() const { return const_iterator(extensions_.end()); } |
| 73 | 73 |
| 74 // Returns true if the set contains the specified extension. | 74 // Returns true if the set contains the specified extension. |
| 75 bool Contains(const std::string& id) const; | 75 bool Contains(const std::string& id) const; |
| 76 | 76 |
| 77 // Adds the specified extension to the set. The set becomes an owner. Any | 77 // Adds the specified extension to the set. The set becomes an owner. Any |
| 78 // previous extension with the same ID is removed. | 78 // previous extension with the same ID is removed. |
| 79 // Returns true if there is no previous extension. | 79 // Returns true if there is no previous extension. |
| 80 bool Insert(const scoped_refptr<const extensions::Extension>& extension); | 80 bool Insert(const scoped_refptr<const Extension>& extension); |
| 81 | 81 |
| 82 // Copies different items from |extensions| to the current set and returns | 82 // Copies different items from |extensions| to the current set and returns |
| 83 // whether anything changed. | 83 // whether anything changed. |
| 84 bool InsertAll(const ExtensionSet& extensions); | 84 bool InsertAll(const ExtensionSet& extensions); |
| 85 | 85 |
| 86 // Removes the specified extension. | 86 // Removes the specified extension. |
| 87 // Returns true if the set contained the specified extnesion. | 87 // Returns true if the set contained the specified extnesion. |
| 88 bool Remove(const std::string& id); | 88 bool Remove(const std::string& id); |
| 89 | 89 |
| 90 // Removes all extensions. | 90 // Removes all extensions. |
| 91 void Clear(); | 91 void Clear(); |
| 92 | 92 |
| 93 // Returns the extension ID, or empty if none. This includes web URLs that | 93 // Returns the extension ID, or empty if none. This includes web URLs that |
| 94 // are part of an extension's web extent. | 94 // are part of an extension's web extent. |
| 95 std::string GetExtensionOrAppIDByURL(const GURL& url) const; | 95 std::string GetExtensionOrAppIDByURL(const GURL& url) const; |
| 96 | 96 |
| 97 // Returns the Extension, or NULL if none. This includes web URLs that are | 97 // Returns the Extension, or NULL if none. This includes web URLs that are |
| 98 // part of an extension's web extent. | 98 // part of an extension's web extent. |
| 99 // NOTE: This can return NULL if called before UpdateExtensions receives | 99 // NOTE: This can return NULL if called before UpdateExtensions receives |
| 100 // bulk extension data (e.g. if called from | 100 // bulk extension data (e.g. if called from |
| 101 // EventBindings::HandleContextCreated) | 101 // EventBindings::HandleContextCreated) |
| 102 const extensions::Extension* GetExtensionOrAppByURL(const GURL& url) const; | 102 const Extension* GetExtensionOrAppByURL(const GURL& url) const; |
| 103 | 103 |
| 104 // Returns the hosted app whose web extent contains the URL. | 104 // Returns the hosted app whose web extent contains the URL. |
| 105 const extensions::Extension* GetHostedAppByURL(const GURL& url) const; | 105 const Extension* GetHostedAppByURL(const GURL& url) const; |
| 106 | 106 |
| 107 // Returns a hosted app that contains any URL that overlaps with the given | 107 // Returns a hosted app that contains any URL that overlaps with the given |
| 108 // extent, if one exists. | 108 // extent, if one exists. |
| 109 const extensions::Extension* GetHostedAppByOverlappingWebExtent( | 109 const Extension* GetHostedAppByOverlappingWebExtent( |
| 110 const extensions::URLPatternSet& extent) const; | 110 const URLPatternSet& extent) const; |
| 111 | 111 |
| 112 // Returns true if |new_url| is in the extent of the same extension as | 112 // Returns true if |new_url| is in the extent of the same extension as |
| 113 // |old_url|. Also returns true if neither URL is in an app. | 113 // |old_url|. Also returns true if neither URL is in an app. |
| 114 bool InSameExtent(const GURL& old_url, const GURL& new_url) const; | 114 bool InSameExtent(const GURL& old_url, const GURL& new_url) const; |
| 115 | 115 |
| 116 // Look up an Extension object by id. | 116 // Look up an Extension object by id. |
| 117 const extensions::Extension* GetByID(const std::string& id) const; | 117 const Extension* GetByID(const std::string& id) const; |
| 118 | 118 |
| 119 // Gets the IDs of all extensions in the set. | 119 // Gets the IDs of all extensions in the set. |
| 120 extensions::ExtensionIdSet GetIDs() const; | 120 ExtensionIdSet GetIDs() const; |
| 121 | 121 |
| 122 // Returns true if |info| should get extension api bindings and be permitted | 122 // Returns true if |info| should get extension api bindings and be permitted |
| 123 // to make api calls. Note that this is independent of what extension | 123 // to make api calls. Note that this is independent of what extension |
| 124 // permissions the given extension has been granted. | 124 // permissions the given extension has been granted. |
| 125 bool ExtensionBindingsAllowed(const GURL& url) const; | 125 bool ExtensionBindingsAllowed(const GURL& url) const; |
| 126 | 126 |
| 127 void set_modification_callback( | 127 void set_modification_callback( |
| 128 const ModificationCallback& modification_callback) { | 128 const ModificationCallback& modification_callback) { |
| 129 modification_callback_ = modification_callback; | 129 modification_callback_ = modification_callback; |
| 130 } | 130 } |
| 131 | 131 |
| 132 private: | 132 private: |
| 133 FRIEND_TEST_ALL_PREFIXES(ExtensionSetTest, ExtensionSet); | 133 FRIEND_TEST_ALL_PREFIXES(ExtensionSetTest, ExtensionSet); |
| 134 | 134 |
| 135 ExtensionMap extensions_; | 135 ExtensionMap extensions_; |
| 136 | 136 |
| 137 // If non-null, called with the extension ids in this set after a modification | 137 // If non-null, called with the extension ids in this set after a modification |
| 138 // occurred. This is not called on Clear() which is typically used when | 138 // occurred. This is not called on Clear() which is typically used when |
| 139 // discarding the set (e.g., on shutdown) and we do not want to track that as | 139 // discarding the set (e.g., on shutdown) and we do not want to track that as |
| 140 // a real modification. | 140 // a real modification. |
| 141 ModificationCallback modification_callback_; | 141 ModificationCallback modification_callback_; |
| 142 | 142 |
| 143 DISALLOW_COPY_AND_ASSIGN(ExtensionSet); | 143 DISALLOW_COPY_AND_ASSIGN(ExtensionSet); |
| 144 }; | 144 }; |
| 145 | 145 |
| 146 #endif // CHROME_COMMON_EXTENSIONS_EXTENSION_SET_H_ | 146 } // namespace extensions |
| 147 |
| 148 #endif // EXTENSIONS_COMMON_EXTENSION_SET_H_ |
| OLD | NEW |