1
# Copyright (C) 2007, 2008 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
"""Functions to manage the user's Launchpad user ID.
19
This allows the user to configure their Launchpad user ID once, rather
20
than once for each place that needs to take it into account.
23
from bzrlib import errors, trace
24
from bzrlib.config import AuthenticationConfig, GlobalConfig
25
from bzrlib.transport import get_transport
28
LAUNCHPAD_BASE = 'https://launchpad.net/'
31
class UnknownLaunchpadUsername(errors.BzrError):
32
_fmt = "The user name %(user)s is not registered on Launchpad."
35
class NoRegisteredSSHKeys(errors.BzrError):
36
_fmt = "The user %(user)s has not registered any SSH keys with Launchpad.\n" \
37
"See <https://launchpad.net/people/+me>"
40
class MismatchedUsernames(errors.BzrError):
42
_fmt = ('bazaar.conf and authentication.conf disagree about launchpad'
43
' account name. Please re-run launchpad-login.')
46
def get_lp_login(_config=None):
47
"""Return the user's Launchpad username.
49
:raises: MismatchedUsername if authentication.conf and bazaar.conf
50
disagree about username.
53
_config = GlobalConfig()
55
username = _config.get_user_option('launchpad_username')
56
if username is not None:
57
auth = AuthenticationConfig()
58
auth_username = _get_auth_user(auth)
60
if auth_username is None:
61
trace.note('Setting ssh/sftp usernames for launchpad.net.')
62
_set_auth_user(username, auth)
63
elif auth_username != username:
64
raise MismatchedUsernames()
68
def _set_global_option(username, _config=None):
70
_config = GlobalConfig()
71
_config.set_user_option('launchpad_username', username)
74
def set_lp_login(username, _config=None):
75
"""Set the user's Launchpad username"""
76
_set_global_option(username, _config)
77
_set_auth_user(username)
80
def _get_auth_user(auth=None):
82
auth = AuthenticationConfig()
83
username = auth.get_user('ssh', '.launchpad.net')
86
def _set_auth_user(username, auth=None):
88
auth = AuthenticationConfig()
90
'Launchpad', '.launchpad.net', username, 'ssh')
93
def check_lp_login(username, _transport=None):
94
"""Check whether the given Launchpad username is okay.
96
This will check for both existence and whether the user has
99
if _transport is None:
100
_transport = get_transport(LAUNCHPAD_BASE)
103
data = _transport.get_bytes('~%s/+sshkeys' % username)
104
except errors.NoSuchFile:
105
raise UnknownLaunchpadUsername(user=username)
108
raise NoRegisteredSSHKeys(user=username)