62b768fece8cb35ec4e0903857bbd1dacb0afb75
[WebKit-https.git] / Source / WebCore / loader / appcache / ApplicationCacheHost.cpp
1 /*
2  * Copyright (C) 2008, 2009 Apple Inc. All Rights Reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #include "config.h"
27 #include "ApplicationCacheHost.h"
28
29 #include "ApplicationCache.h"
30 #include "ApplicationCacheGroup.h"
31 #include "ApplicationCacheResource.h"
32 #include "DocumentLoader.h"
33 #include "DOMApplicationCache.h"
34 #include "FileSystem.h"
35 #include "Frame.h"
36 #include "FrameLoader.h"
37 #include "FrameLoaderClient.h"
38 #include "InspectorInstrumentation.h"
39 #include "MainFrame.h"
40 #include "ProgressEvent.h"
41 #include "ResourceHandle.h"
42 #include "ResourceLoader.h"
43 #include "ResourceRequest.h"
44 #include "Settings.h"
45
46 namespace WebCore {
47
48 ApplicationCacheHost::ApplicationCacheHost(DocumentLoader& documentLoader)
49     : m_domApplicationCache(0)
50     , m_documentLoader(documentLoader)
51     , m_defersEvents(true)
52     , m_candidateApplicationCacheGroup(0)
53 {
54 }
55
56 ApplicationCacheHost::~ApplicationCacheHost()
57 {
58     ASSERT(!m_applicationCache || !m_candidateApplicationCacheGroup || m_applicationCache->group() == m_candidateApplicationCacheGroup);
59
60     if (m_applicationCache)
61         m_applicationCache->group()->disassociateDocumentLoader(&m_documentLoader);
62     else if (m_candidateApplicationCacheGroup)
63         m_candidateApplicationCacheGroup->disassociateDocumentLoader(&m_documentLoader);
64 }
65
66 void ApplicationCacheHost::selectCacheWithoutManifest()
67 {
68     ApplicationCacheGroup::selectCacheWithoutManifestURL(m_documentLoader.frame());
69 }
70
71 void ApplicationCacheHost::selectCacheWithManifest(const URL& manifestURL)
72 {
73     ApplicationCacheGroup::selectCache(m_documentLoader.frame(), manifestURL);
74 }
75
76 void ApplicationCacheHost::maybeLoadMainResource(ResourceRequest& request, SubstituteData& substituteData)
77 {
78     // Check if this request should be loaded from the application cache
79     if (!substituteData.isValid() && isApplicationCacheEnabled() && !isApplicationCacheBlockedForRequest(request)) {
80         ASSERT(!m_mainResourceApplicationCache);
81
82         m_mainResourceApplicationCache = ApplicationCacheGroup::cacheForMainRequest(request, &m_documentLoader);
83
84         if (m_mainResourceApplicationCache) {
85             // Get the resource from the application cache. By definition, cacheForMainRequest() returns a cache that contains the resource.
86             ApplicationCacheResource* resource = m_mainResourceApplicationCache->resourceForRequest(request);
87
88             // ApplicationCache resources have fragment identifiers stripped off of their URLs,
89             // but we'll need to restore that for the SubstituteData.
90             ResourceResponse responseToUse = resource->response();
91             if (request.url().hasFragmentIdentifier()) {
92                 URL url = responseToUse.url();
93                 url.setFragmentIdentifier(request.url().fragmentIdentifier());
94                 responseToUse.setURL(url);
95             }
96
97             substituteData = SubstituteData(resource->data(),
98                                             URL(),
99                                             responseToUse,
100                                             SubstituteData::SessionHistoryVisibility::Visible);
101         }
102     }
103 }
104
105 void ApplicationCacheHost::maybeLoadMainResourceForRedirect(ResourceRequest& request, SubstituteData& substituteData)
106 {
107     ASSERT(status() == UNCACHED);
108     maybeLoadMainResource(request, substituteData);
109 }
110
111 bool ApplicationCacheHost::maybeLoadFallbackForMainResponse(const ResourceRequest& request, const ResourceResponse& r)
112 {
113     if (r.httpStatusCode() / 100 == 4 || r.httpStatusCode() / 100 == 5) {
114         ASSERT(!m_mainResourceApplicationCache);
115         if (isApplicationCacheEnabled() && !isApplicationCacheBlockedForRequest(request)) {
116             m_mainResourceApplicationCache = ApplicationCacheGroup::fallbackCacheForMainRequest(request, &m_documentLoader);
117
118             if (scheduleLoadFallbackResourceFromApplicationCache(m_documentLoader.mainResourceLoader(), m_mainResourceApplicationCache.get()))
119                 return true;
120         }
121     }
122     return false;
123 }
124
125 bool ApplicationCacheHost::maybeLoadFallbackForMainError(const ResourceRequest& request, const ResourceError& error)
126 {
127     if (!error.isCancellation()) {
128         ASSERT(!m_mainResourceApplicationCache);
129         if (isApplicationCacheEnabled() && !isApplicationCacheBlockedForRequest(request)) {
130             m_mainResourceApplicationCache = ApplicationCacheGroup::fallbackCacheForMainRequest(request, &m_documentLoader);
131
132             if (scheduleLoadFallbackResourceFromApplicationCache(m_documentLoader.mainResourceLoader(), m_mainResourceApplicationCache.get()))
133                 return true;
134         }
135     }
136     return false;
137 }
138
139 void ApplicationCacheHost::mainResourceDataReceived(const char*, int, long long, bool)
140 {
141     // This method is here to facilitate alternate implemetations of this interface by the host browser.
142 }
143
144 void ApplicationCacheHost::failedLoadingMainResource()
145 {
146     ApplicationCacheGroup* group = m_candidateApplicationCacheGroup;
147     if (!group && m_applicationCache) {
148         if (mainResourceApplicationCache()) {
149             // Even when the main resource is being loaded from an application cache, loading can fail if aborted.
150             return;
151         }
152         group = m_applicationCache->group();
153     }
154     
155     if (group)
156         group->failedLoadingMainResource(&m_documentLoader);
157 }
158
159 void ApplicationCacheHost::finishedLoadingMainResource()
160 {
161     ApplicationCacheGroup* group = candidateApplicationCacheGroup();
162     if (!group && applicationCache() && !mainResourceApplicationCache())
163         group = applicationCache()->group();
164     
165     if (group)
166         group->finishedLoadingMainResource(&m_documentLoader);
167 }
168
169 bool ApplicationCacheHost::maybeLoadResource(ResourceLoader* loader, const ResourceRequest& request, const URL& originalURL)
170 {
171     if (!isApplicationCacheEnabled() && !isApplicationCacheBlockedForRequest(request))
172         return false;
173     
174     if (request.url() != originalURL)
175         return false;
176
177     ApplicationCacheResource* resource;
178     if (!shouldLoadResourceFromApplicationCache(request, resource))
179         return false;
180
181     m_documentLoader.m_pendingSubstituteResources.set(loader, resource);
182     m_documentLoader.deliverSubstituteResourcesAfterDelay();
183
184     return true;
185 }
186
187 bool ApplicationCacheHost::maybeLoadFallbackForRedirect(ResourceLoader* resourceLoader, ResourceRequest& request, const ResourceResponse& redirectResponse)
188 {
189     if (!redirectResponse.isNull() && !protocolHostAndPortAreEqual(request.url(), redirectResponse.url()))
190         if (scheduleLoadFallbackResourceFromApplicationCache(resourceLoader))
191             return true;
192     return false;
193 }
194
195 bool ApplicationCacheHost::maybeLoadFallbackForResponse(ResourceLoader* resourceLoader, const ResourceResponse& response)
196 {
197     if (response.httpStatusCode() / 100 == 4 || response.httpStatusCode() / 100 == 5)
198         if (scheduleLoadFallbackResourceFromApplicationCache(resourceLoader))
199             return true;
200     return false;
201 }
202
203 bool ApplicationCacheHost::maybeLoadFallbackForError(ResourceLoader* resourceLoader, const ResourceError& error)
204 {
205     if (!error.isCancellation()) {
206         if (resourceLoader == m_documentLoader.mainResourceLoader())
207             return maybeLoadFallbackForMainError(resourceLoader->request(), error);
208         if (scheduleLoadFallbackResourceFromApplicationCache(resourceLoader))
209             return true;
210     }
211     return false;
212 }
213
214 URL ApplicationCacheHost::createFileURL(const String& path)
215 {
216     // FIXME: Can we just use fileURLWithFileSystemPath instead?
217
218     // fileURLWithFileSystemPath function is not suitable because URL::setPath uses encodeWithURLEscapeSequences, which it notes
219     // does not correctly escape '#' and '?'. This function works for our purposes because
220     // app cache media files are always created with encodeForFileName(createCanonicalUUIDString()).
221
222 #if USE(CF) && PLATFORM(WIN)
223     RetainPtr<CFURLRef> cfURL = adoptCF(CFURLCreateWithFileSystemPath(0, path.createCFString().get(), kCFURLWindowsPathStyle, false));
224     URL url(cfURL.get());
225 #else
226     URL url;
227
228     url.setProtocol(ASCIILiteral("file"));
229     url.setPath(path);
230 #endif
231     return url;
232 }
233
234 bool ApplicationCacheHost::maybeLoadSynchronously(ResourceRequest& request, ResourceError& error, ResourceResponse& response, RefPtr<SharedBuffer>& data)
235 {
236     ApplicationCacheResource* resource;
237     if (shouldLoadResourceFromApplicationCache(request, resource)) {
238         if (resource) {
239             // FIXME: Clients proably do not need a copy of the SharedBuffer.
240             // Remove the call to copy() once we ensure SharedBuffer will not be modified.
241             if (resource->path().isEmpty())
242                 data = resource->data()->copy();
243             else
244                 data = SharedBuffer::createWithContentsOfFile(resource->path());
245         }
246         if (!data)
247             error = m_documentLoader.frameLoader()->client().cannotShowURLError(request);
248         else
249             response = resource->response();
250         return true;
251     }
252     return false;
253 }
254
255 void ApplicationCacheHost::maybeLoadFallbackSynchronously(const ResourceRequest& request, ResourceError& error, ResourceResponse& response, RefPtr<SharedBuffer>& data)
256 {
257     // If normal loading results in a redirect to a resource with another origin (indicative of a captive portal), or a 4xx or 5xx status code or equivalent,
258     // or if there were network errors (but not if the user canceled the download), then instead get, from the cache, the resource of the fallback entry
259     // corresponding to the matched namespace.
260     if ((!error.isNull() && !error.isCancellation())
261          || response.httpStatusCode() / 100 == 4 || response.httpStatusCode() / 100 == 5
262          || !protocolHostAndPortAreEqual(request.url(), response.url())) {
263         ApplicationCacheResource* resource;
264         if (getApplicationCacheFallbackResource(request, resource)) {
265             response = resource->response();
266             // FIXME: Clients proably do not need a copy of the SharedBuffer.
267             // Remove the call to copy() once we ensure SharedBuffer will not be modified.
268             data = resource->data()->copy();
269         }
270     }
271 }
272
273 bool ApplicationCacheHost::canCacheInPageCache()
274 {
275     return !applicationCache() && !candidateApplicationCacheGroup();
276 }
277
278 void ApplicationCacheHost::setDOMApplicationCache(DOMApplicationCache* domApplicationCache)
279 {
280     ASSERT(!m_domApplicationCache || !domApplicationCache);
281     m_domApplicationCache = domApplicationCache;
282 }
283
284 void ApplicationCacheHost::notifyDOMApplicationCache(EventID id, int total, int done)
285 {
286     if (id != PROGRESS_EVENT)
287         InspectorInstrumentation::updateApplicationCacheStatus(m_documentLoader.frame());
288
289     if (m_defersEvents) {
290         // Event dispatching is deferred until document.onload has fired.
291         m_deferredEvents.append(DeferredEvent(id, total, done));
292         return;
293     }
294     dispatchDOMEvent(id, total, done);
295 }
296
297 void ApplicationCacheHost::stopLoadingInFrame(Frame* frame)
298 {
299     ASSERT(!m_applicationCache || !m_candidateApplicationCacheGroup || m_applicationCache->group() == m_candidateApplicationCacheGroup);
300
301     if (m_candidateApplicationCacheGroup)
302         m_candidateApplicationCacheGroup->stopLoadingInFrame(frame);
303     else if (m_applicationCache)
304         m_applicationCache->group()->stopLoadingInFrame(frame);
305 }
306
307 void ApplicationCacheHost::stopDeferringEvents()
308 {
309     Ref<DocumentLoader> protect(m_documentLoader);
310     for (unsigned i = 0; i < m_deferredEvents.size(); ++i) {
311         const DeferredEvent& deferred = m_deferredEvents[i];
312         dispatchDOMEvent(deferred.eventID, deferred.progressTotal, deferred.progressDone);
313     }
314     m_deferredEvents.clear();
315     m_defersEvents = false;
316 }
317
318 void ApplicationCacheHost::fillResourceList(ResourceInfoList* resources)
319 {
320     ApplicationCache* cache = applicationCache();
321     if (!cache || !cache->isComplete())
322         return;
323
324     for (const auto& urlAndResource : cache->resources()) {
325         ApplicationCacheResource* resource = urlAndResource.value.get();
326
327         unsigned type = resource->type();
328         bool isMaster = type & ApplicationCacheResource::Master;
329         bool isManifest = type & ApplicationCacheResource::Manifest;
330         bool isExplicit = type & ApplicationCacheResource::Explicit;
331         bool isForeign = type & ApplicationCacheResource::Foreign;
332         bool isFallback = type & ApplicationCacheResource::Fallback;
333
334         resources->append(ResourceInfo(resource->url(), isMaster, isManifest, isFallback, isForeign, isExplicit, resource->estimatedSizeInStorage()));
335     }
336 }
337
338 ApplicationCacheHost::CacheInfo ApplicationCacheHost::applicationCacheInfo()
339 {
340     ApplicationCache* cache = applicationCache();
341     if (!cache || !cache->isComplete())
342         return CacheInfo(URL(), 0, 0, 0);
343
344     // FIXME: Add "Creation Time" and "Update Time" to Application Caches.
345     return CacheInfo(cache->manifestResource()->url(), 0, 0, cache->estimatedSizeInStorage());
346 }
347
348 void ApplicationCacheHost::dispatchDOMEvent(EventID id, int total, int done)
349 {
350     if (m_domApplicationCache) {
351         const AtomicString& eventType = DOMApplicationCache::toEventType(id);
352         RefPtr<Event> event;
353         if (id == PROGRESS_EVENT)
354             event = ProgressEvent::create(eventType, true, done, total);
355         else
356             event = Event::create(eventType, false, false);
357         m_domApplicationCache->dispatchEvent(event, ASSERT_NO_EXCEPTION);
358     }
359 }
360
361 void ApplicationCacheHost::setCandidateApplicationCacheGroup(ApplicationCacheGroup* group)
362 {
363     ASSERT(!m_applicationCache);
364     m_candidateApplicationCacheGroup = group;
365 }
366     
367 void ApplicationCacheHost::setApplicationCache(PassRefPtr<ApplicationCache> applicationCache)
368 {
369     if (m_candidateApplicationCacheGroup) {
370         ASSERT(!m_applicationCache);
371         m_candidateApplicationCacheGroup = 0;
372     }
373
374     m_applicationCache = applicationCache;
375 }
376
377 bool ApplicationCacheHost::shouldLoadResourceFromApplicationCache(const ResourceRequest& request, ApplicationCacheResource*& resource)
378 {
379     ApplicationCache* cache = applicationCache();
380     if (!cache || !cache->isComplete())
381         return false;
382
383     // If the resource is not to be fetched using the HTTP GET mechanism or equivalent, or if its URL has a different
384     // <scheme> component than the application cache's manifest, then fetch the resource normally.
385     if (!ApplicationCache::requestIsHTTPOrHTTPSGet(request) || !equalIgnoringCase(request.url().protocol(), cache->manifestResource()->url().protocol()))
386         return false;
387
388     // If the resource's URL is an master entry, the manifest, an explicit entry, or a fallback entry
389     // in the application cache, then get the resource from the cache (instead of fetching it).
390     resource = cache->resourceForURL(request.url());
391
392     // Resources that match fallback namespaces or online whitelist entries are fetched from the network,
393     // unless they are also cached.
394     if (!resource && (cache->allowsAllNetworkRequests() || cache->urlMatchesFallbackNamespace(request.url()) || cache->isURLInOnlineWhitelist(request.url())))
395         return false;
396
397     // Resources that are not present in the manifest will always fail to load (at least, after the
398     // cache has been primed the first time), making the testing of offline applications simpler.
399     return true;
400 }
401
402 bool ApplicationCacheHost::getApplicationCacheFallbackResource(const ResourceRequest& request, ApplicationCacheResource*& resource, ApplicationCache* cache)
403 {
404     if (!cache) {
405         cache = applicationCache();
406         if (!cache)
407             return false;
408     }
409     if (!cache->isComplete())
410         return false;
411     
412     // If the resource is not a HTTP/HTTPS GET, then abort
413     if (!ApplicationCache::requestIsHTTPOrHTTPSGet(request))
414         return false;
415
416     URL fallbackURL;
417     if (cache->isURLInOnlineWhitelist(request.url()))
418         return false;
419     if (!cache->urlMatchesFallbackNamespace(request.url(), &fallbackURL))
420         return false;
421
422     resource = cache->resourceForURL(fallbackURL);
423     ASSERT(resource);
424
425     return true;
426 }
427
428 bool ApplicationCacheHost::scheduleLoadFallbackResourceFromApplicationCache(ResourceLoader* loader, ApplicationCache* cache)
429 {
430     if (!isApplicationCacheEnabled() && !isApplicationCacheBlockedForRequest(loader->request()))
431         return false;
432
433     ApplicationCacheResource* resource;
434     if (!getApplicationCacheFallbackResource(loader->request(), resource, cache))
435         return false;
436
437     loader->willSwitchToSubstituteResource();
438
439     m_documentLoader.m_pendingSubstituteResources.set(loader, resource);
440     m_documentLoader.deliverSubstituteResourcesAfterDelay();
441
442     return true;
443 }
444
445 ApplicationCacheHost::Status ApplicationCacheHost::status() const
446 {
447     ApplicationCache* cache = applicationCache();    
448     if (!cache)
449         return UNCACHED;
450
451     switch (cache->group()->updateStatus()) {
452         case ApplicationCacheGroup::Checking:
453             return CHECKING;
454         case ApplicationCacheGroup::Downloading:
455             return DOWNLOADING;
456         case ApplicationCacheGroup::Idle: {
457             if (cache->group()->isObsolete())
458                 return OBSOLETE;
459             if (cache != cache->group()->newestCache())
460                 return UPDATEREADY;
461             return IDLE;
462         }
463     }
464
465     ASSERT_NOT_REACHED();
466     return UNCACHED;
467 }
468
469 bool ApplicationCacheHost::update()
470 {
471     ApplicationCache* cache = applicationCache();
472     if (!cache)
473         return false;
474     cache->group()->update(m_documentLoader.frame(), ApplicationCacheUpdateWithoutBrowsingContext);
475     return true;
476 }
477
478 bool ApplicationCacheHost::swapCache()
479 {
480     ApplicationCache* cache = applicationCache();
481     if (!cache)
482         return false;
483
484     // If the group of application caches to which cache belongs has the lifecycle status obsolete, unassociate document from cache.
485     if (cache->group()->isObsolete()) {
486         cache->group()->disassociateDocumentLoader(&m_documentLoader);
487         return true;
488     }
489
490     // If there is no newer cache, raise an INVALID_STATE_ERR exception.
491     ApplicationCache* newestCache = cache->group()->newestCache();
492     if (cache == newestCache)
493         return false;
494     
495     ASSERT(cache->group() == newestCache->group());
496     setApplicationCache(newestCache);
497     InspectorInstrumentation::updateApplicationCacheStatus(m_documentLoader.frame());
498     return true;
499 }
500
501 void ApplicationCacheHost::abort()
502 {
503     ApplicationCacheGroup* cacheGroup = candidateApplicationCacheGroup();
504     if (cacheGroup)
505         cacheGroup->abort(m_documentLoader.frame());
506     else {
507         ApplicationCache* cache = applicationCache();
508         if (cache)
509             cache->group()->abort(m_documentLoader.frame());
510     }
511 }
512
513 bool ApplicationCacheHost::isApplicationCacheEnabled()
514 {
515     return m_documentLoader.frame() && m_documentLoader.frame()->settings().offlineWebApplicationCacheEnabled() && !m_documentLoader.frame()->page()->usesEphemeralSession();
516 }
517
518 bool ApplicationCacheHost::isApplicationCacheBlockedForRequest(const ResourceRequest& request)
519 {
520     Frame* frame = m_documentLoader.frame();
521     if (!frame)
522         return false;
523
524     if (frame->isMainFrame())
525         return false;
526
527     Ref<SecurityOrigin> origin(SecurityOrigin::create(request.url()));
528     return !origin.get().canAccessApplicationCache(frame->document()->topOrigin());
529 }
530
531 }  // namespace WebCore