class.ilFileDelivery.php

Go to the documentation of this file.

<?php
require_once('./Services/Utilities/classes/class.ilMimeTypeUtil.php');
require_once('./Services/Utilities/classes/class.ilUtil.php'); // This include is needed since WAC can use ilFileDelivery without Initialisation
require_once('./Services/Context/classes/class.ilContext.php');
require_once('./Services/Http/classes/class.ilHTTPS.php');
require_once('./Services/WebAccessChecker/classes/class.ilHTTP.php');
require_once('./Services/WebAccessChecker/classes/class.ilWACLog.php');

class ilFileDelivery {

        const DIRECT_PHP_OUTPUT = 'php://output';
        const DELIVERY_METHOD_NONE = 'cache';
        const DELIVERY_METHOD_XSENDFILE = 'mod_xsendfile';
        const DELIVERY_METHOD_XACCEL = 'x-accel-redirect';
        const DELIVERY_METHOD_PHP = 'php';
        const DELIVERY_METHOD_PHP_CHUNKED = 'php_chunked';
        const DELIVERY_METHOD_VIRTUAL = 'virtual';
        const DISP_ATTACHMENT = 'attachment';
        const DISP_INLINE = 'inline';
        const VIRTUAL_DATA = 'virtual-data';
        const SECURED_DATA = 'secured-data';
        const DATA = 'data';
        protected static $self_streaming_methods = array(
                self::DELIVERY_METHOD_XSENDFILE,
                self::DELIVERY_METHOD_XACCEL,
        );
        protected static $delivery_type_static = null;
        protected $delivery_type = self::DELIVERY_METHOD_PHP;
        protected $mime_type = '';
        protected $path_to_file = '';
        protected $download_file_name = '';
        protected $disposition = self::DISP_ATTACHMENT;
        protected $send_mime_type = true;
        protected $exit_after = true;
        protected $convert_file_name_to_asci = true;
        protected $etag = '';
        protected $show_last_modified = true;
        protected $has_context = true;
        protected $cache = false;
        protected $hash_filename = false;
        protected $delete_file = false;
        protected $urlencode_filename = false;
        protected static $DEBUG = false;


        public static function deliverFileAttached($path_to_file, $download_file_name = null, $mime_type = null, $delete_file = false) {
                $obj = new self($path_to_file);
                if ($download_file_name) {
                        $obj->setDownloadFileName($download_file_name);
                }
                if ($mime_type) {
                        $obj->setMimeType($mime_type);
                }
                $obj->setDisposition(self::DISP_ATTACHMENT);
                $obj->setDeleteFile($delete_file);
                $obj->deliver();
        }


        public static function streamVideoInline($path_to_file, $download_file_name = null) {
                $obj = new self($path_to_file);
                if ($download_file_name) {
                        $obj->setDownloadFileName($download_file_name);
                }
                $obj->setDisposition(self::DISP_INLINE);
                $obj->stream();
        }


        public static function deliverFileInline($path_to_file, $download_file_name = null) {
                $obj = new self($path_to_file);

                if ($download_file_name) {
                        $obj->setDownloadFileName($download_file_name);
                }
                $obj->setDisposition(self::DISP_INLINE);
                $obj->deliver();
        }


        public function __construct($path_to_file) {
                if ($path_to_file == self::DIRECT_PHP_OUTPUT) {
                        $this->setPathToFile(self::DIRECT_PHP_OUTPUT);
                } else {
                        $path_to_file = explode("?", $path_to_file); // removing everything behind ?
                        $path_to_file = $path_to_file[0];
                        $this->setPathToFile($path_to_file);
                        $this->detemineDeliveryType();
                        $this->determineMimeType();
                        $this->determineDownloadFileName();
                }
                $this->setHasContext(ilContext::getType() !== null);
        }


        public function stream() {
                if (!in_array($this->getDeliveryType(), self::$self_streaming_methods)) {
                        $this->setDeliveryType(self::DELIVERY_METHOD_PHP_CHUNKED);
                }
                $this->deliver();
        }


