Set lastHandledUserGestureTimestamp on all ancestor documents, not just the top document
[WebKit-https.git] / Source / WebCore / dom / UserGestureIndicator.cpp
1 /*
2  * Copyright (C) 2010 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "UserGestureIndicator.h"
28
29 #include "Document.h"
30 #include "ResourceLoadObserver.h"
31 #include <wtf/MainThread.h>
32 #include <wtf/NeverDestroyed.h>
33
34 namespace WebCore {
35
36 static RefPtr<UserGestureToken>& currentToken()
37 {
38     static NeverDestroyed<RefPtr<UserGestureToken>> token;
39     return token;
40 }
41
42 UserGestureToken::~UserGestureToken()
43 {
44     for (auto& observer : m_destructionObservers)
45         observer(*this);
46 }
47
48 UserGestureIndicator::UserGestureIndicator(std::optional<ProcessingUserGestureState> state, Document* document)
49     : m_previousToken(currentToken())
50 {
51     // Silently ignore UserGestureIndicators on non main threads.
52     if (!isMainThread())
53         return;
54
55     if (state)
56         currentToken() = UserGestureToken::create(state.value());
57
58     if (document && currentToken()->processingUserGesture()) {
59         document->updateLastHandledUserGestureTimestamp(MonotonicTime::now());
60         ResourceLoadObserver::sharedObserver().logUserInteractionWithReducedTimeResolution(*document);
61     }
62 }
63
64 UserGestureIndicator::UserGestureIndicator(RefPtr<UserGestureToken> token)
65     : m_previousToken(currentToken())
66 {
67     if (!isMainThread())
68         return;
69
70     if (token)
71         currentToken() = token;
72 }
73
74 UserGestureIndicator::~UserGestureIndicator()
75 {
76     if (!isMainThread())
77         return;
78     
79     currentToken() = m_previousToken;
80 }
81
82 RefPtr<UserGestureToken> UserGestureIndicator::currentUserGesture()
83 {
84     if (!isMainThread())
85         return nullptr;
86
87     return currentToken();
88 }
89
90 bool UserGestureIndicator::processingUserGesture()
91 {
92     if (!isMainThread())
93         return false;
94
95     return currentToken() ? currentToken()->processingUserGesture() : false;
96 }
97
98 bool UserGestureIndicator::processingUserGestureForMedia()
99 {
100     if (!isMainThread())
101         return false;
102
103     return currentToken() ? currentToken()->processingUserGestureForMedia() : false;
104 }
105
106 }