BookStack Code Mirror - bookstack/blob - app/Users/Models/Role.php

   1 <?php
   2
   3 namespace BookStack\Users\Models;
   4
   5 use BookStack\Activity\Models\Loggable;
   6 use BookStack\App\Model;
   7 use BookStack\Permissions\Models\EntityPermission;
   8 use BookStack\Permissions\Models\JointPermission;
   9 use BookStack\Permissions\Models\RolePermission;
  10 use Illuminate\Database\Eloquent\Collection;
  11 use Illuminate\Database\Eloquent\Factories\HasFactory;
  12 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
  13 use Illuminate\Database\Eloquent\Relations\HasMany;
  14
  15 /**
  16  * Class Role.
  17  *
  18  * @property int        $id
  19  * @property string     $display_name
  20  * @property string     $description
  21  * @property string     $external_auth_id
  22  * @property string     $system_name
  23  * @property bool       $mfa_enforced
  24  * @property Collection $users
  25  */
  26 class Role extends Model implements Loggable
  27 {
  28     use HasFactory;
  29
  30     protected $fillable = ['display_name', 'description', 'external_auth_id', 'mfa_enforced'];
  31
  32     protected $hidden = ['pivot'];
  33
  34     protected $casts = [
  35         'mfa_enforced' => 'boolean',
  36     ];
  37
  38     /**
  39      * The roles that belong to the role.
  40      */
  41     public function users(): BelongsToMany
  42     {
  43         return $this->belongsToMany(User::class)->orderBy('name', 'asc');
  44     }
  45
  46     /**
  47      * Get all related JointPermissions.
  48      */
  49     public function jointPermissions(): HasMany
  50     {
  51         return $this->hasMany(JointPermission::class);
  52     }
  53
  54     /**
  55      * The RolePermissions that belong to the role.
  56      * @return BelongsToMany<RolePermission, $this>
  57      */
  58     public function permissions(): BelongsToMany
  59     {
  60         return $this->belongsToMany(RolePermission::class, 'permission_role', 'role_id', 'permission_id')
  61             ->select(['id', 'name']);
  62     }
  63
  64     /**
  65      * Get the entity permissions assigned to this role.
  66      */
  67     public function entityPermissions(): HasMany
  68     {
  69         return $this->hasMany(EntityPermission::class);
  70     }
  71
  72     /**
  73      * Check if this role has a permission.
  74      */
  75     public function hasPermission(string $permissionName): bool
  76     {
  77         $permissions = $this->getRelationValue('permissions');
  78         foreach ($permissions as $permission) {
  79             if ($permission->getRawAttribute('name') === $permissionName) {
  80                 return true;
  81             }
  82         }
  83
  84         return false;
  85     }
  86
  87     /**
  88      * Add a permission to this role.
  89      */
  90     public function attachPermission(RolePermission $permission)
  91     {
  92         $this->permissions()->attach($permission->id);
  93     }
  94
  95     /**
  96      * Detach a single permission from this role.
  97      */
  98     public function detachPermission(RolePermission $permission)
  99     {
 100         $this->permissions()->detach([$permission->id]);
 101     }
 102
 103     /**
 104      * Get the role of the specified display name.
 105      */
 106     public static function getRole(string $displayName): ?self
 107     {
 108         return static::query()->where('display_name', '=', $displayName)->first();
 109     }
 110
 111     /**
 112      * Get the role object for the specified system role.
 113      */
 114     public static function getSystemRole(string $systemName): ?self
 115     {
 116         static $cache = [];
 117
 118         if (!isset($cache[$systemName])) {
 119             $cache[$systemName] = static::query()->where('system_name', '=', $systemName)->first();
 120         }
 121
 122         return $cache[$systemName];
 123     }
 124
 125     /**
 126      * {@inheritdoc}
 127      */
 128     public function logDescriptor(): string
 129     {
 130         return "({$this->id}) {$this->display_name}";
 131     }
 132 }