1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534
|
#!/usr/bin/env python3
"""
Defines the default object transformers
:authors: Thomas Calmant
:license: Apache License 2.0
:version: 0.4.4
:status: Alpha
..
Copyright 2024 Thomas Calmant
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
"""
# Standard library
import functools
from typing import List, Optional, Tuple
# Numpy (optional)
try:
import numpy
except ImportError:
numpy = None # type: ignore
# Javaobj
from ..constants import TerminalCode, TypeCode
from ..utils import log_debug, log_error, read_string, read_struct, to_bytes
from .api import IJavaStreamParser, ObjectTransformer
from .beans import ( # pylint:disable=W0611
BlockData,
JavaClassDesc,
JavaInstance,
)
from .stream import DataStreamReader
# ------------------------------------------------------------------------------
# Module version
__version_info__ = (0, 4, 4)
__version__ = ".".join(str(x) for x in __version_info__)
# Documentation strings format
__docformat__ = "restructuredtext en"
# ------------------------------------------------------------------------------
class JavaList(list, JavaInstance):
"""
Python-Java list bridge type
"""
HANDLED_CLASSES = ("java.util.ArrayList", "java.util.LinkedList")
def __init__(self):
list.__init__(self)
JavaInstance.__init__(self)
def load_from_instance(self, indent=0):
# type: (int) -> bool
"""
Load content from a parsed instance object
"""
# Lists have their content in there annotations
for cd, annotations in self.annotations.items():
if cd.name in self.HANDLED_CLASSES:
self.extend(ann for ann in annotations[1:])
return True
return False
@functools.total_ordering
class JavaPrimitiveClass(JavaInstance):
"""
Parent of Java classes matching a primitive (Bool, Integer, Long, ...)
"""
def __init__(self):
JavaInstance.__init__(self)
self.value = None
def __str__(self):
return str(self.value)
def __repr__(self):
return repr(self.value)
def __hash__(self):
return hash(self.value)
def __eq__(self, other):
return self.value == other
def __lt__(self, other):
return self.value < other
def load_from_instance(self, indent=0):
# type: (int) -> bool
"""
Load content from a parsed instance object
"""
for fields in self.field_data.values():
for field, value in fields.items():
if field.name == "value":
self.value = value
return True
return False
class JavaBool(JavaPrimitiveClass):
"""
Represents a Java Boolean object
"""
HANDLED_CLASSES = "java.lang.Boolean"
def __bool__(self):
return self.value
class JavaInt(JavaPrimitiveClass):
"""
Represents a Java Integer or Long object
"""
HANDLED_CLASSES = ("java.lang.Integer", "java.lang.Long")
def __int__(self):
return self.value
class JavaMap(dict, JavaInstance):
"""
Python-Java dictionary/map bridge type
"""
HANDLED_CLASSES = (
"java.util.HashMap",
"java.util.TreeMap",
) # type: Tuple[str, ...]
def __init__(self):
dict.__init__(self)
JavaInstance.__init__(self)
def load_from_instance(self, indent=0):
# type: (int) -> bool
"""
Load content from a parsed instance object
"""
# Maps have their content in there annotations
for cd, annotations in self.annotations.items():
if cd.name in JavaMap.HANDLED_CLASSES:
# Group annotation elements 2 by 2
args = [iter(annotations[1:])] * 2
for key, value in zip(*args):
self[key] = value
return True
return False
class JavaLinkedHashMap(JavaMap):
"""
Linked has map are handled with a specific block data
"""
HANDLED_CLASSES = ("java.util.LinkedHashMap",)
def load_from_blockdata(self, parser, reader, indent=0):
# type: (IJavaStreamParser, DataStreamReader, int) -> bool
"""
Loads the content of the map, written with a custom implementation
"""
# Read HashMap fields
self.buckets = reader.read_int()
self.size = reader.read_int()
# Read entries
for _ in range(self.size):
key_code = reader.read_byte()
key = parser._read_content(key_code, True)
value_code = reader.read_byte()
value = parser._read_content(value_code, True)
self[key] = value
# Ignore the end of the blockdata
type_code = reader.read_byte()
if type_code != TerminalCode.TC_ENDBLOCKDATA:
raise ValueError("Didn't find the end of block data")
# Ignore the trailing 0
final_byte = reader.read_byte()
if final_byte != 0:
raise ValueError("Should find 0x0, got {0:x}".format(final_byte))
return True
class JavaSet(set, JavaInstance):
"""
Python-Java set bridge type
"""
HANDLED_CLASSES = (
"java.util.HashSet",
"java.util.LinkedHashSet",
) # type: Tuple[str, ...]
def __init__(self):
set.__init__(self)
JavaInstance.__init__(self)
def load_from_instance(self, indent=0):
# type: (int) -> bool
"""
Load content from a parsed instance object
"""
# Lists have their content in there annotations
for cd, annotations in self.annotations.items():
if cd.name in self.HANDLED_CLASSES:
self.update(x for x in annotations[1:])
return True
return False
class JavaTreeSet(JavaSet):
"""
Tree sets are handled a bit differently
"""
HANDLED_CLASSES = ("java.util.TreeSet",)
def load_from_instance(self, indent=0):
# type: (int) -> bool
"""
Load content from a parsed instance object
"""
# Lists have their content in there annotations
for cd, annotations in self.annotations.items():
if cd.name in self.HANDLED_CLASSES:
# Annotation[1] == size of the set
self.update(x for x in annotations[2:])
return True
return False
class JavaTime(JavaInstance):
"""
Represents the classes found in the java.time package
The semantic of the fields depends on the type of time that has been
parsed
"""
HANDLED_CLASSES = ("java.time.Ser",) # type: Tuple[str, ...]
DURATION_TYPE = 1
INSTANT_TYPE = 2
LOCAL_DATE_TYPE = 3
LOCAL_TIME_TYPE = 4
LOCAL_DATE_TIME_TYPE = 5
ZONE_DATE_TIME_TYPE = 6
ZONE_REGION_TYPE = 7
ZONE_OFFSET_TYPE = 8
OFFSET_TIME_TYPE = 9
OFFSET_DATE_TIME_TYPE = 10
YEAR_TYPE = 11
YEAR_MONTH_TYPE = 12
MONTH_DAY_TYPE = 13
PERIOD_TYPE = 14
def __init__(self):
JavaInstance.__init__(self)
self.type = -1
self.year = None
self.month = None
self.day = None
self.hour = None
self.minute = None
self.second = None
self.nano = None
self.offset = None
self.zone = None
self.time_handlers = {
self.DURATION_TYPE: self.do_duration,
self.INSTANT_TYPE: self.do_instant,
self.LOCAL_DATE_TYPE: self.do_local_date,
self.LOCAL_DATE_TIME_TYPE: self.do_local_date_time,
self.LOCAL_TIME_TYPE: self.do_local_time,
self.ZONE_DATE_TIME_TYPE: self.do_zoned_date_time,
self.ZONE_OFFSET_TYPE: self.do_zone_offset,
self.ZONE_REGION_TYPE: self.do_zone_region,
self.OFFSET_TIME_TYPE: self.do_offset_time,
self.OFFSET_DATE_TIME_TYPE: self.do_offset_date_time,
self.YEAR_TYPE: self.do_year,
self.YEAR_MONTH_TYPE: self.do_year_month,
self.MONTH_DAY_TYPE: self.do_month_day,
self.PERIOD_TYPE: self.do_period,
}
def __str__(self):
return (
"JavaTime(type=0x{s.type}, "
"year={s.year}, month={s.month}, day={s.day}, "
"hour={s.hour}, minute={s.minute}, second={s.second}, "
"nano={s.nano}, offset={s.offset}, zone={s.zone})"
).format(s=self)
def load_from_blockdata(self, parser, reader, indent=0):
"""
Ignore the SC_BLOCK_DATA flag
"""
return True
def load_from_instance(self, indent=0):
# type: (int) -> bool
"""
Load content from a parsed instance object
"""
# Lists have their content in there annotations
for cd, annotations in self.annotations.items():
if cd.name in self.HANDLED_CLASSES:
if not isinstance(annotations[0], BlockData):
raise ValueError("Require a BlockData as annotation")
# Convert back annotations to bytes
# latin-1 is used to ensure that bytes are kept as is
content = to_bytes(annotations[0].data, "latin1")
(self.type,), content = read_struct(content, ">b")
try:
self.time_handlers[self.type](content)
except KeyError as ex:
log_error("Unhandled kind of time: {}".format(ex))
return True
return False
def do_duration(self, data):
(self.second, self.nano), data = read_struct(data, ">qi")
return data
def do_instant(self, data):
(self.second, self.nano), data = read_struct(data, ">qi")
return data
def do_local_date(self, data):
(self.year, self.month, self.day), data = read_struct(data, ">ibb")
return data
def do_local_time(self, data):
(hour,), data = read_struct(data, ">b")
minute = 0
second = 0
nano = 0
if hour < 0:
hour = ~hour
else:
(minute,), data = read_struct(data, ">b")
if minute < 0:
minute = ~minute
else:
(second,), data = read_struct(data, ">b")
if second < 0:
second = ~second
else:
(nano,), data = read_struct(data, ">i")
self.hour = hour
self.minute = minute
self.second = second
self.nano = nano
return data
def do_local_date_time(self, data):
data = self.do_local_date(data)
data = self.do_local_time(data)
return data
def do_zoned_date_time(self, data):
data = self.do_local_date_time(data)
data = self.do_zone_offset(data)
data = self.do_zone_region(data)
return data
def do_zone_offset(self, data):
(offset_byte,), data = read_struct(data, ">b")
if offset_byte == 127:
(self.offset,), data = read_struct(data, ">i")
else:
self.offset = offset_byte * 900
return data
def do_zone_region(self, data):
self.zone, data = read_string(data)
return data
def do_offset_time(self, data):
data = self.do_local_time(data)
data = self.do_zone_offset(data)
return data
def do_offset_date_time(self, data):
data = self.do_local_date_time(data)
data = self.do_zone_offset(data)
return data
def do_year(self, data):
(self.year,), data = read_struct(data, ">i")
return data
def do_year_month(self, data):
(self.year, self.month), data = read_struct(data, ">ib")
return data
def do_month_day(self, data):
(self.month, self.day), data = read_struct(data, ">bb")
return data
def do_period(self, data):
(self.year, self.month, self.day), data = read_struct(data, ">iii")
return data
class DefaultObjectTransformer(ObjectTransformer):
"""
Provider of the default object transformers
"""
KNOWN_TRANSFORMERS = (
JavaBool,
JavaInt,
JavaList,
JavaMap,
JavaLinkedHashMap,
JavaSet,
JavaTreeSet,
JavaTime,
)
def __init__(self):
# Construct the link: Java class name -> Python transformer
self._type_mapper = {}
for transformer_class in self.KNOWN_TRANSFORMERS:
handled_classes = transformer_class.HANDLED_CLASSES
if isinstance(handled_classes, str):
# Single class handled
self._type_mapper[handled_classes] = transformer_class
else:
# Multiple classes handled
for class_name in transformer_class.HANDLED_CLASSES:
self._type_mapper[class_name] = transformer_class
def create_instance(self, classdesc):
# type: (JavaClassDesc) -> Optional[JavaInstance]
"""
Transforms a parsed Java object into a Python object
:param classdesc: The description of a Java class
:return: The Python form of the object, or the original JavaObject
"""
try:
mapped_type = self._type_mapper[classdesc.name]
except KeyError:
# Return None if not handled
return None
else:
log_debug("---")
log_debug(classdesc.name)
log_debug("---")
java_object = mapped_type()
java_object.classdesc = classdesc
log_debug(">>> java_object: {0}".format(java_object))
return java_object
class NumpyArrayTransformer(ObjectTransformer):
"""
Loads arrays as numpy arrays if possible
"""
# Convertion of a Java type char to its NumPy equivalent
NUMPY_TYPE_MAP = {
TypeCode.TYPE_BYTE: "B",
TypeCode.TYPE_CHAR: "b",
TypeCode.TYPE_DOUBLE: ">d",
TypeCode.TYPE_FLOAT: ">f",
TypeCode.TYPE_INTEGER: ">i",
TypeCode.TYPE_LONG: ">l",
TypeCode.TYPE_SHORT: ">h",
TypeCode.TYPE_BOOLEAN: ">B",
}
def load_array(self, reader, type_code, size):
# type: (DataStreamReader, TypeCode, int) -> Optional[list]
"""
Loads a Java array, if possible
"""
if numpy is not None:
try:
dtype = self.NUMPY_TYPE_MAP[type_code]
except KeyError:
# Unhandled data type
return None
else:
return numpy.fromfile(
reader.file_descriptor, dtype=dtype, count=size,
)
return None
|