Merge branch 'develop' into feature/102-gui-task-rework

# Conflicts:
#	.gitignore

Author: hlxid

.gitignore

@@ -36,4 +36,7 @@ project/plugins/project/
 /wiki/
 
 # Plugin Data
-data/
+/data/
+
+# Log Output
+/log/

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/requirement/service/twitch/chat/TwitchChatConnectListener.scala

@@ -14,7 +14,7 @@ class TwitchChatConnectListener(fn: (Boolean, String) => Unit) extends ListenerA
   override def onEvent(event: Event): Unit = {
     event match {
       case _: ConnectEvent => fn(true, "")
-      case e: ConnectAttemptFailedEvent => fn(false, "couldn't connect to irc chat server")
+      case _: ConnectAttemptFailedEvent => fn(false, "couldn't connect to irc chat server")
       case e: NoticeEvent =>
         if (e.getNotice.contains("authentication failed")) {
           fn(false, "authentication failed")

src/main/scala/org/codeoverflow/chatoverflow/requirement/service/twitch/chat/TwitchChatConnector.scala

@@ -53,6 +53,8 @@ class TwitchChatConnector(override val sourceIdentifier: String) extends Connect
 
   def isJoined(channel: String): Boolean = channels.contains(channel)
 
+  def getUsername: String = bot.getNick
+
   private def getConfig: Configuration = {
 
     if (credentials.isDefined) {

src/main/scala/org/codeoverflow/chatoverflow/requirement/service/twitch/chat/impl/TwitchChatInputImpl.scala

@@ -30,6 +30,7 @@ class TwitchChatInputImpl extends EventInputImpl[TwitchEvent, chat.TwitchChatCon
   private val emoticonRegex = """(\d+)-(\d+)""".r
 
   private var currentChannel: Option[String] = None
+  private var ignoreOwnMessages = false
 
   private val onMessageFn = onMessage _
   private val onUnknownFn = onUnknown _
@@ -41,7 +42,9 @@ class TwitchChatInputImpl extends EventInputImpl[TwitchEvent, chat.TwitchChatCon
   }
 
   private def onMessage(event: MessageEvent): Unit = {
-    if (currentChannel.isDefined && event.getChannelSource == currentChannel.get) {
+    if (currentChannel.isDefined && event.getChannelSource == currentChannel.get
+      && (!ignoreOwnMessages || event.getUser.getNick.toLowerCase != getUsername)) {
+
       val message = event.getMessage
       val color = if (event.getV3Tags.get("color").contains("#")) event.getV3Tags.get("color") else ""
       val subscriber = event.getV3Tags.get("subscriber") == "1"
@@ -103,6 +106,10 @@ class TwitchChatInputImpl extends EventInputImpl[TwitchEvent, chat.TwitchChatCon
     if (!sourceConnector.get.isJoined(currentChannel.get)) sourceConnector.get.joinChannel(currentChannel.get)
   }
 
+  override def getUsername: String = sourceConnector.get.getUsername
+
+  override def ignoreOwnMessages(ignore: Boolean): Unit = this.ignoreOwnMessages = ignore
+
   /**
     * Stops the input, called before source connector will shutdown
     *

src/main/scala/org/codeoverflow/chatoverflow/requirement/service/twitch/chat/impl/TwitchChatOutputImpl.scala

@@ -29,6 +29,8 @@ class TwitchChatOutputImpl extends OutputImpl[chat.TwitchChatConnector] with Twi
     if (!sourceConnector.get.isJoined(currentChannel.get)) sourceConnector.get.joinChannel(currentChannel.get)
   }
 
+  override def getUsername: String = sourceConnector.get.getUsername
+
   /**
     * Stops the output, called before source connector will shutdown
     *

src/main/scala/org/codeoverflow/chatoverflow/ui/CLI.scala

@@ -37,6 +37,9 @@ object CLI {
     opt[Unit]('o', "enablePluginOutput").action((_, c) =>
       c.copy(pluginLogOutputOnConsole = true)).text("set this flag to enable plugin log output on console")
 
+    opt[Unit]('f', "enableLogFile").action((_, c) =>
+      c.copy(logFileOutput = true)).text("set this flag to enable logging to log files")
+
     help("help").hidden().text("prints this usage text")
 
     note("\nFor more information, please visit http://codeoverflow.org/")
@@ -65,6 +68,7 @@ object CLI {
                     pluginDataPath: String = "data",
                     webServerPort: Int = 2400,
                     pluginLogOutputOnConsole: Boolean = false,
+                    logFileOutput: Boolean = false,
                     loginPassword: Array[Char] = Array[Char](),
                     startupPlugins: Seq[String] = Seq[String]())
 

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

@@ -38,7 +38,7 @@ class ConfigController(implicit val swagger: Swagger) extends JsonServlet with C
       // Give enough time to return success. Then bye bye
       new Thread(() => {
         Thread.sleep(500)
-        Launcher.exit()
+        System.exit(0) // Shutdown hook takes care to stop everything (registered on startup by the Launcher)
       }).start()
       ResultMessage(success = true)
     }