Merge pull request nus-cs2103-AY1819S2#69 from JiaHaoLim/master

kthSim · web-flow · commit 09cc878eeea4 · 2019-03-16T10:22:10.000+08:00
[v1.2] Open, Save, Import, Export
diff --git a/src/main/java/seedu/address/logic/commands/ExportCommand.java b/src/main/java/seedu/address/logic/commands/ExportCommand.java
@@ -0,0 +1,95 @@
+package seedu.address.logic.commands;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.address.model.Model.PREDICATE_SHOW_ALL_PERSONS;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.HashSet;
+import java.util.logging.Logger;
+
+import seedu.address.MainApp;
+import seedu.address.commons.core.LogsCenter;
+import seedu.address.logic.CommandHistory;
+import seedu.address.model.Model;
+import seedu.address.model.ModelManager;
+import seedu.address.model.person.Person;
+import seedu.address.storage.AddressBookStorage;
+import seedu.address.storage.JsonAddressBookStorage;
+import seedu.address.storage.ParsedInOut;
+import seedu.address.storage.StorageManager;
+
+/**
+ * Exports records to a text file.
+ */
+public class ExportCommand extends Command {
+
+    public static final String COMMAND_WORD = "export";
+
+    public static final String MESSAGE_USAGE = COMMAND_WORD
+            + ": Exports specific patients by index to text file in the \"data\" folder, "
+            + "overwriting if filename exists \n"
+            + "Parameters: FILENAME INDEX_RANGE(must be a positive integer)\n"
+            + "Example: " + COMMAND_WORD + " records1.json + 1-5"
+            + "Example: " + COMMAND_WORD + " records1.json + 1,3,5";
+
+    public static final String MESSAGE_SUCCESS = "Exported the records!";
+    private static final String MESSAGE_FAILURE = "Problem while writing to the file.";
+
+    private final ParsedInOut parsedInput;
+
+    public ExportCommand(ParsedInOut parsedInput) {
+        this.parsedInput = parsedInput;
+    }
+
+    @Override
+    public CommandResult execute(Model model, CommandHistory history) {
+        requireNonNull(model);
+        writeFile(createTempAddressBook(model, parsedInput.getParsedIndex()));
+        model.updateFilteredPersonList(PREDICATE_SHOW_ALL_PERSONS);
+        return new CommandResult(MESSAGE_SUCCESS);
+    }
+
+    /**
+     * writeFile() writes or overwrites a file with the contents of the current address book.
+     */
+    private void writeFile(Model model) {
+
+        AddressBookStorage addressBookStorage = new JsonAddressBookStorage(parsedInput.getFile().toPath());
+
+        StorageManager storage = new StorageManager(addressBookStorage, null);
+
+        final Logger logger = LogsCenter.getLogger(MainApp.class);
+
+        try {
+            storage.saveAddressBook(model.getAddressBook());
+        } catch (IOException e) {
+            logger.warning(MESSAGE_FAILURE);
+        }
+    }
+
+    /**
+     * createTempAddressBook() creates a temporary address book populated with the specified patients in parsedInput[1]
+     * @param model
+     * @param parsedIndex
+     * @return
+     */
+    private ModelManager createTempAddressBook(Model model, HashSet<Integer> parsedIndex) {
+        ModelManager tempModel = new ModelManager();
+
+        tempModel.setAddressBook(model.getAddressBook());
+        ArrayList<Person> deleteList = new ArrayList<>();
+
+        for (int i = 0; i < tempModel.getFilteredPersonList().size(); i++) {
+            if (!parsedIndex.contains(i)) {
+                deleteList.add(tempModel.getFilteredPersonList().get(i));
+            }
+        }
+
+        for (Person personToDelete : deleteList) {
+            tempModel.deletePerson(personToDelete);
+        }
+
+        return tempModel;
+    }
+}
diff --git a/src/main/java/seedu/address/logic/commands/ImportCommand.java b/src/main/java/seedu/address/logic/commands/ImportCommand.java
@@ -0,0 +1,88 @@
+package seedu.address.logic.commands;
+
+import static java.util.Objects.requireNonNull;
+import static seedu.address.model.Model.PREDICATE_SHOW_ALL_PERSONS;
+
+import java.io.IOException;
+import java.util.HashSet;
+import java.util.Optional;
+import java.util.logging.Logger;
+
+import seedu.address.MainApp;
+import seedu.address.commons.core.LogsCenter;
+import seedu.address.commons.exceptions.DataConversionException;
+import seedu.address.logic.CommandHistory;
+import seedu.address.model.AddressBook;
+import seedu.address.model.Model;
+import seedu.address.model.ReadOnlyAddressBook;
+import seedu.address.model.util.SampleDataUtil;
+import seedu.address.storage.AddressBookStorage;
+import seedu.address.storage.JsonAddressBookStorage;
+import seedu.address.storage.ParsedInOut;
+import seedu.address.storage.StorageManager;
+
+/**
+ * Imports records to a text file.
+ */
+public class ImportCommand extends Command {
+
+    public static final String COMMAND_WORD = "import";
+
+    public static final String MESSAGE_USAGE = COMMAND_WORD
+            + ": Imports specific patients by index to text file in the \"data\" folder, "
+            + "overwriting if filename exists \n"
+            + "Parameters: FILENAME INDEX_RANGE(must be a positive integer)\n"
+            + "Example: " + COMMAND_WORD + " records1.json + 1-5"
+            + "Example: " + COMMAND_WORD + " records1.json + 1,3,5";
+
+    public static final String MESSAGE_SUCCESS = "Imported the records!";
+
+    private final ParsedInOut parsedInput;
+
+    public ImportCommand(ParsedInOut parsedInput) {
+        this.parsedInput = parsedInput;
+    }
+
+    @Override
+    public CommandResult execute(Model model, CommandHistory history) {
+        requireNonNull(model);
+        readFile(model, parsedInput.getParsedIndex());
+        model.updateFilteredPersonList(PREDICATE_SHOW_ALL_PERSONS);
+        model.commitAddressBook();
+        return new CommandResult(MESSAGE_SUCCESS);
+    }
+
+    /**
+     * readFile() appends the current address book with the contents of the file.
+     */
+    private void readFile(Model model, HashSet<Integer> parsedIndex) {
+        AddressBookStorage importStorage = new JsonAddressBookStorage(parsedInput.getFile().toPath());
+
+        StorageManager importStorageManager = new StorageManager(importStorage, null);
+
+        final Logger logger = LogsCenter.getLogger(MainApp.class);
+
+        Optional<ReadOnlyAddressBook> importOptional;
+        ReadOnlyAddressBook importData;
+
+        try {
+            importOptional = importStorageManager.readAddressBook();
+            if (!importOptional.isPresent()) {
+                logger.info("Data file not found. Will be starting with a sample AddressBook");
+            }
+            importData = importOptional.orElseGet(SampleDataUtil::getSampleAddressBook);
+        } catch (DataConversionException e) {
+            logger.warning("Data file not in the correct format.");
+            importData = new AddressBook();
+        } catch (IOException e) {
+            logger.warning("Problem while reading from the file.");
+            importData = new AddressBook();
+        }
+
+        for (int i = 0; i < importData.getPersonList().size(); i++) {
+            if (parsedIndex.contains(i) && !model.hasPerson(importData.getPersonList().get(i))) {
+                model.addPerson(importData.getPersonList().get(i));
+            }
+        }
+    }
+}
diff --git a/src/main/java/seedu/address/logic/parser/AddressBookParser.java b/src/main/java/seedu/address/logic/parser/AddressBookParser.java
@@ -13,9 +13,11 @@
 import seedu.address.logic.commands.DeleteCommand;
 import seedu.address.logic.commands.EditCommand;
 import seedu.address.logic.commands.ExitCommand;
