HTTPStreamResponse::getSavedBody() - Code Metrics - Inspection of "API Add streamable response object" - silverstripe/silverstripe-framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#6909)

by Damian

created 2017-05-23 04:33 UTC

HTTPStreamResponse::getSavedBody() A

↳ Parent: HTTPStreamResponse

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php

namespace SilverStripe\Control;

use BadMethodCallException;

/**
 * A response which contains a streamable data source.
 *
 * @package framework
 * @subpackage control
 */
class HTTPStreamResponse extends HTTPResponse
{

    /**
     * Stream source for this response
     *
     * @var resource
     */
    protected $stream = null;

    /**
     * Set to true if this stream has been consumed.
     * A consumed non-seekable stream will not be re-consumable
     *
     * @var bool
     */
    protected $consumed = false;

    /**
     * HTTPStreamResponse constructor.
     * @param resource $stream Data stream
     * @param int $contentLength size of the stream in bytes
     * @param int $statusCode The numeric status code - 200, 404, etc
     * @param string $statusDescription The text to be given alongside the status code.
     */
    public function __construct($stream, $contentLength, $statusCode = null, $statusDescription = null)
    {
        parent::__construct(null, $statusCode, $statusDescription);
        $this->setStream($stream);
        if ($contentLength) {
            $this->addHeader('Content-Length', $contentLength);
        }
    }

    /**
     * Determine if a stream is seekable
     *
     * @return bool
     */
    protected function isSeekable()
    {
        $stream = $this->getStream();
        if (!$stream) {
            return false;
        }
        $metadata = stream_get_meta_data($stream);
        return $metadata['seekable'];
    }

    /**
     * @return resource
     */
    public function getStream()
    {
        return $this->stream;
    }

    /**
     * @param resource $stream
     * @return $this
     */
    public function setStream($stream)
    {
        $this->setBody(null);
        $this->stream = $stream;
        return $this;
    }

    /**
     * Get body prior to stream traversal
     *
     * @return string
     */
    public function getSavedBody()
    {
        return parent::getBody();
class Daddy
{
    protected function getFirstName()
    {
        return "Eidur";
    }

    protected function getSurName()
    {
        return "Gudjohnsen";
    }
}

class Son
{
    public function getFirstName()
    {
        return parent::getSurname();
    }
}
    }

    public function getBody()
    {
        $body = $this->getSavedBody();
        if (isset($body)) {
            return $body;
        }

        // Consume stream into string
        $body = $this->consumeStream(function ($stream) {
            $body = stream_get_contents($stream);

            // If this stream isn't seekable, we'll need to save the body
            // in case of subsequent requests.
            if (!$this->isSeekable()) {
                $this->setBody($body);
            }
            return $body;
        });
        return $body;
    }

    /**
     * Safely consume the stream
     *
     * @param callable $callback Callback which will perform the consumable action on the stream
     * @return mixed Result of $callback($stream) or null if no stream available
     * @throws BadMethodCallException Throws exception if stream can't be re-consumed
     */
    protected function consumeStream($callback)
    {
        // Load from stream
        $stream = $this->getStream();
        if (!$stream) {
            return null;
        }

        // Check if stream must be rewound
        if ($this->consumed) {
            if (!$this->isSeekable()) {
                throw new BadMethodCallException(
                    "Unseekable stream has already been consumed"
                );
            }
            rewind($stream);
        }

        // Consume
        $this->consumed = true;
        return $callback($stream);
    }

    /**
     * Output body of this response to the browser
     */
    protected function outputBody()
    {
        // If the output has been overwritten, or the stream is irreversable and has
        // already been consumed, return the cached body.
        $body = $this->getSavedBody();
        if ($body) {
            echo $body;
            return;
        }

        // Stream to output
        if ($this->getStream()) {
            $this->consumeStream(function ($stream) {
                fpassthru($stream);
            });
            return;
        }

        // Fail over
        parent::outputBody();
    }
}


