Try harder to keep python 2 compat

Fleshed out the cli command, which only supports listing content at the moment
Add the signxml dependency for verifying xar signatures.

Author: mosen

bixar/archive.py

@@ -1,13 +1,13 @@
+from __future__ import print_function
+from typing import List, Union, Generator, Tuple
 import os
 import io
-from typing import List, Union, Generator, Tuple
 import datetime
 import zlib
 import gzip
 import hashlib
 from struct import *
 from collections import namedtuple
-from collections.abc import Container
 import xml.etree.ElementTree as ET
 
 from bixar.errors import XarError, XarChecksumError
@@ -16,7 +16,7 @@
 class XarInfo(object):
     """Just like TarInfo, a XarInfo represents one member in a XarFile. It does not contain the file data."""
 
-    def __init__(self, name = ''):
+    def __init__(self, name=''):
         self._name = name
 
     @classmethod
@@ -65,7 +65,7 @@ def gid(self) -> Union[int, None]:
             return int(self._element.find('gid').text)
         else:
             return None
-    
+
     @property
     def uname(self) -> Union[str, None]:
         user = self._element.find('user')
@@ -102,7 +102,6 @@ def data_archived_checksum(self) -> Tuple[str, str]:
 
         return alg, value
 
-
     def heap_location(self) -> Tuple[int, int]:
         """Get the heap location as length, offset"""
         data = self._element.find('data')
@@ -117,6 +116,7 @@ def isfile(self) -> bool:
     def isdir(self) -> bool:
         return self._element.find('type').text == 'directory'
 
+
 #
 # class XarSignature(object):
 #
@@ -134,10 +134,10 @@ class XarExtendedSignature(object):
     pass
 
 
-
 XarHeader = namedtuple('XarHeader', 'magic size version toc_len_compressed toc_len_uncompressed cksumalg')
 
-class XarFile(Container):
+
+class XarFile(object):
     """XAR Archive
     
     This class is written in the style of TarFile
@@ -230,11 +230,22 @@ def extractall(self, path: str = "."):
 
         self._extract_recursive(self._toc.find('toc'), path)
 
-    def extract(self, matching: str):
+    def extract(self, member, path="", set_attrs=True, *, numeric_owner=False):
+        pass
+
+    def extractfile(self, member):
         pass
 
+    def _getnames(self, element: ET.Element, prefix=''):
+        for f in element.findall('file'):
+            yield os.path.join(prefix, f.find('name').text)
+
+            if f.findtext('type') == 'directory':
+                for cf in self._getnames(f, prefix=prefix + f.findtext('name')):
+                    yield cf
+
     def getnames(self) -> List[str]:
-        return [m.name for m in self.getmembers()]
+        return [m for m in self._getnames(self._toc.find('toc'))]
 
     def _getmembers(self, element: ET.Element):
         for f in element.findall('file'):
@@ -248,13 +259,12 @@ def getmembers(self) -> List[XarInfo]:
         infos = []
 
         toc = self._toc.find('toc')
-        
+
         for m in self._getmembers(toc):
             infos.append(m)
 
         return infos
 
-
     @classmethod
     def is_xarfile(cls, name: str) -> bool:
         """Return True if *name* is a xar archive file, that the moxar module can read."""
@@ -263,16 +273,17 @@ def is_xarfile(cls, name: str) -> bool:
             return magic == b'xar!'
 
     @classmethod
-    def open(cls, name: str) -> any:
-        with open(name, 'rb') as fd:
-            header = fd.read(28)  # The spec says the header must be at least 28
+    def open(cls, name=None, mode='r', fileobj=None) -> any:
+        if fileobj is None:
+            fileobj = open(name, mode)
 
-            if header[:4] != b'xar!':
-                raise ValueError('Not a XAR Archive')
+        header = fileobj.read(28)  # The spec says the header must be at least 28
 
-            hdr = XarHeader._make(XarFile.Header.unpack(header))
-            toc_compressed = fd.read(hdr.toc_len_compressed)
+        if header[:4] != b'xar!':
+            raise ValueError('Not a XAR Archive')
 
+        hdr = XarHeader._make(XarFile.Header.unpack(header))
+        toc_compressed = fileobj.read(hdr.toc_len_compressed)
         toc_uncompressed = zlib.decompress(toc_compressed)
 
         if len(toc_uncompressed) != hdr.toc_len_uncompressed:

bixar/cli.py

@@ -1 +1,43 @@
+from __future__ import print_function
 import argparse
+from .archive import XarFile
+
+
+def main():
+    parser = argparse.ArgumentParser(description='bixar test XAR implementation')
+    parser.add_argument('-c', help='Creates an archive', action='store_true')
+    parser.add_argument('-x', help='Extracts an archive', action='store_true')
+    parser.add_argument('-t', help='Lists an archive', action='store_true')
+    parser.add_argument('-f',
+                        help='Specifies an archive to operate on [REQUIRED!]',
+                        required=True, metavar='filename', type=argparse.FileType('rb'))
+    parser.add_argument('-v', help='Print filenames as they are archived', action='store_true')
+
+    args = parser.parse_args()
+
+    if args.t:
+        return list_archive(args)
+    elif args.c:
+        print('command not implemented')
+        return 1
+    elif args.x:
+        print('command not implemented')
+        return 1
+
+    return 0
+
+
+def create():
+    pass
+
+
+def extract():
+    pass
+
+
+def list_archive(args):
+    archive = XarFile.open(fileobj=args.f)
+
+    for f in archive.getnames():
+        print(f)
+    

bixar/errors.py

@@ -1,7 +1,14 @@
 class XarError(Exception):
+    """Catch-all error"""
     pass
 
 
 class XarChecksumError(Exception):
     """Raised when you attempt to extract a file with an invalid checksum."""
     pass
+
+
+class XarSigningError(Exception):
+    """Raised when the xar signature is invalid."""
+    pass
+

requirements.txt

@@ -0,0 +1,20 @@
+asn1crypto==0.22.0
+certifi==2017.4.17
+cffi==1.10.0
+cryptography==1.8.2
+defusedxml==0.5.0
+eight==0.4.2
+future==0.16.0
+idna==2.5
+lxml==3.8.0
+mock==2.0.0
+packaging==16.8
+pbr==3.0.1
+py==1.4.34
+pycparser==2.17
+pyOpenSSL==17.0.0
+pyparsing==2.2.0
+pytest==3.1.1
+pytest-runner==2.11.1
+signxml==2.3.0
+six==1.10.0

setup.py

@@ -15,6 +15,7 @@
     ],
     keywords='XAR',
     install_requires=[
+        'signxml>=2.3.0'
     ],
     python_requires='>=3.5',
     tests_require=[

testdata/simple/.gitignore

@@ -0,0 +1 @@
+*.xar

testdata/simple/test_dir/test.txt

@@ -0,0 +1 @@
+Text File Content