]> BookStack Code Mirror - bookstack/commitdiff
Added interface for adding/removing roles in entity perms.
authorDan Brown <redacted>
Mon, 10 Oct 2022 11:24:23 +0000 (12:24 +0100)
committerDan Brown <redacted>
Mon, 10 Oct 2022 11:24:23 +0000 (12:24 +0100)
app/Auth/Permissions/PermissionFormData.php
app/Http/Controllers/PermissionsController.php
resources/js/components/entity-permissions.js
resources/sass/_buttons.scss
resources/views/form/entity-permissions-row.blade.php
resources/views/form/entity-permissions.blade.php
routes/web.php

index 07c95c5344924a44b07b88dc59afb3d705190ccf..781209043096d0b2c00db58eda03f44f86b87d1d 100644 (file)
@@ -15,16 +15,15 @@ class PermissionFormData
     }
 
     /**
-     * Get the roles with permissions assigned.
+     * Get the permissions with assigned roles.
      */
-    public function rolesWithPermissions(): array
+    public function permissionsWithRoles(): array
     {
         return $this->entity->permissions()
             ->with('role')
             ->where('role_id', '!=', 0)
-            ->get(['id', 'role_id'])
-            ->pluck('role')
-            ->sortBy('display_name')
+            ->get()
+            ->sortBy('role.display_name')
             ->all();
     }
 
index d8dca9825c4ed3e96c0732af6ca81f45425ad6df..dd6c29a8a1ba3a1e8047b6ba71c14e70403d8911 100644 (file)
@@ -2,7 +2,9 @@
 
 namespace BookStack\Http\Controllers;
 
+use BookStack\Auth\Permissions\EntityPermission;
 use BookStack\Auth\Permissions\PermissionFormData;
+use BookStack\Auth\Role;
 use BookStack\Entities\Models\Book;
 use BookStack\Entities\Models\Bookshelf;
 use BookStack\Entities\Models\Chapter;
@@ -148,4 +150,20 @@ class PermissionsController extends Controller
 
         return redirect($shelf->getUrl());
     }
+
+    /**
+     * Get an empty entity permissions form row for the given role.
+     */
+    public function formRowForRole(string $entityType, string $roleId)
+    {
+        $this->checkPermissionOr('restrictions-manage', fn() => userCan('restrictions-manage-all'));
+
+        $role = Role::query()->findOrFail($roleId);
+
+        return view('form.entity-permissions-row', [
+            'role' => $role,
+            'permission' => new EntityPermission(),
+            'entityType' => $entityType,
+        ]);
+    }
 }
index 8b57d3376ef8d41dc02f51676f66dc2150cdc4f6..a18fc7a97aedbceb8e913baf8b25f6fe0e48f4df 100644 (file)
@@ -1,14 +1,21 @@
-
-
+/**
+ * @extends {Component}
+ */
 class EntityPermissions {
 
     setup() {
+        this.container = this.$el;
+        this.entityType = this.$opts.entityType;
+
         this.everyoneInheritToggle = this.$refs.everyoneInherit;
+        this.roleSelect = this.$refs.roleSelect;
+        this.roleContainer = this.$refs.roleContainer;
 
         this.setupListeners();
     }
 
     setupListeners() {
+        // "Everyone Else" inherit toggle
         this.everyoneInheritToggle.addEventListener('change', event => {
             const inherit = event.target.checked;
             const permissions = document.querySelectorAll('input[type="checkbox"][name^="restrictions[0]["]');
@@ -16,7 +23,56 @@ class EntityPermissions {
                 permission.disabled = inherit;
                 permission.checked = false;
             }
-        })
+        });
+
+        // Remove role row button click
+        this.container.addEventListener('click', event => {
+            const button = event.target.closest('button');
+            if (button && button.dataset.roleId) {
+                this.removeRowOnButtonClick(button)
+            }
+        });
+
+        // Role select change
+        this.roleSelect.addEventListener('change', event => {
+            const roleId = this.roleSelect.value;
+            if (roleId) {
+                this.addRoleRow(roleId);
+            }
+        });
+    }
+
+    async addRoleRow(roleId) {
+        this.roleSelect.disabled = true;
+
+        // Remove option from select
+        const option = this.roleSelect.querySelector(`option[value="${roleId}"]`);
+        if (option) {
+            option.remove();
+        }
+
+        // Get and insert new row
+        const resp = await window.$http.get(`/permissions/form-row/${this.entityType}/${roleId}`);
+        const wrap = document.createElement('div');
+        wrap.innerHTML = resp.data;
+        const row = wrap.children[0];
+        this.roleContainer.append(row);
+        window.components.init(row);
+
+        this.roleSelect.disabled = false;
+    }
+
+    removeRowOnButtonClick(button) {
+        const row = button.closest('.content-permissions-row');
+        const roleId = button.dataset.roleId;
+        const roleName = button.dataset.roleName;
+
+        const option = document.createElement('option');
+        option.value = roleId;
+        option.textContent = roleName;
+
+        this.roleSelect.append(option);
+        row.remove();
     }
 
 }
