/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: Breezy landing bot
  • Author(s): Jelmer Vernooij
  • Date: 2020-08-23 01:15:41 UTC
  • mfrom: (7520.1.4 merge-3.1)
  • Revision ID: breezy.the.bot@gmail.com-20200823011541-nv0oh7nzaganx2qy
Merge lp:brz/3.1.

Merged from https://code.launchpad.net/~jelmer/brz/merge-3.1/+merge/389690

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/plugins/launchpad/lp_registration.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006-2017 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
 
 
17
from io import BytesIO
18
18
import os
19
19
import socket
20
 
from urlparse import urlsplit, urlunsplit
 
20
try:
 
21
    from urllib.parse import urlsplit, urlunsplit
 
22
except ImportError:
 
23
    from urlparse import urlsplit, urlunsplit  # noqa: F401
21
24
import urllib
22
 
import xmlrpclib
 
25
from xmlrpc.client import (
 
26
    __version__ as xmlrpc_version,
 
27
    Fault,
 
28
    ProtocolError,
 
29
    ServerProxy,
 
30
    Transport,
 
31
    )
23
32
 
24
 
from bzrlib import (
25
 
    config,
 
33
from ... import (
26
34
    errors,
27
35
    urlutils,
28
 
    __version__ as _bzrlib_version,
29
 
    )
30
 
from bzrlib.transport.http import _urllib2_wrappers
 
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
    )
31
45
 
32
46
 
33
47
# for testing, do
34
48
'''
35
 
export BZR_LP_XMLRPC_URL=http://xmlrpc.staging.launchpad.net/bazaar/
 
49
export BRZ_LP_XMLRPC_URL=http://xmlrpc.staging.launchpad.net/bazaar/
36
50
'''
37
51
 
 
52
 
 
53
class InvalidURL(errors.PathError):
 
54
 
 
55
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
 
56
 
 
57
 
38
58
class InvalidLaunchpadInstance(errors.BzrError):
39
59
 
40
60
    _fmt = "%(lp_instance)s is not a valid Launchpad instance."
51
71
        errors.BzrError.__init__(self, url=url)
52
72
 
53
73
 
54
 
class XMLRPCTransport(xmlrpclib.Transport):
 
74
class XMLRPCTransport(Transport):
55
75
 
56
76
    def __init__(self, scheme):
57
 
        # In python2.4 xmlrpclib.Transport is a old-style class, and does not
58
 
        # define __init__, so we check first
59
 
        init = getattr(xmlrpclib.Transport, '__init__', None)
60
 
        if init is not None:
61
 
            init(self)
 
77
        Transport.__init__(self)
62
78
        self._scheme = scheme
63
 
        self._opener = _urllib2_wrappers.Opener()
64
79
        self.verbose = 0
 
80
        self._possible_bzr_transports = []
65
81
 
66
82
    def request(self, host, handler, request_body, verbose=0):
67
83
        self.verbose = verbose
68
84
        url = self._scheme + "://" + host + handler
69
 
        request = _urllib2_wrappers.Request("POST", url, request_body)
70
 
        # FIXME: _urllib2_wrappers will override user-agent with its own
71
 
        # request.add_header("User-Agent", self.user_agent)
72
 
        request.add_header("Content-Type", "text/xml")
 
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"})
73
89
 
74
 
        response = self._opener.open(request)
75
 
        if response.code != 200:
76
 
            raise xmlrpclib.ProtocolError(host + handler, response.code,
77
 
                                          response.msg, response.info())
78
 
        return self.parse_response(response)
 
90
        if response.status != 200:
 
91
            raise ProtocolError(url, response.status,
 
92
                                response.text, response.headers)
 
93
        return self.parse_response(BytesIO(response.data))
79
94
 
80
95
 
81
96
class LaunchpadService(object):
82
97
    """A service to talk to Launchpad via XMLRPC.
83
98
 
84
 
    See http://wiki.bazaar.canonical.com/Specs/LaunchpadRpc for the methods we can call.
 
99
    See http://wiki.bazaar.canonical.com/Specs/LaunchpadRpc for the methods we
 
100
    can call.
85
101
    """
