freeipa/ipalib/plugins/hostgroup.py

# 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

"""
Groups of hosts.
"""

from ipalib import api
from ipalib.plugins.basegroup import *

_container_dn = api.env.container_hostgroup
_default_attributes = ['cn', 'description', 'member', 'memberof']
_default_class = 'ipahostgroup'


class hostgroup(basegroup):
    """
    Hostgroup object.
    """
    container = _container_dn

api.register(hostgroup)


class hostgroup_add(basegroup_add):
    """
    Create a new hostgroup.
    """
    base_classes = basegroup_add.base_classes + (_default_class, )

    def execute(self, cn, **kw):
        return super(hostgroup_add, self).execute(cn, **kw)

api.register(hostgroup_add)


class hostgroup_del(basegroup_del):
    """
    Delete an existing hostgroup.
    """
    container = _container_dn

    def execute(self, cn, **kw):
        return super(hostgroup_del, self).execute(cn, **kw)

api.register(hostgroup_del)


class hostgroup_mod(basegroup_mod):
    """
    Edit an existing hostgroup.
    """
    container = _container_dn

    def execute(self, cn, **kw):
        return super(hostgroup_mod, self).execute(cn, **kw)

api.register(hostgroup_mod)


class hostgroup_find(basegroup_find):
    """
    Search the groups.
    """
    container = _container_dn

    def execute(self, term, **kw):
        return super(hostgroup_find, self).execute(term, **kw)

api.register(hostgroup_find)


class hostgroup_show(basegroup_show):
    """
    Examine an existing hostgroup.
    """
    container = _container_dn

    def execute(self, cn, **kw):
        return super(hostgroup_show, self).execute(cn, **kw)

api.register(hostgroup_show)


class hostgroup_add_member(basegroup_add_member):
    """
    Add members to hostgroup.
    """
    container = _container_dn

    takes_options = (
        List('groups?',
            cli_name='groups',
            doc='comma-separated list of user groups to add'
        ),
        List('hosts?',
            cli_name='hosts',
            doc='comma-separated list of hosts to add'
        ),
        List('hostgroups?',
            cli_name='hostgroups',
            doc='comma-separated list of hostgroups to add'
        ),
    )

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

        Returns a tuple containing the number of members added
        and the updated entry.

        :param cn: The group name to add new members to.
        :param kw: groups is a comma-separated list of groups to add
        :parem kw: users is a comma-separated list of users to add
        """
        assert self.container
        ldap = self.api.Backend.ldap2
        (dn, entry_attrs) = ldap.find_entry_by_attr(
            'cn', cn, self.filter_class, [''], self.container
        )
        to_add = []
        add_failed = {}
        completed = 0

        members = kw.get('groups', [])
        (to_add, add_failed) = find_members(
            ldap, add_failed, members, 'cn', 'ipausergroup',
            self.api.env.container_group
        )
        (completed, add_failed) = add_members(
            ldap, completed, to_add, add_failed, dn, 'member'
        )

        members = kw.get('hosts', [])
        (to_add, add_failed) = find_members(
            ldap, add_failed, members, 'cn', 'ipahost',
            self.api.env.container_host
        )
        (completed, add_failed) = add_members(
            ldap, completed, to_add, add_failed, dn, 'member'
        )

        members = kw.get('hostgroups', [])
        (to_add, add_failed) = find_members(
            ldap, add_failed, members, 'cn', 'ipahostgroup',
            self.api.env.container_hostgroup
        )
        (completed, add_failed) = add_members(
            ldap, completed, to_add, add_failed, dn, 'member'
        )

        return (
            completed, add_failed, ldap.get_entry(dn, self.default_attributes)
        )

api.register(hostgroup_add_member)


class hostgroup_remove_member(basegroup_remove_member):
    """
    Remove members from hostgroup.
    """
    container = _container_dn

    takes_options = (
        List('groups?',
            cli_name='groups',
            doc='comma-separated list of user groups to add'
        ),
        List('hosts?',
            cli_name='hosts',
            doc='comma-separated list of hosts to add'
        ),
        List('hostgroups?',
            cli_name='hostgroups',
            doc='comma-separated list of hostgroups to add'
        ),
    )

    def execute(self, cn, **kw):
        """
        Execute the group-remove-member operation.

        Returns a tuple containing the number of members removed
        and the updated entry.

        :param cn: The group name to remove new members from.
        :parem kw: users is a comma-separated list of users to remove
        """
        assert self.container
        ldap = self.api.Backend.ldap2
        (dn, entry_attrs) = ldap.find_entry_by_attr(
            'cn', cn, self.filter_class, [''], self.container
        )
        to_remove = []
        rem_failed = {}
        completed = 0

        members = kw.get('groups', [])
        (to_remove, rem_failed) = find_members(
            ldap, rem_failed, members, 'cn', 'ipausergroup',
            self.api.env.container_group
        )
        (completed, rem_failed) = del_members(
            ldap, completed, to_remove, rem_failed, dn, 'member'
        )

        members = kw.get('hosts', [])
        (to_remove, rem_failed) = find_members(
            ldap, rem_failed, members, 'cn', 'ipahost',
            self.api.env.container_host
        )
        (completed, rem_failed) = del_members(
            ldap, completed, to_remove, rem_failed, dn, 'member'
        )

        members = kw.get('hostgroups', [])
        (to_remove, rem_failed) = find_members(
            ldap, rem_failed, members, 'cn', 'ipahostgroup',
            self.api.env.container_hostgroup
        )
        (completed, rem_failed) = del_members(
            ldap, completed, to_remove, rem_failed, dn, 'member'
        )

        return (
            completed, rem_failed, ldap.get_entry(dn, _default_attributes)
        )

api.register(hostgroup_remove_member)