3b6cd923aff115e736e21f21c9347850bc250092
[WebKit-https.git] / Source / WebKitLegacy / mac / Misc / WebCache.mm
1 /*
2  * Copyright (C) 2006 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #import "WebCache.h"
27
28 #import "NetworkStorageSessionMap.h"
29 #import "WebApplicationCacheInternal.h"
30 #import "WebNSObjectExtras.h"
31 #import "WebPreferences.h"
32 #import "WebView.h"
33 #import "WebViewInternal.h"
34 #import <JavaScriptCore/InitializeThreading.h>
35 #import <WebCore/ApplicationCacheStorage.h>
36 #import <WebCore/CookieJar.h>
37 #import <WebCore/CredentialStorage.h>
38 #import <WebCore/CrossOriginPreflightResultCache.h>
39 #import <WebCore/Document.h>
40 #import <WebCore/MemoryCache.h>
41 #import <WebCore/NetworkStorageSession.h>
42 #import <WebCore/StorageSessionProvider.h>
43 #import <wtf/MainThread.h>
44 #import <wtf/RunLoop.h>
45
46 #if PLATFORM(IOS_FAMILY)
47 #import "MemoryMeasure.h"
48 #import "WebFrameInternal.h"
49 #import <WebCore/CachedImage.h>
50 #import <WebCore/Frame.h>
51 #import <WebCore/PageCache.h>
52 #import <WebCore/WebCoreThreadRun.h>
53 #endif
54
55 class DefaultStorageSessionProvider : public WebCore::StorageSessionProvider {
56     WebCore::NetworkStorageSession* storageSession() const final
57     {
58         return &NetworkStorageSessionMap::defaultStorageSession();
59     }
60 };
61
62 @implementation WebCache
63
64 + (void)initialize
65 {
66 #if !PLATFORM(IOS_FAMILY)
67     JSC::initializeThreading();
68     WTF::initializeMainThreadToProcessMainThread();
69     RunLoop::initializeMainRunLoop();
70 #endif
71 }
72
73 + (NSArray *)statistics
74 {
75     WebCore::MemoryCache::Statistics s = WebCore::MemoryCache::singleton().getStatistics();
76
77     return [NSArray arrayWithObjects:
78         [NSDictionary dictionaryWithObjectsAndKeys:
79             [NSNumber numberWithInt:s.images.count], @"Images",
80             [NSNumber numberWithInt:s.cssStyleSheets.count], @"CSS",
81 #if ENABLE(XSLT)
82             [NSNumber numberWithInt:s.xslStyleSheets.count], @"XSL",
83 #else
84             [NSNumber numberWithInt:0], @"XSL",
85 #endif
86             [NSNumber numberWithInt:s.scripts.count], @"JavaScript",
87             nil],
88         [NSDictionary dictionaryWithObjectsAndKeys:
89             [NSNumber numberWithInt:s.images.size], @"Images",
90             [NSNumber numberWithInt:s.cssStyleSheets.size] ,@"CSS",
91 #if ENABLE(XSLT)
92             [NSNumber numberWithInt:s.xslStyleSheets.size], @"XSL",
93 #else
94             [NSNumber numberWithInt:0], @"XSL",
95 #endif
96             [NSNumber numberWithInt:s.scripts.size], @"JavaScript",
97             nil],
98         [NSDictionary dictionaryWithObjectsAndKeys:
99             [NSNumber numberWithInt:s.images.liveSize], @"Images",
100             [NSNumber numberWithInt:s.cssStyleSheets.liveSize] ,@"CSS",
101 #if ENABLE(XSLT)
102             [NSNumber numberWithInt:s.xslStyleSheets.liveSize], @"XSL",
103 #else
104             [NSNumber numberWithInt:0], @"XSL",
105 #endif
106             [NSNumber numberWithInt:s.scripts.liveSize], @"JavaScript",
107             nil],
108         [NSDictionary dictionaryWithObjectsAndKeys:
109             [NSNumber numberWithInt:s.images.decodedSize], @"Images",
110             [NSNumber numberWithInt:s.cssStyleSheets.decodedSize] ,@"CSS",
111 #if ENABLE(XSLT)
112             [NSNumber numberWithInt:s.xslStyleSheets.decodedSize], @"XSL",
113 #else
114             [NSNumber numberWithInt:0], @"XSL",
115 #endif
116             [NSNumber numberWithInt:s.scripts.decodedSize], @"JavaScript",
117             nil],
118         nil];
119 }
120
121 + (void)empty
122 {
123     // Toggling the cache model like this forces the cache to evict all its in-memory resources.
124     WebCacheModel cacheModel = [WebView _cacheModel];
125     [WebView _setCacheModel:WebCacheModelDocumentViewer];
126     [WebView _setCacheModel:cacheModel];
127
128     // Empty the application cache.
129     webApplicationCacheStorage().empty();
130
131     // Empty the Cross-Origin Preflight cache
132     WebCore::CrossOriginPreflightResultCache::singleton().clear();
133 }
134
135 #if PLATFORM(IOS_FAMILY)
136 + (void)emptyInMemoryResources
137 {
138     // This method gets called from MobileSafari after it calls [WebView
139     // _close]. [WebView _close] schedules its work on the WebThread. So we
140     // schedule this method on the WebThread as well so as to pick up all the
141     // dead resources left behind after closing the WebViews
142     WebThreadRun(^{
143         WebKit::MemoryMeasure measurer("[WebCache emptyInMemoryResources]");
144
145         // Toggling the cache model like this forces the cache to evict all its in-memory resources.
146         WebCacheModel cacheModel = [WebView _cacheModel];
147         [WebView _setCacheModel:WebCacheModelDocumentViewer];
148         [WebView _setCacheModel:cacheModel];
149
150         WebCore::MemoryCache::singleton().pruneLiveResources(true);
151     });
152 }
153
154 + (void)sizeOfDeadResources:(int *)resources
155 {
156     WebCore::MemoryCache::Statistics stats = WebCore::MemoryCache::singleton().getStatistics();
157     if (resources) {
158         *resources = (stats.images.size - stats.images.liveSize)
159                      + (stats.cssStyleSheets.size - stats.cssStyleSheets.liveSize)
160 #if ENABLE(XSLT)
161                      + (stats.xslStyleSheets.size - stats.xslStyleSheets.liveSize)
162 #endif
163                      + (stats.scripts.size - stats.scripts.liveSize);
164     }
165 }
166
167 + (bool)addImageToCache:(CGImageRef)image forURL:(NSURL *)url
168 {
169     return [WebCache addImageToCache:image forURL:url forFrame:nil];
170 }
171
172 + (bool)addImageToCache:(CGImageRef)image forURL:(NSURL *)url forFrame:(WebFrame *)frame
173 {
174     if (!image || !url || ![[url absoluteString] length])
175         return false;
176
177     auto provider = adoptRef(*new DefaultStorageSessionProvider);
178     return WebCore::MemoryCache::singleton().addImageToCache(RetainPtr<CGImageRef>(image), url, frame ? core(frame)->document()->domainForCachePartition() : emptyString(), PAL::SessionID::defaultSessionID(), WebCore::CookieJar::create(WTFMove(provider)).ptr());
179 }
180
181 + (void)removeImageFromCacheForURL:(NSURL *)url
182 {
183     [WebCache removeImageFromCacheForURL:url forFrame:nil];
184 }
185
186 + (void)removeImageFromCacheForURL:(NSURL *)url forFrame:(WebFrame *)frame
187 {
188     if (!url)
189         return;
190
191     return WebCore::MemoryCache::singleton().removeImageFromCache(url, frame ? core(frame)->document()->domainForCachePartition() : emptyString());
192 }
193
194 + (CGImageRef)imageForURL:(NSURL *)url
195 {
196     if (!url)
197         return nullptr;
198     
199     WebCore::ResourceRequest request(url);
200     WebCore::CachedResource* cachedResource = WebCore::MemoryCache::singleton().resourceForRequest(request, PAL::SessionID::defaultSessionID());
201     if (!is<WebCore::CachedImage>(cachedResource))
202         return nullptr;
203     WebCore::CachedImage& cachedImage = downcast<WebCore::CachedImage>(*cachedResource);
204     if (!cachedImage.hasImage())
205         return nullptr;
206     return cachedImage.image()->nativeImage().get();
207 }
208
209 #endif // PLATFORM(IOS_FAMILY)
210
211 + (void)setDisabled:(BOOL)disabled
212 {
213     if (!pthread_main_np())
214         return [[self _webkit_invokeOnMainThread] setDisabled:disabled];
215
216     WebCore::MemoryCache::singleton().setDisabled(disabled);
217 }
218
219 + (BOOL)isDisabled
220 {
221     return WebCore::MemoryCache::singleton().disabled();
222 }
223
224 + (void)clearCachedCredentials
225 {
226     [WebView _makeAllWebViewsPerformSelector:@selector(_clearCredentials)];
227     NetworkStorageSessionMap::defaultStorageSession().credentialStorage().clearCredentials();
228 }
229
230 @end