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
17
from __future__ import absolute_import
22
from urlparse import urlsplit, urlunsplit
30
__version__ as _bzrlib_version,
32
from bzrlib.transport.http import _urllib2_wrappers
37
export BZR_LP_XMLRPC_URL=http://xmlrpc.staging.launchpad.net/bazaar/
40
class InvalidLaunchpadInstance(errors.BzrError):
42
_fmt = "%(lp_instance)s is not a valid Launchpad instance."
44
def __init__(self, lp_instance):
45
errors.BzrError.__init__(self, lp_instance=lp_instance)
48
class NotLaunchpadBranch(errors.BzrError):
50
_fmt = "%(url)s is not registered on Launchpad."
52
def __init__(self, url):
53
errors.BzrError.__init__(self, url=url)
56
class XMLRPCTransport(xmlrpclib.Transport):
58
def __init__(self, scheme):
59
xmlrpclib.Transport.__init__(self)
61
self._opener = _urllib2_wrappers.Opener()
64
def request(self, host, handler, request_body, verbose=0):
65
self.verbose = verbose
66
url = self._scheme + "://" + host + handler
67
request = _urllib2_wrappers.Request("POST", url, request_body)
68
# FIXME: _urllib2_wrappers will override user-agent with its own
69
# request.add_header("User-Agent", self.user_agent)
70
request.add_header("Content-Type", "text/xml")
72
response = self._opener.open(request)
73
if response.code != 200:
74
raise xmlrpclib.ProtocolError(host + handler, response.code,
75
response.msg, response.info())
76
return self.parse_response(response)
79
class LaunchpadService(object):
80
"""A service to talk to Launchpad via XMLRPC.
82
See http://wiki.bazaar.canonical.com/Specs/LaunchpadRpc for the methods we can call.
86
'production': 'launchpad.net',
87
'staging': 'staging.launchpad.net',
88
'qastaging': 'qastaging.launchpad.net',
89
'demo': 'demo.launchpad.net',
90
'dev': 'launchpad.dev',
93
# NB: these should always end in a slash to avoid xmlrpclib appending
95
LAUNCHPAD_INSTANCE = {}
96
for instance, domain in LAUNCHPAD_DOMAINS.iteritems():
97
LAUNCHPAD_INSTANCE[instance] = 'https://xmlrpc.%s/bazaar/' % domain
99
# We use production as the default because edge has been deprecated circa
100
# 2010-11 (see bug https://bugs.launchpad.net/bzr/+bug/583667)
101
DEFAULT_INSTANCE = 'production'
102
DEFAULT_SERVICE_URL = LAUNCHPAD_INSTANCE[DEFAULT_INSTANCE]
105
registrant_email = None
106
registrant_password = None
109
def __init__(self, transport=None, lp_instance=None):
110
"""Construct a new service talking to the launchpad rpc server"""
111
self._lp_instance = lp_instance
112
if transport is None:
113
uri_type = urllib.splittype(self.service_url)[0]
114
transport = XMLRPCTransport(uri_type)
115
transport.user_agent = 'bzr/%s (xmlrpclib/%s)' \
116
% (_bzrlib_version, xmlrpclib.__version__)
117
self.transport = transport
120
def service_url(self):
121
"""Return the http or https url for the xmlrpc server.
123
This does not include the username/password credentials.
125
key = 'BZR_LP_XMLRPC_URL'
126
if key in os.environ:
127
return os.environ[key]
128
elif self._lp_instance is not None:
130
return self.LAUNCHPAD_INSTANCE[self._lp_instance]
132
raise InvalidLaunchpadInstance(self._lp_instance)
134
return self.DEFAULT_SERVICE_URL
137
def for_url(cls, url, **kwargs):
138
"""Return the Launchpad service corresponding to the given URL."""
139
result = urlsplit(url)
140
lp_instance = result[1]
141
if lp_instance == '':
143
elif lp_instance not in cls.LAUNCHPAD_INSTANCE:
144
raise errors.InvalidURL(path=url)
145
return cls(lp_instance=lp_instance, **kwargs)
147
def get_proxy(self, authenticated):
148
"""Return the proxy for XMLRPC requests."""
150
# auth info must be in url
151
# TODO: if there's no registrant email perhaps we should
152
# just connect anonymously?
153
scheme, hostinfo, path = urlsplit(self.service_url)[:3]
155
raise AssertionError(hostinfo)
156
if self.registrant_email is None:
157
raise AssertionError()
158
if self.registrant_password is None:
159
raise AssertionError()
160
# TODO: perhaps fully quote the password to make it very slightly
162
# TODO: can we perhaps add extra Authorization headers
163
# directly to the request, rather than putting this into
164
# the url? perhaps a bit more secure against accidentally
165
# revealing it. std66 s3.2.1 discourages putting the
166
# password in the url.
167
hostinfo = '%s:%s@%s' % (urlutils.quote(self.registrant_email),
168
urlutils.quote(self.registrant_password),
170
url = urlunsplit((scheme, hostinfo, path, '', ''))
172
url = self.service_url
173
return xmlrpclib.ServerProxy(url, transport=self.transport)
175
def gather_user_credentials(self):
176
"""Get the password from the user."""
177
the_config = config.GlobalConfig()
178
self.registrant_email = the_config.user_email()
179
if self.registrant_password is None:
180
auth = config.AuthenticationConfig()
181
scheme, hostinfo = urlsplit(self.service_url)[:2]
182
prompt = 'launchpad.net password for %s: ' % \
183
self.registrant_email
184
# We will reuse http[s] credentials if we can, prompt user
186
self.registrant_password = auth.get_password(scheme, hostinfo,
187
self.registrant_email,
190
def send_request(self, method_name, method_params, authenticated):
191
proxy = self.get_proxy(authenticated)
192
method = getattr(proxy, method_name)
194
result = method(*method_params)
195
except xmlrpclib.ProtocolError, e:
197
# TODO: This can give a ProtocolError representing a 301 error, whose
198
# e.headers['location'] tells where to go and e.errcode==301; should
199
# probably log something and retry on the new url.
200
raise NotImplementedError("should resend request to %s, but this isn't implemented"
201
% e.headers.get('Location', 'NO-LOCATION-PRESENT'))
203
# we don't want to print the original message because its
204
# str representation includes the plaintext password.
205
# TODO: print more headers to help in tracking down failures
206
raise errors.BzrError("xmlrpc protocol error connecting to %s: %s %s"
207
% (self.service_url, e.errcode, e.errmsg))
208
except socket.gaierror, e:
209
raise errors.ConnectionError(
210
"Could not resolve '%s'" % self.domain,
216
if self._lp_instance is None:
217
instance = self.DEFAULT_INSTANCE
219
instance = self._lp_instance
220
return self.LAUNCHPAD_DOMAINS[instance]
222
def _guess_branch_path(self, branch_url, _request_factory=None):
223
scheme, hostinfo, path = urlsplit(branch_url)[:3]
224
if _request_factory is None:
225
_request_factory = ResolveLaunchpadPathRequest
227
resolve = _request_factory(path)
229
result = resolve.submit(self)
230
except xmlrpclib.Fault, fault:
231
raise errors.InvalidURL(branch_url, str(fault))
232
branch_url = result['urls'][0]
233
path = urlsplit(branch_url)[2]
237
for domain in self.LAUNCHPAD_DOMAINS.itervalues())
238
if hostinfo not in domains:
239
raise NotLaunchpadBranch(branch_url)
240
return path.lstrip('/')
242
def get_web_url_from_branch_url(self, branch_url, _request_factory=None):
243
"""Get the Launchpad web URL for the given branch URL.
245
:raise errors.InvalidURL: if 'branch_url' cannot be identified as a
246
Launchpad branch URL.
247
:return: The URL of the branch on Launchpad.
249
path = self._guess_branch_path(branch_url, _request_factory)
250
return urlutils.join('https://code.%s' % self.domain, path)
253
class BaseRequest(object):
254
"""Base request for talking to a XMLRPC server."""
256
# Set this to the XMLRPC method name.
258
_authenticated = True
260
def _request_params(self):
261
"""Return the arguments to pass to the method"""
262
raise NotImplementedError(self._request_params)
264
def submit(self, service):
265
"""Submit request to Launchpad XMLRPC server.
267
:param service: LaunchpadService indicating where to send
268
the request and the authentication credentials.
270
return service.send_request(self._methodname, self._request_params(),
274
class DryRunLaunchpadService(LaunchpadService):
275
"""Service that just absorbs requests without sending to server.
277
The dummy service does not need authentication.
280
def send_request(self, method_name, method_params, authenticated):
283
def gather_user_credentials(self):
287
class BranchRegistrationRequest(BaseRequest):
288
"""Request to tell Launchpad about a bzr branch."""
290
_methodname = 'register_branch'
292
def __init__(self, branch_url,
295
branch_description='',
300
raise errors.InvalidURL(branch_url, "You need to specify a non-empty branch URL.")
301
self.branch_url = branch_url
303
self.branch_name = branch_name
305
self.branch_name = self._find_default_branch_name(self.branch_url)
306
self.branch_title = branch_title
307
self.branch_description = branch_description
308
self.author_email = author_email
309
self.product_name = product_name
311
def _request_params(self):
312
"""Return xmlrpc request parameters"""
313
# This must match the parameter tuple expected by Launchpad for this
315
return (self.branch_url,
318
self.branch_description,
323
def _find_default_branch_name(self, branch_url):
324
i = branch_url.rfind('/')
325
return branch_url[i+1:]
328
class BranchBugLinkRequest(BaseRequest):
329
"""Request to link a bzr branch in Launchpad to a bug."""
331
_methodname = 'link_branch_to_bug'
333
def __init__(self, branch_url, bug_id):
335
self.branch_url = branch_url
337
def _request_params(self):
338
"""Return xmlrpc request parameters"""
339
# This must match the parameter tuple expected by Launchpad for this
341
return (self.branch_url, self.bug_id, '')
344
class ResolveLaunchpadPathRequest(BaseRequest):
345
"""Request to resolve the path component of an lp: URL."""
347
_methodname = 'resolve_lp_path'
348
_authenticated = False
350
def __init__(self, path):
352
raise errors.InvalidURL(path=path,
353
extra="You must specify a project.")
356
def _request_params(self):
357
"""Return xmlrpc request parameters"""
added
removed
bzrlib/plugins/launchpad/lp_registration.py
