Add S3 and Wasabi as storage providers (#281)

app/Enums/StorageProvider.php

@@ -9,4 +9,8 @@ final class StorageProvider
     const FTP = 'ftp';
 
     const LOCAL = 'local';
+
+    const S3 = 's3';
+
+    const WASABI = 'wasabi';
 }

app/SSH/HasS3Storage.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace App\SSH;
+
+trait HasS3Storage
+{
+    private function prepareS3Path(string $path, string $prefix = ''): string
+    {
+        $path = trim($path);
+        $path = ltrim($path, '/');
+        $path = preg_replace('/[^a-zA-Z0-9\-_\.\/]/', '_', $path);
+        $path = preg_replace('/\/+/', '/', $path);
+
+        if ($prefix) {
+            $path = trim($prefix, '/').'/'.$path;
+        }
+
+        return $path;
+    }
+}

app/SSH/Storage/S3.php

@@ -0,0 +1,78 @@
+<?php
+
+namespace App\SSH\Storage;
+
+use App\Exceptions\SSHCommandError;
+use App\Models\Server;
+use App\Models\StorageProvider;
+use App\SSH\HasS3Storage;
+use App\SSH\HasScripts;
+use Illuminate\Support\Facades\Log;
+
+class S3 extends S3AbstractStorage
+{
+    use HasS3Storage, HasScripts;
+
+    public function __construct(Server $server, StorageProvider $storageProvider)
+    {
+        parent::__construct($server, $storageProvider);
+        $this->setBucketRegion($this->storageProvider->credentials['region']);
+        $this->setApiUrl();
+    }
+
+    /**
+     * @throws SSHCommandError
+     */
+    public function upload(string $src, string $dest): array
+    {
+        $uploadCommand = $this->getScript('s3/upload.sh', [
+            'src' => $src,
+            'bucket' => $this->storageProvider->credentials['bucket'],
+            'dest' => $this->prepareS3Path($this->storageProvider->credentials['path'].'/'.$dest),
+            'key' => $this->storageProvider->credentials['key'],
+            'secret' => $this->storageProvider->credentials['secret'],
+            'region' => $this->getBucketRegion(),
+            'endpoint' => $this->getApiUrl(),
+        ]);
+
+        $upload = $this->server->ssh()->exec($uploadCommand, 'upload-to-s3');
+
+        if (str_contains($upload, 'Error') || ! str_contains($upload, 'upload:')) {
+            Log::error('Failed to upload to S3', ['output' => $upload]);
+            throw new SSHCommandError('Failed to upload to S3: '.$upload);
+        }
+
+        return [
+            'size' => null, // You can parse the size from the output if needed
+        ];
+
+    }
+
+    /**
+     * @throws SSHCommandError
+     */
+    public function download(string $src, string $dest): void
+    {
+        $downloadCommand = $this->getScript('s3/download.sh', [
+            'src' => $this->prepareS3Path($this->storageProvider->credentials['path'].'/'.$src),
+            'dest' => $dest,
+            'bucket' => $this->storageProvider->credentials['bucket'],
+            'key' => $this->storageProvider->credentials['key'],
+            'secret' => $this->storageProvider->credentials['secret'],
+            'region' => $this->getBucketRegion(),
+            'endpoint' => $this->getApiUrl(),
+        ]);
+
+        $download = $this->server->ssh()->exec($downloadCommand, 'download-from-s3');
+
+        if (! str_contains($download, 'Download successful')) {
+            Log::error('Failed to download from S3', ['output' => $download]);
+            throw new SSHCommandError('Failed to download from S3: '.$download);
+        }
+    }
+
+    /**
+     * @TODO Implement delete method
+     */
+    public function delete(string $path): void {}
+}

app/SSH/Storage/S3AbstractStorage.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace App\SSH\Storage;
+
+abstract class S3AbstractStorage extends AbstractStorage
+{
+    protected ?string $apiUrl = null;
+
+    protected ?string $bucketRegion = null;
+
+    public function getApiUrl(): string
+    {
+        return $this->apiUrl;
+    }
+
+    public function setApiUrl(?string $region = null): void
+    {
+        $this->bucketRegion = $region ?? $this->bucketRegion;
+        $this->apiUrl = "https://s3.{$this->bucketRegion}.amazonaws.com";
+    }
+
+    // Getter and Setter for $bucketRegion
+    public function getBucketRegion(): string
+    {
+        return $this->bucketRegion;
+    }
+
+    public function setBucketRegion(string $region): void
+    {
+        $this->bucketRegion = $region;
+    }
+}

