Error "not well-formed (invalid token)" when getting watchlist due to "end of transmission" character in movie review

[austin-agronick]

Describe the Bug

I am getting this error after adding 'How to Rob a Bank' to my plex watchlist. After debugging I confirmed that it was this part of the xml that was causing the error:

<Review image="rottentomatoes://image.review.fresh"
                link="https://www.commonsensemedia.org/movie-reviews/how-to-rob-a-bank"
                source="Common Sense Media" tag="Barbara Shulgasser"
                text="How to Rob a Bank is a straightforward, workmanlike documentary that effectively tells the story of man who lived in a large treehouse, cooked meth in his own lab, then switched careers for bank robbing\x04."/>

Specifically the \x04 character causes

         │ /home/austin/.asdf/installs/python/3.11.2/lib/python3.11/xml/etree/ElementTree.py:1338 in XML                                                                                                                                                                                                               │
         │                                                                                                                                                                                                                                                                                                             │
         │   1335 │   """                                                                                                                                                                                                                                                                                              │
         │   1336 │   if not parser:                                                                                                                                                                                                                                                                                   │
         │   1337 │   │   parser = XMLParser(target=TreeBuilder())                                                                                                                                                                                                                                                     │
         │ ❱ 1338 │   parser.feed(text)                                                                                                                                                                                                                                                                                │
         │   1339 │   return parser.close() 

to fail with ParseError: not well-formed (invalid token): line 1, column 20416.

If I set a breakpoint at parser.feed(text) and try to execute parser.feed(text) it will show this error. However if I run parser.feed(text.replace(b'\x04', b'')) it does not error.

Some input validation or filtering may be needed to resolve this as the error seems to come directly from the reviewer's site. The issue probably needs to be resolved in myplex.query when passing data to ElementTree.fromstring(data) if data.strip() else None

Code Snippets

self.plex.watchlist()

Expected Behavior

No response

Additional Context

No response

Operating System and Version

Kubuntu 24.04

Plex Media Server Version

Unknown

Python Version

3.11.2

PlexAPI Version

4.15.15

[JonnyWong16]

Possible solution to clean the XML string.

https://stackoverflow.com/a/64570125'

import re
import sys


# https://stackoverflow.com/a/64570125
_illegal_XML_characters = [
    (0x00, 0x08),
    (0x0B, 0x0C),
    (0x0E, 0x1F),
    (0x7F, 0x84),
    (0x86, 0x9F),
    (0xFDD0, 0xFDDF),
    (0xFFFE, 0xFFFF),
]
if sys.maxunicode >= 0x10000:  # not narrow build 
    _illegal_XML_characters.extend(
        [
            (0x1FFFE, 0x1FFFF),
            (0x2FFFE, 0x2FFFF),
            (0x3FFFE, 0x3FFFF),
            (0x4FFFE, 0x4FFFF),
            (0x5FFFE, 0x5FFFF),
            (0x6FFFE, 0x6FFFF),
            (0x7FFFE, 0x7FFFF),
            (0x8FFFE, 0x8FFFF),
            (0x9FFFE, 0x9FFFF),
            (0xAFFFE, 0xAFFFF),
            (0xBFFFE, 0xBFFFF),
            (0xCFFFE, 0xCFFFF),
            (0xDFFFE, 0xDFFFF),
            (0xEFFFE, 0xEFFFF),
            (0xFFFFE, 0xFFFFF),
            (0x10FFFE, 0x10FFFF),
        ]
    )
_illegal_XML_ranges = [
    fr'{chr(low)}-{chr(high)}'
    for (low, high) in _illegal_XML_characters
]
_illegal_XML_re = re.compile(fr'[{"".join(_illegal_XML_ranges)}]')

def cleanXMLString(s):
    return _illegal_XML_re.sub('', s)

# ElementTree.fromstring(cleanXMLString(data))