ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder Class Reference

Inheritance diagram for ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder:

Collaboration diagram for ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder:

Public Member Functions
	getName ()
	buildForStream (ServerRequestInterface $request, ResponseInterface $response, FileStream $stream,)
	supportPartial ()
	supportStreaming ()
	supportFileDeletion ()
	supportsInlineDelivery ()
	supportsAttachmentDelivery ()

Protected Member Functions
	buildHeaders (ResponseInterface $response, FileStream $stream)
	deliverFull (ResponseInterface $response, FileStream $stream,)
	deliverPartial (RequestInterface|ServerRequestInterface $request, ResponseInterface $response, FileStream $stream,)

Detailed Description

Author

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

Definition at line 33 of file PHPResponseBuilder.php.

Member Function Documentation

buildForStream()

ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder::buildForStream	(	ServerRequestInterface	$request,
		ResponseInterface	$response,
		FileStream	$stream
	)

Implements ILIAS\FileDelivery\Delivery\ResponseBuilder\ResponseBuilder.

Definition at line 40 of file PHPResponseBuilder.php.

References ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder\buildHeaders(), ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder\deliverFull(), ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder\deliverPartial(), and ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder\supportPartial().

     : ResponseInterface {
        $response = $this->buildHeaders($response, $stream);
        $server_params = $request->getServerParams();

        if ($request->getMethod() === 'HEAD') {
            return $response->withStatus(200);
        }

        if (isset($server_params['HTTP_RANGE']) && $this->supportPartial()) {
            return $this->deliverPartial($request, $response, $stream);
        }
        return $this->deliverFull($response, $stream);
    }

Here is the call graph for this function:

buildHeaders()

ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder::buildHeaders ( ResponseInterface  $response, FileStream  $stream  )

protected

Definition at line 58 of file PHPResponseBuilder.php.

References ILIAS\StaticURL\Response\Response\ResponseHeader\ACCEPT_RANGES, ILIAS\StaticURL\Response\Response\ResponseHeader\CONTENT_LENGTH, ILIAS\StaticURL\Response\Response\ResponseHeader\ETAG, ILIAS\StaticURL\Response\Response\ResponseHeader\LAST_MODIFIED, and ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder\supportPartial().

Referenced by ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder\buildForStream().

     : ResponseInterface {
        $uri = $stream->getMetadata('uri');
        if ($this->supportPartial()) {
            $response = $response->withHeader(ResponseHeader::ACCEPT_RANGES, 'bytes');
        }

        $response = $response->withHeader(ResponseHeader::CONTENT_LENGTH, $stream->getSize());
        try {
            $response = $response->withHeader(
                ResponseHeader::LAST_MODIFIED,
                date("D, j M Y H:i:s", filemtime($uri) ?: time()) . " GMT"
            );
        } catch (\Throwable) {
        }

        return $response->withHeader(ResponseHeader::ETAG, md5((string) $uri));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deliverFull()

ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder::deliverFull ( ResponseInterface  $response, FileStream  $stream  )

protected

Definition at line 79 of file PHPResponseBuilder.php.

Referenced by ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder\buildForStream().

     : ResponseInterface {
        $stream->rewind();
        return $response->withBody($stream);
    }

Here is the caller graph for this function:

deliverPartial()

ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder::deliverPartial ( RequestInterface|ServerRequestInterface  $request, ResponseInterface  $response, FileStream  $stream  )

protected

Definition at line 87 of file PHPResponseBuilder.php.

References $response, ILIAS\StaticURL\Response\Response\ResponseHeader\CONTENT_LENGTH, ILIAS\StaticURL\Response\Response\ResponseHeader\CONTENT_RANGE, ILIAS\Repository\int(), null, ILIAS\Filesystem\Stream\Streams\ofString(), and ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder\supportPartial().

Referenced by ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder\buildForStream().

     : ResponseInterface {
        if (!$this->supportPartial()) {
            return $response;
        }
        $request->getServerParams();

        $start = 0;
        $content_length = $stream->getSize();
        $end = null;

        $range_header = $request->getHeaderLine('Range');

        if ($range_header && preg_match(
            '%bytes=(\d+)-(\d+)?%i',
            $range_header,
            $match
        )) {
            $start = (int) $match[1];
            if (isset($match[2])) {
                $end = (int) $match[2];
            }
            $end ??= $content_length - 1;
        }

        $response = $response->withStatus(206);

        $length = $end - $start + 1;
        $fh = $stream->detach();

        // set $buffer_size to 8MB
        $buffer_size = 8048 * 1000; // 8,048,000 bytes

        $output_length = 0;
        if ($stream->isSeekable()) {
            fseek($fh, $start);
            while (!feof($fh) && $length > 0) {
                $chunk_size_requested = min($buffer_size, $end - $start);
                $content = fread($fh, $length);
                if ($content === false) {
                    break;
                }
                $length -= strlen($content);
                $response->getBody()->write($content);
                $output_length = strlen($content);
            }
        } else {
            $length = $buffer_size;
            $content = stream_get_contents($fh, $length, $start);
            $output_length = strlen($content);
            $response = $response->withBody(
                Streams::ofString($content)
            );
            $end = $start + $output_length - 1;
        }

        $response = $response->withHeader(
            ResponseHeader::CONTENT_RANGE,
            "bytes {$start}-{$end}/{$content_length}"
        );

        return $response->withHeader(ResponseHeader::CONTENT_LENGTH, $output_length);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getName()

ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder::getName

(

)

Implements ILIAS\FileDelivery\Delivery\ResponseBuilder\ResponseBuilder.

Definition at line 35 of file PHPResponseBuilder.php.

                             : string
    {
        return 'php';
    }

supportFileDeletion()

ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder::supportFileDeletion

(

)

Implements ILIAS\FileDelivery\Delivery\ResponseBuilder\ResponseBuilder.

Definition at line 164 of file PHPResponseBuilder.php.

                                         : bool
    {
        return true;
    }

supportPartial()

ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder::supportPartial

(

)

Implements ILIAS\FileDelivery\Delivery\ResponseBuilder\ResponseBuilder.

Definition at line 154 of file PHPResponseBuilder.php.

Referenced by ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder\buildForStream(), ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder\buildHeaders(), and ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder\deliverPartial().

                                    : bool
    {
        return true;
    }

Here is the caller graph for this function:

supportsAttachmentDelivery()

ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder::supportsAttachmentDelivery

(

)

Implements ILIAS\FileDelivery\Delivery\ResponseBuilder\ResponseBuilder.

Definition at line 174 of file PHPResponseBuilder.php.

                                                : bool
    {
        return true;
    }

supportsInlineDelivery()

ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder::supportsInlineDelivery

(

)

Implements ILIAS\FileDelivery\Delivery\ResponseBuilder\ResponseBuilder.

Definition at line 169 of file PHPResponseBuilder.php.

                                            : bool
    {
        return true;
    }

supportStreaming()

ILIAS\FileDelivery\Delivery\ResponseBuilder\PHPResponseBuilder::supportStreaming

(

)

Implements ILIAS\FileDelivery\Delivery\ResponseBuilder\ResponseBuilder.

Definition at line 159 of file PHPResponseBuilder.php.

                                      : bool
    {
        return true;
    }

---

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

• components/ILIAS/FileDelivery/src/Delivery/ResponseBuilder/PHPResponseBuilder.php