/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-05-11 18:38:21 UTC
  • mto: This revision was merged to the branch mainline in revision 7301.
  • Revision ID: jelmer@jelmer.uk-20190511183821-3xl6jo6kiy5mf4sa
Integrate _urllib2_wrappers.

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