blob: 0d419bc5feada54d250e7f16ce000e62484e9d94 [file] [log] [blame]
/*
* Copyright (c) 2009, Google Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef ApplicationCacheHost_h
#define ApplicationCacheHost_h
#include "platform/heap/Handle.h"
#include "platform/weborigin/KURL.h"
#include "public/platform/WebApplicationCacheHostClient.h"
#include "wtf/Allocator.h"
#include "wtf/OwnPtr.h"
#include "wtf/Vector.h"
namespace blink {
class ApplicationCache;
class DocumentLoader;
class ResourceRequest;
class ResourceResponse;
class ApplicationCacheHost final : public GarbageCollectedFinalized<ApplicationCacheHost>, public WebApplicationCacheHostClient {
WTF_MAKE_NONCOPYABLE(ApplicationCacheHost);
public:
static ApplicationCacheHost* create(DocumentLoader* loader)
{
return new ApplicationCacheHost(loader);
}
virtual ~ApplicationCacheHost();
void detachFromDocumentLoader();
// The Status numeric values are specified in the HTML5 spec.
enum Status {
UNCACHED = 0,
IDLE = 1,
CHECKING = 2,
DOWNLOADING = 3,
UPDATEREADY = 4,
OBSOLETE = 5
};
enum EventID {
CHECKING_EVENT = 0,
ERROR_EVENT,
NOUPDATE_EVENT,
DOWNLOADING_EVENT,
PROGRESS_EVENT,
UPDATEREADY_EVENT,
CACHED_EVENT,
OBSOLETE_EVENT // Must remain the last value, this is used to size arrays.
};
struct CacheInfo {
STACK_ALLOCATED();
CacheInfo(const KURL& manifest, double creationTime, double updateTime, long long size)
: m_manifest(manifest)
, m_creationTime(creationTime)
, m_updateTime(updateTime)
, m_size(size) { }
KURL m_manifest;
double m_creationTime;
double m_updateTime;
long long m_size;
};
struct ResourceInfo {
DISALLOW_NEW_EXCEPT_PLACEMENT_NEW();
ResourceInfo(const KURL& resource, bool isMaster, bool isManifest, bool isFallback, bool isForeign, bool isExplicit, long long size)
: m_resource(resource)
, m_isMaster(isMaster)
, m_isManifest(isManifest)
, m_isFallback(isFallback)
, m_isForeign(isForeign)
, m_isExplicit(isExplicit)
, m_size(size) { }
KURL m_resource;
bool m_isMaster;
bool m_isManifest;
bool m_isFallback;
bool m_isForeign;
bool m_isExplicit;
long long m_size;
};
typedef Vector<ResourceInfo> ResourceInfoList;
void selectCacheWithoutManifest();
void selectCacheWithManifest(const KURL& manifestURL);
void willStartLoadingMainResource(ResourceRequest&);
void didReceiveResponseForMainResource(const ResourceResponse&);
void mainResourceDataReceived(const char* data, unsigned length);
void finishedLoadingMainResource();
void failedLoadingMainResource();
void willStartLoadingResource(ResourceRequest&);
Status status() const;
bool update();
bool swapCache();
void abort();
void setApplicationCache(ApplicationCache*);
void notifyApplicationCache(EventID, int progressTotal, int progressDone, WebApplicationCacheHost::ErrorReason, const String& errorURL, int errorStatus, const String& errorMessage);
void stopDeferringEvents(); // Also raises the events that have been queued up.
void fillResourceList(ResourceInfoList*);
CacheInfo applicationCacheInfo();
DECLARE_TRACE();
private:
explicit ApplicationCacheHost(DocumentLoader*);
// WebApplicationCacheHostClient implementation
void didChangeCacheAssociation() final;
void notifyEventListener(WebApplicationCacheHost::EventID) final;
void notifyProgressEventListener(const WebURL&, int progressTotal, int progressDone) final;
void notifyErrorEventListener(WebApplicationCacheHost::ErrorReason, const WebURL&, int status, const WebString& message) final;
bool isApplicationCacheEnabled();
DocumentLoader* documentLoader() const { return m_documentLoader; }
struct DeferredEvent {
EventID eventID;
int progressTotal;
int progressDone;
WebApplicationCacheHost::ErrorReason errorReason;
String errorURL;
int errorStatus;
String errorMessage;
DeferredEvent(EventID id, int progressTotal, int progressDone, WebApplicationCacheHost::ErrorReason errorReason, const String& errorURL, int errorStatus, const String& errorMessage)
: eventID(id)
, progressTotal(progressTotal)
, progressDone(progressDone)
, errorReason(errorReason)
, errorURL(errorURL)
, errorStatus(errorStatus)
, errorMessage(errorMessage)
{
}
};
WeakMember<ApplicationCache> m_domApplicationCache;
RawPtrWillBeMember<DocumentLoader> m_documentLoader;
bool m_defersEvents; // Events are deferred until after document onload.
Vector<DeferredEvent> m_deferredEvents;
void dispatchDOMEvent(EventID, int progressTotal, int progressDone, WebApplicationCacheHost::ErrorReason, const String& errorURL, int errorStatus, const String& errorMessage);
OwnPtr<WebApplicationCacheHost> m_host;
};
} // namespace blink
#endif // ApplicationCacheHost_h