class.ilWACPath.php

Go to the documentation of this file.

<?php

class ilWACPath {

        const DIR_DATA = "data";
        const DIR_SEC = "sec";
        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 = array(
                'png',
                'jpg',
                'jpeg',
                'gif',
                'svg',
        );
        protected static $video_suffixes = array(
                'mp4',
                'm4v',
                'mov',
                'wmv',
                'webm',
        );
        protected static $audio_suffixes = array(
                'mp3',
                'aiff',
                'aif',
                'm4a',
                'wav',
        );
        protected $client = '';
        protected $parameters = array();
        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($path) {
                $this->setOriginalRequest($path);
                $re = '/' . self::REGEX . '/';
                preg_match($re, $path, $result);

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

                $this->setPrefix($result['prefix']);
                $this->setClient($result['client']);
                $this->setAppendix($result['appendix']);
                $this->setModuleIdentifier(strstr($result['module_identifier'], "/", true));
                $this->setModuleType($result['module_type']);
                if ($this->getModuleIdentifier()) {
                        $this->setModulePath('.' . strstr($result['module_path'], $this->getModuleIdentifier(), true));
                }else {
                        $this->setModulePath('.' . $result['module_path']);
                }
                $this->setInSecFolder($result['sec'] == '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($param[ilWACSignedPath::WAC_TIMESTAMP_ID]);
                }
                if (isset($param[ilWACSignedPath::WAC_TTL_ID])) {
                        $this->setTTL($param[ilWACSignedPath::WAC_TTL_ID]);
                }
        }


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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