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 ()
	getName ()
	buildForStream (ServerRequestInterface $request, ResponseInterface $response, FileStream $stream,)
	supportStreaming ()
	supportPartial ()
	supportFileDeletion ()
	supportsInlineDelivery ()
	supportsAttachmentDelivery ()

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

Private Member Functions
	parseRange (RequestInterface|ServerRequestInterface $request, FileStream $stream,)
	buildPartialHeaders (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.

     : ResponseInterface {
        $response = $this->buildHeaders($response, $stream);
        $server_params = $request->getServerParams();
        $has_range = isset($server_params['HTTP_RANGE']) && $this->supportPartial();
 
        if ($request->getMethod() === 'HEAD') {
            if ($has_range) {
                return $this->buildPartialHeaders($request, $response, $stream)
                    ->withBody(Streams::ofString(''));
            }
            return $response->withStatus(200);
        }
 
        if ($has_range) {
            return $this->deliverPartial($request, $response, $stream);
        }
        return $this->deliverFull($response, $stream);
    }

buildHeaders()

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

protected

Definition at line 63 of file PHPResponseBuilder.php.

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

References $response, and ILIAS\HTTP\Response\ResponseHeader\ACCEPT_RANGES.

buildPartialHeaders()

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

private

Definition at line 160 of file PHPResponseBuilder.php.

     : ResponseInterface {
        [$start, $end, $content_length] = $this->parseRange($request, $stream);
 
        return $response
            ->withStatus(206)
            ->withHeader(ResponseHeader::CONTENT_RANGE, "bytes {$start}-{$end}/{$content_length}")
            ->withHeader(ResponseHeader::CONTENT_LENGTH, (string) ($end - $start + 1));
    }

deliverFull()

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

protected

Definition at line 84 of file PHPResponseBuilder.php.

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

deliverPartial()

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

protected

Definition at line 92 of file PHPResponseBuilder.php.

     : ResponseInterface {
        if (!$this->supportPartial()) {
            return $response;
        }
 
        [$start, $end, $content_length] = $this->parseRange($request, $stream);
 
        $response = $response->withStatus(206);
 
        $range_length = $end - $start + 1;
        $fh = $stream->detach();
 
        // 8 MiB read buffer
        $buffer_size = 8 * 1024 * 1024;
 
        if ($stream->isSeekable()) {
            fseek($fh, $start);
            $remaining = $range_length;
            while (!feof($fh) && $remaining > 0) {
                $content = fread($fh, min($buffer_size, $remaining));
                if ($content === false) {
                    break;
                }
                $remaining -= strlen($content);
                $response->getBody()->write($content);
            }
            $output_length = $range_length - $remaining;
        } else {
            $length = min($range_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);
    }

References $response.

getName()

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

(

)

Implements ILIAS\FileDelivery\Delivery\ResponseBuilder\ResponseBuilder.

Definition at line 35 of file PHPResponseBuilder.php.

                             : string
    {
        return 'php';
    }

parseRange()

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

private

Definition at line 141 of file PHPResponseBuilder.php.

     : array {
        $content_length = $stream->getSize();
        $start = 0;
        $end = $content_length - 1;
 
        $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];
            }
        }
 
        return [$start, $end, $content_length];
    }

References ILIAS\Repository\int().

Here is the call graph for this function:

supportFileDeletion()

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

(

)

Implements ILIAS\FileDelivery\Delivery\ResponseBuilder\ResponseBuilder.

Definition at line 183 of file PHPResponseBuilder.php.

                                         : bool
    {
        return true;
    }

supportPartial()

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

(

)

Implements ILIAS\FileDelivery\Delivery\ResponseBuilder\ResponseBuilder.

Definition at line 173 of file PHPResponseBuilder.php.

                                    : bool
    {
        return true;
    }

supportsAttachmentDelivery()

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

(

)

Implements ILIAS\FileDelivery\Delivery\ResponseBuilder\ResponseBuilder.

Definition at line 193 of file PHPResponseBuilder.php.

                                                : bool
    {
        return true;
    }

supportsInlineDelivery()

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

(

)

Implements ILIAS\FileDelivery\Delivery\ResponseBuilder\ResponseBuilder.

Definition at line 188 of file PHPResponseBuilder.php.

                                            : bool
    {
        return true;
    }

supportStreaming()

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

(

)

Implements ILIAS\FileDelivery\Delivery\ResponseBuilder\ResponseBuilder.

Definition at line 178 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