← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/urlutils.py

(jameinel) Allow 'bzr serve' to interpret SIGHUP as a graceful shutdown.
 (bug #795025) (John A Meinel)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/urlutils.py
1
 
# Bazaar -- distributed version control
2
 
#
3
 
# Copyright (C) 2006 Canonical Ltd
 
1
# Copyright (C) 2006-2010 Canonical Ltd
4
2
#
5
3
# This program is free software; you can redistribute it and/or modify
6
4
# it under the terms of the GNU General Public License as published by
14
12
#
15
13
# You should have received a copy of the GNU General Public License
16
14
# along with this program; if not, write to the Free Software
17
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
16
 
19
17
"""A collection of function for handling URL operations."""
20
18
 
68
66
        relpath = relpath.encode('utf-8')
69
67
    # After quoting and encoding, the path should be perfectly
70
68
    # safe as a plain ASCII string, str() just enforces this
71
 
    return str(urllib.quote(relpath))
 
69
    return str(urllib.quote(relpath, safe='/~'))
72
70
 
73
71
 
74
72
def file_relpath(base, path):
75
73
    """Compute just the relative sub-portion of a url
76
 
    
 
74
 
77
75
    This assumes that both paths are already fully specified file:// URLs.
78
76
    """
79
77
    if len(base) < MIN_ABS_FILEURL_LENGTH:
80
 
        raise ValueError('Length of base must be equal or'
 
78
        raise ValueError('Length of base (%r) must equal or'
81
79
            ' exceed the platform minimum url length (which is %d)' %
82
 
            MIN_ABS_FILEURL_LENGTH)
 
80
            (base, MIN_ABS_FILEURL_LENGTH))
83
81
    base = local_path_from_url(base)
84
82
    path = local_path_from_url(path)
85
83
    return escape(osutils.relpath(base, path))
103
101
    first_path_slash = path.find('/')
104
102
    if first_path_slash == -1:
105
103
        return len(scheme), None
106
 
    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
107
110
 
108
111
 
109
112
def join(base, *args):
120
123
    """
121
124
    if not args:
122
125
        return base
123
 
    match = _url_scheme_re.match(base)
124
 
    scheme = None
125
 
    if match:
126
 
        scheme = match.group('scheme')
127
 
        path = match.group('path').split('/')
128
 
        if path[-1:] == ['']:
129
 
            # Strip off a trailing slash
130
 
            # This helps both when we are at the root, and when
131
 
            # 'base' has an extra slash at the end
132
 
            path = path[:-1]
133
 
    else:
134
 
        path = base.split('/')
135
 
 
136
 
    if scheme is not None and len(path) >= 1:
137
 
        host = path[:1]
138
 
        # the path should be represented as an abs path.
139
 
        # we know this must be absolute because of the presence of a URL scheme.
140
 
        remove_root = True
141
 
        path = [''] + path[1:]
142
 
    else:
143
 
        # create an empty host, but dont alter the path - this might be a
144
 
        # relative url fragment.
145
 
        host = []
146
 
        remove_root = False
147
 
 
 
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:]
148
132
    for arg in args:
149
 
        match = _url_scheme_re.match(arg)
150
 
        if match:
151
 
            # Absolute URL
152
 
            scheme = match.group('scheme')
153
 
            # this skips .. normalisation, making http://host/../../..
154
 
            # be rather strange.
155
 
            path = match.group('path').split('/')
156
 
            # set the host and path according to new absolute URL, discarding
157
 
            # any previous values.
158
 
            # XXX: duplicates mess from earlier in this function.  This URL
159
 
            # manipulation code needs some cleaning up.
160
 
            if scheme is not None and len(path) >= 1:
161
 
                host = path[:1]
162
 
                path = path[1:]
163
 
                # url scheme implies absolute path.
164
 
                path = [''] + path
165
 
            else:
166
 
                # no url scheme we take the path as is.
167
 
                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
168
143
        else:
169
 
            path = '/'.join(path)
170
144
            path = joinpath(path, arg)
171
 
            path = path.split('/')
172
 
    if remove_root and path[0:1] == ['']:
173
 
        del path[0]
174
 
    if host:
175
 
        # Remove the leading slash from the path, so long as it isn't also the
176
 
        # trailing slash, which we want to keep if present.
177
 
        if path and path[0] == '' and len(path) > 1:
178
 
            del path[0]
179
 
        path = host + path
180
 
 
181
 
    if scheme is None:
182
 
        return '/'.join(path)
183
 
    return scheme + '://' + '/'.join(path)
 
145
    return base[:path_start] + path
184
146
 
185
147
 
186
148
def joinpath(base, *args):
187
149
    """Join URL path segments to a URL path segment.
188
 
    
 
150
 
189
151
    This is somewhat like osutils.joinpath, but intended for URLs.
190
152
 
191
153
    XXX: this duplicates some normalisation logic, and also duplicates a lot of
219
181
# jam 20060502 Sorted to 'l' because the final target is 'local_path_from_url'
220
182
def _posix_local_path_from_url(url):
221
183
    """Convert a url like file:///path/to/foo into /path/to/foo"""
222
 
    if not url.startswith('file:///'):
223
 
        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://'):]
224
193
    # We only strip off 2 slashes
225
 
    return unescape(url[len('file://'):])
 
194
    return unescape(path)
226
195
 
227
196
 
228
197
def _posix_local_path_to_url(path):
230
199
 
231
200
    This also handles transforming escaping unicode characters, etc.
232
201
    """
233
 
    # importing directly from posixpath allows us to test this 
 
202
    # importing directly from posixpath allows us to test this
234
203
    # on non-posix platforms
235
204
    return 'file://' + escape(_posix_normpath(
236
205
        osutils._posix_abspath(path)))
241
210
    if not url.startswith('file://'):
242
211
        raise errors.InvalidURL(url, 'local urls must start with file:///, '
243
212
                                     'UNC path urls must start with file://')
 
213
    url = split_segment_parameters_raw(url)[0]
244
214
    # We strip off all 3 slashes
245
215
    win32_url = url[len('file:'):]
246
216
    # check for UNC path: //HOST/path
254
224
    # allow empty paths so we can serve all roots
255
225
    if win32_url == '///':
256
226
        return '/'
257
 
    
 
227
 
258
228
    # usual local path with drive letter
259
 
    if (win32_url[3] not in ('abcdefghijklmnopqrstuvwxyz'
260
 
                             'ABCDEFGHIJKLMNOPQRSTUVWXYZ')
 
229
    if (len(win32_url) < 6
 
230
        or win32_url[3] not in ('abcdefghijklmnopqrstuvwxyz'
 
231
                                'ABCDEFGHIJKLMNOPQRSTUVWXYZ')
261
232
        or win32_url[4] not in  '|:'
262
233
        or win32_url[5] != '/'):
263
234
        raise errors.InvalidURL(url, 'Win32 file urls start with'
270
241
 
271
242
    This also handles transforming escaping unicode characters, etc.
272
243
    """
273
 
    # importing directly from ntpath allows us to test this 
 
244
    # importing directly from ntpath allows us to test this
274
245
    # on non-win32 platform
275
246
    # FIXME: It turns out that on nt, ntpath.abspath uses nt._getfullpathname
276
247
    #       which actually strips trailing space characters.
277
 
    #       The worst part is that under linux ntpath.abspath has different
 
248
    #       The worst part is that on linux ntpath.abspath has different
278
249
    #       semantics, since 'nt' is not an available module.
279
250
    if path == '/':
280
251
        return 'file:///'
299
270
    MIN_ABS_FILEURL_LENGTH = WIN32_MIN_ABS_FILEURL_LENGTH
300
271
 
301
272
 
302
 
_url_scheme_re = re.compile(r'^(?P<scheme>[^:/]{2,})://(?P<path>.*)$')
 
273
_url_scheme_re = re.compile(r'^(?P<scheme>[^:/]{2,}):(//)?(?P<path>.*)$')
303
274
_url_hex_escapes_re = re.compile(r'(%[0-9a-fA-F]{2})')
304
275
 
305
276
 
306
277
def _unescape_safe_chars(matchobj):
307
278
    """re.sub callback to convert hex-escapes to plain characters (if safe).
308
 
    
 
279
 
309
280
    e.g. '%7E' will be converted to '~'.
310
281
    """
311
282
    hex_digits = matchobj.group(0)[1:]
318
289
 
319
290
def normalize_url(url):
320
291
    """Make sure that a path string is in fully normalized URL form.
321
 
    
 
292
 
322
293
    This handles URLs which have unicode characters, spaces,
323
294
    special characters, etc.
324
295
 
335
306
    :param url: Either a hybrid URL or a local path
336
307
    :return: A normalized URL which only includes 7-bit ASCII characters.
337
308
    """
338
 
    m = _url_scheme_re.match(url)
339
 
    if not m:
 
309
    scheme_end, path_start = _find_scheme_and_separator(url)
 
310
    if scheme_end is None:
340
311
        return local_path_to_url(url)
341
 
    scheme = m.group('scheme')
342
 
    path = m.group('path')
 
312
    prefix = url[:path_start]
 
313
    path = url[path_start:]
343
314
    if not isinstance(url, unicode):
344
315
        for c in url:
345
316
            if c not in _url_safe_characters:
346
317
                raise errors.InvalidURL(url, 'URLs can only contain specific'
347
318
                                            ' safe characters (not %r)' % c)
348
319
        path = _url_hex_escapes_re.sub(_unescape_safe_chars, path)
349
 
        return str(scheme + '://' + ''.join(path))
 
320
        return str(prefix + ''.join(path))
350
321
 
351
322
    # We have a unicode (hybrid) url
352
323
    path_chars = list(path)
358
329
                ['%%%02X' % ord(c) for c in path_chars[i].encode('utf-8')])
