Level-7: updated saving and loading such that user may specify an address to save to and load from

Author: tanhl2000

dukeLog.txt

@@ -1,2 +1 @@
-0,todo hbw
-1,deadline work /by9/9/2022
+0,todo run

resources/dukeLog.txt

@@ -0,0 +1 @@
+0,todo run

src/main/java/command/ByeCommand.java

@@ -1,6 +1,7 @@
 package command;
 
 import exception.DukeException;
+import exception.DukeFileAddressInvalidException;
 import main.Storage;
 import main.TaskList;
 import main.Ui;
@@ -12,10 +13,16 @@
  */
 
 public class ByeCommand extends Command{
+
+    private String logFileAddress = "";
 
     public ByeCommand() {
     }
 
+    public ByeCommand(String newAddress) {
+        this.logFileAddress = newAddress;
+    }
+
 
     /** 
      * Checks if command will cause chatbot to end.
@@ -36,13 +43,31 @@ public boolean isEnd() {
      * @throws DukeException
      */
     public void execute(TaskList tasks, Ui ui, Storage storage) throws DukeException{
+        if (!this.verifyAddress(this.logFileAddress)) {
+            throw new DukeFileAddressInvalidException("User file address invalid, please check pathing");
+        }
         try {
-            storage.cleanUp();
+            if (this.logFileAddress.equals("")) {
+                storage.cleanUp();
+            } else {
+                storage.cleanUp(this.logFileAddress);
+            }
         } catch (DukeException e) {
             throw e;
         }
     }
 
+    private boolean verifyAddress(String address) {
+        String addressToCheck = address.strip();
+        String[] addressSplit = addressToCheck.split(" ");
+        if (addressSplit.length > 1) {
+            return false;
+        }
+        if (address.equals("")) {
+            return false;
+        }
+        return true;
+    }
 
     /** 
      * Returns the task that will be generated from the command, returns an empty task if no task is to be generated

src/main/java/command/LoadCommand.java

@@ -1,18 +1,28 @@
 package command;
 
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
 import exception.DukeException;
+import exception.DukeFileAddressInvalidException;
 import main.Storage;
 import main.TaskList;
 import main.Ui;
 import task.Task;
 
 public class LoadCommand extends Command{
+
+    private String logFileAddress = "";
 
     public LoadCommand() {
         super();
     }
 
-    
+    public LoadCommand(String newAddress) {
+        this.logFileAddress = newAddress;
+    }
+
     /** 
      * Checks if command will cause chatbot to end
      * @return boolean
@@ -33,12 +43,15 @@ public boolean isEnd() {
      */
     public void execute(TaskList tasks, Ui ui, Storage storage) throws DukeException{
         try {
-            storage.loadLog();
+            if (this.logFileAddress.equals("")) {
+                storage.loadLog();
+            } else {
+                storage.loadLog(this.logFileAddress);
+            }
         } catch (DukeException e) {
             throw e;
         }
     }
-
 
     /** 
      * Returns the task that will be generated from the command, returns an empty task if no task is to be generated

src/main/java/exception/DukeFileAddressInvalidException.java

@@ -0,0 +1,8 @@
+package exception;
+
+public class DukeFileAddressInvalidException extends DukeException{
+    
+    public DukeFileAddressInvalidException(String message) {
+        super(message);
+    }
+}

src/main/java/main/Parser.java

@@ -55,7 +55,7 @@ public Command parse(String userCommand) throws InvalidCommandException {
             return new FindCommand(commandArgs);
         case COMMAND_LOAD:
             if (!commandArgs.equals("")) {
-                throw new InvalidCommandException("Argument given for command not needing argument");
+                return new LoadCommand(commandArgs);
             }
             return new LoadCommand();
         case COMMAND_LIST:
@@ -65,7 +65,7 @@ public Command parse(String userCommand) throws InvalidCommandException {
             return new ListCommand();
         case COMMAND_BYE:
             if (!commandArgs.equals("")) {
-                throw new InvalidCommandException("Argument given for command not needing argument");
+                return new ByeCommand(commandArgs);
             }
             return new ByeCommand();
         case COMMAND_TODO:

src/main/java/main/Storage.java

@@ -4,19 +4,24 @@
 import java.io.FileNotFoundException;
 import java.io.FileWriter;
 import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.Scanner;
 
 import command.Command;
 import exception.DukeException;
+import exception.DukeFileAddressInvalidException;
 import exception.DukeFileNotFoundException;
 import exception.DukeIOException;
 import exception.InvalidCommandException;
 import task.Task;
 
 public class Storage {
 
-    private static String logFileAddress = "./ip/dukeLog.txt";
+    private final String LOG_FILE_DIRECTORY = "./resources"; //log files must be in resources directory
+    private String logFileAddress = "./resources/dukeLog.txt"; //default file address
 
     private ArrayList<String[]> loggedTasks = new ArrayList<String[]>();
     private TaskList existingTasks;
@@ -29,12 +34,12 @@ public Storage(TaskList existingTasks, Ui ui) {
 
 
     /** 
-     * loadLog loads the tasks stored in the log file into the curren tasklist, 
+     * loadLog loads the tasks stored in the log file into the current tasklist, 
      * throws DukeExceptions if theres issues with the format of the log file or file address is invalid
      * @return TaskList
      * @throws DukeException
      */
-    public TaskList loadLog() throws DukeException{
+    public void loadLog() throws DukeException{
         try {
             //initialise parser, file scanner and tasklist
             Parser parser = new Parser();
@@ -52,25 +57,36 @@ public TaskList loadLog() throws DukeException{
             fileReader.close();
 
             //add all the tasks in the temporary array list of task logs into the tasklist
+            int numOfTasks = 0;
             for (String[] loggedTask : loggedTasks) {
                 boolean isDone = Integer.parseInt(loggedTask[0]) == 1;
                 Command parsedCommand = parser.parse(loggedTask[1]);
                 Task newTask = parsedCommand.getTask();
+                numOfTasks += 1;
                 if (isDone) {
                     newTask.mark();
                 }
                 newTaskList.add(parsedCommand.getTask());
             }
 
             //return the new tasklist to be used
-            return newTaskList;
+            this.existingTasks.replace(newTaskList);
+            this.sendLoadMessage(numOfTasks);
         } catch (InvalidCommandException e) {
             throw e;
         } catch (FileNotFoundException e) {
             throw new DukeFileNotFoundException(e.getLocalizedMessage());
         }
     }
 
+    public void loadLog(String newPath) throws DukeException{
+        String fullPath = this.LOG_FILE_DIRECTORY + "/" + newPath;
+        if (!this.verifyPath(fullPath)) {
+            throw new DukeFileAddressInvalidException("File path specified does not exist");
+        }
+        this.logFileAddress = fullPath;
+        this.loadLog();
+    }
 
     /** 
      * @throws DukeException
@@ -82,6 +98,9 @@ public void cleanUp() throws DukeException {
             return;
         }
         try {
+            //Verify filepath exists
+            this.createDirectory();
+
             //initialise file writer and integer counter
             FileWriter fileWriter = new FileWriter(logFileAddress);
             int numOfTasks = 0;
@@ -101,6 +120,41 @@ public void cleanUp() throws DukeException {
         }
     }
 
+    /**
+     * 
+     * @param newFileName
+     * @throws DukeException
+     */
+    public void cleanUp(String newFileName) throws DukeException{
+        logFileAddress = this.LOG_FILE_DIRECTORY + "/" + newFileName;
+        this.cleanUp();
+    }
+
+    private boolean verifyPath(String fullPath) {
+        Path fullPathToCheck = Paths.get(fullPath);
+        if (Files.exists(fullPathToCheck)) {
+            return true;
+        } else {
+            return false;
+        }
+    }
+
+    private void createDirectory() {
+        String directoriesPath = this.removeFilePath(this.logFileAddress);
+        Path dirPath = Paths.get(directoriesPath);
+        if (!Files.exists(dirPath)) {
+
+            //if path doesnt exist, create directory
+            File directory = new File(directoriesPath);
+            if (!directory.mkdirs()) {
+                this.ui.logFileError();
+            }
+        }
+    }
+
+    private String removeFilePath(String fullPath) {
+        return fullPath.substring(0, fullPath.lastIndexOf("/") + 1);
+    }
 
     /** 
      * @param numOfTasks
@@ -113,4 +167,8 @@ public void sendNoTasksMessage() {
         this.ui.chat("No tasks saved to log file \n");
     }
 
+    public void sendLoadMessage(int numOfTasks) {
+        this.ui.chat(String.format("Loaded %d tasks", numOfTasks));
+    }
+
 }

src/main/java/main/TaskList.java

@@ -126,6 +126,11 @@ public TaskList search(String keyword) {
         return this.searchTasks;
     }
 
+    public void replace(TaskList newList) {
+        this.tasks = new ArrayList<Task>();
+        this.tasks.addAll(newList.tasks);
+    }
+
     /** 
      * Returns the list command format of the tasks in index order
      * @return String

src/main/java/main/Ui.java

@@ -11,6 +11,7 @@ public class Ui {
     private final String UI_LINE_SPACING = "----------------------------------------";
     private final String MESSAGE_GREETING = "Hello! I'm Duke  \n" + "What can I do for you?";
     private final String MESSAGE_FIND = "Tasks found:\n";
+    private final String MESSAGE_LOG_ERROR = "File pathing for log file is facing issues, tasks not saved\n";
     private final String markMessage = "Task has been marked done:";
     private final String unmarkMessage = "Task has been marked not done:";
     private final String addMessage = "Task added: \n";
@@ -23,6 +24,10 @@ public Ui(TaskList tasks) {
     public void greeting() {
         this.chat(this.MESSAGE_GREETING);
     }
+
+    public void logFileError() {
+        this.chat(MESSAGE_LOG_ERROR);
+    }
 
     /** 
      * Shows a list of the tasks the chatbot holds to the user in tasklist index order,