/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/location.py

  • Committer: Jelmer Vernooij
  • Date: 2019-06-15 13:39:46 UTC
  • mto: This revision was merged to the branch mainline in revision 7342.
  • Revision ID: jelmer@jelmer.uk-20190615133946-uywh9ix0lfpqw0hy
Install quilt.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/location.py
 
1
# Copyright (C) 2006-2010 Canonical Ltd
 
2
# Copyright (C) 2018 Breezy Developers
 
3
#
 
4
# This program is free software; you can redistribute it and/or modify
 
5
# it under the terms of the GNU General Public License as published by
 
6
# the Free Software Foundation; either version 2 of the License, or
 
7
# (at your option) any later version.
 
8
#
 
9
# This program is distributed in the hope that it will be useful,
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
12
# GNU General Public License for more details.
 
13
#
 
14
# You should have received a copy of the GNU General Public License
 
15
# along with this program; if not, write to the Free Software
 
16
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
17
 
 
18
"""UI location string handling."""
 
19
 
 
20
from __future__ import absolute_import
 
21
 
 
22
import re
 
23
 
 
24
from . import (
 
25
    urlutils,
 
26
    )
 
27
from .hooks import Hooks
 
28
from .sixish import (
 
29
    PY3,
 
30
    string_types,
 
31
    )
 
32
 
 
33
 
 
34
class LocationHooks(Hooks):
 
35
    """Dictionary mapping hook name to a list of callables for location hooks.
 
36
    """
 
37
 
 
38
    def __init__(self):
 
39
        Hooks.__init__(self, "breezy.location", "hooks")
 
40
        self.add_hook(
 
41
            'rewrite_url',
 
42
            "Possibly rewrite a URL. Called with a URL to rewrite and the "
 
43
            "purpose of the URL.", (3, 0))
 
44
 
 
45
 
 
46
hooks = LocationHooks()
 
47
 
 
48
 
 
49
def rcp_location_to_url(location, scheme='ssh'):
 
50
    """Convert a rcp-style location to a URL.
 
51
 
 
52
    :param location: Location to convert, e.g. "foo:bar"
 
53
    :param schenme: URL scheme to return, defaults to "ssh"
 
54
    :return: A URL, e.g. "ssh://foo/bar"
 
55
    :raises ValueError: if this is not a RCP-style URL
 
56
    """
 
57
    m = re.match('^(?P<user>[^@:/]+@)?(?P<host>[^/:]+):(?P<path>.*)$', location)
 
58
    if not m:
 
59
        raise ValueError("Not a RCP URL")
 
60
    if m.group('path').startswith('//'):
 
61
        raise ValueError("Not a RCP URL: already looks like a URL")
 
62
    quoted_user = urlutils.quote(m.group('user')[:-1]) if m.group('user') else None
 
63
    url = urlutils.URL(
 
64
        scheme=scheme, quoted_user=quoted_user,
 
65
        port=None, quoted_password=None,
 
66
        quoted_host=urlutils.quote(m.group('host')),
 
67
        quoted_path=urlutils.quote(m.group('path')))
 
68
    return str(url)
 
69
 
 
70
 
 
71
def location_to_url(location, purpose=None):
 
72
    """Determine a fully qualified URL from a location string.
 
73
 
 
74
    This will try to interpret location as both a URL and a directory path. It
 
75
    will also lookup the location in directories.
 
76
 
 
77
    :param location: Unicode or byte string object with a location
 
78
    :param purpose: Intended method of access (None, 'read' or 'write')
 
79
    :raise InvalidURL: If the location is already a URL, but not valid.
 
80
    :return: Byte string with resulting URL
 
81
    """
 
82
    if not isinstance(location, string_types):
 
83
        raise AssertionError("location not a byte or unicode string")
 
84
    from .directory_service import directories
 
85
    location = directories.dereference(location, purpose)
 
86
 
 
87
    # Catch any URLs which are passing Unicode rather than ASCII
 
88
    try:
 
89
        location = location.encode('ascii')
 
90
    except UnicodeError:
 
91
        if urlutils.is_url(location):
 
92
            raise urlutils.InvalidURL(
 
93
                path=location, extra='URLs must be properly escaped')
 
94
        location = urlutils.local_path_to_url(location)
 
95
    else:
 
96
        if PY3:
 
97
            location = location.decode('ascii')
 
98
 
 
99
    if location.startswith("file:") and not location.startswith("file://"):
 
100
        return urlutils.join(urlutils.local_path_to_url("."), location[5:])
 
101
 
 
102
    try:
 
103
        url = rcp_location_to_url(location, scheme="ssh")
 
104
    except ValueError:
 
105
        pass
 
106
    else:
 
107
        return url
 
108
 
 
109
    if not urlutils.is_url(location):
 
110
        return urlutils.local_path_to_url(location)
 
111
 
 
112
    for hook in hooks['rewrite_url']:
 
113
        location = hook(location, purpose=purpose)
 
114
 
 
115
    return location