Collaboration diagram for ILIAS\FileDelivery\Delivery:

Public Types
enum	Disposition : string { INLINE = 'inline' }

Public Member Functions
	__construct ($input, private Services $http)

	stream ()

	deliver ()

	setGeneralHeaders ()

	setCachingHeaders ()

	generateEtag ()

	close ()

	getDeliveryType ()

	setDeliveryType (string $delivery_type)

	getMimeType ()

	setMimeType (string $mime_type)

	getPathToFile ()

	setPathToFile (string $path_to_file)

	getDownloadFileName ()

	setDownloadFileName (string $download_file_name)

	getDisposition ()

	setDisposition (string $disposition)

	isSendMimeType ()

	setSendMimeType (bool $send_mime_type)

	isExitAfter ()

	setExitAfter (bool $exit_after)

	isConvertFileNameToAsci ()

	setConvertFileNameToAsci (bool $convert_file_name_to_asci)

	getEtag ()

	setEtag (string $etag)

	getShowLastModified ()

	setShowLastModified (bool $show_last_modified)

	isHasContext ()

	setHasContext (bool $has_context)

	hasCache ()

	setCache (bool $cache)

	hasHashFilename ()

	setHashFilename (bool $hash_filename)

	checkCache ()

	clearBuffer ()

	isDeleteFile ()

	setDeleteFile (bool $delete_file)

Static Public Member Functions
static	isDEBUG ()

static	setDEBUG (bool $DEBUG)

static	returnASCIIFileName (string $original_filename)
	Converts a UTF-8 filename to ASCII. More...

Data Fields
const	DIRECT_PHP_OUTPUT = 'php://output'

const	DISP_ATTACHMENT = 'attachment'

const	DISP_INLINE = 'inline'

const	EXPIRES_IN = '+5 days'

Private Member Functions
	delivery ()

	determineMimeType ()

	determineDownloadFileName ()

	detemineDeliveryType ()

	sendEtagHeader ()

	sendLastModified ()

	checkExisting ()

	cleanDownloadFileName ()
	Converts the filename to ASCII. More...

	setDispositionHeaders ()

Private Attributes
string	$delivery_type = DeliveryMethod::PHP

string	$mime_type = ''

string	$path_to_file = ''

string	$download_file_name = ''

string	$disposition = self::DISP_ATTACHMENT

bool	$send_mime_type = true

bool	$exit_after = true

bool	$convert_file_name_to_asci = true

string	$etag = ''

bool	$show_last_modified = true

bool	$has_context = true

bool	$cache = false

bool	$hash_filename = false

bool	$delete_file = false

FileDeliveryTypeFactory	$factory

FileStream	$resource = null

Static Private Attributes
static string	$delivery_type_static = null

static bool	$DEBUG = false

Detailed Description

Class Delivery.

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

Version: 2.0.0

Since: 5.3

Definition at line 39 of file Delivery.php.

Member Enumeration Documentation

◆ Disposition

enum ILIAS::FileDelivery::Delivery::Disposition : string

Author: Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Enumerator
INLINE

Definition at line 26 of file Disposition.php.

                 : string
 {
     case ATTACHMENT = 'attachment';
     case INLINE = 'inline';
 }

Constructor & Destructor Documentation

◆ __construct()

ILIAS\FileDelivery\Delivery::__construct	(		$input,
		private Services	$http
	)

Parameters

string \| FileStream	$path_to_file
Services	$http

