class.ilSoapFileAdministration.php

Go to the documentation of this file.

<?php
/*
 +-----------------------------------------------------------------------------+
 | 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. |
 +-----------------------------------------------------------------------------+
*/

class ilSoapFileAdministration extends ilSoapAdministration
{
    public function addFile(string $sid, int $target_id, string $file_xml)
    {
        $this->initAuth($sid);
        $this->initIlias();

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

        $ilAccess = $DIC['ilAccess'];

        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_TARGET_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 (!$ilAccess->checkAccess('create', '', $target_id, "file")) {
            return $this->raiseError('No permission to create Files in target  ' . $target_id . '!', 'Client');
        }

        // create object, put it into the tree and use the parser to update the settings

        $file = new ilObjFile();
        try {
            $fileXMLParser = new ilFileXMLParser($file, $file_xml);

            if ($fileXMLParser->start()) {
                global $DIC;

                $ilLog = $DIC['ilLog'];

                $ilLog->write(__METHOD__ . ': File type: ' . $file->getFileType());

                $file->create();
                $file->createReference();
                $file->putInTree($target_id);
                $file->setPermissions($target_id);

                // we now can save the file contents since we know the obj id now.
                $fileXMLParser->setFileContents();
                #$file->update();

                return $file->getRefId();
            }

            return $this->raiseError("Could not add file", "Server");
        } catch (ilFileException $exception) {
            return $this->raiseError(
                $exception->getMessage(),
                $exception->getCode() == ilFileException::$ID_MISMATCH ? "Client" : "Server"
            );
        }
    }

    public function updateFile(string $sid, int $requested_ref_id, string $file_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'];
        $ilAccess = $DIC['ilAccess'];

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

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

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

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

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

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

        $fileXMLParser = new ilFileXMLParser($file, $file_xml, $obj_id);

        try {
            if ($fileXMLParser->start()) {
                $fileXMLParser->updateFileContents();

                return $file->update();
            }
        } catch (ilFileException $exception) {
            return $this->raiseError(
                $exception->getMessage(),
                $exception->getCode() == ilFileException::$ID_MISMATCH ? "Client" : "Server"
            );
        }
        return false;
    }

    public function getFileXML(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 > 0)) {
            return $this->raiseError(
                'No ref id given. Aborting!',
                'Client'
            );
        }

        global $DIC;

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

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

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

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

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

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

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


        $xmlWriter = new ilFileXMLWriter();
        $xmlWriter->setFile($file);
        $xmlWriter->setAttachFileContents($attachFileContentsMode);
        $xmlWriter->start();

        return $xmlWriter->getXML();
    }
}