Back up user data before updating

Author: puigru

.gitignore

@@ -2,3 +2,4 @@ __pycache__/
 build/
 dist/
 logs/
+backups/

README.md

@@ -1,4 +1,4 @@
-# Flashpoint Updater
+# Flashpoint Ultimate Updater
 
 The updater for BlueMaxima's Flashpoint.
 
@@ -8,7 +8,7 @@ The updater for BlueMaxima's Flashpoint.
 
 **GUI Version (Recommended)**
 
-1. Download the [latest release](https://github.com/FlashpointProject/FlashpointUpdater/releases/latest).
+1. Download the [latest release](https://github.com/FlashpointProject/FlashpointUltimateUpdater/releases/latest).
 2. Unpack anywhere.
 3. Run FlashpointUpdaterQt.exe
 4. Select your Flashpoint path and target version.
@@ -48,6 +48,10 @@ This listing must obey the following structure (note the following is not valid
           "root": "/fp/", # relative path to where the flashpoint data resides
           "lzma": true, # whether LZMA compression was applied to the index file
           "info": "blank" # currently unused: should contain a changelog or description of some sort
+          "backup": [ # optional: list of glob patterns to back up before performing an update
+            "Data/flashpoint.sqlite",
+            "FPSoftware/Important/*"
+          ]
         }
       },
       "anchor": {

core.py

@@ -85,6 +85,9 @@ def get_anchor(self):
     def get_root(self, name):
         return urljoin(self.endpoint, self.index(name)['root'])
 
+    def get_backup_paths(self, name):
+        return self.index(name).get('backup', None)
+
     def autodetect_anchor(self, anchor_hash):
         anchor = self.get_anchor()
         autodetect = dict()

update_gui.py

@@ -7,10 +7,13 @@
 import threading
 import requests
 import logging
+import shutil
 import ctypes
 import update
 import index
 import json
+import glob
+import time
 import sys
 import os
 import re
@@ -26,8 +29,31 @@ def __init__(self, reporter, root_path, server, current, target):
         self.current = current
         self.target = target
 
+    def create_backup(self, backup_paths):
+        files = list()
+        for rel_glob in backup_paths:
+            path_glob = os.path.join(self.root_path, rel_glob)
+            for path in glob.glob(path_glob):
+                if not os.path.isfile(path):
+                    continue
+                rel = os.path.relpath(path, self.root_path)
+                files.append((path, rel))
+        if not files:
+            return
+        backup = os.path.join('backups', time.strftime('%Y-%m-%d_%H-%M-%S'))
+        self.reporter.logger.info('Backup folder: %s' % backup)
+        for (path, rel), report in self.reporter.task_it('Backing up files...', files):
+            report(rel)
+            dest = os.path.join(backup, rel)
+            os.makedirs(os.path.dirname(dest), exist_ok=True)
+            shutil.copy(path, dest)
+            self.reporter.logger.info('Saved: %s' % rel)
+
     def run(self):
+        backup_paths = self.server.get_backup_paths(self.current)
         try:
+            if backup_paths:
+                self.create_backup(backup_paths)
             current = self.server.fetch(self.current, self.reporter)
             target = self.server.fetch(self.target, self.reporter)
             update.perform_update(self.root_path, current, target, server.get_root(self.target), self.reporter)