Module refinery.lib.lnk.extradata

Classes

class EnvironmentVariableDataBlock (reader)

A class to parse structured data. A Struct class can be instantiated as follows:

foo = Struct(data, bar=29)

The initialization routine of the structure will be called with a single argument reader. If the object data is already a StructReader, then it will be passed as reader. Otherwise, the argument will be wrapped in a StructReader. Additional arguments to the struct are passed through.

Expand source code Browse git

class EnvironmentVariableDataBlock(Struct[memoryview]):
    def __init__(self, reader: StructReader[memoryview]):
        raw_ansi = reader.read_bytes(260)
        raw_unicode = reader.read_bytes(520)
        self.target_unicode = codecs.decode(
            raw_unicode.split(b'\0\0')[0].rstrip(b'\0'), 'utf-16-le'
        ) or None
        self.target_ansi = codecs.decode(
            raw_ansi.split(b'\0')[0], 'cp1252'
        ) or None

    def __json__(self) -> dict:
        result: dict = {'type': 'environment_variable'}
        if self.target_unicode:
            result['target'] = self.target_unicode
        elif self.target_ansi:
            result['target'] = self.target_ansi
        return result

Ancestors

• Struct
• typing.Generic
• collections.abc.Buffer

Static methods

def Parse(reader, *args, **kwargs)

class ConsoleDataBlock (reader)

A class to parse structured data. A Struct class can be instantiated as follows:

foo = Struct(data, bar=29)

The initialization routine of the structure will be called with a single argument reader. If the object data is already a StructReader, then it will be passed as reader. Otherwise, the argument will be wrapped in a StructReader. Additional arguments to the struct are passed through.

Expand source code Browse git

class ConsoleDataBlock(Struct[memoryview]):
    def __init__(self, reader: StructReader[memoryview]):
        self.fill_attributes = reader.u16()
        self.popup_fill_attributes = reader.u16()
        self.screen_buffer_size_x = reader.u16()
        self.screen_buffer_size_y = reader.u16()
        self.window_size_x = reader.u16()
        self.window_size_y = reader.u16()
        self.window_origin_x = reader.u16()
        self.window_origin_y = reader.u16()
        reader.skip(8)
        self.font_size = reader.u32()
        self.font_family = reader.u32()
        self.font_weight = reader.u32()
        raw_face = reader.read_bytes(64)
        self.face_name = codecs.decode(
            raw_face.split(b'\0\0')[0].rstrip(b'\0'), 'utf-16-le'
        )
        self.cursor_size = reader.u32()
        self.full_screen = reader.u32()
        self.quick_edit = reader.u32()
        self.insert_mode = reader.u32()
        self.auto_position = reader.u32()
        self.history_buffer_size = reader.u32()
        self.number_of_history_buffers = reader.u32()
        self.history_no_dup = reader.u32()
        self.color_table = [reader.u32() for _ in range(16)]

Ancestors

• Struct
• typing.Generic
• collections.abc.Buffer

Static methods

def Parse(reader, *args, **kwargs)

class TrackerDataBlock (reader)

A class to parse structured data. A Struct class can be instantiated as follows:

foo = Struct(data, bar=29)

The initialization routine of the structure will be called with a single argument reader. If the object data is already a StructReader, then it will be passed as reader. Otherwise, the argument will be wrapped in a StructReader. Additional arguments to the struct are passed through.

Expand source code Browse git

class TrackerDataBlock(Struct[memoryview]):
    def __init__(self, reader: StructReader[memoryview]):
        reader.skip(8)
        raw_machine = reader.read_bytes(16)
        self.machine_id = codecs.decode(
            raw_machine.split(b'\0')[0], 'ascii'
        )
        self.droid_volume = str(reader.read_guid())
        self.droid_file = str(reader.read_guid())
        self.droid_birth_volume = str(reader.read_guid())
        self.droid_birth_file = str(reader.read_guid())

Ancestors

• Struct
• typing.Generic
• collections.abc.Buffer

Static methods

def Parse(reader, *args, **kwargs)

class ConsoleFEDataBlock (reader)

A class to parse structured data. A Struct class can be instantiated as follows:

foo = Struct(data, bar=29)

The initialization routine of the structure will be called with a single argument reader. If the object data is already a StructReader, then it will be passed as reader. Otherwise, the argument will be wrapped in a StructReader. Additional arguments to the struct are passed through.

Expand source code Browse git

class ConsoleFEDataBlock(Struct[memoryview]):
    def __init__(self, reader: StructReader[memoryview]):
        self.code_page = reader.u32()

Ancestors

• Struct
• typing.Generic
• collections.abc.Buffer

Static methods

