class.ilFileDataForum.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilFileDataForum extends ilFileData
{
    private const FORUM_PATH = 'forum';

    private int $obj_id;
    private int $pos_id;
    private string $forum_path;
    private ilErrorHandling $error;
    private ilGlobalTemplateInterface $main_tpl;

    public function __construct(int $a_obj_id = 0, int $a_pos_id = 0)
    {
        global $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();

        $this->error = $DIC['ilErr'];

        parent::__construct();
        $this->forum_path = $this->getPath() . '/' . self::FORUM_PATH;

        if (!$this->checkForumPath()) {
            $this->initDirectory();
        }
        $this->obj_id = $a_obj_id;
        $this->pos_id = $a_pos_id;
    }

    public function getObjId(): int
    {
        return $this->obj_id;
    }

    public function getPosId(): int
    {
        return $this->pos_id;
    }

    public function setPosId(int $a_id): void
    {
        $this->pos_id = $a_id;
    }

    public function getForumPath(): string
    {
        return $this->forum_path;
    }

    public function getFiles(): array
    {
        $directory_iterator = new DirectoryIterator($this->forum_path);
        $filter_iterator = new RegexIterator($directory_iterator, "/^{$this->obj_id}_(.+)$/");

        $files = [];
        foreach ($filter_iterator as $file) {
            if (!$file->isFile()) {
                continue;
            }

            [$obj_id, $rest] = explode('_', $file->getFilename(), 2);
            if ((int) $obj_id === $this->obj_id) {
                $files[] = [
                    'path' => $file->getPathname(),
                    'md5' => md5($this->obj_id . '_' . $rest),
                    'name' => $rest,
                    'size' => $file->getSize(),
                    'ctime' => date('Y-m-d H:i:s', $file->getCTime())
                ];
            }
        }

        return $files;
    }

    public function getFilesOfPost(): array
    {
        $directoryIterator = new DirectoryIterator($this->forum_path);
        $filterIterator = new RegexIterator($directoryIterator, "/^{$this->obj_id}_{$this->getPosId()}_(.+)$/");

        $files = array();
        foreach ($filterIterator as $file) {
            if ($file->isFile()) {
                list($obj_id, $pos_id, $rest) = explode('_', $file->getFilename(), 3);
                $files[$rest] = array(
                    'path' => $file->getPathname(),
                    'md5' => md5($this->obj_id . '_' . $this->pos_id . '_' . $rest),
                    'name' => $rest,
                    'size' => $file->getSize(),
                    'ctime' => date('Y-m-d H:i:s', $file->getCTime())
                );
            }
        }

        return $files;
    }

    public function moveFilesOfPost(int $a_new_frm_id = 0): bool
    {
        if ($a_new_frm_id) {
            $directory_iterator = new DirectoryIterator($this->forum_path);
            $filter_iterator = new RegexIterator($directory_iterator, "/^{$this->obj_id}_(\d+)_(.+)$/");

            foreach ($filter_iterator as $file) {
                if (!$file->isFile()) {
                    continue;
                }

                [$obj_id, $pos_id, $rest] = explode('_', $file->getFilename(), 3);
                if ((int) $obj_id !== $this->obj_id || (int) $pos_id !== $this->getPosId()) {
                    continue;
                }

                ilFileUtils::rename(
                    $file->getPathname(),
                    $this->forum_path . '/' . $a_new_frm_id . '_' . $this->pos_id . '_' . $rest
                );
            }

            return true;
        }

        return false;
    }

    public function ilClone(int $a_new_obj_id, int $a_new_pos_id): bool
    {
        foreach ($this->getFilesOfPost() as $file) {
            copy(
                $this->getForumPath() . '/' . $this->obj_id . '_' . $this->pos_id . '_' . $file['name'],
                $this->getForumPath() . '/' . $a_new_obj_id . '_' . $a_new_pos_id . '_' . $file['name']
            );
        }
        return true;
    }

    public function delete(): bool
    {
        foreach ($this->getFiles() as $file) {
            if (is_file($this->getForumPath() . '/' . $this->getObjId() . '_' . $file['name'])) {
                unlink($this->getForumPath() . '/' . $this->getObjId() . '_' . $file['name']);
            }
        }

        return true;
    }

    public function storeUploadedFile(array $files): bool
    {
        if (isset($files['name']) && is_array($files['name'])) {
            foreach ($files['name'] as $index => $name) {
                $name = rtrim($name, '/');
                $filename = ilFileUtils::_sanitizeFilemame($name);
                $temp_name = $files['tmp_name'][$index];
                $error = $files['error'][$index];

                if ($filename !== '' && $temp_name !== '' && (int) $error === 0) {
                    $path = $this->getForumPath() . '/' . $this->obj_id . '_' . $this->pos_id . '_' . $filename;

                    $this->rotateFiles($path);
                    ilFileUtils::moveUploadedFile($temp_name, $filename, $path);
                }
            }

            return true;
        }

        if (isset($files['name']) && is_string($files['name'])) {
            $files['name'] = rtrim($files['name'], '/');
            $filename = ilFileUtils::_sanitizeFilemame($files['name']);
            $temp_name = $files['tmp_name'];

            $path = $this->getForumPath() . '/' . $this->obj_id . '_' . $this->pos_id . '_' . $filename;

            $this->rotateFiles($path);
            ilFileUtils::moveUploadedFile($temp_name, $filename, $path);

            return true;
        }

        return false;
    }

