← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/urlutils.py

  • Committer: Jelmer Vernooij
  • Date: 2011-12-29 21:05:11 UTC
  • mto: This revision was merged to the branch mainline in revision 6406.
  • Revision ID: jelmer@samba.org-20111229210511-2hfcqpkn001cwzn1
Fix 'bzr shell-complete' and add a really basic test for it.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/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
25
from bzrlib.lazy_import import lazy_import
24
26
lazy_import(globals(), """
25
 
from posixpath import split as _posix_split, normpath as _posix_normpath
26
 
import urllib
 
27
from posixpath import split as _posix_split
27
28
import urlparse
28
29
 
29
30
from bzrlib import (
60
61
    return split(url, exclude_trailing_slash=exclude_trailing_slash)[0]
61
62
 
62
63
 
 
64
# Private copies of quote and unquote, copied from Python's
 
65
# urllib module because urllib unconditionally imports socket, which imports
 
66
# ssl.
 
67
 
 
68
always_safe = ('ABCDEFGHIJKLMNOPQRSTUVWXYZ'
 
69
               'abcdefghijklmnopqrstuvwxyz'
 
70
               '0123456789' '_.-')
 
71
_safe_map = {}
 
72
for i, c in zip(xrange(256), str(bytearray(xrange(256)))):
 
73
    _safe_map[c] = c if (i < 128 and c in always_safe) else '%{0:02X}'.format(i)
 
74
_safe_quoters = {}
 
75
 
 
76
 
 
77
def quote(s, safe='/'):
 
78
    """quote('abc def') -> 'abc%20def'
 
79
 
 
80
    Each part of a URL, e.g. the path info, the query, etc., has a
 
81
    different set of reserved characters that must be quoted.
 
82
 
 
83
    RFC 2396 Uniform Resource Identifiers (URI): Generic Syntax lists
 
84
    the following reserved characters.
 
85
 
 
86
    reserved    = ";" | "/" | "?" | ":" | "@" | "&" | "=" | "+" |
 
87
                  "$" | ","
 
88
 
 
89
    Each of these characters is reserved in some component of a URL,
 
90
    but not necessarily in all of them.
 
91
 
 
92
    By default, the quote function is intended for quoting the path
 
93
    section of a URL.  Thus, it will not encode '/'.  This character
 
94
    is reserved, but in typical usage the quote function is being
 
95
    called on a path where the existing slash characters are used as
 
96
    reserved characters.
 
97
    """
 
98
    # fastpath
 
99
    if not s:
 
100
        if s is None:
 
101
            raise TypeError('None object cannot be quoted')
 
102
        return s
 
103
    cachekey = (safe, always_safe)
 
104
    try:
 
105
        (quoter, safe) = _safe_quoters[cachekey]
 
106
    except KeyError:
 
107
        safe_map = _safe_map.copy()
 
108
        safe_map.update([(c, c) for c in safe])
 
109
        quoter = safe_map.__getitem__
 
110
        safe = always_safe + safe
 
111
        _safe_quoters[cachekey] = (quoter, safe)
 
112
    if not s.rstrip(safe):
 
113
        return s
 
114
    return ''.join(map(quoter, s))
 
115
 
 
116
 
 
117
_hexdig = '0123456789ABCDEFabcdef'
 
118
_hextochr = dict((a + b, chr(int(a + b, 16)))
 
119
                 for a in _hexdig for b in _hexdig)
 
120
 
 
121
def unquote(s):
 
122
    """unquote('abc%20def') -> 'abc def'."""
 
123
    res = s.split('%')
 
124
    # fastpath
 
125
    if len(res) == 1:
 
126
        return s
 
127
    s = res[0]
 
128
    for item in res[1:]:
 
129
        try:
 
130
            s += _hextochr[item[:2]] + item[2:]
 
131
        except KeyError:
 
132
            s += '%' + item
 
133
        except UnicodeDecodeError:
 
134
            s += unichr(int(item[:2], 16)) + item[2:]
 
135
    return s
 
136
 
 
137
 
63
138
def escape(relpath):
64
139
    """Escape relpath to be a valid url."""
65
140
    if isinstance(relpath, unicode):
66
141
        relpath = relpath.encode('utf-8')
67
142
    # After quoting and encoding, the path should be perfectly
68
143
    # safe as a plain ASCII string, str() just enforces this
69
 
    return str(urllib.quote(relpath, safe='/~'))
 
144
    return str(quote(relpath, safe='/~'))
70
145
 
71
146
 
72
147
def file_relpath(base, path):
78
153
        raise ValueError('Length of base (%r) must equal or'
79
154
            ' exceed the platform minimum url length (which is %d)' %
80
155
            (base, MIN_ABS_FILEURL_LENGTH))
81
 
    base = local_path_from_url(base)
82
 
    path = local_path_from_url(path)
 
156
    base = osutils.normpath(local_path_from_url(base))
 
157
    path = osutils.normpath(local_path_from_url(path))
83
158
    return escape(osutils.relpath(base, path))
84
159
 
85
160
 
201
276
    """
202
277
    # importing directly from posixpath allows us to test this
203
278
    # on non-posix platforms
204
 
    return 'file://' + escape(_posix_normpath(
205
 
        osutils._posix_abspath(path)))
 
279
    return 'file://' + escape(osutils._posix_abspath(path))
206
280
 
207
281
 
208
282
def _win32_local_path_from_url(url):
388
462
    """On win32 the drive letter needs to be added to the url base."""
389
463
    # Strip off the drive letter
390
464
    # path is currently /C:/foo
391
 
    if len(path) < 3 or path[2] not in ':|' or path[3] != '/':
 
465
    if len(path) < 4 or path[2] not in ':|' or path[3] != '/':
392
466
        raise errors.InvalidURL(url_base + path,
393
467
            'win32 file:/// paths need a drive letter')
394
468
    url_base += path[0:3] # file:// + /C:
442
516
    :param url: A relative or absolute URL
443
517
    :return: (url, subsegments)
444
518
    """
445
 
    (parent_url, child_dir) = split(url)
446
 
    subsegments = child_dir.split(",")
447
 
    if len(subsegments) == 1:
 
519
    # GZ 2011-11-18: Dodgy removing the terminal slash like this, function
 
520
    #                operates on urls not url+segments, and Transport classes
 
521
    #                should not be blindly adding slashes in the first place. 
 
522
    lurl = strip_trailing_slash(url)
 
523
    # Segments begin at first comma after last forward slash, if one exists
 
524
    segment_start = lurl.find(",", lurl.rfind("/")+1)
 
525
    if segment_start == -1:
448
526
        return (url, [])
449
 
    return (join(parent_url, subsegments[0]), subsegments[1:])
 
527
    return (lurl[:segment_start], lurl[segment_start+1:].split(","))
450
528
 
451
529
 
452
530
def split_segment_parameters(url):
563
641
    This returns a Unicode path from a URL
564
642
    """
565
643
    # jam 20060427 URLs are supposed to be ASCII only strings
566
 
    #       If they are passed in as unicode, urllib.unquote
 
644
    #       If they are passed in as unicode, unquote
567
645
    #       will return a UNICODE string, which actually contains
568
646
    #       utf-8 bytes. So we have to ensure that they are
569
647
    #       plain ASCII strings, or the final .decode will
574
652
    except UnicodeError, e:
575
653
        raise errors.InvalidURL(url, 'URL was not a plain ASCII url: %s' % (e,))
576
654
 
577
 
    unquoted = urllib.unquote(url)
 
655
    unquoted = unquote(url)
578
656
    try:
579
657
        unicode_path = unquoted.decode('utf-8')
580
658
    except UnicodeError, e:
739
817
            port, quoted_path):
