← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/urlutils.py

  • Committer: Robert Collins
  • Date: 2007-07-04 01:39:50 UTC
  • mto: This revision was merged to the branch mainline in revision 2581.
  • Revision ID: robertc@robertcollins.net-20070704013950-7pp23plwyqjvgkxg
Review feedback.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/urlutils.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Bazaar -- distributed version control
 
2
#
 
3
# Copyright (C) 2006 Canonical Ltd
2
4
#
3
5
# This program is free software; you can redistribute it and/or modify
4
6
# it under the terms of the GNU General Public License as published by
12
14
#
13
15
# You should have received a copy of the GNU General Public License
14
16
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
18
 
17
19
"""A collection of function for handling URL operations."""
18
20
 
24
26
lazy_import(globals(), """
25
27
from posixpath import split as _posix_split, normpath as _posix_normpath
26
28
import urllib
27
 
import urlparse
28
29
 
29
30
from bzrlib import (
30
31
    errors,
66
67
        relpath = relpath.encode('utf-8')
67
68
    # After quoting and encoding, the path should be perfectly
68
69
    # safe as a plain ASCII string, str() just enforces this
69
 
    return str(urllib.quote(relpath, safe='/~'))
 
70
    return str(urllib.quote(relpath))
70
71
 
71
72
 
72
73
def file_relpath(base, path):
73
74
    """Compute just the relative sub-portion of a url
74
 
 
 
75
    
75
76
    This assumes that both paths are already fully specified file:// URLs.
76
77
    """
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))
 
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)
 
81
 
81
82
    base = local_path_from_url(base)
82
83
    path = local_path_from_url(path)
83
84
    return escape(osutils.relpath(base, path))
101
102
    first_path_slash = path.find('/')
102
103
    if first_path_slash == -1:
103
104
        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
 
105
    return len(scheme), first_path_slash+len(scheme)+3
110
106
 
111
107
 
112
108
def join(base, *args):
123
119
    """
124
120
    if not args:
125
121
        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:]
 
122
    match = _url_scheme_re.match(base)
 
123
    scheme = None
 
124
    if match:
 
125
        scheme = match.group('scheme')
 
126
        path = match.group('path').split('/')
 
127
        if path[-1:] == ['']:
 
128
            # Strip off a trailing slash
 
129
            # This helps both when we are at the root, and when
 
130
            # 'base' has an extra slash at the end
 
131
            path = path[:-1]
 
132
    else:
 
133
        path = base.split('/')
 
134
 
 
135
    if scheme is not None and len(path) >= 1:
 
136
        host = path[:1]
 
137
        # the path should be represented as an abs path.
 
138
        # we know this must be absolute because of the presence of a URL scheme.
 
139
        remove_root = True
 
140
        path = [''] + path[1:]
 
141
    else:
 
142
        # create an empty host, but dont alter the path - this might be a
 
143
        # relative url fragment.
 
144
        host = []
 
145
        remove_root = False
 
146
 
132
147
    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
 
148
        match = _url_scheme_re.match(arg)
 
149
        if match:
 
150
            # Absolute URL
 
151
            scheme = match.group('scheme')
 
152
            # this skips .. normalisation, making http://host/../../..
 
153
            # be rather strange.
 
154
            path = match.group('path').split('/')
 
155
            # set the host and path according to new absolute URL, discarding
 
156
            # any previous values.
 
157
            # XXX: duplicates mess from earlier in this function.  This URL
 
158
            # manipulation code needs some cleaning up.
 
159
            if scheme is not None and len(path) >= 1:
 
160
                host = path[:1]
 
161
                path = path[1:]
 
162
                # url scheme implies absolute path.
 
163
                path = [''] + path
 
164
            else:
 
165
                # no url scheme we take the path as is.
 
166
                host = []
143
167
        else:
 
168
            path = '/'.join(path)
144
169
            path = joinpath(path, arg)
145
 
    return base[:path_start] + path
 
170
            path = path.split('/')
 
171
    if remove_root and path[0:1] == ['']:
 
172
        del path[0]
 
173
    if host:
 
174
        # Remove the leading slash from the path, so long as it isn't also the
 
175
        # trailing slash, which we want to keep if present.
 
176
        if path and path[0] == '' and len(path) > 1:
 
177
            del path[0]
 
178
        path = host + path
 
179
 
 
180
    if scheme is None:
 