359
330
    path = ''.join(path_chars)
360
331
    path = _url_hex_escapes_re.sub(_unescape_safe_chars, path)
361
 
    return str(scheme + '://' + path)
 
332
    return str(prefix + path)
362
333
 
363
334
 
364
335
def relative_url(base, other):
370
341
    dummy, base_first_slash = _find_scheme_and_separator(base)
371
342
    if base_first_slash is None:
372
343
        return other
373
 
    
 
344
 
374
345
    dummy, other_first_slash = _find_scheme_and_separator(other)
375
346
    if other_first_slash is None:
376
347
        return other
417
388
    """On win32 the drive letter needs to be added to the url base."""
418
389
    # Strip off the drive letter
419
390
    # path is currently /C:/foo
420
 
    if len(path) < 3 or path[2] not in ':|' or path[3] != '/':
421
 
        raise errors.InvalidURL(url_base + path, 
 
391
    if len(path) < 4 or path[2] not in ':|' or path[3] != '/':
 
392
        raise errors.InvalidURL(url_base + path,
422
393
            'win32 file:/// paths need a drive letter')
423
394
    url_base += path[0:3] # file:// + /C:
424
395
    path = path[3:] # /foo
432
403
    :param exclude_trailing_slash: Strip off a final '/' if it is part
433
404
        of the path (but not if it is part of the protocol specification)
434
405
 
435
 
    :return: (parent_url, child_dir).  child_dir may be the empty string if we're at 
 
406
    :return: (parent_url, child_dir).  child_dir may be the empty string if we're at
436
407
        the root.
437
408
    """
438
409
    scheme_loc, first_path_slash = _find_scheme_and_separator(url)
465
436
    return url_base + head, tail
466
437
 
467
438
 
 
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
 
468
511
def _win32_strip_local_trailing_slash(url):
469
512
    """Strip slashes after the drive letter"""
470
513
    if len(url) > WIN32_MIN_ABS_FILEURL_LENGTH:
542
585
# These are characters that if escaped, should stay that way
543
586
_no_decode_chars = ';/?:@&=+$,#'
544
587
_no_decode_ords = [ord(c) for c in _no_decode_chars]
545
 
_no_decode_hex = (['%02x' % o for o in _no_decode_ords] 
 
588
_no_decode_hex = (['%02x' % o for o in _no_decode_ords]
546
589
                + ['%02X' % o for o in _no_decode_ords])
547
590
_hex_display_map = dict(([('%02x' % o, chr(o)) for o in range(256)]
548
591
                    + [('%02X' % o, chr(o)) for o in range(256)]))
574
617
    This will turn file:// urls into local paths, and try to decode
575
618
    any portions of a http:// style url that it can.
576
619
 
577
 
    Any sections of the URL which can't be represented in the encoding or 
 
620
    Any sections of the URL which can't be represented in the encoding or
578
621
    need to stay as escapes are left alone.
579
622
 
580
623
    :param url: A 7-bit ASCII URL
581
624
    :param encoding: The final output encoding
582
625
 
583
 
    :return: A unicode string which can be safely encoded into the 
 
626
    :return: A unicode string which can be safely encoded into the
584
627
         specified encoding.
585
628
    """
586
629
    if encoding is None:
687
730
    if len(segments) == 0:
688
731
        return '.'
689
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)