~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/urlutils.py

  • Committer: Jelmer Vernooij
  • Date: 2011-10-14 13:56:45 UTC
  • mfrom: (6215 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6216.
  • Revision ID: jelmer@samba.org-20111014135645-phc3q3y21k2ks0s2
Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006, 2008 Canonical Ltd
 
1
# Copyright (C) 2006-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
22
22
 
23
23
from bzrlib.lazy_import import lazy_import
24
24
lazy_import(globals(), """
25
 
from posixpath import split as _posix_split, normpath as _posix_normpath
 
25
from posixpath import split as _posix_split
26
26
import urllib
27
27
import urlparse
28
28
 
101
101
    first_path_slash = path.find('/')
102
102
    if first_path_slash == -1:
103
103
        return len(scheme), None
104
 
    return len(scheme), first_path_slash+len(scheme)+3
 
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
110
 
106
111
 
107
112
def join(base, *args):
118
123
    """
119
124
    if not args:
120
125
        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
 
 
 
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:]
146
132
    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 = []
 
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
166
143
        else:
167
 
            path = '/'.join(path)
168
144
            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)
 
145
    return base[:path_start] + path
182
146
 
183
147
 
184
148
def joinpath(base, *args):
217
181
# jam 20060502 Sorted to 'l' because the final target is 'local_path_from_url'
218
182
def _posix_local_path_from_url(url):
219
183
    """Convert a url like file:///path/to/foo into /path/to/foo"""
220
 
    if not url.startswith('file:///'):
221
 
        raise errors.InvalidURL(url, 'local urls must start with file:///')
 
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://'):]
222
193
    # We only strip off 2 slashes
223
 
    return unescape(url[len('file://'):])
 
194
    return unescape(path)
224
195
 
225
196
 
226
197
def _posix_local_path_to_url(path):
230
201
    """
231
202
    # importing directly from posixpath allows us to test this
232
203
    # on non-posix platforms
233
 
    return 'file://' + escape(_posix_normpath(
234
 
        osutils._posix_abspath(path)))
 
204
    return 'file://' + escape(osutils._posix_abspath(path))
235
205
 
236
206
 
237
207
def _win32_local_path_from_url(url):
239
209
    if not url.startswith('file://'):
240
210
        raise errors.InvalidURL(url, 'local urls must start with file:///, '
241
211
                                     'UNC path urls must start with file://')
 
212
    url = split_segment_parameters_raw(url)[0]
242
213
    # We strip off all 3 slashes
243
214
    win32_url = url[len('file:'):]
244
215
    # check for UNC path: //HOST/path
254
225
        return '/'
255
226
 
256
227
    # usual local path with drive letter
257
 
    if (win32_url[3] not in ('abcdefghijklmnopqrstuvwxyz'
258
 
                             'ABCDEFGHIJKLMNOPQRSTUVWXYZ')
 
228
    if (len(win32_url) < 6
 
229
        or win32_url[3] not in ('abcdefghijklmnopqrstuvwxyz'
 
230
                                'ABCDEFGHIJKLMNOPQRSTUVWXYZ')
259
231
        or win32_url[4] not in  '|:'
260
232
        or win32_url[5] != '/'):
261
233
        raise errors.InvalidURL(url, 'Win32 file urls start with'
272
244
    # on non-win32 platform
273
245
    # FIXME: It turns out that on nt, ntpath.abspath uses nt._getfullpathname
274
246
    #       which actually strips trailing space characters.
275
 
    #       The worst part is that under linux ntpath.abspath has different
 
247
    #       The worst part is that on linux ntpath.abspath has different
276
248
    #       semantics, since 'nt' is not an available module.
277
249
    if path == '/':
278
250
        return 'file:///'
297
269
    MIN_ABS_FILEURL_LENGTH = WIN32_MIN_ABS_FILEURL_LENGTH
298
270
 
299
271
 
300
 
_url_scheme_re = re.compile(r'^(?P<scheme>[^:/]{2,})://(?P<path>.*)$')
 
272
_url_scheme_re = re.compile(r'^(?P<scheme>[^:/]{2,}):(//)?(?P<path>.*)$')
301
273
_url_hex_escapes_re = re.compile(r'(%[0-9a-fA-F]{2})')
302
274
 
303
275
 
333
305
    :param url: Either a hybrid URL or a local path
334
306
    :return: A normalized URL which only includes 7-bit ASCII characters.
335
307
    """
