Add new user script injection point: document_idle.

chrome/renderer/render_view.cc

 // Copyright (c) 2009 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/renderer/render_view.h"
 
 #include <algorithm>
 #include <string>
 #include <vector>
 
@@ skipping 1797 matching lines @@
   }
   return new webkit_glue::WebMediaPlayerImpl(client, factory);
 }
 
 void RenderView::willClose(WebFrame* frame) {
   if (!frame->parent()) {
     const GURL& url = frame->url();
     if (url.SchemeIs("http") || url.SchemeIs("https"))
       DumpLoadHistograms();
   }
+
+  WebDataSource* ds = frame->dataSource();

[Matt Perry, 2009/11/02 19:46:30]

Can this ever be NULL?

[Aaron Boodman, 2009/11/03 05:03:11]

No, it is created in didCreateDataSource(), and many places in RenderView assume
it exists after that.

[darin (slow to review), 2009/11/03 05:11:00]

Right, it cannot be null!

+  NavigationState* navigation_state = NavigationState::FromDataSource(ds);
+  navigation_state->user_script_idle_scheduler()->Cancel();
 }
 
 void RenderView::loadURLExternally(
     WebFrame* frame, const WebURLRequest& request,
     WebNavigationPolicy policy) {
   GURL referrer(request.httpHeaderField(WebString::fromUTF8("Referer")));
   if (policy == WebKit::WebNavigationPolicyDownload) {
     Send(new ViewHostMsg_DownloadUrl(routing_id_, request.url(), referrer));
   } else {
     OpenURL(request.url(), referrer, policy);
@@ skipping 182 matching lines @@
 
 void RenderView::didCompleteClientRedirect(
     WebFrame* frame, const WebURL& from) {
   if (!frame->parent())
     completed_client_redirect_src_ = from;
 }
 
 void RenderView::didCreateDataSource(WebFrame* frame, WebDataSource* ds) {
   // The rest of RenderView assumes that a WebDataSource will always have a
   // non-null NavigationState.
-  if (pending_navigation_state_.get()) {
-    ds->setExtraData(pending_navigation_state_.release());
-  } else {
-    ds->setExtraData(NavigationState::CreateContentInitiated());
-  }
+  NavigationState* state = pending_navigation_state_.get() ?
+      pending_navigation_state_.release() : 
+      NavigationState::CreateContentInitiated();
+
+  state->set_user_script_idle_scheduler(
+      new UserScriptIdleScheduler(this, frame));
+  ds->setExtraData(state);
 }
 
 void RenderView::didStartProvisionalLoad(WebFrame* frame) {
   WebDataSource* ds = frame->provisionalDataSource();
   NavigationState* navigation_state = NavigationState::FromDataSource(ds);
 
   navigation_state->set_start_load_time(Time::Now());
 
   // Update the request time if WebKit has better knowledge of it.
   if (navigation_state->request_time().is_null()) {
@@ skipping 194 matching lines @@
   if (RenderThread::current()) {  // Will be NULL during unit tests.
     RenderThread::current()->user_script_slave()->InjectScripts(
         frame, UserScript::DOCUMENT_START);
   }
   if (view_type_ == ViewType::EXTENSION_TOOLSTRIP ||
       view_type_ == ViewType::EXTENSION_MOLE) {
     InjectToolstripCSS();
     ExtensionProcessBindings::SetViewType(webview(), view_type_);
   }
 
-  while (!pending_code_execution_queue_.empty()) {
-    scoped_refptr<CodeExecutionInfo> info =
-        pending_code_execution_queue_.front();
-    OnExecuteCode(info->request_id, info->extension_id, info->is_js_code,
-                  info->code_string);
-    pending_code_execution_queue_.pop();
-  }
-
   // Notify the browser about non-blank documents loading in the top frame.
   GURL url = frame->url();
   if (url.is_valid() && url.spec() != chrome::kAboutBlankURL) {
     if (frame == webview()->mainFrame())
       Send(new ViewHostMsg_DocumentAvailableInMainFrame(routing_id_));
   }
 }
 
 void RenderView::didReceiveTitle(WebFrame* frame, const WebString& title) {
   UpdateTitle(frame, title);
@@ skipping 14 matching lines @@
   // sent up to the browser.
   SendPasswordForms(frame);
 
   // Check whether we have new encoding name.
   UpdateEncoding(frame, frame->view()->pageEncoding().utf8());
 
   if (RenderThread::current()) {  // Will be NULL during unit tests.
     RenderThread::current()->user_script_slave()->InjectScripts(
         frame, UserScript::DOCUMENT_END);
   }
+
+  navigation_state->user_script_idle_scheduler()->DidFinishDocumentLoad();
+}
+
+void RenderView::OnUserScriptIdleLocation(WebFrame* frame) {
+  if (RenderThread::current()) {  // Will be NULL during unit tests.
+    RenderThread::current()->user_script_slave()->InjectScripts(
+        frame, UserScript::DOCUMENT_IDLE);
+  }
+
+  WebFrame* main_frame = webview()->mainFrame();
+  if (frame == main_frame) {
+    while (!pending_code_execution_queue_.empty()) {
+      scoped_refptr<CodeExecutionInfo> info =
+          pending_code_execution_queue_.front();
+      ExecuteCodeImpl(main_frame, info->request_id, info->extension_id,
+                      info->is_js_code, info->code_string);
+      pending_code_execution_queue_.pop();
+    }
+  }
 }
 
 void RenderView::didHandleOnloadEvents(WebFrame* frame) {
   // Ignore
 }
 
 void RenderView::didFailLoad(WebFrame* frame, const WebURLError& error) {
   // Ignore
 }
 
 void RenderView::didFinishLoad(WebFrame* frame) {
   WebDataSource* ds = frame->dataSource();
   NavigationState* navigation_state = NavigationState::FromDataSource(ds);
   DCHECK(navigation_state);
   navigation_state->set_finish_load_time(Time::Now());
+  navigation_state->user_script_idle_scheduler()->DidFinishLoad();
 }
 
 void RenderView::didChangeLocationWithinPage(
     WebFrame* frame, bool is_new_navigation) {
   // If this was a reference fragment navigation that we initiated, then we
   // could end up having a non-null pending navigation state.  We just need to
   // update the ExtraData on the datasource so that others who read the
   // ExtraData will get the new NavigationState.  Similarly, if we did not
   // initiate this navigation, then we need to take care to reset any pre-
   // existing navigation state to a content-initiated navigation state.
@@ skipping 1335 matching lines @@
 }
 
 void RenderView::OnSetEditCommandsForNextKeyEvent(
     const EditCommands& edit_commands) {
   edit_commands_ = edit_commands;
 }
 
 void RenderView::OnExecuteCode(int request_id, const std::string& extension_id,
                                bool is_js_code,
                                const std::string& code_string) {
-  if (is_loading_) {
-    scoped_refptr<CodeExecutionInfo> info = new CodeExecutionInfo(
-        request_id, extension_id, is_js_code, code_string);
-    pending_code_execution_queue_.push(info);
-    return;
-  }
   WebFrame* main_frame = webview() ? webview()->mainFrame() : NULL;
   if (!main_frame) {
     Send(new ViewMsg_ExecuteCodeFinished(routing_id_, request_id, false));
     return;
   }
 
+  WebDataSource* ds = main_frame->dataSource();
+  NavigationState* navigation_state = NavigationState::FromDataSource(ds);
+  if (!navigation_state->user_script_idle_scheduler()->has_run()) {
+    scoped_refptr<CodeExecutionInfo> info = new CodeExecutionInfo(
+        request_id, extension_id, is_js_code, code_string);
+    pending_code_execution_queue_.push(info);
+    return;
+  }
+
+  ExecuteCodeImpl(main_frame, request_id, extension_id, is_js_code, code_string);

[Matt Perry, 2009/11/02 19:46:30]

line length

+}
+
+void RenderView::ExecuteCodeImpl(WebFrame* frame,
+                                 int request_id,
+                                 const std::string& extension_id,
+                                 bool is_js_code,
+                                 const std::string& code_string) {
   if (is_js_code) {
     std::vector<WebScriptSource> sources;
     sources.push_back(
         WebScriptSource(WebString::fromUTF8(code_string)));
     UserScriptSlave::InsertInitExtensionCode(&sources, extension_id);
-    main_frame->executeScriptInIsolatedWorld(
+    frame->executeScriptInIsolatedWorld(
         UserScriptSlave::GetIsolatedWorldId(extension_id),
         &sources.front(), sources.size(), EXTENSION_GROUP_CONTENT_SCRIPTS);
   } else {
-    main_frame->insertStyleText(WebString::fromUTF8(code_string), WebString());
+    frame->insertStyleText(WebString::fromUTF8(code_string), WebString());
   }
 
   Send(new ViewMsg_ExecuteCodeFinished(routing_id_, request_id, true));
 }
 
 void RenderView::Close() {
   // We need to grab a pointer to the doomed WebView before we destroy it.
   WebView* doomed = webview();
   RenderWidget::Close();
   Singleton<ViewMap>::get()->erase(doomed);
@@ skipping 20 matching lines @@
       new PluginMsg_SignalModalDialogEvent(host_window_));
 
   message->EnableMessagePumping();  // Runs a nested message loop.
   bool rv = Send(message);
 
   PluginChannelHost::Broadcast(
       new PluginMsg_ResetModalDialogEvent(host_window_));
 
   return rv;
 }