Sausin\LaravelOvh\OVHSwiftAdapter

Complexity

Total Complexity

13

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getEndpoint()	0	19	3
A	getUrl()	0	4	1
A	getUrlConfirm()	0	11	2
A	getTemporaryUrl()	0	35	2
A	getContainer()	0	4	1
A	getWriteData()	0	12	3

<?php

namespace Sausin\LaravelOvh;

use Carbon\Carbon;
use League\Flysystem\Config;
use Nimbusoft\Flysystem\OpenStack\SwiftAdapter;
use OpenStack\Common\Error\BadResponseError;
use OpenStack\ObjectStore\v1\Models\Container;

class OVHSwiftAdapter extends SwiftAdapter
{
    /** Variables from the Filesystem class will be temporarily stored here */
    protected $specialParams;

    /** @var OVHConfiguration */
    protected $config;

    /**
     * OVHSwiftAdapter constructor.
     *
     * @param Container $container
     * @param OVHConfiguration $config
     * @param string|null $prefix
     */
    public function __construct(Container $container, OVHConfiguration $config, ?string $prefix = null)
    {
        parent::__construct($container, $prefix);

        $this->config = $config;
    }

    /**
     * Gets the endpoint url of the bucket.
     *
     * @param string|null $path
     * @return string
     */
    protected function getEndpoint(?string $path = null): string
    {
        $url = ! empty($this->config->getEndpoint())
            // Allows assigning custom endpoint url
            ? rtrim($this->config->getEndpoint(), '/').'/'
            // If no custom endpoint assigned, use traditional swift v1 endpoint
            : sprintf(
                'https://storage.%s.cloud.ovh.net/v1/AUTH_%s/%s/',
                $this->config->getRegion(),
                $this->config->getProjectId(),
                $this->config->getContainer()
            );

        if (! empty($path)) {
            $url .= ltrim($path, '/');
        }

        return $url;
    }

    /**
     * Custom function to comply with the Storage::url() function in laravel
     * without checking the existence of a file (faster).
     *
     * @param string $path
     * @return string
     */
    public function getUrl($path)
    {
        return $this->getEndpoint($path);
    }

    /**
     * Custom function to get an url with confirmed file existence.
     *
     * @param string $path
     * @return string
     * @throws BadResponseError
     */
    public function getUrlConfirm($path): string
    {
        // check if object exists
        try {
            $this->has($path);
        } catch (BadResponseError $e) {
            throw $e;
        }

        return $this->getEndpoint($path);
    }

    /**
     * Generate a temporary URL for private containers.
     *
     * @param string $path
     * @param Carbon|null $expiresAt
     * @param array $options
     * @return string
     */
    public function getTemporaryUrl(string $path, ?Carbon $expiresAt = null, array $options = []): string
    {
        // Ensure $path doesn't begin with a slash
        $path = ltrim($path, '/');

        // Expiry is relative to current time
        if (empty($expiresAt)) {
            $expiresAt = Carbon::now()->addHour();
        }

        // Get the method
        $method = $options['method'] ?? 'GET';

        // The url on the OVH host
        $codePath = sprintf(
            '/v1/AUTH_%s/%s/%s',
            $this->config->getProjectId(),
            $this->config->getContainer(),
            $path
        );

        // Body for the HMAC hash
        $body = sprintf("%s\n%s\n%s", $method, $expiresAt->timestamp, $codePath);

        // The actual hash signature
        $signature = hash_hmac('sha1', $body, $this->config->getTempUrlKey());

        // Return signed url
        return sprintf(
            '%s?temp_url_sig=%s&temp_url_expires=%s',
            $this->getEndpoint($path),
            $signature,
            $expiresAt
        );
    }

    /**
     * Expose the container to allow for modification to metadata.
     *
     * @return Container
     */
    public function getContainer(): Container
    {
        return $this->container;
    }

    /**
     * Include support for object deletion.
     *
     * @param string $path
     * @param Config $config
     * @return array
     * @see SwiftAdapter
     */
    protected function getWriteData($path, $config): array
    {
        $data = ['name' => $path];

        if ($config->has('deleteAfter')) {
            return $data += ['deleteAfter' => $config->get('deleteAfter')];
        } elseif ($config->has('deleteAt')) {
            return $data += ['deleteAt' => $config->get('deleteAt')];
        }

        return $data;
    }
}