← 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: 2010-04-08 04:34:03 UTC
  • mfrom: (5138 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5139.
  • Revision ID: robertc@robertcollins.net-20100408043403-56z0d07vdqrx7f3t
Update bugfix for 528114 to trunk.

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-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
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
 
19
18
import os
 
19
import socket
20
20
from urlparse import urlsplit, urlunsplit
21
21
import urllib
22
22
import xmlrpclib
24
24
from bzrlib import (
25
25
    config,
26
26
    errors,
 
27
    urlutils,
27
28
    __version__ as _bzrlib_version,
28
29
    )
 
30
from bzrlib.transport.http import _urllib2_wrappers
 
31
 
29
32
 
30
33
# for testing, do
31
34
'''
32
35
export BZR_LP_XMLRPC_URL=http://xmlrpc.staging.launchpad.net/bazaar/
33
36
'''
34
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
 
35
81
class LaunchpadService(object):
36
82
    """A service to talk to Launchpad via XMLRPC.
37
 
    
38
 
    See http://bazaar-vcs.org/Specs/LaunchpadRpc for the methods we can call.
 
83
 
 
84
    See http://wiki.bazaar.canonical.com/Specs/LaunchpadRpc for the methods we can call.
39
85
    """
40
86
 
41
 
    # NB: this should always end in a slash to avoid xmlrpclib appending
 
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
42
96
    # '/RPC2'
43
 
    DEFAULT_SERVICE_URL = 'https://xmlrpc.launchpad.net/bazaar/'
 
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]
44
107
 
45
108
    transport = None
46
109
    registrant_email = None
47
110
    registrant_password = None
48
111
 
49
112
 
50
 
    def __init__(self, transport=None):
 
113
    def __init__(self, transport=None, lp_instance=None):
51
114
        """Construct a new service talking to the launchpad rpc server"""
 
115
        self._lp_instance = lp_instance
52
116
        if transport is None:
53
117
            uri_type = urllib.splittype(self.service_url)[0]
54
 
            if uri_type == 'https':
55
 
                transport = xmlrpclib.SafeTransport()
56
 
            else:
57
 
                transport = xmlrpclib.Transport()
 
118
            transport = XMLRPCTransport(uri_type)
58
119
            transport.user_agent = 'bzr/%s (xmlrpclib/%s)' \
59
120
                    % (_bzrlib_version, xmlrpclib.__version__)
60
121
        self.transport = transport
61
122
 
62
 
 
63
123
    @property
64
124
    def service_url(self):
65
125
        """Return the http or https url for the xmlrpc server.
69
129
        key = 'BZR_LP_XMLRPC_URL'
70
130
        if key in os.environ:
71
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)
72
137
        else:
73
138
            return self.DEFAULT_SERVICE_URL
74
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
 
75
151
    def get_proxy(self, authenticated):
76
152
        """Return the proxy for XMLRPC requests."""
77
153
        if authenticated:
79
155
            # TODO: if there's no registrant email perhaps we should
80
156
            # just connect anonymously?
81
157
            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
 
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()
85
164
            # TODO: perhaps fully quote the password to make it very slightly
86
165
            # obscured
87
166
            # TODO: can we perhaps add extra Authorization headers
114
193
 
115
194
    def send_request(self, method_name, method_params, authenticated):
116
195
        proxy = self.get_proxy(authenticated)
117
 
        assert method_name
118
196
        method = getattr(proxy, method_name)
119
197
        try:
120
198
            result = method(*method_params)
131
209
                # TODO: print more headers to help in tracking down failures
132
210
                raise errors.BzrError("xmlrpc protocol error connecting to %s: %s %s"
133
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)
134
216
        return result
135
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
 
136
256
 
137
257
class BaseRequest(object):
138
258
    """Base request for talking to a XMLRPC server."""
157
277
 
158
278
class DryRunLaunchpadService(LaunchpadService):
159
279
    """Service that just absorbs requests without sending to server.
160
 
    
 
280
 
161
281
    The dummy service does not need authentication.
162
282
    """
163
283
 
180
300
                 author_email='',
181
301
                 product_name='',
182
302
                 ):
183
 
        assert branch_url
 
303
        if not branch_url:
 
304
            raise errors.InvalidURL(branch_url, "You need to specify a non-empty branch URL.")
184
305
        self.branch_url = branch_url
185
306
        if branch_name:
186
307
            self.branch_name = branch_name
214
335
    _methodname = 'link_branch_to_bug'
215
336
 
216
337
    def __init__(self, branch_url, bug_id):
217
 
        assert branch_url
218
338
        self.bug_id = bug_id
219
339
        self.branch_url = branch_url
220
340
 
232
352
    _authenticated = False
233
353
 
234
354
    def __init__(self, path):
235
 
        assert path
 
355
        if not path:
 
356
            raise errors.InvalidURL(path=path,
 
357
                                    extra="You must specify a project.")
236
358
        self.path = path
237
359
 
238
360
    def _request_params(self):