Merge pull request #30 from chrisd149/auto-saver-feature

drewc5131 · web-flow · commit 52c0b5bdf238 · 2021-01-20T17:14:02.000-05:00
feature: file autosaver
diff --git a/toontown/leveleditor/AutoSaver.py b/toontown/leveleditor/AutoSaver.py
@@ -0,0 +1,95 @@
+import os
+import shutil
+import time
+import threading
+
+from .DNASerializer import DNASerializer
+
+
+class AutoSaver:
+    autoSaverToggled = False
+    autoSaverInterval = 15.0
+    maxAutoSaveCount = 10.0
+
+    @staticmethod
+    def initializeAutoSaver():
+        threading.Thread(target = AutoSaver.autoSaverProcess, daemon = True).start()
+        # Creates 'autosaves' directory in user data directory
+        if not os.path.isdir('leveleditor/autosaves'):
+            os.mkdir('leveleditor/autosaves')
+            print('Created "autosaves" dir')
+
+    @staticmethod
+    def autoSaverProcess():
+        while True:
+            autoSaverInterval = AutoSaver.autoSaverInterval * 60  # Converts global autoSaverInterval to minutes
+            # Loops without doing anything if auto saver isn't toggled
+            if AutoSaver.autoSaverToggled is False:
+                time.sleep(0.1)
+
+            while AutoSaver.autoSaverToggled is True:
+                # outputFile filename is empty, which may occur if filename is left blank in file prompt
+                if DNASerializer.outputFile is None:
+                    print('No file loaded, exiting auto saving loop...')
+                    DNASerializer.autoSaveCount = 0
+                    DNASerializer.autoSaverMgrRunning = False
+                    AutoSaver.autoSaverToggled = False
+                    break
+
+                # Epoch time of next auto save
+                endTime = time.time() + autoSaverInterval
+                # Loops until endTime is reached or the auto saver is un-toggled by user
+                while time.time() <= endTime and AutoSaver.autoSaverToggled is True:
+                    time.sleep(0.1)
+                # Only auto save if auto save is toggled
+                if AutoSaver.autoSaverToggled is True:
+                    AutoSaver.manageAutoSaveFiles()
+                    # Sets autoSaveCount
+                    if DNASerializer.autoSaveCount >= AutoSaver.maxAutoSaveCount:
+                        DNASerializer.autoSaveCount = AutoSaver.maxAutoSaveCount
+                    else:
+                        DNASerializer.autoSaveCount += 1
+
+    @staticmethod
+    def manageAutoSaveFiles():
+        DNASerializer.autoSaverMgrRunning = True
+        autoSaveCount = int(DNASerializer.autoSaveCount)
+
+        # Defining outputFile name properties
+        base = os.path.basename(DNASerializer.outputFile)
+        dir = os.path.dirname(DNASerializer.outputFile)
+        basename, extension = os.path.splitext(base)
+
+        # Renames output file to auto save file naming convention
+        if autoSaveCount == 0:
+            # Only save & manage 'latest' file
+            if AutoSaver.maxAutoSaveCount == 0:
+                # Only save auto save latest file
+                if basename[-16:] == '_autosave-latest':
+                    DNASerializer.outputDNADefaultFile()  # Saves working DNA file
+                    return
+            DNASerializer.outputFile = os.path.join(dir, 'autosaves', basename + '_autosave-latest' + extension)
+            # Replaces any back slashes in outputFile with forward slashes
+            DNASerializer.outputFile = DNASerializer.outputFile.replace('\\', '/')
+            # Creates new 'autosaves' directory if none is found
+            # This also accounts for if the directory of outputFile is not in the default user data folder
+            if not os.path.isdir(os.path.join(dir, 'autosaves')):
+                os.mkdir(os.path.join(dir, 'autosaves'))
+
+        # Deletes 'latest' from filename
+        basename = basename[:-6]
+
+        # Copies auto save files
+        while autoSaveCount != 0:
+            filename = os.path.join(dir, basename + str(autoSaveCount) + extension)
+            oldFilename = os.path.join(dir, basename + str(autoSaveCount - 1) + extension)
+            # Copies working auto save file
+            if autoSaveCount == 1:
+                shutil.copy2(DNASerializer.outputFile, filename)
+            # Incrementally copies each auto save file (i.e. 3400_autosave-1.dna -> 3400_autosave-2.dna)
+            if autoSaveCount > 1:
+                shutil.copy2(oldFilename, filename)
+            autoSaveCount -= 1
+
+        DNASerializer.outputDNADefaultFile()  # Saves working DNA file
+        DNASerializer.autoSaverMgrRunning = False
diff --git a/toontown/leveleditor/DNASerializer.py b/toontown/leveleditor/DNASerializer.py
@@ -10,6 +10,9 @@
 class DNASerializer:
     notify = DirectNotifyGlobal.directNotify.newCategory('LevelEditor')
     outputFile = None
+    # Local AutoSaver variables
+    autoSaverMgrRunning = False
+    autoSaveCount = 0
 
     # STYLE/DNA FILE FUNCTIONS
     @staticmethod
@@ -24,6 +27,11 @@ def loadSpecifiedDNAFile():
                                       initialdir = path,
                                       title = 'Load DNA File',
                                       parent = base.le.panel.component('hull'))
+        DNASerializer.autoSaveCount = 0
+        # Wait until auto saver is done managing files before loading new file
+        while DNASerializer.autoSaverMgrRunning is True:
+            if DNASerializer.autoSaverMgrRunning is False:
+                break
         if dnaFilename:
             DNASerializer.loadDNAFromFile(dnaFilename)
             DNASerializer.outputFile = dnaFilename
