Role.php

<?php

namespace Statamic\Auth\File;

use Statamic\Auth\PermissionCache;
use Statamic\Auth\Role as BaseRole;
use Statamic\Events\RoleDeleted;
use Statamic\Events\RoleSaved;
use Statamic\Facades;
use Statamic\Preferences\HasPreferencesInProperty;
use Statamic\Support\Arr;

class Role extends BaseRole
{
    use HasPreferencesInProperty;

    protected $title;
    protected $handle;
    protected $originalHandle;
    protected $permissions;

    public function __construct()
    {
        $this->permissions = collect();
    }

    public function title(?string $title = null)
    {
        if (func_num_args() === 0) {
            return $this->title ?? ucfirst($this->handle);
        }

        $this->title = $title;

        return $this;
    }

    public function id(): string
    {
        return $this->handle();
    }

    public function handle(?string $handle = null)
    {
        if (func_num_args() === 0) {
            return $this->handle;
        }

        if (! $this->originalHandle) {
            $this->originalHandle = $this->handle;
        }

        $this->handle = $handle;

        return $this;
    }

    public function originalHandle()
    {
        return $this->originalHandle;
    }

    public function permissions($permissions = null)
    {
        if (is_null($permissions)) {
            return $this->permissions;
        }

        $this->permissions = collect($permissions);

        app(PermissionCache::class)->clear();

        return $this;
    }

    public function addPermission($permission)
    {
        $this->permissions = $this->permissions
            ->merge(Arr::wrap($permission))
            ->unique()
            ->values();

        app(PermissionCache::class)->clear();

        return $this;
    }

    public function removePermission($permission)
    {
        $this->permissions = $this->permissions
            ->diff(Arr::wrap($permission))
            ->values();

        app(PermissionCache::class)->clear();

        return $this;
    }

    public function hasPermission(string $permission): bool
    {
        if ($this->permissions->contains($permission)) {
            return true;
        }

        return $this->permissions->contains(function ($rolePermission) use ($permission) {
            return $this->matchesWildcard($rolePermission, $permission);
        });
    }

    public function isSuper(): bool
    {
        return $this->hasPermission('super');
    }

    protected function matchesWildcard(string $wildcardPermission, string $requestedPermission): bool
    {
        if (! str_contains($wildcardPermission, '*')) {
            return false;
        }

        $pattern = preg_quote($wildcardPermission, '/');
        $pattern = str_replace('\*', '.*', $pattern);
        $pattern = '/^'.$pattern.'$/';

        return (bool) preg_match($pattern, $requestedPermission);
    }

    public function save()
    {
        // TODO: Move this logic into \Statamic\Auth\Role.php to be consistent with \Statamic\Auth\UserGroup?

        Facades\Role::save($this);

        RoleSaved::dispatch($this);

        return $this;
    }

    public function delete()
    {
        // TODO: Move this logic into \Statamic\Auth\Role.php to be consistent with \Statamic\Auth\UserGroup?

        Facades\Role::delete($this);

        RoleDeleted::dispatch($this);
    }
}