/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 bzrlib/plugins/launchpad/lp_api.py

  • Committer: Robert Collins
  • Date: 2010-05-11 08:36:16 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100511083616-b8fjb19zomwupid0
Make all lock methods return Result objects, rather than lock_read returning self, as per John's review.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugins/launchpad/lp_api.py
1
 
# Copyright (C) 2009-2012 Canonical Ltd
 
1
# Copyright (C) 2009, 2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
16
16
 
17
17
"""Tools for dealing with the Launchpad API."""
18
18
 
19
 
from __future__ import absolute_import
20
 
 
21
19
# Importing this module will be expensive, since it imports launchpadlib and
22
20
# its dependencies. However, our plan is to only load this module when it is
23
21
# needed by a command that uses it.
24
22
 
25
23
 
 
24
import os
26
25
import re
27
 
try:
28
 
    from urllib.parse import (
29
 
        urlparse,
30
 
        urlunparse,
31
 
        )
32
 
except ImportError:  # python < 3
33
 
    from urlparse import (
34
 
        urlparse,
35
 
        urlunparse,
36
 
        )
37
26
 
38
 
from ... import (
 
27
from bzrlib import (
39
28
    branch,
40
 
    bedding,
 
29
    config,
41
30
    errors,
42
31
    osutils,
43
32
    trace,
44
33
    transport,
45
34
    )
46
 
from ...i18n import gettext
47
 
 
48
 
 
49
 
class LaunchpadlibMissing(errors.DependencyNotPresent):
50
 
 
51
 
    _fmt = ("launchpadlib is required for Launchpad API access. "
52
 
            "Please install the launchpadlib package.")
53
 
 
54
 
    def __init__(self, e):
55
 
        super(LaunchpadlibMissing, self).__init__(
56
 
            'launchpadlib', e)
 
35
from bzrlib.plugins.launchpad.lp_registration import (
 
36
    InvalidLaunchpadInstance,
 
37
    NotLaunchpadBranch,
 
38
    )
57
39
 
58
40
try:
59
41
    import launchpadlib
60
 
except ImportError as e:
61
 
    raise LaunchpadlibMissing(e)
 
42
except ImportError, e:
 
43
    raise errors.DependencyNotPresent('launchpadlib', e)
62
44
 
63
 
from launchpadlib.credentials import RequestTokenAuthorizationEngine
64
45
from launchpadlib.launchpad import (
 
46
    EDGE_SERVICE_ROOT,
 
47
    STAGING_SERVICE_ROOT,
65
48
    Launchpad,
66
49
    )
67
 
from launchpadlib import uris
 
50
 
68
51
 
69
52
# Declare the minimum version of launchpadlib that we need in order to work.
70
 
MINIMUM_LAUNCHPADLIB_VERSION = (1, 6, 3)
 
53
# 1.5.1 is the version of launchpadlib packaged in Ubuntu 9.10, the most
 
54
# recent Ubuntu release at the time of writing.
 
55
MINIMUM_LAUNCHPADLIB_VERSION = (1, 5, 1)
71
56
 
72
57
 
73
58
def get_cache_directory():
74
59
    """Return the directory to cache launchpadlib objects in."""
75
 
    return osutils.pathjoin(bedding.cache_dir(), 'launchpad')
 
60
    return osutils.pathjoin(config.config_dir(), 'launchpad')
76
61
 
77
62
 
78
63
def parse_launchpadlib_version(version_number):
84
69
    """Raise an error if launchpadlib has the wrong version number."""
85
70
    installed_version = parse_launchpadlib_version(launchpadlib.__version__)
86
71
    if installed_version < MINIMUM_LAUNCHPADLIB_VERSION:
87
 
        raise errors.DependencyNotPresent(
88
 
            'launchpadlib',
89
 
            'At least launchpadlib %s is required, but installed version is %s'
90
 
            % (MINIMUM_LAUNCHPADLIB_VERSION, installed_version))
91
 
 
92
 
 
93
 
def lookup_service_root(service_root):
 
72
        raise errors.IncompatibleAPI(
 
73
            'launchpadlib', MINIMUM_LAUNCHPADLIB_VERSION,
 
74
            installed_version, installed_version)
 
75
 
 
76
 
 
77
LAUNCHPAD_API_URLS = {
 
78
    'production': 'https://api.launchpad.net/beta/',
 
79
    'edge': EDGE_SERVICE_ROOT,
 
80
    'staging': STAGING_SERVICE_ROOT,
 
81
    'dev': 'https://api.launchpad.dev/beta/',
 
82
    }
 
83
 
 
84
 
 
85
def _get_api_url(service):
 
86
    """Return the root URL of the Launchpad API.
 
87
 
 
88
    e.g. For the 'edge' Launchpad service, this function returns
 
89
    launchpadlib.launchpad.EDGE_SERVICE_ROOT.
 
90
 
 
91
    :param service: A `LaunchpadService` object.
 
92
    :return: A URL as a string.
 
93
    """
 
94
    if service._lp_instance is None:
 
95
        lp_instance = service.DEFAULT_INSTANCE
 
96
    else:
 
97
        lp_instance = service._lp_instance
94
98
    try:
95
 
        return uris.lookup_service_root(service_root)
96
 
    except ValueError:
97
 
        if service_root != 'qastaging':
98
 
            raise
99
 
        staging_root = uris.lookup_service_root('staging')
100
 
        return staging_root.replace('staging', 'qastaging')
101
 
 
102
 
 
103
 
class NoLaunchpadBranch(errors.BzrError):
104
 
    _fmt = 'No launchpad branch could be found for branch "%(url)s".'
105
 
 
106
 
    def __init__(self, branch):
107
 
        errors.BzrError.__init__(self, branch=branch, url=branch.base)
108
 
 
109
 
 
110
 
def get_auth_engine(base_url):
111
 
    return Launchpad.authorization_engine_factory(base_url, 'breezy')
112
 
 
113
 
 
114
 
def get_credential_store():
115
 
    return Launchpad.credential_store_factory(None)
116
 
 
117
 
 
118
 
def connect_launchpad(base_url, timeout=None, proxy_info=None,
119
 
                      version=Launchpad.DEFAULT_VERSION):
 
99
        return LAUNCHPAD_API_URLS[lp_instance]
 
100
    except KeyError:
 
101
        raise InvalidLaunchpadInstance(lp_instance)
 
102
 
 
103
 
 
104
def login(service, timeout=None, proxy_info=None):
120
105
    """Log in to the Launchpad API.
121
106
 
122
107
    :return: The root `Launchpad` object from launchpadlib.
123
108
    """
124
 
    if proxy_info is None:
125
 
        import httplib2
126
 
        proxy_info = httplib2.proxy_info_from_environment('https')
127
 
    try:
128
 
        cache_directory = get_cache_directory()
129
 
    except EnvironmentError:
130
 
        cache_directory = None
131
 
    credential_store = get_credential_store()
132
 
    authorization_engine = get_auth_engine(base_url)
133
 
    return Launchpad.login_with(
134
 
        'breezy', base_url, cache_directory, timeout=timeout,
135
 
        credential_store=credential_store,
136
 
        authorization_engine=authorization_engine,
137
 
        proxy_info=proxy_info, version=version)
138
 
 
 
109
    cache_directory = get_cache_directory()
 
110
    launchpad = Launchpad.login_with(
 
111
        'bzr', _get_api_url(service), cache_directory, timeout=timeout,
 
112
        proxy_info=proxy_info)
 
113
    # XXX: Work-around a minor security bug in launchpadlib 1.5.1, which would
 
114
    # create this directory with default umask.
 
115
    os.chmod(cache_directory, 0700)
 
116
    return launchpad
139
117
 
140
118
 
141
119
class LaunchpadBranch(object):
179
157
            return False
180
158
        if url.startswith('lp:'):
181
159
            return True
182
 
        regex = re.compile('([a-z]*\\+)*(bzr\\+ssh|http)'
 
160
        regex = re.compile('([a-z]*\+)*(bzr\+ssh|http)'
183
161
                           '://bazaar.*.launchpad.net')
184
162
        return bool(regex.match(url))
185
163
 
196
174
        url = bzr_branch.get_push_location()
197
175
        if url is not None:
198
176
            yield url
199
 
        url = bzr_branch.get_parent()
200
 
        if url is not None:
201
 
            yield url
202
177
        yield bzr_branch.base
203
178
 
204
179
    @staticmethod
205
180
    def tweak_url(url, launchpad):
206
181
        """Adjust a URL to work with staging, if needed."""
207
 
        if str(launchpad._root_uri) == uris.STAGING_SERVICE_ROOT:
208
 
            return url.replace('bazaar.launchpad.net',
209
 
                               'bazaar.staging.launchpad.net')
210
 
        elif str(launchpad._root_uri) == lookup_service_root('qastaging'):
211
 
            return url.replace('bazaar.launchpad.net',
212
 
                               'bazaar.qastaging.launchpad.net')
213
 
        return url
 
182
        if str(launchpad._root_uri) != STAGING_SERVICE_ROOT:
 
183
            return url
 
184
        if url is None:
 
185
            return None
 
186
        return url.replace('bazaar.launchpad.net',
 
187
                           'bazaar.staging.launchpad.net')
214
188
 
215
189
    @classmethod
216
 
    def from_bzr(cls, launchpad, bzr_branch, create_missing=True):
 
190
    def from_bzr(cls, launchpad, bzr_branch):
217
191
        """Find a Launchpad branch from a bzr branch."""
218
192
        check_update = True
219
193
        for url in cls.candidate_urls(bzr_branch):
224
198
            if lp_branch is not None:
225
199
                break
226
200
        else:
227
 
            if not create_missing:
228
 
                raise NoLaunchpadBranch(bzr_branch)
229
201
            lp_branch = cls.create_now(launchpad, bzr_branch)
230
202
            check_update = False
231
203
        return cls(lp_branch, bzr_branch.base, bzr_branch, check_update)
235
207
        """Create a Bazaar branch on Launchpad for the supplied branch."""
236
208
        url = cls.tweak_url(bzr_branch.get_push_location(), launchpad)
237
209
        if not cls.plausible_launchpad_url(url):
238
 
            raise errors.BzrError(gettext('%s is not registered on Launchpad') %
 
210
            raise errors.BzrError('%s is not registered on Launchpad' %
239
211
                                  bzr_branch.base)
240
212
        bzr_branch.create_clone_on_transport(transport.get_transport(url))
241
213
        lp_branch = launchpad.branches.getByUrl(url=url)
242
214
        if lp_branch is None:
243
 
            raise errors.BzrError(gettext('%s is not registered on Launchpad') %
244
 
                                  url)
 
215
            raise errors.BzrError('%s is not registered on Launchpad' % url)
245
216
        return lp_branch
246
217
 
247
 
    def get_target(self):
248
 
        """Return the 'LaunchpadBranch' for the target of this one."""
 
218
    def get_dev_focus(self):
 
219
        """Return the 'LaunchpadBranch' for the dev focus of this one."""
249
220
        lp_branch = self.lp
250
 
        if lp_branch.project is not None:
251
 
            dev_focus = lp_branch.project.development_focus
252
 
            if dev_focus is None:
253
 
                raise errors.BzrError(gettext('%s has no development focus.') %
254
 
                                      lp_branch.bzr_identity)
255
 
            target = dev_focus.branch
256
 
            if target is None:
257
 
                raise errors.BzrError(gettext(
258
 
                    'development focus %s has no branch.') % dev_focus)
259
 
        elif lp_branch.sourcepackage is not None:
260
 
            target = lp_branch.sourcepackage.getBranch(pocket="Release")
261
 
            if target is None:
262
 
                raise errors.BzrError(gettext(
263
 
                                      'source package %s has no branch.') %
264
 
                                      lp_branch.sourcepackage)
265
 
        else:
266
 
            raise errors.BzrError(gettext(
267
 
                '%s has no associated product or source package.') %
268
 
                lp_branch.bzr_identity)
269
 
        return LaunchpadBranch(target, target.bzr_identity)
 
221
        if lp_branch.project is None:
 
222
            raise errors.BzrError('%s has no product.' %
 
223
                                  lp_branch.bzr_identity)
 
224
        dev_focus = lp_branch.project.development_focus.branch
 
225
        if dev_focus is None:
 
226
            raise errors.BzrError('%s has no development focus.' %
 
227
                                  lp_branch.bzr_identity)
 
228
        return LaunchpadBranch(dev_focus, dev_focus.bzr_identity)
270
229
 
271
230
    def update_lp(self):
272
231
        """Update the Launchpad copy of this branch."""
273
232
        if not self._check_update:
274
233
            return
275
 
        with self.bzr.lock_read():
 
234
        self.bzr.lock_read()
 
235
        try:
276
236
            if self.lp.last_scanned_id is not None:
277
237
                if self.bzr.last_revision() == self.lp.last_scanned_id:
278
 
                    trace.note(gettext('%s is already up-to-date.') %
 
238
                    trace.note('%s is already up-to-date.' %
279
239
                               self.lp.bzr_identity)
280
240
                    return
281
241
                graph = self.bzr.repository.get_graph()
282
 
                if not graph.is_ancestor(osutils.safe_utf8(self.lp.last_scanned_id),
 
242
                if not graph.is_ancestor(self.lp.last_scanned_id,
283
243
                                         self.bzr.last_revision()):
284
244
                    raise errors.DivergedBranches(self.bzr, self.push_bzr)
285
 
                trace.note(gettext('Pushing to %s') % self.lp.bzr_identity)
 
245
                trace.note('Pushing to %s' % self.lp.bzr_identity)
286
246
            self.bzr.push(self.push_bzr)
 
247
        finally:
 
248
            self.bzr.unlock()
287
249
 
288
250
    def find_lca_tree(self, other):
289
251
        """Find the revision tree for the LCA of this branch and other.
297
259
        return self.bzr.repository.revision_tree(lca)
298
260
 
299
261
 
300
 
def canonical_url(object):
301
 
    """Return the canonical URL for a branch."""
302
 
    scheme, netloc, path, params, query, fragment = urlparse(
303
 
        str(object.self_link))
304
 
    path = '/'.join(path.split('/')[2:])
305
 
    netloc = netloc.replace('api.', 'code.')
306
 
    return urlunparse((scheme, netloc, path, params, query, fragment))
 
262
def load_branch(launchpad, branch):
 
263
    """Return the launchpadlib Branch object corresponding to 'branch'.
 
264
 
 
265
    :param launchpad: The root `Launchpad` object from launchpadlib.
 
266
    :param branch: A `bzrlib.branch.Branch`.
 
267
    :raise NotLaunchpadBranch: If we cannot determine the Launchpad URL of
 
268
        `branch`.
 
269
    :return: A launchpadlib Branch object.
 
270
    """
 
271
    # XXX: This duplicates the "What are possible URLs for the branch that
 
272
    # Launchpad might recognize" logic found in cmd_lp_open.
 
273
 
 
274
    # XXX: This makes multiple roundtrips to Launchpad for what is
 
275
    # conceptually a single operation -- get me the branches that match these
 
276
    # URLs. Unfortunately, Launchpad's support for such operations is poor, so
 
277
    # we have to allow multiple roundtrips.
 
278
    for url in branch.get_public_branch(), branch.get_push_location():
 
279
        lp_branch = launchpad.branches.getByUrl(url=url)
 
280
        if lp_branch:
 
281
            return lp_branch
 
282
    raise NotLaunchpadBranch(url)