class.ilSoapExerciseAdministration.php

Go to the documentation of this file.

<?php

declare(strict_types=1);
/*
 +-----------------------------------------------------------------------------+
 | ILIAS open source                                                           |
 +-----------------------------------------------------------------------------+
 | Copyright (c) 1998-2006 ILIAS open source, University of Cologne            |
 |                                                                             |
 | This program is free software; you can redistribute it and/or               |
 | modify it under the terms of the GNU General Public License                 |
 | as published by the Free Software Foundation; either version 2              |
 | of the License, or (at your option) any later version.                      |
 |                                                                             |
 | This program is distributed in the hope that it will be useful,             |
 | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
 | GNU General Public License for more details.                                |
 |                                                                             |
 | You should have received a copy of the GNU General Public License           |
 | along with this program; if not, write to the Free Software                 |
 | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
 +-----------------------------------------------------------------------------+
*/

include_once './webservice/soap/classes/class.ilSoapAdministration.php';

class ilSoapExerciseAdministration extends ilSoapAdministration
{
    public function addExercise(string $sid, int $target_id, string $exercise_xml)
    {
        $this->initAuth($sid);
        $this->initIlias();

        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
        global $DIC;

        $rbacsystem = $DIC['rbacsystem'];
        $tree = $DIC['tree'];
        $ilLog = $DIC['ilLog'];

        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');
        }

        $allowed_types = array('cat', 'grp', 'crs', 'fold', 'root');
        if (!in_array($target_obj->getType(), $allowed_types)) {
            return $this->raiseError(
                'No valid target type. Target must be reference id of "course, group, category or folder"',
                'Client'
            );
        }

        if (!$rbacsystem->checkAccess('create', $target_id, "exc")) {
            return $this->raiseError('No permission to create exercises in target  ' . $target_id . '!', 'Client');
        }

        // create object, put it into the tree and use the parser to update the settings
        include_once './Modules/Exercise/classes/class.ilObjExercise.php';
        include_once './Modules/Exercise/classes/class.ilExerciseXMLParser.php';
        include_once './Modules/Exercise/exceptions/class.ilExerciseException.php';

        $exercise = new ilObjExercise();
        $exercise->create();
        $exercise->createReference();
        $exercise->putInTree($target_id);
        $exercise->setPermissions($target_id);
        $exercise->saveData();

        // we need this as workaround because file and member objects need to be initialised
        $exercise->read();

        $exerciseXMLParser = new ilExerciseXMLParser($exercise, $exercise_xml);
        try {
            if ($exerciseXMLParser->start()) {
                $exerciseXMLParser->getAssignment()->update();
                return $exercise->update() ? $exercise->getRefId() : -1;
            }
            throw new ilExerciseException("Could not parse XML");
        } catch (ilExerciseException $exception) {
            return $this->raiseError(
                $exception->getMessage(),
                $exception->getCode() == ilExerciseException::$ID_MISMATCH ? "Client" : "Server"
            );
        }
    }

    public function updateExercise(string $sid, int $requested_ref_id, string $exercise_xml)
    {
        $this->initAuth($sid);
        $this->initIlias();

        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
        global $DIC;

        $rbacsystem = $DIC['rbacsystem'];
        $tree = $DIC['tree'];
        $ilLog = $DIC['ilLog'];

        if (ilObject::_isInTrash($requested_ref_id)) {
            return $this->raiseError(
                'Cannot perform update since exercise has been deleted.',
                'CLIENT_OBJECT_DELETED'
            );
        }

        if (!$obj_id = ilObject::_lookupObjectId($requested_ref_id)) {
            return $this->raiseError(
                'No exercise found for id: ' . $requested_ref_id,
                'CLIENT_OBJECT_NOT_FOUND'
            );
        }

        $permission_ok = false;
        foreach ($ref_ids = ilObject::_getAllReferences($obj_id) as $ref_id) {
            if ($rbacsystem->checkAccess('edit', $ref_id)) {
                $permission_ok = true;
                break;
            }
        }

        if (!$permission_ok) {
            return $this->raiseError(
                'No permission to edit the exercise with id: ' . $requested_ref_id,
                'Server'
            );
        }

        $exercise = ilObjectFactory::getInstanceByObjId($obj_id, false);

        if (!is_object($exercise) || $exercise->getType() !== "exc") {
            return $this->raiseError(
                'Wrong obj id or type for exercise with id ' . $requested_ref_id,
                'CLIENT_OBJECT_NOI_FOUND'
            );
        }

        include_once './Modules/Exercise/classes/class.ilExerciseXMLParser.php';
        include_once './Modules/Exercise/exceptions/class.ilExerciseException.php';
        $exerciseXMLParser = new ilExerciseXMLParser($exercise, $exercise_xml, $obj_id);

        try {
            if ($exerciseXMLParser->start()) {
                $exerciseXMLParser->getAssignment()->update();
                return $exercise->update();
            }
            throw new ilExerciseException("Could not parse XML");
        } catch (ilExerciseException $exception) {
            return $this->raiseError(
                $exception->getMessage(),
                $exception->getCode() == ilExerciseException::$ID_MISMATCH ? "Client" : "Server"
            );
        }
    }

    public function getExerciseXML(string $sid, int $requested_ref_id, int $attachFileContentsMode)
    {
        $this->initAuth($sid);
        $this->initIlias();

        if (!$this->checkSession($sid)) {
            return $this->raiseError($this->getMessage(), $this->getMessageCode());
        }
        if (!$requested_ref_id) {
            return $this->raiseError(
                'No ref id given. Aborting!',
                'Client'
            );
        }
        global $DIC;

        $rbacsystem = $DIC['rbacsystem'];
        $tree = $DIC['tree'];
        $ilLog = $DIC['ilLog'];

        // get obj_id
        if (!$obj_id = ilObject::_lookupObjectId($requested_ref_id)) {
            return $this->raiseError(
                'No exercise found for id: ' . $requested_ref_id,
                'Client'
            );
        }

        if (ilObject::_isInTrash($requested_ref_id)) {
            return $this->raiseError("Parent with ID $requested_ref_id has been deleted.", 'Client');
        }

        $permission_ok = false;
        $write_permission_ok = false;
        foreach ($ref_ids = ilObject::_getAllReferences($obj_id) as $ref_id) {
            if ($rbacsystem->checkAccess('write', $ref_id)) {  // #14299
                $write_permission_ok = true;
                break;
            }
            if ($rbacsystem->checkAccess('read', $ref_id)) {
                $permission_ok = true;
                break;
            }
        }

        if (!$permission_ok && !$write_permission_ok) {
            return $this->raiseError(
                'No permission to edit the object with id: ' . $requested_ref_id,
                'Server'
            );
        }

        $exercise = ilObjectFactory::getInstanceByObjId($obj_id, false);

        if (!is_object($exercise) || $exercise->getType() !== "exc") {
            return $this->raiseError(
                'Wrong obj id or type for exercise with id ' . $requested_ref_id,
                'Server'
            );
        }

        include_once './Modules/Exercise/classes/class.ilExerciseXMLWriter.php';

        $xmlWriter = new ilExerciseXMLWriter();
        $xmlWriter->setExercise($exercise);
        $xmlWriter->setAttachMembers($write_permission_ok);
        $xmlWriter->setAttachFileContents($attachFileContentsMode);
        $xmlWriter->start();

        return $xmlWriter->getXML();
    }
}