# 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, either version 3 of the License, or
# (at your option) any later version.
#
# 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, see <http://www.gnu.org/licenses/>.

"""
Base classes for non-LDAP backend plugins.
"""

import logging

from ipalib import Command
from ipalib import errors
from ipapython.dn import DN
from ipalib.text import _

logger = logging.getLogger(__name__)


class VirtualCommand(Command):
    """
    A command that doesn't use the LDAP backend but wants to use the
    LDAP access control system to make authorization decisions.

    The class variable operation is the commonName attribute of the
    entry to be tested against.

    In advance, you need to create an entry of the form:
        cn=<operation>, api.env.container_virtual, api.env.basedn

    Ex.
        cn=request certificate, cn=virtual operations,cn=etc, dc=example, dc=com
    """
    operation = None

    def check_access(self, operation=None):
        """
        Perform an LDAP query to determine authorization.

        This should be executed before any actual work is done.
        """
        if self.operation is None and operation is None:
            raise errors.ACIError(info=_('operation not defined'))

        if operation is None:
            operation = self.operation

        logger.debug("IPA: virtual verify %s", operation)

        return check_operation_access(self.api, operation)


def check_operation_access(api, operation):
    """
    Check access of bound principal to given operation.

    :return: ``True``
    :raises: ``ACIError`` on access denied or ``NotFound`` for
             unknown virtual operation

    """
    operationdn = DN(
        ('cn', operation), api.env.container_virtual, api.env.basedn)

    try:
        if not api.Backend.ldap2.can_write(operationdn, "objectclass"):
            raise errors.ACIError(
                info=_('not allowed to perform operation: %s') % operation)
    except errors.NotFound:
        raise errors.ACIError(info=_('No such virtual command'))

    return True
