forked from karelia/KSFileUtilities
-
Notifications
You must be signed in to change notification settings - Fork 0
/
KSURLComponents.m
552 lines (448 loc) · 18.9 KB
/
KSURLComponents.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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
//
// KSURLComponents.m
// KSFileUtilities
//
// Created by Mike Abdullah on 06/07/2013.
// Copyright © 2013 Karelia Software
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//
#import "KSURLComponents.h"
@interface KSURLComponents ()
@property (nonatomic, copy, readwrite) NSString *percentEncodedUser;
@property (nonatomic, copy, readwrite) NSString *percentEncodedPassword;
@property (nonatomic, copy, readwrite) NSString *percentEncodedHost;
@property (nonatomic, copy, readwrite) NSString *percentEncodedPath;
@property (nonatomic, copy, readwrite) NSString *percentEncodedQuery;
@property (nonatomic, copy, readwrite) NSString *percentEncodedFragment;
@end
@implementation KSURLComponents
#pragma mark Lifecycle
- (instancetype)initWithURL:(NSURL *)url resolvingAgainstBaseURL:(BOOL)resolve;
{
if (!url) [NSException raise:NSInvalidArgumentException format:@"-[KSURLComponents %@] requires a non-nil URL", NSStringFromSelector(_cmd)];
if (resolve) url = url.absoluteURL;
CFStringRef urlString = CFURLGetString((CFURLRef)url);
BOOL fudgedParsing = NO;
self = [self init];
// Default to empty path. NSURLComponents seems to basically do that; it's very hard to end up with a nil path
self.percentEncodedPath = @"";
// Avoid CFURLCopyScheme as it resolves relative URLs
CFRange schemeRange = CFURLGetByteRangeForComponent((CFURLRef)url, kCFURLComponentScheme, NULL);
if (schemeRange.location != kCFNotFound)
{
CFStringRef scheme = CFStringCreateWithSubstring(NULL, urlString, schemeRange);
self.scheme = (__bridge NSString *)scheme;
CFRelease(scheme);
// For URLs which feature no slashes to indicate the path *before* a
// ; ? or # mark, we need to coerce them into parsing
if (schemeRange.location == 0)
{
if (!CFStringFindWithOptions(urlString,
CFSTR(":/"),
CFRangeMake(schemeRange.length, CFStringGetLength(urlString) - schemeRange.length),
kCFCompareAnchored,
NULL))
{
NSMutableString *fudgedString = [(__bridge NSString *)urlString mutableCopy];
[fudgedString insertString:@"/"
atIndex:(schemeRange.length + 1)]; // after the colon
url = [NSURL URLWithString:fudgedString];
urlString = CFURLGetString((CFURLRef)url);
fudgedParsing = YES;
}
}
}
// Avoid CFURLCopyUserName as it removes escapes
CFRange userRange = CFURLGetByteRangeForComponent((CFURLRef)url, kCFURLComponentUser, NULL);
if (userRange.location != kCFNotFound)
{
CFStringRef user = CFStringCreateWithSubstring(NULL, urlString, userRange);
self.percentEncodedUser = (__bridge NSString *)user;
CFRelease(user);
}
// Avoid CFURLCopyPassword as it removes escapes
CFRange passwordRange = CFURLGetByteRangeForComponent((CFURLRef)url, kCFURLComponentPassword, NULL);
if (passwordRange.location != kCFNotFound)
{
CFStringRef password = CFStringCreateWithSubstring(NULL, urlString, passwordRange);
self.percentEncodedPassword = (__bridge NSString *)password;
CFRelease(password);
}
// Avoid CFURLCopyHostName as it removes escapes
CFRange hostRange = CFURLGetByteRangeForComponent((CFURLRef)url, kCFURLComponentHost, NULL);
if (hostRange.location != kCFNotFound)
{
CFStringRef host = CFStringCreateWithSubstring(NULL, urlString, hostRange);
self.percentEncodedHost = (__bridge NSString *)host;
CFRelease(host);
}
// Need to represent the presence of a host whenever the URL starts scheme://
// Manually searching is the best I've found so far
else if (schemeRange.location == 0)
{
if (CFStringFindWithOptions(urlString,
CFSTR("://"),
CFRangeMake(schemeRange.length, CFStringGetLength(urlString) - schemeRange.length),
kCFCompareAnchored,
NULL))
{
self.percentEncodedHost = @"";
}
}
SInt32 port = CFURLGetPortNumber((CFURLRef)url);
if (port >= 0) self.port = @(port);
// Account for parameter. NS/CFURL treat it as distinct, but NSURLComponents rolls it into the path
CFRange pathRange = CFURLGetByteRangeForComponent((CFURLRef)url, kCFURLComponentPath, NULL);
CFRange parameterRange;
CFURLGetByteRangeForComponent((CFURLRef)url, kCFURLComponentParameterString, ¶meterRange);
if (pathRange.location != kCFNotFound || (parameterRange.location != kCFNotFound && parameterRange.length > 0))
{
if (pathRange.location == kCFNotFound)
{
pathRange = parameterRange;
}
else if (parameterRange.length > 0)
{
pathRange.length += parameterRange.length;
}
if (fudgedParsing)
{
pathRange.location++; pathRange.length--;
}
CFStringRef path = CFStringCreateWithSubstring(NULL, CFURLGetString((CFURLRef)url), pathRange);
self.percentEncodedPath = (__bridge NSString *)path;
CFRelease(path);
}
CFStringRef query = CFURLCopyQueryString((CFURLRef)url, NULL);
if (query)
{
self.percentEncodedQuery = (__bridge NSString *)query;
CFRelease(query);
}
CFStringRef fragment = CFURLCopyFragment((CFURLRef)url, NULL);
if (fragment)
{
self.percentEncodedFragment = (__bridge NSString *)fragment;
CFRelease(fragment);
}
return self;
}
+ (instancetype)componentsWithURL:(NSURL *)url resolvingAgainstBaseURL:(BOOL)resolve;
{
return [[self alloc] initWithURL:url resolvingAgainstBaseURL:resolve];
}
- (instancetype)initWithString:(NSString *)URLString;
{
NSURL *url = [[NSURL alloc] initWithString:URLString];
if (!url)
{
return nil;
}
self = [self initWithURL:url
resolvingAgainstBaseURL:NO]; // already absolute
return self;
}
+ (instancetype)componentsWithString:(NSString *)URLString;
{
return [[self alloc] initWithString:URLString];
}
#pragma mark Generating a URL
- (NSURL *)URL;
{
return [self URLRelativeToURL:nil];
}
- (NSURL *)URLRelativeToURL:(NSURL *)baseURL;
{
NSString *user = self.percentEncodedUser;
NSString *password = self.percentEncodedPassword;
NSString *host = self.percentEncodedHost;
NSNumber *port = self.port;
NSString *path = self.percentEncodedPath;
BOOL hasAuthorityComponent = (user || password || host || port);
// If the KSURLComponents has an authority component (user, password, host or port) and a path component, then the path must either begin with "/" or be an empty string.
if (hasAuthorityComponent &&
!(path.length == 0 || path.absolutePath))
{
return nil;
}
// If the KSURLComponents does not have an authority component (user, password, host or port) and has a path component, the path component must not start with "//".
if (!hasAuthorityComponent && [path hasPrefix:@"//"])
{
return nil;
}
NSMutableString *string = [[NSMutableString alloc] init];
NSString *scheme = self.scheme;
if (scheme)
{
[string appendString:scheme];
[string appendString:@":"];
}
if (hasAuthorityComponent) [string appendString:@"//"];
if (user) [string appendString:user];
if (password)
{
[string appendString:@":"];
[string appendString:password];
}
if (user || password) [string appendString:@"@"];
if (host)
{
[string appendString:host];
}
if (port)
{
[string appendFormat:@":%u", port.unsignedIntValue];
}
if (path)
{
[string appendString:path];
}
NSString *query = self.percentEncodedQuery;
if (query)
{
[string appendString:@"?"];
[string appendString:query];
}
NSString *fragment = self.percentEncodedFragment;
if (fragment)
{
[string appendString:@"#"];
[string appendString:fragment];
}
NSURL *result = [NSURL URLWithString:string relativeToURL:baseURL];
return result;
}
#pragma mark Components
@synthesize scheme = _schemeComponent;
- (void)setScheme:(NSString *)scheme;
{
if (scheme)
{
NSCharacterSet *legalCharacters = [NSCharacterSet characterSetWithCharactersInString:@"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-."];
if ([scheme rangeOfCharacterFromSet:legalCharacters.invertedSet].location != NSNotFound)
{
[NSException raise:NSInvalidArgumentException format:@"invalid characters in scheme"];
}
}
scheme = [scheme copy];
_schemeComponent = scheme;
}
@synthesize percentEncodedUser = _userComponent;
- (NSString *)user;
{
return [self.percentEncodedUser stringByReplacingPercentEscapesUsingEncoding:NSUTF8StringEncoding];
}
- (void)setUser:(NSString *)user;
{
if (!user)
{
self.percentEncodedUser = user;
return;
}
CFStringRef escaped = CFURLCreateStringByAddingPercentEscapes(NULL, (CFStringRef)user, NULL, CFSTR(":@/?#"), kCFStringEncodingUTF8);
// : signifies the start of the password, so must be escaped
// @ signifies the end of the user/password, so must be escaped
// / ? # I reckon technically should be fine since they're before the @ symbol, but NSURLComponents seems to be cautious here, and understandably so
self.percentEncodedUser = (__bridge NSString *)escaped;
CFRelease(escaped);
}
@synthesize percentEncodedPassword = _passwordComponent;
- (NSString *)password;
{
return [self.percentEncodedPassword stringByReplacingPercentEscapesUsingEncoding:NSUTF8StringEncoding];
}
- (void)setPassword:(NSString *)password;
{
if (!password)
{
self.percentEncodedPassword = password;
return;
}
CFStringRef escaped = CFURLCreateStringByAddingPercentEscapes(NULL, (CFStringRef)password, NULL, CFSTR("@:/?#"), kCFStringEncodingUTF8);
// @ signifies the end of the user/password, so must be escaped
// : / ? # I reckon technically should be fine since they're before the @ symbol, but NSURLComponents seems to be cautious here, and understandably so
self.percentEncodedPassword = (__bridge NSString *)escaped;
CFRelease(escaped);
}
@synthesize percentEncodedHost = _hostComponent;
- (NSString *)host;
{
// Treat empty host specially. It signifies the host in URLs like file:///path
// nil for practical usage from -host, but a marker internally to differentiate
// from file:/path
NSString *host = self.percentEncodedHost;
if (host.length == 0) return nil;
return [host stringByReplacingPercentEscapesUsingEncoding:NSUTF8StringEncoding];
}
- (void)setHost:(NSString *)host;
{
if (!host)
{
self.percentEncodedHost = host;
return;
}
NSRange startBracket = [host rangeOfString:@"[" options:NSAnchoredSearch];
if (startBracket.location != NSNotFound)
{
NSRange endBracket = [host rangeOfString:@"]" options:NSAnchoredSearch|NSBackwardsSearch];
if (endBracket.location != NSNotFound)
{
host = [host substringWithRange:NSMakeRange(startBracket.length, host.length - endBracket.length - startBracket.length)];
CFStringRef escaped = CFURLCreateStringByAddingPercentEscapes(NULL, (CFStringRef)host, NULL, CFSTR("@/?#"), kCFStringEncodingUTF8);
// @ must be escaped so as not to confuse as a username
// Don't escape : as it's within a host literal, and likely part of an IPv6 address
// / ? and # must be escaped so as not to indicate start of path, query or fragment
NSString *encoded = [NSString stringWithFormat:@"[%@]", escaped];
self.percentEncodedHost = encoded;
CFRelease(escaped);
return;
}
}
CFStringRef escaped = CFURLCreateStringByAddingPercentEscapes(NULL, (CFStringRef)host, NULL, CFSTR("@:/?#"), kCFStringEncodingUTF8);
// @ must be escaped so as not to confuse as a username
// : must be escaped too to avoid confusion with port
// / ? and # must be escaped so as not to indicate start of path, query or fragment
self.percentEncodedHost = (__bridge NSString *)escaped;
CFRelease(escaped);
}
@synthesize port = _portComponent;
- (void)setPort:(NSNumber *)port;
{
if (port.integerValue < 0) [NSException raise:NSInvalidArgumentException format:@"Invalid port: %@; can't be negative", port];
port = [port copy];
_portComponent = port;
}
@synthesize percentEncodedPath = _pathComponent;
- (NSString *)path;
{
// Same treatment as -host
NSString *path = self.percentEncodedPath;
if (path.length == 0) return nil;
return [path stringByReplacingPercentEscapesUsingEncoding:NSUTF8StringEncoding];
}
- (void)setPath:(NSString *)path;
{
if (!path)
{
self.percentEncodedPath = path;
return;
}
CFStringRef escaped = CFURLCreateStringByAddingPercentEscapes(NULL, (CFStringRef)path, NULL, CFSTR(":;?#"), kCFStringEncodingUTF8);
// : doesn't *need* to be escaped if the path is part of a complete URL, but it does if the generated URL is scheme-less. Seems safest to always escape it, and NSURLComponents does so too
// ; ? and # all need to be escape to avoid confusion with parameter, query and fragment
self.percentEncodedPath = (__bridge NSString *)escaped;
CFRelease(escaped);
}
@synthesize percentEncodedQuery = _queryComponent;
- (NSString *)query;
{
return [self.percentEncodedQuery stringByReplacingPercentEscapesUsingEncoding:NSUTF8StringEncoding];
}
- (void)setQuery:(NSString *)query;
{
if (!query)
{
self.percentEncodedQuery = query;
return;
}
CFStringRef escaped = CFURLCreateStringByAddingPercentEscapes(NULL, (CFStringRef)query, NULL, NULL, kCFStringEncodingUTF8);
self.percentEncodedQuery = (__bridge NSString *)escaped;
CFRelease(escaped);
}
@synthesize percentEncodedFragment = _fragmentComponent;
- (NSString *)fragment;
{
return [self.percentEncodedFragment stringByReplacingPercentEscapesUsingEncoding:NSUTF8StringEncoding];
}
- (void)setFragment:(NSString *)fragment;
{
if (!fragment)
{
self.percentEncodedFragment = fragment;
return;
}
CFStringRef escaped = CFURLCreateStringByAddingPercentEscapes(NULL, (CFStringRef)fragment, NULL, NULL, kCFStringEncodingUTF8);
self.percentEncodedFragment = (__bridge NSString *)escaped;
CFRelease(escaped);
}
#pragma mark Equality Testing
- (BOOL)isEqual:(id)object;
{
if (![object isKindOfClass:[KSURLComponents class]]) return NO;
NSString *myScheme = self.scheme;
NSString *otherScheme = [object scheme];
if (myScheme != otherScheme && ![myScheme isEqualToString:otherScheme]) return NO;
NSString *myUser = self.percentEncodedUser;
NSString *otherUser = [object percentEncodedUser];
if (myUser != otherUser && ![myUser isEqualToString:otherUser]) return NO;
NSString *myPassword = self.percentEncodedPassword;
NSString *otherPassword = [object percentEncodedPassword];
if (myPassword != otherPassword && ![myPassword isEqualToString:otherPassword]) return NO;
NSString *myHost = self.percentEncodedHost;
NSString *otherHost = [object percentEncodedHost];
if (myHost != otherHost && ![myHost isEqualToString:otherHost]) return NO;
NSNumber *myPort = self.port;
NSNumber *otherPort = ((KSURLComponents *)object).port;
if (myPort != otherPort && ![myPort isEqualToNumber:otherPort]) return NO;
NSString *myPath = self.percentEncodedPath;
NSString *otherPath = [object percentEncodedPath];
if (myPath != otherPath && ![myPath isEqualToString:otherPath]) return NO;
NSString *myQuery = self.percentEncodedQuery;
NSString *otherQuery = [object percentEncodedQuery];
if (myQuery != otherQuery && ![myQuery isEqualToString:otherQuery]) return NO;
NSString *myFragment = self.percentEncodedFragment;
NSString *otherFragment = [object percentEncodedFragment];
if (myFragment != otherFragment && ![myFragment isEqualToString:otherFragment]) return NO;
return YES;
}
- (NSUInteger)hash;
{
// This could definitely be a better algorithm!
return self.scheme.hash + self.percentEncodedUser.hash + self.percentEncodedPassword.hash + self.percentEncodedPassword.hash + self.percentEncodedHost.hash + self.port.hash + self.percentEncodedPath.hash + self.percentEncodedQuery.hash + self.percentEncodedFragment.hash;
}
#pragma mark NSCopying
- (id)copyWithZone:(NSZone *)zone;
{
KSURLComponents *result = [[KSURLComponents alloc] init];
result.scheme = self.scheme;
result.percentEncodedUser = self.percentEncodedUser;
result.percentEncodedPassword = self.percentEncodedPassword;
result.percentEncodedHost = self.percentEncodedHost;
result.port = self.port;
result.percentEncodedPath = self.percentEncodedPath;
result.percentEncodedQuery = self.percentEncodedQuery;
result.percentEncodedFragment = self.percentEncodedFragment;
return result;
}
#pragma mark Debugging
- (NSString *)description;
{
return [super.description stringByAppendingFormat:
@" {scheme = %@, user = %@, password = %@, host = %@, port = %@, path = %@, query = %@, fragment = %@}",
self.scheme,
self.percentEncodedUser,
self.percentEncodedPassword,
self.percentEncodedHost,
self.port,
self.percentEncodedPath,
self.percentEncodedQuery,
self.percentEncodedFragment];
}
@end