86
102
 
87
 
    LAUNCHPAD_DOMAINS = {
88
 
        'production': 'launchpad.net',
89
 
        'edge': 'edge.launchpad.net',
90
 
        'staging': 'staging.launchpad.net',
91
 
        'demo': 'demo.launchpad.net',
92
 
        'dev': 'launchpad.dev',
93
 
        }
94
 
 
95
103
    # NB: these should always end in a slash to avoid xmlrpclib appending
96
104
    # '/RPC2'
97
105
    LAUNCHPAD_INSTANCE = {}
98
 
    for instance, domain in LAUNCHPAD_DOMAINS.iteritems():
 
106
    for instance, domain in LAUNCHPAD_DOMAINS.items():
99
107
        LAUNCHPAD_INSTANCE[instance] = 'https://xmlrpc.%s/bazaar/' % domain
100
108
 
101
 
    # We use edge as the default because:
102
 
    # Beta users get redirected to it
103
 
    # All users can use it
104
 
    # There is a bug in the launchpad side where redirection causes an OOPS.
105
 
    DEFAULT_INSTANCE = 'edge'
106
109
    DEFAULT_SERVICE_URL = LAUNCHPAD_INSTANCE[DEFAULT_INSTANCE]
107
110
 
108
111
    transport = None
109
112
    registrant_email = None
110
113
    registrant_password = None
111
114
 
112
 
 
113
115
    def __init__(self, transport=None, lp_instance=None):
114
116
        """Construct a new service talking to the launchpad rpc server"""
115
117
        self._lp_instance = lp_instance
116
118
        if transport is None:
117
 
            uri_type = urllib.splittype(self.service_url)[0]
 
119
            uri_type = urlutils.parse_url(self.service_url)[0]
118
120
            transport = XMLRPCTransport(uri_type)
119
 
            transport.user_agent = 'bzr/%s (xmlrpclib/%s)' \
120
 
                    % (_bzrlib_version, xmlrpclib.__version__)
121
121
        self.transport = transport
122
122
 
123
123
    @property
126
126
 
127
127
        This does not include the username/password credentials.
