DarthAffe/Artemis
1
0
Fork 0
mirror of https://github.com/Artemis-RGB/Artemis synced 2025-12-13 05:48:35 +00:00
Code Issues Releases Wiki Activity

Plugins - Made built-in plugins copy code more resilient to different archive structures

Browse Source
This commit is contained in:
Robert 2023-03-25 09:45:26 +01:00
parent 0e32bb6b61
commit 9e8017e17a
1 changed files with 55 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

91
src/Artemis.Core/Services/PluginManagementService.cs
View File

@ -47,15 +47,29 @@ internal class PluginManagementService : IPluginManagementService
private void CopyBuiltInPlugin(ZipArchive zipArchive, string targetDirectory) private void CopyBuiltInPlugin(ZipArchive zipArchive, string targetDirectory)
{ {
ZipArchiveEntry metaDataFileEntry = zipArchive.Entries.First(e => e.Name == "plugin.json");
DirectoryInfo pluginDirectory = new(Path.Combine(Constants.PluginsFolder, targetDirectory)); DirectoryInfo pluginDirectory = new(Path.Combine(Constants.PluginsFolder, targetDirectory));
bool createLockFile = File.Exists(Path.Combine(pluginDirectory.FullName, "artemis.lock")); bool createLockFile = File.Exists(Path.Combine(pluginDirectory.FullName, "artemis.lock"));
// Remove the old directory if it exists // Remove the old directory if it exists
if (Directory.Exists(pluginDirectory.FullName)) if (Directory.Exists(pluginDirectory.FullName))
pluginDirectory.DeleteRecursively(); pluginDirectory.DeleteRecursively();
Directory.CreateDirectory(pluginDirectory.FullName);
zipArchive.ExtractToDirectory(pluginDirectory.FullName, true); // Extract everything in the same archive directory to the unique plugin directory
Utilities.CreateAccessibleDirectory(pluginDirectory.FullName);
string metaDataDirectory = metaDataFileEntry.FullName.Replace(metaDataFileEntry.Name, "");
foreach (ZipArchiveEntry zipArchiveEntry in zipArchive.Entries)
{
if (zipArchiveEntry.FullName.StartsWith(metaDataDirectory) && !zipArchiveEntry.FullName.EndsWith("/"))
{
string target = Path.Combine(pluginDirectory.FullName, zipArchiveEntry.FullName.Remove(0, metaDataDirectory.Length));
// Create folders
Utilities.CreateAccessibleDirectory(Path.GetDirectoryName(target)!);
// Extract files
zipArchiveEntry.ExtractToFile(target);
}
}
if (createLockFile) if (createLockFile)
File.Create(Path.Combine(pluginDirectory.FullName, "artemis.lock")).Close(); File.Create(Path.Combine(pluginDirectory.FullName, "artemis.lock")).Close();
} }
@ -82,6 +96,7 @@ internal class PluginManagementService : IPluginManagementService
return; return;
} }
foreach (FileInfo zipFile in builtInPluginDirectory.EnumerateFiles("*.zip")) foreach (FileInfo zipFile in builtInPluginDirectory.EnumerateFiles("*.zip"))
{ {
try try
@ -98,56 +113,57 @@ internal class PluginManagementService : IPluginManagementService
private void ExtractBuiltInPlugin(FileInfo zipFile, DirectoryInfo pluginDirectory) private void ExtractBuiltInPlugin(FileInfo zipFile, DirectoryInfo pluginDirectory)
{ {
// Find the metadata file in the zip // Find the metadata file in the zip
using ZipArchive archive = ZipFile.OpenRead(zipFile.FullName); using ZipArchive archive = ZipFile.OpenRead(zipFile.FullName);
ZipArchiveEntry? metaDataFileEntry = archive.GetEntry("plugin.json");
if (metaDataFileEntry == null)
throw new ArtemisPluginException("Couldn't find a plugin.json in " + zipFile.FullName);
using StreamReader reader = new(metaDataFileEntry.Open()); ZipArchiveEntry? metaDataFileEntry = archive.Entries.FirstOrDefault(e => e.Name == "plugin.json");
PluginInfo builtInPluginInfo = CoreJson.DeserializeObject<PluginInfo>(reader.ReadToEnd())!; if (metaDataFileEntry == null)
string preferred = builtInPluginInfo.PreferredPluginDirectory; throw new ArtemisPluginException("Couldn't find a plugin.json in " + zipFile.FullName);
// Find the matching plugin in the plugin folder using StreamReader reader = new(metaDataFileEntry.Open());
DirectoryInfo? match = pluginDirectory.EnumerateDirectories().FirstOrDefault(d => d.Name == preferred); PluginInfo builtInPluginInfo = CoreJson.DeserializeObject<PluginInfo>(reader.ReadToEnd())!;
if (match == null) string preferred = builtInPluginInfo.PreferredPluginDirectory;
// Find the matching plugin in the plugin folder
DirectoryInfo? match = pluginDirectory.EnumerateDirectories().FirstOrDefault(d => d.Name == preferred);
if (match == null)
{
CopyBuiltInPlugin(archive, preferred);
}
else
{
string metadataFile = Path.Combine(match.FullName, "plugin.json");
if (!File.Exists(metadataFile))
{ {
_logger.Debug("Copying missing built-in plugin {builtInPluginInfo}", builtInPluginInfo);
CopyBuiltInPlugin(archive, preferred); CopyBuiltInPlugin(archive, preferred);
} }
else else
{ {
string metadataFile = Path.Combine(match.FullName, "plugin.json"); PluginInfo pluginInfo;
if (!File.Exists(metadataFile)) try
{ {
_logger.Debug("Copying missing built-in plugin {builtInPluginInfo}", builtInPluginInfo); // Compare versions, copy if the same when debugging
CopyBuiltInPlugin(archive, preferred); pluginInfo = CoreJson.DeserializeObject<PluginInfo>(File.ReadAllText(metadataFile))!;
} }
else catch (Exception e)
{ {
PluginInfo pluginInfo; throw new ArtemisPluginException($"Failed read plugin metadata needed to install built-in plugin: {e.Message}", e);
try }
{
// Compare versions, copy if the same when debugging
pluginInfo = CoreJson.DeserializeObject<PluginInfo>(File.ReadAllText(metadataFile))!;
}
catch (Exception e)
{
throw new ArtemisPluginException($"Failed read plugin metadata needed to install built-in plugin: {e.Message}", e);
}
try try
{
if (builtInPluginInfo.Version > pluginInfo.Version)
{ {
if (builtInPluginInfo.Version > pluginInfo.Version) _logger.Debug("Copying updated built-in plugin from {pluginInfo} to {builtInPluginInfo}", pluginInfo, builtInPluginInfo);
{ CopyBuiltInPlugin(archive, preferred);
_logger.Debug("Copying updated built-in plugin from {pluginInfo} to {builtInPluginInfo}", pluginInfo, builtInPluginInfo);
CopyBuiltInPlugin(archive, preferred);
}
}
catch (Exception e)
{
throw new ArtemisPluginException($"Failed to install built-in plugin: {e.Message}", e);
} }
} }
catch (Exception e)
{
throw new ArtemisPluginException($"Failed to install built-in plugin: {e.Message}", e);
}
} }
}
} }
#endregion #endregion
@ -568,7 +584,6 @@ internal class PluginManagementService : IPluginManagementService
if (metaDataFileEntry == null) if (metaDataFileEntry == null)
throw new ArtemisPluginException("Couldn't find a plugin.json in " + fileName); throw new ArtemisPluginException("Couldn't find a plugin.json in " + fileName);
using StreamReader reader = new(metaDataFileEntry.Open()); using StreamReader reader = new(metaDataFileEntry.Open());
PluginInfo pluginInfo = CoreJson.DeserializeObject<PluginInfo>(reader.ReadToEnd())!; PluginInfo pluginInfo = CoreJson.DeserializeObject<PluginInfo>(reader.ReadToEnd())!;
if (!pluginInfo.Main.EndsWith(".dll")) if (!pluginInfo.Main.EndsWith(".dll"))