/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/plugins/launchpad/lp_registration.py

  • Committer: Jelmer Vernooij
  • Date: 2019-01-01 21:08:01 UTC
  • mto: This revision was merged to the branch mainline in revision 7231.
  • Revision ID: jelmer@jelmer.uk-20190101210801-2dlsv7b1lvydmpkl
Fix tests.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/plugins/launchpad/lp_registration.py
 
1
# Copyright (C) 2006-2017 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
16
 
 
17
from __future__ import absolute_import
 
18
 
 
19
 
 
20
import os
 
21
import socket
 
22
try:
 
23
    from urllib.parse import urlsplit, urlunsplit
 
24
except ImportError:
 
25
    from urlparse import urlsplit, urlunsplit  # noqa: F401
 
26
import urllib
 
27
try:
 
28
    from xmlrpc.client import (
 
29
        __version__ as xmlrpc_version,
 
30
        Fault,
 
31
        ProtocolError,
 
32
        ServerProxy,
 
33
        Transport,
 
34
        )
 
35
except ImportError:  # python < 3
 
36
    from xmlrpclib import (
 
37
        __version__ as xmlrpc_version,
 
38
        Fault,
 
39
        ProtocolError,
 
40
        Transport,
 
41
        ServerProxy,
 
42
        )
 
43
 
 
44
from ... import (
 
45
    errors,
 
46
    urlutils,
 
47
    __version__ as _breezy_version,
 
48
    )
 
49
from ...transport.http import _urllib2_wrappers
 
50
 
 
51
 
 
52
# for testing, do
 
53
'''
 
54
export BRZ_LP_XMLRPC_URL=http://xmlrpc.staging.launchpad.net/bazaar/
 
55
'''
 
56
 
 
57
 
 
58
class InvalidURL(errors.PathError):
 
59
 
 
60
    _fmt = 'Invalid url supplied to transport: "%(path)s"%(extra)s'
 
61
 
 
62
 
 
63
class InvalidLaunchpadInstance(errors.BzrError):
 
64
 
 
65
    _fmt = "%(lp_instance)s is not a valid Launchpad instance."
 
66
 
 
67
    def __init__(self, lp_instance):
 
68
        errors.BzrError.__init__(self, lp_instance=lp_instance)
 
69
 
 
70
 
 
71
class NotLaunchpadBranch(errors.BzrError):
 
72
 
 
73
    _fmt = "%(url)s is not registered on Launchpad."
 
74
 
 
75
    def __init__(self, url):
 
76
        errors.BzrError.__init__(self, url=url)
 
77
 
 
78
 
 
79
class XMLRPCTransport(Transport):
 
80
 
 
81
    def __init__(self, scheme):
 
82
        Transport.__init__(self)
 
83
        self._scheme = scheme
 
84
        self._opener = _urllib2_wrappers.Opener()
 
85
        self.verbose = 0
 
86
 
 
87
    def request(self, host, handler, request_body, verbose=0):
 
88
        self.verbose = verbose
 
89
        url = self._scheme + "://" + host + handler
 
90
        request = _urllib2_wrappers.Request("POST", url, request_body)
 
91
        request.add_header("User-Agent", self.user_agent)
 
92
        request.add_header("Content-Type", "text/xml")
 
93
 
 
94
        response = self._opener.open(request)
 
95
        if response.code != 200:
 
96
            raise ProtocolError(host + handler, response.code,
 
97
                                response.msg, response.info())
 
98
        return self.parse_response(response)
 
99
 
 
100
 
 
101
class LaunchpadService(object):
 
102
    """A service to talk to Launchpad via XMLRPC.
 
103
 
 
104
    See http://wiki.bazaar.canonical.com/Specs/LaunchpadRpc for the methods we
 
105
    can call.
 
106
    """
 
107
 
 
108
    LAUNCHPAD_DOMAINS = {
 
109
        'production': 'launchpad.net',
 
110
        'staging': 'staging.launchpad.net',
 
111
        'qastaging': 'qastaging.launchpad.net',
 
112
        'demo': 'demo.launchpad.net',
 
113
        'dev': 'launchpad.dev',
 
114
        }
 
115
 
 
116
    # NB: these should always end in a slash to avoid xmlrpclib appending
 
117
    # '/RPC2'
 
118
    LAUNCHPAD_INSTANCE = {}
 
119
    for instance, domain in LAUNCHPAD_DOMAINS.items():
 
120
        LAUNCHPAD_INSTANCE[instance] = 'https://xmlrpc.%s/bazaar/' % domain
 
121
 
 
122
    # We use production as the default because edge has been deprecated circa
 
123
    # 2010-11 (see bug https://bugs.launchpad.net/bzr/+bug/583667)
 
124
    DEFAULT_INSTANCE = 'production'
 
125
    DEFAULT_SERVICE_URL = LAUNCHPAD_INSTANCE[DEFAULT_INSTANCE]
 
126
 
 
127
    transport = None
 
128
    registrant_email = None
 
129
    registrant_password = None
 
130
 
 
131
    def __init__(self, transport=None, lp_instance=None):
 
132
        """Construct a new service talking to the launchpad rpc server"""
 
133
        self._lp_instance = lp_instance
 
134
        if transport is None:
 
135
            uri_type = urlutils.parse_url(self.service_url)[0]
 
136
            transport = XMLRPCTransport(uri_type)
 
137
            transport.user_agent = 'Breezy/%s (xmlrpc/%s)' \
 
138
                % (_breezy_version, xmlrpc_version)
 
139
        self.transport = transport
 
140
 
 
141
    @property
 
142
    def service_url(self):
 
143
        """Return the http or https url for the xmlrpc server.
 
144
 
 
145
        This does not include the username/password credentials.
 
146
        """
 
