#340 New support for installing plugins

Author: rjrudin

src/main/java/com/marklogic/appdeployer/AppConfig.java

@@ -237,6 +237,7 @@ public class AppConfig {
 	private File projectDir;
 
 	private DataConfig dataConfig;
+	private PluginConfig pluginConfig;
 
 	public AppConfig() {
         this(null);
@@ -246,6 +247,7 @@ public AppConfig(File projectDir) {
 		this.projectDir = projectDir;
 
 		dataConfig = new DataConfig(projectDir);
+		pluginConfig = new PluginConfig(projectDir);
 
 		modulePaths = new ArrayList<>();
 		String path = projectDir != null ? new File(projectDir, DEFAULT_MODULES_PATH).getAbsolutePath() : DEFAULT_MODULES_PATH;
@@ -1325,4 +1327,12 @@ public DataConfig getDataConfig() {
 	public void setDataConfig(DataConfig dataConfig) {
 		this.dataConfig = dataConfig;
 	}
+
+	public PluginConfig getPluginConfig() {
+		return pluginConfig;
+	}
+
+	public void setPluginConfig(PluginConfig pluginConfig) {
+		this.pluginConfig = pluginConfig;
+	}
 }

src/main/java/com/marklogic/appdeployer/DefaultAppConfigFactory.java

@@ -690,6 +690,7 @@ public void initialize() {
 		});
 
 		registerDataLoadingProperties();
+		registerPluginProperties();
 	}
 
 	protected void registerDataLoadingProperties() {
@@ -739,6 +740,33 @@ protected void registerDataLoadingProperties() {
 		});
 	}
 
+	protected void registerPluginProperties() {
+		propertyConsumerMap.put("mlPluginDatabaseName", (config, prop) -> {
+			logger.info("Database that plugins will be loaded into and installed from: " + prop);
+			config.getPluginConfig().setDatabaseName(prop);
+		});
+
+		propertyConsumerMap.put("mlPluginInstallationEnabled", (config, prop) -> {
+			logger.info("Whether plugins will be installed: " + prop);
+			config.getPluginConfig().setEnabled(Boolean.parseBoolean(prop));
+		});
+
+		propertyConsumerMap.put("mlPluginPaths", (config, prop) -> {
+			logger.info("Paths that plugins will be installed from: " + prop);
+			List<String> paths = new ArrayList<>();
+			for (String s : prop.split(",")) {
+				String path = this.projectDir != null ? new File(projectDir, s).getAbsolutePath() : s;
+				paths.add(path);
+			}
+			config.getPluginConfig().setPluginPaths(paths);
+		});
+
+		propertyConsumerMap.put("mlPluginUriPrefix", (config, prop) -> {
+			logger.info("URI prefix for plugins: " + prop);
+			config.getPluginConfig().setUriPrefix(prop);
+		});
+	}
+
 	protected ConfigDir buildConfigDir(String path) {
 		File baseDir = this.projectDir != null ? new File(this.projectDir, path) : new File(path);
 		return new ConfigDir(baseDir);

src/main/java/com/marklogic/appdeployer/PluginConfig.java

@@ -0,0 +1,110 @@
+package com.marklogic.appdeployer;
+
+import java.io.File;
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * This is for installing MarkLogic plugins, not Data Hub Framework plugins.
+ */
+public class PluginConfig {
+
+	public final static String DEFAULT_PLUGIN_PATH = "src/main/ml-plugins";
+	public final static String DEFAULT_PLUGIN_URI_PREFIX = "/com.marklogic/plugins/";
+
+	public final static String DEFAULT_INSTALL_SCRIPT = "import module namespace plugin = 'http://marklogic.com/extension/plugin' at 'MarkLogic/plugin/plugin.xqy'; " +
+		"declare variable $uri external; " +
+		"declare variable $scope external; " +
+		"plugin:install-from-zip($scope, fn:doc($uri)/node())";
+
+	public final static String DEFAULT_UNINSTALL_SCRIPT = "import module namespace plugin = 'http://marklogic.com/extension/plugin' at 'MarkLogic/plugin/plugin.xqy'; " +
+		"declare variable $scope external; " +
+		"plugin:uninstall($scope)";
+
+	private List<String> pluginPaths;
+	private boolean enabled = true;
+	private String databaseName;
+	private String uriPrefix = DEFAULT_PLUGIN_URI_PREFIX;
+	private String installScript = DEFAULT_INSTALL_SCRIPT;
+	private String uninstallScript = DEFAULT_UNINSTALL_SCRIPT;
+	private String makeCommand = "make";
+	private String scope = "native";
+
+	private File projectDir;
+
+	public PluginConfig(File projectDir) {
+		this.projectDir = projectDir;
+
+		pluginPaths = new ArrayList<>();
+		String path = projectDir != null ? new File(projectDir, DEFAULT_PLUGIN_PATH).getAbsolutePath() : DEFAULT_PLUGIN_PATH;
+		pluginPaths.add(path);
+	}
+
+	public List<String> getPluginPaths() {
+		return pluginPaths;
+	}
+
+	public void setPluginPaths(List<String> pluginPaths) {
+		this.pluginPaths = pluginPaths;
+	}
+
+	public boolean isEnabled() {
+		return enabled;
+	}
+
+	public void setEnabled(boolean enabled) {
+		this.enabled = enabled;
+	}
+
+	public String getDatabaseName() {
+		return databaseName;
+	}
+
+	public void setDatabaseName(String databaseName) {
+		this.databaseName = databaseName;
+	}
+
+	public String getUriPrefix() {
+		return uriPrefix;
+	}
+
+	public void setUriPrefix(String uriPrefix) {
+		this.uriPrefix = uriPrefix;
+	}
+
+	public String getInstallScript() {
+		return installScript;
+	}
+
+	public void setInstallScript(String installScript) {
+		this.installScript = installScript;
+	}
+
+	public String getMakeCommand() {
+		return makeCommand;
+	}
+
+	public void setMakeCommand(String makeCommand) {
+		this.makeCommand = makeCommand;
+	}
+
+	public String getScope() {
+		return scope;
+	}
+
+	public void setScope(String scope) {
+		this.scope = scope;
+	}
+
+	public String getUninstallScript() {
+		return uninstallScript;
+	}
+
+	public void setUninstallScript(String uninstallScript) {
+		this.uninstallScript = uninstallScript;
+	}
+
+	public File getProjectDir() {
+		return projectDir;
+	}
+}

src/main/java/com/marklogic/appdeployer/command/SortOrderConstants.java

@@ -77,6 +77,8 @@ public abstract class SortOrderConstants {
 
     public static Integer LOAD_DATA = 1300;
 
+    public static Integer INSTALL_PLUGINS = 1400;
+
 	public static Integer DELETE_MIMETYPES = 8500;
 
 	public static Integer UNASSIGN_HOSTS_FROM_GROUPS = 8590;
@@ -117,4 +119,6 @@ public abstract class SortOrderConstants {
 	public static Integer DELETE_AMPS = 2000;
 
 	public static Integer DELETE_SCHEDULED_TASKS = 1000;
+
+	public static Integer UNINSTALL_PLUGINS = 500;
 }