panel/app/Models/File.php

<?php

namespace App\Models;

use App\Enums\TablerIcon;
use App\Livewire\AlertBanner;
use App\Repositories\Daemon\DaemonFileRepository;
use BackedEnum;
use Carbon\Carbon;
use Closure;
use Exception;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Http\Client\ConnectionException;
use Sushi\Sushi;

/**
 * \App\Models\File.
 *
 * @property int $id
 * @property string $name
 * @property Carbon $created_at
 * @property Carbon $modified_at
 * @property string $mode
 * @property int $mode_bits
 * @property int $size
 * @property bool $is_directory
 * @property bool $is_file
 * @property bool $is_symlink
 * @property string $mime_type
 */
class File extends Model
{
    use Sushi;

    protected int $sushiInsertChunkSize = 100;

    public const ARCHIVE_MIMES = [
        'application/vnd.rar', // .rar
        'application/x-rar-compressed', // .rar (2)
        'application/x-tar', // .tar
        'application/x-br', // .tar.br
        'application/x-bzip2', // .tar.bz2, .bz2
        'application/gzip', // .tar.gz, .gz
        'application/x-gzip',
        'application/x-lzip', // .tar.lz4, .lz4 (not sure if this mime type is correct)
        'application/x-sz', // .tar.sz, .sz (not sure if this mime type is correct)
        'application/x-xz', // .tar.xz, .xz
        'application/x-7z-compressed', // .7z
        'application/zstd', // .tar.zst, .zst
        'application/zip', // .zip
    ];

    protected static Server $server;

    protected static string $path;

    protected static ?string $searchTerm;

    /** @var array<string, array<string, string|Closure|null>> */
    protected static array $customSpecialFiles = [];

    public static function registerSpecialFile(string $fileName, string|Closure $bannerTitle, string|Closure|null $bannerBody = null, ?Closure $nameCheck = null): void
    {
        static::$customSpecialFiles[$fileName] = [
            'title' => $bannerTitle,
            'body' => $bannerBody,
            'check' => $nameCheck ?? fn (string $path) => str($path)->endsWith($fileName),
        ];
    }

    /** @return array<string, array<string, string|Closure|null>> */
    public static function getSpecialFiles(): array
    {
        $specialFiles = [
            '.pelicanignore' => [
                'title' => fn () => trans('server/file.alerts.pelicanignore.title'),
                'body' => fn () => trans('server/file.alerts.pelicanignore.body'),
                'check' => fn (string $path) => str($path)->endsWith('.pelicanignore'),
            ],
        ];

        return array_merge($specialFiles, static::$customSpecialFiles);
    }

    public static function get(Server $server, string $path = '/', ?string $searchTerm = null): Builder
    {
        self::$server = $server;
        self::$path = $path;
        self::$searchTerm = $searchTerm;

        return self::query();
    }

    public function isArchive(): bool
    {
        return $this->is_file && in_array($this->mime_type, self::ARCHIVE_MIMES);
    }

    public function isImage(): bool
    {
        return preg_match('/^image\/(?!svg\+xml)/', $this->mime_type);
    }

    public function getIcon(): BackedEnum
    {
        if ($this->is_directory) {
            return TablerIcon::Folder;
        }

        if ($this->isArchive()) {
            return TablerIcon::FileZip;
        }

        if ($this->isImage()) {
            return TablerIcon::Photo;
        }

        return $this->is_symlink ? TablerIcon::FileSymlink : TablerIcon::File;
    }

    public function canEdit(): bool
    {
        if ($this->is_directory || $this->isArchive() || $this->is_symlink || $this->isImage()) {
            return false;
        }

        return $this->is_file && !in_array($this->mime_type, ['application/java-archive', 'application/octet-stream', 'inode/directory']);
    }

    public function server(): Server
    {
        return self::$server;
    }

    protected function casts(): array
    {
        return [
            'created_at' => 'datetime',
            'modified_at' => 'datetime',
        ];
    }

    /**
     * @return string[]
     */
    public function getSchema(): array
    {
        return [
            'name' => 'string',
            'created_at' => 'string',
            'modified_at' => 'string',
            'mode' => 'string',
            'mode_bits' => 'integer',
            'size' => 'integer',
            'is_directory' => 'boolean',
            'is_file' => 'boolean',
            'is_symlink' => 'boolean',
            'mime_type' => 'string',
        ];
    }

    /**
     * @return array<array{
     *     name: string,
     *     created_at: string,
     *     modified_at: string,
     *     mode: string,
     *     mode_bits: int,
     *     size: int,
     *     is_directory: bool,
     *     is_file: bool,
     *     is_symlink: bool,
     *     mime_type: string,
     * }>
     */
    public function getRows(): array
    {
        if (!isset(self::$server)) {
            return [];
        }

        try {
            $fileRepository = (new DaemonFileRepository())->setServer(self::$server);

            if (!is_null(self::$searchTerm)) {
                $contents = cache()->remember('file_search_' . self::$path . '_' . self::$searchTerm, now()->addMinute(), fn () => $fileRepository->search(self::$searchTerm, self::$path));
            } else {
                $contents = $fileRepository->getDirectory(self::$path ?? '/');
            }

            if (isset($contents['error'])) {
                throw new Exception($contents['error']);
            }

            $rows = array_map(function ($file) {
                return [
                    'name' => $file['name'],
                    'created_at' => Carbon::parse($file['created'])->timezone('UTC'),
                    'modified_at' => Carbon::parse($file['modified'])->timezone('UTC'),
                    'mode' => $file['mode'],
                    'mode_bits' => (int) $file['mode_bits'],
                    'size' => (int) $file['size'],
                    'is_directory' => $file['directory'],
                    'is_file' => $file['file'],
                    'is_symlink' => $file['symlink'],
                    'mime_type' => $file['file'] && str($file['name'])->lower()->endsWith('.jar') && in_array($file['mime'], self::ARCHIVE_MIMES) ? 'application/java-archive' : $file['mime'],
                ];
            }, $contents);

            $rowCount = count($rows);
            $limit = 999;
            if ($rowCount > $limit) {
                $this->sushiInsertChunkSize = min(floor($limit / count($this->getSchema())), $rowCount);
            }

            return $rows;
        } catch (Exception $exception) {
            report($exception);

            $message = str($exception->getMessage());
            if ($message->startsWith('cURL error 7: ')) {
                $message = $message->after('cURL error 7: ')->before(' after ');
            }

            if ($exception instanceof ConnectionException) {
                $message = str('Node connection failed');
            }

            AlertBanner::make('files_node_error')
                ->title(trans('server/file.alerts.files_node_error.title'))
                ->body($message->toString())
                ->danger()
                ->send();

            return [];
        }
    }

    protected function sushiShouldCache(): bool
    {
        return false;
    }
}