/// <summary>
/// Clear the cache of plugin.yml files
/// </summary>
/// <remarks></remarks>
//see InstalledPlugin for more cache code
public static void ClearPluginCache()
{
if (Directory.Exists(Fl.Location(RequestFile.Cache) + "/Plugins/"))
{
Directory.Delete(Fl.Location(RequestFile.Cache) + "/Plugins/", true);
}
}
/// <summary>
/// Remove (Delete) this plugin
/// </summary>
public void Remove(bool forceRefresh = true)
{
if (!ProcessHandler.RequestServerStop())
{
return;
}
if (Directory.Exists(Fl.Location(RequestFile.Plugindir) + Name))
{
switch (
MetroMessageBox.Show(null,
"This folder seems to be associated with the " + Name + " plugin." + '\n' +
"Do you want to delete this folder?", "Delete plugin folder", MessageBoxButtons.YesNoCancel,
MessageBoxIcon.Question))
{
case DialogResult.Cancel:
return;
case DialogResult.Yes:
Directory.Delete(Fl.Location(RequestFile.Plugindir) + Name);
break;
case DialogResult.No:
break;
}
}
File.Delete(Path);
if (forceRefresh)
{
InstalledPluginManager.RefreshAllInstalledPluginsAsync();
}
}
/// <summary>
/// Install a plugin, supports .jar and .zip files
/// </summary>
/// <param name="version">Version to install</param>
/// <param name="targetlocation">Target location, plugins/name by default</param>
/// <param name="updatelist">Update the list of installed plugins</param>
/// <param name="showUi">Allow pop-up dialogs</param>
/// <remarks></remarks>
public static Boolean Install(BukgetPluginVersion version, string targetlocation = "", bool updatelist = true,
bool showUi = true)
{
if (string.IsNullOrEmpty(targetlocation) && version.Filename != null)
{
targetlocation = Fl.Location(RequestFile.Plugindir) + "/" + version.Filename;
}
if (version == null || version.Filename == null)
{
return(false);
}
if (version.Filename.EndsWith(".jar"))
{
return(InstallJar(version, targetlocation, showUi));
}
if (version.Filename.EndsWith(".zip"))
{
return(InstallZip(version, showUi));
}
MetroMessageBox.Show(Application.OpenForms[0],
Locale.Tr("The file you chose to download is not supported yet.") + Constants.vbCrLf +
Locale.Tr("At this moment only .jar and .zip files are supported."),
Locale.Tr("Not supported"), MessageBoxButtons.OK, MessageBoxIcon.Warning);
return(false);
}
/// <summary>
/// Install a jarfile
/// </summary>
/// <param name="version">Version to install</param>
/// <param name="targetlocation">Target location, plugins/name by default</param>
/// <param name="showUi">Allow pop-up dialogs</param>
/// <remarks></remarks>
private static Boolean InstallJar(BukgetPluginVersion version, string targetlocation = "", bool showUi = true)
{
if (showUi)
{
if (
MetroMessageBox.Show(Application.OpenForms[0],
Locale.Tr("You are about to install") + " " + version.Filename.Replace(".jar", "") + " (" +
version.VersionNumber + ")" + Constants.vbCrLf + Locale.Tr("Do you wish to continue?"),
Locale.Tr("Continue?"), MessageBoxButtons.YesNo, MessageBoxIcon.Question) == DialogResult.No)
{
return(false);
}
}
Logger.Log(LogLevel.Info, "BukGetAPI", "Installing plugin:" + version.Filename + ", packed as jar file");
// It's nicer to have a plugin name instead of a file name with a random version. versions are retrieved from yml files, so we're using pretty names
if (string.IsNullOrEmpty(targetlocation))
{
targetlocation = Fl.Location(RequestFile.Plugindir) + "/" + version.PluginName.ToLower();
}
FileDownloader fdd = new FileDownloader();
fdd.AddFile(version.DownloadLink, targetlocation);
fdd.ShowDialog();
InstalledPluginManager.ReloadInstalledPluginFile(targetlocation);
if (showUi)
{
ShowInstallationComplete(version.Filename.Replace(".jar", ""), version.VersionNumber);
}
return(true);
}
/// <summary>
/// Initialize everything, create cache
/// </summary>
public static void Initialize()
{
string location = null;
try
{
location = Config.ReadString("Locale", "File",
Fl.Location(RequestFile.Config) + "\\default.xml");
if (string.IsNullOrEmpty(location))
{
location = Fl.Location(RequestFile.Config) + "\\default.xml";
Config.WriteString("Locale", "File", location);
}
LoadFile(location);
LoadCache(); //everything's cached, we're ready to go
Application.ApplicationExit += ((sender, e) => Dispose());
IsInitialized = true;
}
catch (Exception e)
{
Logger.Log(LogLevel.Severe, "Locale", "Couldn't initialize locale", e.Message);
if (!String.IsNullOrEmpty(location) && File.Exists(location))
{
Logger.Log(LogLevel.Severe, "Locale", "Resetting locale file to regenerate", e.Message);
File.Delete(location); // in case of problems, delete, so it'll be regenerated next time
Application.Restart(); // force restart
}
}
}
public static void RemovePlugin(string filename)
{
if (string.IsNullOrEmpty(filename))
{
return;
}
if (!ProcessHandler.RequestServerStop())
{
MetroMessageBox.Show(Application.OpenForms[0], "The server needs to be stopped to perform the operation. The server was not stopped succesfully.", "Plugin removal cancelled",
MessageBoxButtons.OK, MessageBoxIcon.Warning);
return;
}
if (Plugins.ContainsKey(filename))
{
Plugins[filename].Remove();
}
else
{
try
{
File.Delete(Fl.Location(RequestFile.Plugindir) + "/" + filename);
}
catch (Exception exception)
{
Logger.Log(LogLevel.Warning, "InstalledPluginManager", "Failed to remove plugin", exception.Message);
MetroMessageBox.Show(Application.OpenForms[0], "Plugin removal failed", "Plugin removal failed",
MessageBoxButtons.OK, MessageBoxIcon.Error);
RefreshAllInstalledPluginsAsync();
return;
}
}
MetroMessageBox.Show(Application.OpenForms[0], filename + " was removed succesfully", "Plugin removed", MessageBoxButtons.OK, MessageBoxIcon.Information);
RefreshAllInstalledPluginsAsync();
}
/// <summary>
/// Initialize everything, create cache
/// </summary>
public static void Initialize()
{
string location = Config.ReadString("Locale", "File",
Fl.Location(RequestFile.Config) + "\\default.xml");
LoadFile(location);
LoadCache(); //everything's cached, we're ready to go
Application.ApplicationExit += ((sender, e) => Dispose());
IsInitialized = true;
}
/// <summary>
/// Save a config file
/// </summary>
/// <param name="location"></param>
public static void SaveFile(string location = "")
{
if (string.IsNullOrEmpty(location))
{
location = Fl.Location(RequestFile.Config) + CteFileName;
}
if (_cache.Count == 0)
{
Logger.Log(LogLevel.Debug, "Config", "Didn't save file: nothing to save");
return;
}
_filepath = location;
Logger.Log(LogLevel.Info, "Config", "Saving file", _filepath);
SaveCache();
}
/// <summary>
/// Loads the plugin.yml file of a .jar plugin
/// </summary>
/// <param name="path">the path of the plugin.jar file</param>
/// <param name="readCache">if this plugin should be read from cache if possible</param>
/// <returns>The InstalledPlugin (me)</returns>
/// <remarks></remarks>
public InstalledPlugin Loadplugin(string path, bool readCache = true)
{
try
{
// to reduce load times and CPU usage, plugin.yml files are cached
// location: cache/plugins/plugin_name/plugin.yml
// Detect reletive locations and prepend thise with the plugin dir
if (path.Contains(":\\") == false) // has to start with C:\ (\\ due to escaping special characters)
{
path = Fl.Location(RequestFile.Plugindir) + "\\" + path;
}
// get a fileinfo object for the plugin
FileInfo plugFileInfo = new FileInfo(path);
// get a fileinfo object for the cache
FileInfo cacheFileInfo =
new FileInfo(Fl.Location(RequestFile.Cache) + "/plugins/" + plugFileInfo.Name + "/plugin.yml");
Logger.Log(LogLevel.Info, "InstalledPlugin",
"loading plugin (step 1/2): " + plugFileInfo.Name + " - cache allowed:" + readCache);
//check if the cache exists, if not, create cache (we need this cache file, it will be read later on)
if (cacheFileInfo.Exists & readCache)
{
// cache exists, ok
Logger.Log(LogLevel.Info, "InstalledPlugin", "Reading plugin data from cache...");
}
else
{
// cache doesn't exist or is forcefully invalidated by parameter, create
//safety check
if (string.IsNullOrEmpty(path) || plugFileInfo.Exists == false)
{
return(null);
}
Logger.Log(LogLevel.Info, "InstalledPlugin",
"Plugin data not available in cache or cache not allowed. Building cache for plugin...");
Compression.Decompress(Fl.Location(RequestFile.Temp) + "/plugin", path);
// check if the plugin.yml file was decompressed
if (!File.Exists(Fl.Location(RequestFile.Temp) + "/plugin/plugin.yml"))
{
return(null);
}
if (cacheFileInfo.Directory != null && !cacheFileInfo.Directory.Exists)
{
cacheFileInfo.Directory.Create();
}
//copy the yml to cache
File.Copy(Fl.Location(RequestFile.Temp) + "/plugin/plugin.yml", cacheFileInfo.FullName, true);
if (Directory.Exists(Fl.Location(RequestFile.Temp) + "/plugin"))
{
Directory.Delete(Fl.Location(RequestFile.Temp) + "/plugin", true);
}
}
// either way is cache now okay, it already existed or was created just now
Logger.Log(LogLevel.Info, "InstalledPlugin",
"loading plugin (step 2/2): " + plugFileInfo.Name + " - cache allowed:" + readCache);
// load the yml file
if (File.Exists(cacheFileInfo.FullName))
{
Loadymlfile(cacheFileInfo.FullName);
}
FileCreationDate = File.GetLastWriteTime(path);
FileName = new FileInfo(path).Name;
if (Name == null || string.IsNullOrEmpty(Name) && FileName.Contains("."))
{
Name = FileName.Split('.')[0];
}
//if name couldn't be read from yml, parse FileName
Logger.Log(LogLevel.Info, "InstalledPlugin",
"loaded plugin: " + plugFileInfo.Name + " - cache allowed:" + readCache);
return(this);
//return this item
}
catch (Exception ex)
{
Logger.Log(LogLevel.Warning, "InstalledPlugin", "An exception occured when trying to load plugin",
ex.Message);
return(null);
}
}
/// <summary>
/// Install plguins from a zip file
/// </summary>
/// <param name="version">Version to install</param>
/// <param name="showUi">Allow pop-up dialogs</param>
/// <remarks></remarks>
private static Boolean InstallZip(BukgetPluginVersion version, bool showUi = true)
{
if (showUi)
{
if (
MetroMessageBox.Show(Application.OpenForms[0],
Locale.Tr("You are about to install") + " " + version.Filename.Replace(".zip", "") + " (" +
version.VersionNumber + ")" + Constants.vbCrLf + Locale.Tr("Do you wish to continue?"),
Locale.Tr("Continue?"), MessageBoxButtons.YesNo, MessageBoxIcon.Question) == DialogResult.No)
{
return(false);
}
}
Logger.Log(LogLevel.Info, "BukGetAPI", "Installing plugin:" + version.Filename + ", packed as zip file");
string randomName = DateTime.Now.Ticks.ToString();
string zipfile = Fl.SafeLocation(RequestFile.Temp) + "install.zip";
string extraction = Fl.SafeLocation(RequestFile.Temp) + "/install_" + randomName + "/";
FileDownloader fdd = new FileDownloader();
fdd.AddFile(version.DownloadLink, zipfile);
fdd.ShowDialog();
Compression.Decompress(extraction, zipfile);
// ******************************
// At this point, the zip file is extracted to a temporary location
// Now only the needed files should be moved
Boolean hasFileBeenMoved = false;
Boolean hasFolderBeenMoved = false;
//file is decompressed, now search the needed files
DirectoryInfo extracteDirectoryInfo = new DirectoryInfo(extraction);
List <string> extractedFileNamesList = new List <string>();
foreach (FileInfo fileInfo in extracteDirectoryInfo.GetFiles())
{
if (fileInfo.Extension == ".jar")
{
File.Copy(fileInfo.FullName,
Fl.Location(RequestFile.Plugindir) + "/" + fileInfo.Name, true);
extractedFileNamesList.Add(fileInfo.Name);
hasFileBeenMoved = true;
Logger.Log(LogLevel.Info, "BukGetAPI", "Jar file found in .zip (L1), copied:" + fileInfo.Name);
}
}
// now we check if there's a folder with the same name as the plugin. This folder should also be moved to the /plugins folder
foreach (DirectoryInfo directoryInZipInfo in extracteDirectoryInfo.GetDirectories())
{
Boolean folderShouldBeMoved = false;
foreach (string f in extractedFileNamesList)
{
if (f.Contains(directoryInZipInfo.Name))
{
folderShouldBeMoved = true;
Logger.Log(LogLevel.Info, "BukgetAPI",
"Config/Info folder found in .zip, marked directory for copy:" + directoryInZipInfo.Name);
}
}
if (!folderShouldBeMoved)
{
foreach (FileInfo fileInfo in directoryInZipInfo.GetFiles())
{
if (fileInfo.Extension == ".txt" | fileInfo.Extension == ".yml" | fileInfo.Extension == ".cfg" |
fileInfo.Extension == ".csv" | fileInfo.Extension == ".js")
{
folderShouldBeMoved = true;
Logger.Log(LogLevel.Info, "BukgetAPI",
"Config/Info file found in .zip, marked directory for copy:" + fileInfo.Name);
}
}
}
if (folderShouldBeMoved)
{
Directory.Move(directoryInZipInfo.FullName,
Fl.Location(RequestFile.Plugindir) + "/" + directoryInZipInfo.Name);
hasFileBeenMoved = false;
hasFolderBeenMoved = true;
}
// If we didn't copy a file yet, check other folders for jar files
//L2
if (!hasFileBeenMoved)
{
foreach (FileInfo fileInfo in directoryInZipInfo.GetFiles())
{
if (fileInfo.Extension != ".jar")
{
continue;
}
fileInfo.MoveTo(Fl.Location(RequestFile.Plugindir) + "/" + fileInfo.Name);
hasFileBeenMoved = true;
Logger.Log(LogLevel.Info, "BukgetAPI", "Jar file found in .zip (L2), copied:" + fileInfo.Name);
}
}
if (hasFolderBeenMoved)
{
continue;
}
// If we didn't find a config folder yet, check deeper. config folders are not required
foreach (DirectoryInfo dir2 in directoryInZipInfo.GetDirectories())
{
bool copy2 = false;
foreach (string f in extractedFileNamesList)
{
if (!f.Contains(dir2.Name))
{
continue;
}
copy2 = true;
Logger.Log(LogLevel.Info, "BukgetAPI",
"Config/Info folder found in .zip, marked directory for copy:" + dir2.Name);
}
foreach (FileInfo fileInfo in dir2.GetFiles())
{
if (fileInfo.Extension == ".txt" | fileInfo.Extension == ".yml" | fileInfo.Extension == ".cfg" |
fileInfo.Extension == ".csv" | fileInfo.Extension == ".js")
{
copy2 = true;
Logger.Log(LogLevel.Info, "BukgetAPI",
"Config/Info file found in .zip, marked directory for copy:" + fileInfo.Name);
}
}
if (copy2)
{
FsUtil.CopyFolder(directoryInZipInfo.FullName,
Fl.Location(RequestFile.Plugindir) + "/" + dir2.Name, true);
}
}
// end of second level searching
}
Logger.Log(LogLevel.Info, "BukgetAPI",
"Finished plugin installation: Success?" + (hasFileBeenMoved || hasFolderBeenMoved));
//refresh installed list
if (showUi)
{
ShowInstallationComplete(version.PluginName, version.VersionNumber);
}
return(hasFileBeenMoved || hasFolderBeenMoved);
}