GSOC-23: Roles and User Modules

app/Http/Controllers/Dashboard/RolesController.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace App\Http\Controllers\Dashboard;
+
+use App\Models\Role;
+use App\Models\Permission;
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Validator;
+use App\Http\Controllers\Controller;
+use App\Http\Requests\CreateRoleRequest;
+use Inertia\Inertia;
+use Inertia\Response;
+class RolesController extends Controller
+{
+    public function index(): Response
+    {
+         /**
+     * Shows the role page
+     * @return Response
+     */
+
+        return Inertia::render('Roles',
+            [
+                'roles' => []
+            ]
+        );
+    }
+    public function store(CreateRoleRequest $request)
+    {
+
+        // Create a new Role object and save it to the database
+        $role = new Role();
+        $role->name = $request->name;
+        $role->display_name = $request->display_name;
+        $role->description = $request->description;
+        $role->save();
+
+        // Return a success response with the new role object
+        return response()->json($role, 201);
+    }
+    public function getRoles()
+    {
+     // Get all roles from the database
+    //  $roles = Role::all();
+    $roles = Role::with('permissions')->get();
+     // Get the permissions associated with each role
+
+
+     // Embed the permissions into the roles
+
+//    foreach ($roles as $role) {
+//          $role->permissions = $role->permissions;
+//      }
+
+
+     // Return all roles as a JSON response
+     return response()->json($roles);
+    }
+}

app/Http/Requests/CreateRoleRequest.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace App\Http\Requests;
+
+use Illuminate\Foundation\Http\FormRequest;
+
+class CreateRoleRequest extends FormRequest
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     *
+     * @return bool
+     */
+    public function authorize()
+    {
+        return true;
+    }
+
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array<string, mixed>
+     */
+    public function rules()
+    {
+        return [
+            'name' => 'required|string',
+            'display_name' => 'required|string',
+            'description' => 'required|string',
+        ];
+    }
+}

config/laratrust_seeder.php

@@ -0,0 +1,141 @@
+<?php
+
+return [
+    /**
+     * Control if the seeder should create a user per role while seeding the data.
+     */
+    'create_users' => false,
+
+    /**
+     * Control if all the laratrust tables should be truncated before running the seeder.
+     */
+    'truncate_tables' => true,
+
+    'roles_structure' => [
+        'superadministrator' => [
+            'calendar' => 'c,r,u,d',
+            'flow-board' => 'c,r,u,d',
+            'patient' => 'c,r,u,d',
+            'fees' => 'c,r,u,d',
+            'inventory' => 'c,r,u,d',
+            'procedures' => 'c,r,u,d',
+            'administration' => 'c,r,u,d',
+            'reports' => 'c,r,u,d',
+            'misc' => 'c,r,u,d',
+            'popups' => 'c,r,u,d',
+            'qa-measures' => 'c,r,u,d',
+            'help' => 'c,r,u,d',
+        ],
+        'administrators' => [
+            'calendar' => 'c,r,u,d',
+            'flow-board' => 'c,r,u,d',
+            'patient' => 'c,r,u,d',
+            'fees' => 'c,r,u,d',
+            'inventory' => 'c,r,u,d',
+            'procedures' => 'c,r,u,d',
+            'administration' => 'c,r',
+            'reports' => 'c,r,u,d',
+            'misc' => 'c,r,u,d',
+            'popups' => 'c,r,u,d',
+            'qa-measures' => 'c,r,u,d',
+            'help' => 'r',
+        ],
+        'lh-user' => [
+            'calendar' => 'r',
+            'patient' => 'r',
+            'fees' => 'r',
+            'inventory' => 'r',
+            'procedures' => 'r',
+            'administration' => 'r',
+            'reports' => 'r',
+            'misc' => 'r',
+            'popups' => 'r',
+            'qa-measures' => 'r',
+            'help' => 'r',
+        ],
+        'accounting' => [
+            'Calendar' => 'r',
+            'patient' => 'r',
+            'fees' => 'c,r,u,d',
+            'inventory' => 'r',
+            'procedures' => 'r',
+            'administration' => 'r,u',
+            'reports' => 'c,r,u,d',
+            'misc' => 'r,u',
+            'popups' => 'r,u',
+            'qa-measures' => 'r,u',
+            'help' => 'r',
+        ],
+        'clinicians' => [
+            'calendar' => 'c,r,u,d',
+            'patient' => 'c,r,u,d',
+            'fees' => 'c,r,u,d',
+            'inventory' => 'r,u',
+            'procedures' => 'r,u',
+            'administration' => 'r,u',
+            'reports' => 'r,u',
+            'misc' => 'r,u',
+            'popups' => 'r,u',
+            'qa-measures' => 'r,u',
+            'help' => 'r',
+        ],
+        'emergency_login' => [
+            'calendar' => 'r',
+            'patient' => 'c,r,u,d',
+            'fees' => 'r',
+            'inventory' => 'r',
+            'procedures' => 'r',
+            'administration' => 'r',
+            'reports' => 'r',
+            'misc' => 'r',
+            'popups' => 'r',
+            'qa-measures' => 'r',
+            'help' => 'r',
+        ],
+        'front_office' => [
+            'calendar' => 'r,u',
+            'patient' => 'r,u',
+            'fees' => 'r,u',
+            'inventory' => 'r',
+            'procedures' => 'r',
+            'administration' => 'r',
+            'reports' => 'r',
+            'misc' => 'r',
+            'popups' => 'r',
+            'qa-measures' => 'r',
+            'help' => 'r',
+        ],
+        'physicians' => [
+            'calendar' => 'c,r,u,d',
+            'patient' => 'c,r,u,d',
+            'fees' => 'r,u',
+            'inventory' => 'r',
+            'procedures' => 'c,r,u,d',
+            'administration' => 'c,r',
+            'reports' => 'c,r,u,d',
+            'misc' => 'c,r,u,d',
+            'popups' => 'c,r,u,d',
+            'qa-measures' => 'c,r,u,d',
+            'help' => 'r',
+        ],
+        'super_student' => [
+            'calendar' => 'r,u',
+            'patient' => 'r,u',
+            'fees' => 'r',
+            'inventory' => 'r',
+            'procedures' => 'r,u',
+            'administration' => 'r,u',
+            'reports' => 'r,u',
+            'misc' => 'r,u',
+            'popups' => 'r,u',
+            'qa-measures' => 'r,u',
+            'help' => 'r',
+        ],
+    ],
+    'permissions_map' => [
+        'c' => 'create',
+        'r' => 'read',
+        'u' => 'update',
+        'd' => 'delete'
+    ]
+    ];

