~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/urlutils.py

  • Committer: Patch Queue Manager
  • Date: 2011-10-14 16:54:26 UTC
  • mfrom: (6216.1.1 remove-this-file)
  • Revision ID: pqm@pqm.ubuntu.com-20111014165426-tjix4e6idryf1r2z
(jelmer) Remove an accidentally committed .THIS file. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2006-2010 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""A collection of function for handling URL operations."""
 
18
 
 
19
import os
 
20
import re
 
21
import sys
 
22
 
 
23
from bzrlib.lazy_import import lazy_import
 
24
lazy_import(globals(), """
 
25
from posixpath import split as _posix_split
 
26
import urllib
 
27
import urlparse
 
28
 
 
29
from bzrlib import (
 
30
    errors,
 
31
    osutils,
 
32
    )
 
33
""")
 
34
 
 
35
 
 
36
def basename(url, exclude_trailing_slash=True):
 
37
    """Return the last component of a URL.
 
38
 
 
39
    :param url: The URL in question
 
40
    :param exclude_trailing_slash: If the url looks like "path/to/foo/"
 
41
        ignore the final slash and return 'foo' rather than ''
 
42
    :return: Just the final component of the URL. This can return ''
 
43
        if you don't exclude_trailing_slash, or if you are at the
 
44
        root of the URL.
 
45
    """
 
46
    return split(url, exclude_trailing_slash=exclude_trailing_slash)[1]
 
47
 
 
48
 
 
49
def dirname(url, exclude_trailing_slash=True):
 
50
    """Return the parent directory of the given path.
 
51
 
 
52
    :param url: Relative or absolute URL
 
53
    :param exclude_trailing_slash: Remove a final slash
 
