/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/urlutils.py

  • Committer: Jelmer Vernooij
  • Date: 2019-06-03 03:56:59 UTC
  • mto: This revision was merged to the branch mainline in revision 7313.
  • Revision ID: jelmer@jelmer.uk-20190603035659-ln8k6ylzdiytfiog
Fix github module name.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/urlutils.py
16
16
 
17
17
"""A collection of function for handling URL operations."""
18
18
 
 
19
from __future__ import absolute_import
 
20
 
19
21
import os
20
22
import re
21
23
import sys
22
24
 
23
 
from bzrlib.lazy_import import lazy_import
24
 
lazy_import(globals(), """
25
 
from posixpath import split as _posix_split, normpath as _posix_normpath
26
 
import urllib
27
 
import urlparse
 
25
try:
 
26
    import urlparse
 
27
except ImportError:
 
28
    from urllib import parse as urlparse
28
29
 
29
 
from bzrlib import (
 
30
from . import (
30
31
    errors,
31
32
    osutils,
32
33
    )
 
34
 
 
35
from .lazy_import import lazy_import
 
36
lazy_import(globals(), """
 
37
from posixpath import split as _posix_split
33
38
""")
34
39
 
 
40
from .sixish import (
 
41
    int2byte,
 
42
    PY3,
 
43
    text_type,
 
44
    unichr,
 
45
    )
 
46
 
 
47
 
 
48
class InvalidURL(errors.PathError):
 
49
 
 
50
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
 
51
 
 
52
 
 
53
class InvalidURLJoin(errors.PathError):
 
54
 
 
55
    _fmt = "Invalid URL join request: %(reason)s: %(base)r + %(join_args)r"
 
56
 
 
57
    def __init__(self, reason, base, join_args):
 
58
        self.reason = reason
 
59
        self.base = base
 
60
        self.join_args = join_args
 
61
        errors.PathError.__init__(self, base, reason)
 
62
 
 
63
 
 
64
class InvalidRebaseURLs(errors.PathError):
 
65
 
 
66
    _fmt = "URLs differ by more than path: %(from_)r and %(to)r"
 
67
 
 
68
    def __init__(self, from_, to):
 
69
        self.from_ = from_
 
70
        self.to = to
 
71
        errors.PathError.__init__(
 
72
            self, from_, 'URLs differ by more than path.')
 
73
 
35
74
 
36
75
def basename(url, exclude_trailing_slash=True):
37
76
    """Return the last component of a URL.
60
99
    return split(url, exclude_trailing_slash=exclude_trailing_slash)[0]
61
100
 
62
101
 
63
 
def escape(relpath):
 
102
if PY3:
 
103
    quote_from_bytes = urlparse.quote_from_bytes
 
104
    quote = urlparse.quote
 
105
    unquote_to_bytes = urlparse.unquote_to_bytes
 
106
else:
 
107
    # Private copies of quote and unquote, copied from Python's urllib module
 
108
    # because urllib unconditionally imports socket, which imports ssl.
 
109
 
 
110
    always_safe = ('ABCDEFGHIJKLMNOPQRSTUVWXYZ'
 
111
                   'abcdefghijklmnopqrstuvwxyz'
 
112
                   '0123456789' '_.-')
 
113
    _safe_map = {}
 
114
    for i, c in zip(range(256), ''.join(map(chr, range(256)))):
 
115
        _safe_map[c] = c if (
 
116
            i < 128 and c in always_safe) else '%{0:02X}'.format(i)
 
117
    _safe_quoters = {}
 
118
 
 
119
    def quote_from_bytes(s, safe='/'):
 
120
        """quote('abc def') -> 'abc%20def'
 
121
 
 
122
        Each part of a URL, e.g. the path info, the query, etc., has a
 
123
        different set of reserved characters that must be quoted.
 
124
 
 
125
        RFC 2396 Uniform Resource Identifiers (URI): Generic Syntax lists
 
126
        the following reserved characters.
 
127
 
 
128
        reserved    = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" |
 
129
                      "$" | ","
 
130
 
 
131
        Each of these characters is reserved in some component of a URL,
 
132
        but not necessarily in all of them.
 
133
 
 
134
        By default, the quote function is intended for quoting the path
 
135
        section of a URL.  Thus, it will not encode '/'.  This character
 
136
        is reserved, but in typical usage the quote function is being
 
137
        called on a path where the existing slash characters are used as
 
138
        reserved characters.
 
139
        """
 
140
        # fastpath
 
141
        if not s:
 
142
            if s is None:
 
143
                raise TypeError('None object cannot be quoted')
 
144
            return s
 
145
        cachekey = (safe, always_safe)
 
146
        try:
 
147
            (quoter, safe) = _safe_quoters[cachekey]
 
148
        except KeyError:
 
149
            safe_map = _safe_map.copy()
 
150
            safe_map.update([(c, c) for c in safe])
 
151
            quoter = safe_map.__getitem__
 
152
            safe = always_safe + safe
 
153
            _safe_quoters[cachekey] = (quoter, safe)
 
154
        if not s.rstrip(safe):
 
155
            return s
 
156
        return ''.join(map(quoter, s))
 
157
 
 
158
    quote = quote_from_bytes
 
159
    unquote_to_bytes = urlparse.unquote
 
160
 
 
161
 
 
162
unquote = urlparse.unquote
 
163
 
 
164
 
 
165
def escape(relpath, safe='/~'):
64
166
    """Escape relpath to be a valid url."""
65
 
    if isinstance(relpath, unicode):
 
167
    if not isinstance(relpath, str) and sys.version_info[0] == 2:
66
168
        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='/~'))
 
