ilSoapUserAdministration Class Reference

Inheritance diagram for ilSoapUserAdministration:

Collaboration diagram for ilSoapUserAdministration:

Public Member Functions
	login ($client, $username, $password)
	Soap login @global type $ilUser. More...
	loginCAS ($client, $PT, $username)
	loginLDAP ($client, $username, $password)
	Not required anymode. More...
	loginStudipUser ($sid, $user_id)
	login as user from Stud.IP More...
	logout ($sid)
	Logout user destroy session. More...
	lookupUser ($sid, $user_name)
	getUser ($sid, $user_id)
	deleteUser ($sid, $user_id)
	__readUserData (\ilObjUser &$usr_obj)
	importUsers ($sid, $folder_id, $usr_xml, $conflict_rule, $send_account_mail)
	define ("IL_FAIL_ON_CONFLICT", 1); define ("IL_UPDATE_ON_CONFLICT", 2); define ("IL_IGNORE_ON_CONFLICT", 3); More...
	getUsersForContainer ($sid, $ref_id, $attachRoles, $active)
	return list of users following dtd users_3_7 More...
	getUserForRole ($sid, $role_id, $attachRoles, $active)
	__getImportProtocolAsXML ($a_array)
	Create XML ResultSet. More...
	__getUserMappingAsXML ($a_array)
	return user mapping as xml More...
	searchUser ($sid, $a_keyfields, $query_operator, $a_keyvalues, $attach_roles, $active)
	return user xml following dtd 3.7 More...
	__buildSearchQuery ($a_keyfields, $queryOperator, $a_keyvalues)
	create search term according to parameters More...
	getUserXML ($sid, $a_user_ids, $attach_roles)
	return user xmls for given user ids (csv separated ids) as xml based on usr dtd. More...
	hasNewMail ($sid)
	getUserIdBySid ($sid)
Public Member Functions inherited from ilSoapAdministration
	__construct ($use_nusoap=true)
	Constructor. More...
	initErrorWriter ()
	Overwrite error handler. More...
	__explodeSid ($sid)
	__setMessage ($a_str)
	__getMessage ()
	__appendMessage ($a_str)
	__setMessageCode ($a_code)
	__getMessageCode ()
	initAuth ($sid)
	Init authentication. More...
	initIlias ()
	__initAuthenticationObject ($a_auth_mode=AUTH_LOCAL)
	__raiseError ($a_message, $a_code)
	getNIC ($sid)
	get client information from current as xml result set More...
	isFault ($object)
	checkObjectAccess ($ref_id, $expected_type, $permission, $returnObject=false)
	check access for ref id: expected type, permission, return object instance if returnobject is true More...
	getInstallationInfoXML ()
	getClientInfoXML ($clientid)

Protected Member Functions
	isPermittedRole ($a_folder, $a_role)
	check if assignment is allowed More...

Additional Inherited Members
Static Public Member Functions inherited from ilSoapAdministration
static	return_bytes ($val)
	calculate bytes from K,M,G modifiers e.g: 8M = 8 * 1024 * 1024 bytes More...
Data Fields inherited from ilSoapAdministration
	$sauth = null
	$error_method = null
Protected Attributes inherited from ilSoapAdministration
	$soap_check = true

Detailed Description

Definition at line 35 of file class.ilSoapUserAdministration.php.

Member Function Documentation

__buildSearchQuery()

ilSoapUserAdministration::__buildSearchQuery	(		$a_keyfields,
			$queryOperator,
			$a_keyvalues
	)

create search term according to parameters

Parameters

	array	of string $a_keyfields
string	$queryOperator
	array	of string $a_keyValues

Definition at line 981 of file class.ilSoapUserAdministration.php.

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        $query = array();
 
        $allowed_fields = array("firstname","lastname","email","login","matriculation","institution","department","title","ext_account");
 
        foreach ($a_keyfields as $keyfield) {
            $keyfield = strtolower($keyfield);
 
            if (!in_array($keyfield, $allowed_fields)) {
                continue;
            }
 
            $field_query = array();
            foreach ($a_keyvalues as $keyvalue) {
                if (strlen($keyvalue) >= 3) {
                    $field_query [] = $ilDB->like($ilDB->quoteIdentifier($keyfield), 'text', '%' . $keyvalue . "%");
                }
            }
            if (count($field_query)) {
                $query [] = join(" " . strtoupper($queryOperator) . " ", $field_query);
            }
        }
 
        return count($query) ? " AND ((" . join(") OR (", $query) . "))" : "AND 0";
    }

References $DIC, $ilDB, and $query.

Referenced by searchUser().

Here is the caller graph for this function:

__getImportProtocolAsXML()

ilSoapUserAdministration::__getImportProtocolAsXML

(

$a_array

)

Create XML ResultSet.

Definition at line 827 of file class.ilSoapUserAdministration.php.

    {
        include_once './webservice/soap/classes/class.ilXMLResultSet.php';
        include_once './webservice/soap/classes/class.ilXMLResultSetWriter.php';
 
        $xmlResultSet = new ilXMLResultSet();
        $xmlResultSet->addColumn("userid");
        $xmlResultSet->addColumn("login");
        $xmlResultSet->addColumn("action");
        $xmlResultSet->addColumn("message");
 
        foreach ($a_array as $username => $messages) {
            foreach ($messages as $message) {
                $xmlRow = new ilXMLResultSetRow();
                $xmlRow->setValue(0, 0);
                $xmlRow->setValue(1, $username);
                $xmlRow->setValue(2, "");
                $xmlRow->setValue(3, $message);
 
                $xmlResultSet->addRow($xmlRow);
            }
        }
 
        $xml_writer = new ilXMLResultSetWriter($xmlResultSet);
 
        if ($xml_writer->start()) {
            return $xml_writer->getXML();
        }
 
        return $this->__raiseError('Error in __getImportProtocolAsXML', 'Server');
    }

