Skip to content

Code Quality: Refactored TerminalController #10358

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Nov 1, 2022
Merged

Code Quality: Refactored TerminalController #10358

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
aea38a7
Refactore TerminalController
cinqmilleans Oct 31, 2022
efde02a
Merge remote-tracking branch 'upstream/main' into RefactoreTerminalCo…
cinqmilleans Nov 1, 2022
6ed0351
improves
cinqmilleans Nov 1, 2022
a360977
unscribe
cinqmilleans Nov 1, 2022
e6a180b
style Terminal
cinqmilleans Nov 1, 2022
6a6726c
Update src/Files.App/DataModels/Terminal.cs
yaira2 Nov 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
194 changes: 85 additions & 109 deletions src/Files.App/Controllers/TerminalController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,122 +17,125 @@ namespace Files.App.Controllers
{
public class TerminalController : IJson
{
private string defaultTerminalPath = "ms-appx:///Assets/terminal/terminal.json";
private string configContent = string.Empty;

private string folderPath => Path.Combine(ApplicationData.Current.LocalFolder.Path, "settings");
public event Action<TerminalController>? ModelChanged;

private StorageFileQueryResult query;
public string JsonFileName => "terminal.json";

private string configContent;

public TerminalFileModel Model { get; set; }

public event Action<TerminalController> ModelChanged;

public string JsonFileName { get; } = "terminal.json";

public TerminalController()
{
Model = new TerminalFileModel();
}
private TerminalFileModel model = new();
public TerminalFileModel Model => model;

public async Task InitializeAsync()
{
await LoadAsync();
await GetInstalledTerminalsAsync();
await GetInstalledTerminalsAsync(model);
SaveModel();
await StartWatchConfigChangeAsync();
ModelChanged?.Invoke(this);
}

public void SaveModel()
{
try
{
var path = Path.Combine(ApplicationData.Current.LocalFolder.Path, "settings", JsonFileName);
using var file = File.CreateText(path);

// update local configContent to avoid unnecessary refreshes
configContent = JsonSerializer.Serialize(model, DefaultJsonSettingsSerializer.Options);
file.Write(configContent);
}
catch {}
}

private async Task LoadAsync()
{
StorageFolder Folder = await FilesystemTasks.Wrap(() => ApplicationData.Current.LocalFolder.CreateFolderAsync("settings", CreationCollisionOption.OpenIfExists).AsTask());
StorageFolder Folder = await FilesystemTasks.Wrap(() =>
ApplicationData.Current.LocalFolder.CreateFolderAsync("settings", CreationCollisionOption.OpenIfExists)
.AsTask());

if (Folder is null)
{
Model = await GetDefaultTerminalFileModel();
model = await GetDefaultTerminalFileModel();
return;
}

var JsonFile = await FilesystemTasks.Wrap(() => Folder.GetFileAsync(JsonFileName).AsTask());
if (!JsonFile)
var jsonFile = await FilesystemTasks.Wrap(() =>
Folder.GetFileAsync(JsonFileName)
.AsTask());

if (!jsonFile)
{
if (JsonFile == FileSystemStatusCode.NotFound)
{
Model = await GetDefaultTerminalFileModel();
model = await GetDefaultTerminalFileModel();
if (jsonFile.ErrorCode is FileSystemStatusCode.NotFound)
SaveModel();
return;
}
else
{
Model = await GetDefaultTerminalFileModel();
return;
}
return;
}

try
{
configContent = await FileIO.ReadTextAsync(JsonFile.Result);
Model = JsonSerializer.Deserialize<TerminalFileModel>(configContent);
if (Model is null)
{
configContent = await FileIO.ReadTextAsync(jsonFile.Result);

var fileModel = JsonSerializer.Deserialize<TerminalFileModel>(configContent);
if (fileModel is null)
throw new ArgumentException($"{JsonFileName} is empty, regenerating...");
}
model = fileModel!;
}
catch (ArgumentException)
{
Model = await GetDefaultTerminalFileModel();
model = await GetDefaultTerminalFileModel();
SaveModel();
}
catch (Exception)
{
Model = await GetDefaultTerminalFileModel();
model = await GetDefaultTerminalFileModel();
}
}

private async Task StartWatchConfigChangeAsync()
{
var queryOptions = new QueryOptions();
queryOptions.ApplicationSearchFilter = "System.FileName:" + JsonFileName;
var queryOptions = new QueryOptions
{
ApplicationSearchFilter = "System.FileName:" + JsonFileName
};

var settingsFolder = await ApplicationData.Current.LocalFolder.GetFolderAsync("settings");
query = settingsFolder.CreateFileQueryWithOptions(queryOptions);
string a = settingsFolder.Path;
var query = settingsFolder.CreateFileQueryWithOptions(queryOptions);
query.ContentsChanged += Query_ContentsChanged;
await query.GetFilesAsync();
}

private async void Query_ContentsChanged(IStorageQueryResultBase sender, object args)
{
sender.ContentsChanged -= Query_ContentsChanged;

try
{
var configFile = await StorageFile.GetFileFromApplicationUriAsync(new Uri("ms-appdata:///local/settings/terminal.json"));
var content = await FileIO.ReadTextAsync(configFile);

if (configContent != content)
{
configContent = content;
}
else
{
var content = await ReadContent("ms-appdata:///local/settings/terminal.json");
if (configContent == content)
return;
}

configContent = content;
await LoadAsync();
await GetInstalledTerminalsAsync();
await GetInstalledTerminalsAsync(model);
SaveModel();
ModelChanged?.Invoke(this);
}
catch
{
// ignored
}
catch {}
}

private async Task<TerminalFileModel> GetDefaultTerminalFileModel()
{
try
{
StorageFile defaultFile = await StorageFile.GetFileFromApplicationUriAsync(new Uri(defaultTerminalPath));
var defaultContent = await FileIO.ReadTextAsync(defaultFile);
var model = JsonSerializer.Deserialize<TerminalFileModel>(defaultContent);
var content = await ReadContent("ms-appx:///Assets/terminal/terminal.json");
var fileModel = JsonSerializer.Deserialize<TerminalFileModel>(configContent);
if (fileModel is null)
throw new ArgumentException($"{JsonFileName} is empty, regenerating...");
model = fileModel!;

await GetInstalledTerminalsAsync(model);
model.ResetToDefaultTerminal();
return model;
Expand All @@ -146,67 +149,40 @@ private async Task<TerminalFileModel> GetDefaultTerminalFileModel()
}
}

private async Task GetInstalledTerminalsAsync()
private static async Task<string> ReadContent(string path)
{
await GetInstalledTerminalsAsync(Model);
SaveModel();
var uri = new Uri(path);
var file = await StorageFile.GetFileFromApplicationUriAsync(uri);
return await FileIO.ReadTextAsync(file);
}

private async Task GetInstalledTerminalsAsync(TerminalFileModel model)
private static async Task GetInstalledTerminalsAsync(TerminalFileModel model)
{
var terminalDefs = new Dictionary<Terminal, bool>();

terminalDefs.Add(new Terminal()
{
Name = "Windows Terminal",
Path = "wt.exe",
Arguments = "-d .",
Icon = ""
}, await IsWindowsTerminalBuildInstalled());

terminalDefs.Add(new Terminal()
var terminalDefs = new Dictionary<Terminal, bool>
{
Name = "Fluent Terminal",
Path = "flute.exe",
Arguments = "",
Icon = ""
}, await PackageHelper.IsAppInstalledAsync("53621FSApps.FluentTerminal_87x1pks76srcp"));

terminalDefs.Add(new Terminal()
{
Name = "CMD",
Path = "cmd.exe",
Arguments = "",
Icon = ""
}, true); // CMD will always be present (for now at least)
{
new Terminal("Windows Terminal", "wt.exe", "-d ."),
await IsWindowsTerminalBuildInstalled()
},
{
new Terminal("Fluent Terminal", "flute.exe"),
await IsFluentTerminalBuildInstalled()
},
{
new Terminal("CMD", "cmd.exe"),
true // CMD will always be present (for now at least)
}
};

terminalDefs.Where(x => x.Value).ForEach(x => model.AddTerminal(x.Key));
terminalDefs.Where(x => !x.Value).ForEach(x => model.RemoveTerminal(x.Key));
}

public async static Task<bool> IsWindowsTerminalBuildInstalled()
{
bool isWindowsTerminalInstalled = await PackageHelper.IsAppInstalledAsync("Microsoft.WindowsTerminal_8wekyb3d8bbwe");
bool isWindowsTerminalPreviewInstalled = await PackageHelper.IsAppInstalledAsync("Microsoft.WindowsTerminalPreview_8wekyb3d8bbwe");

return isWindowsTerminalPreviewInstalled || isWindowsTerminalInstalled;
}
async static Task<bool> IsWindowsTerminalBuildInstalled()
=> await PackageHelper.IsAppInstalledAsync("Microsoft.WindowsTerminal_8wekyb3d8bbwe")
|| await PackageHelper.IsAppInstalledAsync("Microsoft.WindowsTerminalPreview_8wekyb3d8bbwe");

public void SaveModel()
{
try
{
using (var file = File.CreateText(Path.Combine(folderPath, JsonFileName)))
{
// update local configContent to avoid unnecessary refreshes
configContent = JsonSerializer.Serialize(Model, DefaultJsonSettingsSerializer.Options);
file.Write(configContent);
}
}
catch
{
// ignored
}
async static Task<bool> IsFluentTerminalBuildInstalled()
=> await PackageHelper.IsAppInstalledAsync("53621FSApps.FluentTerminal_87x1pks76srcp");
}
}
}
20 changes: 16 additions & 4 deletions src/Files.App/DataModels/Terminal.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,28 @@ namespace Files.App.DataModels
{
public class Terminal
{
public Terminal()
{
}

public Terminal(string name, string path, string arguments = "", string icon = "")
{
Name = name;
Path = path;
Arguments = arguments;
Icon = icon;
}

[JsonPropertyName("name")]
public string Name { get; set; }
public string Name { get; set; } = string.Empty;

[JsonPropertyName("path")]
public string Path { get; set; }
public string Path { get; set; } = string.Empty;

[JsonPropertyName("arguments")]
public string Arguments { get; set; }
public string Arguments { get; set; } = string.Empty;

[JsonPropertyName("icon")]
public string Icon { get; set; }
public string Icon { get; set; } = string.Empty;
}
}