169
    return quote(relpath, safe=safe)
70
170
 
71
171
 
72
172
def file_relpath(base, path):
76
176
    """
77
177
    if len(base) < MIN_ABS_FILEURL_LENGTH:
78
178
        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)
 
179
                         ' exceed the platform minimum url length (which is %d)' %
 
180
                         (base, MIN_ABS_FILEURL_LENGTH))
 
181
    base = osutils.normpath(local_path_from_url(base))
 
182
    path = osutils.normpath(local_path_from_url(path))
83
183
    return escape(osutils.relpath(base, path))
84
184
 
85
185
 
101
201
    first_path_slash = path.find('/')
102
202
    if first_path_slash == -1:
103
203
        return len(scheme), None
104
 
    return len(scheme), first_path_slash+len(scheme)+3
 
204
    return len(scheme), first_path_slash + m.start('path')
 
205
 
 
206
 
 
207
def is_url(url):
 
208
    """Tests whether a URL is in actual fact a URL."""
 
209
    return _url_scheme_re.match(url) is not None
105
210
 
106
211
 
107
212
def join(base, *args):
118
223
    """
119
224
    if not args:
120
225
        return base
121
 
    match = _url_scheme_re.match(base)
122
 
    scheme = None
123
 
    if match:
124
 
        scheme = match.group('scheme')
125
 
        path = match.group('path').split('/')
126
 
        if path[-1:] == ['']:
127
 
            # Strip off a trailing slash
128
 
            # This helps both when we are at the root, and when
129
 
            # 'base' has an extra slash at the end
130
 
            path = path[:-1]
131
 
    else:
132
 
        path = base.split('/')
133
 
 
134
 
    if scheme is not None and len(path) >= 1:
135
 
        host = path[:1]
136
 
        # the path should be represented as an abs path.
137
 
        # we know this must be absolute because of the presence of a URL scheme.
138
 
        remove_root = True
139
 
        path = [''] + path[1:]
140
 
    else:
141
 
        # create an empty host, but dont alter the path - this might be a
142
 
        # relative url fragment.
143
 
        host = []
144
 
        remove_root = False
145
 
 
 
226
    scheme_end, path_start = _find_scheme_and_separator(base)
 
227
    if scheme_end is None and path_start is None:
 
228
        path_start = 0
 
229
    elif path_start is None:
 
230
        path_start = len(base)
 
231
    path = base[path_start:]
146
232
    for arg in args:
147
 
        match = _url_scheme_re.match(arg)
148
 
        if match:
149
 
            # Absolute URL
150
 
            scheme = match.group('scheme')
151
 
            # this skips .. normalisation, making http://host/../../..
152
 
            # be rather strange.
153
 
            path = match.group('path').split('/')
154
 
            # set the host and path according to new absolute URL, discarding
155
 
            # any previous values.
156
 
            # XXX: duplicates mess from earlier in this function.  This URL
157
 
            # manipulation code needs some cleaning up.
158
 
            if scheme is not None and len(path) >= 1:
159
 
                host = path[:1]
160
 
                path = path[1:]
161
 
                # url scheme implies absolute path.
162
 
                path = [''] + path
163
 
            else:
164
 
                # no url scheme we take the path as is.
165
 
                host = []
 
233
        arg_scheme_end, arg_path_start = _find_scheme_and_separator(arg)
 
234
        if arg_scheme_end is None and arg_path_start is None:
 
235
            arg_path_start = 0
 
236
        elif arg_path_start is None:
 
237
            arg_path_start = len(arg)
 
238
        if arg_scheme_end is not None:
 
239
            base = arg
 
240
            path = arg[arg_path_start:]
 
241
            scheme_end = arg_scheme_end
 
242
            path_start = arg_path_start
166
243
        else:
167
 
            path = '/'.join(path)
168
244
            path = joinpath(path, arg)
169
 
            path = path.split('/')
170
 
    if remove_root and path[0:1] == ['']:
171
 
        del path[0]
172
 
    if host:
173
 
        # Remove the leading slash from the path, so long as it isn't also the
174
 
        # trailing slash, which we want to keep if present.
175
 
        if path and path[0] == '' and len(path) > 1:
176
 
            del path[0]
177
 
        path = host + path
178
 
 
179
 
    if scheme is None:
180
 
        return '/'.join(path)
181
 
    return scheme + '://' + '/'.join(path)
 
245
    return base[:path_start] + path
182
246
 
183
247
 
184
248
def joinpath(base, *args):
193
257
    """
194
258
    path = base.split('/')
195
259
    if len(path) > 1 and path[-1] == '':
196
 
        #If the path ends in a trailing /, remove it.
 
260
        # If the path ends in a trailing /, remove it.
197
261
        path.pop()
198
262
    for arg in args:
199
263
        if arg.startswith('/'):
203
267
                continue
204
268
            elif chunk == '..':
205
269
                if path == ['']:
206
 
                    raise errors.InvalidURLJoin('Cannot go above root',
207
 
                            base, args)
 
270
                    raise InvalidURLJoin('Cannot go above root',
 
271
                                         base, args)
208
272
                path.pop()
209
273
            else:
210
274
                path.append(chunk)
217
281
# jam 20060502 Sorted to 'l' because the final target is 'local_path_from_url'
218
282
def _posix_local_path_from_url(url):
219
283
    """Convert a url like file:///path/to/foo into /path/to/foo"""
 
