confconverter.py

import os
from commandhandler import CommandHandler
import util
import dosboxconfv6
import chardet
import lists
import shutil


# Converts dosbox.conf to dosbox.cfg and dosbox.bat, at the moment Batocera/ Recalbox linux flavor
class ConfConverter:

    def __init__(self, gGator):
        self.logger = gGator.logger
        self.conversionConf = gGator.conversionConf
        self.commandHandler = CommandHandler(gGator)
        self.scriptDir = gGator.scriptDir
        # self.outputDir = gGator.outputDir
        # self.useGenreSubFolders = gGator.useGenreSubFolders
        # self.conversionType = gGator.conversionType
        # self.conversionConf = gGator.conversionConf
        # self.collectionVersion = gGator.collectionVersion
        # self.commandHandler = CommandHandler(gGator)

    # Handle Parameter in ExpertMod
    def __getExpertParam__(self, parameter, defaultValue):
        if self.conversionConf['useExpertMode']:
            return self.conversionConf[parameter]
        else:
            return defaultValue

    # Converts exo collection v6 dosbox.conf to dosbox.cfg and dosbox.bat
    def processV6(self, gGator, defaultDosboxConf, optionsDosboxConfPath):
        exoDosboxConfPath = os.path.join(gGator.getLocalGameDataOutputDir(), "dosbox.conf")  # original game conf
        # stack on top of default conf
        fullDosboxConf = dosboxconfv6.loadDosboxConf(exoDosboxConfPath, defaultDosboxConf)
        if gGator.conversionType == util.retrobat:  # keep options.conf on windows
            fullDosboxConf = dosboxconfv6.loadDosboxConf(optionsDosboxConfPath, fullDosboxConf)
        self.setUserParameters(fullDosboxConf, gGator)
        dosboxCfgPath = os.path.join(gGator.getLocalGameOutputDir(), "dosbox.cfg")
        dosboxconfv6.writeDosboxConf(dosboxCfgPath, fullDosboxConf)
        retroDosboxCfg = open(dosboxCfgPath, 'a')  # retroarch dosbox.cfg
        retroDosboxBat = open(os.path.join(gGator.getLocalGameOutputDir(), "dosbox.bat"), 'w')  # retroarch dosbox.bat

        exoDosboxConf = open(exoDosboxConfPath, 'r')
        count = 0
        lines = exoDosboxConf.readlines()
        for cmdline in lines:
            if cmdline.startswith("[autoexec]"):
                retroDosboxCfg.write(cmdline)
                self.__createDosboxBat__(lines[count + 1:], retroDosboxBat, retroDosboxCfg, gGator)
                break

            count = count + 1

        exoDosboxConf.close()
        os.remove(os.path.join(gGator.getLocalGameDataOutputDir(), "dosbox.conf"))
        retroDosboxCfg.close()
        retroDosboxBat.close()

    def setUserParameters(self, dosboxConf, gGator):
        dosboxConf['[sdl]']['fullscreen'] = 'true'
        if gGator.conversionType != util.retrobat:
            dosboxConf['[sdl]']['fullresolution'] = self.__getExpertParam__("fullresolutionCfg", "desktop")
            dosboxConf['[sdl]']['output'] = self.__getExpertParam__("outputCfg", "texture")
        dosboxConf['[sdl]']['renderer'] = self.__getExpertParam__("rendererCfg", "auto")
        dosboxConf['[sdl]']['vsync'] = 'true' if gGator.conversionConf['vsyncCfg'] else 'false'
        if 'mapper' in self.conversionConf and self.conversionConf['mapper'] == 'mapper.map':
            dosboxConf['[sdl]']['mapperfile'] = 'mapper.map'
        dosboxConf['[render]']['aspect'] = 'true'
        dosboxConf['[joystick]']['buttonwrap'] = 'false'
        dosboxConf['[gus]']['ultradir'] = 'C:\\ULTRASND'

    # Converts exo collection dosbox.conf to dosbox.cfg and dosbox.bat
    def processV5(self, gGator):
        self.logger.log("  create dosbox.bat")
        exoDosboxConf = open(os.path.join(gGator.getLocalGameDataOutputDir(), "dosbox.conf"), 'r')  # original
        retroDosboxCfg = open(os.path.join(gGator.getLocalGameOutputDir(), "dosbox.cfg"), 'w')  # retroarch dosbox.cfg
        retroDosboxBat = open(os.path.join(gGator.getLocalGameOutputDir(), "dosbox.bat"), 'w')  # retroarch dosbox.bat

        count = 0
        lines = exoDosboxConf.readlines()
        for cmdline in lines:
            if cmdline.startswith("fullscreen"):
                retroDosboxCfg.write("fullscreen=true\n")
            elif cmdline.startswith("fullresolution"):
                if gGator.conversionType == util.retrobat:
                    retroDosboxCfg.write(cmdline)
                else:
                    retroDosboxCfg.write("fullresolution=" + self.__getExpertParam__("fullresolutionCfg", "desktop") + "\n")
            elif cmdline.startswith("output"):
                if gGator.conversionType == util.retrobat:
                    retroDosboxCfg.write(cmdline)
                else:
                    retroDosboxCfg.write("output=" + self.__getExpertParam__("outputCfg", "texture") + "\n")
                retroDosboxCfg.write("renderer=" + self.__getExpertParam__("rendererCfg", "auto") + "\n")
                if gGator.conversionConf['vsyncCfg']:
                    retroDosboxCfg.write("vsync=true\n")
                else:
                    retroDosboxCfg.write("vsync=false\n")

            # Always write these
            elif cmdline.startswith("aspect"):
                retroDosboxCfg.write("aspect=true\n")
            elif cmdline.startswith("buttonwrap"):
                retroDosboxCfg.write("buttonwrap=false\n")
            elif cmdline.startswith("mapperfile") and 'mapper' in self.conversionConf and self.conversionConf['mapper'] == 'mapper.map':
                retroDosboxCfg.write("mapperfile=mapper.map\n")
            elif cmdline.startswith("ultradir"):
                retroDosboxCfg.write(r"ultradir=C:\ULTRASND")
                retroDosboxCfg.write("\n")
            elif cmdline.startswith("[autoexec]"):
                retroDosboxCfg.write(cmdline)
                self.__createDosboxBat__(lines[count + 1:], retroDosboxBat, retroDosboxCfg, gGator)
                break
            else:
                retroDosboxCfg.write(cmdline)

            count = count + 1

        exoDosboxConf.close()
        os.remove(os.path.join(gGator.getLocalGameDataOutputDir(), "dosbox.conf"))
        retroDosboxCfg.close()
        retroDosboxBat.close()

    # Creates dosbox.bat from dosbox.conf [autoexec] part
    def __createDosboxBat__(self, cmdlines, retroDosboxBat, retroDosboxCfg, gGator):
        # if needed, set ULTRADIR folder used by dosbox as driver (uses ULTRASND folder un games files)
        if not gGator.isWin3x() and os.path.exists(os.path.join(gGator.getLocalGameDataOutputDir(), 'ULTRASND')):
            self.logger.log("    add ULTRADIR for ULTRASND driver")
            retroDosboxBat.write("set ULTRADIR=C:\\%s\\ULTRASND\n" % gGator.game)

        whereWeAt = [gGator.getLocalGameOutputDir()]  # Identify where we at in generated set
        for cmdline in cmdlines:
            # keep conf in dosbox.cfg but comment it
            if self.conversionConf['useDebugMode']:
                retroDosboxCfg.write("# " + cmdline)
            self.__convertLine__(cmdline, retroDosboxBat, gGator, whereWeAt)

    # Convert command line to dosbox.bat
    def __convertLine__(self, cmdline, retroDosboxBat, gGator, whereWeAt):
        cutLines = ["cd ..", "cls", "mount c", "#", "exit", "echo off", "echo on"]
        # always remove @
        cmdline = cmdline.lstrip('@ ')
        if self.commandHandler.useLine(cmdline, cutLines):
            if cmdline.lower().startswith("c:"):
                retroDosboxBat.write(cmdline)
                if not gGator.isWin3x():
                    # First add move into game subdir
                    retroDosboxBat.write("cd %s\n" % gGator.game)
                    whereWeAt.append(gGator.game)
            # remove cd to gamedir as it is already done, but keep others cd
            elif cmdline.lower().startswith("cd "):
                path = self.commandHandler.reducePathExoPart(cmdline.lstrip(' ').rstrip('\n\r ').split(" ")[-1].rstrip('\n\r '))
                if path.lower() == gGator.game.lower() and not os.path.exists(
                        os.path.join(gGator.getLocalGameDataOutputDir(), path)):
                    self.logger.log("    cd command: '%s' -> path is game name and no existing subpath, removed"
                                    % cmdline.rstrip('\n\r '))
                else:
                    self.logger.log("    cd command: '%s' -> kept" % cmdline.rstrip('\n\r '))
                    retroDosboxBat.write(cmdline)
                    whereWeAt.append(path)
            elif cmdline.lower().startswith("imgmount "):
                fixedCommand, letter = self.commandHandler.handleImgmount(cmdline.rstrip('\n\r '))
                retroDosboxBat.write('imgmount -u ' + letter + '\n')  # prevents dosbox-pure automount
                retroDosboxBat.write(fixedCommand)
                if self.conversionConf['useDebugMode']:
                    retroDosboxBat.write("\npause\n")
                else:
                    retroDosboxBat.write("\n")
            elif cmdline.lower().startswith("mount "):
                fixedCommand, letter = self.commandHandler.handleMount(cmdline.rstrip('\n\r '))
                retroDosboxBat.write('imgmount -u ' + letter + '\n')  # prevents dosbox-pure automount
                retroDosboxBat.write(fixedCommand)
                if self.conversionConf['useDebugMode']:
                    retroDosboxBat.write("\npause\n")
                else:
                    retroDosboxBat.write("\n")
            elif cmdline.lower().startswith("boot "):
                retroDosboxBat.write(self.commandHandler.handleBoot(cmdline.rstrip('\n\r ')))
            elif cmdline.lower().rstrip(' \n\r') == 'call run' or cmdline.lower().rstrip(' \n\r') == 'call run.bat':
                self.logger.log("    <WARNING> game uses call run.bat", self.logger.WARNING)
                if gGator.game in lists.gamesWithRunBatHandling:
                    self.__handleRunBat__(gGator)
                self.__handlePotentialSubFile__(cmdline, gGator, [], whereWeAt)
                retroDosboxBat.write(cmdline)
            else:
                self.__handlePotentialSubFile__(cmdline, gGator, [], whereWeAt)
                retroDosboxBat.write(cmdline)

    # Handle potential sub files and problems in it
    def __handlePotentialSubFile__(self, subPath, gGator, handledSubFiles,whereWeAt):
        # Ignore charset unwritable by python
        if gGator.game in ['747400', 'Frightma', 'FreakOut', 'ghenkhan', 'Spheroid', 'TORNADO']:
            return

        subPath = subPath.lstrip('@ ').lower().replace('call ','') if subPath.lstrip('@ ').lower().startswith("call ") else subPath
        subBat = os.path.join(os.path.join(*whereWeAt), subPath.rstrip(' \n\r') + '.bat')

        if os.path.exists(subBat) and not os.path.isdir(subBat) and subBat.lower() not in handledSubFiles:
            shutil.copy2(os.path.join(self.scriptDir, 'data', 'JCHOICE.EXE'), os.path.dirname(subBat))
            # Handle old DOS file with cp437 encoding (falsely detected as TIS-620, EUC-KR)
            subBatRaw = open(subBat, 'rb')
            rawdata = subBatRaw.read()
            result = chardet.detect(rawdata)
            encodingDic = {'TIS-620': 'cp437', 'EUC-KR': 'cp437', 'CP949': 'cp949'}
            # TODO Survey this fix is ok ...
            encoding = result['encoding'] if result['encoding'] not in encodingDic else encodingDic[result['encoding']]
            subBatRaw.close()
            # TODO is encoding is None use 'cp1252' ?
            self.logger.log('    Handle Bat File (enc:%s->%s) %s' % (result['encoding'],encoding, subBat), self.logger.WARNING)
            handledSubFiles.append(subBat.lower())
            subBatFile = open(subBat, 'r', encoding=encoding)
            subBatFileClone = open(subBat + '1', 'w', newline='\r\n', encoding=encoding)
            for cmdline in subBatFile.readlines():
                # always remove @
                cmdline = cmdline.lstrip('@ ')
                if cmdline.lower().rstrip(' \n\r') == 'c:' and gGator.conversionType == util.mister:
                    self.logger.log('      Remove c: for MiSTeR', self.logger.WARNING)
                else:
                    if 'c:\\' in cmdline.lower():
                        if gGator.conversionType == util.mister:
                            # TODO might need win3x fix
                            cmdline = cmdline.replace('c:', 'E:\\GAMES\\' + gGator.game).replace('C:', 'E:\\GAMES\\' + gGator.game)
                        else:
                            if not gGator.isWin3x():
                                cmdline = cmdline.replace('c:','c:\\'+gGator.game).replace('C:','C:\\'+gGator.game)
                    elif cmdline.lower().startswith('choice '):
                        cmdline = cmdline.replace('choice ', 'jchoice ').replace('CHOICE ', 'JCHOICE ')
                    else:
                        self.__handlePotentialSubFile__(cmdline, gGator, handledSubFiles, whereWeAt)
                    subBatFileClone.write(cmdline)
            subBatFileClone.close()
            subBatFile.close()
            # Delete runbat and rename runbat clone to runbat
            os.remove(subBat)
            os.rename(subBat + '1', subBat)

    # Treat run.bat command inside game directory
    def __handleRunBat__(self, gGator):
        runBat = os.path.join(gGator.getLocalGameDataOutputDir(), 'run.bat')
        if os.path.exists(runBat):
            runFile = open(runBat, 'r')
            runFileClone = open(runBat + '1', 'w', newline='\r\n')
            # Clone run.bat and only modify imgmount lines
            # Add some hardcoded lines which are impossible to handle
            handled = {
                'imgmount d ".\\eXoDOS\\comconra\\cd\\Command & Conquer - Red Alert (USA) (Soviet Disc) (Rerelease) (19991021).cue" ".\\eXoDOS\\comconra\\cd\\Command & Conquer - Red Alert (USA) (Allied Disc) (Rerelease) (19991021).cue" ".\\eXoDOS\\comconra\\cd\\Red Alert Counterstrike CD3.cue" ".\\eXoDOS\\comconra\\cd\\Red Alert Aftermath CD4.cue" -t cdrom':
                'imgmount d ".\\cd\\comma2.cue" ".\\cd\\comma1.cue" ".\\cd\\redal3.cue" ".\\eXoDOS\\comconra\\cd\\redal4.cue" -t cdrom',
                'imgmount d ".\\eXoDOS\\comconra\\cd\\Red Alert Aftermath CD4.cue" ".\\eXoDOS\\comconra\\cd\\Command & Conquer - Red Alert (USA) (Allied Disc) (Rerelease) (19991021).cue" ".\\eXoDOS\\comconra\\cd\\Command & Conquer - Red Alert (USA) (Soviet Disc) (Rerelease) (19991021).cue" ".\\eXoDOS\\comconra\\cd\\Red Alert Counterstrike CD3.cue" -t cdrom':
                'imgmount d ".\\cd\\redal4.cue" ".\\cd\\comma1.cue" ".\\cd\\comma2.cue" ".\\cd\\redal3.cue" -t cdrom',
                'imgmount d ".\\eXoDOS\\comconra\\cd\\Red Alert Counterstrike CD3.cue" ".\\eXoDOS\\comconra\\cd\\Command & Conquer - Red Alert (USA) (Allied Disc) (Rerelease) (19991021).cue" ".\\eXoDOS\\comconra\\cd\\Command & Conquer - Red Alert (USA) (Soviet Disc) (Rerelease) (19991021).cue" ".\\eXoDOS\\comconra\\cd\\Red Alert Aftermath CD4.cue" -t cdrom':
                'imgmount d ".\\cd\\redal3.cue" ".\\cd\\comma1.cue" ".\\cd\\comma2.cue" ".\\cd\\redal4.cue" -t cdrom',
                'imgmount d ".\\eXoDOS\\comconra\\cd\\Red Alert Aftermath CD4.cue" -t cdrom': 'imgmount d ".\\cd\\redal4.cue" -t cdrom',
                'imgmount -u d\n': '\n',
                'imgmount d ".\\eXoDOS\\Blood\\cd\\bloodcd1.cue" -t cdrom': 'imgmount d ".\\cd\\BLOODCD1.cue" -t cdrom',
                'imgmount d ".\\eXoDOS\\comcon\\cd\\Command & Conquer CD-2.iso" ".\\eXoDOS\\comcon\\cd\\Command & Conquer CD-1.iso" ".\\eXoDOS\\comcon\\cd\\Covert Operations.cue" -t cdrom':
                'imgmount d ".\\cd\\comma2.cue" ".\\cd\\comma1.cue" ".\\cd\\cover3.cue" -t cdrom',
                'imgmount d ".\\eXoDOS\\comcon\\cd\\Covert Operations.cue" ".\\eXoDOS\\comcon\\cd\\Command & Conquer CD-2.iso" ".\\eXoDOS\\comcon\\cd\\Command & Conquer CD-1.iso" -t cdrom':
                    'imgmount d ".\\cd\\cover3.cue" ".\\cd\\comma2.cue" ".\\cd\\comma1.cue" -t cdrom',
            }
            for cmdline in runFile.readlines():
                # always remove @
                cmdline = cmdline.lstrip('@ ')
                if cmdline.lower().startswith("imgmount "):
                    cmdline = cmdline.rstrip(' \n\r')
                    if cmdline not in handled:
                        fixedCommand, letter = self.commandHandler.handleImgmount(cmdline, True)
                        runFileClone.write('imgmount -u ' + letter + '\n')  # prevents dosbox-pure automount
                        handled[cmdline] = fixedCommand
                    runFileClone.write(handled[cmdline])
                    if self.conversionConf['useDebugMode']:
                        runFileClone.write("\npause\n")
                    else:
                        runFileClone.write("\n")
                else:
                    runFileClone.write(cmdline)
            runFileClone.close()
            runFile.close()
            # Delete runbat and rename runbat clone to runbat
            os.remove(os.path.join(gGator.getLocalGameDataOutputDir(), 'run.bat'))
            os.rename(os.path.join(gGator.getLocalGameDataOutputDir(), 'run.bat1'), os.path.join(gGator.getLocalGameDataOutputDir(), 'run.bat'))
        else:
            self.logger.log('      <ERROR> run.bat not found', self.logger.ERROR)