custominstall: fix loading seed (close #25)

LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2019-2021 Ian Burgwin
+Copyright (c) 2019 Ian Burgwin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,24 +1,15 @@
 [![License](https://img.shields.io/badge/License-MIT-blue.svg)]() ![Releases](https://img.shields.io/github/downloads/ihaveamac/custom-install/total.svg)
 
 # custom-install
-Installs a title directly to an SD card for the Nintendo 3DS. Originally created late June 2019.
+Experimental script to automate the process of a manual title install for Nintendo 3DS. Originally created late June 2019.
 
 ## Summary
-
-### Windows standalone
-
-1. [Dump boot9.bin and movable.sed](https://ihaveamac.github.io/dump.html) from a 3DS system.
-2. Download the [latest releases](https://github.com/ihaveamac/custom-install/releases).
-3. Extract and run ci-gui. Read `windows-quickstart.txt`.
-
-### With installed Python
 Note for Windows users: Enabling "Add Python 3.X to PATH" is **NOT** required! Python is installed with the `py` launcher by default.
 
 1. [Dump boot9.bin and movable.sed](https://ihaveamac.github.io/dump.html) from a 3DS system.
-2. Download the repo ([zip link](https://github.com/ihaveamac/custom-install/archive/module-newer-gui.zip) or `git clone`)
+2. Download the repo ([zip link](https://github.com/ihaveamac/custom-install/archive/module-new-gui.zip) or `git clone`)
 3. Install the packages:
-  * Windows: Double-click `windows-install-dependencies.py`
-    * Alternate manual method: `py -3 -m pip install --user -r requirements-win32.txt`
+  * Windows: `py -3 -m pip install --user -r requirements.txt`
   * macOS/Linux: `python3 -m pip install --user -r requirements.txt`
 4. Run `custominstall.py` with boot9.bin, movable.sed, path to the SD root, and CIA files to install (see Usage section).
 5. Download and use [custom-install-finalize](https://github.com/ihaveamac/custom-install/releases) on the 3DS system to finish the install.
@@ -61,37 +52,21 @@ python3 custominstall.py -b boot9.bin -m movable.sed --sd /media/GM9SD file.cia
 ```
 
 ## GUI
-A GUI is provided to make the process easier.
+GUI wrapper to easily manage your apps. (More will go here...)
+
+![GUI](https://raw.githubusercontent.com/LyfeOnEdge/custom-install/master/docu/main.png)
 
 ### GUI Setup
-Linux users may need to install a Tk package:
 - Ubuntu/Debian: `sudo apt install python3-tk`
 - Manjaro/Arch: `sudo pacman -S tk`
-
-Install the requirements listed in "Summary", then run `ci-gui.py`.
-
-## Development
-
-### Building Windows standalone
-
-Using a 32-bit version of Python is recommended to build a version to be distributed.
-
-A [virtual environment](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment) is recommended to isolate the packages from system directories. The build script `make-standalone.bat` assumes that the dependencies are in PATH.
-
-Install the dependencies, plus cx-Freeze. In a virtual environment, the specific Python version doesn't need to be requested.
-```batch
-pip install cx-freeze -r requirements-win32.txt
-```
-
-Copy `custom-install-finalize.3dsx` to the project root, this will be copied to the build directory and included in the final archive.
-
-Run `make-standalone.bat`. This will run cxfreeze and make a standalone version at `dist\custom-install-standalone.zip`
+- Mac: Sometimes the default tkinter libs that ship with mac don't work, you can get them on the python site - `https://www.python.org/downloads/mac-osx/`
+- Windows: Install python - `Remember to install tcl/tk when doing a custom installation`
 
 ## License/Credits
 [save3ds by wwylele](https://github.com/wwylele/save3ds) is used to interact with the Title Database (details in `bin/README`).
 
+Thanks to @LyfeOnEdge from the [brewtools Discord](https://brewtools.dev) for designing the GUI. Special thanks to CrafterPika and archbox for testing.
+
 Thanks to @nek0bit for redesigning `custominstall.py` to work as a module, and for implementing an earlier GUI.
 
-Thanks to @LyfeOnEdge from the [brewtools Discord](https://brewtools.dev) for designing the second version of the GUI. Special thanks to CrafterPika and archbox for testing.
-
 Thanks to @BpyH64 for [researching how to generate the cmacs](https://github.com/d0k3/GodMode9/issues/340#issuecomment-487916606).

ci-gui.py

@@ -1,653 +0,0 @@
-# This file is a part of custom-install.py.
-#
-# custom-install is copyright (c) 2019-2020 Ian Burgwin
-# This file is licensed under The MIT License (MIT).
-# You can find the full license text in LICENSE.md in the root of this project.
-
-from os import environ, scandir
-from os.path import abspath, basename, dirname, join, isfile
-from sys import exc_info, platform
-from threading import Thread, Lock
-from time import strftime
-from traceback import format_exception
-import tkinter as tk
-import tkinter.ttk as ttk
-import tkinter.filedialog as fd
-import tkinter.messagebox as mb
-from typing import TYPE_CHECKING
-
-from pyctr.crypto.engine import b9_paths
-from pyctr.util import config_dirs
-from pyctr.type.cdn import CDNError
-from pyctr.type.cia import CIAError
-from pyctr.type.tmd import TitleMetadataError
-
-from custominstall import CustomInstall, CI_VERSION, load_cifinish, InvalidCIFinishError
-
-if TYPE_CHECKING:
-    from typing import Dict, List
-
-is_windows = platform == 'win32'
-taskbar = None
-if is_windows:
-    try:
-        import comtypes.client as cc
-
-        tbl = cc.GetModule('TaskbarLib.tlb')
-
-        taskbar = cc.CreateObject('{56FDF344-FD6D-11D0-958A-006097C9A090}', interface=tbl.ITaskbarList3)
-        taskbar.HrInit()
-    except ModuleNotFoundError:
-        pass
-
-file_parent = dirname(abspath(__file__))
-
-# automatically load boot9 if it's in the current directory
-b9_paths.insert(0, join(file_parent, 'boot9.bin'))
-b9_paths.insert(0, join(file_parent, 'boot9_prot.bin'))
-
-seeddb_paths = [join(x, 'seeddb.bin') for x in config_dirs]
-try:
-    seeddb_paths.insert(0, environ['SEEDDB_PATH'])
-except KeyError:
-    pass
-# automatically load seeddb if it's in the current directory
-seeddb_paths.insert(0, join(file_parent, 'seeddb.bin'))
-
-
-def clamp(n, smallest, largest):
-    return max(smallest, min(n, largest))
-
-
-def find_first_file(paths):
-    for p in paths:
-        if isfile(p):
-            return p
-
-
-# find boot9, seeddb, and movable.sed to auto-select in the gui
-default_b9_path = find_first_file(b9_paths)
-default_seeddb_path = find_first_file(seeddb_paths)
-default_movable_sed_path = find_first_file([join(file_parent, 'movable.sed')])
-
-
-class ConsoleFrame(ttk.Frame):
-    def __init__(self, parent: tk.BaseWidget = None, starting_lines: 'List[str]' = None):
-        super().__init__(parent)
-        self.parent = parent
-
-        self.rowconfigure(0, weight=1)
-        self.columnconfigure(0, weight=1)
-
-        scrollbar = ttk.Scrollbar(self, orient=tk.VERTICAL)
-        scrollbar.grid(row=0, column=1, sticky=tk.NSEW)
-
-        self.text = tk.Text(self, highlightthickness=0, wrap='word', yscrollcommand=scrollbar.set)
-        self.text.grid(row=0, column=0, sticky=tk.NSEW)
-
-        scrollbar.config(command=self.text.yview)
-
-        if starting_lines:
-            for l in starting_lines:
-                self.text.insert(tk.END, l + '\n')
-
-        self.text.see(tk.END)
-        self.text.configure(state=tk.DISABLED)
-
-    def log(self, *message, end='\n', sep=' '):
-        self.text.configure(state=tk.NORMAL)
-        self.text.insert(tk.END, sep.join(message) + end)
-        self.text.see(tk.END)
-        self.text.configure(state=tk.DISABLED)
-
-
-def simple_listbox_frame(parent, title: 'str', items: 'List[str]'):
-    frame = ttk.LabelFrame(parent, text=title)
-    frame.rowconfigure(0, weight=1)
-    frame.columnconfigure(0, weight=1)
-
-    scrollbar = ttk.Scrollbar(frame, orient=tk.VERTICAL)
-    scrollbar.grid(row=0, column=1, sticky=tk.NSEW)
-
-    box = tk.Listbox(frame, highlightthickness=0, yscrollcommand=scrollbar.set, selectmode=tk.EXTENDED)
-    box.grid(row=0, column=0, sticky=tk.NSEW)
-    scrollbar.config(command=box.yview)
-
-    box.insert(tk.END, *items)
-
-    box.config(height=clamp(len(items), 3, 10))
-
-    return frame
-
-
-class TitleReadFailResults(tk.Toplevel):
-    def __init__(self, parent: tk.Tk = None, *, failed: 'Dict[str, str]'):
-        super().__init__(parent)
-        self.parent = parent
-
-        self.wm_withdraw()
-        self.wm_transient(self.parent)
-        self.grab_set()
-        self.wm_title('Failed to add titles')
-
-        self.rowconfigure(0, weight=1)
-        self.columnconfigure(0, weight=1)
-
-        outer_container = ttk.Frame(self)
-        outer_container.grid(sticky=tk.NSEW)
-        outer_container.rowconfigure(0, weight=0)
-        outer_container.rowconfigure(1, weight=1)
-        outer_container.columnconfigure(0, weight=1)
-
-        message_label = ttk.Label(outer_container, text="Some titles couldn't be added.")
-        message_label.grid(row=0, column=0, sticky=tk.NSEW, padx=10, pady=10)
-
-        treeview_frame = ttk.Frame(outer_container)
-        treeview_frame.grid(row=1, column=0, sticky=tk.NSEW)
-        treeview_frame.rowconfigure(0, weight=1)
-        treeview_frame.columnconfigure(0, weight=1)
-
-        treeview_scrollbar = ttk.Scrollbar(treeview_frame, orient=tk.VERTICAL)
-        treeview_scrollbar.grid(row=0, column=1, sticky=tk.NSEW)
-
-        treeview = ttk.Treeview(treeview_frame, yscrollcommand=treeview_scrollbar.set)
-        treeview.grid(row=0, column=0, sticky=tk.NSEW, padx=10, pady=(0, 10))
-        treeview.configure(columns=('filepath', 'reason'), show='headings')
-
-        treeview.column('filepath', width=200, anchor=tk.W)
-        treeview.heading('filepath', text='File path')
-        treeview.column('reason', width=400, anchor=tk.W)
-        treeview.heading('reason', text='Reason')
-
-        treeview_scrollbar.configure(command=treeview.yview)
-
-        for path, reason in failed.items():
-            treeview.insert('', tk.END, text=path, iid=path, values=(basename(path), reason))
-
-        ok_frame = ttk.Frame(outer_container)
-        ok_frame.grid(row=2, column=0, sticky=tk.NSEW, padx=10, pady=(0, 10))
-        ok_frame.rowconfigure(0, weight=1)
-        ok_frame.columnconfigure(0, weight=1)
-
-        ok_button = ttk.Button(ok_frame, text='OK', command=self.destroy)
-        ok_button.grid(row=0, column=0)
-
-        self.wm_deiconify()
-
-
-class InstallResults(tk.Toplevel):
-    def __init__(self, parent: tk.Tk = None, *, install_state: 'Dict[str, List[str]]', copied_3dsx: bool):
-        super().__init__(parent)
-        self.parent = parent
-
-        self.wm_withdraw()
-        self.wm_transient(self.parent)
-        self.grab_set()
-        self.wm_title('Install results')
-
-        self.rowconfigure(0, weight=1)
-        self.columnconfigure(0, weight=1)
-
-        outer_container = ttk.Frame(self)
-        outer_container.grid(sticky=tk.NSEW)
-        outer_container.rowconfigure(0, weight=0)
-        outer_container.columnconfigure(0, weight=1)
-
-        if install_state['failed'] and install_state['installed']:
-            # some failed and some worked
-            message = ('Some titles were installed, some failed. Please check the output for more details.\n'
-                       'The ones that were installed can be finished with custom-install-finalize.')
-        elif install_state['failed'] and not install_state['installed']:
-            # all failed
-            message = 'All titles failed to install. Please check the output for more details.'
-        elif install_state['installed'] and not install_state['failed']:
-            # all worked
-            message = 'All titles were installed.'
-        else:
-            message = 'Nothing was installed.'
-
-        if install_state['installed'] and copied_3dsx:
-            message += '\n\ncustom-install-finalize has been copied to the SD card.'
-
-        message_label = ttk.Label(outer_container, text=message)
-        message_label.grid(row=0, column=0, sticky=tk.NSEW, padx=10, pady=10)
-
-        if install_state['installed']:
-            outer_container.rowconfigure(1, weight=1)
-            frame = simple_listbox_frame(outer_container, 'Installed', install_state['installed'])
-            frame.grid(row=1, column=0, sticky=tk.NSEW, padx=10, pady=(0, 10))
-
-        if install_state['failed']:
-            outer_container.rowconfigure(2, weight=1)
-            frame = simple_listbox_frame(outer_container, 'Failed', install_state['failed'])
-            frame.grid(row=2, column=0, sticky=tk.NSEW, padx=10, pady=(0, 10))
-
-        ok_frame = ttk.Frame(outer_container)
-        ok_frame.grid(row=3, column=0, sticky=tk.NSEW, padx=10, pady=(0, 10))
-        ok_frame.rowconfigure(0, weight=1)
-        ok_frame.columnconfigure(0, weight=1)
-
-        ok_button = ttk.Button(ok_frame, text='OK', command=self.destroy)
-        ok_button.grid(row=0, column=0)
-
-        self.wm_deiconify()
-
-
-class CustomInstallGUI(ttk.Frame):
-    console = None
-
-    def __init__(self, parent: tk.Tk = None):
-        super().__init__(parent)
-        self.parent = parent
-
-        # readers to give to CustomInstall at the install
-        self.readers = {}
-
-        self.lock = Lock()
-
-        self.log_messages = []
-
-        self.hwnd = None  # will be set later
-
-        self.rowconfigure(2, weight=1)
-        self.columnconfigure(0, weight=1)
-
-        if taskbar:
-            # this is so progress can be shown in the taskbar
-            def setup_tab():
-                self.hwnd = int(parent.wm_frame(), 16)
-                taskbar.ActivateTab(self.hwnd)
-
-            self.after(100, setup_tab)
-
-        # ---------------------------------------------------------------- #
-        # create file pickers for base files
-        file_pickers = ttk.Frame(self)
-        file_pickers.grid(row=0, column=0, sticky=tk.EW)
-        file_pickers.columnconfigure(1, weight=1)
-
-        self.file_picker_textboxes = {}
-
-        def sd_callback():
-            f = fd.askdirectory(parent=parent, title='Select SD root (the directory or drive that contains '
-                                                     '"Nintendo 3DS")', initialdir=file_parent, mustexist=True)
-            if f:
-                cifinish_path = join(f, 'cifinish.bin')
-                try:
-                    load_cifinish(cifinish_path)
-                except InvalidCIFinishError:
-                    self.show_error(f'{cifinish_path} was corrupt!\n\n'
-                                    f'This could mean an issue with the SD card or the filesystem. Please check it for errors.\n'
-                                    f'It is also possible, though less likely, to be an issue with custom-install.\n\n'
-                                    f'Stopping now to prevent possible issues. If you want to try again, delete cifinish.bin from the SD card and re-run custom-install.')
-                    return
-
-                sd_selected.delete('1.0', tk.END)
-                sd_selected.insert(tk.END, f)
-
-                sd_msed_path = find_first_file([join(f, 'gm9', 'out', 'movable.sed'), join(f, 'movable.sed')])
-                if sd_msed_path:
-                    self.log('Found movable.sed on SD card at ' + sd_msed_path)
-                    box = self.file_picker_textboxes['movable.sed']
-                    box.delete('1.0', tk.END)
-                    box.insert(tk.END, sd_msed_path)
-
-        sd_type_label = ttk.Label(file_pickers, text='SD root')
-        sd_type_label.grid(row=0, column=0)
-
-        sd_selected = tk.Text(file_pickers, wrap='none', height=1)
-        sd_selected.grid(row=0, column=1, sticky=tk.EW)
-
-        sd_button = ttk.Button(file_pickers, text='...', command=sd_callback)
-        sd_button.grid(row=0, column=2)
-
-        self.file_picker_textboxes['sd'] = sd_selected
-
-        # This feels so wrong.
-        def create_required_file_picker(type_name, types, default, row):
-            def internal_callback():
-                f = fd.askopenfilename(parent=parent, title='Select ' + type_name, filetypes=types,
-                                       initialdir=file_parent)
-                if f:
-                    selected.delete('1.0', tk.END)
-                    selected.insert(tk.END, f)
-
-            type_label = ttk.Label(file_pickers, text=type_name)
-            type_label.grid(row=row, column=0)
-
-            selected = tk.Text(file_pickers, wrap='none', height=1)
-            selected.grid(row=row, column=1, sticky=tk.EW)
-            if default:
-                selected.insert(tk.END, default)
-
-            button = ttk.Button(file_pickers, text='...', command=internal_callback)
-            button.grid(row=row, column=2)
-
-            self.file_picker_textboxes[type_name] = selected
-
-        create_required_file_picker('boot9', [('boot9 file', '*.bin')], default_b9_path, 1)
-        create_required_file_picker('seeddb', [('seeddb file', '*.bin')], default_seeddb_path, 2)
-        create_required_file_picker('movable.sed', [('movable.sed file', '*.sed')], default_movable_sed_path, 3)
-
-        # ---------------------------------------------------------------- #
-        # create buttons to add cias
-        titlelist_buttons = ttk.Frame(self)
-        titlelist_buttons.grid(row=1, column=0)
-
-        def add_cias_callback():
-            files = fd.askopenfilenames(parent=parent, title='Select CIA files', filetypes=[('CIA files', '*.cia')],
-                                        initialdir=file_parent)
-            results = {}
-            for f in files:
-                success, reason = self.add_cia(f)
-                if not success:
-                    results[f] = reason
-
-            if results:
-                title_read_fail_window = TitleReadFailResults(self.parent, failed=results)
-                title_read_fail_window.focus()
-            self.sort_treeview()
-
-        add_cias = ttk.Button(titlelist_buttons, text='Add CIAs', command=add_cias_callback)
-        add_cias.grid(row=0, column=0)
-
-        def add_cdn_callback():
-            d = fd.askdirectory(parent=parent, title='Select folder containing title contents in CDN format',
-                                initialdir=file_parent)
-            if d:
-                if isfile(join(d, 'tmd')):
-                    success, reason = self.add_cia(d)
-                    if not success:
-                        self.show_error(f"Couldn't add {basename(d)}: {reason}")
-                    else:
-                        self.sort_treeview()
-                else:
-                    self.show_error('tmd file not found in the CDN directory:\n' + d)
-
-        add_cdn = ttk.Button(titlelist_buttons, text='Add CDN title folder', command=add_cdn_callback)
-        add_cdn.grid(row=0, column=1)
-
-        def add_dirs_callback():
-            d = fd.askdirectory(parent=parent, title='Select folder containing CIA files', initialdir=file_parent)
-            if d:
-                results = {}
-                for f in scandir(d):
-                    if f.name.lower().endswith('.cia'):
-                        success, reason = self.add_cia(f.path)
-                        if not success:
-                            results[f] = reason
-
-                if results:
-                    title_read_fail_window = TitleReadFailResults(self.parent, failed=results)
-                    title_read_fail_window.focus()
-                self.sort_treeview()
-
-        add_dirs = ttk.Button(titlelist_buttons, text='Add folder', command=add_dirs_callback)
-        add_dirs.grid(row=0, column=2)
-
-        def remove_selected_callback():
-            for entry in self.treeview.selection():
-                self.remove_cia(entry)
-
-        remove_selected = ttk.Button(titlelist_buttons, text='Remove selected', command=remove_selected_callback)
-        remove_selected.grid(row=0, column=3)
-
-        # ---------------------------------------------------------------- #
-        # create treeview
-        treeview_frame = ttk.Frame(self)
-        treeview_frame.grid(row=2, column=0, sticky=tk.NSEW)
-        treeview_frame.rowconfigure(0, weight=1)
-        treeview_frame.columnconfigure(0, weight=1)
-
-        treeview_scrollbar = ttk.Scrollbar(treeview_frame, orient=tk.VERTICAL)
-        treeview_scrollbar.grid(row=0, column=1, sticky=tk.NSEW)
-
-        self.treeview = ttk.Treeview(treeview_frame, yscrollcommand=treeview_scrollbar.set)
-        self.treeview.grid(row=0, column=0, sticky=tk.NSEW)
-        self.treeview.configure(columns=('filepath', 'titleid', 'titlename'), show='headings')
-
-        self.treeview.column('filepath', width=200, anchor=tk.W)
-        self.treeview.heading('filepath', text='File path')
-        self.treeview.column('titleid', width=50, anchor=tk.W)
-        self.treeview.heading('titleid', text='Title ID')
-        self.treeview.column('titlename', width=150, anchor=tk.W)
-        self.treeview.heading('titlename', text='Title name')
-
-        treeview_scrollbar.configure(command=self.treeview.yview)
-
-        # ---------------------------------------------------------------- #
-        # create progressbar
-
-        self.progressbar = ttk.Progressbar(self, orient=tk.HORIZONTAL, mode='determinate')
-        self.progressbar.grid(row=3, column=0, sticky=tk.NSEW)
-
-        # ---------------------------------------------------------------- #
-        # create start and console buttons
-
-        control_frame = ttk.Frame(self)
-        control_frame.grid(row=4, column=0)
-
-        self.skip_contents_var = tk.IntVar()
-        skip_contents_checkbox = ttk.Checkbutton(control_frame, text='Skip contents (only add to title database)',
-                                                 variable=self.skip_contents_var)
-        skip_contents_checkbox.grid(row=0, column=0)
-
-        self.overwrite_saves_var = tk.IntVar()
-        overwrite_saves_checkbox = ttk.Checkbutton(control_frame, text='Overwrite existing saves',
-                                                   variable=self.overwrite_saves_var)
-        overwrite_saves_checkbox.grid(row=0, column=1)
-
-        show_console = ttk.Button(control_frame, text='Show console', command=self.open_console)
-        show_console.grid(row=0, column=2)
-
-        start = ttk.Button(control_frame, text='Start install', command=self.start_install)
-        start.grid(row=0, column=3)
-
-        self.status_label = ttk.Label(self, text='Waiting...')
-        self.status_label.grid(row=5, column=0, sticky=tk.NSEW)
-
-        self.log(f'custom-install {CI_VERSION} - https://github.com/ihaveamac/custom-install', status=False)
-
-        if is_windows and not taskbar:
-            self.log('Note: comtypes module not found.')
-            self.log('Note: Progress will not be shown in the Windows taskbar.')
-
-        self.log('Ready.')
-
-        self.disable_during_install = (add_cias, add_dirs, remove_selected, start, *self.file_picker_textboxes.values())
-
-    def sort_treeview(self):
-        l = [(self.treeview.set(k, 'titlename'), k) for k in self.treeview.get_children()]
-        # sort by title name
-        l.sort(key=lambda x: x[0].lower())
-
-        for idx, pair in enumerate(l):
-            self.treeview.move(pair[1], '', idx)
-
-    def add_cia(self, path):
-        path = abspath(path)
-        if path in self.readers:
-            return False, 'File already in list'
-        try:
-            reader = CustomInstall.get_reader(path)
-        except (CIAError, CDNError, TitleMetadataError):
-            return False, 'Failed to read as a CIA or CDN title, probably corrupt'
-        except Exception as e:
-            return False, f'Exception occurred: {type(e).__name__}: {e}'
-
-        if reader.tmd.title_id.startswith('00048'):
-            return False, 'DSiWare is not supported'
-        try:
-            title_name = reader.contents[0].exefs.icon.get_app_title().short_desc
-        except:
-            title_name = '(No title)'
-        self.treeview.insert('', tk.END, text=path, iid=path, values=(path, reader.tmd.title_id, title_name))
-        self.readers[path] = reader
-        return True, ''
-
-    def remove_cia(self, path):
-        self.treeview.delete(path)
-        del self.readers[path]
-
-    def open_console(self):
-        if self.console:
-            self.console.parent.lift()
-            self.console.focus()
-        else:
-            console_window = tk.Toplevel()
-            console_window.title('custom-install Console')
-
-            self.console = ConsoleFrame(console_window, self.log_messages)
-            self.console.pack(fill=tk.BOTH, expand=True)
-
-            def close():
-                with self.lock:
-                    try:
-                        console_window.destroy()
-                    except:
-                        pass
-                    self.console = None
-
-            console_window.focus()
-
-            console_window.protocol('WM_DELETE_WINDOW', close)
-
-    def log(self, line, status=True):
-        with self.lock:
-            log_msg = f"{strftime('%H:%M:%S')} - {line}"
-            self.log_messages.append(log_msg)
-            if self.console:
-                self.console.log(log_msg)
-
-            if status:
-                self.status_label.config(text=line)
-
-    def show_error(self, message):
-        mb.showerror('Error', message, parent=self.parent)
-
-    def ask_warning(self, message):
-        return mb.askokcancel('Warning', message, parent=self.parent)
-
-    def show_info(self, message):
-        mb.showinfo('Info', message, parent=self.parent)
-
-    def disable_buttons(self):
-        for b in self.disable_during_install:
-            b.config(state=tk.DISABLED)
-
-    def enable_buttons(self):
-        for b in self.disable_during_install:
-            b.config(state=tk.NORMAL)
-
-    def start_install(self):
-        sd_root = self.file_picker_textboxes['sd'].get('1.0', tk.END).strip()
-        boot9 = self.file_picker_textboxes['boot9'].get('1.0', tk.END).strip()
-        seeddb = self.file_picker_textboxes['seeddb'].get('1.0', tk.END).strip()
-        movable_sed = self.file_picker_textboxes['movable.sed'].get('1.0', tk.END).strip()
-
-        if not sd_root:
-            self.show_error('SD root is not specified.')
-            return
-        if not boot9:
-            self.show_error('boot9 is not specified.')
-            return
-        if not movable_sed:
-            self.show_error('movable.sed is not specified.')
-            return
-
-        if not seeddb:
-            if not self.ask_warning('seeddb was not specified. Titles that require it will fail to install.\n'
-                                    'Continue?'):
-                return
-
-        self.disable_buttons()
-
-        if not len(self.readers):
-            self.show_error('There are no titles added to install.')
-            return
-
-        self.log('Starting install...')
-
-        if taskbar:
-            taskbar.SetProgressState(self.hwnd, tbl.TBPF_NORMAL)
-
-        installer = CustomInstall(boot9=boot9,
-                                  seeddb=seeddb,
-                                  movable=movable_sed,
-                                  sd=sd_root,
-                                  skip_contents=self.skip_contents_var.get() == 1,
-                                  overwrite_saves=self.overwrite_saves_var.get() == 1)
-
-        # use the treeview which has been sorted alphabetically
-        #installer.readers = self.readers.values()
-        readers_final = []
-        for k in self.treeview.get_children():
-            readers_final.append(self.readers[self.treeview.set(k, 'filepath')])
-
-        installer.readers = readers_final
-
-        finished_percent = 0
-        max_percentage = 100 * len(self.readers)
-        self.progressbar.config(maximum=max_percentage)
-
-        def ci_on_log_msg(message, *args, **kwargs):
-            # ignoring end
-            self.log(message)
-
-        def ci_update_percentage(total_percent, total_read, size):
-            self.progressbar.config(value=total_percent + finished_percent)
-            if taskbar:
-                taskbar.SetProgressValue(self.hwnd, int(total_percent + finished_percent), max_percentage)
-
-        def ci_on_error(exc):
-            if taskbar:
-                taskbar.SetProgressState(self.hwnd, tbl.TBPF_ERROR)
-            for line in format_exception(*exc):
-                for line2 in line.split('\n')[:-1]:
-                    installer.log(line2)
-            self.show_error('An error occurred during installation.')
-            self.open_console()
-
-        def ci_on_cia_start(idx):
-            nonlocal finished_percent
-            finished_percent = idx * 100
-            if taskbar:
-                taskbar.SetProgressValue(self.hwnd, finished_percent, max_percentage)
-
-        installer.event.on_log_msg += ci_on_log_msg
-        installer.event.update_percentage += ci_update_percentage
-        installer.event.on_error += ci_on_error
-        installer.event.on_cia_start += ci_on_cia_start
-
-        if self.skip_contents_var.get() != 1:
-            total_size, free_space = installer.check_size()
-            if total_size > free_space:
-                self.show_error(f'Not enough free space.\n'
-                                f'Combined title install size: {total_size / (1024 * 1024):0.2f} MiB\n'
-                                f'Free space: {free_space / (1024 * 1024):0.2f} MiB')
-                self.enable_buttons()
-                return
-
-        def install():
-            try:
-                result, copied_3dsx = installer.start()
-                if result:
-                    result_window = InstallResults(self.parent, install_state=result, copied_3dsx=copied_3dsx)
-                    result_window.focus()
-                elif result is None:
-                    self.show_error("An error occurred when trying to run save3ds_fuse.\n"
-                                    "Either title.db doesn't exist, or save3ds_fuse couldn't be run.")
-                    self.open_console()
-            except:
-                installer.event.on_error(exc_info())
-            finally:
-                self.enable_buttons()
-
-        Thread(target=install).start()
-
-
-window = tk.Tk()
-window.title(f'custom-install {CI_VERSION}')
-frame = CustomInstallGUI(window)
-frame.pack(fill=tk.BOTH, expand=True)
-window.mainloop()

custominstall.py

@@ -5,52 +5,28 @@
 # You can find the full license text in LICENSE.md in the root of this project.
 
 from argparse import ArgumentParser
-from os import makedirs, rename, scandir
-from os.path import dirname, join, isdir, isfile
+from os import makedirs, scandir
+from os.path import dirname, join
 from random import randint
 from hashlib import sha256
-from locale import getpreferredencoding
-from pprint import pformat
-from shutil import copyfile, copy2, rmtree
-import sys
-from sys import platform, executable
+from sys import platform
 from tempfile import TemporaryDirectory
-from traceback import format_exception
 from typing import BinaryIO, TYPE_CHECKING
 import subprocess
 
 if TYPE_CHECKING:
     from os import PathLike
-    from typing import List, Union
+    from typing import Union
 
 from events import Events
 
-from pyctr.crypto import CryptoEngine, Keyslot, load_seeddb, get_seed
-from pyctr.type.cdn import CDNReader, CDNError
-from pyctr.type.cia import CIAReader, CIAError
+from pyctr.crypto import CryptoEngine, Keyslot, load_seeddb
+from pyctr.type.cia import CIAReader, CIASection
 from pyctr.type.ncch import NCCHSection
-from pyctr.type.tmd import TitleMetadataError
 from pyctr.util import roundup
 
-if platform == 'msys':
-    platform = 'win32'
-
-is_windows = platform == 'win32'
-
-if is_windows:
-    from ctypes import c_wchar_p, pointer, c_ulonglong, windll
-else:
-    from os import statvfs
-
-CI_VERSION = '2.1b1'
-
 # used to run the save3ds_fuse binary next to the script
-frozen = getattr(sys, 'frozen', False)
-script_dir: str
-if frozen:
-    script_dir = dirname(executable)
-else:
-    script_dir = dirname(__file__)
+script_dir: str = dirname(__file__)
 
 # missing contents are replaced with 0xFFFFFFFF in the cmd file
 CMD_MISSING = b'\xff\xff\xff\xff'
@@ -74,26 +50,6 @@ class InvalidCIFinishError(Exception):
     pass
 
 
-def get_free_space(path: 'Union[PathLike, bytes, str]'):
-    if is_windows:
-        lpSectorsPerCluster = c_ulonglong(0)
-        lpBytesPerSector = c_ulonglong(0)
-        lpNumberOfFreeClusters = c_ulonglong(0)
-        lpTotalNumberOfClusters = c_ulonglong(0)
-        ret = windll.kernel32.GetDiskFreeSpaceW(c_wchar_p(path), pointer(lpSectorsPerCluster),
-                                                pointer(lpBytesPerSector),
-                                                pointer(lpNumberOfFreeClusters),
-                                                pointer(lpTotalNumberOfClusters))
-        if not ret:
-            raise WindowsError
-        free_blocks = lpNumberOfFreeClusters.value * lpSectorsPerCluster.value
-        free_bytes = free_blocks * lpBytesPerSector.value
-    else:
-        stv = statvfs(path)
-        free_bytes = stv.f_bavail * stv.f_frsize
-    return free_bytes
-
-
 def load_cifinish(path: 'Union[PathLike, bytes, str]'):
     try:
         with open(path, 'rb') as f:
@@ -174,103 +130,35 @@ def save_cifinish(path: 'Union[PathLike, bytes, str]', data: dict):
             out.write(b''.join(finalize_entry_data))
 
 
-def get_install_size(title: 'Union[CIAReader, CDNReader]'):
-    sizes = [1] * 5
-
-    if title.tmd.save_size:
-        # one for the data directory, one for the 00000001.sav file
-        sizes.extend((1, title.tmd.save_size))
-
-    for record in title.content_info:
-        sizes.append(record.size)
-
-    # this calculates the size to put in the Title Info Entry
-    title_size = sum(roundup(x, TITLE_ALIGN_SIZE) for x in sizes)
-
-    return title_size
-
-
 class CustomInstall:
-    def __init__(self, boot9, seeddb, movable, sd, cifinish_out=None,
-                 overwrite_saves=False, skip_contents=False):
+
+    cia: CIAReader
+
+    def __init__(self, boot9, seeddb, movable, cias, sd, cifinish_out=None, skip_contents=False):
         self.event = Events()
         self.log_lines = []  # Stores all info messages for user to view
 
         self.crypto = CryptoEngine(boot9=boot9)
         self.crypto.setup_sd_key_from_file(movable)
         self.seeddb = seeddb
-        self.readers: 'List[Union[CDNReader, CIAReader]]' = []
+        self.cias = cias
         self.sd = sd
         self.skip_contents = skip_contents
-        self.overwrite_saves = overwrite_saves
         self.cifinish_out = cifinish_out
         self.movable = movable
 
-    def copy_with_progress(self, src: BinaryIO, dst: BinaryIO, size: int, path: str, fire_event: bool = True):
+    def copy_with_progress(self, src: BinaryIO, dst: BinaryIO, size: int, path: str):
         left = size
         cipher = self.crypto.create_ctr_cipher(Keyslot.SD, self.crypto.sd_path_to_iv(path))
-        hasher = sha256()
         while left > 0:
             to_read = min(READ_SIZE, left)
-            data = src.read(READ_SIZE)
-            hasher.update(data)
-            dst.write(cipher.encrypt(data))
+            data = cipher.encrypt(src.read(READ_SIZE))
+            dst.write(data)
             left -= to_read
             total_read = size - left
-            if fire_event:
             self.event.update_percentage((total_read / size) * 100, total_read / 1048576, size / 1048576)
     
-        return hasher.digest()
-
-    @staticmethod
-    def get_reader(path: 'Union[PathLike, bytes, str]'):
-        if isdir(path):
-            # try the default tmd file
-            reader = CDNReader(join(path, 'tmd'))
-        else:
-            try:
-                reader = CIAReader(path)
-            except CIAError:
-                # if there was an error with parsing the CIA header,
-                # the file would be tried in CDNReader next (assuming it's a tmd)
-                # any other error should be propagated to the caller
-                reader = CDNReader(path)
-        return reader
-
-    def prepare_titles(self, paths: 'List[PathLike]'):
-        readers = []
-        for path in paths:
-            self.log(f'Reading {path}')
-            try:
-                reader = self.get_reader(path)
-            except (CIAError, CDNError, TitleMetadataError):
-                self.log(f"Couldn't read {path}, likely corrupt or not a CIA or CDN title")
-                continue
-            if reader.tmd.title_id.startswith('00048'):  # DSiWare
-                self.log(f'Skipping {reader.tmd.title_id} - DSiWare is not supported')
-                continue
-            readers.append(reader)
-        self.readers = readers
-
-    def check_size(self):
-        total_size = 0
-        for r in self.readers:
-            total_size += get_install_size(r)
-
-        free_space = get_free_space(self.sd)
-        return total_size, free_space
-
     def start(self):
-        if frozen:
-            save3ds_fuse_path = join(script_dir, 'bin', 'save3ds_fuse')
-        else:
-            save3ds_fuse_path = join(script_dir, 'bin', platform, 'save3ds_fuse')
-        if is_windows:
-            save3ds_fuse_path += '.exe'
-        if not isfile(save3ds_fuse_path):
-            self.log("Couldn't find " + save3ds_fuse_path, 2)
-            return None, False
-
         crypto = self.crypto
         # TODO: Move a lot of these into their own methods
         self.log("Finding path to install to...")
@@ -285,71 +173,43 @@ class CustomInstall:
             cifinish_path = self.cifinish_out
         else:
             cifinish_path = join(self.sd, 'cifinish.bin')
-
-        try:
-            cifinish_data = load_cifinish(cifinish_path)
-        except InvalidCIFinishError as e:
-            self.log(f'{type(e).__qualname__}: {e}')
-            self.log(f'{cifinish_path} was corrupt!\n'
-                     f'This could mean an issue with the SD card or the filesystem. Please check it for errors.\n'
-                     f'It is also possible, though less likely, to be an issue with custom-install.\n'
-                     f'Exiting now to prevent possible issues. If you want to try again, delete cifinish.bin from the SD card and re-run custom-install.')
-            return None, False
-
-        with TemporaryDirectory(suffix='-custom-install') as tempdir:
-            # set up the common arguments for the two times we call save3ds_fuse
-            save3ds_fuse_common_args = [
-                save3ds_fuse_path,
-                '-b', crypto.b9_path,
-                '-m', self.movable,
-                '--sd', self.sd,
-                '--db', 'sdtitle',
-                tempdir
-            ]
-
-            extra_kwargs = {}
-            if is_windows:
-                # hide console window
-                extra_kwargs['creationflags'] = 0x08000000  # CREATE_NO_WINDOW
-
-            # extract the title database to add our own entry to
-            self.log('Extracting Title Database...')
-            out = subprocess.run(save3ds_fuse_common_args + ['-x'],
-                                 stdout=subprocess.PIPE,
-                                 stderr=subprocess.STDOUT,
-                                 encoding=getpreferredencoding(),
-                                 **extra_kwargs)
-            if out.returncode:
-                for l in out.stdout.split('\n'):
-                    self.log(l)
-                self.log('Command line:')
-                for l in pformat(out.args).split('\n'):
-                    self.log(l)
-                return None, False
-
         sd_path = join(sd_path, id1s[0])
+        title_info_entries = {}
+        cifinish_data = load_cifinish(cifinish_path)
 
         load_seeddb(self.seeddb)
 
-            install_state = {'installed': [], 'failed': []}
-
         # Now loop through all provided cia files
-            for idx, cia in enumerate(self.readers):
         
-                self.event.on_cia_start(idx)
+        for c in self.cias:
+            self.log('Reading ' + c)
 
-                temp_title_root = join(self.sd, f'ci-install-temp-{cia.tmd.title_id}-{randint(0, 0xFFFFFFFF):08x}')
-                makedirs(temp_title_root, exist_ok=True)
+            try:
+                cia = CIAReader(c)
+            except Exception as e:
+                self.log(f'Failed to load file: {type(e).__name__}: {e}')
+                continue
+
+            self.cia = cia
             
             tid_parts = (cia.tmd.title_id[0:8], cia.tmd.title_id[8:16])
 
             try:
-                    display_title = f'{cia.contents[0].exefs.icon.get_app_title().short_desc} - {cia.tmd.title_id}'
+                self.log(f'Installing {cia.contents[0].exefs.icon.get_app_title().short_desc}...')
             except:
-                    display_title = cia.tmd.title_id
-                self.log(f'Installing {display_title}...')
+                self.log('Installing...')
             
-                title_size = get_install_size(cia)
+            sizes = [1] * 5
+
+            if cia.tmd.save_size:
+                # one for the data directory, one for the 00000001.sav file
+                sizes.extend((1, cia.tmd.save_size))
+            
+            for record in cia.content_info:
+                sizes.append(record.size)
+            
+            # this calculates the size to put in the Title Info Entry
+            title_size = sum(roundup(x, TITLE_ALIGN_SIZE) for x in sizes)
 
             # checks if this is dlc, which has some differences
             is_dlc = tid_parts[0] == '0004008c'
@@ -370,9 +230,6 @@ class CustomInstall:
             cmd_id = len(cia.content_info) if is_dlc else 1
             cmd_filename = f'{cmd_id:08x}.cmd'
 
-                # this is where the final directory will be moved
-                tidhigh_root = join(sd_path, 'title', tid_parts[0])
-
             # get the title root where all the contents will be
             title_root = join(sd_path, 'title', *tid_parts)
             content_root = join(title_root, 'content')
@@ -380,16 +237,14 @@ class CustomInstall:
             title_root_cmd = f'/title/{"/".join(tid_parts)}'
             content_root_cmd = title_root_cmd + '/content'
 
-                temp_content_root = join(temp_title_root, 'content')
-
             if not self.skip_contents:
-                    makedirs(join(temp_content_root, 'cmd'), exist_ok=True)
+                makedirs(join(content_root, 'cmd'), exist_ok=True)
                 if cia.tmd.save_size:
-                        makedirs(join(temp_title_root, 'data'), exist_ok=True)
+                    makedirs(join(title_root, 'data'), exist_ok=True)
                 if is_dlc:
                     # create the separate directories for every 256 contents
                     for x in range(((len(cia.content_info) - 1) // 256) + 1):
-                            makedirs(join(temp_content_root, f'{x:08x}'), exist_ok=True)
+                        makedirs(join(content_root, f'{x:08x}'), exist_ok=True)
 
                 # maybe this will be changed in the future
                 tmd_id = 0
@@ -397,58 +252,42 @@ class CustomInstall:
                 tmd_filename = f'{tmd_id:08x}.tmd'
 
                 # write the tmd
-                    tmd_enc_path = content_root_cmd + '/' + tmd_filename
-                    self.log(f'Writing {tmd_enc_path}...')
-                    with open(join(temp_content_root, tmd_filename), 'wb') as o:
-                        with self.crypto.create_ctr_io(Keyslot.SD, o, self.crypto.sd_path_to_iv(tmd_enc_path)) as e:
-                            e.write(bytes(cia.tmd))
+                enc_path = content_root_cmd + '/' + tmd_filename
+                self.log(f'Writing {enc_path}...')
+                with cia.open_raw_section(CIASection.TitleMetadata) as s:
+                    with open(join(content_root, tmd_filename), 'wb') as o:
+                        self.copy_with_progress(s, o, cia.sections[CIASection.TitleMetadata].size, enc_path)
 
-                    # in case the contents are corrupted
-                    do_continue = False
                 # write each content
                 for co in cia.content_info:
                     content_filename = co.id + '.app'
                     if is_dlc:
                         dir_index = format((co.cindex // 256), '08x')
-                            content_enc_path = content_root_cmd + f'/{dir_index}/{content_filename}'
-                            content_out_path = join(temp_content_root, dir_index, content_filename)
+                        enc_path = content_root_cmd + f'/{dir_index}/{content_filename}'
+                        out_path = join(content_root, dir_index, content_filename)
                     else:
-                            content_enc_path = content_root_cmd + '/' + content_filename
-                            content_out_path = join(temp_content_root, content_filename)
-                        self.log(f'Writing {content_enc_path}...')
-                        with cia.open_raw_section(co.cindex) as s, open(content_out_path, 'wb') as o:
-                            result_hash = self.copy_with_progress(s, o, co.size, content_enc_path)
-                            if result_hash != co.hash:
-                                self.log(f'WARNING: Hash does not match for {content_enc_path}!')
-                                install_state['failed'].append(display_title)
-                                rename(temp_title_root, temp_title_root + '-corrupted')
-                                do_continue = True
-                                break
-
-                    if do_continue:
-                        continue
+                        enc_path = content_root_cmd + '/' + content_filename
+                        out_path = join(content_root, content_filename)
+                    self.log(f'Writing {enc_path}...')
+                    with cia.open_raw_section(co.cindex) as s, open(out_path, 'wb') as o:
+                        self.copy_with_progress(s, o, co.size, enc_path)
 
                 # generate a blank save
                 if cia.tmd.save_size:
-                        sav_enc_path = title_root_cmd + '/data/00000001.sav'
-                        tmp_sav_out_path = join(temp_title_root, 'data', '00000001.sav')
-                        sav_out_path = join(title_root, 'data', '00000001.sav')
-                        if self.overwrite_saves or not isfile(sav_out_path):
-                            cipher = crypto.create_ctr_cipher(Keyslot.SD, crypto.sd_path_to_iv(sav_enc_path))
+                    enc_path = title_root_cmd + '/data/00000001.sav'
+                    out_path = join(title_root, 'data', '00000001.sav')
+                    cipher = crypto.create_ctr_cipher(Keyslot.SD, crypto.sd_path_to_iv(enc_path))
                     # in a new save, the first 0x20 are all 00s. the rest can be random
                     data = cipher.encrypt(b'\0' * 0x20)
-                            self.log(f'Generating blank save at {sav_enc_path}...')
-                            with open(tmp_sav_out_path, 'wb') as o:
+                    self.log(f'Generating blank save at {enc_path}...')
+                    with open(out_path, 'wb') as o:
                         o.write(data)
                         o.write(b'\0' * (cia.tmd.save_size - 0x20))
-                        else:
-                            self.log(f'Copying original save file from {sav_enc_path}...')
-                            copy2(sav_out_path, tmp_sav_out_path)
 
                 # generate and write cmd
-                    cmd_enc_path = content_root_cmd + '/cmd/' + cmd_filename
-                    cmd_out_path = join(temp_content_root, 'cmd', cmd_filename)
-                    self.log(f'Generating {cmd_enc_path}')
+                enc_path = content_root_cmd + '/cmd/' + cmd_filename
+                out_path = join(content_root, 'cmd', cmd_filename)
+                self.log(f'Generating {enc_path}')
                 highest_index = 0
                 content_ids = {}
 
@@ -495,9 +334,9 @@ class CustomInstall:
                 final += b''.join(installed_ids)
                 final += b''.join(cmacs)
 
-                    cipher = crypto.create_ctr_cipher(Keyslot.SD, crypto.sd_path_to_iv(cmd_enc_path))
-                    self.log(f'Writing {cmd_enc_path}')
-                    with open(cmd_out_path, 'wb') as o:
+                cipher = crypto.create_ctr_cipher(Keyslot.SD, crypto.sd_path_to_iv(enc_path))
+                self.log(f'Writing {enc_path}')
+                with open(out_path, 'wb') as o:
                     o.write(cipher.encrypt(final))
 
             # this starts building the title info entry
@@ -534,56 +373,43 @@ class CustomInstall:
                 b'\0' * 0x2c
             ]
 
-                if isdir(title_root):
-                    self.log(f'Removing original install at {title_root}...')
-                    rmtree(title_root)
-
-                makedirs(tidhigh_root, exist_ok=True)
-                rename(temp_title_root, title_root)
+            title_info_entries[cia.tmd.title_id] = b''.join(title_info_entry_data)
 
             cifinish_data[int(cia.tmd.title_id, 16)] = {'seed': (get_seed(cia.contents[0].program_id) if cia.contents[0].flags.uses_seed else None)}
 
         # This is saved regardless if any titles were installed, so the file can be upgraded just in case.
         save_cifinish(cifinish_path, cifinish_data)
 
-                with open(join(tempdir, cia.tmd.title_id), 'wb') as o:
-                    o.write(b''.join(title_info_entry_data))
+        if title_info_entries:
+            with TemporaryDirectory(suffix='-custom-install') as tempdir:
+                # set up the common arguments for the two times we call save3ds_fuse
+                save3ds_fuse_common_args = [
+                    join(script_dir, 'bin', platform, 'save3ds_fuse'),
+                    '-b', crypto.b9_path,
+                    '-m', self.movable,
+                    '--sd', self.sd,
+                    '--db', 'sdtitle',
+                    tempdir
+                ]
+
+                # extract the title database to add our own entry to
+                self.log('Extracting Title Database...')
+                subprocess.run(save3ds_fuse_common_args + ['-x'])
+
+                for title_id, entry in title_info_entries.items():
+                    # write the title info entry to the temp directory
+                    with open(join(tempdir, title_id), 'wb') as o:
+                        o.write(entry)
 
                 # import the directory, now including our title
                 self.log('Importing into Title Database...')
-                out = subprocess.run(save3ds_fuse_common_args + ['-i'],
-                                     stdout=subprocess.PIPE,
-                                     stderr=subprocess.STDOUT,
-                                     encoding=getpreferredencoding(),
-                                     **extra_kwargs)
-                if out.returncode:
-                    for l in out.stdout.split('\n'):
-                        self.log(l)
-                    self.log('Command line:')
-                    for l in pformat(out.args).split('\n'):
-                        self.log(l)
-                    install_state['failed'].append(display_title)
+                subprocess.run(save3ds_fuse_common_args + ['-i'])
 
-                install_state['installed'].append(display_title)
-
-            copied = False
-            if install_state['installed']:
-                finalize_3dsx_orig_path = join(script_dir, 'custom-install-finalize.3dsx')
-                hb_dir = join(self.sd, '3ds')
-                finalize_3dsx_path = join(hb_dir, 'custom-install-finalize.3dsx')
-                if isfile(finalize_3dsx_orig_path):
-                    self.log('Copying finalize program to ' + finalize_3dsx_path)
-                    makedirs(hb_dir, exist_ok=True)
-                    copyfile(finalize_3dsx_orig_path, finalize_3dsx_path)
-                    copied = True
-
-                self.log('FINAL STEP:')
-                self.log('Run custom-install-finalize through homebrew launcher.')
+            self.log('FINAL STEP:\nRun custom-install-finalize through homebrew launcher.')
             self.log('This will install a ticket and seed if required.')
-                if copied:
-                    self.log('custom-install-finalize has been copied to the SD card.')
 
-            return install_state, copied
+        else:
+            self.log('Did not install any titles.', 2)
 
     def get_sd_path(self):
         sd_path = join(self.sd, 'Nintendo 3DS', self.crypto.id0.hex())
@@ -628,24 +454,22 @@ class CustomInstall:
 
 
 if __name__ == "__main__":
-    parser = ArgumentParser(description='Install a CIA to the SD card for a Nintendo 3DS system.')
+    parser = ArgumentParser(description='Manually install a CIA to the SD card for a Nintendo 3DS system.')
     parser.add_argument('cia', help='CIA files', nargs='+')
     parser.add_argument('-m', '--movable', help='movable.sed file', required=True)
     parser.add_argument('-b', '--boot9', help='boot9 file')
     parser.add_argument('-s', '--seeddb', help='seeddb file')
     parser.add_argument('--sd', help='path to SD root', required=True)
     parser.add_argument('--skip-contents', help="don't add contents, only add title info entry", action='store_true')
-    parser.add_argument('--overwrite-saves', help='overwrite existing save files', action='store_true')
     parser.add_argument('--cifinish-out', help='path for cifinish.bin file, defaults to (SD root)/cifinish.bin')
 
-    print(f'custom-install {CI_VERSION} - https://github.com/ihaveamac/custom-install')
     args = parser.parse_args()
 
     installer = CustomInstall(boot9=args.boot9,
                               seeddb=args.seeddb,
+                              cias=args.cia,
                               movable=args.movable,
                               sd=args.sd,
-                              overwrite_saves=args.overwrite_saves,
                               cifinish_out=args.cifinish_out,
                               skip_contents=(args.skip_contents or False))
 
@@ -655,26 +479,7 @@ if __name__ == "__main__":
     def percent_handle(total_percent, total_read, size):
         installer.log(f' {total_percent:>5.1f}%  {total_read:>.1f} MiB / {size:.1f} MiB\r', end='')
 
-    def error(exc):
-        for line in format_exception(*exc):
-            for line2 in line.split('\n')[:-1]:
-                installer.log(line2)
-
     installer.event.on_log_msg += log_handle
     installer.event.update_percentage += percent_handle
-    installer.event.on_error += error
 
-    installer.prepare_titles(args.cia)
-
-    if not args.skip_contents:
-        total_size, free_space = installer.check_size()
-        if total_size > free_space:
-            installer.event.on_log_msg(f'Not enough free space.\n'
-                                       f'Combined title install size: {total_size / (1024 * 1024):0.2f} MiB\n'
-                                       f'Free space: {free_space / (1024 * 1024):0.2f} MiB')
-            sys.exit(1)
-
-    result, copied_3dsx = installer.start()
-    if result is False:
-        # save3ds_fuse failed
-        installer.log('NOTE: Once save3ds_fuse is fixed, run the same command again with --skip-contents')
+    installer.start()

extras/windows-quickstart.txt

@@ -1,7 +0,0 @@
-Run ci-gui to bring up the custom-install gui.
-Select your SD card root, boot9, seeddb, and movable.sed files.
-In some cases these will be automatically selected for you.
-
-Add the CIA files and click "Start install".
-
-Once it's finished, start up the homebrew launcher and run custom-install-finalize to finish the process.

finalize/source/main.c

@@ -189,7 +189,6 @@ int load_cifinish(char* path, struct finish_db_entry_final **entries)
 		}
 	}
 
-	fclose(fp);
 	return header.title_count;
 
 fail:
@@ -218,6 +217,9 @@ void finalize_install(void)
 		return;
 	}
 
+	//printf("Deleting %s...\n", CIFINISH_PATH);
+	//unlink(CIFINISH_PATH);
+
 	memcpy(&ticket_buf, basetik_bin, basetik_bin_size);
 
 	for (int i = 0; i < title_count; ++i)
@@ -264,9 +266,6 @@ void finalize_install(void)
 		}
 	}
 
-	printf("Deleting %s...\n", CIFINISH_PATH);
-	unlink(CIFINISH_PATH);
-
 	free(entries);
 }
 
@@ -276,7 +275,7 @@ int main(int argc, char* argv[])
 	gfxInitDefault();
 	consoleInit(GFX_TOP, NULL);
 
-	printf("custom-install-finalize v1.5\n");
+	printf("custom-install-finalize v1.4\n");
 
 	finalize_install();
 	// print this at the end in case it gets pushed off the screen

gui.py

@@ -0,0 +1,438 @@
+# This file is a part of custom-install.py.
+#
+# custom-install is copyright (c) 2019-2020 Ian Burgwin
+# This file is licensed under The MIT License (MIT).
+# You can find the full license text in LICENSE.md in the root of this project.
+
+# A gui for custom-install.py
+# By LyfeOnEdge
+import os, sys, platform, subprocess, threading
+import tkinter as tk
+import tkinter.filedialog as tkfiledialog
+import style
+
+
+class themedFrame(tk.Frame):
+    def __init__(self, frame, **kw):
+        tk.Frame.__init__(self, frame, **kw)
+        if not (kw.get("background") or kw.get("bg")):
+            self.configure(bg=style.BACKGROUND_COLOR)
+        if not kw.get("borderwidth"):
+            self.configure(borderwidth=0)
+        if not kw.get("highlightthickness"):
+            self.configure(highlightthickness=0)
+
+
+class Button(tk.Label):
+    """Cross-platform button"""
+
+    def __init__(self, frame, callback, **kw):
+        self.callback = callback
+        self.background = "#aaaaaa"
+        self.selected = False
+        tk.Label.__init__(self, frame, **kw)
+        self.configure(anchor="center")
+        self.configure(background=self.background)
+        self.configure(highlightthickness=1)
+        if not "font" in kw.keys():
+            self.configure(font=style.BUTTON_FONT)
+        self.configure(highlightbackground="#999999")
+        self.bind('<Button-1>', self.on_click)
+
+    # Use callback when our makeshift "button" clicked
+    def on_click(self, event=None):
+        self.configure(background="#dddddd")
+        if not self.selected:
+            self.after(100, self.on_click_color_change)
+        if self.callback:
+            self.callback()
+
+    # Function to set the button's image
+    def setimage(self, image):
+        self.configure(image=image)
+
+    # Function to set the button's text
+    def settext(self, text):
+        self.configure(text=text)
+
+    def deselect(self):
+        self.selected = False
+        self.configure(background=self.background)
+
+    def on_click_color_change(self):
+        if not self.selected:
+            self.configure(background=self.background)
+
+
+class PathEntry(tk.Entry):
+    """Tkinter entry widget with a button to set the file path using tkinter's file dialog"""
+
+    def __init__(self, frame, dir=False, filetypes=None, *args, **kw):
+        self.dir = dir
+        self.filetypes = filetypes
+        container = themedFrame(frame)
+        self.button = Button(container, self.set_path, text="...")
+        self.button.place(relheight=1, relx=1, x=- style.BUTTONSIZE, width=style.BUTTONSIZE)
+        tk.Entry.__init__(self, container, *args, **kw)
+        self.text_var = tk.StringVar()
+        self.configure(textvariable=self.text_var)
+        self.configure(background=style.ENTRY_COLOR)
+        self.configure(foreground=style.ENTRY_FOREGROUND)
+        self.configure(borderwidth=0)
+        self.configure(highlightthickness=2)
+        self.configure(highlightbackground=style.BUTTON_COLOR)
+        super().place(relwidth=1, relheight=1, width=- style.BUTTONSIZE)
+        self.container = container
+
+    def clear(self):
+        self.text_var.set("")
+
+    def set(self, string):
+        self.text_var.set(string)
+
+    def get_var(self):
+        return self.text_var
+
+    def get(self):
+        return self.text_var.get()
+
+    def place(self, **kw):
+        self.container.place(**kw)
+
+    def set_path(self):
+        if not self.dir:
+            self.set(tkfiledialog.askopenfilename(filetypes=self.filetypes))
+        else:
+            self.set(tkfiledialog.askdirectory())
+
+
+class LabeledPathEntry(PathEntry):
+    """Gives the PathEntry class a label"""
+
+    def __init__(self, frame, text, *args, **kw):
+        self.xtainer = themedFrame(frame)
+        label = tk.Label(self.xtainer, text=text, background=style.BACKGROUND_COLOR, foreground=style.LABEL_COLOR)
+        label.place(width=label.winfo_reqwidth(), relheight=1)
+        PathEntry.__init__(self, self.xtainer, *args, **kw)
+        PathEntry.place(self, relwidth=1, relheight=1, width=- (label.winfo_reqwidth() + 5),
+                        x=label.winfo_reqwidth() + 5)
+
+    def place(self, **kw):
+        self.xtainer.place(**kw)
+
+
+class AutoScroll(object):
+    def __init__(self, master):
+        try:
+            vsb = tk.Scrollbar(master, orient='vertical', command=self.yview)
+        except:
+            pass
+        hsb = tk.Scrollbar(master, orient='horizontal', command=self.xview)
+
+        try:
+            self.configure(yscrollcommand=self._autoscroll(vsb))
+        except:
+            pass
+        self.configure(xscrollcommand=self._autoscroll(hsb))
+
+        self.grid(column=0, row=0, sticky='nsew')
+        try:
+            vsb.grid(column=1, row=0, sticky='ns')
+        except:
+            pass
+        hsb.grid(column=0, row=1, sticky='ew')
+
+        master.grid_columnconfigure(0, weight=1)
+        master.grid_rowconfigure(0, weight=1)
+
+        methods = tk.Pack.__dict__.keys() | tk.Grid.__dict__.keys() \
+                  | tk.Place.__dict__.keys()
+
+        for m in methods:
+            if m[0] != '_' and m not in ('config', 'configure'):
+                setattr(self, m, getattr(master, m))
+
+    @staticmethod
+    def _autoscroll(sbar):
+        '''Hide and show scrollbar as needed.'''
+
+        def wrapped(first, last):
+            first, last = float(first), float(last)
+            if first <= 0 and last >= 1:
+                sbar.grid_remove()
+            else:
+                sbar.grid()
+            sbar.set(first, last)
+
+        return wrapped
+
+    def __str__(self):
+        return str(self.master)
+
+
+def _create_container(func):
+    '''Creates a tk Frame with a given master, and use this new frame to
+    place the scrollbars and the widget.'''
+
+    def wrapped(cls, master, **kw):
+        container = themedFrame(master)
+        container.bind('<Enter>', lambda e: _bound_to_mousewheel(e, container))
+        container.bind(
+            '<Leave>', lambda e: _unbound_to_mousewheel(e, container))
+        return func(cls, container, **kw)
+
+    return wrapped
+
+
+def _bound_to_mousewheel(event, widget):
+    child = widget.winfo_children()[0]
+    if platform.system() == 'Windows' or platform.system() == 'Darwin':
+        child.bind_all('<MouseWheel>', lambda e: _on_mousewheel(e, child))
+        child.bind_all('<Shift-MouseWheel>',
+                       lambda e: _on_shiftmouse(e, child))
+    else:
+        child.bind_all('<Button-4>', lambda e: _on_mousewheel(e, child))
+        child.bind_all('<Button-5>', lambda e: _on_mousewheel(e, child))
+        child.bind_all('<Shift-Button-4>', lambda e: _on_shiftmouse(e, child))
+        child.bind_all('<Shift-Button-5>', lambda e: _on_shiftmouse(e, child))
+
+
+def _unbound_to_mousewheel(event, widget):
+    if platform.system() == 'Windows' or platform.system() == 'Darwin':
+        widget.unbind_all('<MouseWheel>')
+        widget.unbind_all('<Shift-MouseWheel>')
+    else:
+        widget.unbind_all('<Button-4>')
+        widget.unbind_all('<Button-5>')
+        widget.unbind_all('<Shift-Button-4>')
+        widget.unbind_all('<Shift-Button-5>')
+
+
+def _on_mousewheel(event, widget):
+    if platform.system() == 'Windows':
+        widget.yview_scroll(-1 * int(event.delta / 120), 'units')
+    elif platform.system() == 'Darwin':
+        widget.yview_scroll(-1 * int(event.delta), 'units')
+    else:
+        if event.num == 4:
+            widget.yview_scroll(-1, 'units')
+        elif event.num == 5:
+            widget.yview_scroll(1, 'units')
+
+
+class ScrolledText(AutoScroll, tk.Text):
+    @_create_container
+    def __init__(self, master, **kw):
+        tk.Text.__init__(self, master, **kw)
+        AutoScroll.__init__(self, master)
+
+
+# from https://stackoverflow.com/questions/3221956/how-do-i-display-tooltips-in-tkinter
+
+
+class CreateToolTip(object):
+    '''
+    create a tooltip for a given widget
+    '''
+
+    def __init__(self, widget, text='widget info'):
+        self.widget = widget
+        self.text = text
+        self.widget.bind("<Enter>", self.enter)
+        self.widget.bind("<Leave>", self.close)
+
+    def enter(self, event=None):
+        x = y = 0
+        x, y, cx, cy = self.widget.bbox("insert")
+        x += self.widget.winfo_rootx()
+        y += self.widget.winfo_rooty() + 20
+        # creates a toplevel window
+        self.tw = tk.Toplevel(self.widget)
+        # Leaves only the label and removes the app window
+        self.tw.wm_overrideredirect(True)
+        self.tw.wm_geometry("+%d+%d" % (x, y))
+        label = tk.Label(self.tw, text=self.text, justify='left',
+                         background='gray', foreground=style.LABEL_COLOR,
+                         relief='solid', borderwidth=2,
+                         font=("times", "12", "normal"),
+                         wraplength=self.widget.winfo_width())
+        label.pack(ipadx=1)
+
+    def close(self, event=None):
+        if self.tw:
+            self.tw.destroy()
+
+
+class threader_object:
+    """an object to be declared outside of tk root so
+    things can be called asyncronously (you cannot start
+    a new thread from within a tkinter callback so you
+    must call it from an object that exists outside)"""
+
+    def do_async(self, func, arglist=[]):
+        threading.Thread(target=func, args=arglist).start()
+
+
+class gui(tk.Tk):
+    def __init__(self, threader):
+        self.threader = threader
+        tk.Tk.__init__(self)
+        self.minsize(300, 400)
+        self.title("custom-install gui")
+        self.f = themedFrame(self)
+        self.f.place(relwidth=1, relheight=1)
+
+        outer_frame = themedFrame(self.f)
+        outer_frame.place(relwidth=1, relheight=1, x=+ style.STANDARD_OFFSET, width=- 2 * style.STANDARD_OFFSET,
+                          y=+ style.STANDARD_OFFSET, height=- 2 * style.STANDARD_OFFSET)
+
+        self.sd_box = LabeledPathEntry(outer_frame, "Path to SD root -", dir=True)
+        self.sd_box.place(relwidth=1, height=20, x=0)
+        CreateToolTip(self.sd_box.xtainer, "Select the root of the sd card you wish to install the cias to.")
+
+        self.sed_box = LabeledPathEntry(outer_frame, "Path to movable.sed file -", filetypes=[('sed file', '*.sed')])
+        self.sed_box.place(relwidth=1, height=20, x=0, y=30)
+        CreateToolTip(self.sed_box.xtainer, "Select movable.sed file, this can be dumped from a 3ds")
+
+        self.boot9_box = LabeledPathEntry(outer_frame, "Path to boot9 file -", filetypes=[('boot9 file', '*.bin')])
+        self.boot9_box.place(relwidth=1, height=20, x=0, y=60)
+        CreateToolTip(self.boot9_box.xtainer, "Select the path to boot9.bin, this can be dumped from a 3ds")
+
+        self.seeddb_box = LabeledPathEntry(outer_frame, "Path to seeddb file -", filetypes=[('seeddb file', '*.bin')])
+        self.seeddb_box.place(relwidth=1, height=20, x=0, y=90)
+        CreateToolTip(self.seeddb_box.xtainer, "Select the path to seeddb.bin, this can retrieved from online")
+
+        # -------------------------------------------------
+        cia_container = themedFrame(outer_frame, borderwidth=0, highlightthickness=0)
+        cia_container.place(y=120, relwidth=1, height=190)
+
+        cia_label = tk.Label(cia_container, text="cia paths - ", foreground=style.LABEL_COLOR,
+                             background=style.BACKGROUND_COLOR)
+        cia_label.place(relwidth=1, height=20)
+        self.cia_box = tk.Listbox(cia_container, highlightthickness=0, bg=style.ENTRY_COLOR,
+                                  foreground=style.ENTRY_FOREGROUND)
+        self.cia_box.place(relwidth=1, height=70, y=20)
+        CreateToolTip(cia_label,
+                      "Select the cias you wish to install to the sd card. The `add folder` button will add all cias in the selected folder, but will not check subdirs. The `remove cia` button will remove the currently selected file from the listbox.")
+
+        add_cia_button = Button(cia_container, self.add_cia, text="add cia", font=style.monospace)
+        add_cia_button.place(relx=0, relwidth=0.333, height=20, y=95, width=- 6)
+
+        add_cia_folder_button = Button(cia_container, self.add_cia_folder, text="add folder", font=style.monospace)
+        add_cia_folder_button.place(relx=0.333, relwidth=0.333, height=20, y=95, x=+ 3, width=- 6)
+
+        remove_cia_button = Button(cia_container, self.remove_cia, text="remove cia", font=style.monospace)
+        remove_cia_button.place(relx=0.666, relwidth=0.333, height=20, y=95, x=+ 6, width=- 6)
+        # -------------------------------------------------
+
+        self.skip_contents = tk.IntVar()
+        skip_contents_checkbutton = tk.Checkbutton(outer_frame, text="Skip contents? (only add title info)",
+                                                   variable=self.skip_contents, background=style.BACKGROUND_COLOR,
+                                                   foreground=style.LABEL_COLOR, borderwidth=0, highlightthickness=0)
+        skip_contents_checkbutton.place(relwidth=1, y=239, height=20)
+
+        console_label = tk.Label(outer_frame, text="Console:", background="black", foreground="white",
+                                 font=style.boldmonospace, borderwidth=0, highlightthickness=0)
+        console_label.place(relwidth=1, height=20, y=260)
+        self.console = ScrolledText(outer_frame, background="black", foreground="white", highlightthickness=0)
+        self.console.place(relwidth=1, relheight=1, y=280, height=- 272)
+        run_button = Button(outer_frame, self.run, text="run", font=style.boldmonospace)
+        run_button.place(relwidth=1, rely=1, y=- 22)
+
+    def run(self):
+        args_extra = []
+
+        self.output_to_console("-----------------------\nStarting...\n")
+
+        boot9 = self.boot9_box.get()
+        if not boot9:
+            self.output_to_console(
+                "Warning - boot9 not selected, if it's not set externally you may run into problems.\n")
+        else:
+            args_extra.extend(['-b', boot9])
+
+        sed = self.sed_box.get()
+        if not sed:
+            self.output_to_console("Failed to run - No movable.sed selected.\n")
+            return
+        args_extra.extend(['-m', sed])
+
+        sd = self.sd_box.get().strip()
+        if not sd:
+            self.output_to_console("Failed to run - SD path not selected.\n")
+            return
+        args_extra.extend(['--sd', sd])
+
+        seed = self.seeddb_box.get().strip()
+        if not seed:
+            self.output_to_console("Optional Seeddb not given - Certain CIAs May Require This!\n")
+        args_extra.extend(['--seeddb', seed])
+
+        cias = []
+        for i in range(0, self.cia_box.size()):
+            cias.append(self.cia_box.get(i).strip())
+        for cia in cias:
+            args_extra.append(cia)
+
+        if self.skip_contents.get():
+            args_extra.append('--skip-contents')
+
+        print(f"Running custom-install.py with args {args_extra}\n")
+
+        self.threader.do_async(execute_script, [args_extra, self.output_to_console])
+
+    def output_to_console(self, outstring):
+        self.console.insert('end', outstring)
+        self.console.see('end')
+
+    def add_cia(self):
+        cia_to_add = tkfiledialog.askopenfilename(filetypes=[('cia file', '*.cia')])
+        if cia_to_add:
+            self.cia_box.insert('end', cia_to_add)
+
+    def add_cia_folder(self):
+        cia_dir_to_add = tkfiledialog.askdirectory()
+        if cia_dir_to_add:
+            cias_to_add = [f for f in os.listdir(cia_dir_to_add) if
+                           (os.path.isfile(os.path.join(cia_dir_to_add, f)) and f.endswith(".cia"))]
+            if cias_to_add:
+                for cia_to_add in cias_to_add:
+                    self.cia_box.insert('end', os.path.join(cia_dir_to_add, cia_to_add))
+
+    def remove_cia(self):
+        index = self.cia_box.curselection()
+        if index:
+            self.cia_box.delete(index)
+            if self.cia_box.size():
+                self.cia_box.select_clear(0, 'end')
+                if self.cia_box.size() > 1:
+                    try:
+                        self.cia_box.select_set(index)
+                    except:
+                        pass
+                else:
+                    self.cia_box.select_set(0)
+
+
+def execute_script(args_extra, printer):
+    """Wrapper function to pipe install script output to a printer"""
+    args = [sys.executable, '-u', os.path.join(os.path.dirname(__file__), "custominstall.py")]
+    try:
+        args.extend(args_extra)
+        p = subprocess.Popen(args,
+                             stdout=subprocess.PIPE,
+                             stderr=subprocess.STDOUT,
+                             bufsize=1,
+                             )
+
+        with p.stdout:
+            for line in iter(p.stdout.readline, b''):
+                printer(line)
+        p.wait()
+    except Exception as e:
+        printer(f"Error while executing script with args - {args} | Exception - {e}\n")
+
+
+t = threader_object()
+window = gui(t)
+window.mainloop()

make-standalone.bat

@@ -1,11 +0,0 @@
-mkdir build
-mkdir dist
-cxfreeze ci-gui.py --target-dir=build\custom-install-standalone --base-name=Win32GUI
-mkdir build\custom-install-standalone\bin
-copy TaskbarLib.tlb build\custom-install-standalone
-copy bin\win32\save3ds_fuse.exe build\custom-install-standalone\bin
-copy bin\README build\custom-install-standalone\bin
-copy custom-install-finalize.3dsx build\custom-install-standalone
-copy extras\windows-quickstart.txt build\custom-install-standalone
-copy LICENSE.md build\custom-install-standalone
-python -m zipfile -c dist\custom-install-standalone.zip build\custom-install-standalone

requirements-win32.txt

@@ -1,2 +0,0 @@
--r requirements.txt
-comtypes==1.1.7

requirements.txt

@@ -1,2 +1,3 @@
-events==0.4
-pyctr==0.4.5
+pycryptodomex<=3.9.4
+events==0.3
+pyctr==0.4.1

style.py

@@ -0,0 +1,18 @@
+STANDARD_OFFSET = 10 #Offset to place everything
+BUTTONSIZE = 30
+
+
+monospace = ("Monospace",10)
+boldmonospace = ("Monospace",10,"bold")
+
+BUTTON_FONT = monospace
+
+BACKGROUND_COLOR = "#20232a"
+BUTTON_COLOR = "#aaaaaa"
+ENTRY_COLOR = "#373940"
+ENTRY_FOREGROUND = "black"
+
+LABEL_COLOR = "#61dafb"
+
+
+

windows-install-dependencies.py

@@ -1,13 +0,0 @@
-# This is meant to be double-clicked from File Explorer.
-
-# This doesn't import pip as a module in case the way it's executed changes, which it has in the past.
-# Instead we call it like we would in the command line.
-
-from subprocess import run
-from os.path import dirname, join
-from sys import executable
-
-root_dir = dirname(__file__)
-
-run([executable, '-m', 'pip', 'install', '--user', '-r', join(root_dir, 'requirements-win32.txt')])
-input('Press enter to close')