~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-02-03 10:06:19 UTC
  • mfrom: (4999.3.2 apport)
  • Revision ID: pqm@pqm.ubuntu.com-20100203100619-f76bo5y5bd5c14wk
(mbp) use apport to send bugs, not just store them

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2009, 2010 Canonical Ltd
 
1
# Copyright (C) 2009 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
 
26
24
import os
27
 
import re
28
 
import urlparse
29
25
 
30
26
from bzrlib import (
31
 
    branch,
32
27
    config,
33
28
    errors,
34
29
    osutils,
35
 
    trace,
36
 
    transport,
37
30
    )
38
 
from bzrlib.i18n import gettext
39
31
from bzrlib.plugins.launchpad.lp_registration import (
40
32
    InvalidLaunchpadInstance,
 
33
    NotLaunchpadBranch,
41
34
    )
42
35
 
43
36
try:
46
39
    raise errors.DependencyNotPresent('launchpadlib', e)
47
40
 
48
41
from launchpadlib.launchpad import (
 
42
    EDGE_SERVICE_ROOT,
49
43
    STAGING_SERVICE_ROOT,
50
44
    Launchpad,
51
45
    )
76
70
            installed_version, installed_version)
77
71
 
78
72
 
79
 
# The older versions of launchpadlib only provided service root constants for
80
 
# edge and staging, whilst newer versions drop edge. Therefore service root
81
 
# URIs for which we do not always have constants are derived from the staging
82
 
# one, which does always exist.
83
 
#
84
 
# It is necessary to derive, rather than use hardcoded URIs because
85
 
# launchpadlib <= 1.5.4 requires service root URIs that end in a path of
86
 
# /beta/, whilst launchpadlib >= 1.5.5 requires service root URIs with no path
87
 
# info.
88
 
#
89
 
# Once we have a hard dependency on launchpadlib >= 1.5.4 we can replace all of
90
 
# bzr's local knowledge of individual Launchpad instances with use of the
91
 
# launchpadlib.uris module.
92
73
LAUNCHPAD_API_URLS = {
93
 
    'production': STAGING_SERVICE_ROOT.replace('api.staging.launchpad.net',
94
 
        'api.launchpad.net'),
95
 
    'qastaging': STAGING_SERVICE_ROOT.replace('api.staging.launchpad.net',
96
 
        'api.qastaging.launchpad.net'),
 
74
    'production': 'https://api.launchpad.net/beta/',
 
75
    'edge': EDGE_SERVICE_ROOT,
97
76
    'staging': STAGING_SERVICE_ROOT,
98
 
    'dev': STAGING_SERVICE_ROOT.replace('api.staging.launchpad.net',
99
 
        'api.launchpad.dev'),
 
77
    'dev': 'https://api.launchpad.dev/beta/',
100
78
    }
101
79
 
102
80
 
103
81
def _get_api_url(service):
104
82
    """Return the root URL of the Launchpad API.
105
83
 
106
 
    e.g. For the 'staging' Launchpad service, this function returns
107
 
    launchpadlib.launchpad.STAGING_SERVICE_ROOT.
 
84
    e.g. For the 'edge' Launchpad service, this function returns
 
85
    launchpadlib.launchpad.EDGE_SERVICE_ROOT.
108
86
 
109
87
    :param service: A `LaunchpadService` object.
110
88
    :return: A URL as a string.
119
97
        raise InvalidLaunchpadInstance(lp_instance)
120
98
 
121
99
 
122
 
class NoLaunchpadBranch(errors.BzrError):
123
 
    _fmt = 'No launchpad branch could be found for branch "%(url)s".'
124
 
 
125
 
    def __init__(self, branch):
126
 
        errors.BzrError.__init__(self, branch=branch, url=branch.base)
127
 
 
128
 
 
129
100
def login(service, timeout=None, proxy_info=None):
130
101
    """Log in to the Launchpad API.
131
102
 
137
108
        proxy_info=proxy_info)
138
109
    # XXX: Work-around a minor security bug in launchpadlib 1.5.1, which would
139
110
    # create this directory with default umask.
140
 
    osutils.chmod_if_possible(cache_directory, 0700)
 
111
    os.chmod(cache_directory, 0700)
141
112
    return launchpad
142
113
 
143
114
 
144
 
class LaunchpadBranch(object):
145
 
    """Provide bzr and lp API access to a Launchpad branch."""
146
 
 
147
 
    def __init__(self, lp_branch, bzr_url, bzr_branch=None, check_update=True):
