Remove support for "magic" iframe
[WebKit-https.git] / Source / WebCore / 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 "DocumentLoadTiming.h"
34 #include "DocumentWriter.h"
35 #include "IconDatabaseBase.h"
36 #include "NavigationAction.h"
37 #include "ResourceError.h"
38 #include "ResourceRequest.h"
39 #include "ResourceResponse.h"
40 #include "StringWithDirection.h"
41 #include "SubstituteData.h"
42 #include "Timer.h"
43 #include <wtf/HashSet.h>
44 #include <wtf/RefPtr.h>
45 #include <wtf/Vector.h>
46
47 namespace WebCore {
48
49     class ApplicationCacheHost;
50 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
51     class Archive;
52 #endif
53     class ArchiveResource;
54     class ArchiveResourceCollection;
55     class Frame;
56     class FrameLoader;
57     class MainResourceLoader;
58     class Page;
59     class ResourceLoader;
60     class SchedulePair;
61     class SharedBuffer;
62     class SubstituteResource;
63
64     typedef HashSet<RefPtr<ResourceLoader> > ResourceLoaderSet;
65     typedef Vector<ResourceResponse> ResponseVector;
66
67     class DocumentLoader : public RefCounted<DocumentLoader> {
68     public:
69         static PassRefPtr<DocumentLoader> create(const ResourceRequest& request, const SubstituteData& data)
70         {
71             return adoptRef(new DocumentLoader(request, data));
72         }
73         virtual ~DocumentLoader();
74
75         void setFrame(Frame*);
76         Frame* frame() const { return m_frame; }
77
78         virtual void attachToFrame();
79         virtual void detachFromFrame();
80
81         FrameLoader* frameLoader() const;
82         MainResourceLoader* mainResourceLoader() const { return m_mainResourceLoader.get(); }
83         PassRefPtr<SharedBuffer> mainResourceData() const;
84         
85         DocumentWriter* writer() const { return &m_writer; }
86
87         const ResourceRequest& originalRequest() const;
88         const ResourceRequest& originalRequestCopy() const;
89
90         const ResourceRequest& request() const;
91         ResourceRequest& request();
92         void setRequest(const ResourceRequest&);
93
94         const SubstituteData& substituteData() const { return m_substituteData; }
95
96         // FIXME: This is the same as requestURL(). We should remove one of them.
97         const KURL& url() const;
98         const KURL& unreachableURL() const;
99
100         // The URL of the document resulting from this DocumentLoader.
101         KURL documentURL() const;
102
103         const KURL& originalURL() const;
104         const KURL& requestURL() const;
105         const KURL& responseURL() const;
106         const String& responseMIMEType() const;
107
108         void replaceRequestURLForSameDocumentNavigation(const KURL&);
109         bool isStopping() const { return m_isStopping; }
110         void stopLoading();
111         void setCommitted(bool committed) { m_committed = committed; }
112         bool isCommitted() const { return m_committed; }
113         bool isLoading() const { return m_loading; }
114         void setLoading(bool loading) { m_loading = loading; }
115         void updateLoading();
116         void receivedData(const char*, int);
117         void setupForReplaceByMIMEType(const String& newMIMEType);
118         void finishedLoading();
119         const ResourceResponse& response() const { return m_response; }
120         const ResourceError& mainDocumentError() const { return m_mainDocumentError; }
121         void mainReceivedError(const ResourceError&, bool isComplete);
122         void setResponse(const ResourceResponse& response) { m_response = response; }
123         void prepareForLoadStart();
124         bool isClientRedirect() const { return m_isClientRedirect; }
125         void setIsClientRedirect(bool isClientRedirect) { m_isClientRedirect = isClientRedirect; }
126         void handledOnloadEvents();
127         bool wasOnloadHandled() { return m_wasOnloadHandled; }
128         bool isLoadingInAPISense() const;
129         void setPrimaryLoadComplete(bool);
130         void setTitle(const StringWithDirection&);
131         const String& overrideEncoding() const { return m_overrideEncoding; }
132
133 #if PLATFORM(MAC)
134         void schedule(SchedulePair*);
135         void unschedule(SchedulePair*);
136 #endif
137
138 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
139         void addAllArchiveResources(Archive*);
140         void addArchiveResource(PassRefPtr<ArchiveResource>);
141         
142         PassRefPtr<Archive> popArchiveForSubframe(const String& frameName, const KURL&);
143         void clearArchiveResources();
144         void setParsedArchiveData(PassRefPtr<SharedBuffer>);
145         SharedBuffer* parsedArchiveData() const;
146         
147         bool scheduleArchiveLoad(ResourceLoader*, const ResourceRequest&, const KURL&);
148 #endif // ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
149
150         // Return the ArchiveResource for the URL only when loading an Archive
151         ArchiveResource* archiveResourceForURL(const KURL&) const;
152
153         PassRefPtr<ArchiveResource> mainResource() const;
154
155         // Return an ArchiveResource for the URL, either creating from live data or
156         // pulling from the ArchiveResourceCollection
157         PassRefPtr<ArchiveResource> subresource(const KURL&) const;
158         void getSubresources(Vector<PassRefPtr<ArchiveResource> >&) const;
159
160
161 #ifndef NDEBUG
162         bool isSubstituteLoadPending(ResourceLoader*) const;
163 #endif
164         void cancelPendingSubstituteLoad(ResourceLoader*);   
165         
166         void addResponse(const ResourceResponse&);
167         const ResponseVector& responses() const { return m_responses; }
168
169         const NavigationAction& triggeringAction() const { return m_triggeringAction; }
170         void setTriggeringAction(const NavigationAction& action) { m_triggeringAction = action; }
171         void setOverrideEncoding(const String& encoding) { m_overrideEncoding = encoding; }
172         void setLastCheckedRequest(const ResourceRequest& request) { m_lastCheckedRequest = request; }
173         const ResourceRequest& lastCheckedRequest()  { return m_lastCheckedRequest; }
174
175         void stopRecordingResponses();
176         const StringWithDirection& title() const { return m_pageTitle; }
177
178         KURL urlForHistory() const;
179         bool urlForHistoryReflectsFailure() const;
180
181         // These accessors accommodate WebCore's somewhat fickle custom of creating history
182         // items for redirects, but only sometimes. For "source" and "destination",
183         // these accessors return the URL that would have been used if a history
184         // item were created. This allows WebKit to link history items reflecting
185         // redirects into a chain from start to finish.
186         String clientRedirectSourceForHistory() const { return m_clientRedirectSourceForHistory; } // null if no client redirect occurred.
187         String clientRedirectDestinationForHistory() const { return urlForHistory(); }
188         void setClientRedirectSourceForHistory(const String& clientedirectSourceForHistory) { m_clientRedirectSourceForHistory = clientedirectSourceForHistory; }
189         
190         String serverRedirectSourceForHistory() const { return urlForHistory() == url() ? String() : urlForHistory().string(); } // null if no server redirect occurred.
191         String serverRedirectDestinationForHistory() const { return url(); }
192
193         bool didCreateGlobalHistoryEntry() const { return m_didCreateGlobalHistoryEntry; }
194         void setDidCreateGlobalHistoryEntry(bool didCreateGlobalHistoryEntry) { m_didCreateGlobalHistoryEntry = didCreateGlobalHistoryEntry; }
195         
196         void setDefersLoading(bool);
197
198         bool startLoadingMainResource(unsigned long identifier);
199         void cancelMainResourceLoad(const ResourceError&);
200         
201         // Support iconDatabase in synchronous mode.
202         void iconLoadDecisionAvailable();
203         
204         // Support iconDatabase in asynchronous mode.
205         void continueIconLoadWithDecision(IconLoadDecision);
206         void getIconLoadDecisionForIconURL(const String&);
207         void getIconDataForIconURL(const String&);
208         
209         bool isLoadingMainResource() const;
210         bool isLoadingSubresources() const;
211         bool isLoadingPlugIns() const;
212         bool isLoadingMultipartContent() const;
213
214         void stopLoadingPlugIns();
215         void stopLoadingSubresources();
216
217         void addSubresourceLoader(ResourceLoader*);
218         void removeSubresourceLoader(ResourceLoader*);
219         void addPlugInStreamLoader(ResourceLoader*);
220         void removePlugInStreamLoader(ResourceLoader*);
221
222         void subresourceLoaderFinishedLoadingOnePart(ResourceLoader*);
223
224         void maybeFinishLoadingMultipartContent();
225
226         void setDeferMainResourceDataLoad(bool defer) { m_deferMainResourceDataLoad = defer; }
227         bool deferMainResourceDataLoad() const { return m_deferMainResourceDataLoad; }
228         
229         void didTellClientAboutLoad(const String& url)
230         { 
231 #if !PLATFORM(MAC)
232             // Don't include data urls here, as if a lot of data is loaded
233             // that way, we hold on to the (large) url string for too long.
234             if (protocolIs(url, "data"))
235                 return;
236 #endif
237             if (!url.isEmpty())
238                 m_resourcesClientKnowsAbout.add(url);
239         }
240         bool haveToldClientAboutLoad(const String& url) { return m_resourcesClientKnowsAbout.contains(url); }
241         void recordMemoryCacheLoadForFutureClientNotification(const String& url);
242         void takeMemoryCacheLoadsForClientNotification(Vector<String>& loads);
243
244         DocumentLoadTiming* timing() { return &m_documentLoadTiming; }
245         void resetTiming() { m_documentLoadTiming = DocumentLoadTiming(); }
246
247         // The WebKit layer calls this function when it's ready for the data to
248         // actually be added to the document.
249         void commitData(const char* bytes, size_t length);
250
251         ApplicationCacheHost* applicationCacheHost() const { return m_applicationCacheHost.get(); }
252
253     protected:
254         DocumentLoader(const ResourceRequest&, const SubstituteData&);
255
256         bool m_deferMainResourceDataLoad;
257
258     private:
259         void setupForReplace();
260         void commitIfReady();
261         void clearErrors();
262         void setMainDocumentError(const ResourceError&);
263         void commitLoad(const char*, int);
264         bool doesProgressiveLoad(const String& MIMEType) const;
265
266         void deliverSubstituteResourcesAfterDelay();
267         void substituteResourceDeliveryTimerFired(Timer<DocumentLoader>*);
268                 
269         Frame* m_frame;
270
271         RefPtr<MainResourceLoader> m_mainResourceLoader;
272         ResourceLoaderSet m_subresourceLoaders;
273         ResourceLoaderSet m_multipartSubresourceLoaders;
274         ResourceLoaderSet m_plugInStreamLoaders;
275
276         RefPtr<SharedBuffer> m_mainResourceData;
277         
278         mutable DocumentWriter m_writer;
279
280         // A reference to actual request used to create the data source.
281         // This should only be used by the resourceLoadDelegate's
282         // identifierForInitialRequest:fromDatasource: method. It is
283         // not guaranteed to remain unchanged, as requests are mutable.
284         ResourceRequest m_originalRequest;   
285
286         SubstituteData m_substituteData;
287
288         // A copy of the original request used to create the data source.
289         // We have to copy the request because requests are mutable.
290         ResourceRequest m_originalRequestCopy;
291         
292         // The 'working' request. It may be mutated
293         // several times from the original request to include additional
294         // headers, cookie information, canonicalization and redirects.
295         ResourceRequest m_request;
296
297         ResourceResponse m_response;
298     
299         ResourceError m_mainDocumentError;    
300
301         bool m_committed;
302         bool m_isStopping;
303         bool m_loading;
304         bool m_gotFirstByte;
305         bool m_primaryLoadComplete;
306         bool m_isClientRedirect;
307
308         // FIXME: Document::m_processingLoadEvent and DocumentLoader::m_wasOnloadHandled are roughly the same
309         // and should be merged.
310         bool m_wasOnloadHandled;
311
312         StringWithDirection m_pageTitle;
313
314         String m_overrideEncoding;
315
316         // The action that triggered loading - we keep this around for the
317         // benefit of the various policy handlers.
318         NavigationAction m_triggeringAction;
319
320         // The last request that we checked click policy for - kept around
321         // so we can avoid asking again needlessly.
322         ResourceRequest m_lastCheckedRequest;
323
324         // We retain all the received responses so we can play back the
325         // WebResourceLoadDelegate messages if the item is loaded from the
326         // page cache.
327         ResponseVector m_responses;
328         bool m_stopRecordingResponses;
329         
330         typedef HashMap<RefPtr<ResourceLoader>, RefPtr<SubstituteResource> > SubstituteResourceMap;
331         SubstituteResourceMap m_pendingSubstituteResources;
332         Timer<DocumentLoader> m_substituteResourceDeliveryTimer;
333
334         OwnPtr<ArchiveResourceCollection> m_archiveResourceCollection;
335 #if ENABLE(WEB_ARCHIVE) || ENABLE(MHTML)
336         RefPtr<SharedBuffer> m_parsedArchiveData;
337 #endif
338
339         HashSet<String> m_resourcesClientKnowsAbout;
340         Vector<String> m_resourcesLoadedFromMemoryCacheForClientNotification;
341         
342         String m_clientRedirectSourceForHistory;
343         bool m_didCreateGlobalHistoryEntry;
344
345         DocumentLoadTiming m_documentLoadTiming;
346     
347         RefPtr<IconLoadDecisionCallback> m_iconLoadDecisionCallback;
348         RefPtr<IconDataCallback> m_iconDataCallback;
349
350         friend class ApplicationCacheHost;  // for substitute resource delivery
351         OwnPtr<ApplicationCacheHost> m_applicationCacheHost;
352     };
353
354     inline void DocumentLoader::recordMemoryCacheLoadForFutureClientNotification(const String& url)
355     {
356         m_resourcesLoadedFromMemoryCacheForClientNotification.append(url);
357     }
358
359     inline void DocumentLoader::takeMemoryCacheLoadsForClientNotification(Vector<String>& loadsSet)
360     {
361         loadsSet.swap(m_resourcesLoadedFromMemoryCacheForClientNotification);
362         m_resourcesLoadedFromMemoryCacheForClientNotification.clear();
363     }
364
365 }
366
367 #endif // DocumentLoader_h