ILIAS\StaticURL\Response\Response\Sender\DefaultResponseSenderStrategy Class Reference

Class DefaultResponseSenderStrategy. More...

Inheritance diagram for ILIAS\StaticURL\Response\Response\Sender\DefaultResponseSenderStrategy:

Collaboration diagram for ILIAS\StaticURL\Response\Response\Sender\DefaultResponseSenderStrategy:

Public Member Functions
	__construct ()
	sendResponse (ResponseInterface $response)
	Sends the rendered response to the client. More...

Private Member Functions
	initMemoryLimit ()
	initChunkSize ()

Private Attributes
const	METHOD_FPASSTHRU = 'fpassthru'
const	METHOD_READFILE = 'readfile'
string	$method = self::METHOD_FPASSTHRU
int	$chunk_size
int	$memory_limit

Detailed Description

Class DefaultResponseSenderStrategy.

The default response sender strategy rewinds the current body stream and sends the entire stream out to the client.

Author

Nicolas Schäfli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 31 of file DefaultResponseSenderStrategy.php.

Constructor & Destructor Documentation

__construct()

ILIAS\StaticURL\Response\Response\Sender\DefaultResponseSenderStrategy::__construct

(

)

Definition at line 45 of file DefaultResponseSenderStrategy.php.

References ILIAS\StaticURL\Response\Response\Sender\DefaultResponseSenderStrategy\initChunkSize(), and ILIAS\StaticURL\Response\Response\Sender\DefaultResponseSenderStrategy\initMemoryLimit().

    {
        $this->memory_limit = $this->initMemoryLimit();
        $this->chunk_size = $this->initChunkSize();
    }

Here is the call graph for this function:

Member Function Documentation

initChunkSize()

ILIAS\StaticURL\Response\Response\Sender\DefaultResponseSenderStrategy::initChunkSize ( )

private

Definition at line 67 of file DefaultResponseSenderStrategy.php.

Referenced by ILIAS\StaticURL\Response\Response\Sender\DefaultResponseSenderStrategy\__construct().

                                    : int
    {
        return (int) round(max($this->memory_limit / 4, 8 * 1024));
    }

Here is the caller graph for this function:

initMemoryLimit()

ILIAS\StaticURL\Response\Response\Sender\DefaultResponseSenderStrategy::initMemoryLimit ( )

private

Definition at line 51 of file DefaultResponseSenderStrategy.php.

References ILIAS\Repository\int(), and null.

Referenced by ILIAS\StaticURL\Response\Response\Sender\DefaultResponseSenderStrategy\__construct().

                                      : int
    {
        $ini_memory_limit = ini_get('memory_limit');
        $memory_limit = null;
        if (preg_match('/^(\d+)(.)$/', $ini_memory_limit, $matches)) {
            $memory_limit = match ($matches[2] ?? null) {
                'G' => (int) $matches[1] * 1024 * 1024 * 1024,
                'M' => (int) $matches[1] * 1024 * 1024,
                'K' => (int) $matches[1] * 1024,
                default => (int) $matches[1],
            };
        }

        return $memory_limit ?? 128 * 1024 * 1024;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

sendResponse()

ILIAS\StaticURL\Response\Response\Sender\DefaultResponseSenderStrategy::sendResponse

(

ResponseInterface

$response

)

Sends the rendered response to the client.

Parameters

ResponseInterface

$response

The response which should be send to the client.

Exceptions

ResponseSendingException

Thrown if the response was already sent to the client.

Implements ILIAS\StaticURL\Response\Response\Sender\ResponseSenderStrategy.

Definition at line 79 of file DefaultResponseSenderStrategy.php.

References ILIAS\UI\examples\Symbol\Glyph\Header\header().

                                                             : void
    {
        //check if the request is already send
        if (headers_sent()) {
            throw new ResponseSendingException("Response was already sent.");
        }

        //set status code
        http_response_code($response->getStatusCode());

        //render all headers
        foreach (array_keys($response->getHeaders()) as $key) {
            // See Mantis #37385.
            if (strtolower($key) === 'set-cookie') {
                foreach ($response->getHeader($key) as $header) {
                    header("$key: " . $header, false);
                }
            } else {
                header("$key: " . $response->getHeaderLine($key));
            }
        }

        //rewind body stream
        $stream = $response->getBody();
        $stream->rewind();

        // check body size
        $body_size = $stream->getSize();
        if ($body_size > $this->memory_limit) {
            $this->method = self::METHOD_READFILE;
        }

        //detach psr-7 stream from resource
        $resource = $stream->detach();

        $sendStatus = false;

        if (is_resource($resource)) {
            set_time_limit(0);
            try {
                ob_end_clean(); // see https://mantis.ilias.de/view.php?id=32046
            } catch (\Throwable) {
            }
            switch ($this->method) {
                case self::METHOD_FPASSTHRU:
                    $sendStatus = fpassthru($resource);
                    break;
                case self::METHOD_READFILE:
                    // more memory friendly than fpassthru
                    $sendStatus = true;
                    while (!feof($resource)) {
                        echo $return = fread($resource, $this->chunk_size);
                        $sendStatus = $sendStatus && $return !== false;

                    }
                    break;
            }

            //free up resources
            fclose($resource);
        }

        //check if the body was successfully send to the client
        if ($sendStatus === false) {
            throw new ResponseSendingException("Could not send body content to client.");
        }
    }

Here is the call graph for this function:

Field Documentation

$chunk_size

int ILIAS\StaticURL\Response\Response::Sender\DefaultResponseSenderStrategy::$chunk_size

private

Definition at line 42 of file DefaultResponseSenderStrategy.php.

$memory_limit

int ILIAS\StaticURL\Response\Response::Sender\DefaultResponseSenderStrategy::$memory_limit

private

Definition at line 43 of file DefaultResponseSenderStrategy.php.

$method

string ILIAS\StaticURL\Response\Response::Sender\DefaultResponseSenderStrategy::$method = self::METHOD_FPASSTHRU

private

Definition at line 41 of file DefaultResponseSenderStrategy.php.

METHOD_FPASSTHRU

const ILIAS\StaticURL\Response\Response::Sender\DefaultResponseSenderStrategy::METHOD_FPASSTHRU = 'fpassthru'

private

Definition at line 36 of file DefaultResponseSenderStrategy.php.

METHOD_READFILE

const ILIAS\StaticURL\Response\Response::Sender\DefaultResponseSenderStrategy::METHOD_READFILE = 'readfile'

private

Definition at line 40 of file DefaultResponseSenderStrategy.php.

---

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

• components/ILIAS/HTTP/src/Response/Sender/DefaultResponseSenderStrategy.php