class.ilLDAPAttributeMapping.php

Go to the documentation of this file.

<?php
/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
    +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2006 ILIAS open source, University of Cologne            |
    |                                                                             |
    | 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 2              |
    | 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, write to the Free Software                 |
    | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
    +-----------------------------------------------------------------------------+
*/
 
class ilLDAPAttributeMapping
{
    private static $instances = array();
    private $server_id = null;
    private $db = null;
    private $mapping_rules = array();
    private $rules_for_update = array();
    private $lng;
 
    private function __construct($a_server_id)
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        $lng = $DIC['lng'];
        
        $this->db = $ilDB;
        $this->lng = $lng;
        $this->server_id = $a_server_id;
        $this->read();
    }
    
    public static function _getInstanceByServerId($a_server_id)
    {
        if (array_key_exists($a_server_id, self::$instances) and is_object(self::$instances[$a_server_id])) {
            return self::$instances[$a_server_id];
        }
        return self::$instances[$a_server_id] = new ilLDAPAttributeMapping($a_server_id);
    }
    
 
    public static function _delete($a_server_id)
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $query = "DELETE FROM ldap_attribute_mapping " .
            "WHERE server_id =" . $ilDB->quote($a_server_id, 'integer');
        $res = $ilDB->manipulate($query);
    }
    
    public static function _lookupGlobalRole($a_server_id)
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT value FROM ldap_attribute_mapping " .
            "WHERE server_id =" . $ilDB->quote($a_server_id, 'integer') . " " .
            "AND keyword = " . $ilDB->quote('global_role', 'text');
 
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return (int) $row->value;
        }
        return 0;
    }
    
    public static function hasRulesForUpdate($a_server_id)
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $query = 'SELECT perform_update FROM ldap_attribute_mapping ' .
            'WHERE server_id = ' . $ilDB->quote($a_server_id, 'integer') . ' ' .
            'AND perform_update = 1';
        $res = $ilDB->query($query);
        return $res->numRows() ? true : false;
    }
 
    public function setRule($a_field_name, $a_ldap_attribute, $a_perform_update)
    {
        $this->mapping_rules[$a_field_name]['value'] = $a_ldap_attribute;
        $this->mapping_rules[$a_field_name]['performUpdate'] = $a_perform_update;
    }
    
    public function getRulesForUpdate()
    {
        return $this->rules_for_update ? $this->rules_for_update : array();
    }
    
    public function getFieldsForUpdate()
    {
        foreach ($this->rules_for_update as $field => $rule) {
            if (!strlen($rule['value'])) {
                continue;
            }
            if (strpos($rule['value'], ',') === false) {
                $fields[] = strtolower($rule['value']);
                continue;
            }
            $tmp_fields = explode(',', $rule['value']);
            $value = '';
            foreach ($tmp_fields as $tmp_field) {
                $fields[] = trim(strtolower($tmp_field));
            }
        }
        return $fields ? $fields : array();
    }
    
    public function getFields()
    {
        foreach ($this->mapping_rules as $field => $rule) {
            if (!strlen($rule['value'])) {
                continue;
            }
            if (strpos($rule['value'], ',') === false) {
                $fields[] = strtolower($rule['value']);
                continue;
            }
            $tmp_fields = explode(',', $rule['value']);
            $value = '';
            foreach ($tmp_fields as $tmp_field) {
                $fields[] = trim(strtolower($tmp_field));
            }
        }
        return $fields ? $fields : array();
    }
    
    public function getRules()
    {
        return $this->mapping_rules;
    }
    
    public function clearRules()
    {
        $this->mapping_rules = array();
    }
    
    public function save()
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $this->delete();
        
        foreach ($this->mapping_rules as $keyword => $options) {
            $query = "INSERT INTO ldap_attribute_mapping (server_id,keyword,value,perform_update) " .
                "VALUES( " .
                $this->db->quote($this->server_id, 'integer') . ", " .
                $this->db->quote($keyword, 'text') . ", " .
                $this->db->quote($options['value'], 'text') . ", " .
                $this->db->quote($options['performUpdate'], 'integer') .
                ')';
            $res = $ilDB->manipulate($query);
        }
    }
    
    public function delete()
    {
        self::_delete($this->server_id);
    }
    
    public function enabledUpdate($a_field_name)
    {
        if (array_key_exists($a_field_name, $this->mapping_rules)) {
            return (bool) $this->mapping_rules[$a_field_name]['performUpdate'];
        }
        return false;
    }
    
    public function getValue($a_field_name)
    {
        if (array_key_exists($a_field_name, $this->mapping_rules)) {
            return $this->mapping_rules[$a_field_name]['value'];
        }
        return '';
    }
    
    private function read()
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT * FROM ldap_attribute_mapping " .
            "WHERE server_id =" . $this->db->quote($this->server_id, 'integer') . " ";
 
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->mapping_rules[$row->keyword]['value'] = $row->value;
            $this->mapping_rules[$row->keyword]['performUpdate'] = (bool) $row->perform_update;
            
            if ($row->perform_update) {
                $this->rules_for_update[$row->keyword]['value'] = $row->value;
            }
        }
    }
}