181
        return '/'.join(path)
 
182
    return scheme + '://' + '/'.join(path)
146
183
 
147
184
 
148
185
def joinpath(base, *args):
149
186
    """Join URL path segments to a URL path segment.
150
 
 
 
187
    
151
188
    This is somewhat like osutils.joinpath, but intended for URLs.
152
189
 
153
190
    XXX: this duplicates some normalisation logic, and also duplicates a lot of
181
218
# jam 20060502 Sorted to 'l' because the final target is 'local_path_from_url'
182
219
def _posix_local_path_from_url(url):
183
220
    """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://'):]
 
221
    if not url.startswith('file:///'):
 
222
        raise errors.InvalidURL(url, 'local urls must start with file:///')
193
223
    # We only strip off 2 slashes
194
 
    return unescape(path)
 
224
    return unescape(url[len('file://'):])
195
225
 
196
226
 
197
227
def _posix_local_path_to_url(path):
199
229
 
200
230
    This also handles transforming escaping unicode characters, etc.
201
231
    """
202
 
    # importing directly from posixpath allows us to test this
 
232
    # importing directly from posixpath allows us to test this 
203
233
    # on non-posix platforms
204
234
    return 'file://' + escape(_posix_normpath(
205
235
        osutils._posix_abspath(path)))
210
240
    if not url.startswith('file://'):
211
241
        raise errors.InvalidURL(url, 'local urls must start with file:///, '
212
242
                                     'UNC path urls must start with file://')
213
 
    url = split_segment_parameters_raw(url)[0]
214
243
    # We strip off all 3 slashes
215
244
    win32_url = url[len('file:'):]
216
245
    # check for UNC path: //HOST/path
220
249
            raise errors.InvalidURL(url, 'Win32 UNC path urls'
221
250
                ' have form file://HOST/path')
222
251
        return unescape(win32_url)
223
 
 
224
 
    # allow empty paths so we can serve all roots
225
 
    if win32_url == '///':
226
 
        return '/'
227
 
 
228
252
    # usual local path with drive letter
229
 
    if (len(win32_url) < 6
230
 
        or win32_url[3] not in ('abcdefghijklmnopqrstuvwxyz'
231
 
                                'ABCDEFGHIJKLMNOPQRSTUVWXYZ')
 
253
    if (win32_url[3] not in ('abcdefghijklmnopqrstuvwxyz'
 
254
                             'ABCDEFGHIJKLMNOPQRSTUVWXYZ')
232
255
        or win32_url[4] not in  '|:'
233
256
        or win32_url[5] != '/'):
234
257
        raise errors.InvalidURL(url, 'Win32 file urls start with'
241
264
 
242
265
    This also handles transforming escaping unicode characters, etc.
243
266
    """
244
 
    # importing directly from ntpath allows us to test this
 
267
    # importing directly from ntpath allows us to test this 
245
268
    # on non-win32 platform
246
269
    # FIXME: It turns out that on nt, ntpath.abspath uses nt._getfullpathname
247
270
    #       which actually strips trailing space characters.
248
 
    #       The worst part is that on linux ntpath.abspath has different
 
271
    #       The worst part is that under linux ntpath.abspath has different
249
272
    #       semantics, since 'nt' is not an available module.
250
 
    if path == '/':
251
 
        return 'file:///'
252
 
 
253
273
    win32_path = osutils._win32_abspath(path)
254
274
    # check for UNC path \\HOST\path
255
275
    if win32_path.startswith('//'):
256
276
        return 'file:' + escape(win32_path)
257
 
    return ('file:///' + str(win32_path[0].upper()) + ':' +
258
 
        escape(win32_path[2:]))
 
277
    return 'file:///' + win32_path[0].upper() + ':' + escape(win32_path[2:])
259
278
 
260
279
 
261
280
local_path_to_url = _posix_local_path_to_url
270
289
    MIN_ABS_FILEURL_LENGTH = WIN32_MIN_ABS_FILEURL_LENGTH
271
290
 
272
291
 
273
 
_url_scheme_re = re.compile(r'^(?P<scheme>[^:/]{2,}):(//)?(?P<path>.*)$')
 
292
_url_scheme_re = re.compile(r'^(?P<scheme>[^:/]{2,})://(?P<path>.*)$')
274
293
_url_hex_escapes_re = re.compile(r'(%[0-9a-fA-F]{2})')
275
294
 
