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.plugins.launchpad.lp_registration import (
37
InvalidLaunchpadInstance,
43
except ImportError, e:
44
raise errors.DependencyNotPresent('launchpadlib', e)
46
from launchpadlib.launchpad import (
51
from launchpadlib.uris import LPNET_SERVICE_ROOT
53
LPNET_SERVICE_ROOT = 'https://api.launchpad.net/beta/'
56
# Declare the minimum version of launchpadlib that we need in order to work.
57
# 1.5.1 is the version of launchpadlib packaged in Ubuntu 9.10, the most
58
# recent Ubuntu release at the time of writing.
59
MINIMUM_LAUNCHPADLIB_VERSION = (1, 5, 1)
62
def get_cache_directory():
63
"""Return the directory to cache launchpadlib objects in."""
64
return osutils.pathjoin(config.config_dir(), 'launchpad')
67
def parse_launchpadlib_version(version_number):
68
"""Parse a version number of the style used by launchpadlib."""
69
return tuple(map(int, version_number.split('.')))
72
def check_launchpadlib_compatibility():
73
"""Raise an error if launchpadlib has the wrong version number."""
74
installed_version = parse_launchpadlib_version(launchpadlib.__version__)
75
if installed_version < MINIMUM_LAUNCHPADLIB_VERSION:
76
raise errors.IncompatibleAPI(
77
'launchpadlib', MINIMUM_LAUNCHPADLIB_VERSION,
78
installed_version, installed_version)
81
LAUNCHPAD_API_URLS = {
82
'production': LPNET_SERVICE_ROOT,
83
'staging': STAGING_SERVICE_ROOT,
84
'dev': 'https://api.launchpad.dev/beta/',
88
def _get_api_url(service):
89
"""Return the root URL of the Launchpad API.
91
e.g. For the 'staging' Launchpad service, this function returns
92
launchpadlib.launchpad.STAGING_SERVICE_ROOT.
94
:param service: A `LaunchpadService` object.
95
:return: A URL as a string.
97
if service._lp_instance is None:
98
lp_instance = service.DEFAULT_INSTANCE
100
lp_instance = service._lp_instance
102
return LAUNCHPAD_API_URLS[lp_instance]
104
raise InvalidLaunchpadInstance(lp_instance)
107
class NoLaunchpadBranch(errors.BzrError):
108
_fmt = 'No launchpad branch could be found for branch "%(url)s".'
110
def __init__(self, branch):
111
errors.BzrError.__init__(self, branch=branch, url=branch.base)
114
def login(service, timeout=None, proxy_info=None):
115
"""Log in to the Launchpad API.
117
:return: The root `Launchpad` object from launchpadlib.
119
cache_directory = get_cache_directory()
120
launchpad = Launchpad.login_with(
121
'bzr', _get_api_url(service), cache_directory, timeout=timeout,
122
proxy_info=proxy_info)
123
# XXX: Work-around a minor security bug in launchpadlib 1.5.1, which would
124
# create this directory with default umask.
125
os.chmod(cache_directory, 0700)
129
class LaunchpadBranch(object):
130
"""Provide bzr and lp API access to a Launchpad branch."""
132
def __init__(self, lp_branch, bzr_url, bzr_branch=None, check_update=True):
135
:param lp_branch: The Launchpad branch.
136
:param bzr_url: The URL of the Bazaar branch.
137
:param bzr_branch: An instance of the Bazaar branch.
139
self.bzr_url = bzr_url
140
self._bzr = bzr_branch
141
self._push_bzr = None
142
self._check_update = check_update
147
"""Return the bzr branch for this branch."""
148
if self._bzr is None:
149
self._bzr = branch.Branch.open(self.bzr_url)
154
"""Return the push branch for this branch."""
155
if self._push_bzr is None:
156
self._push_bzr = branch.Branch.open(self.lp.bzr_identity)
157
return self._push_bzr
160
def plausible_launchpad_url(url):
161
"""Is 'url' something that could conceivably be pushed to LP?
163
:param url: A URL that may refer to a Launchpad branch.
168
if url.startswith('lp:'):
170
regex = re.compile('([a-z]*\+)*(bzr\+ssh|http)'
171
'://bazaar.*.launchpad.net')
172
return bool(regex.match(url))
175
def candidate_urls(bzr_branch):
176
"""Iterate through related URLs that might be Launchpad URLs.
178
:param bzr_branch: A Bazaar branch to find URLs from.
179
:return: a generator of URL strings.
181
url = bzr_branch.get_public_branch()
184
url = bzr_branch.get_push_location()
187
yield bzr_branch.base
190
def tweak_url(url, launchpad):
191
"""Adjust a URL to work with staging, if needed."""
192
if str(launchpad._root_uri) != STAGING_SERVICE_ROOT:
196
return url.replace('bazaar.launchpad.net',
197
'bazaar.staging.launchpad.net')
200
def from_bzr(cls, launchpad, bzr_branch, create_missing=True):
201
"""Find a Launchpad branch from a bzr branch."""
203
for url in cls.candidate_urls(bzr_branch):
204
url = cls.tweak_url(url, launchpad)
205
if not cls.plausible_launchpad_url(url):
207
lp_branch = launchpad.branches.getByUrl(url=url)
208
if lp_branch is not None:
211
if not create_missing:
212
raise NoLaunchpadBranch(bzr_branch)
213
lp_branch = cls.create_now(launchpad, bzr_branch)
215
return cls(lp_branch, bzr_branch.base, bzr_branch, check_update)
218
def create_now(cls, launchpad, bzr_branch):
219
"""Create a Bazaar branch on Launchpad for the supplied branch."""
220
url = cls.tweak_url(bzr_branch.get_push_location(), launchpad)
221
if not cls.plausible_launchpad_url(url):
222
raise errors.BzrError('%s is not registered on Launchpad' %
224
bzr_branch.create_clone_on_transport(transport.get_transport(url))
225
lp_branch = launchpad.branches.getByUrl(url=url)
226
if lp_branch is None:
227
raise errors.BzrError('%s is not registered on Launchpad' % url)
230
def get_dev_focus(self):
231
"""Return the 'LaunchpadBranch' for the dev focus of this one."""
233
if lp_branch.project is None:
234
raise errors.BzrError('%s has no product.' %
235
lp_branch.bzr_identity)
236
dev_focus = lp_branch.project.development_focus.branch
237
if dev_focus is None:
238
raise errors.BzrError('%s has no development focus.' %
239
lp_branch.bzr_identity)
240
return LaunchpadBranch(dev_focus, dev_focus.bzr_identity)
243
"""Update the Launchpad copy of this branch."""
244
if not self._check_update:
248
if self.lp.last_scanned_id is not None:
249
if self.bzr.last_revision() == self.lp.last_scanned_id:
250
trace.note('%s is already up-to-date.' %
251
self.lp.bzr_identity)
253
graph = self.bzr.repository.get_graph()
254
if not graph.is_ancestor(self.lp.last_scanned_id,
255
self.bzr.last_revision()):
256
raise errors.DivergedBranches(self.bzr, self.push_bzr)
257
trace.note('Pushing to %s' % self.lp.bzr_identity)
258
self.bzr.push(self.push_bzr)
262
def find_lca_tree(self, other):
263
"""Find the revision tree for the LCA of this branch and other.
265
:param other: Another LaunchpadBranch
266
:return: The RevisionTree of the LCA of this branch and other.
268
graph = self.bzr.repository.get_graph(other.bzr.repository)
269
lca = graph.find_unique_lca(self.bzr.last_revision(),
270
other.bzr.last_revision())
271
return self.bzr.repository.revision_tree(lca)
274
def load_branch(launchpad, branch):
275
"""Return the launchpadlib Branch object corresponding to 'branch'.
277
:param launchpad: The root `Launchpad` object from launchpadlib.
278
:param branch: A `bzrlib.branch.Branch`.
279
:raise NotLaunchpadBranch: If we cannot determine the Launchpad URL of
281
:return: A launchpadlib Branch object.
283
# XXX: This duplicates the "What are possible URLs for the branch that
284
# Launchpad might recognize" logic found in cmd_lp_open.
286
# XXX: This makes multiple roundtrips to Launchpad for what is
287
# conceptually a single operation -- get me the branches that match these
288
# URLs. Unfortunately, Launchpad's support for such operations is poor, so
289
# we have to allow multiple roundtrips.
290
for url in branch.get_public_branch(), branch.get_push_location():
291
lp_branch = launchpad.branches.getByUrl(url=url)
294
raise NotLaunchpadBranch(url)
297
def canonical_url(object):
298
"""Return the canonical URL for a branch."""
299
scheme, netloc, path, params, query, fragment = urlparse.urlparse(
300
str(object.self_link))
301
path = '/'.join(path.split('/')[2:])
302
netloc = netloc.replace('api.', 'code.')
303
return urlparse.urlunparse((scheme, netloc, path, params, query,
added
removed
bzrlib/plugins/launchpad/lp_api.py
