Refactor autosaver to use task system + more

auto saves are now ALWAYS in autosaves folder
auto saves now are saved with the datetime
temporarily (maybe?) remove the max files logic

Author: drewc5131

toontown/leveleditor/AutoSaver.py

@@ -2,94 +2,50 @@
 import shutil
 import time
 import threading
+from datetime import datetime
 
 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')
+        # Remove any existing autosaver tasks (used if we change settings)
+        taskMgr.remove('autosaver-task')
+
+        # Create 'autosaves' directory in user data directory
+        if not os.path.isdir(f'{userfiles}/autosaves'):
+            os.mkdir(f'{userfiles}/autosaves')
             print('Created "autosaves" dir')
+        taskMgr.doMethodLater(settings.get('autosave-interval', 15) * 60, AutoSaver.autoSaverProcess, 'autosaver-task')
 
     @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
+    def autoSaverProcess(task):
+        autosaveEnabled = settings.get('autosave-enabled', True)
+        # Loops without doing anything if auto saver isn't toggled
+        if not autosaveEnabled:
+            return task.again
 
-                # 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
+        # Only auto save if auto save is toggled
+        if autosaveEnabled:
+            AutoSaver.manageAutoSaveFiles()
+            return task.again
 
     @staticmethod
     def manageAutoSaveFiles():
         DNASerializer.autoSaverMgrRunning = True
         autoSaveCount = int(DNASerializer.autoSaveCount)
+        outputFile = DNASerializer.outputFile
+        newout = outputFile
+        if not outputFile:
+            newout = os.path.join(userfiles, 'unsaved.dna')
 
         # 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
+        bn = os.path.basename(newout)
+        basename, extension = os.path.splitext(bn)
 
-        DNASerializer.outputDNADefaultFile()  # Saves working DNA file
+        DNASerializer.outputDNA(
+                f'{userfiles}/autosaves/auto_{basename}_{datetime.now().strftime("%Y_%m_%d-%I_%M_%S_%p")}.dna',
+                True)
         DNASerializer.autoSaverMgrRunning = False

toontown/leveleditor/DNASerializer.py

@@ -60,7 +60,7 @@ def saveToSpecifiedDNAFile():
             DNASerializer.outputFile = dnaFilename
 
     @staticmethod
-    def loadDNAFromFile(filename):
+    def loadDNAFromFile(filename: str):
         DNASerializer.notify.debug("Filename: %s" % filename)
         # Reset level, destroying existing scene/DNA hierarcy
         base.le.reset(fDeleteToplevel = 1, fCreateToplevel = 0,
@@ -71,7 +71,8 @@ def loadDNAFromFile(filename):
             node = loadDNAFile(DNASTORE, Filename.fromOsSpecific(filename).cStr(), CSDefault, 1)
         except Exception:
             DNASerializer.notify.debug(
-                    "Couldn't load specified DNA file. Please make sure storage code has been specified in Config.prc file")
+                    "Couldn't load specified DNA file. Please make sure storage code has been specified in Config.prc "
+                    "file")
             return
         if node.getNumParents() == 1:
             # If the node already has a parent arc when it's loaded, we must
@@ -117,15 +118,23 @@ def outputDNADefaultFile():
         DNASerializer.outputDNA(file)
 
     @staticmethod
-    def outputDNA(filename):
+    def outputDNA(filename: str, isAutoSave: bool = False):
+        """
+        Output current DNA to specified file
+        :param filename: Output filename
+        :param isAutoSave: Specifies whether this is an auto or a manual save
+        """
         print('Saving DNA to: ', filename)
         binaryFilename = Filename(filename)
         binaryFilename.setBinary()
         base.le.DNAData.writeDna(binaryFilename, Notify.out(), DNASTORE)
-        base.le.popupNotification(f"Saved to {os.path.basename(binaryFilename)}")
-        if ConfigVariableString("compiler") in ['libpandadna', 'clash']:
-            print(f"Compiling PDNA for {ConfigVariableString('compiler')}")
-            DNASerializer.compileDNA(binaryFilename)
+        if isAutoSave:
+            base.le.popupNotification(f"Autosaved as {os.path.basename(binaryFilename)}")
+        else:
+            base.le.popupNotification(f"Saved to {os.path.basename(binaryFilename)}")
+            if ConfigVariableString("compiler") in ['libpandadna', 'clash']:
+                print(f"Compiling PDNA for {ConfigVariableString('compiler')}")
+                DNASerializer.compileDNA(binaryFilename)
 
     @staticmethod
     def compileDNA(filename):

toontown/leveleditor/LevelEditor.py

@@ -26,6 +26,7 @@
 from otp.otpbase import OTPGlobals
 from toontown.hood.GenericAnimatedProp import *
 from toontown.toon import RobotToon, LEAvatar
+from .AutoSaver import AutoSaver
 from . import LevelEditorGlobals
 from . import LevelEditorPanel
 from . import VisGroupsEditor
@@ -343,6 +344,8 @@ def startUp(self, dnaPath = None):
         self.boxStartMouse = (0, 0)
         self.boxEndMouse = (0, 0)
 
+        AutoSaver.initializeAutoSaver()
+
     # ENABLE/DISABLE
     def enable(self):
         """ Enable level editing and show level """
@@ -4107,7 +4110,7 @@ def selectionBoxTask(self, task):
         return task.again
 
     def finishBoxSelection(self):
