1
# Copyright (C) 2006 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
24
from bzrlib.lazy_import import lazy_import
25
lazy_import(globals(), """
26
from bzrlib import urlutils
32
__version__ as _bzrlib_version,
34
from bzrlib.transport.http import _urllib2_wrappers
38
export BZR_LP_XMLRPC_URL=http://xmlrpc.staging.launchpad.net/bazaar/
41
class InvalidLaunchpadInstance(errors.BzrError):
43
_fmt = "%(lp_instance)s is not a valid Launchpad instance."
45
def __init__(self, lp_instance):
46
errors.BzrError.__init__(self, lp_instance=lp_instance)
49
class NotLaunchpadBranch(errors.BzrError):
51
_fmt = "%(url)s is not registered on Launchpad."
53
def __init__(self, url):
54
errors.BzrError.__init__(self, url=url)
57
class XMLRPCTransport(xmlrpclib.Transport):
59
def __init__(self, scheme, use_datetime=0):
60
xmlrpclib.Transport.__init__(self, use_datetime=use_datetime)
62
self._opener = _urllib2_wrappers.Opener()
65
def request(self, host, handler, request_body, verbose=0):
66
self.verbose = verbose
67
url = self._scheme + "://" + host + handler
68
request = _urllib2_wrappers.Request("POST", url, request_body)
69
# FIXME: _urllib2_wrappers will override user-agent with its own
70
# request.add_header("User-Agent", self.user_agent)
71
request.add_header("Content-Type", "text/xml")
73
response = self._opener.open(request)
74
if response.code != 200:
75
raise xmlrpclib.ProtocolError(host + handler, response.code,
76
response.msg, response.info())
77
return self.parse_response(response)
80
class LaunchpadService(object):
81
"""A service to talk to Launchpad via XMLRPC.
83
See http://bazaar-vcs.org/Specs/LaunchpadRpc for the methods we can call.
87
'production': 'launchpad.net',
88
'edge': 'edge.launchpad.net',
89
'staging': 'staging.launchpad.net',
90
'demo': 'demo.launchpad.net',
91
'dev': 'launchpad.dev',
94
# NB: these should always end in a slash to avoid xmlrpclib appending
96
LAUNCHPAD_INSTANCE = {}
97
for instance, domain in LAUNCHPAD_DOMAINS.iteritems():
98
LAUNCHPAD_INSTANCE[instance] = 'https://xmlrpc.%s/bazaar/' % domain
100
# We use edge as the default because:
101
# Beta users get redirected to it
102
# All users can use it
103
# There is a bug in the launchpad side where redirection causes an OOPS.
104
DEFAULT_INSTANCE = 'edge'
105
DEFAULT_SERVICE_URL = LAUNCHPAD_INSTANCE[DEFAULT_INSTANCE]
108
registrant_email = None
109
registrant_password = None
112
def __init__(self, transport=None, lp_instance=None):
113
"""Construct a new service talking to the launchpad rpc server"""
114
self._lp_instance = lp_instance
115
if transport is None:
116
uri_type = urllib.splittype(self.service_url)[0]
117
transport = XMLRPCTransport(uri_type)
118
transport.user_agent = 'bzr/%s (xmlrpclib/%s)' \
119
% (_bzrlib_version, xmlrpclib.__version__)
120
self.transport = transport
124
def service_url(self):
125
"""Return the http or https url for the xmlrpc server.
127
This does not include the username/password credentials.
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:
134
return self.LAUNCHPAD_INSTANCE[self._lp_instance]
136
raise InvalidLaunchpadInstance(self._lp_instance)
138
return self.DEFAULT_SERVICE_URL
140
def get_proxy(self, authenticated):
141
"""Return the proxy for XMLRPC requests."""
143
# auth info must be in url
144
# TODO: if there's no registrant email perhaps we should
145
# just connect anonymously?
146
scheme, hostinfo, path = urlsplit(self.service_url)[:3]
148
raise AssertionError(hostinfo)
149
if self.registrant_email is None:
150
raise AssertionError()
151
if self.registrant_password is None:
152
raise AssertionError()
153
# TODO: perhaps fully quote the password to make it very slightly
155
# TODO: can we perhaps add extra Authorization headers
156
# directly to the request, rather than putting this into
157
# the url? perhaps a bit more secure against accidentally
158
# revealing it. std66 s3.2.1 discourages putting the
159
# password in the url.
160
hostinfo = '%s:%s@%s' % (urllib.quote(self.registrant_email),
161
urllib.quote(self.registrant_password),
163
url = urlunsplit((scheme, hostinfo, path, '', ''))
165
url = self.service_url
166
return xmlrpclib.ServerProxy(url, transport=self.transport)
168
def gather_user_credentials(self):
169
"""Get the password from the user."""
170
the_config = config.GlobalConfig()
171
self.registrant_email = the_config.user_email()
172
if self.registrant_password is None:
173
auth = config.AuthenticationConfig()
174
scheme, hostinfo = urlsplit(self.service_url)[:2]
175
prompt = 'launchpad.net password for %s: ' % \
176
self.registrant_email
177
# We will reuse http[s] credentials if we can, prompt user
179
self.registrant_password = auth.get_password(scheme, hostinfo,
180
self.registrant_email,
183
def send_request(self, method_name, method_params, authenticated):
184
proxy = self.get_proxy(authenticated)
185
method = getattr(proxy, method_name)
187
result = method(*method_params)
188
except xmlrpclib.ProtocolError, e:
190
# TODO: This can give a ProtocolError representing a 301 error, whose
191
# e.headers['location'] tells where to go and e.errcode==301; should
192
# probably log something and retry on the new url.
193
raise NotImplementedError("should resend request to %s, but this isn't implemented"
194
% e.headers.get('Location', 'NO-LOCATION-PRESENT'))
196
# we don't want to print the original message because its
197
# str representation includes the plaintext password.
198
# TODO: print more headers to help in tracking down failures
199
raise errors.BzrError("xmlrpc protocol error connecting to %s: %s %s"
200
% (self.service_url, e.errcode, e.errmsg))
201
except socket.gaierror, e:
202
raise errors.ConnectionError(
203
"Could not resolve '%s'" % self.domain,
209
if self._lp_instance is None:
210
instance = self.DEFAULT_INSTANCE
212
instance = self._lp_instance
213
return self.LAUNCHPAD_DOMAINS[instance]
215
def get_web_url_from_branch_url(self, branch_url, _request_factory=None):
216
"""Get the Launchpad web URL for the given branch URL.
218
:raise errors.InvalidURL: if 'branch_url' cannot be identified as a
219
Launchpad branch URL.
220
:return: The URL of the branch on Launchpad.
222
scheme, hostinfo, path = urlsplit(branch_url)[:3]
223
if _request_factory is None:
224
_request_factory = ResolveLaunchpadPathRequest
226
resolve = _request_factory(path)
228
result = resolve.submit(self)
229
except xmlrpclib.Fault, fault:
230
raise errors.InvalidURL(branch_url, str(fault))
231
branch_url = result['urls'][0]
232
path = urlsplit(branch_url)[2]
236
for domain in self.LAUNCHPAD_DOMAINS.itervalues())
237
if hostinfo not in domains:
238
raise NotLaunchpadBranch(branch_url)
239
return urlutils.join('https://code.%s' % self.domain, path)
242
class BaseRequest(object):
243
"""Base request for talking to a XMLRPC server."""
245
# Set this to the XMLRPC method name.
247
_authenticated = True
249
def _request_params(self):
250
"""Return the arguments to pass to the method"""
251
raise NotImplementedError(self._request_params)
253
def submit(self, service):
254
"""Submit request to Launchpad XMLRPC server.
256
:param service: LaunchpadService indicating where to send
257
the request and the authentication credentials.
259
return service.send_request(self._methodname, self._request_params(),
263
class DryRunLaunchpadService(LaunchpadService):
264
"""Service that just absorbs requests without sending to server.
266
The dummy service does not need authentication.
269
def send_request(self, method_name, method_params, authenticated):
272
def gather_user_credentials(self):
276
class BranchRegistrationRequest(BaseRequest):
277
"""Request to tell Launchpad about a bzr branch."""
279
_methodname = 'register_branch'
281
def __init__(self, branch_url,
284
branch_description='',
289
raise errors.InvalidURL(branch_url, "You need to specify a non-empty branch URL.")
290
self.branch_url = branch_url
292
self.branch_name = branch_name
294
self.branch_name = self._find_default_branch_name(self.branch_url)
295
self.branch_title = branch_title
296
self.branch_description = branch_description
297
self.author_email = author_email
298
self.product_name = product_name
300
def _request_params(self):
301
"""Return xmlrpc request parameters"""
302
# This must match the parameter tuple expected by Launchpad for this
304
return (self.branch_url,
307
self.branch_description,
312
def _find_default_branch_name(self, branch_url):
313
i = branch_url.rfind('/')
314
return branch_url[i+1:]
317
class BranchBugLinkRequest(BaseRequest):
318
"""Request to link a bzr branch in Launchpad to a bug."""
320
_methodname = 'link_branch_to_bug'
322
def __init__(self, branch_url, bug_id):
324
self.branch_url = branch_url
326
def _request_params(self):
327
"""Return xmlrpc request parameters"""
328
# This must match the parameter tuple expected by Launchpad for this
330
return (self.branch_url, self.bug_id, '')
333
class ResolveLaunchpadPathRequest(BaseRequest):
334
"""Request to resolve the path component of an lp: URL."""
336
_methodname = 'resolve_lp_path'
337
_authenticated = False
339
def __init__(self, path):
341
raise errors.InvalidURL(path=path,
342
extra="You must specify a project.")
345
def _request_params(self):
346
"""Return xmlrpc request parameters"""
added
removed
bzrlib/plugins/launchpad/lp_registration.py