app/SSH/Storage/Wasabi.php

@@ -0,0 +1,84 @@
+<?php
+
+namespace App\SSH\Storage;
+
+use App\Exceptions\SSHCommandError;
+use App\Models\Server;
+use App\Models\StorageProvider;
+use App\SSH\HasS3Storage;
+use App\SSH\HasScripts;
+use Illuminate\Support\Facades\Log;
+
+class Wasabi extends S3AbstractStorage
+{
+    use HasS3Storage, HasScripts;
+
+    public function __construct(Server $server, StorageProvider $storageProvider)
+    {
+        parent::__construct($server, $storageProvider);
+        $this->setBucketRegion($this->storageProvider->credentials['region']);
+        $this->setApiUrl();
+    }
+
+    /**
+     * @throws SSHCommandError
+     */
+    public function upload(string $src, string $dest): array
+    {
+        $uploadCommand = $this->getScript('wasabi/upload.sh', [
+            'src' => $src,
+            'bucket' => $this->storageProvider->credentials['bucket'],
+            'dest' => $this->prepareS3Path($this->storageProvider->credentials['path'].'/'.$dest),
+            'key' => $this->storageProvider->credentials['key'],
+            'secret' => $this->storageProvider->credentials['secret'],
+            'region' => $this->storageProvider->credentials['region'],
+            'endpoint' => $this->getApiUrl(),
+        ]);
+
+        $upload = $this->server->ssh()->exec($uploadCommand, 'upload-to-wasabi');
+
+        if (str_contains($upload, 'Error') || ! str_contains($upload, 'upload:')) {
+            Log::error('Failed to upload to wasabi', ['output' => $upload]);
+            throw new SSHCommandError('Failed to upload to wasabi: '.$upload);
+        }
+
+        return [
+            'size' => null, // You can parse the size from the output if needed
+        ];
+
+    }
+
+    /**
+     * @throws SSHCommandError
+     */
+    public function download(string $src, string $dest): void
+    {
+        $downloadCommand = $this->getScript('wasabi/download.sh', [
+            'src' => $this->prepareS3Path($this->storageProvider->credentials['path'].'/'.$src),
+            'dest' => $dest,
+            'bucket' => $this->storageProvider->credentials['bucket'],
+            'key' => $this->storageProvider->credentials['key'],
+            'secret' => $this->storageProvider->credentials['secret'],
+            'region' => $this->storageProvider->credentials['region'],
+            'endpoint' => $this->getApiUrl(),
+        ]);
+
+        $download = $this->server->ssh()->exec($downloadCommand, 'download-from-wasabi');
+
+        if (! str_contains($download, 'Download successful')) {
+            Log::error('Failed to download from wasabi', ['output' => $download]);
+            throw new SSHCommandError('Failed to download from wasabi: '.$download);
+        }
+    }
+
+    /**
+     * @TODO Implement delete method
+     */
+    public function delete(string $path): void {}
+
+    public function setApiUrl(?string $region = null): void
+    {
+        $this->bucketRegion = $region ?? $this->bucketRegion;
+        $this->apiUrl = "https://{$this->storageProvider->credentials['bucket']}.s3.{$this->getBucketRegion()}.wasabisys.com";
+    }
+}

app/SSH/Storage/scripts/s3/download.sh

