~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/urlutils.py

  • Committer: Aaron Bentley
  • Date: 2007-03-09 21:46:40 UTC
  • mto: (2323.6.9 0.15-integration)
  • mto: This revision was merged to the branch mainline in revision 2330.
  • Revision ID: abentley@panoramicfeedback.com-20070309214640-nnxk7g37bygoz50c
Add (set|get)_public_branch

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006, 2008 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))
116
117
        join('http://foo', 'bar') => 'http://foo/bar'
117
118
        join('http://foo', 'bar', '../baz') => 'http://foo/baz'
118
119
    """
119
 
    if not args:
120
 
        return base
121
 
    match = _url_scheme_re.match(base)
 
120
    m = _url_scheme_re.match(base)
122
121
    scheme = None
123
 
    if match:
124
 
        scheme = match.group('scheme')
125
 
        path = match.group('path').split('/')
 
122
    if m:
 
123
        scheme = m.group('scheme')
 
124
        path = m.group('path').split('/')
126
125
        if path[-1:] == ['']:
127
126
            # Strip off a trailing slash
128
127
            # This helps both when we are at the root, and when
131
130
    else:
132
131
        path = base.split('/')
133
132
 
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
 
 
146
133
    for arg in args:
147
 
        match = _url_scheme_re.match(arg)
148
 
        if match:
 
134
        m = _url_scheme_re.match(arg)
 
135
        if m:
149
136
            # Absolute URL
150
 
            scheme = match.group('scheme')
 
137
            scheme = m.group('scheme')
151
138
            # this skips .. normalisation, making http://host/../../..
152
139
            # 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 = []
 
140
            path = m.group('path').split('/')
166
141
        else:
167
 
            path = '/'.join(path)
168
 
            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
 
142
            for chunk in arg.split('/'):
 
143
                if chunk == '.':
 
144
                    continue
 
145
                elif chunk == '..':
 
146
                    if len(path) >= 2:
 
147
                        # Don't pop off the host portion
 
148
                        path.pop()
 
149
                    else:
 
150
                        raise errors.InvalidURLJoin('Cannot go above root',
 
151
                                base, args)
 
152
                else:
 
153
                    path.append(chunk)
178
154
 
179
155
    if scheme is None:
180
156
        return '/'.join(path)
181
157
    return scheme + '://' + '/'.join(path)
182
158
 
183
159
 
184
 
def joinpath(base, *args):
185
 
    """Join URL path segments to a URL path segment.
186
 
 
187
 
    This is somewhat like osutils.joinpath, but intended for URLs.
188
 
 
189
 
    XXX: this duplicates some normalisation logic, and also duplicates a lot of
190
 
    path handling logic that already exists in some Transport implementations.
191
 
    We really should try to have exactly one place in the code base responsible
192
 
    for combining paths of URLs.
193
 
    """
194
 
    path = base.split('/')
195
 
    if len(path) > 1 and path[-1] == '':
196
 
        #If the path ends in a trailing /, remove it.
197
 
        path.pop()
198
 
    for arg in args:
199
 
        if arg.startswith('/'):
200
 
            path = []
201
 
        for chunk in arg.split('/'):
202
 
            if chunk == '.':
203
 
                continue
204
 
            elif chunk == '..':
205
 
                if path == ['']:
206
 
                    raise errors.InvalidURLJoin('Cannot go above root',
207
 
                            base, args)
208
 
                path.pop()
209
 
            else:
210
 
                path.append(chunk)
211
 
    if path == ['']:
212
 
        return '/'
213
 
    else:
214
 
        return '/'.join(path)
215
 
 
216
 
 
217
160
# jam 20060502 Sorted to 'l' because the final target is 'local_path_from_url'
218
161
def _posix_local_path_from_url(url):
219
162
    """Convert a url like file:///path/to/foo into /path/to/foo"""
228
171
 
229
172
    This also handles transforming escaping unicode characters, etc.
