#region License Information
/* HeuristicLab
* Copyright (C) 2002-2019 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
*
* This file is part of HeuristicLab.
*
* HeuristicLab is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* HeuristicLab is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with HeuristicLab. If not, see .
*/
#endregion
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Security.Cryptography;
using System.ServiceModel;
using HeuristicLab.Core;
using HeuristicLab.PluginInfrastructure;
namespace HeuristicLab.Clients.Hive {
public static class PluginUtil {
///
/// Checks if plugins are available on Hive Server. If not they are uploaded. Ids are returned.
///
/// An active service-proxy
/// List of plugins which are available online
/// List of plugins which have been uploaded from this Task
/// List of plugins which need to be uploaded
///
public static List GetPluginDependencies(IHiveService service, List onlinePlugins, List alreadyUploadedPlugins,
IEnumerable neededPlugins) {
var pluginIds = new List();
Dictionary checksumsNeededPlugins = CalcChecksumsForPlugins(neededPlugins);
foreach (var neededPlugin in checksumsNeededPlugins) {
Plugin foundPlugin = alreadyUploadedPlugins.FirstOrDefault(p => p.Hash.SequenceEqual(neededPlugin.Value));
if (foundPlugin == null) {
foundPlugin = onlinePlugins.FirstOrDefault(p => {
if (p.Hash != null) {
return p.Hash.SequenceEqual(neededPlugin.Value);
} else {
return false;
}
});
if (foundPlugin == null) {
Plugin p = CreatePlugin(neededPlugin.Key, neededPlugin.Value);
List pd = CreatePluginDatas(neededPlugin.Key);
try {
p.Id = service.AddPlugin(p, pd);
alreadyUploadedPlugins.Add(p);
pluginIds.Add(p.Id);
} catch (FaultException fault) {
onlinePlugins.Add(service.GetPlugin(fault.Detail.Id));
}
} else {
pluginIds.Add(foundPlugin.Id);
}
} else {
pluginIds.Add(foundPlugin.Id);
}
}
return pluginIds;
}
private static Plugin CreatePlugin(IPluginDescription plugin, byte[] hash) {
return new Plugin() { Name = plugin.Name, Version = plugin.Version, Hash = hash };
}
public static List CreatePluginDatas(IPluginDescription plugin) {
List pluginDatas = new List();
foreach (IPluginFile pf in plugin.Files) {
PluginData pluginData = new PluginData();
pluginData.Data = File.ReadAllBytes(pf.Name);
pluginData.FileName = Path.GetFileName(pf.Name);
pluginDatas.Add(pluginData);
}
return pluginDatas;
}
public static List GetPluginsForTask(IEnumerable usedTypes, object task) {
if (usedTypes.Any(x => typeof(IProgrammableItem).IsAssignableFrom(x))) {
//when a programmable item is used all plugins that are currently loaded need to be sent to Hive
return ApplicationManager.Manager.Plugins.ToList();
} else {
return CollectDeclaringPlugins(usedTypes);
}
}
private static List CollectDeclaringPlugins(IEnumerable usedTypes) {
List plugins = new List();
foreach (Type type in usedTypes) {
var plugin = ApplicationManager.Manager.GetDeclaringPlugin(type);
if (plugin != null && !plugins.Contains(plugin)) {
plugins.Add(plugin);
CollectPluginDependencies(plugins, plugin);
}
}
return plugins;
}
private static void CollectPluginDependencies(List plugins, IPluginDescription plugin) {
if (plugin == null) return;
foreach (var dependency in plugin.Dependencies) {
if (!plugins.Contains(dependency)) {
plugins.Add(dependency);
CollectPluginDependencies(plugins, dependency);
}
}
}
private static Dictionary CalcChecksumsForPlugins(IEnumerable neededPlugins) {
Dictionary pluginChecksums = new Dictionary();
foreach (IPluginDescription desc in neededPlugins) {
byte[] hash;
byte[] buffer = new byte[0];
//calculate checksum over all files belonging to a plugin
foreach (IPluginFile pf in desc.Files) {
byte[] tmpBuffer = File.ReadAllBytes(pf.Name);
byte[] newBuffer = new byte[buffer.Length + tmpBuffer.Length];
Array.Copy(buffer, newBuffer, buffer.Length);
Array.Copy(tmpBuffer, 0, newBuffer, buffer.Length, tmpBuffer.Length);
buffer = newBuffer;
}
using (SHA1 sha1 = SHA1.Create()) {
hash = sha1.ComputeHash(buffer);
}
pluginChecksums.Add(desc, hash);
}
return pluginChecksums;
}
}
}