← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/plugins/launchpad/lp_api.py

  • Committer: Aaron Bentley
  • Date: 2005-09-21 15:33:23 UTC
  • mto: (1185.1.37)
  • mto: This revision was merged to the branch mainline in revision 1390.
  • Revision ID: abentley@panoramicfeedback.com-20050921153323-5db674d572d7649d
Fixed bug in distance-from-root graph operation

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
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
 
"""Tools for dealing with the Launchpad API."""
18
 
 
19
 
from __future__ import absolute_import
20
 
 
21
 
# Importing this module will be expensive, since it imports launchpadlib and
22
 
# its dependencies. However, our plan is to only load this module when it is
23
 
# needed by a command that uses it.
24
 
 
25
 
 
26
 
import os
27
 
import re
28
 
import urlparse
29
 
 
30
 
from bzrlib import (
31
 
    branch,
32
 
    config,
33
 
    errors,
34
 
    osutils,
35
 
    trace,
36
 
    transport,
37
 
    )
38
 
from bzrlib.i18n import gettext
39
 
from bzrlib.plugins.launchpad.lp_registration import (
40
 
    InvalidLaunchpadInstance,
41
 
    )
42
 
 
43
 
try:
44
 
    import launchpadlib
45
 
except ImportError, e:
46
 
    raise errors.DependencyNotPresent('launchpadlib', e)
47
 
 
48
 
from launchpadlib.launchpad import (
49
 
    STAGING_SERVICE_ROOT,
50
 
    Launchpad,
51
 
    )
52
 
from launchpadlib import uris
53
 
 
54
 
# Declare the minimum version of launchpadlib that we need in order to work.
55
 
# 1.6.0 is the version of launchpadlib packaged in Ubuntu 10.04, the most
56
 
# recent Ubuntu LTS release supported on the desktop at the time of writing.
57
 
MINIMUM_LAUNCHPADLIB_VERSION = (1, 6, 0)
58
 
 
59
 
 
60
 
def get_cache_directory():
61
 
    """Return the directory to cache launchpadlib objects in."""
62
 
    return osutils.pathjoin(config.config_dir(), 'launchpad')
63
 
 
64
 
 
65
 
def parse_launchpadlib_version(version_number):
66
 
    """Parse a version number of the style used by launchpadlib."""
67
 
    return tuple(map(int, version_number.split('.')))
68
 
 
69
 
 
70
 
def check_launchpadlib_compatibility():
71
 
    """Raise an error if launchpadlib has the wrong version number."""
72
 
    installed_version = parse_launchpadlib_version(launchpadlib.__version__)
73
 
    if installed_version < MINIMUM_LAUNCHPADLIB_VERSION:
74
 
        raise errors.IncompatibleAPI(
75
 
            'launchpadlib', MINIMUM_LAUNCHPADLIB_VERSION,
76
 
            installed_version, installed_version)
77
 
 
78
 
 
79
 
def lookup_service_root(service_root):
80
 
    try:
81
 
        return uris.lookup_service_root(service_root)
82
 
    except ValueError:
83
 
        if service_root != 'qastaging':
84
 
            raise
85
 
        staging_root = uris.lookup_service_root('staging')
86
 
        return staging_root.replace('staging', 'qastaging')
87
 
 
88
 
 
89
 
def _get_api_url(service):
90
 
    """Return the root URL of the Launchpad API.
91
 
 
92
 
    e.g. For the 'staging' Launchpad service, this function returns
93
 
    launchpadlib.launchpad.STAGING_SERVICE_ROOT.
94
 
 
95
 
    :param service: A `LaunchpadService` object.
96
 
    :return: A URL as a string.
97
 
    """
98
 
    if service._lp_instance is None:
99
 
        lp_instance = service.DEFAULT_INSTANCE
100
 
    else:
101
 
        lp_instance = service._lp_instance
102
 
    try:
103
 
        return lookup_service_root(lp_instance)
104
 
    except ValueError:
105
 
        raise InvalidLaunchpadInstance(lp_instance)
106
 
 
107
 
 
108
 
class NoLaunchpadBranch(errors.BzrError):
109
 
    _fmt = 'No launchpad branch could be found for branch "%(url)s".'
110
 
 
111
 
    def __init__(self, branch):
112
 
        errors.BzrError.__init__(self, branch=branch, url=branch.base)
113
 
 
114
 
 
115
 
