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