database/seeders/DatabaseSeeder.php

@@ -42,6 +42,7 @@ public function truncateAndSeedData()
             DB::table($name)->truncate();
         }
         Schema::enableForeignKeyConstraints();
+
         $this->seedData();
         $this->complete();
     }
@@ -58,8 +59,10 @@ public function seedData()
         if (count($continents) < 1) {
             Artisan::call('world:init');
         }
+
         $this->call(CurrencySeeder::class);
         $this->call(UserTableSeeder::class);
+        $this->call(LaratrustSeeder::class);
         $this->call(AddressTableSeeder::class);
         $this->call(ContactTableSeeder::class);
         $this->call(FacilityTableSeeder::class);

database/seeders/LaratrustSeeder.php

@@ -0,0 +1,103 @@
+<?php
+
+namespace Database\Seeders;
+
+use Illuminate\Support\Facades\Schema;
+use Illuminate\Database\Seeder;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Config;
+
+class LaratrustSeeder extends Seeder
+{
+    /**
+     * Run the database seeds.
+     *
+     * @return void
+     */
+    public function run()
+    {
+        $this->truncateLaratrustTables();
+
+        $config = Config::get('laratrust_seeder.roles_structure');
+
+        if ($config === null) {
+            $this->command->error("The configuration has not been published. Did you run `php artisan vendor:publish --tag=\"laratrust-seeder\"`");
+            $this->command->line('');
+            return false;
+        }
+
+        $mapPermission = collect(config('laratrust_seeder.permissions_map'));
+
+        foreach ($config as $key => $modules) {
+
+            // Create a new role
+            $role = \App\Models\Role::firstOrCreate([
+                'name' => $key,
+                'display_name' => ucwords(str_replace('_', ' ', $key)),
+                'description' => ucwords(str_replace('_', ' ', $key))
+            ]);
+            $permissions = [];
+
+            $this->command->info('Creating Role '. strtoupper($key));
+
+            // Reading role permission modules
+            foreach ($modules as $module => $value) {
+
+                foreach (explode(',', $value) as $p => $perm) {
+
+                    $permissionValue = $mapPermission->get($perm);
+
+                    $permissions[] = \App\Models\Permission::firstOrCreate([
+                        'name' => $module . '-' . $permissionValue,
+                        'display_name' => ucfirst($permissionValue) . ' ' . ucfirst($module),
+                        'description' => ucfirst($permissionValue) . ' ' . ucfirst($module),
+                    ])->id;
+
+                    $this->command->info('Creating Permission to '.$permissionValue.' for '. $module);
+                }
+            }
+
+            // Attach all permissions to the role
+            $role->permissions()->sync($permissions);
+
+            if (Config::get('laratrust_seeder.create_users')) {
+                $this->command->info("Creating '{$key}' user");
+                // Create default user for each role
+                $user = \App\Models\User::create([
+                    'name' => ucwords(str_replace('_', ' ', $key)),
+                    'email' => $key.'@app.com',
+                    'password' => bcrypt('password')
+                ]);
+                $user->attachRole($role);
+            }
+
+        }
+    }
+
+    /**
+     * Truncates all the laratrust tables and the users table
+     *
+     * @return  void
+     */
+    public function truncateLaratrustTables()
+    {
+        $this->command->info('Truncating User, Role and Permission tables');
+        Schema::disableForeignKeyConstraints();
+
+        DB::table('permission_role')->truncate();
+        DB::table('permission_user')->truncate();
+        DB::table('role_user')->truncate();
+
+        if (Config::get('laratrust_seeder.truncate_tables')) {
+            DB::table('roles')->truncate();
+            DB::table('permissions')->truncate();
+
+            if (Config::get('laratrust_seeder.create_users')) {
+                $usersTable = (new \App\Models\User)->getTable();
+                DB::table($usersTable)->truncate();
+            }
+        }
+
+        Schema::enableForeignKeyConstraints();
+    }
+}