V1.2.0

Author: TheElementalOfDestruction

CHANGELOG.md

@@ -1,3 +1,9 @@
+**v1.2.0**
+* Updated to new version set of extract-msg (>=0.33.0, <0.34.0). Version 0.32.0 was skipped intentionally due to some issues in the code as well as to prioritize the release of version 0.33.0.
+* Fixed issue where double clicking attachments no longer worked (forgot to update the type checks to use the enum).
+* Fixed bug that caused streams in embedded MSG files to not be found if you loaded it to be the current MSG file.
+* Fixed typo that caused string viewer to not clear (forgot to add `.ui` before a ui element name).
+
 **v1.1.0**
 * Updated to new version set of extract-msg (>=0.31.0, <0.32.0).
 * Added sorting to many of the displays. Updated internal way data is handled to help this.

README.rst

@@ -77,8 +77,8 @@ Credits
 .. |License: GPL v3| image:: https://img.shields.io/badge/License-GPLv3-blue.svg
    :target: LICENSE.txt
 
-.. |PyPI3| image:: https://img.shields.io/badge/pypi-1.1.0-blue.svg
-   :target: https://pypi.org/project/msg-explorer/1.1.0/
+.. |PyPI3| image:: https://img.shields.io/badge/pypi-1.2.0-blue.svg
+   :target: https://pypi.org/project/msg-explorer/1.2.0/
 
 .. |PyPI2| image:: https://img.shields.io/badge/python-3.6+-brightgreen.svg
    :target: https://www.python.org/downloads/release/python-367/

msg_explorer/__init__.py

@@ -27,8 +27,8 @@
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 __author__ = 'Destiny Peterson'
-__date__ = '2022-06-06'
-__version__ = '1.1.0'
+__date__ = '2022-06-08'
+__version__ = '1.2.0'
 
 # When this module is imported, we should try to compile the forms. They only
 # compile when they are outdated.

msg_explorer/attachments_browser.py

@@ -1,4 +1,6 @@
 # This Python file uses the following encoding: utf-8
+import logging
+
 import extract_msg
 
 from PySide6 import QtCore
@@ -9,6 +11,9 @@
 from .ui.ui_attachments_browser import Ui_AttachmentsBrowser
 
 
+logger = logging.getLogger(__name__)
+logger.addHandler(logging.NullHandler())
+
 class AttachmentsBrowser(QtWidgets.QWidget):
     # Signals that an attachment was double clicked.
     attachmentSelected = Signal(int)
@@ -77,3 +82,5 @@ def _cellDoubleClicked(self, row : int, column : int):
                     self.signedAttachmentSelected.emit(int(data))
             else:
                 self.attachmentSelected.emit(int(data))
+        else:
+            logger.warn(f'Received index on cell double click that was outside of table (row: {row}, colunn {column}).')

msg_explorer/main_window.py

@@ -49,7 +49,7 @@ def __init__(self, parent = None):
         # Connect the double click from the tree to the stream view.
         self.ui.pageTreeView.fileDoubleClicked.connect(self.ui.pageStreamView.openStream)
         self.ui.pageTreeView.fileDoubleClicked.connect(self._streamSelected)
-        self.ui.pageNamedProperties.namedPropertySelected.connect(lambda x : self.ui.pageStreamView.openStream(x, True))
+        self.ui.pageNamedProperties.namedPropertySelected.connect(self.ui.pageStreamView.openStream)
         self.ui.pageNamedProperties.namedPropertySelected.connect(self._streamSelected)
 
         self.ui.actionIncrease_Font.triggered.connect(self.increaseFont)
@@ -80,10 +80,10 @@ def attachmentSelected(self, index):
             attachment = self.__msg.attachments[index]
 
         if isinstance(attachment, extract_msg.Attachment):
-            if attachment.type == 'data':
+            if attachment.type == extract_msg.enums.AttachmentType.DATA:
                 self.ui.pageStreamView.openStream(attachment.dir.split('/') + ['__substg1.0_37010102'])
                 self.ui.tabWidget.setCurrentWidget(self.ui.pageStreamView)
-            elif attachment.type == 'msg':
+            elif attachment.type == extract_msg.enums.AttachmentType.MSG:
                 if QMessageBox.question(self, 'Open Embedded Msg', 'Would you like to open the embedded MSG file?') == QMessageBox.Yes:
                     self.__parentMsgs.append(self.__msg)
                     self.__msg = attachment.data

msg_explorer/msg_details_page.py

@@ -35,6 +35,6 @@ def msgOpened(self, msgFile):
         self.ui.labelClassType.setText(msgFile.classType)
         self.ui.labelEncoding.setText(msgFile.stringEncoding)
         self.ui.labelAttachCount.setText(str(len(msgFile.attachments)))
-        self.ui.labelRecipCount.setText(str(len(msgFile.recipients)))
         if isinstance(msgFile, extract_msg.MessageBase):
+            self.ui.labelRecipCount.setText(str(len(msgFile.recipients)))
             self.ui.labelSubject.setText(msgFile.subject)

msg_explorer/named_properties_viewer.py

@@ -26,44 +26,45 @@ def __init__(self, parent = None):
 
         self.ui = Ui_NamedPropertiesViewer()
         self.ui.setupUi(self)
+        self.__loading = False
         self.__msg = None
+        # This is the named instance for the MSG file. It is used to get a list
+        # of all available properties.
+        self.__named : extract_msg.Named = None
+        self.__attachments = None
 
         self.ui.tableNamedProperties.cellDoubleClicked.connect(self._cellDoubleClicked)
         self.ui.comboBoxInstance.currentTextChanged.connect(self._comboBoxChanged)
 
