Added framework support and rest API for creating and deleting plugin instances.

Author: sebinside

src/main/scala/org/codeoverflow/chatoverflow/framework/PluginFramework.scala

@@ -17,6 +17,17 @@ class PluginFramework(pluginDirectoryPath: String) extends WithLogger {
   private val pluginTypes: ListBuffer[PluginType] = ListBuffer[PluginType]()
   private val loadedJarPaths: ListBuffer[String] = ListBuffer[String]()
 
+  /**
+    * Returns, if a plugin type exists.
+    *
+    * @param pluginName   the name of the plugin set in the plugin jar file
+    * @param pluginAuthor the author of the plugin
+    * @return true, if the specified plugin type exists
+    */
+  def pluginExists(pluginName: String, pluginAuthor: String): Boolean = {
+    getPlugin(pluginName, pluginAuthor).isDefined
+  }
+
   /**
     * Returns the plugin type specified by name and author.
     *

src/main/scala/org/codeoverflow/chatoverflow/instance/PluginInstance.scala

@@ -168,6 +168,8 @@ class PluginInstance(val instanceName: String, pluginType: PluginType) extends W
                     }
                   }
 
+                  // TODO: Also connectors & input/output should be shutdown somewhere (if the plugin ends OR is ended)
+
                   // After the loop (or setup) the plugin should end
                   plugin.get.shutdown()
 

src/main/scala/org/codeoverflow/chatoverflow/instance/PluginInstanceRegistry.scala

@@ -52,6 +52,29 @@ class PluginInstanceRegistry extends WithLogger {
     pluginInstances.get(instanceName)
   }
 
+  /**
+    * Removes a plugin specified by its name, if possible.
+    *
+    * @param instanceName the name of the instance to remove
+    * @return true, if the removing process was possible
+    */
+  def removePluginInstance(instanceName: String): Boolean = {
+    if (pluginInstances.contains(instanceName) && pluginInstances(instanceName).isRunning) {
+      false
+    } else {
+      pluginInstances -= instanceName
+      true
+    }
+  }
+
+  /**
+    * Returns if the registry contains a specified instanceName (key).
+    *
+    * @param instanceName the name to search for
+    * @return true, if a plugin instance with the given name exists
+    */
+  def pluginInstanceExists(instanceName: String): Boolean = pluginInstances.contains(instanceName)
+
   /**
     * Returns a list of all plugin instances. Can be used to serialize the instance content.
     *

src/main/scala/org/codeoverflow/chatoverflow/ui/web/JsonServlet.scala

@@ -1,5 +1,7 @@
 package org.codeoverflow.chatoverflow.ui.web
 
+import javax.servlet.http.HttpServletRequest
+import org.codeoverflow.chatoverflow.ui.web.rest.DTOs.ResultMessage
 import org.codeoverflow.chatoverflow.{ChatOverflow, Launcher}
 import org.json4s.{DefaultFormats, Formats}
 import org.scalatra.json.JacksonJsonSupport
@@ -16,4 +18,31 @@ abstract class JsonServlet extends ScalatraServlet with JacksonJsonSupport with
   before() {
     contentType = formats("json")
   }
+
+  /**
+    * Utility function to parse incoming json-body-arguments. Uses a lot of scala magic. Magical!
+    *
+    * @param func    the function (taking an object T, returning a ResultMessage) to call, if the parsing process was successful
+    * @param request the request, implicitly provided by the scalatra environment
+    * @tparam T the type of body you want (probably a case class)
+    * @return a ResultMessage-object containing only true if successful, otherwise false and a error message
+    */
+  protected def parsedAs[T: Manifest](func: T => ResultMessage)(implicit request: HttpServletRequest): ResultMessage = {
+    val errorMessage = ResultMessage(success = false, "Unable to parse. Wrong body-format.")
+
+    if (request.body == "") {
+      // No body provided
+      errorMessage
+    } else {
+      // Parse json, extract case class, execute func
+      val json = parse(request.body)
+      val data = json.extractOpt[T](DefaultFormats, manifest[T])
+
+      if (data.isEmpty) {
+        errorMessage
+      } else {
+        func(data.get)
+      }
+    }
+  }
 }

src/main/scala/org/codeoverflow/chatoverflow/ui/web/rest/DTOs.scala

@@ -24,4 +24,8 @@ object DTOs {
                               areCredentialsSet: Boolean, isRunning: Boolean, requiredCredentialKeys: Seq[String],
                               optionalCredentialKeys: Seq[String])
 
+  case class PluginInstanceRef(instanceName: String, pluginName: String, pluginAuthor: String)
+
+  case class ResultMessage(success: Boolean, message: String = "")
+
 }

src/main/scala/org/codeoverflow/chatoverflow/ui/web/rest/plugin/PluginInstanceController.scala