148
 
        """Constructor.
149
 
 
150
 
        :param lp_branch: The Launchpad branch.
151
 
        :param bzr_url: The URL of the Bazaar branch.
152
 
        :param bzr_branch: An instance of the Bazaar branch.
153
 
        """
154
 
        self.bzr_url = bzr_url
155
 
        self._bzr = bzr_branch
156
 
        self._push_bzr = None
157
 
        self._check_update = check_update
158
 
        self.lp = lp_branch
159
 
 
160
 
    @property
161
 
    def bzr(self):
162
 
        """Return the bzr branch for this branch."""
163
 
        if self._bzr is None:
164
 
            self._bzr = branch.Branch.open(self.bzr_url)
165
 
        return self._bzr
166
 
 
167
 
    @property
168
 
    def push_bzr(self):
169
 
        """Return the push branch for this branch."""
170
 
        if self._push_bzr is None:
171
 
            self._push_bzr = branch.Branch.open(self.lp.bzr_identity)
172
 
        return self._push_bzr
173
 
 
174
 
    @staticmethod
175
 
    def plausible_launchpad_url(url):
176
 
        """Is 'url' something that could conceivably be pushed to LP?
177
 
 
178
 
        :param url: A URL that may refer to a Launchpad branch.
179
 
        :return: A boolean.
180
 
        """
181
 
        if url is None:
182
 
            return False
183
 
        if url.startswith('lp:'):
184
 
            return True
185
 
        regex = re.compile('([a-z]*\+)*(bzr\+ssh|http)'
186
 
                           '://bazaar.*.launchpad.net')
187
 
        return bool(regex.match(url))
188
 
 
189
 
    @staticmethod
190
 
    def candidate_urls(bzr_branch):
191
 
        """Iterate through related URLs that might be Launchpad URLs.
192
 
 
193
 
        :param bzr_branch: A Bazaar branch to find URLs from.
194
 
        :return: a generator of URL strings.
195
 
        """
196
 
        url = bzr_branch.get_public_branch()
197
 
        if url is not None:
198
 
            yield url
199
 
        url = bzr_branch.get_push_location()
200
 
        if url is not None:
201
 
            yield url
202
 
        url = bzr_branch.get_parent()
203
 
        if url is not None:
204
 
            yield url
205
 
        yield bzr_branch.base
206
 
 
207
 
    @staticmethod
208
 
    def tweak_url(url, launchpad):
209
 
        """Adjust a URL to work with staging, if needed."""
210
 
        if str(launchpad._root_uri) == STAGING_SERVICE_ROOT:
211
 
            return url.replace('bazaar.launchpad.net',
212
 
                               'bazaar.staging.launchpad.net')
213
 
        elif str(launchpad._root_uri) == LAUNCHPAD_API_URLS['qastaging']:
214
 
            return url.replace('bazaar.launchpad.net',
215
 
                               'bazaar.qastaging.launchpad.net')
216
 
        return url
217
 
 
218
 
    @classmethod
219
 
    def from_bzr(cls, launchpad, bzr_branch, create_missing=True):
220
 
        """Find a Launchpad branch from a bzr branch."""
221
 
        check_update = True
222
 
        for url in cls.candidate_urls(bzr_branch):
223
 
            url = cls.tweak_url(url, launchpad)
224
 
            if not cls.plausible_launchpad_url(url):
225
 
                continue
226
 
            lp_branch = launchpad.branches.getByUrl(url=url)
227
 
            if lp_branch is not None:
228
 
                break
229
 
        else:
230
 
            if not create_missing:
231
 
                raise NoLaunchpadBranch(bzr_branch)
232
 
            lp_branch = cls.create_now(launchpad, bzr_branch)
233
 
            check_update = False
234
 
        return cls(lp_branch, bzr_branch.base, bzr_branch, check_update)
235
 
 
236
 
    @classmethod
237
 
    def create_now(cls, launchpad, bzr_branch):
238
 
        """Create a Bazaar branch on Launchpad for the supplied branch."""
239
 
        url = cls.tweak_url(bzr_branch.get_push_location(), launchpad)
240
 
        if not cls.plausible_launchpad_url(url):
241
 
            raise errors.BzrError(gettext('%s is not registered on Launchpad') %
242
 
                                  bzr_branch.base)
243
 
        bzr_branch.create_clone_on_transport(transport.get_transport(url))
 
115
def load_branch(launchpad, branch):
 
