WebCore/loader/CachedResource.h

   1 /*
   2     This file is part of the KDE libraries
   3
   4     Copyright (C) 1998 Lars Knoll (knoll@mpi-hd.mpg.de)
   5     Copyright (C) 2001 Dirk Mueller <mueller@kde.org>
   6     Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
   7     Copyright (C) 2004, 2005, 2006 Apple Computer, Inc.
   8
   9     This library is free software; you can redistribute it and/or
  10     modify it under the terms of the GNU Library General Public
  11     License as published by the Free Software Foundation; either
  12     version 2 of the License, or (at your option) any later version.
  13
  14     This library is distributed in the hope that it will be useful,
  15     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17     Library General Public License for more details.
  18
  19     You should have received a copy of the GNU Library General Public License
  20     along with this library; see the file COPYING.LIB.  If not, write to
  21     the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22     Boston, MA 02111-1307, USA.
  23
  24     This class provides all functionality needed for loading images, style sheets and html
  25     pages from the web. It has a memory cache for these objects.
  26 */
  27
  28 #ifndef CachedResource_h
  29 #define CachedResource_h
  30
  31 #include "CachePolicy.h"
  32 #include "PlatformString.h"
  33 #include "ResourceHandleClient.h" // defines PlatformResponse and PlatformData
  34 #include <wtf/HashSet.h>
  35 #include <wtf/Vector.h>
  36 #include <time.h>
  37
  38 #if PLATFORM(MAC)
  39 #include "RetainPtr.h"
  40
  41 #ifdef __OBJC__
  42 @class NSURLRequest;
  43 #else
  44 class NSURLRequest;
  45 #endif
  46
  47 #endif // PLATFORM(MAC)
  48
  49 namespace WebCore {
  50
  51 class Cache;
  52 class CachedResourceClient;
  53 class Request;
  54
  55 // A resource that is held in the cache. Classes who want to use this object should derive
  56 // from CachedResourceClient, to get the function calls in case the requested data has arrived.
  57 // This class also does the actual communication with the loader to obtain the resource from the network.
  58 class CachedResource {
  59 public:
  60     enum Type {
  61         ImageResource,
  62         CSSStyleSheet,
  63         Script
  64 #ifdef XSLT_SUPPORT
  65         , XSLStyleSheet
  66 #endif
  67 #ifdef XBL_SUPPORT
  68         , XBL
  69 #endif
  70     };
  71
  72     enum Status {
  73         NotCached,    // this URL is not cached
  74         Unknown,      // let cache decide what to do with it
  75         New,          // inserting new item
  76         Pending,      // only partially loaded
  77         Cached       // regular case
  78     };
  79
  80     CachedResource(const String& URL, Type type, CachePolicy cachePolicy, time_t expireDate, unsigned size = 0);
  81     virtual ~CachedResource();
  82
  83     virtual void setEncoding(const String&) { }
  84     virtual Vector<char>& bufferData(const char* bytes, int addedSize, Request*);
  85     virtual void data(Vector<char>&, bool allDataReceived) = 0;
  86     virtual void error() = 0;
  87
  88     const String &url() const { return m_url; }
  89     Type type() const { return m_type; }
  90
  91     virtual void ref(CachedResourceClient*);
  92     void deref(CachedResourceClient*);
  93     bool referenced() const { return !m_clients.isEmpty(); }
  94
  95     unsigned count() const { return m_clients.size(); }
  96
  97     Status status() const { return m_status; }
  98
  99     unsigned size() const { return m_size; }
 100
 101     bool isLoaded() const { return !m_loading; }
 102     void setLoading(bool b) { m_loading = b; }
 103
 104     virtual bool isImage() const { return false; }
 105
 106     unsigned accessCount() const { return m_accessCount; }
 107     void increaseAccessCount() { m_accessCount++; }
 108
 109     // Computes the status of an object after loading.
 110     // Updates the expire date on the cache entry file
 111     void finish();
 112
 113     // Called by the cache if the object has been removed from the cache
 114     // while still being referenced. This means the object should delete itself
 115     // if the number of clients observing it ever drops to 0.
 116     void setInCache(bool b) { m_inCache = b; }
 117     bool inCache() const { return m_inCache; }
 118
 119     CachePolicy cachePolicy() const { return m_cachePolicy; }
 120
 121     void setRequest(Request*);
 122
 123     PlatformResponse response() const { return m_response; }
 124     void setResponse(PlatformResponse);
 125     PlatformData allData() const { return m_allData; }
 126     void setAllData(PlatformData);
 127
 128     bool canDelete() const { return !referenced() && !m_request; }
 129
 130     void setExpireDate(time_t expireDate, bool changeHttpCache);
 131
 132     bool isExpired() const;
 133
 134     virtual bool schedule() const { return false; }
 135
 136     // List of acceptable MIME types seperated by ",".
 137     // A MIME type may contain a wildcard, e.g. "text/*".
 138     String accept() const { return m_accept; }
 139     void setAccept(const String& accept) { m_accept = accept; }
 140
 141 #if PLATFORM(MAC)
 142     NSURLRequest* getNSURLRequest();
 143 #endif
 144
 145 protected:
 146     void setSize(unsigned size);
 147
 148     HashSet<CachedResourceClient*> m_clients;
 149
 150     String m_url;
 151     String m_accept;
 152     Request* m_request;
 153
 154 #if PLATFORM(MAC)
 155     RetainPtr<NSURLRequest> m_nsURLRequest;
 156 #endif
 157
 158     PlatformResponse m_response;
 159     PlatformData m_allData;
 160
 161     Type m_type;
 162     Status m_status;
 163
 164 private:
 165     unsigned m_size;
 166     unsigned m_accessCount;
 167
 168 protected:
 169     time_t m_expireDate;
 170     CachePolicy m_cachePolicy;
 171     bool m_inCache;
 172     bool m_loading;
 173     bool m_expireDateChanged;
 174 #ifndef NDEBUG
 175     bool m_deleted;
 176     unsigned m_lruIndex;
 177 #endif
 178
 179 private:
 180     CachedResource* m_nextInLRUList;
 181     CachedResource* m_prevInLRUList;
 182     friend class Cache;
 183 };
 184
 185 }
 186
 187 #endif