← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/plugins/launchpad/lp_registration.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 04:10:52 UTC
  • mfrom: (6616.1.1 fix-en-user-guide)
  • Revision ID: pqm@pqm.ubuntu.com-20160421041052-clcye7ns1qcl2n7w
(richard-wilbur) Ensure build of English use guide always uses English text
 even when user's locale specifies a different language. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugins/launchpad/lp_registration.py
1
 
# Copyright (C) 2006 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
 
18
 
from getpass import getpass
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
 
19
20
import os
 
21
import socket
20
22
from urlparse import urlsplit, urlunsplit
21
23
import urllib
22
24
import xmlrpclib
24
26
from bzrlib import (
25
27
    config,
26
28
    errors,
 
29
    urlutils,
27
30
    __version__ as _bzrlib_version,
28
31
    )
 
32
from bzrlib.transport.http import _urllib2_wrappers
 
33
 
29
34
 
30
35
# for testing, do
31
36
'''
32
37
export BZR_LP_XMLRPC_URL=http://xmlrpc.staging.launchpad.net/bazaar/
33
38
'''
34
39
 
 
40
class InvalidLaunchpadInstance(errors.BzrError):
 
41
 
 
42
    _fmt = "%(lp_instance)s is not a valid Launchpad instance."
 
43
 
 
44
    def __init__(self, lp_instance):
 
45
        errors.BzrError.__init__(self, lp_instance=lp_instance)
 
46
 
 
47
 
 
48
class NotLaunchpadBranch(errors.BzrError):
 
49
 
 
50
    _fmt = "%(url)s is not registered on Launchpad."
 
51
 
 
52
    def __init__(self, url):
 
53
        errors.BzrError.__init__(self, url=url)
 
54
 
 
55
 
 
56
class XMLRPCTransport(xmlrpclib.Transport):
 
57
 
 
58
    def __init__(self, scheme):
 
59
        xmlrpclib.Transport.__init__(self)
 
60
        self._scheme = scheme
 
61
        self._opener = _urllib2_wrappers.Opener()
 
62
        self.verbose = 0
 
63
 
 
64
    def request(self, host, handler, request_body, verbose=0):
 
65
        self.verbose = verbose
 
66
        url = self._scheme + "://" + host + handler
 
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")
 
71
 
 
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)
 
77
 
 
78
 
35
79
class LaunchpadService(object):
36
80
    """A service to talk to Launchpad via XMLRPC.
37
 
    
38
 
    See http://bazaar-vcs.org/Specs/LaunchpadRpc for the methods we can call.
 
81
 
 
82
    See http://wiki.bazaar.canonical.com/Specs/LaunchpadRpc for the methods we can call.
39
83
    """
40
84
 
41
 
    # NB: this should always end in a slash to avoid xmlrpclib appending
 
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
 
 
93
    # NB: these should always end in a slash to avoid xmlrpclib appending
42
94
    # '/RPC2'
43
 
    DEFAULT_SERVICE_URL = 'https://xmlrpc.launchpad.net/bazaar/'
 
95
    LAUNCHPAD_INSTANCE = {}
 
96
    for instance, domain in LAUNCHPAD_DOMAINS.iteritems():
 
97
        LAUNCHPAD_INSTANCE[instance] = 'https://xmlrpc.%s/bazaar/' % domain
 
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'
 
102
    DEFAULT_SERVICE_URL = LAUNCHPAD_INSTANCE[DEFAULT_INSTANCE]
44
103
 
45
104
    transport = None
46
105
    registrant_email = None
47
106
    registrant_password = None
48
107
 
49
108
 
50
 
    def __init__(self, transport=None):
 
109
    def __init__(self, transport=None, lp_instance=None):
51
110
        """Construct a new service talking to the launchpad rpc server"""
 
111
        self._lp_instance = lp_instance
52
112
        if transport is None:
53
113
            uri_type = urllib.splittype(self.service_url)[0]
54
 
            if uri_type == 'https':
55
 
                transport = xmlrpclib.SafeTransport()
56
 
            else:
57
 
                transport = xmlrpclib.Transport()
 
114
            transport = XMLRPCTransport(uri_type)
58
115
            transport.user_agent = 'bzr/%s (xmlrpclib/%s)' \
59
116
                    % (_bzrlib_version, xmlrpclib.__version__)
60
117
        self.transport = transport
61
118
 
62
 
 
63
119
    @property
64
120
    def service_url(self):
