V704-034: Limit number of logs in $ALS_HOME/.als

Add logThreshold property to limit the number of logs.

Author: AdrienBoulanger

source/ada/lsp-ada_driver.adb

@@ -175,6 +175,7 @@ procedure LSP.Ada_Driver is
                      (VSS.Standard_Paths.Home_Location)
               else ALS_Home)));
    ALS_Dir                : constant Virtual_File := Home_Dir / ".als";
+   Clean_ALS_Dir          : Boolean := False;
    GNATdebug              : constant Virtual_File := Create_From_Base
      (".gnatdebug");
 
@@ -248,6 +249,8 @@ begin
       Parse_Config_File (GNATdebug);
 
    elsif ALS_Dir.Is_Directory then
+      Clean_ALS_Dir := True;
+
       --  Search for custom traces config in traces.cfg
       Parse_Config_File (+Virtual_File'(ALS_Dir / "traces.cfg").Full_Name);
 
@@ -346,6 +349,9 @@ begin
    end if;
 
    Server.Finalize;
+   if Clean_ALS_Dir then
+      Ada_Handler.Clean_Logs (ALS_Dir);
+   end if;
    Ada_Handler.Cleanup;
 
    --  Clean secondary stack up

source/ada/lsp-ada_handlers.adb

@@ -531,6 +531,30 @@ package body LSP.Ada_Handlers is
       LSP.File_Monitors.Unchecked_Free (Self.File_Monitor);
    end Cleanup;
 
+   ----------------
+   -- Clean_Logs --
+   ----------------
+
+   procedure Clean_Logs (Self : access Message_Handler; Dir : Virtual_File) is
+      Files : File_Array_Access := Read_Dir (Dir, Files_Only);
+      Dummy : Boolean;
+      Cpt   : Integer := 0;
+   begin
+      Sort (Files.all);
+      --  Browse the log files in reverse timestamp order
+      for F of reverse Files.all loop
+         --  Filter out files like traces.cfg
+         if GNATCOLL.Utils.Ends_With (+F.Base_Name, ".log") then
+            Cpt := Cpt + 1;
+            --  Delete the old logs
+            if Cpt > Self.Log_Threshold then
+               Delete (F, Dummy);
+            end if;
+         end if;
+      end loop;
+      Unchecked_Free (Files);
+   end Clean_Logs;
+
    -----------------------
    -- Exit_Notification --
    -----------------------
@@ -4092,6 +4116,8 @@ package body LSP.Ada_Handlers is
         "documentationStyle";
       useCompletionSnippets             : constant String :=
         "useCompletionSnippets";
+      logThreshold                      : constant String :=
+        "logThreshold";
 
       Ada       : constant LSP.Types.LSP_Any := Value.settings.Get ("ada");
       File      : VSS.Strings.Virtual_String;
@@ -4170,6 +4196,10 @@ package body LSP.Ada_Handlers is
             Self.Named_Notation_Threshold := Ada.Get (namedNotationThreshold);
          end if;
 
+         if Ada.Has_Field (logThreshold) then
+            Self.Log_Threshold := Ada.Get (logThreshold);
+         end if;
+
          --  Check the 'useCompletionSnippets' flag to see if we should use
          --  snippets in completion (if the client supports it).
          if not Self.Completion_Snippets_Enabled then

source/ada/lsp-ada_handlers.ads

@@ -64,6 +64,9 @@ package LSP.Ada_Handlers is
    procedure Cleanup (Self : access Message_Handler);
    --  Free memory referenced by Self
 
+   procedure Clean_Logs (Self : access Message_Handler; Dir : Virtual_File);
+   --  Remove the oldest logs in Dir
+
    subtype Context_Access is LSP.Ada_Context_Sets.Context_Access;
 
    function From_File
@@ -332,6 +335,10 @@ private
       File_Monitor    : LSP.File_Monitors.File_Monitor_Access;
       --  Filesystem monitoring
 
+      Log_Threshold : Natural := 10;
+      --  Maximum number of logs (should be > to the number of servers run
+      --  simultaneously)
+
       ---------------------------------------
       --  Experimental Client Capabilities --
       ---------------------------------------