@@ -42,6 +50,11 @@ def saveToSpecifiedDNAFile():
                 initialdir = path,
                 title = 'Save DNA File as',
                 parent = base.le.panel.component('hull'))
+        DNASerializer.autoSaveCount = 0
+        # Wait until auto saver is done managing files before saving new file
+        while DNASerializer.autoSaverMgrRunning is True:
+            if DNASerializer.autoSaverMgrRunning is False:
+                break
         if dnaFilename:
             DNASerializer.outputDNA(dnaFilename)
             DNASerializer.outputFile = dnaFilename
diff --git a/toontown/leveleditor/LevelEditorPanel.py b/toontown/leveleditor/LevelEditorPanel.py
@@ -8,6 +8,7 @@
 from direct.tkwidgets import Floater
 
 from .DNASerializer import DNASerializer
+from .AutoSaver import AutoSaver
 from .LevelStyleManager import *
 from .LevelEditorGlobals import *
 from .LESceneGraphExplorer import *
@@ -127,6 +128,16 @@ def __init__(self, levelEditor, parent = None, **kw):
                             'Open Injector',
                             label = 'Injector',
                             command = self.showInjector)
+        menuBar.addmenuitem('Advanced', 'separator')
+        menuBar.addmenuitem('Advanced', 'checkbutton',
+                            'Toggle Auto-saver On/Off',
+                            label =  'Toggle Auto Saver',
+                            command = self.toggleAutoSaver)
+        menuBar.addmenuitem('Advanced', 'command',
+                            'User Set Auto Saver Options',
+                            label = 'Auto Saver Options',
+                            command = self.showAutoSaverDialog)
+
         # Corporate Clash Old Toontown-esque Filter
         if base.server == TOONTOWN_CORPORATE_CLASH:
             self.toggleOTVar = IntVar()
@@ -176,6 +187,32 @@ def __init__(self, levelEditor, parent = None, **kw):
                                                 message_text = CONTROLS)
         self.controlsDialog.withdraw()
 
+        self.autoSaverDialog = Pmw.Dialog(parent, title = 'Autosaver Options',
+                                          buttons = ('Save Options',),
+                                          command = self.setAutoSaverInterval)
+        self.autoSaverDialog.withdraw()
+
+        self.autoSaverDialogInterval = Pmw.Counter(self.autoSaverDialog.interior(),
+                                                   labelpos = 'w',
+                                                   label_text = 'Auto save interval in minutes:',
+                                                   entry_width = 10,
+                                                   entryfield_value = int(AutoSaver.autoSaverInterval),
+                                                   entryfield_validate = {'validator': 'real',
+                                                                        'min': 1, 'max': 60})
+
+        self.autoSaverDialogMax = Pmw.Counter(self.autoSaverDialog.interior(),
+                                              labelpos = 'w',
+                                              label_text = 'Max auto save files:',
+                                              entry_width = 10,
+                                              entryfield_value = int(AutoSaver.maxAutoSaveCount),
+                                              entryfield_validate = {'validator': 'numeric',
+                                                                   'min': 0, 'max': 99})
+
+        counters = (self.autoSaverDialogInterval, self.autoSaverDialogMax)
+        Pmw.alignlabels(counters)
+        for counter in counters:
+            counter.pack(fill = 'both', expand = 1)
+
         self.editMenu = Pmw.ComboBox(
                 menuFrame, labelpos = W,
                 label_text = 'Edit Mode:', entry_width = 18,
@@ -962,6 +999,9 @@ def toggleWidgetHandles(s = self):
         # Make sure input variables processed
         self.initialiseoptions(LevelEditorPanel)
 
+        # Initializes auto saver for use
+        AutoSaver.initializeAutoSaver()
+
     def updateInfo(self, page):
         if page == 'Signs':
             self.updateSignPage()
@@ -1466,6 +1506,16 @@ def setSuitPointType(self, name):
     def setBattleCellType(self, name):
         self.levelEditor.currentBattleCellType = name
 
+    def setAutoSaverInterval(self, i):
+        if i == 'Save Options':
+            try:
+                AutoSaver.autoSaverInterval = float(self.autoSaverDialogInterval.get())
+                AutoSaver.maxAutoSaveCount = float(self.autoSaverDialogMax.get())
+            except ValueError as e:
+                # Non-float was passed
+                raise e
+        self.autoSaverDialog.withdraw()
+
     def updateSelectedObjColor(self, color):
         try:
             obj = self.levelEditor.DNATarget
@@ -1506,6 +1556,10 @@ def showControls(self):
         self.controlsDialog.show()
         self.controlsDialog.focus_set()
 
+    def showAutoSaverDialog(self):
+        self.autoSaverDialog.show()
+        self.autoSaverDialog.focus_set()
+
     def showInjector(self):
         self.injectorDialog.show()
         self.injectorDialog.focus_set()
@@ -1531,3 +1585,16 @@ def toggleDrive(self):
             self.levelEditor.useDriveMode()
         else:
             self.levelEditor.useDirectFly()
+
+    def toggleAutoSaver(self):
+        if AutoSaver.autoSaverToggled is False:
+            # If no working DNA outputFile is selected, one is chosen here
+            if DNASerializer.outputFile is None:
+                DNASerializer.saveToSpecifiedDNAFile()
+            print(f'Starting auto saver on an interval of {AutoSaver.autoSaverInterval} minutes')
+            # Toggles auto saver to begin auto saving loop
+            AutoSaver.autoSaverToggled = True
+        else:
+            print('Stopping auto saver...')
+            # Stops auto saving loop
+            AutoSaver.autoSaverToggled = False