def login(service, timeout=None, proxy_info=None,
116
 
          version=Launchpad.DEFAULT_VERSION):
117
 
    """Log in to the Launchpad API.
118
 
 
119
 
    :return: The root `Launchpad` object from launchpadlib.
120
 
    """
121
 
    cache_directory = get_cache_directory()
122
 
    launchpad = Launchpad.login_with(
123
 
        'bzr', _get_api_url(service), cache_directory, timeout=timeout,
124
 
        proxy_info=proxy_info, version=version)
125
 
    # XXX: Work-around a minor security bug in launchpadlib < 1.6.3, which
126
 
    # would create this directory with default umask.
127
 
    osutils.chmod_if_possible(cache_directory, 0700)
128
 
    return launchpad
129
 
 
130
 
 
131
 
class LaunchpadBranch(object):
132
 
    """Provide bzr and lp API access to a Launchpad branch."""
133
 
 
134
 
    def __init__(self, lp_branch, bzr_url, bzr_branch=None, check_update=True):
135
 
        """Constructor.
136
 
 
137
 
        :param lp_branch: The Launchpad branch.
138
 
        :param bzr_url: The URL of the Bazaar branch.
139
 
        :param bzr_branch: An instance of the Bazaar branch.
140
 
        """
141
 
        self.bzr_url = bzr_url
142
 
        self._bzr = bzr_branch
143
 
        self._push_bzr = None
144
 
        self._check_update = check_update
145
 
        self.lp = lp_branch
146
 
 
147
 
    @property
148
 
    def bzr(self):
149
 
        """Return the bzr branch for this branch."""
150
 
        if self._bzr is None:
151
 
            self._bzr = branch.Branch.open(self.bzr_url)
152
 
        return self._bzr
153
 
 
154
 
    @property
155
 
    def push_bzr(self):
156
 
        """Return the push branch for this branch."""
157
 
        if self._push_bzr is None:
158
 
            self._push_bzr = branch.Branch.open(self.lp.bzr_identity)
159
 
        return self._push_bzr
160
 
 
161
 
    @staticmethod
162
 
    def plausible_launchpad_url(url):
163
 
        """Is 'url' something that could conceivably be pushed to LP?
164
 
 
165
 
        :param url: A URL that may refer to a Launchpad branch.
166
 
        :return: A boolean.
167
 
        """
168
 
        if url is None:
169
 
            return False
170
 
        if url.startswith('lp:'):
171
 
            return True
172
 
        regex = re.compile('([a-z]*\+)*(bzr\+ssh|http)'
173
 
                           '://bazaar.*.launchpad.net')
174
 
        return bool(regex.match(url))
175
 
 
176
 
    @staticmethod
177
 
    def candidate_urls(bzr_branch):
178
 
        """Iterate through related URLs that might be Launchpad URLs.
179
 
 
180
 
        :param bzr_branch: A Bazaar branch to find URLs from.
181
 
        :return: a generator of URL strings.
182
 
        """
183
 
        url = bzr_branch.get_public_branch()
184
 
        if url is not None:
185
 
            yield url
186
 
        url = bzr_branch.get_push_location()
187
 
        if url is not None:
188
 
            yield url
189
 
        url = bzr_branch.get_parent()
190
 
        if url is not None:
191
 
            yield url
192
 
        yield bzr_branch.base
193
 
 
194
 
    @staticmethod
195
 
    def tweak_url(url, launchpad):
196
 
        """Adjust a URL to work with staging, if needed."""
197
 
        if str(launchpad._root_uri) == STAGING_SERVICE_ROOT:
198
 
            return url.replace('bazaar.launchpad.net',
199
 
                               'bazaar.staging.launchpad.net')
200
 
        elif str(launchpad._root_uri) == lookup_service_root('qastaging'):
201
 
            return url.replace('bazaar.launchpad.net',
202
 
                               'bazaar.qastaging.launchpad.net')
203
 
        return url
204
 
 
205
 
    @classmethod
206
 
    def from_bzr(cls, launchpad, bzr_branch, create_missing=True):
207
 
        """Find a Launchpad branch from a bzr branch."""
208
 
        check_update = True
209
 
        for url in cls.candidate_urls(bzr_branch):
210
 
            url = cls.tweak_url(url, launchpad)
211
 
            if not cls.plausible_launchpad_url(url):
212
 
                continue
213
 
            lp_branch = launchpad.branches.getByUrl(url=url)