@@ -0,0 +1,32 @@
+#!/bin/bash
+
+# Configure AWS CLI with provided credentials
+/usr/local/bin/aws configure set aws_access_key_id "__key__"
+/usr/local/bin/aws configure set aws_secret_access_key "__secret__"
+/usr/local/bin/aws configure set default.region "__region__"
+
+# Use the provided endpoint in the correct format
+ENDPOINT="__endpoint__"
+BUCKET="__bucket__"
+REGION="__region__"
+
+# Ensure that DEST does not have a trailing slash
+SRC="__src__"
+DEST="__dest__"
+
+# Download the file from S3
+echo "Downloading s3://__bucket__/__src__ to __dest__"
+download_output=$(/usr/local/bin/aws s3 cp "s3://$BUCKET/$SRC" "$DEST" --endpoint-url="$ENDPOINT" --region "$REGION" 2>&1)
+download_exit_code=$?
+
+# Log output and exit code
+echo "Download command output: $download_output"
+echo "Download command exit code: $download_exit_code"
+
+# Check if the download was successful
+if [ $download_exit_code -eq 0 ]; then
+    echo "Download successful"
+else
+    echo "Download failed"
+    exit 1
+fi

app/SSH/Storage/scripts/s3/upload.sh

@@ -0,0 +1,59 @@
+#!/bin/bash
+
+# Check if AWS CLI is installed
+if ! command -v aws &> /dev/null
+then
+    echo "AWS CLI is not installed. Installing..."
+
+    # Detect system architecture
+    ARCH=$(uname -m)
+    if [ "$ARCH" == "x86_64" ]; then
+        CLI_URL="https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip"
+    elif [ "$ARCH" == "aarch64" ]; then
+        CLI_URL="https://awscli.amazonaws.com/awscli-exe-linux-aarch64.zip"
+    else
+        echo "Unsupported architecture: $ARCH"
+        exit 1
+    fi
+
+    # Download and install AWS CLI
+    sudo curl "$CLI_URL" -o "awscliv2.zip"
+    sudo unzip awscliv2.zip
+    sudo ./aws/install --update
+    sudo rm -rf awscliv2.zip aws
+
+    echo "AWS CLI installation completed."
+else
+    echo "AWS CLI is already installed."
+    /usr/local/bin/aws --version
+fi
+
+# Configure AWS CLI with provided credentials
+/usr/local/bin/aws configure set aws_access_key_id "__key__"
+/usr/local/bin/aws configure set aws_secret_access_key "__secret__"
+
+# Use the provided endpoint in the correct format
+ENDPOINT="__endpoint__"
+BUCKET="__bucket__"
+REGION="__region__"
+
+# Ensure that DEST does not have a trailing slash
+SRC="__src__"
+DEST="__dest__"
+
+# Upload the file
+echo "Uploading __src__ to s3://$BUCKET/$DEST"
+upload_output=$(/usr/local/bin/aws s3 cp "$SRC" "s3://$BUCKET/$DEST" --endpoint-url="$ENDPOINT" --region "$REGION" 2>&1)
+upload_exit_code=$?
+
+# Log output and exit code
+echo "Upload command output: $upload_output"
+echo "Upload command exit code: $upload_exit_code"
+
+# Check if the upload was successful
+if [ $upload_exit_code -eq 0 ]; then
+    echo "Upload successful"
+else
+    echo "Upload failed"
+    exit 1
+fi

app/SSH/Storage/scripts/wasabi/download.sh

@@ -0,0 +1,31 @@
+#!/bin/bash
+
+# Configure AWS CLI with provided credentials
+/usr/local/bin/aws configure set aws_access_key_id "__key__"
+/usr/local/bin/aws configure set aws_secret_access_key "__secret__"
+
+# Use the provided endpoint in the correct format
+ENDPOINT="__endpoint__"
+BUCKET="__bucket__"
+REGION="__region__"
+
+# Ensure that DEST does not have a trailing slash
+SRC="__src__"
+DEST="__dest__"
+
+# Download the file from S3
+echo "Downloading s3://__bucket____src__ to __dest__"
+download_output=$(/usr/local/bin/aws s3 cp "s3://$BUCKET/$SRC" "$DEST" --endpoint-url="$ENDPOINT" --region "$REGION" 2>&1)
+download_exit_code=$?
+
+# Log output and exit code
+echo "Download command output: $download_output"
+echo "Download command exit code: $download_exit_code"
+
+# Check if the download was successful
+if [ $download_exit_code -eq 0 ]; then
+    echo "Download successful"
+else
+    echo "Download failed"
+    exit 1
+fi

app/SSH/Storage/scripts/wasabi/upload.sh

