Module refinery.units.formats.lnk

Expand source code Browse git 
from __future__ import annotations

from refinery.lib.structures import MemoryFile
from refinery.lib.tools import NoLogging
from refinery.lib.types import Param
from refinery.units.formats import Arg, JSONTableUnit


class lnk(JSONTableUnit):
    """
    Parse Windows Shortcuts (LNK files) and returns the parsed information in JSON format. This
    unit is a thin wrapper around the LnkParse3 library.
    """

    @JSONTableUnit.Requires('LnkParse3>=1.4.0', ['formats', 'default', 'extended'])
    def _LnkParse3():
        import LnkParse3
        return LnkParse3

    _PATHS = {
        'data': ...,
        'header': {'creation_time', 'accessed_time', 'modified_time', 'windowstyle'},
        'link_info': {'local_base_path', 'location'},
    }

    def __init__(
        self,
        details: Param[bool, Arg('-d', help='Print all details; some properties are hidden by default.')] = False,
        tabular=False,
    ):
        super().__init__(tabular=tabular, details=details)

    def json(self, data):
        with NoLogging():
            parsed = self._LnkParse3.lnk_file(MemoryFile(data)).get_json()
        if not self.args.details:
            paths = self._PATHS
            noise = [key for key in parsed if key not in paths]
            for key in noise:
                del parsed[key]
            for path, scope in paths.items():
                if scope is (...):
                    continue
                try:
                    section = parsed[path]
                except KeyError:
                    continue
                noise = [key for key in section if key not in scope]
                for key in noise:
                    del section[key]
        return parsed

    @classmethod
    def handles(cls, data):
        return data[:20] == B'L\0\0\0\01\x14\02\0\0\0\0\0\xC0\0\0\0\0\0\0F'

Classes

class lnk (details=False, tabular=False)

Parse Windows Shortcuts (LNK files) and returns the parsed information in JSON format. This unit is a thin wrapper around the LnkParse3 library.

Expand source code Browse git 
class lnk(JSONTableUnit):
    """
    Parse Windows Shortcuts (LNK files) and returns the parsed information in JSON format. This
    unit is a thin wrapper around the LnkParse3 library.
    """

    @JSONTableUnit.Requires('LnkParse3>=1.4.0', ['formats', 'default', 'extended'])
    def _LnkParse3():
        import LnkParse3
        return LnkParse3

    _PATHS = {
        'data': ...,
        'header': {'creation_time', 'accessed_time', 'modified_time', 'windowstyle'},
        'link_info': {'local_base_path', 'location'},
    }

    def __init__(
        self,
        details: Param[bool, Arg('-d', help='Print all details; some properties are hidden by default.')] = False,
        tabular=False,
    ):
        super().__init__(tabular=tabular, details=details)

    def json(self, data):
        with NoLogging():
            parsed = self._LnkParse3.lnk_file(MemoryFile(data)).get_json()
        if not self.args.details:
            paths = self._PATHS
            noise = [key for key in parsed if key not in paths]
            for key in noise:
                del parsed[key]
            for path, scope in paths.items():
                if scope is (...):
                    continue
                try:
                    section = parsed[path]
                except KeyError:
                    continue
                noise = [key for key in section if key not in scope]
                for key in noise:
                    del section[key]
        return parsed

    @classmethod
    def handles(cls, data):
        return data[:20] == B'L\0\0\0\01\x14\02\0\0\0\0\0\xC0\0\0\0\0\0\0F'

Ancestors

Subclasses

Methods

def json(self, data)
Expand source code Browse git 
def json(self, data):
    with NoLogging():
        parsed = self._LnkParse3.lnk_file(MemoryFile(data)).get_json()
    if not self.args.details:
        paths = self._PATHS
        noise = [key for key in parsed if key not in paths]
        for key in noise:
            del parsed[key]
        for path, scope in paths.items():
            if scope is (...):
                continue
            try:
                section = parsed[path]
            except KeyError:
                continue
            noise = [key for key in section if key not in scope]
            for key in noise:
                del section[key]
    return parsed

Inherited members