class.ilFSWebStorageExercise.php

Go to the documentation of this file.

<?php

class ilFSWebStorageExercise extends ilFileSystemAbstractionStorage
{
    protected ilLogger $log;
    protected int $ass_id;
    protected string $submissions_path;

    public function __construct(
        int $a_container_id = 0,
        int $a_ass_id = 0
    ) {
        $this->ass_id = $a_ass_id;
        $this->log = ilLoggerFactory::getLogger("exc");
        $this->log->debug("ilFSWebStorageExercise construct with a_container_id = " . $a_container_id . " and ass_id =" . $a_ass_id);
        parent::__construct(self::STORAGE_WEB, true, $a_container_id);
    }

    protected function init(): bool
    {
        if (parent::init()) {
            if ($this->ass_id > 0) {
                $this->submissions_path = $this->path . "/subm_" . $this->ass_id;

                $this->log->debug("parent init() with ass_id =" . $this->ass_id);
                $this->path .= "/ass_" . $this->ass_id;
            }
        } else {
            $this->log->debug("no parent init() without ass_id");
            return false;
        }
        return true;
    }

    protected function getPathPostfix(): string
    {
        return 'exc';
    }

    protected function getPathPrefix(): string
    {
        return 'ilExercise';
    }


    public function deleteUserSubmissionDirectory(
        int $user_id
    ): void {
        $internal_dir = $this->submissions_path . "/" . $user_id;

        //remove first dot from (./data/client/ilExercise/3/exc_318/subm_21/6)
        $internal_dir_without_dot = substr($internal_dir, 1);

        $absolute_path = ILIAS_ABSOLUTE_PATH . $internal_dir_without_dot;

        if (is_dir($absolute_path)) {
            parent::deleteDirectory($absolute_path);
            $this->log->debug("Removed = " . $absolute_path);
        }
    }

    public function getFiles(): array
    {
        $ass = new ilExAssignment($this->ass_id);
        $files_order = $ass->getInstructionFilesOrder();
        $files = array();

        $path = "./" . ILIAS_WEB_DIR . "/" . CLIENT_ID . "/" . $this->getPath();

        if (!is_dir($path)) {
            return $files;
        }

        $dp = opendir($path);
        while ($file = readdir($dp)) {
            if (!is_dir($path . '/' . $file)) {
                $files[] = array(
                    'name' => $file,
                    'size' => filesize($path . '/' . $file),
                    'ctime' => filectime($path . '/' . $file),
                    'fullpath' => $path . '/' . $file,
                    'order' => $files_order[$file]["order_nr"] ?? 0
                    );
            }
        }
        closedir($dp);
        return ilArrayUtil::sortArray($files, "order", "asc", true);
    }

    public function getAssignmentFilePath(
        string $a_file
    ): string {
        return $this->getAbsolutePath() . "/" . $a_file;
    }

    public function uploadAssignmentFiles(
        array $a_files
    ): void {
        if (is_array($a_files["name"])) {
            foreach ($a_files["name"] as $k => $name) {
                if ($name != "") {
                    $tmp_name = $a_files["tmp_name"][$k];
                    ilFileUtils::moveUploadedFile(
                        $tmp_name,
                        basename($name),
                        $this->getAbsolutePath() . DIRECTORY_SEPARATOR . basename($name),
                        false
                    );
                }
            }
        }
    }
}