dfindexeddb 20240305__py3-none-any.whl → 20240331__py3-none-any.whl

dfindexeddb/cli.py

@@ -1,180 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright 2024 Google LLC
-#
-# 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
-#
-#     https://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.
-"""A CLI tool for dfindexeddb."""
-import argparse
-import dataclasses
-from datetime import datetime
-import json
-import pathlib
-import sys
-import traceback
-
-from dfindexeddb import errors
-from dfindexeddb import version
-from dfindexeddb.leveldb import descriptor
-from dfindexeddb.leveldb import ldb
-from dfindexeddb.leveldb import log
-from dfindexeddb.indexeddb import chromium
-from dfindexeddb.indexeddb import v8
-
-
-_VALID_PRINTABLE_CHARACTERS = (
-    'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789' +
-    '!"#$%&\'()*+,-./:;<=>?@[\\]^_`{|}~.')
-
-
-class Encoder(json.JSONEncoder):
-  """A JSON encoder class for dfindexeddb fields."""
-  def default(self, o):
-    if isinstance(o, bytes):
-      out = []
-      for x in o:
-        if chr(x) not in _VALID_PRINTABLE_CHARACTERS:
-          out.append(f'\\x{x:02X}')
-        else:
-          out.append(chr(x))
-      return ''.join(out)
-    if isinstance(o, datetime):
-      return o.isoformat()
-    if isinstance(o, v8.Undefined):
-      return "<undefined>"
-    if isinstance(o, v8.Null):
-      return "<null>"
-    if isinstance(o, set):
-      return list(o)
-    if isinstance(o, v8.RegExp):
-      return str(o)
-    return json.JSONEncoder.default(self, o)
-
-
-def _Output(structure, to_json=False):
-  """Helper method to output parsed structure to stdout."""
-  if to_json:
-    structure_dict = dataclasses.asdict(structure)
-    print(json.dumps(structure_dict, indent=2, cls=Encoder))
-  else:
-    print(structure)
-
-
-def IndexeddbCommand(args):
-  """The CLI for processing a log/ldb file as indexeddb."""
-  if args.source.name.endswith('.log'):
-    records = list(
-        log.FileReader(args.source).GetKeyValueRecords())
-  elif args.source.name.endswith('.ldb'):
-    records = list(
-        ldb.FileReader(args.source).GetKeyValueRecords())
-  else:
-    print('Unsupported file type.', file=sys.stderr)
-    return
-
-  for record in records:
-    try:
-      record = chromium.IndexedDBRecord.FromLevelDBRecord(record)
-    except (errors.ParserError, errors.DecoderError) as err:
-      print(
-          (f'Error parsing blink value: {err} for {record.__class__.__name__} '
-           f'at offset {record.offset}'), file=sys.stderr)
-      print(f'Traceback: {traceback.format_exc()}', file=sys.stderr)
-    _Output(record, to_json=args.json)
-
-
-def ManifestCommand(args):
-  """The CLI for processing MANIFEST aka Descriptor files."""
-  manifest_file = descriptor.FileReader(args.source)
-
-  for version_edit in manifest_file.GetVersionEdits():
-    _Output(version_edit, to_json=args.json)
-
-
-def LdbCommand(args):
-  """The CLI for processing ldb files."""
-  ldb_file = ldb.FileReader(args.source)
-
-  if args.structure_type == 'blocks':
-    # Prints block information.
-    for block in ldb_file.GetBlocks():
-      _Output(block, to_json=args.json)
-
-  elif args.structure_type == 'records':
-    # Prints key value record information.
-    for record in ldb_file.GetKeyValueRecords():
-      _Output(record, to_json=args.json)
-
-
-def LogCommand(args):
-  """The CLI for processing log files."""
-  log_file = log.FileReader(args.source)
-
-  if args.structure_type == 'blocks':
-    # Prints block information.
-    for block in log_file.GetBlocks():
-      _Output(block, to_json=args.json)
-
-  elif args.structure_type == 'physical_records':
-    # Prints log file physical record information.
-    for log_file_record in log_file.GetPhysicalRecords():
-      _Output(log_file_record, to_json=args.json)
-
-  elif args.structure_type == 'write_batches':
-    # Prints log file batch information.
-    for batch in log_file.GetWriteBatches():
-      _Output(batch, to_json=args.json)
-
-  elif args.structure_type in ('parsed_internal_key', 'records'):
-    # Prints key value record information.
-    for record in log_file.GetKeyValueRecords():
-      _Output(record, to_json=args.json)
-
-
-def App():
-  """The CLI app entrypoint."""
-  parser = argparse.ArgumentParser(
-      prog='dfindexeddb',
-      description='A cli tool for the dfindexeddb package',
-      epilog=f'Version {version.GetVersion()}')
-
-  parser.add_argument(
-      '-s', '--source', required=True, type=pathlib.Path, 
-      help='The source leveldb file')
-  parser.add_argument('--json', action='store_true', help='Output as JSON')
-  subparsers = parser.add_subparsers(required=True)
-
-  parser_log = subparsers.add_parser('log')
-  parser_log.add_argument(
-      'structure_type', choices=[
-          'blocks',
-          'physical_records',
-          'write_batches',
-          'parsed_internal_key',
-          'records'])
-  parser_log.set_defaults(func=LogCommand)
-
-  parser_log = subparsers.add_parser('ldb')
-  parser_log.add_argument(
-      'structure_type', choices=[
-          'blocks',
-          'records'])
-  parser_log.set_defaults(func=LdbCommand)
-
-  parser_log = subparsers.add_parser('manifest')
-  parser_log.set_defaults(func=ManifestCommand)
-
-  parser_log = subparsers.add_parser('indexeddb')
-  parser_log.set_defaults(func=IndexeddbCommand)
-
-  args = parser.parse_args()
-
-  args.func(args)

