summaryrefslogtreecommitdiff
path: root/Juick/NSURL+PathParameters.m
blob: 83a55bb7b69871262f8191b93aa1658df81ff1d3 (plain) (blame)
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
//
//  NSURL+PathParameters.m
//
//  Created by Johan Kool on 27/9/2011.
//  Copyright 2011 Koolistov Pte. Ltd. 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.
//  * Neither the name of KOOLISTOV PTE. LTD. nor the names of its contributors may be used to 
//    endorse or promote products derived from this software without specific prior written 
//    permission.
//
//  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 
//  THE COPYRIGHT OWNER OR CONTRIBUTORS 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 "NSURL+PathParameters.h"

@interface NSString (URLParameters)

- (NSString *)stringByEscapingForURLArgument;

@end

@implementation NSString (URLParameters)

- (NSString *)stringByEscapingForURLArgument {
    // Encode all the reserved characters, per RFC 3986 (<http://www.ietf.org/rfc/rfc3986.txt>)
    NSString *escapedString = (__bridge NSString *)CFURLCreateStringByAddingPercentEscapes(kCFAllocatorDefault,
                                                                                  (CFStringRef)self,
                                                                                  NULL,
                                                                                  (CFStringRef)@"!*'\"();:@&=+$,/?%#[] ",
                                                                                  kCFStringEncodingUTF8);
    return [escapedString copy];
}

@end

@implementation NSURL (PathParameters)

- (NSURL *)URLByReplacingPathWithPath:(NSString *)path {
    // scheme://username:password@domain:port/path?query_string#fragment_id
    
    // Chop off path, query and fragment from absoluteString, then add new path and put back query and fragment
    
    NSString *absoluteString = [self absoluteString];
    NSUInteger endIndex = [absoluteString length];
    
    NSString *fragment = [self fragment];
    if (fragment) {
        endIndex -= [fragment length];
        endIndex--; // The # character
    }
    
    NSString *query = [self query];
    if (query) {
        endIndex -= [query length];
        endIndex--; // The ? character
    }

    // Check if the last character of the path is a slash (range must be valid as endIndex must be smaller or equal to length)
    BOOL trailingSlashOnPath = [[absoluteString substringWithRange:NSMakeRange(endIndex - 1, 1)] isEqualToString:@"/"];
       
    NSString *originalPath = [self path]; // This method strips any trailing slash "/"
    if (originalPath) {
        endIndex -= [originalPath length];
        if (trailingSlashOnPath && [originalPath length] > 1) { // Don't get confused with the starting slash
            endIndex--;
        }
    }
    
    absoluteString = [absoluteString substringToIndex:endIndex];
    absoluteString = [absoluteString stringByAppendingString:path];
    if (query) {
        absoluteString = [absoluteString stringByAppendingString:@"?"];
        absoluteString = [absoluteString stringByAppendingString:query];
    }
    if (fragment) {
        absoluteString = [absoluteString stringByAppendingString:@"#"];
        absoluteString = [absoluteString stringByAppendingString:fragment];
    }
    
    return [NSURL URLWithString:absoluteString];
}

- (NSURL *)URLByAppendingPathWithRelativePath:(NSString *)path {
    NSString *originalPath = [self path];
    NSString *combinedPath = [[originalPath stringByAppendingPathComponent:path] stringByStandardizingPath];
    // Don't standardize away a trailing slash
    if ([path length] > 1 && [path hasSuffix:@"/"]) {
        combinedPath = [combinedPath stringByAppendingString:@"/"];
    }
    return [self URLByReplacingPathWithPath:combinedPath];
}

- (NSURL *)URLByAppendingParameters:(NSDictionary *)parameters {
    NSMutableString *query = [[self query] mutableCopy];
      
    if (!query) {
        query = [NSMutableString stringWithString:@""];
    }
    
    // Sort parameters to be appended so that our solution is stable (and testable)
    NSArray *parameterNames = [parameters allKeys];
    parameterNames = [parameterNames sortedArrayUsingSelector:@selector(compare:)];
    
    for (NSString *parameterName in parameterNames) {
        id value = [parameters objectForKey:parameterName];
        NSAssert3([parameterName isKindOfClass:[NSString class]], @"Got '%@' of type %@ as key for parameter with value '%@'. Expected an NSString.", parameterName, NSStringFromClass([parameterName class]), value);
        
        // The value needs to be an NSString, or be able to give us an NSString
        if (![value isKindOfClass:[NSString class]]) {
            if ([value respondsToSelector:@selector(stringValue)]) {
                value = [value stringValue];
            } else {
                // Fallback to simply giving the description
                value = [value description];
            }
        }
        
        if ([query length] == 0) {
            [query appendFormat:@"%@=%@", [parameterName stringByEscapingForURLArgument], [value stringByEscapingForURLArgument]];
        } else {
            [query appendFormat:@"&%@=%@", [parameterName stringByEscapingForURLArgument], [value stringByEscapingForURLArgument]];
        }
    }
        
    // scheme://username:password@domain:port/path?query_string#fragment_id
    
    // Chop off query and fragment from absoluteString, then add new query and put back fragment
    
    NSString *absoluteString = [self absoluteString];
    NSUInteger endIndex = [absoluteString length];
    
    NSString *fragment = [self fragment];
    if (fragment) {
        endIndex -= [fragment length];
        endIndex--; // The # character
    }
    
    NSString *originalQuery = [self query];
    if (originalQuery) {
        endIndex -= [originalQuery length];
        endIndex--; // The ? character
    }
    
    absoluteString = [absoluteString substringToIndex:endIndex];
    absoluteString = [absoluteString stringByAppendingString:@"?"];
    absoluteString = [absoluteString stringByAppendingString:query];
    if (fragment) {
        absoluteString = [absoluteString stringByAppendingString:@"#"];
        absoluteString = [absoluteString stringByAppendingString:fragment];
    }
    
    return [NSURL URLWithString:absoluteString];
}

- (NSURL *)URLByAppendingParameterName:(NSString *)parameter value:(id)value {
    return [self URLByAppendingParameters:[NSDictionary dictionaryWithObjectsAndKeys:value, parameter, nil]];
}


@end