References $message, $messages, and ilSoapAdministration\__raiseError().

Referenced by importUsers().

Here is the call graph for this function:

Here is the caller graph for this function:

__getUserMappingAsXML()

ilSoapUserAdministration::__getUserMappingAsXML

(

$a_array

)

return user mapping as xml

Parameters

array

(user_id => login) $a_array

Returns

XML String, following resultset.dtd

Definition at line 865 of file class.ilSoapUserAdministration.php.

    {
        include_once './webservice/soap/classes/class.ilXMLResultSet.php';
        include_once './webservice/soap/classes/class.ilXMLResultSetWriter.php';
 
        $xmlResultSet = new ilXMLResultSet();
        $xmlResultSet->addColumn("userid");
        $xmlResultSet->addColumn("login");
        $xmlResultSet->addColumn("action");
        $xmlResultSet->addColumn("message");
 
        if (count($a_array)) {
            foreach ($a_array as $username => $message) {
                $xmlRow = new ilXMLResultSetRow();
                $xmlRow->setValue(0, $username);
                $xmlRow->setValue(1, $message["login"]);
                $xmlRow->setValue(2, $message["action"]);
                $xmlRow->setValue(3, $message["message"]);
 
                $xmlResultSet->addRow($xmlRow);
            }
        }
 
        $xml_writer = new ilXMLResultSetWriter($xmlResultSet);
 
        if ($xml_writer->start()) {
            return $xml_writer->getXML();
        }
 
        return $this->__raiseError('Error in __getUserMappingAsXML', 'Server');
    }

References $message, and ilSoapAdministration\__raiseError().

Referenced by importUsers().

Here is the call graph for this function:

Here is the caller graph for this function:

__readUserData()

ilSoapUserAdministration::__readUserData

(

\ilObjUser &

$usr_obj

)

Definition at line 322 of file class.ilSoapUserAdministration.php.

    {
        $usr_data['usr_id'] = $usr_obj->getId();
        $usr_data['login'] = $usr_obj->getLogin();
        $usr_data['passwd'] = $usr_obj->getPasswd();
        $usr_data['passwd_type'] = $usr_obj->getPasswdType();
        $usr_data['firstname'] = $usr_obj->getFirstname();
        $usr_data['lastname'] = $usr_obj->getLastname();
        $usr_data['title'] = $usr_obj->getUTitle();
        $usr_data['gender'] = $usr_obj->getGender();
        $usr_data['email'] = $usr_obj->getEmail();
        $usr_data['second_email'] = $usr_obj->getSecondEmail();
        $usr_data['institution'] = $usr_obj->getInstitution();
        $usr_data['street'] = $usr_obj->getStreet();
        $usr_data['city'] = $usr_obj->getCity();
        $usr_data['zipcode'] = $usr_obj->getZipcode();
        $usr_data['country'] = $usr_obj->getCountry();
        $usr_data['phone_office'] = $usr_obj->getPhoneOffice();
        $usr_data['last_login'] = $usr_obj->getLastLogin();
        $usr_data['last_update'] = $usr_obj->getLastUpdate();
        $usr_data['create_date'] = $usr_obj->getCreateDate();
        $usr_data['hobby'] = $usr_obj->getHobby();
        $usr_data['department'] = $usr_obj->getDepartment();
        $usr_data['phone_home'] = $usr_obj->getPhoneHome();
        $usr_data['phone_mobile'] = $usr_obj->getPhoneMobile();
        $usr_data['fax'] = $usr_obj->getFax();
        $usr_data['time_limit_owner'] = $usr_obj->getTimeLimitOwner();
        $usr_data['time_limit_unlimited'] = $usr_obj->getTimeLimitUnlimited();
        $usr_data['time_limit_from'] = $usr_obj->getTimeLimitFrom();
        $usr_data['time_limit_until'] = $usr_obj->getTimeLimitUntil();
        $usr_data['time_limit_message'] = $usr_obj->getTimeLimitMessage();
        $usr_data['referral_comment'] = $usr_obj->getComment();
        $usr_data['matriculation'] = $usr_obj->getMatriculation();
        $usr_data['active'] = $usr_obj->getActive();
        $usr_data['approve_date'] = $usr_obj->getApproveDate();
        $usr_data['user_skin'] = $usr_obj->getPref('skin');
        $usr_data['user_style'] = $usr_obj->getPref('style');
        $usr_data['user_language'] = $usr_obj->getLanguage();
        $usr_data['auth_mode'] = $usr_obj->getAuthMode();
        $usr_data['accepted_agreement'] = !$usr_obj->hasToAcceptTermsOfService();
        $usr_data['import_id'] = $usr_obj->getImportId();
        
        return $usr_data;
    }

References ilObjUser\getActive(), ilObjUser\getApproveDate(), ilObjUser\getAuthMode(), ilObjUser\getCity(), ilObjUser\getComment(), ilObjUser\getCountry(), ilObject\getCreateDate(), ilObjUser\getDepartment(), ilObjUser\getEmail(), ilObjUser\getFax(), ilObjUser\getFirstname(), ilObjUser\getGender(), ilObjUser\getHobby(), ilObject\getId(), ilObject\getImportId(), ilObjUser\getInstitution(), ilObjUser\getLanguage(), ilObjUser\getLastLogin(), ilObjUser\getLastname(), ilObjUser\getLastUpdate(), ilObjUser\getLogin(), ilObjUser\getMatriculation(), ilObjUser\getPasswd(), ilObjUser\getPasswdType(), ilObjUser\getPhoneHome(), ilObjUser\getPhoneMobile(), ilObjUser\getPhoneOffice(), ilObjUser\getPref(), ilObjUser\getSecondEmail(), ilObjUser\getStreet(), ilObjUser\getTimeLimitFrom(), ilObjUser\getTimeLimitMessage(), ilObjUser\getTimeLimitOwner(), ilObjUser\getTimeLimitUnlimited(), ilObjUser\getTimeLimitUntil(), ilObjUser\getUTitle(), ilObjUser\getZipcode(), and ilObjUser\hasToAcceptTermsOfService().

