15c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)/* 25267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * Copyright (C) 2011 Google Inc. All rights reserved. 35c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 45c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Redistribution and use in source and binary forms, with or without 55c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * modification, are permitted provided that the following conditions are 65c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * met: 75c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 85c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * * Redistributions of source code must retain the above copyright 95c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * notice, this list of conditions and the following disclaimer. 105c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * * Redistributions in binary form must reproduce the above 115c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * copyright notice, this list of conditions and the following disclaimer 125c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * in the documentation and/or other materials provided with the 135c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * distribution. 145c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * * Neither the name of Google Inc. nor the names of its 155c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * contributors may be used to endorse or promote products derived from 165c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * this software without specific prior written permission. 175c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 185c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 195c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 205c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 215c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 225c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 235c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 245c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 255c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 265c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 275c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 285c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 295c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 305c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 315267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)#ifndef WebScopedUserGesture_h 325267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)#define WebScopedUserGesture_h 335c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 345267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)#include "../platform/WebPrivateOwnPtr.h" 355c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 365267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)namespace WebCore { 375267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)class UserGestureIndicator; 38926b001d589ce2f10facb93dd4b87578ea35a855Torne (Richard Coles)} 39926b001d589ce2f10facb93dd4b87578ea35a855Torne (Richard Coles) 4051b2906e11752df6c18351cf520e30522d3b53a1Torne (Richard Coles)namespace blink { 415c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 425267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)class WebUserGestureToken; 435c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 445267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)// An instance of this class, while kept alive, will indicate that we are in 455267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)// the context of a known user gesture. To use, create one, perform whatever 465267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)// actions were done under color of a known user gesture, and then delete it. 475267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)// Usually this will be done on the stack. 485267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)// 495267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)// SECURITY WARNING: Do not create several instances of this class for the same 505267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)// user gesture. Doing so might enable malicious code to work around certain 515267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)// restrictions such as opening multiple windows. 525267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)// Instead, obtain the current WebUserGestureToken from the 535267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)// WebUserGestureIndicator, and use this token to create a 545267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)// WebScopedUserGesture. If the token was alrady consumed, the new 555267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)// WebScopedUserGesture will not indicate that we are in the context of a user 565267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)// gesture. 575267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)class WebScopedUserGesture { 585c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)public: 595267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) explicit WebScopedUserGesture(const WebUserGestureToken& token) { initializeWithToken(token); } 605267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WebScopedUserGesture() { initialize(); } 615267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) ~WebScopedUserGesture() { reset(); } 625c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 635267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)private: 6406f816c7c76bc45a15e452ade8a34e8af077693eTorne (Richard Coles) BLINK_EXPORT void initialize(); 6506f816c7c76bc45a15e452ade8a34e8af077693eTorne (Richard Coles) BLINK_EXPORT void initializeWithToken(const WebUserGestureToken&); 6606f816c7c76bc45a15e452ade8a34e8af077693eTorne (Richard Coles) BLINK_EXPORT void reset(); 675c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 685267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WebPrivateOwnPtr<WebCore::UserGestureIndicator> m_indicator; 695c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)}; 705c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 7151b2906e11752df6c18351cf520e30522d3b53a1Torne (Richard Coles)} // namespace blink 725c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 735267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)#endif // WebScopedUserGesture_h 74