284
    url = split_segment_parameters_raw(url)[0]
220
285
    file_localhost_prefix = 'file://localhost/'
221
286
    if url.startswith(file_localhost_prefix):
222
287
        path = url[len(file_localhost_prefix) - 1:]
223
288
    elif not url.startswith('file:///'):
224
 
        raise errors.InvalidURL(
 
289
        raise InvalidURL(
225
290
            url, 'local urls must start with file:/// or file://localhost/')
226
291
    else:
227
292
        path = url[len('file://'):]
236
301
    """
237
302
    # importing directly from posixpath allows us to test this
238
303
    # on non-posix platforms
239
 
    return 'file://' + escape(_posix_normpath(
240
 
        osutils._posix_abspath(path)))
 
304
    return 'file://' + escape(osutils._posix_abspath(path))
241
305
 
242
306
 
243
307
def _win32_local_path_from_url(url):
244
308
    """Convert a url like file:///C:/path/to/foo into C:/path/to/foo"""
245
309
    if not url.startswith('file://'):
246
 
        raise errors.InvalidURL(url, 'local urls must start with file:///, '
247
 
                                     'UNC path urls must start with file://')
 
310
        raise InvalidURL(url, 'local urls must start with file:///, '
 
311
                         'UNC path urls must start with file://')
 
312
    url = split_segment_parameters_raw(url)[0]
248
313
    # We strip off all 3 slashes
249
314
    win32_url = url[len('file:'):]
250
315
    # check for UNC path: //HOST/path
251
316
    if not win32_url.startswith('///'):
252
317
        if (win32_url[2] == '/'
253
 
            or win32_url[3] in '|:'):
254
 
            raise errors.InvalidURL(url, 'Win32 UNC path urls'
255
 
                ' have form file://HOST/path')
 
318
                or win32_url[3] in '|:'):
 
319
            raise InvalidURL(url, 'Win32 UNC path urls'
 
320
                             ' have form file://HOST/path')
256
321
        return unescape(win32_url)
257
322
 
258
323
    # allow empty paths so we can serve all roots
260
325
        return '/'
261
326
 
262
327
    # usual local path with drive letter
263
 
    if (win32_url[3] not in ('abcdefghijklmnopqrstuvwxyz'
264
 
                             'ABCDEFGHIJKLMNOPQRSTUVWXYZ')
265
 
        or win32_url[4] not in  '|:'
266
 
        or win32_url[5] != '/'):
267
 
        raise errors.InvalidURL(url, 'Win32 file urls start with'
268
 
                ' file:///x:/, where x is a valid drive letter')
 
328
    if (len(win32_url) < 6
 
329
        or win32_url[3] not in ('abcdefghijklmnopqrstuvwxyz'
 
330
                                'ABCDEFGHIJKLMNOPQRSTUVWXYZ') or
 
331
        win32_url[4] not in '|:'
 
332
            or win32_url[5] != '/'):
 
333
        raise InvalidURL(url, 'Win32 file urls start with'
 
334
                         ' file:///x:/, where x is a valid drive letter')
269
335
    return win32_url[3].upper() + u':' + unescape(win32_url[5:])
270
336
 
271
337
 
278
344
    # on non-win32 platform
279
345
    # FIXME: It turns out that on nt, ntpath.abspath uses nt._getfullpathname
280
346
    #       which actually strips trailing space characters.
281
 
    #       The worst part is that under linux ntpath.abspath has different
 
347
    #       The worst part is that on linux ntpath.abspath has different
282
348
    #       semantics, since 'nt' is not an available module.
283
349
    if path == '/':
284
350
        return 'file:///'
288
354
    if win32_path.startswith('//'):
289
355
        return 'file:' + escape(win32_path)
290
356
    return ('file:///' + str(win32_path[0].upper()) + ':' +
291
 
        escape(win32_path[2:]))
 
357
            escape(win32_path[2:]))
292
358
 
293
359
 
294
360
local_path_to_url = _posix_local_path_to_url
303
369
    MIN_ABS_FILEURL_LENGTH = WIN32_MIN_ABS_FILEURL_LENGTH
304
370
 
305
371
 
306
 
_url_scheme_re = re.compile(r'^(?P<scheme>[^:/]{2,})://(?P<path>.*)$')
307
 
_url_hex_escapes_re = re.compile(r'(%[0-9a-fA-F]{2})')
 
372
_url_scheme_re = re.compile('^(?P<scheme>[^:/]{2,}):(//)?(?P<path>.*)$')
 
373
_url_hex_escapes_re = re.compile('(%[0-9a-fA-F]{2})')
308
374
 
309
375
 
310
376
def _unescape_safe_chars(matchobj):
339
405
    :param url: Either a hybrid URL or a local path
340
406
    :return: A normalized URL which only includes 7-bit ASCII characters.
