/
KSURLFormatter.m
321 lines (262 loc) · 10.7 KB
/
KSURLFormatter.m
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
//
// KSURLFormatter.m
//
// Copyright (c) 2008-2012 Mike Abdullah and Karelia Software
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL MIKE ABDULLAH OR KARELIA SOFTWARE BE LIABLE FOR ANY
// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
#import "KSURLFormatter.h"
#import "KSURLUtilities.h"
@implementation KSURLFormatter
#pragma mark Class Methods
+ (NSURL *)URLFromString:(NSString *)string;
{
// Encode the URL string
CFStringRef escapedString = CFURLCreateStringByAddingPercentEscapes(NULL,
(CFStringRef)string,
(CFStringRef)@"%+#",
NULL,
kCFStringEncodingUTF8);
// If we're still left with a valid string, turn it into a URL
NSURL *result = nil;
if (escapedString)
{
// Any hashes after first # needs to be escaped. e.g. Apple's dev docs hand out URLs like this
NSRange range = [(NSString *)escapedString rangeOfString:@"#"];
if (range.location != NSNotFound)
{
NSRange postFragmentRange = NSMakeRange(NSMaxRange(range), [(NSString *)escapedString length] - NSMaxRange(range));
range = [(NSString *)escapedString rangeOfString:@"#" options:0 range:postFragmentRange];
if (range.location != NSNotFound)
{
NSString *extraEscapedString = [(NSString *)escapedString stringByReplacingOccurrencesOfString:@"#"
withString:@"%23" // not ideal, encoding ourselves
options:0
range:postFragmentRange];
CFRelease(escapedString);
return [NSURL URLWithString:extraEscapedString];
}
}
result = [NSURL URLWithString:(NSString *)escapedString];
CFRelease(escapedString);
}
return result;
}
+ (BOOL)isValidEmailAddress:(NSString *)address;
{
// for now, just validate that syntactically it it at least _@_.__
// though we are not checking actual other characters.
// we can refine this over time
NSRange whereAt = [address rangeOfString:@"@"];
BOOL OK = (whereAt.location != NSNotFound && whereAt.location >= 1); // make sure there is an @ and it's not the first character
if (OK)
{
NSInteger len = [address length] - whereAt.location;
NSRange whereDot = [address rangeOfString:@"." options:0 range:NSMakeRange(whereAt.location, len)];
OK = (whereDot.location != NSNotFound);
if (OK)
{
// make sure there is room between the @ and the .
OK = (whereDot.location - whereAt.location >= 2) && ([address length] - whereDot.location >= 3);
}
}
return OK;
}
+ (BOOL)isLikelyEmailAddress:(NSString *)address;
{
BOOL result = [self isValidEmailAddress:address];
if (result)
{
NSURL *URL = [[NSURL alloc] initWithString:address];
if (URL)
{
// Account for strings like http://example.com/@foo which seem to be technically valid as an email address, but unlikely to be one
if ([URL scheme]) result = NO;
[URL release];
}
}
return result;
}
#pragma mark Init & Dealloc
- (id)init
{
if (self = [super init])
{
_defaultScheme = [@"http" retain];
_fallbackTopLevelDomain = [@"com" retain];
}
return self;
}
- (void)dealloc
{
[_defaultScheme release];
[_allowedSchemes release];
[_fallbackTopLevelDomain release];
[super dealloc];
}
#pragma mark Managing Behaviour
@synthesize useDisplayNameForFileURLs = _useDisplayNameForFileURLs;
@synthesize defaultScheme = _defaultScheme;
@synthesize allowedSchemes = _allowedSchemes;
- (void)setAllowedSchemes:(NSArray *)schemes;
{
if (schemes) NSParameterAssert([schemes count] > 0);
schemes = [schemes copy];
[_allowedSchemes release]; _allowedSchemes = schemes;
}
@synthesize fallbackTopLevelDomain = _fallbackTopLevelDomain;
#pragma mark Textual Representation of Cell Content
- (NSString *)stringForObjectValue:(id)anObject
{
if (!anObject) return nil;
if (![anObject isKindOfClass:[NSURL class]]) return [anObject description];
NSURL *URL = anObject;
NSString *result;
if ([self useDisplayNameForFileURLs] && [anObject isFileURL])
{
result = [[NSFileManager defaultManager] displayNameAtPath:[URL path]];
}
else
{
result = [URL absoluteString];
// Append trailing slash if needed
if ([URL ks_hasNetworkLocation] && [[URL path] isEqualToString:@""])
{
result = [result stringByAppendingString:@"/"];
}
}
return result;
}
#pragma mark Object Equivalent to Textual Representation
+ (NSURL *)URLFromString:(NSString *)string defaultScheme:(NSString *)fallbackScheme;
{
// Tries to interpret the string as a complete URL. If there is no scheme specified, try it as an email address. If that doesn't seem reasonable, combine with fallbackScheme
NSURL *result = [self URLFromString:string];
// Allow fragment links as-is
if ([string hasPrefix:@"#"] && ([string length] > [@"#" length] && result))
{
return result;
}
// This is probably a really naive check
if ((![result scheme] && ![string hasPrefix:@"/"]) || // e.g. foo
(![result host])) // e.g. foo.com:8888
{
// if it looks like an email address, use mailto:
if ([self isLikelyEmailAddress:string])
{
result = [NSURL URLWithString:[NSString stringWithFormat:@"mailto:%@", string]];
}
else if (![[result scheme] isEqualToString:@"file"])
{
result = [self URLFromString:[NSString stringWithFormat:
@"%@://%@",
fallbackScheme,
string]];
}
}
// Append a trailing slash if needed
if ([result ks_hasNetworkLocation] && [[result path] isEqualToString:@""])
{
result = [[NSURL URLWithString:@"/" relativeToURL:result] absoluteURL];
}
return result;
}
- (BOOL)getObjectValue:(id *)anObject forString:(NSString *)string errorDescription:(NSString **)error
{
if (anObject)
{
NSURL *URL = [self URLFromString:string];
if ([self generatesURLStrings])
{
*anObject = [URL absoluteString];
}
else
{
*anObject = URL;
}
}
return YES;
}
- (NSURL *)URLFromString:(NSString *)string;
{
NSURL *result = nil;
if ([string length] > 0)
{
result = [KSURLFormatter URLFromString:string defaultScheme:[self defaultScheme]];
// Does the URL have no useful resource specified? If so, generate nil URL
if (result && ![[result scheme] isEqualToString:@"mailto"] && ![result isFileURL])
{
NSString *resource = [result resourceSpecifier];
if ([resource length] == 0 ||
[resource isEqualToString:@"/"] ||
[resource isEqualToString:@"//"])
{
result = nil;
}
// URLs should also really have a host and a path
if (result)
{
NSString *host = [result host];
NSString *path = [result path];
if (!host && !path && ![result fragment])
{
result = nil;
}
}
}
// Did the user not enter a top-level domain? We'll guess for them
if (result && ![result isFileURL] && [self fallbackTopLevelDomain])
{
if ([[result ks_domains] count] == 1)
{
NSString *urlString = [NSString stringWithFormat:
@"%@://%@.%@/",
[result scheme],
[result host],
[self fallbackTopLevelDomain]];
result = [self URLFromString:urlString];
}
}
// Make sure the scheme is allowed
NSArray *allowedSchemes = [self allowedSchemes];
if (allowedSchemes)
{
NSString *scheme = [result scheme];
if (scheme && ![allowedSchemes containsObject:[result scheme]])
{
// Look for the best matching scheme based on the assumption that the URL was simply pasted in missing a small number of initial characters
for (NSString *aScheme in allowedSchemes)
{
if ([aScheme hasSuffix:scheme])
{
result = [result ks_URLWithScheme:aScheme];
return result;
}
}
// Nothing matched? Alright, go for the first one then
result = [result ks_URLWithScheme:[allowedSchemes objectAtIndex:0]];
}
}
}
return result;
}
@synthesize generatesURLStrings = _generateStrings;
@end