feat: add automatic backups #23

Author: johannesjo

app-src/scripts/_app.js

@@ -44,7 +44,7 @@
     .run(initGlobalShortcuts)
     .run(showWelcomeDialog)
     .run(goToWorkViewIfTasks)
-    .run(initPollAutomaticBackups);
+    .run(iniAutomaticBackupsIfEnabled);
 
   /* @ngInject */
   function configMarked(markedProvider) {
@@ -226,11 +226,9 @@
   }
 
   /* @ngInject */
-  function initPollAutomaticBackups(BACKUP_POLL_INTERVAL, $interval, IS_ELECTRON) {
+  function iniAutomaticBackupsIfEnabled(IS_ELECTRON, AppStorage) {
     if (IS_ELECTRON) {
-      //$interval(() => {
-      //
-      //}, BACKUP_POLL_INTERVAL)
+      AppStorage.initBackupsIfEnabled();
     }
   }
 })();

app-src/scripts/constants.js

@@ -98,6 +98,11 @@
         togglePlay: 'y',
       },
       config: {
+        automaticBackups: {
+          isEnabled: false,
+          path: '~/backup-{date}.json',
+          intervalInSeconds: 6
+        },
         isTakeABreakEnabled: false,
         takeABreakMinWorkingTime: undefined,
         isAutoStartNextTask: true,

app-src/scripts/main/global-services/app-storage-s.js

@@ -13,13 +13,14 @@
 
   class AppStorage {
     /* @ngInject */
-    constructor(LS_DEFAULTS, SAVE_APP_STORAGE_POLL_INTERVAL, TMP_FIELDS, $interval, $rootScope, ON_DEMAND_LS_FIELDS, ON_DEMAND_LS_FIELDS_FOR_PROJECT) {
+    constructor(LS_DEFAULTS, SAVE_APP_STORAGE_POLL_INTERVAL, TMP_FIELDS, $interval, $rootScope, ON_DEMAND_LS_FIELDS, ON_DEMAND_LS_FIELDS_FOR_PROJECT, IS_ELECTRON) {
       this.PROJECTS_KEY = 'projects';
       this.LS_DEFAULTS = LS_DEFAULTS;
       this.TMP_FIELDS = TMP_FIELDS;
       this.SAVE_APP_STORAGE_POLL_INTERVAL = SAVE_APP_STORAGE_POLL_INTERVAL;
       this.ON_DEMAND_LS_FIELDS = ON_DEMAND_LS_FIELDS;
       this.ON_DEMAND_LS_FIELDS_FOR_PROJECT = ON_DEMAND_LS_FIELDS_FOR_PROJECT;
+      this.IS_ELECTRON = IS_ELECTRON;
       this.$rootScope = $rootScope;
       this.$interval = $interval;
       this.serializer = angular.toJson;
@@ -36,19 +37,72 @@
       //}, 5);
     }
 
+    initBackupsIfEnabled() {
+      if (!this.IS_ELECTRON
+        || !this.$rootScope.r.config.automaticBackups
+        || !this.$rootScope.r.config.automaticBackups.isEnabled) {
+        return;
+      }
+      const fs = require('fs');
+      const interval = parseInt(this.$rootScope.r.config.automaticBackups.intervalInSeconds, 10) * 1000;
+
+      this.$interval(() => {
+        if (!this.$rootScope.r.config.automaticBackups
+          || !this.$rootScope.r.config.automaticBackups.isEnabled
+          || parseInt(this.$rootScope.r.config.automaticBackups.intervalInSeconds, 10) === 0
+          || !this.$rootScope.r.config.automaticBackups.path
+          || !this.$rootScope.r.config.automaticBackups.path.trim().length > 0
+        ) {
+          return;
+        }
+
+        const now = window.moment();
+        const path = this.$rootScope.r.config.automaticBackups.path
+          .replace('{date}', now.format('YYYY-MM-DD'))
+          .replace('{unix}', now.format('x'));
+
+        this.saveToFileSystem(fs, path);
+      }, interval);
+    }
+
+    saveToFileSystem(fs, path) {
+      const data = angular.copy(this.getCurrentAppState());
+
+      // also add projects data
+      data[this.PROJECTS_KEY] = this.getProjects();
+
+      fs.writeFile(path, JSON.stringify(data), function(err) {
+        if (err) {
+          console.error(err);
+        } else {
+          console.log('Backup to ' + path + ' completed');
+        }
+      });
+    }
+
     setupPollingForSavingCurrentState() {
       this.$interval(() => {
         this.saveToLs();
       }, this.SAVE_APP_STORAGE_POLL_INTERVAL);
     }
 
-    saveToLs() {
-      for (let key in this.$rootScope.r) {
+    // gets the current state of the app excluding tmp variables and the projects
+    getCurrentAppState() {
+      const currentState = {};
+      for (let key in this.LS_DEFAULTS) {
         const isNoTmpField = this.TMP_FIELDS.indexOf(key) === -1;
-        if (this.$rootScope.r.hasOwnProperty(key) && isNoTmpField && key !== this.PROJECTS_KEY) {
-          this.saveLsItem(this.$rootScope.r[key], key);
+        if (this.LS_DEFAULTS.hasOwnProperty(key) && isNoTmpField && key !== this.PROJECTS_KEY) {
+          currentState[key] = this.$rootScope.r[key];
         }
       }
+      return currentState;
+    }
+
+    saveToLs() {
+      const currentState = this.getCurrentAppState();
+      for (let key in currentState) {
+        this.saveLsItem(currentState[key], key);
+      }
     }
 
     getProjects() {

app-src/scripts/routes/settings/settings-c.html

@@ -27,7 +27,7 @@
 
   <section class="config-section"
            md-whiteframe="2">
-    <backup-settings></backup-settings>
+    <backup-settings settings="r.config.automaticBackups"></backup-settings>
   </section>
 
 

app-src/scripts/settings/backup-settings/backup-settings-d.html

@@ -1,12 +1,20 @@
 <h2 class="md-title">
   <ng-md-icon icon="swap_vert"></ng-md-icon>
-  Make/Restore Backup
+  Backup and Sync
 </h2>
 
 <help-section>
-  <p>Here you can download all your data as <strong>JSON</strong> export for backups, but also to use it in a different context (e.g. you might want to export your projects in the browser and import them into the desktop version).</p>
+  <p>Here you can download all your data as
+    <strong>JSON</strong> export for backups, but also to use it in a different context (e.g. you might want to export your projects in the browser and import them into the desktop version).
+  </p>
   <p>The import expects valid json to be copied into the text area.
     <strong>NOTE: Once you hit the import button all your current settings and data will be overwritten!</strong></p>
+
+  <section ng-if="vm.IS_ELECTRON">
+    <p>There is also the option to do
+      <strong>automatic backups</strong>. You can choose an interval in seconds of how often the backup should occur and a custom destination to where the backup should be saved. You can use `{unix}` and `{date}` inside the path string to add output a unix timestamp or a date at this location of the string. E.g. `/mypath/{date}.json` will save your data to `/mypath/2017-12-12.json.
+    </p>
+  </section>
 </help-section>
 
 <a class="md-raised md-button md-ink-ripple"
@@ -43,3 +51,31 @@ <h2 class="md-title">
              class="md-raised md-primary">Import settings
   </md-button>
 </form>
+
+
+<section ng-if="vm.IS_ELECTRON">
+  <h3 class="md-caption">Automatic Backups</h3>
+  <div>
+    <md-switch ng-model="vm.settings.isEnabled"
+               aria-label="Enable automatic backups">
+      Enable automatic backups
+    </md-switch>
+  </div>
+
+  <p><strong>NOTE:</strong> Changes to automated backup settings require you to restart the application to take effect.
+  </p>
+
+  <div ng-show="vm.settings.isEnabled">
+    <md-input-container class="md-block">
+      <label>Interval in seconds to make backups</label>
+      <input type="number"
+             ng-model="vm.settings.intervalInSeconds">
+    </md-input-container>
+    <md-input-container class="md-block">
+      <label>Path to backup (e.g. ~/backup-{date}.json)</label>
+      <input type="text"
+             ng-model="vm.settings.path">
+    </md-input-container>
+
+  </div>
+</section>

app-src/scripts/settings/backup-settings/backup-settings-d.js

@@ -20,13 +20,16 @@
       controller: BackupSettingsCtrl,
       controllerAs: 'vm',
       restrict: 'E',
-      scope: {}
+      scope: {
+        settings: '='
+      }
     };
   }
 
   /* @ngInject */
-  function BackupSettingsCtrl($rootScope, AppStorage) {
+  function BackupSettingsCtrl($rootScope, AppStorage, IS_ELECTRON) {
     let vm = this;
+    vm.IS_ELECTRON = IS_ELECTRON;
 
     // import/export stuff
     vm.importSettings = (uploadSettingsTextarea) => {