summaryrefslogtreecommitdiffstats
path: root/ipalib/plugins/config.py
blob: c97c57597bf5772edf586109b3bd945a70781523 (plain)
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
# Authors:
#   Rob Crittenden <rcritten@redhat.com>
#   Pavel Zuna <pzuna@redhat.com>
#
# Copyright (C) 2008  Red Hat
# see file 'COPYING' for use and warranty information
#
# 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; version 2 only
#
# 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

"""
IPA configuration.
"""

from ipalib import api, errors
from ipalib import Command
from ipalib import Int, Str

_search_options = {
    'ipaSearchTimeLimit': 'Time limit (in seconds)',
    'ipaSearchRecordsLimit': 'Record limit',
    'ipaUserSearchFields': 'User search fields',
    'ipaGroupSearchFields': 'Group search fields',
}

_user_options = {
    'ipaMaxUsernameLength': 'Maximum name length',
    'ipaHomesRootDir': 'Root for home directories',
    'ipaDefaultLoginShell': 'Default shell',
    'ipaDefaultPrimaryGroup': 'Default group',
    'ipaDefaultEmailDomain': 'Default e-mail domain',
}

_options = {
    'Search': _search_options,
    'User': _user_options,
}


class config2_mod(Command):
    """
    Modify IPA configuration options.
    """
    takes_options = (
        Int('ipamaxusernamelength?',
            cli_name='maxusername',
            doc='Max. Username length',
            minvalue=1,
            attribute=True,
        ),
        Str('ipahomesrootdir?',
            cli_name='homedirectory',
            doc='Default location of home directories',
            attribute=True,
        ),
        Str('ipadefaultloginshell?',
            cli_name='defaultshell',
            doc='Default shell for new users',
            attribute=True,
        ),
        Str('ipadefaultprimarygroup?',
            cli_name='defaultgroup',
            doc='Default group for new users',
            attribute=True,
        ),
        Str('ipadefaultemaildomain?',
            cli_name='emaildomain',
            doc='Default e-mail domain new users',
            attribute=True,
        ),
        Int('ipasearchtimelimit?',
            cli_name='searchtimelimit',
            doc='Max. amount of time (sec.) for a search (-1 is unlimited)',
            minvalue=-1,
            attribute=True,
        ),
        Int('ipasearchrecordslimit?',
            cli_name='searchrecordslimit',
            doc='Max. number of records to search (-1 is unlimited)',
            minvalue=-1,
            attribute=True,
        ),
        Str('ipausersearchfields?',
            cli_name='usersearch',
            doc='A comma-separated list of fields to search when searching for users',
            attribute=True,
        ),
        Str('ipagroupsearchfields?',
            cli_name='groupsearch',
            doc='A comma-separated list of fields to search when searching for groups',
            attribute=True,
        ),
    )

    def execute(self, *args, **options):
        """
        Execute the config-mod operation.

        The dn should not be passed as a keyword argument as it is constructed
        by this method.

        Returns the entry

        :param args: This function takes no positional arguments
        :param kw: Keyword arguments for the other LDAP attributes.
        """
        assert 'dn' not in options
        ldap = self.api.Backend.ldap2

        (dn, entry_attrs) = ldap.get_ipa_config()
        entry_attrs = self.args_options_2_entry(*args, **options)

        try:
            ldap.update_entry(dn, entry_attrs)
        except errors.EmptyModlist:
            pass

        return ldap.get_entry(dn, entry_attrs.keys())

    def output_for_cli(self, textui, result, *args, **options):
        (dn, entry_attrs) = result

        for p in self.params:
            textui.print_plain(p)
        textui.print_name(self.name)
        for (name, options) in _options.iteritems():
            textui.print_plain('%s options:' % name)
            for (k, v) in options.iteritems():
                k = k.lower()
                if k in entry_attrs:
                    textui.print_attribute(v, entry_attrs[k])
            textui.print_plain('')
        textui.print_dashed('Modified IPA configuration options.')

api.register(config2_mod)


class config2_show(Command):
    """
    Display IPA configuration options.
    """

    def execute(self, *args, **options):
        """
        Execute the config-show operation.

        The dn should not be passed as a keyword argument as it is constructed
        by this method.

        Returns the entry

        :param args: Not used.
        :param kw: Not used.
        """
        ldap = self.api.Backend.ldap2
        return ldap.get_ipa_config()

    def output_for_cli(self, textui, result, *args, **options):
        (dn, entry_attrs) = result
        count = 0

        textui.print_name(self.name)
        for (name, options) in _options.iteritems():
            textui.print_plain('%s options:' % name)
            for (k, v) in options.iteritems():
                if k in entry_attrs:
                    textui.print_attribute(v, entry_attrs[k])
                    count += 1
            textui.print_plain('')
        textui.print_count(count, '%d option', '%d options')

api.register(config2_show)