ADD: Rest CMD to shutdown

Author: PascalCorpsman

src/CopyCommander2.lpi

@@ -152,7 +152,7 @@
     </Linking>
   </CompilerOptions>
   <Debugging>
-    <Exceptions Count="3">
+    <Exceptions Count="4">
       <Item1>
         <Name Value="EAbort"/>
       </Item1>
@@ -162,6 +162,9 @@
       <Item3>
         <Name Value="EFOpenError"/>
       </Item3>
+      <Item4>
+        <Name Value="Exception"/>
+      </Item4>
     </Exceptions>
   </Debugging>
 </CONFIG>

src/rest.md

@@ -17,6 +17,7 @@ Zombie paths are used to control the application (visible to the user), to enabl
 | --- | --- | --- | --- |
 | GET | [/API/status](#get-apistatus) | normal | get current state of application
 | GET | [/API/view/list](#get-apiviewlist) | normal | get list of content from a spezific view
+| POST | [/API/shutdown](#post-apishutdown) | normal | shutdown CopyCommander2
 | POST | [/API/zombie/setdir](#post-apizombiesetdir) | zombie | set directory path for left or right view
 
 ## GET /API/status
@@ -183,6 +184,36 @@ Creates a new job to copy, move, or delete files/folders.
 }
 ```
 
+## POST /API/shutdown
+
+Shuts down the CopyCommander2 application.
+
+### Request
+
+**Method:** POST  
+**Path:** `/API/shutdown`  
+**Content-Type:** `application/json`
+
+### Request Schema
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| `skipJobs` | boolean | No | Whether to skip currently running jobs (default: false) |
+
+### Example Request
+
+```json
+{
+    "skipJobs": true
+}
+```
+
+### Response
+
+**HTTP Status Codes:**
+- `200 OK` - Application shutdown initiated successfully
+- `403 Forbidden` - Shutdown not allowed (jobs are running and skipJobs is false)
+  
 ## POST /API/zombie/setdir
 
 Sets the directory path for either the left or right view.

src/unit1.pas

@@ -299,6 +299,7 @@
   public
     fWorkThread: TWorkThread; // Bäh wieder Private machen !
     fLeftView, fRightView: TView; // Bäh wieder Private machen !
+    fShutdownbyRestRequest: Boolean;
     Procedure LoadDir(Dir: String; Var View: TView; ForceElementBufferRefresh: Boolean = false);
     Procedure AddToJobQueue(Const Job: TJob); //Fügt non LCL Blocking in die JobQueue ein
   End;
@@ -636,7 +637,7 @@
   startup := true;
   fJobFifo := TJobFifo.create;
   GetElementCountBuffer := Nil;
-
+  fShutdownbyRestRequest := false;
   CheckAndMaybeEnableRestAPI;
 End;
 
@@ -688,6 +689,9 @@
 End;
 
 Procedure TForm1.ApplicationProperties1Idle(Sender: TObject; Var Done: Boolean);
+Const
+  CloseTimer: QWord = 0;
+  CloseTimeout = 250; // Das Verzögert das automatische beenden, in der Hoffnung, dass die ggf. noch Ausstehende Antwort auf jeden Fall raus geht.
 Var
   j: TJob;
 Begin
@@ -739,6 +743,17 @@
     End;
     HandleJobQueue();
   End;
+  If fShutdownbyRestRequest Then Begin
+    // TODO: Prüfen ob gerade noch was gesendet wird (kann die LTPComponente dass ?)
+    If CloseTimer = 0 Then Begin
+      CloseTimer := GetTickCount64;
+    End
+    Else Begin
+      If GetTickCount64 > CloseTimer + CloseTimeout Then Begin
+        close;
+      End;
+    End;
+  End;
   sleep(1);
 End;
 

src/urest.pas

@@ -1,7 +1,7 @@
 (******************************************************************************)
 (* uRest.pas                                                       11.08.2025 *)
 (*                                                                            *)
-(* Version     : 0.04                                                         *)
+(* Version     : 0.05                                                         *)
 (*                                                                            *)
 (* Author      : Uwe Schächterle (Corpsman)                                   *)
 (*                                                                            *)
@@ -26,6 +26,7 @@
 (*               0.02 - Initial version (client)                              *)
 (*               0.03 - ADD HTTPHeader to getHandler                          *)
 (*               0.04 - support more detailed post results                    *)
+(*               0.05 - support post with no params                           *)
 (*                                                                            *)
 (******************************************************************************)
 
@@ -674,16 +675,15 @@
     j := Nil;
     Try
       j := jp.Parse(Body.Text);
-      If Not assigned(j) Then Raise exception.create('Blub'); // Wir wollen einfach in den Fehlerhandler ;)
     Except
       // Fehler Anfrage nicht Parsbar
       SendResponce(
         400, '{"error":' + StringToJsonString('Post ' + Path + ' without valid data') + '}',
         aSocket
         );
+      exit;
     End;
     jp.Free;
-    If Not assigned(j) Then exit;
   End;
   // Suchen eines Passenden Handlers für den Pfad
   For i := 0 To high(fPostPaths) Do Begin
@@ -696,11 +696,11 @@
       Else Begin
         SendResponce(PostRes.HTTPCode, '', aSocket);
       End;
-      j.free;
+      If assigned(j) Then j.free;
       exit;
     End;
   End;
-  j.free;
+  If assigned(j) Then j.free;
   // Fehler kein Handler definiert
   SendResponce(
     501,

src/urestapi.pas

@@ -60,6 +60,7 @@
      * Alle Post Methoden
      *)
     Function Setdir(Sender: TObject; Const aPath: String; Const aContent: TJSONObj): TPostResult;
+    Function Shutdown(Sender: TObject; Const aPath: String; Const aContent: TJSONObj): TPostResult;
     Function Job(Sender: TObject; Const aPath: String; Const aContent: TJSONObj): TPostResult;
   public
     Constructor Create; virtual;
@@ -118,6 +119,7 @@
   fServer.RegisterGetHandler('/api/status', @GetStatus);
   fServer.RegisterGetHandler('/api/view/list', @GetViewList);
   fServer.RegisterPostHandler('/api/job', @Job);
+  fServer.RegisterPostHandler('/api/shutdown', @Shutdown);
 
   If ZombieMode Then Begin
     fServer.RegisterPostHandler('/api/zombie/setdir', @Setdir);
@@ -245,6 +247,38 @@
   End;
 End;
 
+Function TRestAPIDummy.Shutdown(Sender: TObject; Const aPath: String;
+  Const aContent: TJSONObj): TPostResult;
+Var
+  jv: TJSONValue;
+  SkipJobs: Boolean;
+Begin
+  SkipJobs := false;
+  result.HTTPCode := 400;
+  result.Content := Nil;
+  If assigned(aContent) Then Begin
+    Try
+      jv := aContent.FindPath('skipJobs') As TJSONValue;
+      If assigned(jv) Then Begin
+        SkipJobs := lowercase(trim(jv.Value)) = 'true';
+      End;
+    Except
+      exit;
+    End;
+  End;
+  If (Not SkipJobs) And form1.fWorkThread.Busy Then Begin
+    result.HTTPCode := 403;
+    result.Content := TextNode('status', 'pending jobs, no permission to skip jobs.');
+    exit;
+  End
+  Else Begin
+    result.HTTPCode := 200;
+    result.Content := TextNode('status', 'ok');
+  End;
+  // Set Flag "Shutdown"
+  Form1.fShutdownbyRestRequest := true;
+End;
+
 Function TRestAPIDummy.Job(Sender: TObject; Const aPath: String;
   Const aContent: TJSONObj): TPostResult;