@@ -0,0 +1,59 @@
+#!/bin/bash
+
+# Check if AWS CLI is installed
+if ! command -v aws &> /dev/null
+then
+    echo "AWS CLI is not installed. Installing..."
+
+    # Detect system architecture
+    ARCH=$(uname -m)
+    if [ "$ARCH" == "x86_64" ]; then
+        CLI_URL="https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip"
+    elif [ "$ARCH" == "aarch64" ]; then
+        CLI_URL="https://awscli.amazonaws.com/awscli-exe-linux-aarch64.zip"
+    else
+        echo "Unsupported architecture: $ARCH"
+        exit 1
+    fi
+
+    # Download and install AWS CLI
+    sudo curl "$CLI_URL" -o "awscliv2.zip"
+    sudo unzip awscliv2.zip
+    sudo ./aws/install --update
+    sudo rm -rf awscliv2.zip aws
+
+    echo "AWS CLI installation completed."
+else
+    echo "AWS CLI is already installed."
+    aws --version
+fi
+
+# Configure AWS CLI with provided credentials
+/usr/local/bin/aws configure set aws_access_key_id "__key__"
+/usr/local/bin/aws configure set aws_secret_access_key "__secret__"
+
+# Use the provided endpoint in the correct format
+ENDPOINT="__endpoint__"
+BUCKET="__bucket__"
+REGION="__region__"
+
+# Ensure that DEST does not have a trailing slash
+SRC="__src__"
+DEST="__dest__"
+
+# Upload the file
+echo "Uploading __src__ to s3://$BUCKET/$DEST"
+upload_output=$(/usr/local/bin/aws s3 cp "$SRC" "s3://$BUCKET/$DEST" --endpoint-url="$ENDPOINT" --region "$REGION" 2>&1)
+upload_exit_code=$?
+
+# Log output and exit code
+echo "Upload command output: $upload_output"
+echo "Upload command exit code: $upload_exit_code"
+
+# Check if the upload was successful
+if [ $upload_exit_code -eq 0 ]; then
+    echo "Upload successful"
+else
+    echo "Upload failed"
+    exit 1
+fi

app/StorageProviders/S3.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace App\StorageProviders;
+
+use App\Models\Server;
+use App\SSH\Storage\S3 as S3Storage;
+use App\SSH\Storage\Storage;
+use Aws\S3\Exception\S3Exception;
+use Illuminate\Support\Facades\Log;
+
+class S3 extends S3AbstractStorageProvider
+{
+    public function validationRules(): array
+    {
+        return [
+            'key' => 'required|string',
+            'secret' => 'required|string',
+            'region' => 'required|string',
+            'bucket' => 'required|string',
+            'path' => 'required|string',
+        ];
+    }
+
+    public function credentialData(array $input): array
+    {
+        return [
+            'key' => $input['key'],
+            'secret' => $input['secret'],
+            'region' => $input['region'],
+            'bucket' => $input['bucket'],
+            'path' => $input['path'],
+        ];
+    }
+
+    public function connect(): bool
+    {
+        try {
+            $this->setBucketRegion($this->storageProvider->credentials['region']);
+            $this->setApiUrl();
+            $this->buildClientConfig();
+            $this->getClient()->listBuckets();
+
+            return true;
+        } catch (S3Exception $e) {
+            Log::error('Failed to connect to S3', ['exception' => $e]);
+
+            return false;
+        }
+    }
+
+    public function ssh(Server $server): Storage
+    {
+        return new S3Storage($server, $this->storageProvider);
+    }
+
+    public function delete(array $paths): void {}
+}

