class.ilSoapUtils.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
class ilSoapUtils extends ilSoapAdministration
{
    public function ignoreUserAbort(): int
    {
        return ignore_user_abort(true);
    }
 
    public function disableSOAPCheck(): void
    {
        $this->soap_check = false;
    }
 
    public function saveTempFileAsMediaObject(string $sid, string $name, string $tmp_name)
    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
 
        return ilObjMediaObject::_saveTempFileAsMediaObject($name, $tmp_name);
    }
 
    public function getMobsOfObject(string $sid, string $a_type, int $a_id)
    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
 
        return ilObjMediaObject::_getMobsOfObject($a_type, $a_id);
    }
 
    public function ilCloneDependencies(string $sid, int $copy_identifier, bool $is_initialized = false)
    {
        if (!$is_initialized) {
            $this->initAuth($sid);
            $this->initIlias();
 
            if (!$this->checkSession($sid)) {
                return $this->raiseError($this->getMessage(), $this->getMessageCode());
            }
        }
 
        global $DIC;
 
        $ilLog = $DIC['ilLog'];
        $ilUser = $DIC['ilUser'];
 
        $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()) === null) {
            $cp_options->deleteAll();
            ilLoggerFactory::getLogger('obj')->info('Finished copy step 2. Copy completed');
            return true;
        }
 
        // Check options of this node
        $options = $cp_options->getOptions((int) $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(': Start cloning dependencies for node: ' . $node['obj_id'] . ', ' . $node['title'] . ', ' . $node['type']);
                $this->cloneDependencies($node, $cp_options);
                $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;
    }
 
    public function ilClone(string $sid, int $copy_identifier)
    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            ilLoggerFactory::getLogger('obj')->error('Object cloning failed. Invalid session given: ' . $this->getMessage());
        }
 
        global $DIC;
 
        $ilUser = $DIC->user();
 
        $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()) === null) {
            ilLoggerFactory::getLogger('obj')->info('Finished copy step 1. Starting copying of object dependencies...');
            return $this->ilCloneDependencies($sid, $copy_identifier, true);
        }
        // Check options of this node
        $options = $cp_options->getOptions((int) $node['child']);
 
        $action = $this->rewriteActionForNode($cp_options, $node, $options);
 
        $new_ref_id = 0;
        switch ($action) {
            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;
 
            case \ilCopyWizardOptions::COPY_WIZARD_LINK_TO_TARGET:
                ilLoggerFactory::getLogger('obj')->debug('Start creating internal link for: ' . $node['obj_id'] . ', ' . $node['title'] . ', ' . $node['type']);
                $new_ref_id = $this->internalLinkNode($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;
    }
 
    protected function rewriteActionForNode(ilCopyWizardOptions $cpo, array $node, array $options): int
    {
        $default_mode = \ilCopyWizardOptions::COPY_WIZARD_UNDEFINED;
        if (array_key_exists('type', $options)) {
            $default_mode = (int) $options['type'];
        }
        if (
            array_key_exists('child', $node) &&
            $cpo->isRootNode((int) $node['child'])
        ) {
            return $default_mode;
        }
 
        if ($this->findMappedReferenceForNode($cpo, $node) && $default_mode == \ilCopyWizardOptions::COPY_WIZARD_COPY) {
            return \ilCopyWizardOptions::COPY_WIZARD_LINK_TO_TARGET;
        }
        return $default_mode;
    }
 
    protected function findMappedReferenceForNode(\ilCopyWizardOptions $cpo, array $node): ?int
    {
        global $DIC;
 
        $logger = $DIC->logger()->obj();
        $tree = $DIC->repositoryTree();
        $root = $cpo->getRootNode();
        $obj_id = (int) $node['obj_id'];
 
        $mappings = $cpo->getMappings();
        foreach (\ilObject::_getAllReferences($obj_id) as $ref_id => $also_ref_id) {
            $logger->debug('Validating node: ' . $ref_id . ' and root ' . $root);
            $logger->dump($DIC->repositoryTree()->getRelation($ref_id, $root));
 
            if ($DIC->repositoryTree()->getRelation($ref_id, $root) !== \ilTree::RELATION_CHILD) {
                $logger->debug('Ignoring non child relation');
                continue;
            }
            // check if mapping is already available
            $logger->dump($mappings);
            if (array_key_exists($ref_id, $mappings)) {
                $logger->debug('Found existing mapping for linked node.');
                return $mappings[$ref_id];
            }
        }
        $logger->info('Nothing found');
        return null;
    }
 
    private function callNextNode(string $sid, ilCopyWizardOptions $cp_options): void
    {
        global $DIC;
 
        $ilLog = $DIC->logger()->obj();
 
        $cp_options->dropFirstNode();
        if ($cp_options->isSOAPEnabled()) {
            // Start next soap call
            $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();
            $res = ilSoapFunctions::ilClone($sid, $cp_options->getCopyId());
        }
    }
 
    private function callNextDependency(string $sid, ilCopyWizardOptions $cp_options): void
    {
        $cp_options->dropFirstDependenciesNode();
 
        if ($cp_options->isSOAPEnabled()) {
            // Start next soap call
            $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();
            $res = ilSoapFunctions::ilCloneDependencies($sid, $cp_options->getCopyId());
        }
    }
 
    private function cloneNode(array $node, ilCopyWizardOptions $cp_options): int
    {
        global $DIC;
 
        $ilLog = $DIC['ilLog'];
        $tree = $DIC['tree'];
        $ilAccess = $DIC['ilAccess'];
        $rbacreview = $DIC['rbacreview'];
        $source_id = (int) $node['child'];
        $parent_id = (int) $node['parent'];
        $options = $cp_options->getOptions((int) $node['child']);
        $mappings = $cp_options->getMappings();
 
        if (!$ilAccess->checkAccess('copy', '', (int) $node['child'])) {
            ilLoggerFactory::getLogger('obj')->error('No copy permission granted: ' . $source_id . ', ' . $node['title'] . ', ' . $node['type']);
            return 0;
        }
        if (!isset($mappings[$parent_id])) {
            ilLoggerFactory::getLogger('obj')->info('Omitting node ' . $source_id . ', ' . $node['title'] . ', ' . $node['type'] . '. No target found.');
            return 0;
        }
        $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 0;
        }
 
        $orig = ilObjectFactory::getInstanceByRefId($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 0;
        }
 
        // rbac log
        $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, true);
 
        // Finally add new mapping entry
        $cp_options->appendMapping($source_id, $new_obj->getRefId());
        return $new_obj->getRefId();
    }
 
    private function cloneDependencies(array $node, ilCopyWizardOptions $cp_options): void
    {
        global $DIC;
 
        $ilLog = $DIC['ilLog'];
 
        $source_id = (int) $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;
        }
        $target_id = $mappings[$source_id];
 
        $orig = ilObjectFactory::getInstanceByRefId($source_id);
        $orig->cloneDependencies($target_id, $cp_options->getCopyId());
    }
 
    private function internalLinkNode(array $node, ilCopyWizardOptions $cp_options): int
    {
        global $DIC;
 
        $ilAccess = $DIC->access();
        $logger = $DIC->logger()->obj();
        $rbacreview = $DIC->rbac()->review();
        $tree = $DIC->repositoryTree();
        $mappings = $cp_options->getMappings();
 
        $source_id = $this->findMappedReferenceForNode($cp_options, $node);
        try {
            $orig = ilObjectFactory::getInstanceByRefId((int) $source_id);
            if (!$orig instanceof \ilObject) {
                $logger->error('Cannot create object instance.');
                return 0;
            }
        } catch (\ilObjectNotFoundException $e) {
            $logger->error('Cannot create object instance for ref_id: ' . $source_id);
            $logger->error($e->getMessage());
            return 0;
        }
 
        // target (parent id) is the mapped parent id of the current node
        $node_parent = $node['parent'];
        if (!array_key_exists($node_parent, $mappings)) {
            $logger->error('Cannot new parent id for node: ' . $node['parent']);
            return 0;
        }
        $parent_id = $mappings[$node_parent];
 
        $new_ref_id = $orig->createReference();
        $orig->putInTree($parent_id);
        $orig->setPermissions($parent_id);
 
        if (!($new_ref_id)) {
            $logger->warning('Creating internal link failed.');
            return 0;
        }
 
        // rbac log
        $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, true);
 
        // Finally add new mapping entry
        $cp_options->appendMapping($node['child'], $new_ref_id);
 
        $logger->notice('Added mapping for ' . $node['child'] . ' ' . $new_ref_id);
        return $new_ref_id;
    }
 
    private function linkNode(array $node, ilCopyWizardOptions $cp_options): int
    {
        global $DIC;
 
        $ilLog = $DIC['ilLog'];
        $ilAccess = $DIC['ilAccess'];
        $rbacreview = $DIC['rbacreview'];
 
        $source_id = (int) $node['child'];
        $parent_id = (int) $node['parent'];
        $options = $cp_options->getOptions((int) $node['child']);
        $mappings = $cp_options->getMappings();
 
        if (!$ilAccess->checkAccess('delete', '', (int) $node['child'])) {
            ilLoggerFactory::getLogger('obj')->warning('No delete permission granted: ' . $source_id . ', ' . $node['title'] . ', ' . $node['type']);
            return 0;
        }
        if (!isset($mappings[$parent_id])) {
            ilLoggerFactory::getLogger('obj')->warning('Omitting node ' . $source_id . ', ' . $node['title'] . ', ' . $node['type'] . '. No target found.');
            return 0;
        }
        $target_id = $mappings[$parent_id];
 
        $orig = ilObjectFactory::getInstanceByRefId($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 0;
        }
 
        // rbac log
        $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, true);
 
        // Finally add new mapping entry
        $cp_options->appendMapping($source_id, $new_ref_id);
        return $new_ref_id;
    }
 
    public function deleteExpiredDualOptInUserObjects(string $sid, int $usr_id): bool
    {
        $this->initAuth($sid);
        $this->initIlias();
 
        // Session check not possible -> anonymous user is the trigger
 
        global $DIC;
 
        $db = $DIC->database();
        $logger = $DIC->logger()->user();
 
        $logger->debug(
            'Started deletion of inactive user objects with expired confirmation hash values (dual opt in) ...'
        );
        $lifetime = (new ilRegistrationSettings())->getRegistrationHashLifetime();
 
        if ($lifetime <= 0) {
            $logger->debug('Registration hash lifetime is <= 0, kipping deletion.');
            return true;
        }
 
        $utc_clock = (new \ILIAS\Data\Factory())->clock()->utc();
        $now = $utc_clock->now();
        $cutoff = $now->sub(new DateInterval('PT' . $lifetime . 'S'));
        $formatted_cutoff = $cutoff->format(ilObjUser::DATABASE_DATE_FORMAT);
 
        // Fetch only candidates that must be deleted, prioritize the triggering user
        $query = '
        SELECT usr_id, create_date
          FROM usr_data
         WHERE active = 0
           AND reg_hash IS NOT NULL
           AND reg_hash != \'\'
           AND ' . $db->in('usr_id', [ANONYMOUS_USER_ID, SYSTEM_USER_ID], true, ilDBConstants::T_INTEGER) . '
           AND create_date < %s
         ORDER BY (CASE WHEN usr_id = %s THEN 0 ELSE 1 END), create_date';
 
        $res = $db->queryF(
            $query,
            [ilDBConstants::T_TIMESTAMP, ilDBConstants::T_INTEGER],
            [$formatted_cutoff, $usr_id]
        );
 
        $logger->info(sprintf(
            '%d inactive user objects eligible for deletion found (cutoff: %s, lifetime: %d s).',
            $db->numRows($res),
            $cutoff->format(DateTimeInterface::ATOM),
            $lifetime
        ));
 
        $num_deleted_users = 0;
        while ($row = $db->fetchAssoc($res)) {
            $uid = (int) $row['usr_id'];
 
            $user = ilObjectFactory::getInstanceByObjId($uid, false);
            if (!($user instanceof ilObjUser)) {
                continue;
            }
 
            $created = DateTimeImmutable::createFromFormat(
                ilObjUser::DATABASE_DATE_FORMAT,
                (string) $row['create_date'],
                new DateTimeZone('UTC')
            );
 
            $logger->info(sprintf(
                'Deleting user (login: %s | id: %d) – expired dual opt-in (created: %s, cutoff: %s, lifetime: %d s)',
                $user->getLogin(),
                $uid,
                $created ? $created->format(DateTimeInterface::ATOM) : '-',
                $cutoff->format(DateTimeInterface::ATOM),
                $lifetime
            ));
 
            $user->delete();
            ++$num_deleted_users;
        }
 
        $logger->info(sprintf(
            '%d inactive user objects with expired confirmation hash values (dual opt-in) deleted.',
            $num_deleted_users
        ));
 
        return true;
    }
}