class.ilLDAPRoleAssignmentRule.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilLDAPRoleAssignmentRule
{
    private static $instances = null;
    
    private $logger = null;
    
    private $db = null;
    
    const TYPE_GROUP = 1;
    const TYPE_ATTRIBUTE = 2;
    const TYPE_PLUGIN = 3;
    
    private $server_id = 0;
    private $plugin_active = false;
    private $add_on_update = false;
    private $remove_on_update = false;
    private $plugin_id = 0;
    
    
    private function __construct($a_id = 0)
    {
        $this->db = $GLOBALS['DIC']->database();
        $this->logger = $GLOBALS['DIC']->logger()->auth();

        $this->rule_id = $a_id;
        $this->read();
    }
    
    public static function _getInstanceByRuleId($a_rule_id)
    {
        if (isset(self::$instances[$a_rule_id])) {
            return self::$instances[$a_rule_id];
        }
        return self::$instances[$a_rule_id] = new ilLDAPRoleAssignmentRule($a_rule_id);
    }
    
    public static function hasRulesForUpdate()
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = 'SELECT COUNT(*) num FROM ldap_role_assignments ' .
            'WHERE add_on_update = 1 ' .
            'OR remove_on_update = 1 ';
        $res = $ilDB->query($query);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
        return $row->num > 0;
    }
    
    public function matches($a_user_data)
    {
        switch ($this->getType()) {
            case self::TYPE_PLUGIN:
                include_once './Services/LDAP/classes/class.ilLDAPRoleAssignmentRules.php';
                return ilLDAPRoleAssignmentRules::callPlugin($this->getPluginId(), $a_user_data);
                
            case self::TYPE_ATTRIBUTE:
                
                $attn = strtolower($this->getAttributeName());
                
                if (!isset($a_user_data[$attn])) {
                    return false;
                }

                if (!is_array($a_user_data[$attn])) {
                    $attribute_val = array(0 => $a_user_data[$attn]);
                } else {
                    $attribute_val = $a_user_data[$attn];
                }
                
                foreach ($attribute_val as $value) {
                    if ($this->wildcardCompare(trim($this->getAttributeValue()), trim($value))) {
                        $this->logger->debug(': Found role mapping: ' . ilObject::_lookupTitle($this->getRoleId()));
                        return true;
                    }
                }
                return false;

            case self::TYPE_GROUP:
                return $this->isGroupMember($a_user_data);
                
        }
    }
    
    protected function wildcardCompare($a_str1, $a_str2)
    {
        $pattern = str_replace('*', '.*?', $a_str1);
        $this->logger->debug(': Replace pattern:' . $pattern . ' => ' . $a_str2);
        return (bool) preg_match('/^' . $pattern . '$/i', $a_str2);
    }
    
    private function isGroupMember($a_user_data)
    {
        $server = ilLDAPServer::getInstanceByServerId($this->getServerId());

        if ($this->isMemberAttributeDN()) {
            if ($server->enabledEscapeDN()) {
                $user_cmp = ldap_escape($a_user_data['dn'], "", LDAP_ESCAPE_FILTER);
            } else {
                $user_cmp = $a_user_data['dn'];
            }
        } else {
            $user_cmp = $a_user_data['ilExternalAccount'];
        }
        
        try {
            $query = new ilLDAPQuery($server);
            $query->bind();
            $res = $query->query(
                $this->getDN(),
                sprintf(
                    '(%s=%s)',
                    $this->getMemberAttribute(),
                    $user_cmp
                ),
                IL_LDAP_SCOPE_BASE,
                array('dn')
            );
            return $res->numRows() ? true : false;
        } catch (ilLDAPQueryException $e) {
            $this->logger->warning(': Caught Exception: ' . $e->getMessage());
            return false;
        }
    }
    
    
    
    public static function _getRules($a_server_id)
    {
        $ilDB = $GLOBALS['DIC']->database();
        
        $query = "SELECT rule_id FROM ldap_role_assignments " .
                "WHERE server_id = " . $ilDB->quote($a_server_id, 'integer');
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $rules[] = self::_getInstanceByRuleId($row->rule_id);
        }
        return $rules ? $rules : array();
    }
    
    public function setRoleId($a_role_id)
    {
        $this->role_id = $a_role_id;
    }
    
    public function getRoleId()
    {
        return $this->role_id;
    }
    
    public function getRuleId()
    {
        return $this->rule_id;
    }
    
    public function setServerId($a_id)
    {
        $this->server_id = $a_id;
    }
    
    public function getServerId()
    {
        return $this->server_id;
    }
    
    public function setType($a_type)
    {
        $this->type = $a_type;
    }
    
    public function getType()
    {
        return $this->type;
    }
    
    public function setDN($a_dn)
    {
        $this->dn = $a_dn;
    }
    
    public function getDN()
    {
        return $this->dn;
    }
    
    public function setMemberAttribute($a_attribute)
    {
        $this->member_attribute = $a_attribute;
    }
    
    public function getMemberAttribute()
    {
        return $this->member_attribute;
    }
    
    public function setMemberIsDN($a_status)
    {
        $this->member_is_dn = $a_status;
    }
    
    public function isMemberAttributeDN()
    {
        return (bool) $this->member_is_dn;
    }
    
    public function setAttributeName($a_name)
    {
        $this->attribute_name = $a_name;
    }
    
    public function getAttributeName()
    {
        return $this->attribute_name;
    }
    
    public function setAttributeValue($a_value)
    {
        $this->attribute_value = $a_value;
    }
    
    public function getAttributeValue()
    {
        return $this->attribute_value;
    }
    
    public function enableAddOnUpdate($a_status)
    {
        $this->add_on_update = $a_status;
    }
    
    public function isAddOnUpdateEnabled()
    {
        return (bool) $this->add_on_update;
    }
    
    public function enableRemoveOnUpdate($a_status)
    {
        $this->remove_on_update = $a_status;
    }
    
    public function isRemoveOnUpdateEnabled()
    {
        return (bool) $this->remove_on_update;
    }
    
    public function setPluginId($a_id)
    {
        $this->plugin_id = $a_id;
    }
    
    public function getPluginId()
    {
        return $this->plugin_id;
    }
    
    public function isPluginActive()
    {
        return (bool) $this->getType() == self::TYPE_PLUGIN;
    }
    
    
    public function conditionToString()
    {
        $lng = $GLOBALS['DIC']->language();
        
        switch ($this->getType()) {
            case self::TYPE_PLUGIN:
                return $lng->txt('ldap_plugin_id') . ': ' . $this->getPluginId();
            
            case self::TYPE_GROUP:
                $dn_arr = explode(',', $this->getDN());
                return $dn_arr[0];
                
            
            case self::TYPE_ATTRIBUTE:
                return $this->getAttributeName() . '=' . $this->getAttributeValue();
        }
    }
    
    
    public function create()
    {
        $ilDB = $this->db;
        $next_id = $ilDB->nextId('ldap_role_assignments');

        $query = "INSERT INTO ldap_role_assignments (server_id,rule_id,type,dn,attribute,isdn,att_name,att_value,role_id, " .
            "add_on_update, remove_on_update, plugin_id ) " .
            "VALUES( " .
            $this->db->quote($this->getServerId(), 'integer') . ", " .
            $this->db->quote($next_id, 'integer') . ", " .
            $this->db->quote($this->getType(), 'integer') . ", " .
            $this->db->quote($this->getDN(), 'text') . ", " .
            $this->db->quote($this->getMemberAttribute(), 'text') . ", " .
            $this->db->quote($this->isMemberAttributeDN(), 'integer') . ", " .
            $this->db->quote($this->getAttributeName(), 'text') . ", " .
            $this->db->quote($this->getAttributeValue(), 'text') . ", " .
            $this->db->quote($this->getRoleId(), 'integer') . ", " .
            $this->db->quote($this->isAddOnUpdateEnabled(), 'integer') . ', ' .
            $this->db->quote($this->isRemoveOnUpdateEnabled(), 'integer') . ', ' .
            $this->db->quote($this->getPluginId(), 'integer') . ' ' .
            ")";
        $res = $ilDB->manipulate($query);
        $this->rule_id = $next_id;
                
        return true;
    }

    public function update()
    {
        $ilDB = $this->db;
        
        $query = "UPDATE ldap_role_assignments " .
            "SET server_id = " . $this->db->quote($this->getServerId(), 'integer') . ", " .
            "type = " . $this->db->quote($this->getType(), 'integer') . ", " .
            "dn = " . $this->db->quote($this->getDN(), 'text') . ", " .
            "attribute = " . $this->db->quote($this->getMemberAttribute(), 'text') . ", " .
            "isdn = " . $this->db->quote($this->isMemberAttributeDN(), 'integer') . ", " .
            "att_name = " . $this->db->quote($this->getAttributeName(), 'text') . ", " .
            "att_value = " . $this->db->quote($this->getAttributeValue(), 'text') . ", " .
            "role_id = " . $this->db->quote($this->getRoleId(), 'integer') . ", " .
            "add_on_update = " . $this->db->quote($this->isAddOnUpdateEnabled(), 'integer') . ', ' .
            'remove_on_update = ' . $this->db->quote($this->isRemoveOnUpdateEnabled(), 'integer') . ', ' .
            'plugin_id = ' . $this->db->quote($this->getPluginId(), 'integer') . ' ' .
            "WHERE rule_id = " . $this->db->quote($this->getRuleId(), 'integer') . " ";
        $res = $ilDB->manipulate($query);
        return true;
    }
    
    public function validate()
    {
        global $DIC;

        $ilErr = $DIC['ilErr'];
        
        $ilErr->setMessage('');
        
        if (!$this->getRoleId()) {
            $ilErr->setMessage('fill_out_all_required_fields');
            return false;
        }
        switch ($this->getType()) {
            case self::TYPE_GROUP:
                if (!strlen($this->getDN()) or !strlen($this->getMemberAttribute())) {
                    $ilErr->setMessage('fill_out_all_required_fields');
                    return false;
                }
                break;
            case self::TYPE_ATTRIBUTE:
                if (!strlen($this->getAttributeName()) or !strlen($this->getAttributeValue())) {
                    $ilErr->setMessage('fill_out_all_required_fields');
                    return false;
                }
                break;
                
            case self::TYPE_PLUGIN:
                if (!$this->getPluginId()) {
                    $ilErr->setMessage('ldap_err_missing_plugin_id');
                    return false;
                }
                break;
                
            default:
                $ilErr->setMessage('ldap_no_type_given');
                return false;
        }
        return true;
    }
        
    public function delete()
    {
        $ilDB = $this->db;
        
        $query = "DELETE FROM ldap_role_assignments " .
            "WHERE rule_id = " . $this->db->quote($this->getRuleId(), 'integer') . " ";
        $res = $ilDB->manipulate($query);
        return true;
    }
    private function read()
    {
        $ilDB = $this->db;
        
        $query = "SELECT * FROM ldap_role_assignments " .
            "WHERE rule_id = " . $this->db->quote($this->getRuleId(), 'integer') . " ";
        
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->setServerId($row->server_id);
            $this->setType($row->type);
            $this->setDN($row->dn);
            $this->setMemberAttribute($row->attribute);
            $this->setMemberIsDN($row->isdn);
            $this->setAttributeName($row->att_name);
            $this->setAttributeValue($row->att_value);
            $this->setRoleId($row->role_id);
            $this->enableAddOnUpdate($row->add_on_update);
            $this->enableRemoveOnUpdate($row->remove_on_update);
            $this->setPluginId($row->plugin_id);
        }
    }
}