ILIAS\FileDelivery\Delivery Class Reference

Class Delivery. More...

Collaboration diagram for ILIAS\FileDelivery\Delivery:

Public Member Functions
	__construct ($path_to_file, GlobalHttpState $httpState)
	stream ()
	deliver ()
	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)

Static Public Member Functions
static	isDEBUG ()
static	setDEBUG ($DEBUG)
static	returnASCIIFileName ($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'

Private Member Functions
	delivery ()
	determineMimeType ()
	determineDownloadFileName ()
	detemineDeliveryType ()
	sendEtagHeader ()
	sendLastModified ()
	checkExisting ()
	cleanDownloadFileName ()
	Converts the filename to ASCII. More...
	setDispositionHeaders ()

Private Attributes
	$delivery_type = DeliveryMethod::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
	$httpService
	$fileDeliveryTypeFactory

Static Private Attributes
static	$delivery_type_static = null
static	$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 27 of file Delivery.php.

Constructor & Destructor Documentation

__construct()

ILIAS\FileDelivery\Delivery::__construct	(		$path_to_file,
		GlobalHttpState	$httpState
	)

Parameters

string	$path_to_file
GlobalHttpState	$httpState

Definition at line 110 of file Delivery.php.

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

    {
        assert(is_string($path_to_file));
        $this->httpService = $httpState;
        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->fileDeliveryTypeFactory = new FileDeliveryTypeFactory($httpState);
    }

Here is the call graph for this function:

Member Function Documentation

checkCache()

ILIAS\FileDelivery\Delivery::checkCache

(

)

Returns

void

Definition at line 600 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().

    {
        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

Returns

void

Definition at line 628 of file Delivery.php.

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

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

    {
        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.

Returns

void

Definition at line 643 of file Delivery.php.

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

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

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

void

Definition at line 614 of file Delivery.php.

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

    {
        $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 caller graph for this function:

close()

ILIAS\FileDelivery\Delivery::close

(

)

Definition at line 210 of file Delivery.php.

References exit.

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

    {
        exit;
    }

Here is the caller graph for this function:

deliver()

ILIAS\FileDelivery\Delivery::deliver

(

)

Definition at line 142 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\Delivery\isDeleteFile(), ILIAS\FileDelivery\Delivery\isExitAfter(), and ILIAS\FileDelivery\Delivery\setGeneralHeaders().

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

    {
        $response = $this->httpService->response()->withHeader('X-ILIAS-FileDelivery-Method', $this->getDeliveryType());
        if (!$this->delivery()->doesFileExists($this->path_to_file)) {
            $response = $this->httpService->response()->withStatus(404);
            $this->httpService->saveResponse($response);
            $this->httpService->sendResponse();
            $this->close();
        }
        $this->httpService->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();
        }
    }

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

References ILIAS\FileDelivery\Delivery\getDeliveryType().

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

    {
        return $this->fileDeliveryTypeFactory->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

Returns

bool

Definition at line 255 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().

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

        require_once('./Services/Environment/classes/class.ilRuntime.php');
        $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();

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

determineDownloadFileName()

ILIAS\FileDelivery\Delivery::determineDownloadFileName ( )

private

Returns

void

Definition at line 243 of file Delivery.php.

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

Referenced by ILIAS\FileDelivery\Delivery\__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()

ILIAS\FileDelivery\Delivery::determineMimeType ( )

private

Returns

bool

Definition at line 219 of file Delivery.php.

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

Referenced by ILIAS\FileDelivery\Delivery\__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()

ILIAS\FileDelivery\Delivery::generateEtag

(

)

Definition at line 204 of file Delivery.php.

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

Referenced by ILIAS\FileDelivery\Delivery\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()

ILIAS\FileDelivery\Delivery::getDeliveryType

(

)

Returns

string

Definition at line 301 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().

    {
        return $this->delivery_type;
    }

Here is the caller graph for this function:

getDisposition()

ILIAS\FileDelivery\Delivery::getDisposition

(

)

Returns

string

Definition at line 373 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$disposition.

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

    {
        return $this->disposition;
    }

Here is the caller graph for this function:

getDownloadFileName()

ILIAS\FileDelivery\Delivery::getDownloadFileName

(

)

Returns

string

Definition at line 355 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().

    {
        return $this->download_file_name;
    }

Here is the caller graph for this function:

getEtag()

ILIAS\FileDelivery\Delivery::getEtag

(

)

Returns

string

Definition at line 445 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$etag.

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

    {
        return $this->etag;
    }

Here is the caller graph for this function:

getMimeType()

ILIAS\FileDelivery\Delivery::getMimeType

(

)

Returns

string

Definition at line 319 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$mime_type.

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

    {
        return $this->mime_type;
    }

Here is the caller graph for this function:

getPathToFile()

ILIAS\FileDelivery\Delivery::getPathToFile

(

)

Returns

string

Definition at line 337 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().

    {
        return $this->path_to_file;
    }

Here is the caller graph for this function:

getShowLastModified()

ILIAS\FileDelivery\Delivery::getShowLastModified

(

)

Returns

boolean

Definition at line 463 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$show_last_modified.

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

    {
        return $this->show_last_modified;
    }

Here is the caller graph for this function:

hasCache()

ILIAS\FileDelivery\Delivery::hasCache

(

)

Returns

boolean

Definition at line 499 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$cache.

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

    {
        return $this->cache;
    }

Here is the caller graph for this function:

hasHashFilename()

ILIAS\FileDelivery\Delivery::hasHashFilename

(

)

Returns

boolean

Definition at line 517 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$hash_filename.

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

    {
        return $this->hash_filename;
    }

Here is the caller graph for this function:

isConvertFileNameToAsci()

ILIAS\FileDelivery\Delivery::isConvertFileNameToAsci

(

)

Returns

boolean

Definition at line 427 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$convert_file_name_to_asci.

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

    {
        return $this->convert_file_name_to_asci;
    }

Here is the caller graph for this function:

isDEBUG()

static ILIAS\FileDelivery\Delivery::isDEBUG ( )

static

Returns

bool

bool

Definition at line 581 of file Delivery.php.

    {
        return (bool) self::$DEBUG;
    }

isDeleteFile()

ILIAS\FileDelivery\Delivery::isDeleteFile

(

)

Returns

bool

Definition at line 706 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$delete_file.

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

    {
        return (bool) $this->delete_file;
    }

Here is the caller graph for this function:

isExitAfter()

ILIAS\FileDelivery\Delivery::isExitAfter

(

)

Returns

boolean

Definition at line 409 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$exit_after.

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

    {
        return $this->exit_after;
    }

Here is the caller graph for this function:

isHasContext()

ILIAS\FileDelivery\Delivery::isHasContext

(

)

Returns

boolean

Definition at line 481 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$has_context.

    {
        return $this->has_context;
    }

isSendMimeType()

ILIAS\FileDelivery\Delivery::isSendMimeType

(

)

Returns

boolean

Definition at line 391 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$send_mime_type.

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

    {
        return $this->send_mime_type;
    }

Here is the caller graph for this function:

returnASCIIFileName()

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

static

Converts a UTF-8 filename to ASCII.

Parameters

$original_filename

string UFT8-Filename

Returns

string ASCII-Filename

Implementation note: The proper way to convert charsets is mb_convert_encoding. Unfortunately Multibyte String functions are not an installation requirement for ILIAS 3. Codelines behind three slashes '///' show how we would do it using mb_convert_encoding. Note that mb_convert_encoding has the bad habit of substituting unconvertable characters with HTML entitities. Thats why we need a regular expression which replaces HTML entities with their first character. e.g. ä => a

$ascii_filename = mb_convert_encoding($a_filename,'US-ASCII','UTF-8'); $ascii_filename = preg_replace('/&(.)[^;]*;/','\1', $ascii_filename);

Definition at line 657 of file Delivery.php.

References $ascii_filename, and array.

    {
        // The filename must be converted to ASCII, as of RFC 2183,
        // section 2.3.



        // #15914 - try to fix german umlauts
        $umlauts = array(
            "Ä" => "Ae",
            "Ö" => "Oe",
            "Ü" => "Ue",
            "ä" => "ae",
            "ö" => "oe",
            "ü" => "ue",
            "ß" => "ss",
        );
        foreach ($umlauts 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 (string) $ascii_filename;
        //              return iconv("UTF-8", "ASCII//TRANSLIT", $original_name); // proposal
    }

sendEtagHeader()

ILIAS\FileDelivery\Delivery::sendEtagHeader ( )

private

Definition at line 532 of file Delivery.php.

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

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

    {
        if ($this->getEtag()) {
            $response = $this->httpService->response()->withHeader('ETag', $this->getEtag());
            $this->httpService->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 541 of file Delivery.php.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

setCache()

ILIAS\FileDelivery\Delivery::setCache

(

$cache

)

Parameters

boolean

$cache

Definition at line 508 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$cache.

    {
        $this->cache = $cache;
    }

setCachingHeaders()

ILIAS\FileDelivery\Delivery::setCachingHeaders

(

)

Definition at line 194 of file Delivery.php.

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

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

    {
        $response = $this->httpService->response()->withHeader(ResponseHeader::CACHE_CONTROL, 'must-revalidate, post-check=0, pre-check=0')->withHeader(ResponseHeader::PRAGMA, 'public');

        $this->httpService->saveResponse($response);
        $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

(

$convert_file_name_to_asci

)

Parameters

boolean

$convert_file_name_to_asci

Definition at line 436 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$convert_file_name_to_asci.

    {
        $this->convert_file_name_to_asci = $convert_file_name_to_asci;
    }

setDEBUG()

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

static

Parameters

bool

$DEBUG

Definition at line 590 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$DEBUG.

    {
        assert(is_bool($DEBUG));
        self::$DEBUG = $DEBUG;
    }

setDeleteFile()

ILIAS\FileDelivery\Delivery::setDeleteFile

(

$delete_file

)

Parameters

bool

$delete_file

Returns

void

Definition at line 717 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$delete_file.

    {
        assert(is_bool($delete_file));
        $this->delete_file = $delete_file;
    }

setDeliveryType()

ILIAS\FileDelivery\Delivery::setDeliveryType

(

$delivery_type

)

Parameters

string

$delivery_type

Definition at line 310 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$delivery_type.

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

    {
        $this->delivery_type = $delivery_type;
    }

Here is the caller graph for this function:

setDisposition()

ILIAS\FileDelivery\Delivery::setDisposition

(

$disposition

)

Parameters

string

$disposition

Definition at line 382 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$disposition.

    {
        $this->disposition = $disposition;
    }

setDispositionHeaders()

ILIAS\FileDelivery\Delivery::setDispositionHeaders ( )

private

Definition at line 724 of file Delivery.php.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

setDownloadFileName()

ILIAS\FileDelivery\Delivery::setDownloadFileName

(

$download_file_name

)

Parameters

string

$download_file_name

Definition at line 364 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$download_file_name.

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

    {
        $this->download_file_name = $download_file_name;
    }

Here is the caller graph for this function:

setEtag()

ILIAS\FileDelivery\Delivery::setEtag

(

$etag

)

Parameters

string

$etag

Definition at line 454 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$etag.

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

    {
        $this->etag = $etag;
    }

Here is the caller graph for this function:

setExitAfter()

ILIAS\FileDelivery\Delivery::setExitAfter

(

$exit_after

)

Parameters

boolean

$exit_after

Definition at line 418 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$exit_after.

    {
        $this->exit_after = $exit_after;
    }

setGeneralHeaders()

ILIAS\FileDelivery\Delivery::setGeneralHeaders

(

)

Definition at line 167 of file Delivery.php.

References $response, ILIAS\HTTP\Response\ResponseHeader\ACCEPT_RANGES, ILIAS\FileDelivery\Delivery\checkExisting(), ILIAS\FileDelivery\Delivery\cleanDownloadFileName(), ILIAS\HTTP\Response\ResponseHeader\CONNECTION, ILIAS\HTTP\Response\ResponseHeader\CONTENT_LENGTH, ILIAS\HTTP\Response\ResponseHeader\CONTENT_TYPE, ILIAS\FileDelivery\Delivery\getDeliveryType(), ILIAS\FileDelivery\Delivery\getDownloadFileName(), ILIAS\FileDelivery\Delivery\getMimeType(), ILIAS\FileDelivery\Delivery\getPathToFile(), ILIAS\FileDelivery\Delivery\hasHashFilename(), ILIAS\FileDelivery\Delivery\isConvertFileNameToAsci(), ILIAS\FileDelivery\Delivery\isSendMimeType(), ILIAS\FileDelivery\FileDeliveryTypes\DeliveryMethod\PHP, ILIAS\FileDelivery\Delivery\setDispositionHeaders(), and ILIAS\FileDelivery\Delivery\setDownloadFileName().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

setHasContext()

ILIAS\FileDelivery\Delivery::setHasContext

(

$has_context

)

Parameters

boolean

$has_context

Definition at line 490 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$has_context.

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

    {
        $this->has_context = $has_context;
    }

Here is the caller graph for this function:

setHashFilename()

ILIAS\FileDelivery\Delivery::setHashFilename

(

$hash_filename

)

Parameters

boolean

$hash_filename

Definition at line 526 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$hash_filename.

    {
        $this->hash_filename = $hash_filename;
    }

setMimeType()

ILIAS\FileDelivery\Delivery::setMimeType

(

$mime_type

)

Parameters

string

$mime_type

Definition at line 328 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$mime_type.

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

    {
        $this->mime_type = $mime_type;
    }

Here is the caller graph for this function:

setPathToFile()

ILIAS\FileDelivery\Delivery::setPathToFile

(

$path_to_file

)

Parameters

string

$path_to_file

Definition at line 346 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$path_to_file.

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

    {
        $this->path_to_file = $path_to_file;
    }

Here is the caller graph for this function:

setSendMimeType()

ILIAS\FileDelivery\Delivery::setSendMimeType

(

$send_mime_type

)

Parameters

boolean

$send_mime_type

Definition at line 400 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$send_mime_type.

    {
        $this->send_mime_type = $send_mime_type;
    }

setShowLastModified()

ILIAS\FileDelivery\Delivery::setShowLastModified

(

$show_last_modified

)

Parameters

boolean

$show_last_modified

Definition at line 472 of file Delivery.php.

References ILIAS\FileDelivery\Delivery\$show_last_modified.

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

    {
        $this->show_last_modified = $show_last_modified;
    }

Here is the caller graph for this function:

stream()

ILIAS\FileDelivery\Delivery::stream

(

)

Definition at line 127 of file Delivery.php.

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

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

Here is the call graph for this function:

Field Documentation

$cache

ILIAS\FileDelivery\Delivery::$cache = false

private

Definition at line 83 of file Delivery.php.

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

$convert_file_name_to_asci

ILIAS\FileDelivery\Delivery::$convert_file_name_to_asci = true

private

Definition at line 67 of file Delivery.php.

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

$DEBUG

ILIAS\FileDelivery\Delivery::$DEBUG = false

staticprivate

Definition at line 95 of file Delivery.php.

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

$delete_file

ILIAS\FileDelivery\Delivery::$delete_file = false

private

Definition at line 91 of file Delivery.php.

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

$delivery_type

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

private

Definition at line 39 of file Delivery.php.

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

$delivery_type_static

ILIAS\FileDelivery\Delivery::$delivery_type_static = null

staticprivate

Definition at line 35 of file Delivery.php.

$disposition

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

private

Definition at line 55 of file Delivery.php.

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

$download_file_name

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

private

Definition at line 51 of file Delivery.php.

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

$etag

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

private

Definition at line 71 of file Delivery.php.

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

$exit_after

ILIAS\FileDelivery\Delivery::$exit_after = true

private

Definition at line 63 of file Delivery.php.

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

$fileDeliveryTypeFactory

FileDeliveryTypeFactory ILIAS\FileDelivery\Delivery::$fileDeliveryTypeFactory

private

Definition at line 103 of file Delivery.php.

$has_context

ILIAS\FileDelivery\Delivery::$has_context = true

private

Definition at line 79 of file Delivery.php.

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

$hash_filename

ILIAS\FileDelivery\Delivery::$hash_filename = false

private

Definition at line 87 of file Delivery.php.

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

$httpService

HTTPServices ILIAS\FileDelivery\Delivery::$httpService

private

Definition at line 99 of file Delivery.php.

$mime_type

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

private

Definition at line 43 of file Delivery.php.

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

$path_to_file

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

private

Definition at line 47 of file Delivery.php.

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

$send_mime_type

ILIAS\FileDelivery\Delivery::$send_mime_type = true

private

Definition at line 59 of file Delivery.php.

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

$show_last_modified

ILIAS\FileDelivery\Delivery::$show_last_modified = true

private

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

DISP_ATTACHMENT

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

Definition at line 30 of file Delivery.php.

DISP_INLINE

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

Definition at line 31 of file Delivery.php.

---

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

• Services/FileDelivery/classes/Delivery.php