class.ilTestExportOptionARC.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Data\ObjectId;
use ILIAS\Data\ReferenceId;
use ILIAS\Export\ExportHandler\Consumer\ExportOption\BasicLegacyHandler as ilBasicLegacyExportOption;
use ILIAS\Export\ExportHandler\I\Consumer\Context\HandlerInterface as ilExportHandlerConsumerContextInterface;
use ILIAS\DI\Container;
use ILIAS\Export\ExportHandler\I\Info\File\CollectionInterface as ilExportHandlerFileInfoCollectionInterface;
use ILIAS\Export\ExportHandler\I\Consumer\File\Identifier\CollectionInterface as ilExportHandlerConsumerFileIdentifierCollectionInterface;
use ILIAS\Export\ExportHandler\I\Consumer\File\Identifier\HandlerInterface as ilExportHandlerConsumerFileIdentifierInterface;

class ilTestExportOptionARC extends ilBasicLegacyExportOption
{
    protected ilLanguage $lng;
    protected string $data_dir;

    public function init(
        Container $DIC
    ): void {
        $this->lng = $DIC->language();
        $this->data_dir = $DIC->iliasIni()->readVariable('clients', 'datadir');
        parent::init($DIC);
    }

    public function getExportType(): string
    {
        return 'Archive';
    }

    public function getExportOptionId(): string
    {
        return 'test_exp_option_arc';
    }

    public function getSupportedRepositoryObjectTypes(): array
    {
        return ['tst'];
    }

    public function getLabel(): string
    {
        $this->lng->loadLanguageModule('assessment');
        return $this->lng->txt('ass_create_export_test_archive');
    }

    public function onDeleteFiles(
        ilExportHandlerConsumerContextInterface $context,
        ilExportHandlerConsumerFileIdentifierCollectionInterface $file_identifiers
    ): void {
        $object_id = new ObjectId($context->exportObject()->getId());
        foreach ($file_identifiers as $file_identifier) {
            $file = explode(":", $file_identifier->getIdentifier());
            $file[1] = basename($file[1]);
            $export_dir = $this->getDirectory($object_id, $context->exportObject()->getType());
            $exp_file = $export_dir . "/" . str_replace("..", "", $file[1]);
            $exp_dir = $export_dir . "/" . substr($file[1], 0, strlen($file[1]) - 4);
            if (is_file($exp_file)) {
                unlink($exp_file);
            }
            if (
                is_dir($exp_dir) and
                count(scandir($exp_dir)) === 2
            ) {
                ilFileUtils::delDir($exp_dir);
            }
        }
    }

    public function onDownloadFiles(
        ilExportHandlerConsumerContextInterface $context,
        ilExportHandlerConsumerFileIdentifierCollectionInterface $file_identifiers
    ): void {
        $object_id = new ObjectId($context->exportObject()->getId());
        foreach ($file_identifiers as $file_identifier) {
            $file = explode(":", trim($file_identifier->getIdentifier()));
            $export_dir = $this->getDirectory($object_id, $context->exportObject()->getType());
            $file[1] = basename($file[1]);
            ilFileDelivery::deliverFileLegacy(
                $export_dir . "/" . $file[1],
                $file[1]
            );
        }
    }

    public function onDownloadWithLink(
        ReferenceId $reference_id,
        ilExportHandlerConsumerFileIdentifierInterface $file_identifier
    ): void {
        $object_id = $reference_id->toObjectId();
        $type = ilObject::_lookupType($object_id->toInt());
        $file = explode(":", trim($file_identifier->getIdentifier()));
        $export_dir = $this->getDirectory($object_id, $type);
        $file[1] = basename($file[1]);
        ilFileDelivery::deliverFileLegacy(
            $export_dir . "/" . $file[1],
            $file[1]
        );
    }

    public function getFiles(
        ilExportHandlerConsumerContextInterface $context
    ): ilExportHandlerFileInfoCollectionInterface {
        $collection_builder = $context->fileCollectionBuilder();
        $object_id = new ObjectId($context->exportObject()->getId());
        $dir = $this->getDirectory($object_id, $context->exportObject()->getType());
        $file_infos = $this->getExportFiles($dir);
        foreach ($file_infos as $file_name => $file_info) {
            $collection_builder = $collection_builder->withSPLFileInfo(
                new SplFileInfo($dir . DIRECTORY_SEPARATOR . $file_info["file"]),
                $object_id,
                $this
            );
        }
        return $collection_builder->collection();
    }

    public function onExportOptionSelected(
        ilExportHandlerConsumerContextInterface $context
    ): void {
        $context->exportGUIObject()->createTestArchiveExport();
    }

    protected function getExportFiles(
        string $directory
    ): array {
        $files = [];
        try {
            foreach (scandir($directory) as $file) {
                if (
                    in_array($file, ['.', '..']) ||
                    !str_ends_with($file, ".zip")
                ) {
                    continue;
                }
                $files[$file] = ["file" => $file];
            }
        } catch (Exception $e) {

        }
        return $files;
    }

    protected function getDirectory(
        ObjectId $object_id,
        string $export_object_type
    ): string {
        return $this->data_dir
            . DIRECTORY_SEPARATOR . CLIENT_ID . DIRECTORY_SEPARATOR . 'tst_data' . DIRECTORY_SEPARATOR
            . ilTestArchiver::EXPORT_DIRECTORY . DIRECTORY_SEPARATOR . $export_object_type . "_" . $object_id->toInt();
    }
}