        public function deliver() {
                $this->cleanDownloadFileName();
                $this->clearBuffer();
                $this->checkCache();
                $this->setGeneralHeaders();
                switch ($this->getDeliveryType()) {
                        default:
                                $this->deliverPHP();
                                break;
                        case self::DELIVERY_METHOD_XSENDFILE:
                                $this->deliverXSendfile();
                                break;
                        case self::DELIVERY_METHOD_XACCEL:
                                $this->deliverXAccelRedirect();
                                break;
                        case self::DELIVERY_METHOD_PHP_CHUNKED:
                                $this->deliverPHPChunked();
                                break;
                        case self::DELIVERY_METHOD_VIRTUAL:
                                $this->deliverVirtual();
                                break;
                        case self::DELIVERY_METHOD_NONE;
                                break;
                }
                if ($this->isDeleteFile()) {
                        unlink($this->getPathToFile());
                }
                if ($this->isExitAfter()) {
                        $this->close();
                }
        }


        public function deliverVirtual() {
                $path_to_file = $this->getPathToFile();
                $this->clearHeaders();
                header('Content-type:');
                if (strpos($path_to_file, './' . self::DATA . '/') === 0
                    && is_dir('./' . self::VIRTUAL_DATA)
                ) {
                        $path_to_file = str_replace('./' . self::DATA . '/', '/' . self::VIRTUAL_DATA
                                                                             . '/', $path_to_file);
                }
                virtual($path_to_file);
        }


        protected function deliverXSendfile() {
                $realpath = realpath($this->getPathToFile());
                $closure = function () use ($realpath) {
                        header('X-Sendfile: ' . $realpath);
                };
                if ($this->isDeleteFile()) {
                        $this->sendFileUnbufferedUsingHeaders($closure);
                } else {
                        $closure();
                }
        }


        protected function deliverXAccelRedirect() {
                $this->clearHeaders();
                $path_to_file = $this->getPathToFile();

                if (strpos($path_to_file, './' . self::DATA . '/') === 0) {
                        $path_to_file = str_replace('./' . self::DATA . '/', '/' . self::SECURED_DATA
                                                                             . '/', $path_to_file);
                }

                $closure = function () use ($path_to_file) {
                        header('Content-type:');
                        header('X-Accel-Redirect: ' . ($path_to_file));
                };
                if ($this->isDeleteFile()) {
                        $this->sendFileUnbufferedUsingHeaders($closure);
                } else {
                        $closure();
                }
        }


        protected function deliverPHP() {
                set_time_limit(0);
                $file = fopen(($this->getPathToFile()), "rb");

                fpassthru($file);
        }


        protected function clearHeaders() {
                header_remove();
        }


        public function setGeneralHeaders() {
                header("X-ILIAS-FileDelivery-Method: " . $this->getDeliveryType());
                $this->checkExisting();
                if ($this->isSendMimeType()) {
                        header("Content-type: " . $this->getMimeType());
                }
                $download_file_name = $this->getDownloadFileName();
                if ($this->isConvertFileNameToAsci()) {
                        $download_file_name = self::returnASCIIFileName($download_file_name);
                }
                if ($this->hasHashFilename()) {
                        $download_file_name = md5($download_file_name);
                }
                header('Content-Disposition: ' . $this->getDisposition() . '; filename="'
                       . $download_file_name . '"');
                header('Content-Description: ' . $download_file_name);
                header('Accept-Ranges: bytes');
                if ($this->getDeliveryType() == self::DELIVERY_METHOD_PHP
                    && $this->getPathToFile() != self::DIRECT_PHP_OUTPUT
                ) {
                        header("Content-Length: " . (string)filesize($this->getPathToFile()));
                }
                header("Connection: close");
                header("X-ILIAS-FileDelivery: " . $this->getDeliveryType());
        }


