webkit/appcache/appcache.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef WEBKIT_APPCACHE_APPCACHE_H_
   6 #define WEBKIT_APPCACHE_APPCACHE_H_
   7
   8 #include <map>
   9 #include <set>
  10 #include <vector>
  11
  12 #include "base/gtest_prod_util.h"
  13 #include "base/memory/ref_counted.h"
  14 #include "base/time.h"
  15 #include "googleurl/src/gurl.h"
  16 #include "webkit/appcache/appcache_database.h"
  17 #include "webkit/appcache/appcache_entry.h"
  18 #include "webkit/appcache/manifest_parser.h"
  19 #include "webkit/storage/webkit_storage_export.h"
  20
  21 namespace appcache {
  22
  23 class AppCacheGroup;
  24 class AppCacheHost;
  25 class AppCacheStorage;
  26
  27 // Set of cached resources for an application. A cache exists as long as a
  28 // host is associated with it, the cache is in an appcache group or the
  29 // cache is being created during an appcache upate.
  30 class WEBKIT_STORAGE_EXPORT AppCache : public base::RefCounted<AppCache> {
  31  public:
  32   typedef std::map<GURL, AppCacheEntry> EntryMap;
  33   typedef std::set<AppCacheHost*> AppCacheHosts;
  34
  35   AppCache(AppCacheStorage* storage, int64 cache_id);
  36
  37   int64 cache_id() const { return cache_id_; }
  38
  39   AppCacheGroup* owning_group() const { return owning_group_; }
  40
  41   bool is_complete() const { return is_complete_; }
  42   void set_complete(bool value) { is_complete_ = value; }
  43
  44   // Adds a new entry. Entry must not already be in cache.
  45   void AddEntry(const GURL& url, const AppCacheEntry& entry);
  46
  47   // Adds a new entry or modifies an existing entry by merging the types
  48   // of the new entry with the existing entry. Returns true if a new entry
  49   // is added, false if the flags are merged into an existing entry.
  50   bool AddOrModifyEntry(const GURL& url, const AppCacheEntry& entry);
  51
  52   // Removes an entry from the EntryMap, the URL must be in the set.
  53   void RemoveEntry(const GURL& url);
  54
  55   // Do not store the returned object as it could be deleted anytime.
  56   AppCacheEntry* GetEntry(const GURL& url);
  57   const AppCacheEntry* GetEntryWithResponseId(int64 response_id);
  58
  59   const EntryMap& entries() const { return entries_; }
  60
  61   // Returns the URL of the resource used as entry for 'namespace_url'.
  62   GURL GetFallbackEntryUrl(const GURL& namespace_url) const {
  63     return GetNamespaceEntryUrl(fallback_namespaces_, namespace_url);
  64   }
  65   GURL GetInterceptEntryUrl(const GURL& namespace_url) const {
  66     return GetNamespaceEntryUrl(intercept_namespaces_, namespace_url);
  67   }
  68
  69   AppCacheHosts& associated_hosts() { return associated_hosts_; }
  70
  71   bool IsNewerThan(AppCache* cache) const {
  72     // TODO(michaeln): revisit, the system clock can be set
  73     // back in time which would confuse this logic.
  74     if (update_time_ > cache->update_time_)
  75       return true;
  76
  77     // Tie breaker. Newer caches have a larger cache ID.
  78     if (update_time_ == cache->update_time_)
  79       return cache_id_ > cache->cache_id_;
  80
  81     return false;
  82   }
  83
  84   base::Time update_time() const { return update_time_; }
  85
  86   int64 cache_size() const { return cache_size_; }
  87
  88   void set_update_time(base::Time ticks) { update_time_ = ticks; }
  89
  90   // Initializes the cache with information in the manifest.
  91   // Do not use the manifest after this call.
  92   void InitializeWithManifest(Manifest* manifest);
  93
  94   // Initializes the cache with the information in the database records.
  95   void InitializeWithDatabaseRecords(
  96       const AppCacheDatabase::CacheRecord& cache_record,
  97       const std::vector<AppCacheDatabase::EntryRecord>& entries,
  98       const std::vector<AppCacheDatabase::NamespaceRecord>& intercepts,
  99       const std::vector<AppCacheDatabase::NamespaceRecord>& fallbacks,
 100       const std::vector<AppCacheDatabase::OnlineWhiteListRecord>& whitelists);
 101
 102   // Returns the database records to be stored in the AppCacheDatabase
 103   // to represent this cache.
 104   void ToDatabaseRecords(
 105       const AppCacheGroup* group,
 106       AppCacheDatabase::CacheRecord* cache_record,
 107       std::vector<AppCacheDatabase::EntryRecord>* entries,
 108       std::vector<AppCacheDatabase::NamespaceRecord>* intercepts,
 109       std::vector<AppCacheDatabase::NamespaceRecord>* fallbacks,
 110       std::vector<AppCacheDatabase::OnlineWhiteListRecord>* whitelists);
 111
 112   bool FindResponseForRequest(const GURL& url,
 113       AppCacheEntry* found_entry, GURL* found_intercept_namespace,
 114       AppCacheEntry* found_fallback_entry, GURL* found_fallback_namespace,
 115       bool* found_network_namespace);
 116
 117   // Populates the 'infos' vector with an element per entry in the appcache.
 118   void ToResourceInfoVector(AppCacheResourceInfoVector* infos) const;
 119
 120   static const Namespace* FindNamespace(
 121       const NamespaceVector& namespaces,
 122       const GURL& url);
 123
 124  private:
 125   friend class AppCacheGroup;
 126   friend class AppCacheHost;
 127   friend class AppCacheStorageImplTest;
 128   friend class AppCacheUpdateJobTest;
 129   friend class base::RefCounted<AppCache>;
 130
 131   ~AppCache();
 132
 133   // Use AppCacheGroup::Add/RemoveCache() to manipulate owning group.
 134   void set_owning_group(AppCacheGroup* group) { owning_group_ = group; }
 135
 136   // FindResponseForRequest helpers
 137   const Namespace* FindInterceptNamespace(const GURL& url) {
 138     return FindNamespace(intercept_namespaces_, url);
 139   }
 140   const Namespace* FindFallbackNamespace(const GURL& url) {
 141     return FindNamespace(fallback_namespaces_, url);
 142   }
 143   bool IsInNetworkNamespace(const GURL& url) {
 144     return FindNamespace(online_whitelist_namespaces_, url) != NULL;
 145   }
 146
 147   GURL GetNamespaceEntryUrl(const NamespaceVector& namespaces,
 148                             const GURL& namespace_url) const;
 149
 150   // Use AppCacheHost::Associate*Cache() to manipulate host association.
 151   void AssociateHost(AppCacheHost* host) {
 152     associated_hosts_.insert(host);
 153   }
 154   void UnassociateHost(AppCacheHost* host);
 155
 156   const int64 cache_id_;
 157   scoped_refptr<AppCacheGroup> owning_group_;
 158   AppCacheHosts associated_hosts_;
 159
 160   EntryMap entries_;    // contains entries of all types
 161
 162   NamespaceVector intercept_namespaces_;
 163   NamespaceVector fallback_namespaces_;
 164   NamespaceVector online_whitelist_namespaces_;
 165   bool online_whitelist_all_;
 166
 167   bool is_complete_;
 168
 169   // when this cache was last updated
 170   base::Time update_time_;
 171
 172   int64 cache_size_;
 173
 174   // to notify storage when cache is deleted
 175   AppCacheStorage* storage_;
 176
 177   FRIEND_TEST_ALL_PREFIXES(AppCacheTest, InitializeWithManifest);
 178   FRIEND_TEST_ALL_PREFIXES(AppCacheTest, ToFromDatabaseRecords);
 179   DISALLOW_COPY_AND_ASSIGN(AppCache);
 180 };
 181
 182 }  // namespace appcache
 183
 184 #endif  // WEBKIT_APPCACHE_APPCACHE_H_