230
173
    """
231
 
    # importing directly from posixpath allows us to test this
 
174
    # importing directly from posixpath allows us to test this 
232
175
    # on non-posix platforms
233
176
    return 'file://' + escape(_posix_normpath(
234
177
        osutils._posix_abspath(path)))
248
191
            raise errors.InvalidURL(url, 'Win32 UNC path urls'
249
192
                ' have form file://HOST/path')
250
193
        return unescape(win32_url)
251
 
 
252
 
    # allow empty paths so we can serve all roots
253
 
    if win32_url == '///':
254
 
        return '/'
255
 
 
256
194
    # usual local path with drive letter
257
195
    if (win32_url[3] not in ('abcdefghijklmnopqrstuvwxyz'
258
196
                             'ABCDEFGHIJKLMNOPQRSTUVWXYZ')
268
206
 
269
207
    This also handles transforming escaping unicode characters, etc.
270
208
    """
271
 
    # importing directly from ntpath allows us to test this
 
209
    # importing directly from ntpath allows us to test this 
272
210
    # on non-win32 platform
273
211
    # FIXME: It turns out that on nt, ntpath.abspath uses nt._getfullpathname
274
212
    #       which actually strips trailing space characters.
275
213
    #       The worst part is that under linux ntpath.abspath has different
276
214
    #       semantics, since 'nt' is not an available module.
277
 
    if path == '/':
278
 
        return 'file:///'
279
 
 
280
215
    win32_path = osutils._win32_abspath(path)
281
216
    # check for UNC path \\HOST\path
282
217
    if win32_path.startswith('//'):
283
218
        return 'file:' + escape(win32_path)
284
 
    return ('file:///' + str(win32_path[0].upper()) + ':' +
285
 
        escape(win32_path[2:]))
 
219
    return 'file:///' + win32_path[0].upper() + ':' + escape(win32_path[2:])
286
220
 
287
221
 
288
222
local_path_to_url = _posix_local_path_to_url
298
232
 
299
233
 
300
234
_url_scheme_re = re.compile(r'^(?P<scheme>[^:/]{2,})://(?P<path>.*)$')
301
 
_url_hex_escapes_re = re.compile(r'(%[0-9a-fA-F]{2})')
302
 
 
303
 
 
304
 
def _unescape_safe_chars(matchobj):
305
 
    """re.sub callback to convert hex-escapes to plain characters (if safe).
306
 
 
307
 
    e.g. '%7E' will be converted to '~'.
308
 
    """
309
 
    hex_digits = matchobj.group(0)[1:]
310
 
    char = chr(int(hex_digits, 16))
311
 
    if char in _url_dont_escape_characters:
312
 
        return char
313
 
    else:
314
 
        return matchobj.group(0).upper()
315
235
 
316
236
 
