Add HandleInputEventAck message to allow out-of-process plugins to respond to user gestures.

webkit/plugins/ppapi/ppapi_plugin_instance.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 "webkit/plugins/ppapi/ppapi_plugin_instance.h"
 
 #include "base/bind.h"
 #include "base/debug/trace_event.h"
 #include "base/logging.h"
 #include "base/memory/linked_ptr.h"
 #include "base/message_loop.h"
 #include "base/stringprintf.h"
+#include "base/time.h"
 #include "base/utf_offset_string_conversions.h"
 #include "base/utf_string_conversions.h"
 #include "ppapi/c/dev/ppb_find_dev.h"
 #include "ppapi/c/dev/ppb_zoom_dev.h"
 #include "ppapi/c/dev/ppp_find_dev.h"
 #include "ppapi/c/dev/ppp_selection_dev.h"
 #include "ppapi/c/dev/ppp_zoom_dev.h"
 #include "ppapi/c/pp_rect.h"
 #include "ppapi/c/ppb_audio_config.h"
 #include "ppapi/c/ppb_core.h"
@@ skipping 18 matching lines @@
 #include "third_party/skia/include/core/SkRect.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebBindings.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebCompositionUnderline.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebCursorInfo.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebDocument.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebElement.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebFrame.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/platform/WebGamepads.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebInputEvent.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebPluginContainer.h"
+#include "third_party/WebKit/Source/WebKit/chromium/public/WebScopedUserGesture.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebSecurityOrigin.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/platform/WebString.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/platform/WebURL.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/platform/WebURLRequest.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/WebView.h"
 #include "webkit/plugins/ppapi/common.h"
 #include "webkit/plugins/ppapi/event_conversion.h"
 #include "webkit/plugins/ppapi/fullscreen_container.h"
 #include "webkit/plugins/ppapi/gfx_conversion.h"
 #include "webkit/plugins/ppapi/host_globals.h"
@@ skipping 48 matching lines @@
 using ppapi::ViewData;
 using WebKit::WebBindings;
 using WebKit::WebCanvas;
 using WebKit::WebCursorInfo;
 using WebKit::WebDocument;
 using WebKit::WebElement;
 using WebKit::WebFrame;
 using WebKit::WebInputEvent;
 using WebKit::WebPlugin;
 using WebKit::WebPluginContainer;
