class.ilAuthProviderECS.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once './Services/Authentication/classes/Provider/class.ilAuthProvider.php';
include_once './Services/Authentication/interfaces/interface.ilAuthProviderInterface.php';

class ilAuthProviderECS extends ilAuthProvider implements ilAuthProviderInterface 
{
        protected $mid = null;
        protected $abreviation = null;

        protected $currentServer = null;
        protected $servers = null;
        
        
        public function __construct(\ilAuthCredentials $credentials)
        {
                parent::__construct($credentials);

                $this->initECSServices();
        }
        
        public function getAbreviation()
        {
                return $this->abreviation;
        }
        
        public function getMID()
        {
                return $this->mid;              
        }
        
        public function setMID($a_mid)
        {
                $this->mid = $a_mid;
        }

        public function setCurrentServer(ilECSSetting $server = null)
        {
                $this->currentServer = $server;
        }

        public function getCurrentServer()
        {
                return $this->currentServer;
        }

        public function getServerSettings()
        {
                return $this->servers;
        }
        

        public function doAuthentication(\ilAuthStatus $status)
        {
                $this->getLogger()->debug('Starting ECS authentication');
                if(!$this->getServerSettings()->activeServerExists())
                {
                        $this->getLogger()->warning('No active ecs server found. Aborting');
                        $this->handleAuthenticationFail($status, 'err_wrong_login');
                        return false;
                }
                
                // Iterate through all active ecs instances
                include_once './Services/WebServices/ECS/classes/class.ilECSServerSettings.php';
                foreach($this->getServerSettings()->getServers() as $server)
                {
                        $this->setCurrentServer($server);
                        if($this->validateHash())
                        {
                                // handle successful authentication
                                $new_usr_id = $this->handleLogin();
                                $this->getLogger()->info('ECS authentication successful.');
                                $status->setStatus(ilAuthStatus::STATUS_AUTHENTICATED);
                                $status->setAuthenticatedUserId($new_usr_id);
                                return true;
                        }
                }

                $this->getLogger()->warning('Could not validate ecs hash for any active server.');
                $this->handleAuthenticationFail($status, 'err_wrong_login');
                return false;
        }
        
        
        public function handleLogin()
        {
                include_once('./Services/WebServices/ECS/classes/class.ilECSUser.php');
                
                $user = new ilECSUser($_GET);
                
                if(!$usr_id = ilObject::_lookupObjIdByImportId($user->getImportId()))
                {
                        $username = $this->createUser($user);
                }
                else
                {
                        $username = $this->updateUser($user,$usr_id);
                }
                
                // set user imported
                include_once './Services/WebServices/ECS/classes/class.ilECSImport.php';
                $import = new ilECSImport($this->getCurrentServer()->getServerId(), $usr_id);
                $import->save();
                
                // Store remote user data
                include_once './Services/WebServices/ECS/classes/class.ilECSRemoteUser.php';
                $remote = new ilECSRemoteUser();
                $remote->setServerId($this->getCurrentServer()->getServerId());
                $remote->setMid($this->getMID());
                $remote->setRemoteUserId($user->getImportId());
                $remote->setUserId(ilObjUser::_lookupId($username));

                $this->getLogger()->info('Current user is: ' . $username);
                
                if(!$remote->exists())
                {
                        $remote->create();
                }
                return ilObjUser::_lookupId($username);
        }
        
        
        public function validateHash()
        {
                global $ilLog;
                
                // fetch hash
                if(isset($_GET['ecs_hash']) and strlen($_GET['ecs_hash']))
                {
                        $hash = $_GET['ecs_hash'];
                }
                if(isset($_GET['ecs_hash_url']))
                {
                        $hashurl = urldecode($_GET['ecs_hash_url']);
                        $hash = basename(parse_url($hashurl,PHP_URL_PATH));
                        //$hash = urldecode($_GET['ecs_hash_url']);
                }
                
                $this->getLogger()->info('Using ecs hash: ' . $hash);
                // Check if hash is valid ...
                try
                {
                        include_once('./Services/WebServices/ECS/classes/class.ilECSConnector.php');
                        $connector = new ilECSConnector($this->getCurrentServer());
                        $res = $connector->getAuth($hash);
                        $auths = $res->getResult();
                        
                        $this->getLogger()->dump($auths, ilLogLevel::DEBUG);

                        if($auths->pid)
                        {
                                try
                                {
                                        include_once './Services/WebServices/ECS/classes/class.ilECSCommunityReader.php';
                                        $reader = ilECSCommunityReader::getInstanceByServerId($this->getCurrentServer()->getServerId());
                                        $part = $reader->getParticipantByMID($auths->pid);
                                        
                                        if(is_object($part) and is_object($part->getOrganisation()))
                                        {
                                                $this->abreviation = $part->getOrganisation()->getAbbreviation();
                                        }
                                        else
                                        {
                                                $this->abreviation = $auths->abbr;
                                        }
                                }
                                catch(Exception $e)
                                {
                                        $this->getLogger()->warning('Authentication failed with message: ' . $e->getMessage());
                                        return false;
                                }
                        }
                        else
                        {
                                $this->abreviation = $auths->abbr;
                        }
                        
                        $this->getLogger()->debug('Got abbreviation: ' . $this->abreviation);
                }
                catch(ilECSConnectorException $e)
                {
                        $this->getLogger()->warning('Authentication failed with message: ' . $e->getMessage());
                        return false;
                }
                
                // read current mid
                try
                {
                        include_once('./Services/WebServices/ECS/classes/class.ilECSConnector.php');
                        $connector = new ilECSConnector($this->getCurrentServer());
                        $details = $connector->getAuth($hash,TRUE);
                        
                        $this->getLogger()->dump($details, ilLogLevel::DEBUG);
                        $this->getLogger()->debug('Token create for mid: ' . $details->getFirstSender());
                        
                        $this->setMID($details->getFirstSender());
                }
                catch(ilECSConnectorException $e)
                {
                        $this->getLogger()->warning('Receiving mid failed with message: ' . $e->getMessage());
                        return false;
                }
                return true;
        }
        
        
        private function initECSServices()
        {
                include_once './Services/WebServices/ECS/classes/class.ilECSServerSettings.php';
                $this->servers = ilECSServerSettings::getInstance();
        }
        
