1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
# Copyright (C) 2009, 2010 Canonical Ltd
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""Tools for dealing with the Launchpad API."""
# Importing this module will be expensive, since it imports launchpadlib and
# its dependencies. However, our plan is to only load this module when it is
# needed by a command that uses it.
import os
from bzrlib import (
config,
errors,
osutils,
)
from bzrlib.plugins.launchpad.lp_registration import (
InvalidLaunchpadInstance,
NotLaunchpadBranch,
)
try:
import launchpadlib
except ImportError, e:
raise errors.DependencyNotPresent('launchpadlib', e)
from launchpadlib.launchpad import (
STAGING_SERVICE_ROOT,
Launchpad,
)
# Declare the minimum version of launchpadlib that we need in order to work.
# 1.5.1 is the version of launchpadlib packaged in Ubuntu 9.10, the most
# recent Ubuntu release at the time of writing.
MINIMUM_LAUNCHPADLIB_VERSION = (1, 5, 1)
def get_cache_directory():
"""Return the directory to cache launchpadlib objects in."""
return osutils.pathjoin(config.config_dir(), 'launchpad')
def parse_launchpadlib_version(version_number):
"""Parse a version number of the style used by launchpadlib."""
return tuple(map(int, version_number.split('.')))
def check_launchpadlib_compatibility():
"""Raise an error if launchpadlib has the wrong version number."""
installed_version = parse_launchpadlib_version(launchpadlib.__version__)
if installed_version < MINIMUM_LAUNCHPADLIB_VERSION:
raise errors.IncompatibleAPI(
'launchpadlib', MINIMUM_LAUNCHPADLIB_VERSION,
installed_version, installed_version)
LAUNCHPAD_API_URLS = {
'production': 'https://api.launchpad.net/beta/',
'staging': STAGING_SERVICE_ROOT,
'dev': 'https://api.launchpad.dev/beta/',
}
def _get_api_url(service):
"""Return the root URL of the Launchpad API.
e.g. For the 'staging' Launchpad service, this function returns
launchpadlib.launchpad.STAGING_SERVICE_ROOT.
:param service: A `LaunchpadService` object.
:return: A URL as a string.
"""
if service._lp_instance is None:
lp_instance = service.DEFAULT_INSTANCE
else:
lp_instance = service._lp_instance
try:
return LAUNCHPAD_API_URLS[lp_instance]
except KeyError:
raise InvalidLaunchpadInstance(lp_instance)
def login(service, timeout=None, proxy_info=None):
"""Log in to the Launchpad API.
:return: The root `Launchpad` object from launchpadlib.
"""
cache_directory = get_cache_directory()
launchpad = Launchpad.login_with(
'bzr', _get_api_url(service), cache_directory, timeout=timeout,
proxy_info=proxy_info)
# XXX: Work-around a minor security bug in launchpadlib 1.5.1, which would
# create this directory with default umask.
os.chmod(cache_directory, 0700)
return launchpad
def load_branch(launchpad, branch):
"""Return the launchpadlib Branch object corresponding to 'branch'.
:param launchpad: The root `Launchpad` object from launchpadlib.
:param branch: A `bzrlib.branch.Branch`.
:raise NotLaunchpadBranch: If we cannot determine the Launchpad URL of
`branch`.
:return: A launchpadlib Branch object.
"""
# XXX: This duplicates the "What are possible URLs for the branch that
# Launchpad might recognize" logic found in cmd_lp_open.
# XXX: This makes multiple roundtrips to Launchpad for what is
# conceptually a single operation -- get me the branches that match these
# URLs. Unfortunately, Launchpad's support for such operations is poor, so
# we have to allow multiple roundtrips.
for url in branch.get_public_branch(), branch.get_push_location():
lp_branch = launchpad.branches.getByUrl(url=url)
if lp_branch:
return lp_branch
raise NotLaunchpadBranch(url)
|