← 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: Robert Collins
  • Date: 2005-10-19 10:11:57 UTC
  • mfrom: (1185.16.78)
  • mto: This revision was merged to the branch mainline in revision 1470.
  • Revision ID: robertc@robertcollins.net-20051019101157-17438d311e746b4f
merge from upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugins/launchpad/lp_registration.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
2
 
#
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
#
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
#
13
 
# You should have received a copy of the GNU General Public License
14
 
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
 
18
 
import os
19
 
import socket
20
 
from urlparse import urlsplit, urlunsplit
21
 
import urllib
22
 
import xmlrpclib
23
 
 
24
 
from bzrlib import (
25
 
    config,
26
 
    errors,
27
 
    urlutils,
28
 
    __version__ as _bzrlib_version,
29
 
    )
30
 
from bzrlib.transport.http import _urllib2_wrappers
31
 
 
32
 
 
33
 
# for testing, do
34
 
'''
35
 
export BZR_LP_XMLRPC_URL=http://xmlrpc.staging.launchpad.net/bazaar/
36
 
'''
37
 
 
38
 
class InvalidLaunchpadInstance(errors.BzrError):
39
 
 
40
 
    _fmt = "%(lp_instance)s is not a valid Launchpad instance."
41
 
 
42
 
    def __init__(self, lp_instance):
43
 
        errors.BzrError.__init__(self, lp_instance=lp_instance)
44
 
 
45
 
 
46
 
class NotLaunchpadBranch(errors.BzrError):
47
 
 
48
 
    _fmt = "%(url)s is not registered on Launchpad."
49
 
 
50
 
    def __init__(self, url):
51
 
        errors.BzrError.__init__(self, url=url)
52
 
 
53
 
 
54
 
class XMLRPCTransport(xmlrpclib.Transport):
55
 
 
56
 
    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)
62
 
        self._scheme = scheme
63
 
        self._opener = _urllib2_wrappers.Opener()
64
 
        self.verbose = 0
65
 
 
66
 
    def request(self, host, handler, request_body, verbose=0):
67
 
        self.verbose = verbose
68
 
        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)
72
 
        request.add_header("Content-Type", "text/xml")
73
 
 
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)
79
 
 
80
 
 
81
 
class LaunchpadService(object):
82
 
    """A service to talk to Launchpad via XMLRPC.
83
 
 
84
 
    See http://wiki.bazaar.canonical.com/Specs/LaunchpadRpc for the methods we can call.
85
 
    """
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
 
 
95
 
    # NB: these should always end in a slash to avoid xmlrpclib appending
96
 
    # '/RPC2'
97
 
    LAUNCHPAD_INSTANCE = {}
98
 
    for instance, domain in LAUNCHPAD_DOMAINS.iteritems():
99
 
        LAUNCHPAD_INSTANCE[instance] = 'https://xmlrpc.%s/bazaar/' % domain
100
 
 
101
 
    # Previously 'edge' was used to avoid a launchpad bug with redirection
102
 
    DEFAULT_INSTANCE = 'production'
103
 
    DEFAULT_SERVICE_URL = LAUNCHPAD_INSTANCE[DEFAULT_INSTANCE]
104
 
 
105
 
    transport = None
106
 
    registrant_email = None
107
 
    registrant_password = None
108
 
 
109
 
 
110
 
    def __init__(self, transport=None, lp_instance=None):
111
 
        """Construct a new service talking to the launchpad rpc server"""
112
 
        self._lp_instance = lp_instance
113
 
        if transport is None:
114
 
            uri_type = urllib.splittype(self.service_url)[0]
115
 
            transport = XMLRPCTransport(uri_type)
116
 
            transport.user_agent = 'bzr/%s (xmlrpclib/%s)' \
117
 
                    % (_bzrlib_version, xmlrpclib.__version__)
118
 
        self.transport = transport
119
 
 
120
 
    @property
121
 
    def service_url(self):
122
 
        """Return the http or https url for the xmlrpc server.
123
 
 
124
 
        This does not include the username/password credentials.
125
 
        """
126
 
        key = 'BZR_LP_XMLRPC_URL'
127
 
        if key in os.environ:
128
 
            return os.environ[key]
129
 
        elif self._lp_instance is not None:
130
 
            try:
131
 
                return self.LAUNCHPAD_INSTANCE[self._lp_instance]
132
 
            except KeyError:
133
 
                raise InvalidLaunchpadInstance(self._lp_instance)
134
 
        else:
135
 
            return self.DEFAULT_SERVICE_URL
136
 
 
137
 
    @classmethod
138
 
    def for_url(cls, url, **kwargs):
139
 
        """Return the Launchpad service corresponding to the given URL."""
140
 
        result = urlsplit(url)
141
 
        lp_instance = result[1]
142
 
        if lp_instance == '':
