Merge branch 'master' of https://github.com/strifel/chatoverflow

Author: strifel

src/main/scala/org/codeoverflow/chatoverflow/configuration/ConfigurationService.scala

@@ -24,6 +24,9 @@ class ConfigurationService(val configFilePath: String) extends WithLogger {
       <connectorInstances></connectorInstances>
     </config>
 
+  // Note: Right now, its not supported to reload the framework / load the config more than once. So, caching is easy!
+  private var cachedXML: Option[Node] = None
+
   /**
     * Reads the config xml file and creates plugin instances, saved in the instance registry.
     *
@@ -73,6 +76,22 @@ class ConfigurationService(val configFilePath: String) extends WithLogger {
     }
   }
 
+  /**
+    * Loads the config xml file and return its content. Supports caching of the xml file.
+    */
+  private def loadXML(): Node = {
+    if (cachedXML.isEmpty) {
+      if (!new File(configFilePath).exists()) {
+        logger debug s"Config file '$configFilePath' not found. Initialising with default values."
+        saveXML(defaultContent)
+      }
+
+      cachedXML = Some(xml.Utility.trim(xml.XML.loadFile(configFilePath)))
+      logger info "Loaded config file."
+    }
+    cachedXML.get
+  }
+
   /**
     * Load all connector instances from the config xml and save them to the connector registry.
     *
@@ -103,20 +122,6 @@ class ConfigurationService(val configFilePath: String) extends WithLogger {
     }
   }
 
-  /**
-    * Loads the config xml file and return its content.
-    */
-  private def loadXML(): Node = {
-    if (!new File(configFilePath).exists()) {
-      logger debug s"Config file '$configFilePath' not found. Initialising with default values."
-      saveXML(defaultContent)
-    }
-
-    val xmlContent = xml.Utility.trim(xml.XML.loadFile(configFilePath))
-    logger info "Loaded config file."
-    xmlContent
-  }
-
   /**
     * Saves all connector and plugin instances.
     *
@@ -154,7 +159,7 @@ class ConfigurationService(val configFilePath: String) extends WithLogger {
   private def saveXML(xmlContent: Node): Unit = {
     // Create config folder, if not existent
     val dir = new File(configFilePath).getParentFile
-    if(!dir.exists()) {
+    if (!dir.exists()) {
       dir.mkdir()
     }
 
@@ -195,7 +200,10 @@ class ConfigurationService(val configFilePath: String) extends WithLogger {
     val requirementMap = requirements.getRequirementMap
     val keys = requirementMap.keySet().toArray
 
-    for (key <- keys) yield {
+    for {
+      key <- keys
+      if requirementMap.get(key).isSet
+    } yield {
       <requirement>
         <uniqueRequirementId>
           {key}
@@ -204,7 +212,7 @@ class ConfigurationService(val configFilePath: String) extends WithLogger {
           {requirementMap.get(key).getTargetType.getName}
         </targetType>
         <content>
-          {if (requirementMap.get(key).isSet) requirementMap.get(key).get().serialize()}
+          {requirementMap.get(key).get().serialize()}
         </content>
       </requirement>
     }

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

@@ -150,7 +150,7 @@ class PluginInstanceController(implicit val swagger: Swagger) extends JsonServle
               if (!ConfigurationService.fulfillRequirementByDeserializing(instanceName, requirementID, targetType,
                 value, chatOverflow.pluginInstanceRegistry, chatOverflow.typeRegistry)) {
 
-                ResultMessage(success = false, "Unable to set requirement.")
+                ResultMessage(success = false, "Unable to set the requirement.")
               } else {
                 chatOverflow.save()
                 ResultMessage(success = true)
@@ -161,6 +161,40 @@ class PluginInstanceController(implicit val swagger: Swagger) extends JsonServle
     }
   }
 
+  delete("/:instanceName/requirements/:requirementID", operation(deleteRequirement)) {
+    authKeyRequired {
+      val instanceName = params("instanceName")
+      val requirementID = params("requirementID")
+
+      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 is running.")
+
+        } else if (!pluginInstance.get.getRequirements.getRequirementById(requirementID).isPresent) {
+          ResultMessage(success = false, "Requirement not found.")
+        } else {
+
+          if (!pluginInstance.get.getRequirements.unsetRequirementById(requirementID)) {
+
+            ResultMessage(success = false, "Unable to remove the requirement. Already removed.")
+          } else {
+            chatOverflow.save()
+            ResultMessage(success = true)
+          }
+        }
+      }
+
+    }
+  }
+
   get("/:instanceName/log", operation(getLog)) {
     authKeyRequired {
       val instanceName = params("instanceName")

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

@@ -44,6 +44,14 @@ trait PluginInstanceControllerDefinition extends SwaggerSupport with TagSupport
       parameter pathParam[String]("instanceName").description("The name of the plugin instance.")
       parameter pathParam[String]("requirementID").description("The unique id of the requirement.")
       parameter bodyParam[RequirementInfo]("body").description("Requires target type and serialized content."))
+  val deleteRequirement: OperationBuilder =
+    (apiOperation[ResultMessage]("deleteRequirement")
+      summary "Removes a specific requirement."
+      description "Removes a specific requirement by unseting its value."
+      tags controllerTag
+      parameter authHeader
+      parameter pathParam[String]("instanceName").description("The name of the plugin instance.")
+      parameter pathParam[String]("requirementID").description("The unique id of the requirement."))
   val getLog: OperationBuilder =
     (apiOperation[List[String]]("getLog")
       summary "Shows the log of a plugin instance."