-
-
Notifications
You must be signed in to change notification settings - Fork 142
/
SimpleTweaksPlugin.cs
550 lines (459 loc) · 22.4 KB
/
SimpleTweaksPlugin.cs
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
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
using Dalamud.Plugin;
using ImGuiNET;
using System;
using System.Collections.Generic;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Numerics;
using System.Reflection;
using Dalamud.Game;
using Dalamud.Interface.ImGuiNotification;
using Dalamud.Interface.Windowing;
using Dalamud.Plugin.Services;
using SimpleTweaksPlugin.TweakSystem;
using SimpleTweaksPlugin.Debugging;
using SimpleTweaksPlugin.Utility;
using Task = System.Threading.Tasks.Task;
#if DEBUG
using System.Runtime.CompilerServices;
#endif
#pragma warning disable CS0659
namespace SimpleTweaksPlugin {
public class SimpleTweaksPlugin : IDalamudPlugin {
public string Name => "Simple Tweaks";
public SimpleTweaksPluginConfig PluginConfig { get; private set; }
public List<TweakProvider> TweakProviders = new();
public string AssemblyLocation { get; private set; } = Assembly.GetExecutingAssembly().Location;
public static SimpleTweaksPlugin Plugin { get; private set; }
private CultureInfo setCulture;
public bool LoadingTranslations { get; private set; } = false;
public IEnumerable<BaseTweak> Tweaks => TweakProviders.Where(tp => !tp.IsDisposed).SelectMany(tp => tp.Tweaks).OrderBy(t => t.Name);
public readonly ConfigWindow ConfigWindow = new ConfigWindow();
public readonly DebugWindow DebugWindow = new DebugWindow();
public readonly WindowSystem WindowSystem = new WindowSystem("SimpleTweaksPlugin");
public readonly Changelog ChangelogWindow = new();
internal CultureInfo Culture {
get {
if (setCulture != null) return setCulture;
if (string.IsNullOrEmpty(PluginConfig.CustomCulture)) return setCulture = CultureInfo.CurrentUICulture;
try {
var culture = CultureInfo.GetCultureInfo(PluginConfig.CustomCulture);
return setCulture = culture;
} catch {
//
}
return setCulture = CultureInfo.CurrentUICulture;
}
set => setCulture = value;
}
public void Dispose() {
SimpleLog.Debug("Dispose");
SaveAllConfig();
Service.Framework.Update -= FrameworkOnUpdate;
Service.PluginInterface.UiBuilder.Draw -= this.BuildUI;
RemoveCommands();
foreach (var t in TweakProviders.Where(t => !t.IsDisposed)) {
t.Dispose();
}
TweakProviders.Clear();
DebugManager.Dispose();
foreach (var hook in Common.HookList.Where(hook => !hook.IsDisposed)) {
if (hook.IsEnabled) hook.Disable();
hook.Dispose();
}
Common.HookList.Clear();
Common.Shutdown();
TooltipManager.Destroy();
SimpleEvent.Destroy();
}
public int UpdateFrom = -1;
public SimpleTweaksPlugin(IDalamudPluginInterface pluginInterface) {
Plugin = this;
pluginInterface.Create<Service>();
pluginInterface.Create<SimpleLog>();
pluginInterface.Create<Common>();
this.PluginConfig = (SimpleTweaksPluginConfig)Service.PluginInterface.GetPluginConfig() ?? new SimpleTweaksPluginConfig();
this.PluginConfig.Init(this);
#if DEBUG
SimpleLog.SetupBuildPath();
#endif
Task.Run(() => {
UpdateBlacklist();
Service.Framework.RunOnFrameworkThread(Initialize);
});
}
private void UpdateBlacklist() {
try {
// Update Tweak Blacklist
var httpClient = Common.HttpClient;
var response = httpClient.Send(new HttpRequestMessage(HttpMethod.Get, "https://raw.githubusercontent.com/Caraxi/SimpleTweaksPlugin/main/tweakBlacklist.txt"));
if (response.StatusCode != HttpStatusCode.OK) return;
var asStringTask = response.Content.ReadAsStringAsync();
asStringTask.Wait();
if (!asStringTask.IsCompletedSuccessfully) return;
var blacklistedTweaksString = asStringTask.Result;
SimpleLog.Log("Tweak Blacklist:\n" + blacklistedTweaksString);
var blacklistedTweaks = new List<string>();
foreach (var l in blacklistedTweaksString.Split("\n")) {
if (string.IsNullOrWhiteSpace(l)) continue;
blacklistedTweaks.Add(l.Trim());
}
PluginConfig.BlacklistedTweaks = blacklistedTweaks;
} catch {
//
}
}
private void Initialize() {
SetupLocalization();
UiHelper.Setup(Service.SigScanner);
DebugManager.SetPlugin(this);
Common.Setup();
WindowSystem.AddWindow(ConfigWindow);
WindowSystem.AddWindow(DebugWindow);
WindowSystem.AddWindow(ChangelogWindow);
Changelog.AddGeneralChangelogs();
Service.PluginInterface.UiBuilder.Draw += this.BuildUI;
Service.PluginInterface.UiBuilder.OpenConfigUi += OnOpenConfig;
SetupCommands();
var simpleTweakProvider = new TweakProvider(Assembly.GetExecutingAssembly());
simpleTweakProvider.LoadTweaks();
TweakProviders.Add(simpleTweakProvider);
foreach (var provider in PluginConfig.CustomTweakProviders) {
LoadCustomProvider(provider);
}
#if DEBUG
if (!PluginConfig.DisableAutoOpen) {
DebugWindow.IsOpen = true;
ConfigWindow.IsOpen = true;
}
#endif
DebugManager.Reload();
Service.Framework.Update += FrameworkOnUpdate;
MetricsService.ReportMetrics();
}
private void FrameworkOnUpdate(IFramework framework) => Common.InvokeFrameworkUpdate();
public void SetupLocalization() {
this.PluginConfig.Language ??= Service.ClientState.ClientLanguage switch {
ClientLanguage.English => "en",
ClientLanguage.French => "fr",
ClientLanguage.German => "de",
ClientLanguage.Japanese => "ja",
_ => "en"
};
Loc.LoadLanguage(PluginConfig.Language);
foreach (var t in Tweaks) t.LanguageChanged();
}
public void SetupCommands() {
Service.Commands.AddHandler("/tweaks", new Dalamud.Game.Command.CommandInfo(OnConfigCommandHandler) {
HelpMessage = $"Open config window for {this.Name}",
ShowInHelp = true
});
}
private void OnOpenConfig() {
if (ImGui.GetIO().KeyShift && ImGui.GetIO().KeyCtrl) {
DebugWindow.UnCollapseOrToggle();
return;
}
OnConfigCommandHandler(null, null);
}
public void OnConfigCommandHandler(object command, object args) {
if (args is string argString) {
if (argString == "Debug") {
DebugWindow.UnCollapseOrToggle();
return;
}
if (!string.IsNullOrEmpty(argString.Trim())) {
var splitArgString = argString.Split(' ');
switch (splitArgString[0].ToLowerInvariant()) {
case "cl":
case "changes":
case "changelog": {
ChangelogWindow.IsOpen = !ChangelogWindow.IsOpen;
return;
}
case "t":
case "toggle": {
if (splitArgString.Length < 2) {
Service.Chat.PrintError("/tweaks toggle <tweakid>");
return;
}
var tweak = GetTweakById(splitArgString[1]);
if (tweak != null) {
if (tweak.Enabled) {
tweak.InternalDisable();
if (PluginConfig.EnabledTweaks.Contains(tweak.Key)) {
PluginConfig.EnabledTweaks.Remove(tweak.Key);
}
Service.NotificationManager.AddNotification(new Notification { Content = $"Disabled {tweak.Name}", Title = "Simple Tweaks", Type = NotificationType.Info });
} else {
tweak.InternalEnable();
if (!PluginConfig.EnabledTweaks.Contains(tweak.Key)) {
PluginConfig.EnabledTweaks.Add(tweak.Key);
}
Service.NotificationManager.AddNotification(new Notification { Content = $"Enabled {tweak.Name}", Title = "Simple Tweaks", Type = NotificationType.Info });}
PluginConfig.Save();
return;
}
Service.Chat.PrintError($"\"{splitArgString[1]}\" is not a valid tweak id.");
return;
}
case "e":
case "enable": {
if (splitArgString.Length < 2) {
Service.Chat.PrintError("/tweaks enable <tweakid>");
return;
}
var tweak = GetTweakById(splitArgString[1]);
if (tweak != null) {
if (!tweak.Enabled) {
tweak.InternalEnable();
if (!PluginConfig.EnabledTweaks.Contains(tweak.Key)) {
PluginConfig.EnabledTweaks.Add(tweak.Key);
}
Service.NotificationManager.AddNotification(new Notification { Content = $"Enabled {tweak.Name}", Title = "Simple Tweaks", Type = NotificationType.Info });
PluginConfig.Save();
}
return;
}
Service.Chat.PrintError($"\"{splitArgString[1]}\" is not a valid tweak id.");
return;
}
case "d":
case "disable": {
if (splitArgString.Length < 2) {
Service.Chat.PrintError("/tweaks disable <tweakid>");
return;
}
var tweak = GetTweakById(splitArgString[1]);
if (tweak != null) {
if (tweak.Enabled) {
tweak.InternalDisable();
if (PluginConfig.EnabledTweaks.Contains(tweak.Key)) {
PluginConfig.EnabledTweaks.Remove(tweak.Key);
}
Service.NotificationManager.AddNotification(new Notification { Content = $"Disabled {tweak.Name}", Title = "Simple Tweaks", Type = NotificationType.Info });
PluginConfig.Save();
}
return;
}
Service.Chat.PrintError($"\"{splitArgString[1]}\" is not a valid tweak id.");
return;
}
case "f":
case "find": {
if (splitArgString.Length < 2) {
Service.Chat.PrintError("/tweaks find <tweakid>");
return;
}
var tweak = GetTweakById(splitArgString[1]);
if (tweak != null) {
PluginConfig.FocusTweak(tweak);
return;
}
Service.Chat.PrintError($"\"{splitArgString[1]}\" is not a valid tweak id.");
return;
}
default: {
var tweak = GetTweakById(splitArgString[0]);
if (tweak != null) {
tweak.HandleBasicCommand(splitArgString.Skip(1).ToArray());
return;
}
Service.Chat.PrintError($"\"{splitArgString[1]}\" is not a valid tweak id.");
return;
}
}
}
}
ConfigWindow.UnCollapseOrToggle();
}
public BaseTweak? GetTweakById(string s, IEnumerable<BaseTweak>? tweakList = null) {
tweakList ??= Tweaks;
foreach (var t in tweakList) {
if (string.Equals(t.Key, s, StringComparison.InvariantCultureIgnoreCase)) return t;
if (t is SubTweakManager stm) {
var fromSub = GetTweakById(s, stm.GetTweakList());
if (fromSub != null) return fromSub;
}
}
return null;
}
public T GetTweak<T>(IEnumerable<BaseTweak>? tweakList = null) where T : BaseTweak {
tweakList ??= Tweaks;
foreach (var t in tweakList) {
if (t is T tweak) return tweak;
if (t is SubTweakManager stm) {
var fromSub = GetTweak<T>(stm.GetTweakList());
if (fromSub != null) return fromSub;
}
}
return null;
}
public void SaveAllConfig() {
PluginConfig.Save();
foreach (var tp in TweakProviders.Where(tp => !tp.IsDisposed)) {
foreach (var t in tp.Tweaks) {
t.RequestSaveConfig();
}
}
}
public void RemoveCommands() {
Service.Commands.RemoveHandler("/tweaks");
}
private void BuildUI() {
foreach (var e in ErrorList.Where(e => e.IsNew && e.Tweak != null)) {
e.IsNew = false;
e.Tweak.InternalDisable();
Service.NotificationManager.AddNotification(new Notification { Content = $"{e.Tweak.Name} has been disabled due to an error.", Title = "Simple Tweaks", Type = NotificationType.Error });
}
WindowSystem.Draw();
if (ShowErrorWindow) {
if (ErrorList.Count > 0) {
var errorsStillOpen = true;
ImGui.Begin($"{Name}: Error!", ref errorsStillOpen, ImGuiWindowFlags.NoCollapse | ImGuiWindowFlags.AlwaysAutoResize);
for (var i = 0; i < ErrorList.Count && i < 5; i++) {
var e = ErrorList[i];
ImGui.Text($"Error caught in {(e.Manager != null ? $"{e.Manager.Name}@" : "")}{(e.Tweak != null ? e.Tweak.Name : "Tweak Loader")}:");
if (!string.IsNullOrEmpty(e.Message)) {
ImGui.Text(e.Message);
}
ImGui.Text($"{e.Exception}");
if (ImGui.Button($"Clear this Error###clearErrorButton{i}")) {
e.Closed = true;
}
if (e.Count > 1) {
ImGui.SameLine();
ImGui.Text($"This error has occured {e.Count} times.");
}
ImGui.Separator();
}
if (ErrorList.Count > 5) {
ImGui.TextColored(new Vector4(1, 0, 0, 1), $"{ErrorList.Count - 5} Additional Errors");
}
ErrorList.RemoveAll(e => e.Closed);
ImGui.End();
if (!errorsStillOpen) {
ErrorList.Clear();
ShowErrorWindow = false;
}
} else {
ShowErrorWindow = false;
}
}
if (Service.PluginInterface.IsDevMenuOpen && (Service.PluginInterface.IsDev || PluginConfig.ShowInDevMenu)) {
if (ImGui.BeginMainMenuBar()) {
if (ImGui.MenuItem("Simple Tweaks")) {
if (ImGui.GetIO().KeyShift) {
DebugWindow.UnCollapseOrToggle();
} else {
ConfigWindow.UnCollapseOrToggle();
}
}
ImGui.EndMainMenuBar();
}
}
}
internal class CaughtError {
public BaseTweak Tweak;
public SubTweakManager Manager;
public Exception Exception;
public bool IsNew = true;
public bool Closed;
public string Message = string.Empty;
public ulong Count = 1;
public override bool Equals(object obj) {
if (obj is CaughtError otherError) {
if (otherError.Manager != Manager) return false;
if (otherError.Tweak != Tweak) return false;
if (otherError.Message != this.Message) return false;
if ($"{otherError.Exception}" != $"{Exception}") return false;
return true;
}
return false;
}
}
internal bool ShowErrorWindow;
internal readonly List<CaughtError> ErrorList = new List<CaughtError>();
#if DEBUG
public void Error(Exception ex, string message = "", [CallerFilePath] string callerFilePath = "", [CallerLineNumber] int callerLineNumber = 0, [CallerMemberName] string callerMemberName = "") {
Error(null, ex, true, message, callerFilePath, callerLineNumber, callerMemberName);
}
public void Error(BaseTweak tweak, Exception exception, bool allowContinue = false, string message = "", [CallerFilePath] string callerFilePath = "", [CallerLineNumber] int callerLineNumber = 0, [CallerMemberName] string callerMemberName = "" ) {
if (tweak != null) {
SimpleLog.Error($"Exception in '{tweak.Name}'" + (string.IsNullOrEmpty(message) ? "" : ($": {message}")), callerFilePath, callerMemberName, callerLineNumber);
} else {
SimpleLog.Error("Exception in SimpleTweaks framework. "+ (string.IsNullOrEmpty(message) ? "" : ($": {message}")), callerFilePath, callerMemberName, callerLineNumber);
}
SimpleLog.Error($"{exception}", callerFilePath, callerMemberName, callerLineNumber);
#else
public void Error(Exception ex, string message = "") {
Error(null, ex, true, message);
}
public void Error(BaseTweak tweak, Exception exception, bool allowContinue = false, string message="") {
if (tweak == null) {
SimpleLog.Error($"Exception in SimpleTweaks framework. " + (string.IsNullOrEmpty(message) ? "" : ($": {message}")));
} else {
SimpleLog.Error($"Exception in '{tweak.Name}'" + (string.IsNullOrEmpty(message) ? "" : ($": {message}")));
}
SimpleLog.Error($"{exception}");
#endif
var err = new CaughtError {
Tweak = tweak,
Exception = exception,
IsNew = !allowContinue,
Message = message
};
var i = ErrorList.IndexOf(err);
if (i >= 0) {
ErrorList[i].Count++;
ErrorList[i].IsNew = ErrorList[i].IsNew || err.IsNew;
} else {
ErrorList.Insert(0, err);
}
if (ErrorList.Count > 50) {
ErrorList.RemoveRange(50, ErrorList.Count - 50);
}
}
#if DEBUG
public void Error(SubTweakManager manager, BaseTweak tweak, Exception exception, bool allowContinue = false, string message = "", [CallerFilePath] string callerFilePath = "", [CallerLineNumber] int callerLineNumber = 0, [CallerMemberName] string callerMemberName = "") {
SimpleLog.Error($"Exception in '{tweak.Name}' @ '{manager.Name}'" + (string.IsNullOrEmpty(message) ? "" : ($": {message}")), callerFilePath, callerMemberName, callerLineNumber);
SimpleLog.Error($"{exception}", callerFilePath, callerMemberName, callerLineNumber);
#else
public void Error(SubTweakManager manager, BaseTweak tweak, Exception exception, bool allowContinue = false, string message = "") {
SimpleLog.Error($"Exception in '{tweak.Name}' @ '{manager.Name}'" + (string.IsNullOrEmpty(message) ? "" : ($": {message}")));
SimpleLog.Error($"{exception}");
#endif
var err = new CaughtError {
Tweak = tweak,
Manager = manager,
Exception = exception,
IsNew = !allowContinue,
Message = message
};
var i = ErrorList.IndexOf(err);
if (i >= 0) {
ErrorList[i].Count++;
ErrorList[i].IsNew = ErrorList[i].IsNew || err.IsNew;
} else {
ErrorList.Insert(0, err);
}
if (ErrorList.Count > 50) {
ErrorList.RemoveRange(50, ErrorList.Count - 50);
}
}
public void LoadCustomProvider(CustomTweakProviderConfig provider) {
if (!provider.Enabled) return;
var path = provider.Assembly;
if (!File.Exists(path)) return;
TweakProviders.RemoveAll(t => t.IsDisposed);
var tweakProvider = new CustomTweakProvider(provider);
tweakProvider.LoadTweaks();
TweakProviders.Add(tweakProvider);
Loc.ClearCache();
DebugManager.Reload();
}
}
}