ifstools 2.2__tar.gz → 3.0__tar.gz

{ifstools-2.2 → ifstools-3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ifstools
-Version: 2.2
+Version: 3.0
 Requires-Dist: kbinxml>=1.5
 Requires-Dist: lxml
 Requires-Dist: pillow
@@ -37,7 +37,8 @@ Have [uv](https://docs.astral.sh/uv/) installed? You can just `uvx ifstools`.
 ## Usage
 ```
 usage: ifstools [-h] [-e] [-y] [-o OUT_DIR] [--tex-only] [-c]
-                       [--bounds] [--uv] [--no-cache] [-m] [-s] [-r]
+                       [--bounds] [--uv] [--no-cache] [--flags FLAG[,FLAG...]]
+                       [-m] [-s] [-r]
                        file_to_unpack.ifs|folder_to_repack_ifs
                        [file_to_unpack.ifs|folder_to_repack_ifs ...]
 
@@ -65,6 +66,13 @@ optional arguments:
   --rename-dupes        if two files have the same name but differing case
                         (A.png vs a.png) rename the second as "a (1).png" to
                         allow both to be extracted on Windows
+  --flags FLAG[,FLAG...]
+                        flags to use when repacking. Almost never need to set
+                        this, but some old games don't support HasMD5.
+                        One or more of:
+                        ManifestHasTimestamps,HasMD5,UncompressedManifest
+                        Default:
+                        ManifestHasTimestamps,HasMD5
   -m, --extract-manifest
                         extract the IFS manifest for inspection
   --super-disable       only extract files unique to this IFS, do not follow

{ifstools-2.2 → ifstools-3.0}/README.md

@@ -23,7 +23,8 @@ Have [uv](https://docs.astral.sh/uv/) installed? You can just `uvx ifstools`.
 ## Usage
 ```
 usage: ifstools [-h] [-e] [-y] [-o OUT_DIR] [--tex-only] [-c]
-                       [--bounds] [--uv] [--no-cache] [-m] [-s] [-r]
+                       [--bounds] [--uv] [--no-cache] [--flags FLAG[,FLAG...]]
+                       [-m] [-s] [-r]
                        file_to_unpack.ifs|folder_to_repack_ifs
                        [file_to_unpack.ifs|folder_to_repack_ifs ...]
 
@@ -51,6 +52,13 @@ optional arguments:
   --rename-dupes        if two files have the same name but differing case
                         (A.png vs a.png) rename the second as "a (1).png" to
                         allow both to be extracted on Windows
+  --flags FLAG[,FLAG...]
+                        flags to use when repacking. Almost never need to set
+                        this, but some old games don't support HasMD5.
+                        One or more of:
+                        ManifestHasTimestamps,HasMD5,UncompressedManifest
+                        Default:
+                        ManifestHasTimestamps,HasMD5
   -m, --extract-manifest
                         extract the IFS manifest for inspection
   --super-disable       only extract files unique to this IFS, do not follow

{ifstools-2.2 → ifstools-3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "maturin"
 
 [project]
 name = "ifstools"
-version = "2.2"
+version = "3.0"
 description = "Extractor/repacker for Konmai IFS files"
 readme = "README.md"
 authors = [

{ifstools-2.2 → ifstools-3.0}/src/ifstools/handlers/generic_file.py

@@ -11,7 +11,9 @@ from .node import Node
 class GenericFile(Node):
     def from_xml(self, element):
         info = self._split_ints(element.text)
-        # sometimes we don't get a timestamp
+        # controlled by IFSFlags.ManifestHasTimestamps, but recent AVS never
+        # checks that flag and just tries node/s32 (which get treated as
+        # folders) then 2s32/3s32 for files
         if len(info) == 2:
             self.start, self.size = info
             self.time = -1
@@ -52,17 +54,28 @@ class GenericFile(Node):
         self.size = len(ret)
         return ret
 
-    def repack(self, manifest, data_blob, tqdm_progress, **kwargs):
+    def repack(self, manifest, data_blob, tqdm_progress, flags=None, **kwargs):
+        # muh circular deps
+        from ..ifs import IFSFlags
+
         if tqdm_progress:
             tqdm_progress.write(self.full_path)
             tqdm_progress.update(1)
         elem = etree.SubElement(manifest, self.packed_name)
-        elem.attrib['__type'] = '3s32'
+
         data = self.load(convert_kbin = False, **kwargs)
         if self.name.endswith('.xml') and not KBinXML.is_binary_xml(data):
             data = KBinXML(data).to_binary()
-        # offset, size, timestamp
-        elem.text = '{} {} {}'.format(len(data_blob.getvalue()), len(data), self.time)
+
+        if flags and flags & IFSFlags.ManifestHasTimestamps:
+            elem.attrib['__type'] = '3s32'
+            # offset, size, timestamp
+            elem.text = '{} {} {}'.format(len(data_blob.getvalue()), len(data), self.time)
+        else:
+            elem.attrib['__type'] = '2s32'
+            # offset, size
+            elem.text = '{} {}'.format(len(data_blob.getvalue()), len(data))
+
         data_blob.write(data)
         # 16 byte alignment
         align = len(data) % 16

{ifstools-2.2 → ifstools-3.0}/src/ifstools/handlers/generic_folder.py

@@ -30,6 +30,9 @@ class GenericFolder(Node):
     file_handler = GenericFile
 
     def from_xml(self, element):
+        # controlled by IFSFlags.ManifestHasTimestamps, but recent AVS never
+        # checks that flag and just tries node/s32 (which get treated as
+        # folders) then 2s32/3s32 for files
         if element.text:
             self.time = int(element.text)
 
@@ -130,14 +133,18 @@ class GenericFolder(Node):
         for f in self.files.values():
             f.tree_complete()
 
-    def repack(self, manifest, data_blob, tqdm_progress, **kwargs):
+    def repack(self, manifest, data_blob, tqdm_progress, flags=None, **kwargs):
+        # muh circular deps
+        from ..ifs import IFSFlags
+
         if self.name:
             manifest = etree.SubElement(manifest, self.packed_name)
-            manifest.attrib['__type'] = 's32'
-            manifest.text = str(self.time)
+            if flags and flags & IFSFlags.ManifestHasTimestamps:
+                manifest.attrib['__type'] = 's32'
+                manifest.text = str(self.time)
 
         for name, entry in chain(self.folders.items(), self.files.items()):
-            entry.repack(manifest, data_blob, tqdm_progress, **kwargs)
+            entry.repack(manifest, data_blob, tqdm_progress, flags=flags, **kwargs)
 
     @property
     def all_files(self):

{ifstools-2.2 → ifstools-3.0}/src/ifstools/handlers/image_decoders.py

@@ -43,6 +43,13 @@ def decode_argb4444(ifs_img, data):
     r, g, b, a = im.split()
     return Image.merge('RGBA', (b, g, r, a))
 
+def encode_argb4444(ifs_img, image):
+    # there's no BGRA;4B
+    r, g, b, a = image.split()
+    image = Image.merge('RGBA', (b, g, r, a))
+
+    return image.tobytes('raw', 'RGBA;4B')
+
 def decode_dxt(ifs_img, data, version):
     rgba = _native.decode_dxt(data, ifs_img.img_size[0], ifs_img.img_size[1], version)
     return Image.frombytes('RGBA', ifs_img.img_size, rgba)
@@ -59,7 +66,7 @@ def encode_dxt5(ifs_img, image):
 
 image_formats = {
     'argb8888rev' : {'decoder': decode_argb8888rev, 'encoder': encode_argb8888rev},
-    'argb4444'    : {'decoder': decode_argb4444, 'encoder': None},
+    'argb4444'    : {'decoder': decode_argb4444, 'encoder': encode_argb4444},
     'dxt1'        : {'decoder': decode_dxt1, 'encoder': None},
     'dxt5'        : {'decoder': decode_dxt5, 'encoder': encode_dxt5 if _native else None},
 }

{ifstools-2.2 → ifstools-3.0}/src/ifstools/handlers/image_file.py

@@ -83,7 +83,10 @@ class ImageFile(GenericFile):
         # Compress in parallel; the actual write loop in repack() runs serially.
         self._packed = self._build_packed()
 
-    def repack(self, manifest, data_blob, tqdm_progress, **kwargs):
+    def repack(self, manifest, data_blob, tqdm_progress, flags=None, **kwargs):
+        # muh circular deps
+        from ..ifs import IFSFlags
+
         if tqdm_progress:
             tqdm_progress.write(self.full_path)
             tqdm_progress.update(1)
@@ -92,10 +95,15 @@ class ImageFile(GenericFile):
         if data is None:
             data = self._build_packed()
 
-        # offset, size, timestamp
         elem = etree.SubElement(manifest, self.packed_name)
-        elem.attrib['__type'] = '3s32'
-        elem.text = '{} {} {}'.format(len(data_blob.getvalue()), len(data), self.time)
+        if flags and flags & IFSFlags.ManifestHasTimestamps:
+            # offset, size, timestamp
+            elem.attrib['__type'] = '3s32'
+            elem.text = '{} {} {}'.format(len(data_blob.getvalue()), len(data), self.time)
+        else:
+            # offset, size
+            elem.attrib['__type'] = '2s32'
+            elem.text = '{} {}'.format(len(data_blob.getvalue()), len(data))
         data_blob.write(data)
         # 16 byte alignment
         align = len(data) % 16

ifstools-3.0/src/ifstools/handlers/node.py

@@ -0,0 +1,126 @@
+import contextlib
+import os
+
+import lxml.etree as etree
+
+special_names = ('_info_', '_super_')
+
+escapes = {
+    ' ': '_A',
+    '$': '_B',
+    '+': '_C',
+    '-': '_D',
+    '.': '_E',
+    ':': '_F',
+    '@': '_G',
+    '~': '_H',
+    '_': '__',
+}
+
+sanitize_lookup = str.maketrans(escapes)
+
+fix_lookup = {escaped[1]: real for real, escaped in escapes.items()}
+
+class Node(object):
+
+    def __init__(self, ifs_data, obj, parent = None, path = '', name = ''):
+        self.ifs_data = ifs_data
+        self.parent = parent
+        self.path = path
+        self.name = name
+        # xml sanitisation performed by the property
+        self._packed_name = name
+        self.time = None
+        if isinstance(obj, etree._Element):
+            self.from_ifs = True
+            self.from_xml(obj)
+        else:
+            self.from_ifs = False
+            self.from_filesystem(obj)
+
+    def from_xml(self, elem):
+        raise NotImplementedError
+
+    def from_filesystem(self, path):
+        raise NotImplementedError
+
+    def tree_complete(self):
+        '''Call this when the entire tree is parsed and ready for modification'''
+        pass
+
+    def __str__(self):
+        return os.path.join(self.path, self.name)
+
+    def __repr__(self):
+        return '<{}: {}>'.format(self.__class__.__name__, self.full_path)
+
+    @property
+    def packed_name(self):
+        return self.sanitize_name(self._packed_name)
+
+    @property
+    def full_path(self):
+        return os.path.join(self.path, self.name)
+
+    @staticmethod
+    def sanitize_name(n):
+        if n in special_names:
+            return n
+
+        if not n:
+            raise ValueError("Sanitizing an empty name is invalid")
+
+        sanitized = n.translate(sanitize_lookup)
+
+        if sanitized[0].isdigit():
+            sanitized = '_' + sanitized
+
+        return sanitized
+
+    @staticmethod
+    def fix_name(n):
+        if n in special_names:
+            return n
+
+        start = 0
+        fixed = n
+        while (idx := fixed.find('_', start)) != -1:
+            try:
+                key = fixed[idx+1]
+                if idx == 0 and key.isdigit():
+                    new = key
+                else:
+                    new = fix_lookup[key]
+            except (IndexError, KeyError):
+                raise ValueError(f"Invalid escaped string {n!r}") from None
+
+            fixed = fixed[:idx] + new + fixed[idx+2:]
+
+            start = idx + 1
+
+        return fixed
+
+    @staticmethod
+    def _split_ints(text, delim = ' '):
+        return list(map(int, text.split(delim)))
+
+# who needs real tests anyway)
+assert Node.sanitize_name("_A9") == "__A9"
+assert Node.sanitize_name("9_A9") == "_9__A9"
+assert Node.sanitize_name("__") == "____"
+
+assert Node.fix_name("__A9") == "_A9"
+assert Node.fix_name("_9_A9") == "9 9"
+assert Node.fix_name("____9") == "__9"
+with contextlib.suppress(ValueError):
+    Node.fix_name("___Q")
+    assert False
+with contextlib.suppress(ValueError):
+    Node.fix_name("_")
+    assert False
+with contextlib.suppress(ValueError):
+    Node.fix_name("_9_A_9")
+    assert False
+with contextlib.suppress(ValueError):
+    Node.sanitize_name("")
+    assert False

{ifstools-2.2 → ifstools-3.0}/src/ifstools/ifs.py

@@ -2,6 +2,7 @@ import hashlib
 import threading
 from collections import defaultdict
 from concurrent.futures import ThreadPoolExecutor, as_completed
+from enum import IntFlag
 from io import BytesIO
 from os import utime, walk
 from os.path import basename, getmtime, isdir, isfile, join, splitext
@@ -19,7 +20,12 @@ from .handlers.tex_folder import ImageCanvas
 
 SIGNATURE = 0x6CAD8F89
 
-FILE_VERSION = 3
+class IFSFlags(IntFlag):
+    ManifestHasTimestamps = 1
+    HasMD5 = 2
+    UncompressedManifest = 4
+
+DEFAULT_FLAGS = IFSFlags.ManifestHasTimestamps | IFSFlags.HasMD5
 
 class FileBlob(object):
     ''' a basic wrapper around a file to deal with IFS data offset '''
@@ -59,20 +65,24 @@ class IFS:
         signature = header.get_u32()
         if signature != SIGNATURE:
             raise IOError('Given file was not an IFS file!')
-        self.file_version = header.get_u16()
+        self.flags = IFSFlags(header.get_u16())
         # next u16 is just NOT(version)
-        assert header.get_u16() ^ self.file_version == 0xFFFF
+        assert header.get_u16() ^ self.flags == 0xFFFF
         self.time = header.get_u32()
         ifs_tree_size = header.get_u32()
         manifest_end = header.get_u32()
         self.data_blob = FileBlob(self.file, manifest_end)
 
         self.manifest_md5 = None
-        if self.file_version > 1:
+        if self.flags & IFSFlags.HasMD5:
             self.manifest_md5 = header.get_bytes(16)
 
         self.file.seek(header.offset)
-        self.manifest = KBinXML(self.file.read(manifest_end-header.offset))
+        manifest_raw = self.file.read(manifest_end-header.offset)
+        # older IFS files have 0-padding in a plaintext XML manifest
+        if not KBinXML.is_binary_xml(manifest_raw):
+            manifest_raw = manifest_raw.rstrip(b'\0')
+        self.manifest = KBinXML(manifest_raw)
         self.tree = GenericFolder(self.data_blob, self.manifest.xml_doc,
             super_disable=super_disable, super_skip_bad=super_skip_bad,
             super_abort_if_bad=super_abort_if_bad
@@ -93,7 +103,7 @@ class IFS:
             self.ifs_out = self.folder_out + '.ifs'
         self.default_out = self.ifs_out
 
-        self.file_version = FILE_VERSION
+        self.flags = DEFAULT_FLAGS
         self.time = int(getmtime(path))
         self.data_blob = None
         self.manifest = None
@@ -207,46 +217,54 @@ class IFS:
                         extract_manifest=extract_manifest, path=rpath.replace('.ifs','_ifs'),
                         rename_dupes=rename_dupes, **kwargs)
 
-    def repack(self, progress = True, path = None, **kwargs):
+    def repack(self, progress = True, path = None, flags = None, **kwargs):
         if path is None:
             path = self.ifs_out
+        if flags is not None:
+            self.flags = flags
         # open first in case path is bad
         ifs_file = open(path, 'wb')
 
         self.data_blob = BytesIO()
 
         self.manifest = KBinXML(etree.Element('imgfs'))
-        manifest_info = etree.SubElement(self.manifest.xml_doc, '_info_')
+
+        # no md5 in the file also means no _info_ in the manifest for whatever reason
+        if self.flags & IFSFlags.HasMD5:
+            manifest_info = etree.SubElement(self.manifest.xml_doc, '_info_')
 
         # the important bit
         data = self._repack_tree(progress, **kwargs)
 
-        data_md5 = etree.SubElement(manifest_info, 'md5')
-        data_md5.attrib['__type'] = 'bin'
-        data_md5.attrib['__size'] = '16'
-        data_md5.text = hashlib.md5(data).hexdigest()
+        if self.flags & IFSFlags.HasMD5:
+            assert manifest_info is not None # type: ignore
+
+            data_md5 = etree.SubElement(manifest_info, 'md5')
+            data_md5.attrib['__type'] = 'bin'
+            data_md5.attrib['__size'] = '16'
+            data_md5.text = hashlib.md5(data).hexdigest()
 
-        data_size = etree.SubElement(manifest_info, 'size')
-        data_size.attrib['__type'] = 'u32'
-        data_size.text = str(len(data))
+            data_size = etree.SubElement(manifest_info, 'size')
+            data_size.attrib['__type'] = 'u32'
+            data_size.text = str(len(data))
 
-        manifest_bin = self.manifest.to_binary()
+        manifest_bin = self.manifest.to_binary(compressed=not (self.flags & IFSFlags.UncompressedManifest))
         manifest_hash = hashlib.md5(manifest_bin).digest()
 
         head = ByteBuffer()
         head.append_u32(SIGNATURE)
-        head.append_u16(self.file_version)
-        head.append_u16(self.file_version ^ 0xFFFF)
+        head.append_u16(int(self.flags))
+        head.append_u16(int(self.flags) ^ 0xFFFF)
         head.append_u32(int(unixtime()))
         head.append_u32(self.manifest.mem_size)
 
         manifest_end = len(manifest_bin) + head.offset + 4
-        if self.file_version > 1:
+        if self.flags & IFSFlags.HasMD5:
             manifest_end += 16
 
         head.append_u32(manifest_end)
 
-        if self.file_version > 1:
+        if self.flags & IFSFlags.HasMD5:
             head.append_bytes(manifest_hash)
 
         ifs_file.write(head.data)
@@ -280,6 +298,6 @@ class IFS:
         tqdm_progress = None
         if progress:
             tqdm_progress = tqdm(desc='Writing', total=len(files))
-        self.tree.repack(self.manifest.xml_doc, self.data_blob, tqdm_progress, **kwargs)
+        self.tree.repack(self.manifest.xml_doc, self.data_blob, tqdm_progress, flags=self.flags, **kwargs)
 
         return self.data_blob.getvalue()

{ifstools-2.2 → ifstools-3.0}/src/ifstools/ifstools.py

@@ -1,96 +1,111 @@
-import argparse
-import os
-from sys import exit # exe freeze
-
-from .ifs import IFS
-
-def get_choice(prompt):
-    while True:
-        q = input(prompt + ' [Y/n] ').lower()
-        if not q:
-            return True # default to yes
-        elif q == 'y':
-            return True
-        elif q == 'n':
-            return False
-        else:
-            print('Please answer y/n')
-
-def extract(i, args, path):
-    if args.progress:
-        print('Extracting...')
-    i.extract(path=path, **vars(args))
-
-def repack(i, args, path):
-    if args.progress:
-        print('Repacking...')
-    i.repack(path=path, **vars(args))
-
-def main():
-    parser = argparse.ArgumentParser(description='Unpack/pack IFS files and textures')
-    parser.add_argument('files', metavar='file_to_unpack.ifs|folder_to_repack_ifs', type=str, nargs='+',
-                       help='files/folders to process. Files will be unpacked, folders will be repacked')
-    parser.add_argument('-e', '--extract-folders', action='store_true', help='do not repack folders, instead unpack any IFS files inside them', dest='extract_folders')
-    parser.add_argument('-y', action='store_true', help='don\'t prompt for file/folder overwrite', dest='overwrite')
-    parser.add_argument('-o', default='.', help='output directory', dest='out_dir')
-    parser.add_argument('--tex-only', action='store_true', help='only extract textures')
-    parser.add_argument('-c', '--canvas', action='store_true', help='dump the image canvas as defined by the texturelist.xml in _canvas.png', dest='dump_canvas')
-    parser.add_argument('--bounds', action='store_true', help='draw image bounds on the exported canvas in red', dest='draw_bbox')
-    parser.add_argument('--uv', action='store_true', help='crop images to uvrect (usually 1px smaller than imgrect). Forces --tex-only', dest='crop_to_uvrect')
-    parser.add_argument('--no-cache', action='store_true', dest='no_cache_deprecated',
-                       help=argparse.SUPPRESS)
-    parser.add_argument('--rename-dupes', action='store_true',
-                       help='if two files have the same name but differing case (A.png vs a.png) rename the second as "a (1).png" to allow both to be extracted on Windows')
-    parser.add_argument('-m', '--extract-manifest', action='store_true', help='extract the IFS manifest for inspection', dest='extract_manifest')
-    parser.add_argument('--super-disable', action='store_true',
-                       help='only extract files unique to this IFS, do not follow "super" parent references at all')
-    parser.add_argument('--super-skip-bad', action='store_true',
-                       help='if a "super" IFS reference has a checksum mismatch, do not extract it')
-    parser.add_argument('--super-abort-if-bad', action='store_true',
-                       help='if a "super" IFS reference has a checksum mismatch, cancel and display an error')
-    parser.add_argument('-s', '--silent', action='store_false', dest='progress',
-                       help='don\'t display files as they are processed')
-    parser.add_argument('-r', '--norecurse', action='store_false', dest='recurse',
-                       help='if file contains another IFS, don\'t extract its contents')
-
-    args = parser.parse_args()
-
-    if args.no_cache_deprecated:
-        print("WARNING: --no-cache is deprecated and has no effect; the texture cache has been removed.")
-    delattr(args, 'no_cache_deprecated')
-
-    if args.crop_to_uvrect:
-        args.tex_only = True
-
-    if args.extract_folders:
-        dirs = [f for f in args.files if os.path.isdir(f)]
-        # prune
-        args.files = [f for f in args.files if not os.path.isdir(f)]
-        # add the extras
-        for d in dirs:
-            args.files.extend((os.path.join(d,f) for f in os.listdir(d) if f.lower().endswith('.ifs')))
-
-    for f in args.files:
-        if args.progress:
-            print(f)
-        try:
-            i = IFS(f, super_disable=args.super_disable, super_skip_bad=args.super_skip_bad,
-                super_abort_if_bad=args.super_abort_if_bad)
-        except IOError as e:
-            # human friendly
-            print('{}: {}'.format(os.path.basename(f), str(e)))
-            exit(1)
-
-        path = os.path.join(args.out_dir, i.default_out)
-        if os.path.exists(path) and not args.overwrite:
-            if not get_choice('{} exists. Overwrite?'.format(path)):
-                continue
-
-        if i.is_file:
-            extract(i, args, path)
-        else:
-            repack(i, args, path)
-
-
-if __name__ == '__main__':
-    main()
+import argparse
+import os
+from sys import exit  # exe freeze
+from typing import cast
+
+from .ifs import DEFAULT_FLAGS, IFS, IFSFlags
+
+
+def parse_flags(value):
+    flags = IFSFlags(0)
+    for name in value.split(','):
+        try:
+            flags |= IFSFlags[name.strip()]
+        except KeyError:
+            raise argparse.ArgumentTypeError('invalid flag {!r} (choose from {})'.format(
+                name.strip(), ', '.join(IFSFlags.__members__)))
+    return flags
+
+def get_choice(prompt):
+    while True:
+        q = input(prompt + ' [Y/n] ').lower()
+        if not q:
+            return True # default to yes
+        elif q == 'y':
+            return True
+        elif q == 'n':
+            return False
+        else:
+            print('Please answer y/n')
+
+def extract(i, args, path):
+    if args.progress:
+        print('Extracting...')
+    i.extract(path=path, **vars(args))
+
+def repack(i, args, path):
+    if args.progress:
+        print('Repacking...')
+    i.repack(path=path, **vars(args))
+
+def main():
+    parser = argparse.ArgumentParser(description='Unpack/pack IFS files and textures')
+    parser.add_argument('files', metavar='file_to_unpack.ifs|folder_to_repack_ifs', type=str, nargs='+',
+                       help='files/folders to process. Files will be unpacked, folders will be repacked')
+    parser.add_argument('-e', '--extract-folders', action='store_true', help='do not repack folders, instead unpack any IFS files inside them', dest='extract_folders')
+    parser.add_argument('-y', action='store_true', help='don\'t prompt for file/folder overwrite', dest='overwrite')
+    parser.add_argument('-o', default='.', help='output directory', dest='out_dir')
+    parser.add_argument('--tex-only', action='store_true', help='only extract textures')
+    parser.add_argument('-c', '--canvas', action='store_true', help='dump the image canvas as defined by the texturelist.xml in _canvas.png', dest='dump_canvas')
+    parser.add_argument('--bounds', action='store_true', help='draw image bounds on the exported canvas in red', dest='draw_bbox')
+    parser.add_argument('--uv', action='store_true', help='crop images to uvrect (usually 1px smaller than imgrect). Forces --tex-only', dest='crop_to_uvrect')
+    parser.add_argument('--no-cache', action='store_true', dest='no_cache_deprecated',
+                       help=argparse.SUPPRESS)
+    parser.add_argument('--rename-dupes', action='store_true',
+                       help='if two files have the same name but differing case (A.png vs a.png) rename the second as "a (1).png" to allow both to be extracted on Windows')
+    parser.add_argument('--flags', type=parse_flags, metavar='FLAG[,FLAG...]',
+                       help='flags to use when repacking. Almost never need to set this, but some old games don\'t support HasMD5. One or more of: {} Default: {}'.format(
+                           ','.join(IFSFlags.__members__), ','.join(cast(str, f.name) for f in DEFAULT_FLAGS)))
+    parser.add_argument('-m', '--extract-manifest', action='store_true', help='extract the IFS manifest for inspection', dest='extract_manifest')
+    parser.add_argument('--super-disable', action='store_true',
+                       help='only extract files unique to this IFS, do not follow "super" parent references at all')
+    parser.add_argument('--super-skip-bad', action='store_true',
+                       help='if a "super" IFS reference has a checksum mismatch, do not extract it')
+    parser.add_argument('--super-abort-if-bad', action='store_true',
+                       help='if a "super" IFS reference has a checksum mismatch, cancel and display an error')
+    parser.add_argument('-s', '--silent', action='store_false', dest='progress',
+                       help='don\'t display files as they are processed')
+    parser.add_argument('-r', '--norecurse', action='store_false', dest='recurse',
+                       help='if file contains another IFS, don\'t extract its contents')
+
+    args = parser.parse_args()
+
+    if args.no_cache_deprecated:
+        print("WARNING: --no-cache is deprecated and has no effect; the texture cache has been removed.")
+    delattr(args, 'no_cache_deprecated')
+
+    if args.crop_to_uvrect:
+        args.tex_only = True
+
+    if args.extract_folders:
+        dirs = [f for f in args.files if os.path.isdir(f)]
+        # prune
+        args.files = [f for f in args.files if not os.path.isdir(f)]
+        # add the extras
+        for d in dirs:
+            args.files.extend((os.path.join(d,f) for f in os.listdir(d) if f.lower().endswith('.ifs')))
+
+    for f in args.files:
+        if args.progress:
+            print(f)
+        try:
+            i = IFS(f, super_disable=args.super_disable, super_skip_bad=args.super_skip_bad,
+                super_abort_if_bad=args.super_abort_if_bad)
+        except IOError as e:
+            # human friendly
+            print('{}: {}'.format(os.path.basename(f), str(e)))
+            exit(1)
+
+        path = os.path.join(args.out_dir, i.default_out)
+        if os.path.exists(path) and not args.overwrite:
+            if not get_choice('{} exists. Overwrite?'.format(path)):
+                continue
+
+        if i.is_file:
+            extract(i, args, path)
+        else:
+            repack(i, args, path)
+
+
+if __name__ == '__main__':
+    main()

ifstools-3.0/src/ifstools/utils.py

@@ -0,0 +1,13 @@
+import os
+
+
+def mkdir_silent(dir):
+    os.makedirs(dir, exist_ok=True)
+
+def save_with_timestamp(filename, data, timestamp):
+    mkdir_silent(os.path.dirname(filename))
+    with open(filename, 'wb') as f:
+        f.write(data)
+    # we store invalid timestamps as -1
+    if timestamp >= 0:
+        os.utime(filename, (timestamp,timestamp))

ifstools-2.2/src/ifstools/handlers/node.py

@@ -1,70 +0,0 @@
-import os
-
-import lxml.etree as etree
-
-escapes = [
-    ('_E', '.'),
-    ('__', '_'),
-]
-
-class Node(object):
-
-    def __init__(self, ifs_data, obj, parent = None, path = '', name = ''):
-        self.ifs_data = ifs_data
-        self.parent = parent
-        self.path = path
-        self.name = name
-        # xml sanitisation performed by the property
-        self._packed_name = name
-        self.time = None
-        if isinstance(obj, etree._Element):
-            self.from_ifs = True
-            self.from_xml(obj)
-        else:
-            self.from_ifs = False
-            self.from_filesystem(obj)
-
-    def from_xml(self, elem):
-        raise NotImplementedError
-
-    def from_filesystem(self, path):
-        raise NotImplementedError
-
-    def tree_complete(self):
-        '''Call this when the entire tree is parsed and ready for modification'''
-        pass
-
-    def __str__(self):
-        return os.path.join(self.path, self.name)
-
-    def __repr__(self):
-        return '<{}: {}>'.format(self.__class__.__name__, self.full_path)
-
-    @property
-    def packed_name(self):
-        return self.sanitize_name(self._packed_name)
-
-    @property
-    def full_path(self):
-        return os.path.join(self.path, self.name)
-
-    @staticmethod
-    def sanitize_name(n):
-        for e in escapes[::-1]:
-            n = n.replace(e[1], e[0])
-        if n[0].isdigit():
-            n = '_' + n
-        return n
-
-    @staticmethod
-    def fix_name(n):
-        for e in escapes:
-            n = n.replace(*e)
-        if n[0] == '_' and n[1].isdigit():
-            n = n[1:]
-        return n
-
-    @staticmethod
-    def _split_ints(text, delim = ' '):
-        return list(map(int, text.split(delim)))
-

ifstools-2.2/src/ifstools/utils.py

@@ -1,26 +0,0 @@
-import errno
-import os
-
-def mkdir_silent(dir):
-    try: # python 3
-        FileExistsError
-        try:
-            os.mkdir(dir)
-        except FileExistsError:
-            pass
-    except NameError: # python 2
-        try:
-            os.mkdir(dir)
-        except OSError as e:
-            if e.errno == errno.EEXIST:
-                pass
-            else:
-                raise
-
-def save_with_timestamp(filename, data, timestamp):
-    mkdir_silent(os.path.dirname(filename))
-    with open(filename, 'wb') as f:
-        f.write(data)
-    # we store invalid timestamps as -1
-    if timestamp >= 0:
-        os.utime(filename, (timestamp,timestamp))