Merge pull request #81 from doubleSlashde/feature/IPTE-22_exportH2DatabaseToSqlScript

Feature/ipte 22 export h2 database to sql script

Author: Death111

CHANGELOG.md

@@ -6,6 +6,7 @@ All notable changes to this project will be documented in this file.
 
 ### Added
 
+- export functionality of database
 - search functionality
 - functionality to edit past work items
 - possibility to save position on screen

README.md

@@ -26,6 +26,7 @@ Create projects and choose if they are counted as 'work time'. Select the projec
 + Use Hotkey (`Strg`+`Win`): Change the project by using the Hotkey feature. A popup will appear at the mouse cursor.
 + Save Position on Screen: Remembers the last position of the Main UI on application start.
 + Ask for notes when switching project (if empty): Pops up a dialog to add notes if no notes are given and you try to switch projects
++ Export: export database for backup and later import (import currently not yet implemented)
 
 ### Reports:
 ![Report Screen](readme/images/reportDescription.png?raw=true "Report")
@@ -44,6 +45,14 @@ It is recommended to run the application at computer start so you do not forget
 
 You should put the .jar in an extra folder as a *logs* and a *db* folder will be created next to it.\
 
+### Migrate from old version
+
+1. Download new version and replace the .jar file.
+2. Start new version of KeepTime. Notice that your old data is not available.
+3. Stop KeepTime
+4. Copy the files (not directories) of directory `db` (next to the .jar file) into `db/1.4.197/` (path now includes the database version).
+5. Start KeepTime again. Notice that your data is available again.
+
 ## Requirements
 
 * Windows 7, 10

pom.xml

@@ -5,7 +5,7 @@
 
   <groupId>de.doubleslash</groupId>
   <artifactId>keeptime</artifactId>
-  <version>1.1.0-SNAPSHOT</version>
+  <version>1.2.0-SNAPSHOT</version>
   <packaging>jar</packaging>
 
   <name>KeepTime</name>
@@ -55,6 +55,8 @@
     <maven.compiler.source>1.8</maven.compiler.source>
     <maven.compiler.target>1.8</maven.compiler.target>
 
+    <h2.version>1.4.197</h2.version>
+
     <maven-dependency-check.version>6.0.5</maven-dependency-check.version>
     <!-- USING HTML,XML (comma-separated list) did not work with plugin version 5.1.0 -->
     <maven-dependency-check.format>ALL</maven-dependency-check.format>
@@ -72,8 +74,7 @@
     <dependency>
       <groupId>com.h2database</groupId>
       <artifactId>h2</artifactId>
-      <scope>runtime</scope>
-      <version>1.4.197</version>
+      <version>${h2.version}</version>
     </dependency>
     <dependency>
       <groupId>org.springframework.boot</groupId>
@@ -130,6 +131,14 @@
         <artifactId>spring-boot-maven-plugin</artifactId>
       </plugin>
 
+      <plugin>
+        <groupId>pl.project13.maven</groupId>
+        <artifactId>git-commit-id-plugin</artifactId>
+        <configuration>
+          <generateGitPropertiesFile>false</generateGitPropertiesFile>
+        </configuration>
+      </plugin>
+
       <plugin>
         <artifactId>maven-assembly-plugin</artifactId>
         <executions>

readme/images/report.png