Definition at line 81 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\detemineDeliveryType(), ILIAS\FileDelivery\Delivery\determineDownloadFileName(), ILIAS\FileDelivery\Delivery\determineMimeType(), factory(), ilContext\getType(), ILIAS\FileDelivery\http(), null, ILIAS\FileDelivery\Delivery\setHasContext(), and ILIAS\FileDelivery\Delivery\setPathToFile().

     {
         if ($input instanceof FileStream) {
             $this->resource = $input;
             $this->path_to_file = $input->getMetadata('uri');
         } elseif ($input === self::DIRECT_PHP_OUTPUT) {
             $this->setPathToFile(self::DIRECT_PHP_OUTPUT);
         } else {
             $this->setPathToFile($input);
         }
 
         $this->detemineDeliveryType();
         $this->determineMimeType();
         $this->determineDownloadFileName();
 
         $this->setHasContext(\ilContext::getType() !== null);
         $this->factory = new FileDeliveryTypeFactory($this->http);
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkCache()

ILIAS\FileDelivery\Delivery::checkCache ( )

Definition at line 456 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\generateEtag(), ILIAS\FileDelivery\Delivery\hasCache(), ILIAS\FileDelivery\Delivery\sendEtagHeader(), ILIAS\FileDelivery\Delivery\setCachingHeaders(), and ILIAS\FileDelivery\Delivery\setShowLastModified().

Referenced by ILIAS\FileDelivery\Delivery\deliver().

                                 : void
     {
         if ($this->hasCache()) {
             $this->generateEtag();
             $this->sendEtagHeader();
             $this->setShowLastModified(true);
             $this->setCachingHeaders();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkExisting()

ILIAS\FileDelivery\Delivery::checkExisting ( )

private

Definition at line 486 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\close(), and ILIAS\FileDelivery\Delivery\getPathToFile().

Referenced by ILIAS\FileDelivery\Delivery\setGeneralHeaders().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cleanDownloadFileName()

ILIAS\FileDelivery\Delivery::cleanDownloadFileName ( )

private

Converts the filename to ASCII.

Definition at line 499 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\getDownloadFileName(), and ILIAS\FileDelivery\Delivery\setDownloadFileName().

Referenced by ILIAS\FileDelivery\Delivery\setGeneralHeaders().

                                             : void
     {
         $download_file_name = self::returnASCIIFileName($this->getDownloadFileName());
         $this->setDownloadFileName($download_file_name);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearBuffer()

ILIAS\FileDelivery\Delivery::clearBuffer ( )

Returns: bool

Definition at line 470 of file Delivery.php.

Referenced by ILIAS\FileDelivery\Delivery\deliver().

                                  : bool
     {
         try {
             $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
             return true;
         } catch (\Throwable) {
             return false;
         }
     }

Here is the caller graph for this function:

◆ close()

ILIAS\FileDelivery\Delivery::close ( )

Definition at line 190 of file Delivery.php.

References ILIAS\FileDelivery\http().

Referenced by ILIAS\FileDelivery\Delivery\checkExisting(), and ILIAS\FileDelivery\Delivery\deliver().

                            : void
     {
         $this->http->close();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deliver()

ILIAS\FileDelivery\Delivery::deliver ( )

Definition at line 119 of file Delivery.php.

References $response, ILIAS\FileDelivery\Delivery\checkCache(), ILIAS\FileDelivery\Delivery\clearBuffer(), ILIAS\FileDelivery\Delivery\close(), ILIAS\FileDelivery\Delivery\delivery(), ILIAS\FileDelivery\Delivery\getDeliveryType(), ILIAS\FileDelivery\Delivery\getPathToFile(), ILIAS\FileDelivery\http(), ILIAS\FileDelivery\Delivery\isDeleteFile(), ILIAS\FileDelivery\Delivery\isExitAfter(), and ILIAS\FileDelivery\Delivery\setGeneralHeaders().

Referenced by ilFileDelivery\deliverFileLegacy(), and ILIAS\FileDelivery\Delivery\stream().

                              : void
     {
         $response = $this->http->response()->withHeader('X-ILIAS-FileDelivery-Method', $this->getDeliveryType());
         if (
             !$this->delivery()->doesFileExists($this->path_to_file)
             && $this->path_to_file !== self::DIRECT_PHP_OUTPUT
         ) {
             $response = $this->http->response()->withStatus(404);
             $this->http->saveResponse($response);
             $this->http->sendResponse();
             $this->close();
         }
         $this->http->saveResponse($response);
 
         $this->clearBuffer();
         $this->checkCache();
         $this->setGeneralHeaders();
         $this->delivery()->prepare($this->getPathToFile(), $this->resource);
         $this->delivery()->deliver($this->getPathToFile(), $this->isDeleteFile());
         if ($this->isDeleteFile()) {
             $this->delivery()->handleFileDeletion($this->getPathToFile());
         }
         if ($this->isExitAfter()) {
             $this->close();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delivery()

ILIAS\FileDelivery\Delivery::delivery ( )

private

Definition at line 109 of file Delivery.php.

References factory(), ILIAS\FileDelivery\Delivery\getDeliveryType(), ILIAS\FileDelivery\Delivery\isDeleteFile(), and ILIAS\FileDelivery\FileDeliveryTypes\DeliveryMethod\PHP.

Referenced by ILIAS\FileDelivery\Delivery\deliver(), and ILIAS\FileDelivery\Delivery\stream().

                                : ilFileDeliveryType
     {
         if ($this->isDeleteFile()) {
             return $this->factory->getInstance(DeliveryMethod::PHP);
         }
 
         return $this->factory->getInstance($this->getDeliveryType());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ detemineDeliveryType()

ILIAS\FileDelivery\Delivery::detemineDeliveryType ( )

private

Definition at line 224 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\getDeliveryType(), ilRuntime\getInstance(), ILIAS\FileDelivery\Delivery\getPathToFile(), ILIAS\FileDelivery\FileDeliveryTypes\DeliveryMethod\PHP, ILIAS\FileDelivery\Delivery\setDeliveryType(), ILIAS\FileDelivery\FileDeliveryTypes\DeliveryMethod\XACCEL, and ILIAS\FileDelivery\FileDeliveryTypes\DeliveryMethod\XSENDFILE.

Referenced by ILIAS\FileDelivery\Delivery\__construct().

                                            : void
     {
         if (self::$delivery_type_static) {
             $this->setDeliveryType(self::$delivery_type_static);
 
             return;
         }
 
         if (function_exists('apache_get_modules')
             && in_array('mod_xsendfile', apache_get_modules(), true)
         ) {
             $this->setDeliveryType(DeliveryMethod::XSENDFILE);
         }
 
         //        if (function_exists('apache_get_version') && strpos(apache_get_version(), '2.4.') !== false) {
         //            $this->setDeliveryType(DeliveryMethod::XSENDFILE);
         //        }
 
         if (is_file('./components/ILIAS/FileDelivery/classes/override.php')) {
             $override_delivery_type = false;
             require_once('./components/ILIAS/FileDelivery/classes/override.php');
             if ($override_delivery_type) {
                 $this->setDeliveryType($override_delivery_type);
             }
         }
         $ilRuntime = \ilRuntime::getInstance();
         if ((!$ilRuntime->isFPM() && !$ilRuntime->isHHVM())
             && $this->getDeliveryType() === DeliveryMethod::XACCEL
         ) {
             $this->setDeliveryType(DeliveryMethod::PHP);
         }
 
         if ($this->getDeliveryType() === DeliveryMethod::XACCEL
             && !str_starts_with($this->getPathToFile(), './public/data')
         ) {
             $this->setDeliveryType(DeliveryMethod::PHP);
         }
 
         self::$delivery_type_static = $this->getDeliveryType();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ determineDownloadFileName()

ILIAS\FileDelivery\Delivery::determineDownloadFileName ( )

private

Definition at line 215 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\getDownloadFileName(), ILIAS\FileDelivery\Delivery\getPathToFile(), and ILIAS\FileDelivery\Delivery\setDownloadFileName().

Referenced by ILIAS\FileDelivery\Delivery\__construct().

                                                 : void
     {
         if ($this->getDownloadFileName() === '' || $this->getDownloadFileName() === '0') {
             $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()

ILIAS\FileDelivery\Delivery::determineMimeType ( )

private

Definition at line 196 of file Delivery.php.

References $info, ILIAS\FileUpload\MimeType\APPLICATION__OCTET_STREAM, ILIAS\FileDelivery\Delivery\getPathToFile(), ILIAS\FileUpload\MimeType\lookupMimeType(), and ILIAS\FileDelivery\Delivery\setMimeType().

Referenced by ILIAS\FileDelivery\Delivery\__construct().

                                         : void
     {
         $info = MimeType::lookupMimeType($this->getPathToFile(), MimeType::APPLICATION__OCTET_STREAM);
         if ($info !== '' && $info !== '0') {
             $this->setMimeType($info);
 
             return;
         }
         $finfo = finfo_open(FILEINFO_MIME_TYPE);
         $info = finfo_file($finfo, $this->getPathToFile());
         finfo_close($finfo);
         if ($info) {
             $this->setMimeType($info);
 
             return;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateEtag()

ILIAS\FileDelivery\Delivery::generateEtag ( )

Definition at line 184 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\getPathToFile(), and ILIAS\FileDelivery\Delivery\setEtag().

Referenced by ILIAS\FileDelivery\Delivery\checkCache().

                                   : void
     {
         $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()

ILIAS\FileDelivery\Delivery::getDeliveryType ( )

Definition at line 267 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$delivery_type.

Referenced by ILIAS\FileDelivery\Delivery\deliver(), ILIAS\FileDelivery\Delivery\delivery(), ILIAS\FileDelivery\Delivery\detemineDeliveryType(), and ILIAS\FileDelivery\Delivery\setGeneralHeaders().

                                      : string
     {
         return $this->delivery_type;
     }

Here is the caller graph for this function:

◆ getDisposition()

ILIAS\FileDelivery\Delivery::getDisposition ( )

Definition at line 315 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$disposition.

Referenced by ILIAS\FileDelivery\Delivery\setDispositionHeaders().

                                     : string
     {
         return $this->disposition;
     }

Here is the caller graph for this function:

◆ getDownloadFileName()

ILIAS\FileDelivery\Delivery::getDownloadFileName ( )

Definition at line 303 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$download_file_name.

Referenced by ILIAS\FileDelivery\Delivery\cleanDownloadFileName(), ILIAS\FileDelivery\Delivery\determineDownloadFileName(), ILIAS\FileDelivery\Delivery\setDispositionHeaders(), and ILIAS\FileDelivery\Delivery\setGeneralHeaders().

                                          : string
     {
         return $this->download_file_name;
     }

Here is the caller graph for this function:

◆ getEtag()

ILIAS\FileDelivery\Delivery::getEtag ( )

Definition at line 363 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$etag.

Referenced by ILIAS\FileDelivery\Delivery\sendEtagHeader().

                              : string
     {
         return $this->etag;
     }

Here is the caller graph for this function:

◆ getMimeType()

ILIAS\FileDelivery\Delivery::getMimeType ( )

Definition at line 279 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$mime_type.

Referenced by ILIAS\FileDelivery\Delivery\setGeneralHeaders().

                                  : string
     {
         return $this->mime_type;
     }

Here is the caller graph for this function:

◆ getPathToFile()

ILIAS\FileDelivery\Delivery::getPathToFile ( )

Definition at line 291 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$path_to_file.

Referenced by ILIAS\FileDelivery\Delivery\checkExisting(), ILIAS\FileDelivery\Delivery\deliver(), ILIAS\FileDelivery\Delivery\detemineDeliveryType(), ILIAS\FileDelivery\Delivery\determineDownloadFileName(), ILIAS\FileDelivery\Delivery\determineMimeType(), ILIAS\FileDelivery\Delivery\generateEtag(), ILIAS\FileDelivery\Delivery\sendLastModified(), and ILIAS\FileDelivery\Delivery\setGeneralHeaders().

                                    : string
     {
         return $this->path_to_file;
     }

Here is the caller graph for this function:

◆ getShowLastModified()

ILIAS\FileDelivery\Delivery::getShowLastModified ( )

Definition at line 375 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$show_last_modified.

Referenced by ILIAS\FileDelivery\Delivery\sendLastModified().

                                          : bool
     {
         return $this->show_last_modified;
     }

Here is the caller graph for this function:

◆ hasCache()

ILIAS\FileDelivery\Delivery::hasCache ( )

Definition at line 399 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$cache.

Referenced by ILIAS\FileDelivery\Delivery\checkCache().

                               : bool
     {
         return $this->cache;
     }

Here is the caller graph for this function:

◆ hasHashFilename()

ILIAS\FileDelivery\Delivery::hasHashFilename ( )

Definition at line 411 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$hash_filename.

Referenced by ILIAS\FileDelivery\Delivery\setGeneralHeaders().

                                      : bool
     {
         return $this->hash_filename;
     }

Here is the caller graph for this function:

◆ isConvertFileNameToAsci()

ILIAS\FileDelivery\Delivery::isConvertFileNameToAsci ( )

Definition at line 351 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$convert_file_name_to_asci.

Referenced by ILIAS\FileDelivery\Delivery\setGeneralHeaders().

                                              : bool
     {
         return $this->convert_file_name_to_asci;
     }

Here is the caller graph for this function:

◆ isDEBUG()

static ILIAS\FileDelivery\Delivery::isDEBUG ( )

static

Definition at line 444 of file Delivery.php.

                                     : bool
     {
         return self::$DEBUG;
     }

◆ isDeleteFile()

ILIAS\FileDelivery\Delivery::isDeleteFile ( )

Definition at line 542 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$delete_file.

Referenced by ILIAS\FileDelivery\Delivery\deliver(), and ILIAS\FileDelivery\Delivery\delivery().

                                   : bool
     {
         return $this->delete_file;
     }

Here is the caller graph for this function:

◆ isExitAfter()

ILIAS\FileDelivery\Delivery::isExitAfter ( )

Definition at line 339 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$exit_after.

Referenced by ILIAS\FileDelivery\Delivery\deliver().

                                  : bool
     {
         return $this->exit_after;
     }

Here is the caller graph for this function:

◆ isHasContext()

ILIAS\FileDelivery\Delivery::isHasContext ( )

Definition at line 387 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$has_context.

                                   : bool
     {
         return $this->has_context;
     }

◆ isSendMimeType()

ILIAS\FileDelivery\Delivery::isSendMimeType ( )

Definition at line 327 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$send_mime_type.

Referenced by ILIAS\FileDelivery\Delivery\setGeneralHeaders().

                                     : bool
     {
         return $this->send_mime_type;
     }

Here is the caller graph for this function:

◆ returnASCIIFileName()

static ILIAS\FileDelivery\Delivery::returnASCIIFileName ( string $original_filename )

static

Converts a UTF-8 filename to ASCII.

Parameters

$original_filename string UFT8-Filename

Returns: string ASCII-Filename

Definition at line 513 of file Delivery.php.

Referenced by ilFileDataForumDraftsRCImplementation\deliverZipFile(), and ilFileDataForumRCImplementation\deliverZipFile().

                                                                          : string
     {
         $umlaut_mapping = [
             "Ä" => "Ae",
             "Ö" => "Oe",
             "Ü" => "Ue",
             "ä" => "ae",
             "ö" => "oe",
             "ü" => "ue",
             "ß" => "ss"
         ];
         foreach ($umlaut_mapping as $src => $tgt) {
             $original_filename = str_replace($src, $tgt, $original_filename);
         }
 
         $ascii_filename = htmlentities($original_filename, ENT_NOQUOTES, 'UTF-8');
         $ascii_filename = preg_replace('/\&(.)[^;]*;/', '\\1', $ascii_filename);
         $ascii_filename = preg_replace('/[\x7f-\xff]/', '_', (string) $ascii_filename);
 
         // OS do not allow the following characters in filenames: \/:*?"<>|
         $ascii_filename = preg_replace(
             '/[:\x5c\/\*\?\"<>\|]/',
             '_',
             (string) $ascii_filename
         );
         return $ascii_filename;
     }

Here is the caller graph for this function:

◆ sendEtagHeader()

ILIAS\FileDelivery\Delivery::sendEtagHeader ( )

private

Definition at line 423 of file Delivery.php.

References $response, ILIAS\FileDelivery\Delivery\getEtag(), and ILIAS\FileDelivery\http().

Referenced by ILIAS\FileDelivery\Delivery\checkCache(), and ILIAS\FileDelivery\Delivery\setCachingHeaders().

                                      : void
     {
         if ($this->getEtag() !== '' && $this->getEtag() !== '0') {
             $response = $this->http->response()->withHeader('ETag', $this->getEtag());
             $this->http->saveResponse($response);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendLastModified()

ILIAS\FileDelivery\Delivery::sendLastModified ( )

private

Definition at line 432 of file Delivery.php.

References $response, ILIAS\FileDelivery\Delivery\getPathToFile(), ILIAS\FileDelivery\Delivery\getShowLastModified(), and ILIAS\FileDelivery\http().

Referenced by ILIAS\FileDelivery\Delivery\setCachingHeaders().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCache()

ILIAS\FileDelivery\Delivery::setCache ( bool $cache )

Definition at line 405 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$cache.

                                          : void
     {
         $this->cache = $cache;
     }

◆ setCachingHeaders()

ILIAS\FileDelivery\Delivery::setCachingHeaders ( )

Definition at line 174 of file Delivery.php.

References $response, ILIAS\StaticURL\Response\Response\ResponseHeader\CACHE_CONTROL, ILIAS\StaticURL\Response\Response\ResponseHeader\EXPIRES, ILIAS\FileDelivery\http(), ILIAS\StaticURL\Response\Response\ResponseHeader\PRAGMA, ILIAS\FileDelivery\Delivery\sendEtagHeader(), and ILIAS\FileDelivery\Delivery\sendLastModified().

Referenced by ILIAS\FileDelivery\Delivery\checkCache().

                                        : void
     {
         $response = $this->http->response()->withHeader(ResponseHeader::CACHE_CONTROL, 'must-revalidate, post-check=0, pre-check=0')->withHeader(ResponseHeader::PRAGMA, 'public');
 
         $this->http->saveResponse($response->withHeader(ResponseHeader::EXPIRES, date("D, j M Y H:i:s", strtotime(self::EXPIRES_IN)) . " GMT"));
         $this->sendEtagHeader();
         $this->sendLastModified();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setConvertFileNameToAsci()

ILIAS\FileDelivery\Delivery::setConvertFileNameToAsci ( bool $convert_file_name_to_asci )

Definition at line 357 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$convert_file_name_to_asci.

Referenced by ilFileDelivery\deliverFileLegacy().

                                                                              : void
     {
         $this->convert_file_name_to_asci = $convert_file_name_to_asci;
     }

Here is the caller graph for this function:

◆ setDEBUG()

static ILIAS\FileDelivery\Delivery::setDEBUG ( bool $DEBUG )

static

Definition at line 450 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$DEBUG.

                                                 : void
     {
         self::$DEBUG = $DEBUG;
     }

◆ setDeleteFile()

ILIAS\FileDelivery\Delivery::setDeleteFile ( bool $delete_file )

Definition at line 548 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$delete_file.

Referenced by ilFileDelivery\deliverFileLegacy().

                                                     : void
     {
         $this->delete_file = $delete_file;
     }

Here is the caller graph for this function:

◆ setDeliveryType()

ILIAS\FileDelivery\Delivery::setDeliveryType ( string $delivery_type )

Definition at line 273 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$delivery_type.

Referenced by ILIAS\FileDelivery\Delivery\detemineDeliveryType(), and ILIAS\FileDelivery\Delivery\stream().

                                                           : void
     {
         $this->delivery_type = $delivery_type;
     }

Here is the caller graph for this function:

◆ setDisposition()

ILIAS\FileDelivery\Delivery::setDisposition ( string $disposition )

Definition at line 321 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$disposition.

Referenced by ilFileDelivery\deliverFileLegacy().

                                                        : void
     {
         $this->disposition = $disposition;
     }

Here is the caller graph for this function:

◆ setDispositionHeaders()

ILIAS\FileDelivery\Delivery::setDispositionHeaders ( )

private

Definition at line 554 of file Delivery.php.

References $response, ILIAS\StaticURL\Response\Response\ResponseHeader\CONTENT_DISPOSITION, ILIAS\FileDelivery\Delivery\getDisposition(), ILIAS\FileDelivery\Delivery\getDownloadFileName(), and ILIAS\FileDelivery\http().

Referenced by ILIAS\FileDelivery\Delivery\setGeneralHeaders().

                                             : void
     {
         $response = $this->http->response();
         $response = $response->withHeader(
             ResponseHeader::CONTENT_DISPOSITION,
             $this->getDisposition()
                                                . '; filename="'
                                                . $this->getDownloadFileName()
                                                . '"'
         );
         $response = $response->withHeader('Content-Description', $this->getDownloadFileName());
         $this->http->saveResponse($response);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDownloadFileName()

ILIAS\FileDelivery\Delivery::setDownloadFileName ( string $download_file_name )

Definition at line 309 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$download_file_name.

Referenced by ILIAS\FileDelivery\Delivery\cleanDownloadFileName(), ilFileDelivery\deliverFileLegacy(), ILIAS\FileDelivery\Delivery\determineDownloadFileName(), and ILIAS\FileDelivery\Delivery\setGeneralHeaders().

                                                                    : void
     {
         $this->download_file_name = $download_file_name;
     }

Here is the caller graph for this function:

◆ setEtag()

ILIAS\FileDelivery\Delivery::setEtag ( string $etag )

Definition at line 369 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$etag.

Referenced by ILIAS\FileDelivery\Delivery\generateEtag().

                                          : void
     {
         $this->etag = $etag;
     }

Here is the caller graph for this function:

◆ setExitAfter()

ILIAS\FileDelivery\Delivery::setExitAfter ( bool $exit_after )

Definition at line 345 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$exit_after.

Referenced by ilFileDelivery\deliverFileLegacy().

                                                   : void
     {
         $this->exit_after = $exit_after;
     }

Here is the caller graph for this function:

◆ setGeneralHeaders()

ILIAS\FileDelivery\Delivery::setGeneralHeaders ( )

Definition at line 147 of file Delivery.php.

Referenced by ILIAS\FileDelivery\Delivery\deliver().

                                        : void
     {
         $this->checkExisting();
         if ($this->isSendMimeType()) {
             $response = $this->http->response()->withHeader(ResponseHeader::CONTENT_TYPE, $this->getMimeType());
             $this->http->saveResponse($response);
         }
         if ($this->isConvertFileNameToAsci()) {
             $this->cleanDownloadFileName();
         }
         if ($this->hasHashFilename()) {
             $this->setDownloadFileName(md5($this->getDownloadFileName()));
         }
         $this->setDispositionHeaders();
         $response = $this->http->response()->withHeader(ResponseHeader::ACCEPT_RANGES, 'bytes');
         $this->http->saveResponse($response);
         if ($this->getDeliveryType() === DeliveryMethod::PHP
             && $this->getPathToFile() !== self::DIRECT_PHP_OUTPUT
         ) {
             $response = $this->http->response()->withHeader(ResponseHeader::CONTENT_LENGTH, (string) filesize($this->getPathToFile()));
             $this->http->saveResponse($response);
         }
         $response = $this->http->response()->withHeader(ResponseHeader::CONNECTION, "close");
         $this->http->saveResponse($response);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHasContext()

ILIAS\FileDelivery\Delivery::setHasContext ( bool $has_context )

Definition at line 393 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$has_context.

Referenced by ILIAS\FileDelivery\Delivery\__construct().

                                                     : void
     {
         $this->has_context = $has_context;
     }

Here is the caller graph for this function:

◆ setHashFilename()

ILIAS\FileDelivery\Delivery::setHashFilename ( bool $hash_filename )

Definition at line 417 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$hash_filename.

                                                         : void
     {
         $this->hash_filename = $hash_filename;
     }

◆ setMimeType()

ILIAS\FileDelivery\Delivery::setMimeType ( string $mime_type )

Definition at line 285 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$mime_type.

Referenced by ilUtil\deliverData(), ilFileDelivery\deliverFileLegacy(), and ILIAS\FileDelivery\Delivery\determineMimeType().

                                                   : void
     {
         $this->mime_type = $mime_type;
     }

Here is the caller graph for this function:

◆ setPathToFile()

ILIAS\FileDelivery\Delivery::setPathToFile ( string $path_to_file )

Definition at line 297 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$path_to_file.

Referenced by ILIAS\FileDelivery\Delivery\__construct().

                                                        : void
     {
         $this->path_to_file = $path_to_file;
     }

Here is the caller graph for this function:

◆ setSendMimeType()

ILIAS\FileDelivery\Delivery::setSendMimeType ( bool $send_mime_type )

Definition at line 333 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$send_mime_type.

                                                          : void
     {
         $this->send_mime_type = $send_mime_type;
     }

◆ setShowLastModified()

ILIAS\FileDelivery\Delivery::setShowLastModified ( bool $show_last_modified )

Definition at line 381 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$show_last_modified.

Referenced by ILIAS\FileDelivery\Delivery\checkCache().

                                                                  : void
     {
         $this->show_last_modified = $show_last_modified;
     }

Here is the caller graph for this function:

◆ stream()

ILIAS\FileDelivery\Delivery::stream ( )

Definition at line 101 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\deliver(), ILIAS\FileDelivery\Delivery\delivery(), ILIAS\FileDelivery\FileDeliveryTypes\DeliveryMethod\PHP_CHUNKED, and ILIAS\FileDelivery\Delivery\setDeliveryType().

                             : void
     {
         if (!$this->delivery()->supportsStreaming()) {
             $this->setDeliveryType(DeliveryMethod::PHP_CHUNKED);
         }
         $this->deliver();
     }

Here is the call graph for this function:

Field Documentation

◆ $cache

bool ILIAS\FileDelivery\Delivery::$cache = false

private

Definition at line 69 of file Delivery.php.

Referenced by ILIAS\FileDelivery\Delivery\hasCache(), and ILIAS\FileDelivery\Delivery\setCache().

◆ $convert_file_name_to_asci

bool ILIAS\FileDelivery\Delivery::$convert_file_name_to_asci = true

private

Definition at line 65 of file Delivery.php.

Referenced by ILIAS\FileDelivery\Delivery\isConvertFileNameToAsci(), and ILIAS\FileDelivery\Delivery\setConvertFileNameToAsci().

◆ $DEBUG

bool ILIAS\FileDelivery\Delivery::$DEBUG = false

staticprivate

Definition at line 72 of file Delivery.php.

Referenced by ILIAS\FileDelivery\Delivery\setDEBUG().

◆ $delete_file

bool ILIAS\FileDelivery\Delivery::$delete_file = false

private

Definition at line 71 of file Delivery.php.

Referenced by ILIAS\FileDelivery\Delivery\LegacyDelivery\attached(), ILIAS\FileDelivery\Delivery\isDeleteFile(), and ILIAS\FileDelivery\Delivery\setDeleteFile().

◆ $delivery_type

string ILIAS\FileDelivery\Delivery::$delivery_type = DeliveryMethod::PHP

private

Definition at line 58 of file Delivery.php.

Referenced by ILIAS\FileDelivery\Delivery\getDeliveryType(), and ILIAS\FileDelivery\Delivery\setDeliveryType().

◆ $delivery_type_static

string ILIAS\FileDelivery\Delivery::$delivery_type_static = null

staticprivate

Definition at line 57 of file Delivery.php.

◆ $disposition

string ILIAS\FileDelivery\Delivery::$disposition = self::DISP_ATTACHMENT

private

Definition at line 62 of file Delivery.php.

Referenced by ILIAS\FileDelivery\Delivery\LegacyDelivery\deliver(), ILIAS\FileDelivery\Delivery\StreamDelivery\deliver(), ILIAS\FileDelivery\Delivery\StreamDelivery\deliverFromToken(), ILIAS\FileDelivery\Delivery\getDisposition(), ILIAS\FileDelivery\Delivery\setDisposition(), and ILIAS\FileDelivery\Delivery\BaseDelivery\setGeneralHeaders().

◆ $download_file_name

string ILIAS\FileDelivery\Delivery::$download_file_name = ''

private

Definition at line 61 of file Delivery.php.

Referenced by ILIAS\FileDelivery\Delivery\LegacyDelivery\attached(), ILIAS\FileDelivery\Delivery\getDownloadFileName(), and ILIAS\FileDelivery\Delivery\setDownloadFileName().

◆ $etag

string ILIAS\FileDelivery\Delivery::$etag = ''

private

Definition at line 66 of file Delivery.php.

Referenced by ILIAS\FileDelivery\Delivery\getEtag(), and ILIAS\FileDelivery\Delivery\setEtag().

◆ $exit_after

bool ILIAS\FileDelivery\Delivery::$exit_after = true

private

Definition at line 64 of file Delivery.php.

Referenced by ILIAS\FileDelivery\Delivery\isExitAfter(), and ILIAS\FileDelivery\Delivery\setExitAfter().

◆ $factory

FileDeliveryTypeFactory ILIAS\FileDelivery\Delivery::$factory

private

Definition at line 73 of file Delivery.php.

◆ $has_context

bool ILIAS\FileDelivery\Delivery::$has_context = true

private

Definition at line 68 of file Delivery.php.

Referenced by ILIAS\FileDelivery\Delivery\isHasContext(), and ILIAS\FileDelivery\Delivery\setHasContext().

◆ $hash_filename

bool ILIAS\FileDelivery\Delivery::$hash_filename = false

private

Definition at line 70 of file Delivery.php.

Referenced by ILIAS\FileDelivery\Delivery\hasHashFilename(), and ILIAS\FileDelivery\Delivery\setHashFilename().

◆ $mime_type

string ILIAS\FileDelivery\Delivery::$mime_type = ''

private

Definition at line 59 of file Delivery.php.

Referenced by ILIAS\FileDelivery\Delivery\LegacyDelivery\attached(), ILIAS\FileDelivery\Delivery\StreamDelivery\attached(), ILIAS\FileDelivery\Delivery\getMimeType(), and ILIAS\FileDelivery\Delivery\setMimeType().

◆ $path_to_file

string ILIAS\FileDelivery\Delivery::$path_to_file = ''

private

Definition at line 60 of file Delivery.php.

Referenced by ILIAS\FileDelivery\Delivery\ResponseBuilder\XAccelResponseBuilder\buildForStream(), ILIAS\FileDelivery\Delivery\LegacyDelivery\deliver(), ILIAS\FileDelivery\Delivery\getPathToFile(), and ILIAS\FileDelivery\Delivery\setPathToFile().

◆ $resource

FileStream ILIAS\FileDelivery\Delivery::$resource = null

private

Definition at line 74 of file Delivery.php.

◆ $send_mime_type

bool ILIAS\FileDelivery\Delivery::$send_mime_type = true

private

Definition at line 63 of file Delivery.php.

Referenced by ILIAS\FileDelivery\Delivery\isSendMimeType(), and ILIAS\FileDelivery\Delivery\setSendMimeType().

◆ $show_last_modified

bool ILIAS\FileDelivery\Delivery::$show_last_modified = true

private

Definition at line 67 of file Delivery.php.

Referenced by ILIAS\FileDelivery\Delivery\getShowLastModified(), and ILIAS\FileDelivery\Delivery\setShowLastModified().

◆ DIRECT_PHP_OUTPUT

const ILIAS\FileDelivery\Delivery::DIRECT_PHP_OUTPUT = 'php://output'

Definition at line 44 of file Delivery.php.

Referenced by ILIAS\HTTP\HTTPUtil\deliverStream(), and ILIAS\HTTP\HTTPUtil\deliverString().

◆ DISP_ATTACHMENT

const ILIAS\FileDelivery\Delivery::DISP_ATTACHMENT = 'attachment'

Definition at line 48 of file Delivery.php.

Referenced by ILIAS\HTTP\HTTPUtil\deliverStream(), and ILIAS\HTTP\HTTPUtil\deliverString().

◆ DISP_INLINE

const ILIAS\FileDelivery\Delivery::DISP_INLINE = 'inline'

Definition at line 52 of file Delivery.php.

◆ EXPIRES_IN

const ILIAS\FileDelivery\Delivery::EXPIRES_IN = '+5 days'

Definition at line 56 of file Delivery.php.

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

components/ILIAS/FileDelivery/classes/Delivery.php
components/ILIAS/FileDelivery/src/Delivery/Disposition.php

Public Types

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Disposition

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkCache()

◆ checkExisting()

◆ cleanDownloadFileName()

◆ clearBuffer()

◆ close()

◆ deliver()

◆ delivery()

◆ detemineDeliveryType()

◆ determineDownloadFileName()

◆ determineMimeType()

◆ generateEtag()

◆ getDeliveryType()

◆ getDisposition()

◆ getDownloadFileName()

◆ getEtag()

◆ getMimeType()

◆ getPathToFile()

◆ getShowLastModified()

◆ hasCache()

◆ hasHashFilename()

◆ isConvertFileNameToAsci()

◆ isDEBUG()

◆ isDeleteFile()

◆ isExitAfter()

◆ isHasContext()

◆ isSendMimeType()

◆ returnASCIIFileName()

◆ sendEtagHeader()

◆ sendLastModified()

◆ setCache()

◆ setCachingHeaders()

◆ setConvertFileNameToAsci()

◆ setDEBUG()

◆ setDeleteFile()

◆ setDeliveryType()

◆ setDisposition()

◆ setDispositionHeaders()

◆ setDownloadFileName()

◆ setEtag()

◆ setExitAfter()

◆ setGeneralHeaders()

◆ setHasContext()

◆ setHashFilename()

◆ setMimeType()

◆ setPathToFile()

◆ setSendMimeType()

◆ setShowLastModified()

◆ stream()

Field Documentation

◆ $cache

◆ $convert_file_name_to_asci

◆ $DEBUG

◆ $delete_file

◆ $delivery_type

◆ $delivery_type_static

◆ $disposition

◆ $download_file_name

◆ $etag

◆ $exit_after

◆ $factory

◆ $has_context

◆ $hash_filename

◆ $mime_type

◆ $path_to_file

◆ $resource

◆ $send_mime_type

◆ $show_last_modified