Merged with branch develop.

Author: sebinside

.gitignore

@@ -21,6 +21,7 @@ project/plugins/project/
 /plugins-public/
 /plugins-private/
 /gui/
+/setup/
 
 # Plugin Framework
 /plugins/
@@ -36,7 +37,7 @@ project/plugins/project/
 /wiki/
 
 # Plugin Data
-data/
+/data/
 
-# Built gui
-/src/main/resources/chatoverflow-gui
+# Log Output
+/log/

build.sbt

@@ -101,6 +101,13 @@ deploy := BootstrapUtility.prepareDeploymentTask(streams.value.log, scalaMajorVe
 deployDev := BootstrapUtility.prepareDevDeploymentTask(streams.value.log, scalaMajorVersion, apiProjectPath.value, libraryDependencies.value.toList)
 gui := BuildUtility(streams.value.log).guiTask(guiProjectPath.value, streams.value.cacheDirectory / "gui")
 
+Compile / packageBin := {
+  BuildUtility(streams.value.log).packageGUITask(guiProjectPath.value, scalaMajorVersion, crossTarget.value)
+  (Compile / packageBin).value
+}
+
+Compile / unmanagedJars := (crossTarget.value ** "chatoverflow-gui*.jar").classpath
+
 // ---------------------------------------------------------------------------------------------------------------------
 // UTIL
 // ---------------------------------------------------------------------------------------------------------------------
@@ -122,4 +129,3 @@ lazy val getDependencyList = Def.task[List[ModuleID]] {
 
 // Clears the built GUI dirs on clean
 cleanFiles += baseDirectory.value / guiProjectPath.value / "dist"
-cleanFiles += baseDirectory.value / "src" / "main" / "resources" / "chatoverflow-gui"

project/BuildUtility.scala

@@ -1,9 +1,13 @@
 import java.io.{File, IOException}
 import java.nio.file.{Files, StandardCopyOption}
+import java.util.jar.Manifest
 
+import com.fasterxml.jackson.databind.ObjectMapper
 import sbt.internal.util.ManagedLogger
 import sbt.util.{FileFunction, FilesInfo}
 
+import scala.io.Source
+
 /**
   * A build utility instance handles build tasks and prints debug information using the managed logger.
   *
@@ -141,90 +145,64 @@ class BuildUtility(logger: ManagedLogger) {
         return
       }
 
-      if (installGuiDeps(guiDir, cacheDir).isEmpty)
-        return // Early return on failure, error has already been displayed
-
-      val outDir = buildGui(guiDir, cacheDir)
-      if (outDir.isEmpty)
-        return // Again early return on failure
-
-      // Copy built gui into resources, will be included in the classpath on execution of the framework
-      sbt.IO.copyDirectory(outDir.get, new File("src/main/resources/chatoverflow-gui"))
-    }
-  }
-
-  /**
-    * Download the dependencies of the gui using npm.
-    *
-    * @param guiDir   the directory of the gui.
-    * @param cacheDir a dir, where sbt can store files for caching in the "install" sub-dir.
-    * @return None, if a error occurs which will be displayed, otherwise the output directory with the built gui.
-    */
-  private def installGuiDeps(guiDir: File, cacheDir: File): Option[File] = {
-    // Check buildGui for a explanation, it's almost the same.
-
-    val install = FileFunction.cached(new File(cacheDir, "install"), FilesInfo.hash)(_ => {
-
-      logger info "Installing GUI dependencies."
-
-      val exitCode = new ProcessBuilder(getNpmCommand :+ "install": _*)
-        .inheritIO()
-        .directory(guiDir)
-        .start()
-        .waitFor()
+      val packageJson = new File(guiDir, "package.json")
 
-      if (exitCode != 0) {
-        logger error "GUI dependencies couldn't be installed, please check above log for further details."
-        return None
-      } else {
-        logger info "GUI dependencies successfully installed."
-        Set(new File(guiDir, "node_modules"))
+      if (!executeNpmCommand(guiDir, cacheDir, Set(packageJson), "install",
+        () => logger error "GUI dependencies couldn't be installed, please check above log for further details.",
+        () => new File(guiDir, "node_modules")
+      )) {
+        return // early return on failure, error has already been displayed
       }
-    })
 
-    val input = new File(guiDir, "package.json")
-    install(Set(input)).headOption
+      val srcFiles = recursiveFileListing(new File(guiDir, "src"))
+      val outDir = new File(guiDir, "dist")
+
+      executeNpmCommand(guiDir, cacheDir, srcFiles + packageJson, "run build",
+        () => logger error "GUI couldn't be built, please check above log for further details.",
+        () => outDir
+      )
+    }
   }
 
   /**
-    * Builds the gui using npm.
-    *
-    * @param guiDir   the directory of the gui.
-    * @param cacheDir a dir, where sbt can store files for caching in the "build" sub-dir.
-    * @return None, if a error occurs which will be displayed, otherwise the output directory with the built gui.
-    */
-  private def buildGui(guiDir: File, cacheDir: File): Option[File] = {
+   * Executes a npm command in the given directory and skips executing the given command
+   * if no input files have changed and the output file still exists.
+   *
+   * @param workDir  the directory in which npm should be executed
+   * @param cacheDir a directory required for caching using sbt
+   * @param inputs   the input files, which will be used for caching.
+   *                 If any one of these files change the cache is invalidated.
+   * @param command  the npm command to execute
+   * @param failed   called if npm returned an non-zero exit code
+   * @param success  called if npm returned successfully. Needs to return a file for caching.
+   *                 If the returned file doesn't exist the npm command will ignore the cache.
+   * @return true if npm returned zero as a exit code and false otherwise
+   */
+  private def executeNpmCommand(workDir: File, cacheDir: File, inputs: Set[File], command: String,
+                                failed: () => Unit, success: () => File): Boolean = {
     // sbt allows easily to cache our external build using FileFunction.cached
     // sbt will only invoke the passed function when at least one of the input files (passed in the last line of this method)
     // has been modified. For the gui these input files are all files in the src directory of the gui and the package.json.
     // sbt passes these input files to the passed function, but they aren't used, we just instruct npm to build the gui.
     // sbt invalidates the cache as well if any of the output files (returned by the passed function) doesn't exist anymore.
-
-    val build = FileFunction.cached(new File(cacheDir, "build"), FilesInfo.hash)(_ => {
-
-      logger info "Building GUI."
-
-      val buildExitCode = new ProcessBuilder(getNpmCommand :+ "run" :+ "build": _*)
+    val cachedFn = FileFunction.cached(new File(cacheDir, command), FilesInfo.hash) { _ => {
+      val exitCode = new ProcessBuilder(getNpmCommand ++ command.split("\\s+"): _*)
         .inheritIO()
-        .directory(guiDir)
+        .directory(workDir)
         .start()
         .waitFor()
 
-      if (buildExitCode != 0) {
-        logger error "GUI couldn't be built, please check above log for further details."
-        return None
+      if (exitCode != 0) {
+        failed()
+        return false
       } else {
-        logger info "GUI successfully built."
-        Set(new File(guiDir, "dist"))
+        Set(success())
       }
-    })
-
-
-    val srcDir = new File(guiDir, "src")
-    val packageJson = new File(guiDir, "package.json")
-    val inputs = recursiveFileListing(srcDir) + packageJson
+    }
+    }
 
-    build(inputs).headOption
+    cachedFn(inputs)
+    true
   }
 
   private def getNpmCommand: List[String] = {
@@ -235,6 +213,43 @@ class BuildUtility(logger: ManagedLogger) {
     }
   }
 
+  def packageGUITask(guiProjectPath: String, scalaMajorVersion: String, crossTargetDir: File): Unit = {
+    val dir = new File(guiProjectPath, "dist")
+    if (!dir.exists()) {
+      logger info "GUI hasn't been compiled. Won't create a jar for it."
+      return
+    }
+
+    val files = recursiveFileListing(dir)
+
+    // contains tuples with the actual file as the first value and the name with directory in the jar as the second value
+    val jarEntries = files.map(file => file -> s"/chatoverflow-gui/${dir.toURI.relativize(file.toURI).toString}")
+
+    val guiVersion = getGUIVersion(guiProjectPath).getOrElse("unknown")
+
+    sbt.IO.jar(jarEntries, new File(crossTargetDir, s"chatoverflow-gui_$scalaMajorVersion-$guiVersion.jar"), new Manifest())
+  }
+
+  private def getGUIVersion(guiProjectPath: String): Option[String] = {
+    val packageJson = new File(s"$guiProjectPath/package.json")
+    if (!packageJson.exists()) {
+      logger error "The package.json file of the GUI doesn't exist. Have you cloned the GUI in the correct directory?"
+      return None
+    }
+
+    val content = Source.fromFile(packageJson)
+    val version = new ObjectMapper().reader().readTree(content.mkString).get("version").asText()
+
+    content.close()
+
+    if (version.isEmpty) {
+      logger warn "The GUI version couldn't be loaded from the package.json."
+      None
+    } else {
+      Option(version)
+    }
+  }
+
   /**
    * Creates a file listing with all files including files in any sub-dir.
    *

project/plugins.sbt

@@ -1,2 +1,6 @@
 addSbtPlugin("net.virtual-void" % "sbt-dependency-graph" % "0.9.2")
 addSbtPlugin("com.eed3si9n" % "sbt-assembly" % "0.14.9")
+
+
+// JSON lib (Jackson) used for parsing the GUI version in the package.json file
+libraryDependencies += "org.json4s" %% "json4s-jackson" % "3.5.2"

src/main/scala/ScalatraBootstrap.scala

@@ -4,7 +4,7 @@ import org.codeoverflow.chatoverflow.ui.web.rest.connector.ConnectorController
 import org.codeoverflow.chatoverflow.ui.web.rest.events.{EventsController, EventsDispatcher}
 import org.codeoverflow.chatoverflow.ui.web.rest.plugin.PluginInstanceController
 import org.codeoverflow.chatoverflow.ui.web.rest.types.TypeController
-import org.codeoverflow.chatoverflow.ui.web.{CodeOverflowSwagger, OpenAPIServlet}
+import org.codeoverflow.chatoverflow.ui.web.{CodeOverflowSwagger, GUIServlet, OpenAPIServlet}
 import org.scalatra._
 
 /**
@@ -30,5 +30,7 @@ class ScalatraBootstrap extends LifeCycle {
     context.mount(new PluginInstanceController(), "/instances/*", "instances")
     context.mount(new ConnectorController(), "/connectors/*", "connectors")
     context.mount(new OpenAPIServlet(), "/api-docs")
+
+    context.mount(new GUIServlet(), "/*")
   }
 }

src/main/scala/org/codeoverflow/chatoverflow/ChatOverflow.scala

@@ -1,5 +1,6 @@
 package org.codeoverflow.chatoverflow
 
+import java.io.File
 import java.security.Policy
 
 import org.codeoverflow.chatoverflow.api.APIVersion
@@ -49,6 +50,9 @@ class ChatOverflow(val pluginFolderPath: String,
 
     logger debug "Initialization started."
 
+    logger debug "Ensuring that all required directories exist."
+    createDirectories()
+
     logger debug "Enabling framework security policy."
     enableFrameworkSecurity()
 
@@ -99,6 +103,11 @@ class ChatOverflow(val pluginFolderPath: String,
     System.setSecurityManager(new SecurityManager)
   }
 
+  private def createDirectories(): Unit = {
+    Set(pluginFolderPath, configFolderPath, Launcher.pluginDataPath)
+      .foreach(path => new File(path).mkdir())
+  }
+
   /**
     * Saves all settings and credentials to the corresponding files in the config folder.
     */

src/main/scala/org/codeoverflow/chatoverflow/Launcher.scala

@@ -1,5 +1,9 @@
 package org.codeoverflow.chatoverflow
 
+import java.time.OffsetDateTime
+import java.time.format.DateTimeFormatter
+
+import org.apache.log4j.{FileAppender, Level, Logger, PatternLayout}
 import org.codeoverflow.chatoverflow.ui.CLI.parse
 import org.codeoverflow.chatoverflow.ui.web.Server
 
@@ -19,6 +23,24 @@ object Launcher extends WithLogger {
   def main(args: Array[String]): Unit = {
     parse(args) { config =>
 
+      // Enable logging to log files if specified
+      if (config.logFileOutput) {
+        val fileName = s"log/${
+          OffsetDateTime.now().format(DateTimeFormatter.ofPattern("yyyy-MM-dd--HH-mm-ss-SSS"))
+        }.log"
+
+        // Try to retrieve the console appender layout or create a default one
+        val pattern = if (logger.getAppender("CA") != null) {
+          logger.getAppender("CA").getLayout
+        } else new PatternLayout("%-4r %d{HH:mm:ss.SSS} [%t] %-5p %c{2} %x - %m%n")
+
+        // This is the pattern from our basic console logger
+        val appender = new FileAppender(pattern, fileName, true)
+        appender.setThreshold(Level.ALL)
+
+        Logger.getRootLogger.addAppender(appender)
+      }
+
       // Set globally available plugin data path
       this.pluginDataPath = config.pluginDataPath
 
@@ -56,6 +78,8 @@ object Launcher extends WithLogger {
           logger warn "Unable to run startup plugins. No/wrong password supplied."
         }
       }
+
+      Runtime.getRuntime.addShutdownHook(new Thread(() => exit()))
     }
   }
 
@@ -98,6 +122,5 @@ object Launcher extends WithLogger {
     }
 
     logger info "Bye Bye. Stay minzig!"
-    System.exit(0)
   }
 }

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

@@ -4,7 +4,7 @@ import java.io.{File, PrintWriter}
 
 import org.codeoverflow.chatoverflow.WithLogger
 import org.codeoverflow.chatoverflow.api.io
-import org.codeoverflow.chatoverflow.api.plugin.configuration.{Requirement, Requirements}
+import org.codeoverflow.chatoverflow.api.plugin.configuration.Requirements
 import org.codeoverflow.chatoverflow.connector.ConnectorRegistry
 import org.codeoverflow.chatoverflow.framework.PluginFramework
 import org.codeoverflow.chatoverflow.instance.PluginInstanceRegistry
@@ -197,7 +197,7 @@ class ConfigurationService(val configFilePath: String) extends WithLogger {
     * Creates the xml for all requirements of a plugin.
     */
   private def createRequirementXML(requirements: Requirements): Array[Elem] = {
-    val requirementMap = requirements.getRequirementMap
+    val requirementMap = requirements.getAccess.getRequirementMap
     val keys = requirementMap.keySet().toArray
 
     for {
@@ -264,7 +264,7 @@ object ConfigurationService extends WithLogger {
       false
     } else {
       val requirements = instance.get.getRequirements
-      val requirement = requirements.getRequirementById(requirementId)
+      val requirement = requirements.getAccess.getRequirementById(requirementId)
 
       if (!requirement.isPresent) {
         logger error s"Unable to find requirement with the given id '$requirementId'."
@@ -289,7 +289,7 @@ object ConfigurationService extends WithLogger {
 
             try {
               val reqContent = loadedRequirementType.get.newInstance().asInstanceOf[io.Serializable]
-              requirement.get.asInstanceOf[Requirement[io.Serializable]].set(reqContent)
+              requirements.getAccess.setRequirementContent(requirementId, reqContent)
               reqContent.deserialize(content)
 
               logger info s"Created requirement content for '$requirementId' and deserialized its content."