@@ -0,0 +1,112 @@
+package de.doubleslash.keeptime;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.stereotype.Service;
+
+@Service
+public class ApplicationProperties {
+
+   private String buildVersion;
+   private String buildTimestamp;
+
+   private String h2Version;
+
+   private String springDataSourceUrl;
+   private String springDataSourceUserName;
+   private String springDataSourcePassword;
+
+   private String gitCommitId;
+   private String gitCommitTime;
+   private String gitBranch;
+   private String gitDirty;
+
+   public String getBuildVersion() {
+      return buildVersion;
+   }
+
+   @Value("${build.version}")
+   private void setBuildVersion(String projectVersion) {
+      this.buildVersion = projectVersion;
+   }
+
+   public String getBuildTimestamp() {
+      return buildTimestamp;
+   }
+
+   @Value("${build.timestamp}")
+   public void setBuildTimestamp(String buildTimestamp) {
+      this.buildTimestamp = buildTimestamp;
+   }
+
+   public String getH2Version() {
+      return this.h2Version;
+   }
+
+   @Value("${h2.version}")
+   private void setH2Version(final String h2Version) {
+      this.h2Version = h2Version;
+   }
+
+   public String getSpringDataSourceUrl() {
+      return springDataSourceUrl;
+   }
+
+   @Value("${spring.datasource.url}")
+   private void setSpringDataSourceUrl(String springDataSourceUrl) {
+      this.springDataSourceUrl = springDataSourceUrl;
+   }
+
+   public String getSpringDataSourceUserName() {
+      return springDataSourceUserName;
+   }
+
+   @Value("${spring.datasource.username}")
+   private void setSpringDataSourceUserName(String springDataSourceUserName) {
+      this.springDataSourceUserName = springDataSourceUserName;
+   }
+
+   public String getSpringDataSourcePassword() {
+      return springDataSourcePassword;
+   }
+
+   @Value("${spring.datasource.password}")
+   private void setSpringDataSourcePassword(String springDataSourcePassword) {
+      this.springDataSourcePassword = springDataSourcePassword;
+   }
+
+   public String getGitCommitId() {
+      return gitCommitId;
+   }
+
+   @Value("${git.commit.id}")
+   private void setGitCommitId(String gitCommitId) {
+      this.gitCommitId = gitCommitId;
+   }
+
+   public String getGitCommitTime() {
+      return gitCommitTime;
+   }
+
+   @Value("${git.commit.time}")
+   private void setGitCommitTime(String gitCommitTime) {
+      this.gitCommitTime = gitCommitTime;
+   }
+
+   public String getGitBranch() {
+      return gitBranch;
+   }
+
+   @Value("${git.branch}")
+   private void setGitBranch(String gitBranch) {
+      this.gitBranch = gitBranch;
+   }
+
+   public String getGitDirty() {
+      return gitDirty;
+   }
+
+   @Value("${git.dirty}")
+   private void setGitDirty(String gitDirty) {
+      this.gitDirty = gitDirty;
+   }
+}

readme/images/reportDescription.png