Referenced by getUser().

Here is the call graph for this function:

Here is the caller graph for this function:

deleteUser()

ilSoapUserAdministration::deleteUser	(		$sid,
			$user_id
	)

Deprecated:

Definition at line 282 of file class.ilSoapUserAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
 
        if (!isset($user_id)) {
            return $this->__raiseError('No user_id given. Aborting', 'Client');
        }
 
        global $DIC;
 
        $rbacsystem = $DIC['rbacsystem'];
        $ilUser = $DIC['ilUser'];
        $log = $DIC['log'];
 
        if (!$rbacsystem->checkAccess('delete', USER_FOLDER_ID)) {
            return $this->__raiseError('Check access failed.', 'Server');
        }
 
        if (!$ilUser->getLoginByUserId($user_id)) {
            return $this->__raiseError('User id: ' . $user_id . ' is not a valid identifier. Aborting', 'Client');
        }
        if ($ilUser->getId() == $user_id) {
            return $this->__raiseError('Cannot delete myself. Aborting', 'Client');
        }
        if ($user_id == SYSTEM_USER_ID) {
            return $this->__raiseError('Cannot delete root account. Aborting', 'Client');
        }
        // Delete him
        $log->write('SOAP: deleteUser()');
        $delete_user =&ilObjectFactory::getInstanceByObjId($user_id, false);
        $delete_user->delete();
 
        return true;
    }

References $DIC, $ilUser, $log, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObjectFactory\getInstanceByObjId(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), SYSTEM_USER_ID, and USER_FOLDER_ID.

Here is the call graph for this function:

getUser()

ilSoapUserAdministration::getUser	(		$sid,
			$user_id
	)

Parameters

$sid
$user_id

Returns

mixed|\soap_fault|\SoapFault

Exceptions

ilDatabaseException

Exceptions

ilObjectNotFoundException

Definition at line 245 of file class.ilSoapUserAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
 
        global $DIC;
 
        $access = $DIC->access();
        $ilUser = $DIC->user();
 
        if (
            !$access->checkAccess(
                'read_users',
                '',
                USER_FOLDER_ID
            )
        ) {
            return $this->__raiseError('Check access failed.', 'Server');
        }
 
        if ($ilUser->getLoginByUserId($user_id)) {
            $tmp_user =&ilObjectFactory::getInstanceByObjId($user_id);
            $usr_data = $this->__readUserData($tmp_user);
 
            return $usr_data;
        }
        return $this->__raiseError('User does not exist', 'Client');
    }

References $DIC, $ilUser, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), __readUserData(), ilObjectFactory\getInstanceByObjId(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and USER_FOLDER_ID.

Here is the call graph for this function:

getUserForRole()

ilSoapUserAdministration::getUserForRole	(		$sid,
			$role_id,
			$attachRoles,
			$active
	)

Returns

list of users of a specific role, following dtd users_3_7

Definition at line 747 of file class.ilSoapUserAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
 
        include_once './Services/AccessControl/classes/class.ilObjRole.php';
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        $rbacreview = $DIC['rbacreview'];
        $tree = $DIC->repositoryTree();
        $ilUser = $DIC->user();
        $access = $DIC->access();
 
 
        $global_roles = $rbacreview->getGlobalRoles();
 
 
        if (in_array($role_id, $global_roles)) {
            // global roles
            if ($role_id == SYSTEM_ROLE_ID && !in_array(SYSTEM_ROLE_ID, $rbacreview->assignedRoles($ilUser->getId()))
            ) {
                return $this->__raiseError("Role access not permitted. ($role_id)", "Server");
            }
        } else {
            // local roles
            $rolfs = $rbacreview->getFoldersAssignedToRole($role_id, true);
            $access_granted = true;
            foreach ($rolfs as $rolf) {
                if ($tree->isDeleted($rolf)) {
                    $access_granted = false;
                }
                $type = \ilObject::_lookupType($rolf, true);
                switch ($type) {
                    case 'crs':
                    case 'grp':
                        if (!$access->checkAccess('manage_members', '', $rolf)) {
                            $access_granted = false;
                        }
                        break;
                    default:
                        if (!$access->checkAccess('edit_permission', '', $rolf)) {
                            $access_granted = false;
                        }
                        break;
                }
            }
            // read user data must be granted
            if (!$access->checkAccess('read_users', '', USER_FOLDER_ID)) {
                $access_granted = false;
            }
            if (!$access_granted || !count($rolfs)) {
                return $this->__raiseError('Role access not permitted. ' . '(' . $role_id .')', 'Server');
            }
        }
 
        $data = ilObjUser::_getUsersForRole($role_id, $active);
        include_once './Services/User/classes/class.ilUserXMLWriter.php';
 
        $xmlWriter = new ilUserXMLWriter();
        $xmlWriter->setAttachRoles($attachRoles);
        
        $xmlWriter->setObjects($data);
 
        if ($xmlWriter->start()) {
            return $xmlWriter->getXML();
        }
        return $this->__raiseError('Error in getUsersForRole', 'Server');
    }

References $data, $DIC, $ilDB, $ilUser, $type, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObjUser\_getUsersForRole(), ilObject\_lookupType(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), SYSTEM_ROLE_ID, and USER_FOLDER_ID.