index 714dfc42c5905212c752a010489435774fecc79b..83d17352da3c6d830f19146b0c161c5f20391a58 100644 (file)
@@ -109,12 +109,23 @@ button {
   display: block;
 }
 
-.button.icon {
+.button.icon, .icon-button {
   .svg-icon {
     margin-inline-end: 0;
   }
 }
 
+.icon-button {
+  text-align: center;
+  border: 1px solid transparent;
+}
+.icon-button:hover {
+  background-color: rgba(0, 0, 0, 0.05);
+  border-radius: 4px;
+  border-color: #DDD;
+  cursor: pointer;
+}
+
 .button.svg {
   display: flex;
   align-items: center;
index ce8beaec3389251a429e67c919c51928e3d50e85..2bf19db64c61f65474007e933406a0df219a65fa 100644 (file)
@@ -1,3 +1,9 @@
+{{--
+$role - The Role to display this row for.
+$entityType - String identifier for type of entity having permissions applied.
+$permission - The entity permission containing the permissions.
+--}}
+
 <div component="permissions-table" class="content-permissions-row flex-container-row justify-space-between wrap">
     <div class="gap-x-m flex-container-row items-center px-l py-m flex">
         <div class="text-large" title="{{ $role->id === 0 ? 'Everyone Else' : trans('common.role') }}">
@@ -15,7 +21,8 @@
         @endif
     </div>
     @php
-        $inheriting = ($role->id === 0 && !$model->restricted);
+        // TODO
+        $inheriting = ($role->id === 0);
     @endphp
     @if($role->id === 0)
         <div class="px-l flex-container-row items-center" refs="entity-permissions@everyoneInherit">
     <div class="flex-container-row justify-space-between gap-x-xl wrap items-center">
         <input type="hidden" name="permissions[{{ $role->id }}][active]" value="true">
         <div class="px-l">
-            @include('form.restriction-checkbox', ['name'=>'permissions', 'label' => trans('common.view'), 'action' => 'view', 'disabled' => $inheriting])
-        </div>
-        <div class="px-l">
-            @if(!$model instanceof \BookStack\Entities\Models\Page)
-                @include('form.restriction-checkbox', ['name'=>'permissions', 'label' => trans('common.create'), 'action' => 'create', 'disabled' => $inheriting])
-            @endif
+            @include('form.custom-checkbox', [
+                'name' =>  'permissions[' . $role->id . '][view]',
+                'label' => trans('common.view'),
+                'value' => 'true',
+                'checked' => $permission->view,
+                'disabled' => $inheriting
+            ])
         </div>
+        @if($entityType !== 'page')
+            <div class="px-l">
+                @include('form.custom-checkbox', [
+                    'name' =>  'permissions[' . $role->id . '][create]',
+                    'label' => trans('common.create'),
+                    'value' => 'true',
+                    'checked' => $permission->create,
+                    'disabled' => $inheriting
+                ])
+            </div>
+        @endif
         <div class="px-l">
-            @include('form.restriction-checkbox', ['name'=>'permissions', 'label' => trans('common.update'), 'action' => 'update', 'disabled' => $inheriting])
+            @include('form.custom-checkbox', [
+                'name' =>  'permissions[' . $role->id . '][update]',
+                'label' => trans('common.update'),
+                'value' => 'true',
+                'checked' => $permission->update,
+                'disabled' => $inheriting
+            ])
         </div>
         <div class="px-l">
-            @include('form.restriction-checkbox', ['name'=>'permissions', 'label' => trans('common.delete'), 'action' => 'delete', 'disabled' => $inheriting])
+            @include('form.custom-checkbox', [
+                'name' =>  'permissions[' . $role->id . '][delete]',
+                'label' => trans('common.delete'),
+                'value' => 'true',
+                'checked' => $permission->delete,
+                'disabled' => $inheriting
+            ])
         </div>
     </div>
+    @if($role->id !== 0)
+        <div class="flex-container-row items-center px-m py-s">
+            <button type="button"
+                    class="text-neg p-m icon-button"
+                    data-role-id="{{ $role->id }}"
+                    data-role-name="{{ $role->display_name }}"
+                    title="Remove Row">
+                @icon('close') <span class="hide-over-m ml-xs">Remove Row</span>
+            </button>
+        </div>
+    @endif
 </div>
\ No newline at end of file
index 2fd0a4a434980f12c3a2233f39f3d00d2b3f72c6..c6f5a4298589c779016822480c46361bbfda9595 100644 (file)
@@ -1,4 +1,7 @@
-<form component="entity-permissions" action="{{ $model->getUrl('/permissions') }}" method="POST">
+<form component="entity-permissions"
+      option:entity-permissions:entity-type="{{ $model->getType() }}"
+      action="{{ $model->getUrl('/permissions') }}"
+      method="POST">
     {!! csrf_field() !!}
     <input type="hidden" name="_method" value="PUT">
 
         <p class="text-warn">{{ trans('entities.shelves_permissions_cascade_warning') }}</p>
     @endif
 
-    <div class="content-permissions mt-m mb-xl">
-        @foreach($data->rolesWithPermissions() as $role)
-            @include('form.entity-permissions-row', ['role' => $role, 'model' => $model])
+    <div refs="entity-permissions@role-container" class="content-permissions mt-m mb-m">
+        @foreach($data->permissionsWithRoles() as $permission)
+            @include('form.entity-permissions-row', [
+                'permission' => $permission,
+                'role' => $permission->role,
+                'entityType' => $model->getType()
+            ])
         @endforeach
     </div>
 
+    <div class="flex-container-row justify-flex-end mb-xl">
+        <div>
+            <label for="role_select">Override permissions for role</label>
+            <select name="role_select" id="role_select" refs="entity-permissions@role-select">
+                <option value="">{{ trans('common.select') }}</option>
+                @foreach($data->rolesNotAssigned() as $role)
+                    <option value="{{ $role->id }}">{{ $role->display_name }}</option>
+                @endforeach
+            </select>
+        </div>
+    </div>
+
     <div class="content-permissions mt-m mb-xl">
-        @include('form.entity-permissions-row', ['role' => $data->everyoneElseRole(), 'model' => $model])
+        @include('form.entity-permissions-row', [
+                'role' => $data->everyoneElseRole(),
+                'permission' => new \BookStack\Auth\Permissions\EntityPermission(),
+                'entityType' => $model->getType(),
+            ])
     </div>
 
     <div class="text-right">
index 8ee5d073930b27eb7184eb0797eb7d340c55371e..5fdfda3f09bddc5b5e1d80fe37304c08bbd33607 100644 (file)
@@ -215,6 +215,9 @@ Route::middleware('auth')->group(function () {
     Route::get('/', [HomeController::class, 'index']);
     Route::get('/home', [HomeController::class, 'index']);
 
+    // Permissions
+    Route::get('/permissions/form-row/{entityType}/{roleId}', [PermissionsController::class, 'formRowForRole']);
+
     // Maintenance
     Route::get('/settings/maintenance', [MaintenanceController::class, 'index']);
     Route::delete('/settings/maintenance/cleanup-images', [MaintenanceController::class, 'cleanupImages']);