Merge pull request #143 from Schlaumeier5/136-improve-command-line-interface

Improved the command line interface

Author: Schlaumeier5

build.gradle.kts

@@ -19,6 +19,7 @@ dependencies {
     implementation("com.google.code.gson:gson:2.13.1")
     implementation("commons-codec:commons-codec:1.19.0")
     implementation("com.googlecode.owasp-java-html-sanitizer:owasp-java-html-sanitizer:20240325.1")
+    implementation("org.jline:jline:3.30.6") // for better console input handling
 
     testImplementation("org.junit.jupiter:junit-jupiter:5.10.0") // using JUnit 5 (latest)
 }

src/main/java/de/igslandstuhl/database/Application.java

@@ -92,6 +92,12 @@ public Topic[] readFile(String file) throws SerializationException, SQLException
 
     public static void main(String[] args) throws Exception {
         instance = new Application(args);
+        
+        if (!getInstance().suppressCmd()) {
+            Command.registerCommands();
+            CommandLineUtils.setup();
+        }
+        
         Server.getInstance().getConnection().createTables();
 
         Holiday.setupCurrentSchoolYear();
@@ -100,10 +106,6 @@ public static void main(String[] args) throws Exception {
         if (getInstance().runsWebServer()) {
             Server.getInstance().getWebServer().start();
         }
-        if (!getInstance().suppressCmd()) {
-            Command.registerCommands();
-            CommandLineUtils.setup();
-        }
 
         while (true) {
             if (!getInstance().suppressCmd()) {

src/main/java/de/igslandstuhl/database/Registry.java

@@ -6,12 +6,14 @@
 import java.util.stream.Stream;
 
 import de.igslandstuhl.database.server.commands.Command;
+import de.igslandstuhl.database.server.commands.CommandDescription;
 import de.igslandstuhl.database.server.webserver.handlers.HttpHandler;
 import de.igslandstuhl.database.server.webserver.requests.APIPostRequest;
 import de.igslandstuhl.database.server.webserver.requests.GetRequest;
 
 public class Registry<K, V> implements Closeable {
     private static final Registry<String,Command> COMMAND_REGISTRY = new Registry<>();
+    private static final Registry<String,CommandDescription> COMMAND_DESCRIPTION_REGISTRY = new Registry<>();
     private static final Registry<String,HttpHandler<APIPostRequest>> POST_HANDLER_REGISTRY = new Registry<>();
     private static final Registry<String,HttpHandler<GetRequest>> GET_HANDLER_REGISTRY = new Registry<>();
     public static Registry<String,Command> commandRegistry() {
@@ -23,6 +25,9 @@ public static Registry<String, HttpHandler<APIPostRequest>> postRequestHandlerRe
     public static Registry<String, HttpHandler<GetRequest>> getRequestHandlerRegistry() {
         return GET_HANDLER_REGISTRY;
     }
+    public static Registry<String, CommandDescription> commandDescriptionRegistry() {
+        return COMMAND_DESCRIPTION_REGISTRY;
+    }
 
     private final Map<K,V> objects = new HashMap<>();
 

src/main/java/de/igslandstuhl/database/server/commands/Command.java

@@ -2,6 +2,7 @@
 
 import java.sql.SQLException;
 import java.util.Arrays;
+import java.util.List;
 import java.util.Random;
 
 import de.igslandstuhl.database.Registry;
@@ -12,6 +13,11 @@
 @FunctionalInterface
 public interface Command {
     public String execute(String[] args);
+    public default CommandDescription getDescription() {
+        return Registry.commandDescriptionRegistry().get(Registry.commandDescriptionRegistry()
+            .keyStream().filter(k -> Registry.commandRegistry().get(k) == this)
+            .findAny().orElse(null));
+    }
 
     public static String executeCommand(String command, String[] args) {
         try {
@@ -23,18 +29,19 @@ public static String executeCommand(String command, String[] args) {
             return "";
         }
     }
-    public static void registerCommand(String name, Command command) {
+    public static void registerCommand(String name, Command command, CommandDescription description) {
         Registry.commandRegistry().register(name, command);
+        Registry.commandDescriptionRegistry().register(name, description);
     }
     public static void registerCommands() {
         registerCommand("exit", (args) -> {
             System.out.println("Exiting...");
             System.exit(0);
             return "";
-        });
+        }, new CommandDescription("exit", "Exits the application", "exit"));
         registerCommand("help", (args) -> {
-            return Registry.commandRegistry().keyStream().reduce("Available Commands:", (s1,s2) -> s1+"\n"+s2);
-        });
+            return Registry.commandRegistry().keyStream().reduce("Available Commands:", (s1,s2) -> s1+"\n"+Registry.commandDescriptionRegistry().get(s2).toString());
+        }, new CommandDescription("help", "Displays this help message", "help"));
         // Add admin
         registerCommand("add-admin", (args) -> {
             if (args.length < 2) return "Usage: add-admin [username] [password]";
@@ -46,7 +53,7 @@ public static void registerCommands() {
                 return "Error while trying to add admin:\n" + CommonUtils.getStacktrace(e);
             }
             return "Successfully added admin";
-        });
+        }, new CommandDescription("add-admin", "Adds a new admin", "add-admin [username] [password]"));
         registerCommand("remove-admin", (args) -> {
             if (args.length < 1) return "Usage: remove-admin [username]";
             try {
@@ -57,7 +64,7 @@ public static void registerCommands() {
                 return "Error while trying to remove admin:\n" + CommonUtils.getStacktrace(e);
             }
             return "Successfully removed admin";
-        });
+        }, new CommandDescription("remove-admin", "Removes an admin", "remove-admin [username]"));
         registerCommand("get-level-ratio", (args) -> {
             if (args.length < 1) return "Usage: get-level-ratio [level]";
             TaskLevel level;
@@ -69,7 +76,7 @@ public static void registerCommands() {
                 return e.getMessage();
             }
             return String.valueOf(level.getRatio() * 100) + "%";
-        });
+        }, new CommandDescription("get-level-ratio", "Gets the ratio of a task level", "get-level-ratio [level]"));
 
         // Room commands
         registerCommand("list-rooms", (args) -> {
@@ -79,13 +86,13 @@ public static void registerCommands() {
                 return "Error while trying to access database:\n" + CommonUtils.getStacktrace(e);
             }
             return Room.getRooms().keySet().stream().reduce("Rooms:", (s1, s2) -> s1 + "\n" + s2);
-        });
+        }, new CommandDescription("list-rooms", "Lists all available rooms", "list-rooms"));
         registerCommand("get-room-level", (args) -> {
             if (args.length < 1) return "Usage: get-room-level [room]";
             Room room = Room.getRoom(argsPart(args, 0, args.length));
             if (room == null) return "Room not found. Try list-rooms for a list of available rooms";
             return "Room " + room.getLabel() + " has access level " + room.getMinimumLevel();
-        });
+        }, new CommandDescription("get-room-level", "Gets the minimum level required to access a room", "get-room-level [room]"));
         registerCommand("set-room-level", (args) -> {
             if (args.length < 2) return "Usage: set-room-level [room] [level]";
             Room room = Room.getRoom(argsPart(args, 0, args.length-1));
@@ -104,7 +111,7 @@ public static void registerCommands() {
                 return e.getMessage();
             }
             return "Successfully changed room level";
-        });
+        }, new CommandDescription("set-room-level", "Sets the minimum level required to access a room", "set-room-level [room] [level]"));
         registerCommand("add-room", (args) -> {
             if (args.length < 2) return "Usage: add-room [room] [level]";
             if (Room.getRoom(args[0]) != null) return "Room already present";
@@ -122,7 +129,7 @@ public static void registerCommands() {
                 throw new IllegalStateException(e);
             }
             return "Room successfully added";
-        });
+        }, new CommandDescription("add-room", "Adds a new room", "add-room [room] [level]"));
         registerCommand("remove-room", (args) -> {
             if (args.length < 1) return "Usage: remove-room [room]";
 
@@ -133,13 +140,13 @@ public static void registerCommands() {
                 return "Error while trying to access database: \n" + CommonUtils.getStacktrace(e);
             }
             return "Room successfully deleted";
-        });
+        }, new CommandDescription("remove-room", "Removes a room", "remove-room [room]"));
 
 
         // class commands
         registerCommand("list-classes", (args) -> {
             return SchoolClass.getAll().stream().map(SchoolClass::getLabel).reduce("Classes:", (s1,s2) -> s1 + "\n" + s2);
-        });
+        }, new CommandDescription("list-classes", "Lists all classes", "list-classes"));
         registerCommand("add-subject-to-class", (args) -> {
             if (args.length != 2) return "Usage: add-subject-to-class [subject] [class]";
 
@@ -155,7 +162,7 @@ public static void registerCommands() {
                 throw new IllegalStateException(e);
             }
             return "Successfully added subject to class";
-        });
+        }, new CommandDescription("add-subject-to-class", "Adds a subject to a class", "add-subject-to-class [subject] [class]"));
         registerCommand(("set-class-label"), (args) -> {
             if (args.length != 2) return "Usage: set-class-label [old] [new]";
 
@@ -170,7 +177,7 @@ public static void registerCommands() {
             }
 
             return "Class label successfully updated.";
-        });
+        }, new CommandDescription("set-class-label", "Sets the label of a class", "set-class-label [old] [new]"));
         registerCommand(("set-class-grade"), (args) -> {
             if (args.length != 2) return "Usage: set-class-grade [class] [grade]";
 
@@ -191,12 +198,12 @@ public static void registerCommands() {
             }
 
             return "Class grade successfully updated.";
-        });
+        }, new CommandDescription("set-class-grade", "Sets the grade of a class", "set-class-grade [class] [grade]"));
         registerCommand("add-class", (args) -> {
             if (args.length != 1) return "Usage: add-class [class]";
             SchoolClass schoolClass = SchoolClass.getOrCreate(args[0]);
             return "Successfully created class " + schoolClass.getLabel() + " of grade " + schoolClass.getGrade();
-        });
+        }, new CommandDescription("add-class", "Adds a new class", "add-class [class]"));
         registerCommand("remove-class", (args) -> {
             if (args.length != 1) return "Usage: remove-class [class]";
             SchoolClass schoolClass = SchoolClass.get(args[0]);
@@ -207,21 +214,21 @@ public static void registerCommands() {
                 throw new IllegalStateException(e);
             }
             return "Successfully deleted class";
-        });
+        }, new CommandDescription("remove-class", "Removes a class", "remove-class [class]"));
         // school year
         registerCommand("list-school-years", (args) -> {
             return SchoolYear.getAll().stream().map(SchoolYear::getLabel).reduce("School years:", (s1,s2) -> s1 + "\n" + s2);
-        });
+        }, new CommandDescription("list-school-years", "Lists all school years", "list-school-years"));
         registerCommand("get-current-school-year", (args) -> {
             SchoolYear current = SchoolYear.getCurrentYear();
             if (current == null) return "No school year found.";
             return "Current school year: " + current.getLabel() + ", current week: " + current.getCurrentWeek() + ", total week count: " + current.getWeekCount();
-        });
+        }, new CommandDescription("get-current-school-year", "Gets the current school year", "get-current-school-year"));
         registerCommand("get-current-week", (args) -> {
             SchoolYear current = SchoolYear.getCurrentYear();
             if (current == null) return "No school year found.";
             return "Current week: " + current.getCurrentWeek();
-        });
+        }, new CommandDescription("get-current-week", "Gets the current week", "get-current-week"));
         registerCommand("set-current-week", (args) -> {
             if (args.length != 1) return "Usage: set-current-week [week]";
             int week;
@@ -239,7 +246,7 @@ public static void registerCommands() {
                 throw new IllegalStateException(e);
             }
             return "Week successfully changed";
-        });
+        }, new CommandDescription("set-current-week", "Sets the current week", "set-current-week [week]"));
         registerCommand("inc-week", (args) -> {
             SchoolYear current = SchoolYear.getCurrentYear();
             if (current == null) return "No school year found";
@@ -249,7 +256,7 @@ public static void registerCommands() {
                 throw new IllegalStateException(e);
             }
             return "Week successfully changed";
-        });
+        }, new CommandDescription("inc-week", "Increases the current week by 1", "inc-week"));
         registerCommand("add-school-year", (args) -> {
             if (args.length != 2) return "Usage: add-school-year [label] [week count]";
             try {
@@ -260,7 +267,7 @@ public static void registerCommands() {
                 throw new IllegalStateException(e);
             }
             return "Successfully added school year";
-        });
+        }, new CommandDescription("add-school-year", "Adds a new school year", "add-school-year [label] [week count]"));
         registerCommand("remove-school-year", (args) -> {
             if (args.length != 1) return "Usage: remove-school-year [label]";
             SchoolYear schoolYear = SchoolYear.get(args[0]);
@@ -271,7 +278,7 @@ public static void registerCommands() {
                 throw new IllegalStateException(e);
             }
             return "School Year successfully removed";
-        });
+        }, new CommandDescription("remove-school-year", "Removes a school year", "remove-school-year [label]"));
         // User commands
         registerCommand("regenerate-user-password", (args) -> {
             if (args.length != 1) return "Usage: regenerate-user-password [user]";
@@ -282,10 +289,10 @@ public static void registerCommands() {
             } catch (SQLException e) {
                 throw new IllegalStateException(e);
             }
-        });
+        }, new CommandDescription("regenerate-user-password", "Regenerates a user's password", "regenerate-user-password [user]"));
         registerCommand("generate-password", (args) -> {
             return "Passwort: " + User.generateRandomPassword(12, CommonUtils.stringToSeed(argsPart(args, 0, args.length)) + System.currentTimeMillis() + new Random().nextInt(1000));
-        });
+        }, new CommandDescription("generate-password", "Generates a random password", "generate-password [optional seed]"));
         registerCommand("change-user-password", (args) -> {
             if (args.length != 2) return "Usage: change-user-password [user] [password]";
             User user = User.getUser(args[0]);
@@ -296,11 +303,11 @@ public static void registerCommands() {
             } catch (SQLException e) {
                 throw new IllegalStateException(e);
             }
-        });
+        }, new CommandDescription("change-user-password", "Changes a user's password", "change-user-password [user] [password]"));
         // Subject commands
         registerCommand("list-subjects", (args) -> {
             return Subject.getAll().stream().map(Subject::getName).reduce("Subjects:", (s1,s2) -> s1+"\n"+s2);
-        });
+        }, new CommandDescription("list-subjects", "Lists all subjects", "list-subjects"));
         registerCommand("add-subject", (args) -> {
             if (args.length < 1) return "Usage: add-subject [subject]";
             String name = argsPart(args, 0, args.length);
@@ -310,7 +317,7 @@ public static void registerCommands() {
             } catch (SQLException e) {
                 throw new IllegalStateException(e);
             }
-        });
+        }, new CommandDescription("add-subject", "Adds a new subject", "add-subject [subject]"));
         registerCommand("rename-subject", (args) -> {
             if (args.length < 3) return "Usage: rename-subject [old name] : [new name]";
 
@@ -327,7 +334,7 @@ public static void registerCommands() {
             } catch (SQLException e) {
                 throw new IllegalStateException(e);
             }
-        });
+        }, new CommandDescription("rename-subject", "Renames a subject", "rename-subject [old name] : [new name]"));
         registerCommand("remove-subject", (args) -> {
             if (args.length == 0) return "remove-subject [name]";
             String name = argsPart(args, 0, args.length);
@@ -339,7 +346,7 @@ public static void registerCommands() {
             } catch (SQLException e) {
                 throw new IllegalStateException(e);
             }
-        });
+        }, new CommandDescription("remove-subject", "Removes a subject", "remove-subject [name]"));
         // manual sql commands
         registerCommand("sql-update", (args) -> {
             String command = argsPart(args, 0, args.length);
@@ -349,9 +356,12 @@ public static void registerCommands() {
                 throw new IllegalArgumentException(e);
             }
             return "Successfully executed";
-        });
+        }, new CommandDescription("sql-update", "Executes an update sql command", "sql-update [command]"));
     }
     private static String argsPart(String[] args, int start, int end) {
         return Arrays.stream(Arrays.copyOfRange(args, start, end)).reduce("", (s1,s2) -> s1+" "+s2).replaceFirst(" ", "");
     }
+    public static List<String> getAllCommandNames() {
+        return Registry.commandRegistry().keyStream().toList();
+    }
 }

src/main/java/de/igslandstuhl/database/server/commands/CommandDescription.java

@@ -0,0 +1,9 @@
+package de.igslandstuhl.database.server.commands;
+
+import de.igslandstuhl.database.utils.StringUtils;
+
+public record CommandDescription(String name, String description, String usage) {
+    public String toString() {
+        return StringUtils.fitSize(name, 20) + "\t" + StringUtils.fitSize(description, 50) + "\t" + StringUtils.fitSize(usage, 30);
+    }
+}