1 /* 2 * Copyright (C) 2010 Google Inc. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are 6 * met: 7 * 8 * * Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above 11 * copyright notice, this list of conditions and the following disclaimer 12 * in the documentation and/or other materials provided with the 13 * distribution. 14 * * Neither the name of Google Inc. nor the names of its 15 * contributors may be used to endorse or promote products derived from 16 * this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 #ifndef WebApplicationCacheHost_h 32 #define WebApplicationCacheHost_h 33 34 #include "WebCommon.h" 35 #include "WebURL.h" 36 #include "WebVector.h" 37 38 namespace blink { 39 40 class WebApplicationCacheHostClient; 41 class WebURL; 42 class WebURLRequest; 43 class WebURLResponse; 44 struct WebURLError; 45 46 // This interface is used by webkit to call out to the embedder. Webkit uses 47 // the WebFrameClient::createApplicationCacheHost method to create instances, 48 // and calls delete when the instance is no longer needed. 49 class WebApplicationCacheHost { 50 public: 51 // These values must match blink::ApplicationCacheHost::Status values 52 enum Status { 53 Uncached, 54 Idle, 55 Checking, 56 Downloading, 57 UpdateReady, 58 Obsolete 59 }; 60 61 // These values must match blink::ApplicationCacheHost::EventID values 62 enum EventID { 63 CheckingEvent, 64 ErrorEvent, 65 NoUpdateEvent, 66 DownloadingEvent, 67 ProgressEvent, 68 UpdateReadyEvent, 69 CachedEvent, 70 ObsoleteEvent 71 }; 72 73 enum ErrorReason { 74 ManifestError, 75 SignatureError, 76 ResourceError, 77 ChangedError, 78 AbortError, 79 QuotaError, 80 PolicyError, 81 UnknownError 82 }; 83 ~WebApplicationCacheHost()84 virtual ~WebApplicationCacheHost() { } 85 86 // Called for every request made within the context. willStartMainResourceRequest(WebURLRequest & r,const WebApplicationCacheHost * spawningHost)87 virtual void willStartMainResourceRequest(WebURLRequest& r, const WebApplicationCacheHost* spawningHost) { } willStartSubResourceRequest(WebURLRequest &)88 virtual void willStartSubResourceRequest(WebURLRequest&) { } 89 90 // One or the other selectCache methods is called after having parsed the <html> tag. 91 // The latter returns false if the current document has been identified as a "foreign" 92 // entry, in which case the frame navigation will be restarted by webkit. selectCacheWithoutManifest()93 virtual void selectCacheWithoutManifest() { } selectCacheWithManifest(const WebURL & manifestURL)94 virtual bool selectCacheWithManifest(const WebURL& manifestURL) { return true; } 95 96 // Called as the main resource is retrieved. didReceiveResponseForMainResource(const WebURLResponse &)97 virtual void didReceiveResponseForMainResource(const WebURLResponse&) { } didReceiveDataForMainResource(const char * data,int len)98 virtual void didReceiveDataForMainResource(const char* data, int len) { } didFinishLoadingMainResource(bool success)99 virtual void didFinishLoadingMainResource(bool success) { } 100 101 // Called on behalf of the scriptable interface. status()102 virtual Status status() { return Uncached; } startUpdate()103 virtual bool startUpdate() { return false; } swapCache()104 virtual bool swapCache() { return false; } abort()105 virtual void abort() { } 106 107 // Structures and methods to support inspecting Application Caches. 108 struct CacheInfo { 109 WebURL manifestURL; // Empty if there is no associated cache. 110 double creationTime; 111 double updateTime; 112 long long totalSize; CacheInfoCacheInfo113 CacheInfo() : creationTime(0), updateTime(0), totalSize(0) { } 114 }; 115 struct ResourceInfo { 116 WebURL url; 117 long long size; 118 bool isMaster; 119 bool isManifest; 120 bool isExplicit; 121 bool isForeign; 122 bool isFallback; ResourceInfoResourceInfo123 ResourceInfo() : size(0), isMaster(false), isManifest(false), isExplicit(false), isForeign(false), isFallback(false) { } 124 }; getAssociatedCacheInfo(CacheInfo *)125 virtual void getAssociatedCacheInfo(CacheInfo*) { } getResourceList(WebVector<ResourceInfo> *)126 virtual void getResourceList(WebVector<ResourceInfo>*) { } deleteAssociatedCacheGroup()127 virtual void deleteAssociatedCacheGroup() { } 128 }; 129 130 } // namespace blink 131 132 #endif // WebApplicationCacheHost_h 133