1			<?php
2
3			namespace SilverStripe\Control;
4
5			use BadMethodCallException;
6
7			/**
8			* A response which contains a streamable data source.
9			*
10			* @package framework
11			* @subpackage control
12			*/
13			class HTTPStreamResponse extends HTTPResponse
14			{
15
16			/**
17			* Stream source for this response
18			*
19			* @var resource
20			*/
21			protected $stream = null;
22
23			/**
24			* Set to true if this stream has been consumed.
25			* A consumed non-seekable stream will not be re-consumable
26			*
27			* @var bool
28			*/
29			protected $consumed = false;
30
31			/**
32			* HTTPStreamResponse constructor.
33			* @param resource $stream Data stream
34			* @param int $contentLength size of the stream in bytes
35			* @param int $statusCode The numeric status code - 200, 404, etc
36			* @param string $statusDescription The text to be given alongside the status code.
37			*/
38			public function __construct($stream, $contentLength, $statusCode = null, $statusDescription = null)
39			{
40			parent::__construct(null, $statusCode, $statusDescription);
41			$this->setStream($stream);
42			if ($contentLength) {
43			$this->addHeader('Content-Length', $contentLength);
44			}
45			}
46
47			/**
48			* Determine if a stream is seekable
49			*
50			* @return bool
51			*/
52			protected function isSeekable()
53			{
54			$stream = $this->getStream();
55			if (!$stream) {
56			return false;
57			}
58			$metadata = stream_get_meta_data($stream);
59			return $metadata['seekable'];
60			}
61
62			/**
63			* @return resource
64			*/
65			public function getStream()
66			{
67			return $this->stream;
68			}
69
70			/**
71			* @param resource $stream
72			* @return $this
73			*/
74			public function setStream($stream)
75			{
76			$this->setBody(null);
77			$this->stream = $stream;
78			return $this;
79			}
80
81			/**
82			* Get body prior to stream traversal
83			*
84			* @return string
85			*/
86			public function getSavedBody()
87			{
88			return parent::getBody();
			0 ignored issues – show Comprehensibility Bug introduced 2017-05-12 05:14 UTC by Report Bug Copy Issue Report It seems like you call parent on a different method (`getBody()` instead of `getSavedBody()`). Are you sure this is correct? If so, you might want to change this to `$this->getBody()`. This check looks for a call to a parent method whose name is different than the method from which it is called. Consider the following code: class Daddy { protected function getFirstName() { return "Eidur"; } protected function getSurName() { return "Gudjohnsen"; } } class Son { public function getFirstName() { return parent::getSurname(); } } The `getFirstName()` method in the `Son` calls the wrong method in the parent class. Loading history...
89			}
90
91			public function getBody()
92			{
93			$body = $this->getSavedBody();
94			if (isset($body)) {
95			return $body;
96			}
97
98			// Consume stream into string
99			$body = $this->consumeStream(function ($stream) {
100			$body = stream_get_contents($stream);
101
102			// If this stream isn't seekable, we'll need to save the body
103			// in case of subsequent requests.
104			if (!$this->isSeekable()) {
105			$this->setBody($body);
106			}
107			return $body;
108			});
109			return $body;
110			}
111
112			/**
113			* Safely consume the stream
114			*
115			* @param callable $callback Callback which will perform the consumable action on the stream
116			* @return mixed Result of $callback($stream) or null if no stream available
117			* @throws BadMethodCallException Throws exception if stream can't be re-consumed
118			*/
119			protected function consumeStream($callback)
120			{
121			// Load from stream
122			$stream = $this->getStream();
123			if (!$stream) {
124			return null;
125			}
126
127			// Check if stream must be rewound
128			if ($this->consumed) {
129			if (!$this->isSeekable()) {
130			throw new BadMethodCallException(
131			"Unseekable stream has already been consumed"
132			);
133			}
134			rewind($stream);
135			}
136
137			// Consume
138			$this->consumed = true;
139			return $callback($stream);
140			}
141
142			/**
143			* Output body of this response to the browser
144			*/
145			protected function outputBody()
146			{
147			// If the output has been overwritten, or the stream is irreversable and has
148			// already been consumed, return the cached body.
149			$body = $this->getSavedBody();
150			if ($body) {
151			echo $body;
152			return;
153			}
154
155			// Stream to output
156			if ($this->getStream()) {
157			$this->consumeStream(function ($stream) {
158			fpassthru($stream);
159			});
160			return;
161			}
162
163			// Fail over
164			parent::outputBody();
165			}
166			}
167

silverstripe / silverstripe-framework

Pull Request — master (#6909)

HTTPStreamResponse::getSavedBody() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like