Here is the call graph for this function:

getUserIdBySid()

ilSoapUserAdministration::getUserIdBySid

(

$sid

)

Definition at line 1090 of file class.ilSoapUserAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
 
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $parts = explode('::', $sid);
        $query = "SELECT usr_id FROM usr_session "
               . "INNER JOIN usr_data ON usr_id = user_id WHERE session_id = %s";
        $res = $ilDB->queryF($query, array('text'), array($parts[0]));
        $data = $ilDB->fetchAssoc($res);
 
        if (!(int) $data['usr_id']) {
            $this->__raiseError('User does not exist', 'Client');
        }
        
        return (int) $data['usr_id'];
    }

References $data, $DIC, $ilDB, $query, $res, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

Here is the call graph for this function:

getUsersForContainer()

ilSoapUserAdministration::getUsersForContainer	(		$sid,
			$ref_id,
			$attachRoles,
			$active
	)

return list of users following dtd users_3_7

Definition at line 658 of file class.ilSoapUserAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
 
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        $tree = $DIC['tree'];
        $rbacreview = $DIC['rbacreview'];
        $rbacsystem = $DIC['rbacsystem'];
        $access = $DIC->access();
 
        if ($ref_id == -1) {
            $ref_id = USER_FOLDER_ID;
        }
 
        if (
            $ref_id == USER_FOLDER_ID &&
            !$access->checkAccess('read_users', '', USER_FOLDER_ID)
        ) {
            return $this->__raiseError('Access denied', "Client");
        }
 
 
        $object = $this->checkObjectAccess($ref_id, array("crs","cat","grp","usrf","sess"), "read", true);
        if ($this->isFault($object)) {
            return $object;
        }
            
        $data = array();
        switch ($object->getType()) {
            case "usrf":
                $data = ilObjUser::_getUsersForFolder(USER_FOLDER_ID, $active);
                break;
            case "cat":
                $data =  ilObjUser::_getUsersForFolder($ref_id, $active);
                break;
            case "crs":
            {
                // GET ALL MEMBERS
                $roles = $object->__getLocalRoles();
 
                foreach ($roles as $role_id) {
                    $data = array_merge($rbacreview->assignedUsers($role_id), $data);
                }
 
                break;
            }
            case "grp":
                $member_ids = $object->getGroupMemberIds();
                $data = ilObjUser::_getUsersForGroup($member_ids, $active);
                break;
            case "sess":
                $course_ref_id = $tree->checkForParentType($ref_id, 'crs');
                if (!$course_ref_id) {
                    return $this->__raiseError("No course for session", "Client");
                }
 
                $event_obj_id = ilObject::_lookupObjId($ref_id);
                include_once 'Modules/Session/classes/class.ilEventParticipants.php';
                $event_part = new ilEventParticipants($event_obj_id);
                $member_ids = array_keys($event_part->getParticipants());
                $data = ilObjUser::_getUsersForIds($member_ids, $active);
                break;
        }
 
        if (is_array($data)) {
            include_once './Services/User/classes/class.ilUserXMLWriter.php';
 
            $xmlWriter = new ilUserXMLWriter();
            $xmlWriter->setObjects($data);
            $xmlWriter->setAttachRoles($attachRoles);
            
            if ($xmlWriter->start()) {
                return $xmlWriter->getXML();
            }
        }
        return $this->__raiseError('Error in processing information. This is likely a bug.', 'Server');
    }

References $data, $DIC, $ilDB, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObjUser\_getUsersForFolder(), ilObjUser\_getUsersForGroup(), ilObjUser\_getUsersForIds(), ilObject\_lookupObjId(), ilSoapAdministration\checkObjectAccess(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), ilSoapAdministration\isFault(), and USER_FOLDER_ID.

Here is the call graph for this function:

getUserXML()

ilSoapUserAdministration::getUserXML	(		$sid,
			$a_user_ids,
			$attach_roles
	)

return user xmls for given user ids (csv separated ids) as xml based on usr dtd.

Parameters

string	sid session id
string	a_userids array of user ids, may be numeric or ilias ids
boolean	attachRoles if true, role assignments will be attached, nothing will be done otherwise

Returns

string xml string based on usr dtd

Definition at line 1019 of file class.ilSoapUserAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
 
        global $DIC;
 
        $rbacsystem = $DIC['rbacsystem'];
        $access = $DIC->access();
        $ilUser = $DIC['ilUser'];
        $ilDB = $DIC['ilDB'];
 
        // check if own account
        $is_self = false;
        if (is_array($a_user_ids) and count($a_user_ids) == 1) {
            if (end($a_user_ids) == $ilUser->getId()) {
                $is_self = true;
            }
        } elseif (is_numeric($a_user_ids)) {
            if ($a_user_ids == $ilUser->getId()) {
                $is_self = true;
            }
        }
 
        if (!$access->checkAccess('read_users', '', USER_FOLDER_ID) && !$is_self) {
            return $this->__raiseError('Check access failed.', 'Server');
        }
 
 
        // begin-patch filemanager
        $data = ilObjUser::_getUserData((array) $a_user_ids);
        // end-patch filemanager
 
        include_once './Services/User/classes/class.ilUserXMLWriter.php';
        $xmlWriter = new ilUserXMLWriter();
        $xmlWriter->setAttachRoles($attach_roles);
        $xmlWriter->setObjects($data);
 
        if ($xmlWriter->start()) {
            return $xmlWriter->getXML();
        }
 
        return $this->__raiseError('User does not exist', 'Client');
    }

