Merge branch 'dev' into feature_weather

This commit is contained in:
Gian-Andrea Hutter 2022-12-11 15:15:19 +01:00
commit dbba4e2662
23 changed files with 216 additions and 56 deletions

View File

@ -12,6 +12,7 @@ import ch.zhaw.gartenverwaltung.types.Crop;
import ch.zhaw.gartenverwaltung.types.Pest;
import ch.zhaw.gartenverwaltung.types.Plant;
import ch.zhaw.gartenverwaltung.types.Task;
import javafx.application.Platform;
import javafx.beans.property.ListProperty;
import javafx.beans.property.SimpleListProperty;
import javafx.collections.FXCollections;
@ -133,8 +134,14 @@ public class CropDetailController {
initializeTaskListProperty(crop);
TaskList.TaskListObserver taskListObserver = newTaskList -> {
taskListProperty.clear();
taskListProperty.addAll(gardenSchedule.getTaskListForCrop(crop.getCropId().get()));
Platform.runLater(() -> {
taskListProperty.clear();
try {
taskListProperty.addAll(gardenSchedule.getTaskListForCrop(crop.getCropId().get()));
} catch (IOException e) {
e.printStackTrace();
}
});
};
gardenSchedule.setTaskListObserver(taskListObserver);

View File

@ -13,30 +13,46 @@ import javafx.stage.Stage;
import java.io.IOException;
import java.util.Timer;
/**
* Main class of the Application
*/
public class Main extends Application {
Timer backGroundTaskTimer = new Timer();
BackgroundTasks backgroundTasks;
/**
* Method which is automatically called if Application is starting. It loads the scenes to stage and shows the stage.
* It creates a new Instance of BackgroundTasks and schedules them with a Timer instance to execute them every minute.
* @param stage Stage to show
* @throws IOException If loading Scenes can not access the fxml Resource File
*/
@Override
public void start(Stage stage) throws IOException {
AppLoader appLoader = new AppLoader();
backgroundTasks = new BackgroundTasks((TaskList) appLoader.getAppDependency(TaskList.class),(CropList) appLoader.getAppDependency(CropList.class), (PlantList) appLoader.getAppDependency(PlantList.class));
appLoader.loadSceneToStage("MainFXML.fxml", stage);
stage.setTitle("Gartenverwaltung");
stage.show();
backgroundTasks = new BackgroundTasks((TaskList) appLoader.getAppDependency(TaskList.class),(CropList) appLoader.getAppDependency(CropList.class), (PlantList) appLoader.getAppDependency(PlantList.class));
backGroundTaskTimer.scheduleAtFixedRate(backgroundTasks, 0, 60000);
}
/**
* Method which is automatically called when application is stopped.
* It cancels the timer to not execute the background tasks anymore.
*/
@Override
public void stop(){
backGroundTaskTimer.cancel();
}
/**
* The Main method launches the application
* @param args There are no arguments needed.
*/
public static void main(String[] args) {
launch();
}

View File

@ -24,6 +24,7 @@ import javafx.scene.layout.VBox;
import java.io.IOException;
import java.time.LocalDate;
import java.util.List;
import java.util.Objects;
import java.util.logging.Level;
import java.util.logging.Logger;
@ -208,6 +209,12 @@ public class MyScheduleController {
alert.setHeaderText("Are you sure you have completed this task?");
alert.setContentText("Confirming that you have completed the task will remove it from the schedule.");
DialogPane dialogPane = alert.getDialogPane();
dialogPane.getStylesheets().add(
Objects.requireNonNull(getClass().getResource("bootstrap/dialogStyle.css")).toExternalForm());
dialogPane.getStyleClass().add("myDialog");
alert.showAndWait()
.ifPresent(buttonType -> {
if (buttonType == ButtonType.OK) {

View File

@ -6,21 +6,58 @@ import javafx.beans.property.BooleanProperty;
import javafx.beans.property.SimpleBooleanProperty;
import java.util.List;
import java.util.Objects;
/**
* Singleton Class to store default Settings and User Settings
*/
public class Settings {
private static final Settings instance;
private HardinessZone currentHardinessZone = HardinessZone.ZONE_8A;
private final BooleanProperty showTutorial = new SimpleBooleanProperty(false);
private SmtpCredentials smtpCredentials = new SmtpCredentials("imap.gmail.com", "587", "pm3.hs22.it21b.win.team1@gmail.com", "pm3.hs22.it21b.win.team1@gmail.com", "bisefhhjtrrhtoqr", true);
// Gmail Address: pm3.hs22.it21b.win.team1@gmail.com
// Gmail Passwort: Gartenverwaltung.PM3.2022
// E-Mail Inbox: https://www.mailinator.com/v4/public/inboxes.jsp?to=pm3.hs22.it21b.win.team1
private String mailNotificationReceivers = "pm3.hs22.it21b.win.team1@mailinator.com";
private String mailNotificationSubjectTemplate = "Task %s is due!"; // {0} = Task Name
private String mailNotificationTextTemplate = "Dear user\nYour gardentask %s for plant %s is due at %tF. Don't forget to confirm in your application if the task is done.\nTask description:\n%s"; // {0} = Task Name, {1} = plantname, {2} = nextExecution, {3} = Task description
/*
* The Class instance to use everywhere
*/
private static final Settings instance;
/**
* The current Hardiness zone initialized as default value Zone_8A
*/
private HardinessZone currentHardinessZone = HardinessZone.ZONE_8A;
/**
* Setting to show or hide the Tutorial in Main Menu
*/
private final BooleanProperty showTutorial = new SimpleBooleanProperty(false);
/**
* The SMTP Credentials which are used to send E-Mail Notifications
* The following Google Account is created for Testing:
* E-Mail Address: pm3.hs22.it21b.win.team1@gmail.com
* Account Password: Gartenverwaltung.PM3.2022
* SMTP Password: bisefhhjtrrhtoqr
*/
private SmtpCredentials smtpCredentials = new SmtpCredentials("imap.gmail.com", "587", "pm3.hs22.it21b.win.team1@gmail.com", "pm3.hs22.it21b.win.team1@gmail.com", "bisefhhjtrrhtoqr", true);
/**
* List of Receivers for E-Mailnotifications. Multiple E-Mailadresses can be separated by ";"
* Following Public E-mail address was used for Testing: pm3.hs22.it21b.win.team1@mailinator.com
* The E-Mail inbox of this address can be found here: https://www.mailinator.com/v4/public/inboxes.jsp?to=pm3.hs22.it21b.win.team1
*/
private String mailNotificationReceivers = "pm3.hs22.it21b.win.team1@mailinator.com";
/**
* String Template to create E-Mail Subject for Notifications
* Variables: Task Name
*/
private String mailNotificationSubjectTemplate = "Task %s is due!";
/**
* String Template to create E-Mail Text for Notifications
* Variables: Task Name, plant Name, nextExecution, Task description
*/
private String mailNotificationTextTemplate = "Dear user\nYour gardentask %s for plant %s is due at %tF. Don't forget to confirm in your application if the task is done.\nTask description:\n%s";
/**
* Location of the garden can be set by user (Used for Weather Service)
*/
private String location = "";
/*
Create Instance of Settings
*/
static {
instance = new Settings();
}
@ -29,14 +66,21 @@ public class Settings {
return Settings.instance;
}
/**
* Private constructor to prevent Classes from creating more instances
*/
private Settings() {}
public HardinessZone getCurrentHardinessZone() {
return currentHardinessZone;
}
/**
* Method to set the current Hardiness Zone. If no Hardiness Zone is given the default zone (ZONE_8A) will be used.
* @param currentHardinessZone the new Hardiness Zone
*/
public void setCurrentHardinessZone(HardinessZone currentHardinessZone) {
this.currentHardinessZone = currentHardinessZone;
this.currentHardinessZone = Objects.requireNonNullElse(currentHardinessZone, HardinessZone.ZONE_8A);
}
public void setShowTutorial (boolean showTutorial) {

View File

@ -7,6 +7,7 @@ import javafx.scene.image.Image;
import javafx.scene.image.ImageView;
import javafx.scene.layout.StackPane;
import javafx.stage.Stage;
import java.io.File;
/**
* Controller class for the Tutorial.fxml file
@ -32,17 +33,27 @@ public class TutorialController {
switchViews();
setButtonAbilities();
Image addNewPlantImage = new Image(String.valueOf(PlantsController.class.getResource("add-new-plant.png")));
Image selectSowHarvestImage = new Image(String.valueOf(PlantsController.class.getResource("select-sow-harvest.png")));
Image scheduleImage = new Image(String.valueOf(PlantsController.class.getResource("schedule.png")));
Image detailDeleteButtonsImage = new Image(String.valueOf(PlantsController.class.getResource("details-delete.png")));
Image addTaskImage = new Image(String.valueOf(PlantsController.class.getResource("add-task.png")));
setImageView(imgAddNewPlant, "add-new-plant.png");
setImageView(imgSelectDate, "select-sow-harvest.png");
setImageView(imgDetailDeleteButtons, "details-delete.png");
setImageView(imgTaskList, "schedule.png");
setImageView(imgAddTaskButton, "add-task.png");
}
imgAddNewPlant.setImage(addNewPlantImage);
imgSelectDate.setImage(selectSowHarvestImage);
imgDetailDeleteButtons.setImage(detailDeleteButtonsImage);
imgAddTaskButton.setImage(addTaskImage);
imgTaskList.setImage(scheduleImage);
/**
* update the given image view with screenshot or placeholder image.
* @param imageView the image view to update
* @param fileName the file name of the source
*/
private void setImageView(ImageView imageView, String fileName) {
File file = new File(String.valueOf(PlantsController.class.getResource(fileName)));
Image image;
if (file.exists()) {
image = new Image(String.valueOf(PlantsController.class.getResource(fileName)));
} else {
image = new Image(String.valueOf(PlantsController.class.getResource("placeholder.png")));
}
imageView.setImage(image);
}
public void viewNextPage() {

View File

@ -17,14 +17,27 @@ import java.util.TimerTask;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* Class with tasks which must be executed periodic and not triggered by user. Method run must be called in a fix interval.
*/
public class BackgroundTasks extends TimerTask {
private static final Logger LOG = Logger.getLogger(CropDetailController.class.getName());
private final TaskList taskList;
private final Notifier notifier;
private final WeatherGradenTaskPlanner weatherGardenTaskPlaner;
public BackgroundTasks(TaskList taskList, CropList cropList, PlantList plantList) {
this.taskList = taskList;
notifier = new Notifier(taskList, plantList, cropList);
weatherGardenTaskPlaner = new WeatherGradenTaskPlanner(taskList, plantList, cropList);
}
/**
* Changes the field "nextExecution" of all tasks if it's in the past to the actual date as long as they are not done.
* @throws IOException if the taskList can't be read.
*/
private void movePastTasks() throws IOException {
List<Task> taskList = this.taskList.getTaskList(LocalDate.MIN, LocalDate.now().minusDays(1));
List<Task> taskList = this.taskList.getTaskList(LocalDate.MIN.plusDays(1), LocalDate.now().minusDays(1));
for (Task task : taskList) {
if (!task.isDone()) {
task.setNextExecution(LocalDate.now());
@ -33,31 +46,28 @@ public class BackgroundTasks extends TimerTask {
}
}
public BackgroundTasks(TaskList taskList, CropList cropList, PlantList plantList) {
this.taskList = taskList;
notifier = new Notifier(taskList, plantList, cropList);
weatherGardenTaskPlaner = new WeatherGradenTaskPlanner(taskList, plantList, cropList);
}
/**
* Method to call if Tasks should be executed. It calls all Background tasks after each other.
*/
@Override
public void run() {
try {
movePastTasks();
} catch (IOException e) {
e.printStackTrace();
LOG.log(Level.SEVERE, "Could not execute Background Task: move past Tasks ", e.getCause());
LOG.log(Level.WARNING, "Could not execute Background Task: move past Tasks ", e.getCause());
}
try {
weatherGardenTaskPlaner.refreshTasks();
} catch (IOException | HardinessZoneNotSetException | PlantNotFoundException e) {
e.printStackTrace();
LOG.log(Level.SEVERE, "Could not execute Background Task: Refresh Tasks by WeatherGardenTaskPlaner ", e.getCause());
LOG.log(Level.WARNING, "Could not execute Background Task: Refresh Tasks by WeatherGardenTaskPlaner ", e.getCause());
}
try {
notifier.sendNotifications();
} catch (IOException | MessagingException | HardinessZoneNotSetException e) {
e.printStackTrace();
LOG.log(Level.SEVERE, "Could not execute Background Task: send Notification for due Tasks", e.getCause());
LOG.log(Level.WARNING, "Could not execute Background Task: send Notification for due Tasks", e.getCause());
}
}
}

View File

@ -13,6 +13,9 @@ import javax.mail.MessagingException;
import java.io.IOException;
import java.time.LocalDate;
/**
* Class to send Notifications to the user
*/
public class Notifier {
private final TaskList taskList;
private final CropList cropList;
@ -25,6 +28,13 @@ public class Notifier {
this.plantList = plantList;
}
/**
* Method to send a Notification to the user for e specific Task
* @param task The task to use for notification
* @throws IOException if tasklist can not be read
* @throws MessagingException if E-Mail can not be sent for any reason
* @throws HardinessZoneNotSetException if hardiness zone is not set in plant list.
*/
private void sendNotification(Task task) throws IOException, MessagingException, HardinessZoneNotSetException {
String plantName = "unkown plant";
if(cropList.getCropById((task.getCropId())).isPresent()){
@ -38,6 +48,12 @@ public class Notifier {
eMailSender.sendMails(Settings.getInstance().getMailNotificationReceivers(), messageSubject, messageText);
}
/**
* Sends a notification to the user for each task which is due and not done every day as long as it's not done.
* @throws IOException if tasklist can not be read
* @throws MessagingException if E-Mail can not be sent for any reason
* @throws HardinessZoneNotSetException if hardiness zone is not set in plant list.
*/
public void sendNotifications() throws IOException, MessagingException, HardinessZoneNotSetException {
for (Task task : taskList.getTaskList(LocalDate.MIN, LocalDate.MAX)) {
if (task.getNextNotification() != null && task.getNextNotification().isBefore(LocalDate.now().minusDays(1))) {

View File

@ -10,16 +10,20 @@ import java.util.Arrays;
import java.util.Date;
import java.util.List;
/**
* Class to send E-Mails
*/
public class EMailSender {
public EMailSender(){
}
/**
* Method to send E-Mail to one or multiple recipients
* @param recipients recipients E-Mail addresses separated by ";"
* @param subject Subject of the E-Mail
* @param text E-Mail message Text as rear text or html
* @throws MessagingException If sending the E-Mail fails for any reason
*/
public void sendMails(String recipients, String subject, String text) throws MessagingException {
// TODO replace printMail with implementation
printMail(recipients, subject, text); // TODO Remove Printing E-Mail to console to test it
printMail(recipients, subject, text);
MimeMessage message = new MimeMessage(Settings.getInstance().getSmtpCredentials().getSession());
message.addHeader("Content-type", "text/HTML; charset=UTF-8");
message.addHeader("format", "flowed");

View File

@ -5,6 +5,10 @@ import javax.mail.Session;
import java.net.Authenticator;
import java.util.Properties;
/**
* Class to store SMTP Credentials to send E-Mails and create
* corresponding Session Object
*/
public record SmtpCredentials(
String host,
String port,
@ -14,6 +18,10 @@ public record SmtpCredentials(
boolean startTLS
) {
/**
* Creates a Properties Object with SMTP Server Information
* @return the created Properties Object
*/
private Properties getProperties() {
Properties properties = new Properties();
properties.put("mail.smtp.host", host);
@ -23,6 +31,10 @@ public record SmtpCredentials(
return properties;
}
/**
* Creates a javax.mail.Authenticator Object with username and password for SMTP Server
* @return the created javax.mail.Authenticator Object
*/
private javax.mail.Authenticator getAuthenticator() {
return new javax.mail.Authenticator() {
@Override
@ -32,10 +44,11 @@ public record SmtpCredentials(
};
}
/**
* Method to get the Session Instance with the given SMTP Credentials
* @return the Session Instance
*/
public Session getSession() {
return Session.getInstance(getProperties(), getAuthenticator());
}
}

View File

@ -1,5 +1,8 @@
package ch.zhaw.gartenverwaltung.backgroundtasks.weather;
/**
* Enum of possible Weather events
*/
public enum SevereWeather {
FROST,SNOW,HAIL,NO_SEVERE_WEATHER,RAIN
}

View File

@ -17,7 +17,6 @@ import static java.util.stream.Collectors.toList;
/**
* The WeatherGardenTaskPlanner creates Tasks based on weather events and the rain amount from the last days
*
*/
public class WeatherGradenTaskPlanner {
private final TaskList taskList;

View File

@ -1,7 +1,6 @@
package ch.zhaw.gartenverwaltung.backgroundtasks.weather;
/**
* The WeatherService is a class to cause weather events for the WeatherGardenTaskPlanner
*
*/
public class WeatherService {
private static final int NO_RAIN = 0;
@ -9,6 +8,11 @@ public class WeatherService {
private static final int RAIN = 25;
private static final int HEAVY_RAIN = 50;
/**
* Method to simmulate a Weather Service for testing
* @param randomWeather random int. Range: 1-3
* @return the selected SevereWeather
*/
public SevereWeather causeSevereWeather(int randomWeather) {
return switch (randomWeather) {
case 1 -> SevereWeather.HAIL;
@ -19,6 +23,11 @@ public class WeatherService {
}
/**
* Method to simulate a Weather Service for testing
* @param randomRainAmount random int. Range: 1-4
* @return the selected rain amount
*/
public int causeRainAmount(int randomRainAmount) {
return switch (randomRainAmount) {
case 1 -> NO_RAIN;

View File

@ -1,5 +1,6 @@
package ch.zhaw.gartenverwaltung.bootstrap;
import ch.zhaw.gartenverwaltung.CropDetailController;
import ch.zhaw.gartenverwaltung.Main;
import ch.zhaw.gartenverwaltung.io.*;
import ch.zhaw.gartenverwaltung.models.Garden;
@ -17,12 +18,15 @@ import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
* Class responsible for bootstrapping the application wide dependencies
* and injecting them into JavaFX Controllers.
*/
public class AppLoader {
private static final Logger LOG = Logger.getLogger(CropDetailController.class.getName());
/**
* Caching the panes
*/
@ -146,12 +150,17 @@ public class AppLoader {
try {
afterInjectMethod.invoke(controller);
} catch (IllegalAccessException | InvocationTargetException e) {
// TODO: Log
LOG.log(Level.SEVERE, "Could not invoke afterInjectMethod", e.getCause());
e.printStackTrace();
}
});
}
/**
* Method to get any AppDependency
* @param type Class of Dependency
* @return the App dependency
*/
public Object getAppDependency(Class<?> type) {
return dependencies.get(type.getSimpleName());
}

View File

@ -1,5 +1,8 @@
package ch.zhaw.gartenverwaltung.io;
/**
* Exceptionm which is thrown if Hardiness zone is not set in plant list.
*/
public class HardinessZoneNotSetException extends Exception {
public HardinessZoneNotSetException() {
super("HardinessZone must be set to retrieve plants!");

View File

@ -2,6 +2,9 @@ package ch.zhaw.gartenverwaltung.io;
import java.io.IOException;
/**
* Excption which is thrown if a JSON file has a invalid File format.
*/
class InvalidJsonException extends IOException {
public InvalidJsonException(String reason) {
super(reason);

View File

@ -171,6 +171,7 @@ public class GardenSchedule {
do {
if (date.equals(task.getNextExecution()) || (date.equals(checkDate) && !date.isAfter(task.getEndDate().orElse(LocalDate.MIN)))) {
dayTaskList.get(finalI).add(task);
break;
}
checkDate = checkDate.plusDays(task.getInterval().orElse(0));
} while (!(task.getInterval().orElse(0) == 0) && checkDate.isBefore(LocalDate.now().plusDays(listLength)));

View File

@ -1,5 +1,6 @@
package ch.zhaw.gartenverwaltung.models;
import ch.zhaw.gartenverwaltung.Settings;
import ch.zhaw.gartenverwaltung.io.HardinessZoneNotSetException;
import ch.zhaw.gartenverwaltung.io.PlantList;
import ch.zhaw.gartenverwaltung.types.GrowthPhaseType;
@ -16,7 +17,6 @@ import java.util.stream.Collectors;
public class PlantListModel {
private final PlantList plantList;
private HardinessZone currentZone;
/**
* Comparators to create sorted Plant List
@ -33,15 +33,15 @@ public class PlantListModel {
}
private void setDefaultZone() {
currentZone = HardinessZone.ZONE_8A; // TODO: get Default Zone from Settings
Settings.getInstance().setCurrentHardinessZone(null);
}
public void setCurrentZone(HardinessZone currentZone) {
this.currentZone = currentZone;
Settings.getInstance().setCurrentHardinessZone(currentZone);
}
public HardinessZone getCurrentZone() {
return currentZone;
return Settings.getInstance().getCurrentHardinessZone();
}
/**

View File

@ -1,5 +1,8 @@
package ch.zhaw.gartenverwaltung.models;
/**
* Exception which is thrown if there is no plant in plant Database with the given id.
*/
public class PlantNotFoundException extends Exception {
public PlantNotFoundException() {
super("The selected Plant was not found in Database!");

View File

@ -40,7 +40,6 @@ public class Crop {
public Optional<Long> getCropId() {
return Optional.ofNullable(cropId);
}
public long getPlantId() { return plantId; }
public LocalDate getStartDate() { return startDate; }
public double getArea() { return area; }

View File

@ -68,7 +68,7 @@ public record Plant(
return growthPhase.group();
}
}
return 0; // TODO implement
return 0;
}
/**

View File

@ -4,6 +4,9 @@ import com.fasterxml.jackson.annotation.JsonProperty;
import java.time.LocalDate;
/**
* Class which represents a Task if the start and enddate is not known yet.
*/
public class TaskTemplate {
@JsonProperty
private final String name;

View File

@ -14,7 +14,7 @@
<?import javafx.scene.text.Text?>
<?import javafx.scene.text.TextFlow?>
<BorderPane maxHeight="470.0" maxWidth="724.0" minHeight="470.0" minWidth="724.0" prefHeight="470.0" prefWidth="724.0" xmlns="http://javafx.com/javafx/19" xmlns:fx="http://javafx.com/fxml/1" fx:controller="ch.zhaw.gartenverwaltung.TutorialController">
<BorderPane maxHeight="470.0" maxWidth="724.0" minHeight="470.0" minWidth="724.0" prefHeight="470.0" prefWidth="724.0" xmlns="http://javafx.com/javafx/17" xmlns:fx="http://javafx.com/fxml/1" fx:controller="ch.zhaw.gartenverwaltung.TutorialController">
<bottom>
<HBox alignment="CENTER" prefHeight="0.0" prefWidth="724.0" BorderPane.alignment="CENTER">
<children>

View File

@ -101,7 +101,7 @@ class PlantListModelTest {
@Test
void setCurrentZone() {
checkCurrentZone(HardinessZone.ZONE_8A); // TODO change to get default zone from config
checkCurrentZone(HardinessZone.ZONE_8A);
model.setCurrentZone(HardinessZone.ZONE_1A);
checkCurrentZone(HardinessZone.ZONE_1A);
model.setCurrentZone(HardinessZone.ZONE_8A);