    public function unlinkFile(string $a_filename): bool
    {
        if (is_file($this->forum_path . '/' . $this->obj_id . '_' . $this->pos_id . '_' . $a_filename)) {
            return unlink($this->forum_path . '/' . $this->obj_id . '_' . $this->pos_id . '_' . $a_filename);
        }

        return false;
    }

    public function getFileDataByMD5Filename(string $hashedFilename): ?array
    {
        $files = ilFileUtils::getDir($this->forum_path);
        foreach ($files as $file) {
            if ($file['type'] === 'file' && md5($file['entry']) === $hashedFilename) {
                return [
                    'path' => $this->forum_path . '/' . $file['entry'],
                    'filename' => $file['entry'],
                    'clean_filename' => str_replace($this->obj_id . '_' . $this->pos_id . '_', '', $file['entry'])
                ];
            }
        }

        return null;
    }

    public function unlinkFilesByMD5Filenames($hashedFilenameOrFilenames): bool
    {
        $files = ilFileUtils::getDir($this->forum_path);
        if (is_array($hashedFilenameOrFilenames)) {
            foreach ($files as $file) {
                if ($file['type'] === 'file' && in_array(md5($file['entry']), $hashedFilenameOrFilenames, true)) {
                    unlink($this->forum_path . '/' . $file['entry']);
                }
            }

            return true;
        }

        foreach ($files as $file) {
            if ($file['type'] === 'file' && md5($file['entry']) === $hashedFilenameOrFilenames) {
                return unlink($this->forum_path . '/' . $file['entry']);
            }
        }

        return false;
    }

    private function checkForumPath(): bool
    {
        if (!is_dir($this->getForumPath())) {
            return false;
        }
        $this->checkReadWrite();

        return true;
    }

    private function checkReadWrite(): void
    {
        if (!is_writable($this->forum_path) || !is_readable($this->forum_path)) {
            $this->error->raiseError('Forum directory is not readable/writable by webserver', $this->error->FATAL);
        }
    }

    private function initDirectory(): void
    {
        if (is_writable($this->getPath()) && mkdir($this->getPath() . '/' . self::FORUM_PATH) && chmod(
            $this->getPath() . '/' . self::FORUM_PATH,
            0755
        )) {
            $this->forum_path = $this->getPath() . '/' . self::FORUM_PATH;
        }
    }

    private function rotateFiles(string $a_path): void
    {
        if (is_file($a_path)) {
            $this->rotateFiles($a_path . '.old');
            ilFileUtils::rename($a_path, $a_path . '.old');
        }
    }

    public function deliverFile(string $file): void
    {
        global $DIC;

        if (($path = $this->getFileDataByMD5Filename($file)) !== null) {
            ilFileDelivery::deliverFileLegacy($path['path'], $path['clean_filename']);
        } else {
            $this->main_tpl->setOnScreenMessage('failure', $DIC->lanuage()->txt('error_reading_file'), true);
        }
    }

    public function deliverZipFile(): bool
    {
        global $DIC;

        $zip_file = $this->createZipFile();
        if (!$zip_file) {
            $this->main_tpl->setOnScreenMessage('failure', $DIC->language()->txt('error_reading_file'), true);
            return false;
        }

        $post = new ilForumPost($this->getPosId());
        ilFileDelivery::deliverFileLegacy($zip_file, $post->getSubject() . '.zip', '', false, true, false);
        ilFileUtils::delDir($this->getForumPath() . '/zip/' . $this->getObjId() . '_' . $this->getPosId());
        $DIC->http()->close();
        return true; // never
    }

    protected function createZipFile(): ?string
    {
        $filesOfPost = $this->getFilesOfPost();
        ksort($filesOfPost);

        ilFileUtils::makeDirParents($this->getForumPath() . '/zip/' . $this->getObjId() . '_' . $this->getPosId());
        $tmp_dir = $this->getForumPath() . '/zip/' . $this->getObjId() . '_' . $this->getPosId();
        foreach ($filesOfPost as $file) {
            copy($file['path'], $tmp_dir . '/' . $file['name']);
        }

        $zip_file = null;
        if (ilFileUtils::zip(
            $tmp_dir,
            $this->getForumPath() . '/zip/' . $this->getObjId() . '_' . $this->getPosId() . '.zip'
        )) {
            $zip_file = $this->getForumPath() . '/zip/' . $this->getObjId() . '_' . $this->getPosId() . '.zip';
        }

        return $zip_file;
    }
}