/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/plugins/launchpad/lp_registration.py

  • Committer: Jelmer Vernooij
  • Date: 2020-03-22 01:35:14 UTC
  • mfrom: (7490.7.6 work)
  • mto: This revision was merged to the branch mainline in revision 7499.
  • Revision ID: jelmer@jelmer.uk-20200322013514-7vw1ntwho04rcuj3
merge lp:brz/3.1.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/plugins/launchpad/lp_registration.py
 
1
# Copyright (C) 2006-2017 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from io import BytesIO
 
18
import os
 
19
import socket
 
20
try:
 
21
    from urllib.parse import urlsplit, urlunsplit
 
22
except ImportError:
 
23
    from urlparse import urlsplit, urlunsplit  # noqa: F401
 
24
import urllib
 
25
from xmlrpc.client import (
 
26
    __version__ as xmlrpc_version,
 
27
    Fault,
 
28
    ProtocolError,
 
29
    ServerProxy,
 
30
    Transport,
 
31
    )
 
32
 
 
33
from ... import (
 
34
    errors,
 
35
    urlutils,
 
36
    __version__ as _breezy_version,
 
37
    )
 
38
from ...transport import http, get_transport
 
39
 
 
40
from .uris import (
 
41
    DEFAULT_INSTANCE,
 
42
    LAUNCHPAD_DOMAINS,
 
43
    LAUNCHPAD_BAZAAR_DOMAINS,
 
44
    )
 
45
 
 
46
 
 
47
# for testing, do
 
48
'''
 
49
export BRZ_LP_XMLRPC_URL=http://xmlrpc.staging.launchpad.net/bazaar/
 
50
'''
 
51
 
 
52
 
 
53
class InvalidURL(errors.PathError):
 
54
 
 
55
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
 
56
 
 
57
 
 
58
class InvalidLaunchpadInstance(errors.BzrError):
 
59
 
 
60
    _fmt = "%(lp_instance)s is not a valid Launchpad instance."
 
61
 
 
62
    def __init__(self, lp_instance):
 
63
        errors.BzrError.__init__(self, lp_instance=lp_instance)
 
64
 
 
65
 
 
66
class NotLaunchpadBranch(errors.BzrError):
 
67
 
 
68
    _fmt = "%(url)s is not registered on Launchpad."
 
69
 
 
70
    def __init__(self, url):
 
71
        errors.BzrError.__init__(self, url=url)
 
72
 
 
73
 
 
74
class XMLRPCTransport(Transport):
 
75
 
 
76
    def __init__(self, scheme):
 
77
        Transport.__init__(self)
 
78
        self._scheme = scheme
 
79
        self.verbose = 0
 
80
        self._possible_bzr_transports = []
 
81
 
 
82
    def request(self, host, handler, request_body, verbose=0):
 
83
        self.verbose = verbose
 
84
        url = self._scheme + "://" + host + handler
 
85
        transport = get_transport(
 
86
            url, possible_transports=self._possible_bzr_transports)
 
87
        response = transport.request("POST", url, body=request_body, headers={
 
88
            "Content-Type": "text/xml"})
 
89
 
 
90
        if response.status != 200:
 
91
            raise ProtocolError(url, response.status,
 
92
                                response.text, response.headers)
 
93
        return self.parse_response(BytesIO(response.data))
 
94
 
 
95
 
 
96
class LaunchpadService(object):
 
97
    """A service to talk to Launchpad via XMLRPC.
 
98
 
 
99
    See http://wiki.bazaar.canonical.com/Specs/LaunchpadRpc for the methods we
 
100
    can call.
 
101
    """
 
102
 
 
103
    # NB: these should always end in a slash to avoid xmlrpclib appending
 
104
    # '/RPC2'
 
105
    LAUNCHPAD_INSTANCE = {}
 
106
    for instance, domain in LAUNCHPAD_DOMAINS.items():
 
107
        LAUNCHPAD_INSTANCE[instance] = 'https://xmlrpc.%s/bazaar/' % domain
 
108
 
 
109
    DEFAULT_SERVICE_URL = LAUNCHPAD_INSTANCE[DEFAULT_INSTANCE]
 
110
 
 
111
    transport = None
 
112
    registrant_email = None
 
113
    registrant_password = None
 
114
 
 
115
    def __init__(self, transport=None, lp_instance=None):
 
116
        """Construct a new service talking to the launchpad rpc server"""
 
117
        self._lp_instance = lp_instance
 
118
        if transport is None:
 
119
            uri_type = urlutils.parse_url(self.service_url)[0]
 
120
            transport = XMLRPCTransport(uri_type)
 
121
        self.transport = transport
 
122
 
 
123
    @property
 
124
    def service_url(self):
 
125
        """Return the http or https url for the xmlrpc server.
 
126
 
 
127
        This does not include the username/password credentials.
 
128
        """
 
129
        key = 'BRZ_LP_XMLRPC_URL'
 
130
        if key in os.environ:
 
131
            return os.environ[key]
 
132
        elif self._lp_instance is not None:
 
133
            try:
 
134
                return self.LAUNCHPAD_INSTANCE[self._lp_instance]
 
135
            except KeyError:
 
