DarthAffe/Artemis
1
0
Fork 0
mirror of https://github.com/Artemis-RGB/Artemis synced 2026-01-01 18:23:32 +00:00
Code Issues Releases Wiki Activity

Plugin service - Added support for zipped built-in plugins

Browse Source 
Plugin service - Built-in plugins are no longer always copied during debug regardless of their version
This commit is contained in:
SpoinkyNL 2020-10-26 22:37:02 +01:00
parent 4c7c931231
commit 7cd9c65968
1 changed files with 18 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
src/Artemis.Core/Services/PluginService.cs
View File

@ -1,6 +1,7 @@
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.IO; using System.IO;
using System.IO.Compression;
using System.Linq; using System.Linq;
using System.Reflection; using System.Reflection;
using Artemis.Core.DeviceProviders; using Artemis.Core.DeviceProviders;
@ -54,26 +55,28 @@ namespace Artemis.Core.Services
return; return;
} }
foreach (DirectoryInfo subDirectory in builtInPluginDirectory.EnumerateDirectories()) foreach (FileInfo zipFile in builtInPluginDirectory.EnumerateFiles("*.zip"))
{ {
// Load the metadata // Find the metadata file in the zip
string builtInMetadataFile = Path.Combine(subDirectory.FullName, "plugin.json"); using ZipArchive archive = ZipFile.OpenRead(zipFile.FullName);
if (!File.Exists(builtInMetadataFile)) ZipArchiveEntry? metaDataFileEntry = archive.GetEntry("plugin.json");
throw new ArtemisPluginException("Couldn't find the built-in plugins metadata file at " + builtInMetadataFile); if (metaDataFileEntry == null)
throw new ArtemisPluginException("Couldn't find a plugin.json in " + zipFile.FullName);
PluginInfo builtInPluginInfo = JsonConvert.DeserializeObject<PluginInfo>(File.ReadAllText(builtInMetadataFile)); using StreamReader reader = new StreamReader(metaDataFileEntry.Open());
PluginInfo builtInPluginInfo = JsonConvert.DeserializeObject<PluginInfo>(reader.ReadToEnd());
// Find the matching plugin in the plugin folder // Find the matching plugin in the plugin folder
DirectoryInfo match = pluginDirectory.EnumerateDirectories().FirstOrDefault(d => d.Name == subDirectory.Name); DirectoryInfo? match = pluginDirectory.EnumerateDirectories().FirstOrDefault(d => d.Name == Path.GetFileNameWithoutExtension(zipFile.Name));
if (match == null) if (match == null)
CopyBuiltInPlugin(subDirectory); CopyBuiltInPlugin(zipFile, archive);
else else
{ {
string metadataFile = Path.Combine(match.FullName, "plugin.json"); string metadataFile = Path.Combine(match.FullName, "plugin.json");
if (!File.Exists(metadataFile)) if (!File.Exists(metadataFile))
{ {
_logger.Debug("Copying missing built-in plugin {builtInPluginInfo}", builtInPluginInfo); _logger.Debug("Copying missing built-in plugin {builtInPluginInfo}", builtInPluginInfo);
CopyBuiltInPlugin(subDirectory); CopyBuiltInPlugin(zipFile, archive);
} }
else else
{ {
@ -81,19 +84,12 @@ namespace Artemis.Core.Services
{ {
// Compare versions, copy if the same when debugging // Compare versions, copy if the same when debugging
PluginInfo pluginInfo = JsonConvert.DeserializeObject<PluginInfo>(File.ReadAllText(metadataFile)); PluginInfo pluginInfo = JsonConvert.DeserializeObject<PluginInfo>(File.ReadAllText(metadataFile));
#if DEBUG
if (builtInPluginInfo.Version >= pluginInfo.Version)
{
_logger.Debug("Copying updated built-in plugin {builtInPluginInfo}", builtInPluginInfo);
CopyBuiltInPlugin(subDirectory);
}
#else
if (builtInPluginInfo.Version > pluginInfo.Version) if (builtInPluginInfo.Version > pluginInfo.Version)
{ {
_logger.Debug("Copying updated built-in plugin from {pluginInfo} to {builtInPluginInfo}", pluginInfo, builtInPluginInfo); _logger.Debug("Copying updated built-in plugin from {pluginInfo} to {builtInPluginInfo}", pluginInfo, builtInPluginInfo);
CopyBuiltInPlugin(subDirectory); CopyBuiltInPlugin(zipFile, archive);
} }
#endif
} }
catch (Exception e) catch (Exception e)
{ {
@ -369,9 +365,9 @@ namespace Artemis.Core.Services
UnloadPlugins(); UnloadPlugins();
} }
private static void CopyBuiltInPlugin(DirectoryInfo builtInPluginDirectory) private void CopyBuiltInPlugin(FileInfo zipFileInfo, ZipArchive zipArchive)
{ {
DirectoryInfo pluginDirectory = new DirectoryInfo(Path.Combine(Constants.DataFolder, "plugins", builtInPluginDirectory.Name)); DirectoryInfo pluginDirectory = new DirectoryInfo(Path.Combine(Constants.DataFolder, "plugins", Path.GetFileNameWithoutExtension(zipFileInfo.Name)));
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
@ -379,11 +375,11 @@ namespace Artemis.Core.Services
pluginDirectory.DeleteRecursively(); pluginDirectory.DeleteRecursively();
Directory.CreateDirectory(pluginDirectory.FullName); Directory.CreateDirectory(pluginDirectory.FullName);
builtInPluginDirectory.CopyFilesRecursively(pluginDirectory); zipArchive.ExtractToDirectory(pluginDirectory.FullName, true);
if (createLockFile) if (createLockFile)
File.Create(Path.Combine(pluginDirectory.FullName, "artemis.lock")).Close(); File.Create(Path.Combine(pluginDirectory.FullName, "artemis.lock")).Close();
} }
#region Events #region Events
public event EventHandler CopyingBuildInPlugins; public event EventHandler CopyingBuildInPlugins;