1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
# Copyright (C) 2006 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
from getpass import getpass
import os
from urlparse import urlsplit, urlunsplit
import urllib
import xmlrpclib
import bzrlib.config
import bzrlib.errors as errors
# for testing, do
'''
export BZR_LP_XMLRPC_URL=http://xmlrpc.staging.launchpad.net/bazaar/
'''
class LaunchpadService(object):
"""A service to talk to Launchpad via XMLRPC.
See http://bazaar-vcs.org/Specs/LaunchpadRpc for the methods we can call.
"""
# NB: this should always end in a slash to avoid xmlrpclib appending
# '/RPC2'
DEFAULT_SERVICE_URL = 'https://xmlrpc.launchpad.net/bazaar/'
transport = None
registrant_email = None
registrant_password = None
def __init__(self, transport=None):
"""Construct a new service talking to the launchpad rpc server"""
if transport is None:
uri_type = urllib.splittype(self.service_url)[0]
if uri_type == 'https':
transport = xmlrpclib.SafeTransport()
else:
transport = xmlrpclib.Transport()
transport.user_agent = 'bzr/%s (xmlrpclib/%s)' \
% (bzrlib.__version__, xmlrpclib.__version__)
self.transport = transport
@property
def service_url(self):
"""Return the http or https url for the xmlrpc server.
This does not include the username/password credentials.
"""
key = 'BZR_LP_XMLRPC_URL'
if key in os.environ:
return os.environ[key]
else:
return self.DEFAULT_SERVICE_URL
def get_proxy(self):
"""Return the proxy for XMLRPC requests."""
# auth info must be in url
# TODO: if there's no registrant email perhaps we should just connect
# anonymously?
scheme, hostinfo, path = urlsplit(self.service_url)[:3]
assert '@' not in hostinfo
assert self.registrant_email is not None
assert self.registrant_password is not None
# TODO: perhaps fully quote the password to make it very slightly
# obscured
# TODO: can we perhaps add extra Authorization headers directly to the
# request, rather than putting this into the url? perhaps a bit more
# secure against accidentally revealing it. std66 s3.2.1 discourages putting
# the password in the url.
hostinfo = '%s:%s@%s' % (urllib.quote(self.registrant_email),
urllib.quote(self.registrant_password),
hostinfo)
url = urlunsplit((scheme, hostinfo, path, '', ''))
return xmlrpclib.ServerProxy(url, transport=self.transport)
def gather_user_credentials(self):
"""Get the password from the user."""
config = bzrlib.config.GlobalConfig()
self.registrant_email = config.user_email()
if self.registrant_password is None:
prompt = 'launchpad.net password for %s: ' % \
self.registrant_email
self.registrant_password = getpass(prompt)
def send_request(self, method_name, method_params):
proxy = self.get_proxy()
assert method_name
method = getattr(proxy, method_name)
try:
result = method(*method_params)
except xmlrpclib.ProtocolError, e:
if e.errcode == 301:
# TODO: This can give a ProtocolError representing a 301 error, whose
# e.headers['location'] tells where to go and e.errcode==301; should
# probably log something and retry on the new url.
raise NotImplementedError("should resend request to %s, but this isn't implemented"
% e.headers.get('Location', 'NO-LOCATION-PRESENT'))
else:
# we don't want to print the original message because its
# str representation includes the plaintext password.
# TODO: print more headers to help in tracking down failures
raise errors.BzrError("xmlrpc protocol error connecting to %s: %s %s"
% (self.service_url, e.errcode, e.errmsg))
return result
class BaseRequest(object):
"""Base request for talking to a XMLRPC server."""
# Set this to the XMLRPC method name.
_methodname = None
def _request_params(self):
"""Return the arguments to pass to the method"""
raise NotImplementedError(self._request_params)
def submit(self, service):
"""Submit request to Launchpad XMLRPC server.
:param service: LaunchpadService indicating where to send
the request and the authentication credentials.
"""
return service.send_request(self._methodname, self._request_params())
class DryRunLaunchpadService(LaunchpadService):
"""Service that just absorbs requests without sending to server.
The dummy service does not need authentication.
"""
def send_request(self, method_name, method_params):
pass
def gather_user_credentials(self):
pass
class BranchRegistrationRequest(BaseRequest):
"""Request to tell Launchpad about a bzr branch."""
_methodname = 'register_branch'
def __init__(self, branch_url,
branch_name='',
branch_title='',
branch_description='',
author_email='',
product_name='',
):
assert branch_url
self.branch_url = branch_url
if branch_name:
self.branch_name = branch_name
else:
self.branch_name = self._find_default_branch_name(self.branch_url)
self.branch_title = branch_title
self.branch_description = branch_description
self.author_email = author_email
self.product_name = product_name
def _request_params(self):
"""Return xmlrpc request parameters"""
# This must match the parameter tuple expected by Launchpad for this
# method
return (self.branch_url,
self.branch_name,
self.branch_title,
self.branch_description,
self.author_email,
self.product_name,
)
def _find_default_branch_name(self, branch_url):
i = branch_url.rfind('/')
return branch_url[i+1:]
class BranchBugLinkRequest(BaseRequest):
"""Request to link a bzr branch in Launchpad to a bug."""
_methodname = 'link_branch_to_bug'
def __init__(self, branch_url, bug_id):
assert branch_url
self.bug_id = bug_id
self.branch_url = branch_url
def _request_params(self):
"""Return xmlrpc request parameters"""
# This must match the parameter tuple expected by Launchpad for this
# method
return (self.branch_url, self.bug_id, '')
|