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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from getpass import getpass
20
from urlparse import urlsplit, urlunsplit
27
__version__ as _bzrlib_version,
32
export BZR_LP_XMLRPC_URL=http://xmlrpc.staging.launchpad.net/bazaar/
35
class LaunchpadService(object):
36
"""A service to talk to Launchpad via XMLRPC.
38
See http://bazaar-vcs.org/Specs/LaunchpadRpc for the methods we can call.
41
# NB: this should always end in a slash to avoid xmlrpclib appending
43
# We use edge because:
44
# Beta users get redirected to it
45
# All users can use it
46
# There is a bug in the launchpad side where redirection causes an OOPS.
47
DEFAULT_SERVICE_URL = 'https://xmlrpc.edge.launchpad.net/bazaar/'
50
registrant_email = None
51
registrant_password = None
54
def __init__(self, transport=None):
55
"""Construct a new service talking to the launchpad rpc server"""
57
uri_type = urllib.splittype(self.service_url)[0]
58
if uri_type == 'https':
59
transport = xmlrpclib.SafeTransport()
61
transport = xmlrpclib.Transport()
62
transport.user_agent = 'bzr/%s (xmlrpclib/%s)' \
63
% (_bzrlib_version, xmlrpclib.__version__)
64
self.transport = transport
68
def service_url(self):
69
"""Return the http or https url for the xmlrpc server.
71
This does not include the username/password credentials.
73
key = 'BZR_LP_XMLRPC_URL'
75
return os.environ[key]
77
return self.DEFAULT_SERVICE_URL
79
def get_proxy(self, authenticated):
80
"""Return the proxy for XMLRPC requests."""
82
# auth info must be in url
83
# TODO: if there's no registrant email perhaps we should
84
# just connect anonymously?
85
scheme, hostinfo, path = urlsplit(self.service_url)[:3]
86
assert '@' not in hostinfo
87
assert self.registrant_email is not None
88
assert self.registrant_password is not None
89
# TODO: perhaps fully quote the password to make it very slightly
91
# TODO: can we perhaps add extra Authorization headers
92
# directly to the request, rather than putting this into
93
# the url? perhaps a bit more secure against accidentally
94
# revealing it. std66 s3.2.1 discourages putting the
95
# password in the url.
96
hostinfo = '%s:%s@%s' % (urllib.quote(self.registrant_email),
97
urllib.quote(self.registrant_password),
99
url = urlunsplit((scheme, hostinfo, path, '', ''))
101
url = self.service_url
102
return xmlrpclib.ServerProxy(url, transport=self.transport)
104
def gather_user_credentials(self):
105
"""Get the password from the user."""
106
the_config = config.GlobalConfig()
107
self.registrant_email = the_config.user_email()
108
if self.registrant_password is None:
109
auth = config.AuthenticationConfig()
110
scheme, hostinfo = urlsplit(self.service_url)[:2]
111
prompt = 'launchpad.net password for %s: ' % \
112
self.registrant_email
113
# We will reuse http[s] credentials if we can, prompt user
115
self.registrant_password = auth.get_password(scheme, hostinfo,
116
self.registrant_email,
119
def send_request(self, method_name, method_params, authenticated):
120
proxy = self.get_proxy(authenticated)
122
method = getattr(proxy, method_name)
124
result = method(*method_params)
125
except xmlrpclib.ProtocolError, e:
127
# TODO: This can give a ProtocolError representing a 301 error, whose
128
# e.headers['location'] tells where to go and e.errcode==301; should
129
# probably log something and retry on the new url.
130
raise NotImplementedError("should resend request to %s, but this isn't implemented"
131
% e.headers.get('Location', 'NO-LOCATION-PRESENT'))
133
# we don't want to print the original message because its
134
# str representation includes the plaintext password.
135
# TODO: print more headers to help in tracking down failures
136
raise errors.BzrError("xmlrpc protocol error connecting to %s: %s %s"
137
% (self.service_url, e.errcode, e.errmsg))
141
class BaseRequest(object):
142
"""Base request for talking to a XMLRPC server."""
144
# Set this to the XMLRPC method name.
146
_authenticated = True
148
def _request_params(self):
149
"""Return the arguments to pass to the method"""
150
raise NotImplementedError(self._request_params)
152
def submit(self, service):
153
"""Submit request to Launchpad XMLRPC server.
155
:param service: LaunchpadService indicating where to send
156
the request and the authentication credentials.
158
return service.send_request(self._methodname, self._request_params(),
162
class DryRunLaunchpadService(LaunchpadService):
163
"""Service that just absorbs requests without sending to server.
165
The dummy service does not need authentication.
168
def send_request(self, method_name, method_params, authenticated):
171
def gather_user_credentials(self):
175
class BranchRegistrationRequest(BaseRequest):
176
"""Request to tell Launchpad about a bzr branch."""
178
_methodname = 'register_branch'
180
def __init__(self, branch_url,
183
branch_description='',
187
assert branch_url, 'branch_url %r is invalid' % branch_url
188
self.branch_url = branch_url
190
self.branch_name = branch_name
192
self.branch_name = self._find_default_branch_name(self.branch_url)
193
self.branch_title = branch_title
194
self.branch_description = branch_description
195
self.author_email = author_email
196
self.product_name = product_name
198
def _request_params(self):
199
"""Return xmlrpc request parameters"""
200
# This must match the parameter tuple expected by Launchpad for this
202
return (self.branch_url,
205
self.branch_description,
210
def _find_default_branch_name(self, branch_url):
211
i = branch_url.rfind('/')
212
return branch_url[i+1:]
215
class BranchBugLinkRequest(BaseRequest):
216
"""Request to link a bzr branch in Launchpad to a bug."""
218
_methodname = 'link_branch_to_bug'
220
def __init__(self, branch_url, bug_id):
223
self.branch_url = branch_url
225
def _request_params(self):
226
"""Return xmlrpc request parameters"""
227
# This must match the parameter tuple expected by Launchpad for this
229
return (self.branch_url, self.bug_id, '')
232
class ResolveLaunchpadPathRequest(BaseRequest):
233
"""Request to resolve the path component of an lp: URL."""
235
_methodname = 'resolve_lp_path'
236
_authenticated = False
238
def __init__(self, path):
242
def _request_params(self):
243
"""Return xmlrpc request parameters"""
added
removed
bzrlib/plugins/launchpad/lp_registration.py
