dfindexeddb 20240224__py3-none-any.whl

dfindexeddb/utils.py

@@ -0,0 +1,295 @@
+# -*- 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.
+"""Utilities for dfindexeddb."""
+import io
+import os
+import struct
+from typing import BinaryIO, Tuple, Type, TypeVar
+
+
+from dfindexeddb import errors
+
+
+class StreamDecoder:
+  """A helper class to decode primitive data types from BinaryIO streams.
+
+   Attributes:
+    stream (BinaryIO): the binary stream.
+  """
+
+  def __init__(self, stream: BinaryIO):
+    """Initializes a StreamDecoder instance.
+
+    Args:
+      stream: the binary stream.
+    """
+    self.stream = stream
+
+  def NumRemainingBytes(self) -> int:
+    """Returns the number of bytes available to the decoder.
+
+    Raises:
+      errors.DecoderError: if there are a negative number of remaining bytes.
+    """
+    current_offset = self.stream.tell()
+    end_offset = self.stream.seek(0, os.SEEK_END)
+    self.stream.seek(current_offset, os.SEEK_SET)
+    num_rem_bytes = end_offset - current_offset
+    if num_rem_bytes < 0:
+      raise errors.DecoderError('Negative number of remaining bytes.')
+    return num_rem_bytes
+
+  def ReadBytes(self, count: int = -1) -> Tuple[int, bytes]:
+    """Reads a number of bytes or the remaining bytes from the binary stream.
+
+    Args:
+      count: the number of bytes to read, if this value is -1 or not provided,
+          all the remaining bytes area read.
+
+    Returns:
+      the offset where bytes were read from and the bytes that were read.
+
+    Raises:
+      errors.DecoderError: if no bytes are available or there are not enough
+          bytes to read.
+    """
+    offset = self.stream.tell()
+    buffer = self.stream.read(count)
+    if count == -1 and not buffer:
+      raise errors.DecoderError('No bytes available')
+    if count != -1 and len(buffer) != count:
+      raise errors.DecoderError(
+          f'Read {len(buffer)}, wanted {count}, at stream offset {offset}')
+    return offset, buffer
+
+  def PeekBytes(self, count: int) -> Tuple[int, bytes]:
+    """Peeks a number of bytes from the binary stream.
+
+    Args:
+      count: the number of bytes to read, if this value is -1 or not provided,
+          all the remaining bytes area read.
+
+    Returns:
+      the offset where bytes were read from and the bytes that were read.
+    """
+    offset, read_bytes = self.ReadBytes(count)
+    self.stream.seek(offset, os.SEEK_SET)
+    return offset, read_bytes
+
+  def DecodeInt(
+      self,
+      byte_count: int = -1,
+      byte_order: str = 'little',
+      signed: bool = True
+  ) -> Tuple[int, int]:
+    """Decodes an integer from the binary stream.
+
+    Args:
+      byte_count: the number of bytes to read.
+      byte_order: the endianness of the integer.
+      signed: True if twos-complement is used to represent the integer.
+
+    Returns:
+      the decoded integer.
+    """
+    offset, buffer = self.ReadBytes(byte_count)
+    return offset, int.from_bytes(buffer, byteorder=byte_order, signed=signed)
+
+  def DecodeUint8(self) -> Tuple[int, int]:
+    """Decodes an unsigned 8-bit integer from the binary stream."""
+    return self.DecodeInt(byte_count=1, signed=False)
+
+  def DecodeUint16(self) -> Tuple[int, int]:
+    """Decodes an unsigned 16-bit integer from the binary stream."""
+    return self.DecodeInt(byte_count=2, signed=False)
+
+  def DecodeUint24(self) -> Tuple[int, int]:
+    """Decodes an unsigned 24-bit integer from the binary stream."""
+    return self.DecodeInt(byte_count=3, signed=False)
+
+  def DecodeUint32(self) -> Tuple[int, int]:
+    """Decodes an unsigned 32-bit integer from the binary stream."""
+    return self.DecodeInt(byte_count=4, signed=False)
+
+  def DecodeUint48(self) -> Tuple[int, int]:
+    """Decodes an unsigned 48-bit integer from the binary stream."""
+    return self.DecodeInt(byte_count=6, signed=False)
+
+  def DecodeUint64(self) -> Tuple[int, int]:
+    """Decodes an unsigned 64-bit integer from the binary stream."""
+    return self.DecodeInt(byte_count=8, signed=False)
+
+  def DecodeInt8(self) -> Tuple[int, int]:
+    """Decodes a signed 8-bit integer from the binary stream."""
+    return self.DecodeInt(byte_count=1, signed=True)
+
+  def DecodeInt16(self) -> Tuple[int, int]:
+    """Decodes a signed 16-bit integer from the binary stream."""
+    return self.DecodeInt(byte_count=2, signed=True)
+
+  def DecodeInt24(self) -> Tuple[int, int]:
+    """Decodes a signed 24-bit integer from the binary stream."""
+    return self.DecodeInt(byte_count=3, signed=True)
+
+  def DecodeInt32(self) -> Tuple[int, int]:
+    """Decodes a signed 32-bit integer from the binary stream."""
+    return self.DecodeInt(byte_count=4, signed=True)
+
+  def DecodeInt48(self) -> Tuple[int, int]:
+    """Decodes a signed 48-bit integer from the binary stream."""
+    return self.DecodeInt(byte_count=6, signed=True)
+
+  def DecodeInt64(self) -> Tuple[int, int]:
+    """Decodes a signed 64-bit integer from the binary stream."""
+    return self.DecodeInt(byte_count=8, signed=True)
+
+  def DecodeDouble(self, little_endian: bool = True) -> Tuple[int, float]:
+    """Returns a Tuple of the offset and a double-precision float."""
+    offset, blob = self.ReadBytes(8)
+    if little_endian:
+      value = struct.unpack('<d', blob)[0]
+    else:
+      value = struct.unpack('>d', blob)[0]
+    return offset, value
+
+  def DecodeFloat(self, little_endian: bool = True) -> Tuple[int, float]:
+    """Returns a Tuple of the offset and a single-precision float."""
+    offset, blob = self.ReadBytes(4)
+    if little_endian:
+      value = struct.unpack('<f', blob)[0]
+    else:
+      value = struct.unpack('>f', blob)[0]
+    return offset, value
+
+  def DecodeVarint(self, max_bytes: int = 10) -> Tuple[int, int]:
+    """Returns a Tuple of the offset and the decoded base128 varint."""
+    offset = self.stream.tell()
+    varint = 0
+    for i in range(0, max_bytes*7, 7):
+      _, varint_part = self.ReadBytes(1)
+      varint |= (varint_part[0] & 0x7f) << i
+      if not varint_part[0] >> 7:
+        break
+    return offset, varint
+
+  def DecodeZigzagVarint(self, max_bytes: int = 10) -> Tuple[int, int]:
+    """Returns a Tuple of the offset and the decoded zigzag varint."""
+    (offset, varint) = self.DecodeVarint(max_bytes)
+    return offset, (varint >> 1) ^ -(varint & 1)
+
+  def DecodeUint32Varint(self) -> Tuple[int, int]:
+    """Decodes a variable unsigned 32-bit integer from the binary stream."""
+    return self.DecodeVarint(max_bytes=5)
+
+  def DecodeUint64Varint(self) -> Tuple[int, int]:
+    """Decodes a variable unsigned 64-bit integer from the binary stream."""
+    return self.DecodeVarint(max_bytes=10)
+
+  def DecodeInt32Varint(self) -> Tuple[int, int]:
+    """Decodes a variable signed 32-bit integer from the binary stream."""
+    return self.DecodeZigzagVarint(max_bytes=5)
+
+  def DecodeInt64Varint(self) -> Tuple[int, int]:
+    """Decodes a variable signed 64-bit integer from the binary stream."""
+    return self.DecodeZigzagVarint(max_bytes=10)
+
+
+
+class LevelDBDecoder(StreamDecoder):
+  """A helper class to decode data types from LevelDB files."""
+
+  def DecodeBool(self) -> Tuple[int, bool]:
+    """Returns a Tuple of the offset of decoding and the bool value."""
+    offset, buffer = self.ReadBytes(1)
+    return offset, buffer[0] is not None
+
+  def DecodeString(self) -> Tuple[int, str]:
+    """Returns a tuple of the offset of decoding and the string value.
+
+    Raises:
+      errors.DecoderError: when the parsed string buffer is not even (i.e.
+          cannot be decoded as a UTF-16-BE string.
+    """
+    offset = self.stream.tell()
+    buffer = self.stream.read()
+    if len(buffer) % 2:
+      raise errors.DecoderError('Odd number of bytes encountered')
+    return offset, buffer.decode('utf-16-be')
+
+  def DecodeBlobWithLength(self) -> Tuple[int, bytes]:
+    """Returns a tuple of a the offset of decoding and the binary blob."""
+    offset, num_bytes = self.DecodeUint64Varint()
+    _, blob = self.ReadBytes(num_bytes)
+    return offset, blob
+
+  def DecodeStringWithLength(self) -> Tuple[int, str]:
+    """Returns a tuple of the offset of decoding and the string value."""
+    offset, length = self.DecodeUint64Varint()
+    _, buffer = self.ReadBytes(length*2)
+    return offset, buffer.decode('utf-16-be')
+
+
+T = TypeVar('T')
+
+
+class FromStreamMixin:  # TODO: refactor leveldb parsers
+  """A mixin for dataclasses parsing their attributes from a binary stream."""
+
+  @classmethod
+  def FromDecoder(
+      cls: Type[T], decoder: LevelDBDecoder, base_offset: int = 0) -> T:
+    """Decodes a class type from the current position of a LevelDBDecoder.
+
+    Args:
+      decoder: the LevelDBDecoder.
+      base_offset: the base offset.
+
+    Returns:
+      The class instance.
+
+    Raises:
+      NotImplementedError if the child class does not implement this method.
+    """
+    raise NotImplementedError
+
+  @classmethod
+  def FromStream(
+      cls: Type[T], stream: BinaryIO, base_offset: int = 0) -> T:
+    """Decodes a class type from the current position of a binary stream.
+
+    Args:
+      stream: the binary stream.
+      base_offset: the base offset of the binary stream.
+
+    Returns:
+      The class instance.
+    """
+    decoder = LevelDBDecoder(stream)
+    return cls.FromDecoder(decoder, base_offset)
+
+  @classmethod
+  def FromBytes(
+      cls: Type[T], raw_data: bytes, base_offset: int = 0) -> T:
+    """Parses a class type from raw bytes.
+
+    Args:
+      raw_data: the raw data.
+      base_offset: the base offset of the raw data.
+
+    Returns:
+      The class instance.
+    """
+    stream = io.BytesIO(raw_data)
+    return cls.FromStream(stream=stream, base_offset=base_offset)

dfindexeddb/version.py

@@ -0,0 +1,22 @@
+# -*- 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.
+"""Version information for dfIndexeddb."""
+
+__version__ = "20240224"
+
+
+def GetVersion():
+  """Returns the version information."""
+  return __version__

dfindexeddb-20240224.dist-info/AUTHORS

@@ -0,0 +1,12 @@
+# Names should be added to this file with this pattern:
+#
+# For individuals:
+#   Name (email address)
+#
+# For organizations:
+#   Organization (fnmatch pattern)
+#
+# See python fnmatch module documentation for more information.
+
+Google Inc. (*@google.com)
+Syd Pleno (syd.pleno@gmail.com)

dfindexeddb-20240224.dist-info/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.