54
        (treat http://host/foo/ as http://host/foo, but
 
55
        http://host/ stays http://host/)
 
56
    :return: Everything in the URL except the last path chunk
 
57
    """
 
58
    # TODO: jam 20060502 This was named dirname to be consistent
 
59
    #       with the os functions, but maybe "parent" would be better
 
60
    return split(url, exclude_trailing_slash=exclude_trailing_slash)[0]
 
61
 
 
62
 
 
63
def escape(relpath):
 
64
    """Escape relpath to be a valid url."""
 
65
    if isinstance(relpath, unicode):
 
66
        relpath = relpath.encode('utf-8')
 
67
    # After quoting and encoding, the path should be perfectly
 
68
    # safe as a plain ASCII string, str() just enforces this
 
69
    return str(urllib.quote(relpath, safe='/~'))
 
70
 
 
71
 
 
72
def file_relpath(base, path):
 
73
    """Compute just the relative sub-portion of a url
 
74
 
 
75
    This assumes that both paths are already fully specified file:// URLs.
 
76
    """
 
77
    if len(base) < MIN_ABS_FILEURL_LENGTH:
 
78
        raise ValueError('Length of base (%r) must equal or'
 
79
            ' exceed the platform minimum url length (which is %d)' %
 
80
            (base, MIN_ABS_FILEURL_LENGTH))
 
81
    base = local_path_from_url(base)
 
82
    path = local_path_from_url(path)
 
83
    return escape(osutils.relpath(base, path))
 
84
 
 
85
 
 
86
def _find_scheme_and_separator(url):
 
87
    """Find the scheme separator (://) and the first path separator
 
88
 
 
89
    This is just a helper functions for other path utilities.
 
90
    It could probably be replaced by urlparse
 
91
    """
 
92
    m = _url_scheme_re.match(url)
 
93
    if not m:
 
94
        return None, None
 
95
 
 
96
    scheme = m.group('scheme')
 
97
    path = m.group('path')
 
98
 
 
99
    # Find the path separating slash
 
100
    # (first slash after the ://)
 
101
    first_path_slash = path.find('/')
 
102
    if first_path_slash == -1:
 
103
        return len(scheme), None
 
104
    return len(scheme), first_path_slash+m.start('path')
 
105
 
 
106
 
 
107
def is_url(url):
 
108
    """Tests whether a URL is in actual fact a URL."""
 
109
    return _url_scheme_re.match(url) is not None
 
110
 
 
111
 
 
112
def join(base, *args):
 
113
    """Create a URL by joining sections.
 
114
 
 
115
    This will normalize '..', assuming that paths are absolute
 
116
    (it assumes no symlinks in either path)
 
117
 
 
118
    If any of *args is an absolute URL, it will be treated correctly.
 
119
    Example:
 
120
        join('http://foo', 'http://bar') => 'http://bar'
 
121
        join('http://foo', 'bar') => 'http://foo/bar'
 
122
        join('http://foo', 'bar', '../baz') => 'http://foo/baz'
 
123
    """
 
124
    if not args:
 
125
        return base
 
126
    scheme_end, path_start = _find_scheme_and_separator(base)
 
127
    if scheme_end is None and path_start is None:
 
128
        path_start = 0
 
129
    elif path_start is None:
 
130
        path_start = len(base)
 
131
    path = base[path_start:]
 
132
    for arg in args:
 
133
        arg_scheme_end, arg_path_start = _find_scheme_and_separator(arg)
 
134
        if arg_scheme_end is None and arg_path_start is None:
 
135
            arg_path_start = 0
 
136
        elif arg_path_start is None:
 
137
            arg_path_start = len(arg)
 
138
        if arg_scheme_end is not None:
 
139
            base = arg
 
140
            path = arg[arg_path_start:]
 
141
            scheme_end = arg_scheme_end
 
142
            path_start = arg_path_start
 
143
        else:
 
144
            path = joinpath(path, arg)
 
145
    return base[:path_start] + path
 
146
 
 
147
 
 
148
def joinpath(base, *args):
 
149
    """Join URL path segments to a URL path segment.
 
150
 
 
151
    This is somewhat like osutils.joinpath, but intended for URLs.
 
152
 
 
153
    XXX: this duplicates some normalisation logic, and also duplicates a lot of
 
154
    path handling logic that already exists in some Transport implementations.
 
155
    We really should try to have exactly one place in the code base responsible
 
156
    for combining paths of URLs.
 
157
    """
 
158
    path = base.split('/')
 
159
    if len(path) > 1 and path[-1] == '':
 
160
        #If the path ends in a trailing /, remove it.
 
161
        path.pop()
 
162
    for arg in args:
 
163
        if arg.startswith('/'):
 
164
            path = []
 
165
        for chunk in arg.split('/'):
 
166
            if chunk == '.':
 
167
                continue
 
168
            elif chunk == '..':
 
169
                if path == ['']:
 
170
                    raise errors.InvalidURLJoin('Cannot go above root',
 
171
                            base, args)
 
172
                path.pop()
 
173
            else:
 
174
                path.append(chunk)
 
175
    if path == ['']:
 
176
        return '/'
 
177
    else:
 
178
        return '/'.join(path)
 
179
 
 
180
 
 
181
# jam 20060502 Sorted to 'l' because the final target is 'local_path_from_url'
 
182
def _posix_local_path_from_url(url):
 
183
    """Convert a url like file:///path/to/foo into /path/to/foo"""
 
184
    url = split_segment_parameters_raw(url)[0]
 
185
    file_localhost_prefix = 'file://localhost/'
 
186
    if url.startswith(file_localhost_prefix):
 
187
        path = url[len(file_localhost_prefix) - 1:]
 
188
    elif not url.startswith('file:///'):
 
189
        raise errors.InvalidURL(
 
190
            url, 'local urls must start with file:/// or file://localhost/')
 
191
    else:
 
192
        path = url[len('file://'):]
 
193
    # We only strip off 2 slashes
 
194
    return unescape(path)
 
195
 
 
196
 
 
197
def _posix_local_path_to_url(path):
 
198
    """Convert a local path like ./foo into a URL like file:///path/to/foo
 
199
 
 
200
    This also handles transforming escaping unicode characters, etc.
 
201
    """
 
202
    # importing directly from posixpath allows us to test this
 
203
    # on non-posix platforms
 
204
    return 'file://' + escape(osutils._posix_abspath(path))
 
205
 
 
206
 
 
207
def _win32_local_path_from_url(url):
 
208
    """Convert a url like file:///C:/path/to/foo into C:/path/to/foo"""
 
209
    if not url.startswith('file://'):
 
210
        raise errors.InvalidURL(url, 'local urls must start with file:///, '
 
211
                                     'UNC path urls must start with file://')
 
212
    url = split_segment_parameters_raw(url)[0]
 
213
    # We strip off all 3 slashes
 
214
    win32_url = url[len('file:'):]
 
215
    # check for UNC path: //HOST/path
 
216
    if not win32_url.startswith('///'):
 
217
        if (win32_url[2] == '/'
 
218
            or win32_url[3] in '|:'):
 
219
            raise errors.InvalidURL(url, 'Win32 UNC path urls'
 
220
                ' have form file://HOST/path')
 
221
        return unescape(win32_url)
 
222
 
 
223
    # allow empty paths so we can serve all roots
 
224
    if win32_url == '///':
 
225
        return '/'
 
226
 
 
227
    # usual local path with drive letter
 
228
    if (len(win32_url) < 6
 
229
        or win32_url[3] not in ('abcdefghijklmnopqrstuvwxyz'
 
230
                                'ABCDEFGHIJKLMNOPQRSTUVWXYZ')
 
231
        or win32_url[4] not in  '|:'
 
232
        or win32_url[5] != '/'):
 
233
        raise errors.InvalidURL(url, 'Win32 file urls start with'
 
234
                ' file:///x:/, where x is a valid drive letter')
 
235
    return win32_url[3].upper() + u':' + unescape(win32_url[5:])
 
236
 
 
237
 
 
238
def _win32_local_path_to_url(path):
 
239
    """Convert a local path like ./foo into a URL like file:///C:/path/to/foo
 
240
 
 
241
    This also handles transforming escaping unicode characters, etc.
 
242
    """
 
243
    # importing directly from ntpath allows us to test this
 
244
    # on non-win32 platform
 
245
    # FIXME: It turns out that on nt, ntpath.abspath uses nt._getfullpathname
 
246
    #       which actually strips trailing space characters.
 
247
    #       The worst part is that on linux ntpath.abspath has different
 
248
    #       semantics, since 'nt' is not an available module.
 
249
    if path == '/':
 
250
        return 'file:///'
 
251
 
 
252
    win32_path = osutils._win32_abspath(path)
 
253
    # check for UNC path \\HOST\path
 
254
    if win32_path.startswith('//'):
 
255
        return 'file:' + escape(win32_path)
 
256
    return ('file:///' + str(win32_path[0].upper()) + ':' +
 
257
        escape(win32_path[2:]))
 
258
 
 
259
 
 
260
local_path_to_url = _posix_local_path_to_url
 
261
local_path_from_url = _posix_local_path_from_url
 
262
MIN_ABS_FILEURL_LENGTH = len('file:///')
 
263
WIN32_MIN_ABS_FILEURL_LENGTH = len('file:///C:/')
 
264
 
 
265
if sys.platform == 'win32':
 
266
    local_path_to_url = _win32_local_path_to_url
 
267
    local_path_from_url = _win32_local_path_from_url
 
268
 
 
269
    MIN_ABS_FILEURL_LENGTH = WIN32_MIN_ABS_FILEURL_LENGTH
 
270
 
 
271
 
 
272
_url_scheme_re = re.compile(r'^(?P<scheme>[^:/]{2,}):(//)?(?P<path>.*)$')
 
273
_url_hex_escapes_re = re.compile(r'(%[0-9a-fA-F]{2})')
 
274
 
 
275
 
 
276
def _unescape_safe_chars(matchobj):
 
277
    """re.sub callback to convert hex-escapes to plain characters (if safe).
 
278
 
 
279
    e.g. '%7E' will be converted to '~'.
 
280
    """
 
281
    hex_digits = matchobj.group(0)[1:]
 
282
    char = chr(int(hex_digits, 16))
 
283
    if char in _url_dont_escape_characters:
 
284
        return char
 
285
    else:
 
286
        return matchobj.group(0).upper()
 
287
 
 
288
 
 
289
def normalize_url(url):
 
290
    """Make sure that a path string is in fully normalized URL form.
 
291
 
 
292
    This handles URLs which have unicode characters, spaces,
 
293
    special characters, etc.
 
294
 
 
295
    It has two basic modes of operation, depending on whether the
 
296
    supplied string starts with a url specifier (scheme://) or not.
 
297
    If it does not have a specifier it is considered a local path,
 
298
    and will be converted into a file:/// url. Non-ascii characters
 
299
    will be encoded using utf-8.
 
300
    If it does have a url specifier, it will be treated as a "hybrid"
 
301
    URL. Basically, a URL that should have URL special characters already
 
302
    escaped (like +?&# etc), but may have unicode characters, etc
 
303
    which would not be valid in a real URL.
 
304
 
 
305
    :param url: Either a hybrid URL or a local path
 
306
    :return: A normalized URL which only includes 7-bit ASCII characters.
 
307
    """
 
308
    scheme_end, path_start = _find_scheme_and_separator(url)
 
309
    if scheme_end is None:
 
310
        return local_path_to_url(url)
 
311
    prefix = url[:path_start]
 
312
    path = url[path_start:]
 
313
    if not isinstance(url, unicode):
 
314
        for c in url:
 
315
            if c not in _url_safe_characters:
 
316
                raise errors.InvalidURL(url, 'URLs can only contain specific'
 
317
                                            ' safe characters (not %r)' % c)
 
318
        path = _url_hex_escapes_re.sub(_unescape_safe_chars, path)
 
319
        return str(prefix + ''.join(path))
 
320
 
 
321
    # We have a unicode (hybrid) url
 
322
    path_chars = list(path)
 
323
 
 
324
    for i in xrange(len(path_chars)):
 
325
        if path_chars[i] not in _url_safe_characters:
 
326
            chars = path_chars[i].encode('utf-8')
 
327
            path_chars[i] = ''.join(
 
328
                ['%%%02X' % ord(c) for c in path_chars[i].encode('utf-8')])
 
329
    path = ''.join(path_chars)
 
330
    path = _url_hex_escapes_re.sub(_unescape_safe_chars, path)
 
331
    return str(prefix + path)
 
332
 
 
333
 
 
334
def relative_url(base, other):
 
335
    """Return a path to other from base.
 
336
 
 
337
    If other is unrelated to base, return other. Else return a relative path.
 
338
    This assumes no symlinks as part of the url.
 
339
    """
 
340
    dummy, base_first_slash = _find_scheme_and_separator(base)
 
341
    if base_first_slash is None:
 
342
        return other
 
343
 
 
344
    dummy, other_first_slash = _find_scheme_and_separator(other)
 
345
    if other_first_slash is None:
 
346
        return other
 
347
 
 
348
    # this takes care of differing schemes or hosts
 
349
    base_scheme = base[:base_first_slash]
 
350
    other_scheme = other[:other_first_slash]
 
351
    if base_scheme != other_scheme:
 
352
        return other
 
353
    elif sys.platform == 'win32' and base_scheme == 'file://':
 
354
        base_drive = base[base_first_slash+1:base_first_slash+3]
 
355
        other_drive = other[other_first_slash+1:other_first_slash+3]
 
356
        if base_drive != other_drive:
 
357
            return other
 
358
 
 
359
    base_path = base[base_first_slash+1:]
 
360
    other_path = other[other_first_slash+1:]
 
361
 
 
362
    if base_path.endswith('/'):
 
363
        base_path = base_path[:-1]
 
364
 
 
365
    base_sections = base_path.split('/')
 
366
    other_sections = other_path.split('/')
 
367
 
 
368
    if base_sections == ['']:
 
369
        base_sections = []
 
370
    if other_sections == ['']:
 
371
        other_sections = []
 
372
 
 
373
    output_sections = []
 
374
    for b, o in zip(base_sections, other_sections):
 
375
        if b != o:
 
376
            break
 
377
        output_sections.append(b)
 
378
 
 
379
    match_len = len(output_sections)
 
380
    output_sections = ['..' for x in base_sections[match_len:]]
 
381
    output_sections.extend(other_sections[match_len:])
 
382
 
 
383
    return "/".join(output_sections) or "."
 
384
 
 
385
 
 
386
def _win32_extract_drive_letter(url_base, path):
 
387
    """On win32 the drive letter needs to be added to the url base."""
 
388
    # Strip off the drive letter
 
389
    # path is currently /C:/foo
 
390
    if len(path) < 4 or path[2] not in ':|' or path[3] != '/':
 
391
        raise errors.InvalidURL(url_base + path,
 
392
            'win32 file:/// paths need a drive letter')
 
393
    url_base += path[0:3] # file:// + /C:
 
394
    path = path[3:] # /foo
 
395
    return url_base, path
 
396
 
 
397
 
 
398
def split(url, exclude_trailing_slash=True):
 
399
    """Split a URL into its parent directory and a child directory.
 
400
 
 
401
    :param url: A relative or absolute URL
 
402
    :param exclude_trailing_slash: Strip off a final '/' if it is part
 
403
        of the path (but not if it is part of the protocol specification)
 
404
 
 
405
    :return: (parent_url, child_dir).  child_dir may be the empty string if we're at
 
406
        the root.
 
407
    """
 
408
    scheme_loc, first_path_slash = _find_scheme_and_separator(url)
 
409
 
 
410
    if first_path_slash is None:
 
411
        # We have either a relative path, or no separating slash
 
412
        if scheme_loc is None:
 
413
            # Relative path
 
414
            if exclude_trailing_slash and url.endswith('/'):
 
415
                url = url[:-1]
 
416
            return _posix_split(url)
 
417
        else:
 
418
            # Scheme with no path
 
419
            return url, ''
 
420
 
 
421
    # We have a fully defined path
 
422
    url_base = url[:first_path_slash] # http://host, file://
 
423
    path = url[first_path_slash:] # /file/foo
 
424
 
 
425
    if sys.platform == 'win32' and url.startswith('file:///'):
 
426
        # Strip off the drive letter
 
427
        # url_base is currently file://
 
428
        # path is currently /C:/foo
 
429
        url_base, path = _win32_extract_drive_letter(url_base, path)
 
430
        # now it should be file:///C: and /foo
 
431
 
 
432
    if exclude_trailing_slash and len(path) > 1 and path.endswith('/'):
 
433
        path = path[:-1]
 
434
    head, tail = _posix_split(path)
 
435
    return url_base + head, tail
 
436
 
 
437
 
 
438
def split_segment_parameters_raw(url):
 
439
    """Split the subsegment of the last segment of a URL.
 
440
 
 
441
    :param url: A relative or absolute URL
 
442
    :return: (url, subsegments)
 
443
    """
 
444
    (parent_url, child_dir) = split(url)
 
445
    subsegments = child_dir.split(",")
 
446
    if len(subsegments) == 1:
 
447
        return (url, [])
 
448
    return (join(parent_url, subsegments[0]), subsegments[1:])
 
449
 
 
450
 
 
451
def split_segment_parameters(url):
 
452
    """Split the segment parameters of the last segment of a URL.
 
453
 
 
454
    :param url: A relative or absolute URL
 
455
    :return: (url, segment_parameters)
 
456
    """
 
457
    (base_url, subsegments) = split_segment_parameters_raw(url)
 
458
    parameters = {}
 
459
    for subsegment in subsegments:
 
460
        (key, value) = subsegment.split("=", 1)
 
461
        parameters[key] = value
 
462
    return (base_url, parameters)
 
463
 
 
464
 
 
465
def join_segment_parameters_raw(base, *subsegments):
 
466
    """Create a new URL by adding subsegments to an existing one. 
 
467
 
 
468
    This adds the specified subsegments to the last path in the specified
 
469
    base URL. The subsegments should be bytestrings.
 
470
 
 
471
    :note: You probably want to use join_segment_parameters instead.
 
472
    """
 
473
    if not subsegments:
 
474
        return base
 
475
    for subsegment in subsegments:
 
476
        if type(subsegment) is not str:
 
477
            raise TypeError("Subsegment %r is not a bytestring" % subsegment)
 
478
        if "," in subsegment:
 
479
            raise errors.InvalidURLJoin(", exists in subsegments",
 
480
                                        base, subsegments)
 
481
    return ",".join((base,) + subsegments)
 
482
 
 
483
 
 
484
def join_segment_parameters(url, parameters):
 
485
    """Create a new URL by adding segment parameters to an existing one.
 
486
 
 
487
    The parameters of the last segment in the URL will be updated; if a
 
488
    parameter with the same key already exists it will be overwritten.
 
489
 
 
490
    :param url: A URL, as string
 
491
    :param parameters: Dictionary of parameters, keys and values as bytestrings
 
492
    """
 
493
    (base, existing_parameters) = split_segment_parameters(url)
 
494
    new_parameters = {}
 
495
    new_parameters.update(existing_parameters)
 
496
    for key, value in parameters.iteritems():
 
497
        if type(key) is not str:
 
498
            raise TypeError("parameter key %r is not a bytestring" % key)
 
499
        if type(value) is not str:
 
500
            raise TypeError("parameter value %r for %s is not a bytestring" %
 
501
                (key, value))
 
502
        if "=" in key:
 
503
            raise errors.InvalidURLJoin("= exists in parameter key", url,
 
504
                parameters)
 
505
        new_parameters[key] = value
 
506
    return join_segment_parameters_raw(base, 
 
507
        *["%s=%s" % item for item in sorted(new_parameters.items())])
 
508
 
 
509
 
 
510
def _win32_strip_local_trailing_slash(url):
 
511
    """Strip slashes after the drive letter"""
 
512
    if len(url) > WIN32_MIN_ABS_FILEURL_LENGTH:
 
513
        return url[:-1]
 
514
    else:
 
515
        return url
 
516
 
 
517
 
 
518
def strip_trailing_slash(url):
 
519
    """Strip trailing slash, except for root paths.
 
520
 
 
521
    The definition of 'root path' is platform-dependent.
 
522
    This assumes that all URLs are valid netloc urls, such that they
 
523
    form:
 
524
    scheme://host/path
 
525
    It searches for ://, and then refuses to remove the next '/'.
 
526
    It can also handle relative paths
 
527
    Examples:
 
528
        path/to/foo       => path/to/foo
 
529
        path/to/foo/      => path/to/foo
 
530
        http://host/path/ => http://host/path
 
531
        http://host/path  => http://host/path
 
532
        http://host/      => http://host/
 
533
        file:///          => file:///
 
534
        file:///foo/      => file:///foo
 
535
        # This is unique on win32 platforms, and is the only URL
 
536
        # format which does it differently.
 
537
        file:///c|/       => file:///c:/
 
538
    """
 
539
    if not url.endswith('/'):
 
540
        # Nothing to do
 
541
        return url
 
542
    if sys.platform == 'win32' and url.startswith('file://'):
 
543
        return _win32_strip_local_trailing_slash(url)
 
544
 
 
545
    scheme_loc, first_path_slash = _find_scheme_and_separator(url)
 
546
    if scheme_loc is None:
 
547
        # This is a relative path, as it has no scheme
 
548
        # so just chop off the last character
 
549
        return url[:-1]
 
550
 
 
551
    if first_path_slash is None or first_path_slash == len(url)-1:
 
552
        # Don't chop off anything if the only slash is the path
 
553
        # separating slash
 
554
        return url
 
555
 
 
556
    return url[:-1]
 
557
 
 
558
 
 
559
def unescape(url):
 
560
    """Unescape relpath from url format.
 
561
 
 
562
    This returns a Unicode path from a URL
 
563
    """
 
564
    # jam 20060427 URLs are supposed to be ASCII only strings
 
565
    #       If they are passed in as unicode, urllib.unquote
 
566
    #       will return a UNICODE string, which actually contains
 
567
    #       utf-8 bytes. So we have to ensure that they are
 
568
    #       plain ASCII strings, or the final .decode will
 
569
    #       try to encode the UNICODE => ASCII, and then decode
 
570
    #       it into utf-8.
 
571
    try:
 
572
        url = str(url)
 
573
    except UnicodeError, e:
 
574
        raise errors.InvalidURL(url, 'URL was not a plain ASCII url: %s' % (e,))
 
575
 
 
576
    unquoted = urllib.unquote(url)
 
577
    try:
 
578
        unicode_path = unquoted.decode('utf-8')
 
579
    except UnicodeError, e:
 
580
        raise errors.InvalidURL(url, 'Unable to encode the URL as utf-8: %s' % (e,))
 
581
    return unicode_path
 
582
 
 
583
 
 
584
# These are characters that if escaped, should stay that way
 
585
_no_decode_chars = ';/?:@&=+$,#'
 
586
_no_decode_ords = [ord(c) for c in _no_decode_chars]
 
587
_no_decode_hex = (['%02x' % o for o in _no_decode_ords]
 
588
                + ['%02X' % o for o in _no_decode_ords])
 
589
_hex_display_map = dict(([('%02x' % o, chr(o)) for o in range(256)]
 
590
                    + [('%02X' % o, chr(o)) for o in range(256)]))
 
591
#These entries get mapped to themselves
 
592
_hex_display_map.update((hex,'%'+hex) for hex in _no_decode_hex)
 
593
 
 
594
# These characters shouldn't be percent-encoded, and it's always safe to
 
595
# unencode them if they are.
 
596
_url_dont_escape_characters = set(
 
597
   "abcdefghijklmnopqrstuvwxyz" # Lowercase alpha
 
598
   "ABCDEFGHIJKLMNOPQRSTUVWXYZ" # Uppercase alpha
 
599
   "0123456789" # Numbers
 
600
   "-._~"  # Unreserved characters
 
601
)
 
602
 
 
603
# These characters should not be escaped
 
604
_url_safe_characters = set(
 
605
   "abcdefghijklmnopqrstuvwxyz" # Lowercase alpha
 
606
   "ABCDEFGHIJKLMNOPQRSTUVWXYZ" # Uppercase alpha
 
607
   "0123456789" # Numbers
 
608
   "_.-!~*'()"  # Unreserved characters
 
609
   "/;?:@&=+$," # Reserved characters
 
610
   "%#"         # Extra reserved characters
 
611
)
 
612
 
 
613
def unescape_for_display(url, encoding):
 
614
    """Decode what you can for a URL, so that we get a nice looking path.
 
615
 
 
616
    This will turn file:// urls into local paths, and try to decode
 
617
    any portions of a http:// style url that it can.
 
618
 
 
619
    Any sections of the URL which can't be represented in the encoding or
 
620
    need to stay as escapes are left alone.
 
621
 
 
622
    :param url: A 7-bit ASCII URL
 
623
    :param encoding: The final output encoding
 
624
 
 
625
    :return: A unicode string which can be safely encoded into the
 
626
         specified encoding.
 
627
    """
 
628
    if encoding is None:
 
629
        raise ValueError('you cannot specify None for the display encoding')
 
630
    if url.startswith('file://'):
 
631
        try:
 
632
            path = local_path_from_url(url)
 
633
            path.encode(encoding)
 
634
            return path
 
635
        except UnicodeError:
 
636
            return url
 
637
 
 
638
    # Split into sections to try to decode utf-8
 
639
    res = url.split('/')
 
640
    for i in xrange(1, len(res)):
 
641
        escaped_chunks = res[i].split('%')
 
642
        for j in xrange(1, len(escaped_chunks)):
 
643
            item = escaped_chunks[j]
 
644
            try:
 
645
                escaped_chunks[j] = _hex_display_map[item[:2]] + item[2:]
 
646
            except KeyError:
 
647
                # Put back the percent symbol
 
648
                escaped_chunks[j] = '%' + item
 
649
            except UnicodeDecodeError:
 
650
                escaped_chunks[j] = unichr(int(item[:2], 16)) + item[2:]
 
651
        unescaped = ''.join(escaped_chunks)
 
652
        try:
 
653
            decoded = unescaped.decode('utf-8')
 
654
        except UnicodeDecodeError:
 
655
            # If this path segment cannot be properly utf-8 decoded
 
656
            # after doing unescaping we will just leave it alone
 
657
            pass
 
658
        else:
 
659
            try:
 
660
                decoded.encode(encoding)
 
661
            except UnicodeEncodeError:
 
662
                # If this chunk cannot be encoded in the local
 
663
                # encoding, then we should leave it alone
 
664
                pass
 
665
            else:
 
666
                # Otherwise take the url decoded one
 
667
                res[i] = decoded
 
668
    return u'/'.join(res)
 
669
 
 
670
 
 
671
def derive_to_location(from_location):
 
672
    """Derive a TO_LOCATION given a FROM_LOCATION.
 
673
 
 
674
    The normal case is a FROM_LOCATION of http://foo/bar => bar.
 
675
    The Right Thing for some logical destinations may differ though
 
676
    because no / may be present at all. In that case, the result is
 
677
    the full name without the scheme indicator, e.g. lp:foo-bar => foo-bar.
 
678
    This latter case also applies when a Windows drive
 
679
    is used without a path, e.g. c:foo-bar => foo-bar.
 
680
    If no /, path separator or : is found, the from_location is returned.
 
681
    """
 
682
    if from_location.find("/") >= 0 or from_location.find(os.sep) >= 0:
 
683
        return os.path.basename(from_location.rstrip("/\\"))
 
684
    else:
 
685
        sep = from_location.find(":")
 
686
        if sep > 0:
 
687
            return from_location[sep+1:]
 
688
        else:
 
689
            return from_location
 
690
 
 
691
 
 
692
def _is_absolute(url):
 
693
    return (osutils.pathjoin('/foo', url) == url)
 
694
 
 
695
 
 
696
def rebase_url(url, old_base, new_base):
 
697
    """Convert a relative path from an old base URL to a new base URL.
 
698
 
 
699
    The result will be a relative path.
 
700
    Absolute paths and full URLs are returned unaltered.
 
701
    """
 
702
    scheme, separator = _find_scheme_and_separator(url)
 
703
    if scheme is not None:
 
704
        return url
 
705
    if _is_absolute(url):
 
706
        return url
 
707
    old_parsed = urlparse.urlparse(old_base)
 
708
    new_parsed = urlparse.urlparse(new_base)
 
709
    if (old_parsed[:2]) != (new_parsed[:2]):
 
710
        raise errors.InvalidRebaseURLs(old_base, new_base)
 
711
    return determine_relative_path(new_parsed[2],
 
712
                                   join(old_parsed[2], url))
 
713
 
 
714
 
 
715
def determine_relative_path(from_path, to_path):
 
716
    """Determine a relative path from from_path to to_path."""
 
717
    from_segments = osutils.splitpath(from_path)
 
718
    to_segments = osutils.splitpath(to_path)
 
719
    count = -1
 
720
    for count, (from_element, to_element) in enumerate(zip(from_segments,
 
721
                                                       to_segments)):
 
722
        if from_element != to_element:
 
723
            break
 
724
    else:
 
725
        count += 1
 
726
    unique_from = from_segments[count:]
 
727
    unique_to = to_segments[count:]
 
728
    segments = (['..'] * len(unique_from) + unique_to)
 
729
    if len(segments) == 0:
 
730
        return '.'
 
731
    return osutils.pathjoin(*segments)
 
732
 
 
733
 
 
734
class URL(object):
 
735
    """Parsed URL."""
 
736
 
 
737
    def __init__(self, scheme, quoted_user, quoted_password, quoted_host,
 
738
            port, quoted_path):
 
739
        self.scheme = scheme
 
740
        self.quoted_host = quoted_host
 
741
        self.host = urllib.unquote(self.quoted_host)
 
742
        self.quoted_user = quoted_user
 
743
        if self.quoted_user is not None:
 
744
            self.user = urllib.unquote(self.quoted_user)
 
745
        else:
 
746
            self.user = None
 
747
        self.quoted_password = quoted_password
 
748
        if self.quoted_password is not None:
 
749
            self.password = urllib.unquote(self.quoted_password)
 
750
        else:
 
751
            self.password = None
 
752
        self.port = port
 
753
        self.quoted_path = quoted_path
 
754
        self.path = urllib.unquote(self.quoted_path)
 
755
 
 
756
    def __eq__(self, other):
 
757
        return (isinstance(other, self.__class__) and
 
758
                self.scheme == other.scheme and
 
759
                self.host == other.host and
 
760
                self.user == other.user and
 
761
                self.password == other.password and
 
762
                self.path == other.path)
 
763
 
 
764
    def __repr__(self):
 
765
        return "<%s(%r, %r, %r, %r, %r, %r)>" % (
 
766
            self.__class__.__name__,
 
767
            self.scheme, self.quoted_user, self.quoted_password,
 
768
            self.quoted_host, self.port, self.quoted_path)
 
769
 
 
770
    @classmethod
 
771
    def from_string(cls, url):
 
772
        """Create a URL object from a string.
 
773
 
 
774
        :param url: URL as bytestring
 
775
        """
 
776
        if isinstance(url, unicode):
 
777
            raise errors.InvalidURL('should be ascii:\n%r' % url)
 
778
        url = url.encode('utf-8')
 
779
        (scheme, netloc, path, params,
 
780
         query, fragment) = urlparse.urlparse(url, allow_fragments=False)
 
781
        user = password = host = port = None
 
782
        if '@' in netloc:
 
783
            user, host = netloc.rsplit('@', 1)
 
784
            if ':' in user:
 
785
                user, password = user.split(':', 1)
 
786
        else:
 
787
            host = netloc
 
788
 
 
789
        if ':' in host and not (host[0] == '[' and host[-1] == ']'):
 
790
            # there *is* port
 
791
            host, port = host.rsplit(':',1)
 
792
            try:
 
793
                port = int(port)
 
794
            except ValueError:
 
795
                raise errors.InvalidURL('invalid port number %s in url:\n%s' %
 
796
                                        (port, url))
 
797
        if host != "" and host[0] == '[' and host[-1] == ']': #IPv6
 
798
            host = host[1:-1]
 
799
 
 
800
        return cls(scheme, user, password, host, port, path)
 
801
 
 
802
    def __str__(self):
 
803
        netloc = self.quoted_host
 
804
        if ":" in netloc:
 
805
            netloc = "[%s]" % netloc
 
806
        if self.quoted_user is not None:
 
807
            # Note that we don't put the password back even if we
 
808
            # have one so that it doesn't get accidentally
 
809
            # exposed.
 
810
            netloc = '%s@%s' % (self.quoted_user, netloc)
 
811
        if self.port is not None:
 
812
            netloc = '%s:%d' % (netloc, self.port)
 
813
        return urlparse.urlunparse(
 
814
            (self.scheme, netloc, self.quoted_path, None, None, None))
 
815
 
 
816
    @staticmethod
 
817
    def _combine_paths(base_path, relpath):
 
818
        """Transform a Transport-relative path to a remote absolute path.
 
819
 
 
820
        This does not handle substitution of ~ but does handle '..' and '.'
 
821
        components.
 
822
 
 
823
        Examples::
 
824
 
 
825
            t._combine_paths('/home/sarah', 'project/foo')
 
826
                => '/home/sarah/project/foo'
 
827
            t._combine_paths('/home/sarah', '../../etc')
 
828
                => '/etc'
 
829
            t._combine_paths('/home/sarah', '/etc')
 
830
                => '/etc'
 
831
 
 
832
        :param base_path: base path
 
833
        :param relpath: relative url string for relative part of remote path.
 
834
        :return: urlencoded string for final path.
 
835
        """
 
836
        if not isinstance(relpath, str):
 
837
            raise errors.InvalidURL(relpath)
 
838
        if relpath.startswith('/'):
 
839
            base_parts = []
 
840
        else:
 
841
            base_parts = base_path.split('/')
 
842
        if len(base_parts) > 0 and base_parts[-1] == '':
 
843
            base_parts = base_parts[:-1]
 
844
        for p in relpath.split('/'):
 
845
            if p == '..':
 
846
                if len(base_parts) == 0:
 
847
                    # In most filesystems, a request for the parent
 
848
                    # of root, just returns root.
 
849
                    continue
 
850
                base_parts.pop()
 
851
            elif p == '.':
 
852
                continue # No-op
 
853
            elif p != '':
 
854
                base_parts.append(p)
 
855
        path = '/'.join(base_parts)
 
856
        if not path.startswith('/'):
 
857
            path = '/' + path
 
858
        return path
 
859
 
 
860
    def clone(self, offset=None):
 
861
        """Return a new URL for a path relative to this URL.
 
862
 
 
863
        :param offset: A relative path, already urlencoded
 
864
        :return: `URL` instance
 
865
        """
 
866
        if offset is not None:
 
867
            relative = unescape(offset).encode('utf-8')
 
868
            path = self._combine_paths(self.path, relative)
 
869
            path = urllib.quote(path)
 
870
        else:
 
871
            path = self.quoted_path
 
872
        return self.__class__(self.scheme, self.quoted_user,
 
873
                self.quoted_password, self.quoted_host, self.port,
 
874
                path)
 
875
 
 
876
 
 
877
def parse_url(url):
 
878
    """Extract the server address, the credentials and the path from the url.
 
879
 
 
880
    user, password, host and path should be quoted if they contain reserved
 
881
    chars.
 
882
 
 
883
    :param url: an quoted url
 
884
    :return: (scheme, user, password, host, port, path) tuple, all fields
 
885
        are unquoted.
 
886
    """
 
887
    parsed_url = URL.from_string(url)
 
888
    return (parsed_url.scheme, parsed_url.user, parsed_url.password,
 
889
        parsed_url.host, parsed_url.port, parsed_url.path)