55 management of application settings

CHANGELOG.md

@@ -20,6 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added global settings, .env as default; added logo path and room limit ([#34],[#36])
 - Added setting menu for administrators ([#35], [#38])
 - Added a middleware to check whether the request is in sync with model of the database and not stale ([#40], [#41])
+- Added management of application settings ([#55], [#60])
 
 [#1]: https://github.com/THM-Health/PILOS/issues/1
 [#3]: https://github.com/THM-Health/PILOS/pull/3
@@ -54,5 +55,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [#49]: https://github.com/THM-Health/PILOS/pull/49
 [#50]: https://github.com/THM-Health/PILOS/issues/50
 [#54]: https://github.com/THM-Health/PILOS/pull/54
+[#55]: https://github.com/THM-Health/PILOS/issues/55
+[#60]: https://github.com/THM-Health/PILOS/pull/60
 
 [unreleased]: https://github.com/THM-Health/PILOS/compare/3c8359cdb0395546fe97aeabf1a40f93002b182c...HEAD

app/Http/Controllers/api/v1/ApplicationController.php

@@ -3,31 +3,61 @@
 namespace App\Http\Controllers\api\v1;
 
 use App\Http\Controllers\Controller;
+use App\Http\Requests\UpdateSetting;
 use App\Http\Resources\User as UserResource;
+use Illuminate\Http\JsonResponse;
 use Illuminate\Support\Facades\Auth;
 
 class ApplicationController extends Controller
 {
     /**
      * Load basic application data, like settings
-     * @return \Illuminate\Http\JsonResponse
+     * @return JsonResponse
      */
     public function settings()
     {
         return response()->json(['data' => [
-              'logo'                 => setting('logo'),
-              'room_limit'           => setting('room_limit'),
-              'pagination_page_size' => setting('pagination_page_size'),
-              'bbb'                  => [
-                  'file_mimes'              => config('bigbluebutton.allowed_file_mimes'),
-                  'max_filesize'            => config('bigbluebutton.max_filesize'),
-                  'room_name_limit'         => config('bigbluebutton.room_name_limit'),
-                  'welcome_message_limit'   => config('bigbluebutton.welcome_message_limit')
-              ]
-          ]
+            'logo'                           => setting('logo'),
+            'room_limit'                     => setting('room_limit'),
+            'pagination_page_size'           => setting('pagination_page_size'),
+            'own_rooms_pagination_page_size' => setting('own_rooms_pagination_page_size'),
+            'bbb'                            => [
+                'file_mimes'            => config('bigbluebutton.allowed_file_mimes'),
+                'max_filesize'          => config('bigbluebutton.max_filesize'),
+                'room_name_limit'       => config('bigbluebutton.room_name_limit'),
+                'welcome_message_limit' => config('bigbluebutton.welcome_message_limit')
+            ]
+        ]
         ]);
     }
 
+    /**
+     * Update application settings data
+     * @param  UpdateSetting $request
+     * @return JsonResponse
+     */
+    public function updateSettings(UpdateSetting $request)
+    {
+        $data = $request->all();
+
+        // Settings defaults array keys for validation
+        $setting_keys = collect(config('settings.defaults'))->keys()->toArray();
+
+        foreach ($data as $key => $value) {
+            // If key exists in the settings array keys then update settings
+            if (in_array($key, $setting_keys)) {
+                setting([$key => $value])->save();
+            }
+        }
+
+        return response()->json(['data' => [
+            'logo'                           => setting('logo'),
+            'room_limit'                     => setting('room_limit'),
+            'pagination_page_size'           => setting('pagination_page_size'),
+            'own_rooms_pagination_page_size' => setting('own_rooms_pagination_page_size')
+        ]], 201);
+    }
+
     /**
      * Load current user
      * @return UserResource

app/Http/Requests/UpdateSetting.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace App\Http\Requests;
+
+use Illuminate\Foundation\Http\FormRequest;
+
+class UpdateSetting extends FormRequest
+{
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array
+     */
+    public function rules()
+    {
+        return [
+            'room_limit'                     => 'sometimes|required|numeric|max:255',
+            'logo'                           => 'sometimes|required|url|max:255',
+            'own_rooms_pagination_page_size' => 'sometimes|required|numeric|max:255',
+            'pagination_page_size'           => 'sometimes|required|numeric|max:255'
+        ];
+    }
+}

database/seeds/RolesAndPermissionsSeeder.php

@@ -20,12 +20,17 @@ public function run()
 
         $adminPermissions[] = Permission::firstOrCreate([ 'name' => 'rooms.create' ])->id;
         $adminPermissions[] = Permission::firstOrCreate([ 'name' => 'rooms.delete' ])->id;
+
         $adminPermissions[] = Permission::firstOrCreate([ 'name' => 'settings.manage' ])->id;
+        $adminPermissions[] = Permission::firstOrCreate([ 'name' => 'settings.viewAny' ])->id;
+        $adminPermissions[] = Permission::firstOrCreate([ 'name' => 'settings.update' ])->id;
+
         $adminPermissions[] = Permission::firstOrCreate([ 'name' => 'roles.viewAny' ])->id;
         $adminPermissions[] = Permission::firstOrCreate([ 'name' => 'roles.view' ])->id;
         $adminPermissions[] = Permission::firstOrCreate([ 'name' => 'roles.create' ])->id;
         $adminPermissions[] = Permission::firstOrCreate([ 'name' => 'roles.update' ])->id;
         $adminPermissions[] = Permission::firstOrCreate([ 'name' => 'roles.delete' ])->id;
+
         $adminPermissions[] = Permission::firstOrCreate([ 'name' => 'users.viewAny' ])->id;
 
         $adminRole = Role::firstOrCreate([ 'name' => 'admin', 'default' => true, 'role_limit' => -1 ]);

resources/js/lang/de/app.js

@@ -57,7 +57,9 @@ export default {
 
     settings: {
       title: 'Einstellungen',
-      manage: 'Einstellungen verwalten'
+      manage: 'Einstellungen verwalten',
+      update: 'Einstellungen bearbeiten',
+      viewAny: 'Alle Einstellungen anzeigen'
     },
 
     roles: {

resources/js/lang/de/settings.js

@@ -45,5 +45,37 @@ export default {
 
   users: {
     title: 'Benutzer'
+  },
+
+  application: {
+    title: 'Anwendung',
+    save: 'Abspeichern',
+    preview: 'Vorschauen',
+
+    updateSettingsSuccess: {
+      message: 'Einstellung wurde erfolgreich aktualisiert!',
+      title: 'Einstellung'
+    },
+
+    logo: {
+      title: 'Logo',
+      description: 'Das Anwendungslogo ändern. Bild URL eingeben',
+      hint: 'Bild URL'
+    },
+
+    roomLimit: {
+      title: 'Anzahl der Räume pro Benutzer',
+      description: 'Begrenzt die Anzahl der Räume, die ein Benutzer haben kann. Diese Einstellung gilt nicht für Administratoren. Der Wert -1 für unbegrenzte Anzahl der Räume eingeben'
+    },
+
+    paginationPageSize: {
+      title: 'Größe der Paginierung',
+      description: 'Begrenzt die Seitengrößen für die Paginierung der Datentabellen'
+    },
+
+    ownRoomsPaginationPageSize: {
+      title: 'Größe der Paginierung für eigene Räume',
+      description: 'Begrenzt die Seitengrößen für die Paginierung der eigenen Räume'
+    }
   }
 };

resources/js/lang/en/app.js

@@ -57,7 +57,9 @@ export default {
 
     settings: {
       title: 'Settings',
-      manage: 'Manage settings'
+      manage: 'Manage settings',
+      update: 'Edit settings',
+      viewAny: 'Show all settings'
     },
 
     roles: {

resources/js/lang/en/settings.js

@@ -44,5 +44,37 @@ export default {
 
   users: {
     title: 'Users'
+  },
+
+  application: {
+    title: 'Application',
+    save: 'Save',
+    preview: 'Preview',
+
+    updateSettingsSuccess: {
+      message: 'Settings updated successfully!',
+      title: 'Settings'
+    },
+
+    logo: {
+      title: 'Logo',
+      description: 'Change the application logo. Enter the image URL',
+      hint: 'Image URL'
+    },
+
+    roomLimit: {
+      title: 'Number of rooms per user',
+      description: 'Limits the number of rooms that a user can have. This setting does not apply to administrators.  Enter the value -1 for unlimited number of rooms'
+    },
+
+    paginationPageSize: {
+      title: 'Pagination page size',
+      description: 'Limits the number of page size for data tables pagination'
+    },
+
+    ownRoomsPaginationPageSize: {
+      title: 'Own rooms pagination page size',
+      description: 'Limits the number of page size for own rooms pagination'
+    }
   }
 };

resources/js/policies/SettingPolicy.js

@@ -10,5 +10,25 @@ export default {
    */
   manage (permissionService) {
     return !permissionService.currentUser ? false : permissionService.currentUser.permissions.includes('settings.manage');
+  },
+
+  /**
+   * Returns a boolean that indicates whether the user can view all application settings or not.
+   *
+   * @param permissionService
+   * @return {boolean}
+   */
+  viewAny (permissionService) {
+    return !permissionService.currentUser ? false : permissionService.currentUser.permissions.includes('settings.viewAny');
+  },
+
+  /**
+   * Returns a boolean that indicates whether the user can update the application settings or not.
+   *
+   * @param permissionService
+   * @return {boolean}
+   */
+  update (permissionService) {
+    return !permissionService.currentUser ? false : permissionService.currentUser.permissions.includes('settings.update');
   }
 };

resources/js/router.js

@@ -11,6 +11,7 @@ import Settings from './views/settings/Settings';
 import RolesIndex from './views/settings/roles/Index';
 import RolesView from './views/settings/roles/View';
 import Users from './views/settings/Users';
+import Application from './views/settings/Application';
 import SettingsHome from './views/settings/SettingsHome';
 import Base from './api/base';
 
@@ -112,6 +113,19 @@ export const routes = [
             });
           }
         }
+      },
+      {
+        path: 'application',
+        name: 'settings.application',
+        component: Application,
+        meta: {
+          requiresAuth: true,
+          accessPermitted: () => Promise.resolve(
+            PermissionService.can('manage', 'SettingPolicy') &&
+            PermissionService.can('viewAny', 'SettingPolicy') &&
+            PermissionService.can('update', 'SettingPolicy')
+          )
+        }
       }
     ]
   },