147
        key = 'BRZ_LP_XMLRPC_URL'
 
148
        if key in os.environ:
 
149
            return os.environ[key]
 
150
        elif self._lp_instance is not None:
 
151
            try:
 
152
                return self.LAUNCHPAD_INSTANCE[self._lp_instance]
 
153
            except KeyError:
 
154
                raise InvalidLaunchpadInstance(self._lp_instance)
 
155
        else:
 
156
            return self.DEFAULT_SERVICE_URL
 
157
 
 
158
    @classmethod
 
159
    def for_url(cls, url, **kwargs):
 
160
        """Return the Launchpad service corresponding to the given URL."""
 
161
        result = urlsplit(url)
 
162
        lp_instance = result[1]
 
163
        if lp_instance == '':
 
164
            lp_instance = None
 
165
        elif lp_instance not in cls.LAUNCHPAD_INSTANCE:
 
166
            raise InvalidURL(url)
 
167
        return cls(lp_instance=lp_instance, **kwargs)
 
168
 
 
169
    def get_proxy(self):
 
170
        """Return the proxy for XMLRPC requests."""
 
171
        url = self.service_url
 
172
        return ServerProxy(url, transport=self.transport)
 
173
 
 
174
    def send_request(self, method_name, method_params):
 
175
        proxy = self.get_proxy()
 
176
        method = getattr(proxy, method_name)
 
177
        try:
 
178
            result = method(*method_params)
 
179
        except ProtocolError as e:
 
180
            if e.errcode == 301:
 
181
                # TODO: This can give a ProtocolError representing a 301 error, whose
 
182
                # e.headers['location'] tells where to go and e.errcode==301; should
 
183
                # probably log something and retry on the new url.
 
184
                raise NotImplementedError("should resend request to %s, but this isn't implemented"
 
185
                                          % e.headers.get('Location', 'NO-LOCATION-PRESENT'))
 
186
            else:
 
187
                # we don't want to print the original message because its
 
188
                # str representation includes the plaintext password.
 
189
                # TODO: print more headers to help in tracking down failures
 
190
                raise errors.BzrError("xmlrpc protocol error connecting to %s: %s %s"
 
191
                                      % (self.service_url, e.errcode, e.errmsg))
 
192
        except socket.gaierror as e:
 
193
            raise errors.ConnectionError(
 
194
                "Could not resolve '%s'" % self.domain,
 
195
                orig_error=e)
 
196
        return result
 
197
 
 
198
    @property
 
199
    def domain(self):
 
200
        if self._lp_instance is None:
 
201
            instance = self.DEFAULT_INSTANCE
 
202
        else:
 
203
            instance = self._lp_instance
 
204
        return self.LAUNCHPAD_DOMAINS[instance]
 
205
 
 
206
    def _guess_branch_path(self, branch_url, _request_factory=None):
 
207
        scheme, hostinfo, path = urlsplit(branch_url)[:3]
 
208
        if _request_factory is None:
 
209
            _request_factory = ResolveLaunchpadPathRequest
 
210
        if scheme == 'lp':
 
211
            resolve = _request_factory(path)
 
212
            try:
 
213
                result = resolve.submit(self)
 
214
            except Fault as fault:
 
215
                raise InvalidURL(branch_url, str(fault))
 
216
            branch_url = result['urls'][0]
 
217
            path = urlsplit(branch_url)[2]
 
218
        else:
 
219
            domains = (
 
220
                'bazaar.%s' % domain
 
221
                for domain in self.LAUNCHPAD_DOMAINS.values())
 
222
            if hostinfo not in domains:
 
223
                raise NotLaunchpadBranch(branch_url)
 
224
        return path.lstrip('/')
 
225
 
 
226
    def get_web_url_from_branch_url(self, branch_url, _request_factory=None):
 
227
        """Get the Launchpad web URL for the given branch URL.
 
228
 
 
229
        :raise InvalidURL: if 'branch_url' cannot be identified as a
 
230
            Launchpad branch URL.
 
231
        :return: The URL of the branch on Launchpad.
 
232
        """
 
233
        path = self._guess_branch_path(branch_url, _request_factory)
 
234
        return urlutils.join('https://code.%s' % self.domain, path)
 
235
 
 
236
 
 
237
class BaseRequest(object):
 
238
    """Base request for talking to a XMLRPC server."""
 
239
 
 
240
    # Set this to the XMLRPC method name.
 
241
    _methodname = None
 
242
 
 
243
    def _request_params(self):
 
244
        """Return the arguments to pass to the method"""
 
245
        raise NotImplementedError(self._request_params)
 
246
 
 
247
    def submit(self, service):
 
248
        """Submit request to Launchpad XMLRPC server.
 
249
 
 
250
        :param service: LaunchpadService indicating where to send the request.
 
251
        """
 
252
        return service.send_request(self._methodname, self._request_params())
 
253
 
 
254
 
 
255
class DryRunLaunchpadService(LaunchpadService):
 
256
    """Service that just absorbs requests without sending to server."""
 
257
 
 
258
    def send_request(self, method_name, method_params):
 
259
        pass
 
260
 
 
261
 
 
262
class ResolveLaunchpadPathRequest(BaseRequest):
 
263
    """Request to resolve the path component of an lp: URL."""
 
264
 
 
265
    _methodname = 'resolve_lp_path'
 
266
 
 
267
    def __init__(self, path):
 
268
        if not path:
 
269
            raise InvalidURL(url=path, extra="You must specify a project.")
 
270
        self.path = path
 
271
 
 
272
    def _request_params(self):
 
273
        """Return xmlrpc request parameters"""
 
274
        return (self.path,)