| blob | 295767415f7075ac01c7abaf7de65e3c9d7e5e7e |
1 /**
2 * Library for simple URI parsing and manipulation. Requires jQuery.
3 *
4 * Do not expect full RFC 3986 compliance. Intended to be minimal, but featureful.
5 * The use cases we have in mind are constructing 'next page' or 'previous page' URLs,
6 * detecting whether we need to use cross-domain proxies for an API, constructing
7 * simple URL-based API calls, etc.
8 *
9 * Intended to compress very well if you use a JS-parsing minifier.
10 *
11 * Dependencies: mw, jQuery
12 *
13 * Example:
14 *
15 * var uri = new mw.Uri( 'http://foo.com/mysite/mypage.php?quux=2' );
16 *
17 * if ( uri.host == 'foo.com' ) {
18 * uri.host = 'www.foo.com';
19 * uri.extend( { bar: 1 } );
20 *
21 * $( 'a#id1' ).attr( 'href', uri );
22 * // anchor with id 'id1' now links to http://foo.com/mysite/mypage.php?bar=1&quux=2
23 *
24 * $( 'a#id2' ).attr( 'href', uri.clone().extend( { bar: 3, pif: 'paf' } ) );
25 * // anchor with id 'id2' now links to http://foo.com/mysite/mypage.php?bar=3&quux=2&pif=paf
26 * }
27 *
28 * Parsing here is regex based, so may not work on all URIs, but is good enough for most.
29 *
30 * Given a URI like
31 * 'http://usr:pwd@www.test.com:81/dir/dir.2/index.htm?q1=0&&test1&test2=&test3=value+%28escaped%29&r=1&r=2#top':
32 * The returned object will have the following properties:
33 *
34 * protocol 'http'
35 * user 'usr'
36 * password 'pwd'
37 * host 'www.test.com'
38 * port '81'
39 * path '/dir/dir.2/index.htm'
40 * query {
41 * q1: 0,
42 * test1: null,
43 * test2: '',
44 * test3: 'value (escaped)'
45 * r: [1, 2]
46 * }
47 * fragment 'top'
48 *
49 * n.b. 'password' is not technically allowed for HTTP URIs, but it is possible with other
50 * sorts of URIs.
51 * You can modify the properties directly. Then use the toString() method to extract the
52 * full URI string again.
53 *
54 * Parsing based on parseUri 1.2.2 (c) Steven Levithan <stevenlevithan.com> MIT License
55 * http://stevenlevithan.com/demo/parseuri/js/
56 *
57 */
59 ( function( $, mw ) {
61 /**
62 * Function that's useful when constructing the URI string -- we frequently encounter the pattern of
63 * having to add something to the URI as we go, but only if it's present, and to include a character before or after if so.
64 * @param {String} to prepend, if value not empty
65 * @param {String} value to include, if not empty
66 * @param {String} to append, if value not empty
67 * @param {Boolean} raw -- if true, do not URI encode
68 * @return {String}
69 */
70 function cat( pre, val, post, raw ) {
71 if ( val === undefined || val === null || val === '' ) {
72 return '';
73 } else {
74 return pre + ( raw ? val : mw.Uri.encode( val ) ) + post;
75 }
76 }
78 // Regular expressions to parse many common URIs.
79 var parser = {
80 strict: /^(?:([^:\/?#]+):)?(?:\/\/(?:(?:([^:@]*)(?::([^:@]*))?)?@)?([^:\/?#]*)(?::(\d*))?)?((?:[^?#\/]*\/)*[^?#]*)(?:\?([^#]*))?(?:#(.*))?/,
81 loose: /^(?:(?![^:@]+:[^:@\/]*@)([^:\/?#.]+):)?(?:\/\/)?(?:(?:([^:@]*)(?::([^:@]*))?)?@)?([^:\/?#]*)(?::(\d*))?((?:\/(?:[^?#](?![^?#\/]*\.[^?#\/.]+(?:[?#]|$)))*\/?)?[^?#\/]*)(?:\?([^#]*))?(?:#(.*))?/
82 },
84 // The order here matches the order of captured matches in the above parser regexes.
85 properties = [
86 'protocol', // http
87 'user', // usr
88 'password', // pwd
89 'host', // www.test.com
90 'port', // 81
91 'path', // /dir/dir.2/index.htm
92 'query', // q1=0&&test1&test2=value (will become { q1: '0', test1: '', test2: 'value' } )
93 'fragment' // top
94 ];
97 /**
98 * We use a factory to inject a document location, for relative URLs, including protocol-relative URLs.
99 * so the library is still testable & purely functional.
100 */
101 mw.UriRelative = function( documentLocation ) {
103 /**
104 * Constructs URI object. Throws error if arguments are illegal/impossible, or otherwise don't parse.
105 * @constructor
106 * @param {Object|String} URI string, or an Object with appropriate properties (especially another URI object to clone).
107 * Object must have non-blank 'protocol', 'host', and 'path' properties.
108 * @param {Object|Boolean} Object with options, or (backwards compatibility) a boolean for strictMode
109 * - strictMode {Boolean} Trigger strict mode parsing of the url. Default: false
110 * - overrideKeys {Boolean} Wether to let duplicate query parameters override eachother (true) or automagically
111 * convert to an array (false, default).
112 */
113 function Uri( uri, options ) {
114 options = typeof options === 'object' ? options : { strictMode: !!options };
115 options = $.extend( {
116 strictMode: false,
117 overrideKeys: false
118 }, options );
120 if ( uri !== undefined && uri !== null || uri !== '' ) {
121 if ( typeof uri === 'string' ) {
122 this._parse( uri, options );
123 } else if ( typeof uri === 'object' ) {
124 var _this = this;
125 $.each( properties, function( i, property ) {
126 _this[property] = uri[property];
127 } );
128 if ( this.query === undefined ) {
129 this.query = {};
130 }
131 }
132 }
134 // protocol-relative URLs
135 if ( !this.protocol ) {
136 this.protocol = defaultUri.protocol;
137 }
138 // No host given:
139 if ( !this.host ) {
140 this.host = defaultUri.host;
141 // port ?
142 if ( !this.port ) {
143 this.port = defaultUri.port;
144 }
145 }
146 if ( this.path && this.path.charAt( 0 ) !== '/' ) {
147 // A real relative URL, relative to defaultUri.path. We can't really handle that since we cannot
148 // figure out whether the last path compoennt of defaultUri.path is a directory or a file.
149 throw new Error( 'Bad constructor arguments' );
150 }
151 if ( !( this.protocol && this.host && this.path ) ) {
152 throw new Error( 'Bad constructor arguments' );
153 }
154 }
156 /**
157 * Standard encodeURIComponent, with extra stuff to make all browsers work similarly and more compliant with RFC 3986
158 * Similar to rawurlencode from PHP and our JS library mw.util.rawurlencode, but we also replace space with a +
159 * @param {String} string
160 * @return {String} encoded for URI
161 */
162 Uri.encode = function( s ) {
163 return encodeURIComponent( s )
164 .replace( /!/g, '%21').replace( /'/g, '%27').replace( /\(/g, '%28')
165 .replace( /\)/g, '%29').replace( /\*/g, '%2A')
166 .replace( /%20/g, '+' );
167 };
169 /**
170 * Standard decodeURIComponent, with '+' to space
171 * @param {String} string encoded for URI
172 * @return {String} decoded string
173 */
174 Uri.decode = function( s ) {
175 return decodeURIComponent( s.replace( /\+/g, '%20' ) );
176 };
178 Uri.prototype = {
180 /**
181 * Parse a string and set our properties accordingly.
182 * @param {String} URI
183 * @param {Object} options
184 * @return {Boolean} success
185 */
186 _parse: function( str, options ) {
187 var matches = parser[ options.strictMode ? 'strict' : 'loose' ].exec( str );
188 var uri = this;
189 $.each( properties, function( i, property ) {
190 uri[ property ] = matches[ i+1 ];
191 } );
193 // uri.query starts out as the query string; we will parse it into key-val pairs then make
194 // that object the "query" property.
195 // we overwrite query in uri way to make cloning easier, it can use the same list of properties.
196 var q = {};
197 // using replace to iterate over a string
198 if ( uri.query ) {
199 uri.query.replace( /(?:^|&)([^&=]*)(?:(=)([^&]*))?/g, function ($0, $1, $2, $3) {
200 if ( $1 ) {
201 var k = Uri.decode( $1 );
202 var v = ( $2 === '' || $2 === undefined ) ? null : Uri.decode( $3 );
204 // If overrideKeys, always (re)set top level value.
205 // If not overrideKeys but this key wasn't set before, then we set it as well.
206 if ( options.overrideKeys || q[ k ] === undefined ) {
207 q[ k ] = v;
209 // Use arrays if overrideKeys is false and key was already seen before
210 } else {
211 // Once before, still a string, turn into an array
212 if ( typeof q[ k ] === 'string' ) {
213 q[ k ] = [ q[ k ] ];
214 }
215 // Add to the array
216 if ( $.isArray( q[ k ] ) ) {
217 q[ k ].push( v );
218 }
219 }
220 }
221 } );
222 }
223 this.query = q;
224 },
226 /**
227 * Returns user and password portion of a URI.
228 * @return {String}
229 */
230 getUserInfo: function() {
231 return cat( '', this.user, cat( ':', this.password, '' ) );
232 },
234 /**
235 * Gets host and port portion of a URI.
236 * @return {String}
237 */
238 getHostPort: function() {
239 return this.host + cat( ':', this.port, '' );
240 },
242 /**
243 * Returns the userInfo and host and port portion of the URI.
244 * In most real-world URLs, this is simply the hostname, but it is more general.
245 * @return {String}
246 */
247 getAuthority: function() {
248 return cat( '', this.getUserInfo(), '@' ) + this.getHostPort();
249 },
251 /**
252 * Returns the query arguments of the URL, encoded into a string
253 * Does not preserve the order of arguments passed into the URI. Does handle escaping.
254 * @return {String}
255 */
256 getQueryString: function() {
257 var args = [];
258 $.each( this.query, function( key, val ) {
259 var k = Uri.encode( key );
260 var vals = val === null ? [ null ] : $.makeArray( val );
261 $.each( vals, function( i, v ) {
262 args.push( k + ( v === null ? '' : '=' + Uri.encode( v ) ) );
263 } );
264 } );
265 return args.join( '&' );
266 },
268 /**
269 * Returns everything after the authority section of the URI
270 * @return {String}
271 */
272 getRelativePath: function() {
273 return this.path + cat( '?', this.getQueryString(), '', true ) + cat( '#', this.fragment, '' );
274 },
276 /**
277 * Gets the entire URI string. May not be precisely the same as input due to order of query arguments.
278 * @return {String} the URI string
279 */
280 toString: function() {
281 return this.protocol + '://' + this.getAuthority() + this.getRelativePath();
282 },
284 /**
285 * Clone this URI
286 * @return {Object} new URI object with same properties
287 */
288 clone: function() {
289 return new Uri( this );
290 },
292 /**
293 * Extend the query -- supply query parameters to override or add to ours
294 * @param {Object} query parameters in key-val form to override or add
295 * @return {Object} this URI object
296 */
297 extend: function( parameters ) {
298 $.extend( this.query, parameters );
299 return this;
300 }
301 };
303 var defaultUri = new Uri( documentLocation );
305 return Uri;
306 };
308 // if we are running in a browser, inject the current document location, for relative URLs
309 if ( document && document.location && document.location.href ) {
310 mw.Uri = mw.UriRelative( document.location.href );
311 }
313 } )( jQuery, mediaWiki );