        public function setCachingHeaders() {
                header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
                header('Pragma: public');
                $this->sendEtagHeader();
                $this->sendLastModified();
        }


        public function generateEtag() {
                $this->setEtag(md5(filemtime($this->getPathToFile()) . filesize($this->getPathToFile())));
        }


        public function close() {
                exit;
        }


        protected function determineMimeType() {
                $info = ilMimeTypeUtil::lookupMimeType($this->getPathToFile(), ilMimeTypeUtil::APPLICATION__OCTET_STREAM);
                if ($info) {
                        $this->setMimeType($info);

                        return true;
                }
                $finfo = finfo_open(FILEINFO_MIME_TYPE);
                $info = finfo_file($finfo, $this->getPathToFile());
                finfo_close($finfo);
                if ($info) {
                        $this->setMimeType($info);

                        return true;
                }

                return false;
        }


        protected function determineDownloadFileName() {
                if (!$this->getDownloadFileName()) {
                        $download_file_name = basename($this->getPathToFile());
                        $this->setDownloadFileName($download_file_name);
                }
        }


        protected function detemineDeliveryType() {
                if (self::$delivery_type_static) {
                        ilWACLog::getInstance()->write('used cached delivery type');
                        $this->setDeliveryType(self::$delivery_type_static);

                        return true;
                }

                if (function_exists('apache_get_modules')
                    && in_array('mod_xsendfile', apache_get_modules())
                ) {
                        $this->setDeliveryType(self::DELIVERY_METHOD_XSENDFILE);
                }

                if (is_file('./Services/FileDelivery/classes/override.php')) {
                        $override_delivery_type = false;
                        require_once('./Services/FileDelivery/classes/override.php');
                        if ($override_delivery_type) {
                                $this->setDeliveryType($override_delivery_type);
                        }
                }

                require_once('./Services/Environment/classes/class.ilRuntime.php');
                $ilRuntime = ilRuntime::getInstance();
                if ((!$ilRuntime->isFPM() && !$ilRuntime->isHHVM())
                    && $this->getDeliveryType() == self::DELIVERY_METHOD_XACCEL
                ) {
                        $this->setDeliveryType(self::DELIVERY_METHOD_PHP);
                }

                if ($this->getDeliveryType() == self::DELIVERY_METHOD_XACCEL
                    && strpos($this->getPathToFile(), './data') !== 0
                ) {
                        $this->setDeliveryType(self::DELIVERY_METHOD_PHP);
                }

                self::$delivery_type_static = $this->getDeliveryType();

                return true;
        }


        public function getDeliveryType() {
                return $this->delivery_type;
        }


        public function setDeliveryType($delivery_type) {
                $this->delivery_type = $delivery_type;
        }


        public function getMimeType() {
                return $this->mime_type;
        }


        public function setMimeType($mime_type) {
                $this->mime_type = $mime_type;
        }


        public function getPathToFile() {
                return $this->path_to_file;
        }


        public function setPathToFile($path_to_file) {
                $this->path_to_file = $path_to_file;
        }


        public function getDownloadFileName() {
                return $this->download_file_name;
        }


        public function setDownloadFileName($download_file_name) {
                $this->download_file_name = $download_file_name;
        }


        public function getDisposition() {
                return $this->disposition;
        }


        public function setDisposition($disposition) {
                $this->disposition = $disposition;
        }


        public function isSendMimeType() {
                return $this->send_mime_type;
        }


        public function setSendMimeType($send_mime_type) {
                $this->send_mime_type = $send_mime_type;
        }


        public function isExitAfter() {
                return $this->exit_after;
        }


        public function setExitAfter($exit_after) {
                $this->exit_after = $exit_after;
        }


        public function isConvertFileNameToAsci() {
                return $this->convert_file_name_to_asci;
        }


        public function setConvertFileNameToAsci($convert_file_name_to_asci) {
                $this->convert_file_name_to_asci = $convert_file_name_to_asci;
        }