116
    """Return the launchpadlib Branch object corresponding to 'branch'.
 
117
 
 
118
    :param launchpad: The root `Launchpad` object from launchpadlib.
 
119
    :param branch: A `bzrlib.branch.Branch`.
 
120
    :raise NotLaunchpadBranch: If we cannot determine the Launchpad URL of
 
121
        `branch`.
 
122
    :return: A launchpadlib Branch object.
 
123
    """
 
124
    # XXX: This duplicates the "What are possible URLs for the branch that
 
125
    # Launchpad might recognize" logic found in cmd_lp_open.
 
126
 
 
127
    # XXX: This makes multiple roundtrips to Launchpad for what is
 
128
    # conceptually a single operation -- get me the branches that match these
 
129
    # URLs. Unfortunately, Launchpad's support for such operations is poor, so
 
130
    # we have to allow multiple roundtrips.
 
131
    for url in branch.get_public_branch(), branch.get_push_location():
244
132
        lp_branch = launchpad.branches.getByUrl(url=url)
245
 
        if lp_branch is None:
246
 
            raise errors.BzrError(gettext('%s is not registered on Launchpad') %
247
 
                                                                            url)
248
 
        return lp_branch
249
 
 
250
 
    def get_target(self):
251
 
        """Return the 'LaunchpadBranch' for the target of this one."""
252
 
        lp_branch = self.lp
253
 
        if lp_branch.project is not None:
254
 
            dev_focus = lp_branch.project.development_focus
255
 
            if dev_focus is None:
256
 
                raise errors.BzrError(gettext('%s has no development focus.') %
257
 
                                  lp_branch.bzr_identity)
258
 
            target = dev_focus.branch
259
 
            if target is None:
260
 
                raise errors.BzrError(gettext(
261
 
                        'development focus %s has no branch.') % dev_focus)
262
 
        elif lp_branch.sourcepackage is not None:
263
 
            target = lp_branch.sourcepackage.getBranch(pocket="Release")
264
 
            if target is None:
265
 
                raise errors.BzrError(gettext(
266
 
                                      'source package %s has no branch.') %
267
 
                                      lp_branch.sourcepackage)
268
 
        else:
269
 
            raise errors.BzrError(gettext(
270
 
                        '%s has no associated product or source package.') %
271
 
                                  lp_branch.bzr_identity)
272
 
        return LaunchpadBranch(target, target.bzr_identity)
273
 
 
274
 
    def update_lp(self):
275
 
        """Update the Launchpad copy of this branch."""
276
 
        if not self._check_update:
277
 
            return
278
 
        self.bzr.lock_read()
279
 
        try:
280
 
            if self.lp.last_scanned_id is not None:
281
 
                if self.bzr.last_revision() == self.lp.last_scanned_id:
282
 
                    trace.note(gettext('%s is already up-to-date.') %
283
 
                               self.lp.bzr_identity)
284
 
                    return
285
 
                graph = self.bzr.repository.get_graph()
286
 
                if not graph.is_ancestor(self.lp.last_scanned_id,
287
 
                                         self.bzr.last_revision()):
288
 
                    raise errors.DivergedBranches(self.bzr, self.push_bzr)
289
 
                trace.note(gettext('Pushing to %s') % self.lp.bzr_identity)
290
 
            self.bzr.push(self.push_bzr)
291
 
        finally:
292
 
            self.bzr.unlock()
293
 
 
294
 
    def find_lca_tree(self, other):
295
 
        """Find the revision tree for the LCA of this branch and other.
296
 
 
297
 
        :param other: Another LaunchpadBranch
298
 
        :return: The RevisionTree of the LCA of this branch and other.
299
 
        """
300
 
        graph = self.bzr.repository.get_graph(other.bzr.repository)
301
 
        lca = graph.find_unique_lca(self.bzr.last_revision(),
302
 
                                    other.bzr.last_revision())
303
 
        return self.bzr.repository.revision_tree(lca)
304
 
 
305
 
 
306
 
def canonical_url(object):
307
 
    """Return the canonical URL for a branch."""
308
 
    scheme, netloc, path, params, query, fragment = urlparse.urlparse(
309
 
        str(object.self_link))
310
 
    path = '/'.join(path.split('/')[2:])
311
 
    netloc = netloc.replace('api.', 'code.')
312
 
    return urlparse.urlunparse((scheme, netloc, path, params, query,
313
 
                                fragment))
 
133
        if lp_branch:
 
134
            return lp_branch
 
135
    raise NotLaunchpadBranch(url)