214
 
            if lp_branch is not None:
215
 
                break
216
 
        else:
217
 
            if not create_missing:
218
 
                raise NoLaunchpadBranch(bzr_branch)
219
 
            lp_branch = cls.create_now(launchpad, bzr_branch)
220
 
            check_update = False
221
 
        return cls(lp_branch, bzr_branch.base, bzr_branch, check_update)
222
 
 
223
 
    @classmethod
224
 
    def create_now(cls, launchpad, bzr_branch):
225
 
        """Create a Bazaar branch on Launchpad for the supplied branch."""
226
 
        url = cls.tweak_url(bzr_branch.get_push_location(), launchpad)
227
 
        if not cls.plausible_launchpad_url(url):
228
 
            raise errors.BzrError(gettext('%s is not registered on Launchpad') %
229
 
                                  bzr_branch.base)
230
 
        bzr_branch.create_clone_on_transport(transport.get_transport(url))
231
 
        lp_branch = launchpad.branches.getByUrl(url=url)
232
 
        if lp_branch is None:
233
 
            raise errors.BzrError(gettext('%s is not registered on Launchpad') %
234
 
                                                                            url)
235
 
        return lp_branch
236
 
 
237
 
    def get_target(self):
238
 
        """Return the 'LaunchpadBranch' for the target of this one."""
239
 
        lp_branch = self.lp
240
 
        if lp_branch.project is not None:
241
 
            dev_focus = lp_branch.project.development_focus
242
 
            if dev_focus is None:
243
 
                raise errors.BzrError(gettext('%s has no development focus.') %
244
 
                                  lp_branch.bzr_identity)
245
 
            target = dev_focus.branch
246
 
            if target is None:
247
 
                raise errors.BzrError(gettext(
248
 
                        'development focus %s has no branch.') % dev_focus)
249
 
        elif lp_branch.sourcepackage is not None:
250
 
            target = lp_branch.sourcepackage.getBranch(pocket="Release")
251
 
            if target is None:
252
 
                raise errors.BzrError(gettext(
253
 
                                      'source package %s has no branch.') %
254
 
                                      lp_branch.sourcepackage)
255
 
        else:
256
 
            raise errors.BzrError(gettext(
257
 
                        '%s has no associated product or source package.') %
258
 
                                  lp_branch.bzr_identity)
259
 
        return LaunchpadBranch(target, target.bzr_identity)
260
 
 
261
 
    def update_lp(self):
262
 
        """Update the Launchpad copy of this branch."""
263
 
        if not self._check_update:
264
 
            return
265
 
        self.bzr.lock_read()
266
 
        try:
267
 
            if self.lp.last_scanned_id is not None:
268
 
                if self.bzr.last_revision() == self.lp.last_scanned_id:
269
 
                    trace.note(gettext('%s is already up-to-date.') %
270
 
                               self.lp.bzr_identity)
271
 
                    return
272
 
                graph = self.bzr.repository.get_graph()
273
 
                if not graph.is_ancestor(self.lp.last_scanned_id,
274
 
                                         self.bzr.last_revision()):
275
 
                    raise errors.DivergedBranches(self.bzr, self.push_bzr)
276
 
                trace.note(gettext('Pushing to %s') % self.lp.bzr_identity)
277
 
            self.bzr.push(self.push_bzr)
278
 
        finally:
279
 
            self.bzr.unlock()
280
 
 
281
 
    def find_lca_tree(self, other):
282
 
        """Find the revision tree for the LCA of this branch and other.
283
 
 
284
 
        :param other: Another LaunchpadBranch
285
 
        :return: The RevisionTree of the LCA of this branch and other.
286
 
        """
287
 
        graph = self.bzr.repository.get_graph(other.bzr.repository)
288
 
        lca = graph.find_unique_lca(self.bzr.last_revision(),
289
 
                                    other.bzr.last_revision())
290
 
        return self.bzr.repository.revision_tree(lca)
291
 
 
292
 
 
293
 
def canonical_url(object):
294
 
    """Return the canonical URL for a branch."""
295
 
    scheme, netloc, path, params, query, fragment = urlparse.urlparse(
296
 
        str(object.self_link))
297
 
    path = '/'.join(path.split('/')[2:])
298
 
    netloc = netloc.replace('api.', 'code.')
299
 
    return urlparse.urlunparse((scheme, netloc, path, params, query,
300
 
                                fragment))