The IPCs for carrying data requested by plugins have been changed from synchronous IPCs to asynchronous IPCs.

This fixes bug http://code.google.com/p/chromium/issues/detail?id=14323, where the Flash plugin would not render
content on the page if these IPCs were processed while the plugin waited for sync calls like NPN_Evaluate to
return.

Test=covered by UI tests.

Bug=14323

Review URL: http://codereview.chromium.org/159296

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@21548 0039d316-1c4b-4281-b951-d872f2087c98

12 files changed, 116 insertions, 40 deletions

diff --git a/chrome/common/plugin_messages_internal.h b/chrome/common/plugin_messages_internal.h
index 18152d9..5138d5a 100644
--- a/chrome/common/plugin_messages_internal.h
+++ b/chrome/common/plugin_messages_internal.h
@@ -183,20 +183,19 @@ IPC_BEGIN_MESSAGES(Plugin)
                              int /* id */,
                              GURL /* url */)
 
-  IPC_SYNC_MESSAGE_ROUTED1_1(PluginMsg_DidReceiveResponse,
-                             PluginMsg_DidReceiveResponseParams,
-                             bool /* cancel */)
+  IPC_MESSAGE_ROUTED1(PluginMsg_DidReceiveResponse,
+                      PluginMsg_DidReceiveResponseParams)
 
-  IPC_SYNC_MESSAGE_ROUTED3_0(PluginMsg_DidReceiveData,
-                             int /* id */,
-                             std::vector<char> /* buffer */,
-                             int /* data_offset */)
+  IPC_MESSAGE_ROUTED3(PluginMsg_DidReceiveData,
+                      int /* id */,
+                      std::vector<char> /* buffer */,
+                      int /* data_offset */)
 
-  IPC_SYNC_MESSAGE_ROUTED1_0(PluginMsg_DidFinishLoading,
-                             int /* id */)
+  IPC_MESSAGE_ROUTED1(PluginMsg_DidFinishLoading,
+                      int /* id */)
 