341
407
    """
342
 
    m = _url_scheme_re.match(url)
343
 
    if not m:
 
408
    scheme_end, path_start = _find_scheme_and_separator(url)
 
409
    if scheme_end is None:
344
410
        return local_path_to_url(url)
345
 
    scheme = m.group('scheme')
346
 
    path = m.group('path')
347
 
    if not isinstance(url, unicode):
 
411
    prefix = url[:path_start]
 
412
    path = url[path_start:]
 
413
    if not isinstance(url, text_type):
348
414
        for c in url:
349
415
            if c not in _url_safe_characters:
350
 
                raise errors.InvalidURL(url, 'URLs can only contain specific'
351
 
                                            ' safe characters (not %r)' % c)
 
416
                raise InvalidURL(url, 'URLs can only contain specific'
 
417
                                 ' safe characters (not %r)' % c)
352
418
        path = _url_hex_escapes_re.sub(_unescape_safe_chars, path)
353
 
        return str(scheme + '://' + ''.join(path))
 
419
        return str(prefix + ''.join(path))
354
420
 
355
421
    # We have a unicode (hybrid) url
356
422
    path_chars = list(path)
357
423
 
358
 
    for i in xrange(len(path_chars)):
 
424
    for i in range(len(path_chars)):
359
425
        if path_chars[i] not in _url_safe_characters:
360
 
            chars = path_chars[i].encode('utf-8')
361
426
            path_chars[i] = ''.join(
362
 
                ['%%%02X' % ord(c) for c in path_chars[i].encode('utf-8')])
 
427
                ['%%%02X' % c for c in bytearray(path_chars[i].encode('utf-8'))])
363
428
    path = ''.join(path_chars)
364
429
    path = _url_hex_escapes_re.sub(_unescape_safe_chars, path)
365
 
    return str(scheme + '://' + path)
 
430
    return str(prefix + path)
366
431
 
367
432
 
368
433
def relative_url(base, other):
385
450
    if base_scheme != other_scheme:
386
451
        return other
387
452
    elif sys.platform == 'win32' and base_scheme == 'file://':
388
 
        base_drive = base[base_first_slash+1:base_first_slash+3]
389
 
        other_drive = other[other_first_slash+1:other_first_slash+3]
 
453
        base_drive = base[base_first_slash + 1:base_first_slash + 3]
 
454
        other_drive = other[other_first_slash + 1:other_first_slash + 3]
390
455
        if base_drive != other_drive:
391
456
            return other
392
457
 
393
 
    base_path = base[base_first_slash+1:]
394
 
    other_path = other[other_first_slash+1:]
 
458
    base_path = base[base_first_slash + 1:]
 
459
    other_path = other[other_first_slash + 1:]
395
460
 
396
461
    if base_path.endswith('/'):
397
462
        base_path = base_path[:-1]
421
486
    """On win32 the drive letter needs to be added to the url base."""
422
487
    # Strip off the drive letter
423
488
    # path is currently /C:/foo
424
 
    if len(path) < 3 or path[2] not in ':|' or path[3] != '/':
425
 
        raise errors.InvalidURL(url_base + path,
426
 
            'win32 file:/// paths need a drive letter')
427
 
    url_base += path[0:3] # file:// + /C:
428
 
    path = path[3:] # /foo
 
489
    if len(path) < 4 or path[2] not in ':|' or path[3] != '/':
 
490
        raise InvalidURL(url_base + path,
 
491
                         'win32 file:/// paths need a drive letter')
 
492
    url_base += path[0:3]  # file:// + /C:
 
493
    path = path[3:]  # /foo
429
494
    return url_base, path
430
495
 
431
496
 
436
501
    :param exclude_trailing_slash: Strip off a final '/' if it is part
437
502
        of the path (but not if it is part of the protocol specification)
438
503
 
439
 
    :return: (parent_url, child_dir).  child_dir may be the empty string if we're at
440
 
        the root.
 
504
    :return: (parent_url, child_dir).  child_dir may be the empty string if
 
505
        we're at the root.
441
506
    """
442
507
    scheme_loc, first_path_slash = _find_scheme_and_separator(url)
443
508
 
453
518
            return url, ''
454
519
 
455
520
    # We have a fully defined path
456
 
    url_base = url[:first_path_slash] # http://host, file://
457
 
    path = url[first_path_slash:] # /file/foo
 
521
    url_base = url[:first_path_slash]  # http://host, file://
 
522
    path = url[first_path_slash:]  # /file/foo
458
523
 
459
524
    if sys.platform == 'win32' and url.startswith('file:///'):
460
525
        # Strip off the drive letter
469
534
    return url_base + head, tail
470
535
 
471
536
 
 
537
def split_segment_parameters_raw(url):
 
538
    """Split the subsegment of the last segment of a URL.
 
539
 
 
540
    :param url: A relative or absolute URL
 
541
    :return: (url, subsegments)
 
542
    """
 
543
    # GZ 2011-11-18: Dodgy removing the terminal slash like this, function
 
544
    #                operates on urls not url+segments, and Transport classes
 
545
    #                should not be blindly adding slashes in the first place.
 
546
    lurl = strip_trailing_slash(url)
 
547
    # Segments begin at first comma after last forward slash, if one exists
 
548
    segment_start = lurl.find(",", lurl.rfind("/") + 1)
 
549
    if segment_start == -1:
 
550
        return (url, [])
 
551
    return (lurl[:segment_start],
 
552
            [str(s) for s in lurl[segment_start + 1:].split(",")])
 
553
 
 
554
 
 
555
def split_segment_parameters(url):
 
556
    """Split the segment parameters of the last segment of a URL.
 
557
 
 
558
    :param url: A relative or absolute URL
 
559
    :return: (url, segment_parameters)
 
560
    """
 
561
    (base_url, subsegments) = split_segment_parameters_raw(url)
 
562
    parameters = {}
 
563
    for subsegment in subsegments:
 
564
        try:
 
565
            (key, value) = subsegment.split("=", 1)
 
566
        except ValueError:
 
