feat: add command line URL queue

CLI/src/main/java/cli/support/Constants.java

@@ -6,6 +6,10 @@ public class Constants extends support.Constants {
     public static final String ANSI_PURPLE = "\u001B[35m";
     public static final String CLI_APPLICATION_STARTED = "Drifty CLI (Command Line Interface) Application Started !";
     public static final String CLI_APPLICATION_TERMINATED = "Drifty CLI (Command Line Interface) Application Terminated!";
+    public static final String ADD_FLAG = "add";
+    public static final String REMOVE_FLAG = "remove";
+    public static final String LIST_FLAG = "list";
+    public static final String GET_FLAG = "get";
     public static final String HELP_FLAG = "--help";
     public static final String NAME_FLAG = "--name";
     public static final String VERSION_FLAG = "--version";

CLI/src/main/java/main/Drifty_CLI.java

@@ -4,8 +4,10 @@
 import cli.utils.MessageBroker;
 import cli.init.Environment;
 import org.yaml.snakeyaml.Yaml;
+import org.yaml.snakeyaml.error.YAMLException;
 import preferences.AppSettings;
 import properties.MessageType;
+import properties.Program;
 import properties.OS;
 import support.Job;
 import support.JobHistory;
@@ -17,6 +19,7 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.nio.file.StandardCopyOption;
 import java.util.*;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
@@ -40,6 +43,8 @@
     private static String batchDownloadingFile;
     private static final String MSG_FILE_EXISTS_NO_HISTORY = "\"%s\" exists in \"%s\" folder. It will be renamed to \"%s\".";
     private static final String MSG_FILE_EXISTS_HAS_HISTORY = "You have previously downloaded \"%s\" and it exists in \"%s\" folder.\nDo you want to download it again? ";
+    private static final String YAML_FILENAME = "links.yml";
+    private static String yamlFilePath;
 
     public static void main(String[] args) {
         LOGGER.log(MessageType.INFO, CLI_APPLICATION_STARTED);
@@ -53,20 +58,44 @@
         printBanner();
         if (args.length > 0) {
             link = null;
-            String name = null;
-            String location = null;
+            yamlFilePath = Paths.get(Program.get(Program.DRIFTY_PATH), YAML_FILENAME).toAbsolutePath().toString();
             for (int i = 0; i < args.length; i++) {
                 switch (args[i]) {
-                    case HELP_FLAG, HELP_FLAG_SHORT -> {
-                        help();
-                        System.exit(0);
+                    case HELP_FLAG, HELP_FLAG_SHORT -> help();
+                    case ADD_FLAG -> {
+                        if (i + 1 >= args.length) {
+                            messageBroker.msgBatchError("No URL provided.");
+                            System.exit(1);
+                        }
+                        for (int j = i + 1; j < args.length; j++) {
+                            addUrlToFile(args[j]);
+                        }
                     }
-                    case NAME_FLAG, NAME_FLAG_SHORT -> name = args[i + 1];
-                    case LOCATION_FLAG, LOCATION_FLAG_SHORT -> location = args[i + 1];
-                    case VERSION_FLAG, VERSION_FLAG_SHORT -> {
-                        printVersion();
-                        System.exit(0);
+                    case LIST_FLAG -> listUrls();
+                    case REMOVE_FLAG -> {
+                        if (i + 1 >= args.length) {
+                            messageBroker.msgBatchError("No line number provided for removal.");
+                            System.exit(1);
+                        }
+                        for (int j = i + 1; j < args.length; j++) {
+                            if ("all".equalsIgnoreCase(args[j])) {
+                                removeAllUrls();
+                            } else {
+                                removeUrl(args[j]);
+                            }
+                        }
                     }
+                    case GET_FLAG -> {
+                        batchDownloading = true;
+                        // Logic to download URLs goes here
+                        System.out.println("Downloading URLs...");
+                        batchDownloadingFile = yamlFilePath;
+                        batchDownloader();
+                        removeAllUrls();
+                    }
+                    case NAME_FLAG, NAME_FLAG_SHORT -> fileName = args[i + 1];
+                    case LOCATION_FLAG, LOCATION_FLAG_SHORT -> downloadsFolder = args[i + 1];
+                    case VERSION_FLAG, VERSION_FLAG_SHORT -> printVersion();
                     case BATCH_FLAG, BATCH_FLAG_SHORT -> {
                         batchDownloading = true;
                         batchDownloadingFile = args[i + 1];
@@ -75,12 +104,14 @@
                     default -> {
                         if (isURL(args[i])) {
                             link = args[i];
+                            continue;
                         } else {
                             messageBroker.msgInitError("Invalid argument(s) passed!");
                             System.exit(1);
                         }
                     }
                 }
+                System.exit(0);
             }
             if (!batchDownloading) {
                 boolean isUrlValid;
@@ -94,9 +125,8 @@
                     isYoutubeURL = isYoutube(link);
                     isInstagramLink = isInstagram(link);
                     isSpotifyLink = isSpotify(link);
-                    downloadsFolder = location;
                     downloadsFolder = getProperDownloadsFolder(downloadsFolder);
-                    if ((name == null) && (fileName == null || fileName.isEmpty())) {
+                    if (fileName == null || fileName.isEmpty()) {
                         if (isSpotifyLink && link.contains("playlist")) {
                             handleSpotifyPlaylist();
                         } else {
@@ -189,6 +219,172 @@
         }
     }
 
+    private static void ensureYamlFileExists() {
+        // Check if the YAML file exists, create it if it does not
+        File yamlFile = new File(yamlFilePath);
+        if (!yamlFile.exists()) {
+            try {
+                boolean isNewFileCreated = yamlFile.createNewFile();
+                if (isNewFileCreated) {
+                    messageBroker.msgFilenameInfo("New YAML file created: " + yamlFilePath);
+                } else {
+                    messageBroker.msgLogError("Failed to create new YAML file.");
+                }
+            } catch (IOException e) {
+                messageBroker.msgLogError("Error while creating YAML file: " + e.getMessage());
+            }
+        }
+    }
+
+    private static boolean isEmptyYaml(Map<String, List<String>> data) {
+        if (data == null || !data.containsKey("links") || data.get("links").isEmpty()) {
+            messageBroker.msgLinkError("No URL is present in the links queue!\n" +
+                    "Please run with `add <link>` to add the link to the list.");
+            return true;
+        }
+        return false;
+    }
+
+    private static Map<String, List<String>> loadYamlData() {
+        Yaml yaml = new Yaml();
+        Map<String, List<String>> data = null;
+        ensureYamlFileExists(); // Ensure the YAML file exists before trying to read
+
+        try (InputStreamReader reader = new InputStreamReader(new FileInputStream(yamlFilePath))) {
+            data = yaml.load(reader);
+            if (data == null) {
+                data = new HashMap<>();
+            }
+            data.computeIfAbsent("links", k -> new ArrayList<>()); // Ensure 'links' list exists
+        } catch (YAMLException e) {
+            messageBroker.msgLogError("Invalid YAML format in file: " + e.getMessage());
+        } catch (IOException e) {
+            messageBroker.msgLogError("Error reading YAML file: " + e.getMessage());
+        }
+        return data;
+    }
+
+    private static void saveYamlData(Map<String, List<String>> data) {
+        Yaml yaml = new Yaml();
+        File originalFile = new File(yamlFilePath);
+        File backupFile = new File(yamlFilePath + ".bak");
+
+        // Create a backup of the original file
+        try {
+            Files.copy(originalFile.toPath(), backupFile.toPath(), StandardCopyOption.REPLACE_EXISTING);
+        } catch (IOException e) {
+            messageBroker.msgLogError("Failed to create a backup of the YAML file: " + e.getMessage());
+            return; // Abort the operation if backup fails to ensure data integrity
+        }
+
+        // Proceed with writing the updated data to the YAML file
+        try (BufferedWriter writer = new BufferedWriter(new FileWriter(originalFile))) {
+            yaml.dump(data, writer);
+        } catch (IOException e) {
+            messageBroker.msgLogError("Error writing to YAML file: " + e.getMessage());
+            // Attempt to restore from backup in case of a write error
+            try {
+                Files.copy(backupFile.toPath(), originalFile.toPath(), StandardCopyOption.REPLACE_EXISTING);
+                messageBroker.msgLogError("Restored the original YAML file from backup due to write error.");
+            } catch (IOException restoreException) {
+                messageBroker.msgLogError("Failed to restore the original YAML file from backup: " + restoreException.getMessage());
+            }
+        } finally {
+            // Clean up: Delete the backup file if everything went smoothly
+            if (!backupFile.delete()) {
+                messageBroker.msgLogError("Failed to delete the backup file: " + backupFile.getName());
+            }
+        }
+    }
+
+    private static void listUrls() {
+        try {
+            Map<String, List<String>> data = loadYamlData();
+            if (isEmptyYaml(data)) {
+                return;
+            }
+
+            List<String> urls = data.get("links");
+            messageBroker.msgDownloadInfo("List of URLs:");
+            urls.forEach(url -> messageBroker.msgLinkInfo(url));
+        } catch (Exception e) {
+            messageBroker.msgLogError("An error occurred while listing URLs: " + e.getMessage());
+        }
+    }
+
+    private static void removeUrl(String indexStr) {
+        int index;
+        try {
+            index = Integer.parseInt(indexStr);
+        } catch (NumberFormatException e) {
+            messageBroker.msgInputError("Invalid format. Please provide a numeric input.", true);
+            return;
+        }
+
+        try {
+            Map<String, List<String>> data = loadYamlData();
+            if (isEmptyYaml(data)) {
+                return;
+            }
+
+            List<String> urls = data.get("links");
+            if (index < 1 || index > urls.size()) {
+                messageBroker.msgInputError("Invalid line number '" + index + "'. Please provide a number between 1 and " + urls.size() + ".", true);
+                return;
+            }
+
+            String removedUrl = urls.remove(index - 1);
+            saveYamlData(data); // Save updated YAML data
+            messageBroker.msgLinkInfo("Removed URL: " + removedUrl);
+        } catch (Exception e) {
+            messageBroker.msgLogError("An error occurred while removing a URL: " + e.getMessage());
+        }
+    }
+
+    private static void removeAllUrls() {
+        try {
+            // Delete the YAML file to remove all URLs
+            File yamlFile = new File(yamlFilePath);
+            if (yamlFile.exists()) {
+                if (yamlFile.delete()) {
+                    if (batchDownloading) {
+                        messageBroker.msgLogInfo("All URLs removed successfully from the YAML file.");
+                    } else {
+                        messageBroker.msgLinkInfo("All URLs removed successfully.");
+                    }
+                } else {
+                    messageBroker.msgLinkError("Failed to remove all URLs.");
+                }
+            } else {
+                messageBroker.msgLinkError("No URLs to remove.");
+            }
+        } catch (Exception e) {
+            messageBroker.msgLogError("An error occurred while removing all URLs: " + e.getMessage());
+        }
+    }
+
+    private static void addUrlToFile(String urlString) {
+        if (!Utility.isURL(urlString)) {
+            messageBroker.msgInputError("Error: '" + urlString + "' is not a valid URL.", true);
+            return;
+        }
+
+        try {
+            Map<String, List<String>> data = loadYamlData();
+
+            List<String> urls = data.get("links");
+            if (!urls.contains(urlString)) {
+                urls.add(urlString); // Add the URL if it doesn't exist
+                saveYamlData(data); // Save the updated data back to the YAML file
+                messageBroker.msgLinkInfo("URL added: " + urlString);
+            } else {
+                messageBroker.msgInputError("URL already exists: " + urlString, true);
+            }
+        } catch (Exception e) {
+            messageBroker.msgLogError("An error occurred while adding a URL: " + e.getMessage());
+        }
+    }
+
     private static void printVersion() {
         System.out.println("\033[1m" + APPLICATION_NAME + " " + VERSION_NUMBER + ANSI_RESET);
         if (AppSettings.GET.ytDlpVersion().isEmpty()) {
@@ -405,6 +601,10 @@
         System.out.println("--name       -n            Source                   Filename of the downloaded file");
         System.out.println("--help       -h            N/A                      Prints this help menu");
         System.out.println("--version    -v            Current Version          Displays version number of Drifty");
+        System.out.println("add <URL> <URL> ...        Add URLs                 Adds new URLs to the download queue. Multiple URLs can be added by separating them with spaces.");
+        System.out.println("remove <number(s)/all>     Remove URLs              Removes one or more URLs from the download queue. Specify line numbers separated by spaces or use 'all' to remove all URLs.");
+        System.out.println("list                       List URLs                Lists all URLs currently in the download queue");
+        System.out.println("get                        Download URLs            Downloads all URLs in the download queue");
         System.out.println("\033[97;1mSee full documentation at https://github.com/SaptarshiSarkar12/Drifty#readme" + ANSI_RESET);
         System.out.println("For more information visit: ");
         System.out.println("\tProject Link - https://github.com/SaptarshiSarkar12/Drifty/");