276
295
 
277
296
def _unescape_safe_chars(matchobj):
278
297
    """re.sub callback to convert hex-escapes to plain characters (if safe).
279
 
 
 
298
    
280
299
    e.g. '%7E' will be converted to '~'.
281
300
    """
282
301
    hex_digits = matchobj.group(0)[1:]
289
308
 
290
309
def normalize_url(url):
291
310
    """Make sure that a path string is in fully normalized URL form.
292
 
 
 
311
    
293
312
    This handles URLs which have unicode characters, spaces,
294
313
    special characters, etc.
295
314
 
306
325
    :param url: Either a hybrid URL or a local path
307
326
    :return: A normalized URL which only includes 7-bit ASCII characters.
308
327
    """
309
 
    scheme_end, path_start = _find_scheme_and_separator(url)
310
 
    if scheme_end is None:
 
328
    m = _url_scheme_re.match(url)
 
329
    if not m:
311
330
        return local_path_to_url(url)
312
 
    prefix = url[:path_start]
313
 
    path = url[path_start:]
 
331
    scheme = m.group('scheme')
 
332
    path = m.group('path')
314
333
    if not isinstance(url, unicode):
315
334
        for c in url:
316
335
            if c not in _url_safe_characters:
317
336
                raise errors.InvalidURL(url, 'URLs can only contain specific'
318
337
                                            ' safe characters (not %r)' % c)
319
338
        path = _url_hex_escapes_re.sub(_unescape_safe_chars, path)
320
 
        return str(prefix + ''.join(path))
 
339
        return str(scheme + '://' + ''.join(path))
321
340
 
322
341
    # We have a unicode (hybrid) url
323
342
    path_chars = list(path)
329
348
                ['%%%02X' % ord(c) for c in path_chars[i].encode('utf-8')])
330
349
    path = ''.join(path_chars)
331
350
    path = _url_hex_escapes_re.sub(_unescape_safe_chars, path)
332
 
    return str(prefix + path)
 
351
    return str(scheme + '://' + path)
333
352
 
334
353
 
335
354
def relative_url(base, other):
341
360
    dummy, base_first_slash = _find_scheme_and_separator(base)
342
361
    if base_first_slash is None:
343
362
        return other
344
 
 
 
363
    
345
364
    dummy, other_first_slash = _find_scheme_and_separator(other)
346
365
    if other_first_slash is None:
347
366
        return other
351
370
    other_scheme = other[:other_first_slash]
352
371
    if base_scheme != other_scheme:
353
372
        return other
354
 
    elif sys.platform == 'win32' and base_scheme == 'file://':
355
 
        base_drive = base[base_first_slash+1:base_first_slash+3]
356
 
        other_drive = other[other_first_slash+1:other_first_slash+3]
357
 
        if base_drive != other_drive:
358
 
            return other
359
373
 
360
374
    base_path = base[base_first_slash+1:]
361
375
    other_path = other[other_first_slash+1:]
388
402
    """On win32 the drive letter needs to be added to the url base."""
389
403
    # Strip off the drive letter
390
404
    # path is currently /C:/foo
391
 
    if len(path) < 4 or path[2] not in ':|' or path[3] != '/':
