/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_api.py

  • Committer: John Arbash Meinel
  • Date: 2006-04-25 15:05:42 UTC
  • mfrom: (1185.85.85 bzr-encoding)
  • mto: This revision was merged to the branch mainline in revision 1752.
  • Revision ID: john@arbash-meinel.com-20060425150542-c7b518dca9928691
[merge] the old bzr-encoding changes, reparenting them on bzr.dev

Show diffs side-by-side

added added

removed removed

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