Introduce HostID and de-couple Extensions from "script injection System" [browser side]

chrome/browser/extensions/user_script_loader.h

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CHROME_BROWSER_EXTENSIONS_USER_SCRIPT_LOADER_H_
 #define CHROME_BROWSER_EXTENSIONS_USER_SCRIPT_LOADER_H_
 
 #include <map>
 #include <set>
 
 #include "base/compiler_specific.h"
 #include "base/memory/scoped_ptr.h"
+#include "base/memory/shared_memory.h"
 #include "base/memory/weak_ptr.h"
 #include "base/scoped_observer.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_registrar.h"
-#include "extensions/browser/extension_registry_observer.h"
-#include "extensions/common/extension.h"
-#include "extensions/common/extension_set.h"
+#include "extensions/common/consumer.h"
 #include "extensions/common/user_script.h"
 
 namespace base {
 class SharedMemory;
 }
 
 namespace content {
 class BrowserContext;
 class RenderProcessHost;
 }
 
 class Profile;
 
 namespace extensions {
 
 class ContentVerifier;
-class ExtensionRegistry;
-
-typedef std::map<ExtensionId, ExtensionSet::ExtensionPathAndDefaultLocale>
-    ExtensionsInfo;
 
 // Manages one "logical unit" of user scripts in shared memory by constructing a
 // new shared memory region when the set of scripts changes. Also notifies
 // renderers of new shared memory region when new renderers appear, or when
 // script reloading completes. Script loading lives on the UI thread. Instances
 // of this class are embedded within classes with names ending in
 // UserScriptMaster. These "master" classes implement the strategy for which
 // scripts to load/unload on this logical unit of scripts.
-class UserScriptLoader : public content::NotificationObserver,
-                         public ExtensionRegistryObserver {
+class UserScriptLoader : public content::NotificationObserver {
  public:
+  using PathAndDefaultLocale = std::pair<base::FilePath, std::string>;
+  using ConsumersInfo = std::map<ConsumerID, PathAndDefaultLocale>;
+
+  using SubstitutionMap = std::map<std::string, std::string>;
+  using LoadUserScriptsFunctionCallback =
+      base::Callback<bool(const ConsumerID&,
+                          UserScript::File*,
+                          const SubstitutionMap*,
+                          scoped_refptr<ContentVerifier>)>;
+
   // Parses the includes out of |script| and returns them in |includes|.
   static bool ParseMetadataHeader(const base::StringPiece& script_text,
                                   UserScript* script);
 
+  UserScriptLoader(Profile* profile,
+                   const ConsumerID& consumer_id,
+                   ContentVerifier* content_verifier = nullptr);

[Devlin, 2015/01/20 17:51:06]

nit: we don't allow default values for arguments.

[Xi Han, 2015/01/21 21:30:17]

Thank for pointing out this.

+  ~UserScriptLoader() override;
+
   // A wrapper around the method to load user scripts, which is normally run on
   // the file thread. Exposed only for tests.
-  static void LoadScriptsForTest(UserScriptList* user_scripts);
-
-  UserScriptLoader(Profile* profile,
-                   const ExtensionId& owner_extension_id,
-                   bool listen_for_extension_system_loaded);
-  ~UserScriptLoader() override;
+  void LoadScriptsForTest(UserScriptList* user_scripts);
 
   // Add |scripts| to the set of scripts managed by this loader.
   void AddScripts(const std::set<UserScript>& scripts);
 
   // Remove |scripts| from the set of scripts managed by this loader.
   void RemoveScripts(const std::set<UserScript>& scripts);
 
   // Clears the set of scripts managed by this loader.
   void ClearScripts();
 
   // Initiates procedure to start loading scripts on the file thread.
   void StartLoad();
 
-  // Return true if we have any scripts ready.
+  // Returns true if we have any scripts ready.
   bool scripts_ready() const { return shared_memory_.get() != NULL; }
 
+ protected:
+  using ConsumerIDSet = std::set<ConsumerID>;
+
+  // Updates |consumers_info_| to contain info for each element of
+  // |changed_consumers_|.
+  virtual void UpdateConsumersInfo(const ConsumerIDSet& changed_consumers) = 0;
+
+  // Returns a function pointer of a static funcion.
+  // Base and derived classes can specify their ways to load user scripts.
+  virtual LoadUserScriptsFunctionCallback GetLoadUserScriptsFunction();
+
+  // Notifies render process and convert |changed_consumers| to specified types

[Devlin, 2015/01/20 17:51:06]

nit: Just "Notifies the render process of any updated scripts." The fact that
the extension version converts consumer ids is an implementation detail.

[Xi Han, 2015/01/21 21:30:17]

Done.

+  // of consumers.
+  virtual void SendUpdate(content::RenderProcessHost* process,
+                          base::SharedMemoryHandle handle_for_process,
+                          const std::set<ConsumerID>& changed_consumers) = 0;
+
+  // Loads user scripts.
+  static bool LoadScriptContent(const ConsumerID& consumer_id,
+                                UserScript::File* script_file,
+                                const SubstitutionMap* localization_messages,
+                                scoped_refptr<ContentVerifier> verifier);
+
+  // Adds the |consumer_id, location| to the consumers_info_ map.
+  // Only inserts the entry to the map when the given consumer_id doesn't
+  // exists.
+  void AddConsumerInfo(const ConsumerID& consumer_id,
+                       const PathAndDefaultLocale& location);
+
+  // Removes the entries with the given host_id from the consumers_info_ map.

[Devlin, 2015/01/20 17:51:06]

nit: It's common practice to wrap variable names in bars, i.e.
|consumers_info_|. (Goes for everywhere.)

[Xi Han, 2015/01/21 21:30:17]

Updated.

+  void RemoveConsumerInfo(const std::string& host_id);
+
+  // Sets the flag if the initial set of consumers has finished loading; if it's
+  // set to be true, calls AttempLoad() to bootstrap.
+  void SetReady(bool ready);
+
+  Profile* profile() const { return profile_; }
+  const ConsumerID& consumer_id() const { return consumer_id_; }
+
  private:
   // content::NotificationObserver implementation.
   void Observe(int type,
                const content::NotificationSource& source,
                const content::NotificationDetails& details) override;
 
-  // ExtensionRegistryObserver implementation.
-  void OnExtensionUnloaded(content::BrowserContext* browser_context,
-                           const Extension* extension,
-                           UnloadedExtensionInfo::Reason reason) override;
-
-  // Initiates script load when we have been waiting for the extension system
-  // to be ready.
-  void OnExtensionSystemReady();
-
   // Returns whether or not it is possible that calls to AddScripts(),
   // RemoveScripts(), and/or ClearScripts() have caused any real change in the
   // set of scripts to be loaded.
   bool ScriptsMayHaveChanged() const;
 
-  // Attempt to initiate a load.
+  // Attempts to initiate a load.
   void AttemptLoad();
 
   // Called once we have finished loading the scripts on the file thread.
   void OnScriptsLoaded(scoped_ptr<UserScriptList> user_scripts,
                        scoped_ptr<base::SharedMemory> shared_memory);
 
   // Sends the renderer process a new set of user scripts. If
-  // |changed_extensions| is not empty, this signals that only the scripts from
-  // those extensions should be updated. Otherwise, all extensions will be
+  // |changed_consumers| is not empty, this signals that only the scripts from
+  // those consumers should be updated. Otherwise, all consumers will be
   // updated.
   void SendUpdate(content::RenderProcessHost* process,
                   base::SharedMemory* shared_memory,
-                  const std::set<ExtensionId>& changed_extensions);
+                  const ConsumerIDSet& changed_consumers);
 
-  // Add to |changed_extensions_| those extensions referred to by |scripts|.
-  void ExpandChangedExtensions(const std::set<UserScript>& scripts);
-
-  // Update |extensions_info_| to contain info for each element of
-  // |changed_extensions_|.
-  void UpdateExtensionsInfo();
+  // Adds to |changed_consumers_| those consumers referred to by |scripts|.
+  void ExpandChangedConsumers(const std::set<UserScript>& scripts);
 
   bool is_loading() const {
     // Ownership of |user_scripts_| is passed to the file thread when loading.
     return user_scripts_.get() == NULL;
   }
 
   // Manages our notification registrations.
   content::NotificationRegistrar registrar_;
 
   // Contains the scripts that were found the last time scripts were updated.
   scoped_ptr<base::SharedMemory> shared_memory_;
 
   // List of scripts from currently-installed extensions we should load.
   scoped_ptr<UserScriptList> user_scripts_;
 
-  // Maps extension info needed for localization to an extension ID.
-  ExtensionsInfo extensions_info_;
+  // Maps consumer info needed for localization to a host ID.
+  ConsumersInfo consumers_info_;
 
   // The mutually-exclusive sets of scripts that were added or removed since the
   // last script load.
   std::set<UserScript> added_scripts_;
   std::set<UserScript> removed_scripts_;
 
   // Indicates whether the the collection of scripts should be cleared before
   // additions and removals on the next script load.
   bool clear_scripts_;
 
   // The IDs of the extensions which changed in the last update sent to the
   // renderer.
-  ExtensionIdSet changed_extensions_;
+  ConsumerIDSet changed_consumers_;
 
-  // If the extensions service has finished loading its initial set of
-  // extensions.
-  bool extension_system_ready_;
+  // If the initial set of consumers has finished loading.
+  bool ready_;
 
   // If list of user scripts is modified while we're loading it, we note
   // that we're currently mid-load and then start over again once the load
   // finishes.  This boolean tracks whether another load is pending.
   bool pending_load_;
 
   // Whether or not we are currently loading.
   bool is_loading_;
 
   // The profile for which the scripts managed here are installed.
   Profile* profile_;
 
-  // ID of the extension that owns these scripts, if any. This is only set to a
+  // ID of the consumer that owns these scripts, if any. This is only set to a
   // non-empty value for declarative user script shared memory regions.
-  ExtensionId owner_extension_id_;
+  ConsumerID consumer_id_;
 
-  ScopedObserver<ExtensionRegistry, ExtensionRegistryObserver>
-      extension_registry_observer_;
+  // Manages content verification of the loaded user scripts.
+  ContentVerifier* content_verifier_;

[Devlin, 2015/01/20 17:51:06]

Please store this as a scoped_refptr.

[Xi Han, 2015/01/21 21:30:17]

Done.

 
   base::WeakPtrFactory<UserScriptLoader> weak_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(UserScriptLoader);
 };
 
 }  // namespace extensions
 
 #endif  // CHROME_BROWSER_EXTENSIONS_USER_SCRIPT_LOADER_H_