143
 
            lp_instance = None
144
 
        elif lp_instance not in cls.LAUNCHPAD_INSTANCE:
145
 
            raise errors.InvalidURL(path=url)
146
 
        return cls(lp_instance=lp_instance, **kwargs)
147
 
 
148
 
    def get_proxy(self, authenticated):
149
 
        """Return the proxy for XMLRPC requests."""
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)
193
 
        method = getattr(proxy, method_name)
194
 
        try:
195
 
            result = method(*method_params)
196
 
        except xmlrpclib.ProtocolError, e:
197
 
            if e.errcode == 301:
198
 
                # TODO: This can give a ProtocolError representing a 301 error, whose
199
 
                # e.headers['location'] tells where to go and e.errcode==301; should
200
 
                # probably log something and retry on the new url.
201
 
                raise NotImplementedError("should resend request to %s, but this isn't implemented"
202
 
                        % e.headers.get('Location', 'NO-LOCATION-PRESENT'))
203
 
            else:
204
 
                # we don't want to print the original message because its
205
 
                # str representation includes the plaintext password.
206
 
                # TODO: print more headers to help in tracking down failures
207
 
                raise errors.BzrError("xmlrpc protocol error connecting to %s: %s %s"
208
 
                        % (self.service_url, e.errcode, e.errmsg))
209
 
        except socket.gaierror, e:
210
 
            raise errors.ConnectionError(
211
 
                "Could not resolve '%s'" % self.domain,
212
 
                orig_error=e)
213
 
        return result
214
 
 
215
 
    @property
216
 
    def domain(self):
217
 
        if self._lp_instance is None:
218
 
            instance = self.DEFAULT_INSTANCE
219
 
        else:
220
 
            instance = self._lp_instance
221
 
        return self.LAUNCHPAD_DOMAINS[instance]
222
 
 
223
 
    def _guess_branch_path(self, branch_url, _request_factory=None):
224
 
        scheme, hostinfo, path = urlsplit(branch_url)[:3]
225
 
        if _request_factory is None:
226
 
            _request_factory = ResolveLaunchpadPathRequest
227
 
        if scheme == 'lp':
228
 
            resolve = _request_factory(path)
229
 
            try:
230
 
                result = resolve.submit(self)
231
 
            except xmlrpclib.Fault, fault:
232
 
                raise errors.InvalidURL(branch_url, str(fault))
233
 
            branch_url = result['urls'][0]
234
 
            path = urlsplit(branch_url)[2]
235
 
        else:
236
 
            domains = (
237
 
                'bazaar.%s' % domain
238
 
                for domain in self.LAUNCHPAD_DOMAINS.itervalues())
239
 
            if hostinfo not in domains:
240
 
                raise NotLaunchpadBranch(branch_url)
241
 
        return path.lstrip('/')
242
 
 
243
 
    def get_web_url_from_branch_url(self, branch_url, _request_factory=None):
244
 
        """Get the Launchpad web URL for the given branch URL.
245
 
 
246
 
        :raise errors.InvalidURL: if 'branch_url' cannot be identified as a
247
 
            Launchpad branch URL.
248
 
        :return: The URL of the branch on Launchpad.
249
 
        """
250
 
        path = self._guess_branch_path(branch_url, _request_factory)
251
 
        return urlutils.join('https://code.%s' % self.domain, path)
252
 
 
253
 
 
254
 
class BaseRequest(object):
255
 
    """Base request for talking to a XMLRPC server."""
256
 
 
257
 
    # Set this to the XMLRPC method name.
258
 
    _methodname = None
259
 
    _authenticated = True
260
 
 
261
 
    def _request_params(self):
262
 
        """Return the arguments to pass to the method"""
263
 
        raise NotImplementedError(self._request_params)
264
 
 
265
 
    def submit(self, service):
266
 
        """Submit request to Launchpad XMLRPC server.
267
 
 
268
 
        :param service: LaunchpadService indicating where to send
269
 
            the request and the authentication credentials.
270
 
        """
271
 
        return service.send_request(self._methodname, self._request_params(),
272
 
                                    self._authenticated)
273
 
 
274
 
 
275
 
class DryRunLaunchpadService(LaunchpadService):
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, '')
343
 
 
344
 
 
345
 
class ResolveLaunchpadPathRequest(BaseRequest):
346
 
    """Request to resolve the path component of an lp: URL."""
347
 
 
348
 
    _methodname = 'resolve_lp_path'
349
 
    _authenticated = False
350
 
 
351
 
    def __init__(self, path):
352
 
        if not path:
353
 
            raise errors.InvalidURL(path=path,
354
 
                                    extra="You must specify a project.")
355
 
        self.path = path
356
 
 
357
 
    def _request_params(self):
358
 
        """Return xmlrpc request parameters"""
359
 
        return (self.path,)