-    def loadNamed(self, namedInstance, attachment = None):
+    def loadNamed(self):
         """
-        Load the named properties instance. If it is from an attachment,
-        provide the instance so details can be acquired properly.
+        Load the named properties instance. This loads the main sections for each
+        property, not the data.
         """
-        getStream = attachment._getTypedStream if attachment else self.__msg._getTypedStream
-        named = namedInstance.namedProperties
-        keys = sorted(named.keys())
-        self.ui.tableNamedProperties.setRowCount(len(named))
-        for index, key in enumerate(keys):
+        self.ui.tableNamedProperties.setRowCount(len(self.__named))
+        for index, key in enumerate(self.__named):
             self.ui.tableNamedProperties.setItem(index, 0, QTableWidgetItem(key))
-            self.ui.tableNamedProperties.setItem(index, 1, NamedPIDItem(str(named[key].namedPropertyID)))
-            # We need to figure out what to display for the data.
-            if isinstance(named[key].data, (int, float, bool, None.__class__)):
-                # This helps to shortcut a bunch of properties.
-                self.ui.tableNamedProperties.setItem(index, 2, QTableWidgetItem(utils.dataToString(named[key].data)))
-            elif isinstance(named[key].data, (bytes, list, tuple)) or getStream(f'__substg1.0_{0x8000 + named[key].namedPropertyID:04X}')[0]:
-                self.ui.tableNamedProperties.setItem(index, 2, QTableWidgetItem('[Stream]'))
-            else:
-                self.ui.tableNamedProperties.setItem(index, 2, QTableWidgetItem(utils.dataToString(named[key].data)))
+            self.ui.tableNamedProperties.setItem(index, 1, NamedPIDItem(str(self.__named[key].namedPropertyID)))
 
     @Slot()
     def msgClosed(self):
         self.ui.comboBoxInstance.clear()
         self.ui.tableNamedProperties.clearContents()
         self.__msg = None
+        self.__named = None
+        self.__attachments = None
 
     @Slot(extract_msg.MSGFile)
     def msgOpened(self, msgFile):
+        self.__loading = True
         self.__msg = msgFile
+        self.__named = msgFile.named
+        self.__attachments = msgFile._rawAttachments if isinstance(msgFile, extract_msg.MessageSignedBase) else msgFile.attachments
         self.ui.comboBoxInstance.addItem('MSG File')
-        self.ui.comboBoxInstance.addItems((f'Attachment {x}' for x in range(len(msgFile.attachments))))
-        self.loadNamed(msgFile.named)
+        self.ui.comboBoxInstance.addItems((f'Attachment {x}' for x in range(len(self.__attachments))))
+        self.loadNamed()
+        self.__loading = False
+        self._comboBoxChanged('MSG File')
 
     @Slot(int, int)
     def _cellDoubleClicked(self, row, column):
@@ -86,11 +87,29 @@ def _cellDoubleClicked(self, row, column):
 
     @Slot(str)
     def _comboBoxChanged(self, entry):
+        # Prevent this from running while data is being loaded.
+        if self.__loading:
+            return
         if entry:
             if entry == 'MSG File':
-                self.loadNamed(self.__msg.named)
+                getData = self.__msg.namedProperties.get
+                getStream = self.__msg._getTypedStream
             else:
-                self.loadNamed(self.__msg.attachments[int(self.ui.comboBoxInstance.currentText().split(" ")[1])].namedProperties)
+                attachment = self.__attachments[int(entry.split(' ')[-1])]
+                getData = attachment.namedProperties.get
+                getStream = attachment._getTypedStream
+
+            for index in range(self.ui.tableNamedProperties.rowCount()):
+                key = self.ui.tableNamedProperties.item(index, 0).data(0)
+                # We need to figure out what to display for the data.
+                data = getData(self.__named[key])
+                if isinstance(data, (int, float, bool, None.__class__)):
+                    # This helps to shortcut a bunch of properties.
+                    self.ui.tableNamedProperties.setItem(index, 2, QTableWidgetItem(utils.dataToString(data)))
+                elif isinstance(data, (bytes, list, tuple)) or getStream(f'__substg1.0_{self.__named[key].propertyStreamID}')[0]:
+                    self.ui.tableNamedProperties.setItem(index, 2, QTableWidgetItem('[Stream]'))
+                else:
+                    self.ui.tableNamedProperties.setItem(index, 2, QTableWidgetItem(utils.dataToString(data)))
 
 
 

msg_explorer/stream_viewer.py

@@ -73,7 +73,7 @@ def msgOpened(self, msgFile):
         self.__msg = msgFile
 
     @Slot(list)
-    def openStream(self, name, prefix = False):
+    def openStream(self, name, prefix = True):
         """
         Loads the data for the specified stream. Will automatically
         determine how best to show it.
@@ -85,7 +85,7 @@ def openStream(self, name, prefix = False):
             # just telling the function to run again with the main stream.
             return self.openStream(name[:-1] + [name[-1][:-9]])
 
-        self.ui.pageHexViewer.loadHexData(self.__msg._getStream(name))
+        self.ui.pageHexViewer.loadHexData(self.__msg._getStream(name, False))
         self.ui.labelStreamName.setText('/'.join(name))
         # Now determine how to load the rest of the data.
         if name[-1] == '__properties_version1.0':

msg_explorer/string_viewer.py

@@ -16,7 +16,7 @@ def __init__(self):
     @Slot()
     def clear(self):
         self.ui.labelType.setText('')
-        self.textDisplay.setPlainText('')
+        self.ui.textDisplay.setPlainText('')
 
     @Slot(str, str)
     def loadString(self, data, _type):

requirements.txt

@@ -1,4 +1,4 @@
 
 # First level requirements
-extract-msg>=0.31.1, <0.32.0
+extract-msg>=0.33.0, <0.34.0
 PySide6>=6.3.0