panel-pelican-dev/app/Models/Subuser.php

<?php

namespace App\Models;

use App\Contracts\Validatable;
use App\Enums\SubuserPermission;
use App\Traits\HasValidation;
use BackedEnum;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Notifications\Notifiable;
use Illuminate\Support\Carbon;

/**
 * @property int $id
 * @property int $user_id
 * @property int $server_id
 * @property Carbon|null $created_at
 * @property Carbon|null $updated_at
 * @property string[]|null $permissions
 * @property-read Server $server
 * @property-read User $user
 *
 * @method static \Database\Factories\SubuserFactory factory($count = null, $state = [])
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Subuser newModelQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Subuser newQuery()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Subuser query()
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Subuser whereCreatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Subuser whereId($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Subuser wherePermissions($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Subuser whereServerId($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Subuser whereUpdatedAt($value)
 * @method static \Illuminate\Database\Eloquent\Builder<static>|Subuser whereUserId($value)
 */
class Subuser extends Model implements Validatable
{
    use HasFactory;
    use HasValidation;
    use Notifiable;

    /**
     * The resource name for this model when it is transformed into an
     * API representation using fractal.
     */
    public const RESOURCE_NAME = 'server_subuser';

    /** @var array<string, array{name: string, hidden: ?bool, icon: null|string|BackedEnum, translation_prefix: ?string, permissions: string[]}> */
    protected static array $customPermissions = [];

    /** @param string[] $permissions */
    public static function registerCustomPermissions(string $name, array $permissions, ?string $translationPrefix = null, null|string|BackedEnum $icon = null, ?bool $hidden = null): void
    {
        $customPermission = static::$customPermissions[$name] ?? [];

        $customPermission['name'] = $name;
        $customPermission['permissions'] = array_merge($customPermission['permissions'] ?? [], $permissions);

        if (!is_null($translationPrefix)) {
            $customPermission['translation_prefix'] = $translationPrefix;
        }

        if (!is_null($icon)) {
            $customPermission['icon'] = $icon;
        }

        if (!is_null($hidden)) {
            $customPermission['hidden'] = $hidden;
        }

        static::$customPermissions[$name] = $customPermission;
    }

    /**
     * Fields that are not mass assignable.
     */
    protected $guarded = ['id', 'created_at', 'updated_at'];

    /** @var array<array-key, string[]> */
    public static array $validationRules = [
        'user_id' => ['required', 'numeric', 'exists:users,id'],
        'server_id' => ['required', 'numeric', 'exists:servers,id'],
        'permissions' => ['nullable', 'array'],
        'permissions.*' => ['string'],
    ];

    protected function casts(): array
    {
        return [
            'user_id' => 'int',
            'server_id' => 'int',
            'permissions' => 'array',
        ];
    }

    /**
     * Gets the server associated with a subuser.
     */
    public function server(): BelongsTo
    {
        return $this->belongsTo(Server::class);
    }

    /**
     * Gets the user associated with a subuser.
     */
    public function user(): BelongsTo
    {
        return $this->belongsTo(User::class);
    }

    /** @return array<array{name: string, hidden: bool, icon: null|string|BackedEnum, translation_prefix: string, permissions: string[]}> */
    public static function allPermissionData(): array
    {
        $allPermissions = [];

        foreach (SubuserPermission::cases() as $subuserPermission) {
            [$group, $permission] = $subuserPermission->split();

            $allPermissions[$group] = [
                'name' => $group,
                'hidden' => $subuserPermission->isHidden(),
                'icon' => $subuserPermission->getIcon(),
                'permissions' => array_merge($allPermissions[$group]['permissions'] ?? [], [$permission]),
                'translation_prefix' => 'server/user.permissions',
            ];
        }

        foreach (static::$customPermissions as $customPermission) {
            $name = $customPermission['name'];

            $groupData = $allPermissions[$name] ?? [];

            $groupData = [
                'name' => $name,
                'hidden' => $customPermission['hidden'] ?? $groupData['hidden'] ?? false,
                'icon' => $customPermission['icon'] ?? $groupData['icon'],
                'permissions' => array_unique(array_merge($groupData['permissions'] ?? [], $customPermission['permissions'])),
                'translation_prefix' => $customPermission['translation_prefix'] ?? $groupData['translation_prefix'] ?? 'server/user.permissions',
            ];

            $allPermissions[$name] = $groupData;
        }

        return array_values($allPermissions);
    }

    /** @return string[] */
    public static function allPermissionKeys(): array
    {
        return collect(static::allPermissionData())
            ->map(fn ($data) => array_map(fn ($permission) => $data['name'] . '.' . $permission, $data['permissions']))
            ->flatten()
            ->unique()
            ->toArray();
    }

    public static function doesPermissionExist(string|SubuserPermission $permission): bool
    {
        if ($permission instanceof SubuserPermission) {
            $permission = $permission->value;
        }

        return str_contains($permission, '.') && in_array($permission, static::allPermissionKeys());
    }
}