|
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 WebKit { |
|
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 WebCore::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 WebCore::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 virtual ~WebApplicationCacheHost() { } |
|
74 |
|
75 // Called for every request made within the context. |
|
76 virtual void willStartMainResourceRequest(WebURLRequest&) { } |
|
77 virtual void willStartSubResourceRequest(WebURLRequest&) { } |
|
78 |
|
79 // One or the other selectCache methods is called after having parsed the <html> tag. |
|
80 // The latter returns false if the current document has been identified as a "foreign" |
|
81 // entry, in which case the frame navigation will be restarted by webkit. |
|
82 virtual void selectCacheWithoutManifest() { } |
|
83 virtual bool selectCacheWithManifest(const WebURL& manifestURL) { return true; } |
|
84 |
|
85 // Called as the main resource is retrieved. |
|
86 virtual void didReceiveResponseForMainResource(const WebURLResponse&) { } |
|
87 virtual void didReceiveDataForMainResource(const char* data, int len) { } |
|
88 virtual void didFinishLoadingMainResource(bool success) { } |
|
89 |
|
90 // Called on behalf of the scriptable interface. |
|
91 virtual Status status() { return Uncached; } |
|
92 virtual bool startUpdate() { return false; } |
|
93 virtual bool swapCache() { return false; } |
|
94 |
|
95 // Structures and methods to support inspecting Application Caches. |
|
96 struct CacheInfo { |
|
97 WebURL manifestURL; // Empty if there is no associated cache. |
|
98 double creationTime; |
|
99 double updateTime; |
|
100 long long totalSize; |
|
101 CacheInfo() : creationTime(0), updateTime(0), totalSize(0) { } |
|
102 }; |
|
103 struct ResourceInfo { |
|
104 WebURL url; |
|
105 long long size; |
|
106 bool isMaster; |
|
107 bool isManifest; |
|
108 bool isExplicit; |
|
109 bool isForeign; |
|
110 bool isFallback; |
|
111 ResourceInfo() : size(0), isMaster(false), isManifest(false), isExplicit(false), isForeign(false), isFallback(false) { } |
|
112 }; |
|
113 virtual void getAssociatedCacheInfo(CacheInfo*) { } |
|
114 virtual void getResourceList(WebVector<ResourceInfo>*) { } |
|
115 virtual void deleteAssociatedCacheGroup() { } |
|
116 }; |
|
117 |
|
118 } // namespace WebKit |
|
119 |
|
120 #endif // WebApplicationCacheHost_h |
|
121 |