c9587dc450296f908b6ce472275496b8156de716
[WebKit-https.git] / WebKit / Misc / WebKitErrors.m
1 /*
2  * Copyright (C) 2005 Apple Computer, 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 <WebKit/WebKitErrors.h>
30
31 #import <WebKit/WebKitErrorsPrivate.h>
32 #import <WebKit/WebLocalizableStrings.h>
33 #import <WebKit/WebNSURLExtras.h>
34
35 #import <pthread.h>
36
37 NSString *WebKitErrorDomain = @"WebKitErrorDomain";
38
39 NSString * const WebKitErrorMIMETypeKey =               @"WebKitErrorMIMETypeKey";
40 NSString * const WebKitErrorPlugInNameKey =             @"WebKitErrorPlugInNameKey";
41 NSString * const WebKitErrorPlugInPageURLStringKey =    @"WebKitErrorPlugInPageURLStringKey";
42
43 // Policy errors
44 #define WebKitErrorDescriptionCannotShowMIMEType UI_STRING("Cannot show content with specified mime type", "WebKitErrorCannotShowMIMEType description")
45 #define WebKitErrorDescriptionCannotShowURL UI_STRING("Cannot show URL", "WebKitErrorCannotShowURL description")
46 #define WebKitErrorDescriptionFrameLoadInterruptedByPolicyChange UI_STRING("Frame load interrupted", "WebKitErrorFrameLoadInterruptedByPolicyChange description")
47
48 // Plug-in and java errors
49 #define WebKitErrorDescriptionCannotFindPlugin UI_STRING("Cannot find plug-in", "WebKitErrorCannotFindPlugin description")
50 #define WebKitErrorDescriptionCannotLoadPlugin UI_STRING("Cannot load plug-in", "WebKitErrorCannotLoadPlugin description")
51 #define WebKitErrorDescriptionJavaUnavailable UI_STRING("Java is unavailable", "WebKitErrorJavaUnavailable description")
52 #define WebKitErrorDescriptionPlugInCancelledConnection UI_STRING("Plug-in cancelled", "WebKitErrorPlugInCancelledConnection description")
53 #define WebKitErrorDescriptionPlugInWillHandleLoad UI_STRING("Plug-in handled load", "WebKitErrorPlugInWillHandleLoad description")
54
55 static pthread_once_t registerErrorsControl = PTHREAD_ONCE_INIT;
56 static void registerErrors(void);
57
58 @implementation NSError (WebKitExtras)
59
60 static NSMutableDictionary *descriptions = nil;
61
62 + (void)_registerWebKitErrors
63 {
64     pthread_once(&registerErrorsControl, registerErrors);
65 }
66
67 -(id)_webkit_initWithDomain:(NSString *)domain code:(int)code URL:(NSURL *)URL
68 {
69     NSDictionary *descriptionsDict;
70     NSString *localizedDesc;
71     NSDictionary *dict;
72     // insert a localized string here for those folks not savvy to our category methods
73     descriptionsDict = [descriptions objectForKey:domain];
74     localizedDesc = descriptionsDict ? [descriptionsDict objectForKey:[NSNumber numberWithInt:code]] : nil;
75     dict = [NSDictionary dictionaryWithObjectsAndKeys:
76         URL, @"NSErrorFailingURLKey",
77         [URL absoluteString], @"NSErrorFailingURLStringKey",
78         localizedDesc, NSLocalizedDescriptionKey,
79         nil];
80     return [self initWithDomain:domain code:code userInfo:dict];
81 }
82
83 +(id)_webkit_errorWithDomain:(NSString *)domain code:(int)code URL:(NSURL *)URL
84 {
85     return [[[self alloc] _webkit_initWithDomain:domain code:code URL:URL] autorelease];
86 }
87
88 + (NSError *)_webKitErrorWithDomain:(NSString *)domain code:(int)code URL:(NSURL *)URL
89 {
90     [self _registerWebKitErrors];
91     return [self _webkit_errorWithDomain:domain code:code URL:URL];
92 }
93
94 + (NSError *)_webKitErrorWithCode:(int)code failingURL:(NSString *)URLString
95 {
96     return [self _webKitErrorWithDomain:WebKitErrorDomain code:code URL:[NSURL _web_URLWithUserTypedString:URLString]];
97 }
98
99 - (id)_initWithPluginErrorCode:(int)code
100                     contentURL:(NSURL *)contentURL
101                  pluginPageURL:(NSURL *)pluginPageURL
102                     pluginName:(NSString *)pluginName
103                       MIMEType:(NSString *)MIMEType
104 {
105     [[self class] _registerWebKitErrors];
106     
107     NSMutableDictionary *userInfo = [[NSMutableDictionary alloc] init];
108     if (contentURL) {
109         [userInfo setObject:contentURL forKey:@"NSErrorFailingURLKey"];
110         [userInfo setObject:[contentURL _web_userVisibleString] forKey:NSErrorFailingURLStringKey];
111     }
112     if (pluginPageURL) {
113         [userInfo setObject:[pluginPageURL _web_userVisibleString] forKey:WebKitErrorPlugInPageURLStringKey];
114     }
115     if (pluginName) {
116         [userInfo setObject:pluginName forKey:WebKitErrorPlugInNameKey];
117     }
118     if (MIMEType) {
119         [userInfo setObject:MIMEType forKey:WebKitErrorMIMETypeKey];
120     }
121
122     NSDictionary *userInfoCopy = [userInfo count] > 0 ? [[NSDictionary alloc] initWithDictionary:userInfo] : nil;
123     [userInfo release];
124     NSError *error = [self initWithDomain:WebKitErrorDomain code:code userInfo:userInfoCopy];
125     [userInfoCopy release];
126     
127     return error;
128 }
129
130 + (void)_webkit_addErrorsWithCodesAndDescriptions:(NSDictionary *)dictionary inDomain:(NSString *)domain
131 {
132     if (!descriptions)
133         descriptions = [[NSMutableDictionary alloc] init];
134
135     [descriptions setObject:dictionary forKey:domain];
136 }
137
138 static void registerErrors()
139 {
140     NSAutoreleasePool *pool;
141
142     pool = [[NSAutoreleasePool alloc] init];
143
144     NSDictionary *dict = [NSDictionary dictionaryWithObjectsAndKeys:
145         // Policy errors
146         WebKitErrorDescriptionCannotShowMIMEType,                   [NSNumber numberWithInt: WebKitErrorCannotShowMIMEType],
147         WebKitErrorDescriptionCannotShowURL,                        [NSNumber numberWithInt: WebKitErrorCannotShowURL],
148         WebKitErrorDescriptionFrameLoadInterruptedByPolicyChange,   [NSNumber numberWithInt: WebKitErrorFrameLoadInterruptedByPolicyChange],
149
150         // Plug-in and java errors
151         WebKitErrorDescriptionCannotFindPlugin,                     [NSNumber numberWithInt: WebKitErrorCannotFindPlugIn],
152         WebKitErrorDescriptionCannotLoadPlugin,                     [NSNumber numberWithInt: WebKitErrorCannotLoadPlugIn],
153         WebKitErrorDescriptionJavaUnavailable,                      [NSNumber numberWithInt: WebKitErrorJavaUnavailable],
154         WebKitErrorDescriptionPlugInCancelledConnection,            [NSNumber numberWithInt: WebKitErrorPlugInCancelledConnection],
155         WebKitErrorDescriptionPlugInWillHandleLoad,                 [NSNumber numberWithInt: WebKitErrorPlugInWillHandleLoad],
156         nil];
157
158     [NSError _webkit_addErrorsWithCodesAndDescriptions:dict inDomain:WebKitErrorDomain];
159
160     [pool drain];
161 }
162
163 @end