+import seedu.address.logic.commands.ExportCommand;
 import seedu.address.logic.commands.FindCommand;
 import seedu.address.logic.commands.HelpCommand;
 import seedu.address.logic.commands.HistoryCommand;
+import seedu.address.logic.commands.ImportCommand;
 import seedu.address.logic.commands.ListCommand;
 import seedu.address.logic.commands.OpenCommand;
 import seedu.address.logic.commands.RedoCommand;
@@ -98,12 +100,21 @@ public Command parseCommand(String userInput) throws ParseException {
         case SaveCommand.COMMAND_WORD:
             return new SaveCommandParser().parse(arguments);
 
+        case ImportCommand.COMMAND_WORD:
+            return new ImportCommandParser().parse(arguments);
+
+        case ExportCommand.COMMAND_WORD:
+            return new ExportCommandParser().parse(arguments);
+
         case TaskAddCommand.COMMAND_WORD:
             return new TaskAddCommandParser().parse(arguments);
+
         case TaskEditCommand.COMMAND_WORD:
             return new TaskEditCommandParser().parse(arguments);
+
         case TaskDeleteCommand.COMMAND_WORD:
             return new TaskDeleteCommandParser().parse(arguments);
+
         default:
             throw new ParseException(MESSAGE_UNKNOWN_COMMAND);
         }
