AwsS3 - Code Metrics - Inspection of "AwsS3 Multipart Uploads" - KnpLabs/Gaufrette - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#513)

unknown

created 2017-07-02 13:13 UTC

AwsS3 C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	489
Duplicated Lines	10.22 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

Metric	Value
wmc	58
lcom	1
cbo	3
dl	50
loc	489
rs	6.3005
c	0
b	0
f	0

25 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	25	5
A	getUrl()	0	14	2
A	setMetadata()	0	10	2
A	getMetadata()	0	4	2
A	read()	0	20	4
A	rename()	0	16	2
D	write()	0	39	9
A	exists()	0	4	1
A	mtime()	9	10	2
A	size()	9	10	2
A	keys()	0	4	1
A	listKeys()	5	17	4
A	delete()	0	10	2
A	isDirectory()	0	10	1
B	ensureBucketExists()	0	25	4
A	getOptions()	0	14	1
A	computePath()	8	8	2
B	multipartUpload()	0	27	3
A	initiateMultipartUpload()	0	7	1
A	uploadNextPart()	0	15	1
A	completeMultipartUpload()	0	11	1
A	abortMultipartUpload()	0	5	1
A	computeKey()	0	4	1
A	guessContentType()	10	10	2
A	mimeType()	9	9	2

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like AwsS3 often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use AwsS3, and based on these observations, apply Extract Interface, too.

<?php

namespace Gaufrette\Adapter;

use Gaufrette\Adapter;
use Aws\S3\S3Client;
use Aws\S3\Exception\S3Exception;
use Gaufrette\Util;

/**
 * Amazon S3 adapter using the AWS SDK for PHP v2.x.
 *
 * @author  Michael Dowling <[email protected]>
 */
class AwsS3 implements Adapter,

                       MetadataSupporter,

                       ListKeysAware,

                       SizeCalculator,

                       MimeTypeProvider

