1
# Copyright (C) 2006-2010 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
'edge': 'edge.launchpad.net',
90
'staging': 'staging.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
# Previously 'edge' was used to avoid a launchpad bug with redirection
102
DEFAULT_INSTANCE = 'production'
103
DEFAULT_SERVICE_URL = LAUNCHPAD_INSTANCE[DEFAULT_INSTANCE]
106
registrant_email = None
107
registrant_password = None
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
121
def service_url(self):
122
"""Return the http or https url for the xmlrpc server.
124
This does not include the username/password credentials.
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:
131
return self.LAUNCHPAD_INSTANCE[self._lp_instance]
133
raise InvalidLaunchpadInstance(self._lp_instance)
135
return self.DEFAULT_SERVICE_URL
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 == '':
144
elif lp_instance not in cls.LAUNCHPAD_INSTANCE:
145
raise errors.InvalidURL(path=url)
146
return cls(lp_instance=lp_instance, **kwargs)
148
def get_proxy(self, authenticated):
149
"""Return the proxy for XMLRPC requests."""
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]
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
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),
171
url = urlunsplit((scheme, hostinfo, path, '', ''))
173
url = self.service_url
174
return xmlrpclib.ServerProxy(url, transport=self.transport)
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
187
self.registrant_password = auth.get_password(scheme, hostinfo,
188
self.registrant_email,
191
def send_request(self, method_name, method_params, authenticated):
192
proxy = self.get_proxy(authenticated)
193
method = getattr(proxy, method_name)
195
result = method(*method_params)
196
except xmlrpclib.ProtocolError, e:
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'))
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,
217
if self._lp_instance is None:
218
instance = self.DEFAULT_INSTANCE
220
instance = self._lp_instance
221
return self.LAUNCHPAD_DOMAINS[instance]
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
228
resolve = _request_factory(path)
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]
238
for domain in self.LAUNCHPAD_DOMAINS.itervalues())
239
if hostinfo not in domains:
240
raise NotLaunchpadBranch(branch_url)
241
return path.lstrip('/')
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.
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.
250
path = self._guess_branch_path(branch_url, _request_factory)
251
return urlutils.join('https://code.%s' % self.domain, path)
254
class BaseRequest(object):
255
"""Base request for talking to a XMLRPC server."""
257
# Set this to the XMLRPC method name.
259
_authenticated = True
261
def _request_params(self):
262
"""Return the arguments to pass to the method"""
263
raise NotImplementedError(self._request_params)
265
def submit(self, service):
266
"""Submit request to Launchpad XMLRPC server.
268
:param service: LaunchpadService indicating where to send
269
the request and the authentication credentials.
271
return service.send_request(self._methodname, self._request_params(),
275
class DryRunLaunchpadService(LaunchpadService):
276
"""Service that just absorbs requests without sending to server.
278
The dummy service does not need authentication.
281
def send_request(self, method_name, method_params, authenticated):
284
def gather_user_credentials(self):
288
class BranchRegistrationRequest(BaseRequest):
289
"""Request to tell Launchpad about a bzr branch."""
291
_methodname = 'register_branch'
293
def __init__(self, branch_url,
296
branch_description='',
301
raise errors.InvalidURL(branch_url, "You need to specify a non-empty branch URL.")
302
self.branch_url = branch_url
304
self.branch_name = branch_name
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
312
def _request_params(self):
313
"""Return xmlrpc request parameters"""
314
# This must match the parameter tuple expected by Launchpad for this
316
return (self.branch_url,
319
self.branch_description,
324
def _find_default_branch_name(self, branch_url):
325
i = branch_url.rfind('/')
326
return branch_url[i+1:]
329
class BranchBugLinkRequest(BaseRequest):
330
"""Request to link a bzr branch in Launchpad to a bug."""
332
_methodname = 'link_branch_to_bug'
334
def __init__(self, branch_url, bug_id):
336
self.branch_url = branch_url
338
def _request_params(self):
339
"""Return xmlrpc request parameters"""
340
# This must match the parameter tuple expected by Launchpad for this
342
return (self.branch_url, self.bug_id, '')
345
class ResolveLaunchpadPathRequest(BaseRequest):
346
"""Request to resolve the path component of an lp: URL."""
348
_methodname = 'resolve_lp_path'
349
_authenticated = False
351
def __init__(self, path):
353
raise errors.InvalidURL(path=path,
354
extra="You must specify a project.")
357
def _request_params(self):
358
"""Return xmlrpc request parameters"""
added
removed
bzrlib/plugins/launchpad/lp_registration.py
