Matecat\SimpleS3\Commands\Handlers\CopyInBatch

Complexity

Total Complexity

15

Size/Duplication

Total Lines	128
Duplicated Lines	0 %

Test Coverage

Coverage

81.67%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
C	handle()	0	87	13
A	validateParams()	0	5	2

<?php
/**
 *  This file is part of the Simple S3 package.
 *
 * (c) Mauro Cassani<https://github.com/mauretto78>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 */

namespace Matecat\SimpleS3\Commands\Handlers;

use Aws\CommandInterface;
use Aws\CommandPool;
use Aws\Exception\AwsException;
use Aws\ResultInterface;
use Exception;
use InvalidArgumentException;

class CopyInBatch extends CopyItem
{
    /**
     * Copy in batch items from a bucket to another one.
     * For a complete reference:
     * https://docs.aws.amazon.com/cli/latest/reference/s3api/copy-object.html?highlight=copy
     *
     * @param array $params
     *
     * Example:
     * $input = [
     *      'source_bucket' => 'ORIGINAL-BUCKET',
     *      'target_bucket' => 'TARGET-BUCKET', (OPTIONAL)
     *      'files' => [
     *          'source' => [
     *              'keyname-1',
     *              'keyname-2',
     *          ],
     *          'target' => [ (OPTIONAL)
     *              'keyname-3',
     *              'keyname-4',
     *          ],
     *      ],
     * ];
     *
     * @return bool
     * @throws Exception
     */
    public function handle(array $params = []): bool
    {
        if (isset($params[ 'target_bucket' ])) {
            $this->client->createBucketIfItDoesNotExist(['bucket' => $params[ 'target_bucket' ]]);
        }

        if (empty($params[ 'files' ][ 'source' ])) {
            throw new InvalidArgumentException('source files array cannot be empty.');
        }

        $commands     = [];
        $errors       = [];
        $targetKeys   = [];
        $targetBucket = (isset($params[ 'target_bucket' ])) ? $params[ 'target_bucket' ] : $params[ 'source_bucket' ];

        foreach ($params[ 'files' ][ 'source' ] as $key => $file) {
            $targetKey    = (isset($params[ 'files' ][ 'target' ][ $key ])) ? $params[ 'files' ][ 'target' ][ $key ] : $file;
            $sourceBucket = $params[ 'source_bucket' ];

            if ($this->client->hasEncoder()) {
                $targetKey = $this->client->getEncoder()->encode($targetKey);
                $file      = $this->client->getEncoder()->encode($file);
            }

            $copySource   = $this->getCopySource($sourceBucket, $file);
            $targetKeys[] = $targetKey;

            $config = [
                    'Bucket'     => $targetBucket,
                    'Key'        => $targetKey,
                    'CopySource' => $copySource,
            ];

            if ($this->client->isBucketVersioned(['bucket' => $sourceBucket])) {
                $version                = $this->client->getCurrentItemVersion(['bucket' => $sourceBucket, 'key' => $params[ 'source' ]]);
                $config[ 'CopySource' ] = $copySource . '?versionId=' . $version;
            }

            $commands[] = $this->client->getConn()->getCommand('CopyObject', $config);
        }

        try {
            // Create a pool and provide an optional array of configuration
            $pool = new CommandPool($this->client->getConn(), $commands, [
                    'concurrency' => (isset($params[ 'concurrency' ])) ? $params[ 'concurrency' ] : 25,
                    'before'      => function (CommandInterface $cmd, $iterKey) {
                        $this->commandHandlerLogger?->log($this, sprintf('About to send \'%s\'', $iterKey));
                    },
                // Invoke this function for each successful transfer
                    'fulfilled'   => function (
                            ResultInterface $result,
                            $iterKey
                    ) use ($targetBucket, $targetKeys) {
                        $this->commandHandlerLogger?->log($this, sprintf('Completed copy of \'%s\'', $targetKeys[ $iterKey ]));

                        if ($this->client->hasCache()) {
                            $this->client->getCache()->set($targetBucket, $targetKeys[ $iterKey ], '');
                        }
                    },
                // Invoke this function for each failed transfer
                    'rejected'    => function (
                            AwsException $reason
                    ) use (&$errors) {
                        $errors[] = $reason;

                        $this->commandHandlerLogger?->logExceptionAndReturnFalse($reason);

                        throw $reason;
                    },
            ]);

            // Initiate the pool transfers and waits it ends
            $pool->promise()->wait();

            if (count($errors) === 0) {
                $this->commandHandlerLogger?->log($this, sprintf('Copy in batch from \'%s\' to \'%s\' was succeded without errors', $params[ 'source_bucket' ], $targetBucket));

                return true;
            }

            $this->commandHandlerLogger?->log($this, sprintf('Something went wrong during copying in batch from \'%s\' to \'%s\'', $params[ 'source_bucket' ], (isset($params[ 'target_bucket' ])) ? $params[ 'target_bucket' ] : $params[ 'source_bucket' ]), 'warning');

            return false;
        } catch (Exception $e) {
            $this->commandHandlerLogger?->logExceptionAndReturnFalse($e);

            throw $e;
        }
    }

    /**
     * @param array $params
     *
     * @return bool
     */
    public function validateParams(array $params = []): bool
    {
        return (
                isset($params[ 'source_bucket' ]) and
                isset($params[ 'files' ][ 'source' ])
        );
    }
}