app/StorageProviders/S3AbstractStorageProvider.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace App\StorageProviders;
+
+use App\Models\StorageProvider;
+use Aws\S3\S3Client;
+
+abstract class S3AbstractStorageProvider extends AbstractStorageProvider implements S3ClientInterface, S3StorageInterface
+{
+    protected ?string $apiUrl = null;
+
+    protected ?string $bucketRegion = null;
+
+    protected ?S3Client $client = null;
+
+    protected StorageProvider $storageProvider;
+
+    protected array $clientConfig = [];
+
+    public function getApiUrl(): string
+    {
+        return $this->apiUrl;
+    }
+
+    public function setApiUrl(?string $region = null): void
+    {
+        $this->bucketRegion = $region ?? $this->bucketRegion;
+        $this->apiUrl = "https://s3.{$this->bucketRegion}.amazonaws.com";
+    }
+
+    public function getBucketRegion(): string
+    {
+        return $this->bucketRegion;
+    }
+
+    public function setBucketRegion(string $region): void
+    {
+        $this->bucketRegion = $region;
+    }
+
+    public function getClient(): S3Client
+    {
+        return new S3Client($this->clientConfig);
+    }
+
+    /**
+     * Build the configuration array for the S3 client.
+     * This method can be overridden by child classes to modify the configuration.
+     */
+    public function buildClientConfig(): array
+    {
+        $this->clientConfig = [
+            'credentials' => [
+                'key' => $this->storageProvider->credentials['key'],
+                'secret' => $this->storageProvider->credentials['secret'],
+            ],
+            'region' => $this->getBucketRegion(),
+            'version' => 'latest',
+            'endpoint' => $this->getApiUrl(),
+        ];
+
+        return $this->clientConfig;
+    }
+
+    /**
+     * Set or update a configuration parameter for the S3 client.
+     */
+    public function setConfigParam(array $param): void
+    {
+        foreach ($param as $key => $value) {
+            $this->clientConfig[$key] = $value;
+        }
+    }
+}

app/StorageProviders/S3ClientInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App\StorageProviders;
+
+use Aws\S3\S3Client;
+
+interface S3ClientInterface
+{
+    public function getClient(): S3Client;
+}

app/StorageProviders/S3StorageInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace App\StorageProviders;
+
+interface S3StorageInterface
+{
+    public function getApiUrl(): string;
+
+    public function setApiUrl(?string $region = null): void;
+
+    public function getBucketRegion(): string;
+
+    public function setBucketRegion(string $region): void;
+}

app/StorageProviders/Wasabi.php

@@ -0,0 +1,85 @@
+<?php
+
+namespace App\StorageProviders;
+
+use App\Models\Server;
+use App\SSH\Storage\Storage;
+use App\SSH\Storage\Wasabi as WasabiStorage;
+use Aws\S3\Exception\S3Exception;
+use Illuminate\Support\Facades\Log;
+
+class Wasabi extends S3AbstractStorageProvider
+{
+    private const DEFAULT_REGION = 'us-east-1';
+
+    public function validationRules(): array
+    {
+        return [
+            'key' => 'required|string',
+            'secret' => 'required|string',
+            'region' => 'required|string',
+            'bucket' => 'required|string',
+            'path' => 'required|string',
+        ];
+    }
+
+    public function credentialData(array $input): array
+    {
+        return [
+            'key' => $input['key'],
+            'secret' => $input['secret'],
+            'region' => $input['region'],
+            'bucket' => $input['bucket'],
+            'path' => $input['path'],
+        ];
+    }
+
+    public function connect(): bool
+    {
+        try {
+            $this->setBucketRegion(self::DEFAULT_REGION);
+            $this->setApiUrl();
+            $this->buildClientConfig();
+            $this->getClient()->listBuckets();
+
+            return true;
+        } catch (S3Exception $e) {
+            Log::error('Failed to connect to S3', ['exception' => $e]);
+
+            return false;
+        }
+    }
+
+    /**
+     * Build the configuration array for the S3 client.
+     * This method can be overridden by child classes to modify the configuration.
+     */
+    public function buildClientConfig(): array
+    {
+        $this->clientConfig = [
+            'credentials' => [
+                'key' => $this->storageProvider->credentials['key'],
+                'secret' => $this->storageProvider->credentials['secret'],
+            ],
+            'region' => $this->getBucketRegion(),
+            'version' => 'latest',
+            'endpoint' => $this->getApiUrl(),
+            'use_path_style_endpoint' => true,
+        ];
+
+        return $this->clientConfig;
+    }
+
+    public function ssh(Server $server): Storage
+    {
+        return new WasabiStorage($server, $this->storageProvider);
+    }
+
+    public function setApiUrl(?string $region = null): void
+    {
+        $this->bucketRegion = $region ?? $this->bucketRegion;
+        $this->apiUrl = "https://s3.{$this->bucketRegion}.wasabisys.com";
+    }
+
+    public function delete(array $paths): void {}
+}