Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

617 lines (483 sloc) 20.32 kb
//
// KSURLUtilities.m
//
// Copyright (c) 2007-2011, 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 "KSURLUtilities.h"
#import "KSPathUtilities.h"
@implementation NSURL (KSPathUtilities)
#pragma mark Scheme
- (NSURL *)ks_URLWithScheme:(NSString *)scheme;
{
NSString *string = [[NSString alloc] initWithFormat:@"%@:%@", scheme, [self resourceSpecifier]];
NSURL *result = [[self class] URLWithString:string];
[string release];
return result;
}
#pragma mark Host
- (NSURL *)ks_hostURL; // returns a URL like "http://launch.karelia.com/"
{
NSURL *result = [NSURL URLWithString:@"/" relativeToURL:self];
return result;
}
- (NSArray *)ks_domains;
{
NSArray *result = [[self host] componentsSeparatedByString:@"."];
return result;
}
- (BOOL)ks_hasNetworkLocation
{
NSString *resourceSpecifier = [self resourceSpecifier];
BOOL result = (resourceSpecifier != nil &&
[resourceSpecifier length] > 2 &&
[[self ks_domains] count] >= 2);
return result;
}
#pragma mark Paths
/* These two methods operate very similarly to -initWithString:relativeToURL:
* However, they assume the string is a path and ensure it has a trailing slash to match isDirectory.
*/
+ (NSURL *)ks_URLWithPath:(NSString *)path relativeToURL:(NSURL *)baseURL isDirectory:(BOOL)isDirectory
{
return [[[self alloc] ks_initWithPath:path relativeToURL:baseURL isDirectory:isDirectory] autorelease];
}
- (id)ks_initWithPath:(NSString *)path relativeToURL:(NSURL *)baseURL isDirectory:(BOOL)isDirectory
{
NSParameterAssert(path);
NSString *URLString = path;
if ([path hasSuffix:@"/"] != isDirectory)
{
if (isDirectory)
{
URLString = [path stringByAppendingString:@"/"];
}
else
{
URLString = [path substringToIndex:([path length] - 1)];
}
}
[self initWithString:URLString relativeToURL:baseURL];
return self;
}
/* Getting a file:// URL from a path and then turning it into a string is pretty common for us.
* This is a simple method to make it faster.
*/
+ (NSString *)ks_fileURLStringWithPath:(NSString *)path;
{
NSURL *URL = [[NSURL alloc] initFileURLWithPath:path];
NSString *result = [URL absoluteString];
[URL release];
return result;
}
#if !(defined MAC_OS_X_VERSION_10_6) || MAC_OS_X_VERSION_MAX_ALLOWED < MAC_OS_X_VERSION_10_6
// already defined in Snow Leopard
/* The CFURL APIs expose a bunch more path functionality than NSURL. You could of course use
* toll-free bridging, but it's more hassle and less readable. So these methods are here
* to simplify that.
*/
- (NSString *)ks_lastPathComponent
{
NSString *result = NSMakeCollectable(CFURLCopyLastPathComponent((CFURLRef)[self absoluteURL]));
return [result autorelease];
}
- (NSString *)ks_pathExtension
{
NSString *result = NSMakeCollectable(CFURLCopyPathExtension((CFURLRef)[self absoluteURL]));
return [result autorelease];
}
- (NSURL *)ks_URLByAppendingPathExtension:(NSString *)pathExtension
{
NSURL *result = NSMakeCollectable(CFURLCreateCopyAppendingPathExtension(NULL,
(CFURLRef)self,
(CFStringRef)pathExtension));
return [result autorelease];
}
- (NSURL *)ks_URLByDeletingLastPathComponent
{
NSURL *result = self;
if ([[self path] length]) // #74010
{
result = NSMakeCollectable(CFURLCreateCopyDeletingLastPathComponent(NULL, (CFURLRef)self));
[result autorelease];
}
return result;
}
- (NSURL *)ks_URLByDeletingPathExtension
{
NSURL *result = NSMakeCollectable(CFURLCreateCopyDeletingPathExtension(NULL, (CFURLRef)self));
return [result autorelease];
}
#endif
- (BOOL)ks_hasDirectoryPath
{
BOOL result = CFURLHasDirectoryPath((CFURLRef)[self absoluteURL]);
return result;
}
- (NSURL *)ks_URLByAppendingPathComponent:(NSString *)pathComponent isDirectory:(BOOL)isDirectory
{
NSParameterAssert(pathComponent);
NSURL *result = NSMakeCollectable(CFURLCreateCopyAppendingPathComponent(NULL,
(CFURLRef)self,
(CFStringRef)pathComponent,
isDirectory));
return [result autorelease];
}
/* e.g. http://example.com/foo/bar.html is a subpath of http://example.com/foo/
* The URLs should have the same scheme and host. After that, path comparison is used
*/
- (BOOL)ks_isSubpathOfURL:(NSURL *)aURL;
{
BOOL result = NO;
// File URLs are treated specially to handle 'localhost' versus '///' and symlinks
if ([self isFileURL] && [aURL isFileURL])
{
// Resolve aliases for local paths
NSString *myPath = [[self path] stringByResolvingSymlinksInPath];
NSString *otherPath = [[aURL path] stringByResolvingSymlinksInPath];
result = [myPath ks_isSubpathOfPath:otherPath];
}
else
{
NSString *scheme = [self scheme];
NSString *otherScheme = [aURL scheme];
if (scheme && otherScheme && [scheme isEqualToString:otherScheme])
{
NSString *myHost = [self host];
NSString *otherHost = [aURL host];
if (myHost && otherHost && [myHost isEqualToString:otherHost])
{
NSString *myPath = [[self standardizedURL] path];
NSString *otherPath = [[aURL standardizedURL] path];
if (myPath && otherPath)
{
result = [myPath ks_isSubpathOfPath:otherPath];
}
}
}
}
return result;
}
#pragma mark Mailto: URLs
+ (NSURL *)ks_mailtoURLWithEmailAddress:(NSString *)address;
{
NSScanner *s = [NSScanner scannerWithString:address];
if ([s scanUpToString:@"(" intoString:&address])
{
address = [address stringByTrimmingCharactersInSet:
[NSCharacterSet whitespaceAndNewlineCharacterSet]]; // take out whitespace
}
return [self URLWithString:[@"mailto:" stringByAppendingString:address]];
}
#pragma mark Query Dictionary
- (NSDictionary *)ks_queryParameters;
{
NSDictionary *result = [[self class] ks_parametersOfQuery:[self query]];
return result;
}
- (NSURL *)ks_URLWithQueryParameters:(NSDictionary *)parameters;
{
NSString *query = [NSURL ks_queryWithParameters:parameters];
if (![query isEqualToString:@""])
{
NSString *existingQuery = [self query]; // check if we already have a query -- if so we need & not ?
NSString *firstSeparator = (nil == existingQuery || [existingQuery isEqualToString:@""]) ? @"?" : @"&";
query = [firstSeparator stringByAppendingString:query];
}
// Create the URL from the query string
return [NSURL URLWithString:query relativeToURL:self];
}
+ (NSURL *)ks_URLWithScheme:(NSString *)scheme
host:(NSString *)host
path:(NSString *)path
queryParameters:(NSDictionary *)parameters;
{
NSURL *baseURL = [[NSURL alloc] initWithScheme:scheme host:host path:path];
NSURL *result = [baseURL ks_URLWithQueryParameters:parameters];
[baseURL release];
return result;
}
/* These 2 methods form the main backbone for URL query operations
*/
+ (NSString *)ks_queryWithParameters:(NSDictionary *)parameters;
{
// Build the list of parameters as a string
NSMutableString *parametersString = [NSMutableString string];
if (nil != parameters)
{
NSEnumerator *enumerator = [parameters keyEnumerator];
NSString *key;
BOOL thisIsTheFirstParameter = YES;
while (nil != (key = [enumerator nextObject]))
{
id rawParameter = [parameters objectForKey: key];
NSString *parameter = nil;
// Treat arrays specially, otherwise just get the object description
if ([rawParameter isKindOfClass:[NSArray class]]) {
parameter = [rawParameter componentsJoinedByString:@","];
}
else {
parameter = [rawParameter description];
}
// Append the parameter and its key to the full query string
if (!thisIsTheFirstParameter)
{
[parametersString appendString:@"&"];
}
else
{
thisIsTheFirstParameter = NO;
}
[parametersString appendFormat:
@"%@=%@",
[key ks_stringByAddingQueryComponentPercentEscapes],
[parameter ks_stringByAddingQueryComponentPercentEscapes]];
}
}
return parametersString;
}
+ (NSDictionary *)ks_parametersOfQuery:(NSString *)queryString;
{
NSMutableDictionary *result = [NSMutableDictionary dictionary];
// Handle & or ; as separators, as per W3C recommendation
NSCharacterSet *seperatorChars = [NSCharacterSet characterSetWithCharactersInString:@"&;"];
NSArray *keyValues = [queryString componentsSeparatedByCharactersInSet:seperatorChars];
NSEnumerator *theEnum = [keyValues objectEnumerator];
NSString *keyValuePair;
while (nil != (keyValuePair = [theEnum nextObject]) )
{
NSRange whereEquals = [keyValuePair rangeOfString:@"="];
if (NSNotFound != whereEquals.location)
{
NSString *key = [keyValuePair substringToIndex:whereEquals.location];
NSString *value = [[keyValuePair substringFromIndex:whereEquals.location+1] ks_stringByReplacingQueryComponentPercentEscapes];
[result setValue:value forKey:key];
}
}
return result;
}
#pragma mark RFC 1808
- (BOOL)ks_canBeDecomposed { return CFURLCanBeDecomposed((CFURLRef)self); }
#pragma mark Relative URLs
- (NSString *)ks_stringRelativeToURL:(NSURL *)URL
{
// If the base URL is nil then no comparison is needed
if (!URL)
{
NSString *result = [self absoluteString];
return result;
}
// URLs not compliant with RFC 1808 cannot be interpreted
if (![self ks_canBeDecomposed] || ![URL ks_canBeDecomposed])
{
return [self absoluteString];
}
// If the host or scheme differs, there is no possible relative path.
if (![[self scheme] isEqualToString:[URL scheme]] || ![[self host] isEqualToString:[URL host]])
{
NSString *result = [self absoluteString];
return result;
}
// Wanted to use CFURLCopyPath(anAbsoluteURL) to retain trailing slash(es). However, both it and CFURLCopyStrictPath() don't escape percent sequences despite being documented to do so! No longer shall I trust them! Instead, stick to Cocoa, and tack on a trailing slash afterwards if required
NSString *myPath = [self path];
if (!myPath || [myPath isEqualToString:@""]) myPath = @"/";
NSString *dirPath = [URL path];
if (![dirPath length]) dirPath = @"/"; // handle pathless URLs. e.g. http://example.com
if (![URL ks_hasDirectoryPath]) dirPath = [dirPath stringByDeletingLastPathComponent];
NSString *result = [myPath ks_pathRelativeToDirectory:dirPath];
// Need trailing slash?
if ([self ks_hasDirectoryPath] && ![result hasSuffix:@"/"])
{
result = [result stringByAppendingString:@"/"];
}
// Escape
result = [result stringByAddingPercentEscapesUsingEncoding:NSUTF8StringEncoding];
// Re-build any non-path information
NSString *parameters = [self parameterString];
if (parameters)
{
result = [result stringByAppendingFormat:@";%@", parameters];
}
NSString *query = [self query];
if (query)
{
result = [result stringByAppendingFormat:@"?%@", query];
}
NSString *fragment = [self fragment];
if (fragment)
{
result = [result stringByAppendingFormat:@"#%@", fragment];
}
// Finish up
return result;
}
/* Builds on -ks_stringRelativeToURL: by wrapping it into an NSURL object.
*/
- (NSURL *)ks_URLRelativeToURL:(NSURL *)URL;
{
NSURL *result = nil;
NSString *relativeString = [self ks_stringRelativeToURL:URL];
if (relativeString)
{
result = [NSURL URLWithString:relativeString relativeToURL:URL];
}
return result;
}
#pragma mark Comparison
- (BOOL)ks_isEqualToURL:(NSURL *)otherURL;
{
BOOL result = [self isEqual:otherURL];
// For file: URLs the default check might have failed because they reference the host differently. If so, fall back to checking paths
if (!result && [self isFileURL] && [otherURL isFileURL])
{
result = [[self path] isEqualToString:[otherURL path]];
}
return result;
}
- (BOOL)ks_isEqualExceptFragmentToURL:(NSURL *)anotherURL
{
// cover case where both are nil
return ( ([self baseURL] == [anotherURL baseURL]) || [[self baseURL] isEqual:[anotherURL baseURL]] )
&&
( ([self scheme] == [anotherURL scheme]) || [[self scheme] isEqual:[anotherURL scheme]] )
&&
( ([self host] == [anotherURL host]) || [[self host] isEqual:[anotherURL host]] )
&&
( ([self path] == [anotherURL path]) || [[self path] isEqual:[anotherURL path]] )
&&
// query == parameterString?
( ([self query] == [anotherURL query]) || [[self query] isEqual:[anotherURL query]] )
&&
( ([self parameterString] == [anotherURL parameterString]) || [[self parameterString] isEqual:[anotherURL parameterString]] )
&&
( ([self baseURL] == [anotherURL baseURL]) || [[self baseURL] isEqual:[anotherURL baseURL]] )
// less common pieces, but we gotta be careful
&&
( ([self baseURL] == [anotherURL baseURL]) || [[self baseURL] isEqual:[anotherURL baseURL]] )
&&
( ([self port] == [anotherURL port]) || [[self port] isEqual:[anotherURL port]] )
&&
( ([self password] == [anotherURL password]) || [[self password] isEqual:[anotherURL password]] )
&&
( ([self user] == [anotherURL user]) || [[self user] isEqual:[anotherURL user]] )
;
}
@end
#pragma mark -
@implementation NSString (KSURLUtilities)
- (NSString *)ks_stringByAddingPercentEscapesUsingEncoding:(NSStringEncoding)encoding
charactersToLeaveUnescaped:(NSString *)unescapedCharacters
legalURLCharactersToBeEscaped:(NSString *)legalCharactersToEscape;
{
NSString *result = NSMakeCollectable(CFURLCreateStringByAddingPercentEscapes(NULL,
(CFStringRef)self,
(CFStringRef)unescapedCharacters,
(CFStringRef)legalCharactersToEscape,
CFStringConvertNSStringEncodingToEncoding(encoding)));
return [result autorelease];
}
- (NSString *)ks_stringByAddingPercentEscapesWithSpacesAsPlusCharacters:(BOOL)encodeSpacesAsPlusCharacters
{
// Add the percent escapes. If encodeSpacesAsPlusCharacters has been requested, then don't both escaping them
NSString *charactersToLeaveUnescaped = (encodeSpacesAsPlusCharacters) ? @" " : @"";
NSString *result = [self ks_stringByAddingPercentEscapesUsingEncoding:NSUTF8StringEncoding
charactersToLeaveUnescaped:charactersToLeaveUnescaped
legalURLCharactersToBeEscaped:@"&+%="];
// If the user requested it, replace spaces with + signs
if (encodeSpacesAsPlusCharacters)
{
NSMutableString *mutableResult = [result mutableCopy];
[mutableResult replaceOccurrencesOfString:@" "
withString:@"+"
options:NSLiteralSearch
range:NSMakeRange(0, [mutableResult length])];
result = [mutableResult autorelease];
}
return result;
}
// For more fine grain escaping.... we want to escape dashes when URLs are in comments.
- (NSString *)ks_stringByAddingPercentEscapesWithSpacesAsPlusCharacters:(BOOL)encodeSpacesAsPlusCharacters escape:(NSString *)toEscape;
{
// Add the percent escapes. If encodeSpacesAsPlusCharacters has been requested, then don't both escaping them
NSString *charactersToLeaveUnescaped = (encodeSpacesAsPlusCharacters) ? @" " : @"";
NSString *result = [self ks_stringByAddingPercentEscapesUsingEncoding:NSUTF8StringEncoding
charactersToLeaveUnescaped:charactersToLeaveUnescaped
legalURLCharactersToBeEscaped:toEscape];
// If the user requested it, replace sapces with + signs
if (encodeSpacesAsPlusCharacters)
{
NSMutableString *mutableResult = [result mutableCopy];
[mutableResult replaceOccurrencesOfString:@" "
withString:@"+"
options:NSLiteralSearch
range:NSMakeRange(0, [mutableResult length])];
result = [mutableResult autorelease];
}
return result;
}
/*
By default, with null:
encoded: #%<>[\]^`{|}" space
Not encoded: !$&'()*+,-./:;=?@_~
exclamation!number%23dollar$percent%25ampersand&tick'lparen(rparen)aster*plus+space%20comma,dash-dot.slash/colon:semicolon;lessthan%3Cequals=greaterthan%3Equestion?at@lbracket%5Bbackslashl%0Dbracket%5Dcaret%5Eunderscore_backtick%60lbrace%7Bvbar%7Crbrace%7Dtilde~doublequote%22
RFC2396: Within a query component, the characters ";", "/", "?", ":", "@", "&", "=", "+", ",", and "$" are reserved.
*/
- (NSString *)ks_stringByAddingQueryComponentPercentEscapes;
{
NSString *firstPass = [self ks_stringByAddingPercentEscapesUsingEncoding:NSUTF8StringEncoding
charactersToLeaveUnescaped:@" "
legalURLCharactersToBeEscaped:@";/?:@&=+,$%"];
NSMutableString *result = [firstPass mutableCopy];
[result replaceOccurrencesOfString:@" "
withString:@"+"
options:NSLiteralSearch
range:NSMakeRange(0, [result length])];
return [result autorelease];
}
/*! Decode a URL's query-style string, taking out the + and %XX stuff
*/
- (NSString *)ks_stringByReplacingQueryComponentPercentEscapes
{
NSString *ish = [self stringByReplacingPercentEscapesUsingEncoding:NSUTF8StringEncoding];
NSMutableString *result = [ish mutableCopy];
[result replaceOccurrencesOfString:@"+"
withString:@" "
options:NSLiteralSearch
range:NSMakeRange(0, [result length])]; // fix + signs too!
return [result autorelease];
}
/* Turns a given path into a directory path suitable for HTML.
*
* e.g. /photo_album -> /photo_album/
*
* Empty strings are ignored
*/
- (NSString *)ks_URLDirectoryPath
{
NSString *result = self;
if (![self isEqualToString:@""] && ![self hasSuffix:@"/"])
{
result = [self stringByAppendingString:@"/"];
}
return result;
}
@end
Jump to Line
Something went wrong with that request. Please try again.