336
 
    m = _url_scheme_re.match(url)
337
 
    if not m:
 
308
    scheme_end, path_start = _find_scheme_and_separator(url)
 
309
    if scheme_end is None:
338
310
        return local_path_to_url(url)
339
 
    scheme = m.group('scheme')
340
 
    path = m.group('path')
 
311
    prefix = url[:path_start]
 
312
    path = url[path_start:]
341
313
    if not isinstance(url, unicode):
342
314
        for c in url:
343
315
            if c not in _url_safe_characters:
344
316
                raise errors.InvalidURL(url, 'URLs can only contain specific'
345
317
                                            ' safe characters (not %r)' % c)
346
318
        path = _url_hex_escapes_re.sub(_unescape_safe_chars, path)
347
 
        return str(scheme + '://' + ''.join(path))
 
319
        return str(prefix + ''.join(path))
348
320
 
349
321
    # We have a unicode (hybrid) url
350
322
    path_chars = list(path)
356
328
                ['%%%02X' % ord(c) for c in path_chars[i].encode('utf-8')])
357
329
    path = ''.join(path_chars)
358
330
    path = _url_hex_escapes_re.sub(_unescape_safe_chars, path)
359
 
    return str(scheme + '://' + path)
 
331
    return str(prefix + path)
360
332
 
361
333
 
362
334
def relative_url(base, other):
415
387
    """On win32 the drive letter needs to be added to the url base."""
416
388
    # Strip off the drive letter
417
389
    # path is currently /C:/foo
418
 
    if len(path) < 3 or path[2] not in ':|' or path[3] != '/':
 
390
    if len(path) < 4 or path[2] not in ':|' or path[3] != '/':
419
391
        raise errors.InvalidURL(url_base + path,
420
392
            'win32 file:/// paths need a drive letter')
421
393
    url_base += path[0:3] # file:// + /C:
463
435
    return url_base + head, tail
464
436
 
465
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
 
466
510
def _win32_strip_local_trailing_slash(url):
467
511
    """Strip slashes after the drive letter"""
468
512
    if len(url) > WIN32_MIN_ABS_FILEURL_LENGTH:
687
731
    return osutils.pathjoin(*segments)
688
732
 
689
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
 
690
876
 
691
877
def parse_url(url):
692
878
    """Extract the server address, the credentials and the path from the url.
695
881
    chars.
696
882
 
697
883
    :param url: an quoted url
698
 
 
699
884
    :return: (scheme, user, password, host, port, path) tuple, all fields
700
885
        are unquoted.
701
886
    """
702
 
    if isinstance(url, unicode):
703
 
        raise errors.InvalidURL('should be ascii:\n%r' % url)
704
 
    url = url.encode('utf-8')
705
 
    (scheme, netloc, path, params,
706
 
     query, fragment) = urlparse.urlparse(url, allow_fragments=False)
707
 
    user = password = host = port = None
708
 
    if '@' in netloc:
709
 
        user, host = netloc.rsplit('@', 1)
710
 
        if ':' in user:
711
 
            user, password = user.split(':', 1)
712
 
            password = urllib.unquote(password)
713
 
        user = urllib.unquote(user)
714
 
    else:
715
 
        host = netloc
716
 
 
717
 
    if ':' in host and not (host[0] == '[' and host[-1] == ']'): #there *is* port
718
 
        host, port = host.rsplit(':',1)
719
 
        try:
720
 
            port = int(port)
721
 
        except ValueError:
722
 
            raise errors.InvalidURL('invalid port number %s in url:\n%s' %
723
 
                                    (port, url))
724
 
    if host != "" and host[0] == '[' and host[-1] == ']': #IPv6
725
 
        host = host[1:-1]
726
 
 
727
 
    host = urllib.unquote(host)
728
 
    path = urllib.unquote(path)
729
 
 
730
 
    return (scheme, user, password, host, port, path)
 
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)