8960c2fa73eb15bf8517115cb6840e8754c14226
[WebKit-https.git] / WebCore / loader / mac / LoaderNSURLExtras.m
1 /*
2  * Copyright (C) 2005, 2008 Apple Inc. All rights reserved.
3  * Copyright (C) 2006 Alexey Proskuryakov (ap@nypop.com)
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer. 
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution. 
14  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission. 
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29
30 #import "config.h"
31 #import "LoaderNSURLExtras.h"
32
33 #import <wtf/Assertions.h>
34 #import <wtf/Vector.h>
35 #import "KURL.h"
36 #import "LocalizedStrings.h"
37 #import "MIMETypeRegistry.h"
38 #import "PlatformString.h"
39 #import "WebCoreNSStringExtras.h"
40 #import "WebCoreSystemInterface.h"
41
42 using namespace WebCore;
43
44 NSURL *urlByRemovingComponent(NSURL *url, CFURLComponentType component)
45 {
46     if (!url)
47         return nil;
48
49     CFRange fragRg = CFURLGetByteRangeForComponent((CFURLRef)url, component, NULL);
50     // Check to see if a fragment exists before decomposing the URL.
51     if (fragRg.location == kCFNotFound)
52         return url;
53
54     UInt8 *urlBytes, buffer[2048];
55     CFIndex numBytes = CFURLGetBytes((CFURLRef)url, buffer, 2048);
56     if (numBytes == -1) {
57         numBytes = CFURLGetBytes((CFURLRef)url, NULL, 0);
58         urlBytes = static_cast<UInt8*>(malloc(numBytes));
59         CFURLGetBytes((CFURLRef)url, urlBytes, numBytes);
60     } else
61         urlBytes = buffer;
62     
63     NSURL *result = (NSURL *)CFMakeCollectable(CFURLCreateWithBytes(NULL, urlBytes, fragRg.location - 1, kCFStringEncodingUTF8, NULL));
64     if (!result)
65         result = (NSURL *)CFMakeCollectable(CFURLCreateWithBytes(NULL, urlBytes, fragRg.location - 1, kCFStringEncodingISOLatin1, NULL));
66     
67     if (urlBytes != buffer) free(urlBytes);
68     return result ? [result autorelease] : url;
69 }
70
71 NSURL *urlByRemovingFragment(NSURL *url)
72 {
73     return urlByRemovingComponent(url, kCFURLComponentFragment);
74 }
75
76 NSString *urlOriginalDataAsString(NSURL *url)
77 {
78     return [[[NSString alloc] initWithData:urlOriginalData(url) encoding:NSISOLatin1StringEncoding] autorelease];
79 }
80
81 #define URL_BYTES_BUFFER_LENGTH 2048
82
83 NSData *urlOriginalData(NSURL *url)
84 {
85     if (!url)
86         return nil;
87
88     UInt8 *buffer = (UInt8 *)malloc(URL_BYTES_BUFFER_LENGTH);
89     CFIndex bytesFilled = CFURLGetBytes((CFURLRef)url, buffer, URL_BYTES_BUFFER_LENGTH);
90     if (bytesFilled == -1) {
91         CFIndex bytesToAllocate = CFURLGetBytes((CFURLRef)url, NULL, 0);
92         buffer = (UInt8 *)realloc(buffer, bytesToAllocate);
93         bytesFilled = CFURLGetBytes((CFURLRef)url, buffer, bytesToAllocate);
94         ASSERT(bytesFilled == bytesToAllocate);
95     }
96     
97     // buffer is adopted by the NSData
98     NSData *data = [NSData dataWithBytesNoCopy:buffer length:bytesFilled freeWhenDone:YES];
99     
100     NSURL *baseURL = (NSURL *)CFURLGetBaseURL((CFURLRef)url);
101     if (baseURL)
102         return urlOriginalData(urlWithDataRelativeToURL(data, baseURL));
103     return data;
104 }
105
106 NSURL *urlWithData(NSData *data)
107 {
108     if (data == nil)
109         return nil;
110
111     return urlWithDataRelativeToURL(data, nil);
112 }      
113
114 static inline id WebCFAutorelease(CFTypeRef obj)
115 {
116     if (obj)
117         CFMakeCollectable(obj);
118     [(id)obj autorelease];
119     return (id)obj;
120 }
121
122 NSURL *urlWithDataRelativeToURL(NSData *data, NSURL *baseURL)
123 {
124     if (data == nil)
125         return nil;
126     
127     NSURL *result = nil;
128     size_t length = [data length];
129     if (length > 0) {
130         // work around <rdar://4470771>: CFURLCreateAbsoluteURLWithBytes(.., TRUE) doesn't remove non-path components.
131         baseURL = urlByRemovingResourceSpecifier(baseURL);
132         
133         const UInt8 *bytes = static_cast<const UInt8*>([data bytes]);
134         // NOTE: We use UTF-8 here since this encoding is used when computing strings when returning URL components
135         // (e.g calls to NSURL -path). However, this function is not tolerant of illegal UTF-8 sequences, which
136         // could either be a malformed string or bytes in a different encoding, like shift-jis, so we fall back
137         // onto using ISO Latin 1 in those cases.
138         result = WebCFAutorelease(CFURLCreateAbsoluteURLWithBytes(NULL, bytes, length, kCFStringEncodingUTF8, (CFURLRef)baseURL, YES));
139         if (!result)
140             result = WebCFAutorelease(CFURLCreateAbsoluteURLWithBytes(NULL, bytes, length, kCFStringEncodingISOLatin1, (CFURLRef)baseURL, YES));
141     } else
142         result = [NSURL URLWithString:@""];
143
144     return result;
145 }
146
147 NSURL *urlByRemovingResourceSpecifier(NSURL *url)
148 {
149     return urlByRemovingComponent(url, kCFURLComponentResourceSpecifier);
150 }
151
152
153 BOOL urlIsFileURL(NSURL *url)
154 {
155     if (!url)
156         return false;
157
158     return stringIsFileURL(urlOriginalDataAsString(url));
159 }
160
161 BOOL stringIsFileURL(NSString *urlString)
162 {
163     return [urlString rangeOfString:@"file:" options:(NSCaseInsensitiveSearch | NSAnchoredSearch)].location != NSNotFound;
164 }
165
166 BOOL urlIsEmpty(NSURL *url)
167 {
168     if (!url)
169         return false;
170     if (!CFURLGetBaseURL((CFURLRef)url))
171         return CFURLGetBytes((CFURLRef)url, NULL, 0) == 0;
172     return [urlOriginalData(url) length] == 0;
173 }
174
175 NSURL *canonicalURL(NSURL *url)
176 {
177     if (!url)
178         return nil;
179     
180     NSURLRequest *request = [[NSURLRequest alloc] initWithURL:url];
181     Class concreteClass = wkNSURLProtocolClassForReqest(request);
182     if (!concreteClass) {
183         [request release];
184         return url;
185     }
186     
187     // This applies NSURL's concept of canonicalization, but not KURL's concept. It would
188     // make sense to apply both, but when we tried that it caused a performance degradation
189     // (see 5315926). It might make sense to apply only the KURL concept and not the NSURL
190     // concept, but it's too risky to make that change for WebKit 3.0.
191     NSURLRequest *newRequest = [concreteClass canonicalRequestForRequest:request];
192     NSURL *newURL = [newRequest URL]; 
193     NSURL *result = [[newURL retain] autorelease]; 
194     [request release];
195     
196     return result;
197 }
198
199 static bool vectorContainsString(Vector<String> vector, String string)
200 {
201     int size = vector.size();
202     for (int i = 0; i < size; i++)
203         if (vector[i] == string)
204             return true;
205     return false;
206 }
207
208 NSString *suggestedFilenameWithMIMEType(NSURL *url, NSString *MIMEType)
209 {
210     // Get the filename from the URL. Try the lastPathComponent first.
211     NSString *lastPathComponent = [[url path] lastPathComponent];
212     NSString *filename = filenameByFixingIllegalCharacters(lastPathComponent);
213     NSString *extension = nil;
214
215     if ([filename length] == 0 || [lastPathComponent isEqualToString:@"/"]) {
216         // lastPathComponent is no good, try the host.
217         NSString *host = KURL(url).host();
218         filename = filenameByFixingIllegalCharacters(host);
219         if ([filename length] == 0) {
220             // Can't make a filename using this URL, use "unknown".
221             filename = copyImageUnknownFileLabel();
222         }
223     } else {
224         // Save the extension for later correction. Only correct the extension of the lastPathComponent.
225         // For example, if the filename ends up being the host, we wouldn't want to correct ".com" in "www.apple.com".
226         extension = [filename pathExtension];
227     }
228
229     // No mime type reported. Just return the filename we have now.
230     if (!MIMEType) {
231         return filename;
232     }
233
234     // Do not correct filenames that are reported with a mime type of tar, and 
235     // have a filename which has .tar in it or ends in .tgz
236     if (([MIMEType isEqualToString:@"application/tar"] || [MIMEType isEqualToString:@"application/x-tar"]) 
237         && (hasCaseInsensitiveSubstring(filename, @".tar")
238         || hasCaseInsensitiveSuffix(filename, @".tgz"))) {
239         return filename;
240     }
241
242     // I don't think we need to worry about this for the image case
243     // If the type is known, check the extension and correct it if necessary.
244     if (![MIMEType isEqualToString:@"application/octet-stream"] && ![MIMEType isEqualToString:@"text/plain"]) {
245         Vector<String> extensions = MIMETypeRegistry::getExtensionsForMIMEType(MIMEType);
246
247         if (extensions.isEmpty() || !vectorContainsString(extensions, extension)) {
248             // The extension doesn't match the MIME type. Correct this.
249             NSString *correctExtension = MIMETypeRegistry::getPreferredExtensionForMIMEType(MIMEType);
250             if ([correctExtension length] != 0) {
251                 // Append the correct extension.
252                 filename = [filename stringByAppendingPathExtension:correctExtension];
253             }
254         }
255     }
256
257     return filename;
258 }