MultipartStreamBuilder::reset() - Code Metrics - Inspection of "Merge pull request #25 from php-http/issue-24" - php-http/multipart-stream-builder - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( cf58c6...5e02c7 )

by David

created 2016-12-30 23:19 UTC

MultipartStreamBuilder::reset() A

↳ Parent: MultipartStreamBuilder

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	7
ccs	4
cts	4
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	4
nc	1
nop	0
crap	1

<?php

namespace Http\Message\MultipartStream;

use Http\Discovery\StreamFactoryDiscovery;
use Http\Message\StreamFactory;
use Psr\Http\Message\StreamInterface;

/**
 * Build your own Multipart stream. A Multipart stream is a collection of streams separated with a $bounary. This
 * class helps you to create a Multipart stream with stream implementations from any PSR7 library.
 *
 * @author Michael Dowling and contributors to guzzlehttp/psr7
 * @author Tobias Nyholm <[email protected]>
 */
class MultipartStreamBuilder
{
    /**
     * @var StreamFactory
     */
    private $streamFactory;

    /**
     * @var MimetypeHelper
     */
    private $mimetypeHelper;

    /**
     * @var string
     */
    private $boundary;

    /**
     * @var array Element where each Element is an array with keys ['contents', 'headers', 'filename']
     */
    private $data = [];

    /**
     * @param StreamFactory|null $streamFactory
     */
    public function __construct(StreamFactory $streamFactory = null)
    {
        $this->streamFactory = $streamFactory ?: StreamFactoryDiscovery::find();
    }

    /**
     * Add a resource to the Multipart Stream. If the same $name is used twice the first resource will
     * be overwritten.
     *
     * @param string                          $name     the formpost name
     * @param string|resource|StreamInterface $resource
     * @param array                           $options  {
     *
     *     @var array $headers additional headers ['header-name' => 'header-value']
     *     @var string $filename
     * }
     *
     * @return MultipartStreamBuilder
     */
    public function addResource($name, $resource, array $options = [])
    {
        $stream = $this->streamFactory->createStream($resource);

        // validate options['headers'] exists
        if (!isset($options['headers'])) {
            $options['headers'] = [];
        }

        // Try to add filename if it is missing
        if (empty($options['filename'])) {
            $options['filename'] = null;
            $uri = $stream->getMetadata('uri');
            if (substr($uri, 0, 6) !== 'php://') {
                $options['filename'] = $uri;
            }
        }

        $this->prepareHeaders($name, $stream, $options['filename'], $options['headers']);
        $this->data[$name] = ['contents' => $stream, 'headers' => $options['headers'], 'filename' => $options['filename']];

        return $this;
    }

    /**
     * Build the stream.
     *
     * @return StreamInterface
     */
    public function build()
    {
        $streams = '';
        foreach ($this->data as $data) {
            // Add start and headers
            $streams .= "--{$this->getBoundary()}\r\n".
                $this->getHeaders($data['headers'])."\r\n";

            // Convert the stream to string
            $streams .= (string) $data['contents'];
            $streams .= "\r\n";
        }

        // Append end
        $streams .= "--{$this->getBoundary()}--\r\n";

        return $this->streamFactory->createStream($streams);
    }

    /**
     * Add extra headers if they are missing.
     *
     * @param string          $name
     * @param StreamInterface $stream
     * @param string          $filename
     * @param array           &$headers
     */
    private function prepareHeaders($name, StreamInterface $stream, $filename, array &$headers)
    {
        $hasFilename = $filename === '0' || $filename;

        // Set a default content-disposition header if one was not provided
        if (!$this->hasHeader($headers, 'content-disposition')) {
            $headers['Content-Disposition'] = sprintf('form-data; name="%s"', $name);
            if ($hasFilename) {
                $headers['Content-Disposition'] .= sprintf('; filename="%s"', $this->basename($filename));
            }
        }

        // Set a default content-length header if one was not provided
        if (!$this->hasHeader($headers, 'content-length')) {
            if ($length = $stream->getSize()) {
                $headers['Content-Length'] = (string) $length;
            }
        }

        // Set a default Content-Type if one was not provided
        if (!$this->hasHeader($headers, 'content-type') && $hasFilename) {
            if ($type = $this->getMimetypeHelper()->getMimetypeFromFilename($filename)) {
                $headers['Content-Type'] = $type;
            }
        }
    }

    /**
     * Get the headers formatted for the HTTP message.
     *
     * @param array $headers
     *
     * @return string
     */
    private function getHeaders(array $headers)
    {
        $str = '';
        foreach ($headers as $key => $value) {
            $str .= sprintf("%s: %s\r\n", $key, $value);
        }

        return $str;
    }

    /**
     * Check if header exist.
     *
     * @param array  $headers
     * @param string $key     case insensitive
     *
     * @return bool
     */
    private function hasHeader(array $headers, $key)
    {
        $lowercaseHeader = strtolower($key);
        foreach ($headers as $k => $v) {
            if (strtolower($k) === $lowercaseHeader) {
                return true;
            }
        }

        return false;
    }

