class.ilAuthContainerLDAP.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. |
        +-----------------------------------------------------------------------------+
*/

include_once 'Auth/Container/LDAP.php';

class ilAuthContainerLDAP extends Auth_Container_LDAP
{
        private static $force_creation = false;
        
        private $optional_check = false;
        
        private $log = null;
        private $server = null;
        private $ldap_attr_to_user = null;
        
        
        public function __construct($a_server_id = null)
        {
                global $ilLog;
                
                include_once 'Services/LDAP/classes/class.ilLDAPServer.php';
                
                if($a_server_id)
                {
                        $this->server = ilLDAPServer::getInstanceByServerId($a_server_id);
                }
                else
                {
                        $this->server = new ilLDAPServer(ilLDAPServer::_getFirstActiveServer());
                }

                $this->log = ilLoggerFactory::getLogger('auth');
                
                parent::__construct($this->server->toPearAuthArray());
        }
        
        public function forceCreation($a_status)
        {
                self::$force_creation = $a_status;
        }

        public function enableOptionalGroupCheck()
        {
                $this->optional_check = true;
                $this->updateUserFilter();
        }
        
        public function enabledOptionalGroupCheck()
        {
                return (bool) $this->optional_check;
        }
        
        public function fetchData($username, $password)
        {
                if(!$this->server->doConnectionCheck())
                {
                        return FALSE;
                }
                
                
                $res = parent::fetchData($username,$password);
                
                if (PEAR::isError($res))
                { 
                        $this->log->notice('Authentication failed with message:' . $res->getMessage());
                        return $res;
                }
                elseif ($res == true)
                {
                        $this->log->debug('Authentication successful');
                        return true;
                } 
                if(!$this->enabledOptionalGroupCheck() and $this->server->isMembershipOptional())
                {
                        $this->enableOptionalGroupCheck();
                        return parent::fetchData($username,$password);
                }
                return false;
        }

        
        public function checkGroup($a_name)
        {
                $this->log->debug('Checking group restrictions...');

                // if there are multiple groups define check all of them for membership
                $groups = $this->server->getGroupNames();
                
                if(!count($groups))
                {
                        $this->log->debug('no group restrictions found');
                        return true;
                }
                elseif($this->server->isMembershipOptional() and !$this->optional_check)
                {
                        $this->log->debug('Group membership is otional');
                        return true;
                }
        
                foreach($groups as $group)
                {
                        $this->options['group'] = $group;
                        
                        if(parent::checkGroup($a_name))
                        {
                                return true;
                        }
                }
                return false;   
        }
        
        private function updateUserFilter()
        {
                $this->options['userfilter'] = $this->server->getGroupUserFilter();
        }

        public function loginObserver($a_username,$a_auth)
        {
                global $ilLog;
                
                $user_data = array_change_key_case($a_auth->getAuthData(),CASE_LOWER);
                
                $a_username = $this->extractUserName($user_data);

                include_once './Services/LDAP/classes/class.ilLDAPUserSynchronisation.php';
                $sync = new ilLDAPUserSynchronisation('ldap_'.$this->server->getServerId(), $this->server->getServerId());
                $sync->setExternalAccount($a_username);
                $sync->setUserData($user_data);
                $sync->forceCreation(self::$force_creation);

                try {
                        $internal_account = $sync->sync();
                }
                catch(UnexpectedValueException $e) {
                        $this->log->info('Login failed with message: ' . $e->getMessage());
                        $a_auth->status = AUTH_WRONG_LOGIN;
                        $a_auth->logout();
                        return false;
                }
                catch(ilLDAPSynchronisationForbiddenException $e) {
                        // No syncronisation allowed => create Error
                        $this->log->info('Login failed with message: ' . $e->getMessage());
                        $a_auth->status = AUTH_LDAP_NO_ILIAS_USER;
                        $a_auth->logout();
                        return false;
                }
                catch(ilLDAPAccountMigrationRequiredException $e) {
                        $this->log->info('Starting account migration');
                        $a_auth->logout();
                        ilUtil::redirect('ilias.php?baseClass=ilStartUpGUI&cmdClass=ilstartupgui&cmd=showAccountMigration');
                }

                $a_auth->setAuth($internal_account);
                return true;
        }
        private function initLDAPAttributeToUser()
        {
                include_once('Services/LDAP/classes/class.ilLDAPAttributeToUser.php');
                $this->ldap_attr_to_user = new ilLDAPAttributeToUser($this->server);
        }
        
        public function failedLoginObserver($a_username,$a_auth)
        {
                return false;
        }
        
        protected function extractUserName($a_user_data)
        {
                $a_username = isset($a_user_data[strtolower($this->server->getUserAttribute())]) ? 
                        $a_user_data[strtolower($this->server->getUserAttribute())] :
                        trim($a_user_data);

                // Support for multiple user attributes
                if(!is_array($a_username))
                {
                        return $a_username;
                }
                foreach($a_username as $name)
                {
                        // User found with authentication method 'ldap'
                        if(ilObjUser::_checkExternalAuthAccount("ldap",$name))
                        {
                                return trim($name);
                        }
                }
                // No existing user found  => return first name
                return $a_username[0];                          
        }

        protected function updateRequired($a_username)
        {
                if(!ilObjUser::_checkExternalAuthAccount("ldap",$a_username))
                {
                        #$GLOBALS['ilLog']->write(__METHOD__.': Required 1');
                        return true;
                }
                // Check attribute mapping on login
                include_once './Services/LDAP/classes/class.ilLDAPAttributeMapping.php';
                if(ilLDAPAttributeMapping::hasRulesForUpdate($this->server->getServerId()))
                {
                        #$GLOBALS['ilLog']->write(__METHOD__.': Required 2');
                        return true;
                }
                include_once './Services/LDAP/classes/class.ilLDAPRoleAssignmentRule.php';
                if(ilLDAPRoleAssignmentRule::hasRulesForUpdate())
                {
                        #$GLOBALS['ilLog']->write(__METHOD__.': Required 3');
                        return true;
                }
                return false;
        }

        public function supportsCaptchaVerification()
        {
                return true;
        }
}
?>