1
# Copyright (C) 2009, 2010 Canonical Ltd
1
# Copyright (C) 2009-2012 Canonical Ltd
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
17
17
"""Tools for dealing with the Launchpad API."""
19
from __future__ import absolute_import
19
21
# Importing this module will be expensive, since it imports launchpadlib and
20
22
# its dependencies. However, our plan is to only load this module when it is
21
23
# needed by a command that uses it.
43
46
raise errors.DependencyNotPresent('launchpadlib', e)
45
48
from launchpadlib.launchpad import (
47
49
STAGING_SERVICE_ROOT,
52
from launchpadlib import uris
52
54
# 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)
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
60
def get_cache_directory():
74
76
installed_version, installed_version)
77
LAUNCHPAD_API_URLS = {
78
'production': 'https://api.launchpad.net/beta/',
79
'edge': EDGE_SERVICE_ROOT,
80
'staging': STAGING_SERVICE_ROOT,
81
'dev': 'https://api.launchpad.dev/beta/',
79
def lookup_service_root(service_root):
81
return uris.lookup_service_root(service_root)
83
if service_root != 'qastaging':
85
staging_root = uris.lookup_service_root('staging')
86
return staging_root.replace('staging', 'qastaging')
85
89
def _get_api_url(service):
86
90
"""Return the root URL of the Launchpad API.
88
e.g. For the 'edge' Launchpad service, this function returns
89
launchpadlib.launchpad.EDGE_SERVICE_ROOT.
92
e.g. For the 'staging' Launchpad service, this function returns
93
launchpadlib.launchpad.STAGING_SERVICE_ROOT.
91
95
:param service: A `LaunchpadService` object.
92
96
:return: A URL as a string.
97
101
lp_instance = service._lp_instance
99
return LAUNCHPAD_API_URLS[lp_instance]
103
return lookup_service_root(lp_instance)
101
105
raise InvalidLaunchpadInstance(lp_instance)
104
def login(service, timeout=None, proxy_info=None):
108
class NoLaunchpadBranch(errors.BzrError):
109
_fmt = 'No launchpad branch could be found for branch "%(url)s".'
111
def __init__(self, branch):
112
errors.BzrError.__init__(self, branch=branch, url=branch.base)
115
def login(service, timeout=None, proxy_info=None,
116
version=Launchpad.DEFAULT_VERSION):
105
117
"""Log in to the Launchpad API.
107
119
:return: The root `Launchpad` object from launchpadlib.
109
121
cache_directory = get_cache_directory()
110
122
launchpad = Launchpad.login_with(
111
123
'bzr', _get_api_url(service), cache_directory, timeout=timeout,
112
proxy_info=proxy_info)
113
# XXX: Work-around a minor security bug in launchpadlib 1.5.1, which would
114
# create this directory with default umask.
115
os.chmod(cache_directory, 0700)
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)
174
186
url = bzr_branch.get_push_location()
175
187
if url is not None:
189
url = bzr_branch.get_parent()
177
192
yield bzr_branch.base
180
195
def tweak_url(url, launchpad):
181
196
"""Adjust a URL to work with staging, if needed."""
182
if str(launchpad._root_uri) != STAGING_SERVICE_ROOT:
186
return url.replace('bazaar.launchpad.net',
187
'bazaar.staging.launchpad.net')
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')
190
def from_bzr(cls, launchpad, bzr_branch):
206
def from_bzr(cls, launchpad, bzr_branch, create_missing=True):
191
207
"""Find a Launchpad branch from a bzr branch."""
192
208
check_update = True
193
209
for url in cls.candidate_urls(bzr_branch):
198
214
if lp_branch is not None:
217
if not create_missing:
218
raise NoLaunchpadBranch(bzr_branch)
201
219
lp_branch = cls.create_now(launchpad, bzr_branch)
202
220
check_update = False
203
221
return cls(lp_branch, bzr_branch.base, bzr_branch, check_update)
207
225
"""Create a Bazaar branch on Launchpad for the supplied branch."""
208
226
url = cls.tweak_url(bzr_branch.get_push_location(), launchpad)
209
227
if not cls.plausible_launchpad_url(url):
210
raise errors.BzrError('%s is not registered on Launchpad' %
228
raise errors.BzrError(gettext('%s is not registered on Launchpad') %
212
230
bzr_branch.create_clone_on_transport(transport.get_transport(url))
213
231
lp_branch = launchpad.branches.getByUrl(url=url)
214
232
if lp_branch is None:
215
raise errors.BzrError('%s is not registered on Launchpad' % url)
233
raise errors.BzrError(gettext('%s is not registered on Launchpad') %
218
def get_dev_focus(self):
219
"""Return the 'LaunchpadBranch' for the dev focus of this one."""
237
def get_target(self):
238
"""Return the 'LaunchpadBranch' for the target of this one."""
220
239
lp_branch = self.lp
221
if lp_branch.project is None:
222
raise errors.BzrError('%s has no product.' %
223
lp_branch.bzr_identity)
224
dev_focus = lp_branch.project.development_focus.branch
225
if dev_focus is None:
226
raise errors.BzrError('%s has no development focus.' %
227
lp_branch.bzr_identity)
228
return LaunchpadBranch(dev_focus, dev_focus.bzr_identity)
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
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")
252
raise errors.BzrError(gettext(
253
'source package %s has no branch.') %
254
lp_branch.sourcepackage)
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)
230
261
def update_lp(self):
231
262
"""Update the Launchpad copy of this branch."""
236
267
if self.lp.last_scanned_id is not None:
237
268
if self.bzr.last_revision() == self.lp.last_scanned_id:
238
trace.note('%s is already up-to-date.' %
269
trace.note(gettext('%s is already up-to-date.') %
239
270
self.lp.bzr_identity)
241
272
graph = self.bzr.repository.get_graph()
242
273
if not graph.is_ancestor(self.lp.last_scanned_id,
243
274
self.bzr.last_revision()):
244
275
raise errors.DivergedBranches(self.bzr, self.push_bzr)
245
trace.note('Pushing to %s' % self.lp.bzr_identity)
276
trace.note(gettext('Pushing to %s') % self.lp.bzr_identity)
246
277
self.bzr.push(self.push_bzr)
248
279
self.bzr.unlock()
259
290
return self.bzr.repository.revision_tree(lca)
262
def load_branch(launchpad, branch):
263
"""Return the launchpadlib Branch object corresponding to 'branch'.
265
:param launchpad: The root `Launchpad` object from launchpadlib.
266
:param branch: A `bzrlib.branch.Branch`.
267
:raise NotLaunchpadBranch: If we cannot determine the Launchpad URL of
269
:return: A launchpadlib Branch object.
271
# XXX: This duplicates the "What are possible URLs for the branch that
272
# Launchpad might recognize" logic found in cmd_lp_open.
274
# XXX: This makes multiple roundtrips to Launchpad for what is
275
# conceptually a single operation -- get me the branches that match these
276
# URLs. Unfortunately, Launchpad's support for such operations is poor, so
277
# we have to allow multiple roundtrips.
278
for url in branch.get_public_branch(), branch.get_push_location():
279
lp_branch = launchpad.branches.getByUrl(url=url)
282
raise NotLaunchpadBranch(url)
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,
added
removed
bzrlib/plugins/launchpad/lp_api.py
