/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: 2017-06-10 16:40:42 UTC
  • mfrom: (6653.6.7 rename-controldir)
  • mto: This revision was merged to the branch mainline in revision 6690.
  • Revision ID: jelmer@jelmer.uk-20170610164042-zrxqgy2htyduvke2
Merge rename-controldir branch.

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