summaryrefslogtreecommitdiffstats
path: root/ipalib/plugins/defaultoptions.py
blob: ea2af515d9ca7c0303cc203fffe12040ece09ecb (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
# Authors:
#   Rob Crittenden <rcritten@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

"""
Frontend plugin for default options in IPA.
"""

from ipalib import api
from ipalib import Command # Plugin base classes
from ipalib import Str, Int  # Parameter types


class defaultoptions_mod(Command):
    """
    Options command.
    """
    takes_options = (
        Int('ipamaxusernamelength?',
            cli_name='maxusername',
            doc='Max. Username length',
            minvalue=1
        ),
        Str('ipahomesrootdir?',
            cli_name='homedirectory',
            doc='Default location of home directories'
        ),
        Str('ipadefaultloginshell?',
            cli_name='defaultshell',
            doc='Default shell for new users'
        ),
        Str('ipadefaultprimarygroup?',
            cli_name='defaultgroup',
            doc='Default group for new users'
        ),
        Str('ipadefaultemaildomain?',
            cli_name='emaildomain',
            doc='Default e-mail domain new users'
        ),
        Int('ipasearchtimelimit?',
            cli_name='searchtimelimit',
            doc='Max. amount of time (sec.) for a search (-1 is unlimited)',
            minvalue=-1,
        ),
        Int('ipasearchrecordslimit?',
            cli_name='searchrecordslimit',
            doc='Max. number of records to search (-1 is unlimited)',
            minvalue=-1,
        ),
        Str('ipausersearchfields?',
            cli_name='usersearch',
            doc='A comma-separated list of fields to search when searching for users'
        ),
        Str('ipagroupsearchfields?',
            cli_name='groupsearch',
            doc='A comma-separated list of fields to search when searching for groups'
        ),
    )
    def execute(self, *args, **kw):
        """
        Execute the defaultoptions-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 kw
        ldap = self.api.Backend.ldap
        config = ldap.get_ipa_config()
        dn = config.get('dn')

        # The LDAP routines want strings, not ints, so convert a few
        # things. Otherwise it sees a string -> int conversion as a change.
        for k in kw.iterkeys():
            if k.startswith("ipa", 0, 3) and type(kw[k]) is int:
                kw[k] = str(kw[k])

        return ldap.update(dn, **kw)

    def output_for_cli(self, textui, result, *args, **options):
        textui.print_plain("Default options modified")

api.register(defaultoptions_mod)

class defaultoptions_show(Command):
    'Retrieve current default options'
    def execute(self, *args, **kw):
        """
        Execute the defaultoptions-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.ldap
        return ldap.get_ipa_config()

    def output_for_cli(self, textui, result, *args, **options):
        textui.print_plain("Search Configuration")
        textui.print_plain("  Search Time Limit (sec.): %s" % result.get('ipasearchtimelimit'))
        textui.print_plain("  Search Records Limit: %s" % result.get('ipasearchrecordslimit'))
        textui.print_plain("  User Search Fields: %s" % result.get('ipausersearchfields'))
        textui.print_plain("  Group Search Fields: %s" % result.get('ipagroupsearchfields'))

        textui.print_plain("")

        textui.print_plain("User Settings")
        textui.print_plain("  Max. Username Length: %s" % result.get('ipamaxusernamelength'))
        textui.print_plain("  Root for Home Directories: %s" % result.get('ipahomesrootdir'))
        textui.print_plain("  Default Shell: %s" % result.get('ipadefaultloginshell'))
        textui.print_plain("  Default User Group: %s" % result.get('ipadefaultprimarygroup'))
        textui.print_plain("Default E-mail Domain: %s" % result.get('ipadefaultemaildomain'))

api.register(defaultoptions_show)