~bzr-pqm/bzr/bzr.dev

2898.3.5 by James Henstridge
Add copyright headers to new files
1
# Copyright (C) 2007 Canonical Ltd
2
#
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.
7
#
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.
12
#
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
17
"""Functions to manage the user's Launchpad user ID.
18
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.
21
"""
22
2898.3.1 by James Henstridge
API for storing and retrieving the Launchpad user ID that will be used
23
from bzrlib import errors
24
from bzrlib.config import GlobalConfig
25
from bzrlib.transport import get_transport
26
27
28
LAUNCHPAD_BASE = 'https://launchpad.net/'
29
30
31
class UnknownLaunchpadUsername(errors.BzrError):
32
    _fmt = "The user name %(user)s is not registered on Launchpad."
33
34
35
class NoRegisteredSSHKeys(errors.BzrError):
36
    _fmt = "The user %(user)s has not registered any SSH keys with Launchpad."
37
38
2898.3.6 by James Henstridge
Rename function arguments that are only intended for use by the tests.
39
def get_lp_login(_config=None):
2898.3.7 by James Henstridge
* Add tests for account.py exception messages.
40
    """Return the user's Launchpad username"""
2898.3.6 by James Henstridge
Rename function arguments that are only intended for use by the tests.
41
    if _config is None:
42
        _config = GlobalConfig()
43
44
    return _config.get_user_option('launchpad_username')
45
46
47
def set_lp_login(username, _config=None):
2898.3.1 by James Henstridge
API for storing and retrieving the Launchpad user ID that will be used
48
    """Set the user's Launchpad username"""
2898.3.6 by James Henstridge
Rename function arguments that are only intended for use by the tests.
49
    if _config is None:
50
        _config = GlobalConfig()
51
52
    _config.set_user_option('launchpad_username', username)
53
54
55
def check_lp_login(username, _transport=None):
2898.3.1 by James Henstridge
API for storing and retrieving the Launchpad user ID that will be used
56
    """Check whether the given Launchpad username is okay.
57
2934.1.1 by Ian Clatworthy
(James Henstridge) add a command for managing the Launchpad user ID
58
    This will check for both existence and whether the user has
2898.3.1 by James Henstridge
API for storing and retrieving the Launchpad user ID that will be used
59
    uploaded SSH keys.
60
    """
2898.3.6 by James Henstridge
Rename function arguments that are only intended for use by the tests.
61
    if _transport is None:
62
        _transport = get_transport(LAUNCHPAD_BASE)
2898.3.1 by James Henstridge
API for storing and retrieving the Launchpad user ID that will be used
63
64
    try:
2898.3.6 by James Henstridge
Rename function arguments that are only intended for use by the tests.
65
        data = _transport.get_bytes('~%s/+sshkeys' % username)
2898.3.1 by James Henstridge
API for storing and retrieving the Launchpad user ID that will be used
66
    except errors.NoSuchFile:
67
        raise UnknownLaunchpadUsername(user=username)
68
69
    if not data:
70
        raise NoRegisteredSSHKeys(user=username)