{
    /*
     * Amazon S3 does not not allow uploads > 5Go
     */
    const MAX_CONTENT_SIZE = 5368709120;
    const DEFAULT_PART_SIZE = 5242880;

    /** @var S3Client */
    protected $service;
    /** @var string */
    protected $bucket;
    /** @var array */
    protected $options;
    /** @var bool */
    protected $bucketExists;
    /** @var array */
    protected $metadata = [];
    /** @var bool */
    protected $detectContentType;
    /** @var int */
    protected $sizeLimit = self::MAX_CONTENT_SIZE;
    /** @var int */
    protected $partSize = self::DEFAULT_PART_SIZE;

    /**
     * @param S3Client $service
     * @param string   $bucket
     * @param array    $options
     * @param bool     $detectContentType
     */
    public function __construct(S3Client $service, $bucket, array $options = [], $detectContentType = false)
    {
        $this->service = $service;
        $this->bucket = $bucket;

        if (isset($options['size_limit']) && $options['size_limit'] <= self::MAX_CONTENT_SIZE) {
            $this->sizeLimit = $options['size_limit'];
        }

        if (isset($options['part_size']) && $options['part_size'] >= self::DEFAULT_PART_SIZE) {
            $this->partSize = $options['part_size'];
        }


        $this->options = array_replace(
            [
                'create' => false,
                'directory' => '',
                'acl' => 'private',
            ],
            $options
        );

        $this->detectContentType = $detectContentType;
    }

    /**
     * Gets the publicly accessible URL of an Amazon S3 object.
     *
     * @param string $key     Object key
     * @param array  $options Associative array of options used to buld the URL
     *                        - expires: The time at which the URL should expire
     *                        represented as a UNIX timestamp
     *                        - Any options available in the Amazon S3 GetObject
     *                        operation may be specified.
     *
     * @return string
     *
     * @deprecated 1.0 Resolving object path into URLs is out of the scope of this repository since v0.4. gaufrette/extras
     *                 provides a Filesystem decorator with a regular resolve() method. You should use it instead.
     *
     * @see https://github.com/Gaufrette/extras
     */
    public function getUrl($key, array $options = [])
    {
        @trigger_error(
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            E_USER_DEPRECATED,
            'Using AwsS3::getUrl() method was deprecated since v0.4. Please chek gaufrette/extras package if you want this feature'
        );

        return $this->service->getObjectUrl(
            $this->bucket,
            $this->computePath($key),
            isset($options['expires']) ? $options['expires'] : null,

            $options
        );
    }

    /**
     * {@inheritdoc}
     */
    public function setMetadata($key, $metadata)
    {
        // BC with AmazonS3 adapter
        if (isset($metadata['contentType'])) {
            $metadata['ContentType'] = $metadata['contentType'];
            unset($metadata['contentType']);
        }

        $this->metadata[$key] = $metadata;
    }

    /**
     * {@inheritdoc}
     */
    public function getMetadata($key)
    {
        return isset($this->metadata[$key]) ? $this->metadata[$key] : [];
    }

    /**
     * {@inheritdoc}
     */
    public function read($key)
    {
        $this->ensureBucketExists();
        $options = $this->getOptions($key);

        try {
            // Get remote object
            $object = $this->service->getObject($options);
            // If there's no metadata array set up for this object, set it up
            if (!array_key_exists($key, $this->metadata) || !is_array($this->metadata[$key])) {
                $this->metadata[$key] = [];
            }
            // Make remote ContentType metadata available locally
            $this->metadata[$key]['ContentType'] = $object->get('ContentType');

            return (string) $object->get('Body');
        } catch (\Exception $e) {
            return false;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function rename($sourceKey, $targetKey)
    {
        $this->ensureBucketExists();
        $options = $this->getOptions(
            $targetKey,
            ['CopySource' => $this->bucket.'/'.$this->computePath($sourceKey)]
        );

        try {
            $this->service->copyObject(array_merge($options, $this->getMetadata($targetKey)));

            return $this->delete($sourceKey);
        } catch (\Exception $e) {
            return false;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function write($key, $content)
    {
        $this->ensureBucketExists();
        $options = $this->getOptions($key, ['Body' => $content]);

        /*
         * If the ContentType was not already set in the metadata, then we autodetect
         * it to prevent everything being served up as binary/octet-stream.
         */
        if (!isset($options['ContentType']) && $this->detectContentType) {
            $options['ContentType'] = $this->guessContentType($content);
        }

        if ($isResource = is_resource($content)) {
            $size = Util\Size::fromResource($content);
        } else {
            $size =  Util\Size::fromContent($content);
        }

        try {
            $success = true;

            if ($size >= $this->sizeLimit && $isResource) {
                $success = $this->multipartUpload($key, $content);
            } else if ($size <= $this->sizeLimit) {
                $this->service->putObject($options);
            } else {
                /*
                 * content is a string & too big to be uploaded in one shot
                 * We may want to throw an exception here ?
                 */
                return false;
            }

            return $success ? $size : false;

        } catch (\Exception $e) {
            return false;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function exists($key)
    {
        return $this->service->doesObjectExist($this->bucket, $this->computePath($key));
    }

    /**
     * {@inheritdoc}
     */
    public function mtime($key)

    {
        try {
            $result = $this->service->headObject($this->getOptions($key));

            return strtotime($result['LastModified']);
        } catch (\Exception $e) {
            return false;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function size($key)

    {
        try {
            $result = $this->service->headObject($this->getOptions($key));

            return $result['ContentLength'];
        } catch (\Exception $e) {
            return false;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }
    }

    /**
     * {@inheritdoc}
     */
    public function keys()
    {
        return $this->listKeys();
    }

    /**
     * {@inheritdoc}
     */
    public function listKeys($prefix = '')
    {
        $options = ['Bucket' => $this->bucket];
        if ((string) $prefix != '') {

            $options['Prefix'] = $this->computePath($prefix);
        } elseif (!empty($this->options['directory'])) {
            $options['Prefix'] = $this->options['directory'];
        }

        $keys = [];
        $iter = $this->service->getIterator('ListObjects', $options);
        foreach ($iter as $file) {
            $keys[] = $this->computeKey($file['Key']);
        }

        return $keys;
    }

    /**
     * {@inheritdoc}
     */
    public function delete($key)
    {
        try {
            $this->service->deleteObject($this->getOptions($key));

            return true;
        } catch (\Exception $e) {
            return false;
        }
    }

    /**
     * {@inheritdoc}
     */
    public function isDirectory($key)
    {
        $result = $this->service->listObjects([
            'Bucket' => $this->bucket,
            'Prefix' => rtrim($this->computePath($key), '/').'/',
            'MaxKeys' => 1,
        ]);

        return count($result['Contents']) > 0;
    }

    /**
     * Ensures the specified bucket exists. If the bucket does not exists
     * and the create option is set to true, it will try to create the
     * bucket. The bucket is created using the same region as the supplied
     * client object.
     *
     * @throws \RuntimeException if the bucket does not exists or could not be
     *                           created
     */
    protected function ensureBucketExists()
    {
        if ($this->bucketExists) {
            return true;
        }

        if ($this->bucketExists = $this->service->doesBucketExist($this->bucket)) {
            return true;
        }

        if (!$this->options['create']) {
            throw new \RuntimeException(sprintf(
                'The configured bucket "%s" does not exist.',
                $this->bucket
            ));
        }

        $this->service->createBucket([
            'Bucket' => $this->bucket,
            'LocationConstraint' => $this->service->getRegion()
        ]);
        $this->bucketExists = true;

        return true;
    }

    protected function getOptions($key, array $options = [])
    {
        $options['ACL'] = $this->options['acl'];
        $options['Bucket'] = $this->bucket;
        $options['Key'] = $this->computePath($key);

        /*
         * Merge global options for adapter, which are set in the constructor, with metadata.
         * Metadata will override global options.
         */
        $options = array_merge($this->options, $options, $this->getMetadata($key));

        return $options;
    }

    protected function computePath($key)

    {
        if (empty($this->options['directory'])) {
            return $key;
        }

        return sprintf('%s/%s', $this->options['directory'], $key);
    }


    /**
     * MultiPart upload for big files (exceeding size_limit)
     *
     * @param $key
     * @param $content
     *
     * @return bool
     */
    protected function multipartUpload($key, $content)
    {
        $uploadId = $this->initiateMultipartUpload($key);

        $parts = [];
        $partNumber = 1;

        rewind($content);

        try {
            while (!feof($content)) {
                $result = $this->uploadNextPart($key, $content, $uploadId, $partNumber);
                $parts[] = [
                    'PartNumber' => $partNumber++,
                    'ETag' => $result['ETag'],
                ];
            }
        } catch (S3Exception $e) {
            $this->abortMultipartUpload($key, $uploadId);

            return false;
        }

        $this->completeMultipartUpload($key, $uploadId, $parts);

        return true;
    }

    /**
     * @param $key
     *
     * @return mixed
     */
    protected function initiateMultipartUpload($key)
    {
        $options = $this->getOptions($key);
        $result = $this->service->createMultipartUpload($options);

        return $result['UploadId'];
    }

    /**
     * @param $key
     * @param $content
     * @param $uploadId
     * @param $partNumber
     *
     * @return \Aws\Result
     */
    protected function uploadNextPart($key, $content, $uploadId, $partNumber)
    {
        $options = $this->getOptions(
            $key,
            [
                'UploadId' => $uploadId,
                'PartNumber' => $partNumber,
                'Body' => fread($content, $this->partSize),
            ]
        );

        $options = $this->getOptions($key, $options);

        return $this->service->uploadPart($options);
    }

    /**
     * @param $key
     * @param $uploadId
     * @param $parts
     */
    protected function completeMultipartUpload($key, $uploadId, $parts)
    {
       $options = $this->getOptions(
           $key,
           [
               'UploadId' => $uploadId,
               'MultipartUpload' => ['Parts' => $parts],
           ]
        );
        $this->service->completeMultipartUpload($options);
    }

    protected function abortMultipartUpload($key, $uploadId)
    {
        $options = $this->getOptions($key, ['UploadId' => $uploadId]);
        $this->service->abortMultipartUpload($options);
    }

    /**
     * Computes the key from the specified path.
     *
     * @param string $path
     *
     * @return string
     */
    protected function computeKey($path)
    {
        return ltrim(substr($path, strlen($this->options['directory'])), '/');
    }

    /**
     * @param string $content
     *
     * @return string
     */
    private function guessContentType($content)

    {
        $fileInfo = new \finfo(FILEINFO_MIME_TYPE);

        if (is_resource($content)) {
            return $fileInfo->file(stream_get_meta_data($content)['uri']);
        }

        return $fileInfo->buffer($content);
    }

    public function mimeType($key)

    {
        try {
            $result = $this->service->headObject($this->getOptions($key));
            return ($result['ContentType']);
        } catch (\Exception $e) {
            return false;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }
    }
}


1		<?php
2
3		namespace Gaufrette\Adapter;
4
5		use Gaufrette\Adapter;
6		use Aws\S3\S3Client;
7		use Aws\S3\Exception\S3Exception;
8		use Gaufrette\Util;
9
10		/**
11		* Amazon S3 adapter using the AWS SDK for PHP v2.x.
12		*
13		* @author Michael Dowling <[email protected]>
14		*/
15		class AwsS3 implements Adapter,
		0 ignored issues – show Coding Style introduced 2016-03-05 14:38 UTC by Report Bug Copy Issue Report The first item in a multi-line implements list must be on the line following the implements keyword Loading history...
16		MetadataSupporter,
		0 ignored issues – show Coding Style introduced 2016-03-05 14:38 UTC by Report Bug Copy Issue Report Expected 4 spaces before interface name; 23 found Loading history...
17		ListKeysAware,
		0 ignored issues – show Coding Style introduced 2016-03-05 14:38 UTC by Report Bug Copy Issue Report Expected 4 spaces before interface name; 23 found Loading history...
18		SizeCalculator,
		0 ignored issues – show Coding Style introduced 2017-05-21 20:39 UTC by Report Bug Copy Issue Report Expected 4 spaces before interface name; 23 found Loading history...
19		MimeTypeProvider
		0 ignored issues – show Coding Style introduced 2017-07-02 13:15 UTC by Report Bug Copy Issue Report Expected 4 spaces before interface name; 23 found Loading history...
20		{
21		/*
22		* Amazon S3 does not not allow uploads > 5Go
23		*/
24		const MAX_CONTENT_SIZE = 5368709120;
25		const DEFAULT_PART_SIZE = 5242880;
26
27		/** @var S3Client */
28		protected $service;
29		/** @var string */
30		protected $bucket;
31		/** @var array */
32		protected $options;
33		/** @var bool */
34		protected $bucketExists;
35		/** @var array */
36		protected $metadata = [];
37		/** @var bool */
38		protected $detectContentType;
39		/** @var int */
40		protected $sizeLimit = self::MAX_CONTENT_SIZE;
41		/** @var int */
42		protected $partSize = self::DEFAULT_PART_SIZE;
43
44		/**
45		* @param S3Client $service
46		* @param string $bucket
47		* @param array $options
48		* @param bool $detectContentType
49		*/
50		public function __construct(S3Client $service, $bucket, array $options = [], $detectContentType = false)
51		{
52		$this->service = $service;
53		$this->bucket = $bucket;
54
55		if (isset($options['size_limit']) && $options['size_limit'] <= self::MAX_CONTENT_SIZE) {
56		$this->sizeLimit = $options['size_limit'];
57		}
58
59		if (isset($options['part_size']) && $options['part_size'] >= self::DEFAULT_PART_SIZE) {
60		$this->partSize = $options['part_size'];
61		}
62
63
64		$this->options = array_replace(
65		[
66		'create' => false,
67		'directory' => '',
68		'acl' => 'private',
69		],
70		$options
71		);
72
73		$this->detectContentType = $detectContentType;
74		}
75
76		/**
77		* Gets the publicly accessible URL of an Amazon S3 object.
78		*
79		* @param string $key Object key
80		* @param array $options Associative array of options used to buld the URL
81		* - expires: The time at which the URL should expire
82		* represented as a UNIX timestamp
83		* - Any options available in the Amazon S3 GetObject
84		* operation may be specified.
85		*
86		* @return string
87		*
88		* @deprecated 1.0 Resolving object path into URLs is out of the scope of this repository since v0.4. gaufrette/extras
89		* provides a Filesystem decorator with a regular resolve() method. You should use it instead.
90		*
91		* @see https://github.com/Gaufrette/extras
92		*/
93		public function getUrl($key, array $options = [])
94		{
95		@trigger_error(
		0 ignored issues – show Security Best Practice introduced 2017-06-02 13:12 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
96		E_USER_DEPRECATED,
97		'Using AwsS3::getUrl() method was deprecated since v0.4. Please chek gaufrette/extras package if you want this feature'
98		);
99
100		return $this->service->getObjectUrl(
101		$this->bucket,
102		$this->computePath($key),
103		isset($options['expires']) ? $options['expires'] : null,
		0 ignored issues – show Unused Code introduced 2017-03-16 01:34 UTC by Report Bug Copy Issue Report The call to `S3Client::getObjectUrl()` has too many arguments starting with `isset($options['expires'...tions['expires'] : null`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
104		$options
105		);
106		}
107
108		/**
109		* {@inheritdoc}
110		*/
111		public function setMetadata($key, $metadata)
112		{
113		// BC with AmazonS3 adapter
114		if (isset($metadata['contentType'])) {
115		$metadata['ContentType'] = $metadata['contentType'];
116		unset($metadata['contentType']);
117		}
118
119		$this->metadata[$key] = $metadata;
120		}
121
122		/**
123		* {@inheritdoc}
124		*/
125		public function getMetadata($key)
126		{
127		return isset($this->metadata[$key]) ? $this->metadata[$key] : [];
128		}
129
130		/**
131		* {@inheritdoc}
132		*/
133		public function read($key)
134		{
135		$this->ensureBucketExists();
136		$options = $this->getOptions($key);
137
138		try {
139		// Get remote object
140		$object = $this->service->getObject($options);
141		// If there's no metadata array set up for this object, set it up
142		if (!array_key_exists($key, $this->metadata) \|\| !is_array($this->metadata[$key])) {
143		$this->metadata[$key] = [];
144		}
145		// Make remote ContentType metadata available locally
146		$this->metadata[$key]['ContentType'] = $object->get('ContentType');
147
148		return (string) $object->get('Body');
149		} catch (\Exception $e) {
150		return false;
151		}
152		}
153
154		/**
155		* {@inheritdoc}
156		*/
157		public function rename($sourceKey, $targetKey)
158		{
159		$this->ensureBucketExists();
160		$options = $this->getOptions(
161		$targetKey,
162		['CopySource' => $this->bucket.'/'.$this->computePath($sourceKey)]
163		);
164
165		try {
166		$this->service->copyObject(array_merge($options, $this->getMetadata($targetKey)));
167
168		return $this->delete($sourceKey);
169		} catch (\Exception $e) {
170		return false;
171		}
172		}
173
174		/**
175		* {@inheritdoc}
176		*/
177		public function write($key, $content)
178		{
179		$this->ensureBucketExists();
180		$options = $this->getOptions($key, ['Body' => $content]);
181
182		/*
183		* If the ContentType was not already set in the metadata, then we autodetect
184		* it to prevent everything being served up as binary/octet-stream.
185		*/
186		if (!isset($options['ContentType']) && $this->detectContentType) {
187		$options['ContentType'] = $this->guessContentType($content);
188		}
189
190		if ($isResource = is_resource($content)) {
191		$size = Util\Size::fromResource($content);
192		} else {
193		$size = Util\Size::fromContent($content);
194		}
195
196		try {
197		$success = true;
198
199		if ($size >= $this->sizeLimit && $isResource) {
200		$success = $this->multipartUpload($key, $content);
201		} else if ($size <= $this->sizeLimit) {
202		$this->service->putObject($options);
203		} else {
204		/*
205		* content is a string & too big to be uploaded in one shot
206		* We may want to throw an exception here ?
207		*/
208		return false;
209		}
210
211		return $success ? $size : false;
		0 ignored issues – show Bug Compatibility introduced 2017-07-02 13:15 UTC by Report Bug Copy Issue Report The expression `$success ? $size : false;` of type `string\|integer\|false` adds the type `string` to the return on line 211 which is incompatible with the return type declared by the interface `Gaufrette\Adapter::write` of type `integer\|boolean`. Loading history...
212		} catch (\Exception $e) {
213		return false;
214		}
215		}
216
217		/**
218		* {@inheritdoc}
219		*/
220		public function exists($key)
221		{
222		return $this->service->doesObjectExist($this->bucket, $this->computePath($key));
223		}
224
225		/**
226		* {@inheritdoc}
227		*/
228	View Code Duplication	public function mtime($key)
		0 ignored issues – show Duplication introduced 2016-03-05 14:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
229		{
230		try {
231		$result = $this->service->headObject($this->getOptions($key));
232
233		return strtotime($result['LastModified']);
234		} catch (\Exception $e) {
235		return false;
236		}
237		}
238
239		/**
240		* {@inheritdoc}
241		*/
242	View Code Duplication	public function size($key)
		0 ignored issues – show Duplication introduced 2016-03-05 14:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
243		{
244		try {
245		$result = $this->service->headObject($this->getOptions($key));
246
247		return $result['ContentLength'];
248		} catch (\Exception $e) {
249		return false;
		0 ignored issues – show Bug Best Practice introduced 2016-12-14 20:44 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type declared by the interface `Gaufrette\Adapter\SizeCalculator::size` of type `integer`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
250		}
251		}
252
253		/**
254		* {@inheritdoc}
255		*/
256		public function keys()
257		{
258		return $this->listKeys();
259		}
260
261		/**
262		* {@inheritdoc}
263		*/
264		public function listKeys($prefix = '')
265		{
266		$options = ['Bucket' => $this->bucket];
267	View Code Duplication	if ((string) $prefix != '') {
		0 ignored issues – show Duplication introduced 2017-03-19 17:27 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
268		$options['Prefix'] = $this->computePath($prefix);
269		} elseif (!empty($this->options['directory'])) {
270		$options['Prefix'] = $this->options['directory'];
271		}
272
273		$keys = [];
274		$iter = $this->service->getIterator('ListObjects', $options);
275		foreach ($iter as $file) {
276		$keys[] = $this->computeKey($file['Key']);
277		}
278
279		return $keys;
280		}
281
282		/**
283		* {@inheritdoc}
284		*/
285		public function delete($key)
286		{
287		try {
288		$this->service->deleteObject($this->getOptions($key));
289
290		return true;
291		} catch (\Exception $e) {
292		return false;
293		}
294		}
295
296		/**
297		* {@inheritdoc}
298		*/
299		public function isDirectory($key)
300		{
301		$result = $this->service->listObjects([
302		'Bucket' => $this->bucket,
303		'Prefix' => rtrim($this->computePath($key), '/').'/',
304		'MaxKeys' => 1,
305		]);
306
307		return count($result['Contents']) > 0;
308		}
309
310		/**
311		* Ensures the specified bucket exists. If the bucket does not exists
312		* and the create option is set to true, it will try to create the
313		* bucket. The bucket is created using the same region as the supplied
314		* client object.
315		*
316		* @throws \RuntimeException if the bucket does not exists or could not be
317		* created
318		*/
319		protected function ensureBucketExists()
320		{
321		if ($this->bucketExists) {
322		return true;
323		}
324
325		if ($this->bucketExists = $this->service->doesBucketExist($this->bucket)) {
326		return true;
327		}
328
329		if (!$this->options['create']) {
330		throw new \RuntimeException(sprintf(
331		'The configured bucket "%s" does not exist.',
332		$this->bucket
333		));
334		}
335
336		$this->service->createBucket([
337		'Bucket' => $this->bucket,
338		'LocationConstraint' => $this->service->getRegion()
339		]);
340		$this->bucketExists = true;
341
342		return true;
343		}
344
345		protected function getOptions($key, array $options = [])
346		{
347		$options['ACL'] = $this->options['acl'];
348		$options['Bucket'] = $this->bucket;
349		$options['Key'] = $this->computePath($key);
350
351		/*
352		* Merge global options for adapter, which are set in the constructor, with metadata.
353		* Metadata will override global options.
354		*/
355		$options = array_merge($this->options, $options, $this->getMetadata($key));
356
357		return $options;
358		}
359
360	View Code Duplication	protected function computePath($key)
		0 ignored issues – show Duplication introduced 2016-03-05 14:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
361		{
362		if (empty($this->options['directory'])) {
363		return $key;
364		}
365
366		return sprintf('%s/%s', $this->options['directory'], $key);
367		}
368
369
370		/**
371		* MultiPart upload for big files (exceeding size_limit)
372		*
373		* @param $key
374		* @param $content
375		*
376		* @return bool
377		*/
378		protected function multipartUpload($key, $content)
379		{
380		$uploadId = $this->initiateMultipartUpload($key);
381
382		$parts = [];
383		$partNumber = 1;
384
385		rewind($content);
386
387		try {
388		while (!feof($content)) {
389		$result = $this->uploadNextPart($key, $content, $uploadId, $partNumber);
390		$parts[] = [
391		'PartNumber' => $partNumber++,
392		'ETag' => $result['ETag'],
393		];
394		}
395		} catch (S3Exception $e) {
396		$this->abortMultipartUpload($key, $uploadId);
397
398		return false;
399		}
400
401		$this->completeMultipartUpload($key, $uploadId, $parts);
402
403		return true;
404		}
405
406		/**
407		* @param $key
408		*
409		* @return mixed
410		*/
411		protected function initiateMultipartUpload($key)
412		{
413		$options = $this->getOptions($key);
414		$result = $this->service->createMultipartUpload($options);
415
416		return $result['UploadId'];
417		}
418
419		/**
420		* @param $key
421		* @param $content
422		* @param $uploadId
423		* @param $partNumber
424		*
425		* @return \Aws\Result
426		*/
427		protected function uploadNextPart($key, $content, $uploadId, $partNumber)
428		{
429		$options = $this->getOptions(
430		$key,
431		[
432		'UploadId' => $uploadId,
433		'PartNumber' => $partNumber,
434		'Body' => fread($content, $this->partSize),
435		]
436		);
437
438		$options = $this->getOptions($key, $options);
439
440		return $this->service->uploadPart($options);
441		}
442
443		/**
444		* @param $key
445		* @param $uploadId
446		* @param $parts
447		*/
448		protected function completeMultipartUpload($key, $uploadId, $parts)
449		{
450		$options = $this->getOptions(
451		$key,
452		[
453		'UploadId' => $uploadId,
454		'MultipartUpload' => ['Parts' => $parts],
455		]
456		);
457		$this->service->completeMultipartUpload($options);
458		}
459
460		protected function abortMultipartUpload($key, $uploadId)
461		{
462		$options = $this->getOptions($key, ['UploadId' => $uploadId]);
463		$this->service->abortMultipartUpload($options);
464		}
465
466		/**
467		* Computes the key from the specified path.
468		*
469		* @param string $path
470		*
471		* @return string
472		*/
473		protected function computeKey($path)
474		{
475		return ltrim(substr($path, strlen($this->options['directory'])), '/');
476		}
477
478		/**
479		* @param string $content
480		*
481		* @return string
482		*/
483	View Code Duplication	private function guessContentType($content)
		0 ignored issues – show Duplication introduced 2016-05-25 21:24 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
484		{
485		$fileInfo = new \finfo(FILEINFO_MIME_TYPE);
486
487		if (is_resource($content)) {
488		return $fileInfo->file(stream_get_meta_data($content)['uri']);
489		}
490
491		return $fileInfo->buffer($content);
492		}
493
494	View Code Duplication	public function mimeType($key)
		0 ignored issues – show Duplication introduced 2017-05-21 20:39 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
495		{
496		try {
497		$result = $this->service->headObject($this->getOptions($key));
498		return ($result['ContentType']);
499		} catch (\Exception $e) {
500		return false;
		0 ignored issues – show Bug Best Practice introduced 2017-05-21 20:39 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type declared by the interface `Gaufrette\Adapter\MimeTypeProvider::mimeType` of type `string`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
501		}
502		}
503		}
504

KnpLabs / Gaufrette