Module refinery.units.formats.archive.xtace

Expand source code Browse git 
from __future__ import annotations

from refinery.lib.structures import MemoryFile
from refinery.lib.thirdparty import acefile
from refinery.units.formats.archive import ArchiveUnit


class xtace(ArchiveUnit, docs='{0}{p}{PathExtractorUnit}'):
    """
    Extract files from an ACE archive.
    """
    def unpack(self, data):
        ace = acefile.open(MemoryFile(data, output=bytes))
        for member in ace.getmembers():
            member: acefile.AceMember
            comment = {} if not member.comment else {'comment': member.comment}
            yield self._pack(
                member.filename,
                member.datetime,
                lambda a=ace, m=member: a.read(m, pwd=self.args.pwd),
                **comment
            )

    @classmethod
    def handles(cls, data) -> bool:
        return data[7:14] == b'**ACE**'

Classes

class xtace (*paths, list=False, join_path=False, drop_path=False, fuzzy=0, exact=False, regex=False, path=b'path', exclude=None, date=b'date', pwd=b'')

Extract files from an ACE archive.

This unit extracts items with an associated virtual path from a container; each extracted item is emitted as a separate chunk with a corresponding meta variable named "path".

Positional arguments to xtace are patterns to filter the extracted items. Use the -x flag to add an exclusion pattern. To extract all files with a foo or bar extension, but none that has the word "temp" in its path:

xtace .foo .bar -x temp

To view only the paths of all chunks, use the listing switch:

emit data | ... | xtace -l

Otherwise, extracted items are written to the standard output port and usually require a frame to properly process. In order to dump all extracted data to disk, the following pipeline can be used:

emit data | ... | xtace [| dump extracted/{path} ]

The value {path} is a placeholder which is substituted by the virtual path of the extracted item. When using xtace to unpack a file on disk, the following pattern can be useful:

ef pack.bin [| xtace -j | d2p ]

The unit ef is also a path extractor. By specifying -j (or --join), the paths of extracted items are combined. Here, d2p is a shortcut for dump {path}. It deconflicts the joined paths with the local file system: If pack.bin contains items one.txt and two.txt, the following local file tree would be the result:

pack.bin
pack/one.txt
pack/two.txt

Finally, the -d (or --drop) switch can be used to not create (or alter) the path metadata at all, which is useful in cases where path metadata from a previous unit should be preserved.

Expand source code Browse git 
class xtace(ArchiveUnit, docs='{0}{p}{PathExtractorUnit}'):
    """
    Extract files from an ACE archive.
    """
    def unpack(self, data):
        ace = acefile.open(MemoryFile(data, output=bytes))
        for member in ace.getmembers():
            member: acefile.AceMember
            comment = {} if not member.comment else {'comment': member.comment}
            yield self._pack(
                member.filename,
                member.datetime,
                lambda a=ace, m=member: a.read(m, pwd=self.args.pwd),
                **comment
            )

    @classmethod
    def handles(cls, data) -> bool:
        return data[7:14] == b'**ACE**'

Ancestors

Subclasses

Class variables

var reverse

The type of the None singleton.

Methods

def unpack(self, data)
Expand source code Browse git 
def unpack(self, data):
    ace = acefile.open(MemoryFile(data, output=bytes))
    for member in ace.getmembers():
        member: acefile.AceMember
        comment = {} if not member.comment else {'comment': member.comment}
        yield self._pack(
            member.filename,
            member.datetime,
            lambda a=ace, m=member: a.read(m, pwd=self.args.pwd),
            **comment
        )

Inherited members