class.ilSoapCourseAdministration.php

Go to the documentation of this file.

<?php
 
class ilSoapCourseAdministration extends ilSoapAdministration
{
    public const int MEMBER = 1;
    public const int TUTOR = 2;
    public const int ADMIN = 4;
    public const int OWNER = 8;
 
    public function addCourse(string $sid, int $target_id, string $crs_xml)
    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
 
        global $DIC;
 
        $rbacsystem = $DIC['rbacsystem'];
 
        if (!$target_obj = ilObjectFactory::getInstanceByRefId($target_id, false)) {
            return $this->raiseError('No valid target given.', 'Client');
        }
 
        if (ilObject::_isInTrash($target_id)) {
            return $this->raiseError("Parent with ID $target_id has been deleted.", 'CLIENT_OBJECT_DELETED');
        }
 
        if (!$rbacsystem->checkAccess('create', $target_id, 'crs')) {
            return $this->raiseError('Check access failed. No permission to create courses', 'Server');
        }
 
        $newObj = new ilObjCourse();
        $newObj->setType('crs');
        $newObj->setTitle('dummy');
        $newObj->setDescription("");
        $newObj->create(); // true for upload
        $newObj->createReference();
        $newObj->putInTree($target_id);
        $newObj->setPermissions($target_id);
 
