class.ilCopyFilesToTempDirectoryJob.php

Go to the documentation of this file.

<?php

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

class ilCopyFilesToTempDirectoryJob extends AbstractJob
{
    private ?ilLogger $logger;
    protected string $target_directory = '';


    public function __construct()
    {
        global $DIC;
        $this->logger = $DIC->logger()->cal();
    }


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


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


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


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

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

        $this->target_directory = $definition->getTempDir();

        // 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, $definition);

        // 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, ilCopyDefinition $definition): void
    {
        foreach ($definition->getCopyDefinitions() as $copy_task) {
            $source_dir_or_file = $copy_task[ilCopyDefinition::COPY_SOURCE_DIR];
            $target_dir_or_file = $copy_task[ilCopyDefinition::COPY_TARGET_DIR];
            $absolute_path_of_target_dir_or_file = $tmpdir . '/' . $target_dir_or_file;
            $absolute_directory_of_target_dir_or_file = $tmpdir . '/' . dirname($target_dir_or_file);

            $this->logger->debug('Creating directory: ' . $tmpdir . '/' . dirname($target_dir_or_file));

            ilFileUtils::makeDirParents(
                $absolute_directory_of_target_dir_or_file
            );

            if (!file_exists($source_dir_or_file)) {
                // if the "file" to be copied is an empty folder the directory has to be created so it will be contained in the download zip
                $is_empty_folder = preg_match_all("/\/$/", $target_dir_or_file);
                if ($is_empty_folder && !file_exists($absolute_path_of_target_dir_or_file)) {
                    mkdir($absolute_path_of_target_dir_or_file);
                    $this->logger->notice('Empty folder has been created: ' . $tmpdir . '/' . $source_dir_or_file);
                } else {
                    $this->logger->notice('Cannot find file: ' . $source_dir_or_file);
                }
                continue;
            }

            $this->logger->debug(
                'Copying from: ' .
                $source_dir_or_file .
                ' to ' .
                $absolute_path_of_target_dir_or_file
            );
            if (
                !is_dir($source_dir_or_file) && is_file($source_dir_or_file)
                && !is_dir($absolute_path_of_target_dir_or_file)
            ) {
                copy(
                    $source_dir_or_file,
                    $absolute_path_of_target_dir_or_file
                );
            }
        }
    }


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