567
            raise InvalidURL(url, "missing = in subsegment")
 
568
        if not isinstance(key, str):
 
569
            raise TypeError(key)
 
570
        if not isinstance(value, str):
 
571
            raise TypeError(value)
 
572
        parameters[key] = value
 
573
    return (base_url, parameters)
 
574
 
 
575
 
 
576
def join_segment_parameters_raw(base, *subsegments):
 
577
    """Create a new URL by adding subsegments to an existing one.
 
578
 
 
579
    This adds the specified subsegments to the last path in the specified
 
580
    base URL. The subsegments should be bytestrings.
 
581
 
 
582
    :note: You probably want to use join_segment_parameters instead.
 
583
    """
 
584
    if not subsegments:
 
585
        return base
 
586
    for subsegment in subsegments:
 
587
        if not isinstance(subsegment, str):
 
588
            raise TypeError("Subsegment %r is not a bytestring" % subsegment)
 
589
        if "," in subsegment:
 
590
            raise InvalidURLJoin(", exists in subsegments",
 
591
                                 base, subsegments)
 
592
    return ",".join((base,) + subsegments)
 
593
 
 
594
 
 
595
def join_segment_parameters(url, parameters):
 
596
    """Create a new URL by adding segment parameters to an existing one.
 
597
 
 
598
    The parameters of the last segment in the URL will be updated; if a
 
599
    parameter with the same key already exists it will be overwritten.
 
600
 
 
601
    :param url: A URL, as string
 
602
    :param parameters: Dictionary of parameters, keys and values as bytestrings
 
603
    """
 
604
    (base, existing_parameters) = split_segment_parameters(url)
 
605
    new_parameters = {}
 
606
    new_parameters.update(existing_parameters)
 
607
    for key, value in parameters.items():
 
608
        if not isinstance(key, str):
 
609
            raise TypeError("parameter key %r is not a str" % key)
 
610
        if not isinstance(value, str):
 
611
            raise TypeError("parameter value %r for %r is not a str" %
 
612
                            (value, key))
 
613
        if "=" in key:
 
614
            raise InvalidURLJoin("= exists in parameter key", url,
 
615
                                 parameters)
 
616
        new_parameters[key] = value
 
617
    return join_segment_parameters_raw(
 
618
        base, *["%s=%s" % item for item in sorted(new_parameters.items())])
 
619
 
 
620
 
472
621
def _win32_strip_local_trailing_slash(url):
473
622
    """Strip slashes after the drive letter"""
474
623
    if len(url) > WIN32_MIN_ABS_FILEURL_LENGTH:
510
659
        # so just chop off the last character
511
660
        return url[:-1]
512
661
 
513
 
    if first_path_slash is None or first_path_slash == len(url)-1:
 
662
    if first_path_slash is None or first_path_slash == len(url) - 1:
514
663
        # Don't chop off anything if the only slash is the path
515
664
        # separating slash
516
665
        return url
524
673
    This returns a Unicode path from a URL
525
674
    """
526
675
    # jam 20060427 URLs are supposed to be ASCII only strings
527
 
    #       If they are passed in as unicode, urllib.unquote
 
676
    #       If they are passed in as unicode, unquote
528
677
    #       will return a UNICODE string, which actually contains
529
678
    #       utf-8 bytes. So we have to ensure that they are
530
679
    #       plain ASCII strings, or the final .decode will
531
680
    #       try to encode the UNICODE => ASCII, and then decode
532
681
    #       it into utf-8.
533
 
    try:
534
 
        url = str(url)
535
 
    except UnicodeError, e:
536
 
        raise errors.InvalidURL(url, 'URL was not a plain ASCII url: %s' % (e,))
537
682
 
538
 
    unquoted = urllib.unquote(url)
539
 
    try:
540
 
        unicode_path = unquoted.decode('utf-8')
541
 
    except UnicodeError, e:
542
 
        raise errors.InvalidURL(url, 'Unable to encode the URL as utf-8: %s' % (e,))
543
 
    return unicode_path
 
683
    if PY3:
 
684
        if isinstance(url, text_type):
 
685
            try:
 
686
                url.encode("ascii")
 
687
            except UnicodeError as e:
 
688
                raise InvalidURL(
 
689
                    url, 'URL was not a plain ASCII url: %s' % (e,))
 
690
        return urlparse.unquote(url)
 
691
    else:
 
692
        if isinstance(url, text_type):
 
693
            try:
 
694
                url = url.encode("ascii")
 
695
            except UnicodeError as e:
 
696
                raise InvalidURL(
 
697
                    url, 'URL was not a plain ASCII url: %s' % (e,))
 
698
        unquoted = unquote(url)
 
699
        try:
 
700
            unicode_path = unquoted.decode('utf-8')
 
701
        except UnicodeError as e:
 
702
            raise InvalidURL(
 
703
                url, 'Unable to encode the URL as utf-8: %s' % (e,))
 
704
        return unicode_path
544
705
 
545
706
 
546
707
# These are characters that if escaped, should stay that way
547
708
_no_decode_chars = ';/?:@&=+$,#'
548
709
_no_decode_ords = [ord(c) for c in _no_decode_chars]
549
710
_no_decode_hex = (['%02x' % o for o in _no_decode_ords]
550
 
                + ['%02X' % o for o in _no_decode_ords])
551
 
_hex_display_map = dict(([('%02x' % o, chr(o)) for o in range(256)]
552
 
                    + [('%02X' % o, chr(o)) for o in range(256)]))
553
 
#These entries get mapped to themselves
554
 
_hex_display_map.update((hex,'%'+hex) for hex in _no_decode_hex)
 
711
                  + ['%02X' % o for o in _no_decode_ords])
 
712
_hex_display_map = dict(([('%02x' % o, int2byte(o)) for o in range(256)]
 
713
                         + [('%02X' % o, int2byte(o)) for o in range(256)]))
 
714
# These entries get mapped to themselves
 
715
_hex_display_map.update((hex, b'%' + hex.encode('ascii'))
 
716
                        for hex in _no_decode_hex)
555
717
 
556
718
# These characters shouldn't be percent-encoded, and it's always safe to
557
719
# unencode them if they are.
558
720
_url_dont_escape_characters = set(
559
 
   "abcdefghijklmnopqrstuvwxyz" # Lowercase alpha
560
 
   "ABCDEFGHIJKLMNOPQRSTUVWXYZ" # Uppercase alpha
561
 
   "0123456789" # Numbers
562
 
   "-._~"  # Unreserved characters
 
721
    "abcdefghijklmnopqrstuvwxyz"  # Lowercase alpha
 
722
    "ABCDEFGHIJKLMNOPQRSTUVWXYZ"  # Uppercase alpha
 
723
    "0123456789"  # Numbers
 
724
    "-._~"  # Unreserved characters
563
725
)
564
726
 
565
727
# These characters should not be escaped
566
728
_url_safe_characters = set(
567
 
   "abcdefghijklmnopqrstuvwxyz" # Lowercase alpha
568
 
   "ABCDEFGHIJKLMNOPQRSTUVWXYZ" # Uppercase alpha
569
 
   "0123456789" # Numbers
570
 
   "_.-!~*'()"  # Unreserved characters
571
 
   "/;?:@&=+$," # Reserved characters
572
 
   "%#"         # Extra reserved characters
 
729
    "abcdefghijklmnopqrstuvwxyz"  # Lowercase alpha
 
730
    "ABCDEFGHIJKLMNOPQRSTUVWXYZ"  # Uppercase alpha
 
731
    "0123456789"  # Numbers
 
732
    "_.-!~*'()"  # Unreserved characters
 
733
    "/;?:@&=+$,"  # Reserved characters
 
734
    "%#"         # Extra reserved characters
573
735
)
574
736
 
 
737
 
 
738
def _unescape_segment_for_display(segment, encoding):
 
739
    """Unescape a segment for display.
 
