← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/plugins/launchpad/account.py

Latest bzr.dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugins/launchpad/account.py
1
 
# Copyright (C) 2007, 2008 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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
 
 
23
 
from bzrlib import errors, trace
24
 
from bzrlib.config import AuthenticationConfig, 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.\n" \
37
 
        "See <https://launchpad.net/people/+me>"
38
 
 
39
 
 
40
 
class MismatchedUsernames(errors.BzrError):
41
 
 
42
 
    _fmt = ('bazaar.conf and authentication.conf disagree about launchpad'
43
 
            ' account name.  Please re-run launchpad-login.')
44
 
 
45
 
 
46
 
def get_lp_login(_config=None):
47
 
    """Return the user's Launchpad username.
48
 
 
49
 
    :raises: MismatchedUsername if authentication.conf and bazaar.conf
50
 
        disagree about username.
51
 
    """
52
 
    if _config is None:
53
 
        _config = GlobalConfig()
54
 
 
55
 
    username = _config.get_user_option('launchpad_username')
56
 
    if username is not None:
57
 
        auth = AuthenticationConfig()
58
 
        auth_username = _get_auth_user(auth)
59
 
        # Auto-upgrading
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()
65
 
    return username
66
 
 
67
 
 
68
 
def _set_global_option(username, _config=None):
69
 
    if _config is None:
70
 
        _config = GlobalConfig()
71
 
    _config.set_user_option('launchpad_username', username)
72
 
 
73
 
 
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)
78
 
 
79
 
 
80
 
def _get_auth_user(auth=None):
81
 
    if auth is None:
82
 
        auth = AuthenticationConfig()
83
 
    username = auth.get_user('ssh', '.launchpad.net')
84
 
    return username
85
 
 
86
 
def _set_auth_user(username, auth=None):
87
 
    if auth is None:
88
 
        auth = AuthenticationConfig()
89
 
    auth.set_credentials(
90
 
        'Launchpad', '.launchpad.net', username, 'ssh')
91
 
 
92
 
 
93
 
def check_lp_login(username, _transport=None):
94
 
    """Check whether the given Launchpad username is okay.
95
 
 
96
 
    This will check for both existence and whether the user has
97
 
    uploaded SSH keys.
98
 
    """
99
 
    if _transport is None:
100
 
        _transport = get_transport(LAUNCHPAD_BASE)
101
 
 
102
 
    try:
103
 
        data = _transport.get_bytes('~%s/+sshkeys' % username)
104
 
    except errors.NoSuchFile:
105
 
        raise UnknownLaunchpadUsername(user=username)
106
 
 
107
 
    if not data:
108
 
        raise NoRegisteredSSHKeys(user=username)