def get_mod_edits(self, params=None):
mod = BcmlMod.from_json(params["mod"])
edits = {}
merger_list = sorted({m() for m in mergers.get_mergers()}, key=lambda m: m.NAME)
for merger in merger_list:
edits[merger.friendly_name] = merger.get_mod_edit_info(mod)
return {key: sorted({str(v) for v in value}) for key, value in edits.items()}
def update_mod(self, params):
try:
update_file = self.file_pick({"multiple": False})[0]
except IndexError:
return
mod = BcmlMod.from_json(params["mod"])
if (mod.path / "options.json").exists():
options = json.loads((mod.path / "options.json").read_text(),
encoding="utf-8")
else:
options = {}
remergers = mergers.get_mergers_for_mod(mod)
rmtree(mod.path)
with Pool(maxtasksperchild=1000) as pool:
new_mod = install.install_mod(
Path(update_file),
insert_priority=mod.priority,
options=options,
pool=pool,
)
remergers |= {
m
for m in mergers.get_mergers_for_mod(new_mod)
if m.NAME not in {m.NAME
for m in remergers}
}
try:
install.refresh_merges()
except Exception: # pylint: disable=broad-except
pool.terminate()
raise
def reprocess(self, params):
mod = BcmlMod.from_json(params["mod"])
rmtree(mod.path / "logs")
if (mod.path / "options.json").exists():
options = json.loads((mod.path / "options.json").read_text())
else:
options = {}
install.generate_logs(mod.path, options)
def mod_action(self, params):
mod = BcmlMod.from_json(params["mod"])
action = params["action"]
if action == "enable":
install.enable_mod(mod)
elif action == "disable":
install.disable_mod(mod)
elif action == "uninstall":
install.uninstall_mod(mod)
elif action == "update":
self.update_mod(params)
elif action == "reprocess":
self.reprocess(params)
def uninstall_mod(mod: Union[Path, BcmlMod, str],
wait_merge: bool = False,
verbose: bool = False):
"""
Uninstalls the mod currently installed at the specified path and updates merges as needed
:param mod: The mod to remove, as a path or a BcmlMod.
:param wait_merge: Resort mods but don't remerge anything yet, defaults to False.
:type wait_merge: bool, optional
:param verbose: Whether to display more detailed output, defaults to False.
:type verbose: bool, optional
"""
path = Path(mod) if isinstance(
mod, str) else mod.path if isinstance(mod, BcmlMod) else mod
mod_name, mod_priority, _ = util.get_mod_info(path / 'rules.txt') \
if not isinstance(mod, BcmlMod) else mod
print(f'Uninstalling {mod_name}...')
remergers = set()
partials = {}
for merger in [merger() for merger in mergers.get_mergers()]:
if merger.is_mod_logged(BcmlMod(mod_name, mod_priority, path)):
remergers.add(merger)
if merger.can_partial_remerge():
partials[merger.NAME] = merger.get_mod_affected(mod)
shutil.rmtree(str(path))
next_mod = util.get_mod_by_priority(mod_priority + 1)
if next_mod:
print('Adjusting mod priorities...')
change_mod_priority(next_mod,
mod_priority,
wait_merge=True,
verbose=verbose)
print()
if not wait_merge:
pool = Pool(cpu_count())
for merger in mergers.sort_mergers(remergers):
merger.set_pool(pool)
if merger.NAME in partials:
merger.set_options({'only_these': partials[merger.NAME]})
merger.perform_merge()
pool.close()
pool.join()
print(f'{mod_name} has been uninstalled.')
def update_mod(self, params):
try:
update_file = self.file_pick({"multiple": False})[0]
except IndexError:
return
mod = BcmlMod.from_json(params["mod"])
if (mod.path / "options.json").exists():
options = json.loads((mod.path / "options.json").read_text())
else:
options = {}
rmtree(mod.path)
with Pool(maxtasksperchild=500) as pool:
new_mod = install.install_mod(
Path(update_file),
insert_priority=mod.priority,
options=options,
pool=pool,
)
def get_mod_info(self, params):
mod = BcmlMod.from_json(params["mod"])
util.vprint(mod)
img = ""
try:
img = base64.b64encode(mod.get_preview().read_bytes()).decode("utf8")
except: # pylint: disable=bare-except
pass
return {
"changes": [
m.NAME.upper() for m in mergers.get_mergers() if m().is_mod_logged(mod)
],
"desc": mod.description,
"date": mod.date,
"processed": (mod.path / ".processed").exists(),
"image": img,
"url": mod.url,
}
def apply_queue(self, params):
mods = []
for move_mod in params["moves"]:
mod = BcmlMod.from_json(move_mod["mod"])
mods.append(mod)
mod.change_priority(move_mod["priority"])
with Pool(maxtasksperchild=500) as pool:
for i in params["installs"]:
print(i)
mods.append(
install.install_mod(
Path(i["path"].replace("QUEUE", "")),
options=i["options"],
insert_priority=i["priority"],
pool=pool,
))
try:
install.refresh_merges()
except Exception: # pylint: disable=broad-except
pool.terminate()
raise
install.refresh_master_export()
def perform_merge_2(self):
print('Perfoming RSTB merge...')
log_merged_files_rstb()
master_diffs = [
*self.get_all_diffs(),
self.get_mod_diff(BcmlMod('Master BCML', 9999, util.get_master_modpack_dir()))
]
diffs = self.consolidate_diffs(master_diffs)
new_rstb = get_stock_rstb()
counts = {
'add': 0,
'update': 0,
'del': 0
}
for file, size in diffs.items():
if size > 0:
if new_rstb.is_in_table(file):
counts['update'] += 1
else:
counts['add'] += 1
new_rstb.set_size(file, size)
else:
if new_rstb.is_in_table(file):
new_rstb.delete_entry(file)
counts['del'] += 1
rstb_path = util.get_master_modpack_dir() / 'content' / 'System' / 'Resource' /\
'ResourceSizeTable.product.srsizetable'
if not rstb_path.exists():
rstb_path.parent.mkdir(parents=True, exist_ok=True)
buf = io.BytesIO()
new_rstb.write(buf, be=True)
rstb_path.write_bytes(util.compress(buf.getvalue()))
print(
f'RSTB merge complete: updated {counts["update"]} entries, '
f'added {counts["add"]} entries, deleted {counts["del"]} entries'
)
def install_mod(
mod: Path,
options: dict = None,
selects: dict = None,
pool: Optional[multiprocessing.pool.Pool] = None,
insert_priority: int = 0,
merge_now: bool = False,
updated: bool = False,
):
if not insert_priority:
insert_priority = get_next_priority()
try:
if isinstance(mod, str):
mod = Path(mod)
if mod.is_file():
print("Opening mod...")
tmp_dir = open_mod(mod)
elif mod.is_dir():
if not ((mod / "rules.txt").exists() or
(mod / "info.json").exists()):
print(
f"Cannot open mod at {str(mod)}, no rules.txt or info.json found"
)
return
print(f"Loading mod from {str(mod)}...")
tmp_dir = Path(mkdtemp())
if tmp_dir.exists():
shutil.rmtree(tmp_dir)
shutil.copytree(str(mod), str(tmp_dir))
if (mod /
"rules.txt").exists() and not (mod / "info.json").exists():
print("Upgrading old mod format...")
upgrade.convert_old_mod(mod, delete_old=True)
else:
print(f"Error: {str(mod)} is neither a valid file nor a directory")
return
except Exception as err: # pylint: disable=broad-except
raise util.InstallError(err) from err
if not options:
options = {"options": {}, "disable": []}
this_pool: Optional[multiprocessing.pool.Pool] = None # type: ignore
try:
rules = json.loads((tmp_dir / "info.json").read_text("utf-8"))
mod_name = rules["name"].strip(" '\"").replace("_", "")
print(f"Identified mod: {mod_name}")
if rules["depends"]:
try:
installed_metas = {
v[0]: v[1]
for m in util.get_installed_mods()
for v in util.BcmlMod.meta_from_id(m.id)
}
except (IndexError, TypeError) as err:
raise RuntimeError(
f"This BNP has invalid or corrupt dependency data.")
for depend in rules["depends"]:
depend_name, depend_version = util.BcmlMod.meta_from_id(depend)
if (depend_name not in installed_metas) or (
depend_name in installed_metas
and depend_version > installed_metas[depend_name]):
raise RuntimeError(
f"{mod_name} requires {depend_name} version {depend_version}, "
f"but it is not installed. Please install {depend_name} and "
"try again.")
friendly_plaform = lambda p: "Wii U" if p == "wiiu" else "Switch"
user_platform = "wiiu" if util.get_settings("wiiu") else "switch"
if rules["platform"] != user_platform:
raise ValueError(
f'"{mod_name}" is for {friendly_plaform(rules["platform"])}, not '
f" {friendly_plaform(user_platform)}.'")
if "priority" in rules and rules["priority"] == "base":
insert_priority = 100
logs = tmp_dir / "logs"
if logs.exists():
print("Loading mod logs...")
for merger in [
merger() # type: ignore
for merger in mergers.get_mergers()
if merger.NAME in options["disable"]
]:
if merger.is_mod_logged(BcmlMod(tmp_dir)):
(tmp_dir / "logs" / merger.log_name).unlink()
else:
this_pool = pool or Pool(maxtasksperchild=500)
dev._pack_sarcs(tmp_dir,
util.get_hash_table(util.get_settings("wiiu")),
this_pool)
generate_logs(tmp_dir=tmp_dir, options=options, pool=this_pool)
if not util.get_settings("strip_gfx"):
(tmp_dir / ".processed").touch()
except Exception as err: # pylint: disable=broad-except
try:
name = mod_name
except NameError:
name = "your mod, the name of which could not be detected"
raise util.InstallError(err, name) from err
if selects:
for opt_dir in {
d
for d in (tmp_dir / "options").glob("*") if d.is_dir()
}:
if opt_dir.name not in selects:
shutil.rmtree(opt_dir, ignore_errors=True)
else:
file: Path
for file in {
f
for f in opt_dir.rglob("**/*")
if ("logs" not in f.parts and f.is_file())
}:
out = tmp_dir / file.relative_to(opt_dir)
out.parent.mkdir(parents=True, exist_ok=True)
try:
os.link(file, out)
except FileExistsError:
if file.suffix in util.SARC_EXTS:
try:
old_sarc = oead.Sarc(
util.unyaz_if_needed(out.read_bytes()))
except (ValueError, oead.InvalidDataError,
RuntimeError):
out.unlink()
os.link(file, out)
try:
link_sarc = oead.Sarc(
util.unyaz_if_needed(file.read_bytes()))
except (ValueError, oead.InvalidDataError,
RuntimeError):
del old_sarc
continue
new_sarc = oead.SarcWriter.from_sarc(link_sarc)
link_files = {
f.name
for f in link_sarc.get_files()
}
for sarc_file in old_sarc.get_files():
if sarc_file.name not in link_files:
new_sarc.files[sarc_file.name] = bytes(
sarc_file.data)
del old_sarc
del link_sarc
out.write_bytes(new_sarc.write()[1])
del new_sarc
else:
out.unlink()
os.link(file, out)
rstb_path = (tmp_dir / util.get_content_path() / "System" / "Resource" /
"ResourceSizeTable.product.srsizetable")
if rstb_path.exists():
rstb_path.unlink()
priority = insert_priority
print(f"Assigned mod priority of {priority}")
mod_id = util.get_mod_id(mod_name, priority)
mod_dir = util.get_modpack_dir() / mod_id
try:
if not updated:
for existing_mod in util.get_installed_mods(True):
if existing_mod.priority >= priority:
existing_mod.change_priority(existing_mod.priority + 1)
if (tmp_dir / "patches").exists() and not util.get_settings("no_cemu"):
patch_dir = (util.get_cemu_dir() / "graphicPacks" /
f"bcmlPatches" /
util.get_safe_pathname(rules["name"]))
patch_dir.mkdir(parents=True, exist_ok=True)
for file in {
f
for f in (tmp_dir / "patches").rglob("*") if f.is_file()
}:
out = patch_dir / file.relative_to(tmp_dir / "patches")
out.parent.mkdir(parents=True, exist_ok=True)
shutil.copyfile(file, out)
mod_dir.parent.mkdir(parents=True, exist_ok=True)
print(f"Moving mod to {str(mod_dir)}...")
if mod.is_file():
try:
shutil.move(str(tmp_dir), str(mod_dir))
except Exception: # pylint: disable=broad-except
try:
shutil.rmtree(str(mod_dir))
shutil.copytree(str(tmp_dir), str(mod_dir))
shutil.rmtree(str(tmp_dir), ignore_errors=True)
except Exception: # pylint: disable=broad-except
raise OSError(
"BCML could not transfer your mod from the temp directory to the"
" BCML directory.")
elif mod.is_dir():
shutil.copytree(str(tmp_dir), str(mod_dir))
shutil.rmtree(tmp_dir, ignore_errors=True)
rules["priority"] = priority
(mod_dir / "info.json").write_text(json.dumps(rules,
ensure_ascii=False,
indent=2),
encoding="utf-8")
(mod_dir / "options.json").write_text(json.dumps(options,
ensure_ascii=False,
indent=2),
encoding="utf-8")
output_mod = BcmlMod(mod_dir)
try:
util.get_mod_link_meta(rules)
util.get_mod_preview(output_mod)
except Exception: # pylint: disable=broad-except
pass
except Exception as err: # pylint: disable=broad-except
if mod_dir.exists():
try:
uninstall_mod(mod_dir, wait_merge=True)
except Exception: # pylint: disable=broad-except
shutil.rmtree(str(mod_dir))
raise util.InstallError(err, mod_name) from err
try:
if merge_now:
for merger in [m() for m in mergers.get_mergers()]:
if this_pool or pool:
merger.set_pool(this_pool or pool)
if merger.NAME in options["options"]:
merger.set_options(options["options"][merger.NAME])
merger.perform_merge()
except Exception as err: # pylint: disable=broad-except
raise util.MergeError(err) from err
if this_pool and not pool:
this_pool.close()
this_pool.join()
return output_mod
def change_mod_priority(path: Path,
new_priority: int,
wait_merge: bool = False,
verbose: bool = False):
"""
Changes the priority of a mod
:param path: The path to the mod.
:type path: class:`pathlib.Path`
:param new_priority: The new priority of the mod.
:type new_priority: int
:param wait_merge: Resort priorities but don't remerge anything yet, defaults to False.
:type wait_merge: bool, optional
:param verbose: Whether to display more detailed output, defaults to False.
:type verbose: bool, optional
"""
mod = util.get_mod_info(path / 'rules.txt')
print(
f'Changing priority of {mod.name} from {mod.priority} to {new_priority}...'
)
mods = util.get_installed_mods()
if new_priority > mods[len(mods) - 1][1]:
new_priority = len(mods) - 1
mods.remove(mod)
mods.insert(new_priority - 100, util.BcmlMod(mod.name, new_priority, path))
all_mergers = [merger() for merger in mergers.get_mergers()]
remergers = set()
partials = {}
for merger in all_mergers:
if merger.is_mod_logged(mod):
remergers.add(merger)
if merger.can_partial_remerge():
partials[merger.NAME] = set(merger.get_mod_affected(mod))
print('Resorting other affected mods...')
for mod in mods:
if mod.priority != (mods.index(mod) + 100):
adjusted_priority = mods.index(mod) + 100
mods.remove(mod)
mods.insert(adjusted_priority - 100,
BcmlMod(mod.name, adjusted_priority, mod.path))
if verbose:
print(f'Changing priority of {mod.name} from'
f'{mod.priority} to {adjusted_priority}...')
for mod in mods:
if not mod.path.stem.startswith(f'{mod.priority:04}'):
for merger in all_mergers:
if merger.is_mod_logged(mod):
remergers.add(merger)
if merger.can_partial_remerge():
if merger.NAME not in partials:
partials[merger.NAME] = set()
partials[merger.NAME] |= set(
merger.get_mod_affected(mod))
new_mod_id = util.get_mod_id(mod[0], mod[1])
shutil.move(str(mod[2]), str(mod[2].parent / new_mod_id))
rules = util.RulesParser()
rules.read(str(mod.path.parent / new_mod_id / 'rules.txt'))
rules['Definition']['fsPriority'] = str(mod[1])
with (mod[2].parent / new_mod_id / 'rules.txt').open(
'w', encoding='utf-8') as r_file:
rules.write(r_file)
refresh_cemu_mods()
if not wait_merge:
for merger in mergers.sort_mergers(remergers):
if merger.NAME in partials:
merger.set_options({'only_these': partials[merger.NAME]})
merger.perform_merge()
if wait_merge:
print('Mods resorted, will need to remerge later')
print('Finished updating mod priorities.')
def install_mod(mod: Path,
verbose: bool = False,
options: dict = None,
wait_merge: bool = False,
insert_priority: int = 0):
"""
Installs a graphic pack mod, merging RSTB changes and optionally packs and texts
:param mod: Path to the mod to install. Must be a RAR, 7z, or ZIP archive or a graphicpack
directory containing a rules.txt file.
:type mod: class:`pathlib.Path`
:param verbose: Whether to display more detailed output, defaults to False.
:type verbose: bool, optional
:param wait_merge: Install mod and log changes, but wait to run merge manually,
defaults to False.
:type wait_merge: bool, optional
:param insert_priority: Insert mod(s) at priority specified, defaults to get_next_priority().
:type insert_priority: int
"""
if insert_priority == 0:
insert_priority = get_next_priority()
util.create_bcml_graphicpack_if_needed()
if isinstance(mod, str):
mod = Path(mod)
if mod.is_file():
print('Extracting mod...')
tmp_dir = open_mod(mod)
elif mod.is_dir():
if (mod / 'rules.txt').exists():
print(f'Loading mod from {str(mod)}...')
tmp_dir = util.get_work_dir() / f'tmp_{mod.name}'
shutil.copytree(str(mod), str(tmp_dir))
else:
print(f'Cannot open mod at {str(mod)}, no rules.txt found')
return
else:
print(f'Error: {str(mod)} is neither a valid file nor a directory')
return
pool: Pool = None
try:
rules = util.RulesParser()
rules.read(tmp_dir / 'rules.txt')
mod_name = str(rules['Definition']['name']).strip(' "\'')
print(f'Identified mod: {mod_name}')
logs = tmp_dir / 'logs'
if logs.exists():
print('This mod supports Quick Install! Loading changes...')
for merger in [merger() for merger in mergers.get_mergers() \
if merger.NAME in options['disable']]:
if merger.is_mod_logged(BcmlMod('', 0, tmp_dir)):
(tmp_dir / 'logs' / merger.log_name()).unlink()
else:
pool = Pool(cpu_count())
generate_logs(tmp_dir=tmp_dir,
verbose=verbose,
options=options,
original_pool=pool)
except Exception as e: # pylint: disable=broad-except
if hasattr(e, 'error_text'):
raise e
clean_error = RuntimeError()
try:
name = mod_name
except NameError:
name = 'your mod, the name of which could not be detected'
clean_error.error_text = (
f'There was an error while processing {name}. '
'This could indicate there is a problem with the mod itself, '
'but it could also reflect a new or unusual edge case BCML does '
'not anticipate. Here is the error:\n\n'
f'{traceback.format_exc(limit=-4)}')
raise clean_error
priority = insert_priority
print(f'Assigned mod priority of {priority}')
mod_id = util.get_mod_id(mod_name, priority)
mod_dir = util.get_modpack_dir() / mod_id
try:
for existing_mod in util.get_installed_mods():
if existing_mod.priority >= priority:
priority_shifted = existing_mod.priority + 1
new_id = util.get_mod_id(existing_mod.name, priority_shifted)
new_path = util.get_modpack_dir() / new_id
shutil.move(str(existing_mod.path), str(new_path))
existing_mod_rules = util.RulesParser()
existing_mod_rules.read(str(new_path / 'rules.txt'))
existing_mod_rules['Definition']['fsPriority'] = str(
priority_shifted)
with (new_path / 'rules.txt').open('w',
encoding='utf-8') as r_file:
existing_mod_rules.write(r_file)
mod_dir.parent.mkdir(parents=True, exist_ok=True)
print()
print(f'Moving mod to {str(mod_dir)}...')
if mod.is_file():
try:
shutil.move(str(tmp_dir), str(mod_dir))
except Exception: # pylint: disable=broad-except
try:
shutil.copytree(str(tmp_dir), str(mod_dir))
try:
shutil.rmtree(str(tmp_dir))
except Exception: # pylint: disable=broad-except
pass
except Exception: # pylint: disable=broad-except
raise OSError(
'BCML could not transfer your mod from the temp directory '
'to the BCML directory.')
elif mod.is_dir():
shutil.copytree(str(tmp_dir), str(mod_dir))
rulepath = os.path.basename(rules['Definition']['path']).replace(
'"', '')
rules['Definition']['path'] = f'{{BCML: DON\'T TOUCH}}/{rulepath}'
rules['Definition']['fsPriority'] = str(priority)
with Path(mod_dir / 'rules.txt').open('w', encoding='utf-8') as r_file:
rules.write(r_file)
output_mod = BcmlMod(mod_name, priority, mod_dir)
try:
util.get_mod_link_meta(rules)
util.get_mod_preview(output_mod, rules)
except Exception: # pylint: disable=broad-except
pass
print(f'Enabling {mod_name} in Cemu...')
refresh_cemu_mods()
except Exception: # pylint: disable=broad-except
clean_error = RuntimeError()
clean_error.error_text = (
f'There was an error installing {mod_name}. '
'It processed successfully, but could not be added to your BCML '
'mods. This may indicate a problem with your BCML installation. '
'Here is the error:\n\n'
f'{traceback.format_exc(limit=-4)}\n\n'
f'{mod_name} is being removed and no changes will be made.')
if mod_dir.exists():
try:
uninstall_mod(mod_dir, wait_merge=True)
except Exception: # pylint: disable=broad-except
shutil.rmtree(str(mod_dir))
raise clean_error
if wait_merge:
print('Mod installed, merge still pending...')
else:
try:
if not pool:
pool = Pool(cpu_count)
print('Performing merges...')
if not options:
options = {}
if 'disable' not in options:
options['disable'] = []
for merger in mergers.sort_mergers([cls() for cls in mergers.get_mergers() \
if cls.NAME not in options['disable']]):
merger.set_pool(pool)
if merger.NAME in options:
merger.set_options(options[merger.NAME])
if merger.is_mod_logged(output_mod):
merger.perform_merge()
print()
print(f'{mod_name} installed successfully!')
pool.close()
pool.join()
except Exception: # pylint: disable=broad-except
clean_error = RuntimeError()
clean_error.error_text = (
f'There was an error merging {mod_name}. '
'It processed and installed without error, but it has not '
'successfully merged with your other mods. '
'Here is the error:\n\n'
f'{traceback.format_exc(limit=-4)}\n\n'
f'To protect your mod setup, BCML will remove {mod_name} '
'and remerge.')
try:
uninstall_mod(mod_dir)
except FileNotFoundError:
pass
raise clean_error
return output_mod