Declarative content scripts: Browser-side: per-extension shared memory regions (lazily loaded)

chrome/browser/extensions/user_script_master.cc

 // Copyright (c) 2012 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.
 
 #include "chrome/browser/extensions/user_script_master.h"
 
 #include <string>
 
 #include "base/bind.h"
 #include "base/bind_helpers.h"
 #include "base/file_util.h"
 #include "base/files/file_path.h"
 #include "base/memory/shared_memory.h"
 #include "base/version.h"
 #include "chrome/browser/chrome_notification_types.h"
 #include "chrome/browser/extensions/extension_util.h"
 #include "chrome/browser/profiles/profile.h"
-#include "chrome/common/extensions/api/i18n/default_locale_handler.h"
 #include "chrome/common/extensions/manifest_handlers/content_scripts_handler.h"
 #include "content/public/browser/notification_service.h"
 #include "content/public/browser/render_process_host.h"
 #include "extensions/browser/component_extension_resource_manager.h"
 #include "extensions/browser/content_verifier.h"
 #include "extensions/browser/extension_registry.h"
 #include "extensions/browser/extension_system.h"
 #include "extensions/browser/extensions_browser_client.h"
 #include "extensions/common/file_util.h"
 #include "extensions/common/message_bundle.h"
 #include "ui/base/resource/resource_bundle.h"
 
 using content::BrowserThread;
 using extensions::ExtensionsBrowserClient;
 
 namespace extensions {
 
 namespace {
 
 typedef base::Callback<void(scoped_ptr<UserScriptList>,
                             scoped_ptr<base::SharedMemory>)>
                                 LoadScriptsCallback;
 
 void VerifyContent(scoped_refptr<ContentVerifier> verifier,
-                   const std::string& extension_id,
+                   const ExtensionId& extension_id,
                    const base::FilePath& extension_root,
                    const base::FilePath& relative_path,
                    const std::string& content) {
   DCHECK_CURRENTLY_ON(content::BrowserThread::IO);
   scoped_refptr<ContentVerifyJob> job(
       verifier->CreateJobFor(extension_id, extension_root, relative_path));
   if (job.get()) {
     job->Start();
     job->BytesRead(content.size(), content.data());
     job->DoneReading();
   }
 }
 
-bool LoadScriptContent(const std::string& extension_id,
+bool LoadScriptContent(const ExtensionId& extension_id,
                        UserScript::File* script_file,
                        const SubstitutionMap* localization_messages,
                        scoped_refptr<ContentVerifier> verifier) {
   std::string content;
   const base::FilePath& path = ExtensionResource::GetFilePath(
       script_file->extension_root(), script_file->relative_path(),
       ExtensionResource::SYMLINKS_MUST_RESOLVE_WITHIN_ROOT);
   if (path.empty()) {
     int resource_id;
     if (ExtensionsBrowserClient::Get()->GetComponentExtensionResourceManager()->
@@ skipping 40 matching lines @@
   if (index == 0) {
     script_file->set_content(content.substr(strlen(base::kUtf8ByteOrderMark)));
   } else {
     script_file->set_content(content);
   }
 
   return true;
 }
 
 SubstitutionMap* GetLocalizationMessages(const ExtensionsInfo& extensions_info,
-                                         const std::string& extension_id) {
+                                         const ExtensionId& extension_id) {
   ExtensionsInfo::const_iterator iter = extensions_info.find(extension_id);
   if (iter == extensions_info.end())
     return NULL;
   return file_util::LoadMessageBundleSubstitutionMap(iter->second.first,
                                                      extension_id,
                                                      iter->second.second);
 }
 
 void LoadUserScripts(UserScriptList* user_scripts,
                      const ExtensionsInfo& extensions_info,
-                     const std::set<std::string>& new_extensions,
+                     const std::set<ExtensionId>& new_extensions,
                      ContentVerifier* verifier) {
   for (size_t i = 0; i < user_scripts->size(); ++i) {
     UserScript& script = user_scripts->at(i);
     if (new_extensions.count(script.extension_id()) == 0)
       continue;
     scoped_ptr<SubstitutionMap> localization_messages(
         GetLocalizationMessages(extensions_info, script.extension_id()));
     for (size_t k = 0; k < script.js_scripts().size(); ++k) {
       UserScript::File& script_file = script.js_scripts()[k];
       if (script_file.GetContent().empty())
@@ skipping 52 matching lines @@
   if (!shared_memory.ShareReadOnlyToProcess(base::GetCurrentProcessHandle(),
                                             &readonly_handle))
     return scoped_ptr<base::SharedMemory>();
 
   return make_scoped_ptr(new base::SharedMemory(readonly_handle,
                                                 /*read_only=*/true));
 }
 
 void LoadScriptsOnFileThread(scoped_ptr<UserScriptList> user_scripts,
                              const ExtensionsInfo& extensions_info,
-                             const std::set<std::string>& new_extensions,
+                             const std::set<ExtensionId>& new_extensions,
                              scoped_refptr<ContentVerifier> verifier,
                              LoadScriptsCallback callback) {
   DCHECK(user_scripts.get());
   LoadUserScripts(
       user_scripts.get(), extensions_info, new_extensions, verifier);
   scoped_ptr<base::SharedMemory> memory = Serialize(*user_scripts);
   BrowserThread::PostTask(
       BrowserThread::UI,
       FROM_HERE,
       base::Bind(callback,
@@ skipping 112 matching lines @@
   // Greasemonkey does.
   if (script->globs().empty() && script->url_patterns().is_empty())
     script->add_glob("*");
 
   return true;
 }
 
 // static
 void UserScriptMaster::LoadScriptsForTest(UserScriptList* user_scripts) {
   ExtensionsInfo info;
-  std::set<std::string> new_extensions;
+  std::set<ExtensionId> new_extensions;
   for (UserScriptList::const_iterator iter = user_scripts->begin();
        iter != user_scripts->end();
        ++iter) {
     new_extensions.insert(iter->extension_id());
   }
   LoadUserScripts(
       user_scripts, info, new_extensions, NULL /* no verifier for testing */);
 }
 
-UserScriptMaster::UserScriptMaster(Profile* profile)
-    : user_scripts_(new UserScriptList()),
-      extensions_service_ready_(false),
-      pending_load_(false),
+UserScriptMaster::UserScriptMaster(Profile* profile,
+                                   ExtensionId owner_extension_id)
+    : pending_load_(false),
       profile_(profile),
-      extension_registry_observer_(this),
-      weak_factory_(this) {
-  extension_registry_observer_.Add(ExtensionRegistry::Get(profile_));
-  registrar_.Add(this, chrome::NOTIFICATION_EXTENSIONS_READY,
-                 content::Source<Profile>(profile_));
-  registrar_.Add(this, content::NOTIFICATION_RENDERER_PROCESS_CREATED,
+      weak_factory_(this),
+      owner_extension_id_(owner_extension_id) {
+  registrar_.Add(this,
+                 content::NOTIFICATION_RENDERER_PROCESS_CREATED,
                  content::NotificationService::AllBrowserContextsAndSources());
 }
 
 UserScriptMaster::~UserScriptMaster() {
 }
 
+void UserScriptMaster::Observe(int type,
+                               const content::NotificationSource& source,
+                               const content::NotificationDetails& details) {
+  DCHECK_EQ(content::NOTIFICATION_RENDERER_PROCESS_CREATED, type);
+  content::RenderProcessHost* process =
+      content::Source<content::RenderProcessHost>(source).ptr();
+  Profile* profile = Profile::FromBrowserContext(process->GetBrowserContext());
+  if (!profile_->IsSameProfile(profile))
+    return;
+  if (ScriptsReady())
+    SendUpdate(process, GetSharedMemory(), GetAllManagedExtensions());
+}
+
 void UserScriptMaster::OnScriptsLoaded(
     scoped_ptr<UserScriptList> user_scripts,
     scoped_ptr<base::SharedMemory> shared_memory) {
-  user_scripts_.reset(user_scripts.release());
+  AcquireUserScripts(make_scoped_ptr(user_scripts.release()));
   if (pending_load_) {
     // While we were loading, there were further changes. Don't bother
     // notifying about these scripts and instead just immediately reload.
     pending_load_ = false;
     StartLoad();
     return;
   }
 
   if (shared_memory.get() == NULL) {
     // This can happen if we run out of file descriptors.  In that case, we
     // have a choice between silently omitting all user scripts for new tabs,
     // by nulling out shared_memory_, or only silently omitting new ones by
     // leaving the existing object in place. The second seems less bad, even
     // though it removes the possibility that freeing the shared memory block
     // would open up enough FDs for long enough for a retry to succeed.
 
     // Pretend the extension change didn't happen.
     return;
   }
 
   // We've got scripts ready to go.
   shared_memory_.reset(shared_memory.release());
 
   for (content::RenderProcessHost::iterator i(
           content::RenderProcessHost::AllHostsIterator());
        !i.IsAtEnd(); i.Advance()) {
-    SendUpdate(i.GetCurrentValue(),
-               shared_memory_.get(),
-               changed_extensions_);
+    SendUpdate(
+        i.GetCurrentValue(), shared_memory_.get(), GetChangedExtensions());
   }
-  changed_extensions_.clear();
+  ResetChangedExtensions();
 
   content::NotificationService::current()->Notify(
       chrome::NOTIFICATION_USER_SCRIPTS_UPDATED,
       content::Source<Profile>(profile_),
       content::Details<base::SharedMemory>(shared_memory_.get()));
 }
 
-void UserScriptMaster::OnExtensionLoaded(
-    content::BrowserContext* browser_context,
-    const Extension* extension) {
-  added_extensions_.insert(extension->id());
-  removed_extensions_.erase(extension->id());
-  extensions_info_[extension->id()] =
-      ExtensionSet::ExtensionPathAndDefaultLocale(
-          extension->path(), LocaleInfo::GetDefaultLocale(extension));
-  if (extensions_service_ready_) {
-    changed_extensions_.insert(extension->id());
-    if (is_loading())
-      pending_load_ = true;
-    else
-      StartLoad();
-  }
-}
-
-void UserScriptMaster::OnExtensionUnloaded(
-    content::BrowserContext* browser_context,
-    const Extension* extension,
-    UnloadedExtensionInfo::Reason reason) {
-  removed_extensions_.insert(extension->id());
-  added_extensions_.erase(extension->id());
-  // Remove any content scripts.
-  extensions_info_.erase(extension->id());
-  changed_extensions_.insert(extension->id());
-  if (is_loading())
-    pending_load_ = true;
-  else
-    StartLoad();
-}
-
-void UserScriptMaster::Observe(int type,
-                               const content::NotificationSource& source,
-                               const content::NotificationDetails& details) {
-  bool should_start_load = false;
-  switch (type) {
-    case chrome::NOTIFICATION_EXTENSIONS_READY:
-      extensions_service_ready_ = true;
-      should_start_load = true;
-      break;
-    case content::NOTIFICATION_RENDERER_PROCESS_CREATED: {
-      content::RenderProcessHost* process =
-          content::Source<content::RenderProcessHost>(source).ptr();
-      Profile* profile = Profile::FromBrowserContext(
-          process->GetBrowserContext());
-      if (!profile_->IsSameProfile(profile))
-        return;
-      if (ScriptsReady()) {
-        SendUpdate(process,
-                   GetSharedMemory(),
-                   std::set<std::string>());  // Include all extensions.
-      }
-      break;
-    }
-    default:
-      DCHECK(false);
-  }
-
-  if (should_start_load) {
-    if (is_loading())
-      pending_load_ = true;
-    else
-      StartLoad();
-  }
-}
-
-void UserScriptMaster::StartLoad() {
-  DCHECK_CURRENTLY_ON(BrowserThread::UI);
-  DCHECK(!is_loading());
-
-  // Remove any user scripts belonging to any extension that was updated or
-  // removed.
-  for (UserScriptList::iterator iter = user_scripts_->begin();
-       iter != user_scripts_->end();) {
-    if (removed_extensions_.count(iter->extension_id()) > 0 ||
-        added_extensions_.count(iter->extension_id()) > 0) {
-      iter = user_scripts_->erase(iter);
-    } else {
-      ++iter;
-    }
-  }
-
-  // Add any content scripts for extensions that were recently loaded.
-  const ExtensionSet& enabled_extensions =
-      ExtensionRegistry::Get(profile_)->enabled_extensions();
-  for (std::set<std::string>::const_iterator iter = added_extensions_.begin();
-       iter != added_extensions_.end(); ++iter) {
-    const Extension* extension = enabled_extensions.GetByID(*iter);
-    if (!extension)
-      continue;
-    bool incognito_enabled =
-        util::IsIncognitoEnabled(extension->id(), profile_);
-    const UserScriptList& scripts =
-        ContentScriptsInfo::GetContentScripts(extension);
-    for (UserScriptList::const_iterator script = scripts.begin();
-         script != scripts.end();
-         ++script) {
-      user_scripts_->push_back(*script);
-      user_scripts_->back().set_incognito_enabled(incognito_enabled);
-    }
-  }
-
-  BrowserThread::PostTask(
-      BrowserThread::FILE,
+void UserScriptMaster::LoadScripts(scoped_ptr<UserScriptList> scripts,
+                                   const ExtensionsInfo& extensions_info) {
+  content::BrowserThread::PostTask(
+      content::BrowserThread::FILE,
       FROM_HERE,
       base::Bind(&LoadScriptsOnFileThread,
-                 base::Passed(&user_scripts_),
-                 extensions_info_,
-                 added_extensions_,
+                 base::Passed(&scripts),
+                 GetExtensionsInfo(),

[Devlin, 2014/07/31 20:32:24]

Wasn't this passed into the function?

+                 GetAddedExtensions(),
                  make_scoped_refptr(
                      ExtensionSystem::Get(profile_)->content_verifier()),
                  base::Bind(&UserScriptMaster::OnScriptsLoaded,
                             weak_factory_.GetWeakPtr())));
-  added_extensions_.clear();
-  removed_extensions_.clear();
-  user_scripts_.reset(NULL);
 }
 
 void UserScriptMaster::SendUpdate(
     content::RenderProcessHost* process,
     base::SharedMemory* shared_memory,
-    const std::set<std::string>& changed_extensions) {
+    const std::set<ExtensionId>& changed_extensions) {
   // Don't allow injection of content scripts into <webview>.
   if (process->IsIsolatedGuest())
     return;
 
   Profile* profile = Profile::FromBrowserContext(process->GetBrowserContext());
   // Make sure we only send user scripts to processes in our profile.
   if (!profile_->IsSameProfile(profile))
     return;
 
   // If the process is being started asynchronously, early return.  We'll end up
   // calling InitUserScripts when it's created which will call this again.
   base::ProcessHandle handle = process->GetHandle();
   if (!handle)
     return;
 
   base::SharedMemoryHandle handle_for_process;
   if (!shared_memory->ShareToProcess(handle, &handle_for_process))
     return;  // This can legitimately fail if the renderer asserts at startup.
 
   if (base::SharedMemory::IsHandleValid(handle_for_process)) {
-    process->Send(new ExtensionMsg_UpdateUserScripts(handle_for_process,
-                                                     changed_extensions));
+    process->Send(new ExtensionMsg_UpdateUserScripts(
+        handle_for_process, owner_extension_id_, changed_extensions));
   }
 }
 
 }  // namespace extensions