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

  • Committer: Marius Kruger
  • Date: 2010-07-10 21:28:56 UTC
  • mto: (5384.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5385.
  • Revision ID: marius.kruger@enerweb.co.za-20100710212856-uq4ji3go0u5se7hx
* Update documentation
* add NEWS

Show diffs side-by-side

added added

removed removed

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