Collaboration diagram for ilFileDelivery:

Public Member Functions
	__construct ($path_to_file)

	stream ()

	deliver ()

	deliverVirtual ()
	not supported More...

	setGeneralHeaders ()

	setCachingHeaders ()

	generateEtag ()

	close ()

	getDeliveryType ()

	setDeliveryType ($delivery_type)

	getMimeType ()

	setMimeType ($mime_type)

	getPathToFile ()

	setPathToFile ($path_to_file)

	getDownloadFileName ()

	setDownloadFileName ($download_file_name)

	getDisposition ()

	setDisposition ($disposition)

	isSendMimeType ()

	setSendMimeType ($send_mime_type)

	isExitAfter ()

	setExitAfter ($exit_after)

	isConvertFileNameToAsci ()

	setConvertFileNameToAsci ($convert_file_name_to_asci)

	getEtag ()

	setEtag ($etag)

	getShowLastModified ()

	setShowLastModified ($show_last_modified)

	isHasContext ()

	setHasContext ($has_context)

	hasCache ()

	setCache ($cache)

	hasHashFilename ()

	setHashFilename ($hash_filename)

	checkCache ()

	clearBuffer ()

	isDeleteFile ()

	setDeleteFile ($delete_file)

	isUrlencodeFilename ()

	setUrlencodeFilename ($urlencode_filename)

Static Public Member Functions
static	deliverFileAttached ($path_to_file, $download_file_name=null, $mime_type=null, $delete_file=false)

static	streamVideoInline ($path_to_file, $download_file_name=null)

static	deliverFileInline ($path_to_file, $download_file_name=null)

static	isDEBUG ()

static	setDEBUG ($DEBUG)

static	returnASCIIFileName ($original_name)

Data Fields
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 Member Functions
	deliverXSendfile ()

	deliverXAccelRedirect ()

	deliverPHP ()

	clearHeaders ()

	determineMimeType ()

	determineDownloadFileName ()

	detemineDeliveryType ()

	deliverPHPChunked ()

	sendEtagHeader ()

	sendLastModified ()

	isNonModified ()

	checkExisting ()

	sendFileUnbufferedUsingHeaders (\Closure $closure)

Protected Attributes
	$delivery_type = self::DELIVERY_METHOD_PHP

	$mime_type = ''

	$path_to_file = ''

	$download_file_name = ''

	$disposition = self::DISP_ATTACHMENT

	$send_mime_type = true

	$exit_after = true

	$convert_file_name_to_asci = true

	$etag = ''

	$show_last_modified = true

	$has_context = true

	$cache = false

	$hash_filename = false

	$delete_file = false

	$urlencode_filename = false

Static Protected Attributes
static	$self_streaming_methods

static	$delivery_type_static = null

static	$DEBUG = false

Detailed Description

Class ilFileDelivery.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version: 1.0.0

Definition at line 15 of file class.ilFileDelivery.php.

Constructor & Destructor Documentation

◆ __construct()

ilFileDelivery::__construct ( $path_to_file )

Parameters

$path_to_file

Definition at line 158 of file class.ilFileDelivery.php.

References $path_to_file, detemineDeliveryType(), determineDownloadFileName(), determineMimeType(), ilContext\getType(), setHasContext(), and setPathToFile().

                                                    {
                 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);
         }

Here is the call graph for this function:

Member Function Documentation

◆ checkCache()

ilFileDelivery::checkCache ( )

Definition at line 760 of file class.ilFileDelivery.php.

References generateEtag(), hasCache(), isNonModified(), sendEtagHeader(), setCachingHeaders(), and setShowLastModified().

Referenced by deliver(), and ilPHPOutputDelivery\start().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkExisting()

ilFileDelivery::checkExisting ( )

protected

Definition at line 784 of file class.ilFileDelivery.php.

