Rename NavigationInitiatedByMainFrame to InitiatedByMainFrame
[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 "ResourceHandleTypes.h"
40 #include "ResourceLoadNotifier.h"
41 #include "ResourceLoaderOptions.h"
42 #include "ResourceRequestBase.h"
43 #include "SecurityContext.h"
44 #include "Timer.h"
45 #include <wtf/Forward.h>
46 #include <wtf/HashSet.h>
47 #include <wtf/OptionSet.h>
48 #include <wtf/Optional.h>
49
50 namespace WebCore {
51
52 class Archive;
53 class CachedFrame;
54 class CachedFrameBase;
55 class CachedPage;
56 class CachedResource;
57 class Chrome;
58 class DOMWrapperWorld;
59 class Document;
60 class DocumentLoader;
61 class Event;
62 class FormState;
63 class FormSubmission;
64 class FrameLoadRequest;
65 class FrameLoaderClient;
66 class FrameNetworkingContext;
67 class HistoryController;
68 class HistoryItem;
69 class IconController;
70 class NavigationAction;
71 class NetworkingContext;
72 class Page;
73 class PolicyChecker;
74 class ResourceError;
75 class ResourceRequest;
76 class ResourceResponse;
77 class SerializedScriptValue;
78 class SharedBuffer;
79 class SubframeLoader;
80 class SubstituteData;
81
82 struct WindowFeatures;
83
84 WEBCORE_EXPORT bool isBackForwardLoadType(FrameLoadType);
85 WEBCORE_EXPORT bool isReload(FrameLoadType);
86
87 class FrameLoader {
88     WTF_MAKE_NONCOPYABLE(FrameLoader);
89 public:
90     FrameLoader(Frame&, FrameLoaderClient&);
91     ~FrameLoader();
92
93     WEBCORE_EXPORT void init();
94 #if PLATFORM(IOS)
95     void initForSynthesizedDocument(const URL&);
96 #endif
97
98     Frame& frame() const { return m_frame; }
99
100     PolicyChecker& policyChecker() const { return *m_policyChecker; }
101     HistoryController& history() const { return *m_history; }
102     ResourceLoadNotifier& notifier() const { return m_notifier; }
103     SubframeLoader& subframeLoader() const { return *m_subframeLoader; }
104     IconController& icon() const { return *m_icon; }
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&, StoredCredentials, 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
136     // FIXME: These are all functions which stop loads. We have too many.
137     WEBCORE_EXPORT void stopAllLoaders(ClearProvisionalItemPolicy = ShouldClearProvisionalItem);
138     WEBCORE_EXPORT void stopForUserCancel(bool deferCheckLoadComplete = false);
139     void stop();
140     void stopLoading(UnloadEventPolicy);
141     bool closeURL();
142     void cancelAndClear();
143     // FIXME: clear() is trying to do too many things. We should break it down into smaller functions (ideally with fewer raw Boolean parameters).
144     void clear(Document* newDocument, bool clearWindowProperties = true, bool clearScriptObjects = true, bool clearFrameView = true);
145
146     bool isLoading() const;
147     WEBCORE_EXPORT bool frameHasLoaded() const;
148
149     WEBCORE_EXPORT int numPendingOrLoadingRequests(bool recurse) const;
150     String referrer() const;
151     WEBCORE_EXPORT String outgoingReferrer() const;
152     String outgoingOrigin() const;
153
154     WEBCORE_EXPORT DocumentLoader* activeDocumentLoader() const;
155     DocumentLoader* documentLoader() const { return m_documentLoader.get(); }
156     DocumentLoader* policyDocumentLoader() const { return m_policyDocumentLoader.get(); }
157     DocumentLoader* provisionalDocumentLoader() const { return m_provisionalDocumentLoader.get(); }
158     FrameState state() const { return m_state; }
159
160 #if PLATFORM(IOS)
161     RetainPtr<CFDictionaryRef> connectionProperties(ResourceLoader*);
162 #endif
163     const ResourceRequest& originalRequest() const;
164     const ResourceRequest& initialRequest() const;
165     void receivedMainResourceError(const ResourceError&);
166
167     bool willLoadMediaElementURL(URL&);
168
169     void handleFallbackContent();
170
171     WEBCORE_EXPORT ResourceError cancelledError(const ResourceRequest&) const;
172     WEBCORE_EXPORT ResourceError blockedByContentBlockerError(const ResourceRequest&) const;
173     ResourceError blockedError(const ResourceRequest&) const;
174 #if ENABLE(CONTENT_FILTERING)
175     ResourceError blockedByContentFilterError(const ResourceRequest&) const;
176 #endif
177
178     bool isHostedByObjectElement() const;
179
180     bool isReplacing() const;
181     void setReplacing();
182     bool subframeIsLoading() const;
183     void willChangeTitle(DocumentLoader*);
184     void didChangeTitle(DocumentLoader*);
185
186     bool shouldTreatURLAsSrcdocDocument(const URL&) const;
187
188     WEBCORE_EXPORT FrameLoadType loadType() const;
189
190     CachePolicy subresourceCachePolicy(const URL&) const;
191
192     void didReachLayoutMilestone(LayoutMilestones);
193     void didFirstLayout();
194
195     void loadedResourceFromMemoryCache(CachedResource*, ResourceRequest& newRequest);
196     void tellClientAboutPastMemoryCacheLoads();
197
198     void checkLoadComplete();
199     WEBCORE_EXPORT void detachFromParent();
200     void detachViewsAndDocumentLoader();
201
202     void addExtraFieldsToSubresourceRequest(ResourceRequest&);
203     void addExtraFieldsToMainResourceRequest(ResourceRequest&);
204     
205     static void addHTTPOriginIfNeeded(ResourceRequest&, const String& origin);
206     static void addHTTPUpgradeInsecureRequestsIfNeeded(ResourceRequest&);
207
208     FrameLoaderClient& client() const { return m_client; }
209
210     void setDefersLoading(bool);
211
212     void didExplicitOpen();
213
214     // Callbacks from DocumentWriter
215     void didBeginDocument(bool dispatchWindowObjectAvailable);
216
217     void receivedFirstData();
218
219     void dispatchOnloadEvents();
220     String userAgent(const URL&) const;
221
222     void dispatchDidClearWindowObjectInWorld(DOMWrapperWorld&);
223     void dispatchDidClearWindowObjectsInAllWorlds();
224
225     // The following sandbox flags will be forced, regardless of changes to
226     // the sandbox attribute of any parent frames.
227     void forceSandboxFlags(SandboxFlags flags) { m_forcedSandboxFlags |= flags; }
228     SandboxFlags effectiveSandboxFlags() const;
229
230     bool checkIfFormActionAllowedByCSP(const URL&, bool didReceiveRedirectResponse) const;
231
232     WEBCORE_EXPORT Frame* opener();
233     WEBCORE_EXPORT void setOpener(Frame*);
234
235     void resetMultipleFormSubmissionProtection();
236
237     void checkCallImplicitClose();
238
239     void frameDetached();
240
241     void setOutgoingReferrer(const URL&);
242
243     void loadDone();
244     void finishedParsing();
245     void checkCompleted();
246
247     WEBCORE_EXPORT bool isComplete() const;
248
249     void commitProvisionalLoad();
250
251     void setLoadsSynchronously(bool loadsSynchronously) { m_loadsSynchronously = loadsSynchronously; }
252     bool loadsSynchronously() const { return m_loadsSynchronously; }
253
254     FrameLoaderStateMachine& stateMachine() { return m_stateMachine; }
255
256     WEBCORE_EXPORT Frame* findFrameForNavigation(const AtomicString& name, Document* activeDocument = nullptr);
257
258     void applyUserAgent(ResourceRequest&);
259
260     bool shouldInterruptLoadForXFrameOptions(const String&, const URL&, unsigned long requestIdentifier);
261
262     void completed();
263     bool allAncestorsAreComplete() const; // including this
264     void clientRedirected(const URL&, double delay, double fireDate, LockBackForwardList);
265     void clientRedirectCancelledOrFinished(bool cancelWithLoadInProgress);
266
267     // FIXME: This is public because this asynchronous callback from the FrameLoaderClient
268     // uses the policy machinery (and therefore is called via the PolicyChecker).  Once we
269     // introduce a proper callback type for this function, we should make it private again.
270     void continueLoadAfterWillSubmitForm();
271
272     WEBCORE_EXPORT void setOriginalURLForDownloadRequest(ResourceRequest&);
273
274     bool quickRedirectComing() const { return m_quickRedirectComing; }
275
276     WEBCORE_EXPORT bool shouldClose();
277     
278     void started();
279
280     enum class PageDismissalType { None, BeforeUnload, PageHide, Unload };
281     PageDismissalType pageDismissalEventBeingDispatched() const { return m_pageDismissalEventBeingDispatched; }
282
283     WEBCORE_EXPORT NetworkingContext* networkingContext() const;
284
285     void loadProgressingStatusChanged();
286
287     const URL& previousURL() const { return m_previousURL; }
288
289     void forcePageTransitionIfNeeded();
290
291     void setOverrideCachePolicyForTesting(ResourceRequestCachePolicy policy) { m_overrideCachePolicyForTesting = policy; }
292     void setOverrideResourceLoadPriorityForTesting(ResourceLoadPriority priority) { m_overrideResourceLoadPriorityForTesting = priority; }
293     void setStrictRawResourceValidationPolicyDisabledForTesting(bool disabled) { m_isStrictRawResourceValidationPolicyDisabledForTesting = disabled; }
294     bool isStrictRawResourceValidationPolicyDisabledForTesting() { return m_isStrictRawResourceValidationPolicyDisabledForTesting; }
295
296     WEBCORE_EXPORT void clearTestingOverrides();
297
298     const URL& provisionalLoadErrorBeingHandledURL() const { return m_provisionalLoadErrorBeingHandledURL; }
299     void setProvisionalLoadErrorBeingHandledURL(const URL& url) { m_provisionalLoadErrorBeingHandledURL = url; }
300
301     bool isAlwaysOnLoggingAllowed() const;
302     bool shouldSuppressKeyboardInput() const;
303
304 private:
305     enum FormSubmissionCacheLoadPolicy {
306         MayAttemptCacheOnlyLoadForFormSubmissionItem,
307         MayNotAttemptCacheOnlyLoadForFormSubmissionItem
308     };
309
310     bool allChildrenAreComplete() const; // immediate children, not all descendants
311
312     void checkTimerFired();
313
314     void loadSameDocumentItem(HistoryItem&);
315     void loadDifferentDocumentItem(HistoryItem&, FrameLoadType, FormSubmissionCacheLoadPolicy);
316
317     void loadProvisionalItemFromCachedPage();
318
319     void updateFirstPartyForCookies();
320     void setFirstPartyForCookies(const URL&);
321
322     void addExtraFieldsToRequest(ResourceRequest&, FrameLoadType, bool isMainResource);
323     ResourceRequestCachePolicy defaultRequestCachingPolicy(const ResourceRequest&, FrameLoadType, bool isMainResource);
324
325     void clearProvisionalLoad();
326     void transitionToCommitted(CachedPage*);
327     void frameLoadCompleted();
328
329     SubstituteData defaultSubstituteDataForURL(const URL&);
330
331     bool dispatchBeforeUnloadEvent(Chrome&, FrameLoader* frameLoaderBeingNavigated);
332     void dispatchUnloadEvents(UnloadEventPolicy);
333
334     void continueLoadAfterNavigationPolicy(const ResourceRequest&, FormState*, bool shouldContinue, AllowNavigationToInvalidURL);
335     void continueLoadAfterNewWindowPolicy(const ResourceRequest&, FormState*, const String& frameName, const NavigationAction&, bool shouldContinue, AllowNavigationToInvalidURL, NewFrameOpenerPolicy);
336     void continueFragmentScrollAfterNavigationPolicy(const ResourceRequest&, bool shouldContinue);
337
338     bool shouldPerformFragmentNavigation(bool isFormSubmission, const String& httpMethod, FrameLoadType, const URL&);
339     void scrollToFragmentWithParentBoundary(const URL&, bool isNewNavigation = true);
340
341     void checkLoadCompleteForThisFrame();
342
343     void setDocumentLoader(DocumentLoader*);
344     void setPolicyDocumentLoader(DocumentLoader*);
345     void setProvisionalDocumentLoader(DocumentLoader*);
346
347     void setState(FrameState);
348
349     void closeOldDataSources();
350     void willRestoreFromCachedPage();
351
352     bool shouldReloadToHandleUnreachableURL(DocumentLoader*);
353
354     void dispatchDidCommitLoad(std::optional<HasInsecureContent> initialHasInsecureContent);
355
356     void urlSelected(FrameLoadRequest&&, Event*);
357
358     void loadWithDocumentLoader(DocumentLoader*, FrameLoadType, FormState*, AllowNavigationToInvalidURL); // Calls continueLoadAfterNavigationPolicy
359     void load(DocumentLoader*); // Calls loadWithDocumentLoader
360
361     void loadWithNavigationAction(const ResourceRequest&, const NavigationAction&, LockHistory, FrameLoadType, FormState*, AllowNavigationToInvalidURL, InitiatedByMainFrame); // Calls loadWithDocumentLoader
362
363     void loadPostRequest(FrameLoadRequest&&, const String& referrer, FrameLoadType, Event*, FormState*);
364     void loadURL(FrameLoadRequest&&, const String& referrer, FrameLoadType, Event*, FormState*);
365
366     bool shouldReload(const URL& currentURL, const URL& destinationURL);
367
368     void requestFromDelegate(ResourceRequest&, unsigned long& identifier, ResourceError&);
369
370     WEBCORE_EXPORT void detachChildren();
371     void closeAndRemoveChild(Frame&);
372
373     void loadInSameDocument(const URL&, SerializedScriptValue* stateObject, bool isNewNavigation);
374
375     void prepareForLoadStart();
376     void provisionalLoadStarted();
377
378     void willTransitionToCommitted();
379     bool didOpenURL();
380
381     void scheduleCheckCompleted();
382     void scheduleCheckLoadComplete();
383     void startCheckCompleteTimer();
384
385     bool shouldTreatURLAsSameAsCurrent(const URL&) const;
386
387     void dispatchGlobalObjectAvailableInAllWorlds();
388
389     bool isNavigationAllowed() const;
390
391     Frame& m_frame;
392     FrameLoaderClient& m_client;
393
394     const std::unique_ptr<PolicyChecker> m_policyChecker;
395     const std::unique_ptr<HistoryController> m_history;
396     mutable ResourceLoadNotifier m_notifier;
397     const std::unique_ptr<SubframeLoader> m_subframeLoader;
398     mutable FrameLoaderStateMachine m_stateMachine;
399     const std::unique_ptr<IconController> m_icon;
400     mutable MixedContentChecker m_mixedContentChecker;
401
402     class FrameProgressTracker;
403     std::unique_ptr<FrameProgressTracker> m_progressTracker;
404
405     FrameState m_state;
406     FrameLoadType m_loadType;
407
408     // Document loaders for the three phases of frame loading. Note that while 
409     // a new request is being loaded, the old document loader may still be referenced.
410     // E.g. while a new request is in the "policy" state, the old document loader may
411     // be consulted in particular as it makes sense to imply certain settings on the new loader.
412     RefPtr<DocumentLoader> m_documentLoader;
413     RefPtr<DocumentLoader> m_provisionalDocumentLoader;
414     RefPtr<DocumentLoader> m_policyDocumentLoader;
415
416     URL m_provisionalLoadErrorBeingHandledURL;
417
418     bool m_quickRedirectComing;
419     bool m_sentRedirectNotification;
420     bool m_inStopAllLoaders;
421
422     String m_outgoingReferrer;
423
424     bool m_isExecutingJavaScriptFormAction;
425
426     bool m_didCallImplicitClose;
427     bool m_wasUnloadEventEmitted;
428
429     PageDismissalType m_pageDismissalEventBeingDispatched { PageDismissalType::None };
430     bool m_isComplete;
431
432     RefPtr<SerializedScriptValue> m_pendingStateObject;
433
434     bool m_needsClear;
435
436     URL m_submittedFormURL;
437
438     Timer m_checkTimer;
439     bool m_shouldCallCheckCompleted;
440     bool m_shouldCallCheckLoadComplete;
441
442     Frame* m_opener;
443     HashSet<Frame*> m_openedFrames;
444
445     bool m_loadingFromCachedPage;
446
447     bool m_currentNavigationHasShownBeforeUnloadConfirmPanel;
448
449     bool m_loadsSynchronously;
450
451     SandboxFlags m_forcedSandboxFlags;
452
453     RefPtr<FrameNetworkingContext> m_networkingContext;
454
455     std::optional<ResourceRequestCachePolicy> m_overrideCachePolicyForTesting;
456     std::optional<ResourceLoadPriority> m_overrideResourceLoadPriorityForTesting;
457     bool m_isStrictRawResourceValidationPolicyDisabledForTesting { false };
458
459     URL m_previousURL;
460     RefPtr<HistoryItem> m_requestedHistoryItem;
461 };
462
463 // This function is called by createWindow() in JSDOMWindowBase.cpp, for example, for
464 // modal dialog creation.  The lookupFrame is for looking up the frame name in case
465 // the frame name references a frame different from the openerFrame, e.g. when it is
466 // "_self" or "_parent".
467 //
468 // FIXME: Consider making this function part of an appropriate class (not FrameLoader)
469 // and moving it to a more appropriate location.
470 RefPtr<Frame> createWindow(Frame& openerFrame, Frame& lookupFrame, FrameLoadRequest&&, const WindowFeatures&, bool& created);
471
472 } // namespace WebCore