def Parse(reader, *args, **kwargs)

class SpecialFolderDataBlock (reader)

A class to parse structured data. A Struct class can be instantiated as follows:

foo = Struct(data, bar=29)

The initialization routine of the structure will be called with a single argument reader. If the object data is already a StructReader, then it will be passed as reader. Otherwise, the argument will be wrapped in a StructReader. Additional arguments to the struct are passed through.

Expand source code Browse git

class SpecialFolderDataBlock(Struct[memoryview]):
    def __init__(self, reader: StructReader[memoryview]):
        self.special_folder_id = reader.u32()
        self.offset = reader.u32()

Ancestors

• Struct
• typing.Generic
• collections.abc.Buffer

Static methods

def Parse(reader, *args, **kwargs)

class DarwinDataBlock (reader)

A class to parse structured data. A Struct class can be instantiated as follows:

foo = Struct(data, bar=29)

The initialization routine of the structure will be called with a single argument reader. If the object data is already a StructReader, then it will be passed as reader. Otherwise, the argument will be wrapped in a StructReader. Additional arguments to the struct are passed through.

Expand source code Browse git

class DarwinDataBlock(Struct[memoryview]):
    def __init__(self, reader: StructReader[memoryview]):
        raw_ansi = reader.read_bytes(260)
        raw_unicode = reader.read_bytes(520)
        self.darwin_data_unicode = codecs.decode(
            raw_unicode.split(b'\0\0')[0].rstrip(b'\0'), 'utf-16-le'
        ) or None
        self.darwin_data_ansi = codecs.decode(
            raw_ansi.split(b'\0')[0], 'cp1252'
        ) or None

    def __json__(self) -> dict:
        result: dict = {'type': 'darwin'}
        data = self.darwin_data_unicode or self.darwin_data_ansi
        if data:
            result['darwin_data'] = data
        return result

Ancestors

• Struct
• typing.Generic
• collections.abc.Buffer

Static methods

def Parse(reader, *args, **kwargs)

class IconEnvironmentDataBlock (reader)

A class to parse structured data. A Struct class can be instantiated as follows:

foo = Struct(data, bar=29)

The initialization routine of the structure will be called with a single argument reader. If the object data is already a StructReader, then it will be passed as reader. Otherwise, the argument will be wrapped in a StructReader. Additional arguments to the struct are passed through.

Expand source code Browse git

class IconEnvironmentDataBlock(Struct[memoryview]):
    def __init__(self, reader: StructReader[memoryview]):
        raw_ansi = reader.read_bytes(260)
        raw_unicode = reader.read_bytes(520)
        self.target_unicode = codecs.decode(
            raw_unicode.split(b'\0\0')[0].rstrip(b'\0'), 'utf-16-le'
        ) or None
        self.target_ansi = codecs.decode(
            raw_ansi.split(b'\0')[0], 'cp1252'
        ) or None

    def __json__(self) -> dict:
        result: dict = {'type': 'icon_environment'}
        if self.target_unicode:
            result['target'] = self.target_unicode
        elif self.target_ansi:
            result['target'] = self.target_ansi
        return result

Ancestors

• Struct
• typing.Generic
• collections.abc.Buffer

Static methods

def Parse(reader, *args, **kwargs)

class ShimDataBlock (reader, block_data_size)

A class to parse structured data. A Struct class can be instantiated as follows:

foo = Struct(data, bar=29)

The initialization routine of the structure will be called with a single argument reader. If the object data is already a StructReader, then it will be passed as reader. Otherwise, the argument will be wrapped in a StructReader. Additional arguments to the struct are passed through.

Expand source code Browse git

class ShimDataBlock(Struct[memoryview]):
    def __init__(self, reader: StructReader[memoryview], block_data_size: int):
        raw = reader.read_bytes(block_data_size)
        self.layer_name = codecs.decode(
            raw.rstrip(b'\0').rstrip(b'\0'), 'utf-16-le'
        )

Ancestors

• Struct
• typing.Generic
• collections.abc.Buffer

Static methods

def Parse(reader, *args, **kwargs)

class PropertyStoreDataBlock (reader, block_data_size)

A class to parse structured data. A Struct class can be instantiated as follows:

foo = Struct(data, bar=29)

The initialization routine of the structure will be called with a single argument reader. If the object data is already a StructReader, then it will be passed as reader. Otherwise, the argument will be wrapped in a StructReader. Additional arguments to the struct are passed through.

Expand source code Browse git

class PropertyStoreDataBlock(Struct[memoryview]):
    def __init__(self, reader: StructReader[memoryview], block_data_size: int):
        self.raw = reader.read_bytes(block_data_size)

    def __json__(self) -> dict:
        return {'type': 'property_store', 'raw': self.raw.hex()}

