15d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)// Copyright 2013 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#ifndef EXTENSIONS_COMMON_EXTENSION_SET_H_ 65d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#define EXTENSIONS_COMMON_EXTENSION_SET_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <iterator> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <map> 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1246d4c2bc3267f3f028f39e7e311b0f89aba2e4fdTorne (Richard Coles)#include "base/callback.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/gtest_prod_util.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/ref_counted.h" 15f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)#include "extensions/common/extension.h" 167dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch#include "url/gurl.h" 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 185d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)namespace extensions { 195d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The one true extension container. Extensions are identified by their id. 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Only one extension can be in the set with a given ID. 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ExtensionSet { 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) typedef std::pair<base::FilePath, std::string> ExtensionPathAndDefaultLocale; 255d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) typedef std::map<std::string, scoped_refptr<const Extension> > ExtensionMap; 265d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) typedef base::Callback<void(const ExtensionIdSet&)> 271e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) ModificationCallback; 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Iteration over the values of the map (given that it's an ExtensionSet, 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // it should iterate like a set iterator). 315d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) class const_iterator : public std::iterator<std::input_iterator_tag, 325d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) scoped_refptr<const Extension> > { 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_iterator(); 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_iterator(const const_iterator& other); 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) explicit const_iterator(ExtensionMap::const_iterator it); 37a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) ~const_iterator(); 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_iterator& operator++() { 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ++it_; 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return *this; 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 424e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) const_iterator operator++(int) { 434e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) const const_iterator old(*this); 444e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) ++it_; 454e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) return old; 464e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) } 475d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const scoped_refptr<const Extension>& operator*() const { 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return it_->second; 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 505d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const scoped_refptr<const Extension>* operator->() const { 517d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles) return &it_->second; 527d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles) } 534e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) bool operator!=(const const_iterator& other) const { 544e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) return it_ != other.it_; 554e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) } 564e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) bool operator==(const const_iterator& other) const { 574e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) return it_ == other.it_; 584e180b6a0b4720a9b8e9e959a882386f690f08ffTorne (Richard Coles) } 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ExtensionMap::const_iterator it_; 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ExtensionSet(); 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~ExtensionSet(); 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t size() const; 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_empty() const; 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Iteration support. 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_iterator begin() const { return const_iterator(extensions_.begin()); } 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const_iterator end() const { return const_iterator(extensions_.end()); } 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if the set contains the specified extension. 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool Contains(const std::string& id) const; 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Adds the specified extension to the set. The set becomes an owner. Any 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // previous extension with the same ID is removed. 79c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) // Returns true if there is no previous extension. 805d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) bool Insert(const scoped_refptr<const Extension>& extension); 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Copies different items from |extensions| to the current set and returns 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // whether anything changed. 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool InsertAll(const ExtensionSet& extensions); 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Removes the specified extension. 872a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Returns true if the set contained the specified extnesion. 882a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) bool Remove(const std::string& id); 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Removes all extensions. 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Clear(); 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the extension ID, or empty if none. This includes web URLs that 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // are part of an extension's web extent. 95ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch std::string GetExtensionOrAppIDByURL(const GURL& url) const; 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the Extension, or NULL if none. This includes web URLs that are 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // part of an extension's web extent. 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // NOTE: This can return NULL if called before UpdateExtensions receives 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // bulk extension data (e.g. if called from 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // EventBindings::HandleContextCreated) 1025d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const Extension* GetExtensionOrAppByURL(const GURL& url) const; 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 104a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch // Returns the app specified by the given |url|, if one exists. This will 105a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch // return NULL if there is no entry with |url|, or if the extension with 106a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch // |url| is not an app. 107a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch const Extension* GetAppByURL(const GURL& url) const; 108a02191e04bc25c4935f804f2c080ae28663d096dBen Murdoch 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the hosted app whose web extent contains the URL. 1105d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const Extension* GetHostedAppByURL(const GURL& url) const; 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns a hosted app that contains any URL that overlaps with the given 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // extent, if one exists. 1145d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const Extension* GetHostedAppByOverlappingWebExtent( 1155d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const URLPatternSet& extent) const; 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if |new_url| is in the extent of the same extension as 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |old_url|. Also returns true if neither URL is in an app. 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool InSameExtent(const GURL& old_url, const GURL& new_url) const; 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Look up an Extension object by id. 1225d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const Extension* GetByID(const std::string& id) const; 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1242a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) // Gets the IDs of all extensions in the set. 1255d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) ExtensionIdSet GetIDs() const; 1262a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles) 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if |info| should get extension api bindings and be permitted 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // to make api calls. Note that this is independent of what extension 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // permissions the given extension has been granted. 130ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch bool ExtensionBindingsAllowed(const GURL& url) const; 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1321e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) void set_modification_callback( 1331e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) const ModificationCallback& modification_callback) { 1341e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) modification_callback_ = modification_callback; 1351e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) } 1361e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) FRIEND_TEST_ALL_PREFIXES(ExtensionSetTest, ExtensionSet); 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ExtensionMap extensions_; 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1421e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // If non-null, called with the extension ids in this set after a modification 1431e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // occurred. This is not called on Clear() which is typically used when 1441e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // discarding the set (e.g., on shutdown) and we do not want to track that as 1451e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // a real modification. 1461e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) ModificationCallback modification_callback_; 1471e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) 1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(ExtensionSet); 1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1515d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)} // namespace extensions 1525d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1535d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#endif // EXTENSIONS_COMMON_EXTENSION_SET_H_ 154