136
                raise InvalidLaunchpadInstance(self._lp_instance)
 
137
        else:
 
138
            return self.DEFAULT_SERVICE_URL
 
139
 
 
140
    @classmethod
 
141
    def for_url(cls, url, **kwargs):
 
142
        """Return the Launchpad service corresponding to the given URL."""
 
143
        result = urlsplit(url)
 
144
        lp_instance = result[1]
 
145
        if lp_instance == '':
 
146
            lp_instance = None
 
147
        elif lp_instance not in cls.LAUNCHPAD_INSTANCE:
 
148
            raise InvalidURL(url)
 
149
        return cls(lp_instance=lp_instance, **kwargs)
 
150
 
 
151
    def get_proxy(self):
 
152
        """Return the proxy for XMLRPC requests."""
 
153
        url = self.service_url
 
154
        return ServerProxy(url, transport=self.transport)
 
155
 
 
156
    def send_request(self, method_name, method_params):
 
157
        proxy = self.get_proxy()
 
158
        method = getattr(proxy, method_name)
 
159
        try:
 
160
            result = method(*method_params)
 
161
        except ProtocolError as e:
 
162
            if e.errcode == 301:
 
163
                # TODO: This can give a ProtocolError representing a 301 error, whose
 
164
                # e.headers['location'] tells where to go and e.errcode==301; should
 
165
                # probably log something and retry on the new url.
 
166
                raise NotImplementedError("should resend request to %s, but this isn't implemented"
 
167
                                          % e.headers.get('Location', 'NO-LOCATION-PRESENT'))
 
168
            else:
 
169
                # we don't want to print the original message because its
 
170
                # str representation includes the plaintext password.
 
171
                # TODO: print more headers to help in tracking down failures
 
172
                raise errors.BzrError("xmlrpc protocol error connecting to %s: %s %s"
 
173
                                      % (self.service_url, e.errcode, e.errmsg))
 
174
        except socket.gaierror as e:
 
175
            raise errors.ConnectionError(
 
176
                "Could not resolve '%s'" % self.domain,
 
177
                orig_error=e)
 
178
        return result
 
179
 
 
180
    @property
 
181
    def domain(self):
 
182
        if self._lp_instance is None:
 
183
            instance = DEFAULT_INSTANCE
 
184
        else:
 
185
            instance = self._lp_instance
 
186
        return LAUNCHPAD_DOMAINS[instance]
 
187
 
 
188
    def _guess_branch_path(self, branch_url, _request_factory=None):
 
189
        scheme, hostinfo, path = urlsplit(branch_url)[:3]
 
190
        if _request_factory is None:
 
191
            _request_factory = ResolveLaunchpadPathRequest
 
192
        if scheme == 'lp':
 
193
            resolve = _request_factory(path)
 
194
            try:
 
195
                result = resolve.submit(self)
 
196
            except Fault as fault:
 
197
                raise InvalidURL(branch_url, str(fault))
 
198
            branch_url = result['urls'][0]
 
199
            path = urlsplit(branch_url)[2]
 
200
        else:
 
201
            if hostinfo not in LAUNCHPAD_BAZAAR_DOMAINS:
 
202
                raise NotLaunchpadBranch(branch_url)
 
203
        return path.lstrip('/')
 
204
 
 
205
    def get_web_url_from_branch_url(self, branch_url, _request_factory=None):
 
206
        """Get the Launchpad web URL for the given branch URL.
 
207
 
 
208
        :raise InvalidURL: if 'branch_url' cannot be identified as a
 
209
            Launchpad branch URL.
 
210
        :return: The URL of the branch on Launchpad.
 
211
        """
 
212
        path = self._guess_branch_path(branch_url, _request_factory)
 
213
        return urlutils.join('https://code.%s' % self.domain, path)
 
214
 
 
215
 
 
216
class BaseRequest(object):
 
217
    """Base request for talking to a XMLRPC server."""
 
218
 
 
219
    # Set this to the XMLRPC method name.
 
220
    _methodname = None
 
221
 
 
222
    def _request_params(self):
 
223
        """Return the arguments to pass to the method"""
 
224
        raise NotImplementedError(self._request_params)
 
225
 
 
226
    def submit(self, service):
 
227
        """Submit request to Launchpad XMLRPC server.
 
228
 
 
229
        :param service: LaunchpadService indicating where to send the request.
 
230
        """
 
231
        return service.send_request(self._methodname, self._request_params())
 
232
 
 
233
 
 
234
class DryRunLaunchpadService(LaunchpadService):
 
235
    """Service that just absorbs requests without sending to server."""
 
236
 
 
237
    def send_request(self, method_name, method_params):
 
238
        pass
 
239
 
 
240
 
 
241
class ResolveLaunchpadPathRequest(BaseRequest):
 
242
    """Request to resolve the path component of an lp: URL."""
 
243
 
 
244
    _methodname = 'resolve_lp_path'
 
245
 
 
246
    def __init__(self, path):
 
247
        if not path:
 
248
            raise InvalidURL(url=path, extra="You must specify a project.")
 
249
        self.path = path
 
250
 
 
251
    def _request_params(self):
 
252
        """Return xmlrpc request parameters"""
 
253
        return (self.path,)