third_party/WebKit/public/platform/WebApplicationCacheHost.h

   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 WebURL;
  41 class WebURLRequest;
  42 class WebURLResponse;
  43
  44 // This interface is used by webkit to call out to the embedder. Webkit uses
  45 // the WebFrameClient::createApplicationCacheHost method to create instances,
  46 // and calls delete when the instance is no longer needed.
  47 class WebApplicationCacheHost {
  48 public:
  49     // These values must match blink::ApplicationCacheHost::Status values
  50     enum Status {
  51         Uncached,
  52         Idle,
  53         Checking,
  54         Downloading,
  55         UpdateReady,
  56         Obsolete
  57     };
  58
  59     // These values must match blink::ApplicationCacheHost::EventID values
  60     enum EventID {
  61         CheckingEvent,
  62         ErrorEvent,
  63         NoUpdateEvent,
  64         DownloadingEvent,
  65         ProgressEvent,
  66         UpdateReadyEvent,
  67         CachedEvent,
  68         ObsoleteEvent
  69     };
  70
  71     enum ErrorReason {
  72         ManifestError,
  73         SignatureError,
  74         ResourceError,
  75         ChangedError,
  76         AbortError,
  77         QuotaError,
  78         PolicyError,
  79         UnknownError
  80     };
  81
  82     virtual ~WebApplicationCacheHost() { }
  83
  84     // Called for every request made within the context.
  85     virtual void willStartMainResourceRequest(WebURLRequest& r, const WebApplicationCacheHost* spawningHost) { }
  86     virtual void willStartSubResourceRequest(WebURLRequest&) { }
  87
  88     // One or the other selectCache methods is called after having parsed the <html> tag.
  89     // The latter returns false if the current document has been identified as a "foreign"
  90     // entry, in which case the frame navigation will be restarted by webkit.
  91     virtual void selectCacheWithoutManifest() { }
  92     virtual bool selectCacheWithManifest(const WebURL& manifestURL) { return true; }
  93
  94     // Called as the main resource is retrieved.
  95     virtual void didReceiveResponseForMainResource(const WebURLResponse&) { }
  96     virtual void didReceiveDataForMainResource(const char* data, unsigned len) { }
  97     virtual void didFinishLoadingMainResource(bool success) { }
  98
  99     // Called on behalf of the scriptable interface.
 100     virtual Status status() { return Uncached; }
 101     virtual bool startUpdate() { return false; }
 102     virtual bool swapCache() { return false; }
 103     virtual void abort() { }
 104
 105     // Structures and methods to support inspecting Application Caches.
 106     struct CacheInfo {
 107         WebURL manifestURL; // Empty if there is no associated cache.
 108         double creationTime;
 109         double updateTime;
 110         long long totalSize;
 111         CacheInfo() : creationTime(0), updateTime(0), totalSize(0) { }
 112     };
 113     struct ResourceInfo {
 114         WebURL url;
 115         long long size;
 116         bool isMaster;
 117         bool isManifest;
 118         bool isExplicit;
 119         bool isForeign;
 120         bool isFallback;
 121         ResourceInfo() : size(0), isMaster(false), isManifest(false), isExplicit(false), isForeign(false), isFallback(false) { }
 122     };
 123     virtual void getAssociatedCacheInfo(CacheInfo*) { }
 124     virtual void getResourceList(WebVector<ResourceInfo>*) { }
 125     virtual void deleteAssociatedCacheGroup() { }
 126 };
 127
 128 } // namespace blink
 129
 130 #endif // WebApplicationCacheHost_h