class.ilWACPath.php

Go to the documentation of this file.

<?php
use ILIAS\Data\URI;

class ilWACPath
{
    public const DIR_DATA = "data";
    public const DIR_SEC = "sec";
    public const REGEX = "(?<prefix>.*?)(?<path>(?<path_without_query>(?<secure_path_id>(?<module_path>\/data\/(?<client>[\w\-\.]*)\/(?<sec>sec\/|)(?<module_type>.*?)\/(?<module_identifier>.*\/|)))(?<appendix>[^\?\n]*)).*)";
    protected static $image_suffixes = ['png', 'jpg', 'jpeg', 'gif', 'svg'];
    protected static $video_suffixes = ['mp4', 'm4v', 'mov', 'wmv', 'webm'];
    protected static $audio_suffixes = ['mp3', 'aiff', 'aif', 'm4a', 'wav'];
    protected $client = '';
    protected $parameters = [];
    protected $in_sec_folder = false;
    protected $token = '';
    protected $timestamp = 0;
    protected $ttl = 0;
    protected $secure_path = '';
    protected $secure_path_id = '';
    protected $original_request = '';
    protected $file_name = '';
    protected $query = '';
    protected $suffix = '';
    protected $prefix = '';
    protected $appendix = '';
    protected $module_path = '';
    protected $path = '';
    protected $module_type = '';
    protected $module_identifier = '';
    protected $path_without_query = '';


    public function __construct(string $path, bool $normalize = true)
    {
        if ($normalize) {
            $path = $this->normalizePath($path);
        }

        $this->setOriginalRequest($path);

        $re = '/' . self::REGEX . '/';
        preg_match($re, $path, $result);

        $result['path_without_query'] = strstr(
            parse_url($path)['path'],
            '/data/',
            false
        );

        foreach ($result as $k => $v) {
            if (is_numeric($k)) {
                unset($result[$k]);
            }
        }

        $moduleId = strstr($result['module_identifier'] ?? '', "/", true);
        $moduleId = $moduleId === false ? '' : $moduleId;

        $this->setPrefix($result['prefix'] ?? '');
        $this->setClient($result['client'] ?? '');
        $this->setAppendix($result['appendix'] ?? '');
        $this->setModuleIdentifier($moduleId);
        $this->setModuleType($result['module_type'] ?? '');

        $modulePath = null;

        if ($this->getModuleIdentifier()) {
            $modulePath = strstr($result['module_path'] ?? '', $this->getModuleIdentifier(), true);
            $modulePath = '.' . ($modulePath === false ? '' : $modulePath);
        } else {
            $modulePath = ('.' . ($result['module_path'] ?? ''));
        }

        $this->setModulePath((string) $modulePath);
        $this->setInSecFolder(($result['sec'] ?? null) === 'sec/');
        $this->setPathWithoutQuery('.' . ($result['path_without_query'] ?? ''));
        $this->setPath('.' . ($result['path'] ?? ''));
        $this->setSecurePath('.' . ($result['secure_path_id'] ?? ''));
        $this->setSecurePathId($result['module_type'] ?? '');
        // Pathinfo
        $parts = parse_url($path);
        $this->setFileName(basename($parts['path']));
        if (isset($parts['query'])) {
            $parts_query = $parts['query'];
            $this->setQuery($parts_query);
            parse_str($parts_query, $query);
            $this->setParameters($query);
        }
        $this->setSuffix(pathinfo($parts['path'], PATHINFO_EXTENSION));
        $this->handleParameters();
    }


    protected function handleParameters()
    {
        $param = $this->getParameters();
        if (isset($param[ilWACSignedPath::WAC_TOKEN_ID])) {
            $this->setToken($param[ilWACSignedPath::WAC_TOKEN_ID]);
        }
        if (isset($param[ilWACSignedPath::WAC_TIMESTAMP_ID])) {
            $this->setTimestamp(intval($param[ilWACSignedPath::WAC_TIMESTAMP_ID]));
        }
        if (isset($param[ilWACSignedPath::WAC_TTL_ID])) {
            $this->setTTL(intval($param[ilWACSignedPath::WAC_TTL_ID]));
        }
    }


    public function getParameters()
    {
        return (array) $this->parameters;
    }


    public function setParameters(array $parameters)
    {
        $this->parameters = $parameters;
    }


    public static function getAudioSuffixes()
    {
        return (array) self::$audio_suffixes;
    }


    public static function setAudioSuffixes(array $audio_suffixes)
    {
        self::$audio_suffixes = $audio_suffixes;
    }


    public static function getImageSuffixes()
    {
        return (array) self::$image_suffixes;
    }


    public static function setImageSuffixes(array $image_suffixes)
    {
        self::$image_suffixes = $image_suffixes;
    }


    public static function getVideoSuffixes()
    {
        return (array) self::$video_suffixes;
    }


    public static function setVideoSuffixes(array $video_suffixes)
    {
        self::$video_suffixes = $video_suffixes;
    }

