← Back to branch summary

~bzr/ubuntu/lucid/bzr/beta-ppa

« back to all changes in this revision

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

  • Committer: Martin Pool
  • Date: 2010-07-02 07:29:40 UTC
  • mfrom: (129.1.7 packaging-karmic)
  • Revision ID: mbp@sourcefrog.net-20100702072940-hpzq5elg8wjve8rh
http://bugs.debian.org/452024
http://bugs.debian.org/464688
http://bugs.debian.org/523595
http://bugs.debian.org/526233
http://bugs.debian.org/537708
http://bugs.debian.org/555336
http://bugs.debian.org/555343
https://launchpad.net/bugs/249452
https://launchpad.net/bugs/385074
* PPA rebuild.
* PPA rebuild for Karmic.
* PPA rebuild for Jaunty.
* PPA rebuild for Hardy.
* From postinst, actually remove the example bash completion scripts.
  (LP: #249452)
* New upstream release.
* New upstream release.
* New upstream release.
* Revert change to Build-depends: Dapper does not have python-central.
  Should be python-support..
* Target ppa..
* Target ppa..
* Target ppa..
* Target ppa..
* New upstream release.
* Switch to dpkg-source 3.0 (quilt) format.
* Bump standards version to 3.8.4.
* Remove embedded copy of python-configobj. Closes: #555336
* Remove embedded copy of python-elementtree. Closes: #555343
* Change section from 'Devel' to 'Vcs'..
* Change section from 'Devel' to 'Vcs'..
* Change section from 'Devel' to 'Vcs'..
* Change section from 'Devel' to 'Vcs'..
* Change section from 'Devel' to 'Vcs'..
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* debian/control: Fix obsolete-relation-form-in-source
  lintian warning. 
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Split out docs into bzr-doc package.
* New upstream release.
* Added John Francesco Ferlito to Uploaders.
* Fix install path to quick-reference guide
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Fix FTBFS due to path changes, again.
* Fix FTBFS due to doc paths changing
* New upstream release.
* Fix FTBFS due to path changes, again.
* Fix FTBFS due to doc paths changing
* New upstream release.
* Fix FTBFS due to path changes, again.
* Fix FTBFS due to doc paths changing
* New upstream release.
* Fix FTBFS due to path changes, again, again.
* Fix FTBFS due to path changes, again.
* Fix FTBFS due to path changes.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Bump standards version to 3.8.3.
* Remove unused patch system.
* New upstream release.
* New upstream release.
* New upstream release.
* Fix copy and paste tab error in .install file
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
 + Fixes compatibility with Python 2.4. Closes: #537708
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream version.
* Bump standards version to 3.8.2.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Add python-pyrex to build-deps to ensure C extensions are always build.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Split documentation into bzr-doc package. ((LP: #385074)
* Multiple packaging changes to make us more linitan clean.
* New upstream release.
* Split documentation into bzr-doc package. ((LP: #385074)
* Multiple packaging changes to make us more linitan clean.
* New upstream release.
* Split documentation into bzr-doc package. ((LP: #385074)
* Multiple packaging changes to make us more linitan clean.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Fix API compatibility version. (Closes: #526233)
* New upstream release.
  + Fixes default format for upgrade command. (Closes: #464688)
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Add missing dependency on zlib development library. (Closes:
  #523595)
* Add zlib build-depends.
* Add zlib build-depends.
* Add zlib build-depends.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Move to section vcs.
* Bump standards version to 3.8.1.
* New upstream release.
* Remove temporary patch for missing .c files from distribution
* New upstream release.
* Remove temporary patch for missing .c files from distribution
* New upstream release.
* Remove temporary patch for missing .c files from distribution
* Add temporary patch for missing .c files from distribution
* Add temporary patch for missing .c files from distribution
* Add temporary patch for missing .c files from distribution
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Recommend ca-certificates. (Closes: #452024)
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Update watch file. bazaar now uses launchpad to host its sources.
* Remove patch for inventory root revision copy, applied upstream.
* New upstream release.
* New upstream release.
* New upstream release
* Force removal of files installed in error to /etc/bash_completion.d/
  (LP: #249452)
* New upstream release.
* New upstream release
* New upstream release.
* Bump standards version.
* Include patch for inventory root revision copy, required for bzr-svn.
* New upstream release.
* Remove unused lintian overrides.
* Correct the package version not to be native.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Final 1.5 release.
* New upstream release.
* New upstream release.
* New upstream release.
* Add myself as a co-maintainer.
* Add a Dm-Upload-Allowed: yes header.
* New upstream bugfix release.
* New upstream release.
* Final 1.3 release.
* New upstream release.
* First release candidate of the upcoming 1.3 release.
* Rebuild to fix the problem caused by a build with a broken python-central.
* New upstream release.
* Rebuild for dapper PPA.
* Apply Lamont's patches to fix build-dependencies on dapper.
  (See: https://bugs.launchpad.net/bzr/+bug/189915)

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://bazaar-vcs.org/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
    # 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
    DEFAULT_SERVICE_URL = LAUNCHPAD_INSTANCE[DEFAULT_INSTANCE]
 
107
 
 
108
    transport = None
 
109
    registrant_email = None
 
110
    registrant_password = None
 
111
 
 
112
 
 
113
    def __init__(self, transport=None, lp_instance=None):
 
114
        """Construct a new service talking to the launchpad rpc server"""
 
115
        self._lp_instance = lp_instance
 
116
        if transport is None:
 
117
            uri_type = urllib.splittype(self.service_url)[0]
 
118
            transport = XMLRPCTransport(uri_type)
 
119
            transport.user_agent = 'bzr/%s (xmlrpclib/%s)' \
 
120
                    % (_bzrlib_version, xmlrpclib.__version__)
 
121
        self.transport = transport
 
122
 
 
123
    @property
 
124
    def service_url(self):
 
125
        """Return the http or https url for the xmlrpc server.
 
126
 
 
127
        This does not include the username/password credentials.
 
128
        """
 
129
        key = 'BZR_LP_XMLRPC_URL'
 
130
        if key in os.environ:
 
131
            return os.environ[key]
 
132
        elif self._lp_instance is not None:
 
133
            try:
 
134
                return self.LAUNCHPAD_INSTANCE[self._lp_instance]
 
135
            except KeyError:
 
136
                raise InvalidLaunchpadInstance(self._lp_instance)
 
137
        else:
 
138
            return self.DEFAULT_SERVICE_URL
 
139
 
 
140
    @classmethod
 
141
    def for_url(cls, url, **kwargs):
 
142
        """Return the Launchpad service corresponding to the given URL."""
 
143
        result = urlsplit(url)
 
144
        lp_instance = result[1]
 
145
        if lp_instance == '':
 
146
            lp_instance = None
 
147
        elif lp_instance not in cls.LAUNCHPAD_INSTANCE:
 
148
            raise errors.InvalidURL(path=url)
 
149
        return cls(lp_instance=lp_instance, **kwargs)
 
150
 
 
151
    def get_proxy(self, authenticated):
 
152
        """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)
 
196
        method = getattr(proxy, method_name)
 
197
        try:
 
198
            result = method(*method_params)
 
199
        except xmlrpclib.ProtocolError, e:
 
200
            if e.errcode == 301:
 
201
                # TODO: This can give a ProtocolError representing a 301 error, whose
 
202
                # e.headers['location'] tells where to go and e.errcode==301; should
 
203
                # probably log something and retry on the new url.
 
204
                raise NotImplementedError("should resend request to %s, but this isn't implemented"
 
205
                        % e.headers.get('Location', 'NO-LOCATION-PRESENT'))
 
206
            else:
 
207
                # we don't want to print the original message because its
 
208
                # str representation includes the plaintext password.
 
209
                # TODO: print more headers to help in tracking down failures
 
210
                raise errors.BzrError("xmlrpc protocol error connecting to %s: %s %s"
 
211
                        % (self.service_url, e.errcode, e.errmsg))
 
212
        except socket.gaierror, e:
 
213
            raise errors.ConnectionError(
 
214
                "Could not resolve '%s'" % self.domain,
 
215
                orig_error=e)
 
216
        return result
 
217
 
 
218
    @property
 
219
    def domain(self):
 
220
        if self._lp_instance is None:
 
221
            instance = self.DEFAULT_INSTANCE
 
222
        else:
 
223
            instance = self._lp_instance
 
224
        return self.LAUNCHPAD_DOMAINS[instance]
 
225
 
 
226
    def _guess_branch_path(self, branch_url, _request_factory=None):
 
227
        scheme, hostinfo, path = urlsplit(branch_url)[:3]
 
228
        if _request_factory is None:
 
229
            _request_factory = ResolveLaunchpadPathRequest
 
230
        if scheme == 'lp':
 
231
            resolve = _request_factory(path)
 
232
            try:
 
233
                result = resolve.submit(self)
 
234
            except xmlrpclib.Fault, fault:
 
235
                raise errors.InvalidURL(branch_url, str(fault))
 
236
            branch_url = result['urls'][0]
 
237
            path = urlsplit(branch_url)[2]
 
238
        else:
 
239
            domains = (
 
240
                'bazaar.%s' % domain
 
241
                for domain in self.LAUNCHPAD_DOMAINS.itervalues())
 
242
            if hostinfo not in domains:
 
243
                raise NotLaunchpadBranch(branch_url)
 
244
        return path.lstrip('/')
 
245
 
 
246
    def get_web_url_from_branch_url(self, branch_url, _request_factory=None):
 
247
        """Get the Launchpad web URL for the given branch URL.
 
248
 
 
249
        :raise errors.InvalidURL: if 'branch_url' cannot be identified as a
 
250
            Launchpad branch URL.
 
251
        :return: The URL of the branch on Launchpad.
 
252
        """
 
253
        path = self._guess_branch_path(branch_url, _request_factory)
 
254
        return urlutils.join('https://code.%s' % self.domain, path)
 
255
 
 
256
 
 
257
class BaseRequest(object):
 
258
    """Base request for talking to a XMLRPC server."""
 
259
 
 
260
    # Set this to the XMLRPC method name.
 
261
    _methodname = None
 
262
    _authenticated = True
 
263
 
 
264
    def _request_params(self):
 
265
        """Return the arguments to pass to the method"""
 
266
        raise NotImplementedError(self._request_params)
 
267
 
 
268
    def submit(self, service):
 
269
        """Submit request to Launchpad XMLRPC server.
 
270
 
 
271
        :param service: LaunchpadService indicating where to send
 
272
            the request and the authentication credentials.
 
273
        """
 
274
        return service.send_request(self._methodname, self._request_params(),
 
275
                                    self._authenticated)
 
276
 
 
277
 
 
278
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, '')
 
346
 
 
347
 
 
348
class ResolveLaunchpadPathRequest(BaseRequest):
 
349
    """Request to resolve the path component of an lp: URL."""
 
350
 
 
351
    _methodname = 'resolve_lp_path'
 
352
    _authenticated = False
 
353
 
 
354
    def __init__(self, path):
 
355
        if not path:
 
356
            raise errors.InvalidURL(path=path,
 
357
                                    extra="You must specify a project.")
 
358
        self.path = path
 
359
 
 
360
    def _request_params(self):
 
361
        """Return xmlrpc request parameters"""
 
362
        return (self.path,)