1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
import functools
import os
import platform
from pathlib import Path
from typing import Callable, Optional
from PyQt6.QtCore import QDir, qDebug, qInfo, qWarning
from PyQt6.QtWidgets import QApplication
import mobase
from . import bg3_utils
_IS_LINUX = platform.system() != "Windows"
# Top-level subdirectories of MO2's overwrite that should be redirected into
# the game's Documents folder. Each is published as a single directory
# mapping so the parent symlink covers everything underneath — recursing
# into overwrite/ produces nested mappings whose destinations resolve back
# through the parent symlink to the source, corrupting the tree into
# self-pointing symlinks on the next launch.
_OVERWRITE_REDIRECTED_DIRS = (
"Script Extender",
"Stats",
"Temp",
"LevelCache",
"Mods",
"GMCampaigns",
)
class BG3FileMapper(mobase.IPluginFileMapper):
current_mappings: list[mobase.Mapping] = []
_linux_symlinks: list[Path] = []
def __init__(self, utils: bg3_utils.BG3Utils, doc_dir: Callable[[], QDir]):
super().__init__()
self._utils = utils
self.doc_dir = doc_dir
@functools.cached_property
def doc_path(self):
return Path(self.doc_dir().path())
def mappings(self) -> list[mobase.Mapping]:
qInfo("creating custom bg3 mappings")
self.current_mappings.clear()
if _IS_LINUX:
self._cleanup_linux_symlinks()
active_mods = self._utils.active_mods()
if not active_mods:
return []
progress = self._utils.create_progress_window(
"Mapping files to documents folder", len(active_mods) + 1
)
docs_path_mods = self.doc_path / "Mods"
docs_path_se = self.doc_path / "Script Extender"
for mod in active_mods:
modpath = Path(mod.absolutePath())
self.map_files(modpath, dest=docs_path_mods, pattern="*.pak", rel=False)
self.map_files(modpath / "Script Extender", dest=docs_path_se)
if self._utils.convert_yamls_to_json:
self.map_files(modpath / "bin", only_convert=True)
progress.setValue(progress.value() + 1)
QApplication.processEvents()
if progress.wasCanceled():
qWarning("mapping canceled by user")
return self.current_mappings
for name in _OVERWRITE_REDIRECTED_DIRS:
src = self._utils.overwrite_path / name
src.mkdir(parents=True, exist_ok=True)
self.current_mappings.append(
mobase.Mapping(
source=str(src),
destination=str(self.doc_path / name),
is_directory=True,
create_target=True,
)
)
self.create_mapping(
self._utils.modsettings_path,
self.doc_path
/ "PlayerProfiles"
/ "Public"
/ self._utils.modsettings_path.name,
)
progress.setValue(len(active_mods) + 1)
QApplication.processEvents()
progress.close()
return self.current_mappings
def map_files(
self,
path: Path,
dest: Optional[Path] = None,
pattern: str = "*",
rel: bool = True,
only_convert: bool = False,
):
dest = dest if dest else self.doc_path
dest_func: Callable[[Path], str] = (
(lambda f: os.path.relpath(f, path)) if rel else lambda f: f.name
)
found_jsons: set[Path] = set()
for file in list(path.rglob(pattern)):
if self._utils.convert_yamls_to_json and (
file.name.endswith(".yaml") or file.name.endswith(".yml")
):
converted_path = file.parent / file.name.replace(
".yaml", ".json"
).replace(".yml", ".json")
try:
if not converted_path.exists() or os.path.getmtime(
file
) > os.path.getmtime(converted_path):
import json
import yaml
with open(file, "r") as yaml_file:
with open(converted_path, "w") as json_file:
json.dump(
yaml.safe_load(yaml_file), json_file, indent=2
)
qDebug(f"Converted {file} to JSON")
found_jsons.add(converted_path)
except OSError as e:
qWarning(f"Error accessing file {converted_path}: {e}")
elif file.name.endswith(".json"):
found_jsons.add(file)
elif not only_convert:
self.create_mapping(file, dest / dest_func(file))
if only_convert:
return
for file in found_jsons:
self.create_mapping(file, dest / dest_func(file))
def create_mapping(self, file: Path, dest: Path):
bg3_utils.create_dir_if_needed(dest)
# On Linux, FUSE cannot handle file mappings outside the game's data
# directory. Create real symlinks so the game (via Proton) can find
# mod files in the documents/prefix directory.
if _IS_LINUX and not file.is_dir():
try:
if dest.is_symlink() or dest.exists():
dest.unlink()
dest.symlink_to(file)
self._linux_symlinks.append(dest)
except OSError as e:
qWarning(f"BG3: failed to symlink {dest} -> {file}: {e}")
self.current_mappings.append(
mobase.Mapping(
source=str(file),
destination=str(dest),
is_directory=file.is_dir(),
create_target=True,
)
)
def _cleanup_linux_symlinks(self):
"""Remove symlinks created by previous mappings() calls."""
for link in self._linux_symlinks:
try:
if link.is_symlink():
link.unlink()
except OSError:
pass
self._linux_symlinks.clear()
def cleanup(self):
"""Public cleanup method — call from onFinishedRun."""
if _IS_LINUX:
self._cleanup_linux_symlinks()
|
