~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/urlutils.py

  • Committer: John Arbash Meinel
  • Date: 2006-11-10 15:38:16 UTC
  • mto: This revision was merged to the branch mainline in revision 2129.
  • Revision ID: john@arbash-meinel.com-20061110153816-46acf76fc86a512b
use try/finally to clean up a nested progress bar during weave fetching

Show diffs side-by-side

added added

removed removed

Lines of Context:
117
117
        join('http://foo', 'bar') => 'http://foo/bar'
118
118
        join('http://foo', 'bar', '../baz') => 'http://foo/baz'
119
119
    """
120
 
    if not args:
121
 
        return base
122
 
    match = _url_scheme_re.match(base)
 
120
    m = _url_scheme_re.match(base)
123
121
    scheme = None
124
 
    if match:
125
 
        scheme = match.group('scheme')
126
 
        path = match.group('path').split('/')
 
122
    if m:
 
123
        scheme = m.group('scheme')
 
124
        path = m.group('path').split('/')
127
125
        if path[-1:] == ['']:
128
126
            # Strip off a trailing slash
129
127
            # This helps both when we are at the root, and when
132
130
    else:
133
131
        path = base.split('/')
134
132
 
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
 
 
147
133
    for arg in args:
148
 
        match = _url_scheme_re.match(arg)
149
 
        if match:
 
134
        m = _url_scheme_re.match(arg)
 
135
        if m:
150
136
            # Absolute URL
151
 
            scheme = match.group('scheme')
 
137
            scheme = m.group('scheme')
152
138
            # this skips .. normalisation, making http://host/../../..
153
139
            # 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 = []
 
140
            path = m.group('path').split('/')
167
141
        else:
168
 
            path = '/'.join(path)
169
 
            path = joinpath(path, arg)
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
 
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)
179
154
 
180
155
    if scheme is None:
181
156
        return '/'.join(path)
182
157
    return scheme + '://' + '/'.join(path)
183
158
 
184
159
 
185
 
def joinpath(base, *args):
186
 
    """Join URL path segments to a URL path segment.
187
 
    
188
 
    This is somewhat like osutils.joinpath, but intended for URLs.
189
 
 
190
 
    XXX: this duplicates some normalisation logic, and also duplicates a lot of
191
 
    path handling logic that already exists in some Transport implementations.
192
 
    We really should try to have exactly one place in the code base responsible
193
 
    for combining paths of URLs.
194
 
    """
195
 
    path = base.split('/')
196
 
    if len(path) > 1 and path[-1] == '':
197
 
        #If the path ends in a trailing /, remove it.
198
 
        path.pop()
199
 
    for arg in args:
200
 
        if arg.startswith('/'):
201
 
            path = []
202
 
        for chunk in arg.split('/'):
203
 
            if chunk == '.':
204
 
                continue
205
 
            elif chunk == '..':
206
 
                if path == ['']:
207
 
                    raise errors.InvalidURLJoin('Cannot go above root',
208
 
                            base, args)
209
 
                path.pop()
210
 
            else:
211
 
                path.append(chunk)
212
 
    if path == ['']:
213
 
        return '/'
214
 
    else:
215
 
        return '/'.join(path)
216
 
 
217
 
 
218
160
# jam 20060502 Sorted to 'l' because the final target is 'local_path_from_url'
219
161
def _posix_local_path_from_url(url):
220
162
    """Convert a url like file:///path/to/foo into /path/to/foo"""
237
179
 
238
180
def _win32_local_path_from_url(url):
239
181
    """Convert a url like file:///C:/path/to/foo into C:/path/to/foo"""
240
 
    if not url.startswith('file://'):
241
 
        raise errors.InvalidURL(url, 'local urls must start with file:///, '
242
 
                                     'UNC path urls must start with file://')
 
182
    if not url.startswith('file:///'):
 
183
        raise errors.InvalidURL(url, 'local urls must start with file:///')
243
184
    # We strip off all 3 slashes
244
 
    win32_url = url[len('file:'):]
