WebKit.WebsitePoliciesAutoplayQuirks API test times out with async policy delegates
[WebKit-https.git] / Source / WebCore / loader / FrameLoader.h
1 /*
2  * Copyright (C) 2006-2016 Apple Inc. All rights reserved.
3  * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
4  * Copyright (C) Research In Motion Limited 2009. All rights reserved.
5  * Copyright (C) 2011 Google Inc. All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1.  Redistributions of source code must retain the above copyright
12  *     notice, this list of conditions and the following disclaimer. 
13  * 2.  Redistributions in binary form must reproduce the above copyright
14  *     notice, this list of conditions and the following disclaimer in the
15  *     documentation and/or other materials provided with the distribution. 
16  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
17  *     its contributors may be used to endorse or promote products derived
18  *     from this software without specific prior written permission. 
19  *
20  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
21  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
22  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
24  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
25  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
27  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
29  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #pragma once
33
34 #include "CachePolicy.h"
35 #include "FrameLoaderStateMachine.h"
36 #include "FrameLoaderTypes.h"
37 #include "LayoutMilestones.h"
38 #include "MixedContentChecker.h"
39 #include "ReferrerPolicy.h"
40 #include "ResourceLoadNotifier.h"
41 #include "ResourceLoaderOptions.h"
42 #include "ResourceRequestBase.h"
43 #include "SecurityContext.h"
44 #include "StoredCredentialsPolicy.h"
45 #include "Timer.h"
46 #include <wtf/Forward.h>
47 #include <wtf/HashSet.h>
48 #include <wtf/OptionSet.h>
49 #include <wtf/Optional.h>
50 #include <wtf/WallTime.h>
51
52 namespace WebCore {
53
54 class Archive;
55 class CachedFrame;
56 class CachedFrameBase;
57 class CachedPage;
58 class CachedResource;
59 class Chrome;
60 class DOMWrapperWorld;
61 class Document;
62 class DocumentLoader;
63 class Event;
64 class FormState;
65 class FormSubmission;
66 class FrameLoadRequest;
67 class FrameLoaderClient;
68 class FrameNetworkingContext;
69 class HistoryController;
70 class HistoryItem;
71 class NavigationAction;
72 class NetworkingContext;
73 class Page;
74 class PolicyChecker;
75 class ResourceError;
76 class ResourceRequest;
77 class ResourceResponse;
78 class SerializedScriptValue;
79 class SharedBuffer;
80 class SubframeLoader;
81 class SubstituteData;
82
83 struct WindowFeatures;
84
85 WEBCORE_EXPORT bool isBackForwardLoadType(FrameLoadType);
86 WEBCORE_EXPORT bool isReload(FrameLoadType);
87
88 using ContentPolicyDecisionFunction = WTF::Function<void(PolicyAction)>;
89
90 class FrameLoader {
91     WTF_MAKE_NONCOPYABLE(FrameLoader);
92 public:
93     FrameLoader(Frame&, FrameLoaderClient&);
94     ~FrameLoader();
95
96     WEBCORE_EXPORT void init();
97     void initForSynthesizedDocument(const URL&);
98
99     Frame& frame() const { return m_frame; }
100
101     PolicyChecker& policyChecker() const { return *m_policyChecker; }
102     HistoryController& history() const { return *m_history; }
103     ResourceLoadNotifier& notifier() const { return m_notifier; }
104     SubframeLoader& subframeLoader() const { return *m_subframeLoader; }
105     MixedContentChecker& mixedContentChecker() const { return m_mixedContentChecker; }
106
107     void setupForReplace();
108
109     // FIXME: These are all functions which start loads. We have too many.
110     WEBCORE_EXPORT void loadURLIntoChildFrame(const URL&, const String& referer, Frame*);
111     WEBCORE_EXPORT void loadFrameRequest(FrameLoadRequest&&, Event*, FormState*); // Called by submitForm, calls loadPostRequest and loadURL.
112
113     WEBCORE_EXPORT void load(FrameLoadRequest&&);
114
115 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
116     WEBCORE_EXPORT void loadArchive(Ref<Archive>&&);
117 #endif
118     unsigned long loadResourceSynchronously(const ResourceRequest&, StoredCredentialsPolicy, ClientCredentialPolicy, ResourceError&, ResourceResponse&, RefPtr<SharedBuffer>& data);
119
120     void changeLocation(FrameLoadRequest&&);
121     WEBCORE_EXPORT void urlSelected(const URL&, const String& target, Event*, LockHistory, LockBackForwardList, ShouldSendReferrer, ShouldOpenExternalURLsPolicy, std::optional<NewFrameOpenerPolicy> = std::nullopt, const AtomicString& downloadAttribute = nullAtom());
122     void submitForm(Ref<FormSubmission>&&);
123
124     WEBCORE_EXPORT void reload(OptionSet<ReloadOption> = { });
125     WEBCORE_EXPORT void reloadWithOverrideEncoding(const String& overrideEncoding);
126
127     void open(CachedFrameBase&);
128     void loadItem(HistoryItem&, FrameLoadType);
129     HistoryItem* requestedHistoryItem() const { return m_requestedHistoryItem.get(); }
130
131     void retryAfterFailedCacheOnlyMainResourceLoad();
132
133     static void reportLocalLoadFailed(Frame*, const String& url);
134     static void reportBlockedPortFailed(Frame*, const String& url);
135     static void reportAuthenticationChallengeBlocked(Frame*, const URL&, const String& reason);
136
137     // FIXME: These are all functions which stop loads. We have too many.
138     WEBCORE_EXPORT void stopAllLoaders(ClearProvisionalItemPolicy = ShouldClearProvisionalItem);
139     WEBCORE_EXPORT void stopForUserCancel(bool deferCheckLoadComplete = false);
140     void stop();
141     void stopLoading(UnloadEventPolicy);
142     bool closeURL();
143     void cancelAndClear();
144     void clearProvisionalLoadForPolicyCheck();
145     // FIXME: clear() is trying to do too many things. We should break it down into smaller functions (ideally with fewer raw Boolean parameters).
146     void clear(Document* newDocument, bool clearWindowProperties = true, bool clearScriptObjects = true, bool clearFrameView = true);
147
148     bool isLoading() const;
149     WEBCORE_EXPORT bool frameHasLoaded() const;
150
151     WEBCORE_EXPORT int numPendingOrLoadingRequests(bool recurse) const;
152
153     ReferrerPolicy effectiveReferrerPolicy() const;
154     String referrer() const;
155     WEBCORE_EXPORT String outgoingReferrer() const;
156     String outgoingOrigin() const;
157
158     WEBCORE_EXPORT DocumentLoader* activeDocumentLoader() const;
159     DocumentLoader* documentLoader() const { return m_documentLoader.get(); }
160     DocumentLoader* policyDocumentLoader() const { return m_policyDocumentLoader.get(); }
161     DocumentLoader* provisionalDocumentLoader() const { return m_provisionalDocumentLoader.get(); }
162     FrameState state() const { return m_state; }
163
164     void setShouldReportResourceTimingToParentFrame(bool value) { m_shouldReportResourceTimingToParentFrame = value; }
165     bool shouldReportResourceTimingToParentFrame() { return m_shouldReportResourceTimingToParentFrame; };
166     
167 #if PLATFORM(IOS)
168     RetainPtr<CFDictionaryRef> connectionProperties(ResourceLoader*);
169 #endif
170     const ResourceRequest& originalRequest() const;
171     const ResourceRequest& initialRequest() const;
172     void receivedMainResourceError(const ResourceError&);
173
174     bool willLoadMediaElementURL(URL&);
175
176     void handleFallbackContent();
177
178     WEBCORE_EXPORT ResourceError cancelledError(const ResourceRequest&) const;
179     WEBCORE_EXPORT ResourceError blockedByContentBlockerError(const ResourceRequest&) const;
180     ResourceError blockedError(const ResourceRequest&) const;
181 #if ENABLE(CONTENT_FILTERING)
182     ResourceError blockedByContentFilterError(const ResourceRequest&) const;
183 #endif
184
185     bool isHostedByObjectElement() const;
186
187     bool isReplacing() const;
188     void setReplacing();
189     bool subframeIsLoading() const;
190     void willChangeTitle(DocumentLoader*);
191     void didChangeTitle(DocumentLoader*);
192
193     bool shouldTreatURLAsSrcdocDocument(const URL&) const;
194
195     WEBCORE_EXPORT FrameLoadType loadType() const;
196
197     CachePolicy subresourceCachePolicy(const URL&) const;
198
199     void didReachLayoutMilestone(LayoutMilestones);
200     void didFirstLayout();
201
202     void loadedResourceFromMemoryCache(CachedResource&, ResourceRequest& newRequest, ResourceError&);
203     void tellClientAboutPastMemoryCacheLoads();
204
205     void checkLoadComplete();
206     WEBCORE_EXPORT void detachFromParent();
207     void detachViewsAndDocumentLoader();
208
209     void addExtraFieldsToSubresourceRequest(ResourceRequest&);
210     void addExtraFieldsToMainResourceRequest(ResourceRequest&);
211     
212     static void addHTTPOriginIfNeeded(ResourceRequest&, const String& origin);
213     static void addHTTPUpgradeInsecureRequestsIfNeeded(ResourceRequest&);
214
215     FrameLoaderClient& client() const { return m_client; }
216
217     void setDefersLoading(bool);
218
219     void checkContentPolicy(const ResourceResponse&, ContentPolicyDecisionFunction&&);
220
221     void didExplicitOpen();
222
223     // Callbacks from DocumentWriter
224     void didBeginDocument(bool dispatchWindowObjectAvailable);
225
226     void receivedFirstData();
227
228     void dispatchOnloadEvents();
229     String userAgent(const URL&) const;
230
231     void dispatchDidClearWindowObjectInWorld(DOMWrapperWorld&);
232     void dispatchDidClearWindowObjectsInAllWorlds();
233
234     // The following sandbox flags will be forced, regardless of changes to
235     // the sandbox attribute of any parent frames.
236     void forceSandboxFlags(SandboxFlags flags) { m_forcedSandboxFlags |= flags; }
237     SandboxFlags effectiveSandboxFlags() const;
238
239     bool checkIfFormActionAllowedByCSP(const URL&, bool didReceiveRedirectResponse) const;
240
241     WEBCORE_EXPORT Frame* opener();
242     WEBCORE_EXPORT void setOpener(Frame*);
243
244     void resetMultipleFormSubmissionProtection();
245
246     void checkCallImplicitClose();
247
248     void frameDetached();
249
250     void setOutgoingReferrer(const URL&);
251
252     void loadDone();
253     void finishedParsing();
254     void checkCompleted();
255
256     WEBCORE_EXPORT bool isComplete() const;
257
258     void commitProvisionalLoad();
259
260     void setLoadsSynchronously(bool loadsSynchronously) { m_loadsSynchronously = loadsSynchronously; }
261     bool loadsSynchronously() const { return m_loadsSynchronously; }
262
263     FrameLoaderStateMachine& stateMachine() { return m_stateMachine; }
264
265     WEBCORE_EXPORT Frame* findFrameForNavigation(const AtomicString& name, Document* activeDocument = nullptr);
266
267     void applyUserAgentIfNeeded(ResourceRequest&);
268
269     bool shouldInterruptLoadForXFrameOptions(const String&, const URL&, unsigned long requestIdentifier);
270
271     void completed();
272     bool allAncestorsAreComplete() const; // including this
273     void clientRedirected(const URL&, double delay, WallTime fireDate, LockBackForwardList);
274     void clientRedirectCancelledOrFinished(bool cancelWithLoadInProgress);
275
276     WEBCORE_EXPORT void setOriginalURLForDownloadRequest(ResourceRequest&);
277
278     bool quickRedirectComing() const { return m_quickRedirectComing; }
279
280     WEBCORE_EXPORT bool shouldClose();
281     
282     void started();
283
284     enum class PageDismissalType { None, BeforeUnload, PageHide, Unload };
285     PageDismissalType pageDismissalEventBeingDispatched() const { return m_pageDismissalEventBeingDispatched; }
286
287     WEBCORE_EXPORT NetworkingContext* networkingContext() const;
288
289     void loadProgressingStatusChanged();
290
291     const URL& previousURL() const { return m_previousURL; }
292
293     void forcePageTransitionIfNeeded();
294
295     void setOverrideCachePolicyForTesting(ResourceRequestCachePolicy policy) { m_overrideCachePolicyForTesting = policy; }
296     void setOverrideResourceLoadPriorityForTesting(ResourceLoadPriority priority) { m_overrideResourceLoadPriorityForTesting = priority; }
297     void setStrictRawResourceValidationPolicyDisabledForTesting(bool disabled) { m_isStrictRawResourceValidationPolicyDisabledForTesting = disabled; }
298     bool isStrictRawResourceValidationPolicyDisabledForTesting() { return m_isStrictRawResourceValidationPolicyDisabledForTesting; }
299
300     WEBCORE_EXPORT void clearTestingOverrides();
301
302     const URL& provisionalLoadErrorBeingHandledURL() const { return m_provisionalLoadErrorBeingHandledURL; }
303     void setProvisionalLoadErrorBeingHandledURL(const URL& url) { m_provisionalLoadErrorBeingHandledURL = url; }
304
305     bool isAlwaysOnLoggingAllowed() const;
306     bool shouldSuppressTextInputFromEditing() const;
307     bool isReloadingFromOrigin() const { return m_loadType == FrameLoadType::ReloadFromOrigin; }
308
309 private:
310     enum FormSubmissionCacheLoadPolicy {
311         MayAttemptCacheOnlyLoadForFormSubmissionItem,
312         MayNotAttemptCacheOnlyLoadForFormSubmissionItem
313     };
314
315     bool allChildrenAreComplete() const; // immediate children, not all descendants
316
317     void checkTimerFired();
318
319     void loadSameDocumentItem(HistoryItem&);
320     void loadDifferentDocumentItem(HistoryItem&, FrameLoadType, FormSubmissionCacheLoadPolicy);
321
322     void loadProvisionalItemFromCachedPage();
323
324     void updateFirstPartyForCookies();
325     void setFirstPartyForCookies(const URL&);
326
327     void addExtraFieldsToRequest(ResourceRequest&, FrameLoadType, bool isMainResource);
328     ResourceRequestCachePolicy defaultRequestCachingPolicy(const ResourceRequest&, FrameLoadType, bool isMainResource);
329
330     void clearProvisionalLoad();
331     void transitionToCommitted(CachedPage*);
332     void frameLoadCompleted();
333
334     SubstituteData defaultSubstituteDataForURL(const URL&);
335
336     bool dispatchBeforeUnloadEvent(Chrome&, FrameLoader* frameLoaderBeingNavigated);
337     void dispatchUnloadEvents(UnloadEventPolicy);
338
339     void continueLoadAfterNavigationPolicy(const ResourceRequest&, FormState*, bool shouldContinue, AllowNavigationToInvalidURL);
340     void continueLoadAfterNewWindowPolicy(const ResourceRequest&, FormState*, const String& frameName, const NavigationAction&, bool shouldContinue, AllowNavigationToInvalidURL, NewFrameOpenerPolicy);
341     void continueFragmentScrollAfterNavigationPolicy(const ResourceRequest&, bool shouldContinue);
342
343     bool shouldPerformFragmentNavigation(bool isFormSubmission, const String& httpMethod, FrameLoadType, const URL&);
344     void scrollToFragmentWithParentBoundary(const URL&, bool isNewNavigation = true);
345
346     void checkLoadCompleteForThisFrame();
347
348     void setDocumentLoader(DocumentLoader*);
349     void setPolicyDocumentLoader(DocumentLoader*);
350     void setProvisionalDocumentLoader(DocumentLoader*);
351
352     void setState(FrameState);
353
354     void closeOldDataSources();
355     void willRestoreFromCachedPage();
356
357     bool shouldReloadToHandleUnreachableURL(DocumentLoader*);
358
359     void dispatchDidCommitLoad(std::optional<HasInsecureContent> initialHasInsecureContent);
360
361     void urlSelected(FrameLoadRequest&&, Event*);
362
363     void loadWithDocumentLoader(DocumentLoader*, FrameLoadType, FormState*, AllowNavigationToInvalidURL, CompletionHandler<void()>&&); // Calls continueLoadAfterNavigationPolicy
364     void load(DocumentLoader*); // Calls loadWithDocumentLoader
365
366     void loadWithNavigationAction(const ResourceRequest&, const NavigationAction&, LockHistory, FrameLoadType, FormState*, AllowNavigationToInvalidURL, CompletionHandler<void()>&&); // Calls loadWithDocumentLoader
367
368     void loadPostRequest(FrameLoadRequest&&, const String& referrer, FrameLoadType, Event*, FormState*, CompletionHandler<void()>&&);
369     void loadURL(FrameLoadRequest&&, const String& referrer, FrameLoadType, Event*, FormState*, CompletionHandler<void()>&&);
370
371     bool shouldReload(const URL& currentURL, const URL& destinationURL);
372
373     void requestFromDelegate(ResourceRequest&, unsigned long& identifier, ResourceError&);
374
375     WEBCORE_EXPORT void detachChildren();
376     void closeAndRemoveChild(Frame&);
377
378     void loadInSameDocument(const URL&, SerializedScriptValue* stateObject, bool isNewNavigation);
379
380     void prepareForLoadStart();
381     void provisionalLoadStarted();
382
383     void willTransitionToCommitted();
384     bool didOpenURL();
385
386     void scheduleCheckCompleted();
387     void scheduleCheckLoadComplete();
388     void startCheckCompleteTimer();
389
390     bool shouldTreatURLAsSameAsCurrent(const URL&) const;
391
392     void dispatchGlobalObjectAvailableInAllWorlds();
393
394     bool isNavigationAllowed() const;
395     bool isStopLoadingAllowed() const;
396
397     Frame& m_frame;
398     FrameLoaderClient& m_client;
399
400     const std::unique_ptr<PolicyChecker> m_policyChecker;
401     const std::unique_ptr<HistoryController> m_history;
402     mutable ResourceLoadNotifier m_notifier;
403     const std::unique_ptr<SubframeLoader> m_subframeLoader;
404     mutable FrameLoaderStateMachine m_stateMachine;
405     mutable MixedContentChecker m_mixedContentChecker;
406
407     class FrameProgressTracker;
408     std::unique_ptr<FrameProgressTracker> m_progressTracker;
409
410     FrameState m_state;
411     FrameLoadType m_loadType;
412
413     // Document loaders for the three phases of frame loading. Note that while 
414     // a new request is being loaded, the old document loader may still be referenced.
415     // E.g. while a new request is in the "policy" state, the old document loader may
416     // be consulted in particular as it makes sense to imply certain settings on the new loader.
417     RefPtr<DocumentLoader> m_documentLoader;
418     RefPtr<DocumentLoader> m_provisionalDocumentLoader;
419     RefPtr<DocumentLoader> m_policyDocumentLoader;
420
421     URL m_provisionalLoadErrorBeingHandledURL;
422
423     bool m_quickRedirectComing;
424     bool m_sentRedirectNotification;
425     bool m_inStopAllLoaders;
426     bool m_shouldReportResourceTimingToParentFrame { true };
427
428     String m_outgoingReferrer;
429
430     bool m_isExecutingJavaScriptFormAction;
431
432     bool m_didCallImplicitClose;
433     bool m_wasUnloadEventEmitted;
434
435     PageDismissalType m_pageDismissalEventBeingDispatched { PageDismissalType::None };
436     bool m_isComplete;
437
438     RefPtr<SerializedScriptValue> m_pendingStateObject;
439
440     bool m_needsClear;
441
442     URL m_submittedFormURL;
443
444     Timer m_checkTimer;
445     bool m_shouldCallCheckCompleted;
446     bool m_shouldCallCheckLoadComplete;
447
448     Frame* m_opener;
449     HashSet<Frame*> m_openedFrames;
450
451     bool m_loadingFromCachedPage;
452
453     bool m_currentNavigationHasShownBeforeUnloadConfirmPanel;
454
455     bool m_loadsSynchronously;
456
457     SandboxFlags m_forcedSandboxFlags;
458
459     RefPtr<FrameNetworkingContext> m_networkingContext;
460
461     std::optional<ResourceRequestCachePolicy> m_overrideCachePolicyForTesting;
462     std::optional<ResourceLoadPriority> m_overrideResourceLoadPriorityForTesting;
463     bool m_isStrictRawResourceValidationPolicyDisabledForTesting { false };
464
465     URL m_previousURL;
466     RefPtr<HistoryItem> m_requestedHistoryItem;
467 };
468
469 // This function is called by createWindow() in JSDOMWindowBase.cpp, for example, for
470 // modal dialog creation.  The lookupFrame is for looking up the frame name in case
471 // the frame name references a frame different from the openerFrame, e.g. when it is
472 // "_self" or "_parent".
473 //
474 // FIXME: Consider making this function part of an appropriate class (not FrameLoader)
475 // and moving it to a more appropriate location.
476 RefPtr<Frame> createWindow(Frame& openerFrame, Frame& lookupFrame, FrameLoadRequest&&, const WindowFeatures&, bool& created);
477
478 } // namespace WebCore