        $xml_parser = new ilCourseXMLParser($newObj);
        $xml_parser->setMode(ilCourseXMLParser::MODE_SOAP);
        $xml_parser->setXMLContent($crs_xml);
        $xml_parser->startParsing();
        return $newObj->getRefId() ?: "0";
    }
 
    public function deleteCourse(string $sid, int $course_id)
    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
 
        global $DIC;
 
        $rbacsystem = $DIC['rbacsystem'];
 
        if (ilObject::_lookupType(ilObject::_lookupObjId($course_id)) !== 'crs') {
            $ref_ids = ilObject::_getAllReferences($course_id);
            $course_id = end($ref_ids);
            if (ilObject::_lookupType(ilObject::_lookupObjId($course_id)) !== 'crs') {
                return $this->raiseError(
                    'Invalid course id. Object with id "' . $course_id . '" is not of type "course"',
                    'Client'
                );
            }
        }
 
        if (!$rbacsystem->checkAccess('delete', $course_id)) {
            return $this->raiseError('Check access failed. No permission to delete course', 'Server');
        }
 
        global $DIC;
        $tree = $DIC->repositoryTree();
        $user = $DIC->user();
        $rbacadmin = $DIC['rbacadmin'];
        $log = $DIC['log'];
 
        if ($tree->isDeleted($course_id)) {
            return $this->raiseError('Node already deleted', 'Server');
        }
 
        $subnodes = $tree->getSubTree($tree->getNodeData($course_id));
        foreach ($subnodes as $subnode) {
            $rbacadmin->revokePermission($subnode["child"]);
        }
        if (!$tree->moveToTrash($course_id, true, $user->getId())) {
            return $this->raiseError('Node already deleted', 'Client');
        }
 
        $log->write("SOAP ilObjectGUI::confirmedDeleteObject(), moved ref_id " . $course_id . " to trash");
        return true;
    }
 
    public function assignCourseMember(
        string $sid,
        int $course_id,
        int $user_id,
        string $type,
        ?bool $notification = null,
        ?bool $contact_person = null,
        ?bool $blocked = null
    ) {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
 
        global $DIC;
 
        $rbacsystem = $DIC['rbacsystem'];
 
        if (ilObject::_lookupType(ilObject::_lookupObjId($course_id)) !== 'crs') {
            $ref_ids = ilObject::_getAllReferences($course_id);
            $course_id = end($ref_ids);
            if (ilObject::_lookupType(ilObject::_lookupObjId($course_id)) !== 'crs') {
                return $this->raiseError(
                    'Invalid course id. Object with id "' . $course_id . '" is not of type "course"',
                    'Client'
                );
            }
        }
 
        if (!$rbacsystem->checkAccess('manage_members', $course_id)) {
            return $this->raiseError('Check access failed. No permission to write to course', 'Server');
        }
 
        if (ilObject::_lookupType($user_id) !== 'usr') {
            return $this->raiseError('Invalid user id. User with id "' . $user_id . ' does not exist', 'Client');
        }
        $valid_roles = [
            'Admin' => ilParticipants::IL_CRS_ADMIN,
            'Tutor' => ilParticipants::IL_CRS_TUTOR,
            'Member' => ilParticipants::IL_CRS_MEMBER
        ];
        if (!isset($valid_roles[$type])) {
            return $this->raiseError('Invalid type. Must be "Admin", "Tutor", or "Member"', 'Client');
        }
 
        if (!$tmp_course = ilObjectFactory::getInstanceByRefId($course_id, false)) {
            return $this->raiseError('Cannot create course instance!', 'Server');
        }
 
        if (!$tmp_user = ilObjectFactory::getInstanceByObjId($user_id, false)) {
            return $this->raiseError('Cannot create user instance!', 'Server');
        }
 
        $course_members = ilCourseParticipants::_getInstanceByObjId($tmp_course->getId());
 
        $course_members->add($tmp_user->getId(), $valid_roles[$type]);
 
        $course_members->sendNotification(
            ilCourseMembershipMailNotification::TYPE_ADMISSION_MEMBER,
            $tmp_user->getId()
        );
 
        if ($type === 'Admin' || $type === 'Tutor') {
            if ($notification !== null) {
                $course_members->updateNotification($tmp_user->getId(), $notification);
            }
 
            if ($contact_person !== null) {
                $course_members->updateContact($tmp_user->getId(), $contact_person);
            }
        } elseif ($type === "Member" && $blocked !== null) {
            $course_members->updateBlocked($tmp_user->getId(), $blocked);
        }
        return true;
    }
 
    public function excludeCourseMember(string $sid, int $course_id, int $user_id)
    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
 
        global $DIC;
 
        $rbacsystem = $DIC['rbacsystem'];
 
        if (ilObject::_lookupType(ilObject::_lookupObjId($course_id)) !== 'crs') {
            $ref_ids = ilObject::_getAllReferences($course_id);
            $course_id = end($ref_ids);
            if (ilObject::_lookupType(ilObject::_lookupObjId($course_id)) !== 'crs') {
                return $this->raiseError(
                    'Invalid course id. Object with id "' . $course_id . '" is not of type "course"',
                    'Client'
                );
            }
        }
 
        if (ilObject::_lookupType($user_id) !== 'usr') {
            return $this->raiseError('Invalid user id. User with id "' . $user_id . ' does not exist', 'Client');
        }
 
        if (!$tmp_course = ilObjectFactory::getInstanceByRefId($course_id, false)) {
            return $this->raiseError('Cannot create course instance!', 'Server');
        }
 
        if (!$rbacsystem->checkAccess('manage_members', $course_id)) {
            return $this->raiseError('Check access failed. No permission to write to course', 'Server');
        }
 
        $course_members = ilCourseParticipants::_getInstanceByObjId($tmp_course->getId());
        if (!$course_members->checkLastAdmin(array($user_id))) {
            return $this->raiseError('Cannot deassign last administrator from course', 'Server');
        }
        $course_members->delete($user_id);
        return true;
    }
 
    public function isAssignedToCourse(string $sid, int $course_id, int $user_id)
    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
 
        global $DIC;
 
        $rbacsystem = $DIC['rbacsystem'];
 
        if (ilObject::_lookupType(ilObject::_lookupObjId($course_id)) !== 'crs') {
            $ref_ids = ilObject::_getAllReferences($course_id);
            $course_id = end($ref_ids);
            if (ilObject::_lookupType(ilObject::_lookupObjId($course_id)) !== 'crs') {
                return $this->raiseError(
                    'Invalid course id. Object with id "' . $course_id . '" is not of type "course"',
                    'Client'
                );
            }
        }
 
        if (ilObject::_lookupType($user_id) !== 'usr') {
            return $this->raiseError('Invalid user id. User with id "' . $user_id . ' does not exist', 'Client');
        }
 
        if (!$tmp_course = ilObjectFactory::getInstanceByRefId($course_id, false)) {
            return $this->raiseError('Cannot create course instance!', 'Server');
        }
 
        if (!$rbacsystem->checkAccess('manage_members', $course_id)) {
            return $this->raiseError('Check access failed. No permission to write to course', 'Server');
        }
 
        $crs_members = ilCourseParticipants::_getInstanceByObjId($tmp_course->getId());
 
        if ($crs_members->isAdmin($user_id)) {
            return ilParticipants::IL_CRS_ADMIN;
        }
        if ($crs_members->isTutor($user_id)) {
            return ilParticipants::IL_CRS_TUTOR;
        }
        if ($crs_members->isMember($user_id)) {
            return ilParticipants::IL_CRS_MEMBER;
        }
        return "0";
    }
 
    public function getCourseXML(string $sid, int $course_id)
    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
 
        global $DIC;
 
        $rbacsystem = $DIC['rbacsystem'];
 
        $tmp_course = $this->checkObjectAccess($course_id, ['crs'], "read", true);
        if ($this->isFault($tmp_course)) {
            return $tmp_course;
        }
 
        $xml_writer = new ilCourseXMLWriter($tmp_course);
        $xml_writer->start();
        return $xml_writer->getXML();
    }
 
    public function updateCourse(string $sid, int $course_id, string $xml)
    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
 
        global $DIC;
 
        $rbacsystem = $DIC['rbacsystem'];
 
        if (ilObject::_lookupType(ilObject::_lookupObjId($course_id)) !== 'crs') {
            $ref_ids = ilObject::_getAllReferences($course_id);
            $course_id = end($ref_ids);
            if (ilObject::_lookupType(ilObject::_lookupObjId($course_id)) !== 'crs') {
                return $this->raiseError(
                    'Invalid course id. Object with id "' . $course_id . '" is not of type "course"',
                    'Client'
                );
            }
        }
 
        if (!$tmp_course = ilObjectFactory::getInstanceByRefId($course_id, false)) {
            return $this->raiseError('Cannot create course instance!', 'Server');
        }
 
        if (!$rbacsystem->checkAccess('write', $course_id)) {
            return $this->raiseError('Check access failed. No permission to write course', 'Server');
        }
 
        ilCourseParticipants::_deleteAllEntries($tmp_course->getId());
 
        ilCourseWaitingList::_deleteAll($tmp_course->getId());
 
 
        $xml_parser = new ilCourseXMLParser($tmp_course);
        $xml_parser->setMode(ilCourseXMLParser::MODE_SOAP);
        $xml_parser->setXMLContent($xml);
        $xml_parser->startParsing();
        $tmp_course->MDUpdateListener('General');
 
        return true;
    }
 
    public function getCoursesForUser(string $sid, string $parameters)
    {
        $this->initAuth($sid);
        $this->initIlias();
 
        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
 
        global $DIC;
 
        $rbacreview = $DIC['rbacreview'];
        $ilObjDataCache = $DIC['ilObjDataCache'];
        $tree = $DIC['tree'];
 
        $parser = new ilXMLResultSetParser($parameters);
        try {
            $parser->startParsing();
        } catch (ilSaxParserException $exception) {
            return $this->raiseError($exception->getMessage(), "Client");
        }
        $xmlResultSet = $parser->getXMLResultSet();
 
        if (!$xmlResultSet->hasColumn("user_id")) {
            return $this->raiseError("parameter user_id is missing", "Client");
        }
 
        if (!$xmlResultSet->hasColumn("status")) {
            return $this->raiseError("parameter status is missing", "Client");
        }
 
        $user_id = (int) $xmlResultSet->getValue(0, "user_id");
        $status = (int) $xmlResultSet->getValue(0, "status");
 
        $ref_ids = array();
 
        if (
            self::MEMBER == ($status & self::MEMBER) ||
            self::TUTOR == ($status & self::TUTOR) ||
            self::ADMIN == ($status & self::ADMIN)
        ) {
            foreach ($rbacreview->assignedRoles($user_id) as $role_id) {
                if ($role = ilObjectFactory::getInstanceByObjId($role_id, false)) {
                    #echo $role->getType();
                    if ($role->getType() !== "role") {
                        continue;
                    }
                    if ($role->getParent() == ROLE_FOLDER_ID) {
                        continue;
                    }
                    $role_title = $role->getTitle();
 
                    if ($ref_id = ilUtil::__extractRefId($role_title)) {
                        if (!ilObject::_exists($ref_id, true) || ilObject::_isInTrash($ref_id)) {
                            continue;
                        }
 
                        if (
                            self::MEMBER == ($status & self::MEMBER) && strpos(
                                $role_title,
                                "member"
                            ) !== false
                        ) {
                            $ref_ids[] = $ref_id;
                        } elseif (
                            self::TUTOR == ($status & self::TUTOR) && strpos(
                                $role_title,
                                "tutor"
                            ) !== false
                        ) {
                            $ref_ids[] = $ref_id;
                        } elseif (
                            self::ADMIN == ($status & self::ADMIN) && strpos(
                                $role_title,
                                "admin"
                            ) !== false
                        ) {
                            $ref_ids[] = $ref_id;
                        } elseif (($status & self::OWNER) == self::OWNER && $ilObjDataCache->lookupOwner($ilObjDataCache->lookupObjId($ref_id)) == $user_id) {
                            $ref_ids[] = $ref_id;
                        }
                    }
                }
            }
        }
        if (($status & self::OWNER) == self::OWNER) {
            $owned_objects = ilObjectFactory::getObjectsForOwner("crs", $user_id);
            $refs = [];
            foreach ($owned_objects as $obj_id) {
                $allrefs = ilObject::_getAllReferences($obj_id);
                foreach ($allrefs as $r) {
                    if ($tree->isDeleted($r)) {
                        continue;
                    }
                    if ($tree->isInTree($r)) {
                        $refs[] = $r;
                    }
                }
                if (count($refs) > 0) {
                    $ref_ids[] = array_pop($refs);
                }
            }
        }
        $ref_ids = array_unique($ref_ids);
 
        $ref_ids = array_unique($ref_ids);
 
        $xmlResultSet = new ilXMLResultSet();
        $xmlResultSet->addColumn("ref_id");
        $xmlResultSet->addColumn("xml");
        $xmlResultSet->addColumn("parent_ref_id");
 
        global $DIC;
 
        $ilUser = $DIC['ilUser'];
        //#18004
        // Enable to see own participations by reducing the needed permissions
        $permission = $user_id === $ilUser->getId() ? 'read' : 'write';
 
        foreach ($ref_ids as $course_id) {
            $course_obj = $this->checkObjectAccess($course_id, ['crs'], $permission, true);
            if ($course_obj instanceof ilObjCourse) {
                $row = new ilXMLResultSetRow();
                $row->setValue("ref_id", $course_id);
                $xmlWriter = new ilCourseXMLWriter($course_obj);
                $xmlWriter->setAttachUsers(false);
                $xmlWriter->start();
                $row->setValue("xml", $xmlWriter->getXML());
                $row->setValue("parent_ref_id", $tree->getParentId($course_id));
                $xmlResultSet->addRow($row);
            }
        }
        $xmlResultSetWriter = new ilXMLResultSetWriter($xmlResultSet);
        $xmlResultSetWriter->start();
        return $xmlResultSetWriter->getXML();
    }
}