Changeset 81057 in webkit

Timestamp:

Mar 14, 2011 2:22:32 PM (13 years ago)

Author:

aestes@apple.com

Message:

2011-03-13 Andy Estes <​aestes@apple.com>

Reviewed by Darin Adler.

Timer-based events should inherit the user gesture state of their
originating event in certain cases.
​https://bugs.webkit.org/show_bug.cgi?id=55104

• fast/events/popup-blocking-timers-expected.txt: Added.
• fast/events/popup-blocking-timers.html: Added.

2011-03-14 Andy Estes <​aestes@apple.com>

Reviewed by Darin Adler.

Timer-based events should inherit the user gesture state of their
originating event in certain cases.
​https://bugs.webkit.org/show_bug.cgi?id=55104

If a timer is installed by a gesture-originated event and will fire
within one second, the timer-initiated event should behave as if it
were also initiated by a user gesture. Multi-shot timers should only
get this behavior on their first execution. Nested timers should not
get this behavior. This makes us compatible with Gecko when handling
popups and file chooser dialogs created from timer events.

Test: fast/events/popup-blocking-timers.html

• page/DOMTimer.cpp: (WebCore::timeoutId): Create a helper function so that m_timeoutId can be initialized in the data member initialization list. (WebCore::shouldForwardUserGesture): Ditto, but for m_shouldForwardUserGesture. (WebCore::DOMTimer::DOMTimer): Move initialization of data members from the ctor body to the data member initialization list. Also rename the argument 'timeout' to 'interval'. (WebCore::DOMTimer::fired): Create a UserGestureIndicator and set its state based on the value of m_shouldForwardUserGesture. (WebCore::DOMTimer::adjustMinimumTimerInterval): m_originalTimeout was renamed to m_originalInterval.
• page/DOMTimer.h: Add m_shouldForwardUserGesture and rename m_originalTimeout to m_originalInterval.

Location:

trunk

Files:

• LayoutTests/ChangeLog (modified) (1 diff)
• LayoutTests/fast/events/popup-blocking-timers-expected.txt (added)
• LayoutTests/fast/events/popup-blocking-timers.html (added)
• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/page/DOMTimer.cpp (modified) (7 diffs)
• Source/WebCore/page/DOMTimer.h (modified) (2 diffs)

trunk/LayoutTests/ChangeLog

@@ +1 @@
+2011-03-13  Andy Estes  <aestes@apple.com>
+
+        Reviewed by Darin Adler.
+
+        Timer-based events should inherit the user gesture state of their
+        originating event in certain cases.
+        https://bugs.webkit.org/show_bug.cgi?id=55104
+
+        * fast/events/popup-blocking-timers-expected.txt: Added.
+        * fast/events/popup-blocking-timers.html: Added.
+
 2011-03-09  Levi Weintraub  <leviw@chromium.org>
 

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2011-03-14  Andy Estes  <aestes@apple.com>
+
+        Reviewed by Darin Adler.
+
+        Timer-based events should inherit the user gesture state of their
+        originating event in certain cases.
+        https://bugs.webkit.org/show_bug.cgi?id=55104
+
+        If a timer is installed by a gesture-originated event and will fire
+        within one second, the timer-initiated event should behave as if it
+        were also initiated by a user gesture. Multi-shot timers should only
+        get this behavior on their first execution. Nested timers should not
+        get this behavior. This makes us compatible with Gecko when handling
+        popups and file chooser dialogs created from timer events.
+
+        Test: fast/events/popup-blocking-timers.html
+
+        * page/DOMTimer.cpp:
+        (WebCore::timeoutId): Create a helper function so that m_timeoutId can
+        be initialized in the data member initialization list.
+        (WebCore::shouldForwardUserGesture): Ditto, but for
+        m_shouldForwardUserGesture.
+        (WebCore::DOMTimer::DOMTimer): Move initialization of data members from
+        the ctor body to the data member initialization list. Also rename the
+        argument 'timeout' to 'interval'.
+        (WebCore::DOMTimer::fired): Create a UserGestureIndicator and set its
+        state based on the value of m_shouldForwardUserGesture.
+        (WebCore::DOMTimer::adjustMinimumTimerInterval): m_originalTimeout was
+        renamed to m_originalInterval.
+        * page/DOMTimer.h: Add m_shouldForwardUserGesture and rename
+        m_originalTimeout to m_originalInterval.
+
 2011-03-09  Levi Weintraub  <leviw@chromium.org>
 

