src/third_party/WebKit/Source/core/dom/ExecutionContext.h

   1 /*
   2  * Copyright (C) 2008 Apple Inc. All Rights Reserved.
   3  * Copyright (C) 2012 Google Inc. All Rights Reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25  *
  26  */
  27
  28 #ifndef ExecutionContext_h
  29 #define ExecutionContext_h
  30
  31 #include "core/dom/ActiveDOMObject.h"
  32 #include "core/dom/ExecutionContextClient.h"
  33 #include "core/dom/SandboxFlags.h"
  34 #include "core/dom/SecurityContext.h"
  35 #include "core/events/ErrorEvent.h"
  36 #include "core/fetch/CrossOriginAccessControl.h"
  37 #include "core/frame/ConsoleTypes.h"
  38 #include "core/frame/DOMTimer.h"
  39 #include "platform/LifecycleContext.h"
  40 #include "platform/Supplementable.h"
  41 #include "platform/weborigin/KURL.h"
  42 #include "wtf/Functional.h"
  43 #include "wtf/OwnPtr.h"
  44 #include "wtf/PassOwnPtr.h"
  45
  46 namespace WTF {
  47 class OrdinalNumber;
  48 }
  49
  50 namespace WebCore {
  51
  52 class ContextLifecycleNotifier;
  53 class DOMWindow;
  54 class EventListener;
  55 class EventQueue;
  56 class EventTarget;
  57 class ExecutionContextTask;
  58 class ScriptState;
  59 class PublicURLManager;
  60 class SecurityOrigin;
  61 class ScriptCallStack;
  62
  63 class ExecutionContext : public LifecycleContext<ExecutionContext>, public Supplementable<ExecutionContext> {
  64 public:
  65     ExecutionContext();
  66     virtual ~ExecutionContext();
  67
  68     // Delegating to ExecutionContextClient
  69     void setClient(ExecutionContextClient* client) { m_client = client; }
  70     bool isDocument() const { return m_client && m_client->isDocument(); }
  71     bool isWorkerGlobalScope() const { return m_client && m_client->isWorkerGlobalScope(); }
  72     bool isJSExecutionForbidden() { return m_client && m_client->isJSExecutionForbidden(); }
  73     SecurityOrigin* securityOrigin() const;
  74     ContentSecurityPolicy* contentSecurityPolicy() const;
  75     const KURL& url() const;
  76     KURL completeURL(const String& url) const;
  77     void disableEval(const String& errorMessage);
  78     DOMWindow* executingWindow() const;
  79     String userAgent(const KURL&) const;
  80     void postTask(PassOwnPtr<ExecutionContextTask>);
  81     void postTask(const Closure&);
  82     double timerAlignmentInterval() const;
  83
  84     bool shouldSanitizeScriptError(const String& sourceURL, AccessControlStatus);
  85     void reportException(PassRefPtrWillBeRawPtr<ErrorEvent>, PassRefPtr<ScriptCallStack>, AccessControlStatus);
  86
  87     void addConsoleMessage(MessageSource, MessageLevel, const String& message, const String& sourceURL, unsigned lineNumber);
  88     void addConsoleMessage(MessageSource, MessageLevel, const String& message, ScriptState* = 0);
  89
  90     PublicURLManager& publicURLManager();
  91
  92     // Active objects are not garbage collected even if inaccessible, e.g. because their activity may result in callbacks being invoked.
  93     bool hasPendingActivity();
  94
  95     void suspendActiveDOMObjects();
  96     void resumeActiveDOMObjects();
  97     void stopActiveDOMObjects();
  98     unsigned activeDOMObjectCount();
  99
 100     virtual void suspendScheduledTasks();
 101     virtual void resumeScheduledTasks();
 102     virtual bool tasksNeedSuspension() { return false; }
 103
 104     bool activeDOMObjectsAreSuspended() const { return m_activeDOMObjectsAreSuspended; }
 105     bool activeDOMObjectsAreStopped() const { return m_activeDOMObjectsAreStopped; }
 106     bool isIteratingOverObservers() const;
 107
 108     // Called after the construction of an ActiveDOMObject to synchronize suspend state.
 109     void suspendActiveDOMObjectIfNeeded(ActiveDOMObject*);
 110
 111     void ref() { refExecutionContext(); }
 112     void deref() { derefExecutionContext(); }
 113
 114     // Gets the next id in a circular sequence from 1 to 2^31-1.
 115     int circularSequentialID();
 116
 117     void didChangeTimerAlignmentInterval();
 118
 119     SandboxFlags sandboxFlags() const { return m_sandboxFlags; }
 120     bool isSandboxed(SandboxFlags mask) const { return m_sandboxFlags & mask; }
 121     void enforceSandboxFlags(SandboxFlags mask);
 122
 123     PassOwnPtr<LifecycleNotifier<ExecutionContext> > createLifecycleNotifier();
 124
 125     virtual EventQueue* eventQueue() const = 0;
 126
 127 protected:
 128
 129     ContextLifecycleNotifier& lifecycleNotifier();
 130
 131 private:
 132     friend class DOMTimer; // For installNewTimeout() and removeTimeoutByID() below.
 133
 134     bool dispatchErrorEvent(PassRefPtrWillBeRawPtr<ErrorEvent>, AccessControlStatus);
 135
 136     virtual void refExecutionContext() = 0;
 137     virtual void derefExecutionContext() = 0;
 138     // LifecycleContext implementation.
 139
 140     // Implementation details for DOMTimer. No other classes should call these functions.
 141     int installNewTimeout(PassOwnPtr<ScheduledAction>, int timeout, bool singleShot);
 142     void removeTimeoutByID(int timeoutID); // This makes underlying DOMTimer instance destructed.
 143
 144     ExecutionContextClient* m_client;
 145     SandboxFlags m_sandboxFlags;
 146
 147     int m_circularSequentialID;
 148     typedef HashMap<int, OwnPtr<DOMTimer> > TimeoutMap;
 149     TimeoutMap m_timeouts;
 150
 151     bool m_inDispatchErrorEvent;
 152     class PendingException;
 153     OwnPtr<Vector<OwnPtr<PendingException> > > m_pendingExceptions;
 154
 155     bool m_activeDOMObjectsAreSuspended;
 156     bool m_activeDOMObjectsAreStopped;
 157
 158     OwnPtr<PublicURLManager> m_publicURLManager;
 159
 160     // The location of this member is important; to make sure contextDestroyed() notification on
 161     // ExecutionContext's members (notably m_timeouts) is called before they are destructed,
 162     // m_lifecycleNotifer should be placed *after* such members.
 163     OwnPtr<ContextLifecycleNotifier> m_lifecycleNotifier;
 164 };
 165
 166 } // namespace WebCore
 167
 168 #endif // ExecutionContext_h