6fb10f39b64d1a4817b2e46b4214727de99cca55
[WebKit-https.git] / WebKit / mac / WebView / WebResource.mm
1 /*
2  * Copyright (C) 2005, 2006, 2007, 2008 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #import "WebResourcePrivate.h"
30
31 #import "WebFrameInternal.h"
32 #import "WebNSDictionaryExtras.h"
33 #import "WebNSURLExtras.h"
34
35 #import <WebCore/ArchiveResource.h>
36 #import <WebCore/LegacyWebArchive.h>
37 #import <WebCore/TextEncoding.h>
38 #import <WebCore/WebCoreObjCExtras.h>
39 #import <WebCore/WebCoreURLResponse.h>
40
41 #import <runtime/InitializeThreading.h>
42 #import <wtf/PassRefPtr.h>
43
44 using namespace WebCore;
45
46 static NSString * const WebResourceDataKey =              @"WebResourceData";
47 static NSString * const WebResourceFrameNameKey =         @"WebResourceFrameName";
48 static NSString * const WebResourceMIMETypeKey =          @"WebResourceMIMEType";
49 static NSString * const WebResourceURLKey =               @"WebResourceURL";
50 static NSString * const WebResourceTextEncodingNameKey =  @"WebResourceTextEncodingName";
51 static NSString * const WebResourceResponseKey =          @"WebResourceResponse";
52
53 #define WebResourceVersion 1
54
55 @interface WebResourcePrivate : NSObject
56 {
57 @public
58     ArchiveResource* coreResource;
59 }
60
61 - (id)initWithCoreResource:(PassRefPtr<ArchiveResource>)coreResource;
62 @end
63
64 @implementation WebResourcePrivate
65
66 + (void)initialize
67 {
68     JSC::initializeThreading();
69 #ifndef BUILDING_ON_TIGER
70     WebCoreObjCFinalizeOnMainThread(self);
71 #endif
72 }
73
74 - (id)init
75 {
76     return [super init];
77 }
78
79 - (id)initWithCoreResource:(PassRefPtr<ArchiveResource>)passedResource
80 {
81     self = [super init];
82     if (!self)
83         return self;
84     
85     // Acquire the PassRefPtr<>'s ref as our own manual ref
86     coreResource = passedResource.releaseRef();
87
88     return self;
89 }
90
91 - (void)dealloc
92 {
93     if (WebCoreObjCScheduleDeallocateOnMainThread([WebResourcePrivate class], self))
94         return;
95
96     if (coreResource)
97         coreResource->deref();
98     [super dealloc];
99 }
100
101 - (void)finalize
102 {
103     if (coreResource)
104         coreResource->deref();
105     [super finalize];
106 }
107
108 @end
109
110 @implementation WebResource
111
112 - (id)init
113 {
114     self = [super init];
115     if (!self)
116         return nil;
117     _private = [[WebResourcePrivate alloc] init];
118     return self;
119 }
120
121 - (id)initWithData:(NSData *)data URL:(NSURL *)URL MIMEType:(NSString *)MIMEType textEncodingName:(NSString *)textEncodingName frameName:(NSString *)frameName
122 {
123     return [self _initWithData:data URL:URL MIMEType:MIMEType textEncodingName:textEncodingName frameName:frameName response:nil copyData:YES];
124 }
125
126 - (id)initWithCoder:(NSCoder *)decoder
127 {
128     self = [super init];
129     if (!self)
130         return nil;
131
132     NSData *data = nil;
133     NSURL *url = nil;
134     NSString *mimeType = nil, *textEncoding = nil, *frameName = nil;
135     NSURLResponse *response = nil;
136     
137     @try {
138         id object = [decoder decodeObjectForKey:WebResourceDataKey];
139         if ([object isKindOfClass:[NSData class]])
140             data = object;
141         object = [decoder decodeObjectForKey:WebResourceURLKey];
142         if ([object isKindOfClass:[NSURL class]])
143             url = object;
144         object = [decoder decodeObjectForKey:WebResourceMIMETypeKey];
145         if ([object isKindOfClass:[NSString class]])
146             mimeType = object;
147         object = [decoder decodeObjectForKey:WebResourceTextEncodingNameKey];
148         if ([object isKindOfClass:[NSString class]])
149             textEncoding = object;
150         object = [decoder decodeObjectForKey:WebResourceFrameNameKey];
151         if ([object isKindOfClass:[NSString class]])
152             frameName = object;
153         object = [decoder decodeObjectForKey:WebResourceResponseKey];
154         if ([object isKindOfClass:[NSURLResponse class]])
155             response = object;
156     } @catch(id) {
157         [self release];
158         return nil;
159     }
160
161     _private = [[WebResourcePrivate alloc] initWithCoreResource:ArchiveResource::create(SharedBuffer::wrapNSData(data), url, mimeType, textEncoding, frameName, response)];
162
163     return self;
164 }
165
166 - (void)encodeWithCoder:(NSCoder *)encoder
167 {
168     ArchiveResource *resource = _private->coreResource;
169     
170     NSData *data = nil;
171     NSURL *url = nil;
172     NSString *mimeType = nil, *textEncoding = nil, *frameName = nil;
173     NSURLResponse *response = nil;
174     
175     if (resource) {
176         if (resource->data())
177             data = [resource->data()->createNSData() autorelease];
178         url = resource->url();
179         mimeType = resource->mimeType();
180         textEncoding = resource->textEncoding();
181         frameName = resource->frameName();
182         response = resource->response().nsURLResponse();
183     }
184     [encoder encodeObject:data forKey:WebResourceDataKey];
185     [encoder encodeObject:url forKey:WebResourceURLKey];
186     [encoder encodeObject:mimeType forKey:WebResourceMIMETypeKey];
187     [encoder encodeObject:textEncoding forKey:WebResourceTextEncodingNameKey];
188     [encoder encodeObject:frameName forKey:WebResourceFrameNameKey];
189     [encoder encodeObject:response forKey:WebResourceResponseKey];
190 }
191
192 - (void)dealloc
193 {
194     [_private release];
195     [super dealloc];
196 }
197
198 - (id)copyWithZone:(NSZone *)zone
199 {
200     return [self retain];
201 }
202
203 - (NSData *)data
204 {
205     if (_private->coreResource && _private->coreResource->data())
206         return [_private->coreResource->data()->createNSData() autorelease];
207     return 0;
208 }
209
210 - (NSURL *)URL
211 {
212     return _private->coreResource ? (NSURL *)_private->coreResource->url() : 0;
213 }
214
215 - (NSString *)MIMEType
216 {
217     return _private->coreResource ? (NSString *)_private->coreResource->mimeType() : 0;
218 }
219
220 - (NSString *)textEncodingName
221 {
222     return _private->coreResource ? (NSString *)_private->coreResource->textEncoding() : 0;
223 }
224
225 - (NSString *)frameName
226 {
227     return _private->coreResource ? (NSString *)_private->coreResource->frameName() : 0;
228 }
229
230 - (id)description
231 {
232     return [NSString stringWithFormat:@"<%@ %@>", [self className], [self URL]];
233 }
234
235 @end
236
237 @implementation WebResource (WebResourceInternal)
238
239 - (id)_initWithCoreResource:(PassRefPtr<ArchiveResource>)coreResource
240 {
241     self = [super init];
242     if (!self)
243         return nil;
244             
245     ASSERT(coreResource);
246     
247     // WebResources should not be init'ed with nil data, and doing so breaks certain uses of NSHTMLReader
248     // See <rdar://problem/5820157> for more info
249     if (!coreResource->data()) {
250         [self release];
251         return nil;
252     }
253     
254     _private = [[WebResourcePrivate alloc] initWithCoreResource:coreResource];
255             
256     return self;
257 }
258
259 - (WebCore::ArchiveResource *)_coreResource
260 {
261     return _private->coreResource;
262 }
263
264 @end
265
266 @implementation WebResource (WebResourcePrivate)
267
268 // SPI for Mail (5066325)
269 // FIXME: This "ignoreWhenUnarchiving" concept is an ugly one - can we find a cleaner solution for those who need this SPI?
270 - (void)_ignoreWhenUnarchiving
271 {
272     if (_private->coreResource)
273         _private->coreResource->ignoreWhenUnarchiving();
274 }
275
276 - (id)_initWithData:(NSData *)data 
277                 URL:(NSURL *)URL 
278            MIMEType:(NSString *)MIMEType 
279    textEncodingName:(NSString *)textEncodingName 
280           frameName:(NSString *)frameName 
281            response:(NSURLResponse *)response
282            copyData:(BOOL)copyData
283 {
284     self = [super init];
285     if (!self)
286         return nil;
287     
288     if (!data || !URL || !MIMEType) {
289         [self release];
290         return nil;
291     }
292             
293     _private = [[WebResourcePrivate alloc] initWithCoreResource:ArchiveResource::create(SharedBuffer::wrapNSData(copyData ? [[data copy] autorelease] : data), URL, MIMEType, textEncodingName, frameName, response)];
294             
295     return self;
296 }
297
298 - (id)_initWithData:(NSData *)data URL:(NSURL *)URL response:(NSURLResponse *)response
299 {
300     // Pass NO for copyData since the data doesn't need to be copied since we know that callers will no longer modify it.
301     // Copying it will also cause a performance regression.
302     return [self _initWithData:data
303                            URL:URL
304                       MIMEType:[response _webcore_MIMEType]
305               textEncodingName:[response textEncodingName]
306                      frameName:nil
307                       response:response
308                       copyData:NO];    
309 }
310
311 - (NSFileWrapper *)_fileWrapperRepresentation
312 {
313     SharedBuffer* coreData = _private->coreResource ? _private->coreResource->data() : 0;
314     NSData *data = coreData ? [coreData->createNSData() autorelease] : nil;
315     
316     NSFileWrapper *wrapper = [[[NSFileWrapper alloc] initRegularFileWithContents:data] autorelease];
317     NSString *preferredFilename = _private->coreResource ? (NSString *)_private->coreResource->response().suggestedFilename() : nil;
318     if (!preferredFilename || ![preferredFilename length]) {
319         NSURL *url = _private->coreResource ? (NSURL *)_private->coreResource->url() : nil;
320         NSString *mimeType = _private->coreResource ? (NSString *)_private->coreResource->mimeType() : nil;
321         preferredFilename = [url _webkit_suggestedFilenameWithMIMEType:mimeType];
322     }
323     
324     [wrapper setPreferredFilename:preferredFilename];
325     return wrapper;
326 }
327
328 - (NSURLResponse *)_response
329 {
330     NSURLResponse *response = nil;
331     if (_private->coreResource)
332         response = _private->coreResource->response().nsURLResponse();
333     
334     return response ? response : [[[NSURLResponse alloc] init] autorelease];        
335 }
336
337 - (NSString *)_stringValue
338 {
339     WebCore::TextEncoding encoding(_private->coreResource ? (NSString *)_private->coreResource->textEncoding() : nil);
340     if (!encoding.isValid())
341         encoding = WindowsLatin1Encoding();
342     
343     SharedBuffer* coreData = _private->coreResource ? _private->coreResource->data() : 0;
344     
345     return encoding.decode(reinterpret_cast<const char*>(coreData ? coreData->data() : 0), coreData ? coreData->size() : 0);
346 }
347
348 @end