Merge branch 'master' of https://github.com/codeoverflow-org/chatoverflow

Author: strifel

README.md

@@ -2,35 +2,59 @@
   <img src = "chatoverflow-logo.png"/>
 </p>
 
-Imagine an [IFTTT](https://ifttt.com/), solely developed for livestreaming. 
-Living in a event-triggered environment, chat overflow reacts on inputs like twitch chat, sub messages, bits, ...
+What if you could **combine** the power of
+- **Chat bots** like *nightbot*, *moobot* and *botler*
+- **Supporting services** like *StreamElements*, *Streamlabs*, *TipeeeStream*, *Loots* and
+- **Social Media** and Chat software, e.g. *Twitter*, *Discord*, *YouTube* etc.
 
-Looking for a new chat bot, stream overlay or custom lighting in your living room, whenever someone subscribes?
-Everything can be developed with the easy-to-use API from the chat overflow framework.
+with your interactive chat in your livestream. What if you could easily react on events, e.g.
 
-One example: Chatbot. Starting with two lines of code:
+- Automatically **share** your new subscribers on twitter
+- Automatically **control** your studio's lighting colors through chat messages
+- Automatically **post** an user's cheer on your minecraft server
+- Automatically **upload** a youtube video with stream highlights when your stream stops
 
-```
- twitchChat = require.input.twitchChat(...)
+and so much more. We know, there is [IFTTT](https://ifttt.com/). But sometimes, building blocks are to generic and services aren't optimized for your streaming environment.
+
+The alternative: Develop everything by yourself and waste hundreds of hours with API-integration. We already solved this problem for you. This is **Chat Overflow**.
+
+## The ChatOverflow Project
+
+**Chat Overflow** is a plugin framework, which offers ready-to-use platform integrations for all* major streaming- and social-media-sites.
+
+**Chat Overflow** enables you to to level up your stream by writing simple, platform-independent plugins in java or scala**.
+
+It's getting even better: The **Chat Overflow** license allows you to sell your custom plugins, creating new services for other streamers. 
+
+And it's so easy. Here is all the code to get started with a simple twitch chat bot:
+
+```java
+ twitchChat = require.input.twitchChat()
  twitchChat.get.registerMessageHandler(msg => ...)
 ```
 
-Chat overflow fills the gap between simple but limited services like IFTTT and own from-scratch developed applications.
+**Chat Overflow** fills the gap between simple but limited services like IFTTT and own from-scratch developed applications.
 
 *Current development state: **Pre-Alpha***
 
-## Chat Overflow Framework
-The framework contains all information to connect to livestream inputs and outputs. Combined with the [API Project](https://github.com/codeoverflow-org/chatoverflow-api), plugins can be executed. They provide defined behavior, e.g. the [public plugins](https://github.com/codeoverflow-org/chatoverflow-plugins).
+\* There are still missing platforms. This is a open-source project. You can [help](https://github.com/codeoverflow-org/chatoverflow/issues), too!
+
+\** The API is written in java. So, every JVM-compatible language is possible. Java, Scala, Kotlin, etc.
+
+### Installation / Releases
+Head over to [releases](https://github.com/codeoverflow-org/chatoverflow/releases). 
+
+Just download the newest zip file, make sure that java is installed and launch the framework.
+
+Note that you'll have to develop your own plugins or search for plugins online (e.g. on our [Discord Server](https://discord.gg/p2HDsme)). **Chat Overflow** is only the framework.
 
 ### Development
 
 Start with the [Installation](https://github.com/codeoverflow-org/chatoverflow/wiki/Installation). Then learn more about the [CLI](https://github.com/codeoverflow-org/chatoverflow/wiki/Using-the-CLI).
 
-Please see the wiki to learn how to code new [platform sources](https://github.com/codeoverflow-org/chatoverflow/wiki/Adding-a-new-platform-source) and new [plugins](https://github.com/codeoverflow-org/chatoverflow/wiki/Writing-a-plugin).
-
-### Usage
+Please consult the wiki to learn how to code new [platform sources](https://github.com/codeoverflow-org/chatoverflow/wiki/Adding-a-new-platform-source) and new [plugins](https://github.com/codeoverflow-org/chatoverflow/wiki/Writing-a-plugin).
 
-Chat Overflow releases are not yet available. ETA Q2 2019.
+***Pre-Alpha note***: Please note that the development workflow and the documentation will be updated soon.
 
 ### Discord
 
@@ -40,4 +64,6 @@ The perfect place if you need help with the framework, found a bug or want to sh
 
 ### About Code Overflow
 
-Code Overflow started as a coding-livestream project by three computer science students @ [KIT, Karlsruhe](http://www.kit.edu/) and is headed by [skate702](http://skate702.de).
+Code Overflow started as a coding-livestream project from 3 computer science students @ [KIT, Karlsruhe](http://www.kit.edu/).
+Now, it is a team of free open-source developers, sitting all over the world (really, lol). 
+The project is headed by [skate702](http://skate702.de).

build.sbt

@@ -3,7 +3,7 @@
 // ---------------------------------------------------------------------------------------------------------------------
 
 name := "ChatOverflow"
-version := "0.2"
+version := "0.2.1"
 mainClass := Some("org.codeoverflow.chatoverflow.Launcher")
 
 // One version for all sub projects. Use "retrieveManaged := true" to download and show all library dependencies.
@@ -64,6 +64,8 @@ libraryDependencies += "net.dv8tion" % "JDA" % "3.8.3_463"
 //Serial Communication
 libraryDependencies += "com.fazecast" % "jSerialComm" % "[2.0.0,3.0.0)"
 
+// Socket.io
+libraryDependencies += "io.socket" % "socket.io-client"% "1.0.0"
 // ---------------------------------------------------------------------------------------------------------------------
 // PLUGIN FRAMEWORK DEFINITIONS
 // ---------------------------------------------------------------------------------------------------------------------
@@ -84,7 +86,7 @@ lazy val deploy = TaskKey[Unit]("deploy", "Prepares the environment for deployme
 lazy val gui = TaskKey[Unit]("gui", "Installs GUI dependencies and builds it using npm.")
 
 pluginBuildFileName := "plugins.sbt"
-pluginFolderNames := List("plugins-public")
+pluginFolderNames := List("plugins-public", "plugins-private")
 pluginTargetFolderNames := List("plugins", s"target/scala-$scalaMajorVersion/plugins")
 apiProjectPath := "api"
 guiProjectPath := "gui"

src/main/scala/ScalatraBootstrap.scala

@@ -10,7 +10,7 @@ import org.scalatra._
   * This class provides all runtime information for Scalatra. Servlets are mounted here.
   */
 class ScalatraBootstrap extends LifeCycle {
-  val apiVersion = "1.0"
+  val apiVersion = "0.2"
   implicit val swagger: CodeOverflowSwagger = new CodeOverflowSwagger(apiVersion)
 
   override def init(context: ServletContext) {

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

@@ -11,6 +11,7 @@ object Launcher extends WithLogger {
 
   var server: Option[Server] = None
   var pluginDataPath: String = "data"
+  private var chatOverflow: Option[ChatOverflow] = None
 
   /**
     * Software entry point.
@@ -24,6 +25,7 @@ object Launcher extends WithLogger {
       // The complete project visible trough one single instance
       val chatOverflow = new ChatOverflow(config.pluginFolderPath,
         config.configFolderPath, config.requirementPackage, config.pluginLogOutputOnConsole)
+      this.chatOverflow = Some(chatOverflow)
 
       // Initialize chat overflow
       chatOverflow.init()
@@ -68,7 +70,34 @@ object Launcher extends WithLogger {
     * Shuts down the framework.
     */
   def exit(): Unit = {
-    logger info "Shutting down Chat Overflow."
+    logger debug "Shutting down Chat Overflow."
+
+    if (server.isDefined) {
+      logger info "Stopping the server."
+      server.get.stop()
+    }
+
+    if (chatOverflow.isDefined) {
+      logger info "Saving all settings."
+      chatOverflow.get.save()
+
+      logger debug "Trying to stop all running instances..."
+      chatOverflow.get.pluginInstanceRegistry.getAllPluginInstances.
+        filter(_.isRunning).foreach(_.stopPlease())
+
+      for (i <- 1 to 5) {
+        if (chatOverflow.get.pluginInstanceRegistry.getAllPluginInstances.
+          exists(_.isRunning)) {
+          logger info s"Check $i of 5. Still waiting on: ${
+            chatOverflow.get.pluginInstanceRegistry.getAllPluginInstances.
+              filter(_.isRunning).map(_.instanceName).mkString(", ")
+          }"
+          Thread.sleep(1000)
+        }
+      }
+    }
+
+    logger info "Bye Bye. Stay minzig!"
     System.exit(0)
   }
 }

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

@@ -1,12 +1,13 @@
 package org.codeoverflow.chatoverflow.configuration
 
 import java.nio.charset.StandardCharsets
-import java.security.{DigestException, MessageDigest, SecureRandom}
+import java.security.{DigestException, InvalidKeyException, MessageDigest, SecureRandom}
 import java.util
 import java.util.Base64
 
 import javax.crypto.spec.{IvParameterSpec, PBEKeySpec, SecretKeySpec}
 import javax.crypto.{Cipher, SecretKeyFactory}
+import org.codeoverflow.chatoverflow.WithLogger
 
 /**
   * Provides methods to de- and encrypt using the AES-CBC algorithm.
@@ -15,7 +16,7 @@ import javax.crypto.{Cipher, SecretKeyFactory}
   * The SSL compliant / crypto-js compliant code is based on
   * https://stackoverflow.com/questions/41432896/cryptojs-aes-encryption-and-java-aes-decryption
   */
-object CryptoUtil {
+object CryptoUtil extends WithLogger {
 
   // Used for the run-unique auth key
   private val runSpecificRandom = generateIV
@@ -65,6 +66,9 @@ object CryptoUtil {
         Some(decrString.substring(5))
       }
     } catch {
+      case e: InvalidKeyException => logger.error("Your environment does not work with AES256." +
+        "Please update your java runtime version to at least: 1.8.0_161", e)
+        None
       case _: Exception => None
     }
   }
@@ -143,6 +147,13 @@ object CryptoUtil {
     new String(Base64.getEncoder.encode(message), StandardCharsets.UTF_8)
   }
 
+  private def generateSalt: Array[Byte] = {
+    val random = new SecureRandom()
+    val salt = new Array[Byte](8)
+    random.nextBytes(salt)
+    salt
+  }
+
   /**
     * Encrypts the provided plaintext using AES.
     *
@@ -173,13 +184,6 @@ object CryptoUtil {
     ciphertext.toString
   }
 
-  private def generateSalt: Array[Byte] = {
-    val random = new SecureRandom()
-    val salt = new Array[Byte](8)
-    random.nextBytes(salt)
-    salt
-  }
-
   private def generateIV: Array[Byte] = {
     val random = new SecureRandom()
     val iv = new Array[Byte](16)

src/main/scala/org/codeoverflow/chatoverflow/connector/Connector.scala

@@ -25,6 +25,8 @@ abstract class Connector(val sourceIdentifier: String) extends WithLogger {
   protected var optionalCredentialKeys: List[String]
   protected var running = false
 
+  private var instanceCount = 0
+
   def getCredentials: Option[Credentials] = this.credentials
 
   /**
@@ -76,6 +78,7 @@ abstract class Connector(val sourceIdentifier: String) extends WithLogger {
     // Check if running
     if (running) {
       logger info s"Unable to start $connectorSourceAndType. Already running!"
+      changeInstanceCount(1)
       true
     } else {
 
@@ -101,6 +104,7 @@ abstract class Connector(val sourceIdentifier: String) extends WithLogger {
 
           if (start()) {
             logger info s"Started $connectorSourceAndType."
+            changeInstanceCount(1)
             running = true
             true
           } else {
@@ -127,15 +131,29 @@ abstract class Connector(val sourceIdentifier: String) extends WithLogger {
   /**
     * Shuts down the connector by calling the stop method.
     */
-  def shutdown(): Unit = {
-    if (stop()) {
-      running = false
-      logger info s"Stopped $connectorSourceAndType."
+  def shutdown(): Boolean = {
+    changeInstanceCount(-1)
+
+    if (instanceCount <= 0) {
+      logger info "Instance count is zero. Connector is no longer needed and shut down. RIP."
+      if (stop()) {
+        running = false
+        logger info s"Stopped $connectorSourceAndType."
+        true
+      } else {
+        logger warn s"Unable to shutdown $connectorSourceAndType."
+        false
+      }
     } else {
-      logger warn s"Unable to shutdown $connectorSourceAndType."
+      true // Return true to keep transparency
     }
   }
 
+  private def changeInstanceCount(delta: Int): Unit = {
+    instanceCount += delta
+    logger info s"Instance count: $instanceCount"
+  }
+
   /**
     * Returns the unique type string of the implemented connector.
     *

src/main/scala/org/codeoverflow/chatoverflow/framework/manager/PluginManagerImpl.scala

@@ -3,7 +3,7 @@ package org.codeoverflow.chatoverflow.framework.manager
 import java.util
 
 import org.codeoverflow.chatoverflow.WithLogger
-import org.codeoverflow.chatoverflow.api.plugin.PluginManager
+import org.codeoverflow.chatoverflow.api.plugin.{PluginLogMessage, PluginManager}
 
 import scala.collection.JavaConverters._
 import scala.collection.mutable.ListBuffer
@@ -15,15 +15,15 @@ import scala.collection.mutable.ListBuffer
   */
 class PluginManagerImpl(pluginInstanceName: String, logOutputOnConsole: Boolean) extends PluginManager with WithLogger {
 
-  private val logMessages = new ListBuffer[String]
+  private val logMessages = new ListBuffer[PluginLogMessage]
 
   /**
     * Prints a log message on the console and saves the message for later inspection.
     *
     * @param message the message to show
     */
   override def log(message: String): Unit = {
-    logMessages += message
+    logMessages += new PluginLogMessage(message)
 
     if (logOutputOnConsole) {
       logger info s"[$pluginInstanceName] $message"
@@ -35,5 +35,5 @@ class PluginManagerImpl(pluginInstanceName: String, logOutputOnConsole: Boolean)
     *
     * @return a list of log messages
     */
-  override def getLogMessages: util.List[String] = logMessages.toList.asJava
+  override def getLogMessages: util.List[PluginLogMessage] = logMessages.toList.asJava
 }

src/main/scala/org/codeoverflow/chatoverflow/framework/manager/PluginManagerStub.scala

@@ -2,7 +2,7 @@ package org.codeoverflow.chatoverflow.framework.manager
 
 import java.util
 
-import org.codeoverflow.chatoverflow.api.plugin.PluginManager
+import org.codeoverflow.chatoverflow.api.plugin.{PluginLogMessage, PluginManager}
 
 /**
   * This plugin manager stub does not provide any useful functionality and should only be used for
@@ -23,7 +23,7 @@ class PluginManagerStub extends PluginManager {
     *
     * @return a list of log messages
     */
-  override def getLogMessages: util.List[String] = {
-    new util.ArrayList[String]()
+  override def getLogMessages: util.List[PluginLogMessage] = {
+    new util.ArrayList[PluginLogMessage]()
   }
 }

src/main/scala/org/codeoverflow/chatoverflow/instance/PluginInstance.scala

@@ -73,12 +73,6 @@ class PluginInstance(val instanceName: String, pluginType: PluginType) extends W
     new PluginManagerStub()
   }
 
-  /**
-    * Returns, if the plugin instance is created. This should be always the case when a plugin instance
-    * is added to the registry.
-    */
-  private def isCreated: Boolean = plugin.isDefined
-
   /**
     * Creates a new thread and tries to start the plugin.
     * Make sure to set the requirements first!
@@ -183,6 +177,20 @@ class PluginInstance(val instanceName: String, pluginType: PluginType) extends W
                   case e: AbstractMethodError => logger.error(s"Plugin '$instanceName' just crashed. Looks like a plugin version error.", e)
                   case e: Exception => logger.error(s"Plugin '$instanceName' just had an exception. Might be a plugin implementation fault.", e)
                   case e: Throwable => logger.error(s"Plugin '$instanceName' just crashed. We don't know whats going up here!", e)
+
+                } finally {
+
+                  // If the plugin ended or crashed, try to shut down the connectors
+                  val inputRequirements = getRequirements.getInputRequirements.toArray
+                  inputRequirements.filter(_.asInstanceOf[Requirement[_]].isSet).foreach(requirement => {
+                    requirement.asInstanceOf[Requirement[Input]].get().shutdown()
+                  })
+
+                  val outputRequirements = getRequirements.getOutputRequirements.toArray
+                  outputRequirements.filter(_.asInstanceOf[Requirement[_]].isSet).foreach(requirement => {
+                    requirement.asInstanceOf[Requirement[Output]].get().shutdown()
+                  })
+
                 }
               })
               instanceThread.start()
@@ -198,6 +206,12 @@ class PluginInstance(val instanceName: String, pluginType: PluginType) extends W
     }
   }
 
+  /**
+    * Returns, if the plugin instance is created. This should be always the case when a plugin instance
+    * is added to the registry.
+    */
+  private def isCreated: Boolean = plugin.isDefined
+
   /**
     * Returns the requirements object of the specific plugin instance.
     *