Print module refactor

.env.ci

@@ -7,3 +7,4 @@ DB_PORT=3306
 DB_DATABASE=test
 DB_USERNAME=root
 DB_PASSWORD=password
+PRINTER_NAME=printer

.env.example

@@ -71,9 +71,11 @@ PREVENT_ACCESSING_MISSING_ATTRIBUTES=false
 
 PRINT_COST_ONESIDED=8
 PRINT_COST_TWOSIDED=12
+
+#Data used during migration in 2023_12_25_182310_create_printers_table.php to create a new printer
 PRINTER_NAME=NemUjBela
-PRINTER_ADDITIONAL_ARGS=
-PRINTER_STAT_ADDITIONAL_ARGS=
+PRINTER_IP=
+PRINTER_PORT=
 
 NETREG=1000
 KKT=2000
@@ -88,6 +90,7 @@ CANCEL_COMMAND=cancel
 PDFINFO_COMMAND=pdfinfo
 PING_COMMAND=ping
 PDFLATEX_COMMAND=/usr/bin/pdflatex
+RUN_COMMANDS_IN_DEBUG_MODE=false
 
 WORKSHOP_BALANCE_EXTERN=0.45
 WORKSHOP_BALANCE_RESIDENT=0.6

app/Console/Commands.php

@@ -2,6 +2,7 @@
 
 namespace App\Console;
 
+use App\Utils\Process;
 use Illuminate\Support\Facades\Log;
 
 /**
@@ -10,84 +11,23 @@
  */
 class Commands
 {
-    private static function isDebugMode()
-    {
-        return config('app.debug');
-    }
-
-    public static function getCompletedPrintingJobs()
-    {
-        $command = config('commands.lpstat') . " " . config('print.stat_additional_args') . " -W completed -o " . config('print.printer_name') . " | awk '{print $1}'";
-        if (self::isDebugMode()) {
-            $result = [0];
-        } else {
-            $result = [];
-            exec($command, $result);
-        }
-        Log::info([$command, $result]);
-        return $result;
-    }
-
-    public static function print($command)
-    {
-        if (self::isDebugMode()) {
-            $job_id = 0;
-            $result = "request id is " . config('print.printer_name') . "-" . $job_id . " (1 file(s))";
-        } else {
-            $result = exec($command);
-        }
-        Log::info([$command, $result]);
-        return $result;
-    }
-
-    public static function cancelPrintJob(string $jobID)
-    {
-        $command = config('commands.cancel') . " " . $jobID;
-        if (self::isDebugMode()) {
-            // cancel(1) exits with status code 0 if it succeeds
-            $result = ['output' => '', 'exit_code' => 0];
-        } else {
-            $output = exec($command, $result, $exit_code);
-            $result = ['output' => $output, 'exit_code' => $exit_code];
-        }
-        Log::info([$command, $result]);
-        return $result;
-    }
-
-    public static function getPages($path)
-    {
-        $command = config('commands.pdfinfo') . " " . $path . " | grep '^Pages' | awk '{print $2}' 2>&1";
-        if (self::isDebugMode()) {
-            $result = rand(1, 10);
-        } else {
-            $result = exec($command);
-        }
-        Log::info([$command, $result]);
-        return $result;
-    }
-
     public static function pingRouter($router)
     {
-        if (self::isDebugMode()) {
-            $result = rand(1, 10) > 9 ? "error" : '';
-        } else {
-            // This happens too often to log.
-            $command = config('commands.ping') . " " . $router->ip . " -c 1 | grep 'error\|unreachable'";
-            $result = exec($command);
+        if (!filter_var($router->ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4)) {
+            throw new \InvalidArgumentException("Invalid IP address: " . $router->ip);
         }
+
+        $process = Process::fromShellCommandline(config('commands.ping') . " $router->ip -c 1 | grep 'error\|unreachable'");
+        $process->run($log = false);
+        $result = $process->getOutput(debugOutput: rand(1, 10) > 9 ? "error" : '');
         return $result;
     }
 
     public static function latexToPdf($path, $outputDir)
     {
-        if (self::isDebugMode()) {
-            $result = "ok";
-        } else {
-            $command = config('commands.pdflatex') . " " . "-interaction=nonstopmode -output-dir " . $outputDir . " " . $path . " 2>&1";
-            Log::info($command);
-            $result = exec($command);
-            Log::info($result);
-        }
+        $process = new Process([config('commands.pdflatex'), '-interaction=nonstopmode', '-output-dir', $outputDir, $path]);
+        $process->run();
+        $result = $process->getOutput(debugOutput: 'ok');
         return $result;
     }
 }

app/Enums/PrintJobStatus.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace App\Enums;
+
+enum PrintJobStatus: string {
+    case QUEUED = 'QUEUED';
+    //case ERROR = 'ERROR'; //There are some older print jobs that have this status, but it is not used anymore
+    case CANCELLED = 'CANCELLED';
+    case SUCCESS = 'SUCCESS';
+    // case REIMBURSED = 'REIMBURSED';
+}

app/Enums/PrinterCancelResult.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App\Enums;
+
+enum PrinterCancelResult: string {
+    case AlreadyCancelled = "already-cancelled";
+    case AlreadyCompleted = "already-completed";
+    case CannotCancel = "cannot-cancel";
+    case Success = "successfully-cancelled";
+}

app/Http/Controllers/Auth/RegisterController.php

@@ -112,8 +112,6 @@ public function create(array $data)
                 'password' => Hash::make($data['password']),
             ]);
 
-            $user->roles()->attach(Role::get(Role::PRINTER)->id);
-
             if ($data['user_type'] == Role::TENANT) {
                 $user->roles()->attach(Role::get(Role::TENANT));
                 $user->personalInformation()->create([