Collaboration diagram for ILIAS\FileDelivery\Delivery:

Public Member Functions
	__construct (string $path_to_file, 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

Services	$http

FileDeliveryTypeFactory	$factory

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

@Internal

Definition at line 37 of file Delivery.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\FileDelivery\Delivery::__construct	(	string	$path_to_file,
		Services	$http
	)

Parameters

string	$path_to_file
Services	$http

Definition at line 67 of file Delivery.php.

    {
        $this->http = $http;
        if ($path_to_file === self::DIRECT_PHP_OUTPUT) {
            $this->setPathToFile(self::DIRECT_PHP_OUTPUT);
        } else {
            $this->setPathToFile($path_to_file);
            $this->detemineDeliveryType();
            $this->determineMimeType();
            $this->determineDownloadFileName();
        }
        $this->setHasContext(\ilContext::getType() !== null);
        $this->factory = new FileDeliveryTypeFactory($http);
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ checkCache()

ILIAS\FileDelivery\Delivery::checkCache ( )

Definition at line 431 of file Delivery.php.

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

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().

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 461 of file Delivery.php.

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

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

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

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 474 of file Delivery.php.

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

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

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

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 445 of file Delivery.php.

                                 : 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 $t) {
            return false;
        }
    }

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

Here is the caller graph for this function:

◆ close()

ILIAS\FileDelivery\Delivery::close ( )

Definition at line 169 of file Delivery.php.

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

References ILIAS\FileDelivery\http().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deliver()

ILIAS\FileDelivery\Delivery::deliver ( )

Definition at line 98 of file Delivery.php.

                             : 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->delivery()->deliver($this->getPathToFile(), $this->isDeleteFile());
        if ($this->isDeleteFile()) {
            $this->delivery()->handleFileDeletion($this->getPathToFile());
        }
        if ($this->isExitAfter()) {
            $this->close();
        }
    }

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 ILIAS\FileDelivery\Delivery\stream().

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 92 of file Delivery.php.

                               : ilFileDeliveryType
    {
        return $this->factory->getInstance($this->getDeliveryType());
    }

References ILIAS\FileDelivery\Delivery\getDeliveryType().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ detemineDeliveryType()

ILIAS\FileDelivery\Delivery::detemineDeliveryType ( )

private

@noRector

