Display all version numbers on startup

Author: hlxid

src/main/scala/ScalatraBootstrap.scala

@@ -1,4 +1,5 @@
 import javax.servlet.ServletContext
+import org.codeoverflow.chatoverflow.VersionInfo
 import org.codeoverflow.chatoverflow.ui.web.rest.config.ConfigController
 import org.codeoverflow.chatoverflow.ui.web.rest.connector.ConnectorController
 import org.codeoverflow.chatoverflow.ui.web.rest.events.{EventsController, EventsDispatcher}
@@ -8,11 +9,10 @@ import org.codeoverflow.chatoverflow.ui.web.{CodeOverflowSwagger, GUIServlet, Op
 import org.scalatra._
 
 /**
-  * This class provides all runtime information for Scalatra. Servlets are mounted here.
-  */
+ * This class provides all runtime information for Scalatra. Servlets are mounted here.
+ */
 class ScalatraBootstrap extends LifeCycle {
-  val apiVersion = "3.0.0-3"
-  implicit val swagger: CodeOverflowSwagger = new CodeOverflowSwagger(apiVersion)
+  implicit val swagger: CodeOverflowSwagger = new CodeOverflowSwagger(VersionInfo.rest)
 
   override def init(context: ServletContext) {
 

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

@@ -3,7 +3,6 @@ package org.codeoverflow.chatoverflow
 import java.io.File
 import java.security.Policy
 
-import org.codeoverflow.chatoverflow.api.APIVersion
 import org.codeoverflow.chatoverflow.configuration.{ConfigurationService, CredentialsService}
 import org.codeoverflow.chatoverflow.connector.ConnectorRegistry
 import org.codeoverflow.chatoverflow.framework.PluginFramework
@@ -45,8 +44,9 @@ class ChatOverflow(val pluginFolderPath: String,
   def init(): Unit = {
     logger info "Minzig!"
     logger debug s"Starting Chat Overflow Framework. " +
-      s"API Version is '${APIVersion.MAJOR_VERSION}.${APIVersion.MINOR_VERSION}'. " +
-      s"For more information and updates, please visit: http://codeoverflow.org"
+      "For more information and updates, please visit: http://codeoverflow.org"
+
+    VersionInfo.logSummary()
 
     logger debug "Initialization started."
 

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

@@ -0,0 +1,44 @@
+package org.codeoverflow.chatoverflow
+
+import org.codeoverflow.chatoverflow.api.APIVersion._
+import org.codeoverflow.chatoverflow.ui.web.GUIServlet._
+
+import scala.io.Source
+import scala.xml.XML
+
+/**
+ * VersionInfo stores the version numbers for the api, framework, rest interface, gui and the used rest interface of the gui.
+ */
+object VersionInfo extends WithLogger {
+  val api: String = s"$MAJOR_VERSION.$MINOR_VERSION"
+  val framework: String = {
+    try {
+      (XML.load(getClass.getResourceAsStream("/dependencies.pom")) \ "version").text
+    } catch {
+      case _: Exception => "unknown"
+    }
+  }
+  val rest: String = "3.0.0-3"
+  val gui: String = getGUIVersionFile("/version_gui.txt")
+  val usedRest: String = getGUIVersionFile("/version_gui_rest.txt")
+
+  def logSummary(): Unit = {
+    logger info s"Running Chat Overflow version $framework with api version $api."
+    logger info s"Providing rest interface with version $rest."
+    if (gui != "unknown") {
+      logger info s"GUI version $gui using rest interface version $usedRest detected."
+    } else {
+      logger warn "No GUI detected!"
+    }
+    if (usedRest != "unknown" && usedRest != rest) {
+      logger warn "Provided rest interface version and the used one of the GUI differ. " +
+        "GUI functionality may be restricted!"
+    }
+  }
+
+  private def getGUIVersionFile(name: String): String = try {
+    guiJar.map(jar => Source.fromInputStream(jar.getInputStream(jar.getJarEntry(name))).mkString).getOrElse("unknown")
+  } catch {
+    case _: Exception => "unknown"
+  }
+}

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

@@ -6,50 +6,35 @@ import java.util.jar.JarFile
 
 import org.codeoverflow.chatoverflow.WithLogger
 import org.eclipse.jetty.http.MimeTypes
-import org.eclipse.jetty.util.Loader
 import org.scalatra.{ActionResult, ScalatraServlet}
 
+import scala.util.Try
+
 /**
  * A servlet to serve the GUI files of the chatoverflow-gui dir from the classpath.
  * This directory is provided if the gui jar is added on the classpath.
  * Responds with an error if the gui jar isn't on the classpath.
  */
 class GUIServlet extends ScalatraServlet with WithLogger {
 
-  private val jarFilePath = {
-    val res = Loader.getResource(s"/chatoverflow-gui/")
-
-    // directory couldn't be found
-    if (res == null) {
-      logger error "GUI couldn't be found on the classpath! Has the GUI been built?"
-      None
-    } else {
-      // remove the path inside the jar and only keep the file path to the jar file
-      val jarPath = res.getFile.split("!").head
-      logger info s"GUI jar file found at ${new File(".").toURI.relativize(new URI(jarPath))}"
-
-      Some(jarPath)
-    }
-  }
+  import GUIServlet.guiJar
 
   get("/*") {
-    if (jarFilePath.isEmpty) {
+    if (guiJar.isEmpty) {
       ActionResult(500, "GUI couldn't be found on the classpath! Has the GUI been built?", Map("Cache-Control" -> "no-cache,no-store"))
     } else {
-      val jarFile = new JarFile(new File(new URI(jarFilePath.get)))
-
       val path = if (requestPath == "/")
         "/index.html"
       else
         requestPath
 
-      val entry = jarFile.getEntry(s"/chatoverflow-gui$path")
+      val entry = guiJar.get.getEntry(s"/chatoverflow-gui$path")
 
       val res = if (entry == null) {
         ActionResult(404, s"Requested file '$path' couldn't be found in the GUI jar!", Map())
       } else {
         contentType = MimeTypes.getDefaultMimeByExtension(entry.getName)
-        val is = new BufferedInputStream(jarFile.getInputStream(entry))
+        val is = new BufferedInputStream(guiJar.get.getInputStream(entry))
         val os = response.getOutputStream
 
         Iterator.continually(is.read)
@@ -58,8 +43,19 @@ class GUIServlet extends ScalatraServlet with WithLogger {
       }
 
       response.setHeader("Cache-Control", "no-cache,no-store")
-      jarFile.close()
       res
     }
   }
 }
+
+/**
+ * This companion object holds a reference to the gui jar file.
+ */
+object GUIServlet extends WithLogger {
+  val guiJar: Option[JarFile] = Try {
+    val guiJarPath = getClass.getClassLoader.getResource("/chatoverflow-gui").getFile.split("!").head
+
+    logger info s"GUI jar file found at ${new File(".").toURI.relativize(new URI(guiJarPath))}"
+    new JarFile(new File(new URI(guiJarPath)))
+  }.toOption
+}