ilSoapAuthentication Class Reference

Inheritance diagram for ilSoapAuthentication:

Collaboration diagram for ilSoapAuthentication:

Public Member Functions
	__construct ()
	Constructor. More...
	disableSoapCheck ()
	authenticate ()
	validateSession ()
	__checkSOAPEnabled ()
	__checkClientEnabled ()

Data Fields
	$soap_check = true

Protected Member Functions
	__checkAgreement ($a_auth_mode)
	Check if user agreement is accepted. More...

Detailed Description

Definition at line 36 of file class.ilSoapAuthentication.php.

Constructor & Destructor Documentation

__construct()

ilSoapAuthentication::__construct

(

)

Constructor.

Definition at line 44 of file class.ilSoapAuthentication.php.

References $_COOKIE.

    {
        // First unset all cookie inforamtions
        unset($_COOKIE['PHPSESSID']);

        parent::__construct();
        $this->__setMessageCode('Client');
    }

Member Function Documentation

__checkAgreement()

ilSoapAuthentication::__checkAgreement (   $a_auth_mode )

protected

Check if user agreement is accepted.

protected

Parameters

string

auth_mode local,ldap or cas

Definition at line 110 of file class.ilSoapAuthentication.php.

References $GLOBALS, and ilObjUser\_checkExternalAuthAccount().

Referenced by authenticate().

    {
        include_once('./Services/User/classes/class.ilObjUser.php');
        include_once('./Services/Administration/classes/class.ilSetting.php');

        $GLOBALS['ilSetting'] = new ilSetting();

        if (!$login = ilObjUser::_checkExternalAuthAccount($a_auth_mode, $this->getUsername())) {
            return true;
        }

        if (ilObjUser::hasUserToAcceptTermsOfService($login)) {
            $this->__setMessage('User agreement no accepted.');
            return false;
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__checkClientEnabled()

ilSoapAuthentication::__checkClientEnabled

(

)

Definition at line 194 of file class.ilSoapAuthentication.php.

Referenced by validateSession().

    {
        if (is_object($this->ini) and $this->ini->readVariable('client', 'access')) {
            return true;
        }
        return false;
    }

Here is the caller graph for this function:

__checkSOAPEnabled()

ilSoapAuthentication::__checkSOAPEnabled

(

)

Definition at line 174 of file class.ilSoapAuthentication.php.

References $GLOBALS, and $ilDB.

Referenced by authenticate(), and validateSession().

    {
        include_once './Services/Database/classes/MDB2/class.ilDB.php';

        //$db = new ilDB($this->dsn);
        $ilDB = $this->db;
        $ilDB->connect();

        $GLOBALS["ilDB"] = $ilDB;
        include_once './Services/Administration/classes/class.ilSetting.php';
        $set = new ilSetting();
        return ($set->get("soap_user_administration") == 1);

        /*$query = "SELECT * FROM set tings WHERE keyword = 'soap_user_administration' AND value = 1";

        $res = $db->query($query);

        return $res->numRows() ? true : false;*/
    }

Here is the caller graph for this function:

authenticate()

ilSoapAuthentication::authenticate

(

)

Definition at line 58 of file class.ilSoapAuthentication.php.

References __checkAgreement(), and __checkSOAPEnabled().

    {
        if (!$this->getClient()) {
            $this->__setMessage('No client given');
            return false;
        }
        if (!$this->getUsername()) {
            $this->__setMessage('No username given');
            return false;
        }
        // Read ilias ini
        if (!$this->__buildDSN()) {
            $this->__setMessage('Error building dsn/Wrong client Id?');
            return false;
        }
        if (!$this->__setSessionSaveHandler()) {
            return false;
        }
        if (!$this->__checkAgreement('local')) {
            return false;
        }
        if (!$this->__buildAuth()) {
            return false;
        }
        if ($this->soap_check and !$this->__checkSOAPEnabled()) {
            $this->__setMessage('SOAP is not enabled in ILIAS administration for this client');
            $this->__setMessageCode('Server');

            return false;
        }


        $this->auth->start();

        if (!$this->auth->getAuth()) {
            $this->__getAuthStatus();

            return false;
        }

        $this->setSid(session_id());

        return true;
    }

Here is the call graph for this function:

disableSoapCheck()

ilSoapAuthentication::disableSoapCheck

(

)

Definition at line 53 of file class.ilSoapAuthentication.php.

    {
        $this->soap_check = false;
    }

validateSession()

ilSoapAuthentication::validateSession

(

)

Definition at line 131 of file class.ilSoapAuthentication.php.

References __checkClientEnabled(), and __checkSOAPEnabled().

    {
        if (!$this->getClient()) {
            $this->__setMessage('No client given');
            return false;
        }
        if (!$this->getSid()) {
            $this->__setMessage('No session id given');
            return false;
        }

        if (!$this->__buildDSN()) {
            $this->__setMessage('Error building dsn');
            return false;
        }
        if (!$this->__checkClientEnabled()) {
            $this->__setMessage('Client disabled.');
            return false;
        }
        
        if (!$this->__setSessionSaveHandler()) {
            return false;
        }
        if (!$this->__buildAuth()) {
            return false;
        }
        if ($this->soap_check and !$this->__checkSOAPEnabled()) {
            $this->__setMessage('SOAP is not enabled in ILIAS administration for this client');
            $this->__setMessageCode('Server');

            return false;
        }
        $this->auth->start();
        if (!$this->auth->getAuth()) {
            $this->__setMessage('Session not valid');

            return false;
        }

        return true;
    }

Here is the call graph for this function:

Field Documentation

$soap_check

ilSoapAuthentication::$soap_check = true

Definition at line 38 of file class.ilSoapAuthentication.php.

---

The documentation for this class was generated from the following file:

• webservice/soap/classes/class.ilSoapAuthentication.php