65
121
        """Return the http or https url for the xmlrpc server.
69
125
        key = 'BZR_LP_XMLRPC_URL'
70
126
        if key in os.environ:
71
127
            return os.environ[key]
 
128
        elif self._lp_instance is not None:
 
129
            try:
 
130
                return self.LAUNCHPAD_INSTANCE[self._lp_instance]
 
131
            except KeyError:
 
132
                raise InvalidLaunchpadInstance(self._lp_instance)
72
133
        else:
73
134
            return self.DEFAULT_SERVICE_URL
74
135
 
 
136
    @classmethod
 
137
    def for_url(cls, url, **kwargs):
 
138
        """Return the Launchpad service corresponding to the given URL."""
 
139
        result = urlsplit(url)
 
140
        lp_instance = result[1]
 
141
        if lp_instance == '':
 
142
            lp_instance = None
 
143
        elif lp_instance not in cls.LAUNCHPAD_INSTANCE:
 
144
            raise errors.InvalidURL(path=url)
 
145
        return cls(lp_instance=lp_instance, **kwargs)
 
146
 
75
147
    def get_proxy(self, authenticated):
76
148
        """Return the proxy for XMLRPC requests."""
77
149
        if authenticated:
79
151
            # TODO: if there's no registrant email perhaps we should
80
152
            # just connect anonymously?
81
153
            scheme, hostinfo, path = urlsplit(self.service_url)[:3]
82
 
            assert '@' not in hostinfo
83
 
            assert self.registrant_email is not None
84
 
            assert self.registrant_password is not None
 
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()
85
160
            # TODO: perhaps fully quote the password to make it very slightly
86
161
            # obscured
87
162
            # TODO: can we perhaps add extra Authorization headers
89
164
            # the url?  perhaps a bit more secure against accidentally
90
165
            # revealing it.  std66 s3.2.1 discourages putting the
91
166
            # password in the url.
92
 
            hostinfo = '%s:%s@%s' % (urllib.quote(self.registrant_email),
93
 
                                     urllib.quote(self.registrant_password),
 
167
            hostinfo = '%s:%s@%s' % (urlutils.quote(self.registrant_email),
 
168
                                     urlutils.quote(self.registrant_password),
94
169
                                     hostinfo)
95
170
            url = urlunsplit((scheme, hostinfo, path, '', ''))
96
171
        else:
114
189
 
115
190
    def send_request(self, method_name, method_params, authenticated):
116
191
        proxy = self.get_proxy(authenticated)
117
 
        assert method_name
118
192
        method = getattr(proxy, method_name)
119
193
        try:
120
194
            result = method(*method_params)
131
205
                # TODO: print more headers to help in tracking down failures
132
206
                raise errors.BzrError("xmlrpc protocol error connecting to %s: %s %s"
133
207
                        % (self.service_url, e.errcode, e.errmsg))
 
208
        except socket.gaierror, e:
 
209
            raise errors.ConnectionError(
 
210
                "Could not resolve '%s'" % self.domain,
 
211
                orig_error=e)
134
212
        return result
135
213
 
 
214
    @property
 
215
    def domain(self):
 
216
        if self._lp_instance is None:
 
217
            instance = self.DEFAULT_INSTANCE
 
218
        else:
 
219
            instance = self._lp_instance
 
220
        return self.LAUNCHPAD_DOMAINS[instance]
 
221
 
 
222
    def _guess_branch_path(self, branch_url, _request_factory=None):
 
223
        scheme, hostinfo, path = urlsplit(branch_url)[:3]
 
224
        if _request_factory is None:
 
225
            _request_factory = ResolveLaunchpadPathRequest
 
226
        if scheme == 'lp':
 
227
            resolve = _request_factory(path)
 
228
            try:
 
229
                result = resolve.submit(self)
 
230
            except xmlrpclib.Fault, fault:
 
231
                raise errors.InvalidURL(branch_url, str(fault))
 
232
            branch_url = result['urls'][0]
 
233
            path = urlsplit(branch_url)[2]
 
234
        else:
 
235
            domains = (
 
236
                'bazaar.%s' % domain
 
237
                for domain in self.LAUNCHPAD_DOMAINS.itervalues())
 
238
            if hostinfo not in domains:
 
239
                raise NotLaunchpadBranch(branch_url)
 
240
        return path.lstrip('/')
 
241
 
 
242
    def get_web_url_from_branch_url(self, branch_url, _request_factory=None):
 
243
        """Get the Launchpad web URL for the given branch URL.
 
244
 
 
245
        :raise errors.InvalidURL: if 'branch_url' cannot be identified as a
 
246
            Launchpad branch URL.
 
247
        :return: The URL of the branch on Launchpad.
 
248
        """
 
249
        path = self._guess_branch_path(branch_url, _request_factory)
 
250
        return urlutils.join('https://code.%s' % self.domain, path)
 
251
 
136
252
 
137
253
class BaseRequest(object):
138
254
    """Base request for talking to a XMLRPC server."""
157
273
 
158
274
class DryRunLaunchpadService(LaunchpadService):
159
275
    """Service that just absorbs requests without sending to server.
160
 
    
 
276
 
161
277
    The dummy service does not need authentication.
162
278
    """
163
279
 
180
296
                 author_email='',
181
297
                 product_name='',
182
298
                 ):
183
 
        assert branch_url
 
299
        if not branch_url:
 
300
            raise errors.InvalidURL(branch_url, "You need to specify a non-empty branch URL.")
184
301
        self.branch_url = branch_url
185
302
        if branch_name:
186
303
            self.branch_name = branch_name
214
331
    _methodname = 'link_branch_to_bug'
215
332
 
216
333
    def __init__(self, branch_url, bug_id):
217
 
        assert branch_url
218
334
        self.bug_id = bug_id
219
335
        self.branch_url = branch_url
220
336
 
232
348
    _authenticated = False
233
349
 
234
350
    def __init__(self, path):
235
 
        assert path
 
351
        if not path:
 
352
            raise errors.InvalidURL(path=path,
 
353
                                    extra="You must specify a project.")
236
354
        self.path = path
237
355
 
238
356
    def _request_params(self):