References $DIC, $download_file_name, close(), getDownloadFileName(), getPathToFile(), isConvertFileNameToAsci(), isUrlencodeFilename(), ilIniFile\readVariable(), setConvertFileNameToAsci(), setDownloadFileName(), setUrlencodeFilename(), and ilHTTP\status().

Referenced by setGeneralHeaders().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearBuffer()

ilFileDelivery::clearBuffer ( )

Definition at line 774 of file class.ilFileDelivery.php.

References ilWACLog\getInstance().

Referenced by deliver(), and ilPHPOutputDelivery\start().

                                       {
                 $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
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearHeaders()

ilFileDelivery::clearHeaders ( )

protected

Definition at line 273 of file class.ilFileDelivery.php.

Referenced by deliverVirtual(), and deliverXAccelRedirect().

                                           {
                 header_remove();
         }

Here is the caller graph for this function:

◆ close()

ilFileDelivery::close ( )

Definition at line 318 of file class.ilFileDelivery.php.

References exit.

Referenced by checkExisting(), deliver(), deliverPHPChunked(), and ilPHPOutputDelivery\stop().

                                 {
                 exit;
         }

Here is the caller graph for this function:

◆ deliver()

ilFileDelivery::deliver ( )

Definition at line 181 of file class.ilFileDelivery.php.

References checkCache(), clearBuffer(), close(), deliverPHP(), deliverPHPChunked(), deliverVirtual(), deliverXAccelRedirect(), deliverXSendfile(), getDeliveryType(), getPathToFile(), isDeleteFile(), isExitAfter(), and setGeneralHeaders().

Referenced by stream().

                                   {
                 $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();
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deliverFileAttached()

static ilFileDelivery::deliverFileAttached	(	$path_to_file,
		$download_file_name = `null`,
		$mime_type = `null`,
		$delete_file = `false`
	)

static

Parameters

	$path_to_file
null	$download_file_name
null	$mime_type
bool	$delete_file

Definition at line 112 of file class.ilFileDelivery.php.

References $delete_file, $download_file_name, $mime_type, and $path_to_file.

Referenced by ilSystemStyleSkinContainer\export(), and ilObjBibliographicGUI\sendFile().

                                                                                                                                        {
                 $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();
         }

Here is the caller graph for this function:

◆ deliverFileInline()

static ilFileDelivery::deliverFileInline	(	$path_to_file,
		$download_file_name = `null`
	)

static

Parameters

	$path_to_file
null	$download_file_name

Definition at line 144 of file class.ilFileDelivery.php.

References $download_file_name, and $path_to_file.

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

◆ deliverPHP()

ilFileDelivery::deliverPHP ( )

protected

Definition at line 265 of file class.ilFileDelivery.php.

References $file, and getPathToFile().

Referenced by deliver().

                                         {
                 set_time_limit(0);
                 $file = fopen(($this->getPathToFile()), "rb");
 
                 fpassthru($file);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deliverPHPChunked()

ilFileDelivery::deliverPHPChunked ( )

protected

Definition at line 610 of file class.ilFileDelivery.php.

References $_SERVER, $file, $size, $start, close(), getPathToFile(), header, and ilHTTP\status().

Referenced by deliver().

                                                {
                 $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);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deliverVirtual()

ilFileDelivery::deliverVirtual ( )

not supported

Definition at line 217 of file class.ilFileDelivery.php.

References $path_to_file, clearHeaders(), getPathToFile(), and header.

Referenced by deliver().

                                          {
                 $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);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deliverXAccelRedirect()

ilFileDelivery::deliverXAccelRedirect ( )

protected

Definition at line 244 of file class.ilFileDelivery.php.

References $path_to_file, clearHeaders(), getPathToFile(), header, isDeleteFile(), and sendFileUnbufferedUsingHeaders().

Referenced by deliver().

                                                    {
                 $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();
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deliverXSendfile()

ilFileDelivery::deliverXSendfile ( )

protected

Definition at line 231 of file class.ilFileDelivery.php.

References getPathToFile(), header, isDeleteFile(), and sendFileUnbufferedUsingHeaders().

Referenced by deliver().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ detemineDeliveryType()

ilFileDelivery::detemineDeliveryType ( )

protected

Returns: bool

Definition at line 360 of file class.ilFileDelivery.php.

References getDeliveryType(), ilRuntime\getInstance(), ilWACLog\getInstance(), getPathToFile(), and setDeliveryType().

Referenced by __construct().

                                                   {
                 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;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ determineDownloadFileName()

ilFileDelivery::determineDownloadFileName ( )

protected

Returns: bool

Definition at line 349 of file class.ilFileDelivery.php.

References $download_file_name, getDownloadFileName(), getPathToFile(), and setDownloadFileName().

Referenced by __construct().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ determineMimeType()

ilFileDelivery::determineMimeType ( )

protected

Returns: bool

Definition at line 326 of file class.ilFileDelivery.php.

References $info, ilMimeTypeUtil\APPLICATION__OCTET_STREAM, getPathToFile(), ilMimeTypeUtil\lookupMimeType(), and setMimeType().

Referenced by __construct().

                                                {
                 $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;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateEtag()

ilFileDelivery::generateEtag ( )

Definition at line 313 of file class.ilFileDelivery.php.

References getPathToFile(), and setEtag().

Referenced by checkCache().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDeliveryType()

ilFileDelivery::getDeliveryType ( )

Returns: string

Definition at line 405 of file class.ilFileDelivery.php.

References $delivery_type.

Referenced by deliver(), detemineDeliveryType(), setGeneralHeaders(), and stream().

                                           {
                 return $this->delivery_type;
         }

Here is the caller graph for this function:

◆ getDisposition()

ilFileDelivery::getDisposition ( )

Returns: string

Definition at line 469 of file class.ilFileDelivery.php.

References $disposition.

Referenced by setGeneralHeaders().

                                          {
                 return $this->disposition;
         }

Here is the caller graph for this function:

◆ getDownloadFileName()

ilFileDelivery::getDownloadFileName ( )

Returns: string

Definition at line 453 of file class.ilFileDelivery.php.

References $download_file_name.

Referenced by checkExisting(), determineDownloadFileName(), and setGeneralHeaders().

                                               {
                 return $this->download_file_name;
         }

Here is the caller graph for this function:

◆ getEtag()

ilFileDelivery::getEtag ( )

Returns: string

Definition at line 533 of file class.ilFileDelivery.php.

References $etag.

Referenced by isNonModified(), and sendEtagHeader().

                                   {
                 return $this->etag;
         }

Here is the caller graph for this function:

◆ getMimeType()

ilFileDelivery::getMimeType ( )

Returns: string

Definition at line 421 of file class.ilFileDelivery.php.

References $mime_type.

Referenced by setGeneralHeaders().

                                       {
                 return $this->mime_type;
         }

Here is the caller graph for this function:

◆ getPathToFile()

ilFileDelivery::getPathToFile ( )

Returns: string

Definition at line 437 of file class.ilFileDelivery.php.

References $path_to_file.

Referenced by checkExisting(), deliver(), deliverPHP(), deliverPHPChunked(), deliverVirtual(), deliverXAccelRedirect(), deliverXSendfile(), detemineDeliveryType(), determineDownloadFileName(), determineMimeType(), generateEtag(), isNonModified(), sendLastModified(), and setGeneralHeaders().

                                         {
                 return $this->path_to_file;
         }

Here is the caller graph for this function:

◆ getShowLastModified()

ilFileDelivery::getShowLastModified ( )

Returns: boolean

Definition at line 549 of file class.ilFileDelivery.php.

References $show_last_modified.

Referenced by sendLastModified().

                                               {
                 return $this->show_last_modified;
         }

Here is the caller graph for this function:

◆ hasCache()

ilFileDelivery::hasCache ( )

Returns: boolean

Definition at line 581 of file class.ilFileDelivery.php.

References $cache.

Referenced by checkCache().

                                    {
                 return $this->cache;
         }

Here is the caller graph for this function:

◆ hasHashFilename()

ilFileDelivery::hasHashFilename ( )

Returns: boolean

Definition at line 597 of file class.ilFileDelivery.php.

References $hash_filename.

Referenced by setGeneralHeaders().

                                           {
                 return $this->hash_filename;
         }

Here is the caller graph for this function:

◆ isConvertFileNameToAsci()

ilFileDelivery::isConvertFileNameToAsci ( )

Returns: boolean

Definition at line 517 of file class.ilFileDelivery.php.

References $convert_file_name_to_asci.

Referenced by checkExisting(), and setGeneralHeaders().

                                                   {
                 return $this->convert_file_name_to_asci;
         }

Here is the caller graph for this function:

◆ isDEBUG()

static ilFileDelivery::isDEBUG ( )

static

Returns: boolean

Definition at line 747 of file class.ilFileDelivery.php.

                                          {
                 return self::$DEBUG;
         }

◆ isDeleteFile()

ilFileDelivery::isDeleteFile ( )

Returns: boolean

Definition at line 832 of file class.ilFileDelivery.php.

References $delete_file.

Referenced by deliver(), deliverXAccelRedirect(), and deliverXSendfile().

                                        {
                 return $this->delete_file;
         }

Here is the caller graph for this function:

◆ isExitAfter()

ilFileDelivery::isExitAfter ( )

Returns: boolean

Definition at line 501 of file class.ilFileDelivery.php.

References $exit_after.

Referenced by deliver().

                                       {
                 return $this->exit_after;
         }

Here is the caller graph for this function:

◆ isHasContext()

ilFileDelivery::isHasContext ( )

Returns: boolean

Definition at line 565 of file class.ilFileDelivery.php.

References $has_context.

                                        {
                 return $this->has_context;
         }

◆ isNonModified()

ilFileDelivery::isNonModified ( )

protected

Returns: bool

Definition at line 721 of file class.ilFileDelivery.php.

References $_SERVER, getEtag(), and getPathToFile().

Referenced by checkCache().

                                            {
                 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;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSendMimeType()

ilFileDelivery::isSendMimeType ( )

Returns: boolean

Definition at line 485 of file class.ilFileDelivery.php.

References $send_mime_type.

Referenced by setGeneralHeaders().

                                          {
                 return $this->send_mime_type;
         }

Here is the caller graph for this function:

◆ isUrlencodeFilename()

ilFileDelivery::isUrlencodeFilename ( )

Returns: bool

Definition at line 848 of file class.ilFileDelivery.php.

References $urlencode_filename.

Referenced by checkExisting().

                                               {
                 return $this->urlencode_filename;
         }

Here is the caller graph for this function:

◆ returnASCIIFileName()

static ilFileDelivery::returnASCIIFileName ( $original_name )

static

Parameters

$original_name

Returns: string

Definition at line 823 of file class.ilFileDelivery.php.

References ilUtil\getASCIIFilename().

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

Here is the call graph for this function:

◆ sendEtagHeader()

ilFileDelivery::sendEtagHeader ( )

protected

Definition at line 703 of file class.ilFileDelivery.php.

References getEtag(), and header.

Referenced by checkCache(), and setCachingHeaders().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendFileUnbufferedUsingHeaders()

ilFileDelivery::sendFileUnbufferedUsingHeaders ( \Closure $closure )

protected

Parameters

\Closure $closure which sets the output-headers, e.g. header('X-Sendfile: ' . realpath($this->getPathToFile()));

Definition at line 865 of file class.ilFileDelivery.php.

Referenced by deliverXAccelRedirect(), and deliverXSendfile().

                                                                              {
                 ignore_user_abort(true);
                 set_time_limit(0);
                 ob_start();
 
                 $closure();
 
                 ob_flush();
                 ob_end_flush();
                 flush();
         }

Here is the caller graph for this function:

◆ sendLastModified()

ilFileDelivery::sendLastModified ( )

protected

Definition at line 710 of file class.ilFileDelivery.php.

References date, getPathToFile(), getShowLastModified(), and header.

Referenced by setCachingHeaders().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCache()

ilFileDelivery::setCache ( $cache )

Parameters

boolean $cache

Definition at line 589 of file class.ilFileDelivery.php.

References $cache.

Referenced by ilWebAccessCheckerDelivery\deliver().

                                          {
                 $this->cache = $cache;
         }

Here is the caller graph for this function:

◆ setCachingHeaders()

ilFileDelivery::setCachingHeaders ( )

Definition at line 305 of file class.ilFileDelivery.php.

References header, sendEtagHeader(), and sendLastModified().

Referenced by checkCache(), and ilPHPOutputDelivery\start().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setConvertFileNameToAsci()

ilFileDelivery::setConvertFileNameToAsci ( $convert_file_name_to_asci )

Parameters

boolean $convert_file_name_to_asci

Definition at line 525 of file class.ilFileDelivery.php.

References $convert_file_name_to_asci.

Referenced by checkExisting().

                                                                              {
                 $this->convert_file_name_to_asci = $convert_file_name_to_asci;
         }

Here is the caller graph for this function:

◆ setDEBUG()

static ilFileDelivery::setDEBUG ( $DEBUG )

static

Parameters

boolean $DEBUG

Definition at line 755 of file class.ilFileDelivery.php.

References $DEBUG.

                                                 {
                 self::$DEBUG = $DEBUG;
         }

◆ setDeleteFile()

ilFileDelivery::setDeleteFile ( $delete_file )

Parameters

boolean $delete_file

Definition at line 840 of file class.ilFileDelivery.php.

References $delete_file.

                                                     {
                 $this->delete_file = $delete_file;
         }

◆ setDeliveryType()

ilFileDelivery::setDeliveryType ( $delivery_type )

Parameters

string $delivery_type

Definition at line 413 of file class.ilFileDelivery.php.

References $delivery_type.

Referenced by detemineDeliveryType(), and stream().

                                                         {
                 $this->delivery_type = $delivery_type;
         }

Here is the caller graph for this function:

◆ setDisposition()

ilFileDelivery::setDisposition ( $disposition )

Parameters

string $disposition

Definition at line 477 of file class.ilFileDelivery.php.

References $disposition.

Referenced by ilWebAccessCheckerDelivery\deliverDummyImage(), ilWebAccessCheckerDelivery\deliverDummyVideo(), and ilPHPOutputDelivery\start().

                                                      {
                 $this->disposition = $disposition;
         }

Here is the caller graph for this function:

◆ setDownloadFileName()

ilFileDelivery::setDownloadFileName ( $download_file_name )

Parameters

string $download_file_name

Definition at line 461 of file class.ilFileDelivery.php.

References $download_file_name.

Referenced by checkExisting(), determineDownloadFileName(), and ilPHPOutputDelivery\start().

                                                                  {
                 $this->download_file_name = $download_file_name;
         }

Here is the caller graph for this function:

◆ setEtag()

ilFileDelivery::setEtag ( $etag )

Parameters

string $etag

Definition at line 541 of file class.ilFileDelivery.php.

References $etag.

Referenced by generateEtag().

                                        {
                 $this->etag = $etag;
         }

Here is the caller graph for this function:

◆ setExitAfter()

ilFileDelivery::setExitAfter ( $exit_after )

Parameters

boolean $exit_after

Definition at line 509 of file class.ilFileDelivery.php.

References $exit_after.

                                                   {
                 $this->exit_after = $exit_after;
         }

◆ setGeneralHeaders()

ilFileDelivery::setGeneralHeaders ( )

Definition at line 278 of file class.ilFileDelivery.php.

References $download_file_name, checkExisting(), getDeliveryType(), getDisposition(), getDownloadFileName(), getMimeType(), getPathToFile(), hasHashFilename(), header, isConvertFileNameToAsci(), and isSendMimeType().

Referenced by deliver(), and ilPHPOutputDelivery\start().

                                             {
                 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());
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHasContext()

ilFileDelivery::setHasContext ( $has_context )

Parameters

boolean $has_context

Definition at line 573 of file class.ilFileDelivery.php.

References $has_context.

Referenced by __construct().

                                                     {
                 $this->has_context = $has_context;
         }

Here is the caller graph for this function:

◆ setHashFilename()

ilFileDelivery::setHashFilename ( $hash_filename )

Parameters

boolean $hash_filename

Definition at line 605 of file class.ilFileDelivery.php.

References $hash_filename.

                                                         {
                 $this->hash_filename = $hash_filename;
         }

◆ setMimeType()

ilFileDelivery::setMimeType ( $mime_type )

Parameters

string $mime_type

Definition at line 429 of file class.ilFileDelivery.php.

References $mime_type.

Referenced by determineMimeType(), and ilPHPOutputDelivery\start().

                                                 {
                 $this->mime_type = $mime_type;
         }

Here is the caller graph for this function:

◆ setPathToFile()

ilFileDelivery::setPathToFile ( $path_to_file )

Parameters

string $path_to_file

Definition at line 445 of file class.ilFileDelivery.php.

References $path_to_file.

Referenced by __construct().

                                                      {
                 $this->path_to_file = $path_to_file;
         }

Here is the caller graph for this function:

◆ setSendMimeType()

ilFileDelivery::setSendMimeType ( $send_mime_type )

Parameters

boolean $send_mime_type

Definition at line 493 of file class.ilFileDelivery.php.

References $send_mime_type.

                                                          {
                 $this->send_mime_type = $send_mime_type;
         }

◆ setShowLastModified()

ilFileDelivery::setShowLastModified ( $show_last_modified )

Parameters

boolean $show_last_modified

Definition at line 557 of file class.ilFileDelivery.php.

References $show_last_modified.

Referenced by checkCache(), and ilPHPOutputDelivery\start().

                                                                  {
                 $this->show_last_modified = $show_last_modified;
         }

Here is the caller graph for this function:

◆ setUrlencodeFilename()

ilFileDelivery::setUrlencodeFilename ( $urlencode_filename )

Parameters

bool $urlencode_filename

Definition at line 856 of file class.ilFileDelivery.php.

References $urlencode_filename.

Referenced by checkExisting().

                                                                   {
                 $this->urlencode_filename = $urlencode_filename;
         }

Here is the caller graph for this function:

◆ stream()

ilFileDelivery::stream ( )

Definition at line 173 of file class.ilFileDelivery.php.

References deliver(), getDeliveryType(), and setDeliveryType().

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

Here is the call graph for this function:

◆ streamVideoInline()

static ilFileDelivery::streamVideoInline	(	$path_to_file,
		$download_file_name = `null`
	)

static

Parameters

	$path_to_file
null	$download_file_name

Definition at line 130 of file class.ilFileDelivery.php.

References $download_file_name, and $path_to_file.

                                                                                             {
                 $obj = new self($path_to_file);
                 if ($download_file_name) {
                         $obj->setDownloadFileName($download_file_name);
                 }
                 $obj->setDisposition(self::DISP_INLINE);
                 $obj->stream();
         }

Field Documentation

◆ $cache

ilFileDelivery::$cache = false

protected

Definition at line 87 of file class.ilFileDelivery.php.

Referenced by hasCache(), and setCache().

◆ $convert_file_name_to_asci

ilFileDelivery::$convert_file_name_to_asci = true

protected

Definition at line 71 of file class.ilFileDelivery.php.

Referenced by isConvertFileNameToAsci(), and setConvertFileNameToAsci().

◆ $DEBUG

ilFileDelivery::$DEBUG = false

staticprotected

Definition at line 103 of file class.ilFileDelivery.php.

Referenced by setDEBUG().

◆ $delete_file

ilFileDelivery::$delete_file = false

protected

Definition at line 95 of file class.ilFileDelivery.php.

Referenced by deliverFileAttached(), isDeleteFile(), and setDeleteFile().

◆ $delivery_type

ilFileDelivery::$delivery_type = self::DELIVERY_METHOD_PHP

protected

Definition at line 43 of file class.ilFileDelivery.php.

Referenced by getDeliveryType(), and setDeliveryType().

◆ $delivery_type_static

ilFileDelivery::$delivery_type_static = null

staticprotected

Definition at line 39 of file class.ilFileDelivery.php.

◆ $disposition

ilFileDelivery::$disposition = self::DISP_ATTACHMENT

protected

Definition at line 59 of file class.ilFileDelivery.php.

Referenced by getDisposition(), and setDisposition().

◆ $download_file_name

ilFileDelivery::$download_file_name = ''

protected

Definition at line 55 of file class.ilFileDelivery.php.

Referenced by checkExisting(), deliverFileAttached(), deliverFileInline(), determineDownloadFileName(), getDownloadFileName(), setDownloadFileName(), setGeneralHeaders(), and streamVideoInline().

◆ $etag

ilFileDelivery::$etag = ''

protected

Definition at line 75 of file class.ilFileDelivery.php.

Referenced by getEtag(), and setEtag().

◆ $exit_after

ilFileDelivery::$exit_after = true

protected

Definition at line 67 of file class.ilFileDelivery.php.

Referenced by isExitAfter(), and setExitAfter().

◆ $has_context

ilFileDelivery::$has_context = true

protected

Definition at line 83 of file class.ilFileDelivery.php.

Referenced by isHasContext(), and setHasContext().

◆ $hash_filename

ilFileDelivery::$hash_filename = false

protected

Definition at line 91 of file class.ilFileDelivery.php.

Referenced by hasHashFilename(), and setHashFilename().

◆ $mime_type

ilFileDelivery::$mime_type = ''

protected

Definition at line 47 of file class.ilFileDelivery.php.

Referenced by deliverFileAttached(), getMimeType(), and setMimeType().

◆ $path_to_file

ilFileDelivery::$path_to_file = ''

protected

Definition at line 51 of file class.ilFileDelivery.php.

Referenced by __construct(), deliverFileAttached(), deliverFileInline(), deliverVirtual(), deliverXAccelRedirect(), getPathToFile(), setPathToFile(), and streamVideoInline().

◆ $self_streaming_methods

ilFileDelivery::$self_streaming_methods

staticprotected

Initial value:

= array(
                self::DELIVERY_METHOD_XSENDFILE,
                self::DELIVERY_METHOD_XACCEL,
        )

Definition at line 32 of file class.ilFileDelivery.php.

◆ $send_mime_type

ilFileDelivery::$send_mime_type = true

protected

Definition at line 63 of file class.ilFileDelivery.php.

Referenced by isSendMimeType(), and setSendMimeType().

◆ $show_last_modified

ilFileDelivery::$show_last_modified = true

protected

Definition at line 79 of file class.ilFileDelivery.php.

Referenced by getShowLastModified(), and setShowLastModified().

◆ $urlencode_filename

ilFileDelivery::$urlencode_filename = false

protected

Definition at line 99 of file class.ilFileDelivery.php.

Referenced by isUrlencodeFilename(), and setUrlencodeFilename().

◆ DATA

const ilFileDelivery::DATA = 'data'

Definition at line 28 of file class.ilFileDelivery.php.

◆ DELIVERY_METHOD_NONE

const ilFileDelivery::DELIVERY_METHOD_NONE = 'cache'

Definition at line 18 of file class.ilFileDelivery.php.

◆ DELIVERY_METHOD_PHP

const ilFileDelivery::DELIVERY_METHOD_PHP = 'php'

Definition at line 21 of file class.ilFileDelivery.php.

◆ DELIVERY_METHOD_PHP_CHUNKED

const ilFileDelivery::DELIVERY_METHOD_PHP_CHUNKED = 'php_chunked'

Definition at line 22 of file class.ilFileDelivery.php.

◆ DELIVERY_METHOD_VIRTUAL

const ilFileDelivery::DELIVERY_METHOD_VIRTUAL = 'virtual'

Definition at line 23 of file class.ilFileDelivery.php.

◆ DELIVERY_METHOD_XACCEL

const ilFileDelivery::DELIVERY_METHOD_XACCEL = 'x-accel-redirect'

Definition at line 20 of file class.ilFileDelivery.php.

◆ DELIVERY_METHOD_XSENDFILE

const ilFileDelivery::DELIVERY_METHOD_XSENDFILE = 'mod_xsendfile'

Definition at line 19 of file class.ilFileDelivery.php.

◆ DIRECT_PHP_OUTPUT

const ilFileDelivery::DIRECT_PHP_OUTPUT = 'php://output'

Definition at line 17 of file class.ilFileDelivery.php.

Referenced by ilExcel\sendToClient(), and ilPHPOutputDelivery\start().

◆ DISP_ATTACHMENT

const ilFileDelivery::DISP_ATTACHMENT = 'attachment'

Definition at line 24 of file class.ilFileDelivery.php.

Referenced by ilObjFile\determineFileSize(), and ilPHPOutputDelivery\start().

◆ DISP_INLINE

const ilFileDelivery::DISP_INLINE = 'inline'

Definition at line 25 of file class.ilFileDelivery.php.

Referenced by ilObjFile\determineFileSize().

◆ SECURED_DATA

const ilFileDelivery::SECURED_DATA = 'secured-data'

Definition at line 27 of file class.ilFileDelivery.php.

◆ VIRTUAL_DATA

const ilFileDelivery::VIRTUAL_DATA = 'virtual-data'

Definition at line 26 of file class.ilFileDelivery.php.

The documentation for this class was generated from the following file:

Services/FileDelivery/classes/class.ilFileDelivery.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkCache()

◆ checkExisting()

◆ clearBuffer()

◆ clearHeaders()

◆ close()

◆ deliver()

◆ deliverFileAttached()

◆ deliverFileInline()

◆ deliverPHP()

◆ deliverPHPChunked()

◆ deliverVirtual()

◆ deliverXAccelRedirect()

◆ deliverXSendfile()

◆ detemineDeliveryType()

◆ determineDownloadFileName()

◆ determineMimeType()

◆ generateEtag()

◆ getDeliveryType()

◆ getDisposition()

◆ getDownloadFileName()

◆ getEtag()

◆ getMimeType()

◆ getPathToFile()

◆ getShowLastModified()

◆ hasCache()

◆ hasHashFilename()

◆ isConvertFileNameToAsci()

◆ isDEBUG()

◆ isDeleteFile()

◆ isExitAfter()

◆ isHasContext()

◆ isNonModified()

◆ isSendMimeType()

◆ isUrlencodeFilename()

◆ returnASCIIFileName()

◆ sendEtagHeader()

◆ sendFileUnbufferedUsingHeaders()

◆ sendLastModified()

◆ setCache()

◆ setCachingHeaders()

◆ setConvertFileNameToAsci()

◆ setDEBUG()

◆ setDeleteFile()

◆ setDeliveryType()

◆ setDisposition()

◆ setDownloadFileName()

◆ setEtag()

◆ setExitAfter()

◆ setGeneralHeaders()

◆ setHasContext()

◆ setHashFilename()

◆ setMimeType()

◆ setPathToFile()

◆ setSendMimeType()

◆ setShowLastModified()

◆ setUrlencodeFilename()

◆ stream()

◆ streamVideoInline()

Field Documentation

◆ $cache

◆ $convert_file_name_to_asci

◆ $DEBUG

◆ $delete_file

◆ $delivery_type

◆ $delivery_type_static

◆ $disposition

◆ $download_file_name

◆ $etag

◆ $exit_after

◆ $has_context