Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebCore / platform / network / mac / ResourceErrorMac.mm
1 /*
2  * Copyright (C) 2006, 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  * 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 "config.h"
27 #import "ResourceError.h"
28
29 #import <CoreFoundation/CFError.h>
30 #import <Foundation/Foundation.h>
31 #import <wtf/BlockObjCExceptions.h>
32 #import <wtf/NeverDestroyed.h>
33 #import <wtf/URL.h>
34 #import <wtf/text/WTFString.h>
35
36 @interface NSError (WebExtras)
37 - (NSString *)_web_localizedDescription;
38 @end
39
40 #if PLATFORM(IOS_FAMILY)
41
42 // This workaround code exists here because we can't call translateToCFError in Foundation. Once we
43 // have that, we can remove this code. <rdar://problem/9837415> Need SPI for translateCFError
44 // The code is mostly identical to Foundation - I changed the class name and fixed minor compile errors.
45 // We need this because client code (Safari) wants an NSError with NSURLErrorDomain as its domain.
46 // The Foundation code below does that and sets up appropriate certificate keys in the NSError.
47
48 @interface WebCustomNSURLError : NSError
49
50 @end
51
52 @implementation WebCustomNSURLError
53
54 static NSDictionary* dictionaryThatCanCode(NSDictionary* src)
55 {
56     // This function makes a copy of input dictionary, modifies it such that it "should" (as much as we can help it)
57     // not contain any objects that do not conform to NSCoding protocol, and returns it autoreleased.
58
59     NSMutableDictionary* dst = [src mutableCopy];
60
61     // Kill the known problem entries.
62     [dst removeObjectForKey:@"NSErrorPeerCertificateChainKey"]; // NSArray with SecCertificateRef objects
63     [dst removeObjectForKey:@"NSErrorClientCertificateChainKey"]; // NSArray with SecCertificateRef objects
64     [dst removeObjectForKey:NSURLErrorFailingURLPeerTrustErrorKey]; // SecTrustRef object
65     [dst removeObjectForKey:NSUnderlyingErrorKey]; // (Immutable) CFError containing kCF equivalent of the above
66     // We could reconstitute this but it's more trouble than it's worth
67
68     // Non-comprehensive safety check:  Kill top-level dictionary entries that don't conform to NSCoding.
69     // We may hit ones we just removed, but that's fine.
70     // We don't handle arbitrary objects that clients have stuffed into the dictionary, since we may not know how to
71     // get at its conents (e.g., a CFError object -- you'd have to know it had a userInfo dictionary and kill things
72     // inside it).
73     [src enumerateKeysAndObjectsUsingBlock:^(id key, id obj, BOOL*) {
74         if (! [obj conformsToProtocol:@protocol(NSCoding)]) {
75             [dst removeObjectForKey:key];
76         }
77         // FIXME: We could drill down into subdictionaries, but it seems more trouble than it's worth
78     }];
79
80     return [dst autorelease];
81 }
82
83 - (void)encodeWithCoder:(NSCoder *)coder
84 {
85     NSDictionary* newUserInfo = dictionaryThatCanCode([self userInfo]);
86
87     [[NSError errorWithDomain:[self domain] code:[self code] userInfo:newUserInfo] encodeWithCoder:coder];
88 }
89
90 @end
91
92 #endif // PLATFORM(IOS_FAMILY)
93
94 namespace WebCore {
95
96 static RetainPtr<NSError> createNSErrorFromResourceErrorBase(const ResourceErrorBase& resourceError)
97 {
98     RetainPtr<NSMutableDictionary> userInfo = adoptNS([[NSMutableDictionary alloc] init]);
99
100     if (!resourceError.localizedDescription().isEmpty())
101         [userInfo.get() setValue:resourceError.localizedDescription() forKey:NSLocalizedDescriptionKey];
102
103     if (!resourceError.failingURL().isEmpty()) {
104         [userInfo.get() setValue:(NSString *)resourceError.failingURL().string() forKey:@"NSErrorFailingURLStringKey"];
105         if (NSURL *cocoaURL = (NSURL *)resourceError.failingURL())
106             [userInfo.get() setValue:cocoaURL forKey:@"NSErrorFailingURLKey"];
107     }
108
109     return adoptNS([[NSError alloc] initWithDomain:resourceError.domain() code:resourceError.errorCode() userInfo:userInfo.get()]);
110 }
111
112 ResourceError::ResourceError(NSError *nsError)
113     : ResourceErrorBase(Type::Null)
114     , m_dataIsUpToDate(false)
115     , m_platformError(nsError)
116 {
117     mapPlatformError();
118 }
119
120 ResourceError::ResourceError(CFErrorRef cfError)
121     : ResourceError { (__bridge NSError *)cfError }
122 {
123 }
124
125 const String& ResourceError::getNSURLErrorDomain() const
126 {
127     static const NeverDestroyed<String> errorDomain(NSURLErrorDomain);
128     return errorDomain.get();
129 }
130
131 const String& ResourceError::getCFErrorDomainCFNetwork() const
132 {
133     static const NeverDestroyed<String> errorDomain(kCFErrorDomainCFNetwork);
134     return errorDomain.get();
135 }
136
137 void ResourceError::mapPlatformError()
138 {
139     static_assert(NSURLErrorTimedOut == kCFURLErrorTimedOut, "NSURLErrorTimedOut needs to equal kCFURLErrorTimedOut");
140     static_assert(NSURLErrorCancelled == kCFURLErrorCancelled, "NSURLErrorCancelled needs to equal kCFURLErrorCancelled");
141
142     if (!m_platformError)
143         return;
144
145     auto domain = [m_platformError.get() domain];
146     auto errorCode = [m_platformError.get() code];
147
148     if ([domain isEqualToString:NSURLErrorDomain] || [domain isEqualToString:(__bridge NSString *)kCFErrorDomainCFNetwork])
149         setType((errorCode == NSURLErrorTimedOut) ? Type::Timeout : (errorCode == NSURLErrorCancelled) ? Type::Cancellation : Type::General);
150     else
151         setType(Type::General);
152 }
153
154 void ResourceError::platformLazyInit()
155 {
156     if (m_dataIsUpToDate)
157         return;
158
159     m_domain = [m_platformError.get() domain];
160     m_errorCode = [m_platformError.get() code];
161
162     if (NSString* failingURLString = [[m_platformError.get() userInfo] valueForKey:@"NSErrorFailingURLStringKey"])
163         m_failingURL = URL(URL(), failingURLString);
164     else
165         m_failingURL = URL((NSURL *)[[m_platformError.get() userInfo] valueForKey:@"NSErrorFailingURLKey"]);
166     // Workaround for <rdar://problem/6554067>
167     m_localizedDescription = m_failingURL;
168     BEGIN_BLOCK_OBJC_EXCEPTIONS;
169     m_localizedDescription = [m_platformError.get() _web_localizedDescription];
170     END_BLOCK_OBJC_EXCEPTIONS;
171
172     m_dataIsUpToDate = true;
173 }
174
175 bool ResourceError::platformCompare(const ResourceError& a, const ResourceError& b)
176 {
177     return a.nsError() == b.nsError();
178 }
179
180 void ResourceError::doPlatformIsolatedCopy(const ResourceError&)
181 {
182 }
183
184 NSError *ResourceError::nsError() const
185 {
186     if (isNull()) {
187         ASSERT(!m_platformError);
188         return nil;
189     }
190
191     if (!m_platformError)
192         m_platformError = createNSErrorFromResourceErrorBase(*this);
193
194     return m_platformError.get();
195 }
196
197 ResourceError::operator NSError *() const
198 {
199     return nsError();
200 }
201
202 CFErrorRef ResourceError::cfError() const
203 {
204     return (__bridge CFErrorRef)nsError();
205 }
206
207 ResourceError::operator CFErrorRef() const
208 {
209     return cfError();
210 }
211
212 } // namespace WebCore