/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: 2019-01-01 21:38:07 UTC
  • mfrom: (7228 work)
  • mto: This revision was merged to the branch mainline in revision 7233.
  • Revision ID: jelmer@jelmer.uk-20190101213807-ay6uqghz0nnrgjvx
Merge trunk.

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
from __future__ import absolute_import
 
18
 
17
19
 
18
20
import os
19
21
import socket
20
 
from urlparse import urlsplit, urlunsplit
 
22
try:
 
23
    from urllib.parse import urlsplit, urlunsplit
 
24
except ImportError:
 
25
    from urlparse import urlsplit, urlunsplit  # noqa: F401
21
26
import urllib
22
 
import xmlrpclib
 
27
try:
 
28
    from xmlrpc.client import (
 
29
        __version__ as xmlrpc_version,
 
30
        Fault,
 
31
        ProtocolError,
 
32
        ServerProxy,
 
33
        Transport,
 
34
        )
 
35
except ImportError:  # python < 3
 
36
    from xmlrpclib import (
 
37
        __version__ as xmlrpc_version,
 
38
        Fault,
 
39
        ProtocolError,
 
40
        Transport,
 
41
        ServerProxy,
 
42
        )
23
43
 
24
 
from bzrlib import (
25
 
    config,
 
44
from ... import (
26
45
    errors,
27
46
    urlutils,
28
 
    __version__ as _bzrlib_version,
 
47
    __version__ as _breezy_version,
29
48
    )
30
 
from bzrlib.transport.http import _urllib2_wrappers
 
49
from ...transport.http import _urllib2_wrappers
31
50
 
32
51
 
33
52
# for testing, do
34
53
'''
35
 
export BZR_LP_XMLRPC_URL=http://xmlrpc.staging.launchpad.net/bazaar/
 
54
export BRZ_LP_XMLRPC_URL=http://xmlrpc.staging.launchpad.net/bazaar/
36
55
'''
37
56
 
 
57
 
 
58
class InvalidURL(errors.PathError):
 
59
 
 
60
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
 
61
 
 
62
 
38
63
class InvalidLaunchpadInstance(errors.BzrError):
39
64
 
40
65
    _fmt = "%(lp_instance)s is not a valid Launchpad instance."
51
76
        errors.BzrError.__init__(self, url=url)
52
77
 
53
78
 
54
 
class XMLRPCTransport(xmlrpclib.Transport):
 
79
class XMLRPCTransport(Transport):
55
80
 
56
81
    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)
 
82
        Transport.__init__(self)
62
83
        self._scheme = scheme
63
84
        self._opener = _urllib2_wrappers.Opener()
64
85
        self.verbose = 0
67
88
        self.verbose = verbose
68
89
        url = self._scheme + "://" + host + handler
69
90
        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)
 
91
        request.add_header("User-Agent", self.user_agent)
72
92
        request.add_header("Content-Type", "text/xml")
73
93
 
74
94
        response = self._opener.open(request)
75
95
        if response.code != 200:
76
 
            raise xmlrpclib.ProtocolError(host + handler, response.code,
77
 
                                          response.msg, response.info())
 
96
            raise ProtocolError(host + handler, response.code,
 
97
                                response.msg, response.info())
78
98
        return self.parse_response(response)
79
99
 
80
100
 
81
101
class LaunchpadService(object):
82
102
    """A service to talk to Launchpad via XMLRPC.
83
103
 
84
 
    See http://wiki.bazaar.canonical.com/Specs/LaunchpadRpc for the methods we can call.
 
104
    See http://wiki.bazaar.canonical.com/Specs/LaunchpadRpc for the methods we
 
105
    can call.
85
106
    """
86
107
 
87
108
    LAUNCHPAD_DOMAINS = {
88
109
        'production': 'launchpad.net',
89
 
        'edge': 'edge.launchpad.net',
90
110
        'staging': 'staging.launchpad.net',
 
111
        'qastaging': 'qastaging.launchpad.net',
91
112
        'demo': 'demo.launchpad.net',
92
113
        'dev': 'launchpad.dev',
93
114
        }
95
116
    # NB: these should always end in a slash to avoid xmlrpclib appending
96
117
    # '/RPC2'
97
118
    LAUNCHPAD_INSTANCE = {}
98
 
    for instance, domain in LAUNCHPAD_DOMAINS.iteritems():
 
119
    for instance, domain in LAUNCHPAD_DOMAINS.items():
99
120
        LAUNCHPAD_INSTANCE[instance] = 'https://xmlrpc.%s/bazaar/' % domain
100
121
 
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'
 
122
    # We use production as the default because edge has been deprecated circa
 
123
    # 2010-11 (see bug https://bugs.launchpad.net/bzr/+bug/583667)
 
124
    DEFAULT_INSTANCE = 'production'
106
125
    DEFAULT_SERVICE_URL = LAUNCHPAD_INSTANCE[DEFAULT_INSTANCE]
107
126
 
108
127
    transport = None
109
128
    registrant_email = None
110
129
    registrant_password = None
111
130
 
112
 
 
113
131
    def __init__(self, transport=None, lp_instance=None):
114
132
        """Construct a new service talking to the launchpad rpc server"""
115
133
        self._lp_instance = lp_instance
116
134
        if transport is None:
117
 
            uri_type = urllib.splittype(self.service_url)[0]
 
135
            uri_type = urlutils.parse_url(self.service_url)[0]
118
136
            transport = XMLRPCTransport(uri_type)
