ShortFilePayload.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\FileDelivery\Token\Signer\Payload;
 
use ILIAS\FileDelivery\Setup\BaseDirObjective;
 
class ShortFilePayload extends StructuredPayload
{
    protected string $mime_type = '';
    protected string $disposition = '';
    protected int $user_id = 0;
 
    public function __construct(
        private string $uri,
        private string $file_name,
        private bool $isolated = true
    ) {
        $modification_time = @filemtime($uri);
        // try to shorten uri
        $base = BaseDirObjective::get();
        if ($base !== null && str_starts_with($uri, $base)) {
            $uri = substr($uri, strlen($base));
        }
 
        $data = [
            'p' => $uri,
            'n' => $file_name,
            'mt' => $modification_time,
        ];
        // only tokens leaving the content domain carry the flag, so all others stay as short as before
        if (!$isolated) {
            $data['ni'] = 1;
        }
 
        parent::__construct($data);
    }
 
    public static function fromArray(array $raw_payload): self
    {
        return new self(
            $raw_payload['p'],
            $raw_payload['n'],
            empty($raw_payload['ni'])
        );
    }
 
    public function getUri(): string
    {
        $uri = $this->uri;
        // try to expand uri
        $base = BaseDirObjective::get();
        // only shortened (relative) uris are expanded, absolute ones lie outside the base dir
        if ($base !== null && !str_starts_with($uri, '/')) {
            return $base . $uri;
        }
 
        return $uri;
    }
 
    public function getMimeType(): string
    {
        return $this->mime_type;
    }
 
    public function getFileName(): string
    {
        return $this->file_name;
    }
 
    public function getDisposition(): string
    {
        return $this->disposition;
    }
 
    public function getUserId(): int
    {
        return $this->user_id;
    }
 
    public function isIsolated(): bool
    {
        return $this->isolated;
    }
}