782ee68bf1a0cac830559e0cf299046c57e60cf4
[WebKit-https.git] / Source / WebCore / page / DOMWindow.h
1 /*
2  * Copyright (C) 2006-2017 Apple Inc. All rights reserved.
3  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies)
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 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 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 #pragma once
28
29 #include "Base64Utilities.h"
30 #include "ContextDestructionObserver.h"
31 #include "EventTarget.h"
32 #include "ExceptionOr.h"
33 #include "FrameDestructionObserver.h"
34 #include "ImageBitmap.h"
35 #include "ScrollToOptions.h"
36 #include "Supplementable.h"
37 #include <heap/HandleTypes.h>
38 #include <wtf/Function.h>
39 #include <wtf/HashSet.h>
40 #include <wtf/WeakPtr.h>
41
42 namespace JSC {
43 class ExecState;
44 class JSObject;
45 class JSValue;
46 template<typename> class Strong;
47 }
48
49 namespace WebCore {
50
51 class BarProp;
52 class CSSRuleList;
53 class CSSStyleDeclaration;
54 class Crypto;
55 class CustomElementRegistry;
56 class DOMApplicationCache;
57 class DOMSelection;
58 class DOMWindowProperty;
59 class DOMWrapperWorld;
60 class Document;
61 class Element;
62 class EventListener;
63 class FloatRect;
64 class History;
65 class Location;
66 class MediaQueryList;
67 class Navigator;
68 class Node;
69 class NodeList;
70 class Page;
71 class PageConsoleClient;
72 class Performance;
73 class PostMessageTimer;
74 class RequestAnimationFrameCallback;
75 class ScheduledAction;
76 class Screen;
77 class Storage;
78 class StyleMedia;
79 class WebKitNamespace;
80 class WebKitPoint;
81
82 struct ImageBitmapOptions;
83 struct WindowFeatures;
84
85 enum SetLocationLocking { LockHistoryBasedOnGestureState, LockHistoryAndBackForwardList };
86
87 // FIXME: DOMWindow shouldn't subclass FrameDestructionObserver and instead should get to Frame via its Document.
88 class DOMWindow final
89     : public RefCounted<DOMWindow>
90     , public EventTargetWithInlineData
91     , public ContextDestructionObserver
92     , public FrameDestructionObserver
93     , public Base64Utilities
94     , public Supplementable<DOMWindow> {
95 public:
96     static Ref<DOMWindow> create(Document& document) { return adoptRef(*new DOMWindow(document)); }
97     WEBCORE_EXPORT virtual ~DOMWindow();
98
99     // In some rare cases, we'll reuse a DOMWindow for a new Document. For example,
100     // when a script calls window.open("..."), the browser gives JavaScript a window
101     // synchronously but kicks off the load in the window asynchronously. Web sites
102     // expect that modifications that they make to the window object synchronously
103     // won't be blown away when the network load commits. To make that happen, we
104     // "securely transition" the existing DOMWindow to the Document that results from
105     // the network load. See also SecurityContext::isSecureTransitionTo.
106     void didSecureTransitionTo(Document&);
107
108     void registerProperty(DOMWindowProperty&);
109     void unregisterProperty(DOMWindowProperty&);
110
111     void resetUnlessSuspendedForDocumentSuspension();
112     void suspendForDocumentSuspension();
113     void resumeFromDocumentSuspension();
114
115     RefPtr<MediaQueryList> matchMedia(const String&);
116
117     WEBCORE_EXPORT unsigned pendingUnloadEventListeners() const;
118
119     WEBCORE_EXPORT static bool dispatchAllPendingBeforeUnloadEvents();
120     WEBCORE_EXPORT static void dispatchAllPendingUnloadEvents();
121
122     static FloatRect adjustWindowRect(Page&, const FloatRect& pendingChanges);
123
124     bool allowPopUp(); // Call on first window, not target window.
125     static bool allowPopUp(Frame& firstFrame);
126     static bool canShowModalDialog(const Frame&);
127     WEBCORE_EXPORT void setCanShowModalDialogOverride(bool);
128
129     Screen* screen() const;
130     History* history() const;
131     Crypto* crypto() const;
132     BarProp* locationbar() const;
133     BarProp* menubar() const;
134     BarProp* personalbar() const;
135     BarProp* scrollbars() const;
136     BarProp* statusbar() const;
137     BarProp* toolbar() const;
138     Navigator* navigator() const;
139     Navigator* clientInformation() const { return navigator(); }
140
141     Location* location() const;
142     void setLocation(DOMWindow& activeWindow, DOMWindow& firstWindow, const String& location, SetLocationLocking = LockHistoryBasedOnGestureState);
143
144     DOMSelection* getSelection();
145
146     Element* frameElement() const;
147
148     WEBCORE_EXPORT void focus(bool allowFocus = false);
149     void focus(DOMWindow& incumbentWindow);
150     void blur();
151     WEBCORE_EXPORT void close();
152     void close(Document&);
153     void print();
154     void stop();
155
156     WEBCORE_EXPORT RefPtr<DOMWindow> open(DOMWindow& activeWindow, DOMWindow& firstWindow, const String& urlString, const AtomicString& frameName, const String& windowFeaturesString);
157
158     void showModalDialog(const String& urlString, const String& dialogFeaturesString, DOMWindow& activeWindow, DOMWindow& firstWindow, const WTF::Function<void(DOMWindow&)>& prepareDialogFunction);
159
160     void alert(const String& message = emptyString());
161     bool confirm(const String& message);
162     String prompt(const String& message, const String& defaultValue);
163
164     bool find(const String&, bool caseSensitive, bool backwards, bool wrap, bool wholeWord, bool searchInFrames, bool showDialog) const;
165
166     bool offscreenBuffering() const;
167
168     int outerHeight() const;
169     int outerWidth() const;
170     int innerHeight() const;
171     int innerWidth() const;
172     int screenX() const;
173     int screenY() const;
174     int screenLeft() const { return screenX(); }
175     int screenTop() const { return screenY(); }
176     int scrollX() const;
177     int scrollY() const;
178
179     bool closed() const;
180
181     unsigned length() const;
182
183     String name() const;
184     void setName(const String&);
185
186     String status() const;
187     void setStatus(const String&);
188     String defaultStatus() const;
189     void setDefaultStatus(const String&);
190
191     // Self-referential attributes
192
193     DOMWindow* self() const;
194     DOMWindow* window() const { return self(); }
195     DOMWindow* frames() const { return self(); }
196
197     DOMWindow* opener() const;
198     DOMWindow* parent() const;
199     DOMWindow* top() const;
200
201     String origin() const;
202
203     // DOM Level 2 AbstractView Interface
204
205     WEBCORE_EXPORT Document* document() const;
206
207     // CSSOM View Module
208
209     RefPtr<StyleMedia> styleMedia() const;
210
211     // DOM Level 2 Style Interface
212
213     WEBCORE_EXPORT Ref<CSSStyleDeclaration> getComputedStyle(Element&, const String& pseudoElt) const;
214
215     // WebKit extensions
216
217     WEBCORE_EXPORT RefPtr<CSSRuleList> getMatchedCSSRules(Element*, const String& pseudoElt, bool authorOnly = true) const;
218     double devicePixelRatio() const;
219
220     RefPtr<WebKitPoint> webkitConvertPointFromPageToNode(Node*, const WebKitPoint*) const;
221     RefPtr<WebKitPoint> webkitConvertPointFromNodeToPage(Node*, const WebKitPoint*) const;
222
223     PageConsoleClient* console() const;
224
225     void printErrorMessage(const String&);
226     String crossDomainAccessErrorMessage(const DOMWindow& activeWindow);
227
228     ExceptionOr<void> postMessage(JSC::ExecState&, DOMWindow& incumbentWindow, JSC::JSValue message, const String& targetOrigin, Vector<JSC::Strong<JSC::JSObject>>&&);
229     void postMessageTimerFired(PostMessageTimer&);
230
231     void languagesChanged();
232
233     void scrollBy(const ScrollToOptions&) const;
234     void scrollBy(double x, double y) const;
235     void scrollTo(const ScrollToOptions&) const;
236     void scrollTo(double x, double y) const;
237
238     void moveBy(float x, float y) const;
239     void moveTo(float x, float y) const;
240
241     void resizeBy(float x, float y) const;
242     void resizeTo(float width, float height) const;
243
244     // Timers
245     ExceptionOr<int> setTimeout(JSC::ExecState&, std::unique_ptr<ScheduledAction>, int timeout, Vector<JSC::Strong<JSC::Unknown>>&& arguments);
246     void clearTimeout(int timeoutId);
247     ExceptionOr<int> setInterval(JSC::ExecState&, std::unique_ptr<ScheduledAction>, int timeout, Vector<JSC::Strong<JSC::Unknown>>&& arguments);
248     void clearInterval(int timeoutId);
249
250     int requestAnimationFrame(Ref<RequestAnimationFrameCallback>&&);
251     int webkitRequestAnimationFrame(Ref<RequestAnimationFrameCallback>&&);
252     void cancelAnimationFrame(int id);
253
254     // ImageBitmap
255     void createImageBitmap(ImageBitmap::Source&&, ImageBitmapOptions&&, ImageBitmap::Promise&&);
256     void createImageBitmap(ImageBitmap::Source&&, int sx, int sy, int sw, int sh, ImageBitmapOptions&&, ImageBitmap::Promise&&);
257
258     // Secure Contexts
259     bool isSecureContext() const;
260
261     // Events
262     // EventTarget API
263     bool addEventListener(const AtomicString& eventType, Ref<EventListener>&&, const AddEventListenerOptions&) final;
264     bool removeEventListener(const AtomicString& eventType, EventListener&, const ListenerOptions&) final;
265     void removeAllEventListeners() final;
266
267     using EventTarget::dispatchEvent;
268     bool dispatchEvent(Event&, EventTarget*);
269
270     void dispatchLoadEvent();
271
272     void captureEvents();
273     void releaseEvents();
274
275     void finishedLoading();
276
277     using RefCounted::ref;
278     using RefCounted::deref;
279
280     // HTML 5 key/value storage
281     ExceptionOr<Storage*> sessionStorage() const;
282     ExceptionOr<Storage*> localStorage() const;
283     Storage* optionalSessionStorage() const { return m_sessionStorage.get(); }
284     Storage* optionalLocalStorage() const { return m_localStorage.get(); }
285
286     DOMApplicationCache* applicationCache() const;
287     DOMApplicationCache* optionalApplicationCache() const { return m_applicationCache.get(); }
288
289     CustomElementRegistry* customElementRegistry() { return m_customElementRegistry.get(); }
290     CustomElementRegistry& ensureCustomElementRegistry();
291
292     ExceptionOr<Ref<NodeList>> collectMatchingElementsInFlatTree(Node&, const String& selectors);
293     ExceptionOr<RefPtr<Element>> matchingElementInFlatTree(Node&, const String& selectors);
294
295 #if ENABLE(ORIENTATION_EVENTS)
296     // This is the interface orientation in degrees. Some examples are:
297     //  0 is straight up; -90 is when the device is rotated 90 clockwise;
298     //  90 is when rotated counter clockwise.
299     int orientation() const;
300 #endif
301
302     Performance* performance() const;
303     double nowTimestamp() const;
304
305 #if PLATFORM(IOS)
306     void incrementScrollEventListenersCount();
307     void decrementScrollEventListenersCount();
308     unsigned scrollEventListenerCount() const { return m_scrollEventListenerCount; }
309 #endif
310
311     void resetAllGeolocationPermission();
312
313 #if ENABLE(IOS_TOUCH_EVENTS) || ENABLE(IOS_GESTURE_EVENTS)
314     bool hasTouchOrGestureEventListeners() const { return m_touchAndGestureEventListenerCount > 0; }
315 #endif
316
317 #if ENABLE(USER_MESSAGE_HANDLERS)
318     bool shouldHaveWebKitNamespaceForWorld(DOMWrapperWorld&);
319     WebKitNamespace* webkitNamespace() const;
320 #endif
321
322     // FIXME: When this DOMWindow is no longer the active DOMWindow (i.e.,
323     // when its document is no longer the document that is displayed in its
324     // frame), we would like to zero out m_frame to avoid being confused
325     // by the document that is currently active in m_frame.
326     bool isCurrentlyDisplayedInFrame() const;
327
328     void willDetachDocumentFromFrame();
329     void willDestroyCachedFrame();
330
331     void enableSuddenTermination();
332     void disableSuddenTermination();
333
334     WeakPtr<DOMWindow> createWeakPtr() { return m_weakPtrFactory.createWeakPtr(*this); }
335
336 private:
337     explicit DOMWindow(Document&);
338
339     EventTargetInterface eventTargetInterface() const final { return DOMWindowEventTargetInterfaceType; }
340     ScriptExecutionContext* scriptExecutionContext() const final { return ContextDestructionObserver::scriptExecutionContext(); }
341
342     DOMWindow* toDOMWindow() final;
343
344     Page* page();
345     bool allowedToChangeWindowGeometry() const;
346
347     void frameDestroyed() final;
348     void willDetachPage() final;
349
350     void refEventTarget() final { ref(); }
351     void derefEventTarget() final { deref(); }
352
353     static RefPtr<Frame> createWindow(const String& urlString, const AtomicString& frameName, const WindowFeatures&, DOMWindow& activeWindow, Frame& firstFrame, Frame& openerFrame, const WTF::Function<void(DOMWindow&)>& prepareDialogFunction = nullptr);
354     bool isInsecureScriptAccess(DOMWindow& activeWindow, const String& urlString);
355
356     void resetDOMWindowProperties();
357     void disconnectDOMWindowProperties();
358     void reconnectDOMWindowProperties();
359     void willDestroyDocumentInFrame();
360
361     bool isSameSecurityOriginAsMainFrame() const;
362
363 #if ENABLE(GAMEPAD)
364     void incrementGamepadEventListenerCount();
365     void decrementGamepadEventListenerCount();
366 #endif
367
368     bool m_shouldPrintWhenFinishedLoading { false };
369     bool m_suspendedForDocumentSuspension { false };
370     std::optional<bool> m_canShowModalDialogOverride;
371
372     HashSet<DOMWindowProperty*> m_properties;
373
374     mutable RefPtr<Crypto> m_crypto;
375     mutable RefPtr<History> m_history;
376     mutable RefPtr<BarProp> m_locationbar;
377     mutable RefPtr<StyleMedia> m_media;
378     mutable RefPtr<BarProp> m_menubar;
379     mutable RefPtr<Navigator> m_navigator;
380     mutable RefPtr<BarProp> m_personalbar;
381     mutable RefPtr<Screen> m_screen;
382     mutable RefPtr<BarProp> m_scrollbars;
383     mutable RefPtr<DOMSelection> m_selection;
384     mutable RefPtr<BarProp> m_statusbar;
385     mutable RefPtr<BarProp> m_toolbar;
386     mutable RefPtr<Location> m_location;
387
388     String m_status;
389     String m_defaultStatus;
390
391     enum class PageStatus { None, Shown, Hidden };
392     PageStatus m_lastPageStatus { PageStatus::None };
393
394     WeakPtrFactory<DOMWindow> m_weakPtrFactory;
395
396 #if PLATFORM(IOS)
397     unsigned m_scrollEventListenerCount { 0 };
398 #endif
399
400 #if ENABLE(IOS_TOUCH_EVENTS) || ENABLE(IOS_GESTURE_EVENTS)
401     unsigned m_touchAndGestureEventListenerCount { 0 };
402 #endif
403
404 #if ENABLE(GAMEPAD)
405     unsigned m_gamepadEventListenerCount { 0 };
406 #endif
407
408     mutable RefPtr<Storage> m_sessionStorage;
409     mutable RefPtr<Storage> m_localStorage;
410     mutable RefPtr<DOMApplicationCache> m_applicationCache;
411
412     RefPtr<CustomElementRegistry> m_customElementRegistry;
413
414     mutable RefPtr<Performance> m_performance;
415
416 #if ENABLE(USER_MESSAGE_HANDLERS)
417     mutable RefPtr<WebKitNamespace> m_webkitNamespace;
418 #endif
419 };
420
421 inline String DOMWindow::status() const
422 {
423     return m_status;
424 }
425
426 inline String DOMWindow::defaultStatus() const
427 {
428     return m_defaultStatus;
429 }
430
431 } // namespace WebCore