dfindexeddb/indexeddb/blink.py

@@ -1,115 +0,0 @@
-# -*- coding: utf-8 -*-
-# Copyright 2024 Google LLC
-#
-# 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
-#
-#     https://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.
-"""Parsers for blink javascript serialized objects."""
-import io
-from typing import Any
-
-from dfindexeddb import utils
-from dfindexeddb.indexeddb import definitions
-from dfindexeddb.indexeddb import v8
-
-
-
-class V8ScriptValueDecoder:
-  """A Blink V8 Serialized Script Value (SSV) decoder.
-
-  Attributes:
-    deserializer (v8.ValueDeserializer): the V8 value deserializer.
-    raw_data (bytes): the raw bytes containing the serialized javascript
-        value.
-    version (int): the blink version.
-  """
-  _MIN_VERSION_FOR_SEPARATE_ENVELOPE = 16
-
-  # As defined in trailer_reader.h
-  _MIN_WIRE_FORMAT_VERSION = 21
-
-  def __init__(self, raw_data: bytes):
-    self.deserializer = None
-    self.raw_data = raw_data
-    self.version = 0
-
-  def _ReadVersionEnvelope(self) -> int:
-    """Reads the Blink version envelope.
-
-    Returns:
-      The number of bytes consumed reading the Blink version envelope or zero
-          if no blink envelope is detected.
-    """
-    if not self.raw_data:
-      return 0
-
-    decoder = utils.StreamDecoder(io.BytesIO(self.raw_data))
-    _, tag_value = decoder.DecodeUint8()
-    tag = definitions.BlinkSerializationTag(tag_value)
-    if tag != definitions.BlinkSerializationTag.VERSION:
-      return 0
-
-    _, version = decoder.DecodeUint32Varint()
-    if version < self._MIN_VERSION_FOR_SEPARATE_ENVELOPE:
-      return 0
-
-    consumed_bytes = decoder.stream.tell()
-
-    if version >= self._MIN_WIRE_FORMAT_VERSION:
-      trailer_offset_data_size = 1 + 8 + 4 # 1 + sizeof(uint64) + sizeof(uint32)
-      consumed_bytes += trailer_offset_data_size
-      if consumed_bytes >= len(self.raw_data):
-        return 0
-    return consumed_bytes
-
-  def ReadTag(self) -> definitions.BlinkSerializationTag:
-    """Reads a blink serialization tag.
-
-    Returns:
-      The blink serialization tag.
-    """
-    _, tag_value = self.deserializer.decoder.DecodeUint8()
-    return definitions.BlinkSerializationTag(tag_value)
-
-  def ReadHostObject(self) -> Any:
-    """Reads a host DOM object.
-
-    Raises:
-      NotImplementedError: when called.
-    """
-    tag = self.ReadTag()
-    raise NotImplementedError(f'V8ScriptValueDecoder.ReadHostObject - {tag}')
-
-  def Deserialize(self) -> Any:
-    """Deserializes a Blink SSV.
-
-    The serialization format has two 'envelopes'.
-    [version tag] [Blink version] [version tag] [v8 version] ...
-
-    Returns:
-      The deserialized script value.
-    """
-    version_envelope_size = self._ReadVersionEnvelope()
-    self.deserializer = v8.ValueDeserializer(
-        io.BytesIO(self.raw_data[version_envelope_size:]), delegate=self)
-    v8_version = self.deserializer.ReadHeader()
-    if not self.version:
-      self.version = v8_version
-    return self.deserializer.ReadValue()
-
-  @classmethod
-  def FromBytes(cls, data: bytes) -> Any:
-    """Deserializes a Blink SSV from the data array.
-
-    Returns:
-      The deserialized script value.
-    """
-    return cls(data).Deserialize()