References $data, $DIC, $ilDB, $ilUser, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObjUser\_getUserData(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and USER_FOLDER_ID.

Here is the call graph for this function:

hasNewMail()

ilSoapUserAdministration::hasNewMail

(

$sid

)

Definition at line 1070 of file class.ilSoapUserAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
 
        global $DIC;
 
        $ilUser = $DIC['ilUser'];
 
        if (ilMailGlobalServices::getNewMailsData((int) $ilUser->getId())['count'] > 0) {
            return true;
        } else {
            return false;
        }
    }

References $DIC, $ilUser, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilMailGlobalServices\getNewMailsData(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

Here is the call graph for this function:

importUsers()

ilSoapUserAdministration::importUsers	(		$sid,
			$folder_id,
			$usr_xml,
			$conflict_rule,
			$send_account_mail
	)

define ("IL_FAIL_ON_CONFLICT", 1); define ("IL_UPDATE_ON_CONFLICT", 2); define ("IL_IGNORE_ON_CONFLICT", 3);

Definition at line 373 of file class.ilSoapUserAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
 
 
        include_once './Services/User/classes/class.ilUserImportParser.php';
        include_once './Services/AccessControl/classes/class.ilObjRole.php';
        include_once './Services/Object/classes/class.ilObjectFactory.php';
        global $DIC;
 
        $rbacreview = $DIC['rbacreview'];
        $rbacsystem = $DIC['rbacsystem'];
        $access = $DIC->access();
        $tree = $DIC['tree'];
        $lng = $DIC['lng'];
        $ilUser = $DIC['ilUser'];
        $ilLog = $DIC['ilLog'];
 
        // this takes time but is nescessary
        $error = false;
 
 
        // validate to prevent wrong XMLs
        $this->dom = @domxml_open_mem($usr_xml, DOMXML_LOAD_VALIDATING, $error);
        if ($error) {
            $msg = array();
            if (is_array($error)) {
                foreach ($error as $err) {
                    $msg []= "(" . $err["line"] . "," . $err["col"] . "): " . $err["errormessage"];
                }
            } else {
                $msg[] = $error;
            }
            $msg = join("\n", $msg);
            return $this->__raiseError($msg, "Client");
        }
 
 
        switch ($conflict_rule) {
            case 2:
                $conflict_rule = IL_UPDATE_ON_CONFLICT;
                break;
            case 3:
                $conflict_rule = IL_IGNORE_ON_CONFLICT;
                break;
            default:
                $conflict_rule = IL_FAIL_ON_CONFLICT;
        }
        if ($folder_id == 0) {
            if (!$access->checkAccess('create_usr', '', USER_FOLDER_ID)) {
                return $this->__raiseError('Missing permission for creating/modifying users accounts' . USER_FOLDER_ID . ' ' . $ilUser->getId(), 'Server');
            }
        }
 
        // folder id 0, means to check permission on user basis!
        // must have create user right in time_limit_owner property (which is ref_id of container)
        if ($folder_id != 0) {
            // determine where to import
            if ($folder_id == -1) {
                $folder_id = USER_FOLDER_ID;
            }
 
            // get folder
            $import_folder = ilObjectFactory::getInstanceByRefId($folder_id, false);
            // id does not exist
            if (!$import_folder) {
                return $this->__raiseError('Wrong reference id.', 'Server');
            }
 
            // folder is not a folder, can also be a category
            if ($import_folder->getType() != "usrf" && $import_folder->getType() != "cat") {
                return $this->__raiseError('Folder must be a usr folder or a category.', 'Server');
            }
 
            // check access to folder
            if (!$rbacsystem->checkAccess('create_usr', $folder_id)) {
                return $this->__raiseError('Missing permission for creating users within ' . $import_folder->getTitle(), 'Server');
            }
        }
 
        // first verify
        $importParser = new ilUserImportParser("", IL_VERIFY, $conflict_rule);
        $importParser->setUserMappingMode(IL_USER_MAPPING_ID);
        $importParser->setXMLContent($usr_xml);
        $importParser->startParsing();
 
        switch ($importParser->getErrorLevel()) {
            case IL_IMPORT_SUCCESS:
                break;
            case IL_IMPORT_WARNING:
                return $this->__getImportProtocolAsXML($importParser->getProtocol("User Import Log - Warning"));
                break;
            case IL_IMPORT_FAILURE:
                return $this->__getImportProtocolAsXML($importParser->getProtocol("User Import Log - Failure"));
        }
 
        // verify is ok, so get role assignments
 
        $importParser = new ilUserImportParser("", IL_EXTRACT_ROLES, $conflict_rule);
        $importParser->setXMLContent($usr_xml);
        $importParser->setUserMappingMode(IL_USER_MAPPING_ID);
        $importParser->startParsing();
 
        $roles = $importParser->getCollectedRoles();
 
        //print_r($roles);
 
 
 
        // roles to be assigned, skip if one is not allowed!
        $permitted_roles = array();
        foreach ($roles as $role_id => $role) {
            if (!is_numeric($role_id)) {
                // check if internal id
                $internalId = ilUtil::__extractId($role_id, IL_INST_ID);
                
                if (is_numeric($internalId)) {
                    $role_id = $internalId;
                    $role_name = $role_id;
                }
                /*                              else // perhaps it is a rolename
                                {
                                    $role  = ilSoapUserAdministration::__getRoleForRolename ($role_id);
                                    $role_name = $role->title;
                                    $role_id = $role->role_id;
                                }*/
            }
            
            if ($this->isPermittedRole($folder_id, $role_id)) {
                $permitted_roles[$role_id] = $role_id;
            } else {
                $role_name = ilObject::_lookupTitle($role_id);
                return $this->__raiseError("Could not find role " . $role_name . ". Either you use an invalid/deleted role " .
                    "or you try to assign a local role into the non-standard user folder and this role is not in its subtree.", 'Server');
            }
        }
 
        $global_roles = $rbacreview->getGlobalRoles();
 
        //print_r ($global_roles);
 
 
 
        foreach ($permitted_roles as $role_id => $role_name) {
            if ($role_id != "") {
                if (in_array($role_id, $global_roles)) {
                    if ($role_id == SYSTEM_ROLE_ID && !in_array(SYSTEM_ROLE_ID, $rbacreview->assignedRoles($ilUser->getId()))
                        || ($folder_id != USER_FOLDER_ID && $folder_id != 0 && !ilObjRole::_getAssignUsersStatus($role_id))
                        ) {
                        return $this->__raiseError($lng->txt("usrimport_with_specified_role_not_permitted") . " $role_name ($role_id)", 'Server');
                    }
                } else {
                    $rolf = $rbacreview->getFoldersAssignedToRole($role_id, true);
                    if ($rbacreview->isDeleted($rolf[0])
                                || !$rbacsystem->checkAccess('write', $rolf[0])) {
                        return $this->__raiseError($lng->txt("usrimport_with_specified_role_not_permitted") . " $role_name ($role_id)", "Server");
                    }
                }
            }
        }
 
        //print_r ($permitted_roles);
 
        $importParser = new ilUserImportParser("", IL_USER_IMPORT, $conflict_rule);
        $importParser->setSendMail($send_account_mail);
        $importParser->setUserMappingMode(IL_USER_MAPPING_ID);
        $importParser->setFolderId($folder_id);
        $importParser->setXMLContent($usr_xml);
 
        $importParser->setRoleAssignment($permitted_roles);
 
        $importParser->startParsing();
 
        if ($importParser->getErrorLevel() != IL_IMPORT_FAILURE) {
            return $this->__getUserMappingAsXML($importParser->getUserMapping());
        }
        return $this->__getImportProtocolAsXML($importParser->getProtocol());
    }

