limenet\S3BucketStreamZip\S3BucketStreamZip

Complexity

Total Complexity

22

Size/Duplication

Total Lines	166
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

31.43%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	22	3
A	bucket()	0	6	1
A	prefix()	0	6	1
A	addParams()	0	8	2
B	send()	0	32	4
A	parts()	0	23	3
A	validateAuth()	0	12	3
B	doesDirectoryExist()	0	17	5

<?php

namespace limenet\S3BucketStreamZip;

use Aws\S3\Exception\S3Exception;
use Aws\S3\S3Client;
use limenet\S3BucketStreamZip\Exception\InvalidParameterException;
use ZipStream\ZipStream;

class S3BucketStreamZip
{
    public const MAX_ARCHIVE_SIZE = 2147483648; // 2^30 * 2 = 2 GB

36% of this comment could be valid code. Did you maybe forget this after debugging?

    protected $auth = [];

    protected $s3Client;

    protected $params;

    protected $part;

    /**
     * Create a new ZipStream object.
     *
     * @param array $auth - AWS key and secret
     *
     * @throws InvalidParameterException
     */
    public function __construct($auth, $part = 0)
    {
        $this->validateAuth($auth);

        $this->auth = $auth;
        $this->part = $part;

        // S3 User in $this->auth should have permission to execute ListBucket on any buckets
        // AND GetObject on any object with which you need to interact.
        $this->s3Client = new S3Client([
            'version'     => (isset($this->auth['version'])) ? $this->auth['version'] : 'latest',
            'region'      => (isset($this->auth['region'])) ? $this->auth['region'] : 'us-east-1',
            'credentials' => [
                'key'    => $this->auth['key'],
                'secret' => $this->auth['secret'],
            ],
        ]);

        // Register the stream wrapper from an S3Client object
        // This allows you to access buckets and objects stored in Amazon S3 using the s3:// protocol
        $this->s3Client->registerStreamWrapper();
    }

    public function bucket($bucket)
    {
        $this->params = new S3Params($bucket);

        return $this;
    }

    public function prefix($prefix)
    {
        $this->params->setParam('Prefix', rtrim($prefix, '/').'/');

        return $this;
    }

    public function addParams(array $params)
    {
        foreach ($params as $key => $value) {
            $this->params->setParam($key, $value);
        }

        return $this;
    }

    /**
     * Stream a zip file to the client.
     *
     * @param string $filename - Name for the file to be sent to the client
     *                         $filename will be what is sent in the content-disposition header
     *
     * @throws InvalidParameterException
     *
     * @internal param array - See the documentation for the List Objects API for valid parameters.
     * Only `Bucket` is required.
     *
     * http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGET.html
     */
    public function send($filename)
    {
        $params = $this->params->getParams();

        $this->doesDirectoryExist($params);

        $zip = new ZipStream($filename);
        // The iterator fetches ALL of the objects without having to manually loop over responses.
        $files = $this->s3Client->getIterator('ListObjects', $params);

$files is not used, you could remove the assignment.

        $parts = $this->parts();

        // Add each object from the ListObjects call to the new zip file.
        foreach ($parts[$this->part] as $file) {
            var_dump($file['Size']);

var_dump($file['Size']); looks like debug code. Are you sure you do not want to remove it? This might expose sensitive data.

            // Get the file name on S3 so we can save it to the zip file using the same name.
            $fileName = basename($file['Key']);

            if (is_file("s3://{$params['Bucket']}/{$file['Key']}")) {
                $context = stream_context_create([
                    's3' => ['seekable' => true],
                ]);
                // open seekable(!) stream
                if ($stream = fopen("s3://{$params['Bucket']}/{$file['Key']}", 'r', false, $context)) {
                    $zip->addFileFromStream($fileName, $stream);
                }
            }
        }

        // Finalize the zip file.
        $zip->finish();
    }

    public function parts()
    {
        $params = $this->params->getParams();

        $this->doesDirectoryExist($params);

        $files = $this->s3Client->getIterator('ListObjects', $params);

        $parts = [0 => []];
        $partSizes = [0 => 0];
        $currentPart = 0;
        foreach ($files as $file) {
            if ($partSizes[$currentPart] + $file['Size'] > self::MAX_ARCHIVE_SIZE) {
                $currentPart++;
                $parts[$currentPart] = [];
                $partSizes[$currentPart] = 0;
            }
            $parts[$currentPart][] = $file;
            $partSizes[$currentPart] += $file['Size'];
        }

        return $parts;
    }

    protected function validateAuth($auth)
    {
        // We require the AWS key to be passed in $auth.
        if (!isset($auth['key'])) {
            throw new InvalidParameterException('$auth parameter to constructor requires a `key` attribute');
        }

        // We require the AWS secret to be passed in $auth.
        if (!isset($auth['secret'])) {
            throw new InvalidParameterException('$auth parameter to constructor requires a `secret` attribute');
        }
    }

    protected function doesDirectoryExist($params)
    {
        $command = $this->s3Client->getCommand('listObjects', $params);

        try {
            $result = $this->s3Client->execute($command);

            if (empty($result['Contents']) && empty($result['CommonPrefixes'])) {
                throw new InvalidParameterException('Bucket or Prefix does not exist');
            }
        } catch (S3Exception $e) {
            if ($e->getStatusCode() === 403) {
                return false;
            }
            throw $e;
        }
    }
}