740
 
 
741
    Helper for unescape_for_display
 
742
 
 
743
    :param url: A 7-bit ASCII URL
 
744
    :param encoding: The final output encoding
 
745
 
 
746
    :return: A unicode string which can be safely encoded into the
 
747
         specified encoding.
 
748
    """
 
749
    escaped_chunks = segment.split('%')
 
750
    escaped_chunks[0] = escaped_chunks[0].encode('utf-8')
 
751
    for j in range(1, len(escaped_chunks)):
 
752
        item = escaped_chunks[j]
 
753
        try:
 
754
            escaped_chunks[j] = _hex_display_map[item[:2]]
 
755
        except KeyError:
 
756
            # Put back the percent symbol
 
757
            escaped_chunks[j] = b'%' + \
 
758
                (item[:2].encode('utf-8') if PY3 else item[:2])
 
759
        except UnicodeDecodeError:
 
760
            escaped_chunks[j] = unichr(int(item[:2], 16)).encode('utf-8')
 
761
        escaped_chunks[j] += (item[2:].encode('utf-8') if PY3 else item[2:])
 
762
    unescaped = b''.join(escaped_chunks)
 
763
    try:
 
764
        decoded = unescaped.decode('utf-8')
 
765
    except UnicodeDecodeError:
 
766
        # If this path segment cannot be properly utf-8 decoded
 
767
        # after doing unescaping we will just leave it alone
 
768
        return segment
 
769
    else:
 
770
        try:
 
771
            decoded.encode(encoding)
 
772
        except UnicodeEncodeError:
 
773
            # If this chunk cannot be encoded in the local
 
774
            # encoding, then we should leave it alone
 
775
            return segment
 
776
        else:
 
777
            # Otherwise take the url decoded one
 
778
            return decoded
 
779
 
 
780
 
575
781
def unescape_for_display(url, encoding):
576
782
    """Decode what you can for a URL, so that we get a nice looking path.
577
783
 
599
805
 
600
806
    # Split into sections to try to decode utf-8
601
807
    res = url.split('/')
602
 
    for i in xrange(1, len(res)):
603
 
        escaped_chunks = res[i].split('%')
604
 
        for j in xrange(1, len(escaped_chunks)):
605
 
            item = escaped_chunks[j]
606
 
            try:
607
 
                escaped_chunks[j] = _hex_display_map[item[:2]] + item[2:]
608
 
            except KeyError:
609
 
                # Put back the percent symbol
610
 
                escaped_chunks[j] = '%' + item
611
 
            except UnicodeDecodeError:
612
 
                escaped_chunks[j] = unichr(int(item[:2], 16)) + item[2:]
613
 
        unescaped = ''.join(escaped_chunks)
614
 
        try:
615
 
            decoded = unescaped.decode('utf-8')
616
 
        except UnicodeDecodeError:
617
 
            # If this path segment cannot be properly utf-8 decoded
618
 
            # after doing unescaping we will just leave it alone
619
 
            pass
620
 
        else:
