summaryrefslogtreecommitdiffstats
path: root/third_party/WebKit/Source/core/loader/DocumentLoader.h
blob: c1ea3babbaf086a48ad283a5f33c89ae71a34299 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
/*
 * Copyright (C) 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
 * Copyright (C) 2011 Google Inc. All rights reserved.
 *
 * 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 DocumentLoader_h
#define DocumentLoader_h

#include "core/CoreExport.h"
#include "core/dom/WeakIdentifierMap.h"
#include "core/fetch/ClientHintsPreferences.h"
#include "core/fetch/RawResource.h"
#include "core/fetch/ResourceLoaderOptions.h"
#include "core/fetch/SubstituteData.h"
#include "core/frame/csp/ContentSecurityPolicy.h"
#include "core/loader/DocumentLoadTiming.h"
#include "core/loader/DocumentWriter.h"
#include "core/loader/FrameLoaderTypes.h"
#include "core/loader/NavigationPolicy.h"
#include "platform/SharedBuffer.h"
#include "platform/network/ResourceError.h"
#include "platform/network/ResourceRequest.h"
#include "platform/network/ResourceResponse.h"
#include "wtf/HashSet.h"
#include "wtf/RefPtr.h"

namespace blink {

class ApplicationCacheHost;
class ResourceFetcher;
class DocumentInit;
class LocalFrame;
class FrameLoader;
class ResourceLoader;
class ThreadedDataReceiver;

class CORE_EXPORT DocumentLoader : public RefCountedWillBeGarbageCollectedFinalized<DocumentLoader>, private RawResourceClient {
    USING_FAST_MALLOC_WILL_BE_REMOVED(DocumentLoader);
public:
    static PassRefPtrWillBeRawPtr<DocumentLoader> create(LocalFrame* frame, const ResourceRequest& request, const SubstituteData& data)
    {
        return adoptRefWillBeNoop(new DocumentLoader(frame, request, data));
    }
    ~DocumentLoader() override;

    LocalFrame* frame() const { return m_frame; }

    virtual void detachFromFrame();

    unsigned long mainResourceIdentifier() const;

    void replaceDocumentWhileExecutingJavaScriptURL(const DocumentInit&, const String& source);

    const AtomicString& mimeType() const;

    const ResourceRequest& originalRequest() const;

    const ResourceRequest& request() const;

    ResourceFetcher* fetcher() const { return m_fetcher.get(); }

    const SubstituteData& substituteData() const { return m_substituteData; }

    const KURL& url() const;
    const KURL& unreachableURL() const;
    const KURL& urlForHistory() const;

    const AtomicString& responseMIMEType() const;

    void didChangePerformanceTiming();
    void updateForSameDocumentNavigation(const KURL&, SameDocumentNavigationSource);
    const ResourceResponse& response() const { return m_response; }
    bool isClientRedirect() const { return m_isClientRedirect; }
    void setIsClientRedirect(bool isClientRedirect) { m_isClientRedirect = isClientRedirect; }
    bool replacesCurrentHistoryItem() const { return m_replacesCurrentHistoryItem; }
    void setReplacesCurrentHistoryItem(bool replacesCurrentHistoryItem) { m_replacesCurrentHistoryItem = replacesCurrentHistoryItem; }

    bool isCommittedButEmpty() const { return m_state == Committed; }

    void setSentDidFinishLoad() { m_state = SentDidFinishLoad; }
    bool sentDidFinishLoad() const { return m_state == SentDidFinishLoad; }

    NavigationType getNavigationType() const { return m_navigationType; }
    void setNavigationType(NavigationType navigationType) { m_navigationType = navigationType; }

    void startLoadingMainResource();

    void attachThreadedDataReceiver(PassRefPtrWillBeRawPtr<ThreadedDataReceiver>);
    void acceptDataFromThreadedReceiver(const char* data, int dataLength, int encodedDataLength);
    DocumentLoadTiming& timing() { return m_documentLoadTiming; }
    const DocumentLoadTiming& timing() const { return m_documentLoadTiming; }

    ApplicationCacheHost* applicationCacheHost() const { return m_applicationCacheHost.get(); }

    void clearRedirectChain();
    void appendRedirect(const KURL&);

    PassRefPtrWillBeRawPtr<ContentSecurityPolicy> releaseContentSecurityPolicy() { return m_contentSecurityPolicy.release(); }

    ClientHintsPreferences& clientHintsPreferences() { return m_clientHintsPreferences; }

    struct InitialScrollState {
        DISALLOW_NEW();
        InitialScrollState()
            : wasScrolledByUser(false)
            , didRestoreFromHistory(false)
        {
        }

        bool wasScrolledByUser;
        bool didRestoreFromHistory;
    };
    InitialScrollState& initialScrollState() { return m_initialScrollState; }

    void setWasBlockedAfterXFrameOptionsOrCSP() { m_wasBlockedAfterXFrameOptionsOrCSP = true; }
    bool wasBlockedAfterXFrameOptionsOrCSP() { return m_wasBlockedAfterXFrameOptionsOrCSP; }

    String suboriginName() const { return m_suboriginName; }

    Resource* startPreload(Resource::Type, FetchRequest&);

    DECLARE_VIRTUAL_TRACE();

protected:
    DocumentLoader(LocalFrame*, const ResourceRequest&, const SubstituteData&);

    Vector<KURL> m_redirectChain;

private:
    static PassRefPtrWillBeRawPtr<DocumentWriter> createWriterFor(const DocumentInit&, const AtomicString& mimeType, const AtomicString& encoding, bool dispatch, ParserSynchronizationPolicy);

    void ensureWriter(const AtomicString& mimeType, const KURL& overridingURL = KURL());
    void endWriting(DocumentWriter*);

    FrameLoader* frameLoader() const;

    void commitIfReady();
    void commitData(const char* bytes, size_t length);
    ResourceLoader* mainResourceLoader() const;
    void clearMainResourceHandle();

    bool maybeCreateArchive();

    void finishedLoading(double finishTime);
    void cancelLoadAfterXFrameOptionsOrCSPDenied(const ResourceResponse&);
    void redirectReceived(Resource*, ResourceRequest&, const ResourceResponse&) final;
    void responseReceived(Resource*, const ResourceResponse&, PassOwnPtr<WebDataConsumerHandle>) final;
    void dataReceived(Resource*, const char* data, size_t length) final;
    void processData(const char* data, size_t length);
    void notifyFinished(Resource*) final;
    String debugName() const override { return "DocumentLoader"; }

    bool maybeLoadEmpty();

    bool isRedirectAfterPost(const ResourceRequest&, const ResourceResponse&);

    bool shouldContinueForResponse() const;

    RawPtrWillBeMember<LocalFrame> m_frame;
    PersistentWillBeMember<ResourceFetcher> m_fetcher;

    RefPtrWillBeMember<RawResource> m_mainResource;

    RefPtrWillBeMember<DocumentWriter> m_writer;

    // A reference to actual request used to create the data source.
    // The only part of this request that should change is the url, and
    // that only in the case of a same-document navigation.
    ResourceRequest m_originalRequest;

    SubstituteData m_substituteData;

    // The 'working' request. It may be mutated
    // several times from the original request to include additional
    // headers, cookie information, canonicalization and redirects.
    ResourceRequest m_request;

    ResourceResponse m_response;

    bool m_isClientRedirect;
    bool m_replacesCurrentHistoryItem;

    NavigationType m_navigationType;

    DocumentLoadTiming m_documentLoadTiming;

    double m_timeOfLastDataReceived;

    PersistentWillBeMember<ApplicationCacheHost> m_applicationCacheHost;

    RefPtrWillBeMember<ContentSecurityPolicy> m_contentSecurityPolicy;
    ClientHintsPreferences m_clientHintsPreferences;
    InitialScrollState m_initialScrollState;
    String m_suboriginName;

    bool m_wasBlockedAfterXFrameOptionsOrCSP;

    enum State {
        NotStarted,
        Provisional,
        Committed,
        DataReceived,
        MainResourceDone,
        SentDidFinishLoad
    };
    State m_state;

    // Used to protect against reentrancy into dataReceived().
    bool m_inDataReceived;
    RefPtr<SharedBuffer> m_dataBuffer;
};

DECLARE_WEAK_IDENTIFIER_MAP(DocumentLoader);

} // namespace blink

#endif // DocumentLoader_h