summaryrefslogtreecommitdiffstats
path: root/ipalib/plugins/taskgroup.py
blob: ebd7f11eea29ea1af54ec6829931f95c92afe74c (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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
# Authors:
#   Rob Crittenden <rcritten@redhat.com>
#
# Copyright (C) 2009  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 plugins for taskgroups.
"""

from ipalib import api, crud, errors, errors2
from ipalib import Object, Command  # Plugin base classes
from ipalib import Str, Int, Flag  # Parameter types

default_attributes = ['cn','description']
container_taskgroup = "cn=taskgroups"

def make_taskgroup_dn(cn):
    """
    Construct group dn from cn.
    """
    import ldap
    return 'cn=%s,%s,%s' % (
        ldap.dn.escape_dn_chars(cn),
        container_taskgroup,
        api.env.basedn,
    )

class taskgroup(Object):
    """
    taskgroup object.
    """
    takes_params = (
        Str('description',
            doc='A description of this group',
            attribute=True,
        ),
        Str('cn',
            cli_name='name',
            primary_key=True,
            normalizer=lambda value: value.lower(),
            attribute=True,
        ),
    )
api.register(taskgroup)


class taskgroup_add(crud.Add):
    'Add a new group.'

    def execute(self, cn, **kw):
        """
        Execute the taskgroup-add operation.

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

        Returns the entry as it will be created in LDAP.

        No need to explicitly set gidNumber. The dna_plugin will do this
        for us if the value isn't provided by the caller.

        :param cn: The name of the group being added.
        :param kw: Keyword arguments for the other LDAP attributes.
        """
        assert 'cn' not in kw
        assert 'dn' not in kw
        ldap = self.api.Backend.ldap
        entry = self.args_options_2_entry(cn, **kw)
        entry['dn'] = make_taskgroup_dn(cn)

        # some required objectclasses
        entry['objectClass'] = ['top','groupofnames']

        return ldap.create(**entry)

    def output_for_cli(self, textui, result, *args, **options):
        """
        Output result of this command to command line interface.
        """
        textui.print_name(self.name)
        textui.print_entry(result)
        textui.print_dashed('Added group "%s"' % result['cn'])

api.register(taskgroup_add)


class taskgroup_del(crud.Del):
    'Delete an existing group.'
    def execute(self, cn, **kw):
        """
        Delete a group

        :param cn: The name of the group being removed
        :param kw: Unused
        """
        ldap = self.api.Backend.ldap
        dn = ldap.find_entry_dn("cn", cn, "groupofnames", container_taskgroup)
        self.log.info("IPA: taskgroup-del '%s'" % dn)

        return ldap.delete(dn)

    def output_for_cli(self, textui, result, cn):
        """
        Output result of this command to command line interface.
        """
        textui.print_plain("Deleted group %s" % cn)

api.register(taskgroup_del)


class taskgroup_mod(crud.Mod):
    'Edit an existing group.'
    def execute(self, cn, **kw):
        """
        Execute the taskgroup-mod operation.

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

        Returns the entry

        :param cn: The name of the group to update.
        :param kw: Keyword arguments for the other LDAP attributes.
        """
        assert 'cn' not in kw
        assert 'dn' not in kw
        ldap = self.api.Backend.ldap
        dn = ldap.find_entry_dn("cn", cn, "groupofnames", container_taskgroup)

        return ldap.update(dn, **kw)

    def output_for_cli(self, textui, result, cn, **options):
        """
        Output result of this command to command line interface.
        """
        if result:
            textui.print_plain("Group updated")

api.register(taskgroup_mod)


class taskgroup_find(crud.Find):
    'Search the groups.'
    def execute(self, term, **kw):
        ldap = self.api.Backend.ldap

        # Pull the list of searchable attributes out of the configuration.
        config = ldap.get_ipa_config()
        search_fields_conf_str = config.get('ipagroupsearchfields')
        search_fields = search_fields_conf_str.split(",")

        search_kw = {}
        for s in search_fields:
            search_kw[s] = term

        object_type = ldap.get_object_type("cn")
        if object_type and not kw.get('objectclass'):
            search_kw['objectclass'] = object_type
        search_kw['base'] = container_taskgroup
        search_kw['objectclass'] = "groupofnames"
        return ldap.search(**search_kw)

    def output_for_cli(self, textui, result, uid, **options):
        counter = result[0]
        groups = result[1:]
        if counter == 0 or len(groups) == 0:
            textui.print_plain("No entries found")
            return
        if len(groups) == 1:
            textui.print_entry(groups[0])
            return
        textui.print_name(self.name)

        for g in groups:
            textui.print_entry(g)
            textui.print_plain('')
        if counter == -1:
            textui.print_plain("These results are truncated.")
            textui.print_plain("Please refine your search and try again.")
        textui.print_count(groups, '%d groups matched')

api.register(taskgroup_find)


class taskgroup_show(crud.Get):
    'Examine an existing group.'
    takes_options = (
        Flag('all', doc='Retrieve all attributes'),
    )
    def execute(self, cn, **kw):
        """
        Execute the taskgroup-show operation.

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

        Returns the entry

        :param cn: The group name to retrieve.
        :param kw: Not used.
        """
        ldap = self.api.Backend.ldap
        dn = ldap.find_entry_dn("cn", cn, "groupofnames", container_taskgroup)

        # FIXME: should kw contain the list of attributes to display?
        if kw.get('all', False):
            return ldap.retrieve(dn)
        else:
            return ldap.retrieve(dn, default_attributes)

    def output_for_cli(self, textui, result, *args, **options):
        textui.print_entry(result)

api.register(taskgroup_show)