-        ''' Calculates all the stuff in the selection '''
+        """ Calculates all the stuff in the selection """
         base.direct.deselectAll()
 
         # The following is mostly from direct.directtools.DirectManipulation, but modified for dnanodes instead of geom nodes.

toontown/leveleditor/LevelEditorPanel.py

@@ -129,10 +129,6 @@ def __init__(self, levelEditor, parent = None, **kw):
                             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',
@@ -192,23 +188,32 @@ def __init__(self, levelEditor, parent = None, **kw):
                                           command = self.setAutoSaverInterval)
         self.autoSaverDialog.withdraw()
 
+        self.autoSaverEnabled = IntVar()
+        self.autoSaverEnabled.set(settings['autosave-enabled'])
+        self.autoSaverEnable = ttk.Checkbutton(
+                self.autoSaverDialog.interior(),
+                text = 'Enable Autosaving', width = 20,
+                variable = self.autoSaverEnabled)
+
         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_value = int(settings['autosave-interval']),
                                                    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)
+                                                                          '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(settings['autosave-max-files']),
+        #                                      entryfield_validate = {'validator': 'numeric',
+        #                                                             'min':       0, 'max': 99
+        #                                                             })
+
+        counters = (self.autoSaverEnable, self.autoSaverDialogInterval)#, self.autoSaverDialogMax)
         Pmw.alignlabels(counters)
         for counter in counters:
             counter.pack(fill = 'both', expand = 1)
@@ -412,7 +417,7 @@ def __init__(self, levelEditor, parent = None, **kw):
                     landmarkBuildingsPage, width = 24,
                     textvariable = self.landmarkBuildingNameString)
             self.landmarkBuildingNameBox.pack(expand = 0, fill = X)
-            
+
         self.bldgLabels = IntVar()
         self.bldgLabels.set(0)
         self.bldgLabelsButton = ttk.Checkbutton(
@@ -999,9 +1004,6 @@ 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()
@@ -1509,8 +1511,11 @@ def setBattleCellType(self, name):
     def setAutoSaverInterval(self, i):
         if i == 'Save Options':
             try:
-                AutoSaver.autoSaverInterval = float(self.autoSaverDialogInterval.get())
-                AutoSaver.maxAutoSaveCount = float(self.autoSaverDialogMax.get())
+                settings['autosave-enabled'] = bool(self.autoSaverEnabled.get())
+                settings['autosave-interval'] = int(self.autoSaverDialogInterval.get())
+                #settings['autosave-max-files'] = float(self.autoSaverDialogMax.get())
+                # Reset the autosaver
+                AutoSaver.initializeAutoSaver()
             except ValueError as e:
                 # Non-float was passed
                 raise e
@@ -1585,16 +1590,3 @@ 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

ttle.py

@@ -29,12 +29,13 @@
 DEFAULT_SERVER = TOONTOWN_ONLINE
 
 DEFAULT_SETTINGS = {
-    'autosave-enabled':   True,
-    'autosave-interval':  15,
-    'autosave-max-files': 10,
+    'autosave-enabled':      True,
+    'autosave-interval':     15,
+    'autosave-max-files':    10,
     'fps-meter-update-rate': 0
     }
 
+
 class ToontownLevelEditor(ShowBase):
     notify = directNotify.newCategory("Open Level Editor")
     APP_VERSION = open('ver', 'r').read()
@@ -99,8 +100,8 @@ def __init__(self):
                 loadPrcFileData("", "png-textures true")
             else:
                 messagebox.showerror(
-                    message = "There was an error located resources!\n"
-                              "Make sure you put the phase folders in the root folder!")
+                        message = "There was an error located resources!\n"
+                                  "Make sure you put the phase folders in the root folder!")
 
         server = SERVER_TO_ID.get(args.server[0].lower(), DEFAULT_SERVER)
         self.server = server
@@ -148,7 +149,8 @@ def toggleFrameRateMeter(self, flag):
         if flag:
             if not self.frameRateMeter:
                 self.frameRateMeter = OnscreenText(parent = base.a2dTopRight, text = '', pos = (-0.01, -0.05, 0.0),
-                                                   scale = 0.05, style = 3, bg = (0, 0, 0, 0.4), align = TextNode.ARight,
+                                                   scale = 0.05, style = 3, bg = (0, 0, 0, 0.4),
+                                                   align = TextNode.ARight,
                                                    font = ToontownGlobals.getToonFont())
                 taskMgr.add(self.updateFrameRateMeter, 'fps')
         else:
@@ -176,7 +178,7 @@ def updateFrameRateMeter(self, task):
         text = f'{round(fps, 1)} FPS'
         self.frameRateMeter.setText(text)
         self.frameRateMeter.setFg(color)
-        task.delayTime = settings['fps-meter-update-rate']/1000
+        task.delayTime = settings['fps-meter-update-rate'] / 1000
         return task.again
 
     def __checkForFiles(self):
@@ -230,8 +232,8 @@ async def __checkUpdates(self):
                         self.notify.info("Client is up to date!")
             except:
                 messagebox.showerror(
-                    message = "There was an error checking for updates! This is likely an issue with your connection. "
-                              "Press OK to continue using the application.")
+                        message = "There was an error checking for updates! This is likely an issue with your connection. "
+                                  "Press OK to continue using the application.")
 
 
 # Run it