DownloadMultipleConsumer.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\ResourceStorage\Consumer;

use ILIAS\Filesystem\Stream\Streams;
use ILIAS\FileUpload\MimeType;
use ILIAS\HTTP\Response\ResponseHeader;
use ILIAS\ResourceStorage\Collection\ResourceCollection;
use ILIAS\ResourceStorage\Consumer\StreamAccess\StreamAccess;
use ILIAS\ResourceStorage\Policy\FileNamePolicy;

class DownloadMultipleConsumer implements DeliveryConsumer
{
    protected ResourceCollection $collection;
    protected ?int $revision_number = null;
    protected bool $use_revision_titles = false;
    protected array $resources;
    private StreamAccess $stream_access;
    protected FileNamePolicy $file_name_policy;
    protected string $zip_file_name;

    public function __construct(
        array $resources,
        StreamAccess $stream_access,
        FileNamePolicy $file_name_policy,
        string $zip_file_name
    ) {
        $this->resources = $resources;
        $this->stream_access = $stream_access;
        $this->file_name_policy = $file_name_policy;
        $this->zip_file_name = $zip_file_name;
    }


    public function run(): void
    {
        global $DIC;

        $directory = CLIENT_DATA_DIR . '/temp';
        $temp = tempnam($directory, 'zip');
        $zip = new \ZipArchive();
        $zip->open($temp, \ZipArchive::CREATE | \ZipArchive::OVERWRITE);

        foreach ($this->resources as $resource) {
            $revision = $this->stream_access->populateRevision($resource->getCurrentRevision());
            if ($this->use_revision_titles) {
                $file_name = $this->file_name_policy->prepareFileNameForConsumer($revision->getTitle());
            } else {
                $file_name = $this->file_name_policy->prepareFileNameForConsumer(
                    $revision->getInformation()->getTitle()
                );
            }

            $zip->addFile($revision->maybeGetToken()->resolveStream()->getMetadata('uri'), $file_name);
        }

        $zip->close();
        $response = $DIC->http()->response();
        $response = $response->withHeader(ResponseHeader::CONTENT_TYPE, MimeType::APPLICATION__ZIP);
        $response = $response->withHeader(ResponseHeader::CONNECTION, 'close');
        $response = $response->withHeader(ResponseHeader::ACCEPT_RANGES, 'bytes');
        $response = $response->withHeader(
            ResponseHeader::CONTENT_DISPOSITION,
            'attachment'
            . '; filename="'
            . $this->zip_file_name
            . '"'
        );
        $fopen = fopen($temp, 'rb');
        $response = $response->withBody(Streams::ofResource($fopen));
        $DIC->http()->saveResponse($response);
        $DIC->http()->sendResponse();
        fclose($fopen);
        unlink($temp);
        $DIC->http()->close();
    }


    public function useRevisionTitlesForFileNames(bool $use_revision_titles): self
    {
        $this->use_revision_titles = $use_revision_titles;
        return $this;
    }

    public function setRevisionNumber(int $revision_number): DeliveryConsumer
    {
        $this->revision_number = $revision_number;
        return $this;
    }

    public function overrideFileName(string $file_name): DeliveryConsumer
    {
        $this->zip_file_name = $file_name;
        return $this;
    }
}