Sausin\LaravelOvh\Commands\SetTempUrlKey

Complexity

Total Complexity

9

Size/Duplication

Total Lines	107
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	handle()	0	6	3
A	askIfShouldOverrideExistingKey()	0	11	2
A	getRandomKey()	0	4	1
A	setContainerKey()	0	12	2

<?php

namespace Sausin\LaravelOvh\Commands;

use Exception;
use Illuminate\Console\Command;
use Illuminate\Support\Facades\Storage;
use OpenStack\ObjectStore\v1\Models\Container;

class SetTempUrlKey extends Command
{
    /**
     * The name and signature of the console command.
     *
     * @var string
     */
    protected $signature = 'ovh:set-temp-url-key
                            {--key= : The key you want to set up on your container}
                            {--force : Forcibly set a new key on the container}';

    /**
     * The console command description.
     *
     * @var string
     */
    protected $description = 'Set temp url key on the private container, making the use of Storage::temporaryUrl() possible';

    /**
     * The Object Storage Container.
     *
     * @var Container
     */
    protected $container;

    /**
     * Create a new command instance.
     *
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct()
    {
        parent::__construct();

        $this->container = Storage::disk('ovh')->getAdapter()->getContainer();

The method getAdapter() does not seem to exist on object<Illuminate\Contracts\Filesystem\Filesystem>.

    }

    /**
     * Execute the console command.
     *
     * If the '--force' flag is provided, a new Temp URL Key will be generated and
     * forcefully set in the Container's metadata, overriding any existing keys.
     *
     * If the command is not forced and there's an existing key, the User will be
     * prompted to override the existing keys.
     *
     * @return void
     */
    public function handle(): void
    {
        if ($this->hasOption('force') || $this->askIfShouldOverrideExistingKey()) {
            $this->setContainerKey();
        }
    }

    /**
     * If there's no existing Temp URL Key present in the Container, continue.
     *
     * Otherwise, if there's already an existing Temp URL Key present in the
     * Container, the User will be prompted to choose if we should override it
     * or not.
     *
     * @return bool
     */
    protected function askIfShouldOverrideExistingKey(): bool
    {
        if (!array_key_exists('Temp-Url-Key', $this->container->getMetadata())) {
            return true; // Yeah, override the non-existing key.
        }

        return $this->confirm(
            'A Temp URL Key already exists in your container, would you like to override it?',
            false
        );
    }

    /**
     * Generates a random Temp URL Key.
     *
     * For more details, please refer to:
     *  - https://docs.ovh.com/gb/en/public-cloud/share_an_object_via_a_temporary_url/#generate-the-temporary-address-tempurl
     *
     * @return string
     */
    protected function getRandomKey(): string
    {
        return hash('sha512', time());
    }

    /**
     * Updates the Temp URL Key for the Container.
     *
     * @return void
     */
    protected function setContainerKey(): void
    {
        $key = $this->option('key') ?? $this->getRandomKey();

        try {
            $this->container->resetMetadata(['Temp-Url-Key' => $key]);
        } catch (Exception $e) {
            $this->error($e->getMessage());
        }

        $this->info('Successfully set Temp URL Key to: '.$key);
    }
}