119
 
            transport.user_agent = 'bzr/%s (xmlrpclib/%s)' \
120
 
                    % (_bzrlib_version, xmlrpclib.__version__)
 
137
            transport.user_agent = 'Breezy/%s (xmlrpc/%s)' \
 
138
                % (_breezy_version, xmlrpc_version)
121
139
        self.transport = transport
122
140
 
123
141
    @property
126
144
 
127
145
        This does not include the username/password credentials.
128
146
        """
129
 
        key = 'BZR_LP_XMLRPC_URL'
 
147
        key = 'BRZ_LP_XMLRPC_URL'
130
148
        if key in os.environ:
131
149
            return os.environ[key]
132
150
        elif self._lp_instance is not None:
145
163
        if lp_instance == '':
146
164
            lp_instance = None
147
165
        elif lp_instance not in cls.LAUNCHPAD_INSTANCE:
148
 
            raise errors.InvalidURL(path=url)
 
166
            raise InvalidURL(url)
149
167
        return cls(lp_instance=lp_instance, **kwargs)
150
168
 
151
 
    def get_proxy(self, authenticated):
 
169
    def get_proxy(self):
152
170
        """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)
 
171
        url = self.service_url
 
172
        return ServerProxy(url, transport=self.transport)
 
173
 
 
174
    def send_request(self, method_name, method_params):
 
175
        proxy = self.get_proxy()
196
176
        method = getattr(proxy, method_name)
197
177
        try:
198
178
            result = method(*method_params)
199
 
        except xmlrpclib.ProtocolError, e:
 
179
        except ProtocolError as e:
200
180
            if e.errcode == 301:
201
181
                # TODO: This can give a ProtocolError representing a 301 error, whose
202
182
                # e.headers['location'] tells where to go and e.errcode==301; should
203
183
                # probably log something and retry on the new url.
204
184
                raise NotImplementedError("should resend request to %s, but this isn't implemented"
205
 
                        % e.headers.get('Location', 'NO-LOCATION-PRESENT'))
 
185
                                          % e.headers.get('Location', 'NO-LOCATION-PRESENT'))
206
186
            else:
207
187
                # we don't want to print the original message because its
208
188
                # str representation includes the plaintext password.
209
189
                # TODO: print more headers to help in tracking down failures
210
190
                raise errors.BzrError("xmlrpc protocol error connecting to %s: %s %s"
211
 
                        % (self.service_url, e.errcode, e.errmsg))
212
 
        except socket.gaierror, e:
 
191
                                      % (self.service_url, e.errcode, e.errmsg))
 
192
        except socket.gaierror as e:
213
193
            raise errors.ConnectionError(
214
194
                "Could not resolve '%s'" % self.domain,
215
195
                orig_error=e)
231
211
            resolve = _request_factory(path)
232
212
            try:
233
213
                result = resolve.submit(self)
234
 
            except xmlrpclib.Fault, fault:
235
 
                raise errors.InvalidURL(branch_url, str(fault))
 
214
            except Fault as fault:
 
215
                raise InvalidURL(branch_url, str(fault))
236
216
            branch_url = result['urls'][0]
237
217
            path = urlsplit(branch_url)[2]
238
218
        else:
239
219
            domains = (
240
220
                'bazaar.%s' % domain
241
 
                for domain in self.LAUNCHPAD_DOMAINS.itervalues())
 
221
                for domain in self.LAUNCHPAD_DOMAINS.values())
242
222
            if hostinfo not in domains:
243
223
                raise NotLaunchpadBranch(branch_url)
244
224
        return path.lstrip('/')
246
226
    def get_web_url_from_branch_url(self, branch_url, _request_factory=None):
247
227
        """Get the Launchpad web URL for the given branch URL.
248
228
 
249
 
        :raise errors.InvalidURL: if 'branch_url' cannot be identified as a
 
229
        :raise InvalidURL: if 'branch_url' cannot be identified as a
250
230
            Launchpad branch URL.
251
231
        :return: The URL of the branch on Launchpad.
252
232
        """
259
239
 
260
240
    # Set this to the XMLRPC method name.
261
241
    _methodname = None
262
 
    _authenticated = True
263
242
 
264
243
    def _request_params(self):
265
244
        """Return the arguments to pass to the method"""
268
247
    def submit(self, service):
269
248
        """Submit request to Launchpad XMLRPC server.
270
249
 
271
 
        :param service: LaunchpadService indicating where to send
272
 
            the request and the authentication credentials.
 
250
        :param service: LaunchpadService indicating where to send the request.
273
251
        """
274
 
        return service.send_request(self._methodname, self._request_params(),
275
 
                                    self._authenticated)
 
252
        return service.send_request(self._methodname, self._request_params())
276
253
 
277
254
 
278
255
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, '')
 
256
    """Service that just absorbs requests without sending to server."""
 
257
 
 
258
    def send_request(self, method_name, method_params):
 
259
        pass
346
260
 
347
261
 
348
262
class ResolveLaunchpadPathRequest(BaseRequest):
349
263
    """Request to resolve the path component of an lp: URL."""
350
264
 
351
265
    _methodname = 'resolve_lp_path'
352
 
    _authenticated = False
353
266
 
354
267
    def __init__(self, path):
355
268
        if not path:
356
 
            raise errors.InvalidURL(path=path,
357
 
                                    extra="You must specify a project.")
 
269
            raise InvalidURL(url=path, extra="You must specify a project.")
358
270
        self.path = path
359
271
 
360
272
    def _request_params(self):