Code Update

* Removed the History tag in readme files
* fixed and activated the filezip and fileunzip programs
* Fixed a crash in file management when running ls (program was trying to hash a directory)
* create a _userhomedirectory variable to store the default user home directory
* Updated BuildSigner to be more verbose and output to be more readable

Author: DAK404

Source/Cataphract/API/Astaroth/Readme.txt

@@ -23,26 +23,6 @@ Author: DAK404 (https://github.com/DAK404)
 This Package provides utilities to handle date/time efficiently. Can also print a calendar,
 helpful for users and scripting.
 
-
--[ HISTORY ]-
-
-While working on Truncheon (then called Lamashtu before being cancelled and reworked),
-date/time handling became essential since the program would write log files. Additionally,
-for scripting, end users could not print the date and time information. At that point of
-time, WraithEdit.java handled the logging and used the java.util.Date class.
-
-This created a problem.
-
-For example, let us consider 3 classes: A, B and C.
-
-If class A uses java.util.Date, class B uses java.time.LocalDateTime and class C uses a 3rd
-party library or java.text.date to implement the same features, the memory usage would be
-very high due to the number of classes loaded into the memory for runtime.
-
-Current implementation has solved this issue by providing a single class that shall return
-the date/time information.
-
-
 -[ DETAILS ]-
 
 The following classes are implemented in Astaroth Package:

Source/Cataphract/API/Dragon/Readme.txt

@@ -23,45 +23,6 @@ Author: DAK404 (https://github.com/DAK404)
 This Package provides utilities to create, manage and delete user accounts. Also provides a
 class for authenticating user credentials.
 
-
--[ HISTORY ]-
-
-While working on Zen Quantum, it was essential to have a class that handled authentication.
-Therefore a new package called "Anima" was created. Anima was aimed to contain all user
-account management utilities. The following functions were implemented:
-
-    * AddUser.java
-    * CreateDB.java
-    * LoginAPI.java
-
-AddUser.java -> Contained code to add a user to the database. The code was non-modular and
-did not effectively handle invalid credentials.
-
-CreateDB.java -> Contained code to create a database file, a table to hold the user details.
-CreateDB was called by the setup program.
-
-LoginAPI.java -> Contained code to handle credential authentication. It was inefficient
-since it required 3 variables to check the validity of the credentials.
-
-In Mosaic, UpdateCredentials.java was introduced. It was aimed to update the user
-credentials. Again, the code was non-modular, which made it very difficult to work on,
-although it provided the required functionality of updating credentials.
-
-In Truncheon, package was renamed to Dragon. The class was renamed to ModifyAccount.java.
-With the privilege system in place, it was now necessary to check for the privilege to
-promote or demote users. There was no dedicated method that would return the privilege of
-the user, therefore, it had to be manually queried and then stored in a variable. It is also
-notable that DeleteAccount.java was created which helped in deleting accounts. With the
-privilege system, an administrator could now delete other user accounts.
-
-In Truncheon: Katana, the LoginAPI, now renamed to LoginAuth.java, had an option to query
-and return privileges therefore it was easier to implement features without rewriting the
-logic to query and acquire the privilege value from the database.
-
-Currently, the class is named as Login.java for a better nomenclature. It is also modular,
-therefore the code is easier to read and develop upon.
-
-
 -[ DETAILS ]-
 
 The classes currently implemented in this package are:

Source/Cataphract/API/Wraith/Archive/FileUnzip.java

@@ -1,28 +1,11 @@
-/*
-*                                                      |
-*                                                     ||
-*  |||||| ||||||||| |||||||| ||||||||| |||||||  |||  ||| ||||||| |||||||||  |||||| ||||||||
-* |||            ||    |||          ||       || |||  |||       ||       || |||        |||
-* |||      ||||||||    |||    ||||||||  ||||||  ||||||||  ||||||  |||||||| |||        |||
-* |||      |||  |||    |||    |||  |||  |||     |||  |||  ||  ||  |||  ||| |||        |||
-*  ||||||  |||  |||    |||    |||  |||  |||     |||  |||  ||   || |||  |||  ||||||    |||
-*                                               ||
-*                                               |
-*
-* A Cross Platform OS Shell
-* Powered By Truncheon Core
-*/
-
 package Cataphract.API.Wraith.Archive;
 
-import java.io.FileInputStream; 
+import java.io.FileInputStream;
 import java.io.FileNotFoundException;
 import java.io.FileOutputStream;
-
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
-
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipInputStream;
 
@@ -32,67 +15,70 @@
 import Cataphract.API.Wraith.FileWrite;
 
 /**
-* A utility class for unzipping files.
-*
-* @author DAK404 (https://github.com/DAK404)
-* @version 1.0.0 (11-October-2023, Cataphract)
-* @since 0.0.1 (Cataphract 0.0.1)
-*/
+ * A utility class for unzipping files.
+ * 
+ * @author DAK404 (https://github.com/DAK404)
+ * @version 1.0.0 (11-October-2023, Cataphract)
+ * @since 0.0.1 (Cataphract 0.0.1)
+ */
 public class FileUnzip
 {
     /** Store value of user privileges. */
-    private boolean isUserAdmin = false;
+    private boolean _isUserAdmin = false;
 
-    /** Store value of the update mode; True if program is updating, False if program is not*/
+    /** Store value of the update mode; True if program is updating, False if program is not */
     private boolean updateMode = false;
 
     /**
-    * Constructor to check if the current user is an administrator or not.
-    *
-    * @param username The currently logged in username.
-    * @throws Exception Throws any exceptions encountered during runtime.
-    */
-    public FileUnzip(String username)throws Exception
+     * Constructor to check if the current user is an administrator or not.
+     * 
+     * @param username The currently logged in username.
+     * @throws Exception Throws any exceptions encountered during runtime.
+     */
+    public FileUnzip(String username) throws Exception
     {
-        isUserAdmin = new Login(username).checkPrivilegeLogic();
+        _isUserAdmin = new Login(username).checkPrivilegeLogic();
     }
 
     /**
-    * Unzips a user file in the specified destination directory
-    *
-    * @param fileName Name of the file to be unzipped.
-    * @param unzipDestination Destination for the file to be unzipped in.
-    * @throws Exception Throws any exceptions encountered during runtime.
-    */
-    public void unzip(String fileName, String unzipDestination)throws Exception
+     * Unzips a user file in the specified destination directory
+     * 
+     * @param fileName          Name of the file to be unzipped.
+     * @param unzipDestination  Destination for the file to be unzipped in.
+     * @throws Exception Throws any exceptions encountered during runtime.
+     */
+    public void unzip(String fileName, String unzipDestination) throws Exception
     {
+        fileName = IOStreams.convertFileSeparator(fileName);
+        unzipDestination = IOStreams.convertFileSeparator(unzipDestination);
         // Check the policy if file unzip is allowed in the policy file, can be bypassed by the accounts with administrator privileges
-        if(new PolicyCheck().retrievePolicyValue("filemgmt").equals("on") || isUserAdmin)
-        unzipLogic(fileName, unzipDestination);
+        if (new PolicyCheck().retrievePolicyValue("filemgmt").equals("on") || _isUserAdmin)
+            unzipLogic(fileName, unzipDestination);
         else
-        IOStreams.printError("Policy Management System - Permission Denied.");
+            IOStreams.printError("Policy Management System - Permission Denied.");
     }
 
     /**
-    * Installs an update by unzipping the "Update.zip" file.
-    *
-    * @throws Exception Throws any exceptions encountered during runtime.
-    */
-    public void installUpdate()throws Exception
+     * Installs an update by unzipping the "Update.zip" file.
+     * 
+     * @throws Exception Throws any exceptions encountered during runtime.
+     */
+    public void installUpdate() throws Exception
     {
         updateMode = true;
-        if(new PolicyCheck().retrievePolicyValue("update").equals("on") || isUserAdmin)
-        unzipLogic("./Update.zip", "./");
+        if (new PolicyCheck().retrievePolicyValue("update").equals("on") || _isUserAdmin)
+            unzipLogic(IOStreams.convertFileSeparator(".|Update.zip"), IOStreams.convertFileSeparator(".|"));
         else
-        IOStreams.printError("Policy Management System - Permission Denied.");
+            IOStreams.printError("Policy Management System - Permission Denied.");
+        updateMode = false;
     }
 
     /**
-    * Unzips a given zip file into the specified output directory.
-    *
-    * @param zipFilePath Path to the zip file.
-    * @param outputDirectory Directory where the unzipped files will be placed.
-    */
+     * Unzips a given zip file into the specified output directory.
+     * 
+     * @param zipFilePath       Path to the zip file.
+     * @param outputDirectory   Directory where the unzipped files will be placed.
+     */
     private void unzipLogic(String zipFilePath, String outputDirectory)
     {
         try
@@ -121,8 +107,8 @@ private void unzipLogic(String zipFilePath, String outputDirectory)
                         // Create directories for file entries and write the file content
                         Files.createDirectories(entryPath.getParent());
                         try
-                        {   
-                            if(updateMode)
+                        {
+                            if (updateMode)
                             {
                                 IOStreams.printInfo("Installing File: " + entryName);
                                 FileWrite.logger("Installing: " + entryName, "Update");
@@ -132,18 +118,20 @@ private void unzipLogic(String zipFilePath, String outputDirectory)
                             int bytesRead;
 
                             while ((bytesRead = zipIn.read(buffer)) != -1)
-                            fos.write(buffer, 0, bytesRead);
+                            {
+                                fos.write(buffer, 0, bytesRead);
+                            }
+                            fos.close(); // Close the FileOutputStream here
                         }
-                        catch(Exception e)
+                        catch (Exception e)
                         {
                             IOStreams.printError("File Error: " + entryName);
                         }
                     }
                 }
                 zipIn.closeEntry();
-                fos.close();
-            }   
-            catch(Exception e)
+            }
+            catch (Exception e)
             {
                 IOStreams.println("Error: " + e);
                 e.printStackTrace();

Source/Cataphract/API/Wraith/Archive/FileZip.java

@@ -37,7 +37,10 @@
 public class FileZip
 {
     /** Store value of user privileges. */
-    private boolean isUserAdmin = false;
+    private boolean _isUserAdmin = false;
+
+    /** Store the username of the current user */
+    private String _username = "";
 
     /**
     * Constructor to check if the current user is an administrator or not.
@@ -47,7 +50,8 @@ public class FileZip
     */
     public FileZip(String username)throws Exception
     {
-        isUserAdmin = new Login(username).checkPrivilegeLogic();
+        _username = username;
+        _isUserAdmin = new Login(username).checkPrivilegeLogic();
     }
 
     /**
@@ -59,11 +63,12 @@ public FileZip(String username)throws Exception
     */
     public void zipFile(String zipFileName, String directoryToCompress) throws Exception
     {
+        directoryToCompress = IOStreams.convertFileSeparator(directoryToCompress);
         // Check the policy if file zipping is allowed in the policy file, can be bypassed by the accounts with administrator privileges
-        if(new PolicyCheck().retrievePolicyValue("filemgmt").equals("on") || isUserAdmin)
+        if(new PolicyCheck().retrievePolicyValue("filemgmt").equals("on") || _isUserAdmin)
         {
             // Create a FileOutputStream for the zip file
-            FileOutputStream fos = new FileOutputStream(zipFileName);
+            FileOutputStream fos = new FileOutputStream(IOStreams.convertFileSeparator(".|Users|Cataphract|" + _username + "|") + zipFileName);
             // Create a ZipOutputStream using the FileOutputStream
             ZipOutputStream zipOut = new ZipOutputStream(fos);
 
@@ -95,18 +100,18 @@ private void zipFileLogic(File fileToZip, String fileName, ZipOutputStream zipOu
             if (fileToZip.isDirectory())
             {
                 // If it's a directory, create a zip entry for it
-                if (fileName.endsWith("/"))
+                if (fileName.endsWith(File.separator))
                 zipOut.putNextEntry(new ZipEntry(fileName));
                 else
-                zipOut.putNextEntry(new ZipEntry(fileName + "/"));
+                zipOut.putNextEntry(new ZipEntry(fileName + File.separator));
 
                 // Get the list of children files and recursively zip them
                 File[] children = fileToZip.listFiles();
                 if (children != null)
                 {
                     for (File childFile : children)
                     {
-                        zipFileLogic(childFile, fileName + "/" + childFile.getName(), zipOut);
+                        zipFileLogic(childFile, fileName + File.separator + childFile.getName(), zipOut);
                     }
                 }
             }

Source/Cataphract/API/Wraith/FileManagement.java

@@ -28,6 +28,8 @@
 import Cataphract.API.Dragon.Login;
 import Cataphract.API.Minotaur.Cryptography;
 import Cataphract.API.Minotaur.PolicyCheck;
+import Cataphract.API.Wraith.Archive.FileZip;
+import Cataphract.API.Wraith.Archive.FileUnzip;
 
 /**
 * A utility class for file management.
@@ -44,6 +46,8 @@ public class FileManagement
     private String _name = "";
     /** Store the present working directory during file management */
     private String _presentWorkingDirectory = "";
+    /** Store the default user home directory */
+    private String _userHomeDirectory = "";
 
     /** Instantiate Console to get user inputs. */
     private Console console = System.console();
@@ -61,7 +65,8 @@ public FileManagement(String username)throws Exception
         // Set the name of the user to the global variable
         _name = new Login(username).getNameLogic();
         // Initialize the present working directory
-        _presentWorkingDirectory = ".|Users|Cataphract|" + _username + "|";
+        _userHomeDirectory = ".|Users|Cataphract|" + _username + "|";
+        _presentWorkingDirectory = _userHomeDirectory;
     }
 
     /*****************************************
@@ -220,7 +225,7 @@ private final void navPreviousDirectory()throws Exception
      */
     private final void resetToHomeDirectory()
     {
-        _presentWorkingDirectory = ".|Users|Cataphract|" + _username + '|'  ;
+        _presentWorkingDirectory = _userHomeDirectory;
     }
 
     /**
@@ -231,7 +236,7 @@ private final void resetToHomeDirectory()
      */
     private final void makeDirectory(String fileName) throws Exception
     {
-        new File(_presentWorkingDirectory + fileName).mkdirs();
+        new File(IOStreams.convertFileSeparator(_presentWorkingDirectory) + fileName).mkdirs();
     }
 
     /**
@@ -340,7 +345,7 @@ private final void listEntities() throws Exception
             for (File file : dPath.listFiles())
             {
                 // Format and print the file or directory information
-                System.out.format(format, file.getName().replace(_username, _name), file.length() / 1024 + " KB", file.isDirectory() ? "Directory" : "File", Cryptography.fileToMD5(file));
+                System.out.format(format, file.getName().replace(_username, _name), file.length() / 1024 + " KB", file.isDirectory() ? "Directory" : "File", file.isDirectory() ? "" : Cryptography.fileToMD5(file));
             }
             // Print a newline for better formatting
             System.out.println();
@@ -401,7 +406,6 @@ public void fileManagementLogic()throws Exception
             // Check if the user is logged in
             if (login())
             {
-                System.out.println(IOStreams.convertToNionSeparator(IOStreams.convertFileSeparator(_presentWorkingDirectory)));
                 String inputValue = "";
                 // Loop to continuously read and execute commands until 'exit' is entered
                 do
@@ -604,6 +608,22 @@ private void grinchInterpreter(String command)throws Exception
                 // Exit the interpreter
             break;
 
+            case "zip":
+                // Check if the command has the correct number of arguments
+                if (commandArray.length < 3)
+                    IOStreams.printError("Invalid Syntax.");
+                else
+                    new FileZip(_username).zipFile(commandArray[1], _presentWorkingDirectory + commandArray[2]);
+            break;
+
+            case "unzip":
+                    // Check if the command has the correct number of arguments
+                    if (commandArray.length < 3)
+                    IOStreams.printError("Invalid Syntax.");
+                else
+                    new FileUnzip(_username).unzip(_presentWorkingDirectory + commandArray[1], _presentWorkingDirectory + commandArray[2]);
+            break;
+
             default:
                 // Pass the command to the Anvil interpreter for further processing
                 Anvil.anvilInterpreter(commandArray);