eu.mihosoft.vrl.devel.NativePluginCreator Maven / Gradle / Ivy
/*
* NativePluginCreator.java
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2007–2018 by Michael Hoffer,
* Copyright (c) 2015–2018 G-CSC, Uni Frankfurt,
* Copyright (c) 2009–2015 Steinbeis Forschungszentrum (STZ Ölbronn)
*
* This file is part of Visual Reflection Library (VRL).
*
* VRL is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* as published by the Free Software Foundation.
*
* see: http://opensource.org/licenses/LGPL-3.0
* file://path/to/VRL/src/eu/mihosoft/vrl/resources/license/lgplv3.txt
*
* VRL 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 Lesser General Public License for more details.
*
* This version of VRL includes copyright notice and attribution requirements.
* According to the LGPL this information must be displayed even if you modify
* the source code of VRL. Neither the VRL Canvas attribution icon nor any
* copyright statement/attribution may be removed.
*
* Attribution Requirements:
*
* If you create derived work you must do three things regarding copyright
* notice and author attribution.
*
* First, the following text must be displayed on the Canvas:
* "based on VRL source code". In this case the VRL canvas icon must be removed.
*
* Second, the copyright notice must remain. It must be reproduced in any
* program that uses VRL.
*
* Third, add an additional notice, stating that you modified VRL. A suitable
* notice might read
* "VRL source code modified by YourName 2012".
*
* Note, that these requirements are in full accordance with the LGPL v3
* (see 7. Additional Terms, b).
*
* Please cite the publication(s) listed below.
*
* Publications:
*
* M. Hoffer, C. Poliwoda, & G. Wittum. (2013). Visual reflection library:
* a framework for declarative GUI programming on the Java platform.
* Computing and Visualization in Science, 2013, 16(4),
* 181–192. http://doi.org/10.1007/s00791-014-0230-y
*/
package eu.mihosoft.vrl.devel;
import eu.mihosoft.vrl.annotation.ComponentInfo;
import eu.mihosoft.vrl.annotation.MethodInfo;
import eu.mihosoft.vrl.annotation.ObjectInfo;
import eu.mihosoft.vrl.annotation.ParamInfo;
import eu.mihosoft.vrl.io.IOUtil;
import eu.mihosoft.vrl.reflection.VisualCanvas;
import eu.mihosoft.vrl.system.PluginDataController;
import eu.mihosoft.vrl.types.CanvasRequest;
import eu.mihosoft.vrl.visual.Message;
import eu.mihosoft.vrl.visual.MessageType;
import eu.mihosoft.vrl.visual.VDialog;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.logging.Level;
import java.util.logging.Logger;
/**
*
* @author Michael Hoffer <[email protected]>
*/
@ComponentInfo(name = "Native Plugin Creator", category = "VRL/Development",
description = "Adds native libraries to VRL-Plugin")
@ObjectInfo(controlFlowIn = true, controlFlowOut = true)
public class NativePluginCreator implements Serializable {
private static final long serialVersionUID = 1L;
@MethodInfo(name = "", valueName = "Destination",
interactive = true, hide = false)
public File addNatives(
CanvasRequest cReq,
@ParamInfo(name = "Source", style = "load-dialog",
options = "endings=[\".jar\"];description=\"Java Library - *.jar\"") final File src,
@ParamInfo(name = "Destination", style = "save-dialog",
options = "endings=[\".jar\"];description=\"Java Library - *.jar\"") final File dest,
@ParamInfo(name = "OS/Architecture", style = "selection",
options = "value=[\"linux/x86\", \"linux/x64\", \"windows/x86\", \"windows/x64\", \"osx\"]") final String osArchFolderName,
@ParamInfo(name = "Natives", style = "load-dialog",
options = "endings=[\".zip\"];description=\"Natives - *.zip\"") final File natives,
@ParamInfo(name="Ask if File exists", options="value=true") boolean ask) {
if (cReq != null) {
addNatives(
src,
dest,
natives,
osArchFolderName,
ask,
new AddLibraryPluginActionImpl(cReq.getCanvas()));
} else {
addNatives(
src,
dest,
natives,
osArchFolderName,
ask,
null);
}
return dest;
}
private static class AddLibraryPluginActionImpl
implements eu.mihosoft.vrl.devel.AddNativeLibrariesAction {
private VisualCanvas canvas;
public AddLibraryPluginActionImpl(VisualCanvas canvas) {
this.canvas = canvas;
}
@Override
public boolean overwrite(File destFile) {
return VDialog.showConfirmDialog(canvas,
"Overwrite file?",
"Shall the file "
+ Message.EMPHASIZE_BEGIN
+ destFile
+ Message.EMPHASIZE_END
+ " be overwritten?.",
VDialog.DialogType.YES_NO)
== VDialog.YES;
}
@Override
public void cannotAdd(Exception ex) {
canvas.getMessageBox().addUniqueMessage(
"Cannot Add Native Libraries",
ex.toString(), null, MessageType.ERROR);
}
@Override
public void added(File f) {
canvas.getMessageBox().addMessage(
"Added native Libraries:",
">> the library "
+ f.getName() + " has been created.",
MessageType.INFO);
}
@Override
public void illegalDest(File destFile) {
canvas.getMessageBox().addUniqueMessage(
"Cannot Add Native Libraries", ">> File "
+ Message.EMPHASIZE_BEGIN
+ destFile
+ Message.EMPHASIZE_END
+ " does not specify a valid Java library."
+ " Java libraries must end with .jar",
null, MessageType.ERROR);
}
@Override
public void nativesDontExist(File natives) {
canvas.getMessageBox().addUniqueMessage(
"Cannot Add Native Libraries", ">> File "
+ Message.EMPHASIZE_BEGIN
+ natives
+ Message.EMPHASIZE_END
+ " does not exist.",
null, MessageType.ERROR);
}
}; // end action
// @MethodInfo(noGUI = true)
// private static void addNatives(
// final File src,
// final File dest,
// final File natives,
// final String osArchFolder,
// final AddNativeLibrariesAction action,
// final boolean multiThreaded) {
//
// Runnable r = new Runnable() {
//
// @Override
// public void run() {
// addNatives(src, action);
// }
// };
//
//
// if (multiThreaded) {
// Thread t = new Thread(r);
// t.start();
// } else {
// r.run();
// }
// }
private static void addNatives(
final File src,
File dest,
final File natives,
final String osArchFolder,
boolean ask,
AddNativeLibrariesAction action) {
if (!dest.getName().endsWith(".jar")) {
if (action != null) {
action.illegalDest(dest);
return;
} else {
throw new IllegalArgumentException("Library must end with .jar");
}
}
if (dest.exists() && ask) {
if (action != null) {
if (!action.overwrite(dest)) {
return;
}
}
}
File tmpFolder = null;
try {
tmpFolder = IOUtil.createTempDir();
} catch (IOException ex) {
Logger.getLogger(NativePluginCreator.class.getName()).
log(Level.SEVERE, null, ex);
if (action != null) {
action.cannotAdd(ex);
}
return;
}
// copy native libraries
IOException exception = null;
File nativesFolder = new File(tmpFolder,
"eu/mihosoft/vrl/plugin/content/"
+PluginDataController.NATIVELIB+"/" + osArchFolder);
File nativesDest = new File(nativesFolder, natives.getName());
try {
// unzip VRL plugin
IOUtil.unzip(src, tmpFolder);
// unzip natives
nativesFolder.mkdirs();
IOUtil.copyFile(natives, nativesDest);
} catch (FileNotFoundException ex) {
Logger.getLogger(NativePluginCreator.class.getName()).
log(Level.SEVERE, null, ex);
exception = ex;
} catch (IOException ex) {
Logger.getLogger(NativePluginCreator.class.getName()).
log(Level.SEVERE, null, ex);
exception = ex;
}
if (exception != null) {
if (action != null) {
action.cannotAdd(exception);
}
}
try {
// IOUtil.zipContentOfFolder(
// tmpFolder.getAbsolutePath(), dest.getAbsolutePath());
IOUtil.zipContentOfFolder(
tmpFolder, dest);
} catch (IOException ex) {
Logger.getLogger(NativePluginCreator.class.getName()).
log(Level.SEVERE, null, ex);
if (action != null) {
action.cannotAdd(ex);
}
}
if (action != null) {
action.added(dest);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy