class.ilObjFileDAV.php

Go to the documentation of this file.

<?php
use Sabre\DAV\Exception;
use Sabre\DAV\Exception\Forbidden;
use ILIAS\Filesystem\Stream\Streams;
use ILIAS\ResourceStorage\Manager\Manager;
use ILIAS\ResourceStorage\Consumer\Consumers;

class ilObjFileDAV extends ilObjectDAV implements Sabre\DAV\IFile
{
    protected $resource_manager;
    protected $resource_consumer;
    protected $request;

    protected $versioning_enabled;

    public function __construct(ilObjFile $a_obj, ilWebDAVRepositoryHelper $repo_helper, ilWebDAVObjDAVHelper $dav_helper)
    {
        global $DIC;
        $settings = new ilSetting('webdav');
        $this->resource_manager = $DIC->resourceStorage()->manage();
        $this->resource_consumer = $DIC->resourceStorage()->consume();
        $this->versioning_enabled = (bool) $settings->get('webdav_versioning_enabled', true);
        parent::__construct($a_obj, $repo_helper, $dav_helper);
    }

    public function put($data)
    {
        if ($this->repo_helper->checkAccess('write', $this->getRefId())) {
            if ($this->versioning_enabled === true ||
                $this->obj->getVersion() === '1' && $this->getSize() === 0) {
                // Stolen from ilObjFile->addFileVersion
                return $this->handleFileUpload($data, 'new_version');
            } else {
                return $this->handleFileUpload($data, 'replace');
            }
        }
        throw new Exception\Forbidden("Permission denied. No write access for this file");
    }

    public function get()
    {
        if ($this->repo_helper->checkAccess("read", $this->obj->getRefId())) {
            if ($this->getSize() === 0) {
                return "";
            }

            if (($r_id = $this->obj->getResourceId()) &&
                ($identification = $this->resource_manager->find($r_id))) {
                return $this->resource_consumer->stream($identification)->getStream()->getContents();
            }

            /*
             * @todo: This is legacy and should be removed with ILIAS 8
             */
            if (file_exists($file = $this->getPathToFile())) {
                return fopen($file, 'r');
            }

            throw new Exception\NotFound("File not found");
        }

        throw new Exception\Forbidden("Permission denied. No read access for this file");
    }

    public function getName()
    {
        return ilFileUtils::getValidFilename($this->obj->getTitle());
    }

    public function getContentType()
    {
        return  $this->obj->getFileType();
    }

    public function getETag()
    {
        if (file_exists($path = $this->getPathToFile())) {
            return '"' . sha1(
                fileinode($path) .
                filesize($path) .
                filemtime($path)
            ) . '"';
        }

        if ($this->getSize() > 0) {
            return '"' . sha1(
                $this->getSize() .
                $this->getName() .
                $this->obj->getCreateDate()
            ) . '"';
        }

        return null;
    }

    public function getSize() : int
    {
        return $this->obj->getFileSize();
    }

    public function setName($a_name)
    {
        if ($this->dav_helper->isValidFileNameWithValidFileExtension($a_name)) {
            parent::setName($a_name);
        } else {
            throw new Exception\Forbidden("Invalid file extension");
        }
    }

    public function handleFileUpload($a_data, $a_file_action)
    {
        if ($a_file_action != 'create' && file_exists($this->getPathToFile())) {
            global $DIC;
            $migration = new ilFileObjectToStorageMigrationRunner(
                $DIC->fileSystem()->storage(),
                $DIC->database(),
                rtrim(CLIENT_DATA_DIR, "/") . '/ilFile/migration_log.csv'
            );
            $migration->migrate(new ilFileObjectToStorageDirectory($this->obj->getId(), $this->obj->getDirectory()));
        }

        $size = (int) $this->request->getHeader('Content-Length')[0];

        if ($size === 0 && $this->request->hasHeader('X-Expected-Entity-Length')) {
            $size = $this->request->getHeader('X-Expected-Entity-Length')[0];
        }

        if ($size > ilUtil::getUploadSizeLimitBytes()) {
            throw new Exception\Forbidden('File is too big');
        }

        $stream = Streams::ofResource($a_data);

        if ($a_file_action === 'replace') {
            $this->obj->replaceWithStream($stream, $this->obj->getTitle());
        } else {
            $this->obj->appendStream($stream, $this->obj->getTitle());
        }

        $stream->close();

        // TODO filename is "input" and metadata etc.

        if ($this->obj->update()) {
            $this->createHistoryAndNotificationForObjUpdate($a_file_action);
            ilPreview::createPreview($this->obj, true);
        }

        return $this->getETag();
    }


    protected function getPathToDirectory()
    {
        return $this->obj->getDirectory($this->obj->getVersion());
    }

    protected function getPathToFile()
    {
        // ilObjFile delivers the filename like it was on the upload. But if the file-extension is forbidden, the file
        // will be safed as .sec-file. In this case ->getFileName returns the wrong file name
        $path = $this->getPathToDirectory() . "/" . $this->obj->getFileName();

        // For the case of forbidden file-extensions, ::getValidFilename($path) returns the path with the .sec extension
        return ilFileUtils::getValidFilename($path);
    }

    protected function checkForVirus(string $file_dest_path)
    {
        $vrs = ilUtil::virusHandling($file_dest_path, '', true);
        // If vrs[0] == false -> virus found
        if ($vrs[0] == false) {
            ilLoggerFactory::getLogger('WebDAV')->error(get_class($this) . ' ' . $this->obj->getTitle() . " -> virus found on '$file_dest_path'!");
            throw new Exception\Forbidden('Virus found!');
        }
    }

    protected function createHistoryAndNotificationForObjUpdate($a_action)
    {
        // Add history entry and notification for new file version (stolen from ilObjFile->addFileVersion)
        switch ($a_action) {
            case "new_version":
            case "replace":
                ilHistory::_createEntry($this->obj->getId(), $a_action, $this->obj->getTitle() . "," . $this->obj->getVersion() . "," . $this->obj->getMaxVersion());
                break;
        }

        $this->obj->notifyUpdate($this->obj->getId());
    }

    protected function deleteObjOrVersion()
    {
        if ($this->obj->getVersion() > 1) {
            $version_dir = $this->obj->getDirectory($this->obj->getVersion());
            ilUtil::delDir($version_dir);
        } else {
            $this->obj->deleteVersions();
            $this->obj->delete();
        }
    }
}