@@ -65,8 +65,6 @@ public class Main extends Application {
 
    private static final Logger LOG = LoggerFactory.getLogger(Main.class);
 
-   public static final String VERSION = "v1.1.0";
-
    private ConfigurableApplicationContext springContext;
 
    private Stage popupViewStage;
@@ -81,12 +79,18 @@ public class Main extends Application {
 
    @Override
    public void init() throws Exception {
-      LOG.info("Starting KeepTime {}", VERSION);
+      LOG.info("Starting KeepTime.");
       final DefaultExceptionHandler defaultExceptionHandler = new DefaultExceptionHandler();
       defaultExceptionHandler.register();
 
       springContext = SpringApplication.run(Main.class);
-      // TODO test if everywhere is used the same model
+      ApplicationProperties applicationProperties = springContext.getBean(ApplicationProperties.class);
+      LOG.info("KeepTime Version: '{}'.", applicationProperties.getBuildVersion());
+      LOG.info("KeepTime Build Timestamp: '{}'.", applicationProperties.getBuildTimestamp());
+      LOG.info("KeepTime Git Infos: id '{}', branch '{}', time '{}', dirty '{}'.",
+            applicationProperties.getGitCommitId(), applicationProperties.getGitBranch(),
+            applicationProperties.getGitCommitTime(), applicationProperties.getGitDirty());
+
       model = springContext.getBean(Model.class);
       controller = springContext.getBean(Controller.class);
       model.setSpringContext(springContext);
@@ -137,8 +141,7 @@ private void initialiseApplication(final Stage primaryStage) throws Exception {
       FontProvider.loadFonts();
       readSettings();
 
-      final List<Work> todaysWorkItems = model.getWorkRepository()
-            .findByStartDateOrderByStartTimeAsc(LocalDate.now());
+      final List<Work> todaysWorkItems = model.getWorkRepository().findByStartDateOrderByStartTimeAsc(LocalDate.now());
       LOG.info("Found {} past work items", todaysWorkItems.size());
       model.getPastWorkItems().addAll(todaysWorkItems);
 
@@ -153,7 +156,7 @@ private void initialiseApplication(final Stage primaryStage) throws Exception {
 
       model.getAllProjects().addAll(projects);
       model.getAvailableProjects()
-            .addAll(model.getAllProjects().stream().filter(Project::isEnabled).collect(Collectors.toList()));
+           .addAll(model.getAllProjects().stream().filter(Project::isEnabled).collect(Collectors.toList()));
 
       // set default project
       final Optional<Project> findAny = projects.stream().filter(Project::isDefault).findAny();

readme/images/settings.png

@@ -22,6 +22,7 @@
 import org.slf4j.LoggerFactory;
 import org.springframework.stereotype.Component;
 
+import de.doubleslash.keeptime.ApplicationProperties;
 import de.doubleslash.keeptime.Main;
 import de.doubleslash.keeptime.common.BrowserHelper;
 import de.doubleslash.keeptime.common.FileOpenHelper;
@@ -67,10 +68,16 @@ public class AboutController {
 
    private static final Logger LOG = LoggerFactory.getLogger(AboutController.class);
 
+   private final ApplicationProperties applicationProperties;
+
+   public AboutController (ApplicationProperties applicationProperties) {
+	   this.applicationProperties = applicationProperties;
+   }
+   
    @FXML
    public void initialize() {
       LOG.debug("set version label");
-      versionNumberLabel.setText(Main.VERSION);
+      versionNumberLabel.setText(applicationProperties.getBuildVersion());
 
       ourLicenseHyperLink.setFocusTraversable(false);
       ourLicenseHyperLink.setOnAction(ae -> showLicense(Licenses.GPLV3));

src/main/java/de/doubleslash/keeptime/ApplicationProperties.java

@@ -16,13 +16,18 @@
 
 package de.doubleslash.keeptime.view;
 
+import java.io.File;
 import java.io.IOException;
+import java.nio.file.Paths;
+import java.sql.SQLException;
 
+import org.h2.tools.Script;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
 
+import de.doubleslash.keeptime.ApplicationProperties;
 import de.doubleslash.keeptime.common.OS;
 import de.doubleslash.keeptime.common.Resources;
 import de.doubleslash.keeptime.common.Resources.RESOURCE;
@@ -43,6 +48,8 @@
 import javafx.scene.layout.AnchorPane;
 import javafx.scene.layout.Region;
 import javafx.scene.paint.Color;
+import javafx.stage.FileChooser;
+import javafx.stage.FileChooser.ExtensionFilter;
 import javafx.stage.Modality;
 import javafx.stage.Stage;
 
@@ -91,6 +98,9 @@ public class SettingsController {
    @FXML
    private Button cancelButton;
 
+   @FXML
+   private Button exportButton;
+
    @FXML
    private Button aboutButton;
 
@@ -106,6 +116,7 @@ public class SettingsController {
 
    private final Controller controller;
    private final Model model;
+   private final ApplicationProperties applicationProperties;
 
    private Stage thisStage;
 
@@ -115,9 +126,11 @@ public class SettingsController {
    ViewController mainscreen;
 
    @Autowired
-   public SettingsController(final Model model, final Controller controller) {
+   public SettingsController(final Model model, final Controller controller,
+         ApplicationProperties applicationProperties) {
       this.model = model;
       this.controller = controller;
+      this.applicationProperties = applicationProperties;
    }
 
    @FXML
@@ -136,6 +149,8 @@ private void initialize() {
          globalKeyloggerLabel.setDisable(true);
       }
 
+      initExportButton();
+
       LOG.debug("saveButton.setOnAction");
       saveButton.setOnAction(ae -> {
          LOG.info("Save clicked");
@@ -203,11 +218,11 @@ private void initialize() {
       });
 
       LOG.debug("resetButton.setOnAction");
-      resetHoverBackgroundButton
-            .setOnAction(ae -> hoverBackgroundColor.setValue(Model.ORIGINAL_HOVER_BACKGROUND_COLOR));
+      resetHoverBackgroundButton.setOnAction(
+            ae -> hoverBackgroundColor.setValue(Model.ORIGINAL_HOVER_BACKGROUND_COLOR));
       resetHoverFontButton.setOnAction(ae -> hoverFontColor.setValue(Model.ORIGINAL_HOVER_Font_COLOR));
-      resetDefaultBackgroundButton
-            .setOnAction(ae -> defaultBackgroundColor.setValue(Model.ORIGINAL_DEFAULT_BACKGROUND_COLOR));
+      resetDefaultBackgroundButton.setOnAction(
+            ae -> defaultBackgroundColor.setValue(Model.ORIGINAL_DEFAULT_BACKGROUND_COLOR));
       resetDefaultFontButton.setOnAction(ae -> defaultFontColor.setValue(Model.ORIGINAL_DEFAULT_FONT_COLOR));
       resetTaskBarFontButton.setOnAction(ae -> taskBarColor.setValue(Model.ORIGINAL_TASK_BAR_FONT_COLOR));
 
@@ -218,6 +233,51 @@ private void initialize() {
       });
    }
 
+   private void initExportButton() {
+      LOG.debug("Initialize exportButton.");
+      exportButton.setOnAction(actionEvent -> {
+         LOG.info("Button pressed: exportButton");
+
+         try {
+            final String h2Version = applicationProperties.getH2Version();
+
+            final FileChooser fileChooser = new FileChooser();
+            fileChooser.setInitialDirectory(Paths.get(".").toFile());
+            fileChooser.setInitialFileName(String.format("KeepTime_database-export_H2-version-%s.sql", h2Version));
+            fileChooser.getExtensionFilters().add(new ExtensionFilter("SQL script files.", "*.sql"));
+            final File fileToSave = fileChooser.showSaveDialog(thisStage);
+            if (fileToSave == null) {
+               LOG.info("User canceled export.");
+               return;
+            }
+
+            final String url = applicationProperties.getSpringDataSourceUrl();
+            final String username = applicationProperties.getSpringDataSourceUserName();
+            final String password = applicationProperties.getSpringDataSourcePassword();
+
+            LOG.info("Exporting database to '{}'.", fileToSave);
+            Script.process(url, username, password, fileToSave.getAbsolutePath(), "DROP", "");
+            LOG.info("Export done.");
+
+            Alert informationDialog = new Alert(AlertType.INFORMATION);
+            informationDialog.setTitle("Export done");
+            informationDialog.setHeaderText("The current data was exported.");
+            informationDialog.setContentText("The data was exported to '" + fileToSave + "'.");
+
+            informationDialog.showAndWait();
+         } catch (final SQLException e) {
+            LOG.error("Could not export db to script file.", e);
+
+            Alert errorDialog = new Alert(AlertType.ERROR);
+            errorDialog.setTitle("Export failed");
+            errorDialog.setHeaderText("The current data could not be exported.");
+            errorDialog.setContentText("Please inform a developer and provide your log file.");
+
+            errorDialog.showAndWait();
+         }
+      });
+   }
+
    void update() {
       // needed to close stage on esc
       settingsRoot.requestFocus();