Definition at line 203 of file Delivery.php.

                                           : 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 (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);
            }
        }
        $ilRuntime = \ilRuntime::getInstance();
        if ((!$ilRuntime->isFPM() && !$ilRuntime->isHHVM())
            && $this->getDeliveryType() === DeliveryMethod::XACCEL
        ) {
            $this->setDeliveryType(DeliveryMethod::PHP);
        }
 
        if ($this->getDeliveryType() === DeliveryMethod::XACCEL
            && strpos($this->getPathToFile(), './data') !== 0
        ) {
            $this->setDeliveryType(DeliveryMethod::PHP);
        }
 
        self::$delivery_type_static = $this->getDeliveryType();
    }

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().

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 194 of file Delivery.php.

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

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

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

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 175 of file Delivery.php.

                                        : void
    {
        $info = \ILIAS\FileUpload\MimeType::lookupMimeType($this->getPathToFile(), \ILIAS\FileUpload\MimeType::APPLICATION__OCTET_STREAM);
        if ($info) {
            $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;
        }
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateEtag()

ILIAS\FileDelivery\Delivery::generateEtag ( )

Definition at line 163 of file Delivery.php.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDeliveryType()

ILIAS\FileDelivery\Delivery::getDeliveryType ( )

Definition at line 242 of file Delivery.php.

                                     : string
    {
        return $this->delivery_type;
    }

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().

Here is the caller graph for this function:

◆ getDisposition()

ILIAS\FileDelivery\Delivery::getDisposition ( )

Definition at line 290 of file Delivery.php.

                                    : string
    {
        return $this->disposition;
    }

References ILIAS\FileDelivery\Delivery\$disposition.

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

Here is the caller graph for this function:

◆ getDownloadFileName()

ILIAS\FileDelivery\Delivery::getDownloadFileName ( )

Definition at line 278 of file Delivery.php.

                                         : string
    {
        return $this->download_file_name;
    }

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().

Here is the caller graph for this function:

◆ getEtag()

ILIAS\FileDelivery\Delivery::getEtag ( )

Definition at line 338 of file Delivery.php.

                             : string
    {
        return $this->etag;
    }

References ILIAS\FileDelivery\Delivery\$etag.

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

Here is the caller graph for this function:

◆ getMimeType()

ILIAS\FileDelivery\Delivery::getMimeType ( )

Definition at line 254 of file Delivery.php.

                                 : string
    {
        return $this->mime_type;
    }

References ILIAS\FileDelivery\Delivery\$mime_type.

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

Here is the caller graph for this function:

◆ getPathToFile()

ILIAS\FileDelivery\Delivery::getPathToFile ( )

Definition at line 266 of file Delivery.php.

                                   : string
    {
        return $this->path_to_file;
    }

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().

Here is the caller graph for this function:

◆ getShowLastModified()

ILIAS\FileDelivery\Delivery::getShowLastModified ( )

Definition at line 350 of file Delivery.php.

                                         : bool
    {
        return $this->show_last_modified;
    }

References ILIAS\FileDelivery\Delivery\$show_last_modified.

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

Here is the caller graph for this function:

◆ hasCache()

ILIAS\FileDelivery\Delivery::hasCache ( )

Definition at line 374 of file Delivery.php.

                              : bool
    {
        return $this->cache;
    }

References ILIAS\FileDelivery\Delivery\$cache.

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

Here is the caller graph for this function:

◆ hasHashFilename()

ILIAS\FileDelivery\Delivery::hasHashFilename ( )

Definition at line 386 of file Delivery.php.

                                     : bool
    {
        return $this->hash_filename;
    }

References ILIAS\FileDelivery\Delivery\$hash_filename.

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

Here is the caller graph for this function:

◆ isConvertFileNameToAsci()

ILIAS\FileDelivery\Delivery::isConvertFileNameToAsci ( )

Definition at line 326 of file Delivery.php.

                                             : bool
    {
        return $this->convert_file_name_to_asci;
    }

References ILIAS\FileDelivery\Delivery\$convert_file_name_to_asci.

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

Here is the caller graph for this function:

◆ isDEBUG()

static ILIAS\FileDelivery\Delivery::isDEBUG ( )

static

Definition at line 419 of file Delivery.php.

                                    : bool
    {
        return self::$DEBUG;
    }

References ILIAS\FileDelivery\Delivery\$DEBUG.

◆ isDeleteFile()

ILIAS\FileDelivery\Delivery::isDeleteFile ( )

Definition at line 517 of file Delivery.php.

                                  : bool
    {
        return $this->delete_file;
    }

References ILIAS\FileDelivery\Delivery\$delete_file.

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

Here is the caller graph for this function:

◆ isExitAfter()

ILIAS\FileDelivery\Delivery::isExitAfter ( )

Definition at line 314 of file Delivery.php.

                                 : bool
    {
        return $this->exit_after;
    }

References ILIAS\FileDelivery\Delivery\$exit_after.

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

Here is the caller graph for this function:

◆ isHasContext()

ILIAS\FileDelivery\Delivery::isHasContext ( )

Definition at line 362 of file Delivery.php.

                                  : bool
    {
        return $this->has_context;
    }

References ILIAS\FileDelivery\Delivery\$has_context.

◆ isSendMimeType()

ILIAS\FileDelivery\Delivery::isSendMimeType ( )

Definition at line 302 of file Delivery.php.

                                    : bool
    {
        return $this->send_mime_type;
    }

References ILIAS\FileDelivery\Delivery\$send_mime_type.

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

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 488 of file Delivery.php.

                                                                         : 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]/', '_', $ascii_filename);
 
        // OS do not allow the following characters in filenames: \/:*?"<>|
        $ascii_filename = preg_replace(
            '/[:\x5c\/\*\?\"<>\|]/',
            '_',
            $ascii_filename
        );
        return $ascii_filename;
    }

References $ascii_filename.

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

Here is the caller graph for this function:

◆ sendEtagHeader()

ILIAS\FileDelivery\Delivery::sendEtagHeader ( )

private

Definition at line 398 of file Delivery.php.

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

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

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

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 407 of file Delivery.php.

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

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

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

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 380 of file Delivery.php.

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

References ILIAS\FileDelivery\Delivery\$cache.

◆ setCachingHeaders()

ILIAS\FileDelivery\Delivery::setCachingHeaders ( )

Definition at line 153 of file Delivery.php.

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

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

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

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 332 of file Delivery.php.

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

References ILIAS\FileDelivery\Delivery\$convert_file_name_to_asci.

◆ setDEBUG()

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

static

Definition at line 425 of file Delivery.php.

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

References ILIAS\FileDelivery\Delivery\$DEBUG.

◆ setDeleteFile()

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

Definition at line 523 of file Delivery.php.

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

References ILIAS\FileDelivery\Delivery\$delete_file.

◆ setDeliveryType()

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

Definition at line 248 of file Delivery.php.

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

