← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-10-31 03:15:38 UTC
  • mfrom: (3806.1.1 contrib)
  • Revision ID: pqm@pqm.ubuntu.com-20081031031538-0ih0zi2owevf6fwu
Add contrib/bzr_ssh_path_limiter. (Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/plugins/launchpad/account.py
 
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
 
 
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."
 
37
 
 
38
 
 
39
class MismatchedUsernames(errors.BzrError):
 
40
 
 
41
    _fmt = ('bazaar.conf and authentication.conf disagree about launchpad'
 
42
            ' account name.  Please re-run launchpad-login.')
 
43
 
 
44
 
 
45
def get_lp_login(_config=None):
 
46
    """Return the user's Launchpad username.
 
47
 
 
48
    :raises: MismatchedUsername if authentication.conf and bazaar.conf
 
49
        disagree about username.
 
50
    """
 
51
    if _config is None:
 
52
        _config = GlobalConfig()
 
53
 
 
54
    username = _config.get_user_option('launchpad_username')
 
55
    if username is not None:
 
56
        auth = AuthenticationConfig()
 
57
        auth_username = _get_auth_user(auth)
 
58
        # Auto-upgrading
 
59
        if auth_username is None:
 
60
            trace.note('Setting ssh/sftp usernames for launchpad.net.')
 
61
            _set_auth_user(username, auth)
 
62
        elif auth_username != username:
 
63
            raise MismatchedUsernames()
 
64
    return username
 
65
 
 
66
 
 
67
def _set_global_option(username, _config=None):
 
68
    if _config is None:
 
69
        _config = GlobalConfig()
 
70
    _config.set_user_option('launchpad_username', username)
 
71
 
 
72
 
 
73
def set_lp_login(username, _config=None):
 
74
    """Set the user's Launchpad username"""
 
75
    _set_global_option(username, _config)
 
76
    _set_auth_user(username)
 
77
 
 
78
 
 
79
def _get_auth_user(auth=None):
 
80
    if auth is None:
 
81
        auth = AuthenticationConfig()
 
82
    return auth.get_user('ssh', '.launchpad.net')
 
83
 
 
84
def _set_auth_user(username, auth=None):
 
85
    if auth is None:
 
86
        auth = AuthenticationConfig()
 
87
    auth.set_credentials(
 
88
        'Launchpad', '.launchpad.net', username, 'ssh')
 
89
 
 
90
 
 
91
def check_lp_login(username, _transport=None):
 
92
    """Check whether the given Launchpad username is okay.
 
93
 
 
94
    This will check for both existence and whether the user has
 
95
    uploaded SSH keys.
 
96
    """
 
97
    if _transport is None:
 
98
        _transport = get_transport(LAUNCHPAD_BASE)
 
99
 
 
100
    try:
 
101
        data = _transport.get_bytes('~%s/+sshkeys' % username)
 
102
    except errors.NoSuchFile:
 
103
        raise UnknownLaunchpadUsername(user=username)
 
104
 
 
105
    if not data:
 
106
        raise NoRegisteredSSHKeys(user=username)