621
 
            try:
622
 
                decoded.encode(encoding)
623
 
            except UnicodeEncodeError:
624
 
                # If this chunk cannot be encoded in the local
625
 
                # encoding, then we should leave it alone
626
 
                pass
627
 
            else:
628
 
                # Otherwise take the url decoded one
629
 
                res[i] = decoded
 
808
    for i in range(1, len(res)):
 
809
        res[i] = _unescape_segment_for_display(res[i], encoding)
630
810
    return u'/'.join(res)
631
811
 
632
812
 
641
821
    is used without a path, e.g. c:foo-bar => foo-bar.
642
822
    If no /, path separator or : is found, the from_location is returned.
643
823
    """
 
824
    from_location, unused_params = split_segment_parameters(from_location)
644
825
    if from_location.find("/") >= 0 or from_location.find(os.sep) >= 0:
645
826
        return os.path.basename(from_location.rstrip("/\\"))
646
827
    else:
647
828
        sep = from_location.find(":")
648
829
        if sep > 0:
649
 
            return from_location[sep+1:]
 
830
            return from_location[sep + 1:]
650
831
        else:
651
832
            return from_location
652
833
 
669
850
    old_parsed = urlparse.urlparse(old_base)
670
851
    new_parsed = urlparse.urlparse(new_base)
671
852
    if (old_parsed[:2]) != (new_parsed[:2]):
672
 
        raise errors.InvalidRebaseURLs(old_base, new_base)
 
853
        raise InvalidRebaseURLs(old_base, new_base)
673
854
    return determine_relative_path(new_parsed[2],
674
855
                                   join(old_parsed[2], url))
675
856
 
680
861
    to_segments = osutils.splitpath(to_path)
681
862
    count = -1
682
863
    for count, (from_element, to_element) in enumerate(zip(from_segments,
683
 
                                                       to_segments)):
 
864
                                                           to_segments)):
684
865
        if from_element != to_element:
685
866
            break
686
867
    else:
693
874
    return osutils.pathjoin(*segments)
694
875
 
695
876
 
 
877
class URL(object):
 
878
    """Parsed URL."""
 
879
 
 
880
    def __init__(self, scheme, quoted_user, quoted_password, quoted_host,
 
881
                 port, quoted_path):
 
882
        self.scheme = scheme
 
883
        self.quoted_host = quoted_host
 
884
        self.host = unquote(self.quoted_host)
 
885
        self.quoted_user = quoted_user
 
886
        if self.quoted_user is not None:
 
887
            self.user = unquote(self.quoted_user)
 
888
        else:
 
889
            self.user = None
 
890
        self.quoted_password = quoted_password
 
891
        if self.quoted_password is not None:
 
892
            self.password = unquote(self.quoted_password)
 
893
        else:
 
894
            self.password = None
 
895
        self.port = port
 
896
        self.quoted_path = _url_hex_escapes_re.sub(
 
897
            _unescape_safe_chars, quoted_path)
 
898
        self.path = unquote(self.quoted_path)
 
899
 
 
900
    def __eq__(self, other):
 
901
        return (isinstance(other, self.__class__) and
 
902
                self.scheme == other.scheme and
 
903
                self.host == other.host and
 
904
                self.user == other.user and
 
905
                self.password == other.password and
 
906
                self.path == other.path)
 
907
 
 
908
    def __repr__(self):
 
909
        return "<%s(%r, %r, %r, %r, %r, %r)>" % (
 
910
            self.__class__.__name__,
 
911
            self.scheme, self.quoted_user, self.quoted_password,
 
912
            self.quoted_host, self.port, self.quoted_path)
 
913
 
 
914
    @classmethod
 
915
    def from_string(cls, url):
 
916
        """Create a URL object from a string.
 
917
 
 
918
        :param url: URL as bytestring
 
919
        """
 
920
        # GZ 2017-06-09: Actually validate ascii-ness
 
921
        # pad.lv/1696545: For the moment, accept both native strings and
 
922
        # unicode.
 
923
        if isinstance(url, str):
 
924
            pass
 
925
        elif isinstance(url, text_type):
 
926
            try:
 
927
                url = url.encode()
 
928
            except UnicodeEncodeError:
 
929
                raise InvalidURL(url)
 
930
        else:
 
931
            raise InvalidURL(url)
 
932
        (scheme, netloc, path, params,
 
933
         query, fragment) = urlparse.urlparse(url, allow_fragments=False)
 
934
        user = password = host = port = None
 
935
        if '@' in netloc:
 
936
            user, host = netloc.rsplit('@', 1)
 
937
            if ':' in user:
 
938
                user, password = user.split(':', 1)
 
939
        else:
 
940
            host = netloc
 
941
 
 
942
        if ':' in host and not (host[0] == '[' and host[-1] == ']'):
 
943
            # there *is* port
 
944
            host, port = host.rsplit(':', 1)
 
945
            if port:
 
946
                try:
 
947
                    port = int(port)
 
948
                except ValueError:
 
949
                    raise InvalidURL('invalid port number %s in url:\n%s' %
 
950
                                     (port, url))
 
951
            else:
 
952
                port = None
 
953
        if host != "" and host[0] == '[' and host[-1] == ']':  # IPv6
 
954
            host = host[1:-1]
 
955
 
 
956
        return cls(scheme, user, password, host, port, path)
 
957
 
 
958
    def __str__(self):
 
959
        netloc = self.quoted_host
 
960
        if ":" in netloc:
 
961
            netloc = "[%s]" % netloc
 
962
        if self.quoted_user is not None:
 
963
            # Note that we don't put the password back even if we
 
964
            # have one so that it doesn't get accidentally
 
965
            # exposed.
 
966
            netloc = '%s@%s' % (self.quoted_user, netloc)
 
967
        if self.port is not None:
 
968
            netloc = '%s:%d' % (netloc, self.port)
 
969
        return urlparse.urlunparse(
 
970
            (self.scheme, netloc, self.quoted_path, None, None, None))
 
971
 
 
972
    @staticmethod
 
973
    def _combine_paths(base_path, relpath):
 
974
        """Transform a Transport-relative path to a remote absolute path.
 
