Inheritance diagram for ilSoapAdministration:

Collaboration diagram for ilSoapAdministration:

Public Member Functions
	__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)

Static Public Member Functions
static	return_bytes ($val)
	calculate bytes from K,M,G modifiers e.g: 8M = 8 * 1024 * 1024 bytes More...

Data Fields
	$sauth = null

	$error_method = null

Protected Attributes
	$soap_check = true

Private Member Functions
	getClientInfo ($init, $client_dir)

Detailed Description

Definition at line 41 of file class.ilSoapAdministration.php.

Constructor & Destructor Documentation

◆ __construct()

ilSoapAdministration::__construct ( $use_nusoap = true )

Constructor.

Parameters

bool $use_nusoap

Definition at line 63 of file class.ilSoapAdministration.php.

References $client, $GLOBALS, $ilUser, __explodeSid(), __initAuthenticationObject(), __setMessage(), __setMessageCode(), IL_SOAPMODE, and IL_SOAPMODE_NUSOAP.

         {
             define('USER_FOLDER_ID',7);
                 define('NUSOAP',1);
                 define('PHP5',2);
 
                 if(IL_SOAPMODE == IL_SOAPMODE_NUSOAP)
                 {
                         $this->error_method = NUSOAP;
                 } 
                 else
                 { 
                         $this->error_method = PHP5;
                 }
                 #echo ("SOAP: using soap mode ".IL_SOAPMODE == IL_SOAPMODE_NUSOAP ? "NUSOAP": "PHP5");
                 $this->__initAuthenticationObject();
         }

Here is the call graph for this function:

Member Function Documentation

◆ __appendMessage()

ilSoapAdministration::__appendMessage ( $a_str )

Definition at line 160 of file class.ilSoapAdministration.php.

         {
                 $this->message .= isset($this->message) ? ' ' : '';
                 $this->message .= $a_str;
         }

◆ __explodeSid()

ilSoapAdministration::__explodeSid ( $sid )

Definition at line 144 of file class.ilSoapAdministration.php.

References array.

Referenced by __construct(), initAuth(), and ilSoapUserAdministration\loginStudipUser().

         {
                 $exploded = explode('::',$sid);
 
                 return is_array($exploded) ? $exploded : array('sid' => '','client' => '');
         }

Here is the caller graph for this function:

◆ __getMessage()

ilSoapAdministration::__getMessage ( )

Definition at line 156 of file class.ilSoapAdministration.php.

         {
                 return $this->message;
         }

Here is the caller graph for this function:

◆ __getMessageCode()

ilSoapAdministration::__getMessageCode ( )

Definition at line 171 of file class.ilSoapAdministration.php.

         {
                 return $this->message_code;
         }

Here is the caller graph for this function:

◆ __initAuthenticationObject()

ilSoapAdministration::__initAuthenticationObject ( $a_auth_mode = AUTH_LOCAL )

Definition at line 206 of file class.ilSoapAdministration.php.

References ilAuthFactory\CONTEXT_SOAP, and ilAuthFactory\setContext().