        public function getEtag() {
                return $this->etag;
        }


        public function setEtag($etag) {
                $this->etag = $etag;
        }


        public function getShowLastModified() {
                return $this->show_last_modified;
        }


        public function setShowLastModified($show_last_modified) {
                $this->show_last_modified = $show_last_modified;
        }


        public function isHasContext() {
                return $this->has_context;
        }


        public function setHasContext($has_context) {
                $this->has_context = $has_context;
        }


        public function hasCache() {
                return $this->cache;
        }


        public function setCache($cache) {
                $this->cache = $cache;
        }


        public function hasHashFilename() {
                return $this->hash_filename;
        }


        public function setHashFilename($hash_filename) {
                $this->hash_filename = $hash_filename;
        }


        protected function deliverPHPChunked() {
                $file = $this->getPathToFile();
                $fp = @fopen($file, 'rb');

                $size = filesize($file); // File size
                $length = $size;           // Content length
                $start = 0;               // Start byte
                $end = $size - 1;       // End byte
                // Now that we've gotten so far without errors we send the accept range header
                /* At the moment we only support single ranges.
                 * Multiple ranges requires some more work to ensure it works correctly
                 * and comply with the spesifications: http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.2
                 *
                 * Multirange support annouces itself with:
                 * header('Accept-Ranges: bytes');
                 *
                 * Multirange content must be sent with multipart/byteranges mediatype,
                 * (mediatype = mimetype)
                 * as well as a boundry header to indicate the various chunks of data.
                 */
                header("Accept-Ranges: 0-$length");
                // header('Accept-Ranges: bytes');
                // multipart/byteranges
                // http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.2
                if (isset($_SERVER['HTTP_RANGE'])) {
                        $c_start = $start;
                        $c_end = $end;

                        // Extract the range string
                        list(, $range) = explode('=', $_SERVER['HTTP_RANGE'], 2);
                        // Make sure the client hasn't sent us a multibyte range
                        if (strpos($range, ',') !== false) {
                                // (?) Shoud this be issued here, or should the first
                                // range be used? Or should the header be ignored and
                                // we output the whole content?
                                ilHTTP::status(416);
                                header("Content-Range: bytes $start-$end/$size");
                                // (?) Echo some info to the client?
                                $this->close();
                        } // fim do if
                        // If the range starts with an '-' we start from the beginning
                        // If not, we forward the file pointer
                        // And make sure to get the end byte if spesified
                        if ($range{0} == '-') {
                                // The n-number of the last bytes is requested
                                $c_start = $size - substr($range, 1);
                        } else {
                                $range = explode('-', $range);
                                $c_start = $range[0];
                                $c_end = (isset($range[1]) && is_numeric($range[1])) ? $range[1] : $size;
                        } // fim do if
                        /* Check the range and make sure it's treated according to the specs.
                         * http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
                         */
                        // End bytes can not be larger than $end.
                        $c_end = ($c_end > $end) ? $end : $c_end;
                        // Validate the requested range and return an error if it's not correct.
                        if ($c_start > $c_end || $c_start > $size - 1 || $c_end >= $size) {
                                ilHTTP::status(416);
                                header("Content-Range: bytes $start-$end/$size");
                                // (?) Echo some info to the client?
                                $this->close();
                        } // fim do if

                        $start = $c_start;
                        $end = $c_end;
                        $length = $end - $start + 1; // Calculate new content length
                        fseek($fp, $start);
                        ilHTTP::status(206);
                } // fim do if

                // Notify the client the byte range we'll be outputting
                header("Content-Range: bytes $start-$end/$size");
                header("Content-Length: $length");

                // Start buffered download
                $buffer = 1024 * 8;
                while (!feof($fp) && ($p = ftell($fp)) <= $end) {
                        if ($p + $buffer > $end) {
                                // In case we're only outputtin a chunk, make sure we don't
                                // read past the length
                                $buffer = $end - $p + 1;
                        } // fim do if

                        set_time_limit(0); // Reset time limit for big files
                        echo fread($fp, $buffer);
                        flush(); // Free up memory. Otherwise large files will trigger PHP's memory limit.
                } // fim do while

                fclose($fp);
        }


