/// <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>
/// 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>
/// 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>
/// Parse a bukget plugin from the json result
/// </summary>
/// <param name="jsonCode"></param>
/// <returns></returns>
public BukgetPlugin(string jsonCode)
{
InitFields();
if (string.IsNullOrEmpty(jsonCode)) throw new FormatException("Invalid JSON supplied: string is empty");
if (Equals(jsonCode, "[]")) throw new FormatException("Invalid JSON supplied: array is empty");
// Load the string into a json object
JsonObject json;
// In case of an array, load the first entry
try
{
if (jsonCode.StartsWith("["))
{
json = (JsonObject) JsonConvert.Import<JsonArray>(jsonCode)[0];
}
else
{
json = JsonConvert.Import<JsonObject>(jsonCode);
}
}
catch (Exception exception)
{
throw new FormatException("Invalid JSON supplied: " + exception);
}
if (json["main"] != null) Main = (string) json["main"];
if (json["plugin_name"] != null) Name = (string) json["plugin_name"];
// If no name or mainspace, return
if (string.IsNullOrEmpty(Main) || string.IsNullOrEmpty(Name)) return;
Logger.Log(LogLevel.Info, "BukGetAPI", "parsing plugin:" + Name, Main);
// Slug
if (json["slug"] != null) Slug = (String) json["slug"];
// Description
if (json["description"] != null) Description = (String) json["description"];
// BukkitDev link
if (json["dbo_page"] != null) BukkitDevLink = (String) json["dbo_page"];
// Website
if (json["link"] != null) Website = (String) json["link"];
// Stage
if (json["stage"] != null)
{
try
{
Status = (PluginStatus) Enum.Parse(typeof (PluginStatus), json["stage"].ToString());
}
catch (Exception e)
{
Logger.Log(LogLevel.Warning, "BukgetV3", "Couldn't parse plugin status", e.Message);
}
}
// Authors
AuthorsList = JsonParser.ParseJsonStringList(json["authors"]);
// Categories
// load strings
List<String> categories = JsonParser.ParseJsonStringList(json["categories"]);
// convert to enum values
foreach (string category in categories)
{
CategoryList.Add((PluginCategory) Enum.Parse(typeof (PluginCategory), category));
}
// Versions
IEnumerable<JsonObject> versions = JsonParser.ParseJsonObjectList(json["versions"]);
foreach (JsonObject jsonObject in versions)
{
BukgetPluginVersion v = new BukgetPluginVersion(this, jsonObject.ToString());
if (v.VersionNumber != null) VersionsList.Add(v);
}
LastParsedPlugin = this;
}
/// <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);
}
/// <summary>
/// Parse a bukget plugin from the json result
/// </summary>
/// <param name="jsonCode"></param>
/// <returns></returns>
public BukgetPlugin(string jsonCode)
{
InitFields();
if (string.IsNullOrEmpty(jsonCode))
{
throw new FormatException("Invalid JSON supplied: string is empty");
}
if (Equals(jsonCode, "[]"))
{
throw new FormatException("Invalid JSON supplied: array is empty");
}
// Load the string into a json object
JsonObject json;
// In case of an array, load the first entry
try
{
if (jsonCode.StartsWith("["))
{
json = (JsonObject)JsonConvert.Import <JsonArray>(jsonCode)[0];
}
else
{
json = JsonConvert.Import <JsonObject>(jsonCode);
}
}
catch (Exception exception)
{
throw new FormatException("Invalid JSON supplied: " + exception);
}
if (json["main"] != null)
{
Main = (string)json["main"];
}
if (json["plugin_name"] != null)
{
Name = (string)json["plugin_name"];
}
// If no name or mainspace, return
if (string.IsNullOrEmpty(Main) || string.IsNullOrEmpty(Name))
{
return;
}
Logger.Log(LogLevel.Info, "BukGetAPI", "parsing plugin:" + Name, Main);
// Slug
if (json["slug"] != null)
{
Slug = (String)json["slug"];
}
// Description
if (json["description"] != null)
{
Description = (String)json["description"];
}
// BukkitDev link
if (json["dbo_page"] != null)
{
BukkitDevLink = (String)json["dbo_page"];
}
// Website
if (json["link"] != null)
{
Website = (String)json["link"];
}
// Stage
if (json["stage"] != null)
{
try
{
Status = (PluginStatus)Enum.Parse(typeof(PluginStatus), json["stage"].ToString());
}
catch (Exception e)
{
Logger.Log(LogLevel.Warning, "BukgetV3", "Couldn't parse plugin status", e.Message);
}
}
// Authors
AuthorsList = JsonParser.ParseJsonStringList(json["authors"]);
// Categories
// load strings
List <String> categories = JsonParser.ParseJsonStringList(json["categories"]);
// convert to enum values
foreach (string category in categories)
{
CategoryList.Add((PluginCategory)Enum.Parse(typeof(PluginCategory), category));
}
// Versions
IEnumerable <JsonObject> versions = JsonParser.ParseJsonObjectList(json["versions"]);
foreach (JsonObject jsonObject in versions)
{
BukgetPluginVersion v = new BukgetPluginVersion(this, jsonObject.ToString());
if (v.VersionNumber != null)
{
VersionsList.Add(v);
}
}
LastParsedPlugin = this;
}
/// <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);
}
