Expand r209943 to suppress paste during provisional navigation as well
[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
51 namespace WebCore {
52
53 class Archive;
54 class CachedFrame;
55 class CachedFrameBase;
56 class CachedPage;
57 class CachedResource;
58 class Chrome;
59 class DOMWrapperWorld;
60 class Document;
61 class DocumentLoader;
62 class Event;
63 class FormState;
64 class FormSubmission;
65 class FrameLoadRequest;
66 class FrameLoaderClient;
67 class FrameNetworkingContext;
68 class HistoryController;
69 class HistoryItem;
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 using ContentPolicyDecisionFunction = WTF::Function<void(PolicyAction)>;
88
89 class FrameLoader {
90     WTF_MAKE_NONCOPYABLE(FrameLoader);
91 public:
92     FrameLoader(Frame&, FrameLoaderClient&);
93     ~FrameLoader();
94
95     WEBCORE_EXPORT void init();
96 #if PLATFORM(IOS)
97     void initForSynthesizedDocument(const URL&);
98 #endif
99
100     Frame& frame() const { return m_frame; }
101
102     PolicyChecker& policyChecker() const { return *m_policyChecker; }
103     HistoryController& history() const { return *m_history; }
104     ResourceLoadNotifier& notifier() const { return m_notifier; }
105     SubframeLoader& subframeLoader() const { return *m_subframeLoader; }
106     MixedContentChecker& mixedContentChecker() const { return m_mixedContentChecker; }
107
108     void setupForReplace();
109
110     // FIXME: These are all functions which start loads. We have too many.
111     WEBCORE_EXPORT void loadURLIntoChildFrame(const URL&, const String& referer, Frame*);
112     WEBCORE_EXPORT void loadFrameRequest(FrameLoadRequest&&, Event*, FormState*); // Called by submitForm, calls loadPostRequest and loadURL.
113
114     WEBCORE_EXPORT void load(FrameLoadRequest&&);
115
116 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
117     WEBCORE_EXPORT void loadArchive(Ref<Archive>&&);
118 #endif
119     unsigned long loadResourceSynchronously(const ResourceRequest&, StoredCredentialsPolicy, ClientCredentialPolicy, ResourceError&, ResourceResponse&, RefPtr<SharedBuffer>& data);
120
121     void changeLocation(FrameLoadRequest&&);
122     WEBCORE_EXPORT void urlSelected(const URL&, const String& target, Event*, LockHistory, LockBackForwardList, ShouldSendReferrer, ShouldOpenExternalURLsPolicy, std::optional<NewFrameOpenerPolicy> = std::nullopt, const AtomicString& downloadAttribute = nullAtom());
123     void submitForm(Ref<FormSubmission>&&);
124
125     WEBCORE_EXPORT void reload(OptionSet<ReloadOption> = { });
126     WEBCORE_EXPORT void reloadWithOverrideEncoding(const String& overrideEncoding);
127
128     void open(CachedFrameBase&);
129     void loadItem(HistoryItem&, FrameLoadType);
130     HistoryItem* requestedHistoryItem() const { return m_requestedHistoryItem.get(); }
131
132     void retryAfterFailedCacheOnlyMainResourceLoad();
133
134     static void reportLocalLoadFailed(Frame*, const String& url);
135     static void reportBlockedPortFailed(Frame*, const String& url);
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     // FIXME: clear() is trying to do too many things. We should break it down into smaller functions (ideally with fewer raw Boolean parameters).
145     void clear(Document* newDocument, bool clearWindowProperties = true, bool clearScriptObjects = true, bool clearFrameView = true);
146
147     bool isLoading() const;
148     WEBCORE_EXPORT bool frameHasLoaded() const;
149
150     WEBCORE_EXPORT int numPendingOrLoadingRequests(bool recurse) const;
151
152     ReferrerPolicy effectiveReferrerPolicy() const;
153     String referrer() const;
154     WEBCORE_EXPORT String outgoingReferrer() const;
155     String outgoingOrigin() const;
156
157     WEBCORE_EXPORT DocumentLoader* activeDocumentLoader() const;
158     DocumentLoader* documentLoader() const { return m_documentLoader.get(); }
159     DocumentLoader* policyDocumentLoader() const { return m_policyDocumentLoader.get(); }
160     DocumentLoader* provisionalDocumentLoader() const { return m_provisionalDocumentLoader.get(); }
161     FrameState state() const { return m_state; }
162
163 #if PLATFORM(IOS)
164     RetainPtr<CFDictionaryRef> connectionProperties(ResourceLoader*);
165 #endif
166     const ResourceRequest& originalRequest() const;
167     const ResourceRequest& initialRequest() const;
168     void receivedMainResourceError(const ResourceError&);
169
170     bool willLoadMediaElementURL(URL&);
171
172     void handleFallbackContent();
173
174     WEBCORE_EXPORT ResourceError cancelledError(const ResourceRequest&) const;
175     WEBCORE_EXPORT ResourceError blockedByContentBlockerError(const ResourceRequest&) const;
176     ResourceError blockedError(const ResourceRequest&) const;
177 #if ENABLE(CONTENT_FILTERING)
178     ResourceError blockedByContentFilterError(const ResourceRequest&) const;
179 #endif
180
181     bool isHostedByObjectElement() const;
182
183     bool isReplacing() const;
184     void setReplacing();
185     bool subframeIsLoading() const;
186     void willChangeTitle(DocumentLoader*);
187     void didChangeTitle(DocumentLoader*);
188
189     bool shouldTreatURLAsSrcdocDocument(const URL&) const;
190
191     WEBCORE_EXPORT FrameLoadType loadType() const;
192
193     CachePolicy subresourceCachePolicy(const URL&) const;
194
195     void didReachLayoutMilestone(LayoutMilestones);
196     void didFirstLayout();
197
198     void loadedResourceFromMemoryCache(CachedResource&, ResourceRequest& newRequest, ResourceError&);
199     void tellClientAboutPastMemoryCacheLoads();
200
201     void checkLoadComplete();
202     WEBCORE_EXPORT void detachFromParent();
203     void detachViewsAndDocumentLoader();
204
205     void addExtraFieldsToSubresourceRequest(ResourceRequest&);
206     void addExtraFieldsToMainResourceRequest(ResourceRequest&);
207     
208     static void addHTTPOriginIfNeeded(ResourceRequest&, const String& origin);
209     static void addHTTPUpgradeInsecureRequestsIfNeeded(ResourceRequest&);
210
211     FrameLoaderClient& client() const { return m_client; }
212
213     void setDefersLoading(bool);
214
215     void checkContentPolicy(const ResourceResponse&, ContentPolicyDecisionFunction&&);
216
217     void didExplicitOpen();
218
219     // Callbacks from DocumentWriter
220     void didBeginDocument(bool dispatchWindowObjectAvailable);
221
222     void receivedFirstData();
223
224     void dispatchOnloadEvents();
225     String userAgent(const URL&) const;
226
227     void dispatchDidClearWindowObjectInWorld(DOMWrapperWorld&);
228     void dispatchDidClearWindowObjectsInAllWorlds();
229
230     // The following sandbox flags will be forced, regardless of changes to
231     // the sandbox attribute of any parent frames.
232     void forceSandboxFlags(SandboxFlags flags) { m_forcedSandboxFlags |= flags; }
233     SandboxFlags effectiveSandboxFlags() const;
234
235     bool checkIfFormActionAllowedByCSP(const URL&, bool didReceiveRedirectResponse) const;
236
237     WEBCORE_EXPORT Frame* opener();
238     WEBCORE_EXPORT void setOpener(Frame*);
239
240     void resetMultipleFormSubmissionProtection();
241
242     void checkCallImplicitClose();
243
244     void frameDetached();
245
246     void setOutgoingReferrer(const URL&);
247
248     void loadDone();
249     void finishedParsing();
250     void checkCompleted();
251
252     WEBCORE_EXPORT bool isComplete() const;
253
254     void commitProvisionalLoad();
255
256     void setLoadsSynchronously(bool loadsSynchronously) { m_loadsSynchronously = loadsSynchronously; }
257     bool loadsSynchronously() const { return m_loadsSynchronously; }
258
259     FrameLoaderStateMachine& stateMachine() { return m_stateMachine; }
260
261     WEBCORE_EXPORT Frame* findFrameForNavigation(const AtomicString& name, Document* activeDocument = nullptr);
262
263     void applyUserAgent(ResourceRequest&);
264
265     bool shouldInterruptLoadForXFrameOptions(const String&, const URL&, unsigned long requestIdentifier);
266
267     void completed();
268     bool allAncestorsAreComplete() const; // including this
269     void clientRedirected(const URL&, double delay, double fireDate, LockBackForwardList);
270     void clientRedirectCancelledOrFinished(bool cancelWithLoadInProgress);
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 shouldSuppressTextInputFromEditing() 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); // 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     mutable MixedContentChecker m_mixedContentChecker;
400
401     class FrameProgressTracker;
402     std::unique_ptr<FrameProgressTracker> m_progressTracker;
403
404     FrameState m_state;
405     FrameLoadType m_loadType;
406
407     // Document loaders for the three phases of frame loading. Note that while 
408     // a new request is being loaded, the old document loader may still be referenced.
409     // E.g. while a new request is in the "policy" state, the old document loader may
410     // be consulted in particular as it makes sense to imply certain settings on the new loader.
411     RefPtr<DocumentLoader> m_documentLoader;
412     RefPtr<DocumentLoader> m_provisionalDocumentLoader;
413     RefPtr<DocumentLoader> m_policyDocumentLoader;
414
415     URL m_provisionalLoadErrorBeingHandledURL;
416
417     bool m_quickRedirectComing;
418     bool m_sentRedirectNotification;
419     bool m_inStopAllLoaders;
420
421     String m_outgoingReferrer;
422
423     bool m_isExecutingJavaScriptFormAction;
424
425     bool m_didCallImplicitClose;
426     bool m_wasUnloadEventEmitted;
427
428     PageDismissalType m_pageDismissalEventBeingDispatched { PageDismissalType::None };
429     bool m_isComplete;
430
431     RefPtr<SerializedScriptValue> m_pendingStateObject;
432
433     bool m_needsClear;
434
435     URL m_submittedFormURL;
436
437     Timer m_checkTimer;
438     bool m_shouldCallCheckCompleted;
439     bool m_shouldCallCheckLoadComplete;
440
441     Frame* m_opener;
442     HashSet<Frame*> m_openedFrames;
443
444     bool m_loadingFromCachedPage;
445
446     bool m_currentNavigationHasShownBeforeUnloadConfirmPanel;
447
448     bool m_loadsSynchronously;
449
450     SandboxFlags m_forcedSandboxFlags;
451
452     RefPtr<FrameNetworkingContext> m_networkingContext;
453
454     std::optional<ResourceRequestCachePolicy> m_overrideCachePolicyForTesting;
455     std::optional<ResourceLoadPriority> m_overrideResourceLoadPriorityForTesting;
456     bool m_isStrictRawResourceValidationPolicyDisabledForTesting { false };
457
458     URL m_previousURL;
459     RefPtr<HistoryItem> m_requestedHistoryItem;
460 };
461
462 // This function is called by createWindow() in JSDOMWindowBase.cpp, for example, for
463 // modal dialog creation.  The lookupFrame is for looking up the frame name in case
464 // the frame name references a frame different from the openerFrame, e.g. when it is
465 // "_self" or "_parent".
466 //
467 // FIXME: Consider making this function part of an appropriate class (not FrameLoader)
468 // and moving it to a more appropriate location.
469 RefPtr<Frame> createWindow(Frame& openerFrame, Frame& lookupFrame, FrameLoadRequest&&, const WindowFeatures&, bool& created);
470
471 } // namespace WebCore