        protected function sendEtagHeader() {
                if ($this->getEtag()) {
                        header('ETag: ' . $this->getEtag() . '');
                }
        }


        protected function sendLastModified() {
                if ($this->getShowLastModified()) {
                        header('Last-Modified: ' . date("D, j M Y H:i:s", filemtime($this->getPathToFile()))
                               . " GMT");
                }
        }


        protected function isNonModified() {
                if (self::$DEBUG) {
                        return false;
                }

                if (!isset($_SERVER['HTTP_IF_NONE_MATCH']) || !isset($_SERVER['HTTP_IF_MODIFIED_SINCE'])) {
                        return false;
                }

                $http_if_none_match = $_SERVER['HTTP_IF_NONE_MATCH'];
                $http_if_modified_since = $_SERVER['HTTP_IF_MODIFIED_SINCE'];

                switch (true) {
                        case ($http_if_none_match != $this->getEtag()):
                                return false;
                        case (@strtotime($http_if_modified_since) <= filemtime($this->getPathToFile())):
                                return false;
                }

                return true;
        }


        public static function isDEBUG() {
                return self::$DEBUG;
        }


        public static function setDEBUG($DEBUG) {
                self::$DEBUG = $DEBUG;
        }


        public function checkCache() {
                if ($this->hasCache()) {
                        $this->generateEtag();
                        $this->sendEtagHeader();
                        $this->setShowLastModified(true);
                        $this->setCachingHeaders();
                        if ($this->isNonModified()) {
                                //ilHTTP::status(304);
                                //$this->close();
                        }
                }
        }


        public function clearBuffer() {
                $ob_get_contents = ob_get_contents();
                if ($ob_get_contents) {
                        ilWACLog::getInstance()->write(__CLASS__ . ' had output before file delivery: '
                                                       . $ob_get_contents);
                }
                ob_end_clean(); // fixed 0016469, 0016467, 0016468
        }


        protected function checkExisting() {
                if ($this->getPathToFile() != self::DIRECT_PHP_OUTPUT
                    && !file_exists($this->getPathToFile())
                ) {
                        ilHTTP::status(404);
                        $this->close();
                }
        }


        public function cleanDownloadFileName() {
                global $DIC;
                $ilClientIniFile = $DIC['ilClientIniFile'];

                if ($ilClientIniFile instanceof ilIniFile
                    && $ilClientIniFile->readVariable('file_access', 'disable_ascii')
                ) {
                        $this->setConvertFileNameToAsci(false);
                        $this->setUrlencodeFilename(false);
                }
                $download_file_name = $this->getDownloadFileName();
                if ($this->isConvertFileNameToAsci()) {
                        $download_file_name = self::returnASCIIFileName($download_file_name);
                }
                if ($this->isUrlencodeFilename()) {
                        $download_file_name = urlencode($download_file_name);
                }
                $this->setDownloadFileName($download_file_name);
        }


        public static function returnASCIIFileName($original_name) {
                return ilUtil::getASCIIFilename($original_name);
                //              return iconv("UTF-8", "ASCII//TRANSLIT", $original_name); // proposal
        }


        public function isDeleteFile() {
                return $this->delete_file;
        }


        public function setDeleteFile($delete_file) {
                $this->delete_file = $delete_file;
        }


        public function isUrlencodeFilename() {
                return $this->urlencode_filename;
        }


        public function setUrlencodeFilename($urlencode_filename) {
                $this->urlencode_filename = $urlencode_filename;
        }


        protected function sendFileUnbufferedUsingHeaders(\Closure $closure) {
                ignore_user_abort(true);
                set_time_limit(0);
                ob_start();

                $closure();

                ob_flush();
                ob_end_flush();
                flush();
        }
}