@@ -3,7 +3,7 @@ package org.codeoverflow.chatoverflow.ui.web.rest.plugin
 import org.codeoverflow.chatoverflow.api.io
 import org.codeoverflow.chatoverflow.api.plugin.configuration
 import org.codeoverflow.chatoverflow.ui.web.JsonServlet
-import org.codeoverflow.chatoverflow.ui.web.rest.DTOs.{PluginInstance, Requirement}
+import org.codeoverflow.chatoverflow.ui.web.rest.DTOs.{PluginInstance, PluginInstanceRef, Requirement, ResultMessage}
 import org.scalatra.swagger.Swagger
 
 import scala.collection.JavaConverters._
@@ -45,15 +45,54 @@ class PluginInstanceController(implicit val swagger: Swagger) extends JsonServle
     val index = startIndex.getOrElse("0")
     val msg = logMessages.toArray.drop(Integer.parseInt(index))
     msg.toSeq
+  }
 
+  post("/", operation(postInstance)) {
+    parsedAs[PluginInstanceRef] {
+      case PluginInstanceRef(instanceName, pluginName, pluginAuthor) =>
+        // Check existence of key first
+        if (chatOverflow.pluginInstanceRegistry.pluginInstanceExists(instanceName)) {
+          ResultMessage(success = false, "Plugin instance already exists.")
+
+        } else if (!chatOverflow.pluginFramework.pluginExists(pluginName, pluginAuthor)) {
+          ResultMessage(success = false, "Plugin type does not exist.")
+
+        } else {
+          val pluginType = chatOverflow.pluginFramework.getPlugin(pluginName, pluginAuthor)
+
+          if (!chatOverflow.pluginInstanceRegistry.addPluginInstance(instanceName, pluginType.get)) {
+            ResultMessage(success = false, "Unable to create new plugin instance.")
+          } else {
+            chatOverflow.save()
+            ResultMessage(success = true)
+          }
+        }
+    }
+  }
+
+  delete("/:instanceName", operation(deleteInstance)) {
+    val instanceName = params("instanceName")
+
+    val pluginInstance = chatOverflow.pluginInstanceRegistry.getPluginInstance(instanceName)
+
+    if (pluginInstance.isEmpty) {
+      ResultMessage(success = false, "Plugin instance not found.")
+
+    } else if (pluginInstance.get.isRunning) {
+      ResultMessage(success = false, "Plugin instance is running.")
+
+    } else if (!chatOverflow.pluginInstanceRegistry.removePluginInstance(instanceName)) {
+      ResultMessage(success = false, "Unable to remove plugin instance.")
+
+    } else {
+      chatOverflow.save()
+      ResultMessage(success = true)
+    }
   }
 
   private def pluginInstanceToDTO(pluginInstance: org.codeoverflow.chatoverflow.instance.PluginInstance) = {
     PluginInstance(pluginInstance.instanceName, pluginInstance.getPluginTypeName,
       pluginInstance.getPluginTypeAuthor, pluginInstance.isRunning,
       pluginInstance.getRequirements.getRequirementMap.keySet().asScala.toList)
-
   }
-
-
 }

src/main/scala/org/codeoverflow/chatoverflow/ui/web/rest/plugin/PluginInstanceControllerDefinition.scala

@@ -1,6 +1,6 @@
 package org.codeoverflow.chatoverflow.ui.web.rest.plugin
 
-import org.codeoverflow.chatoverflow.ui.web.rest.DTOs.{PluginInstance, Requirement}
+import org.codeoverflow.chatoverflow.ui.web.rest.DTOs.{PluginInstance, PluginInstanceRef, Requirement, ResultMessage}
 import org.scalatra.swagger.SwaggerSupport
 import org.scalatra.swagger.SwaggerSupportSyntax.OperationBuilder
 
@@ -30,6 +30,17 @@ trait PluginInstanceControllerDefinition extends SwaggerSupport {
       parameter pathParam[String]("instanceName").description("The name of the plugin instance.")
       parameter queryParam[Option[String]]("startIndex").description("The start index of the message stream").optional)
 
+  val postInstance: OperationBuilder =
+    (apiOperation[ResultMessage]("postInstance")
+      summary "Creates a new plugin instance."
+      description "Creates a new plugin instance with given name and plugin type."
+      parameter bodyParam[PluginInstanceRef]("body").description("Requires new instance name and PluginType (name and author)."))
+
+  val deleteInstance: OperationBuilder =
+    (apiOperation[PluginInstance]("deleteInstance")
+      summary "Removes a plugin instance."
+      description "Removes a plugin instance specified by its name, if possible."
+      parameter pathParam[String]("instanceName").description("The name of the plugin instance."))
 
   override protected def applicationDescription: String = "Handles plugin instances and requirements."