-  IPC_SYNC_MESSAGE_ROUTED1_0(PluginMsg_DidFail,
-                             int /* id */)
+  IPC_MESSAGE_ROUTED1(PluginMsg_DidFail,
+                      int /* id */)
 
   IPC_MESSAGE_ROUTED5(PluginMsg_SendJavaScriptStream,
                       std::string /* url */,
diff --git a/chrome/plugin/webplugin_delegate_stub.cc b/chrome/plugin/webplugin_delegate_stub.cc
index a8a42b0..655a619 100644
--- a/chrome/plugin/webplugin_delegate_stub.cc
+++ b/chrome/plugin/webplugin_delegate_stub.cc
@@ -173,8 +173,7 @@ void WebPluginDelegateStub::OnWillSendRequest(int id, const GURL& url) {
 }
 
 void WebPluginDelegateStub::OnDidReceiveResponse(
-    const PluginMsg_DidReceiveResponseParams& params, bool* cancel) {
-  *cancel = false;
+    const PluginMsg_DidReceiveResponseParams& params) {
   WebPluginResourceClient* client = webplugin_->GetResourceClient(params.id);
   if (!client)
     return;
@@ -183,8 +182,7 @@ void WebPluginDelegateStub::OnDidReceiveResponse(
                              params.headers,
                              params.expected_length,
                              params.last_modified,
-                             params.request_is_seekable,
-                             cancel);
+                             params.request_is_seekable);
 }
 
 void WebPluginDelegateStub::OnDidReceiveData(int id,
diff --git a/chrome/plugin/webplugin_delegate_stub.h b/chrome/plugin/webplugin_delegate_stub.h
index 2def46c..519a648 100644
--- a/chrome/plugin/webplugin_delegate_stub.h
+++ b/chrome/plugin/webplugin_delegate_stub.h
@@ -52,8 +52,7 @@ class WebPluginDelegateStub : public IPC::Channel::Listener,
   void OnInit(const PluginMsg_Init_Params& params, bool* result);
 
   void OnWillSendRequest(int id, const GURL& url);
-  void OnDidReceiveResponse(const PluginMsg_DidReceiveResponseParams& params,
-                            bool* cancel);
+  void OnDidReceiveResponse(const PluginMsg_DidReceiveResponseParams& params);
   void OnDidReceiveData(int id, const std::vector<char>& buffer,
                         int data_offset);
   void OnDidFinishLoading(int id);
diff --git a/chrome/plugin/webplugin_proxy.cc b/chrome/plugin/webplugin_proxy.cc
index 67919e8..3d34674 100644
--- a/chrome/plugin/webplugin_proxy.cc
+++ b/chrome/plugin/webplugin_proxy.cc
@@ -239,8 +239,10 @@ WebPluginProxy* WebPluginProxy::FromCPBrowsingContext(
 
 WebPluginResourceClient* WebPluginProxy::GetResourceClient(int id) {
   ResourceClientMap::iterator iterator = resource_clients_.find(id);
+  // The IPC messages which deal with streams are now asynchronous. It is
+  // now possible to receive stream messages from the renderer for streams
+  // which may have been cancelled by the plugin.
   if (iterator == resource_clients_.end()) {
-    NOTREACHED();
     return NULL;
   }
 
diff --git a/chrome/renderer/webplugin_delegate_proxy.cc b/chrome/renderer/webplugin_delegate_proxy.cc
index ba7b197..4b87f7e 100644
--- a/chrome/renderer/webplugin_delegate_proxy.cc
+++ b/chrome/renderer/webplugin_delegate_proxy.cc
@@ -99,8 +99,7 @@ class ResourceClientProxy : public WebPluginResourceClient {
                           const std::string& headers,
                           uint32 expected_length,
                           uint32 last_modified,
-                          bool request_is_seekable,
-                          bool* cancel) {
+                          bool request_is_seekable) {
     DCHECK(channel_ != NULL);
     PluginMsg_DidReceiveResponseParams params;
     params.id = resource_id_;
@@ -112,8 +111,7 @@ class ResourceClientProxy : public WebPluginResourceClient {
     // Grab a reference on the underlying channel so it does not get
     // deleted from under us.
     scoped_refptr<PluginChannelHost> channel_ref(channel_);
-    channel_->Send(new PluginMsg_DidReceiveResponse(instance_id_, params,
-                                                    cancel));
+    channel_->Send(new PluginMsg_DidReceiveResponse(instance_id_, params));
   }
 
   void DidReceiveData(const char* buffer, int length, int data_offset) {
diff --git a/webkit/glue/plugins/plugin_instance.cc b/webkit/glue/plugins/plugin_instance.cc
index d980e10..79b5b4f 100644
--- a/webkit/glue/plugins/plugin_instance.cc
+++ b/webkit/glue/plugins/plugin_instance.cc
@@ -373,12 +373,10 @@ void PluginInstance::DidReceiveManualResponse(const std::string& url,
     response_url = instance_url_.spec();
   }
 
-  bool cancel = false;
-
   plugin_data_stream_ = CreateStream(-1, url, mime_type, false, NULL);
 
   plugin_data_stream_->DidReceiveResponse(mime_type, headers, expected_length,
-                                          last_modified, true, &cancel);
+                                          last_modified, true);
 }
 
 void PluginInstance::DidReceiveManualData(const char* buffer, int length) {
diff --git a/webkit/glue/plugins/plugin_stream_url.cc b/webkit/glue/plugins/plugin_stream_url.cc
index b050411..2f0cfbe 100644
--- a/webkit/glue/plugins/plugin_stream_url.cc
+++ b/webkit/glue/plugins/plugin_stream_url.cc
@@ -44,8 +44,7 @@ void PluginStreamUrl::DidReceiveResponse(const std::string& mime_type,
                                          const std::string& headers,
                                          uint32 expected_length,
                                          uint32 last_modified,
-                                         bool request_is_seekable,
-                                         bool* cancel) {
+                                         bool request_is_seekable) {
   bool opened = Open(mime_type,
                      headers,
                      expected_length,
@@ -53,7 +52,7 @@ void PluginStreamUrl::DidReceiveResponse(const std::string& mime_type,
                      request_is_seekable);
   if (!opened) {
     instance()->RemoveStream(this);
-    *cancel = true;
+    CancelRequest();
   }
 }
 
diff --git a/webkit/glue/plugins/plugin_stream_url.h b/webkit/glue/plugins/plugin_stream_url.h
index db5d4a5..1f5fe57 100644
--- a/webkit/glue/plugins/plugin_stream_url.h
+++ b/webkit/glue/plugins/plugin_stream_url.h
@@ -48,8 +48,7 @@ class PluginStreamUrl : public PluginStream,
                           const std::string& headers,
                           uint32 expected_length,
                           uint32 last_modified,
-                          bool request_is_seekable,
-                          bool* cancel);
+                          bool request_is_seekable);
   void DidReceiveData(const char* buffer, int length, int data_offset);
   void DidFinishLoading();
   void DidFail();
diff --git a/webkit/glue/plugins/test/plugin_get_javascript_url_test.cc b/webkit/glue/plugins/test/plugin_get_javascript_url_test.cc
index 74d01f1..ebdd745 100644
--- a/webkit/glue/plugins/test/plugin_get_javascript_url_test.cc
+++ b/webkit/glue/plugins/test/plugin_get_javascript_url_test.cc
@@ -17,11 +17,19 @@
 // The maximum chunk size of stream data.
 #define STREAM_CHUNK 197
 
+const int kNPNEvaluateTimerID = 100;
+const int kNPNEvaluateTimerElapse = 50;
+
+
 namespace NPAPIClient {
 
 ExecuteGetJavascriptUrlTest::ExecuteGetJavascriptUrlTest(NPP id, NPNetscapeFuncs *host_functions)
   : PluginTest(id, host_functions),
-    test_started_(false) {
+    test_started_(false),
+#ifdef OS_WIN
+    window_(NULL),
+#endif
+    npn_evaluate_context_(false) {
 }
 
 NPError ExecuteGetJavascriptUrlTest::SetWindow(NPWindow* pNPWindow) {
@@ -30,15 +38,64 @@ NPError ExecuteGetJavascriptUrlTest::SetWindow(NPWindow* pNPWindow) {
     HostFunctions()->geturlnotify(id(), url.c_str(), "_top",
                                   reinterpret_cast<void*>(SELF_URL_STREAM_ID));
     test_started_ = true;
+
+#ifdef OS_WIN
+    HWND window_handle = reinterpret_cast<HWND>(pNPWindow->window);
+    if (!::GetProp(window_handle, L"Plugin_Instance")) {
+      ::SetProp(window_handle, L"Plugin_Instance", this);
+      // We attempt to retreive the NPObject for the plugin instance identified
+      // by the NPObjectLifetimeTestInstance2 class as it may not have been
+      // instantiated yet.
+      SetTimer(window_handle, kNPNEvaluateTimerID, kNPNEvaluateTimerElapse,
+               TimerProc);
+    }
+    window_ = window_handle;
+#endif
   }
+
   return NPERR_NO_ERROR;
 }
 
+#ifdef OS_WIN
+void CALLBACK ExecuteGetJavascriptUrlTest::TimerProc(
+    HWND window, UINT message, UINT timer_id, unsigned long elapsed_time) {
+  ExecuteGetJavascriptUrlTest* this_instance =
+      reinterpret_cast<ExecuteGetJavascriptUrlTest*>
+          (::GetProp(window, L"Plugin_Instance"));
+
+  NPObject *window_obj = NULL;
+  this_instance->HostFunctions()->getvalue(this_instance->id(),
+                                           NPNVWindowNPObject,
+                                           &window_obj);
+  if (!window_obj) {
+    this_instance->SetError("Failed to get NPObject for plugin instance2");
+    this_instance->SignalTestCompleted();
+    return;
+  }
+
+  std::string script = "javascript:window.location";
+  NPString script_string;
+  script_string.UTF8Characters = script.c_str();
+  script_string.UTF8Length = static_cast<unsigned int>(script.length());
+  NPVariant result_var;
+
+  this_instance->npn_evaluate_context_ = true;
+  NPError result = this_instance->HostFunctions()->evaluate(
+      this_instance->id(), window_obj, &script_string, &result_var);
+  this_instance->npn_evaluate_context_ = false;
+}
+#endif
+
 NPError ExecuteGetJavascriptUrlTest::NewStream(NPMIMEType type, NPStream* stream,
                               NPBool seekable, uint16* stype) {
   if (stream == NULL)
     SetError("NewStream got null stream");
 
+  if (npn_evaluate_context_) {
+    SetError("NewStream received in context of NPN_Evaluate");
+    return NPERR_NO_ERROR;
+  }
+
   COMPILE_ASSERT(sizeof(unsigned long) <= sizeof(stream->notifyData),
                  cast_validity_check);
   unsigned long stream_id = reinterpret_cast<unsigned long>(stream->notifyData);
@@ -53,6 +110,10 @@ NPError ExecuteGetJavascriptUrlTest::NewStream(NPMIMEType type, NPStream* stream
 }
 
 int32 ExecuteGetJavascriptUrlTest::WriteReady(NPStream *stream) {
+  if (npn_evaluate_context_) {
+    SetError("WriteReady received in context of NPN_Evaluate");
+    return NPERR_NO_ERROR;
+  }
   return STREAM_CHUNK;
 }
 
@@ -63,6 +124,11 @@ int32 ExecuteGetJavascriptUrlTest::Write(NPStream *stream, int32 offset, int32 l
   if (len < 0 || len > STREAM_CHUNK)
     SetError("Write got bogus stream chunk size");
 
+  if (npn_evaluate_context_) {
+    SetError("Write received in context of NPN_Evaluate");
+    return len;
+  }
+
   COMPILE_ASSERT(sizeof(unsigned long) <= sizeof(stream->notifyData),
                  cast_validity_check);
   unsigned long stream_id = reinterpret_cast<unsigned long>(stream->notifyData);
@@ -83,6 +149,15 @@ NPError ExecuteGetJavascriptUrlTest::DestroyStream(NPStream *stream, NPError rea
   if (stream == NULL)
     SetError("NewStream got null stream");
 
+#ifdef OS_WIN
+  KillTimer(window_, kNPNEvaluateTimerID);
+#endif
+
+  if (npn_evaluate_context_) {
+    SetError("DestroyStream received in context of NPN_Evaluate");
+    return NPERR_NO_ERROR;
+  }
+
   COMPILE_ASSERT(sizeof(unsigned long) <= sizeof(stream->notifyData),
                  cast_validity_check);
   unsigned long stream_id = reinterpret_cast<unsigned long>(stream->notifyData);
@@ -100,6 +175,12 @@ NPError ExecuteGetJavascriptUrlTest::DestroyStream(NPStream *stream, NPError rea
 void ExecuteGetJavascriptUrlTest::URLNotify(const char* url, NPReason reason, void* data) {
   COMPILE_ASSERT(sizeof(unsigned long) <= sizeof(data),
                  cast_validity_check);
+
+  if (npn_evaluate_context_) {
+    SetError("URLNotify received in context of NPN_Evaluate");
+    return;
+  }
+
   unsigned long stream_id = reinterpret_cast<unsigned long>(data);
   switch (stream_id) {
     case SELF_URL_STREAM_ID:
diff --git a/webkit/glue/plugins/test/plugin_get_javascript_url_test.h b/webkit/glue/plugins/test/plugin_get_javascript_url_test.h
index cff6775..5c2540d 100644
--- a/webkit/glue/plugins/test/plugin_get_javascript_url_test.h
+++ b/webkit/glue/plugins/test/plugin_get_javascript_url_test.h
@@ -28,8 +28,18 @@ class ExecuteGetJavascriptUrlTest : public PluginTest {
   virtual void    URLNotify(const char* url, NPReason reason, void* data);
 
  private:
+#if defined(OS_WIN)
+  static void CALLBACK TimerProc(HWND window, UINT message, UINT timer_id,
+                                 unsigned long elapsed_time);
+#endif
   bool test_started_;
+  // This flag is set to true in the context of the NPN_Evaluate call.
+  bool npn_evaluate_context_;
   std::string self_url_;
+
+#if defined(OS_WIN)
+  HWND window_;
+#endif
 };
 
 } // namespace NPAPIClient
diff --git a/webkit/glue/webplugin.h b/webkit/glue/webplugin.h
index 07d2470..70952d0 100644
--- a/webkit/glue/webplugin.h
+++ b/webkit/glue/webplugin.h
@@ -146,8 +146,7 @@ class WebPluginResourceClient {
                                   const std::string& headers,
                                   uint32 expected_length,
                                   uint32 last_modified,
-                                  bool request_is_seekable,
-                                  bool* cancel) = 0;
+                                  bool request_is_seekable) = 0;
   virtual void DidReceiveData(const char* buffer, int length,
                               int data_offset) = 0;
   virtual void DidFinishLoading() = 0;
diff --git a/webkit/glue/webplugin_impl.cc b/webkit/glue/webplugin_impl.cc
index 826bfb9..1761b23 100644
--- a/webkit/glue/webplugin_impl.cc
+++ b/webkit/glue/webplugin_impl.cc
@@ -999,13 +999,7 @@ void WebPluginImpl::didReceiveResponse(WebURLLoader* loader,
       base::SysWideToNativeMB(http_response_info.mime_type),
       base::SysWideToNativeMB(GetAllHeaders(resource_response)),
       http_response_info.expected_length,
-      http_response_info.last_modified, request_is_seekable, &cancel);
-
-  if (cancel) {
-    loader->cancel();
-    RemoveClient(loader);
-    return;
-  }
+      http_response_info.last_modified, request_is_seekable);
 
   // Bug http://b/issue?id=925559. The flash plugin would not handle the HTTP
   // error codes in the stream header and as a result, was unaware of the