class.ilObjFileDAV.php

Go to the documentation of this file.

<?php

use ILIAS\UI\NotImplementedException;
use Sabre\DAV\Exception;

require_once 'Modules/File/classes/class.ilObjFile.php';

class ilObjFileDAV extends ilObjectDAV implements Sabre\DAV\IFile
{
    protected $obj;

    public function __construct(ilObjFile $a_obj, ilWebDAVRepositoryHelper $repo_helper, ilWebDAVObjDAVHelper $dav_helper)
    {
        parent::__construct($a_obj, $repo_helper, $dav_helper);
    }

    public function put($data)
    {
        if ($this->repo_helper->checkAccess('write', $this->getRefId())) {
            $this->setObjValuesForNewFileVersion();
            $this->handleFileUpload($data);
            return $this->getETag();
        }
        throw new Exception\Forbidden("Permission denied. No write access for this file");
    }

    public function get()
    {
        if ($this->repo_helper->checkAccess("read", $this->obj->getRefId())) {
            $file = $this->getPathToFile();
            if (file_exists($file)) {
                return fopen($file, 'r');
            } else {
                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->guessFileType();
    }
    
    public function getETag()
    {
        if (file_exists($path = $this->getPathToFile())) {
            return '"' . sha1(
                fileinode($path) .
                filesize($path) .
                filemtime($path)
            ) . '"';
        }
        
        return null;
    }
    
    public function getSize()
    {
        if (file_exists($this->getPathToFile())) {
            return $this->obj->getFileSize();
        }
        return 0;
    }

    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)
    {
        // Set name for uploaded file because due to the versioning, the title can change for different versions. This setter-call here
        // ensures that the uploaded file is saved with the title of the object. This obj->setFileName() has to be called
        // before $this->getPathToFile(). Otherwise, the file could be saved under the wrong filename.
        $this->obj->setFileName($this->getName());
        $file_dest_path = $this->getPathToFile();

        // If dir does not exist yet -> create it
        if (!file_exists($file_dest_path)) {
            ilUtil::makeDirParents($this->getPathToDirectory());
        }
        
        // File upload
        if (is_resource($a_data)) {
            $written_length = $this->fileUploadWithStream($a_data, $file_dest_path);
        } elseif (is_string($a_data)) {
            $written_length = $this->fileUploadWithString($a_data, $file_dest_path);
        } else {
            ilLoggerFactory::getLogger('WebDAV')->warning(get_class($this) . ' ' . $this->obj->getTitle() . " -> invalid upload data sent");
            throw new Exception\BadRequest('Invalid put data sent');
        }
        
        // Security checks
        $this->checkForVirus($file_dest_path);

        // Set last meta data
        include_once("./Services/Utilities/classes/class.ilMimeTypeUtil.php");
        $this->obj->setFileType(ilMimeTypeUtil::lookupMimeType($file_dest_path));
        $this->obj->setFileSize($written_length);
        if ($this->obj->update() && $this->obj->getMaxVersion() > 1) {
            $this->createHistoryAndNotificationForObjUpdate();
        }
    }

    protected function fileUploadWithStream($a_data, string $file_dest_path)
    {
        try {
            $written_length = 0;
            $write_stream = fopen($file_dest_path, 'w');
            while (!feof($a_data)) {
                if (false === ($written = fwrite($write_stream, fread($a_data, 4096)))) {
                    fclose($write_stream);
                    throw new Exception\Forbidden('Forbidden to write file');
                }
                $written_length += $written;
            }
        } catch (Exception $e) {
            ilLoggerFactory::getLogger('WebDAV')->error("Error on uploading {$this->obj->getTitle()} to path $file_dest_path with message: " . $e->getMessage());
            throw new Exception();
        } finally {
            fclose($write_stream);
        }
        
        return $written_length;
    }
    
    protected function fileUploadWithString(string $a_data, string $file_dest_path)
    {
        $write_stream = fopen($file_dest_path, 'w');
        $written_length = fwrite($write_stream, $a_data);
        fclose($write_stream);
        if ($written_length === false && strlen($a_data) > 0) {
            throw new Exception\Forbidden('Forbidden to write file');
        }
        return $written_length;
    }
    
    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'!");
            unlink($file_dest_path);
            $this->obj->delete();
            throw new Exception\Forbidden('Virus found!');
        }
    }

    protected function setObjValuesForNewFileVersion()
    {
        // This is necessary for windows explorer. Because windows explorer makes always 2 PUT requests. One with a 0 Byte
        // file to test, if the user has write permissions and the second one to upload the original file.
        if ($this->obj->getFileSize() > 0) {
            // Stolen from ilObjFile->addFileVersion
            $this->obj->setVersion($this->obj->getMaxVersion() + 1);
            $this->obj->setMaxVersion($this->obj->getMaxVersion() + 1);
        }
    }

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