Referenced by __construct(), and ilSoapUserAdministration\loginCAS().

         {
                 include_once './Services/Authentication/classes/class.ilAuthFactory.php';
                 ilAuthFactory::setContext(ilAuthFactory::CONTEXT_SOAP);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __raiseError()

ilSoapAdministration::__raiseError	(	$a_message,
		$a_code
	)

Definition at line 213 of file class.ilSoapAdministration.php.

         {
                 #echo $a_message, $a_code;
             switch($this->error_method)
                 {
                         case NUSOAP:
                                 return new soap_fault($a_code,'',$a_message);
                         case PHP5:
                                 return new SoapFault($a_code, $a_message);
                 }
         }

Here is the caller graph for this function:

◆ __setMessage()

ilSoapAdministration::__setMessage ( $a_str )

Definition at line 152 of file class.ilSoapAdministration.php.

Referenced by __construct().

         {
                 $this->message = $a_str;
         }

Here is the caller graph for this function:

◆ __setMessageCode()

ilSoapAdministration::__setMessageCode ( $a_code )

Definition at line 166 of file class.ilSoapAdministration.php.

Referenced by __construct().

         {
                 $this->message_code = $a_code;
         }

Here is the caller graph for this function:

◆ checkObjectAccess()

ilSoapAdministration::checkObjectAccess	(	$ref_id,
		$expected_type,
		$permission,
		$returnObject = `false`
	)

check access for ref id: expected type, permission, return object instance if returnobject is true

Parameters

int	$ref_id
	string	or array $expected_type
string	$permission
boolean	$returnObject

Returns: Object or type

Definition at line 346 of file class.ilSoapAdministration.php.

References $ref_id, __raiseError(), ilObject\_exists(), ilObject\_isInTrash(), ilObjectFactory\getInstanceByRefId(), and ilObjectFactory\getTypeByRefId().

Referenced by ilSoapCourseAdministration\getCoursesForUser(), ilSoapCourseAdministration\getCourseXML(), ilSoapGroupAdministration\getGroupsForUser(), and ilSoapUserAdministration\getUsersForContainer().

                                                                                                        {
                 global $rbacsystem;
                 if(!is_numeric($ref_id))
                 {
                         return $this->__raiseError('No valid id given.',
                                                                            'Client');
                 }
                 if (!ilObject::_exists($ref_id, true)) {
                         return $this->__raiseError('No object for id.',
                                                                            'CLIENT_OBJECT_NOT_FOUND');
                 }
                 
                 if (ilObject::_isInTrash($ref_id)) {
                         return $this->__raiseError('Object is already trashed.',
                                                                            'CLIENT_OBJECT_DELETED');                    
                 }
                 
                 $type = ilObjectFactory::getTypeByRefId($ref_id);
                 if ((is_array($expected_type) && !in_array($type, $expected_type)) 
                     || 
                     (!is_array($expected_type) && $type != $expected_type)
                     )
                 {
                         return $this->__raiseError("Wrong type $type for id. Expected: ".(is_array($expected_type) ? join (",",$expected_type) : $expected_type), 'CLIENT_OBJECT_WRONG_TYPE');                                          
                 }
                 
                 if (!$rbacsystem->checkAccess($permission, $ref_id, $type))
                 {
                         return $this->__raiseError('Missing permission $permission for type $type.', 'CLIENT_OBJECT_WRONG_PERMISSION');
                 }
                 
                 if ($returnObject) {
                         return ilObjectFactory::getInstanceByRefId($ref_id);
                 }
                 
                 return $type;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getClientInfo()

ilSoapAdministration::getClientInfo	(	$init,
		$client_dir
	)

private

Definition at line 435 of file class.ilSoapAdministration.php.

References $client_id, $GLOBALS, $ilDB, and $style.

Referenced by getClientInfoXML(), and getInstallationInfoXML().

         {
                 global $ilDB;
                 $ini_file = "./".$client_dir."/client.ini.php";
                 
                 // get settings from ini file
                 require_once("./Services/Init/classes/class.ilIniFile.php");
                 
                 $ilClientIniFile = new ilIniFile($ini_file);
                 $ilClientIniFile->read();
                 if ($ilClientIniFile->ERROR != "")
                 {
                         return false;
                 }
                 $client_id = $ilClientIniFile->readVariable('client','name');
                 if ($ilClientIniFile->variableExists('client', 'expose'))
                 {
                     $client_expose = $ilClientIniFile->readVariable('client','expose');
                     if ($client_expose == "0")
                         return false;
                 }
 
                 // build dsn of database connection and connect
                 require_once("./Services/Database/classes/class.ilDBWrapperFactory.php");
                 $ilDB = ilDBWrapperFactory::getWrapper($ilClientIniFile->readVariable("db","type"),
                         $ilClientIniFile->readVariable("db","inactive_mysqli"));
                 $ilDB->initFromIniFile($ilClientIniFile);                       
                 if ($ilDB->connect(true)) 
                 {
                         $GLOBALS['ilDB'] = $ilDB;
         
                         require_once("Services/Administration/classes/class.ilSetting.php");
                         $settings = new ilSetting();
                         $GLOBALS["ilSetting"] = $settings;
                         // workaround to determine http path of client
                         define ("IL_INST_ID",  $settings->get("inst_id",0));
                         $settings->access = $ilClientIniFile->readVariable("client", "access");
                         $settings->description = $ilClientIniFile->readVariable("client","description");
                         $settings->session = min((int) ini_get("session.gc_maxlifetime"), (int) $ilClientIniFile->readVariable("session","expire"));
                         $settings->language = $ilClientIniFile->readVariable("language","default");
                         $settings->clientid = basename($client_dir); //pathinfo($client_dir, PATHINFO_FILENAME);
                         $settings->default_show_users_online = $settings->get("show_users_online");
                         $settings->default_hits_per_page = $settings->get("hits_per_page");
                         $skin = $ilClientIniFile->readVariable("layout","skin");
                         $style = $ilClientIniFile->readVariable("layout","style");
                         $settings->default_skin_style = $skin.":".$style;
                         return $settings;               
                 }
                 return null;
         }

Here is the caller graph for this function:

◆ getClientInfoXML()

ilSoapAdministration::getClientInfoXML ( $clientid )

Definition at line 411 of file class.ilSoapAdministration.php.

References $client, __raiseError(), ilContext\CONTEXT_SOAP_WITHOUT_CLIENT, getClientInfo(), ilContext\init(), and ilInitialisation\initILIAS().

         {               
                 include_once "Services/Context/classes/class.ilContext.php";
                 ilContext::init(ilContext::CONTEXT_SOAP_WITHOUT_CLIENT);
                 
                 require_once("Services/Init/classes/class.ilInitialisation.php");
                 ilInitialisation::initILIAS();  
                 
                 $clientdir = ILIAS_WEB_DIR."/".$clientid;
                 require_once ("webservice/soap/classes/class.ilSoapInstallationInfoXMLWriter.php");
                 $writer = new ilSoapInstallationInfoXMLWriter ();               
                 $writer->setExportAdvancedMetaDataDefinitions (true);
                 $writer->setExportUDFDefinitions (true);
                 $writer->start();
                 if (is_object($client = $this->getClientInfo($init, $clientdir)))
                 {
                         $writer->addClient($client);
                 }
                 else
                         return $this->__raiseError("Client ID $clientid does not exist!", 'Client');
                 $writer->end();
                 return $writer->getXML();
         }

Here is the call graph for this function:

◆ getInstallationInfoXML()

ilSoapAdministration::getInstallationInfoXML ( )

Definition at line 384 of file class.ilSoapAdministration.php.

References ilContext\CONTEXT_SOAP_WITHOUT_CLIENT, getClientInfo(), ilContext\init(), and ilInitialisation\initILIAS().

         {               
                 include_once "Services/Context/classes/class.ilContext.php";
                 ilContext::init(ilContext::CONTEXT_SOAP_WITHOUT_CLIENT);
                 
                 require_once("Services/Init/classes/class.ilInitialisation.php");
                 ilInitialisation::initILIAS();
                                 
                 $clientdirs = glob(ILIAS_WEB_DIR."/*",GLOB_ONLYDIR);
                 require_once ("webservice/soap/classes/class.ilSoapInstallationInfoXMLWriter.php");     
                 $writer = new ilSoapInstallationInfoXMLWriter ();
                 $writer->start();               
                 if (is_array($clientdirs))
                 {               
                         foreach ($clientdirs as $clientdir) 
                         {                               
                                 if (is_object($clientInfo= $this->getClientInfo($init, $clientdir)))
                                 {
                                         $writer->addClient ($clientInfo);
                                 }
                         }
                 }
                 $writer->end();
                 
                 return $writer->getXML();
         }

Here is the call graph for this function:

◆ getNIC()

ilSoapAdministration::getNIC ( $sid )

get client information from current as xml result set

Parameters

string $sid current session id

Returns: XMLResultSet containing columns installation_id, installation_version, installation_url, installation_description, installation_default_language

Definition at line 232 of file class.ilSoapAdministration.php.

References $ilLog, $ilSetting, $records, __getMessage(), __getMessageCode(), __raiseError(), ilAdvancedMDRecord\_getActivatedRecordsByObjectType(), ilAuthUtils\_getActiveAuthModes(), ilAdvancedMDRecord\_getAssignableObjectTypes(), ilAuthUtils\_getAuthModeName(), array, ILIAS_VERSION, initAuth(), initIlias(), and return_bytes().

         {
                 $this->initAuth($sid);
                 $this->initIlias();
 
             if(!$this->__checkSession($sid))
                 {
                         return $this->__raiseError($this->__getMessage(),$this->__getMessageCode());
                 }
 
                 global $rbacsystem, $rbacreview, $ilLog, $rbacadmin,$ilSetting, $ilClientIniFile;
 
                 if (!is_object($ilClientIniFile)) {
                     return $this->__raiseError("Client ini is not initialized","Server");
                 }
                 $auth_modes = ilAuthUtils::_getActiveAuthModes();
                 $auth_mode_default =  strtoupper(ilAuthUtils::_getAuthModeName(array_shift($auth_modes)));
                 $auth_mode_names = array();
                 foreach ($auth_modes as $mode) {
                         $auth_mode_names[] = strtoupper(ilAuthUtils::_getAuthModeName($mode));
                 }
 
                 include_once 'Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php';
                 include_once 'Services/AdvancedMetaData/classes/class.ilAdvancedMDRecordXMLWriter.php';
                 
                 // create advanced meta data record xml
                 $record_ids = array();
                 $record_types = ilAdvancedMDRecord::_getAssignableObjectTypes();
                 foreach($record_types as $type_info) {
                         $type = $type_info['obj_type'];
                         $records = ilAdvancedMDRecord::_getActivatedRecordsByObjectType($type);
                         foreach ($records as $record){
                                 $record_ids [] = $record->getRecordId();
                         }                       
                 }
                 $record_ids = array_unique($record_ids);                
                 $advmwriter = new ilAdvancedMDRecordXMLWriter($record_ids);
                 $advmwriter->write();           
                 
                 // create user defined fields record xml, simulate empty user records
                 include_once ("./Services/User/classes/class.ilUserXMLWriter.php");
                 $udfWriter = new ilUserXMLWriter();
                 $users = array();
                 $udfWriter->setObjects($users);
                 $udfWriter->start();                            
                  
         // todo: get information from client id, read from ini file specificied
         $client_details[] = array ("installation_id" => IL_INST_ID,
                                    "installation_version" => ILIAS_VERSION,
                                    "installation_url" => ILIAS_HTTP_PATH,
                                    "installation_description" => $ilClientIniFile->readVariable("client","description"),
                                                                         "installation_language_default" => $ilClientIniFile->readVariable("language","default"),
                                                                         "installation_session_expire" => $ilClientIniFile->readVariable("session","expire"),
                                                                         "installation_php_postmaxsize" => $this->return_bytes(ini_get("post_max_size")),
                                                                         "authentication_methods" => join(",", $auth_mode_names),
                                                                         "authentication_default_method" => $auth_mode_default,
                                                                 "installation_udf_xml" => $udfWriter ->getXML(),
                                                                 "installation_advmd_xml" => $advmwriter->xmlDumpMem(false)
 
                                                                                                                                                 );
 
         // store into xml result set
                 include_once './webservice/soap/classes/class.ilXMLResultSet.php';
 
 
         $xmlResult = new ilXMLResultSet();
         $xmlResult->addArray($client_details, true);
 
         // create writer and return xml
                 include_once './webservice/soap/classes/class.ilXMLResultSetWriter.php';
         $xmlResultWriter = new ilXMLResultSetWriter($xmlResult);
         $xmlResultWriter->start();
         return $xmlResultWriter->getXML();
         }

Here is the call graph for this function:

◆ initAuth()

ilSoapAdministration::initAuth ( $sid )

Init authentication.

Parameters

string $sid

Definition at line 180 of file class.ilSoapAdministration.php.

References $_COOKIE, $client, and __explodeSid().

         {
                 list($sid,$client) = $this->__explodeSid($sid);
                 define('CLIENT_ID',$client);
                 $_COOKIE['ilClientId'] = $client;
                 $_COOKIE['PHPSESSID'] = $sid;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initErrorWriter()

ilSoapAdministration::initErrorWriter ( )

Overwrite error handler.

public

Parameters

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

References array.

         {
                 include_once('./Services/Init/classes/class.ilErrorHandling.php');
 
                 set_error_handler(array('ilErrorHandling','_ilErrorWriter'),E_ALL);
         }

◆ initIlias()

ilSoapAdministration::initIlias ( )

Definition at line 188 of file class.ilSoapAdministration.php.

References ilContext\CONTEXT_SOAP, ilContext\getType(), and ilInitialisation\initILIAS().

         {               
                 if(ilContext::getType() == ilContext::CONTEXT_SOAP)
                 {
                         try
                         {
                                 require_once("Services/Init/classes/class.ilInitialisation.php");
                                 ilInitialisation::initILIAS();
                         }
                         catch(Exception $e)
                         {                               
                                 // #10608                               
                                 // no need to do anything here, see __checkSession() below
                         }
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isFault()

ilSoapAdministration::isFault ( $object )

Definition at line 326 of file class.ilSoapAdministration.php.

Referenced by ilSoapObjectAdministration\addObject(), ilSoapObjectAdministration\copyObject(), ilSoapCourseAdministration\getCourseXML(), ilSoapUserAdministration\getUsersForContainer(), ilSoapObjectAdministration\moveObject(), ilSoapObjectAdministration\updateObjects(), and ilSoapObjectAdministration\validateReferences().

                                          {
                 switch($this->error_method)
                 {
                         case NUSOAP:
                                 return $object instanceof soap_fault;
                         case PHP5:
                                 return $object instanceof SoapFault;
                 }
                 return true;
         }

Here is the caller graph for this function:

◆ return_bytes()

static ilSoapAdministration::return_bytes ( $val )

static

calculate bytes from K,M,G modifiers e.g: 8M = 8 * 1024 * 1024 bytes

Definition at line 311 of file class.ilSoapAdministration.php.

Referenced by getNIC().

                                                   {
                 $val = trim($val);
                 $last = strtolower($val{strlen($val)-1});
                 switch($last) {
                 // The 'G' modifier is available since PHP 5.1.0
                 case 'g':
                         $val *= 1024;
                 case 'm':
                         $val *= 1024;
                 case 'k':
                         $val *= 1024;
                 }
                 return $val;
         }

Here is the caller graph for this function:

Field Documentation

◆ $error_method

ilSoapAdministration::$error_method = null

Definition at line 56 of file class.ilSoapAdministration.php.

◆ $sauth

ilSoapAdministration::$sauth = null

Definition at line 50 of file class.ilSoapAdministration.php.

◆ $soap_check

ilSoapAdministration::$soap_check = true

protected

Definition at line 43 of file class.ilSoapAdministration.php.

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

webservice/soap/classes/class.ilSoapAdministration.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __appendMessage()

◆ __explodeSid()

◆ __getMessage()

◆ __getMessageCode()

◆ __initAuthenticationObject()

◆ __raiseError()

◆ __setMessage()

◆ __setMessageCode()

◆ checkObjectAccess()

◆ getClientInfo()

◆ getClientInfoXML()

◆ getInstallationInfoXML()

◆ getNIC()

◆ initAuth()

◆ initErrorWriter()

◆ initIlias()

◆ isFault()

◆ return_bytes()

Field Documentation

◆ $error_method

◆ $sauth

◆ $soap_check