Skip to content

fix: Custom reader should read till endblock #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
svaningelgem wants to merge 4 commits into
base: master
Choose a base branch
from
Open

fix: Custom reader should read till endblock #61

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
14aa441
Adding test data
svaningelgem Jun 9, 2025
67c629f
Changed code
svaningelgem Jun 9, 2025
eebea7e
Fixed the issue.
svaningelgem Jun 9, 2025
1bf2a23
Only an issue under v1, not v2
svaningelgem Jun 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fixed the issue.
  • Loading branch information
@svaningelgem
svaningelgem committed Jun 9, 2025
commit eebea7ef53f8303a076a66075ffd8457f8ab9412
85 changes: 61 additions & 24 deletions javaobj/v1/unmarshaller.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -514,44 +514,81 @@ def do_object(self, parent=None, ident=0):
# TODO:
raise NotImplementedError("externalContents isn't implemented yet")

if classdesc.flags & ClassDescFlags.SC_SERIALIZABLE:
# Handle each class in the hierarchy separately, from most derived to root
self._read_class_data(java_object, classdesc, ident)
# Process class data for the entire hierarchy
self._read_serializable_data(java_object, classdesc, ident)

log_debug(">>> java_object: {0}".format(java_object), ident)
return java_object

def _read_class_data(self, java_object, classdesc, ident):
def _read_serializable_data(self, java_object, classdesc, ident):
"""
Recursively reads class data for the inheritance hierarchy
Read serializable data following the Java specification more closely.
According to the spec, for each class in the hierarchy (from super to sub):
1. Read primitive fields
2. If SC_WRITE_METHOD is set, read custom writeObject data until TC_ENDBLOCKDATA
"""
if classdesc is None:
return
if classdesc.superclass:
self._read_serializable_data(java_object, classdesc.superclass, ident + 1)

# First, handle the superclass data
if classdesc.superclass is not None:
self._read_class_data(java_object, classdesc.superclass, ident)
if classdesc.flags & ClassDescFlags.SC_SERIALIZABLE:
# TODO: look at ObjectInputStream.readSerialData()
# FIXME: Handle the SC_WRITE_METHOD flag

log_debug("Constructing class...", ident)
log_debug("Class: {0}".format(classdesc.name), ident + 1)
if classdesc.fields_names:
class_fields_str = " - ".join(
" ".join((str(field_type), field_name))
for field_type, field_name in zip(
classdesc.fields_types, classdesc.fields_names
)
)
log_debug(class_fields_str, ident + 2)

# Then handle this class's data
log_debug("Reading class data for: {0}".format(classdesc.name), ident)
log_debug("Values count: {0}".format(len(classdesc.fields_names)), ident)
log_debug("Prepared list of values: {0}".format(classdesc.fields_names), ident)
log_debug("Prepared list of types: {0}".format(classdesc.fields_types), ident)

# Read field values for this specific class
for field_name, field_type in zip(classdesc.fields_names, classdesc.fields_types):
log_debug("Reading field: {0} - {1}".format(field_type, field_name), ident)
res = self._read_value(field_type, ident, name=field_name)
java_object.__setattr__(field_name, res)
for field_name, field_type in zip(classdesc.fields_names, classdesc.fields_types):
log_debug(
"Reading field: {0} - {1}".format(field_type, field_name)
)
res = self._read_value(field_type, ident, name=field_name)
java_object.__setattr__(field_name, res)

# Handle annotations if this class has the SC_WRITE_METHOD flag
if classdesc.flags & ClassDescFlags.SC_WRITE_METHOD:
log_debug("Reading annotations for class: {0}".format(classdesc.name), ident)
has_write_method = classdesc.flags & ClassDescFlags.SC_SERIALIZABLE and classdesc.flags & ClassDescFlags.SC_WRITE_METHOD
has_block_data = classdesc.flags & ClassDescFlags.SC_EXTERNALIZABLE and classdesc.flags & ClassDescFlags.SC_BLOCK_DATA
if has_write_method or has_block_data:
# objectAnnotation
log_debug(
"java_object.annotations before: {0}".format(
java_object.annotations
),
ident,
)

while True:
opcode = None
while opcode != TerminalCode.TC_ENDBLOCKDATA:
opcode, obj = self._read_and_exec_opcode(ident=ident + 1)
if opcode == TerminalCode.TC_ENDBLOCKDATA:
break
java_object.annotations.append(obj)
# , expect=[self.TC_ENDBLOCKDATA, self.TC_BLOCKDATA,
# self.TC_OBJECT, self.TC_NULL, self.TC_REFERENCE])
if opcode != TerminalCode.TC_ENDBLOCKDATA:
java_object.annotations.append(obj)

log_debug("objectAnnotation value: {0}".format(obj), ident)

log_debug(
"java_object.annotations after: {0}".format(
java_object.annotations
),
ident,
)

# Allow extra loading operations
if hasattr(java_object, "__extra_loading__"):
log_debug("Java object has extra loading capability.")
java_object.__extra_loading__(self, ident)

def do_string(self, parent=None, ident=0):
"""
Handles a TC_STRING opcode
Expand Down
3 changes: 3 additions & 0 deletions tests/test_v2.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -645,6 +645,9 @@ def test_writeObject(self):
self.assertEqual(expected["custom_obj"]["annotations"], super_data)

def test_read_custom(self):
"""
Tests to verify that the super-class is properly read when a custom writer is involved.
"""
ser = self.read_file("issue60_custom_reader_endblock.ser")
pobj = javaobj.loads(ser)
self.assertIsNone(pobj.superItems)
Expand Down