tosecdat.py

#!/usr/bin/python

from color import cDim
from pathlib import Path
from scanfile import ScanFile
import logging
import xml.etree.ElementTree

class InvalidTosecFileException(Exception):
    """
    Exception if file processed isn't a valid TOSEC file"""

class TosecHeader:
    """
    TOSEC DAT file Header.
    On init the given XML tree is scaned for header and header/name.
    If XML elements aren't found an exception is raised """

    def __init__(self, root: xml.etree.ElementTree.Element):
        header = root.find("header")
        if header is None:
            raise InvalidTosecFileException("no datafile/header found")
        name = header.find("name")
        if name is None:
            raise InvalidTosecFileException("no datafile/header/name found")
        self.games = []
        self.roms = {}
        self.name = name.text
        splitName = self.name.split(" - ", 1)
        self.system = splitName[0]
        self.category = splitName[1] if len(splitName) > 1 else None

class TosecGameRom:
    """
    TOSEC DAT ROM entry.
    On init the XML element is parsed. """

    def __init__(self, romEntry: xml.etree.ElementTree.Element, game): # game: TosecGameEntry
        self.game = game
        self.name = romEntry.get("name")
        if self.name is None:
            raise InvalidTosecFileException("no {} found for ROM {}".format(cDim("datafile/game/rom{name}"), cDim(self.name)))
        self.size = romEntry.get("size")
        if self.size is None:
            raise InvalidTosecFileException("no {} found for ROM {}".format(cDim("datafile/game/rom{size}"), cDim(self.name)))
        self.md5 = romEntry.get("md5")
        if self.md5 is None:
            raise InvalidTosecFileException("no {} found for ROM {}".format(cDim("datafile/game/rom{md5}"), cDim(self.name)))
        self.crc = romEntry.get("crc")
        if self.crc is None:
            raise InvalidTosecFileException("no {} found for ROM {}".format(cDim("datafile/game/rom{crc}"), cDim(self.name)))
        self.sha1 = romEntry.get("sha1")
        if self.sha1 is None:
            raise InvalidTosecFileException("no {} found for ROM {}".format(cDim("datafile/game/rom{sha1}"), cDim(self.name)))

    def isMatching(self, scanFile: ScanFile) -> bool:
        """
        Compare the given scanFile to the internal ROM entry.
        @param scanFile
            file to compare to the TOSEC DAT ROM entry
        @return
            true if all criteria match, false otherwise"""

        return scanFile is not None and self.md5 == scanFile.md5 and self.crc == scanFile.crc and self.size == str(scanFile.size)

    def getFileName(self, basePath: Path) -> Path:
        """
        Get the file path for the ROM entry based on the given base path
        the file path has the following structure <base>/<system>[/<category>][/<game>]/<rom>.
        If TOSEC header has no category the hirachie level is skipped.
        If TOSEC game has only one ROM entry the game directory is skipped.
        The folder structure isn't created.
        @param basePath
            base path for the created path structure
        @return
            filename path to the rom entry file"""

        return self.game.getPathName(basePath) / self.name

class TosecGameEntry:
    """
    TOSEC DAT Game entry.
    On init the XML element is parsed. One Game entry must have at least one ROM
    but can have unlimited ROM files.
    If XML structure doesn't fit a game entry an exception is raised"""


    def __init__(self, gameEntry: xml.etree.ElementTree.Element, header: TosecHeader):
        self.header = header
        self.name = gameEntry.get("name")
        if self.name is None:
            raise InvalidTosecFileException("no {} found".format(cDim("datafile/game{name}")))
        roms = gameEntry.findall("rom")
        if len(roms) < 1:
            raise InvalidTosecFileException("no {} found for game {}".format(cDim("datafile/game/rom"), cDim(self.name)))
        self.roms = []
        for rom in roms:
            self.roms.append(TosecGameRom(rom, self))
        logging.debug("parsed game entry %s", cDim(self.name))

    def getPathName(self, basePath: Path) -> Path:
        """
        Get the path for the game entry based on the given base path
        the path has the following structure <base>/<system>[/<category>][/<game>]/.
        If TOSEC header has no category the hirachie level is skipped.
        If TOSEC game has only one ROM entry the game directory is skipped.
        The folder structure isn't created.
        @param basePath
            base path for the created path structure
        @return
            path to the game entry directory"""

        path = basePath / self.header.system
        if self.header.category is not None:
            path /= self.header.category
        if len(self.roms) > 1:
            return path / self.name
        return path