24
from bzrlib.lazy_import import lazy_import
25
lazy_import(globals(), """
26
from bzrlib import urlutils
32
__version__ as _bzrlib_version,
25
import bzrlib.errors as errors
37
29
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
32
class LaunchpadService(object):
57
33
"""A service to talk to Launchpad via XMLRPC.
59
35
See http://bazaar-vcs.org/Specs/LaunchpadRpc for the methods we can call.
63
'production': 'launchpad.net',
64
'edge': 'edge.launchpad.net',
65
'staging': 'staging.launchpad.net',
66
'demo': 'demo.launchpad.net',
67
'dev': 'launchpad.dev',
70
# NB: these should always end in a slash to avoid xmlrpclib appending
38
# NB: this should always end in a slash to avoid xmlrpclib appending
72
LAUNCHPAD_INSTANCE = {}
73
for instance, domain in LAUNCHPAD_DOMAINS.iteritems():
74
LAUNCHPAD_INSTANCE[instance] = 'https://xmlrpc.%s/bazaar/' % domain
76
# We use edge as the default because:
77
# Beta users get redirected to it
78
# All users can use it
79
# There is a bug in the launchpad side where redirection causes an OOPS.
80
DEFAULT_INSTANCE = 'edge'
81
DEFAULT_SERVICE_URL = LAUNCHPAD_INSTANCE[DEFAULT_INSTANCE]
40
DEFAULT_SERVICE_URL = 'https://xmlrpc.launchpad.net/bazaar/'
84
43
registrant_email = None
85
44
registrant_password = None
88
def __init__(self, transport=None, lp_instance=None):
47
def __init__(self, transport=None):
89
48
"""Construct a new service talking to the launchpad rpc server"""
90
self._lp_instance = lp_instance
91
49
if transport is None:
92
50
uri_type = urllib.splittype(self.service_url)[0]
93
51
if uri_type == 'https':
108
66
key = 'BZR_LP_XMLRPC_URL'
109
67
if key in os.environ:
110
68
return os.environ[key]
111
elif self._lp_instance is not None:
113
return self.LAUNCHPAD_INSTANCE[self._lp_instance]
115
raise InvalidLaunchpadInstance(self._lp_instance)
117
70
return self.DEFAULT_SERVICE_URL
119
def get_proxy(self, authenticated):
120
73
"""Return the proxy for XMLRPC requests."""
122
# auth info must be in url
123
# TODO: if there's no registrant email perhaps we should
124
# just connect anonymously?
125
scheme, hostinfo, path = urlsplit(self.service_url)[:3]
127
raise AssertionError(hostinfo)
128
if self.registrant_email is None:
129
raise AssertionError()
130
if self.registrant_password is None:
131
raise AssertionError()
132
# TODO: perhaps fully quote the password to make it very slightly
134
# TODO: can we perhaps add extra Authorization headers
135
# directly to the request, rather than putting this into
136
# the url? perhaps a bit more secure against accidentally
137
# revealing it. std66 s3.2.1 discourages putting the
138
# password in the url.
139
hostinfo = '%s:%s@%s' % (urllib.quote(self.registrant_email),
140
urllib.quote(self.registrant_password),
142
url = urlunsplit((scheme, hostinfo, path, '', ''))
144
url = self.service_url
74
# auth info must be in url
75
# TODO: if there's no registrant email perhaps we should just connect
77
scheme, hostinfo, path = urlsplit(self.service_url)[:3]
78
assert '@' not in hostinfo
79
assert self.registrant_email is not None
80
assert self.registrant_password is not None
81
# TODO: perhaps fully quote the password to make it very slightly
83
# TODO: can we perhaps add extra Authorization headers directly to the
84
# request, rather than putting this into the url? perhaps a bit more
85
# secure against accidentally revealing it. std66 s3.2.1 discourages putting
86
# the password in the url.
87
hostinfo = '%s:%s@%s' % (urllib.quote(self.registrant_email),
88
urllib.quote(self.registrant_password),
90
url = urlunsplit((scheme, hostinfo, path, '', ''))
145
91
return xmlrpclib.ServerProxy(url, transport=self.transport)
147
93
def gather_user_credentials(self):
148
94
"""Get the password from the user."""
149
the_config = config.GlobalConfig()
150
self.registrant_email = the_config.user_email()
95
config = bzrlib.config.GlobalConfig()
96
self.registrant_email = config.user_email()
151
97
if self.registrant_password is None:
152
auth = config.AuthenticationConfig()
153
scheme, hostinfo = urlsplit(self.service_url)[:2]
154
98
prompt = 'launchpad.net password for %s: ' % \
155
99
self.registrant_email
156
# We will reuse http[s] credentials if we can, prompt user
158
self.registrant_password = auth.get_password(scheme, hostinfo,
159
self.registrant_email,
100
self.registrant_password = getpass(prompt)
162
def send_request(self, method_name, method_params, authenticated):
163
proxy = self.get_proxy(authenticated)
102
def send_request(self, method_name, method_params):
103
proxy = self.get_proxy()
164
105
method = getattr(proxy, method_name)
166
107
result = method(*method_params)
179
120
% (self.service_url, e.errcode, e.errmsg))
184
if self._lp_instance is None:
185
instance = self.DEFAULT_INSTANCE
187
instance = self._lp_instance
188
return self.LAUNCHPAD_DOMAINS[instance]
190
def get_web_url_from_branch_url(self, branch_url, _request_factory=None):
191
"""Get the Launchpad web URL for the given branch URL.
193
:raise errors.InvalidURL: if 'branch_url' cannot be identified as a
194
Launchpad branch URL.
195
:return: The URL of the branch on Launchpad.
197
scheme, hostinfo, path = urlsplit(branch_url)[:3]
198
if _request_factory is None:
199
_request_factory = ResolveLaunchpadPathRequest
201
resolve = _request_factory(path)
203
result = resolve.submit(self)
204
except xmlrpclib.Fault, fault:
205
raise errors.InvalidURL(branch_url, str(fault))
206
branch_url = result['urls'][0]
207
path = urlsplit(branch_url)[2]
211
for domain in self.LAUNCHPAD_DOMAINS.itervalues())
212
if hostinfo not in domains:
213
raise NotLaunchpadBranch(branch_url)
214
return urlutils.join('https://code.%s' % self.domain, path)
217
124
class BaseRequest(object):
218
125
"""Base request for talking to a XMLRPC server."""
220
127
# Set this to the XMLRPC method name.
221
128
_methodname = None
222
_authenticated = True
224
130
def _request_params(self):
225
131
"""Return the arguments to pass to the method"""
231
137
:param service: LaunchpadService indicating where to send
232
138
the request and the authentication credentials.
234
return service.send_request(self._methodname, self._request_params(),
140
return service.send_request(self._methodname, self._request_params())
238
143
class DryRunLaunchpadService(LaunchpadService):
239
144
"""Service that just absorbs requests without sending to server.
241
146
The dummy service does not need authentication.
244
def send_request(self, method_name, method_params, authenticated):
149
def send_request(self, method_name, method_params):
247
152
def gather_user_credentials(self):
303
208
# This must match the parameter tuple expected by Launchpad for this
305
210
return (self.branch_url, self.bug_id, '')
308
class ResolveLaunchpadPathRequest(BaseRequest):
309
"""Request to resolve the path component of an lp: URL."""
311
_methodname = 'resolve_lp_path'
312
_authenticated = False
314
def __init__(self, path):
316
raise errors.InvalidURL(path=path,
317
extra="You must specify a product.")
320
def _request_params(self):
321
"""Return xmlrpc request parameters"""
added
removed
bzrlib/plugins/launchpad/lp_registration.py
