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

extensions/common/user_script.h

 // Copyright 2013 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 EXTENSIONS_COMMON_USER_SCRIPT_H_
 #define EXTENSIONS_COMMON_USER_SCRIPT_H_
 
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/files/file_path.h"
+#include "base/memory/linked_ptr.h"
 #include "base/strings/string_piece.h"
+#include "extensions/common/consumer.h"
 #include "extensions/common/url_pattern.h"
 #include "extensions/common/url_pattern_set.h"
 #include "url/gurl.h"
 
 class Pickle;
 class PickleIterator;
 
 namespace extensions {
 
 // Represents a user script, either a standalone one, or one that is part of an
@@ skipping 163 matching lines @@
   void add_exclude_url_pattern(const URLPattern& pattern);
 
   // List of js scripts for this user script
   FileList& js_scripts() { return js_scripts_; }
   const FileList& js_scripts() const { return js_scripts_; }
 
   // List of css scripts for this user script
   FileList& css_scripts() { return css_scripts_; }
   const FileList& css_scripts() const { return css_scripts_; }
 
-  const std::string& extension_id() const { return extension_id_; }
-  void set_extension_id(const std::string& id) { extension_id_ = id; }
+  const std::string& extension_id() const;

[Fady Samuel, 2015/01/07 19:19:40]

This is no longer a trivial accessor and so it must be renamed to GetExtensionID

[Xi Han, 2015/01/07 20:28:42]

Renamed.

+
+  ConsumerID* consumer_id() const { return consumer_id_.get(); }
+  void set_consumer_id(const ConsumerID& consumer_id) {
+    consumer_id_.reset(new ConsumerID(consumer_id));
+  }
 
   int id() const { return user_script_id_; }
   void set_id(int id) { user_script_id_ = id; }
 
   bool is_incognito_enabled() const { return incognito_enabled_; }
   void set_incognito_enabled(bool enabled) { incognito_enabled_ = enabled; }
 
-  bool is_standalone() const { return extension_id_.empty(); }
+  bool is_standalone() const { return extension_id().empty(); }
 
   // Returns true if the script should be applied to the specified URL, false
   // otherwise.
   bool MatchesURL(const GURL& url) const;
 
   // Serialize the UserScript into a pickle. The content of the scripts and
   // paths to UserScript::Files will not be serialized!
   void Pickle(::Pickle* pickle) const;
 
   // Deserialize the script from a pickle. Note that this always succeeds
   // because presumably we were the one that pickled it, and we did it
   // correctly.
   void Unpickle(const ::Pickle& pickle, PickleIterator* iter);
 
  private:
   // Pickle helper functions used to pickle the individual types of components.
   void PickleGlobs(::Pickle* pickle,
                    const std::vector<std::string>& globs) const;
+  void PickleConsumerID(::Pickle* pickle,
+                        linked_ptr<ConsumerID> consumer_id) const;
   void PickleURLPatternSet(::Pickle* pickle,
                            const URLPatternSet& pattern_list) const;
   void PickleScripts(::Pickle* pickle, const FileList& scripts) const;
 
   // Unpickle helper functions used to unpickle individual types of components.
   void UnpickleGlobs(const ::Pickle& pickle, PickleIterator* iter,
                      std::vector<std::string>* globs);
+  ConsumerID* UnpickleConsumerID(const ::Pickle& pickle, PickleIterator* iter);
   void UnpickleURLPatternSet(const ::Pickle& pickle, PickleIterator* iter,
                              URLPatternSet* pattern_list);
   void UnpickleScripts(const ::Pickle& pickle, PickleIterator* iter,
                        FileList* scripts);
 
   // The location to run the script inside the document.
   RunLocation run_location_;
 
   // The namespace of the script. This is used by Greasemonkey in the same way
   // as XML namespaces. Only used when parsing Greasemonkey-style scripts.
@@ skipping 18 matching lines @@
   // only used with scripts that are part of extensions.
   URLPatternSet url_set_;
   URLPatternSet exclude_url_set_;
 
   // List of js scripts defined in content_scripts
   FileList js_scripts_;
 
   // List of css scripts defined in content_scripts
   FileList css_scripts_;
 
-  // The ID of the extension this script is a part of, if any. Can be empty if
-  // the script is a "standlone" user script.
-  std::string extension_id_;
+  // The ID of the consumer this script is a part of. The host_id of the
+  // consumer_id can be empty if the script is a "standlone" user script.
+  linked_ptr<ConsumerID> consumer_id_;

[Fady Samuel, 2015/01/07 19:19:40]

Why is this a linked_ptr? Can it be a scoped_ptr?

[Xi Han, 2015/01/07 20:28:42]

No, it can't be a scoped_ptr, since scoped_ptr is not copyable. There are many
places that objects of UserScript be stored in STL containers, for example:
https://code.google.com/p/chromium/codesearch#chromium/src/chrome/common/exte....

 
   // The globally-unique id associated with this user script. Defaults to
   // -1 for invalid.
   int user_script_id_;
 
   // Whether we should try to emulate Greasemonkey's APIs when running this
   // script.
   bool emulate_greasemonkey_;
 
   // Whether the user script should run in all frames, or only just the top one.
   // Defaults to false.
   bool match_all_frames_;
 
   // Whether the user script should run in about:blank and about:srcdoc as well.
   // Defaults to false.
   bool match_about_blank_;
 
   // True if the script should be injected into an incognito tab.
   bool incognito_enabled_;
 };
 
 // For storing UserScripts with unique IDs in sets.
 bool operator<(const UserScript& script1, const UserScript& script2);
 
 typedef std::vector<UserScript> UserScriptList;
 
 }  // namespace extensions
 
 #endif  // EXTENSIONS_COMMON_USER_SCRIPT_H_