Added Recent File Menu

OpenMotor now tracks recently opened files and lets you easily return to them.

Author: AstroChuck

uilib/fileIO.py

@@ -16,6 +16,7 @@ class fileTypes(Enum):
     PREFERENCES = 1
     PROPELLANTS = 2
     MOTOR = 3
+    RECENT_FILES = 4
 
 def futureVersion(verA, verB): # Returns true if a is newer than b
     major = verA[0] > verB[0]
@@ -162,7 +163,8 @@ def migrateMotor_0_2_0_to_0_3_0(data):
         'to': (0, 6, 0),
         fileTypes.PREFERENCES: passthrough,
         fileTypes.PROPELLANTS: passthrough,
-        fileTypes.MOTOR: migrateMotor_0_5_0_to_0_6_0
+        fileTypes.MOTOR: migrateMotor_0_5_0_to_0_6_0,
+        fileTypes.RECENT_FILES: passthrough
     },
     (0, 4, 0): {
         'to': (0, 5, 0),

uilib/fileManager.py

@@ -1,17 +1,23 @@
-from PyQt6.QtCore import QObject
+from PyQt6.QtCore import QObject, pyqtSignal
 from PyQt6.QtWidgets import QFileDialog, QMessageBox
-from PyQt6.QtCore import pyqtSignal
+from PyQt6.QtGui import QAction
 
+import os
 import motorlib
 
-from .fileIO import saveFile, loadFile, fileTypes
+from .fileIO import saveFile, loadFile, fileTypes, getConfigPath
 from .helpers import FLAGS_NO_ICON, excludeKeys
 from .logger import logger
 
 class FileManager(QObject):
 
+    MAX_RECENT_FILES = 5
+
     fileNameChanged = pyqtSignal(str, bool)
     newMotor = pyqtSignal(object)
+    # TODO: eventually a signal like this that makes the mainWindow repopulate the propellant editor should
+    # be emitted whenever load() is called
+    recentFileLoaded = pyqtSignal()
 
     def __init__(self, app):
         super().__init__()
@@ -25,6 +31,9 @@ def __init__(self, app):
 
         self.newFile()
 
+        self.recentlyOpenedFiles = []
+        self.recentFilesPath = os.path.join(getConfigPath(), 'recent_files.yaml')
+
     # Check if current motor is unsaved and start over from default motor. Called when the menu item is triggered.
     def newFile(self):
         if not self.unsavedCheck():
@@ -67,6 +76,7 @@ def saveAs(self):
         if fileName is not None:
             self.fileName = fileName
             self.save()
+            self.addRecentFile(fileName)
 
     # Checks for unsaved changes, asks for a filename, and loads the file
     def load(self, path=None):
@@ -80,6 +90,7 @@ def load(self, path=None):
                         motor = motorlib.motor.Motor()
                         motor.applyDict(res)
                         self.startFromMotor(motor, path)
+                        self.addRecentFile(path)
                         return True
                 except Exception as exc:
                     self.app.outputException(exc, "An error occurred while loading the file: ")
@@ -233,3 +244,44 @@ def checkPropellant(self, motor):
                                'New propellant added')
 
         return motor
+
+    def createRecentlyOpenedMenu(self, recentlyOpenedMenu):
+        self.recentlyOpenedMenu = recentlyOpenedMenu
+
+        try:
+            self.recentFilesList = loadFile(self.recentFilesPath, fileTypes.RECENT_FILES)['recentFilesList']
+        except FileNotFoundError:
+            logger.warn('Unable to load recent files, creating new file at {}'.format(self.recentFilesPath))
+            self.recentFilesList = []
+            saveFile(self.recentFilesPath, {'recentFilesList': self.recentFilesList}, fileTypes.RECENT_FILES)
+
+        self.createRecentlyOpenedItems()
+
+    def createRecentlyOpenedItems(self):
+        self.recentlyOpenedMenu.clear()
+
+        if len(self.recentFilesList) == 0:
+            self.recentlyOpenedMenu.addAction(QAction('No Recent Files', self.recentlyOpenedMenu))
+            return
+
+        for filepath in self.recentFilesList:
+            _, filename = os.path.split(filepath)
+            action = QAction(filename, self.recentlyOpenedMenu)
+            action.triggered.connect(lambda _, path=filepath: self.loadRecentFile(path))
+            self.recentlyOpenedMenu.addAction(action)
+
+    def loadRecentFile(self, path):
+        self.load(path)
+        self.recentFileLoaded.emit()
+
+    def addRecentFile(self, filepath):
+        if filepath in self.recentFilesList:
+            self.recentFilesList.remove(filepath)
+
+        self.recentFilesList = [filepath] + self.recentFilesList
+
+        self.recentFilesList = self.recentFilesList[:FileManager.MAX_RECENT_FILES]
+
+        saveFile(self.recentFilesPath, {'recentFilesList': self.recentFilesList}, fileTypes.RECENT_FILES)
+
+        self.createRecentlyOpenedItems()

uilib/views/forms/MainWindow.ui

@@ -587,8 +587,14 @@
       <string>Import</string>
      </property>
     </widget>
+    <widget class="QMenu" name="menuOpen_Recent">
+     <property name="title">
+      <string>Open Recent</string>
+     </property>
+    </widget>
     <addaction name="actionNew"/>
     <addaction name="actionOpen"/>
+    <addaction name="menuOpen_Recent"/>
     <addaction name="actionSave"/>
     <addaction name="actionSaveAs"/>
     <addaction name="separator"/>

uilib/widgets/mainWindow.py

@@ -34,6 +34,7 @@ def __init__(self, app):
         self.app.fileManager.fileNameChanged.connect(self.updateWindowTitle)
         self.app.fileManager.newMotor.connect(self.resetOutput)
         self.app.fileManager.newMotor.connect(self.getQuickResults)
+        self.app.fileManager.recentFileLoaded.connect(self.motorImported)
 
         self.app.importExportManager.motorImported.connect(self.motorImported)
 
@@ -88,6 +89,7 @@ def setupMenu(self):
         self.ui.actionOpen.triggered.connect(lambda x: self.loadMotor(None))
 
         self.app.importExportManager.createMenus(self.ui.menuImport, self.ui.menuExport)
+        self.app.fileManager.createRecentlyOpenedMenu(self.ui.menuOpen_Recent)
 
         self.ui.actionQuit.triggered.connect(self.closeEvent)