diff --git a/src/main/java/seedu/address/logic/parser/ExportCommandParser.java b/src/main/java/seedu/address/logic/parser/ExportCommandParser.java
@@ -0,0 +1,23 @@
+package seedu.address.logic.parser;
+
+import seedu.address.logic.commands.ExportCommand;
+import seedu.address.logic.parser.exceptions.ParseException;
+
+/**
+ * Parses input arguments and creates a new ExportCommand object.
+ */
+public class ExportCommandParser implements Parser<ExportCommand> {
+
+    /**
+     * Parses the given argument {@code String} in the context of the ExportCommand
+     * and returns an ExportCommand object for execution.
+     * @throws ParseException if the user input does not conform the expected format
+     */
+    public ExportCommand parse(String args) throws ParseException {
+        try {
+            return new ExportCommand(ParserUtil.parseImportExport(args));
+        } catch (ParseException pe) {
+            throw new ParseException(pe.getMessage());
+        }
+    }
+}
diff --git a/src/main/java/seedu/address/logic/parser/ImportCommandParser.java b/src/main/java/seedu/address/logic/parser/ImportCommandParser.java
@@ -0,0 +1,34 @@
+package seedu.address.logic.parser;
+
+import java.io.File;
+
+import seedu.address.logic.commands.ImportCommand;
+import seedu.address.logic.parser.exceptions.ParseException;
+import seedu.address.storage.ParsedInOut;
+
+/**
+ * Parses input arguments and creates a new ImportCommand object.
+ */
+public class ImportCommandParser implements Parser<ImportCommand> {
+
+    /**
+     * Parses the given argument {@code String} in the context of the ImportCommand
+     * and returns an ImportCommand object for execution.
+     * @throws ParseException if the user input does not conform the expected format
+     */
+    public ImportCommand parse(String args) throws ParseException {
+        try {
+            ParsedInOut parsedInOut = ParserUtil.parseImportExport(args);
+            importValidation(parsedInOut.getFile());
+            return new ImportCommand(parsedInOut);
+        } catch (ParseException pe) {
+            throw new ParseException(pe.getMessage());
+        }
+    }
+
+    private void importValidation(File file) throws ParseException {
+        if (!file.exists() || !file.isFile() || !file.canRead()) {
+            throw new ParseException("File is invalid");
+        }
+    }
+}
diff --git a/src/main/java/seedu/address/logic/parser/OpenCommandParser.java b/src/main/java/seedu/address/logic/parser/OpenCommandParser.java
@@ -17,7 +17,7 @@ public class OpenCommandParser implements Parser<OpenCommand> {
      */
     public OpenCommand parse(String args) throws ParseException {
         try {
-            File file = ParserUtil.parseFile(args);
+            File file = ParserUtil.parseOpenSave(args);
             openValidation(file);
             return new OpenCommand(file);
         } catch (ParseException pe) {
diff --git a/src/main/java/seedu/address/logic/parser/ParserUtil.java b/src/main/java/seedu/address/logic/parser/ParserUtil.java
@@ -6,6 +6,8 @@
 import java.util.Collection;
 import java.util.HashSet;
 import java.util.Set;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 
 import seedu.address.commons.core.index.Index;
 import seedu.address.commons.util.StringUtil;
@@ -19,6 +21,7 @@
 import seedu.address.model.person.Phone;
 import seedu.address.model.tag.Tag;
 import seedu.address.model.task.Title;
+import seedu.address.storage.ParsedInOut;
 
 /**
  * Contains utility methods used for parsing strings in the various *Parser classes.
@@ -205,10 +208,10 @@ public static Set<Tag> parseTags(Collection<String> tags) throws ParseException
      *
      * @throws ParseException if the given {@code file} is invalid.
      */
-    public static File parseFile(String filePath) throws ParseException {
+    public static File parseOpenSave(String filePath) throws ParseException {
         requireNonNull(filePath);
         filePath = filePath.trim();
-        final String validationRegex = "\\p{Alnum}+.(txt|xml|json)$";
+        final String validationRegex = "^([\\w-\\\\\\s.\\(\\)]+)+\\.(txt|xml|json)$";
 
         if (!filePath.matches(validationRegex)) {
             throw new ParseException("File name is invalid");
@@ -220,4 +223,59 @@ public static File parseFile(String filePath) throws ParseException {
 
         return file;
     }
+
+    /**
+     * Parses a {@code String file} and {@code Index} into a {@code ParsedIO}.
+     *
+     * @throws ParseException if the given {@code file} is invalid.
+     */
+    public static ParsedInOut parseImportExport(String input) throws ParseException {
+        requireNonNull(input);
+        input = input.trim();
+        final String validationRegex = "^([\\w-\\\\\\s.\\(\\)]+)+\\.(txt|xml|json)+\\s?([0-9,-]*)?$";
+
+        if (!input.matches(validationRegex)) {
+            throw new ParseException("File name is invalid or no index given");
+        }
+
+        String newPath = "data\\";
+        final Pattern splitRegex = Pattern.compile("([\\w-\\\\\\s.\\(\\)]+)+\\.(txt|xml|json)+\\s?([0-9,-]*)?");
+        Matcher splitMatcher = splitRegex.matcher(input);
+        String filepath = "";
+        String indexRange = "";
+
+        if (splitMatcher.find()) {
+            filepath = splitMatcher.group(1).concat(".");
+            filepath = filepath.concat(splitMatcher.group(2));
+            filepath = newPath.concat(filepath);
+            indexRange = splitMatcher.group(3);
+        } else {
+            // This shouldn't be possible after validationRegex
+            throw new ParseException("File name is invalid or no index given");
+        }
+
+        HashSet<Integer> parsedIndex = new HashSet<>();
+
+        String[] splitInput = indexRange.trim().split(",");
+        String[] splitRange;
+        final String singleNumberRegex = "^\\d+$";
+        final String rangeNumberRegex = "^(\\d+)-(\\d+)$";
+
+        for (String string : splitInput) {
+            if (string.matches(singleNumberRegex)) {
+                // -1 because indexes displayed to user starts with 1, not 0
+                parsedIndex.add(Integer.parseInt(string) - 1);
+            } else if (string.matches(rangeNumberRegex)) {
+                splitRange = string.split("-");
+                for (int i = Integer.parseInt(splitRange[0]); i < Integer.parseInt(splitRange[1]) + 1; i++) {
+                    // -1 because indexes displayed to user starts with 1, not 0
+                    parsedIndex.add(i - 1);
+                }
+            } else {
+                throw new ParseException("Invalid index range!");
+            }
+        }
+
+        return new ParsedInOut(new File(filepath), parsedIndex);
+    }
 }
diff --git a/src/main/java/seedu/address/logic/parser/SaveCommandParser.java b/src/main/java/seedu/address/logic/parser/SaveCommandParser.java
@@ -17,7 +17,7 @@ public class SaveCommandParser implements Parser<SaveCommand> {
      */
     public SaveCommand parse(String args) throws ParseException {
         try {
-            File file = ParserUtil.parseFile(args);
+            File file = ParserUtil.parseOpenSave(args);
             return new SaveCommand(file);
         } catch (ParseException pe) {
             throw new ParseException(pe.getMessage());
diff --git a/src/main/java/seedu/address/storage/ParsedInOut.java b/src/main/java/seedu/address/storage/ParsedInOut.java
