matecat / simple-s3

src/Commands/Handlers/UploadItemFromBody.php

<?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\ResultInterface;
use Exception;
use InvalidArgumentException;
use Matecat\SimpleS3\Commands\CommandHandler;
use Matecat\SimpleS3\Components\Validators\S3ObjectSafeNameValidator;
use Matecat\SimpleS3\Components\Validators\S3StorageClassNameValidator;
use Matecat\SimpleS3\Exceptions\InvalidS3NameException;
use Matecat\SimpleS3\Helpers\File;
use Matecat\SimpleS3\Helpers\FilenameValidator;

The type Matecat\SimpleS3\Helpers\FilenameValidator was not found. Maybe you did not declare it correctly or list all dependencies?

class UploadItemFromBody extends CommandHandler
{
    /**
     * Upload a content to S3.
     * For a complete reference of put object see:
     * https://docs.aws.amazon.com/cli/latest/reference/s3api/put-object.html?highlight=put
     *
     * @param array $params
     *
     * @return bool
     * @throws Exception
     */
    public function handle(array $params = []): bool
    {
        $bucketName = $params[ 'bucket' ];
        $keyName    = $params[ 'key' ];
        $body       = $params[ 'body' ];

        if (isset($params[ 'bucket_check' ]) and true === $params[ 'bucket_check' ]) {
            $this->client->createBucketIfItDoesNotExist(['bucket' => $bucketName]);
        }

        if (false === S3ObjectSafeNameValidator::isValid($keyName)) {
            throw new InvalidS3NameException(sprintf('%s is not a valid S3 object name. [' . implode(', ', S3ObjectSafeNameValidator::validate($keyName)) . ']', $keyName));
        }

        if ((isset($params[ 'storage' ]) and false === S3StorageClassNameValidator::isValid($params[ 'storage' ]))) {
            throw new InvalidArgumentException(S3StorageClassNameValidator::validate($params[ 'storage' ])[ 0 ]);
        }

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

        return $this->upload($bucketName, $keyName, $body, (isset($params[ 'storage' ])) ? $params[ 'storage' ] : null, (isset($params[ 'meta' ])) ? $params[ 'meta' ] : null);
    }

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

    /**
     * @param string      $bucketName
     * @param string      $keyName
     * @param resource    $body
     * @param string|null $storage
     * @param array|null  $meta
     *
     * @return bool
     */
    private function upload(string $bucketName, string $keyName, $body, ?string $storage = null, ?array $meta = null): bool
    {
        try {
            $config = [
                    'Bucket'            => $bucketName,
                    'Key'               => $keyName,
                    'Body'              => $body,
                    'MetadataDirective' => 'REPLACE',
            ];

            if (null != $storage) {

It seems like you are loosely comparing $storage of type null|string against null; this is ambiguous if the string can be empty. Consider using a strict comparison !== instead.

                $config[ 'StorageClass' ] = $storage;
            }

            if (null != $meta) {
                $config[ 'Metadata' ] = $meta;
            }

            $config[ 'Metadata' ][ 'original_name' ] = File::getBaseName($keyName);

            $result = $this->client->getConn()->putObject($config);

            if (($result instanceof ResultInterface) and $result[ '@metadata' ][ 'statusCode' ] === 200) {
                $this->commandHandlerLogger?->log($this, sprintf('File \'%s\' was successfully uploaded in \'%s\' bucket', $keyName, $bucketName));

                if (null == $storage and $this->client->hasCache()) {

It seems like you are loosely comparing $storage of type null|string against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

                    $version = null;
                    if (isset($result[ '@metadata' ][ 'headers' ][ 'x-amz-version-id' ])) {
                        $version = $result[ '@metadata' ][ 'headers' ][ 'x-amz-version-id' ];
                    }

                    $this->client->getCache()->set($bucketName, $keyName, '', $version);
                }

                return true;
            }

            $this->commandHandlerLogger?->log($this, sprintf('Something went wrong during upload of file \'%s\' in \'%s\' bucket', $keyName, $bucketName), 'warning');

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

            throw $e;
        }
    }
}