# -*- coding: utf-8 -*- # FlashGBX # Author: Lesserkuma (github.com/lesserkuma) import sys, os, glob, re, json, zlib, argparse, zipfile, traceback, platform, datetime, copy from . import Util def ReadConfigFiles(args): reset = args['argparsed'].reset settings = Util.IniSettings(path=args["config_path"] + "/settings.ini") config_version = settings.value("ConfigVersion") if not os.path.exists(args["config_path"]): os.makedirs(args["config_path"]) fc_files = glob.glob("{:s}/fc_*.txt".format(glob.escape(args["config_path"]))) if config_version is not None and len(fc_files) == 0: print("No flash cartridge type configuration files found in {:s}. Resetting configuration...".format(args["config_path"])) settings.clear() os.rename(args["config_path"] + "/settings.ini", args["config_path"] + "/settings.ini_" + datetime.datetime.now().strftime("%Y%m%d%H%M%S") + ".bak") config_version = False # extracts the config.zip again elif reset: settings.clear() print("All configuration has been reset.") settings.setValue("ConfigVersion", Util.VERSION) return (config_version, fc_files) def LoadConfig(args): app_path = args['app_path'] config_path = args['config_path'] ret = [] flashcarts = { "DMG":{}, "AGB":{} } # Settings and Config (config_version, fc_files) = ReadConfigFiles(args=args) if config_version != Util.VERSION: # Rename old files that have since been replaced/renamed/merged deprecated_files = [ "fc_AGB_TEST.txt", "fc_DMG_TEST.txt", "fc_AGB_Nintendo_E201850.txt", "fc_AGB_Nintendo_E201868.txt", "config.ini", "fc_DMG_MX29LV320ABTC.txt", "fc_DMG_iG_4MB_MBC3_RTC.txt", "fc_AGB_Flash2Advance.txt", "fc_AGB_MX29LV640_AUDIO.txt", "fc_AGB_M36L0R7050T.txt", "fc_AGB_M36L0R8060B.txt", "fc_AGB_M36L0R8060T.txt", "fc_AGB_iG_32MB_S29GL512N.txt", "fc_DMG_SST39SF010_MBC1_AUDIO.txt", "fc_DMG_SST39SF040_MBC5_AUDIO.txt", "fc_DMG_AM29F010_MBC1_AUDIO.txt", "fc_DMG_AM29F040_MBC1_AUDIO.txt", "fc_DMG_AM29F040_MBC1_WR.txt", "fc_DMG_AM29F080_MBC1_AUDIO.txt", "fc_DMG_AM29F080_MBC1_WR.txt", "fc_DMG_SST39SF040_MBC1_AUDIO.txt", "fc_DMG_SST39SF020_MBC1_AUDIO.txt", "fc_DMG_29LV016T.txt", "fc_DMG_Retrostage.txt" ] for file in deprecated_files: if os.path.exists(config_path + "/" + file): os.rename(config_path + "/" + file, config_path + "/" + file + "_" + datetime.datetime.now().strftime("%Y%m%d%H%M%S") + ".bak") rf_list = "" if os.path.exists(app_path + "/res/config.zip"): with zipfile.ZipFile(app_path + "/res/config.zip") as zip: for zfile in zip.namelist(): if os.path.exists(config_path + "/" + zfile): zfile_crc = zip.getinfo(zfile).CRC with open(config_path + "/" + zfile, "rb") as ofile: buffer = ofile.read() ofile_crc = zlib.crc32(buffer) & 0xFFFFFFFF if zfile_crc == ofile_crc: continue os.rename(config_path + "/" + zfile, config_path + "/" + zfile + "_" + datetime.datetime.now().strftime("%Y%m%d%H%M%S") + ".bak") rf_list += zfile + "\n" zip.extract(zfile, config_path + "/") if rf_list != "": ret.append([1, "The application was recently updated and some flashcart type files have been updated as well. You will find backup copies of them in your configuration directory.\n\nUpdated files:\n" + rf_list[:-1]]) fc_files = glob.glob("{0:s}/fc_*.txt".format(glob.escape(config_path))) else: print("WARNING: {:s} not found. This is required to load new flash cartridge type configurations after updating.".format(app_path + "/res/config.zip")) # Read flash cart types for file in fc_files: if os.path.exists(file): with open(file, encoding='utf-8') as f: data = f.read() specs_int = re.sub("(0x[0-9A-F]+)", lambda m: str(int(m.group(1), 16)), data) # hex numbers to int numbers, otherwise not valid json try: specs = json.loads(specs_int) except: ret.append([2, "The flashchip type file “{:s}” could not be parsed and needs to be fixed before it can be used.".format(os.path.basename(file))]) continue if "names" not in specs: continue for name in specs["names"]: if not specs["type"] in flashcarts: continue # only DMG and AGB are supported right now temp = copy.deepcopy(specs) temp["names"] = [name] flashcarts[specs["type"]][name] = temp return { "flashcarts":flashcarts, "config_ret":ret } class ArgParseCustomFormatter(argparse.ArgumentDefaultsHelpFormatter, argparse.RawDescriptionHelpFormatter): pass def main(portableMode=False): if platform.system() == "Windows": os.system("color") elif platform.system() == "Darwin": macos_version = tuple(map(int, platform.mac_ver()[0].split('.'))) # macOS above Big Sur don't need a compat layer fix in the environment if macos_version < (12, 0): os.environ['QT_MAC_WANTS_LAYER'] = '1' print("{:s} {:s} by Lesserkuma".format(Util.APPNAME, Util.VERSION)) print("https://github.com/lesserkuma/FlashGBX") if getattr(sys, 'frozen', False) and hasattr(sys, '_MEIPASS'): app_path = os.path.dirname(sys.executable) else: app_path = os.path.dirname(os.path.abspath(__file__)) try: from .pyside import QtCore cp = { "subdir":app_path + "/config", "appdata":QtCore.QStandardPaths.writableLocation(QtCore.QStandardPaths.AppConfigLocation) + '/FlashGBX' } except: cp = { "subdir":app_path + "/config", "appdata":os.path.expanduser('~') + '/FlashGBX' } if portableMode: cfgdir_default = "subdir" else: cfgdir_default = "appdata" examples = "\nexamples:\n" + \ " Backup the ROM of a Game Boy Advance cartridge:\n\tFlashGBX --mode agb --action backup-rom\n\n" + \ " Backup Save Data from a Game Boy cartridge:\n\tFlashGBX --mode dmg --action backup-save\n\n" + \ " Write a Game Boy Advance ROM relying on auto-detecting the flash cartridge:\n\tFlashGBX --mode agb --action flash-rom ROM.gba\n\n" + \ " Extract Game Boy Camera pictures as .png files from a save data file:\n\tFlashGBX --mode dmg --action gbcamera-extract --gbcamera-outfile-format png GAMEBOYCAMERA.sav\n\n" parser = argparse.ArgumentParser(formatter_class=ArgParseCustomFormatter, epilog=examples) try: # pylint: disable=protected-access parser._action_groups[1].title = "general arguments" except: pass parser.add_argument("--cli", help="force command line interface mode", action="store_true") parser.add_argument("--reset", help="clears all settings such as last used directory information", action="store_true") parser.add_argument("--debug", help="enable debug messages used for development", action="store_true") parser.add_argument_group('') ap_config = parser.add_argument_group('configuration arguments') if "appdata" in cp: ap_config.add_argument("--cfgdir", choices=["appdata", "subdir"], type=str.lower, default=cfgdir_default, help="sets the config directory to either the OS-provided local app config directory (" + cp['appdata'] + "), or a subdirectory of this application (" + cp['subdir'].replace("\\", "/") + ")") ap_cli1 = parser.add_argument_group('main command line interface arguments') ap_cli1.add_argument("--mode", choices=["dmg", "agb"], type=str.lower, default=None, help="set cartridge mode to \"dmg\" (Game Boy) or \"agb\" (Game Boy Advance)") ap_cli1.add_argument("--action", choices=["info", "backup-rom", "flash-rom", "backup-save", "restore-save", "erase-save", "gbcamera-extract", "fwupdate-gbxcartrw", "debug-test-save"], type=str.lower, default=None, help="select program action") ap_cli1.add_argument("--overwrite", action="store_true", help="overwrite without asking if target file already exists") ap_cli1.add_argument("path", nargs="?", default="auto", help="target or source file path (optional when reading, required when writing)") ap_cli2 = parser.add_argument_group('optional command line interface arguments') ap_cli2.add_argument("--dmg-romsize", choices=["auto", "32kb", "64kb", "128kb", "256kb", "512kb", "1mb", "2mb", "4mb", "8mb", "16mb", "32mb", "64mb", "128mb"], type=str.lower, default="auto", help="set size of Game Boy cartridge ROM data") ap_cli2.add_argument("--dmg-mbc", type=str.lower, default="auto", help="set memory bank controller type of Game Boy cartridge") ap_cli2.add_argument("--dmg-savetype", choices=["auto", "4k", "16k", "64k", "256k", "512k", "1m", "mbc6", "mbc7_2k", "mbc7_4k", "tama5", "sram4m", "eeprom1m", "photo"], type=str.lower, default="auto", help="set type of Game Boy cartridge save data") ap_cli2.add_argument("--agb-romsize", choices=["auto", "32kb", "64kb", "128kb", "256kb", "512kb", "1mb", "2mb", "4mb", "8mb", "16mb", "32mb", "64mb", "128mb", "256mb", "512mb"], type=str.lower, default="auto", help="set size of Game Boy Advance cartridge ROM data") ap_cli2.add_argument("--agb-savetype", choices=["auto", "eeprom4k", "eeprom64k", "sram256k", "flash512k", "flash1m", "dacs8m", "sram512k", "sram1m"], type=str.lower, default="auto", help="set type of Game Boy Advance cartridge save data") ap_cli2.add_argument("--store-rtc", action="store_true", default=False, help="store RTC register values if supported") ap_cli2.add_argument("--ignore-bad-header", action="store_true", help="don’t stop if invalid data found in cartridge header data") ap_cli2.add_argument("--flashcart-type", type=str, default="autodetect", help="name of flash cart; see txt files in config directory") ap_cli2.add_argument("--prefer-chip-erase", action="store_true", help="prefer full chip erase over sector erase when both available") ap_cli2.add_argument("--force-5v", action="store_true", help="force 5V when writing Game Boy flash cartridges") ap_cli2.add_argument("--no-verify-write", action="store_true", help="do not verify written data") ap_cli2.add_argument("--generate-dump-report", action="store_true", help="generate dump reports when making a ROM backup") ap_cli2.add_argument("--save-filename-add-datetime", action="store_true", help="adds a timestamp to the file name of save data backups") ap_cli2.add_argument("--gbcamera-palette", choices=["grayscale", "dmg", "sgb", "cgb1", "cgb2", "cgb3"], type=str.lower, default="grayscale", help="sets the palette of pictures extracted from Game Boy Camera saves") ap_cli2.add_argument("--gbcamera-outfile-format", choices=["png", "bmp", "gif", "jpg"], type=str.lower, default="png", help="sets the file format of saved pictures extracted from Game Boy Camera saves") ap_cli2.add_argument("--device-port", help="override device port", default=None) ap_cli2.add_argument("--device-limit-baudrate", action="store_true", help="limit connection to a slower baud rate") args = parser.parse_args() if "appdata" in cp: config_path = cp[args.cfgdir] else: config_path = cp["subdir"] if args.mode is not None or args.action is not None: args.cli = True if args.debug == True: Util.DEBUG = True args = {"app_path":app_path, "config_path":config_path, "argparsed":args} while True: try: if not os.path.exists(config_path): os.mkdir(config_path) tf = "{:s}/settings.ini".format(config_path) f = open(tf, "ab") f.close() break except PermissionError: print("\n{:s}Error: This program has no permission to use the configuration directory “{:s}”!{:s}".format(Util.ANSI.RED, config_path, Util.ANSI.RESET)) if "appdata" in cp and args["argparsed"].cfgdir == "subdir": answer = input("Use directory “{:s}” instead? [y/N] ".format(cp["appdata"])).strip().lower() if answer != "y": return config_path = cp["appdata"] args["config_path"] = config_path continue else: input("") return args.update(LoadConfig(args)) app = None exc = None if not args["argparsed"].cli: try: from . import FlashGBX_GUI app = FlashGBX_GUI.FlashGBX_GUI(args) except ModuleNotFoundError: app = None except: exc = traceback.format_exc() app = None if app is None: from . import FlashGBX_CLI if args["argparsed"].action is None: parser.print_help() print("\n\n{:s}NOTE: GUI mode couldn’t be launched, but the application can be run in CLI mode.\n Optional command line switches are explained above.{:s}\n".format(Util.ANSI.RED, Util.ANSI.RESET)) if exc is not None: print("{:s}{:s}{:s}".format(Util.ANSI.YELLOW, exc, Util.ANSI.RESET)) print("Now running in CLI mode.\n") app = FlashGBX_CLI.FlashGBX_CLI(args) try: app.run() except KeyboardInterrupt: print("\n\nProgram stopped.") return app.run() else: from . import FlashGBX_CLI print("Now running in CLI mode.\n") app = FlashGBX_CLI.FlashGBX_CLI(args) try: app.run() except KeyboardInterrupt: print("\n\nProgram stopped.")