Added start and stop to the REST API.

Author: sebinside

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

@@ -164,6 +164,7 @@ class PluginInstance(val instanceName: String, pluginType: PluginType) extends W
                   if (plugin.get.getLoopInterval > 0) {
                     while (!threadStopAfterNextIteration) {
                       plugin.get.loop()
+                      // FIXME: This is not a loop interval. Should be responsive to the loop runtime
                       Thread.sleep(plugin.get.getLoopInterval)
                     }
                   }

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

@@ -7,6 +7,8 @@ object DTOs {
 
   case class PluginInstance(instanceName: String, pluginName: String, pluginAuthor: String, isRunning: Boolean, requirementIDs: Seq[String])
 
+  case class PluginInstanceName(instanceName: String)
+
   case class ConfigInfo(name: String, apiMajorVersion: Int, apiMinorVersion: Int, pluginFolderPath: String,
                         configFolderPath: String, requirementPackage: String, pluginDataPath: String)
 

src/main/scala/org/codeoverflow/chatoverflow/ui/web/rest/config/ConfigController.scala

@@ -4,7 +4,7 @@ import org.codeoverflow.chatoverflow.Launcher
 import org.codeoverflow.chatoverflow.api.APIVersion
 import org.codeoverflow.chatoverflow.configuration.CryptoUtil
 import org.codeoverflow.chatoverflow.ui.web.JsonServlet
-import org.codeoverflow.chatoverflow.ui.web.rest.DTOs.{ConfigInfo, Password, ResultMessage}
+import org.codeoverflow.chatoverflow.ui.web.rest.DTOs.{AuthKey, ConfigInfo, Password, ResultMessage}
 import org.scalatra.swagger._
 
 class ConfigController(implicit val swagger: Swagger) extends JsonServlet with ConfigControllerDefinition {
@@ -24,6 +24,24 @@ class ConfigController(implicit val swagger: Swagger) extends JsonServlet with C
     }
   }
 
+  // Is this even a thing?
+  post("/exit", operation(postExit)) {
+    parsedAs[AuthKey] {
+      case AuthKey(authKey) =>
+        if (authKey != chatOverflow.credentialsService.generateAuthKey()) {
+          ResultMessage(success = false, "Wrong auth key.")
+
+        } else {
+          // Give enough time to return success. Then bye bye
+          new Thread(() => {
+            Thread.sleep(500)
+            System.exit(0)
+          }).start()
+          ResultMessage(success = true)
+        }
+    }
+  }
+
   get("/login", operation(getLogin)) {
     chatOverflow.isLoaded
   }

src/main/scala/org/codeoverflow/chatoverflow/ui/web/rest/config/ConfigControllerDefinition.scala

@@ -1,6 +1,6 @@
 package org.codeoverflow.chatoverflow.ui.web.rest.config
 
-import org.codeoverflow.chatoverflow.ui.web.rest.DTOs.{ConfigInfo, Password, ResultMessage}
+import org.codeoverflow.chatoverflow.ui.web.rest.DTOs.{AuthKey, ConfigInfo, Password, ResultMessage}
 import org.scalatra.swagger.SwaggerSupport
 import org.scalatra.swagger.SwaggerSupportSyntax.OperationBuilder
 
@@ -16,6 +16,13 @@ trait ConfigControllerDefinition extends SwaggerSupport {
       summary "Triggers the saving process of the framework manually (if loaded previously)."
       description "Triggers saving of credentials and configuration. Should not be needed manually.")
 
+  val postExit: OperationBuilder =
+    (apiOperation[ResultMessage]("postExit")
+      summary "Shuts the framework down."
+      description "Shutdown the framework in the next second if a correct auth key is supplied."
+      parameter bodyParam[AuthKey]("body").description("Requires the run specific auth key."))
+
+
   val getLogin: OperationBuilder =
     (apiOperation[Boolean]("getLogin")
       summary "Returns if the framework is already loaded."

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

@@ -23,6 +23,59 @@ class PluginInstanceController(implicit val swagger: Swagger) extends JsonServle
     chatOverflow.pluginInstanceRegistry.getPluginInstance(instanceName).map(pluginInstanceToDTO)
   }
 
+  post("/start", operation(startInstance)) {
+    parsedAs[PluginInstanceName] {
+      case PluginInstanceName(instanceName) =>
+
+        if (!chatOverflow.isLoaded) {
+          ResultMessage(success = false, "Framework not loaded.")
+
+        } else {
+          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 already running.")
+
+          } else if (!pluginInstance.get.getRequirements.isComplete) {
+            ResultMessage(success = false, "Not all required requirements have been set.")
+
+          } else if (!pluginInstance.get.start()) {
+            ResultMessage(success = false, "Unable to start plugin.")
+
+          } else {
+            ResultMessage(success = true)
+          }
+        }
+    }
+  }
+
+  post("/stop", operation(stopInstance)) {
+    parsedAs[PluginInstanceName] {
+      case PluginInstanceName(instanceName) =>
+
+        if (!chatOverflow.isLoaded) {
+          ResultMessage(success = false, "Framework not loaded.")
+
+        } else {
+          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 not running.")
+
+          } else {
+            pluginInstance.get.stopPlease()
+            ResultMessage(success = true)
+          }
+        }
+    }
+  }
+
   get("/:instanceName/requirements", operation(getRequirements)) {
     val instanceName = params("instanceName")
     val returnSeq = ListBuffer[Requirement]()

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

@@ -57,6 +57,18 @@ trait PluginInstanceControllerDefinition extends SwaggerSupport {
       description "Removes a plugin instance specified by its name, if possible."
       parameter pathParam[String]("instanceName").description("The name of the plugin instance."))
 
+  val startInstance: OperationBuilder =
+    (apiOperation[ResultMessage]("startInstance")
+      summary "Starts a specific plugin instance."
+      description "Starts a specific plugin instance if possible."
+      parameter bodyParam[PluginInstanceName]("body").description("Requires the name of the plugin instance."))
+
+  val stopInstance: OperationBuilder =
+    (apiOperation[ResultMessage]("stopInstance")
+      summary "Stops a specific plugin instance."
+      description "Requires the stop of a specified plugin instance. This can take up to one loop interval."
+      parameter bodyParam[PluginInstanceName]("body").description("Requires the name of the plugin instance."))
+
   override protected def applicationDescription: String = "Handles plugin instances and requirements."
 
 }