317
237
def normalize_url(url):
318
238
    """Make sure that a path string is in fully normalized URL form.
319
 
 
320
 
    This handles URLs which have unicode characters, spaces,
 
239
    
 
240
    This handles URLs which have unicode characters, spaces, 
321
241
    special characters, etc.
322
242
 
323
243
    It has two basic modes of operation, depending on whether the
336
256
    m = _url_scheme_re.match(url)
337
257
    if not m:
338
258
        return local_path_to_url(url)
339
 
    scheme = m.group('scheme')
340
 
    path = m.group('path')
341
259
    if not isinstance(url, unicode):
342
260
        for c in url:
343
261
            if c not in _url_safe_characters:
344
262
                raise errors.InvalidURL(url, 'URLs can only contain specific'
345
263
                                            ' safe characters (not %r)' % c)
346
 
        path = _url_hex_escapes_re.sub(_unescape_safe_chars, path)
347
 
        return str(scheme + '://' + ''.join(path))
348
 
 
 
264
        return url
349
265
    # We have a unicode (hybrid) url
350
 
    path_chars = list(path)
 
266
    scheme = m.group('scheme')
 
267
    path = list(m.group('path'))
351
268
 
352
 
    for i in xrange(len(path_chars)):
353
 
        if path_chars[i] not in _url_safe_characters:
354
 
            chars = path_chars[i].encode('utf-8')
355
 
            path_chars[i] = ''.join(
356
 
                ['%%%02X' % ord(c) for c in path_chars[i].encode('utf-8')])
357
 
    path = ''.join(path_chars)
358
 
    path = _url_hex_escapes_re.sub(_unescape_safe_chars, path)
359
 
    return str(scheme + '://' + path)
 
269
    for i in xrange(len(path)):
 
270
        if path[i] not in _url_safe_characters:
 
271
            chars = path[i].encode('utf-8')
 
272
            path[i] = ''.join(['%%%02X' % ord(c) for c in path[i].encode('utf-8')])
 
273
    return str(scheme + '://' + ''.join(path))
360
274
 
361
275
 
362
276
def relative_url(base, other):
368
282
    dummy, base_first_slash = _find_scheme_and_separator(base)
369
283
    if base_first_slash is None:
370
284
        return other
371
 
 
 
285
    
372
286
    dummy, other_first_slash = _find_scheme_and_separator(other)
373
287
    if other_first_slash is None:
374
288
        return other
378
292
    other_scheme = other[:other_first_slash]
379
293
    if base_scheme != other_scheme:
380
294
        return other
381
 
    elif sys.platform == 'win32' and base_scheme == 'file://':
382
 
        base_drive = base[base_first_slash+1:base_first_slash+3]
383
 
        other_drive = other[other_first_slash+1:other_first_slash+3]
384
 
        if base_drive != other_drive:
385
 
            return other
386
295
 
387
296
    base_path = base[base_first_slash+1:]
388
297
    other_path = other[other_first_slash+1:]
416
325
    # Strip off the drive letter
417
326
    # path is currently /C:/foo
418
327
    if len(path) < 3 or path[2] not in ':|' or path[3] != '/':
419
 
        raise errors.InvalidURL(url_base + path,
 
328
        raise errors.InvalidURL(url_base + path, 
420
329
            'win32 file:/// paths need a drive letter')
421
330
    url_base += path[0:3] # file:// + /C:
422
331
    path = path[3:] # /foo
430
339
    :param exclude_trailing_slash: Strip off a final '/' if it is part
431
340
        of the path (but not if it is part of the protocol specification)
432
341
 
433
 
    :return: (parent_url, child_dir).  child_dir may be the empty string if we're at
 
342
    :return: (parent_url, child_dir).  child_dir may be the empty string if we're at 
434
343
        the root.
435
344
    """
436
345
    scheme_loc, first_path_slash = _find_scheme_and_separator(url)
540
449
# These are characters that if escaped, should stay that way
541
450
_no_decode_chars = ';/?:@&=+$,#'
542
451
_no_decode_ords = [ord(c) for c in _no_decode_chars]
543
 
