1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
|
// Copyright (c) 2011 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CONTENT_BROWSER_APPCACHE_APPCACHE_GROUP_H_
#define CONTENT_BROWSER_APPCACHE_APPCACHE_GROUP_H_
#include <map>
#include <vector>
#include "base/cancelable_callback.h"
#include "base/gtest_prod_util.h"
#include "base/memory/ref_counted.h"
#include "base/memory/scoped_ptr.h"
#include "base/observer_list.h"
#include "base/time/time.h"
#include "content/common/content_export.h"
#include "url/gurl.h"
namespace content {
FORWARD_DECLARE_TEST(AppCacheGroupTest, StartUpdate);
FORWARD_DECLARE_TEST(AppCacheGroupTest, CancelUpdate);
FORWARD_DECLARE_TEST(AppCacheGroupTest, QueueUpdate);
FORWARD_DECLARE_TEST(AppCacheUpdateJobTest, AlreadyChecking);
FORWARD_DECLARE_TEST(AppCacheUpdateJobTest, AlreadyDownloading);
class AppCache;
class AppCacheHost;
class AppCacheStorage;
class AppCacheUpdateJob;
class AppCacheUpdateJobTest;
class HostObserver;
class MockAppCacheStorage;
// Collection of application caches identified by the same manifest URL.
// A group exists as long as it is in use by a host or is being updated.
class CONTENT_EXPORT AppCacheGroup
: public base::RefCounted<AppCacheGroup> {
public:
class CONTENT_EXPORT UpdateObserver {
public:
// Called just after an appcache update has completed.
virtual void OnUpdateComplete(AppCacheGroup* group) = 0;
virtual ~UpdateObserver() {}
};
enum UpdateAppCacheStatus {
IDLE,
CHECKING,
DOWNLOADING,
};
AppCacheGroup(AppCacheStorage* storage, const GURL& manifest_url,
int64 group_id);
// Adds/removes an update observer, the AppCacheGroup does not take
// ownership of the observer.
void AddUpdateObserver(UpdateObserver* observer);
void RemoveUpdateObserver(UpdateObserver* observer);
int64 group_id() const { return group_id_; }
const GURL& manifest_url() const { return manifest_url_; }
const base::Time& creation_time() const { return creation_time_; }
void set_creation_time(const base::Time& time) { creation_time_ = time; }
bool is_obsolete() const { return is_obsolete_; }
void set_obsolete(bool value) { is_obsolete_ = value; }
bool is_being_deleted() const { return is_being_deleted_; }
void set_being_deleted(bool value) { is_being_deleted_ = value; }
AppCache* newest_complete_cache() const { return newest_complete_cache_; }
void AddCache(AppCache* complete_cache);
void RemoveCache(AppCache* cache);
bool HasCache() const { return newest_complete_cache_ != NULL; }
void AddNewlyDeletableResponseIds(std::vector<int64>* response_ids);
UpdateAppCacheStatus update_status() const { return update_status_; }
// Starts an update via update() javascript API.
void StartUpdate() {
StartUpdateWithHost(NULL);
}
// Starts an update for a doc loaded from an application cache.
void StartUpdateWithHost(AppCacheHost* host) {
StartUpdateWithNewMasterEntry(host, GURL());
}
// Starts an update for a doc loaded using HTTP GET or equivalent with
// an <html> tag manifest attribute value that matches this group's
// manifest url.
void StartUpdateWithNewMasterEntry(AppCacheHost* host,
const GURL& new_master_resource);
// Cancels an update if one is running.
void CancelUpdate();
private:
class HostObserver;
friend class base::RefCounted<AppCacheGroup>;
friend class content::AppCacheUpdateJobTest;
friend class content::MockAppCacheStorage; // for old_caches()
friend class AppCacheUpdateJob;
~AppCacheGroup();
typedef std::vector<AppCache*> Caches;
typedef std::map<AppCacheHost*, GURL> QueuedUpdates;
static const int kUpdateRestartDelayMs = 1000;
AppCacheUpdateJob* update_job() { return update_job_; }
void SetUpdateAppCacheStatus(UpdateAppCacheStatus status);
void NotifyContentBlocked();
const Caches& old_caches() const { return old_caches_; }
// Update cannot be processed at this time. Queue it for a later run.
void QueueUpdate(AppCacheHost* host, const GURL& new_master_resource);
void RunQueuedUpdates();
static bool FindObserver(const UpdateObserver* find_me,
const ObserverList<UpdateObserver>& observer_list);
void ScheduleUpdateRestart(int delay_ms);
void HostDestructionImminent(AppCacheHost* host);
const int64 group_id_;
const GURL manifest_url_;
base::Time creation_time_;
UpdateAppCacheStatus update_status_;
bool is_obsolete_;
bool is_being_deleted_;
std::vector<int64> newly_deletable_response_ids_;
// Old complete app caches.
Caches old_caches_;
// Newest cache in this group to be complete, aka relevant cache.
AppCache* newest_complete_cache_;
// Current update job for this group, if any.
AppCacheUpdateJob* update_job_;
// Central storage object.
AppCacheStorage* storage_;
// List of objects observing this group.
ObserverList<UpdateObserver> observers_;
// Updates that have been queued for the next run.
QueuedUpdates queued_updates_;
ObserverList<UpdateObserver> queued_observers_;
base::CancelableClosure restart_update_task_;
scoped_ptr<HostObserver> host_observer_;
// True if we're in our destructor.
bool is_in_dtor_;
FRIEND_TEST_ALL_PREFIXES(content::AppCacheGroupTest, StartUpdate);
FRIEND_TEST_ALL_PREFIXES(content::AppCacheGroupTest, CancelUpdate);
FRIEND_TEST_ALL_PREFIXES(content::AppCacheGroupTest, QueueUpdate);
FRIEND_TEST_ALL_PREFIXES(content::AppCacheUpdateJobTest, AlreadyChecking);
FRIEND_TEST_ALL_PREFIXES(content::AppCacheUpdateJobTest, AlreadyDownloading);
DISALLOW_COPY_AND_ASSIGN(AppCacheGroup);
};
} // namespace content
#endif // CONTENT_BROWSER_APPCACHE_APPCACHE_GROUP_H_
|