Merge remote-tracking branch 'origin/master'

Author: sebinside

build.sbt

@@ -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/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/instance/PluginInstance.scala

@@ -182,12 +182,12 @@ class PluginInstance(val instanceName: String, pluginType: PluginType) extends W
 
                   // If the plugin ended or crashed, try to shut down the connectors
                   val inputRequirements = getRequirements.getInputRequirements.toArray
-                  inputRequirements.foreach(requirement => {
+                  inputRequirements.filter(_.asInstanceOf[Requirement[_]].isSet).foreach(requirement => {
                     requirement.asInstanceOf[Requirement[Input]].get().shutdown()
                   })
 
                   val outputRequirements = getRequirements.getOutputRequirements.toArray
-                  outputRequirements.foreach(requirement => {
+                  outputRequirements.filter(_.asInstanceOf[Requirement[_]].isSet).foreach(requirement => {
                     requirement.asInstanceOf[Requirement[Output]].get().shutdown()
                   })
 

src/main/scala/org/codeoverflow/chatoverflow/requirement/impl/EventHandler.scala

@@ -0,0 +1,7 @@
+package org.codeoverflow.chatoverflow.requirement.impl
+
+import java.util.function.Consumer
+
+import org.codeoverflow.chatoverflow.api.io.event.Event
+
+private[impl] case class EventHandler[T <: Event](consumer: Consumer[T], clazz: Class[T])

src/main/scala/org/codeoverflow/chatoverflow/requirement/impl/EventInputImpl.scala

@@ -0,0 +1,42 @@
+package org.codeoverflow.chatoverflow.requirement.impl
+
+import java.util.function.Consumer
+
+import org.codeoverflow.chatoverflow.api.io.event.Event
+import org.codeoverflow.chatoverflow.api.io.input.event.EventInput
+import org.codeoverflow.chatoverflow.connector.Connector
+
+import scala.collection.mutable.ListBuffer
+import scala.reflect.ClassTag
+
+/**
+  * Default implementation for all inputs that provide events.
+  *
+  * The integrated event registry allows registering new Event handlers at any time.
+  * @tparam T the event interface that all events for this EventInput share
+  * @tparam C the connector to which this input belongs
+  */
+abstract class EventInputImpl[T <: Event, C <: Connector](implicit ctc: ClassTag[C]) extends InputImpl[C] with EventInput[T] {
+
+  protected val handlers: ListBuffer[EventHandler[_ <: T]] = ListBuffer[EventHandler[_ <: T]]()
+
+  /**
+    * Register a new event handler that listens for a specific event
+    *
+    * @param eventHandler consumer for which `accept()` is called if the event is fired
+    * @param eventClass   class of the events for which this listener should listen
+    */
+  override def registerEventHandler[S <: T](eventHandler: Consumer[S], eventClass: Class[S]): Unit = {
+    handlers += EventHandler[S](eventHandler, eventClass)
+  }
+
+  /**
+    * Use this methods to fire an event.
+    * All eventHandlers listening for that event will be triggered.
+    * @param event the event that should be fired
+    */
+  protected def call[S <: T](event: S)(implicit cts: ClassTag[S]): Unit = {
+    handlers.filter(handler => handler.clazz == cts.runtimeClass)
+      .foreach(handler => handler.consumer.asInstanceOf[Consumer[S]].accept(event))
+  }
+}

src/main/scala/org/codeoverflow/chatoverflow/requirement/InputImpl.scala renamed to src/main/scala/org/codeoverflow/chatoverflow/requirement/impl/InputImpl.scala

@@ -1,8 +1,9 @@
-package org.codeoverflow.chatoverflow.requirement
+package org.codeoverflow.chatoverflow.requirement.impl
 
 import org.codeoverflow.chatoverflow.WithLogger
 import org.codeoverflow.chatoverflow.api.io.input.Input
 import org.codeoverflow.chatoverflow.connector.Connector
+import org.codeoverflow.chatoverflow.requirement.Connection
 
 import scala.reflect.ClassTag
 

src/main/scala/org/codeoverflow/chatoverflow/requirement/OutputImpl.scala renamed to src/main/scala/org/codeoverflow/chatoverflow/requirement/impl/OutputImpl.scala

@@ -1,8 +1,9 @@
-package org.codeoverflow.chatoverflow.requirement
+package org.codeoverflow.chatoverflow.requirement.impl
 
 import org.codeoverflow.chatoverflow.WithLogger
 import org.codeoverflow.chatoverflow.api.io.output.Output
 import org.codeoverflow.chatoverflow.connector.Connector
+import org.codeoverflow.chatoverflow.requirement.Connection
 
 import scala.reflect.ClassTag
 

src/main/scala/org/codeoverflow/chatoverflow/requirement/service/discord/DiscordChatConnector.scala

@@ -101,7 +101,7 @@ class DiscordChatConnector(override val sourceIdentifier: String) extends Connec
       case None =>
         Option(validJDA.getPrivateChannelById(channelId)) match {
           case Some(channel) => channel.getMessageById(messageId)
-          case None => throw new IllegalArgumentException(s"Channel with id $channelId not found")
+          case None => throw new IllegalArgumentException(s"TextChannel with id $channelId not found")
         }
     }
   }
@@ -123,7 +123,7 @@ class DiscordChatConnector(override val sourceIdentifier: String) extends Connec
   def sendChatMessage(channelId: String, chatMessage: String): Unit = {
     Option(validJDA.getTextChannelById(channelId)) match {
       case Some(channel) => channel.sendMessage(chatMessage).queue(null, defaultFailureHandler)
-      case None => throw new IllegalArgumentException(s"Channel with id $channelId not found")
+      case None => throw new IllegalArgumentException(s"TextChannel with id $channelId not found")
     }
   }
 
@@ -136,7 +136,7 @@ class DiscordChatConnector(override val sourceIdentifier: String) extends Connec
   def sendChatMessage(channelId: String, embed: MessageEmbed): Unit = {
     Option(validJDA.getTextChannelById(channelId)) match {
       case Some(channel) => channel.sendMessage(embed).queue(null, defaultFailureHandler)
-      case None => throw new IllegalArgumentException(s"Channel with id $channelId not found")
+      case None => throw new IllegalArgumentException(s"TextChannel with id $channelId not found")
     }
   }
 
@@ -157,7 +157,7 @@ class DiscordChatConnector(override val sourceIdentifier: String) extends Connec
             case Some(m) => channel.sendFile(fileIn.get.get, fileName, new MessageBuilder(m).build()).queue(null, defaultFailureHandler)
             case None => channel.sendFile(fileIn.get.get, fileName).queue(null, defaultFailureHandler)
           }
-        case None => throw new IllegalArgumentException(s"Channel with id $channelId not found")
+        case None => throw new IllegalArgumentException(s"TextChannel with id $channelId not found")
       }
     } else {
       logger warn s"Could not load file '$file'"