8
8
# This program is distributed in the hope that it will be useful,
9
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.
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# # GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from getpass import getpass
20
20
from urlparse import urlsplit, urlunsplit
28
__version__ as _bzrlib_version,
30
from bzrlib.transport.http import _urllib2_wrappers
25
import bzrlib.errors as errors
35
29
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
32
class LaunchpadService(object):
82
33
"""A service to talk to Launchpad via XMLRPC.
84
See http://wiki.bazaar.canonical.com/Specs/LaunchpadRpc for the methods we can call.
35
See http://bazaar-vcs.org/Specs/LaunchpadRpc for the methods we can call.
88
'production': 'launchpad.net',
89
'staging': 'staging.launchpad.net',
90
'qastaging': 'qastaging.launchpad.net',
91
'demo': 'demo.launchpad.net',
92
'dev': 'launchpad.dev',
95
# 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
97
LAUNCHPAD_INSTANCE = {}
98
for instance, domain in LAUNCHPAD_DOMAINS.iteritems():
99
LAUNCHPAD_INSTANCE[instance] = 'https://xmlrpc.%s/bazaar/' % domain
101
# We use production as the default because edge has been deprecated circa
102
# 2010-11 (see bug https://bugs.launchpad.net/bzr/+bug/583667)
103
DEFAULT_INSTANCE = 'production'
104
DEFAULT_SERVICE_URL = LAUNCHPAD_INSTANCE[DEFAULT_INSTANCE]
40
DEFAULT_SERVICE_URL = 'https://xmlrpc.launchpad.net/bazaar/'
107
43
registrant_email = None
108
44
registrant_password = None
111
def __init__(self, transport=None, lp_instance=None):
47
def __init__(self, transport=None):
112
48
"""Construct a new service talking to the launchpad rpc server"""
113
self._lp_instance = lp_instance
114
49
if transport is None:
115
50
uri_type = urllib.splittype(self.service_url)[0]
116
transport = XMLRPCTransport(uri_type)
51
if uri_type == 'https':
52
transport = xmlrpclib.SafeTransport()
54
transport = xmlrpclib.Transport()
117
55
transport.user_agent = 'bzr/%s (xmlrpclib/%s)' \
118
% (_bzrlib_version, xmlrpclib.__version__)
56
% (bzrlib.__version__, xmlrpclib.__version__)
119
57
self.transport = transport
122
61
def service_url(self):
123
62
"""Return the http or https url for the xmlrpc server.
127
66
key = 'BZR_LP_XMLRPC_URL'
128
67
if key in os.environ:
129
68
return os.environ[key]
130
elif self._lp_instance is not None:
132
return self.LAUNCHPAD_INSTANCE[self._lp_instance]
134
raise InvalidLaunchpadInstance(self._lp_instance)
136
70
return self.DEFAULT_SERVICE_URL
139
def for_url(cls, url, **kwargs):
140
"""Return the Launchpad service corresponding to the given URL."""
141
result = urlsplit(url)
142
lp_instance = result[1]
143
if lp_instance == '':
145
elif lp_instance not in cls.LAUNCHPAD_INSTANCE:
146
raise errors.InvalidURL(path=url)
147
return cls(lp_instance=lp_instance, **kwargs)
149
def get_proxy(self, authenticated):
150
73
"""Return the proxy for XMLRPC requests."""
152
# auth info must be in url
153
# TODO: if there's no registrant email perhaps we should
154
# just connect anonymously?
155
scheme, hostinfo, path = urlsplit(self.service_url)[:3]
157
raise AssertionError(hostinfo)
158
if self.registrant_email is None:
159
raise AssertionError()
160
if self.registrant_password is None:
161
raise AssertionError()
162
# TODO: perhaps fully quote the password to make it very slightly
164
# TODO: can we perhaps add extra Authorization headers
165
# directly to the request, rather than putting this into
166
# the url? perhaps a bit more secure against accidentally
167
# revealing it. std66 s3.2.1 discourages putting the
168
# password in the url.
169
hostinfo = '%s:%s@%s' % (urllib.quote(self.registrant_email),
170
urllib.quote(self.registrant_password),
172
url = urlunsplit((scheme, hostinfo, path, '', ''))
174
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, '', ''))
175
91
return xmlrpclib.ServerProxy(url, transport=self.transport)
177
93
def gather_user_credentials(self):
178
94
"""Get the password from the user."""
179
the_config = config.GlobalConfig()
180
self.registrant_email = the_config.user_email()
95
config = bzrlib.config.GlobalConfig()
96
self.registrant_email = config.user_email()
181
97
if self.registrant_password is None:
182
auth = config.AuthenticationConfig()
183
scheme, hostinfo = urlsplit(self.service_url)[:2]
184
98
prompt = 'launchpad.net password for %s: ' % \
185
99
self.registrant_email
186
# We will reuse http[s] credentials if we can, prompt user
188
self.registrant_password = auth.get_password(scheme, hostinfo,
189
self.registrant_email,
100
self.registrant_password = getpass(prompt)
192
def send_request(self, method_name, method_params, authenticated):
193
proxy = self.get_proxy(authenticated)
102
def send_request(self, method_name, method_params):
103
proxy = self.get_proxy()
194
105
method = getattr(proxy, method_name)
196
107
result = method(*method_params)
207
118
# TODO: print more headers to help in tracking down failures
208
119
raise errors.BzrError("xmlrpc protocol error connecting to %s: %s %s"
209
120
% (self.service_url, e.errcode, e.errmsg))
210
except socket.gaierror, e:
211
raise errors.ConnectionError(
212
"Could not resolve '%s'" % self.domain,
218
if self._lp_instance is None:
219
instance = self.DEFAULT_INSTANCE
221
instance = self._lp_instance
222
return self.LAUNCHPAD_DOMAINS[instance]
224
def _guess_branch_path(self, branch_url, _request_factory=None):
225
scheme, hostinfo, path = urlsplit(branch_url)[:3]
226
if _request_factory is None:
227
_request_factory = ResolveLaunchpadPathRequest
229
resolve = _request_factory(path)
231
result = resolve.submit(self)
232
except xmlrpclib.Fault, fault:
233
raise errors.InvalidURL(branch_url, str(fault))
234
branch_url = result['urls'][0]
235
path = urlsplit(branch_url)[2]
239
for domain in self.LAUNCHPAD_DOMAINS.itervalues())
240
if hostinfo not in domains:
241
raise NotLaunchpadBranch(branch_url)
242
return path.lstrip('/')
244
def get_web_url_from_branch_url(self, branch_url, _request_factory=None):
245
"""Get the Launchpad web URL for the given branch URL.
247
:raise errors.InvalidURL: if 'branch_url' cannot be identified as a
248
Launchpad branch URL.
249
:return: The URL of the branch on Launchpad.
251
path = self._guess_branch_path(branch_url, _request_factory)
252
return urlutils.join('https://code.%s' % self.domain, path)
255
124
class BaseRequest(object):
256
125
"""Base request for talking to a XMLRPC server."""
258
127
# Set this to the XMLRPC method name.
259
128
_methodname = None
260
_authenticated = True
262
130
def _request_params(self):
263
131
"""Return the arguments to pass to the method"""
added
removed
bzrlib/plugins/launchpad/lp_registration.py
