feature: set unique name for logstation instance, prepend to <title/>

jdrews · Jul 1, 2018 · 667007b · 667007b
1 parent 72988ae
commit 667007b
Show file tree

Hide file tree

Showing 9 changed files with 56 additions and 12 deletions.
diff --git a/build.sbt b/build.sbt
@@ -1,6 +1,6 @@
 name := "logstation"
 
-version := "0.3.9"
+version := "0.3.10"
 
 scalaVersion := "2.10.4"
 

diff --git a/src/main/resources/webapp/index.html b/src/main/resources/webapp/index.html
@@ -3,7 +3,7 @@
 <html xmlns="http://www.w3.org/1999/xhtml">
 
 <head>
-    <title>LogStation</title>
+    <title>logstation</title>
     <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">
     <link rel="icon" href="/favicon.ico" type="image/x-icon">
 </head>

diff --git a/src/main/resources/webapp/js/LogStationScripts.js b/src/main/resources/webapp/js/LogStationScripts.js
@@ -117,6 +117,16 @@ function updateMaxLogLinesPerLog(maxLogLinesPerLog) {
     window.maxLogLinesPerLog = maxLogLinesPerLog
 }
 
+// update the logStationName in the title of the page
+// called from LogStationPage
+function updateLogStationName(logStationName) {
+    console.log("updating logStationName to " + logStationName);
+    window.logStationName = logStationName
+    if (logStationName !== '') {
+        document.title = logStationName + " - logstation"
+    }
+}
+
 // called from LogStationPage for resetting all local vars
 function resetAll() {
     console.log("resetting all");

diff --git a/src/main/resources/webapp/templates-hidden/default.html b/src/main/resources/webapp/templates-hidden/default.html
@@ -17,7 +17,6 @@
     <!-- Custom styles for this template -->
     <link href="bootstrap/css/logstation.css" rel="stylesheet">
 
-    <!-- TODO: make these files be included in
     <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
     <!--[if lt IE 9]>
     <script src="bootstrap/js/html5shiv.min.js"></script>
@@ -68,7 +67,7 @@
 
                     <p class="text-muted float-right">
                         <!-- TODO: make version populate via sbt version -->
-                        <a href="https://github.com/jdrews/logstation">logstation</a> 0.3.8</p>
+                        <a href="https://github.com/jdrews/logstation">logstation</a> 0.3.10</p>
                 </div>
                 <div style="clear: both;"></div>
 

diff --git a/src/main/scala/com/jdrews/logstation/LogStation.scala b/src/main/scala/com/jdrews/logstation/LogStation.scala
@@ -1,8 +1,8 @@
 package com.jdrews.logstation
 
 import java.io.{BufferedWriter, File, FileWriter}
-import java.awt.Desktop;
-import java.net.URI;
+import java.awt.Desktop
+import java.net.URI
 
 import akka.actor.Props
 import akka.event.Logging
@@ -28,6 +28,7 @@ import scala.util.matching.Regex
 // TODO: move these to their own files to make it a bit cleaner
 case class BufferLength (myVal: Int)
 case class MaxLogLinesPerLog (myVal: Int)
+case class LogStationName (myVal: String)
 
 //TODO: fix the user lockout follow (or disable altogether) -- add button to scroll to bottom (maybe make it hover or something cool like that?)
 object LogStation extends App {
@@ -90,10 +91,23 @@ object LogStation extends App {
         }
     }
 
+    val logStationName = {
+        if (conf.hasPath("logstation.logStationName")) {
+            val logStationName = conf.getString("logstation.logStationName")
+            logger.info(s"logStationName (user set): $logStationName")
+            logStationName
+        } else {
+            val logStationName = ""
+            logger.info(s"logStationName (default): $logStationName")
+            logStationName
+        }
+    }
+
     // Start up the BridgeActor
     private val bridge = BridgeController.getBridgeActor
     bridge ! MaxLogLinesPerLog(maxLogLinesPerLog)
     bridge ! BufferLength(bufferLength)
+    bridge ! LogStationName(logStationName)
 
     // Start up the embedded webapp
     val webServer = new EmbeddedWebapp(webServerPort, "/")

diff --git a/src/main/scala/com/jdrews/logstation/config/BridgeActor.scala b/src/main/scala/com/jdrews/logstation/config/BridgeActor.scala
@@ -2,7 +2,7 @@ package com.jdrews.logstation.config
 
 import akka.actor.{Actor, ActorLogging}
 import com.jdrews.logstation.utils.FixedList
-import com.jdrews.logstation.{BufferLength, MaxLogLinesPerLog}
+import com.jdrews.logstation.{BufferLength, LogStationName, MaxLogLinesPerLog}
 import net.liftweb.actor.LiftActor
 
 /**
@@ -18,13 +18,15 @@ class BridgeActor extends Actor with ActorLogging {
     private var bufferLength = 12
     private var maxLogLinesPerLog = 120
     private var msgs = new FixedList[Any](bufferLength)
+    private var logStationName = ""
     def receive = {
         case lift: LiftActor =>
             log.debug(s"received LiftActor: $lift")
             target = Some(lift)
 
             // send LogStationWebServer the maxLogLinesPerLog
             lift ! MaxLogLinesPerLog(maxLogLinesPerLog)
+            lift ! LogStationName(logStationName)
 
             if (msgs.nonEmpty) {
                 log.debug("sending out buffered msgs")
@@ -42,6 +44,9 @@ class BridgeActor extends Actor with ActorLogging {
             bufferLength = bl.myVal
             // rebuild msgs list with new buffer length
             msgs = new FixedList[Any](bufferLength)
+        case lsname: LogStationName =>
+            log.debug(s"received logStationName: $logStationName")
+            logStationName = lsname.myVal
         case msg =>
             if (target.isEmpty) {
                 log.debug(s"buffering this message since target is empty... $msg")

diff --git a/src/main/scala/com/jdrews/logstation/config/DefaultConfigHolder.scala b/src/main/scala/com/jdrews/logstation/config/DefaultConfigHolder.scala
@@ -41,6 +41,11 @@ object DefaultConfigHolder {
           |    #    These will be sent to any new connections so they have some history of logs
           |    #    bufferLength is multiplied by number of logs, and buffered on best effort for each log
           |    bufferLength=10
+          |
+          |    # Unique name for logstation instance
+          |    #    This name will be prepended to the browser tab
+          |    #    Can be useful when connecting to multiple logstations
+          |    #logStationName="dc10srv42"
           |}
         """.stripMargin
 }
diff --git a/src/main/scala/com/jdrews/logstation/webserver/comet/LogStationPage.scala b/src/main/scala/com/jdrews/logstation/webserver/comet/LogStationPage.scala
@@ -1,5 +1,6 @@
 package com.jdrews.logstation.webserver.comet
 
+import com.jdrews.logstation.LogStationName
 import com.jdrews.logstation.webserver.LogMessage
 import net.liftweb.common.{Full, Loggable}
 import net.liftweb.http.js.JE.JsFunc
@@ -22,15 +23,20 @@ class LogStationPage extends CometActor with CometListener with Loggable {
              logger.debug(s"got LogMessage: $lm")
              partialUpdate(JsFunc("addOrAppendLogMessage", lm.logFile, lm.logMessage).cmd)
          case nlp: NewListenerPackage =>
-            logger.debug(s"received a new listener package: $nlp")
-            partialUpdate(JsFunc("updateMaxLogLinesPerLog", nlp.maxLogLinesPerLog).cmd)
+             logger.debug(s"received a new listener package: $nlp")
+             partialUpdate(JsFunc("updateMaxLogLinesPerLog", nlp.maxLogLinesPerLog).cmd)
+             partialUpdate(JsFunc("updateLogStationName", nlp.logStationName).cmd)
              nlp.msgs.foreach{ lm =>
                  logger.debug(s"passing the following up: $lm")
                 partialUpdate(JsFunc("addOrAppendLogMessage", lm.logFile, lm.logMessage).cmd)
              }
          case mll: Int =>
+             logger.debug(s"received maxLogLinesPerLog: $mll")
              partialUpdate(JsFunc("updateMaxLogLinesPerLog", mll).cmd)
              maxLogLinesPerLog = mll
+         case lsname: LogStationName =>
+             logger.debug(s"received logStationName: $lsname")
+             partialUpdate(JsFunc("updateLogStationName", lsname.myVal).cmd)
          case something =>
              logger.warn(s"in LogStationPage: got something, not sure what it is: $something")
 

diff --git a/src/main/scala/com/jdrews/logstation/webserver/comet/LogStationWebServer.scala b/src/main/scala/com/jdrews/logstation/webserver/comet/LogStationWebServer.scala
@@ -4,7 +4,7 @@ import akka.actor.ActorRef
 import com.jdrews.logstation.config.BridgeController
 import com.jdrews.logstation.utils.FixedList
 import com.jdrews.logstation.webserver.LogMessage
-import com.jdrews.logstation.{BufferLength, MaxLogLinesPerLog}
+import com.jdrews.logstation.{BufferLength, LogStationName, MaxLogLinesPerLog}
 import net.liftweb.actor._
 import net.liftweb.common.Loggable
 import net.liftweb.http._
@@ -15,11 +15,12 @@ import net.liftweb.http._
  * Communicates with LogStationPages to push updates to the web page
  */
 
-case class NewListenerPackage ( maxLogLinesPerLog: Int, msgs: List[LogMessage])
+case class NewListenerPackage ( maxLogLinesPerLog: Int, logStationName: String, msgs: List[LogMessage])
 
 object LogStationWebServer extends LiftActor with ListenerManager with Loggable {
     private var maxLogLinesPerLog = 130
     private var bufferLength = 17
+    private var logStationName = ""
     private var msgs = new FixedList[LogMessage](bufferLength)
 
     logger.debug("at the front of LogStationWebServer...")
@@ -41,7 +42,7 @@ object LogStationWebServer extends LiftActor with ListenerManager with Loggable
      */
     def createUpdate = {
         logger.info("client connected")
-        NewListenerPackage(maxLogLinesPerLog, msgs.toList)
+        NewListenerPackage(maxLogLinesPerLog, logStationName, msgs.toList)
     }
 
     /**
@@ -63,6 +64,10 @@ object LogStationWebServer extends LiftActor with ListenerManager with Loggable
             bufferLength = bl.myVal
             // rebuild msgs list with new buffer length
             msgs = new FixedList[LogMessage](bufferLength)
+        case lsname: LogStationName =>
+            logger.debug(s"received logStationName: $lsname")
+            logStationName = lsname.myVal
+            sendListenersMessage(lsname)
         case something =>
             logger.warn(s"in LogStationWebServer: got something, not sure what it is: $something")