References ILIAS\FileDelivery\Delivery\$delivery_type.

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

Here is the caller graph for this function:

◆ setDisposition()

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

Definition at line 296 of file Delivery.php.

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

References ILIAS\FileDelivery\Delivery\$disposition.

◆ setDispositionHeaders()

ILIAS\FileDelivery\Delivery::setDispositionHeaders ( )

private

Definition at line 529 of file Delivery.php.

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

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

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

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 284 of file Delivery.php.

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

References ILIAS\FileDelivery\Delivery\$download_file_name.

Referenced by ILIAS\FileDelivery\Delivery\cleanDownloadFileName(), ilFileDelivery\deliverFileAttached(), ilFileDelivery\deliverFileInline(), ILIAS\FileDelivery\Delivery\determineDownloadFileName(), ILIAS\FileDelivery\Delivery\setGeneralHeaders(), and ilFileDelivery\streamVideoInline().

Here is the caller graph for this function:

◆ setEtag()

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

Definition at line 344 of file Delivery.php.

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

References ILIAS\FileDelivery\Delivery\$etag.

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

Here is the caller graph for this function:

◆ setExitAfter()

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

Definition at line 320 of file Delivery.php.

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

References ILIAS\FileDelivery\Delivery\$exit_after.

◆ setGeneralHeaders()

ILIAS\FileDelivery\Delivery::setGeneralHeaders ( )

Definition at line 126 of file Delivery.php.

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

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

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 368 of file Delivery.php.

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

References ILIAS\FileDelivery\Delivery\$has_context.

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

Here is the caller graph for this function:

◆ setHashFilename()

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

Definition at line 392 of file Delivery.php.

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

References ILIAS\FileDelivery\Delivery\$hash_filename.

◆ setMimeType()

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

Definition at line 260 of file Delivery.php.

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

References ILIAS\FileDelivery\Delivery\$mime_type.

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

Here is the caller graph for this function:

◆ setPathToFile()

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

Definition at line 272 of file Delivery.php.

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

References ILIAS\FileDelivery\Delivery\$path_to_file.

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

Here is the caller graph for this function:

◆ setSendMimeType()

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

Definition at line 308 of file Delivery.php.

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

References ILIAS\FileDelivery\Delivery\$send_mime_type.

◆ setShowLastModified()

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

Definition at line 356 of file Delivery.php.

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

References ILIAS\FileDelivery\Delivery\$show_last_modified.

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

Here is the caller graph for this function:

◆ stream()

ILIAS\FileDelivery\Delivery::stream ( )

Definition at line 83 of file Delivery.php.

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

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

Here is the call graph for this function:

Field Documentation

◆ $cache

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

private

Definition at line 55 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 51 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 58 of file Delivery.php.

Referenced by ILIAS\FileDelivery\Delivery\isDEBUG(), and ILIAS\FileDelivery\Delivery\setDEBUG().

◆ $delete_file

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

private

Definition at line 57 of file Delivery.php.

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

◆ $delivery_type

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

private

Definition at line 44 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 43 of file Delivery.php.

◆ $disposition

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

private

Definition at line 48 of file Delivery.php.

Referenced by ILIAS\FileDelivery\Delivery\getDisposition(), and ILIAS\FileDelivery\Delivery\setDisposition().

◆ $download_file_name

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

private

Definition at line 47 of file Delivery.php.

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

◆ $etag

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

private

Definition at line 52 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 50 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 60 of file Delivery.php.

◆ $has_context

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

private

Definition at line 54 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 56 of file Delivery.php.

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

◆ $http

Services ILIAS\FileDelivery\Delivery::$http

private

Definition at line 59 of file Delivery.php.

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

◆ $mime_type

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

private

Definition at line 45 of file Delivery.php.

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

◆ $path_to_file

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

private

Definition at line 46 of file Delivery.php.

Referenced by ILIAS\FileDelivery\Delivery\getPathToFile(), and ILIAS\FileDelivery\Delivery\setPathToFile().

◆ $send_mime_type

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

private

Definition at line 49 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 53 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 39 of file Delivery.php.

◆ DISP_ATTACHMENT

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

Definition at line 40 of file Delivery.php.

◆ DISP_INLINE

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

Definition at line 41 of file Delivery.php.

◆ EXPIRES_IN

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

Definition at line 42 of file Delivery.php.

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

Services/FileDelivery/classes/Delivery.php

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

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

◆ $http

◆ $mime_type

◆ $path_to_file

◆ $send_mime_type

◆ $show_last_modified

◆ DIRECT_PHP_OUTPUT

◆ DISP_ATTACHMENT

◆ DISP_INLINE