/* * Copyright (C) 2006, 2007, 2008, 2009 Apple Inc. All rights reserved. * Copyright (C) 2008 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/) * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of * its contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ #ifndef FrameLoader_h #define FrameLoader_h #include "CachePolicy.h" #include "FrameLoaderTypes.h" #include "ResourceRequest.h" #include "ThreadableLoader.h" #include "Timer.h" namespace WebCore { class Archive; class AuthenticationChallenge; class CachedFrame; class CachedPage; class CachedResource; class Document; class DocumentLoader; class Event; class FormData; class FormState; class Frame; class FrameLoaderClient; class HistoryItem; class HTMLAppletElement; class HTMLFormElement; class HTMLFrameOwnerElement; class IconLoader; class IntSize; class NavigationAction; class RenderPart; class ResourceError; class ResourceLoader; class ResourceResponse; class ScriptSourceCode; class ScriptString; class ScriptValue; class SecurityOrigin; class SharedBuffer; class SubstituteData; class TextResourceDecoder; class Widget; struct FrameLoadRequest; struct ScheduledRedirection; struct WindowFeatures; bool isBackForwardLoadType(FrameLoadType); typedef void (*NavigationPolicyDecisionFunction)(void* argument, const ResourceRequest&, PassRefPtr, bool shouldContinue); typedef void (*NewWindowPolicyDecisionFunction)(void* argument, const ResourceRequest&, PassRefPtr, const String& frameName, bool shouldContinue); typedef void (*ContentPolicyDecisionFunction)(void* argument, PolicyAction); class PolicyCheck { public: PolicyCheck(); void clear(); void set(const ResourceRequest&, PassRefPtr, NavigationPolicyDecisionFunction, void* argument); void set(const ResourceRequest&, PassRefPtr, const String& frameName, NewWindowPolicyDecisionFunction, void* argument); void set(ContentPolicyDecisionFunction, void* argument); const ResourceRequest& request() const { return m_request; } void clearRequest(); void call(bool shouldContinue); void call(PolicyAction); void cancel(); private: ResourceRequest m_request; RefPtr m_formState; String m_frameName; NavigationPolicyDecisionFunction m_navigationFunction; NewWindowPolicyDecisionFunction m_newWindowFunction; ContentPolicyDecisionFunction m_contentFunction; void* m_argument; }; class FrameLoader : Noncopyable { public: FrameLoader(Frame*, FrameLoaderClient*); ~FrameLoader(); void init(); Frame* frame() const { return m_frame; } // FIXME: This is not cool, people. There are too many different functions that all start loads. // We should aim to consolidate these into a smaller set of functions, and try to reuse more of // the logic by extracting common code paths. void prepareForLoadStart(); void setupForReplace(); void setupForReplaceByMIMEType(const String& newMIMEType); void loadURLIntoChildFrame(const KURL&, const String& referer, Frame*); void loadFrameRequest(const FrameLoadRequest&, bool lockHistory, bool lockBackForwardList, // Called by submitForm, calls loadPostRequest and loadURL. PassRefPtr, PassRefPtr); void load(const ResourceRequest&, bool lockHistory); // Called by WebFrame, calls load(ResourceRequest, SubstituteData). void load(const ResourceRequest&, const SubstituteData&, bool lockHistory); // Called both by WebFrame and internally, calls load(DocumentLoader*). void load(const ResourceRequest&, const String& frameName, bool lockHistory); // Called by WebPluginController. void loadArchive(PassRefPtr); // Returns true for any non-local URL. If document parameter is supplied, its local load policy dictates, // otherwise if referrer is non-empty and represents a local file, then the local load is allowed. static bool canLoad(const KURL&, const String& referrer, const Document*); static bool canLoad(const KURL&, const String& referrer, const SecurityOrigin* = 0); static void reportLocalLoadFailed(Frame*, const String& url); static bool shouldHideReferrer(const KURL&, const String& referrer); // Called by createWindow in JSDOMWindowBase.cpp, e.g. to fulfill a modal dialog creation Frame* createWindow(FrameLoader* frameLoaderForFrameLookup, const FrameLoadRequest&, const WindowFeatures&, bool& created); unsigned long loadResourceSynchronously(const ResourceRequest&, StoredCredentials, ResourceError&, ResourceResponse&, Vector& data); bool canHandleRequest(const ResourceRequest&); // Also not cool. void stopAllLoaders(DatabasePolicy = DatabasePolicyStop); void stopForUserCancel(bool deferCheckLoadComplete = false); bool isLoadingMainResource() const { return m_isLoadingMainResource; } bool isLoading() const; bool frameHasLoaded() const; int numPendingOrLoadingRequests(bool recurse) const; String referrer() const; String outgoingReferrer() const; String outgoingOrigin() const; DocumentLoader* activeDocumentLoader() const; DocumentLoader* documentLoader() const { return m_documentLoader.get(); } DocumentLoader* policyDocumentLoader() const { return m_policyDocumentLoader.get(); } DocumentLoader* provisionalDocumentLoader() const { return m_provisionalDocumentLoader.get(); } FrameState state() const { return m_state; } static double timeOfLastCompletedLoad(); bool shouldUseCredentialStorage(ResourceLoader*); void didReceiveAuthenticationChallenge(ResourceLoader*, const AuthenticationChallenge&); void didCancelAuthenticationChallenge(ResourceLoader*, const AuthenticationChallenge&); void assignIdentifierToInitialRequest(unsigned long identifier, const ResourceRequest&); void willSendRequest(ResourceLoader*, ResourceRequest&, const ResourceResponse& redirectResponse); void didReceiveResponse(ResourceLoader*, const ResourceResponse&); void didReceiveData(ResourceLoader*, const char*, int, int lengthReceived); void didFinishLoad(ResourceLoader*); void didFailToLoad(ResourceLoader*, const ResourceError&); void didLoadResourceByXMLHttpRequest(unsigned long identifier, const ScriptString& sourceString); const ResourceRequest& originalRequest() const; const ResourceRequest& initialRequest() const; void receivedMainResourceError(const ResourceError&, bool isComplete); void receivedData(const char*, int); void handleFallbackContent(); bool isStopping() const; void finishedLoading(); ResourceError cancelledError(const ResourceRequest&) const; ResourceError fileDoesNotExistError(const ResourceResponse&) const; ResourceError blockedError(const ResourceRequest&) const; ResourceError cannotShowURLError(const ResourceRequest&) const; void cannotShowMIMEType(const ResourceResponse&); ResourceError interruptionForPolicyChangeError(const ResourceRequest&); bool isHostedByObjectElement() const; bool isLoadingMainFrame() const; bool canShowMIMEType(const String& MIMEType) const; bool representationExistsForURLScheme(const String& URLScheme); String generatedMIMETypeForURLScheme(const String& URLScheme); void checkNavigationPolicy(const ResourceRequest&, NavigationPolicyDecisionFunction function, void* argument); void checkContentPolicy(const String& MIMEType, ContentPolicyDecisionFunction, void* argument); void cancelContentPolicyCheck(); void reload(bool endToEndReload = false); void reloadWithOverrideEncoding(const String& overrideEncoding); void didReceiveServerRedirectForProvisionalLoadForFrame(); void finishedLoadingDocument(DocumentLoader*); void committedLoad(DocumentLoader*, const char*, int); bool isReplacing() const; void setReplacing(); void revertToProvisional(DocumentLoader*); void setMainDocumentError(DocumentLoader*, const ResourceError&); void mainReceivedCompleteError(DocumentLoader*, const ResourceError&); bool subframeIsLoading() const; void willChangeTitle(DocumentLoader*); void didChangeTitle(DocumentLoader*); FrameLoadType loadType() const; CachePolicy subresourceCachePolicy() const; void didFirstLayout(); bool firstLayoutDone() const; void didFirstVisuallyNonEmptyLayout(); #if ENABLE(WML) void setForceReloadWmlDeck(bool); #endif void loadedResourceFromMemoryCache(const CachedResource*); void tellClientAboutPastMemoryCacheLoads(); void checkLoadComplete(); void detachFromParent(); void addExtraFieldsToSubresourceRequest(ResourceRequest&); void addExtraFieldsToMainResourceRequest(ResourceRequest&); static void addHTTPOriginIfNeeded(ResourceRequest&, String origin); FrameLoaderClient* client() const { return m_client; } void setDefersLoading(bool); void changeLocation(const KURL&, const String& referrer, bool lockHistory = true, bool lockBackForwardList = true, bool userGesture = false, bool refresh = false); void urlSelected(const ResourceRequest&, const String& target, PassRefPtr, bool lockHistory, bool lockBackForwardList, bool userGesture); bool requestFrame(HTMLFrameOwnerElement*, const String& url, const AtomicString& frameName); void submitForm(const char* action, const String& url, PassRefPtr, const String& target, const String& contentType, const String& boundary, bool lockHistory, PassRefPtr, PassRefPtr); void stop(); void stopLoading(bool sendUnload, DatabasePolicy = DatabasePolicyStop); bool closeURL(); void didExplicitOpen(); KURL iconURL(); void commitIconURLToIconDatabase(const KURL&); KURL baseURL() const; bool isScheduledLocationChangePending() const { return m_scheduledRedirection && isLocationChange(*m_scheduledRedirection); } void scheduleHTTPRedirection(double delay, const String& url); void scheduleLocationChange(const String& url, const String& referrer, bool lockHistory = true, bool lockBackForwardList = true, bool userGesture = false); void scheduleRefresh(bool userGesture = false); void scheduleHistoryNavigation(int steps); bool canGoBackOrForward(int distance) const; void goBackOrForward(int distance); int getHistoryLength(); void begin(); void begin(const KURL&, bool dispatchWindowObjectAvailable = true, SecurityOrigin* forcedSecurityOrigin = 0); void write(const char* string, int length = -1, bool flush = false); void write(const String&); void end(); void endIfNotLoadingMainResource(); void setEncoding(const String& encoding, bool userChosen); String encoding() const; ScriptValue executeScript(const ScriptSourceCode&); ScriptValue executeScript(const String& script, bool forceUserGesture = false); void gotoAnchor(); void tokenizerProcessedData(); void handledOnloadEvents(); String userAgent(const KURL&) const; PassRefPtr createJavaAppletWidget(const IntSize&, HTMLAppletElement*, const HashMap& args); void dispatchWindowObjectAvailable(); void dispatchDocumentElementAvailable(); void restoreDocumentState(); Frame* opener(); void setOpener(Frame*); bool openedByDOM() const; void setOpenedByDOM(); bool isProcessingUserGesture(); void resetMultipleFormSubmissionProtection(); void addData(const char* bytes, int length); void checkCallImplicitClose(); void frameDetached(); const KURL& url() const { return m_URL; } void setResponseMIMEType(const String&); const String& responseMIMEType() const; bool containsPlugins() const; void loadDone(); void finishedParsing(); void checkCompleted(); bool isComplete() const; bool requestObject(RenderPart* frame, const String& url, const AtomicString& frameName, const String& serviceType, const Vector& paramNames, const Vector& paramValues); KURL completeURL(const String& url); void cancelAndClear(); void setTitle(const String&); void commitProvisionalLoad(PassRefPtr); void goToItem(HistoryItem*, FrameLoadType); void saveDocumentAndScrollState(); HistoryItem* currentHistoryItem(); void setCurrentHistoryItem(PassRefPtr); enum LocalLoadPolicy { AllowLocalLoadsForAll, // No restriction on local loads. AllowLocalLoadsForLocalAndSubstituteData, AllowLocalLoadsForLocalOnly, }; static void setLocalLoadPolicy(LocalLoadPolicy); static bool restrictAccessToLocal(); static bool allowSubstituteDataAccessToLocal(); bool committingFirstRealLoad() const { return !m_creatingInitialEmptyDocument && !m_committedFirstRealDocumentLoad; } void iconLoadDecisionAvailable(); bool shouldAllowNavigation(Frame* targetFrame) const; Frame* findFrameForNavigation(const AtomicString& name); void startIconLoader(); void applyUserAgent(ResourceRequest& request); bool shouldInterruptLoadForXFrameOptions(const String&, const KURL&); private: PassRefPtr createHistoryItem(bool useOriginal); PassRefPtr createHistoryItemTree(Frame* targetFrame, bool clipAtTarget); bool canCachePageContainingThisFrame(); #ifndef NDEBUG void logCanCachePageDecision(); bool logCanCacheFrameDecision(int indentLevel); #endif void addBackForwardItemClippedAtTarget(bool doClip); void restoreScrollPositionAndViewState(); void saveDocumentState(); void loadItem(HistoryItem*, FrameLoadType); bool urlsMatchItem(HistoryItem*) const; void invalidateCurrentItemCachedPage(); void recursiveGoToItem(HistoryItem*, HistoryItem*, FrameLoadType); bool childFramesMatchItem(HistoryItem*) const; void updateHistoryForBackForwardNavigation(); void updateHistoryForReload(); void updateHistoryForStandardLoad(); void updateHistoryForRedirectWithLockedBackForwardList(); void updateHistoryForClientRedirect(); void updateHistoryForCommit(); void updateHistoryForAnchorScroll(); void redirectionTimerFired(Timer*); void checkCompletedTimerFired(Timer*); void checkLoadCompleteTimerFired(Timer*); void cancelRedirection(bool newLoadInProgress = false); void started(); void completed(); void parentCompleted(); bool shouldUsePlugin(const KURL&, const String& mimeType, bool hasFallback, bool& useFallback); bool loadPlugin(RenderPart*, const KURL&, const String& mimeType, const Vector& paramNames, const Vector& paramValues, bool useFallback); bool loadProvisionalItemFromCachedPage(); void cachePageForHistoryItem(HistoryItem*); void receivedFirstData(); void updateFirstPartyForCookies(); void setFirstPartyForCookies(const KURL&); void addExtraFieldsToRequest(ResourceRequest&, FrameLoadType loadType, bool isMainResource, bool cookiePolicyURLFromRequest); // Also not cool. void stopLoadingSubframes(); void clearProvisionalLoad(); void markLoadComplete(); void transitionToCommitted(PassRefPtr); void frameLoadCompleted(); void mainReceivedError(const ResourceError&, bool isComplete); void setLoadType(FrameLoadType); void checkNavigationPolicy(const ResourceRequest&, DocumentLoader*, PassRefPtr, NavigationPolicyDecisionFunction, void* argument); void checkNewWindowPolicy(const NavigationAction&, const ResourceRequest&, PassRefPtr, const String& frameName); void continueAfterNavigationPolicy(PolicyAction); void continueAfterNewWindowPolicy(PolicyAction); void continueAfterContentPolicy(PolicyAction); void continueLoadAfterWillSubmitForm(PolicyAction = PolicyUse); static void callContinueLoadAfterNavigationPolicy(void*, const ResourceRequest&, PassRefPtr, bool shouldContinue); void continueLoadAfterNavigationPolicy(const ResourceRequest&, PassRefPtr, bool shouldContinue); static void callContinueLoadAfterNewWindowPolicy(void*, const ResourceRequest&, PassRefPtr, const String& frameName, bool shouldContinue); void continueLoadAfterNewWindowPolicy(const ResourceRequest&, PassRefPtr, const String& frameName, bool shouldContinue); static void callContinueFragmentScrollAfterNavigationPolicy(void*, const ResourceRequest&, PassRefPtr, bool shouldContinue); void continueFragmentScrollAfterNavigationPolicy(const ResourceRequest&, bool shouldContinue); bool shouldScrollToAnchor(bool isFormSubmission, FrameLoadType, const KURL&); void addHistoryItemForFragmentScroll(); void stopPolicyCheck(); void checkLoadCompleteForThisFrame(); void setDocumentLoader(DocumentLoader*); void setPolicyDocumentLoader(DocumentLoader*); void setProvisionalDocumentLoader(DocumentLoader*); void setState(FrameState); void closeOldDataSources(); void open(CachedPage&); void open(CachedFrame&); void updateHistoryAfterClientRedirect(); void clear(bool clearWindowProperties = true, bool clearScriptObjects = true); bool shouldReloadToHandleUnreachableURL(DocumentLoader*); void handleUnimplementablePolicy(const ResourceError&); void scheduleRedirection(ScheduledRedirection*); void startRedirectionTimer(); void stopRedirectionTimer(); void dispatchDidCommitLoad(); void dispatchAssignIdentifierToInitialRequest(unsigned long identifier, DocumentLoader*, const ResourceRequest&); void dispatchWillSendRequest(DocumentLoader*, unsigned long identifier, ResourceRequest&, const ResourceResponse& redirectResponse); void dispatchDidReceiveResponse(DocumentLoader*, unsigned long identifier, const ResourceResponse&); void dispatchDidReceiveContentLength(DocumentLoader*, unsigned long identifier, int length); void dispatchDidFinishLoading(DocumentLoader*, unsigned long identifier); static bool isLocationChange(const ScheduledRedirection&); void scheduleFormSubmission(const FrameLoadRequest&, bool lockHistory, PassRefPtr, PassRefPtr); void loadWithDocumentLoader(DocumentLoader*, FrameLoadType, PassRefPtr); // Calls continueLoadAfterNavigationPolicy void load(DocumentLoader*); // Calls loadWithDocumentLoader void loadWithNavigationAction(const ResourceRequest&, const NavigationAction&, // Calls loadWithDocumentLoader bool lockHistory, FrameLoadType, PassRefPtr); void loadPostRequest(const ResourceRequest&, const String& referrer, // Called by loadFrameRequest, calls loadWithNavigationAction const String& frameName, bool lockHistory, FrameLoadType, PassRefPtr, PassRefPtr); void loadURL(const KURL&, const String& referrer, const String& frameName, // Called by loadFrameRequest, calls loadWithNavigationAction or dispatches to navigation policy delegate bool lockHistory, FrameLoadType, PassRefPtr, PassRefPtr); void clientRedirectCancelledOrFinished(bool cancelWithLoadInProgress); void clientRedirected(const KURL&, double delay, double fireDate, bool lockBackForwardList); bool shouldReload(const KURL& currentURL, const KURL& destinationURL); void sendRemainingDelegateMessages(unsigned long identifier, const ResourceResponse&, int length, const ResourceError&); void requestFromDelegate(ResourceRequest&, unsigned long& identifier, ResourceError&); void recursiveCheckLoadComplete(); void detachChildren(); void closeAndRemoveChild(Frame*); Frame* loadSubframe(HTMLFrameOwnerElement*, const KURL&, const String& name, const String& referrer); // Returns true if argument is a JavaScript URL. bool executeIfJavaScriptURL(const KURL&, bool userGesture = false, bool replaceDocument = true); bool gotoAnchor(const String& name); // returns true if the anchor was found void scrollToAnchor(const KURL&); void provisionalLoadStarted(); bool canCachePage(); bool didOpenURL(const KURL&); void scheduleCheckCompleted(); void scheduleCheckLoadComplete(); KURL originalRequestURL() const; bool shouldTreatURLAsSameAsCurrent(const KURL&) const; void saveScrollPositionAndViewStateToItem(HistoryItem*); Frame* m_frame; FrameLoaderClient* m_client; FrameState m_state; FrameLoadType m_loadType; // Document loaders for the three phases of frame loading. Note that while // a new request is being loaded, the old document loader may still be referenced. // E.g. while a new request is in the "policy" state, the old document loader may // be consulted in particular as it makes sense to imply certain settings on the new loader. RefPtr m_documentLoader; RefPtr m_provisionalDocumentLoader; RefPtr m_policyDocumentLoader; // This identifies the type of navigation action which prompted this load. Note // that WebKit conveys this value as the WebActionNavigationTypeKey value // on navigation action delegate callbacks. FrameLoadType m_policyLoadType; PolicyCheck m_policyCheck; bool m_delegateIsHandlingProvisionalLoadError; bool m_delegateIsDecidingNavigationPolicy; bool m_delegateIsHandlingUnimplementablePolicy; bool m_firstLayoutDone; bool m_quickRedirectComing; bool m_sentRedirectNotification; bool m_inStopAllLoaders; String m_outgoingReferrer; bool m_isExecutingJavaScriptFormAction; bool m_isRunningScript; String m_responseMIMEType; bool m_didCallImplicitClose; bool m_wasUnloadEventEmitted; bool m_unloadEventBeingDispatched; bool m_isComplete; bool m_isLoadingMainResource; KURL m_URL; KURL m_workingURL; OwnPtr m_iconLoader; bool m_mayLoadIconLater; bool m_cancellingWithLoadInProgress; OwnPtr m_scheduledRedirection; bool m_needsClear; bool m_receivedData; bool m_encodingWasChosenByUser; String m_encoding; RefPtr m_decoder; bool m_containsPlugIns; KURL m_submittedFormURL; Timer m_redirectionTimer; Timer m_checkCompletedTimer; Timer m_checkLoadCompleteTimer; Frame* m_opener; HashSet m_openedFrames; bool m_openedByDOM; bool m_creatingInitialEmptyDocument; bool m_isDisplayingInitialEmptyDocument; bool m_committedFirstRealDocumentLoad; RefPtr m_currentHistoryItem; RefPtr m_previousHistoryItem; RefPtr m_provisionalHistoryItem; bool m_didPerformFirstNavigation; #ifndef NDEBUG bool m_didDispatchDidCommitLoad; #endif #if ENABLE(WML) bool m_forceReloadWmlDeck; #endif }; } // namespace WebCore #endif // FrameLoader_h