References $DIC, $ilUser, $lng, ilUtil\__extractId(), __getImportProtocolAsXML(), ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), __getUserMappingAsXML(), ilSoapAdministration\__raiseError(), ilObjRole\_getAssignUsersStatus(), ilObject\_lookupTitle(), domxml_open_mem(), ilObjectFactory\getInstanceByRefId(), IL_EXTRACT_ROLES, IL_FAIL_ON_CONFLICT, IL_IGNORE_ON_CONFLICT, IL_IMPORT_FAILURE, IL_IMPORT_SUCCESS, IL_IMPORT_WARNING, IL_INST_ID, IL_UPDATE_ON_CONFLICT, IL_USER_IMPORT, IL_USER_MAPPING_ID, IL_VERIFY, ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), isPermittedRole(), SYSTEM_ROLE_ID, and USER_FOLDER_ID.

Here is the call graph for this function:

isPermittedRole()

ilSoapUserAdministration::isPermittedRole (   $a_folder,   $a_role  )

protected

check if assignment is allowed

@access protected

Parameters

return

Definition at line 564 of file class.ilSoapUserAdministration.php.

    {
        static $checked_roles = array();
        static $global_roles = null;
        
        
        if (isset($checked_roles[$a_role])) {
            return $checked_roles[$a_role];
        }
        
        global $DIC;
 
        $rbacsystem = $DIC['rbacsystem'];
        $rbacreview = $DIC['rbacreview'];
        $ilUser = $DIC['ilUser'];
        $tree = $DIC['tree'];
        $ilLog = $DIC['ilLog'];
        
        $locations = $rbacreview->getFoldersAssignedToRole($a_role, true);
        $location = $locations[0];
        
        // global role
        if ($location == ROLE_FOLDER_ID) {
            $ilLog->write(__METHOD__ . ': Check global role');
            // check assignment permission if called from local admin
            
            
            if ($a_folder != USER_FOLDER_ID and $a_folder != 0) {
                $ilLog->write(__METHOD__ . ': ' . $a_folder);
                include_once './Services/AccessControl/classes/class.ilObjRole.php';
                if (!ilObjRole::_getAssignUsersStatus($a_role)) {
                    $ilLog->write(__METHOD__ . ': No assignment allowed');
                    $checked_roles[$a_role] = false;
                    return false;
                }
            }
            // exclude anonymous role from list
            if ($a_role == ANONYMOUS_ROLE_ID) {
                $ilLog->write(__METHOD__ . ': Anonymous role chosen.');
                $checked_roles[$a_role] = false;
                return false;
            }
            // do not allow to assign users to administrator role if current user does not has SYSTEM_ROLE_ID
            if ($a_role == SYSTEM_ROLE_ID and !in_array(SYSTEM_ROLE_ID, $rbacreview->assignedRoles($ilUser->getId()))) {
                $ilLog->write(__METHOD__ . ': System role assignment forbidden.');
                $checked_roles[$a_role] = false;
                return false;
            }
            
            // Global role assignment ok
            $ilLog->write(__METHOD__ . ': Assignment allowed.');
            $checked_roles[$a_role] = true;
            return true;
        } elseif ($location) {
            $ilLog->write(__METHOD__ . ': Check local role.');
 
            // It's a local role
            $rolfs = $rbacreview->getFoldersAssignedToRole($a_role, true);
            $rolf = $rolfs[0];
 
 
            // only process role folders that are not set to status "deleted"
            // and for which the user has write permissions.
            // We also don't show the roles which are in the ROLE_FOLDER_ID folder.
            // (The ROLE_FOLDER_ID folder contains the global roles).
            if ($rbacreview->isDeleted($rolf)
                || !$rbacsystem->checkAccess('edit_permission', $rolf)) {
                $ilLog->write(__METHOD__ . ': Role deleted or no permission.');
                $checked_roles[$a_role] = false;
                return false;
            }
            // A local role is only displayed, if it is contained in the subtree of
            // the localy administrated category. If the import function has been
            // invoked from the user folder object, we show all local roles, because
            // the user folder object is considered the parent of all local roles.
            // Thus, if we start from the user folder object, we initializ$isInSubtree = $folder_id == USER_FOLDER_ID || $folder_id == 0;e the
            // isInSubtree variable with true. In all other cases it is initialized
            // with false, and only set to true if we find the object id of the
            // locally administrated category in the tree path to the local role.
            if ($a_folder != USER_FOLDER_ID and $a_folder != 0 and !$tree->isGrandChild($a_folder, $rolf)) {
                $ilLog->write(__METHOD__ . ': Not in path of category.');
                $checked_roles[$a_role] = false;
                return false;
            }
            $ilLog->write(__METHOD__ . ': Assignment allowed.');
            $checked_roles[$a_role] = true;
            return true;
        }
    }