245
 
    # check for UNC path: //HOST/path
246
 
    if not win32_url.startswith('///'):
247
 
        if (win32_url[2] == '/'
248
 
            or win32_url[3] in '|:'):
249
 
            raise errors.InvalidURL(url, 'Win32 UNC path urls'
250
 
                ' have form file://HOST/path')
251
 
        return unescape(win32_url)
252
 
    # usual local path with drive letter
253
 
    if (win32_url[3] not in ('abcdefghijklmnopqrstuvwxyz'
 
185
    win32_url = url[len('file:///'):]
 
186
    if (win32_url[0] not in ('abcdefghijklmnopqrstuvwxyz'
254
187
                             'ABCDEFGHIJKLMNOPQRSTUVWXYZ')
255
 
        or win32_url[4] not in  '|:'
256
 
        or win32_url[5] != '/'):
 
188
        or win32_url[1] not in  '|:'
 
189
        or win32_url[2] != '/'):
257
190
        raise errors.InvalidURL(url, 'Win32 file urls start with'
258
191
                ' file:///x:/, where x is a valid drive letter')
259
 
    return win32_url[3].upper() + u':' + unescape(win32_url[5:])
 
192
    return win32_url[0].upper() + u':' + unescape(win32_url[2:])
260
193
 
261
194
 
262
195
def _win32_local_path_to_url(path):
270
203
    #       which actually strips trailing space characters.
271
204
    #       The worst part is that under linux ntpath.abspath has different
272
205
    #       semantics, since 'nt' is not an available module.
273
 
    win32_path = osutils._win32_abspath(path)
274
 
    # check for UNC path \\HOST\path
275
 
    if win32_path.startswith('//'):
276
 
        return 'file:' + escape(win32_path)
 
206
    win32_path = osutils._nt_normpath(
 
207
        osutils._win32_abspath(path)).replace('\\', '/')
277
208
    return 'file:///' + win32_path[0].upper() + ':' + escape(win32_path[2:])
278
209
 
279
210
 
290
221
 
291
222
 
292
223
_url_scheme_re = re.compile(r'^(?P<scheme>[^:/]{2,})://(?P<path>.*)$')
293
 
_url_hex_escapes_re = re.compile(r'(%[0-9a-fA-F]{2})')
294
 
 
295
 
 
296
 
def _unescape_safe_chars(matchobj):
297
 
    """re.sub callback to convert hex-escapes to plain characters (if safe).
298
 
    
299
 
    e.g. '%7E' will be converted to '~'.
300
 
    """
301
 
    hex_digits = matchobj.group(0)[1:]
302
 
    char = chr(int(hex_digits, 16))
303
 
    if char in _url_dont_escape_characters:
304
 
        return char
305
 
    else:
306
 
        return matchobj.group(0).upper()
307
224
 
308
225
 
309
226
def normalize_url(url):
310
227
    """Make sure that a path string is in fully normalized URL form.
311
228
    
312
 
    This handles URLs which have unicode characters, spaces,
 
229
    This handles URLs which have unicode characters, spaces, 
313
230
    special characters, etc.
314
231
 
315
232
    It has two basic modes of operation, depending on whether the
328
245
    m = _url_scheme_re.match(url)
329
246
    if not m:
330
247
        return local_path_to_url(url)
331
 
    scheme = m.group('scheme')
332
 
    path = m.group('path')
333
248
    if not isinstance(url, unicode):
334
249
        for c in url:
335
250
            if c not in _url_safe_characters:
336
251
                raise errors.InvalidURL(url, 'URLs can only contain specific'
337
252
                                            ' safe characters (not %r)' % c)
338
 
        path = _url_hex_escapes_re.sub(_unescape_safe_chars, path)
339
 
        return str(scheme + '://' + ''.join(path))
340
 
 
 
253
        return url
341
254
    # We have a unicode (hybrid) url
342
 
    path_chars = list(path)
 
255
    scheme = m.group('scheme')
 
256
    path = list(m.group('path'))
343
257
 
344
 
    for i in xrange(len(path_chars)):
345
 
        if path_chars[i] not in _url_safe_characters:
346
 
            chars = path_chars[i].encode('utf-8')
347
 
            path_chars[i] = ''.join(
348
 
                ['%%%02X' % ord(c) for c in path_chars[i].encode('utf-8')])
349
 
    path = ''.join(path_chars)
350
 
    path = _url_hex_escapes_re.sub(_unescape_safe_chars, path)
351
 
    return str(scheme + '://' + path)
 
258
    for i in xrange(len(path)):
 
259
        if path[i] not in _url_safe_characters:
 
260
            chars = path[i].encode('utf-8')
 
261
            path[i] = ''.join(['%%%02X' % ord(c) for c in path[i].encode('utf-8')])
 
262
    return scheme + '://' + ''.join(path)
352
263
 
353
264
 
354
265
def relative_url(base, other):
482
393
    if not url.endswith('/'):
483
394
        # Nothing to do
484
395
        return url
485
 
    if sys.platform == 'win32' and url.startswith('file://'):
 
396
    if sys.platform == 'win32' and url.startswith('file:///'):
486
397
        return _win32_strip_local_trailing_slash(url)
487
398
 
488
399
    scheme_loc, first_path_slash = _find_scheme_and_separator(url)
534
445
#These entries get mapped to themselves
535
446
_hex_display_map.update((hex,'%'+hex) for hex in _no_decode_hex)
536
447
 
537
 
# These characters shouldn't be percent-encoded, and it's always safe to
538
 
# unencode them if they are.
539
 
_url_dont_escape_characters = set(
540
 
   "abcdefghijklmnopqrstuvwxyz" # Lowercase alpha
541
 
   "ABCDEFGHIJKLMNOPQRSTUVWXYZ" # Uppercase alpha
542
 
   "0123456789" # Numbers
543
 
   "-._~"  # Unreserved characters
544
 
)
545
 
 
546
448
# These characters should not be escaped
547
 
_url_safe_characters = set(
548
 
   "abcdefghijklmnopqrstuvwxyz" # Lowercase alpha
549
 
   "ABCDEFGHIJKLMNOPQRSTUVWXYZ" # Uppercase alpha
550
 
   "0123456789" # Numbers
551
 
   "_.-!~*'()"  # Unreserved characters
552
 
   "/;?:@&=+$," # Reserved characters
553
 
   "%#"         # Extra reserved characters
554
 
)
 
449
_url_safe_characters = set('abcdefghijklmnopqrstuvwxyz'
 
450
                        'ABCDEFGHIJKLMNOPQRSTUVWXYZ'
 
451
                        '0123456789' '_.-/'
 
452
                        ';?:@&=+$,%#')
 
453
 
555
454
 
556
455
def unescape_for_display(url, encoding):
557
456
    """Decode what you can for a URL, so that we get a nice looking path.
608
507
                # Otherwise take the url decoded one
609
508
                res[i] = decoded
610
509
    return u'/'.join(res)
611
 
 
612
 
 
613
 
def derive_to_location(from_location):
614
 
    """Derive a TO_LOCATION given a FROM_LOCATION.
615
 
 
616
 
    The normal case is a FROM_LOCATION of http://foo/bar => bar.
617
 
    The Right Thing for some logical destinations may differ though
618
 
    because no / may be present at all. In that case, the result is
619
 
    the full name without the scheme indicator, e.g. lp:foo-bar => foo-bar.
620
 
    This latter case also applies when a Windows drive
621
 
    is used without a path, e.g. c:foo-bar => foo-bar.
622
 
    If no /, path separator or : is found, the from_location is returned.
623
 
    """
624
 
    if from_location.find("/") >= 0 or from_location.find(os.sep) >= 0:
625
 
        return os.path.basename(from_location.rstrip("/\\"))
626
 
    else:
627
 
        sep = from_location.find(":")
628
 
        if sep > 0:
629
 
            return from_location[sep+1:]
630
 
        else:
631
 
            return from_location