    /**
     * Get the boundary that separates the streams.
     *
     * @return string
     */
    public function getBoundary()
    {
        if ($this->boundary === null) {
            $this->boundary = uniqid();
        }

        return $this->boundary;
    }

    /**
     * @param string $boundary
     *
     * @return MultipartStreamBuilder
     */
    public function setBoundary($boundary)
    {
        $this->boundary = $boundary;

        return $this;
    }

    /**
     * @return MimetypeHelper
     */
    private function getMimetypeHelper()
    {
        if ($this->mimetypeHelper === null) {
            $this->mimetypeHelper = new ApacheMimetypeHelper();
        }

        return $this->mimetypeHelper;
    }

    /**
     * If you have custom file extension you may overwrite the default MimetypeHelper with your own.
     *
     * @param MimetypeHelper $mimetypeHelper
     *
     * @return MultipartStreamBuilder
     */
    public function setMimetypeHelper(MimetypeHelper $mimetypeHelper)
    {
        $this->mimetypeHelper = $mimetypeHelper;

        return $this;
    }

    /**
     * Reset and clear all stored data. This allows you to use builder for a subsequent request.
     *
     * @return MultipartStreamBuilder
     */
    public function reset()
    {
        $this->data = [];
        $this->boundary = null;

        return $this;
    }

    /**
     * Gets the filename from a given path.
     *
     * PHP's basename() does not properly support streams or filenames beginning with a non-US-ASCII character.
     *
     * @author Drupal 8.2
     *
     * @param string $path
     *
     * @return string
     */
    private function basename($path)
    {
        $separators = '/';
        if (DIRECTORY_SEPARATOR != '/') {
            // For Windows OS add special separator.
            $separators .= DIRECTORY_SEPARATOR;
        }

        // Remove right-most slashes when $path points to directory.
        $path = rtrim($path, $separators);

        // Returns the trailing part of the $path starting after one of the directory separators.
        $filename = preg_match('@[^'.preg_quote($separators, '@').']+$@', $path, $matches) ? $matches[0] : '';

        return $filename;
    }
}


