BinaryStreamResponse::__construct() - Code Metrics - ezsystems/ezpublish-kernel - Measure and Improve Code Quality continuously with Scrutinizer

BinaryStreamResponse::__construct() A
last analyzed 2020-05-12 17:01 UTC

↳ Parent: BinaryStreamResponse

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	7
dl	0
loc	12
rs	9.8666
c	0
b	0
f	0

<?php

/**
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
 * @license For full copyright and license information view LICENSE file distributed with this source code.
 */
namespace eZ\Bundle\EzPublishIOBundle;

use DateTime;
use eZ\Publish\Core\IO\IOServiceInterface;
use eZ\Publish\Core\IO\Values\BinaryFile;
use LogicException;
use Symfony\Component\HttpFoundation\BinaryFileResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

/**
 * A modified version of HttpFoundation's BinaryFileResponse that accepts a stream as the input.
 */
class BinaryStreamResponse extends Response
{
    protected static $trustXSendfileTypeHeader = false;

    /** @var BinaryFile */
    protected $file;

    /** @var IOServiceInterface */
    protected $ioService;

    protected $offset;

    protected $maxlen;

    /**
     * Constructor.
     *
     * @param BinaryFile          $binaryFile         The name of the file to stream
     * @param IOServiceInterface  $ioService          The name of the file to stream
     * @param int                 $status             The response status code
     * @param array               $headers            An array of response headers
     * @param bool                $public             Files are public by default
     * @param string|null         $contentDisposition The type of Content-Disposition to set automatically with the filename
     * @param bool                $autoEtag           Whether the ETag header should be automatically set
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param bool                $autoLastModified   Whether the Last-Modified header should be automatically set
     */
    public function __construct(BinaryFile $binaryFile, IOServiceInterface $ioService, $status = 200, $headers = [], $public = true, $contentDisposition = null, $autoLastModified = true)
    {
        $this->ioService = $ioService;

        parent::__construct(null, $status, $headers);

        $this->setFile($binaryFile, $contentDisposition, $autoLastModified);

        if ($public) {
            $this->setPublic();
        }
    }

    /**
     * Sets the file to stream.
     *
     * @param \SplFileInfo|string $file The file to stream
     * @param string $contentDisposition
     * @param bool $autoEtag
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param bool $autoLastModified
     *
     * @return BinaryFileResponse
     */
    public function setFile($file, $contentDisposition = null, $autoLastModified = true)
    {
        $this->file = $file;


        if ($autoLastModified) {
            $this->setAutoLastModified();
        }

        if ($contentDisposition) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->setContentDisposition($contentDisposition);
        }

        return $this;
    }

    /**
     * Gets the file.
     *
     * @return BinaryFile The file to stream
     */
    public function getFile()
    {
        return $this->file;
    }

    /**
     * Automatically sets the Last-Modified header according the file modification date.
     */
    public function setAutoLastModified()
    {
        $this->setLastModified(DateTime::createFromFormat('U', $this->file->mtime->getTimestamp()));


        return $this;
    }

    /**
     * Sets the Content-Disposition header with the given filename.
     *
     * @param string $disposition ResponseHeaderBag::DISPOSITION_INLINE or ResponseHeaderBag::DISPOSITION_ATTACHMENT
     * @param string $filename Optionally use this filename instead of the real name of the file
     * @param string $filenameFallback A fallback filename, containing only ASCII characters. Defaults to an automatically encoded filename
     *
     * @return BinaryStreamResponse
     */
    public function setContentDisposition($disposition, $filename = '', $filenameFallback = '')
    {
        if ($filename === '') {
            $filename = $this->file->id;
        }

        if (empty($filenameFallback)) {
            $filenameFallback = mb_convert_encoding($filename, 'ASCII');
        }

        $dispositionHeader = $this->headers->makeDisposition($disposition, $filename, $filenameFallback);
        $this->headers->set('Content-Disposition', $dispositionHeader);

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function prepare(Request $request)
    {
        $this->headers->set('Content-Length', $this->file->size);
        $this->headers->set('Accept-Ranges', 'bytes');
        $this->headers->set('Content-Transfer-Encoding', 'binary');

        if (!$this->headers->has('Content-Type')) {
            $this->headers->set(
                'Content-Type',
                $this->ioService->getMimeType($this->file->id) ?: 'application/octet-stream'
            );
        }

        if ('HTTP/1.0' != $request->server->get('SERVER_PROTOCOL')) {
            $this->setProtocolVersion('1.1');
        }

        $this->ensureIEOverSSLCompatibility($request);

        $this->offset = 0;
        $this->maxlen = -1;

        if ($request->headers->has('Range')) {
            // Process the range headers.
            if (!$request->headers->has('If-Range') || $this->getEtag() == $request->headers->get('If-Range')) {
                $range = $request->headers->get('Range');
                $fileSize = $this->file->size;

                list($start, $end) = explode('-', substr($range, 6), 2) + [0];

                $end = ('' === $end) ? $fileSize - 1 : (int)$end;

                if ('' === $start) {
                    $start = $fileSize - $end;
                    $end = $fileSize - 1;
                } else {
                    $start = (int)$start;
                }

                if ($start <= $end) {
                    if ($start < 0 || $end > $fileSize - 1) {
                        $this->setStatusCode(416); // HTTP_REQUESTED_RANGE_NOT_SATISFIABLE
                    } elseif ($start !== 0 || $end !== $fileSize - 1) {
                        $this->maxlen = $end < $fileSize ? $end - $start + 1 : -1;
                        $this->offset = $start;

                        $this->setStatusCode(206); // HTTP_PARTIAL_CONTENT
                        $this->headers->set('Content-Range', sprintf('bytes %s-%s/%s', $start, $end, $fileSize));
                        $this->headers->set('Content-Length', $end - $start + 1);
                    }
                }
            }
        }

        return $this;
    }

    /**
     * Sends the file.
     */
    public function sendContent()
    {
        if (!$this->isSuccessful()) {
            parent::sendContent();

            return;
        }

        if (0 === $this->maxlen) {
            return;
        }

        $out = fopen('php://output', 'wb');
        $in = $this->ioService->getFileInputStream($this->file);
        stream_copy_to_stream($in, $out, $this->maxlen, $this->offset);

        fclose($out);
    }

    /**
     * {@inheritdoc}
     *
     * @throws LogicException when the content is not null
     */
    public function setContent($content)
    {
        if (null !== $content) {
            throw new LogicException('The content cannot be set on a BinaryStreamResponse instance.');
        }
    }

    public function getContent()
    {
        return null;
    }
}


