1
# Copyright (C) 2006-2011 Canonical Ltd
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.
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.
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
20
from urlparse import urlsplit, urlunsplit
28
__version__ as _bzrlib_version,
30
from bzrlib.transport.http import _urllib2_wrappers
35
export BZR_LP_XMLRPC_URL=http://xmlrpc.staging.launchpad.net/bazaar/
38
class InvalidLaunchpadInstance(errors.BzrError):
40
_fmt = "%(lp_instance)s is not a valid Launchpad instance."
42
def __init__(self, lp_instance):
43
errors.BzrError.__init__(self, lp_instance=lp_instance)
46
class NotLaunchpadBranch(errors.BzrError):
48
_fmt = "%(url)s is not registered on Launchpad."
50
def __init__(self, url):
51
errors.BzrError.__init__(self, url=url)
54
class XMLRPCTransport(xmlrpclib.Transport):
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)
63
self._opener = _urllib2_wrappers.Opener()
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")
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)
81
class LaunchpadService(object):
82
"""A service to talk to Launchpad via XMLRPC.
84
See http://wiki.bazaar.canonical.com/Specs/LaunchpadRpc for the methods we can call.
88
'production': 'launchpad.net',
89
'staging': 'staging.launchpad.net',
90
'qastaging': 'qastaging.launchpad.net',
91
'demo': 'demo.launchpad.net',
92
'dev': 'launchpad.dev',
95
# NB: these should always end in a slash to avoid xmlrpclib appending
97
LAUNCHPAD_INSTANCE = {}
98
for instance, domain in LAUNCHPAD_DOMAINS.iteritems():
99
LAUNCHPAD_INSTANCE[instance] = 'https://xmlrpc.%s/bazaar/' % domain
101
# We use production as the default because edge has been deprecated circa
102
# 2010-11 (see bug https://bugs.launchpad.net/bzr/+bug/583667)
103
DEFAULT_INSTANCE = 'production'
104
DEFAULT_SERVICE_URL = LAUNCHPAD_INSTANCE[DEFAULT_INSTANCE]
107
registrant_email = None
108
registrant_password = None
111
def __init__(self, transport=None, lp_instance=None):
112
"""Construct a new service talking to the launchpad rpc server"""
113
self._lp_instance = lp_instance
114
if transport is None:
115
uri_type = urllib.splittype(self.service_url)[0]
116
transport = XMLRPCTransport(uri_type)
117
transport.user_agent = 'bzr/%s (xmlrpclib/%s)' \
118
% (_bzrlib_version, xmlrpclib.__version__)
119
self.transport = transport
122
def service_url(self):
123
"""Return the http or https url for the xmlrpc server.
125
This does not include the username/password credentials.
127
key = 'BZR_LP_XMLRPC_URL'
128
if key in os.environ:
129
return os.environ[key]
130
elif self._lp_instance is not None:
132
return self.LAUNCHPAD_INSTANCE[self._lp_instance]
134
raise InvalidLaunchpadInstance(self._lp_instance)
136
return self.DEFAULT_SERVICE_URL
139
def for_url(cls, url, **kwargs):
140
"""Return the Launchpad service corresponding to the given URL."""
141
result = urlsplit(url)
142
lp_instance = result[1]
143
if lp_instance == '':
145
elif lp_instance not in cls.LAUNCHPAD_INSTANCE:
146
raise errors.InvalidURL(path=url)
147
return cls(lp_instance=lp_instance, **kwargs)
149
def get_proxy(self, authenticated):
150
"""Return the proxy for XMLRPC requests."""
152
# auth info must be in url
153
# TODO: if there's no registrant email perhaps we should
154
# just connect anonymously?
155
scheme, hostinfo, path = urlsplit(self.service_url)[:3]
157
raise AssertionError(hostinfo)
158
if self.registrant_email is None:
159
raise AssertionError()
160
if self.registrant_password is None:
161
raise AssertionError()
162
# TODO: perhaps fully quote the password to make it very slightly
164
# TODO: can we perhaps add extra Authorization headers
165
# directly to the request, rather than putting this into
166
# the url? perhaps a bit more secure against accidentally
167
# revealing it. std66 s3.2.1 discourages putting the
168
# password in the url.
169
hostinfo = '%s:%s@%s' % (urllib.quote(self.registrant_email),
170
urllib.quote(self.registrant_password),
172
url = urlunsplit((scheme, hostinfo, path, '', ''))
174
url = self.service_url
175
return xmlrpclib.ServerProxy(url, transport=self.transport)
177
def gather_user_credentials(self):
178
"""Get the password from the user."""
179
the_config = config.GlobalConfig()
180
self.registrant_email = the_config.user_email()
181
if self.registrant_password is None:
182
auth = config.AuthenticationConfig()
183
scheme, hostinfo = urlsplit(self.service_url)[:2]
184
prompt = 'launchpad.net password for %s: ' % \
185
self.registrant_email
186
# We will reuse http[s] credentials if we can, prompt user
188
self.registrant_password = auth.get_password(scheme, hostinfo,
189
self.registrant_email,
192
def send_request(self, method_name, method_params, authenticated):
193
proxy = self.get_proxy(authenticated)
194
method = getattr(proxy, method_name)
196
result = method(*method_params)
197
except xmlrpclib.ProtocolError, e:
199
# TODO: This can give a ProtocolError representing a 301 error, whose
200
# e.headers['location'] tells where to go and e.errcode==301; should
201
# probably log something and retry on the new url.
202
raise NotImplementedError("should resend request to %s, but this isn't implemented"
203
% e.headers.get('Location', 'NO-LOCATION-PRESENT'))
205
# we don't want to print the original message because its
206
# str representation includes the plaintext password.
207
# TODO: print more headers to help in tracking down failures
208
raise errors.BzrError("xmlrpc protocol error connecting to %s: %s %s"
209
% (self.service_url, e.errcode, e.errmsg))
210
except socket.gaierror, e:
211
raise errors.ConnectionError(
212
"Could not resolve '%s'" % self.domain,
218
if self._lp_instance is None:
219
instance = self.DEFAULT_INSTANCE
221
instance = self._lp_instance
222
return self.LAUNCHPAD_DOMAINS[instance]
224
def _guess_branch_path(self, branch_url, _request_factory=None):
225
scheme, hostinfo, path = urlsplit(branch_url)[:3]
226
if _request_factory is None:
227
_request_factory = ResolveLaunchpadPathRequest
229
resolve = _request_factory(path)
231
result = resolve.submit(self)
232
except xmlrpclib.Fault, fault:
233
raise errors.InvalidURL(branch_url, str(fault))
234
branch_url = result['urls'][0]
235
path = urlsplit(branch_url)[2]
239
for domain in self.LAUNCHPAD_DOMAINS.itervalues())
240
if hostinfo not in domains:
241
raise NotLaunchpadBranch(branch_url)
242
return path.lstrip('/')
244
def get_web_url_from_branch_url(self, branch_url, _request_factory=None):
245
"""Get the Launchpad web URL for the given branch URL.
247
:raise errors.InvalidURL: if 'branch_url' cannot be identified as a
248
Launchpad branch URL.
249
:return: The URL of the branch on Launchpad.
251
path = self._guess_branch_path(branch_url, _request_factory)
252
return urlutils.join('https://code.%s' % self.domain, path)
255
class BaseRequest(object):
256
"""Base request for talking to a XMLRPC server."""
258
# Set this to the XMLRPC method name.
260
_authenticated = True
262
def _request_params(self):
263
"""Return the arguments to pass to the method"""
264
raise NotImplementedError(self._request_params)
266
def submit(self, service):
267
"""Submit request to Launchpad XMLRPC server.
269
:param service: LaunchpadService indicating where to send
270
the request and the authentication credentials.
272
return service.send_request(self._methodname, self._request_params(),
276
class DryRunLaunchpadService(LaunchpadService):
277
"""Service that just absorbs requests without sending to server.
279
The dummy service does not need authentication.
282
def send_request(self, method_name, method_params, authenticated):
285
def gather_user_credentials(self):
289
class BranchRegistrationRequest(BaseRequest):
290
"""Request to tell Launchpad about a bzr branch."""
292
_methodname = 'register_branch'
294
def __init__(self, branch_url,
297
branch_description='',
302
raise errors.InvalidURL(branch_url, "You need to specify a non-empty branch URL.")
303
self.branch_url = branch_url
305
self.branch_name = branch_name
307
self.branch_name = self._find_default_branch_name(self.branch_url)
308
self.branch_title = branch_title
309
self.branch_description = branch_description
310
self.author_email = author_email
311
self.product_name = product_name
313
def _request_params(self):
314
"""Return xmlrpc request parameters"""
315
# This must match the parameter tuple expected by Launchpad for this
317
return (self.branch_url,
320
self.branch_description,
325
def _find_default_branch_name(self, branch_url):
326
i = branch_url.rfind('/')
327
return branch_url[i+1:]
330
class BranchBugLinkRequest(BaseRequest):
331
"""Request to link a bzr branch in Launchpad to a bug."""
333
_methodname = 'link_branch_to_bug'
335
def __init__(self, branch_url, bug_id):
337
self.branch_url = branch_url
339
def _request_params(self):
340
"""Return xmlrpc request parameters"""
341
# This must match the parameter tuple expected by Launchpad for this
343
return (self.branch_url, self.bug_id, '')
346
class ResolveLaunchpadPathRequest(BaseRequest):
347
"""Request to resolve the path component of an lp: URL."""
349
_methodname = 'resolve_lp_path'
350
_authenticated = False
352
def __init__(self, path):
354
raise errors.InvalidURL(path=path,
355
extra="You must specify a project.")
358
def _request_params(self):
359
"""Return xmlrpc request parameters"""
added
removed
bzrlib/plugins/launchpad/lp_registration.py