+using WebKit::WebScopedUserGesture;
 using WebKit::WebString;
 using WebKit::WebURLRequest;
 using WebKit::WebView;
 
 namespace webkit {
 namespace ppapi {
 
 #if defined(OS_WIN)
 // Exported by pdf.dll
 typedef bool (*RenderPDFPageToDCProc)(
@@ skipping 164 matching lines @@
       flash_fullscreen_(false),
       desired_fullscreen_state_(false),
       message_channel_(NULL),
       sad_plugin_(NULL),
       input_event_mask_(0),
       filtered_input_event_mask_(0),
       text_input_type_(kPluginDefaultTextInputType),
       text_input_caret_(0, 0, 0, 0),
       text_input_caret_bounds_(0, 0, 0, 0),
       text_input_caret_set_(false),
-      lock_mouse_callback_(PP_BlockUntilComplete()) {
+      lock_mouse_callback_(PP_BlockUntilComplete()),
+      pending_user_gesture_(0.0) {
   pp_instance_ = HostGlobals::Get()->AddInstance(this);
 
   memset(&current_print_settings_, 0, sizeof(current_print_settings_));
   DCHECK(delegate);
   module_->InstanceCreated(this);
   delegate_->InstanceCreated(this);
   message_channel_.reset(new MessageChannel(this));
 
   view_data_.is_page_visible = delegate->IsPageVisible();
 }
@@ skipping 360 matching lines @@
     PP_InputEvent_Class event_class = ClassifyInputEvent(event.type);
     if (!event_class)
       return false;
 
     if ((filtered_input_event_mask_ & event_class) ||
         (input_event_mask_ & event_class)) {
       // Actually send the event.
       std::vector< ::ppapi::InputEventData > events;
       CreateInputEventData(event, &events);
 
+      // Allow the user gesture to be pending after the plugin handles the
+      // event. This allows out-of-process plugins to respond to the user
+      // gesture after processing has finished here.
+      WebFrame* frame = container_->element().document().frame();
+      if (frame->isProcessingUserGesture()) {
+        pending_user_gesture_ =
+            ::ppapi::EventTimeToPPTimeTicks(event.timeStampSeconds);
+      }
+
       // Each input event may generate more than one PP_InputEvent.
       for (size_t i = 0; i < events.size(); i++) {
         if (filtered_input_event_mask_ & event_class)
           events[i].is_filtered = true;
         else
           rv = true;  // Unfiltered events are assumed to be handled.
         scoped_refptr<PPB_InputEvent_Shared> event_resource(
             new PPB_InputEvent_Shared(::ppapi::OBJECT_IS_IMPL,
                                       pp_instance(), events[i]));
 
@@ skipping 531 matching lines @@
   // container isn't ready yet, don't do anything more).
   if (fullscreen == IsFullscreenOrPending())
     return false;
 
   // Check whether we are trying to switch while the state is in transition.
   // The 2nd request gets dropped while messing up the internal state, so
   // disallow this.
   if (view_data_.is_fullscreen != desired_fullscreen_state_)
     return false;
 
-  // The browser will allow us to go into fullscreen mode only when processing
-  // a user gesture. This is guaranteed to work with in-process plugins and
-  // out-of-process syncronous proxies, but might be an issue with Flash when
-  // it switches over from PPB_FlashFullscreen.
-  // TODO(polina, bbudge): make this work with asynchronous proxies.
-  WebFrame* frame = container_->element().document().frame();
-  if (fullscreen && !frame->isProcessingUserGesture())
+  if (fullscreen && !HasUserGesture())
     return false;
 
   VLOG(1) << "Setting fullscreen to " << (fullscreen ? "on" : "off");
   desired_fullscreen_state_ = fullscreen;
 
   if (fullscreen) {
+    // Create the user gesture in case we're processing one that's pending.
+    WebScopedUserGesture user_gesture;
     // WebKit does not resize the plugin to fill the screen in fullscreen mode,
     // so we will tweak plugin's attributes to support the expected behavior.
     KeepSizeAttributesBeforeFullscreen();
     SetSizeAttributesForFullscreen();
     container_->element().requestFullScreen();
   } else {
     container_->element().document().cancelFullScreen();
   }
   return true;
 }
@@ skipping 433 matching lines @@
       CreateSimulatedWebInputEvents(
           input_event,
           view_data_.rect.point.x + view_data_.rect.size.width / 2,
           view_data_.rect.point.y + view_data_.rect.size.height / 2);
   for (std::vector<linked_ptr<WebInputEvent> >::iterator it = events.begin();
       it != events.end(); ++it) {
     web_view->handleInputEvent(*it->get());
   }
 }
 
+void PluginInstance::ClosePendingUserGesture(PP_Instance instance,
+                                             PP_TimeTicks timestamp) {
+  // Close the pending user gesture if the plugin had a chance to respond.
+  // Don't close the pending user gesture if the timestamps are equal since
+  // there may be multiple input events with the same timestamp.
+  if (timestamp > pending_user_gesture_)
+    pending_user_gesture_ = 0.0;
+}
+
+bool PluginInstance::HasUserGesture() {
+  PP_TimeTicks now =
+      ::ppapi::TimeTicksToPPTimeTicks(base::TimeTicks::Now());
+  // Give a lot of slack so tests won't be flaky. Well behaved plugins will
+  // close the user gesture.
+  const PP_TimeTicks kUserGestureDurationInSeconds = 10.0;
+  return (now - pending_user_gesture_ < kUserGestureDurationInSeconds);
+}
+
 PPB_Instance_FunctionAPI* PluginInstance::AsPPB_Instance_FunctionAPI() {
   return this;
 }
 
 PP_Bool PluginInstance::BindGraphics(PP_Instance instance,
                                      PP_Resource device) {
   if (bound_graphics_.get()) {
     if (GetBoundGraphics2D()) {
       GetBoundGraphics2D()->BindToInstance(NULL);
     } else if (GetBoundGraphics3D()) {
@@ skipping 369 matching lines @@
   screen_size_for_fullscreen_ = gfx::Size();
   WebElement element = container_->element();
   element.setAttribute(WebString::fromUTF8(kWidth), width_before_fullscreen_);
   element.setAttribute(WebString::fromUTF8(kHeight), height_before_fullscreen_);
   element.setAttribute(WebString::fromUTF8(kBorder), border_before_fullscreen_);
   element.setAttribute(WebString::fromUTF8(kStyle), style_before_fullscreen_);
 }
 
 }  // namespace ppapi
 }  // namespace webkit