15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 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) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef CHROME_BROWSER_BACKGROUND_BACKGROUND_APPLICATION_LIST_MODEL_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CHROME_BROWSER_BACKGROUND_BACKGROUND_APPLICATION_LIST_MODEL_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <map> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/observer_list.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/browser/notification_observer.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "content/public/browser/notification_registrar.h" 15f2477e01787aa58f445919b809d89e252beef54fTorne (Richard Coles)#include "extensions/common/extension.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Profile; 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace gfx { 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ImageSkia; 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Model for list of Background Applications associated with a Profile (i.e. 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// extensions with kBackgroundPermission set, or hosted apps with a 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// BackgroundContents). 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class BackgroundApplicationListModel : public content::NotificationObserver { 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Observer is informed of changes to the model. Users of the 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // BackgroundApplicationListModel should anticipate that associated data, 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // e. g. the Icon, may exist and yet not be immediately available. When the 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // data becomes available, OnApplicationDataChanged will be invoked for all 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Observers of the model. 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class Observer { 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Invoked when data that the model associates with the extension, such as 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // the Icon, has changed. 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnApplicationDataChanged( 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const extensions::Extension* extension, 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Profile* profile); 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Invoked when the model detects a previously unknown extension and/or when 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // it no longer detects a previously known extension. 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnApplicationListChanged(Profile* profile); 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~Observer(); 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Create a new model associated with profile. 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) explicit BackgroundApplicationListModel(Profile* profile); 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~BackgroundApplicationListModel(); 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Associate observer with this model. 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AddObserver(Observer* observer); 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Return the icon associated with |extension| or NULL. NULL indicates either 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // that there is no icon associated with the extension, or that a pending 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // task to retrieve the icon has not completed. See the Observer class above. 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // NOTE: The model manages the ImageSkia result, that is it "owns" the memory, 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // releasing it if the associated background application is unloaded. 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // NOTE: All icons are currently sized as 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ExtensionIconSet::EXTENSION_ICON_BITTY. 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const gfx::ImageSkia* GetIcon(const extensions::Extension* extension); 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Return the position of |extension| within this list model. 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int GetPosition(const extensions::Extension* extension) const; 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Return the extension at the specified |position| in this list model. 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const extensions::Extension* GetExtension(int position) const; 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns true if the passed extension is a background app. 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) static bool IsBackgroundApp(const extensions::Extension& extension, 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Profile* profile); 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Dissociate observer from this model. 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void RemoveObserver(Observer* observer); 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) extensions::ExtensionList::const_iterator begin() const { 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return extensions_.begin(); 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) extensions::ExtensionList::const_iterator end() const { 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return extensions_.end(); 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t size() const { 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return extensions_.size(); 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 92116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // Returns true if all startup notifications have already been issued. 93116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch bool is_ready() const { 94116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch return ready_; 95116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch } 96116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Contains data associated with a background application that is not 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // represented by the Extension class. 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class Application; 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Associates extension id strings with Application objects. 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::map<std::string, Application*> ApplicationMap; 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Identifies and caches data related to the extension. 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AssociateApplicationData(const extensions::Extension* extension); 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Clears cached data related to |extension|. 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void DissociateApplicationData(const extensions::Extension* extension); 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the Application associated with |extension| or NULL. 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const Application* FindApplication( 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const extensions::Extension* extension) const; 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns the Application associated with |extension| or NULL. 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Application* FindApplication(const extensions::Extension* extension); 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // content::NotificationObserver implementation. 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void Observe(int type, 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const content::NotificationSource& source, 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const content::NotificationDetails& details) OVERRIDE; 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Notifies observers that some of the data associated with this background 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // application, e. g. the Icon, has changed. 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SendApplicationDataChangedNotifications( 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const extensions::Extension* extension); 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Notifies observers that at least one background application has been added 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // or removed. 1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SendApplicationListChangedNotifications(); 1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1320529e5d033099cbfc42635f6f6183833b09dff6eBen Murdoch // Invoked by Observe for NOTIFICATION_EXTENSION_LOADED_DEPRECATED. 1335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnExtensionLoaded(const extensions::Extension* extension); 1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13523730a6e56a168d1879203e4b3819bb36e3d8f1fTorne (Richard Coles) // Invoked by Observe for NOTIFICATION_EXTENSION_UNLOADED_DEPRECATED. 1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnExtensionUnloaded(const extensions::Extension* extension); 1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Invoked by Observe for NOTIFICATION_EXTENSION_PERMISSIONS_UPDATED. 1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnExtensionPermissionsUpdated( 1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const extensions::Extension* extension, 1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) extensions::UpdatedExtensionPermissionsInfo::Reason reason, 1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const extensions::PermissionSet* permissions); 1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Refresh the list of background applications and generate notifications. 1455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Update(); 1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1471e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // Determines if the given extension has to be considered a "background app" 1481e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // due to its use of PushMessaging. Normally every extension that expectes 1491e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // push messages is classified as "background app", however there are some 1501e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) // rare exceptions, so this function implements a whitelist. 1511e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) static bool RequiresBackgroundModeForPushMessaging( 1521e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) const extensions::Extension& extension); 1531e9bf3e0803691d0a228da41fc608347b6db4340Torne (Richard Coles) 1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ApplicationMap applications_; 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) extensions::ExtensionList extensions_; 156a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) ObserverList<Observer, true> observers_; 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) Profile* profile_; 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) content::NotificationRegistrar registrar_; 159116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch bool ready_; 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(BackgroundApplicationListModel); 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // CHROME_BROWSER_BACKGROUND_BACKGROUND_APPLICATION_LIST_MODEL_H_ 165