    protected function normalizePath(string $path) : string
    {
        $path = ltrim($path, '.');
        $path = rawurldecode($path);

        // cut everything before "data/" (for installations using a subdirectory)
        $path = strstr($path, '/' . self::DIR_DATA . '/');

        $original_path = parse_url($path, PHP_URL_PATH);
        $query = parse_url($path, PHP_URL_QUERY);

        $real_data_dir = realpath("./" . self::DIR_DATA);
        $realpath = realpath("." . $original_path);

        if (strpos($realpath, (string) $real_data_dir) !== 0) {
            throw new ilWACException(ilWACException::NOT_FOUND, "Path is not in data directory");
        }

        $normalized_path = ltrim(
            str_replace(
                $real_data_dir,
                '',
                $realpath
            ),
            '/'
        );

        return "/" . self::DIR_DATA . '/' . $normalized_path . (!empty($query) ? '?' . $query : '');
    }

    public function getPrefix()
    {
        return (string) $this->prefix;
    }


    public function setPrefix($prefix)
    {
        assert(is_string($prefix));
        $this->prefix = $prefix;
    }


    public function getAppendix()
    {
        return (string) $this->appendix;
    }


    public function setAppendix($appendix)
    {
        assert(is_string($appendix));
        $this->appendix = $appendix;
    }


    public function getModulePath()
    {
        return (string) $this->module_path;
    }


    public function setModulePath($module_path)
    {
        assert(is_string($module_path));
        $this->module_path = $module_path;
    }


    public function getDirName()
    {
        return (string) dirname($this->getPathWithoutQuery());
    }


    public function getPathWithoutQuery()
    {
        return (string) $this->path_without_query;
    }


    public function setPathWithoutQuery($path_without_query)
    {
        assert(is_string($path_without_query));
        $this->path_without_query = $path_without_query;
    }


    public function isImage()
    {
        return (bool) in_array(strtolower($this->getSuffix()), self::$image_suffixes);
    }


    public function getSuffix()
    {
        return (string) $this->suffix;
    }


    public function setSuffix($suffix)
    {
        assert(is_string($suffix));
        $this->suffix = $suffix;
    }


    public function isStreamable()
    {
        return (bool) ($this->isAudio() || $this->isVideo());
    }


    public function isAudio()
    {
        return (bool) in_array(strtolower($this->getSuffix()), self::$audio_suffixes);
    }


    public function isVideo()
    {
        return (bool) in_array(strtolower($this->getSuffix()), self::$video_suffixes);
    }


    public function fileExists()
    {
        return (bool) is_file($this->getPathWithoutQuery());
    }


    public function hasToken()
    {
        return (bool) ($this->token !== '');
    }


    public function hasTimestamp()
    {
        return (bool) ($this->timestamp !== 0);
    }


    public function hasTTL()
    {
        return (bool) ($this->ttl !== 0);
    }


    public function getToken()
    {
        return (string) $this->token;
    }


    public function setToken($token)
    {
        assert(is_string($token));
        $this->parameters[ilWACSignedPath::WAC_TOKEN_ID] = $token;
        $this->token = $token;
    }


    public function getTimestamp()
    {
        return (int) $this->timestamp;
    }


    public function setTimestamp($timestamp)
    {
        assert(is_int($timestamp));
        $this->parameters[ilWACSignedPath::WAC_TIMESTAMP_ID] = $timestamp;
        $this->timestamp = $timestamp;
    }


    public function getTTL()
    {
        return (int) $this->ttl;
    }


    public function setTTL($ttl)
    {
        $this->parameters[ilWACSignedPath::WAC_TTL_ID] = $ttl;
        $this->ttl = $ttl;
    }


    public function getClient()
    {
        return (string) $this->client;
    }


    public function setClient($client)
    {
        assert(is_string($client));
        $this->client = $client;
    }


    public function getSecurePathId()
    {
        return (string) $this->secure_path_id;
    }


    public function setSecurePathId($secure_path_id)
    {
        assert(is_string($secure_path_id));
        $this->secure_path_id = $secure_path_id;
    }


    public function getPath()
    {
        return (string) $this->path;
    }


    public function getCleanURLdecodedPath()
    {
        return rawurldecode($this->getPathWithoutQuery());
    }


    public function setPath($path)
    {
        assert(is_string($path));
        $this->path = $path;
    }


    public function getQuery()
    {
        return (string) $this->query;
    }


    public function setQuery($query)
    {
        assert(is_string($query));
        $this->query = $query;
    }


    public function getFileName()
    {
        return (string) $this->file_name;
    }


    public function setFileName($file_name)
    {
        assert(is_string($file_name));
        $this->file_name = $file_name;
    }


    public function getOriginalRequest()
    {
        return (string) $this->original_request;
    }


    public function setOriginalRequest($original_request)
    {
        assert(is_string($original_request));
        $this->original_request = $original_request;
    }


    public function getSecurePath()
    {
        return (string) $this->secure_path;
    }


    public function setSecurePath($secure_path)
    {
        assert(is_string($secure_path));
        $this->secure_path = $secure_path;
    }


    public function isInSecFolder()
    {
        return (bool) $this->in_sec_folder;
    }


    public function setInSecFolder($in_sec_folder)
    {
        assert(is_bool($in_sec_folder));
        $this->in_sec_folder = $in_sec_folder;
    }


    public function getModuleType()
    {
        return (string) $this->module_type;
    }


    public function setModuleType($module_type)
    {
        assert(is_string($module_type));
        $this->module_type = $module_type;
    }


    public function getModuleIdentifier()
    {
        return (string) $this->module_identifier;
    }


    public function setModuleIdentifier($module_identifier)
    {
        assert(is_string($module_identifier));
        $this->module_identifier = $module_identifier;
    }
}