Remove ENABLE(SVG) guards
[WebKit-https.git] / Source / WebCore / loader / cache / CachedResource.cpp
1 /*
2     Copyright (C) 1998 Lars Knoll (knoll@mpi-hd.mpg.de)
3     Copyright (C) 2001 Dirk Mueller (mueller@kde.org)
4     Copyright (C) 2002 Waldo Bastian (bastian@kde.org)
5     Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
6     Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Apple Inc. All rights reserved.
7
8     This library is free software; you can redistribute it and/or
9     modify it under the terms of the GNU Library General Public
10     License as published by the Free Software Foundation; either
11     version 2 of the License, or (at your option) any later version.
12
13     This library is distributed in the hope that it will be useful,
14     but WITHOUT ANY WARRANTY; without even the implied warranty of
15     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16     Library General Public License for more details.
17
18     You should have received a copy of the GNU Library General Public License
19     along with this library; see the file COPYING.LIB.  If not, write to
20     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21     Boston, MA 02110-1301, USA.
22 */
23
24 #include "config.h"
25 #include "CachedResource.h"
26
27 #include "CachedResourceClient.h"
28 #include "CachedResourceClientWalker.h"
29 #include "CachedResourceHandle.h"
30 #include "CachedResourceLoader.h"
31 #include "CrossOriginAccessControl.h"
32 #include "Document.h"
33 #include "DocumentLoader.h"
34 #include "FrameLoader.h"
35 #include "FrameLoaderClient.h"
36 #include "InspectorInstrumentation.h"
37 #include "URL.h"
38 #include "LoaderStrategy.h"
39 #include "Logging.h"
40 #include "MemoryCache.h"
41 #include "PlatformStrategies.h"
42 #include "PurgeableBuffer.h"
43 #include "ResourceBuffer.h"
44 #include "ResourceHandle.h"
45 #include "ResourceLoadScheduler.h"
46 #include "SchemeRegistry.h"
47 #include "SecurityOrigin.h"
48 #include "SecurityPolicy.h"
49 #include "SubresourceLoader.h"
50 #include <wtf/CurrentTime.h>
51 #include <wtf/MathExtras.h>
52 #include <wtf/RefCountedLeakCounter.h>
53 #include <wtf/StdLibExtras.h>
54 #include <wtf/text/CString.h>
55 #include <wtf/Vector.h>
56
57 #if USE(QUICK_LOOK)
58 #include "QuickLook.h"
59 #endif
60
61 using namespace WTF;
62
63 namespace WebCore {
64
65 // These response headers are not copied from a revalidated response to the
66 // cached response headers. For compatibility, this list is based on Chromium's
67 // net/http/http_response_headers.cc.
68 const char* const headersToIgnoreAfterRevalidation[] = {
69     "allow",
70     "connection",
71     "etag",
72     "expires",
73     "keep-alive",
74     "last-modified"
75     "proxy-authenticate",
76     "proxy-connection",
77     "trailer",
78     "transfer-encoding",
79     "upgrade",
80     "www-authenticate",
81     "x-frame-options",
82     "x-xss-protection",
83 };
84
85 // Some header prefixes mean "Don't copy this header from a 304 response.".
86 // Rather than listing all the relevant headers, we can consolidate them into
87 // this list, also grabbed from Chromium's net/http/http_response_headers.cc.
88 const char* const headerPrefixesToIgnoreAfterRevalidation[] = {
89     "content-",
90     "x-content-",
91     "x-webkit-"
92 };
93
94 static inline bool shouldUpdateHeaderAfterRevalidation(const AtomicString& header)
95 {
96     for (size_t i = 0; i < WTF_ARRAY_LENGTH(headersToIgnoreAfterRevalidation); i++) {
97         if (equalIgnoringCase(header, headersToIgnoreAfterRevalidation[i]))
98             return false;
99     }
100     for (size_t i = 0; i < WTF_ARRAY_LENGTH(headerPrefixesToIgnoreAfterRevalidation); i++) {
101         if (header.startsWith(headerPrefixesToIgnoreAfterRevalidation[i], false))
102             return false;
103     }
104     return true;
105 }
106
107 static ResourceLoadPriority defaultPriorityForResourceType(CachedResource::Type type)
108 {
109     switch (type) {
110     case CachedResource::MainResource:
111         return ResourceLoadPriorityVeryHigh;
112     case CachedResource::CSSStyleSheet:
113         return ResourceLoadPriorityHigh;
114     case CachedResource::Script:
115     case CachedResource::FontResource:
116     case CachedResource::RawResource:
117         return ResourceLoadPriorityMedium;
118     case CachedResource::ImageResource:
119         return ResourceLoadPriorityLow;
120 #if ENABLE(XSLT)
121     case CachedResource::XSLStyleSheet:
122         return ResourceLoadPriorityHigh;
123 #endif
124     case CachedResource::SVGDocumentResource:
125         return ResourceLoadPriorityLow;
126 #if ENABLE(LINK_PREFETCH)
127     case CachedResource::LinkPrefetch:
128         return ResourceLoadPriorityVeryLow;
129     case CachedResource::LinkSubresource:
130         return ResourceLoadPriorityVeryLow;
131 #endif
132 #if ENABLE(VIDEO_TRACK)
133     case CachedResource::TextTrackResource:
134         return ResourceLoadPriorityLow;
135 #endif
136     }
137     ASSERT_NOT_REACHED();
138     return ResourceLoadPriorityLow;
139 }
140
141 static double deadDecodedDataDeletionIntervalForResourceType(CachedResource::Type type)
142 {
143     if (type == CachedResource::Script)
144         return 0;
145     return memoryCache()->deadDecodedDataDeletionInterval();
146 }
147
148 DEFINE_DEBUG_ONLY_GLOBAL(RefCountedLeakCounter, cachedResourceLeakCounter, ("CachedResource"));
149
150 CachedResource::CachedResource(const ResourceRequest& request, Type type)
151     : m_resourceRequest(request)
152     , m_loadPriority(defaultPriorityForResourceType(type))
153     , m_responseTimestamp(currentTime())
154     , m_decodedDataDeletionTimer(this, &CachedResource::decodedDataDeletionTimerFired, deadDecodedDataDeletionIntervalForResourceType(type))
155     , m_lastDecodedAccessTime(0)
156     , m_loadFinishTime(0)
157     , m_encodedSize(0)
158     , m_decodedSize(0)
159     , m_accessCount(0)
160     , m_handleCount(0)
161     , m_preloadCount(0)
162     , m_preloadResult(PreloadNotReferenced)
163     , m_inLiveDecodedResourcesList(false)
164     , m_requestedFromNetworkingLayer(false)
165     , m_inCache(false)
166     , m_loading(false)
167     , m_switchingClientsToRevalidatedResource(false)
168     , m_type(type)
169     , m_status(Pending)
170 #ifndef NDEBUG
171     , m_deleted(false)
172     , m_lruIndex(0)
173 #endif
174     , m_nextInAllResourcesList(0)
175     , m_prevInAllResourcesList(0)
176     , m_nextInLiveResourcesList(0)
177     , m_prevInLiveResourcesList(0)
178     , m_owningCachedResourceLoader(0)
179     , m_resourceToRevalidate(0)
180     , m_proxyResource(0)
181 {
182     ASSERT(m_type == unsigned(type)); // m_type is a bitfield, so this tests careless updates of the enum.
183 #ifndef NDEBUG
184     cachedResourceLeakCounter.increment();
185 #endif
186
187     if (!m_resourceRequest.url().hasFragmentIdentifier())
188         return;
189     URL urlForCache = MemoryCache::removeFragmentIdentifierIfNeeded(m_resourceRequest.url());
190     if (urlForCache.hasFragmentIdentifier())
191         return;
192     m_fragmentIdentifierForRequest = m_resourceRequest.url().fragmentIdentifier();
193     m_resourceRequest.setURL(urlForCache);
194 }
195
196 CachedResource::~CachedResource()
197 {
198     ASSERT(!m_resourceToRevalidate); // Should be true because canDelete() checks this.
199     ASSERT(canDelete());
200     ASSERT(!inCache());
201     ASSERT(!m_deleted);
202     ASSERT(url().isNull() || memoryCache()->resourceForRequest(resourceRequest()) != this);
203
204 #ifndef NDEBUG
205     m_deleted = true;
206     cachedResourceLeakCounter.decrement();
207 #endif
208
209     if (m_owningCachedResourceLoader)
210         m_owningCachedResourceLoader->removeCachedResource(this);
211 }
212
213 void CachedResource::failBeforeStarting()
214 {
215     // FIXME: What if resources in other frames were waiting for this revalidation?
216     LOG(ResourceLoading, "Cannot start loading '%s'", url().string().latin1().data());
217     if (m_resourceToRevalidate) 
218         memoryCache()->revalidationFailed(this); 
219     error(CachedResource::LoadError);
220 }
221
222 void CachedResource::addAdditionalRequestHeaders(CachedResourceLoader* cachedResourceLoader)
223 {
224     // Note: We skip the Content-Security-Policy check here because we check
225     // the Content-Security-Policy at the CachedResourceLoader layer so we can
226     // handle different resource types differently.
227
228     FrameLoader& frameLoader = cachedResourceLoader->frame()->loader();
229     String outgoingReferrer;
230     String outgoingOrigin;
231     if (m_resourceRequest.httpReferrer().isNull()) {
232         outgoingReferrer = frameLoader.outgoingReferrer();
233         outgoingOrigin = frameLoader.outgoingOrigin();
234     } else {
235         outgoingReferrer = m_resourceRequest.httpReferrer();
236         outgoingOrigin = SecurityOrigin::createFromString(outgoingReferrer)->toString();
237     }
238
239     outgoingReferrer = SecurityPolicy::generateReferrerHeader(cachedResourceLoader->document()->referrerPolicy(), m_resourceRequest.url(), outgoingReferrer);
240     if (outgoingReferrer.isEmpty())
241         m_resourceRequest.clearHTTPReferrer();
242     else if (!m_resourceRequest.httpReferrer())
243         m_resourceRequest.setHTTPReferrer(outgoingReferrer);
244     FrameLoader::addHTTPOriginIfNeeded(m_resourceRequest, outgoingOrigin);
245
246     frameLoader.addExtraFieldsToSubresourceRequest(m_resourceRequest);
247 }
248
249 void CachedResource::load(CachedResourceLoader* cachedResourceLoader, const ResourceLoaderOptions& options)
250 {
251     if (!cachedResourceLoader->frame()) {
252         failBeforeStarting();
253         return;
254     }
255
256     FrameLoader& frameLoader = cachedResourceLoader->frame()->loader();
257     if (options.securityCheck == DoSecurityCheck && (frameLoader.state() == FrameStateProvisional || !frameLoader.activeDocumentLoader() || frameLoader.activeDocumentLoader()->isStopping())) {
258         failBeforeStarting();
259         return;
260     }
261
262     m_options = options;
263     m_loading = true;
264
265 #if USE(QUICK_LOOK)
266     if (!m_resourceRequest.isNull() && m_resourceRequest.url().protocolIs(QLPreviewProtocol())) {
267         // When QuickLook is invoked to convert a document, it returns a unique URL in the
268         // NSURLReponse for the main document. To make safeQLURLForDocumentURLAndResourceURL()
269         // work, we need to use the QL URL not the original URL.
270         const URL& documentURL = cachedResourceLoader->frame() ? cachedResourceLoader->frame()->loader().documentLoader()->response().url() : cachedResourceLoader->document()->url();
271         m_resourceRequest.setURL(safeQLURLForDocumentURLAndResourceURL(documentURL, url()));
272     }
273 #endif
274
275     if (!accept().isEmpty())
276         m_resourceRequest.setHTTPAccept(accept());
277
278     if (isCacheValidator()) {
279         CachedResource* resourceToRevalidate = m_resourceToRevalidate;
280         ASSERT(resourceToRevalidate->canUseCacheValidator());
281         ASSERT(resourceToRevalidate->isLoaded());
282         const String& lastModified = resourceToRevalidate->response().httpHeaderField("Last-Modified");
283         const String& eTag = resourceToRevalidate->response().httpHeaderField("ETag");
284         if (!lastModified.isEmpty() || !eTag.isEmpty()) {
285             ASSERT(cachedResourceLoader->cachePolicy(type()) != CachePolicyReload);
286             if (cachedResourceLoader->cachePolicy(type()) == CachePolicyRevalidate)
287                 m_resourceRequest.setHTTPHeaderField("Cache-Control", "max-age=0");
288             if (!lastModified.isEmpty())
289                 m_resourceRequest.setHTTPHeaderField("If-Modified-Since", lastModified);
290             if (!eTag.isEmpty())
291                 m_resourceRequest.setHTTPHeaderField("If-None-Match", eTag);
292         }
293     }
294
295 #if ENABLE(LINK_PREFETCH)
296     if (type() == CachedResource::LinkPrefetch || type() == CachedResource::LinkSubresource)
297         m_resourceRequest.setHTTPHeaderField("Purpose", "prefetch");
298 #endif
299     m_resourceRequest.setPriority(loadPriority());
300
301     if (type() != MainResource)
302         addAdditionalRequestHeaders(cachedResourceLoader);
303
304     // FIXME: It's unfortunate that the cache layer and below get to know anything about fragment identifiers.
305     // We should look into removing the expectation of that knowledge from the platform network stacks.
306     ResourceRequest request(m_resourceRequest);
307     if (!m_fragmentIdentifierForRequest.isNull()) {
308         URL url = request.url();
309         url.setFragmentIdentifier(m_fragmentIdentifierForRequest);
310         request.setURL(url);
311         m_fragmentIdentifierForRequest = String();
312     }
313
314     m_loader = platformStrategies()->loaderStrategy()->resourceLoadScheduler()->scheduleSubresourceLoad(cachedResourceLoader->frame(), this, request, request.priority(), options);
315     if (!m_loader) {
316         failBeforeStarting();
317         return;
318     }
319
320     m_status = Pending;
321 }
322
323 void CachedResource::checkNotify()
324 {
325     if (isLoading())
326         return;
327
328     CachedResourceClientWalker<CachedResourceClient> w(m_clients);
329     while (CachedResourceClient* c = w.next())
330         c->notifyFinished(this);
331 }
332
333 void CachedResource::addDataBuffer(ResourceBuffer*)
334 {
335     ASSERT(m_options.dataBufferingPolicy == BufferData);
336 }
337
338 void CachedResource::addData(const char*, unsigned)
339 {
340     ASSERT(m_options.dataBufferingPolicy == DoNotBufferData);
341 }
342
343 void CachedResource::finishLoading(ResourceBuffer*)
344 {
345     setLoading(false);
346     checkNotify();
347 }
348
349 void CachedResource::error(CachedResource::Status status)
350 {
351     setStatus(status);
352     ASSERT(errorOccurred());
353     m_data.clear();
354
355     setLoading(false);
356     checkNotify();
357 }
358     
359 void CachedResource::cancelLoad()
360 {
361     if (!isLoading())
362         return;
363
364     setStatus(LoadError);
365     setLoading(false);
366     checkNotify();
367 }
368
369 void CachedResource::finish()
370 {
371     if (!errorOccurred())
372         m_status = Cached;
373 }
374
375 bool CachedResource::passesAccessControlCheck(SecurityOrigin* securityOrigin)
376 {
377     String errorDescription;
378     return WebCore::passesAccessControlCheck(m_response, resourceRequest().allowCookies() ? AllowStoredCredentials : DoNotAllowStoredCredentials, securityOrigin, errorDescription);
379 }
380
381 bool CachedResource::isExpired() const
382 {
383     if (m_response.isNull())
384         return false;
385
386     return currentAge() > freshnessLifetime();
387 }
388
389 double CachedResource::currentAge() const
390 {
391     // RFC2616 13.2.3
392     // No compensation for latency as that is not terribly important in practice
393     double dateValue = m_response.date();
394     double apparentAge = std::isfinite(dateValue) ? std::max(0., m_responseTimestamp - dateValue) : 0;
395     double ageValue = m_response.age();
396     double correctedReceivedAge = std::isfinite(ageValue) ? std::max(apparentAge, ageValue) : apparentAge;
397     double residentTime = currentTime() - m_responseTimestamp;
398     return correctedReceivedAge + residentTime;
399 }
400
401 double CachedResource::freshnessLifetime() const
402 {
403     if (!m_response.url().protocolIsInHTTPFamily()) {
404         // Don't cache non-HTTP main resources since we can't check for freshness.
405         // FIXME: We should not cache subresources either, but when we tried this
406         // it caused performance and flakiness issues in our test infrastructure.
407         if (m_type == MainResource && !SchemeRegistry::shouldCacheResponsesFromURLSchemeIndefinitely(m_response.url().protocol()))
408             return 0;
409
410         return std::numeric_limits<double>::max();
411     }
412
413     // RFC2616 13.2.4
414     double maxAgeValue = m_response.cacheControlMaxAge();
415     if (std::isfinite(maxAgeValue))
416         return maxAgeValue;
417     double expiresValue = m_response.expires();
418     double dateValue = m_response.date();
419     double creationTime = std::isfinite(dateValue) ? dateValue : m_responseTimestamp;
420     if (std::isfinite(expiresValue))
421         return expiresValue - creationTime;
422     double lastModifiedValue = m_response.lastModified();
423     if (std::isfinite(lastModifiedValue))
424         return (creationTime - lastModifiedValue) * 0.1;
425     // If no cache headers are present, the specification leaves the decision to the UA. Other browsers seem to opt for 0.
426     return 0;
427 }
428
429 void CachedResource::responseReceived(const ResourceResponse& response)
430 {
431     setResponse(response);
432     m_responseTimestamp = currentTime();
433     String encoding = response.textEncodingName();
434     if (!encoding.isNull())
435         setEncoding(encoding);
436 }
437
438 void CachedResource::clearLoader()
439 {
440     ASSERT(m_loader);
441     m_loader = 0;
442 }
443
444 void CachedResource::addClient(CachedResourceClient* client)
445 {
446     if (addClientToSet(client))
447         didAddClient(client);
448 }
449
450 void CachedResource::didAddClient(CachedResourceClient* c)
451 {
452     if (m_decodedDataDeletionTimer.isActive())
453         m_decodedDataDeletionTimer.stop();
454
455     if (m_clientsAwaitingCallback.contains(c)) {
456         m_clients.add(c);
457         m_clientsAwaitingCallback.remove(c);
458     }
459     if (!isLoading() && !stillNeedsLoad())
460         c->notifyFinished(this);
461 }
462
463 bool CachedResource::addClientToSet(CachedResourceClient* client)
464 {
465     ASSERT(!isPurgeable());
466
467     if (m_preloadResult == PreloadNotReferenced) {
468         if (isLoaded())
469             m_preloadResult = PreloadReferencedWhileComplete;
470         else if (m_requestedFromNetworkingLayer)
471             m_preloadResult = PreloadReferencedWhileLoading;
472         else
473             m_preloadResult = PreloadReferenced;
474     }
475     if (!hasClients() && inCache())
476         memoryCache()->addToLiveResourcesSize(this);
477
478     if ((m_type == RawResource || m_type == MainResource) && !m_response.isNull() && !m_proxyResource) {
479         // Certain resources (especially XHRs and main resources) do crazy things if an asynchronous load returns
480         // synchronously (e.g., scripts may not have set all the state they need to handle the load).
481         // Therefore, rather than immediately sending callbacks on a cache hit like other CachedResources,
482         // we schedule the callbacks and ensure we never finish synchronously.
483         ASSERT(!m_clientsAwaitingCallback.contains(client));
484         m_clientsAwaitingCallback.add(client, CachedResourceCallback::schedule(this, client));
485         return false;
486     }
487
488     m_clients.add(client);
489     return true;
490 }
491
492 void CachedResource::removeClient(CachedResourceClient* client)
493 {
494     OwnPtr<CachedResourceCallback> callback = m_clientsAwaitingCallback.take(client);
495     if (callback) {
496         ASSERT(!m_clients.contains(client));
497         callback->cancel();
498         callback.clear();
499     } else {
500         ASSERT(m_clients.contains(client));
501         m_clients.remove(client);
502         didRemoveClient(client);
503     }
504
505     bool deleted = deleteIfPossible();
506     if (!deleted && !hasClients()) {
507         if (inCache()) {
508             memoryCache()->removeFromLiveResourcesSize(this);
509             memoryCache()->removeFromLiveDecodedResourcesList(this);
510         }
511         if (!m_switchingClientsToRevalidatedResource)
512             allClientsRemoved();
513         destroyDecodedDataIfNeeded();
514         if (response().cacheControlContainsNoStore()) {
515             // RFC2616 14.9.2:
516             // "no-store: ... MUST make a best-effort attempt to remove the information from volatile storage as promptly as possible"
517             // "... History buffers MAY store such responses as part of their normal operation."
518             // We allow non-secure content to be reused in history, but we do not allow secure content to be reused.
519             if (url().protocolIs("https"))
520                 memoryCache()->remove(this);
521         } else
522             memoryCache()->prune();
523     }
524     // This object may be dead here.
525 }
526
527 void CachedResource::destroyDecodedDataIfNeeded()
528 {
529     if (!m_decodedSize)
530         return;
531     if (!memoryCache()->deadDecodedDataDeletionInterval())
532         return;
533     m_decodedDataDeletionTimer.restart();
534 }
535
536 void CachedResource::decodedDataDeletionTimerFired(DeferrableOneShotTimer<CachedResource>&)
537 {
538     destroyDecodedData();
539 }
540
541 bool CachedResource::deleteIfPossible()
542 {
543     if (canDelete() && !inCache()) {
544         InspectorInstrumentation::willDestroyCachedResource(this);
545         delete this;
546         return true;
547     }
548     return false;
549 }
550
551 void CachedResource::setDecodedSize(unsigned size)
552 {
553     if (size == m_decodedSize)
554         return;
555
556     int delta = size - m_decodedSize;
557
558     // The object must now be moved to a different queue, since its size has been changed.
559     // We have to remove explicitly before updating m_decodedSize, so that we find the correct previous
560     // queue.
561     if (inCache())
562         memoryCache()->removeFromLRUList(this);
563     
564     m_decodedSize = size;
565    
566     if (inCache()) { 
567         // Now insert into the new LRU list.
568         memoryCache()->insertInLRUList(this);
569         
570         // Insert into or remove from the live decoded list if necessary.
571         // When inserting into the LiveDecodedResourcesList it is possible
572         // that the m_lastDecodedAccessTime is still zero or smaller than
573         // the m_lastDecodedAccessTime of the current list head. This is a
574         // violation of the invariant that the list is to be kept sorted
575         // by access time. The weakening of the invariant does not pose
576         // a problem. For more details please see: https://bugs.webkit.org/show_bug.cgi?id=30209
577         if (m_decodedSize && !m_inLiveDecodedResourcesList && hasClients())
578             memoryCache()->insertInLiveDecodedResourcesList(this);
579         else if (!m_decodedSize && m_inLiveDecodedResourcesList)
580             memoryCache()->removeFromLiveDecodedResourcesList(this);
581
582         // Update the cache's size totals.
583         memoryCache()->adjustSize(hasClients(), delta);
584     }
585 }
586
587 void CachedResource::setEncodedSize(unsigned size)
588 {
589     if (size == m_encodedSize)
590         return;
591
592     // The size cannot ever shrink (unless it is being nulled out because of an error).  If it ever does, assert.
593     ASSERT(size == 0 || size >= m_encodedSize);
594     
595     int delta = size - m_encodedSize;
596
597     // The object must now be moved to a different queue, since its size has been changed.
598     // We have to remove explicitly before updating m_encodedSize, so that we find the correct previous
599     // queue.
600     if (inCache())
601         memoryCache()->removeFromLRUList(this);
602     
603     m_encodedSize = size;
604    
605     if (inCache()) { 
606         // Now insert into the new LRU list.
607         memoryCache()->insertInLRUList(this);
608         
609         // Update the cache's size totals.
610         memoryCache()->adjustSize(hasClients(), delta);
611     }
612 }
613
614 void CachedResource::didAccessDecodedData(double timeStamp)
615 {
616     m_lastDecodedAccessTime = timeStamp;
617     
618     if (inCache()) {
619         if (m_inLiveDecodedResourcesList) {
620             memoryCache()->removeFromLiveDecodedResourcesList(this);
621             memoryCache()->insertInLiveDecodedResourcesList(this);
622         }
623         memoryCache()->prune();
624     }
625 }
626     
627 void CachedResource::setResourceToRevalidate(CachedResource* resource) 
628
629     ASSERT(resource);
630     ASSERT(!m_resourceToRevalidate);
631     ASSERT(resource != this);
632     ASSERT(m_handlesToRevalidate.isEmpty());
633     ASSERT(resource->type() == type());
634
635     LOG(ResourceLoading, "CachedResource %p setResourceToRevalidate %p", this, resource);
636
637     // The following assert should be investigated whenever it occurs. Although it should never fire, it currently does in rare circumstances.
638     // https://bugs.webkit.org/show_bug.cgi?id=28604.
639     // So the code needs to be robust to this assert failing thus the "if (m_resourceToRevalidate->m_proxyResource == this)" in CachedResource::clearResourceToRevalidate.
640     ASSERT(!resource->m_proxyResource);
641
642     resource->m_proxyResource = this;
643     m_resourceToRevalidate = resource;
644 }
645
646 void CachedResource::clearResourceToRevalidate() 
647
648     ASSERT(m_resourceToRevalidate);
649     if (m_switchingClientsToRevalidatedResource)
650         return;
651
652     // A resource may start revalidation before this method has been called, so check that this resource is still the proxy resource before clearing it out.
653     if (m_resourceToRevalidate->m_proxyResource == this) {
654         m_resourceToRevalidate->m_proxyResource = 0;
655         m_resourceToRevalidate->deleteIfPossible();
656     }
657     m_handlesToRevalidate.clear();
658     m_resourceToRevalidate = 0;
659     deleteIfPossible();
660 }
661     
662 void CachedResource::switchClientsToRevalidatedResource()
663 {
664     ASSERT(m_resourceToRevalidate);
665     ASSERT(m_resourceToRevalidate->inCache());
666     ASSERT(!inCache());
667
668     LOG(ResourceLoading, "CachedResource %p switchClientsToRevalidatedResource %p", this, m_resourceToRevalidate);
669
670     m_switchingClientsToRevalidatedResource = true;
671     HashSet<CachedResourceHandleBase*>::iterator end = m_handlesToRevalidate.end();
672     for (HashSet<CachedResourceHandleBase*>::iterator it = m_handlesToRevalidate.begin(); it != end; ++it) {
673         CachedResourceHandleBase* handle = *it;
674         handle->m_resource = m_resourceToRevalidate;
675         m_resourceToRevalidate->registerHandle(handle);
676         --m_handleCount;
677     }
678     ASSERT(!m_handleCount);
679     m_handlesToRevalidate.clear();
680
681     Vector<CachedResourceClient*> clientsToMove;
682     HashCountedSet<CachedResourceClient*>::iterator end2 = m_clients.end();
683     for (HashCountedSet<CachedResourceClient*>::iterator it = m_clients.begin(); it != end2; ++it) {
684         CachedResourceClient* client = it->key;
685         unsigned count = it->value;
686         while (count) {
687             clientsToMove.append(client);
688             --count;
689         }
690     }
691
692     unsigned moveCount = clientsToMove.size();
693     for (unsigned n = 0; n < moveCount; ++n)
694         removeClient(clientsToMove[n]);
695     ASSERT(m_clients.isEmpty());
696
697     for (unsigned n = 0; n < moveCount; ++n)
698         m_resourceToRevalidate->addClientToSet(clientsToMove[n]);
699     for (unsigned n = 0; n < moveCount; ++n) {
700         // Calling didAddClient may do anything, including trying to cancel revalidation.
701         // Assert that it didn't succeed.
702         ASSERT(m_resourceToRevalidate);
703         // Calling didAddClient for a client may end up removing another client. In that case it won't be in the set anymore.
704         if (m_resourceToRevalidate->m_clients.contains(clientsToMove[n]))
705             m_resourceToRevalidate->didAddClient(clientsToMove[n]);
706     }
707     m_switchingClientsToRevalidatedResource = false;
708 }
709
710 void CachedResource::updateResponseAfterRevalidation(const ResourceResponse& validatingResponse)
711 {
712     m_responseTimestamp = currentTime();
713
714     // RFC2616 10.3.5
715     // Update cached headers from the 304 response
716     for (const auto& header : validatingResponse.httpHeaderFields()) {
717         // Entity headers should not be sent by servers when generating a 304
718         // response; misconfigured servers send them anyway. We shouldn't allow
719         // such headers to update the original request. We'll base this on the
720         // list defined by RFC2616 7.1, with a few additions for extension headers
721         // we care about.
722         if (!shouldUpdateHeaderAfterRevalidation(header.key))
723             continue;
724         m_response.setHTTPHeaderField(header.key, header.value);
725     }
726 }
727
728 void CachedResource::registerHandle(CachedResourceHandleBase* h)
729 {
730     ++m_handleCount;
731     if (m_resourceToRevalidate)
732         m_handlesToRevalidate.add(h);
733 }
734
735 void CachedResource::unregisterHandle(CachedResourceHandleBase* h)
736 {
737     ASSERT(m_handleCount > 0);
738     --m_handleCount;
739
740     if (m_resourceToRevalidate)
741          m_handlesToRevalidate.remove(h);
742
743     if (!m_handleCount)
744         deleteIfPossible();
745 }
746
747 bool CachedResource::canUseCacheValidator() const
748 {
749     if (m_loading || errorOccurred())
750         return false;
751
752     if (m_response.cacheControlContainsNoStore())
753         return false;
754     return m_response.hasCacheValidatorFields();
755 }
756
757 bool CachedResource::mustRevalidateDueToCacheHeaders(CachePolicy cachePolicy) const
758 {    
759     ASSERT(cachePolicy == CachePolicyRevalidate || cachePolicy == CachePolicyCache || cachePolicy == CachePolicyVerify);
760
761     if (cachePolicy == CachePolicyRevalidate)
762         return true;
763
764     if (m_response.cacheControlContainsNoCache() || m_response.cacheControlContainsNoStore()) {
765         LOG(ResourceLoading, "CachedResource %p mustRevalidate because of m_response.cacheControlContainsNoCache() || m_response.cacheControlContainsNoStore()\n", this);
766         return true;
767     }
768
769     if (cachePolicy == CachePolicyCache) {
770         if (m_response.cacheControlContainsMustRevalidate() && isExpired()) {
771             LOG(ResourceLoading, "CachedResource %p mustRevalidate because of cachePolicy == CachePolicyCache and m_response.cacheControlContainsMustRevalidate() && isExpired()\n", this);
772             return true;
773         }
774         return false;
775     }
776
777     // CachePolicyVerify
778     if (isExpired()) {
779         LOG(ResourceLoading, "CachedResource %p mustRevalidate because of isExpired()\n", this);
780         return true;
781     }
782
783     return false;
784 }
785
786 bool CachedResource::isSafeToMakePurgeable() const
787
788 #if ENABLE(DISK_IMAGE_CACHE)
789     // It does not make sense to have a resource in the disk image cache
790     // (memory mapped on disk) and purgeable (in memory). So do not allow
791     // disk image cached resources to be purgeable.
792     if (isUsingDiskImageCache())
793         return false;
794 #endif
795
796     return !hasClients() && !m_proxyResource && !m_resourceToRevalidate;
797 }
798
799 bool CachedResource::makePurgeable(bool purgeable) 
800
801     if (purgeable) {
802         ASSERT(isSafeToMakePurgeable());
803
804         if (m_purgeableData) {
805             ASSERT(!m_data);
806             return true;
807         }
808         if (!m_data)
809             return false;
810         
811         // Should not make buffer purgeable if it has refs other than this since we don't want two copies.
812         if (!m_data->hasOneRef())
813             return false;
814
815         m_data->createPurgeableBuffer();
816         if (!m_data->hasPurgeableBuffer())
817             return false;
818
819         m_purgeableData = m_data->releasePurgeableBuffer();
820         m_purgeableData->setPurgePriority(purgePriority());
821         m_purgeableData->makePurgeable(true);
822         m_data.clear();
823         return true;
824     }
825
826     if (!m_purgeableData)
827         return true;
828     ASSERT(!m_data);
829     ASSERT(!hasClients());
830
831     if (!m_purgeableData->makePurgeable(false))
832         return false; 
833
834     m_data = ResourceBuffer::adoptSharedBuffer(SharedBuffer::adoptPurgeableBuffer(m_purgeableData.release()));
835     return true;
836 }
837
838 bool CachedResource::isPurgeable() const
839 {
840     return m_purgeableData && m_purgeableData->isPurgeable();
841 }
842
843 bool CachedResource::wasPurged() const
844 {
845     return m_purgeableData && m_purgeableData->wasPurged();
846 }
847
848 unsigned CachedResource::overheadSize() const
849 {
850     static const int kAverageClientsHashMapSize = 384;
851     return sizeof(CachedResource) + m_response.memoryUsage() + kAverageClientsHashMapSize + m_resourceRequest.url().string().length() * 2;
852 }
853
854 void CachedResource::setLoadPriority(ResourceLoadPriority loadPriority)
855 {
856     if (loadPriority == ResourceLoadPriorityUnresolved)
857         loadPriority = defaultPriorityForResourceType(type());
858     if (loadPriority == m_loadPriority)
859         return;
860     m_loadPriority = loadPriority;
861     if (m_loader)
862         m_loader->didChangePriority(loadPriority);
863 }
864
865 CachedResource::CachedResourceCallback::CachedResourceCallback(CachedResource* resource, CachedResourceClient* client)
866     : m_resource(resource)
867     , m_client(client)
868     , m_callbackTimer(this, &CachedResourceCallback::timerFired)
869 {
870     m_callbackTimer.startOneShot(0);
871 }
872
873 void CachedResource::CachedResourceCallback::cancel()
874 {
875     if (m_callbackTimer.isActive())
876         m_callbackTimer.stop();
877 }
878
879 void CachedResource::CachedResourceCallback::timerFired(Timer<CachedResourceCallback>&)
880 {
881     m_resource->didAddClient(m_client);
882 }
883
884 #if ENABLE(DISK_IMAGE_CACHE)
885 bool CachedResource::isUsingDiskImageCache() const
886 {
887     return m_data && m_data->isUsingDiskImageCache();
888 }
889 #endif
890
891 #if PLATFORM(MAC)
892 void CachedResource::tryReplaceEncodedData(PassRefPtr<SharedBuffer> newBuffer)
893 {
894     if (!m_data)
895         return;
896     
897     if (!mayTryReplaceEncodedData())
898         return;
899     
900     // Because the disk cache is asynchronous and racey with regards to the data we might be asked to replace,
901     // we need to verify that the new buffer has the same contents as our old buffer.
902     if (m_data->size() != newBuffer->size() || memcmp(m_data->data(), newBuffer->data(), m_data->size()))
903         return;
904
905     m_data->tryReplaceSharedBufferContents(newBuffer.get());
906 }
907 #endif
908
909 }