975
 
 
976
        This does not handle substitution of ~ but does handle '..' and '.'
 
977
        components.
 
978
 
 
979
        Examples::
 
980
 
 
981
            t._combine_paths('/home/sarah', 'project/foo')
 
982
                => '/home/sarah/project/foo'
 
983
            t._combine_paths('/home/sarah', '../../etc')
 
984
                => '/etc'
 
985
            t._combine_paths('/home/sarah', '/etc')
 
986
                => '/etc'
 
987
 
 
988
        :param base_path: base path
 
989
        :param relpath: relative url string for relative part of remote path.
 
990
        :return: urlencoded string for final path.
 
991
        """
 
992
        # pad.lv/1696545: For the moment, accept both native strings and
 
993
        # unicode.
 
994
        if isinstance(relpath, str):
 
995
            pass
 
996
        elif isinstance(relpath, text_type):
 
997
            try:
 
998
                relpath = relpath.encode()
 
999
            except UnicodeEncodeError:
 
1000
                raise InvalidURL(relpath)
 
1001
        else:
 
1002
            raise InvalidURL(relpath)
 
1003
        relpath = _url_hex_escapes_re.sub(_unescape_safe_chars, relpath)
 
1004
        if relpath.startswith('/'):
 
1005
            base_parts = []
 
1006
        else:
 
1007
            base_parts = base_path.split('/')
 
1008
        if len(base_parts) > 0 and base_parts[-1] == '':
 
1009
            base_parts = base_parts[:-1]
 
1010
        for p in relpath.split('/'):
 
1011
            if p == '..':
 
1012
                if len(base_parts) == 0:
 
1013
                    # In most filesystems, a request for the parent
 
1014
                    # of root, just returns root.
 
1015
                    continue
 
1016
                base_parts.pop()
 
1017
            elif p == '.':
 
1018
                continue  # No-op
 
1019
            elif p != '':
 
1020
                base_parts.append(p)
 
1021
        path = '/'.join(base_parts)
 
1022
        if not path.startswith('/'):
 
1023
            path = '/' + path
 
1024
        return path
 
1025
 
 
1026
    def clone(self, offset=None):
 
1027
        """Return a new URL for a path relative to this URL.
 
1028
 
 
1029
        :param offset: A relative path, already urlencoded
 
1030
        :return: `URL` instance
 
1031
        """
 
1032
        if offset is not None:
 
1033
            relative = unescape(offset)
 
1034
            if sys.version_info[0] == 2:
 
1035
                relative = relative.encode('utf-8')
 
1036
            path = self._combine_paths(self.path, relative)
 
1037
            path = quote(path, safe="/~")
 
1038
        else:
 
1039
            path = self.quoted_path
 
1040
        return self.__class__(self.scheme, self.quoted_user,
 
1041
                              self.quoted_password, self.quoted_host, self.port,
 
1042
                              path)
 
1043
 
696
1044
 
697
1045
def parse_url(url):
698
1046
    """Extract the server address, the credentials and the path from the url.
701
1049
    chars.
702
1050
 
703
1051
    :param url: an quoted url
704
 
 
705
1052
    :return: (scheme, user, password, host, port, path) tuple, all fields
706
1053
        are unquoted.
707
1054
    """
708
 
    if isinstance(url, unicode):
709
 
        raise errors.InvalidURL('should be ascii:\n%r' % url)
710
 
    url = url.encode('utf-8')
711
 
    (scheme, netloc, path, params,
712
 
     query, fragment) = urlparse.urlparse(url, allow_fragments=False)
713
 
    user = password = host = port = None
714
 
    if '@' in netloc:
715
 
        user, host = netloc.rsplit('@', 1)
716
 
        if ':' in user:
717
 
            user, password = user.split(':', 1)
718
 
            password = urllib.unquote(password)
719
 
        user = urllib.unquote(user)
720
 
    else:
721
 
        host = netloc
722
 
 
723
 
    if ':' in host and not (host[0] == '[' and host[-1] == ']'): #there *is* port
724
 
        host, port = host.rsplit(':',1)
725
 
        try:
726
 
            port = int(port)
727
 
        except ValueError:
728
 
            raise errors.InvalidURL('invalid port number %s in url:\n%s' %
729
 
                                    (port, url))
730
 
    if host != "" and host[0] == '[' and host[-1] == ']': #IPv6
731
 
        host = host[1:-1]
732
 
 
733
 
    host = urllib.unquote(host)
734
 
    path = urllib.unquote(path)
735
 
 
736
 
    return (scheme, user, password, host, port, path)
 
1055
    parsed_url = URL.from_string(url)
 
1056
    return (parsed_url.scheme, parsed_url.user, parsed_url.password,
 
1057
            parsed_url.host, parsed_url.port, parsed_url.path)