Ancestors

• Struct
• typing.Generic
• collections.abc.Buffer

Static methods

def Parse(reader, *args, **kwargs)

class KnownFolderDataBlock (reader)

A class to parse structured data. A Struct class can be instantiated as follows:

foo = Struct(data, bar=29)

The initialization routine of the structure will be called with a single argument reader. If the object data is already a StructReader, then it will be passed as reader. Otherwise, the argument will be wrapped in a StructReader. Additional arguments to the struct are passed through.

Expand source code Browse git

class KnownFolderDataBlock(Struct[memoryview]):
    def __init__(self, reader: StructReader[memoryview]):
        self.known_folder_id = str(reader.read_guid())
        self.offset = reader.u32()

Ancestors

• Struct
• typing.Generic
• collections.abc.Buffer

Static methods

def Parse(reader, *args, **kwargs)

class VistaAndAboveIDListDataBlock (reader, block_data_size)

A class to parse structured data. A Struct class can be instantiated as follows:

foo = Struct(data, bar=29)

The initialization routine of the structure will be called with a single argument reader. If the object data is already a StructReader, then it will be passed as reader. Otherwise, the argument will be wrapped in a StructReader. Additional arguments to the struct are passed through.

Expand source code Browse git

class VistaAndAboveIDListDataBlock(Struct[memoryview]):
    def __init__(self, reader: StructReader[memoryview], block_data_size: int):
        end = reader.tell() + block_data_size
        self.id_list = LinkTargetIDList(reader)
        reader.seekset(end)

Ancestors

• Struct
• typing.Generic
• collections.abc.Buffer

Static methods

def Parse(reader, *args, **kwargs)

class ExtraDataBlock (signature, name, data=None)

ExtraDataBlock(signature: 'int', name: 'str', data: 'Struct | None' = None)

Expand source code Browse git

@dataclass
class ExtraDataBlock:
    signature: int
    name: str
    data: Struct | None = None

    def __json__(self) -> dict:
        if self.data is not None:
            return self.data.__json__()
        return {'type': self.name, 'signature': F'0x{self.signature:08X}'}

Instance variables

var signature

The type of the None singleton.

var name

The type of the None singleton.

var data

The type of the None singleton.

class ExtraData (blocks=<factory>)

ExtraData(blocks: 'list[ExtraDataBlock]' = )

Expand source code Browse git

@dataclass
class ExtraData:
    blocks: list[ExtraDataBlock] = field(default_factory=list)

    def __json__(self) -> list:
        return [struct_to_json(b.__json__()) for b in self.blocks]

    @classmethod
    def parse(cls, reader: StructReader[memoryview]) -> ExtraData:
        result = cls()
        while reader.remaining_bytes >= 4:
            block_size = reader.u32()
            if block_size < 4:
                break
            if reader.remaining_bytes < 4:
                break
            signature = reader.u32()
            data_size = block_size - 8
            name = _BLOCK_NAMES.get(signature, F'unknown_0x{signature:08X}')
            block_start = reader.tell()
            parsed: Struct | None = None
            try:
                if signature == _SIG_ENVIRONMENT_VARIABLE:
                    parsed = EnvironmentVariableDataBlock(reader)
                elif signature == _SIG_CONSOLE:
                    parsed = ConsoleDataBlock(reader)
                elif signature == _SIG_TRACKER:
                    parsed = TrackerDataBlock(reader)
                elif signature == _SIG_CONSOLE_FE:
                    parsed = ConsoleFEDataBlock(reader)
                elif signature == _SIG_SPECIAL_FOLDER:
                    parsed = SpecialFolderDataBlock(reader)
                elif signature == _SIG_DARWIN:
                    parsed = DarwinDataBlock(reader)
                elif signature == _SIG_ICON_ENVIRONMENT:
                    parsed = IconEnvironmentDataBlock(reader)
                elif signature == _SIG_SHIM:
                    parsed = ShimDataBlock(reader, data_size)
                elif signature == _SIG_PROPERTY_STORE:
                    parsed = PropertyStoreDataBlock(reader, data_size)
                elif signature == _SIG_KNOWN_FOLDER:
                    parsed = KnownFolderDataBlock(reader)
                elif signature == _SIG_VISTA_IDLIST:
                    parsed = VistaAndAboveIDListDataBlock(reader, data_size)
            except Exception:
                pass
            reader.seekset(block_start + data_size)
            result.blocks.append(ExtraDataBlock(
                signature=signature, name=name, data=parsed))
        return result

Static methods

def parse(reader)

Instance variables

var blocks

The type of the None singleton.