Inheritance diagram for ilSoapUtils:

Collaboration diagram for ilSoapUtils:

Public Member Functions
	ilSoapUtils ()

	ignoreUserAbort ()

	disableSOAPCheck ()

	sendMail ($sid, $to, $cc, $bcc, $sender, $subject, $message, $attach)

	distributeMails ($sid, $a_mail_xml)
	mail via soap More...

	saveTempFileAsMediaObject ($sid, $name, $tmp_name)

	getMobsOfObject ($sid, $a_type, $a_id)

	ilCloneDependencies ($sid, $copy_identifier)
	clone object dependencies (e.g. More...

	ilClone ($sid, $copy_identifier)
	Clone object. More...

	handleECSTasks ($sid, $a_server_id)

	deleteExpiredDualOptInUserObjects ($sid, $usr_id)
	Method for soap webservice: deleteExpiredDualOptInUserObjects. More...

Public Member Functions inherited from ilSoapAdministration
	ilSoapAdministration ($use_nusoap=true)

	initErrorWriter ()
	Overwrite error handler. More...

	__explodeSid ($sid)

	__setMessage ($a_str)

	__getMessage ()

	__appendMessage ($a_str)

	__setMessageCode ($a_code)

	__getMessageCode ()

	initAuth ($sid)

	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	validateXML ($xml)
	validates an xml file, if dtd is attached More...

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...

Private Member Functions
	callNextNode ($sid, $cp_options)
	Call next node using soap. More...

	callNextDependency ($sid, $cp_options)

	cloneNode ($node, $cp_options)
	Clone node. More...

	cloneDependencies ($node, $cp_options)
	cloneDependencies More...

	linkNode ($node, $cp_options)
	Link node. More...

Additional Inherited Members
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.ilSoapUtils.php.

Member Function Documentation

◆ callNextDependency()

ilSoapUtils::callNextDependency	(	$sid,
		$cp_options
	)

private

Definition at line 414 of file class.ilSoapUtils.php.

References $ilLog, $res, ilLoggerFactory\getLogger(), and ilSoapFunctions\ilCloneDependencies().

Referenced by ilCloneDependencies().

         {
                 global $ilLog;
 
                 $cp_options->dropFirstDependenciesNode();
                 
                 if($cp_options->isSOAPEnabled())
                 {
                         // Start next soap call
                         include_once 'Services/WebServices/SOAP/classes/class.ilSoapClient.php';
                         $soap_client = new ilSoapClient();
                         $soap_client->setResponseTimeout(1);
                         $soap_client->enableWSDL(true);
                         $soap_client->init();
                         $soap_client->call('ilCloneDependencies',array($sid,$cp_options->getCopyId()));
                 }
                 else
                 {
                         ilLoggerFactory::getLogger('obj')->warning('SOAP clone call failed. Calling clone method manually');
                         $cp_options->read();
                         include_once('./webservice/soap/include/inc.soap_functions.php');
                         $res = ilSoapFunctions::ilCloneDependencies($sid,$cp_options->getCopyId());
                 }
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ callNextNode()

ilSoapUtils::callNextNode	(	$sid,
		$cp_options
	)

private

Call next node using soap.

Parameters

object copx wizard options instance private

Definition at line 388 of file class.ilSoapUtils.php.

References $ilLog, $res, ilLoggerFactory\getLogger(), and ilSoapFunctions\ilClone().

Referenced by ilClone().

         {
                 global $ilLog;
 
                 $cp_options->dropFirstNode();
 
                 if($cp_options->isSOAPEnabled())
                 {
                         // Start next soap call
                         include_once 'Services/WebServices/SOAP/classes/class.ilSoapClient.php';
                         $soap_client = new ilSoapClient();
                         $soap_client->setResponseTimeout(1);
                         $soap_client->enableWSDL(true);
                         $soap_client->init();
                         $soap_client->call('ilClone',array($sid,$cp_options->getCopyId()));
                 }
                 else
                 {
                         ilLoggerFactory::getLogger('obj')->warning('SOAP clone call failed. Calling clone method manually');
                         $cp_options->read();                    
                         include_once('./webservice/soap/include/inc.soap_functions.php');
                         $res = ilSoapFunctions::ilClone($sid,$cp_options->getCopyId());
                 }
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cloneDependencies()

ilSoapUtils::cloneDependencies	(	$node,
		$cp_options
	)

private

cloneDependencies

private

Parameters

Definition at line 504 of file class.ilSoapUtils.php.

References $ilLog, $target_id, ilObjectFactory\getInstanceByRefId(), and ilLoggerFactory\getLogger().

Referenced by ilCloneDependencies().

         {
                 global $ilLog;
                 
                 $source_id = $node['child'];
                 $mappings = $cp_options->getMappings();
                 
                 if(!isset($mappings[$source_id]))
                 {
                         ilLoggerFactory::getLogger('obj')->debug('Omitting node '.$source_id.', '.$node['title'].', '.$node['type']. '. No mapping found.');
                         return true;
                 }
                 $target_id = $mappings[$source_id];
 
                 $orig = ilObjectFactory::getInstanceByRefId((int) $source_id);
                 $orig->cloneDependencies($target_id,$cp_options->getCopyId());
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cloneNode()

ilSoapUtils::cloneNode	(	$node,
		$cp_options
	)

private

Clone node.

private

Parameters

Definition at line 447 of file class.ilSoapUtils.php.

References $ilLog, $options, $target_id, ilRbacLog\add(), ilRbacLog\COPY_OBJECT, ilRbacLog\gatherFaPa(), ilObjectFactory\getInstanceByRefId(), and ilLoggerFactory\getLogger().

Referenced by ilClone().

         {
                 global $ilLog,$tree,$ilAccess,$rbacreview;
                 
                 #sleep(20);
                 
                 $source_id = $node['child'];
                 $parent_id = $node['parent'];
                 $options = $cp_options->getOptions($node['child']);
                 $mappings = $cp_options->getMappings();
                 
                 if(!$ilAccess->checkAccess('copy','',$node['child']))
                 {
                         ilLoggerFactory::getLogger('obj')->error('No copy permission granted: '.$source_id.', '.$node['title'].', '.$node['type']);
                         return false;
                         
                 }
                 if(!isset($mappings[$parent_id]))
                 {
                         ilLoggerFactory::getLogger('obj')->info('Omitting node '.$source_id.', '.$node['title'].', '.$node['type']. '. No target found.');
                         return true;
                 }
                 $target_id = $mappings[$parent_id];
                 
                 if(!$tree->isInTree($target_id))
                 {
                         ilLoggerFactory::getLogger('obj')->notice('Omitting node '.$source_id.', '.$node['title'].', '.$node['type']. '. Object has been deleted.');
                         return false;
                 }
 
                 $orig = ilObjectFactory::getInstanceByRefId((int) $source_id);
                 $new_obj = $orig->cloneObject((int) $target_id,$cp_options->getCopyId());
                 
                 if(!is_object($new_obj))
                 {
                         ilLoggerFactory::getLogger('obj')->error('Error copying '.$source_id.', '.$node['title'].', '.$node['type'].'. No target found.');
                         return false;
                 }
 
                 // rbac log
                 include_once "Services/AccessControl/classes/class.ilRbacLog.php";
                 $rbac_log_roles = $rbacreview->getParentRoleIds($new_obj->getRefId(), false);
                 $rbac_log = ilRbacLog::gatherFaPa($new_obj->getRefId(), array_keys($rbac_log_roles), true);
                 ilRbacLog::add(ilRbacLog::COPY_OBJECT, $new_obj->getRefId(), $rbac_log, (int)$source_id);
                 
                 // Finally add new mapping entry
                 $cp_options->appendMapping($source_id,$new_obj->getRefId());
                 return $new_obj->getRefId();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteExpiredDualOptInUserObjects()

ilSoapUtils::deleteExpiredDualOptInUserObjects	(	$sid,
		$usr_id
	)

Method for soap webservice: deleteExpiredDualOptInUserObjects.

This service will run in background. The client has not to wait for response.

Parameters

string	$sid	Session id + client id, separated by ::
integer	$usr_id	User id of the actuator

Returns: boolean true or false public

Definition at line 635 of file class.ilSoapUtils.php.

References $ilDB, $ilLog, $query, $res, $row, ilObjectFactory\getInstanceByObjId(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

         {
                 $this->initAuth($sid);
                 $this->initIlias();
                 
                 // Session check not possible -> anonymous user is the trigger
                 
                 global $ilDB, $ilLog;
                 
                 $ilLog->write(__METHOD__.': Started deletion of inactive user objects with expired confirmation hash values (dual opt in) ...');
 
                 require_once 'Services/Registration/classes/class.ilRegistrationSettings.php';
                 $oRegSettigs = new ilRegistrationSettings();
                 
                 $query = '';
 
                 /* 
                  * Fetch the current actuator user object first, because this user will try to perform very probably
                  * a new registration with the same login name in a few seconds ;-)
                  * 
                  */ 
                 if((int)$usr_id > 0)
                 {
                         $query .= 'SELECT usr_id, create_date, reg_hash FROM usr_data '
                                     . 'WHERE active = 0 '
                                     . 'AND reg_hash IS NOT NULL '
                                     . 'AND usr_id = '.$ilDB->quote($usr_id, 'integer').' ';
                         $query .= 'UNION ';
                 }
                                 
                 $query .= 'SELECT usr_id, create_date, reg_hash FROM usr_data '
                             . 'WHERE active = 0 '
                             . 'AND reg_hash IS NOT NULL '
                             . 'AND usr_id != '.$ilDB->quote($usr_id, 'integer').' ';                        
 
                 $res = $ilDB->query($query);
                 
                 $ilLog->write(__METHOD__.': '.$ilDB->numRows($res).' inactive user objects with confirmation hash values (dual opt in) found ...');
 
                 /* 
                  * mjansen: 15.12.2010:
                  * I perform the expiration check in php because of multi database support (mysql, postgresql).
                  * I did not find an oracle equivalent for mysql: UNIX_TIMESTAMP()  
                  */
                 
                 $num_deleted_users = 0;
                 while($row = $ilDB->fetchAssoc($res))
                 {
                         if($row['usr_id'] == ANONYMOUS_USER_ID || $row['usr_id'] == SYSTEM_USER_ID) continue;                   
                         if(!strlen($row['reg_hash'])) continue;
                                                 
                         if((int)$oRegSettigs->getRegistrationHashLifetime() > 0 &&
                            $row['create_date'] != '' &&
                            time() - $oRegSettigs->getRegistrationHashLifetime() > strtotime($row['create_date']))
                         {
                                 $user = ilObjectFactory::getInstanceByObjId($row['usr_id'], false);
                                 if($user instanceof ilObjUser)
                                 {
                                         $ilLog->write(__METHOD__.': User '.$user->getLogin().' (obj_id: '.$user->getId().') will be deleted due to an expired registration hash ...');
                                         $user->delete();
                                         ++$num_deleted_users;
                                 }
                         }       
                 }               
                 
                 $ilLog->write(__METHOD__.': '.$num_deleted_users.' inactive user objects with expired confirmation hash values (dual opt in) deleted ...');
                 
                 $ilLog->write(__METHOD__.': Finished deletion of inactive user objects with expired confirmation hash values (dual opt in) ...');
                 
                 return true;
         }

Here is the call graph for this function:

◆ disableSOAPCheck()

ilSoapUtils::disableSOAPCheck ( )

Definition at line 47 of file class.ilSoapUtils.php.

         {
                 $this->soap_check = false;              
         }

◆ distributeMails()

ilSoapUtils::distributeMails	(	$sid,
		$a_mail_xml
	)

mail via soap

Parameters

object	$sid
object	$a_mail_xml

Returns

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

References $file, $GLOBALS, $ilUser, $ok, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilUtil\_sanitizeFilemame(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and ilMail\setSaveInSentbox().

         {
                 $this->initAuth($sid);
                 $this->initIlias();
 
                 if(!$this->__checkSession($sid))
                 {
                         return $this->__raiseError($this->__getMessage(),$this->__getMessageCode());
                 }
                 
                 include_once 'Services/Mail/classes/class.ilMail.php';
                 include_once 'webservice/soap/classes/class.ilSoapMailXmlParser.php';
                 
                 $parser = new ilSoapMailXmlParser($a_mail_xml);
                 try
                 {
                         // Check if wellformed
                         libxml_use_internal_errors(true);
                         $ok = simplexml_load_string($a_mail_xml);
                         if(!$ok)
                         {
                                 foreach(libxml_get_errors() as $err)
                                 {
                                         $error .= ($err->message.' ');
                                 }
                                 return $this->__raiseError($error, 'CLIENT');
                         }
                         $parser->start();               
                 }
                 catch(InvalidArgumentException $e)
                 {
                         $GLOBALS['ilLog']->write(__METHOD__.' '.$e->getMessage());
                         return $this->__raiseError($e->getMessage(),'CLIENT');
                 }
                 catch(ilSaxParserException $e)
                 {
                         $GLOBALS['ilLog']->write(__METHOD__.' '.$e->getMessage());
                         return $this->__raiseError($e->getMessage(), 'CLIENT');
                 }
                 
                 $mails = $parser->getMails();
                 
                 global $ilUser;
                 
                 foreach($mails as $mail)
                 {
                         // Prepare attachments
                         include_once './Services/Mail/classes/class.ilFileDataMail.php';
                         $file = new ilFileDataMail($ilUser->getId());
                         foreach((array) $mail['attachments'] as $attachment)
                         {
                                 // TODO: Error handling
                                 $file->storeAsAttachment($attachment['name'], $attachment['content']);
                                 $attachments[] = ilUtil::_sanitizeFilemame($attachment['name']);
                         }
                         
                         $mail_obj = new ilMail($ilUser->getId());
                         $mail_obj->setSaveInSentbox(true);
                         $mail_obj->saveAttachments((array) $attachments);
                         $mail_obj->sendMail(
                                 implode(',',(array) $mail['to']),
                                 implode(',',(array) $mail['cc']),
                                 implode(',',(array) $mail['bcc']),
                                 $mail['subject'],
                                 implode("\n", (array)$mail['body']),
                                 (array) $attachments,
                                 array($mail['type']),
                                 (bool) $mail['usePlaceholders']
                         );
                         
                         // Finally unlink attachments
                         foreach((array) $attachments as $att)
                         {
                                 $file->unlinkFile($att);
                         }
                         $mail_obj->savePostData(
                                 $ilUser->getId(),
                                 array(),
                                 '',
                                 '',
                                 '',
                                 '',
                                 '',
                                 '',
                                 '',
                                 ''
                         );
                 }
                 return true;
         }

Here is the call graph for this function:

◆ getMobsOfObject()

ilSoapUtils::getMobsOfObject	(	$sid,
		$a_type,
		$a_id
	)

Definition at line 229 of file class.ilSoapUtils.php.

References ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObjMediaObject\_getMobsOfObject(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

         {
                 $this->initAuth($sid);
                 $this->initIlias();
 
                 if(!$this->__checkSession($sid))
                 {
                         return $this->__raiseError($this->__getMessage(),$this->__getMessageCode());
                 }                       
 
                 include_once "./Services/MediaObjects/classes/class.ilObjMediaObject.php";
                 return ilObjMediaObject::_getMobsOfObject($a_type, $a_id);
         }

Here is the call graph for this function:

◆ handleECSTasks()

ilSoapUtils::handleECSTasks	(	$sid,
		$a_server_id
	)

Definition at line 602 of file class.ilSoapUtils.php.

References $ilLog, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilECSTaskScheduler\_getInstanceByServerId(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

         {               
                 $this->initAuth($sid);
                 $this->initIlias();
 
                 if(!$this->__checkSession($sid))
                 {
                         return $this->__raiseError($this->__getMessage(),$this->__getMessageCode());
                 }                       
                 
                 include_once('./Services/WebServices/ECS/classes/class.ilECSTaskScheduler.php');
 
                 global $ilLog;
                 
                 $ilLog->write(__METHOD__.': Starting task execution...');
                 $scheduler = ilECSTaskScheduler::_getInstanceByServerId($a_server_id);
                 $scheduler->startTaskExecution();
                 
                 return true;
         }

Here is the call graph for this function:

◆ ignoreUserAbort()

ilSoapUtils::ignoreUserAbort ( )

Definition at line 42 of file class.ilSoapUtils.php.

         {
                 return ignore_user_abort(true);
         }

◆ ilClone()

ilSoapUtils::ilClone	(	$sid,
		$copy_identifier
	)

Clone object.

public

Parameters

string	soap session id
int	copy identifier (ilCopyWizarardOptions)

Definition at line 317 of file class.ilSoapUtils.php.

References $ilLog, $ilUser, $options, ilSoapAdministration\__getMessage(), ilCopyWizardOptions\_getInstance(), callNextNode(), cloneNode(), ilCopyWizardOptions\COPY_WIZARD_COPY, ilCopyWizardOptions\COPY_WIZARD_LINK, ilCopyWizardOptions\COPY_WIZARD_OMIT, ilLoggerFactory\getLogger(), ilCloneDependencies(), ilSoapAdministration\initAuth(), ilSoapAdministration\initIlias(), and linkNode().

         {
                 $this->initAuth($sid);
                 $this->initIlias();
 
                 if(!$this->__checkSession($sid))
                 {
                         ilLoggerFactory::getLogger('obj')->error('Object cloning failed. Invalid session given: '. $this->__getMessage());
                 }                       
 
                 global $ilLog,$ilUser;
                 
                 include_once('Services/CopyWizard/classes/class.ilCopyWizardOptions.php');
                 $cp_options = ilCopyWizardOptions::_getInstance($copy_identifier);
                 
                 // Check owner of copy procedure
                 if(!$cp_options->checkOwner($ilUser->getId()))
                 {
                         ilLoggerFactory::getLogger('obj')->error('Permission check failed for user id: '.$ilUser->getId().', copy id: '.$copy_identifier);
                         return false;
                 }
                 
                 
                 // Fetch first node
                 if(($node = $cp_options->fetchFirstNode()) === false)
                 {
                         ilLoggerFactory::getLogger('obj')->info('Finished copy step 1. Starting copying of object dependencies...');
                         return $this->ilCloneDependencies($sid,$copy_identifier);
                 }
         
                 // Check options of this node
                 $options = $cp_options->getOptions($node['child']);
                 
                 $new_ref_id = 0;
                 switch($options['type'])
                 {
                         case ilCopyWizardOptions::COPY_WIZARD_OMIT:
                                 ilLoggerFactory::getLogger('obj')->debug(': Omitting node: '.$node['obj_id'].', '.$node['title'].', '.$node['type']);
                                 // set mapping to zero
                                 $cp_options->appendMapping($node['child'],0);
                                 $this->callNextNode($sid,$cp_options);
                                 break;
                                 
                         case ilCopyWizardOptions::COPY_WIZARD_COPY:
                                 
                                 ilLoggerFactory::getLogger('obj')->debug('Start cloning node: '.$node['obj_id'].', '.$node['title'].', '.$node['type']);
                                 $new_ref_id = $this->cloneNode($node,$cp_options);
                                 $this->callNextNode($sid,$cp_options);
                                 break;
                         
                         case ilCopyWizardOptions::COPY_WIZARD_LINK:
                                 ilLoggerFactory::getLogger('obj')->debug('Start linking node: '.$node['obj_id'].', '.$node['title'].', '.$node['type']);
                                 $new_ref_id = $this->linkNode($node,$cp_options);
                                 $this->callNextNode($sid,$cp_options);
                                 break;
 
                         default:
                                 ilLoggerFactory::getLogger('obj')->warning('No valid action type given for: '.$node['obj_id'].', '.$node['title'].', '.$node['type']);
                                 $this->callNextNode($sid,$cp_options);
                                 break;
                                 
                 }
                 return $new_ref_id;
         }

Here is the call graph for this function:

◆ ilCloneDependencies()

ilSoapUtils::ilCloneDependencies	(	$sid,
		$copy_identifier
	)

clone object dependencies (e.g.

course start objects, preconditions ...)

public

Parameters

Definition at line 250 of file class.ilSoapUtils.php.

References $ilLog, $ilUser, $options, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilCopyWizardOptions\_getInstance(), callNextDependency(), cloneDependencies(), ilCopyWizardOptions\COPY_WIZARD_COPY, ilCopyWizardOptions\COPY_WIZARD_LINK, ilCopyWizardOptions\COPY_WIZARD_OMIT, ilLoggerFactory\getLogger(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

Referenced by ilClone().

         {
                 $this->initAuth($sid);
                 $this->initIlias();
 
                 if(!$this->__checkSession($sid))
                 {
                         return $this->__raiseError($this->__getMessage(),$this->__getMessageCode());
                 }                       
 
                 global $ilLog,$ilUser;
 
                 include_once('Services/CopyWizard/classes/class.ilCopyWizardOptions.php');
                 $cp_options = ilCopyWizardOptions::_getInstance($copy_identifier);
                 
                 // Check owner of copy procedure
                 if(!$cp_options->checkOwner($ilUser->getId()))
                 {
                         ilLoggerFactory::getLogger('obj')->error('Permission check failed for user id: '.$ilUser->getId().', copy id: '.$copy_identifier);
                         return false;
                 }
                 
                 // Fetch first node
                 if(($node = $cp_options->fetchFirstDependenciesNode()) === false)
                 {
                         $cp_options->deleteAll();
                         ilLoggerFactory::getLogger('obj')->info('Finished copy step 2. Copy completed');
                         return true;
                 }
 
                 // Check options of this node
                 $options = $cp_options->getOptions($node['child']);
                 $new_ref_id = 0;
                 switch($options['type'])
                 {
                         case ilCopyWizardOptions::COPY_WIZARD_OMIT:
                                 ilLoggerFactory::getLogger('obj')->debug(': Omitting node: '.$node['obj_id'].', '.$node['title'].', '.$node['type']);
                                 $this->callNextDependency($sid,$cp_options);
                                 break;
                         
                         case ilCopyWizardOptions::COPY_WIZARD_LINK:
                                 ilLoggerFactory::getLogger('obj')->debug(': Nothing to do for node: '.$node['obj_id'].', '.$node['title'].', '.$node['type']);
                                 $this->callNextDependency($sid,$cp_options);
                                 break;
                                 
                         case ilCopyWizardOptions::COPY_WIZARD_COPY:
                                 ilLoggerFactory::getLogger('obj')->debug(': Start cloning dependencies: '.$node['obj_id'].', '.$node['title'].', '.$node['type']);
                                 $this->cloneDependencies($node,$cp_options);
                                 $this->callNextDependency($sid,$cp_options);
                                 break;
                                 
                         default:
                                 ilLoggerFactory::getLogger('obj')->warning('No valid action type given for node: '.$node['obj_id'].', '.$node['title'].', '.$node['type']);
                                 $this->callNextDependency($sid,$cp_options);
                                 break;
                 }
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ilSoapUtils()

ilSoapUtils::ilSoapUtils ( )

Definition at line 37 of file class.ilSoapUtils.php.

         {
                 parent::ilSoapAdministration();
         }

◆ linkNode()

ilSoapUtils::linkNode	(	$node,
		$cp_options
	)

private

Link node.

private

Parameters

Definition at line 530 of file class.ilSoapUtils.php.

References $ilLog, $options, $target_id, ilRbacLog\add(), ilRbacLog\gatherFaPa(), ilObjectFactory\getInstanceByRefId(), ilLoggerFactory\getLogger(), and ilRbacLog\LINK_OBJECT.

Referenced by ilClone().

         {
                 global $ilLog,$ilAccess,$rbacreview;
                 
                 $source_id = $node['child'];
                 $parent_id = $node['parent'];
                 $options = $cp_options->getOptions($node['child']);
                 $mappings = $cp_options->getMappings();
                 
                 if(!$ilAccess->checkAccess('delete','',$node['child']))
                 {
                         ilLoggerFactory::getLogger('obj')->warning('No delete permission granted: '.$source_id.', '.$node['title'].', '.$node['type']);
                         return false;
                         
                 }
                 if(!isset($mappings[$parent_id]))
                 {
                         ilLoggerFactory::getLogger('obj')->warning('Omitting node '.$source_id.', '.$node['title'].', '.$node['type']. '. No target found.');
                         return true;
                 }
                 $target_id = $mappings[$parent_id];
 
                 $orig = ilObjectFactory::getInstanceByRefId((int) $source_id);
                 $new_ref_id = $orig->createReference();
                 $orig->putInTree($target_id);
                 $orig->setPermissions($target_id);
                 
                 if(!($new_ref_id))
                 {
                         ilLoggerFactory::getLogger('obj')->error('Error linking '.$source_id.', '.$node['title'].', '.$node['type'].'. No target found.');
                         return false;
                 }
 
                 // rbac log
                 include_once "Services/AccessControl/classes/class.ilRbacLog.php";
                 $rbac_log_roles = $rbacreview->getParentRoleIds($new_ref_id, false);
                 $rbac_log = ilRbacLog::gatherFaPa($new_ref_id, array_keys($rbac_log_roles), true);
                 ilRbacLog::add(ilRbacLog::LINK_OBJECT, $new_ref_id, $rbac_log, (int)$source_id);
                 
                 // Finally add new mapping entry
                 $cp_options->appendMapping($source_id,$new_ref_id);
                 return $new_ref_id;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveTempFileAsMediaObject()

ilSoapUtils::saveTempFileAsMediaObject	(	$sid,
		$name,
		$tmp_name
	)

Definition at line 215 of file class.ilSoapUtils.php.

References ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilObjMediaObject\_saveTempFileAsMediaObject(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

         {
                 $this->initAuth($sid);
                 $this->initIlias();
 
                 if(!$this->__checkSession($sid))
                 {
                         return $this->__raiseError($this->__getMessage(),$this->__getMessageCode());
                 }                       
 
                 include_once "./Services/MediaObjects/classes/class.ilObjMediaObject.php";
                 return ilObjMediaObject::_saveTempFileAsMediaObject($name, $tmp_name);
         }

Here is the call graph for this function:

◆ sendMail()

ilSoapUtils::sendMail	(	$sid,
		$to,
		$cc,
		$bcc,
		$sender,
		$subject,
		$message,
		$attach
	)

Definition at line 52 of file class.ilSoapUtils.php.

References $filename, ilSoapAdministration\__getMessage(), ilSoapAdministration\__getMessageCode(), ilSoapAdministration\__raiseError(), ilSoapAdministration\initAuth(), and ilSoapAdministration\initIlias().

         {
                 $this->initAuth($sid);
                 $this->initIlias();
 
                 if(!$this->__checkSession($sid))
                 {
                         return $this->__raiseError($this->__getMessage(),$this->__getMessageCode());
                 }                       
 
                 include_once 'Services/Mail/classes/class.ilMimeMail.php';
 
                 if(strpos($sender, '#:#') !== false)
                 {
                         $sender = explode('#:#', $sender);
                 }
 
                 $mmail = new ilMimeMail();
                 $mmail->autoCheck(false);
                 $mmail->From($sender);
                 $mmail->To(explode(',',$to));
                 $mmail->Subject($subject);
                 $mmail->Body($message);
 
                 if($cc)
                 {
                         $mmail->Cc(explode(',',$cc));
                 }
 
                 if($bcc)
                 {
                         $mmail->Bcc(explode(',',$bcc));
                 }
                 if($attach)
                 {
                         // mjansen: switched separator from "," to "#:#" because of mantis bug #6039
                         // for backward compatibility we have to check if the substring "#:#" exists as leading separator
                         // otherwise we should use ";" 
                         if(strpos($attach, '#:#') === 0)
                         {
                                 $attach = substr($attach, strlen('#:#'));
                                 $attachments = explode('#:#', $attach); 
                         }
                         else
                         {
                                 $attachments = explode(',', $attach);
                         }
 
                         foreach($attachments as $attachment)
                         {
                                 $final_filename = null;
                                 $filename       = basename($attachment);
                                 if(strlen($filename) > 0)
                                 {
                                         // #17740
                                         $final_filename = preg_replace('/^(\d+?_)(.*)/', '$2', $filename);
                                 }
                                 $mmail->Attach($attachment, '', 'inline', $final_filename);
                         }
                 }
 
                 $mmail->Send();
 
                 return true;
         }

Here is the call graph for this function:

◆ validateXML()

static ilSoapUtils::validateXML ( $xml )

static

validates an xml file, if dtd is attached

Parameters

$xml	current xml stream

Returns: true, if correct, or String with error messages

Definition at line 580 of file class.ilSoapUtils.php.

References DOMXML_LOAD_VALIDATING, and domxml_open_mem().

                                            {
                 // validate to prevent wrong XMLs
                 $dom = @domxml_open_mem($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 $msg;
                 }
                 return true;
         }

Here is the call graph for this function:

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

webservice/soap/classes/class.ilSoapUtils.php

Public Member Functions

Static Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ callNextDependency()

◆ callNextNode()

◆ cloneDependencies()

◆ cloneNode()

◆ deleteExpiredDualOptInUserObjects()

◆ disableSOAPCheck()

◆ distributeMails()

◆ getMobsOfObject()

◆ handleECSTasks()

◆ ignoreUserAbort()

◆ ilClone()

◆ ilCloneDependencies()

◆ ilSoapUtils()

◆ linkNode()

◆ saveTempFileAsMediaObject()

◆ sendMail()

◆ validateXML()