_no_decode_hex = (['%02x' % o for o in _no_decode_ords]
 
452
_no_decode_hex = (['%02x' % o for o in _no_decode_ords] 
544
453
                + ['%02X' % o for o in _no_decode_ords])
545
454
_hex_display_map = dict(([('%02x' % o, chr(o)) for o in range(256)]
546
455
                    + [('%02X' % o, chr(o)) for o in range(256)]))
547
456
#These entries get mapped to themselves
548
457
_hex_display_map.update((hex,'%'+hex) for hex in _no_decode_hex)
549
458
 
550
 
# These characters shouldn't be percent-encoded, and it's always safe to
551
 
# unencode them if they are.
552
 
_url_dont_escape_characters = set(
553
 
   "abcdefghijklmnopqrstuvwxyz" # Lowercase alpha
554
 
   "ABCDEFGHIJKLMNOPQRSTUVWXYZ" # Uppercase alpha
555
 
   "0123456789" # Numbers
556
 
   "-._~"  # Unreserved characters
557
 
)
558
 
 
559
459
# These characters should not be escaped
560
460
_url_safe_characters = set(
561
461
   "abcdefghijklmnopqrstuvwxyz" # Lowercase alpha
572
472
    This will turn file:// urls into local paths, and try to decode
573
473
    any portions of a http:// style url that it can.
574
474
 
575
 
    Any sections of the URL which can't be represented in the encoding or
 
475
    Any sections of the URL which can't be represented in the encoding or 
576
476
    need to stay as escapes are left alone.
577
477
 
578
478
    :param url: A 7-bit ASCII URL
579
479
    :param encoding: The final output encoding
580
480
 
581
 
    :return: A unicode string which can be safely encoded into the
 
481
    :return: A unicode string which can be safely encoded into the 
582
482
         specified encoding.
583
483
    """
584
 
    if encoding is None:
585
 
        raise ValueError('you cannot specify None for the display encoding')
 
484
    assert encoding is not None, 'you cannot specify None for the display encoding.'
586
485
    if url.startswith('file://'):
587
486
        try:
588
487
            path = local_path_from_url(url)
622
521
                # Otherwise take the url decoded one
623
522
                res[i] = decoded
624
523
    return u'/'.join(res)
625
 
 
626
 
 
627
 
def derive_to_location(from_location):
628
 
    """Derive a TO_LOCATION given a FROM_LOCATION.
629
 
 
630
 
    The normal case is a FROM_LOCATION of http://foo/bar => bar.
631
 
    The Right Thing for some logical destinations may differ though
632
 
    because no / may be present at all. In that case, the result is
633
 
    the full name without the scheme indicator, e.g. lp:foo-bar => foo-bar.
634
 
    This latter case also applies when a Windows drive
635
 
    is used without a path, e.g. c:foo-bar => foo-bar.
636
 
    If no /, path separator or : is found, the from_location is returned.
637
 
    """
638
 
    if from_location.find("/") >= 0 or from_location.find(os.sep) >= 0:
639
 
        return os.path.basename(from_location.rstrip("/\\"))
640
 
    else:
641
 
        sep = from_location.find(":")
642
 
        if sep > 0:
643
 
            return from_location[sep+1:]
644
 
        else:
645
 
            return from_location
646
 
 
647
 
 
648
 
def _is_absolute(url):
649
 
    return (osutils.pathjoin('/foo', url) == url)
650
 
 
651
 
 
652
 
def rebase_url(url, old_base, new_base):
653
 
    """Convert a relative path from an old base URL to a new base URL.
654
 
 
655
 
    The result will be a relative path.
656
 
    Absolute paths and full URLs are returned unaltered.
657
 
    """
658
 
    scheme, separator = _find_scheme_and_separator(url)
659
 
    if scheme is not None:
660
 
        return url
661
 
    if _is_absolute(url):
662
 
        return url
663
 
    old_parsed = urlparse.urlparse(old_base)
664
 
    new_parsed = urlparse.urlparse(new_base)
665
 
    if (old_parsed[:2]) != (new_parsed[:2]):
666
 
        raise errors.InvalidRebaseURLs(old_base, new_base)
667
 
    return determine_relative_path(new_parsed[2],
668
 
                                   join(old_parsed[2], url))
669
 
 
670
 
 
671
 
def determine_relative_path(from_path, to_path):
672
 
    """Determine a relative path from from_path to to_path."""
673
 
    from_segments = osutils.splitpath(from_path)
674
 
    to_segments = osutils.splitpath(to_path)
675
 
    count = -1
676
 
    for count, (from_element, to_element) in enumerate(zip(from_segments,
677
 
                                                       to_segments)):
678
 
        if from_element != to_element:
679
 
            break
680
 
    else:
681
 
        count += 1
682
 
    unique_from = from_segments[count:]
683
 
    unique_to = to_segments[count:]
684
 
    segments = (['..'] * len(unique_from) + unique_to)
685
 
    if len(segments) == 0:
686
 
        return '.'
687
 
    return osutils.pathjoin(*segments)
688
 
 
689
 
 
690
 
 
691
 
def parse_url(url):
692
 
    """Extract the server address, the credentials and the path from the url.
693
 
 
694
 
    user, password, host and path should be quoted if they contain reserved
695
 
    chars.
696
 
 
697
 
    :param url: an quoted url
698
 
 
699
 
    :return: (scheme, user, password, host, port, path) tuple, all fields
700
 
        are unquoted.
701
 
    """
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)