740
818
        self.scheme = scheme
741
819
        self.quoted_host = quoted_host
742
 
        self.host = urllib.unquote(self.quoted_host)
 
820
        self.host = unquote(self.quoted_host)
743
821
        self.quoted_user = quoted_user
744
822
        if self.quoted_user is not None:
745
 
            self.user = urllib.unquote(self.quoted_user)
 
823
            self.user = unquote(self.quoted_user)
746
824
        else:
747
825
            self.user = None
748
826
        self.quoted_password = quoted_password
749
827
        if self.quoted_password is not None:
750
 
            self.password = urllib.unquote(self.quoted_password)
 
828
            self.password = unquote(self.quoted_password)
751
829
        else:
752
830
            self.password = None
753
831
        self.port = port
754
 
        self.quoted_path = quoted_path
755
 
        self.path = urllib.unquote(self.quoted_path)
 
832
        self.quoted_path = _url_hex_escapes_re.sub(_unescape_safe_chars, quoted_path)
 
833
        self.path = unquote(self.quoted_path)
756
834
 
757
835
    def __eq__(self, other):
758
836
        return (isinstance(other, self.__class__) and
836
914
        """
837
915
        if not isinstance(relpath, str):
838
916
            raise errors.InvalidURL(relpath)
 
917
        relpath = _url_hex_escapes_re.sub(_unescape_safe_chars, relpath)
839
918
        if relpath.startswith('/'):
840
919
            base_parts = []
841
920
        else:
867
946
        if offset is not None:
868
947
            relative = unescape(offset).encode('utf-8')
869
948
            path = self._combine_paths(self.path, relative)
870
 
            path = urllib.quote(path)
 
949
            path = quote(path, safe="/~")
871
950
        else:
872
951
            path = self.quoted_path
873
952
        return self.__class__(self.scheme, self.quoted_user,