extract-msg 0.54.0__tar.gz → 0.55.0__tar.gz

{extract_msg-0.54.0 → extract_msg-0.55.0}/CHANGELOG.md

@@ -1,3 +1,14 @@
+**v0.55.0**
+* [[TeamMsgExtractor #465](https://github.com/TeamMsgExtractor/msg-extractor/issues/465)] Added missing `msg.close()` to `openMsg()`. If the MSG file was actually just a plain OLE file, it would be left open.
+* Adjusted the default value of `maxNameLength` for `MessageBase.save()` to 40 instead of 256.
+* Adjusted exception handling for `MessageBase.save()` to properly report the reason a folder fails to be created.
+* Simplified some of the code for `MessageBase.save()`.
+* Fixed some typing information.
+
+**v0.54.1**
+* [[TeamMsgExtractor #462](https://github.com/TeamMsgExtractor/msg-extractor/issues/462)] Fix potential issue where child MSG might have incompatible encoding to parent MSG when trying to grab a stream from the parent.
+* Added code to attempt to significantly improve RTF deencapsulation times. This tries to strip away unneeded data before passing it to `RTFDE`. This shows improvements on all files that take more than one second. Currently, this actually fixes some files previously outputting wrong from `RTFDE` when deencapsulating the HTML body, specifically around non breaking spaces sometimes not transferring over.
+
 **v0.54.0**
 * [[TeamMsgExtractor #456](https://github.com/TeamMsgExtractor/msg-extractor/issues/456)] Changed the prepared html output to use plainly encoded HTML instead of prettified, since current prettification options used mangles the output and causes the output to sometimes be very large.
 

{extract_msg-0.54.0 → extract_msg-0.55.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: extract_msg
-Version: 0.54.0
+Version: 0.55.0
 Summary: Extracts emails and attachments saved in Microsoft Outlook's .msg files
 Home-page: https://github.com/TeamMsgExtractor/msg-extractor
 Download-URL: https://github.com/TeamMsgExtractor/msg-extractor/archives/master
@@ -278,8 +278,8 @@ your access to the newest major version of extract-msg.
 .. |License: GPL v3| image:: https://img.shields.io/badge/License-GPLv3-blue.svg
    :target: LICENSE.txt
 
-.. |PyPI3| image:: https://img.shields.io/badge/pypi-0.54.0-blue.svg
-   :target: https://pypi.org/project/extract-msg/0.54.0/
+.. |PyPI3| image:: https://img.shields.io/badge/pypi-0.55.0-blue.svg
+   :target: https://pypi.org/project/extract-msg/0.55.0/
 
 .. |PyPI2| image:: https://img.shields.io/badge/python-3.8+-brightgreen.svg
    :target: https://www.python.org/downloads/release/python-3810/

{extract_msg-0.54.0 → extract_msg-0.55.0}/README.rst

@@ -260,8 +260,8 @@ your access to the newest major version of extract-msg.
 .. |License: GPL v3| image:: https://img.shields.io/badge/License-GPLv3-blue.svg
    :target: LICENSE.txt
 
-.. |PyPI3| image:: https://img.shields.io/badge/pypi-0.54.0-blue.svg
-   :target: https://pypi.org/project/extract-msg/0.54.0/
+.. |PyPI3| image:: https://img.shields.io/badge/pypi-0.55.0-blue.svg
+   :target: https://pypi.org/project/extract-msg/0.55.0/
 
 .. |PyPI2| image:: https://img.shields.io/badge/python-3.8+-brightgreen.svg
    :target: https://www.python.org/downloads/release/python-3810/

{extract_msg-0.54.0 → extract_msg-0.55.0}/extract_msg/__init__.py

@@ -27,8 +27,8 @@ https://github.com/TeamMsgExtractor/msg-extractor
 #    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 __author__ = 'Destiny Peterson & Matthew Walker'
-__date__ = '2025-03-23'
-__version__ = '0.54.0'
+__date__ = '2025-08-12'
+__version__ = '0.55.0'
 
 __all__ = [
     # Modules:

{extract_msg-0.54.0 → extract_msg-0.55.0}/extract_msg/attachments/attachment.py

@@ -13,7 +13,7 @@ import random
 import string
 import zipfile
 
-from typing import TYPE_CHECKING
+from typing import Optional, TYPE_CHECKING
 
 from .. import constants
 from .attachment_base import AttachmentBase
@@ -72,7 +72,7 @@ class Attachment(AttachmentBase):
 
         return filename
 
-    def regenerateRandomName(self) -> str:
+    def regenerateRandomName(self) -> None:
         """
         Used to regenerate the random filename used if the attachment cannot
         find a usable filename.
@@ -166,9 +166,11 @@ class Attachment(AttachmentBase):
                 _zip.close()
 
     @property
-    def data(self) -> bytes:
+    def data(self) -> Optional[bytes]:
         """
         The bytes making up the attachment data.
+
+        If the attachment data stream does not exist, returns None.
         """
         return self.__data
 

{extract_msg-0.54.0 → extract_msg-0.55.0}/extract_msg/constants/re.py

@@ -8,6 +8,9 @@ __all__ = [
     'HTML_SAN_SPACE',
     'INVALID_FILENAME_CHARS',
     'INVALID_OLE_PATH',
+    'RTF_BODY_STRIP_INIT',
+    'RTF_BODY_STRIP_PRE_CLOSE',
+    'RTF_BODY_STRIP_PRE_OPEN',
     'RTF_ENC_BODY_START',
 ]
 
@@ -40,3 +43,12 @@ RTF_ENC_BODY_START: Final[_RE_BYTES_TYPE] = re.compile(br'\{\\\*\\htmltag[0-9]*
 # invalid.
 INVALID_OLE_PATH: Final[_RE_STR_TYPE] = re.compile(r'[:/\\!]')
 
+# Used as the initial step in stripping RTF files for deencapsulation. Finds
+# ignored sections that do not contrain groups *and* finds HTML tag sections
+# that are entirely empty. It also then finds sections of data that can be
+# merged together without affecting the results
+RTF_BODY_STRIP_INIT: Final[_RE_BYTES_TYPE] = re.compile(rb'(\\htmlrtf[^0{}][^{}]*?\\htmlrtf0 ?)|(\{\\\*\\htmltag[0-9]+\})|(\\htmlrtf0 ?\\htmlrtf1? ?)|(\\htmlrtf1? ?\{\}\\htmlrtf0 ?)|(\\htmlrtf1? ?\\\'[a-fA-F0-9]{2}\\htmlrtf0 ?)')
+
+# Preprocessing steps to simplify the RTF.
+RTF_BODY_STRIP_PRE_CLOSE: Final[_RE_BYTES_TYPE] = re.compile(rb'(\\htmlrtf1? ?}\\htmlrtf0 ?)|(\\htmlrtf1? ?[^0{}][^{}]*?} ?\\htmlrtf0 ?)')
+RTF_BODY_STRIP_PRE_OPEN: Final[_RE_BYTES_TYPE] = re.compile(rb'\\htmlrtf1? ?{[^{}]*?\\htmlrtf0 ?')

{extract_msg-0.54.0 → extract_msg-0.55.0}/extract_msg/msg_classes/message_base.py

@@ -48,7 +48,8 @@ from ..recipient import Recipient
 from ..utils import (
         addNumToDir, addNumToZipDir, createZipOpen, decodeRfc2047, findWk,
         htmlSanitize, inputToBytes, inputToString, isEncapsulatedRtf,
-        prepareFilename, rtfSanitizeHtml, rtfSanitizePlain, validateHtml
+        prepareFilename, rtfSanitizeHtml, rtfSanitizePlain, stripRtf,
+        validateHtml
     )
 
 
@@ -725,12 +726,12 @@ class MessageBase(MSGFile):
         pdf = kwargs.get('pdf', False)
         allowFallback = kwargs.get('allowFallback', False)
         _zip = kwargs.get('zip')
-        maxNameLength = kwargs.get('maxNameLength', 256)
+        maxNameLength = kwargs.get('maxNameLength', 40)
 
         # Variables involved in the save location.
         customFilename = kwargs.get('customFilename')
         useMsgFilename = kwargs.get('useMsgFilename', False)
-        #maxPathLength = kwargs.get('maxPathLength', 255)
+        #maxPathLength = kwargs.get('maxPathLength', 255) # TODO
 
         # Track if we are only saving the attachments.
         attachOnly = kwargs.get('attachmentsOnly', False)
@@ -741,6 +742,8 @@ class MessageBase(MSGFile):
         # raising an exception.
         skipBodyNotFound = kwargs.get('skipBodyNotFound', False)
 
+        fext = None
+
         if pdf:
             kwargs['preparedHtml'] = True
 
@@ -757,30 +760,22 @@ class MessageBase(MSGFile):
                 if self.htmlBody:
                     useHtml = True
                     fext = 'html'
-                elif not allowFallback:
-                    if skipBodyNotFound:
-                        fext = None
-                    else:
-                        raise DataNotFoundError('Could not find the htmlBody.')
+                elif not allowFallback and not skipBodyNotFound:
+                    raise DataNotFoundError('Could not find the htmlBody.')
 
             if pdf:
                 if self.htmlBody:
                     usePdf = True
                     fext = 'pdf'
-                elif not allowFallback:
-                    if skipBodyNotFound:
-                        fext = None
-                    else:
-                        raise DataNotFoundError('Count not find the htmlBody to convert to pdf.')
+                elif not allowFallback and not skipBodyNotFound:
+                    raise DataNotFoundError('Count not find the htmlBody to convert to pdf.')
 
             if rtf or (html and not useHtml) or (pdf and not usePdf):
                 if self.rtfBody:
                     useRtf = True
                     fext = 'rtf'
                 elif not allowFallback:
-                    if skipBodyNotFound:
-                        fext = None
-                    else:
+                    if not skipBodyNotFound:
                         raise DataNotFoundError('Could not find the rtfBody.')
                 else:
                     # This was the last resort before plain text, so fall
@@ -793,10 +788,7 @@ class MessageBase(MSGFile):
                 # We need to check if the plain text body was found. If it
                 # was found but was empty that is considered valid, so we
                 # specifically check against None.
-                if self.body is None:
-                    if skipBodyNotFound:
-                        fext = None
-                    else:
+                if self.body is None and not skipBodyNotFound:
                         if allowFallback:
                             raise DataNotFoundError('Could not find a valid body using current options.')
                         else:
@@ -871,12 +863,12 @@ class MessageBase(MSGFile):
             if not _zip:
                 try:
                     os.makedirs(path)
-                except Exception:
+                except Exception as e:
                     newDirName = addNumToDir(path)
                     if newDirName:
                         path = newDirName
                     else:
-                        raise OSError(f'Failed to create directory "{path}". Does it already exist?')
+                        raise OSError(f'Failed to create directory "{path}". Reason: {e}')
             else:
                 # In my testing I ended up with multiple files in a zip at the
                 # same location so let's try to handle that.
@@ -1012,6 +1004,11 @@ class MessageBase(MSGFile):
             while body and body[-1] != 125:
                 body = body[:-1]
 
+            # Some files take a long time due to how they are structured and
+            # how RTFDE works. The longer a file would normally take, the
+            # better this fix works:
+            body = stripRtf(body)
+
             try:
                 deencapsultor = RTFDE.DeEncapsulator(body)
                 deencapsultor.deencapsulate()

{extract_msg-0.54.0 → extract_msg-0.55.0}/extract_msg/msg_classes/msg.py

@@ -203,7 +203,23 @@ class MSGFile:
             self.__overrideEncoding = overrideEncoding
 
             if prefix and not filename:
-                filename = self.getStringStream(prefixl[:-1] + ['__substg1.0_3001'], prefix = False)
+                # We actually need to get this from the parent.
+                msg = None
+                parentNeedsClose = False
+                if self.__parentMsg:
+                    msg = self.__parentMsg()
+                if msg is None:
+                    # We *NEED* the parent here, so we're going to do something
+                    # dumb and just generate it *manually*, grab what we need, # and them immediately close it.
+                    #
+                    # We don't need anything more advanced than MSGFile.
+                    msg = MSGFile(path, prefix = prefixl[:-2], delayAttachments = True)
+                    parentNeedsClose = True
+                # Now that we know we have the parent, grab the stream.
+                filename = msg.getStringStream(prefixl[:-1] + ['__substg1.0_3001'], prefix = False)
+                # Now if we opened the parent, close it.
+                if parentNeedsClose:
+                    msg.close()
             if filename:
                 self.filename = filename
             elif hasattr(path, '__len__'):
@@ -492,7 +508,7 @@ class MSGFile:
 
         :param path: A path-like object (including strings and ``pathlib.Path``
             objects) or an IO device with a write method which accepts bytes.
-        :param allowBadEmbed: If True, attempts to skip steps that will fail if 
+        :param allowBadEmbed: If True, attempts to skip steps that will fail if
             the embedded MSG file violates standards. It will also attempt to repair the data to try to ensure it can open in Outlook.
         """
         from ..ole_writer import OleWriter
@@ -507,7 +523,7 @@ class MSGFile:
         """
         Saves a new copy of the MSG file, returning the bytes.
 
-        :param allowBadEmbed: If True, attempts to skip steps that will fail if 
+        :param allowBadEmbed: If True, attempts to skip steps that will fail if
             the embedded MSG file violates standards. It will also attempt to repair the data to try to ensure it can open in Outlook.
         """
         out = io.BytesIO()

{extract_msg-0.54.0 → extract_msg-0.55.0}/extract_msg/open_msg.py

@@ -109,6 +109,7 @@ def openMsg(path, **kwargs) -> MSGFile:
     # lower function. So let's make sure we got a good return first.
     if not ct:
         if kwargs.get('strict', True):
+            msg.close()
             raise InvalidFileFormatError('File was confirmed to be an olefile, but was not an MSG file.')
         else:
             # If strict mode is off, we'll just return an MSGFile anyways.

{extract_msg-0.54.0 → extract_msg-0.55.0}/extract_msg/utils.py

@@ -37,6 +37,7 @@ __all__ = [
     'rtfSanitizeHtml',
     'rtfSanitizePlain',
     'setupLogging',
+    'stripRtf',
     'tryGetMimetype',
     'unsignedToSignedInt',
     'unwrapMsg',
@@ -61,6 +62,7 @@ import logging
 import logging.config
 import os
 import pathlib
+import re
 import shutil
 import struct
 import sys
@@ -1012,6 +1014,63 @@ def setupLogging(defaultPath = None, defaultLevel = logging.WARN, logfile = None
     return True
 
 
+def stripRtf(rtfBody: bytes) -> bytes:
+    """
+    Cleans up RTF before sending it to RTFDE.
+
+    Attempts to find common sections of RTF data that will
+    """
+    # First, do a pre-strip to try and simplify ignored sections as much as possible.
+    rtfBody = constants.re.RTF_BODY_STRIP_PRE_OPEN.sub(_stripRtfOpenHelper, rtfBody)
+    rtfBody = constants.re.RTF_BODY_STRIP_PRE_CLOSE.sub(_stripRtfCloseHelper, rtfBody)
+    # Second do an initial strip to simplify our data stream.
+    rtfBody = constants.re.RTF_BODY_STRIP_INIT.sub(b'', rtfBody)
+    # Do it one more time to help with some things that might not have gotten
+    # caught the first time, perhaps because something now exists after
+    # stripping.
+    rtfBody = constants.re.RTF_BODY_STRIP_INIT.sub(b'', rtfBody)
+
+    # TODO: Further processing...
+
+    return rtfBody
+
+def _stripRtfCloseHelper(match: re.Match) -> bytes:
+    if (ret := match.expand(b'\\g<0>')).count(b'\\htmlrtf0') > 1:
+        return ret
+
+    if b'\\f' in ret:
+        return ret
+
+    return b'\\htmlrtf}\\htmlrtf0 '
+
+
+def _stripRtfOpenHelper(match: re.Match) -> bytes:
+    if b'\\f' in (ret := match.expand(b'\\g<0>')):
+        return ret
+
+    return b'\\htmlrtf{\\htmlrtf0 '
+
+
+def _stripRtfHelper(match: re.Match) -> bytes:
+    res = match.string
+
+    # If these don't match, don't even try.
+    if res.count(b'{') != res.count(b'}') or res.count(b'{') == 0:
+        return res
+
+    # If any group markers are prefixed by a backslash, give up.
+    if res.find(b'\\{') != -1 or res.find(b'\\}') != -1:
+        return res
+
+    # Last little bit of processing to validate everything. We know the {}
+    # match, but let's be *absolutely* sure.
+    # TODO
+
+    return res
+
+
+
+
 def tryGetMimetype(att: AttachmentBase, mimetype: Union[str, None]) -> Union[str, None]:
     """
     Uses an optional dependency to try and get the mimetype of an attachment.

{extract_msg-0.54.0 → extract_msg-0.55.0}/extract_msg.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: extract-msg
-Version: 0.54.0
+Version: 0.55.0
 Summary: Extracts emails and attachments saved in Microsoft Outlook's .msg files
 Home-page: https://github.com/TeamMsgExtractor/msg-extractor
 Download-URL: https://github.com/TeamMsgExtractor/msg-extractor/archives/master
@@ -278,8 +278,8 @@ your access to the newest major version of extract-msg.
 .. |License: GPL v3| image:: https://img.shields.io/badge/License-GPLv3-blue.svg
    :target: LICENSE.txt
 
-.. |PyPI3| image:: https://img.shields.io/badge/pypi-0.54.0-blue.svg
-   :target: https://pypi.org/project/extract-msg/0.54.0/
+.. |PyPI3| image:: https://img.shields.io/badge/pypi-0.55.0-blue.svg
+   :target: https://pypi.org/project/extract-msg/0.55.0/
 
 .. |PyPI2| image:: https://img.shields.io/badge/python-3.8+-brightgreen.svg
    :target: https://www.python.org/downloads/release/python-3810/