trunk/Source/WebCore/page/DOMTimer.cpp

@@ -31 +31 @@
 #include "ScheduledAction.h"
 #include "ScriptExecutionContext.h"
+#include "UserGestureIndicator.h"
 #include <wtf/HashSet.h>
 #include <wtf/StdLibExtras.h>
@@ -38 +39 @@
 namespace WebCore {
 
+static const int maxIntervalForUserGestureForwarding = 1000; // One second matches Gecko.
 static const int maxTimerNestingLevel = 5;
 static const double oneMillisecond = 0.001;
@@ -43 +45 @@
 
 static int timerNestingLevel = 0;
-
-DOMTimer::DOMTimer(ScriptExecutionContext* context, PassOwnPtr<ScheduledAction> action, int timeout, bool singleShot)
-    : SuspendableTimer(context)
-    , m_action(action)
-    , m_originalTimeout(timeout)
+    
+static int timeoutId()
 {
     static int lastUsedTimeoutId = 0;
@@ -54 +53 @@
     if (lastUsedTimeoutId <= 0)
         lastUsedTimeoutId = 1;
-    m_timeoutId = lastUsedTimeoutId;
+    return lastUsedTimeoutId;
+}
+    
+static inline bool shouldForwardUserGesture(int interval, int nestingLevel)
+{
+    return UserGestureIndicator::processingUserGesture()
+        && interval <= maxIntervalForUserGestureForwarding
+        && nestingLevel == 1; // Gestures should not be forwarded to nested timers.
+}
 
-    m_nestingLevel = timerNestingLevel + 1;
-
+DOMTimer::DOMTimer(ScriptExecutionContext* context, PassOwnPtr<ScheduledAction> action, int interval, bool singleShot)
+    : SuspendableTimer(context)
+    , m_timeoutId(timeoutId())
+    , m_nestingLevel(timerNestingLevel + 1)
+    , m_action(action)
+    , m_originalInterval(interval)
+    , m_shouldForwardUserGesture(shouldForwardUserGesture(interval, m_nestingLevel))
+{
     scriptExecutionContext()->addTimeout(m_timeoutId, this);
 
-    double intervalMilliseconds = intervalClampedToMinimum(timeout, context->minimumTimerInterval());
+    double intervalMilliseconds = intervalClampedToMinimum(interval, context->minimumTimerInterval());
     if (singleShot)
         startOneShot(intervalMilliseconds);
@@ -102 +115 @@
     ScriptExecutionContext* context = scriptExecutionContext();
     timerNestingLevel = m_nestingLevel;
+    
+    UserGestureIndicator gestureIndicator(m_shouldForwardUserGesture ? DefinitelyProcessingUserGesture : PossiblyProcessingUserGesture);
+    
+    // Only the first execution of a multi-shot timer should get an affirmative user gesture indicator.
+    m_shouldForwardUserGesture = false;
 
     InspectorInstrumentationCookie cookie = InspectorInstrumentation::willFireTimer(context, m_timeoutId);
@@ -156 +174 @@
 
     double newMinimumInterval = scriptExecutionContext()->minimumTimerInterval();
-    double newClampedInterval = intervalClampedToMinimum(m_originalTimeout, newMinimumInterval);
+    double newClampedInterval = intervalClampedToMinimum(m_originalInterval, newMinimumInterval);
 
     if (repeatInterval()) {
@@ -163 +181 @@
     }
 
-    double previousClampedInterval = intervalClampedToMinimum(m_originalTimeout, oldMinimumTimerInterval);
+    double previousClampedInterval = intervalClampedToMinimum(m_originalInterval, oldMinimumTimerInterval);
     augmentFireInterval(newClampedInterval - previousClampedInterval);
 }

trunk/Source/WebCore/page/DOMTimer.h

@@ -56 +56 @@
 
     private:
-        DOMTimer(ScriptExecutionContext*, PassOwnPtr<ScheduledAction>, int timeout, bool singleShot);
+        DOMTimer(ScriptExecutionContext*, PassOwnPtr<ScheduledAction>, int interval, bool singleShot);
         virtual void fired();
 
@@ -69 +69 @@
         int m_nestingLevel;
         OwnPtr<ScheduledAction> m_action;
-        int m_originalTimeout;
+        int m_originalInterval;
+        bool m_shouldForwardUserGesture;
         static double s_minDefaultTimerInterval;
     };