1		<?php
2
3		namespace Http\Message\MultipartStream;
4
5		use Http\Discovery\StreamFactoryDiscovery;
6		use Http\Message\StreamFactory;
7		use Psr\Http\Message\StreamInterface;
8
9		/**
10		* Build your own Multipart stream. A Multipart stream is a collection of streams separated with a $bounary. This
11		* class helps you to create a Multipart stream with stream implementations from any PSR7 library.
12		*
13		* @author Michael Dowling and contributors to guzzlehttp/psr7
14		* @author Tobias Nyholm <[email protected]>
15		*/
16		class MultipartStreamBuilder
17		{
18		/**
19		* @var StreamFactory
20		*/
21		private $streamFactory;
22
23		/**
24		* @var MimetypeHelper
25		*/
26		private $mimetypeHelper;
27
28		/**
29		* @var string
30		*/
31		private $boundary;
32
33		/**
34		* @var array Element where each Element is an array with keys ['contents', 'headers', 'filename']
35		*/
36		private $data = [];
37
38		/**
39		* @param StreamFactory\|null $streamFactory
40		*/
41	8	public function __construct(StreamFactory $streamFactory = null)
42		{
43	8	$this->streamFactory = $streamFactory ?: StreamFactoryDiscovery::find();
44	8	}
45
46		/**
47		* Add a resource to the Multipart Stream. If the same $name is used twice the first resource will
48		* be overwritten.
49		*
50		* @param string $name the formpost name
51		* @param string\|resource\|StreamInterface $resource
52		* @param array $options {
53		*
54		* @var array $headers additional headers ['header-name' => 'header-value']
55		* @var string $filename
56		* }
57		*
58		* @return MultipartStreamBuilder
59		*/
60	8	public function addResource($name, $resource, array $options = [])
61		{
62	8	$stream = $this->streamFactory->createStream($resource);
63
64		// validate options['headers'] exists
65	8	if (!isset($options['headers'])) {
66	7	$options['headers'] = [];
67	7	}
68
69		// Try to add filename if it is missing
70	8	if (empty($options['filename'])) {
71	7	$options['filename'] = null;
72	7	$uri = $stream->getMetadata('uri');
73	7	if (substr($uri, 0, 6) !== 'php://') {
74	1	$options['filename'] = $uri;
75	1	}
76	7	}
77
78	8	$this->prepareHeaders($name, $stream, $options['filename'], $options['headers']);
79	8	$this->data[$name] = ['contents' => $stream, 'headers' => $options['headers'], 'filename' => $options['filename']];
80
81	8	return $this;
82		}
83
84		/**
85		* Build the stream.
86		*
87		* @return StreamInterface
88		*/
89	8	public function build()
90		{
91	8	$streams = '';
92	8	foreach ($this->data as $data) {
93		// Add start and headers
94	7	$streams .= "--{$this->getBoundary()}\r\n".
95	7	$this->getHeaders($data['headers'])."\r\n";
96
97		// Convert the stream to string
98	7	$streams .= (string) $data['contents'];
99	7	$streams .= "\r\n";
100	8	}
101
102		// Append end
103	8	$streams .= "--{$this->getBoundary()}--\r\n";
104
105	8	return $this->streamFactory->createStream($streams);
106		}
107
108		/**
109		* Add extra headers if they are missing.
110		*
111		* @param string $name
112		* @param StreamInterface $stream
113		* @param string $filename
114		* @param array &$headers
115		*/
116	8	private function prepareHeaders($name, StreamInterface $stream, $filename, array &$headers)
117		{
118	8	$hasFilename = $filename === '0' \|\| $filename;
119
120		// Set a default content-disposition header if one was not provided
121	8	if (!$this->hasHeader($headers, 'content-disposition')) {
122	7	$headers['Content-Disposition'] = sprintf('form-data; name="%s"', $name);
123	7	if ($hasFilename) {
124	2	$headers['Content-Disposition'] .= sprintf('; filename="%s"', $this->basename($filename));
125	2	}
126	7	}
127
128		// Set a default content-length header if one was not provided
129	8	if (!$this->hasHeader($headers, 'content-length')) {
130	7	if ($length = $stream->getSize()) {
131	7	$headers['Content-Length'] = (string) $length;
132	7	}
133	7	}
134
135		// Set a default Content-Type if one was not provided
136	8	if (!$this->hasHeader($headers, 'content-type') && $hasFilename) {
137	2	if ($type = $this->getMimetypeHelper()->getMimetypeFromFilename($filename)) {
138	2	$headers['Content-Type'] = $type;
139	2	}
140	2	}
141	8	}
142
143		/**
144		* Get the headers formatted for the HTTP message.
145		*
146		* @param array $headers
147		*
148		* @return string
149		*/
150	7	private function getHeaders(array $headers)
151		{
152	7	$str = '';
153	7	foreach ($headers as $key => $value) {
154	7	$str .= sprintf("%s: %s\r\n", $key, $value);
155	7	}
156
157	7	return $str;
158		}
159
160		/**
161		* Check if header exist.
162		*
163		* @param array $headers
164		* @param string $key case insensitive
165		*
166		* @return bool
167		*/
168	8	private function hasHeader(array $headers, $key)
169		{
170	8	$lowercaseHeader = strtolower($key);
171	8	foreach ($headers as $k => $v) {
172	8	if (strtolower($k) === $lowercaseHeader) {
173	1	return true;
174		}
175	8	}
176
177	7	return false;
178		}
179
180		/**
181		* Get the boundary that separates the streams.
182		*
183		* @return string
184		*/
185	8	public function getBoundary()
186		{
187	8	if ($this->boundary === null) {
188	7	$this->boundary = uniqid();
189	7	}
190
191	8	return $this->boundary;
192		}
193
194		/**
195		* @param string $boundary
196		*
197		* @return MultipartStreamBuilder
198		*/
199	2	public function setBoundary($boundary)
200		{
201	2	$this->boundary = $boundary;
202
203	2	return $this;
204		}
205
206		/**
207		* @return MimetypeHelper
208		*/
209	2	private function getMimetypeHelper()
210		{
211	2	if ($this->mimetypeHelper === null) {
212	2	$this->mimetypeHelper = new ApacheMimetypeHelper();
213	2	}
214
215	2	return $this->mimetypeHelper;
216		}
217
218		/**
219		* If you have custom file extension you may overwrite the default MimetypeHelper with your own.
220		*
221		* @param MimetypeHelper $mimetypeHelper
222		*
223		* @return MultipartStreamBuilder
224		*/
225		public function setMimetypeHelper(MimetypeHelper $mimetypeHelper)
226		{
227		$this->mimetypeHelper = $mimetypeHelper;
228
229		return $this;
230		}
231
232		/**
233		* Reset and clear all stored data. This allows you to use builder for a subsequent request.
234		*
235		* @return MultipartStreamBuilder
236		*/
237	1	public function reset()
238		{
239	1	$this->data = [];
240	1	$this->boundary = null;
241
242	1	return $this;
243		}
244
245		/**
246		* Gets the filename from a given path.
247		*
248		* PHP's basename() does not properly support streams or filenames beginning with a non-US-ASCII character.
249		*
250		* @author Drupal 8.2
251		*
252		* @param string $path
253		*
254		* @return string
255		*/
256	2	private function basename($path)
257		{
258	2	$separators = '/';
259	2	if (DIRECTORY_SEPARATOR != '/') {
260		// For Windows OS add special separator.
261		$separators .= DIRECTORY_SEPARATOR;
262		}
263
264		// Remove right-most slashes when $path points to directory.
265	2	$path = rtrim($path, $separators);
266
267		// Returns the trailing part of the $path starting after one of the directory separators.
268	2	$filename = preg_match('@[^'.preg_quote($separators, '@').']+$@', $path, $matches) ? $matches[0] : '';
269
270	2	return $filename;
271		}
272		}
273

php-http / multipart-stream-builder

Push — master ( cf58c6...5e02c7 )

MultipartStreamBuilder::reset() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like