1
# Bazaar -- distributed version control
3
# Copyright (C) 2006 Canonical Ltd
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
"""A collection of function for handling URL operations."""
25
from bzrlib.lazy_import import lazy_import
26
lazy_import(globals(), """
27
from posixpath import split as _posix_split, normpath as _posix_normpath
37
def basename(url, exclude_trailing_slash=True):
38
"""Return the last component of a URL.
40
:param url: The URL in question
41
:param exclude_trailing_slash: If the url looks like "path/to/foo/"
42
ignore the final slash and return 'foo' rather than ''
43
:return: Just the final component of the URL. This can return ''
44
if you don't exclude_trailing_slash, or if you are at the
47
return split(url, exclude_trailing_slash=exclude_trailing_slash)[1]
50
def dirname(url, exclude_trailing_slash=True):
51
"""Return the parent directory of the given path.
53
:param url: Relative or absolute URL
54
:param exclude_trailing_slash: Remove a final slash
55
(treat http://host/foo/ as http://host/foo, but
56
http://host/ stays http://host/)
57
:return: Everything in the URL except the last path chunk
59
# TODO: jam 20060502 This was named dirname to be consistent
60
# with the os functions, but maybe "parent" would be better
61
return split(url, exclude_trailing_slash=exclude_trailing_slash)[0]
65
"""Escape relpath to be a valid url."""
66
if isinstance(relpath, unicode):
67
relpath = relpath.encode('utf-8')
68
# After quoting and encoding, the path should be perfectly
69
# safe as a plain ASCII string, str() just enforces this
70
return str(urllib.quote(relpath))
73
def file_relpath(base, path):
74
"""Compute just the relative sub-portion of a url
76
This assumes that both paths are already fully specified file:// URLs.
78
assert len(base) >= MIN_ABS_FILEURL_LENGTH, ('Length of base must be equal or'
79
' exceed the platform minimum url length (which is %d)' %
80
MIN_ABS_FILEURL_LENGTH)
82
base = local_path_from_url(base)
83
path = local_path_from_url(path)
84
return escape(osutils.relpath(base, path))
87
def _find_scheme_and_separator(url):
88
"""Find the scheme separator (://) and the first path separator
90
This is just a helper functions for other path utilities.
91
It could probably be replaced by urlparse
93
m = _url_scheme_re.match(url)
97
scheme = m.group('scheme')
98
path = m.group('path')
100
# Find the path separating slash
101
# (first slash after the ://)
102
first_path_slash = path.find('/')
103
if first_path_slash == -1:
104
return len(scheme), None
105
return len(scheme), first_path_slash+len(scheme)+3
108
def join(base, *args):
109
"""Create a URL by joining sections.
111
This will normalize '..', assuming that paths are absolute
112
(it assumes no symlinks in either path)
114
If any of *args is an absolute URL, it will be treated correctly.
116
join('http://foo', 'http://bar') => 'http://bar'
117
join('http://foo', 'bar') => 'http://foo/bar'
118
join('http://foo', 'bar', '../baz') => 'http://foo/baz'
120
m = _url_scheme_re.match(base)
123
scheme = m.group('scheme')
124
path = m.group('path').split('/')
125
if path[-1:] == ['']:
126
# Strip off a trailing slash
127
# This helps both when we are at the root, and when
128
# 'base' has an extra slash at the end
131
path = base.split('/')
134
m = _url_scheme_re.match(arg)
137
scheme = m.group('scheme')
138
# this skips .. normalisation, making http://host/../../..
140
path = m.group('path').split('/')
142
for chunk in arg.split('/'):
147
# Don't pop off the host portion
150
raise errors.InvalidURLJoin('Cannot go above root',
156
return '/'.join(path)
157
return scheme + '://' + '/'.join(path)
160
# jam 20060502 Sorted to 'l' because the final target is 'local_path_from_url'
161
def _posix_local_path_from_url(url):
162
"""Convert a url like file:///path/to/foo into /path/to/foo"""
163
if not url.startswith('file:///'):
164
raise errors.InvalidURL(url, 'local urls must start with file:///')
165
# We only strip off 2 slashes
166
return unescape(url[len('file://'):])
169
def _posix_local_path_to_url(path):
170
"""Convert a local path like ./foo into a URL like file:///path/to/foo
172
This also handles transforming escaping unicode characters, etc.
174
# importing directly from posixpath allows us to test this
175
# on non-posix platforms
176
return 'file://' + escape(_posix_normpath(
177
osutils._posix_abspath(path)))
180
def _win32_local_path_from_url(url):
181
"""Convert a url like file:///C:/path/to/foo into C:/path/to/foo"""
182
if not url.startswith('file://'):
183
raise errors.InvalidURL(url, 'local urls must start with file:///, '
184
'UNC path urls must start with file://')
185
# We strip off all 3 slashes
186
win32_url = url[len('file:'):]
187
# check for UNC path: //HOST/path
188
if not win32_url.startswith('///'):
189
if (win32_url[2] == '/'
190
or win32_url[3] in '|:'):
191
raise errors.InvalidURL(url, 'Win32 UNC path urls'
192
' have form file://HOST/path')
193
return unescape(win32_url)
194
# usual local path with drive letter
195
if (win32_url[3] not in ('abcdefghijklmnopqrstuvwxyz'
196
'ABCDEFGHIJKLMNOPQRSTUVWXYZ')
197
or win32_url[4] not in '|:'
198
or win32_url[5] != '/'):
199
raise errors.InvalidURL(url, 'Win32 file urls start with'
200
' file:///x:/, where x is a valid drive letter')
201
return win32_url[3].upper() + u':' + unescape(win32_url[5:])
204
def _win32_local_path_to_url(path):
205
"""Convert a local path like ./foo into a URL like file:///C:/path/to/foo
207
This also handles transforming escaping unicode characters, etc.
209
# importing directly from ntpath allows us to test this
210
# on non-win32 platform
211
# FIXME: It turns out that on nt, ntpath.abspath uses nt._getfullpathname
212
# which actually strips trailing space characters.
213
# The worst part is that under linux ntpath.abspath has different
214
# semantics, since 'nt' is not an available module.
215
win32_path = osutils._win32_abspath(path)
216
# check for UNC path \\HOST\path
217
if win32_path.startswith('//'):
218
return 'file:' + escape(win32_path)
219
return 'file:///' + win32_path[0].upper() + ':' + escape(win32_path[2:])
222
local_path_to_url = _posix_local_path_to_url
223
local_path_from_url = _posix_local_path_from_url
224
MIN_ABS_FILEURL_LENGTH = len('file:///')
225
WIN32_MIN_ABS_FILEURL_LENGTH = len('file:///C:/')
227
if sys.platform == 'win32':
228
local_path_to_url = _win32_local_path_to_url
229
local_path_from_url = _win32_local_path_from_url
231
MIN_ABS_FILEURL_LENGTH = WIN32_MIN_ABS_FILEURL_LENGTH
234
_url_scheme_re = re.compile(r'^(?P<scheme>[^:/]{2,})://(?P<path>.*)$')
237
def normalize_url(url):
238
"""Make sure that a path string is in fully normalized URL form.
240
This handles URLs which have unicode characters, spaces,
241
special characters, etc.
243
It has two basic modes of operation, depending on whether the
244
supplied string starts with a url specifier (scheme://) or not.
245
If it does not have a specifier it is considered a local path,
246
and will be converted into a file:/// url. Non-ascii characters
247
will be encoded using utf-8.
248
If it does have a url specifier, it will be treated as a "hybrid"
249
URL. Basically, a URL that should have URL special characters already
250
escaped (like +?&# etc), but may have unicode characters, etc
251
which would not be valid in a real URL.
253
:param url: Either a hybrid URL or a local path
254
:return: A normalized URL which only includes 7-bit ASCII characters.
256
m = _url_scheme_re.match(url)
258
return local_path_to_url(url)
259
if not isinstance(url, unicode):
261
if c not in _url_safe_characters:
262
raise errors.InvalidURL(url, 'URLs can only contain specific'
263
' safe characters (not %r)' % c)
265
# We have a unicode (hybrid) url
266
scheme = m.group('scheme')
267
path = list(m.group('path'))
269
for i in xrange(len(path)):
270
if path[i] not in _url_safe_characters:
271
chars = path[i].encode('utf-8')
272
path[i] = ''.join(['%%%02X' % ord(c) for c in path[i].encode('utf-8')])
273
return str(scheme + '://' + ''.join(path))
276
def relative_url(base, other):
277
"""Return a path to other from base.
279
If other is unrelated to base, return other. Else return a relative path.
280
This assumes no symlinks as part of the url.
282
dummy, base_first_slash = _find_scheme_and_separator(base)
283
if base_first_slash is None:
286
dummy, other_first_slash = _find_scheme_and_separator(other)
287
if other_first_slash is None:
290
# this takes care of differing schemes or hosts
291
base_scheme = base[:base_first_slash]
292
other_scheme = other[:other_first_slash]
293
if base_scheme != other_scheme:
296
base_path = base[base_first_slash+1:]
297
other_path = other[other_first_slash+1:]
299
if base_path.endswith('/'):
300
base_path = base_path[:-1]
302
base_sections = base_path.split('/')
303
other_sections = other_path.split('/')
305
if base_sections == ['']:
307
if other_sections == ['']:
311
for b, o in zip(base_sections, other_sections):
314
output_sections.append(b)
316
match_len = len(output_sections)
317
output_sections = ['..' for x in base_sections[match_len:]]
318
output_sections.extend(other_sections[match_len:])
320
return "/".join(output_sections) or "."
323
def _win32_extract_drive_letter(url_base, path):
324
"""On win32 the drive letter needs to be added to the url base."""
325
# Strip off the drive letter
326
# path is currently /C:/foo
327
if len(path) < 3 or path[2] not in ':|' or path[3] != '/':
328
raise errors.InvalidURL(url_base + path,
329
'win32 file:/// paths need a drive letter')
330
url_base += path[0:3] # file:// + /C:
331
path = path[3:] # /foo
332
return url_base, path
335
def split(url, exclude_trailing_slash=True):
336
"""Split a URL into its parent directory and a child directory.
338
:param url: A relative or absolute URL
339
:param exclude_trailing_slash: Strip off a final '/' if it is part
340
of the path (but not if it is part of the protocol specification)
342
:return: (parent_url, child_dir). child_dir may be the empty string if we're at
345
scheme_loc, first_path_slash = _find_scheme_and_separator(url)
347
if first_path_slash is None:
348
# We have either a relative path, or no separating slash
349
if scheme_loc is None:
351
if exclude_trailing_slash and url.endswith('/'):
353
return _posix_split(url)
355
# Scheme with no path
358
# We have a fully defined path
359
url_base = url[:first_path_slash] # http://host, file://
360
path = url[first_path_slash:] # /file/foo
362
if sys.platform == 'win32' and url.startswith('file:///'):
363
# Strip off the drive letter
364
# url_base is currently file://
365
# path is currently /C:/foo
366
url_base, path = _win32_extract_drive_letter(url_base, path)
367
# now it should be file:///C: and /foo
369
if exclude_trailing_slash and len(path) > 1 and path.endswith('/'):
371
head, tail = _posix_split(path)
372
return url_base + head, tail
375
def _win32_strip_local_trailing_slash(url):
376
"""Strip slashes after the drive letter"""
377
if len(url) > WIN32_MIN_ABS_FILEURL_LENGTH:
383
def strip_trailing_slash(url):
384
"""Strip trailing slash, except for root paths.
386
The definition of 'root path' is platform-dependent.
387
This assumes that all URLs are valid netloc urls, such that they
390
It searches for ://, and then refuses to remove the next '/'.
391
It can also handle relative paths
393
path/to/foo => path/to/foo
394
path/to/foo/ => path/to/foo
395
http://host/path/ => http://host/path
396
http://host/path => http://host/path
397
http://host/ => http://host/
399
file:///foo/ => file:///foo
400
# This is unique on win32 platforms, and is the only URL
401
# format which does it differently.
402
file:///c|/ => file:///c:/
404
if not url.endswith('/'):
407
if sys.platform == 'win32' and url.startswith('file://'):
408
return _win32_strip_local_trailing_slash(url)
410
scheme_loc, first_path_slash = _find_scheme_and_separator(url)
411
if scheme_loc is None:
412
# This is a relative path, as it has no scheme
413
# so just chop off the last character
416
if first_path_slash is None or first_path_slash == len(url)-1:
417
# Don't chop off anything if the only slash is the path
425
"""Unescape relpath from url format.
427
This returns a Unicode path from a URL
429
# jam 20060427 URLs are supposed to be ASCII only strings
430
# If they are passed in as unicode, urllib.unquote
431
# will return a UNICODE string, which actually contains
432
# utf-8 bytes. So we have to ensure that they are
433
# plain ASCII strings, or the final .decode will
434
# try to encode the UNICODE => ASCII, and then decode
438
except UnicodeError, e:
439
raise errors.InvalidURL(url, 'URL was not a plain ASCII url: %s' % (e,))
441
unquoted = urllib.unquote(url)
443
unicode_path = unquoted.decode('utf-8')
444
except UnicodeError, e:
445
raise errors.InvalidURL(url, 'Unable to encode the URL as utf-8: %s' % (e,))
449
# These are characters that if escaped, should stay that way
450
_no_decode_chars = ';/?:@&=+$,#'
451
_no_decode_ords = [ord(c) for c in _no_decode_chars]
452
_no_decode_hex = (['%02x' % o for o in _no_decode_ords]
453
+ ['%02X' % o for o in _no_decode_ords])
454
_hex_display_map = dict(([('%02x' % o, chr(o)) for o in range(256)]
455
+ [('%02X' % o, chr(o)) for o in range(256)]))
456
#These entries get mapped to themselves
457
_hex_display_map.update((hex,'%'+hex) for hex in _no_decode_hex)
459
# These characters should not be escaped
460
_url_safe_characters = set(
461
"abcdefghijklmnopqrstuvwxyz" # Lowercase alpha
462
"ABCDEFGHIJKLMNOPQRSTUVWXYZ" # Uppercase alpha
463
"0123456789" # Numbers
464
"_.-!~*'()" # Unreserved characters
465
"/;?:@&=+$," # Reserved characters
466
"%#" # Extra reserved characters
469
def unescape_for_display(url, encoding):
470
"""Decode what you can for a URL, so that we get a nice looking path.
472
This will turn file:// urls into local paths, and try to decode
473
any portions of a http:// style url that it can.
475
Any sections of the URL which can't be represented in the encoding or
476
need to stay as escapes are left alone.
478
:param url: A 7-bit ASCII URL
479
:param encoding: The final output encoding
481
:return: A unicode string which can be safely encoded into the
484
assert encoding is not None, 'you cannot specify None for the display encoding.'
485
if url.startswith('file://'):
487
path = local_path_from_url(url)
488
path.encode(encoding)
493
# Split into sections to try to decode utf-8
495
for i in xrange(1, len(res)):
496
escaped_chunks = res[i].split('%')
497
for j in xrange(1, len(escaped_chunks)):
498
item = escaped_chunks[j]
500
escaped_chunks[j] = _hex_display_map[item[:2]] + item[2:]
502
# Put back the percent symbol
503
escaped_chunks[j] = '%' + item
504
except UnicodeDecodeError:
505
escaped_chunks[j] = unichr(int(item[:2], 16)) + item[2:]
506
unescaped = ''.join(escaped_chunks)
508
decoded = unescaped.decode('utf-8')
509
except UnicodeDecodeError:
510
# If this path segment cannot be properly utf-8 decoded
511
# after doing unescaping we will just leave it alone
515
decoded.encode(encoding)
516
except UnicodeEncodeError:
517
# If this chunk cannot be encoded in the local
518
# encoding, then we should leave it alone
521
# Otherwise take the url decoded one
523
return u'/'.join(res)
added
removed
bzrlib/urlutils.py
