chylex/TweetDuck
1
0
Fork 0
mirror of https://github.com/chylex/TweetDuck.git synced 2025-06-01 02:34:04 +02:00
Code

Refactor plugin loading and validation

Browse Source
This commit is contained in:
chylex 2018-04-05 21:34:35 +02:00
parent 7fc9edc9cb
commit 44595bad40
4 changed files with 158 additions and 103 deletions

202
Plugins/Plugin.cs
View File

@ -1,28 +1,26 @@
using System; using System;
using System.Collections.Generic;
using System.IO; using System.IO;
using System.Linq;
using System.Text;
using TweetDuck.Plugins.Enums; using TweetDuck.Plugins.Enums;
namespace TweetDuck.Plugins{ namespace TweetDuck.Plugins{
sealed class Plugin{ sealed class Plugin{
private const string VersionWildcard = "*"; private const string VersionWildcard = "*";
private static readonly Version AppVersion = new Version(Program.VersionTag);
public string Identifier { get; } public string Identifier { get; }
public PluginGroup Group { get; } public PluginGroup Group { get; }
public PluginEnvironment Environments { get; } public PluginEnvironment Environments { get; }
public string Name => metadata["NAME"]; public string Name { get; }
public string Description => metadata["DESCRIPTION"]; public string Description { get; }
public string Author => metadata["AUTHOR"]; public string Author { get; }
public string Version => metadata["VERSION"]; public string Version { get; }
public string Website => metadata["WEBSITE"]; public string Website { get; }
public string ConfigFile => metadata["CONFIGFILE"]; public string ConfigFile { get; }
public string ConfigDefault => metadata["CONFIGDEFAULT"]; public string ConfigDefault { get; }
public string RequiredVersion => metadata["REQUIRES"]; public Version RequiredVersion { get; }
public bool CanRun { get; private set; } public bool CanRun { get; }
public bool HasConfig{ public bool HasConfig{
get => ConfigFile.Length > 0 && GetFullPathIfSafe(PluginFolder.Data, ConfigFile).Length > 0; get => ConfigFile.Length > 0 && GetFullPathIfSafe(PluginFolder.Data, ConfigFile).Length > 0;
@ -42,41 +40,25 @@ public string DefaultConfigPath{
private readonly string pathRoot; private readonly string pathRoot;
private readonly string pathData; private readonly string pathData;
private readonly Dictionary<string, string> metadata = new Dictionary<string, string>(8){
{ "NAME", "" },
{ "DESCRIPTION", "" },
{ "AUTHOR", "(anonymous)" },
{ "VERSION", "(unknown)" },
{ "WEBSITE", "" },
{ "CONFIGFILE", "" },
{ "CONFIGDEFAULT", "" },
{ "REQUIRES", VersionWildcard }
};
private Plugin(string path, string name, PluginGroup group, PluginEnvironment environments){ private Plugin(PluginGroup group, string identifier, string pathRoot, string pathData, Builder builder){
this.pathRoot = path; this.pathRoot = pathRoot;
this.pathData = Path.Combine(Program.PluginDataPath, group.GetIdentifierPrefix(), name); this.pathData = pathData;
this.Identifier = group.GetIdentifierPrefix()+name;
this.Group = group; this.Group = group;
this.Environments = environments; this.Identifier = identifier;
} this.Environments = builder.Environments;
private void OnMetadataLoaded(){ this.Name = builder.Name;
CanRun = CheckRequiredVersion(RequiredVersion); this.Description = builder.Description;
this.Author = builder.Author;
this.Version = builder.Version;
this.Website = builder.Website;
this.ConfigFile = builder.ConfigFile;
this.ConfigDefault = builder.ConfigDefault;
this.RequiredVersion = builder.RequiredVersion;
string configPath = ConfigPath, defaultConfigPath = DefaultConfigPath; this.CanRun = AppVersion >= RequiredVersion;
if (configPath.Length > 0 && defaultConfigPath.Length > 0 && !File.Exists(configPath) && File.Exists(defaultConfigPath)){
string dataFolder = GetPluginFolder(PluginFolder.Data);
try{
Directory.CreateDirectory(dataFolder);
File.Copy(defaultConfigPath, configPath, false);
}catch(Exception e){
throw new IOException("Could not generate a configuration file for '"+Identifier+"' plugin: "+e.Message, e);
}
}
} }
public string GetScriptPath(PluginEnvironment environment){ public string GetScriptPath(PluginEnvironment environment){
@ -132,78 +114,94 @@ public override bool Equals(object obj){
return obj is Plugin plugin && plugin.Identifier.Equals(Identifier); return obj is Plugin plugin && plugin.Identifier.Equals(Identifier);
} }
// Static // Builder
private static readonly Version AppVersion = new Version(Program.VersionTag);
private static readonly string[] EndTag = { "[END]" };
public static Plugin CreateFromFolder(string path, PluginGroup group){ public sealed class Builder{
Plugin plugin = new Plugin(path, Path.GetFileName(path), group, LoadEnvironments(path)); private static readonly Version DefaultRequiredVersion = new Version(0, 0, 0, 0);
LoadMetadata(path, plugin);
return plugin;
}
private static PluginEnvironment LoadEnvironments(string path){ public string Name { get; private set; }
PluginEnvironment environments = PluginEnvironment.None; public string Description { get; private set; } = string.Empty;
public string Author { get; private set; } = "(anonymous)";
public string Version { get; private set; } = "(unknown)";
public string Website { get; private set; } = string.Empty;
public string ConfigFile { get; private set; } = string.Empty;
public string ConfigDefault { get; private set; } = string.Empty;
public Version RequiredVersion { get; private set; } = DefaultRequiredVersion;
foreach(string file in Directory.EnumerateFiles(path, "*.js", SearchOption.TopDirectoryOnly).Select(Path.GetFileName)){ public PluginEnvironment Environments { get; private set; } = PluginEnvironment.None;
environments |= PluginEnvironmentExtensions.Values.FirstOrDefault(env => file.Equals(env.GetPluginScriptFile(), StringComparison.Ordinal));
private readonly PluginGroup group;
private readonly string pathRoot;
private readonly string pathData;
private readonly string identifier;
public Builder(PluginGroup group, string name, string pathRoot, string pathData){
this.group = group;
this.pathRoot = pathRoot;
this.pathData = pathData;
this.identifier = group.GetIdentifierPrefix()+name;
} }
if (environments == PluginEnvironment.None){ public void SetFromTag(string tag, string value){
throw new ArgumentException("Plugin has no script files"); switch(tag){
} case "NAME": this.Name = value; break;
case "DESCRIPTION": this.Description = value; break;
return environments; case "AUTHOR": this.Author = value; break;
} case "VERSION": this.Version = value; break;
case "WEBSITE": this.Website = value; break;
private static void LoadMetadata(string path, Plugin plugin){ case "CONFIGFILE": this.ConfigFile = value; break;
string metaFile = Path.Combine(path, ".meta"); case "CONFIGDEFAULT": this.ConfigDefault = value; break;
case "REQUIRES": SetRequiredVersion(value); break;
if (!File.Exists(metaFile)){ default: throw new FormatException("Invalid metadata tag: "+tag);
throw new ArgumentException("Missing .meta file");
}
string currentTag = null, currentContents = string.Empty;
foreach(string line in File.ReadAllLines(metaFile, Encoding.UTF8).Concat(EndTag).Select(line => line.TrimEnd()).Where(line => line.Length > 0)){
if (line[0] == '[' && line[line.Length-1] == ']'){
if (currentTag != null){
plugin.metadata[currentTag] = currentContents;
}
currentTag = line.Substring(1, line.Length-2).ToUpper();
currentContents = string.Empty;
if (line.Equals(EndTag[0])){
break;
}
if (!plugin.metadata.ContainsKey(currentTag)){
throw new FormatException("Invalid metadata tag: "+currentTag);
}
} }
else if (currentTag != null){ }
currentContents = currentContents.Length == 0 ? line : currentContents+Environment.NewLine+line;
public void AddEnvironment(PluginEnvironment environment){
this.Environments |= environment;
}
private void SetRequiredVersion(string versionStr){
if (System.Version.TryParse(versionStr, out Version version)){
this.RequiredVersion = version;
}
else if (versionStr == VersionWildcard){
this.RequiredVersion = DefaultRequiredVersion;
} }
else{ else{
throw new FormatException("Missing metadata tag before value: "+line); throw new FormatException("Plugin contains invalid minimum version: "+versionStr);
} }
} }
if (plugin.Name.Length == 0){ public Plugin BuildAndSetup(){
throw new FormatException("Plugin is missing a name in the .meta file"); Plugin plugin = new Plugin(group, identifier, pathRoot, pathData, this);
if (plugin.Name.Length == 0){
throw new InvalidOperationException("Plugin is missing a name in the .meta file");
}
if (plugin.Environments == PluginEnvironment.None){
throw new InvalidOperationException("Plugin has no script files");
}
// setup
string configPath = plugin.ConfigPath, defaultConfigPath = plugin.DefaultConfigPath;
if (configPath.Length > 0 && defaultConfigPath.Length > 0 && !File.Exists(configPath) && File.Exists(defaultConfigPath)){
string dataFolder = plugin.GetPluginFolder(PluginFolder.Data);
try{
Directory.CreateDirectory(dataFolder);
File.Copy(defaultConfigPath, configPath, false);
}catch(Exception e){
throw new IOException($"Could not generate a configuration file for '{plugin.Identifier}' plugin: {e.Message}", e);
}
}
// done
return plugin;
} }
if (plugin.RequiredVersion.Length == 0 || !(plugin.RequiredVersion == VersionWildcard || System.Version.TryParse(plugin.RequiredVersion, out Version _))){
throw new FormatException("Plugin contains invalid version: "+plugin.RequiredVersion);
}
plugin.OnMetadataLoaded();
}
private static bool CheckRequiredVersion(string requires){
return requires == VersionWildcard || AppVersion >= new Version(requires);
} }
} }
} }

56
Plugins/PluginLoader.cs Normal file
View File

@ -0,0 +1,56 @@
using System;
using System.IO;
using System.Linq;
using System.Text;
using TweetDuck.Plugins.Enums;
namespace TweetDuck.Plugins{
static class PluginLoader{
private static readonly string[] EndTag = { "[END]" };
public static Plugin FromFolder(string path, PluginGroup group){
string name = Path.GetFileName(path);
if (string.IsNullOrEmpty(name)){
throw new ArgumentException("Could not extract directory name from path: "+path);
}
Plugin.Builder builder = new Plugin.Builder(group, name, path, Path.Combine(Program.PluginDataPath, group.GetIdentifierPrefix(), name));
foreach(string file in Directory.EnumerateFiles(path, "*.js", SearchOption.TopDirectoryOnly).Select(Path.GetFileName)){
builder.AddEnvironment(PluginEnvironmentExtensions.Values.FirstOrDefault(env => file.Equals(env.GetPluginScriptFile(), StringComparison.Ordinal)));
}
string metaFile = Path.Combine(path, ".meta");
if (!File.Exists(metaFile)){
throw new ArgumentException("Plugin is missing a .meta file");
}
string currentTag = null, currentContents = string.Empty;
foreach(string line in File.ReadAllLines(metaFile, Encoding.UTF8).Concat(EndTag).Select(line => line.TrimEnd()).Where(line => line.Length > 0)){
if (line[0] == '[' && line[line.Length-1] == ']'){
if (currentTag != null){
builder.SetFromTag(currentTag, currentContents);
}
currentTag = line.Substring(1, line.Length-2).ToUpper();
currentContents = string.Empty;
if (line.Equals(EndTag[0])){
break;
}
}
else if (currentTag != null){
currentContents = currentContents.Length == 0 ? line : currentContents+Environment.NewLine+line;
}
else{
throw new FormatException("Missing metadata tag before value: "+line);
}
}
return builder.BuildAndSetup();
}
}
}

2
Plugins/PluginManager.cs
View File

@ -136,7 +136,7 @@ IEnumerable<Plugin> LoadPluginsFrom(string path, PluginGroup group){
Plugin plugin; Plugin plugin;
try{ try{
plugin = Plugin.CreateFromFolder(fullDir, group); plugin = PluginLoader.FromFolder(fullDir, group);
}catch(Exception e){ }catch(Exception e){
loadErrors.Add(group.GetIdentifierPrefix()+Path.GetFileName(fullDir)+": "+e.Message); loadErrors.Add(group.GetIdentifierPrefix()+Path.GetFileName(fullDir)+": "+e.Message);
continue; continue;

1
TweetDuck.csproj
View File

@ -289,6 +289,7 @@
<Compile Include="Plugins\Enums\PluginEnvironment.cs" /> <Compile Include="Plugins\Enums\PluginEnvironment.cs" />
<Compile Include="Plugins\Enums\PluginGroup.cs" /> <Compile Include="Plugins\Enums\PluginGroup.cs" />
<Compile Include="Plugins\Events\PluginErrorEventArgs.cs" /> <Compile Include="Plugins\Events\PluginErrorEventArgs.cs" />
<Compile Include="Plugins\PluginLoader.cs" />
<Compile Include="Plugins\PluginManager.cs" /> <Compile Include="Plugins\PluginManager.cs" />
<Compile Include="Plugins\PluginScriptGenerator.cs" /> <Compile Include="Plugins\PluginScriptGenerator.cs" />
<Compile Include="Properties\Resources.Designer.cs"> <Compile Include="Properties\Resources.Designer.cs">