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

  • Committer: Jelmer Vernooij
  • Date: 2017-05-21 12:41:27 UTC
  • mto: This revision was merged to the branch mainline in revision 6623.
  • Revision ID: jelmer@jelmer.uk-20170521124127-iv8etg0vwymyai6y
s/bzr/brz/ in apport config.

Show diffs side-by-side

added added

removed removed

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