From 6bb27a028f612fa1936be652a4e7220c19ced8a3 Mon Sep 17 00:00:00 2001 From: "T. Joseph Carter" Date: Sat, 8 Jul 2017 05:52:34 -0700 Subject: [PATCH] Broke diskimg.py out of legacy I may not have done this 100% "properly"--this is really the first full application thingy I've ever tried to write in Python. I learned circular imports are possible and the error messages are not obvious when you do that. I've also learned that importing a package doesn't necessarily import the modules within that package--if you want that, the package needs to import its submodules into itself. That was not obvious either. It does explain why sometimes you must import subpackages directly and other times importing the package is all you need. This is probably obvious to Python developers who actually work on big projects, but ... I've only ever done single-file scripts before now so it wasn't obvious to me. For now, blocksfree is importing legacy. We don't have enough outside of legacy yet to make the alternative even remotely useful at this time. Eventually though the goal is to stop doing that. --- blocksfree/__init__.py | 2 + blocksfree/diskimg.py | 97 ++++++++++++++++++++++++++++++++++++++++++ blocksfree/legacy.py | 97 ++---------------------------------------- 3 files changed, 102 insertions(+), 94 deletions(-) create mode 100644 blocksfree/diskimg.py diff --git a/blocksfree/__init__.py b/blocksfree/__init__.py index 4ab94f7..6b16109 100644 --- a/blocksfree/__init__.py +++ b/blocksfree/__init__.py @@ -15,3 +15,5 @@ # You should have received a copy of the GNU General Public License along # with this program; if not, write to the Free Software Foundation, Inc., # 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +from . import legacy, diskimg +from .logging import log diff --git a/blocksfree/diskimg.py b/blocksfree/diskimg.py new file mode 100644 index 0000000..81270bf --- /dev/null +++ b/blocksfree/diskimg.py @@ -0,0 +1,97 @@ +import os +import struct +from collections import namedtuple + +# FIXME Move to_sys_name +from . import legacy + +### NEW DISK CLASSES + +TWOIMG_V1_UNPACK = ( + '<' # use little-endian numbers + '4s' # magic string '2IMG' + '4s' # creator string + 'H' # header length + 'H' # 2mg version + 'L' # image format + 'L' # flags (we unpack it into "vol") + 'L' # number of 512 blocks + 'L' # image data offset + 'L' # image data length + 'L' # comment offset + 'L' # comment length + 'L' # creator private use offset + 'L' # creator private use length + '16x' # reserved for future use + ) +TWOIMG_V1_ATTRS = ( + 'magic', 'creator', 'hdr_len', 'version', + 'img_fmt', 'flags', 'num_blocks', + 'data_offset', 'data_len', + 'comment_offset', 'comment_len', + 'creator_offset', 'creator_len' + ) + +TwoImgV1 = namedtuple('TwoImgV1', TWOIMG_V1_ATTRS) + +class Disk: + def __init__(self, name=None): + if name is not None: + self.pathname = name + self.path, self.filename = os.path.split(name) + self.diskname, self.ext = os.path.splitext(self.filename) + self.ext = os.path.splitext(name)[1].lower() + # FIXME: Handle compressed images? + with open(legacy.to_sys_name(name), "rb") as f: + self.image = f.read() + + if self.ext in ('.2mg', '.2img'): + self._parse_2mg() + + def _parse_2mg(self): + self.twoimg = None + self.twoimg_comment = None + self.twoimg_creator = None + self.twoimg_locked = None + hdr = TwoImgV1(*struct.unpack_from(TWOIMG_V1_UNPACK, self.image)) + if hdr.magic == b'2IMG': + self._raw_twoimg = self.image[:hdr.hdr_len] + if hdr.version == 1: + if hdr.hdr_len == 64: + # Extract comment (if it exists and is valid) + if hdr.comment_offset and hdr.comment_len: + self.twoimg_comment = self.image[ + hdr.comment_offset + : hdr.comment_offset + hdr.comment_len] + if len(self.twoimg_comment) != hdr.comment_len: + log.warn('invalid 2mg comment: {} bytes ' + '(expected {} bytes)'.format( + len(self.twoimg_comment), + hdr.comment_len)) + self.twoimg_comment = None + + # Extract creator area (if it exists and is valid) + if hdr.creator_offset and hdr.creator_len: + self.twoimg_creator = self.image[ + hdr.creator_offset + : hdr.creator_offset + hdr.creator_len] + if len(self.twoimg_creator) != hdr.creator_len: + log.warn('invalid 2mg creator: {} bytes ' + '(expected {} bytes)'.format( + len(self.twoimg_creator), + hdr.creator_len)) + self.twoimg_creator = None + + self.twoimg_locked = bool(hdr.flags & 0x80000000) + + self.twoimg = hdr + else: + log.warn('2mg header length: {} (expected 64 ' + 'for version 1)'.format(hdr.hdr_len)) + else: + log.warn('2mg version unsupported: {} (only support ' + 'version 1)'.format(hdr.version)) + else: + log.warn('2mg header not found: magic is {}'.format(hdr.magic)) + self._raw_twoimg = None + diff --git a/blocksfree/legacy.py b/blocksfree/legacy.py index 30a37a4..f5382ff 100755 --- a/blocksfree/legacy.py +++ b/blocksfree/legacy.py @@ -58,10 +58,10 @@ import subprocess #import tempfile # not used, but should be for temp directory? import struct from typing import Sequence -from collections import namedtuple from binascii import a2b_hex, b2a_hex -from blocksfree.logging import log +from . import diskimg +from .logging import log class Globals: pass @@ -895,97 +895,6 @@ def isnumber(number): #---- end IvanX general purpose functions ----# -### NEW DISK CLASSES - -TWOIMG_V1_UNPACK = ( - '<' # use little-endian numbers - '4s' # magic string '2IMG' - '4s' # creator string - 'H' # header length - 'H' # 2mg version - 'L' # image format - 'L' # flags (we unpack it into "vol") - 'L' # number of 512 blocks - 'L' # image data offset - 'L' # image data length - 'L' # comment offset - 'L' # comment length - 'L' # creator private use offset - 'L' # creator private use length - '16x' # reserved for future use - ) -TWOIMG_V1_ATTRS = ( - 'magic', 'creator', 'hdr_len', 'version', - 'img_fmt', 'flags', 'num_blocks', - 'data_offset', 'data_len', - 'comment_offset', 'comment_len', - 'creator_offset', 'creator_len' - ) - -TwoImgV1 = namedtuple('TwoImgV1', TWOIMG_V1_ATTRS) - -class Disk: - def __init__(self, name=None): - if name is not None: - self.pathname = name - self.path, self.filename = os.path.split(name) - self.diskname, self.ext = os.path.splitext(self.filename) - self.ext = os.path.splitext(name)[1].lower() - # FIXME: Handle compressed images? - with open(to_sys_name(name), "rb") as f: - self.image = f.read() - - if self.ext in ('.2mg', '.2img'): - self._parse_2mg() - - def _parse_2mg(self): - self.twoimg = None - self.twoimg_comment = None - self.twoimg_creator = None - self.twoimg_locked = None - hdr = TwoImgV1(*struct.unpack_from(TWOIMG_V1_UNPACK, self.image)) - if hdr.magic == b'2IMG': - self._raw_twoimg = self.image[:hdr.hdr_len] - if hdr.version == 1: - if hdr.hdr_len == 64: - # Extract comment (if it exists and is valid) - if hdr.comment_offset and hdr.comment_len: - self.twoimg_comment = self.image[ - hdr.comment_offset - : hdr.comment_offset + hdr.comment_len] - if len(self.twoimg_comment) != hdr.comment_len: - log.warn('invalid 2mg comment: {} bytes ' - '(expected {} bytes)'.format( - len(self.twoimg_comment), - hdr.comment_len)) - self.twoimg_comment = None - - # Extract creator area (if it exists and is valid) - if hdr.creator_offset and hdr.creator_len: - self.twoimg_creator = self.image[ - hdr.creator_offset - : hdr.creator_offset + hdr.creator_len] - if len(self.twoimg_creator) != hdr.creator_len: - log.warn('invalid 2mg creator: {} bytes ' - '(expected {} bytes)'.format( - len(self.twoimg_creator), - hdr.creator_len)) - self.twoimg_creator = None - - self.twoimg_locked = bool(hdr.flags & 0x80000000) - - self.twoimg = hdr - else: - log.warn('2mg header length: {} (expected 64 ' - 'for version 1)'.format(hdr.hdr_len)) - else: - log.warn('2mg version unsupported: {} (only support ' - 'version 1)'.format(hdr.version)) - else: - log.warn('2mg header not found: magic is {}'.format(hdr.magic)) - self._raw_twoimg = None - - ### UTIL def seqsplit(seq: Sequence, num: int) -> Sequence: @@ -1030,7 +939,7 @@ def hexdump( def run_cppo(): try: - disk = Disk(g.image_file) + disk = diskimg.Disk(g.image_file) except IOError as e: log.critical(e) quit_now(2)