class.ilZipJob.php

Go to the documentation of this file.

<?php
use ILIAS\Filesystem\Util\Archive\Archives;
use ILIAS\BackgroundTasks\Observer;
use ILIAS\BackgroundTasks\Implementation\Tasks\AbstractJob;
use ILIAS\BackgroundTasks\Implementation\Values\ScalarValues\StringValue;
use ILIAS\BackgroundTasks\Types\SingleType;
use ILIAS\BackgroundTasks\Types\Type;
use ILIAS\BackgroundTasks\Value;

class ilZipJob extends AbstractJob
{
    private ?ilLogger $logger;
    private Archives $archives;

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


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


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


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


    public function run(array $input, Observer $observer): Value
    {
        $this->logger->debug('Start zipping input dir!');
        $this->logger->dump($input);
        $string = $input[0]->getValue();
        $tmpdir = rtrim((string) $string, "/");
        $this->logger->debug('Zipping directory:' . $tmpdir);
        $zip_name = $tmpdir . '.zip';

        $zip = $this->archives->zip([]);
        $zip->addDirectory($tmpdir);
        $zip_stream = $zip->get();
        stream_copy_to_stream($zip_stream->detach(), fopen($zip_name, 'wb')); // we currently have to write to disk

        // delete temp directory
        ilFileUtils::delDir($tmpdir);

        $zip_file_name = new StringValue();
        $zip_file_name->setValue($zip_name);

        return $zip_file_name;
    }


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