-
Notifications
You must be signed in to change notification settings - Fork 0
/
get_plugins.rs
336 lines (324 loc) · 11.5 KB
/
get_plugins.rs
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
use crate::{err_or_ignore, err_or_ignore_thread_safe, msg, Cfg, Log, MsgTone};
use anyhow::{anyhow, Context, Result};
use rayon::iter::{IntoParallelRefIterator, ParallelIterator};
use std::{
collections::{hash_map::Entry, HashMap},
fs::{self, File},
io::{self, BufRead},
path::{Path, PathBuf},
};
#[derive(PartialEq)]
pub(crate) struct PluginInfo {
pub(crate) name: String,
pub(crate) name_lowercased: String,
pub(crate) path: PathBuf,
}
#[derive(Default)]
struct Helper {
mor_found: bool,
omw_found: bool,
omw_data_ended: bool,
omw_data_counter: usize,
mor_data_files_dir: PathBuf,
mor_data_files_dir_found: bool,
omw_all_plugins_found: bool,
// Make plugins defined in both plugins_skip and plugins_skip_last be skipped once
preskipped_plugins_number: usize,
skipped_plugin_numbers: Vec<usize>,
}
pub(crate) fn get_plugins(config_path: &Path, cfg: &Cfg, log: &mut Log) -> Result<Vec<PluginInfo>> {
let text = format!(
"Gathering plugins from game configuration file \"{}\"",
config_path.display()
);
msg(text, MsgTone::Neutral, 1, cfg, log)?;
let config_lines = read_lines(config_path).with_context(|| {
format!(
"Failed to read game configuration file \"{}\"",
config_path.display()
)
})?;
let mut res: Vec<PluginInfo> = Vec::new();
let mut helper: Helper = Helper::default();
let mut omw_data_dirs: Vec<(usize, PathBuf)> = Vec::new();
let mut omw_all_plugins: HashMap<String, PathBuf> = HashMap::new();
for line in config_lines.flatten() {
if !helper.omw_found && line.starts_with(&cfg.guts.mor_line_beginning_content) {
if !helper.mor_data_files_dir_found {
mor_get_data_files_dir(config_path, &mut helper, cfg)
.with_context(|| "Failed to find Morrowind's \"Data Files\" directory")?;
}
mor_get_plugin(&line, &mut res, &mut helper, cfg, log)
.with_context(|| "Failed to find Morrowind's plugin")?;
}
if !helper.mor_found {
if !helper.omw_data_ended && line.starts_with(&cfg.guts.omw_line_beginning_data) {
omw_get_data_dir(&line, &mut omw_data_dirs, &mut helper, cfg, log)
.with_context(|| "Failed to get OpenMW's data directory")?;
}
if line.starts_with(&cfg.guts.omw_line_beginning_content) {
if !helper.omw_all_plugins_found {
omw_all_plugins = get_all_plugins(&omw_data_dirs, &mut helper, cfg)
.with_context(|| "Failed to find all OpenMW's plugins")?;
};
omw_get_plugin(&line, &mut res, &omw_all_plugins, &mut helper, cfg, log)
.with_context(|| "Failed to find OpenMW's plugin")?;
}
}
}
if cfg.skip_last > 0 {
skip_last_plugins(&mut res, &helper, cfg, log)
.with_context(|| format!("Failed to skip last {} plugins", cfg.skip_last))?;
}
Ok(res)
}
fn read_lines<P>(filename: P) -> Result<io::Lines<io::BufReader<File>>>
where
P: AsRef<Path>,
{
let file = File::open(&filename)
.with_context(|| format!("Failed to open file \"{}\"", filename.as_ref().display()))?;
Ok(io::BufReader::new(file).lines())
}
fn get_all_plugins(
omw_data_dirs: &[(usize, PathBuf)],
helper: &mut Helper,
cfg: &Cfg,
) -> Result<HashMap<String, PathBuf>> {
let mut found_plugins: Vec<(usize, String, PathBuf)> = omw_data_dirs
.par_iter()
.map(
|(id, dir_path)| -> Result<Vec<(usize, String, PathBuf)>, _> {
let mut res: Vec<(usize, String, PathBuf)> = Vec::new();
match fs::read_dir(dir_path) {
Ok(dir_contents) => {
for entry in dir_contents.flatten() {
let path = entry.path();
if let Some(plugin_extension) = path.extension() {
if cfg
.guts
.omw_plugin_extensions
.contains(&plugin_extension.to_ascii_lowercase())
{
res.push((
*id,
entry.file_name().to_string_lossy().into_owned(),
path,
));
}
}
}
}
Err(error) => {
let text = format!(
"Failed to open directory \"{}\" with error \"{}\"",
dir_path.display(),
error
);
err_or_ignore_thread_safe(text, cfg)?;
}
}
Ok(res)
},
)
.collect::<Result<Vec<_>>>()?
.into_iter()
.filter(|vec| !vec.is_empty())
.flatten()
.collect();
found_plugins.sort();
let mut all_plugins: HashMap<String, PathBuf> = HashMap::new();
found_plugins
.into_iter()
.rev()
.for_each(|(_, plugin, path)| {
if let Entry::Vacant(v) = all_plugins.entry(plugin) {
v.insert(path);
}
});
if !helper.omw_all_plugins_found {
helper.omw_all_plugins_found = true;
}
Ok(all_plugins)
}
fn mor_get_data_files_dir(config_path: &Path, helper: &mut Helper, cfg: &Cfg) -> Result<()> {
helper.mor_data_files_dir = match config_path.canonicalize()?.parent() {
Some(path) => Path::new(path).join(&cfg.guts.mor_data_files_dir),
None => {
return Err(anyhow!(
"Failed to find Morrowind's \"Data Files\" directory at expected location \"{}\"",
&cfg.guts.mor_data_files_dir
))
}
};
if !helper.mor_data_files_dir_found {
helper.mor_data_files_dir_found = true;
}
Ok(())
}
fn mor_get_plugin(
line: &str,
res: &mut Vec<PluginInfo>,
helper: &mut Helper,
cfg: &Cfg,
log: &mut Log,
) -> Result<()> {
if let Some(raw_name) = line.split('=').nth(1) {
if let Some((name, name_lowercased)) = skip_filtered_plugins(raw_name, helper, cfg, log)? {
let path = helper.mor_data_files_dir.join(&name);
if path.exists() {
res.push(PluginInfo {
name,
name_lowercased,
path,
});
} else {
let text = format!(
"Plugin \"{}\" not found at expected location \"{}\"",
name,
helper.mor_data_files_dir.join(&name).display()
);
err_or_ignore(text, cfg, log)?;
}
}
} else {
let text = format!("Failed to parse line \"{line}\"");
err_or_ignore(text, cfg, log)?;
}
if !helper.mor_found {
helper.mor_found = true;
}
Ok(())
}
fn omw_get_data_dir(
line: &str,
omw_data_dirs: &mut Vec<(usize, PathBuf)>,
helper: &mut Helper,
cfg: &Cfg,
log: &mut Log,
) -> Result<()> {
if let Some(raw_data) = line.split('=').nth(1) {
let data = PathBuf::from(&raw_data[1..raw_data.len() - 1]);
omw_data_dirs.push((helper.omw_data_counter, data));
helper.omw_data_counter += 1;
} else {
let text = format!("Failed to parse line \"{line}\"");
err_or_ignore(text, cfg, log)?;
}
if !helper.omw_found {
helper.omw_found = true;
}
Ok(())
}
fn omw_get_plugin(
line: &str,
res: &mut Vec<PluginInfo>,
omw_all_plugins: &HashMap<String, PathBuf>,
helper: &mut Helper,
cfg: &Cfg,
log: &mut Log,
) -> Result<()> {
if let Some(raw_name) = line.split('=').nth(1) {
if let Some((name, name_lowercased)) = skip_filtered_plugins(raw_name, helper, cfg, log)? {
if let Some(path) = omw_all_plugins.get(&name) {
res.push(PluginInfo {
name,
name_lowercased,
path: path.clone(),
});
} else {
let text = format!("Failed to find plugin \"{name}\"");
err_or_ignore(text, cfg, log)?;
}
}
}
if !helper.omw_data_ended {
helper.omw_data_ended = true;
}
Ok(())
}
fn skip_filtered_plugins(
raw_name: &str,
helper: &mut Helper,
cfg: &Cfg,
log: &mut Log,
) -> Result<Option<(String, String)>> {
let name = raw_name.trim().to_owned();
let name_lowercased = name.to_lowercase();
helper.preskipped_plugins_number += 1;
let text = if name == cfg.output.name {
format!(
"Plugin \"{}\" will be skipped, because it has the same name as the output plugin",
name
)
} else if name_lowercased.starts_with(&cfg.output.name_lowercased_starts_with) {
format!("Plugin \"{}\" will be skipped, because it's name matches output plugin name pattern \"{}\"", name, cfg.output.name_lowercased_starts_with)
} else if cfg.skip.contains(&name_lowercased) {
format!(
"Plugin \"{}\" will be skipped, because it's listed as a plugin to skip",
name
)
} else {
String::new()
};
if text.is_empty() {
Ok(Some((name, name_lowercased)))
} else {
helper
.skipped_plugin_numbers
.push(helper.preskipped_plugins_number);
msg(&text, MsgTone::Neutral, 0, cfg, log)?;
Ok(None)
}
}
fn skip_last_plugins(
res: &mut Vec<PluginInfo>,
helper: &Helper,
cfg: &Cfg,
log: &mut Log,
) -> Result<()> {
let res_len = res.len();
if res_len > cfg.skip_last {
// Make plugins defined in both plugins_skip and plugins_skip_last be skipped once
let skip_last_border = helper.preskipped_plugins_number - cfg.skip_last;
let mut skip_last_modifier = 0;
let mut already_skipped_numbers = Vec::new();
for number in helper.skipped_plugin_numbers.iter() {
if number > &skip_last_border {
skip_last_modifier += 1;
already_skipped_numbers.push(helper.preskipped_plugins_number - number);
}
}
let mut number_shift = 0;
for (number, plugin) in res
.drain(res_len + skip_last_modifier - cfg.skip_last..)
.rev()
.enumerate()
{
// Make plugins defined in both plugins_skip and plugins_skip_last be skipped once
let mut check_number = number + number_shift;
loop {
if already_skipped_numbers.contains(&check_number) {
already_skipped_numbers.retain(|item| item != &check_number);
number_shift += 1;
check_number += 1;
} else {
break;
}
}
let text = format!(
"Plugin \"{}\" will be skipped, because it's number {} from the end",
plugin.name,
number + number_shift + 1
);
msg(&text, MsgTone::Neutral, 0, cfg, log)?;
}
Ok(())
} else {
Err(anyhow!(
"There are only {} plugins, --skip-last {} is too large",
res_len,
cfg.skip_last
))
}
}