128
128
        """
129
 
        key = 'BZR_LP_XMLRPC_URL'
 
129
        key = 'BRZ_LP_XMLRPC_URL'
130
130
        if key in os.environ:
131
131
            return os.environ[key]
132
132
        elif self._lp_instance is not None:
145
145
        if lp_instance == '':
146
146
            lp_instance = None
147
147
        elif lp_instance not in cls.LAUNCHPAD_INSTANCE:
148
 
            raise errors.InvalidURL(path=url)
 
148
            raise InvalidURL(url)
149
149
        return cls(lp_instance=lp_instance, **kwargs)
150
150
 
151
 
    def get_proxy(self, authenticated):
 
151
    def get_proxy(self):
152
152
        """Return the proxy for XMLRPC requests."""
153
 
        if authenticated:
154
 
            # auth info must be in url
155
 
            # TODO: if there's no registrant email perhaps we should
156
 
            # just connect anonymously?
157
 
            scheme, hostinfo, path = urlsplit(self.service_url)[:3]
158
 
            if '@' in hostinfo:
159
 
                raise AssertionError(hostinfo)
160
 
            if self.registrant_email is None:
161
 
                raise AssertionError()
162
 
            if self.registrant_password is None:
163
 
                raise AssertionError()
164
 
            # TODO: perhaps fully quote the password to make it very slightly
165
 
            # obscured
166
 
            # TODO: can we perhaps add extra Authorization headers
167
 
            # directly to the request, rather than putting this into
168
 
            # the url?  perhaps a bit more secure against accidentally
169
 
            # revealing it.  std66 s3.2.1 discourages putting the
170
 
            # password in the url.
171
 
            hostinfo = '%s:%s@%s' % (urllib.quote(self.registrant_email),
172
 
                                     urllib.quote(self.registrant_password),
173
 
                                     hostinfo)
174
 
            url = urlunsplit((scheme, hostinfo, path, '', ''))
175
 
        else:
176
 
            url = self.service_url
177
 
        return xmlrpclib.ServerProxy(url, transport=self.transport)
178
 
 
179
 
    def gather_user_credentials(self):
180
 
        """Get the password from the user."""
181
 
        the_config = config.GlobalConfig()
182
 
        self.registrant_email = the_config.user_email()
183
 
        if self.registrant_password is None:
184
 
            auth = config.AuthenticationConfig()
185
 
            scheme, hostinfo = urlsplit(self.service_url)[:2]
186
 
            prompt = 'launchpad.net password for %s: ' % \
187
 
                    self.registrant_email
188
 
            # We will reuse http[s] credentials if we can, prompt user
189
 
            # otherwise
190
 
            self.registrant_password = auth.get_password(scheme, hostinfo,
191
 
                                                         self.registrant_email,
192
 
                                                         prompt=prompt)
193
 
 
194
 
    def send_request(self, method_name, method_params, authenticated):
195
 
        proxy = self.get_proxy(authenticated)
 
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()
196
158
        method = getattr(proxy, method_name)
197
159
        try:
198
160
            result = method(*method_params)
199
 
        except xmlrpclib.ProtocolError, e:
 
161
        except ProtocolError as e:
200
162
            if e.errcode == 301:
201
163
                # TODO: This can give a ProtocolError representing a 301 error, whose
202
164
                # e.headers['location'] tells where to go and e.errcode==301; should
203
165
                # probably log something and retry on the new url.
204
166
                raise NotImplementedError("should resend request to %s, but this isn't implemented"
205
 
                        % e.headers.get('Location', 'NO-LOCATION-PRESENT'))
 
167
                                          % e.headers.get('Location', 'NO-LOCATION-PRESENT'))
206
168
            else:
207
169
                # we don't want to print the original message because its
208
170
                # str representation includes the plaintext password.
209
171
                # TODO: print more headers to help in tracking down failures
210
172
                raise errors.BzrError("xmlrpc protocol error connecting to %s: %s %s"
211
 
                        % (self.service_url, e.errcode, e.errmsg))
212
 
        except socket.gaierror, e:
 
173
                                      % (self.service_url, e.errcode, e.errmsg))
 
174
        except socket.gaierror as e:
213
175
            raise errors.ConnectionError(
214
176
                "Could not resolve '%s'" % self.domain,
215
177
                orig_error=e)
218
180
    @property
219
181
    def domain(self):
220
182
        if self._lp_instance is None:
221
 
            instance = self.DEFAULT_INSTANCE
 
183
            instance = DEFAULT_INSTANCE
222
184
        else:
223
185
            instance = self._lp_instance
224
 
        return self.LAUNCHPAD_DOMAINS[instance]
 
186
        return LAUNCHPAD_DOMAINS[instance]
225
187
 
226
188
    def _guess_branch_path(self, branch_url, _request_factory=None):
227
189
        scheme, hostinfo, path = urlsplit(branch_url)[:3]
231
193
            resolve = _request_factory(path)
232
194
            try:
233
195
                result = resolve.submit(self)
234
 
            except xmlrpclib.Fault, fault:
235
 
                raise errors.InvalidURL(branch_url, str(fault))
 
196
            except Fault as fault:
 
197
                raise InvalidURL(branch_url, str(fault))
236
198
            branch_url = result['urls'][0]
237
199
            path = urlsplit(branch_url)[2]
238
200
        else:
239
 
            domains = (
240
 
                'bazaar.%s' % domain
241
 
                for domain in self.LAUNCHPAD_DOMAINS.itervalues())
242
 
            if hostinfo not in domains:
 
201
            if hostinfo not in LAUNCHPAD_BAZAAR_DOMAINS:
243
202
                raise NotLaunchpadBranch(branch_url)
244
203
        return path.lstrip('/')
245
204
 
246
205
    def get_web_url_from_branch_url(self, branch_url, _request_factory=None):
247
206
        """Get the Launchpad web URL for the given branch URL.
248
207
 
249
 
        :raise errors.InvalidURL: if 'branch_url' cannot be identified as a
 
208
        :raise InvalidURL: if 'branch_url' cannot be identified as a
250
209
            Launchpad branch URL.
