1 // Copyright 2013 The Chromium Authors. All rights reserved. 2 // Use of this source code is governed by a BSD-style license that can be 3 // found in the LICENSE file. 4 5 #ifndef EXTENSIONS_COMMON_MANIFEST_HANDLERS_BACKGROUND_INFO_H_ 6 #define EXTENSIONS_COMMON_MANIFEST_HANDLERS_BACKGROUND_INFO_H_ 7 8 #include <string> 9 #include <vector> 10 11 #include "base/values.h" 12 #include "extensions/common/extension.h" 13 #include "extensions/common/manifest_handler.h" 14 #include "url/gurl.h" 15 16 namespace extensions { 17 18 class BackgroundInfo : public Extension::ManifestData { 19 public: 20 BackgroundInfo(); 21 virtual ~BackgroundInfo(); 22 23 static GURL GetBackgroundURL(const Extension* extension); 24 static const std::vector<std::string>& GetBackgroundScripts( 25 const Extension* extension); 26 static const std::string& GetServiceWorkerScript(const Extension* extension); 27 static bool HasBackgroundPage(const Extension* extension); 28 static bool HasPersistentBackgroundPage(const Extension* extension); 29 static bool HasLazyBackgroundPage(const Extension* extension); 30 static bool HasGeneratedBackgroundPage(const Extension* extension); 31 static bool HasServiceWorker(const Extension* extension); 32 static bool AllowJSAccess(const Extension* extension); 33 has_background_page()34 bool has_background_page() const { 35 return background_url_.is_valid() || !background_scripts_.empty(); 36 } 37 has_persistent_background_page()38 bool has_persistent_background_page() const { 39 return has_background_page() && is_persistent_; 40 } 41 has_lazy_background_page()42 bool has_lazy_background_page() const { 43 return has_background_page() && !is_persistent_; 44 } 45 has_service_worker()46 bool has_service_worker() const { return !service_worker_script_.empty(); } 47 48 bool Parse(const Extension* extension, base::string16* error); 49 50 private: 51 bool LoadServiceWorkerScript(const Extension* extension, 52 const std::string& key, 53 base::string16* error); 54 bool LoadBackgroundScripts(const Extension* extension, 55 const std::string& key, 56 base::string16* error); 57 bool LoadBackgroundPage(const Extension* extension, 58 const std::string& key, 59 base::string16* error); 60 bool LoadBackgroundPage(const Extension* extension, base::string16* error); 61 bool LoadBackgroundPersistent(const Extension* extension, 62 base::string16* error); 63 bool LoadAllowJSAccess(const Extension* extension, base::string16* error); 64 65 // Optional URL to a master page of which a single instance should be always 66 // loaded in the background. 67 GURL background_url_; 68 69 // Optional list of scripts to use to generate a background page. If this is 70 // present, background_url_ will be empty and generated by GetBackgroundURL(). 71 std::vector<std::string> background_scripts_; 72 73 // True if the background page should stay loaded forever; false if it should 74 // load on-demand (when it needs to handle an event). Defaults to true. 75 bool is_persistent_; 76 77 // Optional script to register as a service worker. This is mutually exclusive 78 // to the use of background_url_ or background_scripts_. 79 std::string service_worker_script_; 80 81 // True if the background page can be scripted by pages of the app or 82 // extension, in which case all such pages must run in the same process. 83 // False if such pages are not permitted to script the background page, 84 // allowing them to run in different processes. 85 // Defaults to true. 86 bool allow_js_access_; 87 88 DISALLOW_COPY_AND_ASSIGN(BackgroundInfo); 89 }; 90 91 // Parses all background/event page-related keys in the manifest. 92 class BackgroundManifestHandler : public ManifestHandler { 93 public: 94 BackgroundManifestHandler(); 95 virtual ~BackgroundManifestHandler(); 96 97 virtual bool Parse(Extension* extension, base::string16* error) OVERRIDE; 98 virtual bool Validate(const Extension* extension, 99 std::string* error, 100 std::vector<InstallWarning>* warnings) const OVERRIDE; 101 virtual bool AlwaysParseForType(Manifest::Type type) const OVERRIDE; 102 103 private: 104 virtual const std::vector<std::string> Keys() const OVERRIDE; 105 106 DISALLOW_COPY_AND_ASSIGN(BackgroundManifestHandler); 107 }; 108 109 } // namespace extensions 110 111 #endif // EXTENSIONS_COMMON_MANIFEST_HANDLERS_BACKGROUND_INFO_H_ 112