1
# Copyright (C) 2009, 2010 Canonical Ltd
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.
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.
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
17
"""Tools for dealing with the Launchpad API."""
19
# Importing this module will be expensive, since it imports launchpadlib and
20
# its dependencies. However, our plan is to only load this module when it is
21
# needed by a command that uses it.
36
from bzrlib.i18n import gettext
37
from bzrlib.plugins.launchpad.lp_registration import (
38
InvalidLaunchpadInstance,
43
except ImportError, e:
44
raise errors.DependencyNotPresent('launchpadlib', e)
46
from launchpadlib.launchpad import (
52
# Declare the minimum version of launchpadlib that we need in order to work.
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)
58
def get_cache_directory():
59
"""Return the directory to cache launchpadlib objects in."""
60
return osutils.pathjoin(config.config_dir(), 'launchpad')
63
def parse_launchpadlib_version(version_number):
64
"""Parse a version number of the style used by launchpadlib."""
65
return tuple(map(int, version_number.split('.')))
68
def check_launchpadlib_compatibility():
69
"""Raise an error if launchpadlib has the wrong version number."""
70
installed_version = parse_launchpadlib_version(launchpadlib.__version__)
71
if installed_version < MINIMUM_LAUNCHPADLIB_VERSION:
72
raise errors.IncompatibleAPI(
73
'launchpadlib', MINIMUM_LAUNCHPADLIB_VERSION,
74
installed_version, installed_version)
77
# The older versions of launchpadlib only provided service root constants for
78
# edge and staging, whilst newer versions drop edge. Therefore service root
79
# URIs for which we do not always have constants are derived from the staging
80
# one, which does always exist.
82
# It is necessary to derive, rather than use hardcoded URIs because
83
# launchpadlib <= 1.5.4 requires service root URIs that end in a path of
84
# /beta/, whilst launchpadlib >= 1.5.5 requires service root URIs with no path
87
# Once we have a hard dependency on launchpadlib >= 1.5.4 we can replace all of
88
# bzr's local knowledge of individual Launchpad instances with use of the
89
# launchpadlib.uris module.
90
LAUNCHPAD_API_URLS = {
91
'production': STAGING_SERVICE_ROOT.replace('api.staging.launchpad.net',
93
'qastaging': STAGING_SERVICE_ROOT.replace('api.staging.launchpad.net',
94
'api.qastaging.launchpad.net'),
95
'staging': STAGING_SERVICE_ROOT,
96
'dev': STAGING_SERVICE_ROOT.replace('api.staging.launchpad.net',
101
def _get_api_url(service):
102
"""Return the root URL of the Launchpad API.
104
e.g. For the 'staging' Launchpad service, this function returns
105
launchpadlib.launchpad.STAGING_SERVICE_ROOT.
107
:param service: A `LaunchpadService` object.
108
:return: A URL as a string.
110
if service._lp_instance is None:
111
lp_instance = service.DEFAULT_INSTANCE
113
lp_instance = service._lp_instance
115
return LAUNCHPAD_API_URLS[lp_instance]
117
raise InvalidLaunchpadInstance(lp_instance)
120
class NoLaunchpadBranch(errors.BzrError):
121
_fmt = 'No launchpad branch could be found for branch "%(url)s".'
123
def __init__(self, branch):
124
errors.BzrError.__init__(self, branch=branch, url=branch.base)
127
def login(service, timeout=None, proxy_info=None):
128
"""Log in to the Launchpad API.
130
:return: The root `Launchpad` object from launchpadlib.
132
cache_directory = get_cache_directory()
133
launchpad = Launchpad.login_with(
134
'bzr', _get_api_url(service), cache_directory, timeout=timeout,
135
proxy_info=proxy_info)
136
# XXX: Work-around a minor security bug in launchpadlib 1.5.1, which would
137
# create this directory with default umask.
138
os.chmod(cache_directory, 0700)
142
class LaunchpadBranch(object):
143
"""Provide bzr and lp API access to a Launchpad branch."""
145
def __init__(self, lp_branch, bzr_url, bzr_branch=None, check_update=True):
148
:param lp_branch: The Launchpad branch.
149
:param bzr_url: The URL of the Bazaar branch.
150
:param bzr_branch: An instance of the Bazaar branch.
152
self.bzr_url = bzr_url
153
self._bzr = bzr_branch
154
self._push_bzr = None
155
self._check_update = check_update
160
"""Return the bzr branch for this branch."""
161
if self._bzr is None:
162
self._bzr = branch.Branch.open(self.bzr_url)
167
"""Return the push branch for this branch."""
168
if self._push_bzr is None:
169
self._push_bzr = branch.Branch.open(self.lp.bzr_identity)
170
return self._push_bzr
173
def plausible_launchpad_url(url):
174
"""Is 'url' something that could conceivably be pushed to LP?
176
:param url: A URL that may refer to a Launchpad branch.
181
if url.startswith('lp:'):
183
regex = re.compile('([a-z]*\+)*(bzr\+ssh|http)'
184
'://bazaar.*.launchpad.net')
185
return bool(regex.match(url))
188
def candidate_urls(bzr_branch):
189
"""Iterate through related URLs that might be Launchpad URLs.
191
:param bzr_branch: A Bazaar branch to find URLs from.
192
:return: a generator of URL strings.
194
url = bzr_branch.get_public_branch()
197
url = bzr_branch.get_push_location()
200
url = bzr_branch.get_parent()
203
yield bzr_branch.base
206
def tweak_url(url, launchpad):
207
"""Adjust a URL to work with staging, if needed."""
208
if str(launchpad._root_uri) == STAGING_SERVICE_ROOT:
209
return url.replace('bazaar.launchpad.net',
210
'bazaar.staging.launchpad.net')
211
elif str(launchpad._root_uri) == LAUNCHPAD_API_URLS['qastaging']:
212
return url.replace('bazaar.launchpad.net',
213
'bazaar.qastaging.launchpad.net')
217
def from_bzr(cls, launchpad, bzr_branch, create_missing=True):
218
"""Find a Launchpad branch from a bzr branch."""
220
for url in cls.candidate_urls(bzr_branch):
221
url = cls.tweak_url(url, launchpad)
222
if not cls.plausible_launchpad_url(url):
224
lp_branch = launchpad.branches.getByUrl(url=url)
225
if lp_branch is not None:
228
if not create_missing:
229
raise NoLaunchpadBranch(bzr_branch)
230
lp_branch = cls.create_now(launchpad, bzr_branch)
232
return cls(lp_branch, bzr_branch.base, bzr_branch, check_update)
235
def create_now(cls, launchpad, bzr_branch):
236
"""Create a Bazaar branch on Launchpad for the supplied branch."""
237
url = cls.tweak_url(bzr_branch.get_push_location(), launchpad)
238
if not cls.plausible_launchpad_url(url):
239
raise errors.BzrError(gettext('%s is not registered on Launchpad') %
241
bzr_branch.create_clone_on_transport(transport.get_transport(url))
242
lp_branch = launchpad.branches.getByUrl(url=url)
243
if lp_branch is None:
244
raise errors.BzrError(gettext('%s is not registered on Launchpad') %
248
def get_target(self):
249
"""Return the 'LaunchpadBranch' for the target of this one."""
251
if lp_branch.project is not None:
252
dev_focus = lp_branch.project.development_focus
253
if dev_focus is None:
254
raise errors.BzrError(gettext('%s has no development focus.') %
255
lp_branch.bzr_identity)
256
target = dev_focus.branch
258
raise errors.BzrError(gettext(
259
'development focus %s has no branch.') % dev_focus)
260
elif lp_branch.sourcepackage is not None:
261
target = lp_branch.sourcepackage.getBranch(pocket="Release")
263
raise errors.BzrError(gettext(
264
'source package %s has no branch.') %
265
lp_branch.sourcepackage)
267
raise errors.BzrError(gettext(
268
'%s has no associated product or source package.') %
269
lp_branch.bzr_identity)
270
return LaunchpadBranch(target, target.bzr_identity)
273
"""Update the Launchpad copy of this branch."""
274
if not self._check_update:
278
if self.lp.last_scanned_id is not None:
279
if self.bzr.last_revision() == self.lp.last_scanned_id:
280
trace.note(gettext('%s is already up-to-date.') %
281
self.lp.bzr_identity)
283
graph = self.bzr.repository.get_graph()
284
if not graph.is_ancestor(self.lp.last_scanned_id,
285
self.bzr.last_revision()):
286
raise errors.DivergedBranches(self.bzr, self.push_bzr)
287
trace.note(gettext('Pushing to %s') % self.lp.bzr_identity)
288
self.bzr.push(self.push_bzr)
292
def find_lca_tree(self, other):
293
"""Find the revision tree for the LCA of this branch and other.
295
:param other: Another LaunchpadBranch
296
:return: The RevisionTree of the LCA of this branch and other.
298
graph = self.bzr.repository.get_graph(other.bzr.repository)
299
lca = graph.find_unique_lca(self.bzr.last_revision(),
300
other.bzr.last_revision())
301
return self.bzr.repository.revision_tree(lca)
304
def canonical_url(object):
305
"""Return the canonical URL for a branch."""
306
scheme, netloc, path, params, query, fragment = urlparse.urlparse(
307
str(object.self_link))
308
path = '/'.join(path.split('/')[2:])
309
netloc = netloc.replace('api.', 'code.')
310
return urlparse.urlunparse((scheme, netloc, path, params, query,
added
removed
bzrlib/plugins/launchpad/lp_api.py
