Notify clients when the user plays media otherwise prevented from autoplaying
[WebKit-https.git] / Source / WebCore / page / ChromeClient.h
1 /*
2  * Copyright (C) 2006-2017 Apple, Inc. All rights reserved.
3  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
4  * Copyright (C) 2012 Samsung Electronics. All rights reserved.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  */
21
22 #pragma once
23
24 #include "AXObjectCache.h"
25 #include "Cursor.h"
26 #include "DatabaseDetails.h"
27 #include "DisplayRefreshMonitor.h"
28 #include "FocusDirection.h"
29 #include "FrameLoader.h"
30 #include "GraphicsContext.h"
31 #include "HTMLMediaElementEnums.h"
32 #include "HostWindow.h"
33 #include "LayerFlushThrottleState.h"
34 #include "MediaProducer.h"
35 #include "PopupMenu.h"
36 #include "PopupMenuClient.h"
37 #include "RenderEmbeddedObject.h"
38 #include "ScrollTypes.h"
39 #include "ScrollingCoordinator.h"
40 #include "SearchPopupMenu.h"
41 #include "WebCoreKeyboardUIMode.h"
42 #include <runtime/ConsoleTypes.h>
43 #include <wtf/Forward.h>
44 #include <wtf/Seconds.h>
45 #include <wtf/Vector.h>
46
47 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
48 #include "MediaPlaybackTargetContext.h"
49 #endif
50
51 #if PLATFORM(IOS)
52 #include "PlatformLayer.h"
53 #define NSResponder WAKResponder
54 #ifndef __OBJC__
55 class WAKResponder;
56 #else
57 @class WAKResponder;
58 #endif
59 #endif
60
61 OBJC_CLASS NSResponder;
62
63 namespace WebCore {
64
65 class AccessibilityObject;
66 class ColorChooser;
67 class ColorChooserClient;
68 class DateTimeChooser;
69 class DateTimeChooserClient;
70 class Element;
71 class FileChooser;
72 class FileIconLoader;
73 class FloatRect;
74 class Frame;
75 class Geolocation;
76 class GraphicsLayer;
77 class GraphicsLayerFactory;
78 class HTMLInputElement;
79 class HTMLMediaElement;
80 class HTMLVideoElement;
81 class HitTestResult;
82 class IntRect;
83 class MediaSessionMetadata;
84 class NavigationAction;
85 class Node;
86 class Page;
87 class PopupMenuClient;
88 class SecurityOrigin;
89 class ViewportConstraints;
90 class Widget;
91
92 #if ENABLE(VIDEO) && USE(GSTREAMER)
93 class MediaPlayerRequestInstallMissingPluginsCallback;
94 #endif
95
96 struct DateTimeChooserParameters;
97 struct FrameLoadRequest;
98 struct GraphicsDeviceAdapter;
99 struct ViewportArguments;
100 struct WindowFeatures;
101
102 class WEBCORE_EXPORT ChromeClient {
103 public:
104     virtual void chromeDestroyed() = 0;
105
106     virtual void setWindowRect(const FloatRect&) = 0;
107     virtual FloatRect windowRect() = 0;
108
109     virtual FloatRect pageRect() = 0;
110
111     virtual void focus() = 0;
112     virtual void unfocus() = 0;
113
114     virtual bool canTakeFocus(FocusDirection) = 0;
115     virtual void takeFocus(FocusDirection) = 0;
116
117     virtual void focusedElementChanged(Element*) = 0;
118     virtual void focusedFrameChanged(Frame*) = 0;
119
120     // The Frame pointer provides the ChromeClient with context about which
121     // Frame wants to create the new Page. Also, the newly created window
122     // should not be shown to the user until the ChromeClient of the newly
123     // created Page has its show method called.
124     // The FrameLoadRequest parameter is only for ChromeClient to check if the
125     // request could be fulfilled. The ChromeClient should not load the request.
126     virtual Page* createWindow(Frame&, const FrameLoadRequest&, const WindowFeatures&, const NavigationAction&) = 0;
127     virtual void show() = 0;
128
129     virtual bool canRunModal() = 0;
130     virtual void runModal() = 0;
131
132     virtual void setToolbarsVisible(bool) = 0;
133     virtual bool toolbarsVisible() = 0;
134
135     virtual void setStatusbarVisible(bool) = 0;
136     virtual bool statusbarVisible() = 0;
137
138     virtual void setScrollbarsVisible(bool) = 0;
139     virtual bool scrollbarsVisible() = 0;
140
141     virtual void setMenubarVisible(bool) = 0;
142     virtual bool menubarVisible() = 0;
143
144     virtual void setResizable(bool) = 0;
145
146     virtual void addMessageToConsole(MessageSource, MessageLevel, const String& message, unsigned lineNumber, unsigned columnNumber, const String& sourceID) = 0;
147
148     virtual bool canRunBeforeUnloadConfirmPanel() = 0;
149     virtual bool runBeforeUnloadConfirmPanel(const String& message, Frame&) = 0;
150
151     virtual void closeWindowSoon() = 0;
152
153     virtual void runJavaScriptAlert(Frame&, const String&) = 0;
154     virtual bool runJavaScriptConfirm(Frame&, const String&) = 0;
155     virtual bool runJavaScriptPrompt(Frame&, const String& message, const String& defaultValue, String& result) = 0;
156     virtual void setStatusbarText(const String&) = 0;
157     virtual KeyboardUIMode keyboardUIMode() = 0;
158
159     virtual bool supportsImmediateInvalidation() { return false; }
160     virtual void invalidateRootView(const IntRect&) = 0;
161     virtual void invalidateContentsAndRootView(const IntRect&) = 0;
162     virtual void invalidateContentsForSlowScroll(const IntRect&) = 0;
163     virtual void scroll(const IntSize&, const IntRect&, const IntRect&) = 0;
164
165 #if USE(COORDINATED_GRAPHICS)
166     virtual void delegatedScrollRequested(const IntPoint&) = 0;
167 #endif
168
169     virtual IntPoint screenToRootView(const IntPoint&) const = 0;
170     virtual IntRect rootViewToScreen(const IntRect&) const = 0;
171
172 #if PLATFORM(IOS)
173     virtual IntPoint accessibilityScreenToRootView(const IntPoint&) const = 0;
174     virtual IntRect rootViewToAccessibilityScreen(const IntRect&) const = 0;
175 #endif    
176
177     virtual PlatformPageClient platformPageClient() const = 0;
178     virtual void scrollbarsModeDidChange() const = 0;
179
180 #if ENABLE(CURSOR_SUPPORT)
181     virtual void setCursor(const Cursor&) = 0;
182     virtual void setCursorHiddenUntilMouseMoves(bool) = 0;
183 #endif
184
185 #if !USE(REQUEST_ANIMATION_FRAME_TIMER)
186     virtual void scheduleAnimation() = 0;
187 #endif
188
189     virtual FloatSize screenSize() const { return const_cast<ChromeClient&>(*this).windowRect().size(); }
190     virtual FloatSize availableScreenSize() const { return const_cast<ChromeClient&>(*this).windowRect().size(); }
191
192     virtual void dispatchViewportPropertiesDidChange(const ViewportArguments&) const { }
193
194     virtual void contentsSizeChanged(Frame&, const IntSize&) const = 0;
195     virtual void scrollRectIntoView(const IntRect&) const { }; // Currently only Mac has a non empty implementation.
196
197     virtual bool shouldUnavailablePluginMessageBeButton(RenderEmbeddedObject::PluginUnavailabilityReason) const { return false; }
198     virtual void unavailablePluginButtonClicked(Element&, RenderEmbeddedObject::PluginUnavailabilityReason) const { }
199     virtual void mouseDidMoveOverElement(const HitTestResult&, unsigned modifierFlags) = 0;
200
201     virtual void setToolTip(const String&, TextDirection) = 0;
202
203     virtual void print(Frame&) = 0;
204
205     virtual Color underlayColor() const { return Color(); }
206
207     virtual void pageExtendedBackgroundColorDidChange(Color) const { }
208
209     virtual void exceededDatabaseQuota(Frame&, const String& databaseName, DatabaseDetails) = 0;
210
211     // Callback invoked when the application cache fails to save a cache object
212     // because storing it would grow the database file past its defined maximum
213     // size or past the amount of free space on the device. 
214     // The chrome client would need to take some action such as evicting some
215     // old caches.
216     virtual void reachedMaxAppCacheSize(int64_t spaceNeeded) = 0;
217
218     // Callback invoked when the application cache origin quota is reached. This
219     // means that the resources attempting to be cached via the manifest are
220     // more than allowed on this origin. This callback allows the chrome client
221     // to take action, such as prompting the user to ask to increase the quota
222     // for this origin. The totalSpaceNeeded parameter is the total amount of
223     // storage, in bytes, needed to store the new cache along with all of the
224     // other existing caches for the origin that would not be replaced by
225     // the new cache.
226     virtual void reachedApplicationCacheOriginQuota(SecurityOrigin&, int64_t totalSpaceNeeded) = 0;
227
228 #if ENABLE(DASHBOARD_SUPPORT)
229     virtual void annotatedRegionsChanged();
230 #endif
231
232     virtual bool shouldReplaceWithGeneratedFileForUpload(const String& path, String& generatedFilename);
233     virtual String generateReplacementFile(const String& path);
234
235 #if ENABLE(IOS_TOUCH_EVENTS)
236     virtual void didPreventDefaultForEvent() = 0;
237 #endif
238
239     virtual Seconds eventThrottlingDelay() { return 0_s; };
240
241 #if PLATFORM(IOS)
242     virtual void didReceiveMobileDocType(bool) = 0;
243     virtual void setNeedsScrollNotifications(Frame&, bool) = 0;
244     virtual void observedContentChange(Frame&) = 0;
245     virtual void clearContentChangeObservers(Frame&) = 0;
246     virtual void notifyRevealedSelectionByScrollingFrame(Frame&) = 0;
247
248     enum LayoutType { NormalLayout, Scroll };
249     virtual void didLayout(LayoutType = NormalLayout) = 0;
250     virtual void didStartOverflowScroll() = 0;
251     virtual void didEndOverflowScroll() = 0;
252
253     // FIXME: Remove this functionality. This functionality was added to workaround an issue (<rdar://problem/5973875>)
254     // where the unconfirmed text in a text area would be removed when a person clicks in the text area before a
255     // suggestion is shown. We should fix this issue in <rdar://problem/5975559>.
256     virtual void suppressFormNotifications() = 0;
257     virtual void restoreFormNotifications() = 0;
258
259     virtual void didFlushCompositingLayers() { }
260
261     virtual bool fetchCustomFixedPositionLayoutRect(IntRect&) { return false; }
262
263     virtual void updateViewportConstrainedLayers(HashMap<PlatformLayer*, std::unique_ptr<ViewportConstraints>>&, HashMap<PlatformLayer*, PlatformLayer*>&) { }
264
265     virtual void addOrUpdateScrollingLayer(Node*, PlatformLayer* scrollingLayer, PlatformLayer* contentsLayer, const IntSize& scrollSize, bool allowHorizontalScrollbar, bool allowVerticalScrollbar) = 0;
266     virtual void removeScrollingLayer(Node*, PlatformLayer* scrollingLayer, PlatformLayer* contentsLayer) = 0;
267
268     virtual void webAppOrientationsUpdated() = 0;
269     virtual void showPlaybackTargetPicker(bool hasVideo) = 0;
270 #endif
271
272 #if ENABLE(ORIENTATION_EVENTS)
273     virtual int deviceOrientation() const = 0;
274 #endif
275
276 #if ENABLE(INPUT_TYPE_COLOR)
277     virtual std::unique_ptr<ColorChooser> createColorChooser(ColorChooserClient&, const Color&) = 0;
278 #endif
279
280     virtual void runOpenPanel(Frame&, FileChooser&) = 0;
281     // Asynchronous request to load an icon for specified filenames.
282     virtual void loadIconForFiles(const Vector<String>&, FileIconLoader&) = 0;
283         
284     virtual void elementDidFocus(Element&) { }
285     virtual void elementDidBlur(Element&) { }
286     virtual void elementDidRefocus(Element&) { }
287     
288     virtual bool shouldPaintEntireContents() const { return false; }
289     virtual bool hasStablePageScaleFactor() const { return true; }
290
291     // Allows ports to customize the type of graphics layers created by this page.
292     virtual GraphicsLayerFactory* graphicsLayerFactory() const { return nullptr; }
293
294 #if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
295     virtual RefPtr<DisplayRefreshMonitor> createDisplayRefreshMonitor(PlatformDisplayID) const { return nullptr; }
296 #endif
297
298     // Pass nullptr as the GraphicsLayer to detatch the root layer.
299     virtual void attachRootGraphicsLayer(Frame&, GraphicsLayer*) = 0;
300     virtual void attachViewOverlayGraphicsLayer(Frame&, GraphicsLayer*) = 0;
301     // Sets a flag to specify that the next time content is drawn to the window,
302     // the changes appear on the screen in synchrony with updates to GraphicsLayers.
303     virtual void setNeedsOneShotDrawingSynchronization() = 0;
304     // Sets a flag to specify that the view needs to be updated, so we need
305     // to do an eager layout before the drawing.
306     virtual void scheduleCompositingLayerFlush() = 0;
307     // Returns whether or not the client can render the composited layer,
308     // regardless of the settings.
309     virtual bool allowsAcceleratedCompositing() const { return true; }
310
311     enum CompositingTrigger {
312         ThreeDTransformTrigger = 1 << 0,
313         VideoTrigger = 1 << 1,
314         PluginTrigger = 1 << 2,
315         CanvasTrigger = 1 << 3,
316         AnimationTrigger = 1 << 4,
317         FilterTrigger = 1 << 5,
318         ScrollableInnerFrameTrigger = 1 << 6,
319         AnimatedOpacityTrigger = 1 << 7,
320         AllTriggers = 0xFFFFFFFF
321     };
322     typedef unsigned CompositingTriggerFlags;
323
324     // Returns a bitfield indicating conditions that can trigger the compositor.
325     virtual CompositingTriggerFlags allowedCompositingTriggers() const { return static_cast<CompositingTriggerFlags>(AllTriggers); }
326     
327     // Returns true if layer tree updates are disabled.
328     virtual bool layerTreeStateIsFrozen() const { return false; }
329
330     virtual bool adjustLayerFlushThrottling(LayerFlushThrottleState::Flags) { return false; }
331
332     virtual RefPtr<ScrollingCoordinator> createScrollingCoordinator(Page&) const { return nullptr; }
333
334 #if PLATFORM(WIN) && USE(AVFOUNDATION)
335     virtual GraphicsDeviceAdapter* graphicsDeviceAdapter() const { return nullptr; }
336 #endif
337
338     virtual bool supportsVideoFullscreen(HTMLMediaElementEnums::VideoFullscreenMode) { return false; }
339
340 #if ENABLE(VIDEO)
341     virtual void enterVideoFullscreenForVideoElement(HTMLVideoElement&, HTMLMediaElementEnums::VideoFullscreenMode) { }
342     virtual void setUpPlaybackControlsManager(HTMLMediaElement&) { }
343     virtual void clearPlaybackControlsManager() { }
344 #endif
345
346     virtual void exitVideoFullscreenForVideoElement(HTMLVideoElement&) { }
347     virtual void exitVideoFullscreenToModeWithoutAnimation(HTMLVideoElement&, HTMLMediaElementEnums::VideoFullscreenMode) { }
348     virtual bool requiresFullscreenForVideoPlayback() { return false; } 
349
350 #if ENABLE(FULLSCREEN_API)
351     virtual bool supportsFullScreenForElement(const Element&, bool) { return false; }
352     virtual void enterFullScreenForElement(Element&) { }
353     virtual void exitFullScreenForElement(Element*) { }
354     virtual void setRootFullScreenLayer(GraphicsLayer*) { }
355 #endif
356
357 #if USE(COORDINATED_GRAPHICS)
358     virtual IntRect visibleRectForTiledBackingStore() const { return IntRect(); }
359 #endif
360
361 #if PLATFORM(COCOA)
362     virtual NSResponder *firstResponder() { return nullptr; }
363     virtual void makeFirstResponder(NSResponder *) { }
364     // Focuses on the containing view associated with this page.
365     virtual void makeFirstResponder() { }
366 #endif
367
368 #if PLATFORM(IOS)
369     // FIXME: Come up with a more descriptive name for this function and make it platform independent (if possible).
370     virtual bool isStopping() = 0;
371 #endif
372
373     virtual void enableSuddenTermination() { }
374     virtual void disableSuddenTermination() { }
375
376 #if PLATFORM(WIN)
377     virtual void setLastSetCursorToCurrentCursor() = 0;
378     virtual void AXStartFrameLoad() = 0;
379     virtual void AXFinishFrameLoad() = 0;
380 #endif
381
382     virtual bool selectItemWritingDirectionIsNatural() = 0;
383     virtual bool selectItemAlignmentFollowsMenuWritingDirection() = 0;
384     // Checks if there is an opened popup, called by RenderMenuList::showPopup().
385     virtual bool hasOpenedPopup() const = 0;
386     virtual RefPtr<PopupMenu> createPopupMenu(PopupMenuClient&) const = 0;
387     virtual RefPtr<SearchPopupMenu> createSearchPopupMenu(PopupMenuClient&) const = 0;
388
389     virtual void postAccessibilityNotification(AccessibilityObject&, AXObjectCache::AXNotification) { }
390
391     virtual void notifyScrollerThumbIsVisibleInRect(const IntRect&) { }
392     virtual void recommendedScrollbarStyleDidChange(ScrollbarStyle) { }
393
394     virtual std::optional<ScrollbarOverlayStyle> preferredScrollbarOverlayStyle() { return ScrollbarOverlayStyleDefault; }
395
396     virtual void wheelEventHandlersChanged(bool hasHandlers) = 0;
397         
398     virtual bool isSVGImageChromeClient() const { return false; }
399
400 #if ENABLE(POINTER_LOCK)
401     virtual bool requestPointerLock() { return false; }
402     virtual void requestPointerUnlock() { }
403 #endif
404
405     virtual FloatSize minimumWindowSize() const { return FloatSize(100, 100); };
406
407     virtual bool isEmptyChromeClient() const { return false; }
408
409     virtual String plugInStartLabelTitle(const String& mimeType) const { UNUSED_PARAM(mimeType); return String(); }
410     virtual String plugInStartLabelSubtitle(const String& mimeType) const { UNUSED_PARAM(mimeType); return String(); }
411     virtual String plugInExtraStyleSheet() const { return String(); }
412     virtual String plugInExtraScript() const { return String(); }
413
414     virtual void didAssociateFormControls(const Vector<RefPtr<Element>>&) { };
415     virtual bool shouldNotifyOnFormChanges() { return false; };
416
417     virtual void didAddHeaderLayer(GraphicsLayer&) { }
418     virtual void didAddFooterLayer(GraphicsLayer&) { }
419
420     virtual bool shouldUseTiledBackingForFrameView(const FrameView&) const { return false; }
421
422     virtual void isPlayingMediaDidChange(MediaProducer::MediaStateFlags, uint64_t) { }
423     virtual void didPlayMediaPreventedFromPlayingWithoutUserGesture() { }
424
425 #if ENABLE(MEDIA_SESSION)
426     virtual void hasMediaSessionWithActiveMediaElementsDidChange(bool) { }
427     virtual void mediaSessionMetadataDidChange(const MediaSessionMetadata&) { }
428     virtual void focusedContentMediaElementDidChange(uint64_t) { }
429 #endif
430
431 #if ENABLE(SUBTLE_CRYPTO)
432     virtual bool wrapCryptoKey(const Vector<uint8_t>&, Vector<uint8_t>&) const { return false; }
433     virtual bool unwrapCryptoKey(const Vector<uint8_t>&, Vector<uint8_t>&) const { return false; }
434 #endif
435
436 #if ENABLE(TELEPHONE_NUMBER_DETECTION) && PLATFORM(MAC)
437     virtual void handleTelephoneNumberClick(const String&, const IntPoint&) { }
438 #endif
439
440 #if ENABLE(SERVICE_CONTROLS)
441     virtual void handleSelectionServiceClick(FrameSelection&, const Vector<String>&, const IntPoint&) { }
442     virtual bool hasRelevantSelectionServices(bool /*isTextOnly*/) const { return false; }
443 #endif
444
445     virtual bool shouldDispatchFakeMouseMoveEvents() const { return true; }
446
447     virtual void handleAutoFillButtonClick(HTMLInputElement&) { }
448
449 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
450     virtual void addPlaybackTargetPickerClient(uint64_t /*contextId*/) { }
451     virtual void removePlaybackTargetPickerClient(uint64_t /*contextId*/) { }
452     virtual void showPlaybackTargetPicker(uint64_t /*contextId*/, const IntPoint&, bool /*isVideo*/) { }
453     virtual void playbackTargetPickerClientStateDidChange(uint64_t /*contextId*/, MediaProducer::MediaStateFlags) { }
454     virtual void setMockMediaPlaybackTargetPickerEnabled(bool)  { }
455     virtual void setMockMediaPlaybackTargetPickerState(const String&, MediaPlaybackTargetContext::State) { }
456 #endif
457
458     virtual void imageOrMediaDocumentSizeChanged(const IntSize&) { }
459
460 #if ENABLE(VIDEO) && USE(GSTREAMER)
461     virtual void requestInstallMissingMediaPlugins(const String& /*details*/, const String& /*description*/, MediaPlayerRequestInstallMissingPluginsCallback&) { }
462 #endif
463
464     virtual void didInvalidateDocumentMarkerRects() { }
465
466     virtual void reportProcessCPUTime(int64_t, ActivityStateForCPUSampling) { }
467
468 protected:
469     virtual ~ChromeClient() { }
470 };
471
472 } // namespace WebCore