251
210
        :return: The URL of the branch on Launchpad.
252
211
        """
259
218
 
260
219
    # Set this to the XMLRPC method name.
261
220
    _methodname = None
262
 
    _authenticated = True
263
221
 
264
222
    def _request_params(self):
265
223
        """Return the arguments to pass to the method"""
268
226
    def submit(self, service):
269
227
        """Submit request to Launchpad XMLRPC server.
270
228
 
271
 
        :param service: LaunchpadService indicating where to send
272
 
            the request and the authentication credentials.
 
229
        :param service: LaunchpadService indicating where to send the request.
273
230
        """
274
 
        return service.send_request(self._methodname, self._request_params(),
275
 
                                    self._authenticated)
 
231
        return service.send_request(self._methodname, self._request_params())
276
232
 
277
233
 
278
234
class DryRunLaunchpadService(LaunchpadService):
279
 
    """Service that just absorbs requests without sending to server.
280
 
 
281
 
    The dummy service does not need authentication.
282
 
    """
283
 
 
284
 
    def send_request(self, method_name, method_params, authenticated):
285
 
        pass
286
 
 
287
 
    def gather_user_credentials(self):
288
 
        pass
289
 
 
290
 
 
291
 
class BranchRegistrationRequest(BaseRequest):
292
 
    """Request to tell Launchpad about a bzr branch."""
293
 
 
294
 
    _methodname = 'register_branch'
295
 
 
296
 
    def __init__(self, branch_url,
297
 
                 branch_name='',
298
 
                 branch_title='',
299
 
                 branch_description='',
300
 
                 author_email='',
301
 
                 product_name='',
302
 
                 ):
303
 
        if not branch_url:
304
 
            raise errors.InvalidURL(branch_url, "You need to specify a non-empty branch URL.")
305
 
        self.branch_url = branch_url
306
 
        if branch_name:
307
 
            self.branch_name = branch_name
308
 
        else:
309
 
            self.branch_name = self._find_default_branch_name(self.branch_url)
310
 
        self.branch_title = branch_title
311
 
        self.branch_description = branch_description
312
 
        self.author_email = author_email
313
 
        self.product_name = product_name
314
 
 
315
 
    def _request_params(self):
316
 
        """Return xmlrpc request parameters"""
317
 
        # This must match the parameter tuple expected by Launchpad for this
318
 
        # method
319
 
        return (self.branch_url,
320
 
                self.branch_name,
321
 
                self.branch_title,
322
 
                self.branch_description,
323
 
                self.author_email,
324
 
                self.product_name,
325
 
               )
326
 
 
327
 
    def _find_default_branch_name(self, branch_url):
328
 
        i = branch_url.rfind('/')
329
 
        return branch_url[i+1:]
330
 
 
331
 
 
332
 
class BranchBugLinkRequest(BaseRequest):
333
 
    """Request to link a bzr branch in Launchpad to a bug."""
334
 
 
335
 
    _methodname = 'link_branch_to_bug'
336
 
 
337
 
    def __init__(self, branch_url, bug_id):
338
 
        self.bug_id = bug_id
339
 
        self.branch_url = branch_url
340
 
 
341
 
    def _request_params(self):
342
 
        """Return xmlrpc request parameters"""
343
 
        # This must match the parameter tuple expected by Launchpad for this
344
 
        # method
345
 
        return (self.branch_url, self.bug_id, '')
 
235
    """Service that just absorbs requests without sending to server."""
 
236
 
 
237
    def send_request(self, method_name, method_params):
 
238
        pass
346
239
 
347
240
 
348
241
class ResolveLaunchpadPathRequest(BaseRequest):
349
242
    """Request to resolve the path component of an lp: URL."""
350
243
 
351
244
    _methodname = 'resolve_lp_path'
352
 
    _authenticated = False
353
245
 
354
246
    def __init__(self, path):
355
247
        if not path:
356
 
            raise errors.InvalidURL(path=path,
357
 
                                    extra="You must specify a project.")
 
248
            raise InvalidURL(url=path, extra="You must specify a project.")
358
249
        self.path = path
359
250
 
360
251
    def _request_params(self):