1			<?php
2
3			/**
4			* @copyright Copyright (C) eZ Systems AS. All rights reserved.
5			* @license For full copyright and license information view LICENSE file distributed with this source code.
6			*/
7			namespace eZ\Bundle\EzPublishIOBundle;
8
9			use DateTime;
10			use eZ\Publish\Core\IO\IOServiceInterface;
11			use eZ\Publish\Core\IO\Values\BinaryFile;
12			use LogicException;
13			use Symfony\Component\HttpFoundation\BinaryFileResponse;
14			use Symfony\Component\HttpFoundation\Request;
15			use Symfony\Component\HttpFoundation\Response;
16
17			/**
18			* A modified version of HttpFoundation's BinaryFileResponse that accepts a stream as the input.
19			*/
20			class BinaryStreamResponse extends Response
21			{
22			protected static $trustXSendfileTypeHeader = false;
23
24			/** @var BinaryFile */
25			protected $file;
26
27			/** @var IOServiceInterface */
28			protected $ioService;
29
30			protected $offset;
31
32			protected $maxlen;
33
34			/**
35			* Constructor.
36			*
37			* @param BinaryFile $binaryFile The name of the file to stream
38			* @param IOServiceInterface $ioService The name of the file to stream
39			* @param int $status The response status code
40			* @param array $headers An array of response headers
41			* @param bool $public Files are public by default
42			* @param string\|null $contentDisposition The type of Content-Disposition to set automatically with the filename
43			* @param bool $autoEtag Whether the ETag header should be automatically set
			0 ignored issues – show Bug introduced 2015-11-21 14:36 UTC by Report Bug Copy Issue Report There is no parameter named `$autoEtag`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
44			* @param bool $autoLastModified Whether the Last-Modified header should be automatically set
45			*/
46			public function __construct(BinaryFile $binaryFile, IOServiceInterface $ioService, $status = 200, $headers = [], $public = true, $contentDisposition = null, $autoLastModified = true)
47			{
48			$this->ioService = $ioService;
49
50			parent::__construct(null, $status, $headers);
51
52			$this->setFile($binaryFile, $contentDisposition, $autoLastModified);
53
54			if ($public) {
55			$this->setPublic();
56			}
57			}
58
59			/**
60			* Sets the file to stream.
61			*
62			* @param \SplFileInfo\|string $file The file to stream
63			* @param string $contentDisposition
64			* @param bool $autoEtag
			0 ignored issues – show Bug introduced 2015-11-21 14:36 UTC by Report Bug Copy Issue Report There is no parameter named `$autoEtag`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
65			* @param bool $autoLastModified
66			*
67			* @return BinaryFileResponse
68			*/
69			public function setFile($file, $contentDisposition = null, $autoLastModified = true)
70			{
71			$this->file = $file;
			0 ignored issues – show Documentation Bug introduced 2015-11-21 14:36 UTC by Report Bug Copy Issue Report It seems like `$file` of type `object<SplFileInfo>` or `string` is incompatible with the declared type `object<eZ\Publish\Core\IO\Values\BinaryFile>` of property `$file`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
72
73			if ($autoLastModified) {
74			$this->setAutoLastModified();
75			}
76
77			if ($contentDisposition) {
			0 ignored issues – show Bug Best Practice introduced 2015-11-21 14:36 UTC by Report Bug Copy Issue Report The expression `$contentDisposition` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
78			$this->setContentDisposition($contentDisposition);
79			}
80
81			return $this;
82			}
83
84			/**
85			* Gets the file.
86			*
87			* @return BinaryFile The file to stream
88			*/
89			public function getFile()
90			{
91			return $this->file;
92			}
93
94			/**
95			* Automatically sets the Last-Modified header according the file modification date.
96			*/
97			public function setAutoLastModified()
98			{
99			$this->setLastModified(DateTime::createFromFormat('U', $this->file->mtime->getTimestamp()));
			0 ignored issues – show Security Bug introduced 2019-04-05 10:51 UTC by Report Bug Copy Issue Report It seems like `\DateTime::createFromFor...>mtime->getTimestamp())` targeting `DateTime::createFromFormat()` can also be of type `false`; however, `Symfony\Component\HttpFo...onse::setLastModified()` does only seem to accept `null\|object<DateTimeInterface>`, did you maybe forget to handle an error condition? Loading history...
100
101			return $this;
102			}
103
104			/**
105			* Sets the Content-Disposition header with the given filename.
106			*
107			* @param string $disposition ResponseHeaderBag::DISPOSITION_INLINE or ResponseHeaderBag::DISPOSITION_ATTACHMENT
108			* @param string $filename Optionally use this filename instead of the real name of the file
109			* @param string $filenameFallback A fallback filename, containing only ASCII characters. Defaults to an automatically encoded filename
110			*
111			* @return BinaryStreamResponse
112			*/
113			public function setContentDisposition($disposition, $filename = '', $filenameFallback = '')
114			{
115			if ($filename === '') {
116			$filename = $this->file->id;
117			}
118
119			if (empty($filenameFallback)) {
120			$filenameFallback = mb_convert_encoding($filename, 'ASCII');
121			}
122
123			$dispositionHeader = $this->headers->makeDisposition($disposition, $filename, $filenameFallback);
124			$this->headers->set('Content-Disposition', $dispositionHeader);
125
126			return $this;
127			}
128
129			/**
130			* {@inheritdoc}
131			*/
132			public function prepare(Request $request)
133			{
134			$this->headers->set('Content-Length', $this->file->size);
135			$this->headers->set('Accept-Ranges', 'bytes');
136			$this->headers->set('Content-Transfer-Encoding', 'binary');
137
138			if (!$this->headers->has('Content-Type')) {
139			$this->headers->set(
140			'Content-Type',
141			$this->ioService->getMimeType($this->file->id) ?: 'application/octet-stream'
142			);
143			}
144
145			if ('HTTP/1.0' != $request->server->get('SERVER_PROTOCOL')) {
146			$this->setProtocolVersion('1.1');
147			}
148
149			$this->ensureIEOverSSLCompatibility($request);
150
151			$this->offset = 0;
152			$this->maxlen = -1;
153
154			if ($request->headers->has('Range')) {
155			// Process the range headers.
156			if (!$request->headers->has('If-Range') \|\| $this->getEtag() == $request->headers->get('If-Range')) {
157			$range = $request->headers->get('Range');
158			$fileSize = $this->file->size;
159
160			list($start, $end) = explode('-', substr($range, 6), 2) + [0];
161
162			$end = ('' === $end) ? $fileSize - 1 : (int)$end;
163
164			if ('' === $start) {
165			$start = $fileSize - $end;
166			$end = $fileSize - 1;
167			} else {
168			$start = (int)$start;
169			}
170
171			if ($start <= $end) {
172			if ($start < 0 \|\| $end > $fileSize - 1) {
173			$this->setStatusCode(416); // HTTP_REQUESTED_RANGE_NOT_SATISFIABLE
174			} elseif ($start !== 0 \|\| $end !== $fileSize - 1) {
175			$this->maxlen = $end < $fileSize ? $end - $start + 1 : -1;
176			$this->offset = $start;
177
178			$this->setStatusCode(206); // HTTP_PARTIAL_CONTENT
179			$this->headers->set('Content-Range', sprintf('bytes %s-%s/%s', $start, $end, $fileSize));
180			$this->headers->set('Content-Length', $end - $start + 1);
181			}
182			}
183			}
184			}
185
186			return $this;
187			}
188
189			/**
190			* Sends the file.
191			*/
192			public function sendContent()
193			{
194			if (!$this->isSuccessful()) {
195			parent::sendContent();
196
197			return;
198			}
199
200			if (0 === $this->maxlen) {
201			return;
202			}
203
204			$out = fopen('php://output', 'wb');
205			$in = $this->ioService->getFileInputStream($this->file);
206			stream_copy_to_stream($in, $out, $this->maxlen, $this->offset);
207
208			fclose($out);
209			}
210
211			/**
212			* {@inheritdoc}
213			*
214			* @throws LogicException when the content is not null
215			*/
216			public function setContent($content)
217			{
218			if (null !== $content) {
219			throw new LogicException('The content cannot be set on a BinaryStreamResponse instance.');
220			}
221			}
222
223			public function getContent()
224			{
225			return null;
226			}
227			}
228

ezsystems / ezpublish-kernel

BinaryStreamResponse::__construct() A last analyzed 2020-05-12 17:01 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

BinaryStreamResponse::__construct() A
last analyzed 2020-05-12 17:01 UTC