        protected function createUser(ilECSUser $user)
        {
                global $ilClientIniFile, $ilSetting, $rbacadmin, $ilLog;

                $userObj = new ilObjUser();
                $userObj->setOwner(SYSTEM_USER_ID);

                include_once('./Services/Authentication/classes/class.ilAuthUtils.php');
                $local_user = ilAuthUtils::_generateLogin($this->getAbreviation() . '_' . $user->getLogin());

                $newUser["login"] = $local_user;
                $newUser["firstname"] = $user->getFirstname();
                $newUser["lastname"] = $user->getLastname();
                $newUser['email'] = $user->getEmail();
                $newUser['institution'] = $user->getInstitution();

                // set "plain md5" password (= no valid password)
                $newUser["passwd"] = "";
                $newUser["passwd_type"] = IL_PASSWD_CRYPTED;

                $newUser["auth_mode"] = "ecs";
                $newUser["profile_incomplete"] = 0;

                // system data
                $userObj->assignData($newUser);
                $userObj->setTitle($userObj->getFullname());
                $userObj->setDescription($userObj->getEmail());

                // set user language to system language
                $userObj->setLanguage($ilSetting->get("language"));

                // Time limit
                $userObj->setTimeLimitOwner(7);
                $userObj->setTimeLimitUnlimited(0);
                $userObj->setTimeLimitFrom(time() - 5);
                $userObj->setTimeLimitUntil(time() + $ilClientIniFile->readVariable("session", "expire"));

                #$now = new ilDateTime(time(), IL_CAL_UNIX);
                #$userObj->setAgreeDate($now->get(IL_CAL_DATETIME));

                // Create user in DB
                $userObj->setOwner(6);
                $userObj->create();
                $userObj->setActive(1);
                $userObj->updateOwner();
                $userObj->saveAsNew();
                $userObj->writePrefs();

                if($global_role = $this->getCurrentServer()->getGlobalRole())
                {
                        $rbacadmin->assignUser($this->getCurrentServer()->getGlobalRole(), $userObj->getId(), true);
                }
                ilObject::_writeImportId($userObj->getId(), $user->getImportId());

                $this->getLogger()->info('Created new remote user with usr_id: ' . $user->getImportId());

                // Send Mail
                #$this->sendNotification($userObj);
                $this->resetMailOptions($userObj->getId());
                
                return $userObj->getLogin();
        }
        
        protected function updateUser(ilECSUser $user,$a_local_user_id)
        {
                global $ilClientIniFile,$ilLog,$rbacadmin;
                
                $user_obj = new ilObjUser($a_local_user_id);
                $user_obj->setFirstname($user->getFirstname());
                $user_obj->setLastname($user->getLastname());
                $user_obj->setEmail($user->getEmail());
                $user_obj->setInstitution($user->getInstitution());
                $user_obj->setActive(true);
                
                $until = $user_obj->getTimeLimitUntil();

                if($until < (time() + $ilClientIniFile->readVariable('session','expire')))
                {               
                        $user_obj->setTimeLimitFrom(time() - 60);
                        $user_obj->setTimeLimitUntil(time() + $ilClientIniFile->readVariable("session","expire"));
                }
                $user_obj->update();
                $user_obj->refreshLogin();
                
                if($global_role = $this->getCurrentServer()->getGlobalRole())
                {
                        $rbacadmin->assignUser(
                                $this->getCurrentServer()->getGlobalRole(),
                                $user_obj->getId(),
                                true
                        );
                }
                
                $this->resetMailOptions($a_local_user_id);

                $this->getLogger()->debug('Finished update of remote user with usr_id: ' . $user->getImportId());
                return $user_obj->getLogin();
        }
        
        protected function resetMailOptions($a_usr_id)
        {
                include_once './Services/Mail/classes/class.ilMailOptions.php';
                $options = new ilMailOptions($a_usr_id);
                $options->updateOptions(
                                $options->getSignature(),
                                $options->getLinebreak(),
                                IL_MAIL_LOCAL,
                                $options->getCronjobNotification()
                );
        }
}
?>