class.ilCalendarCopyFilesToTempDirectoryJob.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\BackgroundTasks\Implementation\Tasks\AbstractJob;
use ILIAS\BackgroundTasks\Types\Type;
use ILIAS\BackgroundTasks\Value;
use ILIAS\BackgroundTasks\Observer;
use ILIAS\BackgroundTasks\Types\SingleType;
use ILIAS\BackgroundTasks\Implementation\Values\ScalarValues\StringValue;
use ILIAS\BackgroundTasks\Types\ListType;
use ILIAS\BackgroundTasks\Types\TupleType;

/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilCalendarCopyFilesToTempDirectoryJob extends AbstractJob
{
    private ilLogger $logger;
    private ILIAS\ResourceStorage\Services $irss;

    protected string $target_directory;

    public function __construct()
    {
        global $DIC;

        $this->irss = $DIC->resourceStorage();
        $this->logger = $DIC->logger()->cal();
    }

    public function getInputTypes(): array
    {
        return
            [
                new SingleType(ilCalendarRessourceStorageCopyDefinition::class)
            ];
    }

    public function getOutputType(): Type
    {
        return new SingleType(StringValue::class);
    }

    public function isStateless(): bool
    {
        return true;
    }

    public function run(array $input, Observer $observer): Value
    {
        $cal_copy_def = $input[0];

        $this->logger->info('Called copy files job');

        $this->target_directory = $cal_copy_def->getTempDir();
        //$this->target_directory = $input[1]->getValue();

        // create temp directory
        $tmpdir = $this->createUniqueTempDirectory();
        $targetdir = $this->createTargetDirectory($tmpdir);

        // copy files from source to temp directory
        //$this->copyFiles($targetdir, $input[0]);
        $this->copyFiles($targetdir, $cal_copy_def);

        // zip

        // return zip file name
        $this->logger->debug('Returning new tempdirectory: ' . $targetdir);

        $out = new StringValue();
        $out->setValue($targetdir);
        return $out;
    }

    protected function createUniqueTempDirectory(): string
    {
        $tmpdir = ilFileUtils::ilTempnam();
        ilFileUtils::makeDirParents($tmpdir);
        $this->logger->info('New temp directory: ' . $tmpdir);
        return $tmpdir;
    }

    protected function createTargetDirectory(string $a_tmpdir): string
    {
        $final_dir = $a_tmpdir . "/" . $this->target_directory;
        ilFileUtils::makeDirParents($final_dir);
        $this->logger->info('New final directory: ' . $final_dir);
        return $final_dir;
    }

    protected function copyFiles(string $tmpdir, ilCalendarRessourceStorageCopyDefinition $definition): void
    {
        foreach ($definition->getCopyDefinitions() as $copy_task) {
            if(!is_null($copy_task[ilCalendarRessourceStorageCopyDefinition::COPY_RESSOURCE_ID])) {
                $this->copyWithRId($tmpdir, $copy_task);
            } else {
                $this->copyWithAbsolutePath($tmpdir, $copy_task);
            }
        }
    }

    protected function copyWithRId(string $tmpdir, array $copy_task)
    {
        $target_dir = $copy_task[ilCalendarRessourceStorageCopyDefinition::COPY_TARGET_DIR];
        $rid = $copy_task[ilCalendarRessourceStorageCopyDefinition::COPY_RESSOURCE_ID];
        $resource_identification = $this->irss->manage()->find($rid);

        if(is_null($resource_identification)) {
            $this->logger->notice('Cannot ressource identification of rid: ' . $rid);
            return;
        }

        $this->logger->debug('Creating directory: ' . $tmpdir . '/' . dirname($target_dir));
        ilFileUtils::makeDirParents($tmpdir . '/' . dirname($target_dir));
        $this->logger->debug('Copying ressource with id: ' . $rid . ' to ' . $tmpdir . '/' . $target_dir);

        file_put_contents(
            $tmpdir . '/' . $copy_task[ilCalendarRessourceStorageCopyDefinition::COPY_TARGET_DIR],
            $this->irss->consume()->stream($resource_identification)->getStream()
        );
    }

    protected function copyWithAbsolutePath(string $tmpdir, array $copy_task)
    {
        $absolute_path = $copy_task[ilCalendarRessourceStorageCopyDefinition::COPY_ABSOLUTE_PATH];
        $target_dir = $copy_task[ilCalendarRessourceStorageCopyDefinition::COPY_TARGET_DIR];

        if (!file_exists($absolute_path)) {
            $this->logger->notice('Cannot find file: ' . $absolute_path);
            return;
        }

        $this->logger->debug('Creating directory: ' . $tmpdir . '/' . dirname($target_dir));
        ilFileUtils::makeDirParents($tmpdir . '/' . dirname($target_dir));
        $this->logger->debug('Copying from: ' . $absolute_path . ' to ' . $tmpdir . '/' . $target_dir);

        copy($absolute_path, $tmpdir . '/' . $target_dir);
    }

    public function getExpectedTimeOfTaskInSeconds(): int
    {
        return 30;
    }
}