Inheritance diagram for ILIAS\ResourceStorage\Consumer\BaseHTTPResponseBasedConsumer:

Collaboration diagram for ILIAS\ResourceStorage\Consumer\BaseHTTPResponseBasedConsumer:

Public Member Functions
	__construct (\ILIAS\HTTP\Services $http, StorableResource $resource, StreamAccess $stream_access, FileNamePolicy $file_name_policy)

	run ()
	This runs the actual DeliveryConsumer. More...

Public Member Functions inherited from ILIAS\ResourceStorage\Consumer\BaseConsumer
	__construct (StorableResource $resource, StreamAccess $stream_access, FileNamePolicy $file_name_policy)
	DownloadConsumer constructor. More...

	run ()
	This runs the actual DeliveryConsumer. More...

	setRevisionNumber (int $revision_number)

	overrideFileName (string $file_name)

Protected Member Functions
	getDisposition ()

Private Attributes
const	NON_VALID_EXTENSION_MIME = \ILIAS\FileUpload\MimeType::APPLICATION__OCTET_STREAM

ILIAS HTTP Services	$http

Additional Inherited Members
Protected Attributes inherited from ILIAS\ResourceStorage\Consumer\BaseConsumer
int	$revision_number = null

string	$file_name = ''

StorableResource	$resource

StreamAccess	$stream_access

FileNamePolicy	$file_name_policy

Detailed Description

Definition at line 32 of file BaseHTTPResponseBasedConsumer.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\ResourceStorage\Consumer\BaseHTTPResponseBasedConsumer::__construct	(	\ILIAS\HTTP\Services	$http,
		StorableResource	$resource,
		StreamAccess	$stream_access,
		FileNamePolicy	$file_name_policy
	)

Definition at line 38 of file BaseHTTPResponseBasedConsumer.php.

References ILIAS\ResourceStorage\Consumer\BaseHTTPResponseBasedConsumer\$http, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\ResourceStorage\Consumer\BaseHTTPResponseBasedConsumer\getDisposition(), and ILIAS\FileDelivery\http().

       {
         $this->http = $http;
         parent::__construct($resource, $stream_access, $file_name_policy);
     }

Here is the call graph for this function:

Member Function Documentation

◆ getDisposition()

ILIAS\ResourceStorage\Consumer\BaseHTTPResponseBasedConsumer::getDisposition ( )

abstractprotected

Referenced by ILIAS\ResourceStorage\Consumer\BaseHTTPResponseBasedConsumer\__construct(), and ILIAS\ResourceStorage\Consumer\BaseHTTPResponseBasedConsumer\run().

Here is the caller graph for this function:

◆ run()

ILIAS\ResourceStorage\Consumer\BaseHTTPResponseBasedConsumer::run ( )

This runs the actual DeliveryConsumer.

E.g. a DownloadConsumer will pass the Stream of a Ressource to the HTTP-Service and download the file.

Implements ILIAS\ResourceStorage\Consumer\DeliveryConsumer.

Definition at line 50 of file BaseHTTPResponseBasedConsumer.php.

References $response, ILIAS\HTTP\Response\ResponseHeader\ACCEPT_RANGES, ILIAS\HTTP\Response\ResponseHeader\CONNECTION, ILIAS\HTTP\Response\ResponseHeader\CONTENT_DISPOSITION, ILIAS\HTTP\Response\ResponseHeader\CONTENT_TYPE, ILIAS\ResourceStorage\Consumer\BaseHTTPResponseBasedConsumer\getDisposition(), ILIAS\FileDelivery\http(), and ILIAS\HTTP\Response\ResponseHeader\X_CONTENT_TYPE_OPTIONS.

                          : void
     {
         $revision = $this->getRevision();
         $filename_with_extension = $this->file_name ?? $revision->getInformation()->getTitle();
         $extension = pathinfo($filename_with_extension, PATHINFO_EXTENSION);
         $file_name_for_consumer = $this->file_name_policy->prepareFileNameForConsumer($filename_with_extension);
 
         // Build Response
         $response = $this->http->response();
         if ($this->file_name_policy->isValidExtension($extension)) {
             $response = $response->withHeader(ResponseHeader::CONTENT_TYPE, $revision->getInformation()->getMimeType());
         } else {
             $response = $response->withHeader(ResponseHeader::X_CONTENT_TYPE_OPTIONS, 'nosniff');
             $response = $response->withHeader(ResponseHeader::CONTENT_TYPE, self::NON_VALID_EXTENSION_MIME);
         }
 
         $response = $response->withHeader(ResponseHeader::CONNECTION, 'close');
         $response = $response->withHeader(ResponseHeader::ACCEPT_RANGES, 'none');
         $response = $response->withHeader(
             ResponseHeader::CONTENT_DISPOSITION,
             $this->getDisposition()
             . '; filename="'
             . $file_name_for_consumer
             . '"'
         );
         $revision = $this->stream_access->populateRevision($revision);
 
         $response = $response->withBody($revision->maybeGetToken()->resolveStream());
 
         $this->http->saveResponse($response);
         $this->http->sendResponse();
         $this->http->close();
     }