src/third_party/WebKit/Source/core/loader/DocumentLoader.h

   1 /*
   2  * Copyright (C) 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
   3  * Copyright (C) 2011 Google Inc. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   9  * 1.  Redistributions of source code must retain the above copyright
  10  *     notice, this list of conditions and the following disclaimer.
  11  * 2.  Redistributions in binary form must reproduce the above copyright
  12  *     notice, this list of conditions and the following disclaimer in the
  13  *     documentation and/or other materials provided with the distribution.
  14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  15  *     its contributors may be used to endorse or promote products derived
  16  *     from this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #ifndef DocumentLoader_h
  31 #define DocumentLoader_h
  32
  33 #include "core/fetch/RawResource.h"
  34 #include "core/fetch/ResourceLoaderOptions.h"
  35 #include "core/fetch/ResourcePtr.h"
  36 #include "core/frame/csp/ContentSecurityPolicy.h"
  37 #include "core/loader/DocumentLoadTiming.h"
  38 #include "core/loader/DocumentWriter.h"
  39 #include "core/loader/NavigationAction.h"
  40 #include "core/loader/SubstituteData.h"
  41 #include "platform/network/ResourceError.h"
  42 #include "platform/network/ResourceRequest.h"
  43 #include "platform/network/ResourceResponse.h"
  44 #include "wtf/HashSet.h"
  45 #include "wtf/RefPtr.h"
  46
  47 namespace blink {
  48 class WebThreadedDataReceiver;
  49 }
  50
  51 namespace blink {
  52     class ApplicationCacheHost;
  53     class ArchiveResourceCollection;
  54     class ResourceFetcher;
  55     class DocumentInit;
  56     class LocalFrame;
  57     class FrameLoader;
  58     class MHTMLArchive;
  59     class ResourceLoader;
  60
  61     class DocumentLoader : public RefCounted<DocumentLoader>, private RawResourceClient {
  62         WTF_MAKE_FAST_ALLOCATED;
  63     public:
  64         static PassRefPtr<DocumentLoader> create(LocalFrame* frame, const ResourceRequest& request, const SubstituteData& data)
  65         {
  66             return adoptRef(new DocumentLoader(frame, request, data));
  67         }
  68         virtual ~DocumentLoader();
  69
  70         LocalFrame* frame() const { return m_frame; }
  71
  72         void detachFromFrame();
  73
  74         unsigned long mainResourceIdentifier() const;
  75
  76         void replaceDocumentWhileExecutingJavaScriptURL(const DocumentInit&, const String& source, Document*);
  77
  78         const AtomicString& mimeType() const;
  79
  80         void setUserChosenEncoding(const String& charset);
  81
  82         const ResourceRequest& originalRequest() const;
  83
  84         const ResourceRequest& request() const;
  85
  86         ResourceFetcher* fetcher() const { return m_fetcher.get(); }
  87
  88         const SubstituteData& substituteData() const { return m_substituteData; }
  89
  90         const KURL& url() const;
  91         const KURL& unreachableURL() const;
  92         const KURL& urlForHistory() const;
  93
  94         const AtomicString& responseMIMEType() const;
  95
  96         void updateForSameDocumentNavigation(const KURL&, SameDocumentNavigationSource);
  97         void stopLoading();
  98         bool isCommitted() const { return m_committed; }
  99         bool isLoading() const;
 100         bool isLoadingMainResource() const { return m_loadingMainResource; }
 101         const ResourceResponse& response() const { return m_response; }
 102         const ResourceError& mainDocumentError() const { return m_mainDocumentError; }
 103         bool isClientRedirect() const { return m_isClientRedirect; }
 104         void setIsClientRedirect(bool isClientRedirect) { m_isClientRedirect = isClientRedirect; }
 105         bool replacesCurrentHistoryItem() const { return m_replacesCurrentHistoryItem; }
 106         void setReplacesCurrentHistoryItem(bool replacesCurrentHistoryItem) { m_replacesCurrentHistoryItem = replacesCurrentHistoryItem; }
 107
 108         bool scheduleArchiveLoad(Resource*, const ResourceRequest&);
 109
 110         bool shouldContinueForNavigationPolicy(const ResourceRequest&, ContentSecurityPolicyCheck shouldCheckMainWorldContentSecurityPolicy, bool isTransitionNavigation = false);
 111         const NavigationAction& triggeringAction() const { return m_triggeringAction; }
 112         void setTriggeringAction(const NavigationAction& action) { m_triggeringAction = action; }
 113
 114         void setDefersLoading(bool);
 115
 116         void startLoadingMainResource();
 117         void cancelMainResourceLoad(const ResourceError&);
 118
 119         void attachThreadedDataReceiver(PassOwnPtr<blink::WebThreadedDataReceiver>);
 120         DocumentLoadTiming* timing() { return &m_documentLoadTiming; }
 121
 122         ApplicationCacheHost* applicationCacheHost() const { return m_applicationCacheHost.get(); }
 123
 124         bool isRedirect() const { return m_redirectChain.size() > 1; }
 125         void clearRedirectChain();
 126         void appendRedirect(const KURL&);
 127
 128         PassRefPtr<ContentSecurityPolicy> releaseContentSecurityPolicy() { return m_contentSecurityPolicy.release(); }
 129
 130     protected:
 131         DocumentLoader(LocalFrame*, const ResourceRequest&, const SubstituteData&);
 132
 133         Vector<KURL> m_redirectChain;
 134
 135     private:
 136         static PassRefPtrWillBeRawPtr<DocumentWriter> createWriterFor(const Document* ownerDocument, const DocumentInit&, const AtomicString& mimeType, const AtomicString& encoding, bool dispatch);
 137
 138         void ensureWriter(const AtomicString& mimeType, const KURL& overridingURL = KURL());
 139         void endWriting(DocumentWriter*);
 140
 141         Document* document() const;
 142         FrameLoader* frameLoader() const;
 143
 144         void commitIfReady();
 145         void commitData(const char* bytes, size_t length);
 146         void setMainDocumentError(const ResourceError&);
 147         void clearMainResourceLoader();
 148         ResourceLoader* mainResourceLoader() const;
 149         void clearMainResourceHandle();
 150
 151         bool maybeCreateArchive();
 152
 153         void prepareSubframeArchiveLoadIfNeeded();
 154         void addAllArchiveResources(MHTMLArchive*);
 155
 156         void willSendRequest(ResourceRequest&, const ResourceResponse&);
 157         void finishedLoading(double finishTime);
 158         void mainReceivedError(const ResourceError&);
 159         void cancelLoadAfterXFrameOptionsOrCSPDenied(const ResourceResponse&);
 160         virtual void redirectReceived(Resource*, ResourceRequest&, const ResourceResponse&) override final;
 161         virtual void updateRequest(Resource*, const ResourceRequest&) override final;
 162         virtual void responseReceived(Resource*, const ResourceResponse&, PassOwnPtr<WebDataConsumerHandle>) override final;
 163         virtual void dataReceived(Resource*, const char* data, unsigned length) override final;
 164         virtual void notifyFinished(Resource*) override final;
 165
 166         bool maybeLoadEmpty();
 167
 168         bool isRedirectAfterPost(const ResourceRequest&, const ResourceResponse&);
 169
 170         bool shouldContinueForResponse() const;
 171
 172         LocalFrame* m_frame;
 173         RefPtrWillBePersistent<ResourceFetcher> m_fetcher;
 174
 175         ResourcePtr<RawResource> m_mainResource;
 176
 177         RefPtrWillBePersistent<DocumentWriter> m_writer;
 178
 179         // A reference to actual request used to create the data source.
 180         // The only part of this request that should change is the url, and
 181         // that only in the case of a same-document navigation.
 182         ResourceRequest m_originalRequest;
 183
 184         SubstituteData m_substituteData;
 185
 186         // The 'working' request. It may be mutated
 187         // several times from the original request to include additional
 188         // headers, cookie information, canonicalization and redirects.
 189         ResourceRequest m_request;
 190
 191         ResourceResponse m_response;
 192
 193         ResourceError m_mainDocumentError;
 194
 195         bool m_committed;
 196         bool m_isClientRedirect;
 197         bool m_replacesCurrentHistoryItem;
 198
 199         // The action that triggered loading - we keep this around for the
 200         // benefit of the various policy handlers.
 201         NavigationAction m_triggeringAction;
 202
 203         OwnPtrWillBePersistent<ArchiveResourceCollection> m_archiveResourceCollection;
 204         RefPtrWillBePersistent<MHTMLArchive> m_archive;
 205
 206         bool m_loadingMainResource;
 207         DocumentLoadTiming m_documentLoadTiming;
 208
 209         double m_timeOfLastDataReceived;
 210
 211         friend class ApplicationCacheHost;  // for substitute resource delivery
 212         OwnPtrWillBePersistent<ApplicationCacheHost> m_applicationCacheHost;
 213
 214         RefPtr<ContentSecurityPolicy> m_contentSecurityPolicy;
 215     };
 216 }
 217
 218 #endif // DocumentLoader_h