392
 
        raise errors.InvalidURL(url_base + path,
 
405
    if len(path) < 3 or path[2] not in ':|' or path[3] != '/':
 
406
        raise errors.InvalidURL(url_base + path, 
393
407
            'win32 file:/// paths need a drive letter')
394
408
    url_base += path[0:3] # file:// + /C:
395
409
    path = path[3:] # /foo
403
417
    :param exclude_trailing_slash: Strip off a final '/' if it is part
404
418
        of the path (but not if it is part of the protocol specification)
405
419
 
406
 
    :return: (parent_url, child_dir).  child_dir may be the empty string if we're at
 
420
    :return: (parent_url, child_dir).  child_dir may be the empty string if we're at 
407
421
        the root.
408
422
    """
409
423
    scheme_loc, first_path_slash = _find_scheme_and_separator(url)
436
450
    return url_base + head, tail
437
451
 
438
452
 
439
 
def split_segment_parameters_raw(url):
440
 
    """Split the subsegment of the last segment of a URL.
441
 
 
442
 
    :param url: A relative or absolute URL
443
 
    :return: (url, subsegments)
444
 
    """
445
 
    (parent_url, child_dir) = split(url)
446
 
    subsegments = child_dir.split(",")
447
 
    if len(subsegments) == 1:
448
 
        return (url, [])
449
 
    return (join(parent_url, subsegments[0]), subsegments[1:])
450
 
 
451
 
 
452
 
def split_segment_parameters(url):
453
 
    """Split the segment parameters of the last segment of a URL.
454
 
 
455
 
    :param url: A relative or absolute URL
456
 
    :return: (url, segment_parameters)
457
 
    """
458
 
    (base_url, subsegments) = split_segment_parameters_raw(url)
459
 
    parameters = {}
460
 
    for subsegment in subsegments:
461
 
        (key, value) = subsegment.split("=", 1)
462
 
        parameters[key] = value
463
 
    return (base_url, parameters)
464
 
 
465
 
 
466
 
def join_segment_parameters_raw(base, *subsegments):
467
 
    """Create a new URL by adding subsegments to an existing one. 
468
 
 
469
 
    This adds the specified subsegments to the last path in the specified
470
 
    base URL. The subsegments should be bytestrings.
471
 
 
472
 
    :note: You probably want to use join_segment_parameters instead.
473
 
    """
474
 
    if not subsegments:
475
 
        return base
476
 
    for subsegment in subsegments:
477
 
        if type(subsegment) is not str:
478
 
            raise TypeError("Subsegment %r is not a bytestring" % subsegment)
479
 
        if "," in subsegment:
480
 
            raise errors.InvalidURLJoin(", exists in subsegments",
481
 
                                        base, subsegments)
482
 
    return ",".join((base,) + subsegments)
483
 
 
484
 
 
485
 
def join_segment_parameters(url, parameters):
486
 
    """Create a new URL by adding segment parameters to an existing one.
487
 
 
488
 
    The parameters of the last segment in the URL will be updated; if a
489
 
    parameter with the same key already exists it will be overwritten.
490
 
 
491
 
    :param url: A URL, as string
492
 
    :param parameters: Dictionary of parameters, keys and values as bytestrings
493
 
    """
494
 
    (base, existing_parameters) = split_segment_parameters(url)
495
 
    new_parameters = {}
496
 
    new_parameters.update(existing_parameters)
497
 
    for key, value in parameters.iteritems():
498
 
        if type(key) is not str:
499
 
            raise TypeError("parameter key %r is not a bytestring" % key)
500
 
        if type(value) is not str:
501
 
            raise TypeError("parameter value %r for %s is not a bytestring" %
502
 
                (key, value))
503
 
        if "=" in key:
504
 
            raise errors.InvalidURLJoin("= exists in parameter key", url,
505
 
                parameters)
506
 
        new_parameters[key] = value
507
 
    return join_segment_parameters_raw(base, 
508
 
        *["%s=%s" % item for item in sorted(new_parameters.items())])
509
 
 
510
 
 
511
453
def _win32_strip_local_trailing_slash(url):
512
454
    """Strip slashes after the drive letter"""
513
455
    if len(url) > WIN32_MIN_ABS_FILEURL_LENGTH:
585
527
# These are characters that if escaped, should stay that way
586
528
_no_decode_chars = ';/?:@&=+$,#'
587
529
_no_decode_ords = [ord(c) for c in _no_decode_chars]
588
 
_no_decode_hex = (['%02x' % o for o in _no_decode_ords]
 
530
_no_decode_hex = (['%02x' % o for o in _no_decode_ords] 
589
531
                + ['%02X' % o for o in _no_decode_ords])
590
532
_hex_display_map = dict(([('%02x' % o, chr(o)) for o in range(256)]
591
533
                    + [('%02X' % o, chr(o)) for o in range(256)]))
617
559
    This will turn file:// urls into local paths, and try to decode
618
560
    any portions of a http:// style url that it can.
619
561
 
620
 
    Any sections of the URL which can't be represented in the encoding or
 
562
    Any sections of the URL which can't be represented in the encoding or 
621
563
    need to stay as escapes are left alone.
622
564
 
623
565
    :param url: A 7-bit ASCII URL
624
566
    :param encoding: The final output encoding
625
567
 
626
 
    :return: A unicode string which can be safely encoded into the
 
568
    :return: A unicode string which can be safely encoded into the 
627
569
         specified encoding.
628
570
    """
629
 
    if encoding is None:
630
 
        raise ValueError('you cannot specify None for the display encoding')
 
571
    assert encoding is not None, 'you cannot specify None for the display encoding.'
631
572
    if url.startswith('file://'):
632
573
        try:
633
574
            path = local_path_from_url(url)
688
629
            return from_location[sep+1:]
689
630
        else:
690
631
            return from_location
691
 
 
692
 
 
693
 
def _is_absolute(url):
694
 
    return (osutils.pathjoin('/foo', url) == url)
695
 
 
696
 
 
697
 
def rebase_url(url, old_base, new_base):
698
 
    """Convert a relative path from an old base URL to a new base URL.
699
 
 
700
 
    The result will be a relative path.
701
 
    Absolute paths and full URLs are returned unaltered.
702
 
    """
703
 
    scheme, separator = _find_scheme_and_separator(url)
704
 
    if scheme is not None:
705
 
        return url
706
 
    if _is_absolute(url):
707
 
        return url
708
 
    old_parsed = urlparse.urlparse(old_base)
709
 
    new_parsed = urlparse.urlparse(new_base)
710
 
    if (old_parsed[:2]) != (new_parsed[:2]):
711
 
        raise errors.InvalidRebaseURLs(old_base, new_base)
712
 
    return determine_relative_path(new_parsed[2],
713
 
                                   join(old_parsed[2], url))
714
 
 
715
 
 
716
 
def determine_relative_path(from_path, to_path):
717
 
    """Determine a relative path from from_path to to_path."""
718
 
    from_segments = osutils.splitpath(from_path)
719
 
    to_segments = osutils.splitpath(to_path)
720
 
    count = -1
721
 
    for count, (from_element, to_element) in enumerate(zip(from_segments,
722
 
                                                       to_segments)):
723
 
        if from_element != to_element:
724
 
            break
725
 
    else:
726
 
        count += 1
727
 
    unique_from = from_segments[count:]
728
 
    unique_to = to_segments[count:]
729
 
    segments = (['..'] * len(unique_from) + unique_to)
730
 
    if len(segments) == 0:
731
 
        return '.'
732
 
    return osutils.pathjoin(*segments)
733
 
 
734
 
 
735
 
class URL(object):
736
 
    """Parsed URL."""
737
 
 
738
 
    def __init__(self, scheme, quoted_user, quoted_password, quoted_host,
739
 
            port, quoted_path):
740
 
        self.scheme = scheme
741
 
        self.quoted_host = quoted_host
742
 
        self.host = urllib.unquote(self.quoted_host)
743
 
        self.quoted_user = quoted_user
744
 
        if self.quoted_user is not None:
745
 
            self.user = urllib.unquote(self.quoted_user)
746
 
        else:
747
 
            self.user = None
748
 
        self.quoted_password = quoted_password
749
 
        if self.quoted_password is not None:
750
 
            self.password = urllib.unquote(self.quoted_password)
751
 
        else:
752
 
            self.password = None
753
 
        self.port = port
754
 
        self.quoted_path = quoted_path
755
 
        self.path = urllib.unquote(self.quoted_path)
756
 
 
757
 
    def __eq__(self, other):
758
 
        return (isinstance(other, self.__class__) and
759
 
                self.scheme == other.scheme and
760
 
                self.host == other.host and
761
 
                self.user == other.user and
762
 
                self.password == other.password and
763
 
                self.path == other.path)
764
 
 
765
 
    def __repr__(self):
766
 
        return "<%s(%r, %r, %r, %r, %r, %r)>" % (
767
 
            self.__class__.__name__,
768
 
            self.scheme, self.quoted_user, self.quoted_password,
769
 
            self.quoted_host, self.port, self.quoted_path)
770
 
 
771
 
    @classmethod
772
 
    def from_string(cls, url):
773
 
        """Create a URL object from a string.
774
 
 
775
 
        :param url: URL as bytestring
776
 
        """
777
 
        if isinstance(url, unicode):
778
 
            raise errors.InvalidURL('should be ascii:\n%r' % url)
779
 
        url = url.encode('utf-8')
780
 
        (scheme, netloc, path, params,
781
 
         query, fragment) = urlparse.urlparse(url, allow_fragments=False)
782
 
        user = password = host = port = None
783
 
        if '@' in netloc:
784
 
            user, host = netloc.rsplit('@', 1)
785
 
            if ':' in user:
786
 
                user, password = user.split(':', 1)
787
 
        else:
788
 
            host = netloc
789
 
 
790
 
        if ':' in host and not (host[0] == '[' and host[-1] == ']'):
791
 
            # there *is* port
792
 
            host, port = host.rsplit(':',1)
793
 
            try:
794
 
                port = int(port)
795
 
            except ValueError:
796
 
                raise errors.InvalidURL('invalid port number %s in url:\n%s' %
797
 
                                        (port, url))
798
 
        if host != "" and host[0] == '[' and host[-1] == ']': #IPv6
799
 
            host = host[1:-1]
800
 
 
801
 
        return cls(scheme, user, password, host, port, path)
802
 
 
803
 
    def __str__(self):
804
 
        netloc = self.quoted_host
805
 
        if ":" in netloc:
806
 
            netloc = "[%s]" % netloc
807
 
        if self.quoted_user is not None:
808
 
            # Note that we don't put the password back even if we
809
 
            # have one so that it doesn't get accidentally
810
 
            # exposed.
811
 
            netloc = '%s@%s' % (self.quoted_user, netloc)
812
 
        if self.port is not None:
813
 
            netloc = '%s:%d' % (netloc, self.port)
814
 
        return urlparse.urlunparse(
815
 
            (self.scheme, netloc, self.quoted_path, None, None, None))
816
 
 
817
 
    @staticmethod
818
 
    def _combine_paths(base_path, relpath):
819
 
        """Transform a Transport-relative path to a remote absolute path.
820
 
 
821
 
        This does not handle substitution of ~ but does handle '..' and '.'
822
 
        components.
823
 
 
824
 
        Examples::
825
 
 
826
 
            t._combine_paths('/home/sarah', 'project/foo')
827
 
                => '/home/sarah/project/foo'
828
 
            t._combine_paths('/home/sarah', '../../etc')
829
 
                => '/etc'
830
 
            t._combine_paths('/home/sarah', '/etc')
831
 
                => '/etc'
832
 
 
833
 
        :param base_path: base path
834
 
        :param relpath: relative url string for relative part of remote path.
835
 
        :return: urlencoded string for final path.
836
 
        """
837
 
        if not isinstance(relpath, str):
838
 
            raise errors.InvalidURL(relpath)
839
 
        if relpath.startswith('/'):
840
 
            base_parts = []
841
 
        else:
842
 
            base_parts = base_path.split('/')
843
 
        if len(base_parts) > 0 and base_parts[-1] == '':
844
 
            base_parts = base_parts[:-1]
845
 
        for p in relpath.split('/'):
846
 
            if p == '..':
847
 
                if len(base_parts) == 0:
848
 
                    # In most filesystems, a request for the parent
849
 
                    # of root, just returns root.
850
 
                    continue
851
 
                base_parts.pop()
852
 
            elif p == '.':
853
 
                continue # No-op
854
 
            elif p != '':
855
 
                base_parts.append(p)
856
 
        path = '/'.join(base_parts)
857
 
        if not path.startswith('/'):
858
 
            path = '/' + path
859
 
        return path
860
 
 
861
 
    def clone(self, offset=None):
862
 
        """Return a new URL for a path relative to this URL.
863
 
 
864
 
        :param offset: A relative path, already urlencoded
865
 
        :return: `URL` instance
866
 
        """
867
 
        if offset is not None:
868
 
            relative = unescape(offset).encode('utf-8')
869
 
            path = self._combine_paths(self.path, relative)
870
 
            path = urllib.quote(path)
871
 
        else:
872
 
            path = self.quoted_path
873
 
        return self.__class__(self.scheme, self.quoted_user,
874
 
                self.quoted_password, self.quoted_host, self.port,
875
 
                path)
876
 
 
877
 
 
878
 
def parse_url(url):
879
 
    """Extract the server address, the credentials and the path from the url.
880
 
 
881
 
    user, password, host and path should be quoted if they contain reserved
882
 
    chars.
883
 
 
884
 
    :param url: an quoted url
885
 
    :return: (scheme, user, password, host, port, path) tuple, all fields
886
 
        are unquoted.
887
 
    """
888
 
    parsed_url = URL.from_string(url)
889
 
    return (parsed_url.scheme, parsed_url.user, parsed_url.password,
890
 
        parsed_url.host, parsed_url.port, parsed_url.path)