References $DIC, $ilUser, $location, ilObjRole\_getAssignUsersStatus(), ANONYMOUS_ROLE_ID, ROLE_FOLDER_ID, SYSTEM_ROLE_ID, and USER_FOLDER_ID.

Referenced by importUsers().

Here is the call graph for this function:

Here is the caller graph for this function:

login()

ilSoapUserAdministration::login	(		$client,
			$username,
			$password
	)

Soap login @global type $ilUser.

Parameters

type	$client
type	$username
type	$password

Returns

type

Definition at line 46 of file class.ilSoapUserAdministration.php.

    {
        unset($_COOKIE[session_name()]);
        $_COOKIE['ilClientId'] = $client;
 
        try {
            $this->initIlias();
        } catch (Exception $e) {
            return $this->__raiseError($e->getMessage(), 'Server');
        }
        
        // now try authentication
        include_once './Services/Authentication/classes/Frontend/class.ilAuthFrontendCredentials.php';
        $credentials = new ilAuthFrontendCredentials();
        $credentials->setUsername($username);
        $credentials->setPassword($password);
        
        include_once './Services/Authentication/classes/Provider/class.ilAuthProviderFactory.php';
        $provider_factory = new ilAuthProviderFactory();
        $providers = $provider_factory->getProviders($credentials);
            
        include_once './Services/Authentication/classes/class.ilAuthStatus.php';
        $status = ilAuthStatus::getInstance();
            
        include_once './Services/Authentication/classes/Frontend/class.ilAuthFrontendFactory.php';
        $frontend_factory = new ilAuthFrontendFactory();
        $frontend_factory->setContext(ilAuthFrontendFactory::CONTEXT_CLI);
        $frontend = $frontend_factory->getFrontend(
            $GLOBALS['DIC']['ilAuthSession'],
            $status,
            $credentials,
            $providers
        );
            
        $frontend->authenticate();
            
        switch ($status->getStatus()) {
            case ilAuthStatus::STATUS_AUTHENTICATED:
                ilLoggerFactory::getLogger('auth')->debug('Authentication successful.');
                return $GLOBALS['DIC']['ilAuthSession']->getId() . '::' . $client;
                
 
            default:
            case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
                return $this->__raiseError(
                    $status->getReason(),
                    'Server'
                );
        }
        return true;
    }

References $_COOKIE, $client, Vendor\Package\$e, $GLOBALS, $password, ilSoapAdministration\__raiseError(), ilAuthFrontendFactory\CONTEXT_CLI, ilAuthStatus\getInstance(), ilLoggerFactory\getLogger(), ilSoapAdministration\initIlias(), ilAuthStatus\STATUS_AUTHENTICATED, and ilAuthStatus\STATUS_AUTHENTICATION_FAILED.

Referenced by loginLDAP().

Here is the call graph for this function:

Here is the caller graph for this function:

loginCAS()

ilSoapUserAdministration::loginCAS	(		$client,
			$PT,
			$username
	)

Definition at line 99 of file class.ilSoapUserAdministration.php.

    {
        $this->__initAuthenticationObject(AUTH_CAS);
        $this->sauth->setClient($client);
        $this->sauth->setUsername($username);
        $this->sauth->setPT($PT);
        $authenticated = true;
        if (!$this->sauth->authenticate()) {
            $authenticated = false;
        }
        if (!$authenticated) {
            return $this->__raiseError($this->sauth->getMessage(), $this->sauth->getMessageCode());
        }
        return $this->sauth->getSid() . '::' . $client;
    }

References $client, ilSoapAdministration\__initAuthenticationObject(), ilSoapAdministration\__raiseError(), and AUTH_CAS.

Here is the call graph for this function:

loginLDAP()

ilSoapUserAdministration::loginLDAP	(		$client,
			$username,
			$password
	)

Not required anymode.

This method is a simple alias for login()

Parameters

type	$client
type	$username
type	$password

Returns

type

Deprecated:

since version 5.2

Definition at line 124 of file class.ilSoapUserAdministration.php.

    {
        return $this->login($client, $username, $password);
    }

References $client, $password, and login().

Here is the call graph for this function:

loginStudipUser()

ilSoapUserAdministration::loginStudipUser	(		$sid,
			$user_id
	)

login as user from Stud.IP

Deprecated:

Parameters

string	$sid
int	$user_id

Returns

string $sid

Definition at line 136 of file class.ilSoapUserAdministration.php.

    {
        global $DIC;
 
        $rbacreview = $DIC['rbacreview'];
        $ilUser = $DIC['ilUser'];
        $ilIliasIniFile = $DIC['ilIliasIniFile'];
 
        $this->initAuth($sid);
        $this->initIlias();
        list($admin_sid, $client) = $this->__explodeSid($sid);
         
        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
 
        if (!$ilIliasIniFile->readVariable('server', 'studip')) {
            return $this->__raiseError('Stud.IP mode not active.', 'Server');
        }
 
        if (!$rbacreview->isAssigned($ilUser->getId(), SYSTEM_ROLE_ID)) {
            return $this->__raiseError('No permission to initialize user session.', 'Server');
        }
 
        if ($ilUser->getLoginByUserId($user_id)) {
            // logout admin
            include_once './Services/Authentication/classes/class.ilSession.php';
            ilSession::setClosingContext(ilSession::SESSION_CLOSE_USER);
            $GLOBALS['DIC']['ilAuthSession']->logout();
            unset($_COOKIE[session_name()]);
 
            // init session and set user as authenticated
            $_COOKIE['ilClientId'] = $client;
            $GLOBALS['DIC']['ilAuthSession']->init();
            $GLOBALS['DIC']['ilAuthSession']->setAuthenticated(true, $user_id);
            return (session_id() . '::' . $client);
        }
        return $this->__raiseError('User does not exist', 'Client');
    }

References $_COOKIE, $client, $DIC, $GLOBALS, $ilIliasIniFile, $ilUser, ilSoapAdministration\__explodeSid(), ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), ilSession\SESSION_CLOSE_USER, ilSession\setClosingContext(), and SYSTEM_ROLE_ID.

Here is the call graph for this function:

logout()

ilSoapUserAdministration::logout

(

$sid

)

Logout user destroy session.

Parameters

string

$sid

Returns

type

Definition at line 181 of file class.ilSoapUserAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
        
        include_once './Services/Authentication/classes/class.ilSession.php';
        ilSession::setClosingContext(ilSession::SESSION_CLOSE_USER);
        $GLOBALS['DIC']['ilAuthSession']->logout();
        return true;
    }

References $GLOBALS, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), ilSession\SESSION_CLOSE_USER, and ilSession\setClosingContext().

Here is the call graph for this function:

lookupUser()

ilSoapUserAdministration::lookupUser	(		$sid,
			$user_name
	)

Parameters

$sid
$user_name

Returns

int|\soap_fault|\SoapFault|string

Definition at line 201 of file class.ilSoapUserAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
 
        $user_name = trim($user_name);
 
        if (!strlen($user_name)) {
            return $this->__raiseError('No username given. Aborting', 'Client');
        }
 
        global $DIC;
 
        $ilUser = $DIC->user();
        $access = $DIC->access();
 
        if (
            strcasecmp($ilUser->getLogin(), $user_name) !== 0 &&
            !$access->checkAccess(
                'read_users',
                '',
                USER_FOLDER_ID
            )
        ) {
            return $this->__raiseError('Check access failed. ' . USER_FOLDER_ID, 'Server');
        }
 
        $user_id = ilObjUser::getUserIdByLogin($user_name);
 
 
        return $user_id ? $user_id : "0";
    }

References $DIC, $ilUser, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObjUser\getUserIdByLogin(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and USER_FOLDER_ID.

Here is the call graph for this function:

searchUser()

ilSoapUserAdministration::searchUser	(		$sid,
			$a_keyfields,
			$query_operator,
			$a_keyvalues,
			$attach_roles,
			$active
	)

return user xml following dtd 3.7

Parameters

String	$sid	session id
	String	array $a_keyfields array of user fieldname, following dtd 3.7
String	$queryOperator	any logical operator
	String	array $a_keyValues values separated by space, at least 3 chars per search term

Definition at line 905 of file class.ilSoapUserAdministration.php.

    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->__checkSession($sid)) {
            return $this->__raiseError($this->__getMessage(), $this->__getMessageCode());
        }
        
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        $access = $DIC->access();
 
        if (!$access->checkAccess('read_users', '', USER_FOLDER_ID)) {
            return $this->__raiseError('Check access failed.', 'Server');
        }
        if (!count($a_keyfields)) {
            $this->__raiseError('At least one keyfield is needed', 'Client');
        }
 
        if (!count($a_keyvalues)) {
            $this->__raiseError('At least one keyvalue is needed', 'Client');
        }
 
        if (!strcasecmp($query_operator, "and")==0 || !strcasecmp($query_operator, "or") == 0) {
            $this->__raiseError('Query operator must be either \'and\' or \'or\'', 'Client');
        }
 
 
        $query = $this->__buildSearchQuery($a_keyfields, $query_operator, $a_keyvalues);
 
        $query = "SELECT usr_data.*, usr_pref.value AS language
                          FROM usr_data
                          LEFT JOIN usr_pref
                          ON usr_pref.usr_id = usr_data.usr_id AND usr_pref.keyword = " .
            $ilDB->quote("language", "text") .
            "  WHERE 1 = 1 " . $query;
 
        if (is_numeric($active) && $active > -1) {
            $query .= " AND active = " . $ilDB->quote($active);
        }
 
        $query .= " ORDER BY usr_data.lastname, usr_data.firstname ";
 
        //echo $query;
 
        $r = $ilDB->query($query);
 
        $data = array();
 
        while ($row = $ilDB->fetchAssoc($r)) {
            $data[] = $row;
        }
 
        include_once './Services/User/classes/class.ilUserXMLWriter.php';
 
        $xmlWriter = new ilUserXMLWriter();
        $xmlWriter->setAttachRoles($attach_roles);
         
        $xmlWriter->setObjects($data);
 
        if ($xmlWriter->start()) {
            return $xmlWriter->getXML();
        }
        return $this->__raiseError('Error in searchUser', 'Server');
    }

References $data, $DIC, $ilDB, $query, __buildSearchQuery(), ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and USER_FOLDER_ID.

Here is the call graph for this function:

---

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

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