Added more startup options and flags.

Author: sebinside

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

@@ -20,11 +20,13 @@ import org.codeoverflow.chatoverflow.registry.TypeRegistry
   */
 class ChatOverflow(val pluginFolderPath: String,
                    val configFolderPath: String,
-                   val requirementPackage: String)
+                   val requirementPackage: String,
+                   val requirePasswordOnStartup: Boolean,
+                   val logOutputOnConsole: Boolean)
   extends WithLogger {
 
   val pluginFramework = new PluginFramework(pluginFolderPath)
-  val pluginInstanceRegistry = new PluginInstanceRegistry
+  val pluginInstanceRegistry = new PluginInstanceRegistry(logOutputOnConsole)
   val typeRegistry = new TypeRegistry(requirementPackage)
   val credentialsService = new CredentialsService(s"$configFolderPath/credentials")
   val configService = new ConfigurationService(s"$configFolderPath/config.xml")
@@ -52,11 +54,12 @@ class ChatOverflow(val pluginFolderPath: String,
     ConnectorRegistry.setTypeRegistry(typeRegistry)
     logger debug "Finished updating type registry."
 
-    logger debug "Loading configs and credentials."
-    // TODO: Add flag for asking for the password on the console prior to the gui
-    //askForPassword()
-    //load()
-    logger debug "Finished loading configs and credentials."
+    if (requirePasswordOnStartup) {
+      logger debug "Loading configs and credentials."
+      askForPassword()
+      load()
+      logger debug "Finished loading configs and credentials."
+    }
 
     logger debug "Finished initialization."
   }

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

@@ -11,35 +11,37 @@ import org.codeoverflow.chatoverflow.ui.web.Server
 object Launcher extends WithLogger {
 
   var server: Option[Server] = None
+  var pluginDataPath: String = "data"
 
   /**
     * Software entry point.
     */
   def main(args: Array[String]): Unit = {
     parse(args) { config =>
 
+      this.pluginDataPath = config.pluginDataPath
+
       // The complete project visible trough one single instance
       val chatOverflow = new ChatOverflow(config.pluginFolderPath,
-        config.configFolderPath, config.requirementPackage)
+        config.configFolderPath, config.requirementPackage, config.requirePasswordOnStartup, config.pluginLogOutputOnConsole)
 
       chatOverflow.init()
 
       // Launch UI
       config.ui match {
         case UI.GUI =>
-          startServer(chatOverflow)
+          startServer(chatOverflow, config.webServerPort)
         case UI.REPL =>
           startREPL(chatOverflow)
         case UI.BOTH =>
-          startServer(chatOverflow)
+          startServer(chatOverflow, config.webServerPort)
           startREPL(chatOverflow)
       }
     }
   }
 
-  private def startServer(chatOverflow: ChatOverflow): Unit = {
+  private def startServer(chatOverflow: ChatOverflow, port: Int): Unit = {
     if (server.isEmpty) {
-      // TODO: Enable custom port support
       server = Some(new Server(chatOverflow, 2400))
       server.get.startAsync()
     }

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

@@ -13,7 +13,7 @@ import scala.collection.mutable
   * @param credentialsFilePath the file path of the credentials file
   */
 class CredentialsService(val credentialsFilePath: String) extends WithLogger {
-  private var password = Array[Char]()
+  private[this] var password = Array[Char]()
 
   /**
     * Sets the password. Needed to load or save credentials.
@@ -22,6 +22,11 @@ class CredentialsService(val credentialsFilePath: String) extends WithLogger {
     */
   def setPassword(password: Array[Char]): Unit = this.password = password
 
+  /**
+    * Returns true, if a password is set. Note that this says nothing about the correctness of it.
+    *
+    * @return true, if the password length is greater than zero
+    */
   def isLoggedIn: Boolean = {
     password.length > 0
   }

src/main/scala/org/codeoverflow/chatoverflow/connector/actor/FileSystemActor.scala

@@ -4,6 +4,7 @@ import java.io.{File, PrintWriter}
 import java.nio.file.Paths
 
 import akka.actor.Actor
+import org.codeoverflow.chatoverflow.Launcher
 import org.codeoverflow.chatoverflow.connector.actor.FileSystemActor.{CreateDirectory, LoadFile, SaveFile}
 
 import scala.io.Source
@@ -13,8 +14,7 @@ import scala.io.Source
   */
 class FileSystemActor extends Actor {
 
-  // TODO: Should be an startup option in the CLI
-  private val dataFilePath = "data"
+  private val dataFilePath = Launcher.pluginDataPath
 
   // Create data folder if non existent
   private val dataFolder = new File(dataFilePath)

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

@@ -13,7 +13,7 @@ import scala.collection.mutable.ListBuffer
   *
   * @param pluginInstanceName the name of the plugin instance
   */
-class PluginManagerImpl(pluginInstanceName: String) extends PluginManager with WithLogger {
+class PluginManagerImpl(pluginInstanceName: String, logOutputOnConsole: Boolean) extends PluginManager with WithLogger {
 
   private val logMessages = new ListBuffer[String]
 
@@ -24,8 +24,10 @@ class PluginManagerImpl(pluginInstanceName: String) extends PluginManager with W
     */
   override def log(message: String): Unit = {
     logMessages += message
-    // TODO: Add disabling plugin messages by flag
-    logger info s"[$pluginInstanceName] $message"
+
+    if (logOutputOnConsole) {
+      logger info s"[$pluginInstanceName] $message"
+    }
   }
 
   /**

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

@@ -231,8 +231,8 @@ class PluginInstance(val instanceName: String, pluginType: PluginType) extends W
     * Creates a new plugin instance with the default manager implementation.
     * Note: This is instance-private, because non-instantiatable plugins should be not added in the registry
     */
-  private[instance] def createPluginInstanceWithDefaultManager: Boolean = {
-    createPluginInstance(new PluginManagerImpl(instanceName))
+  private[instance] def createPluginInstanceWithDefaultManager(logOutputOnConsole: Boolean): Boolean = {
+    createPluginInstance(new PluginManagerImpl(instanceName, logOutputOnConsole))
   }
 
   /**

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

@@ -8,7 +8,7 @@ import scala.collection.mutable
 /**
   * The plugin instance registry does hold all running and not-running instances of plugins.
   */
-class PluginInstanceRegistry extends WithLogger {
+class PluginInstanceRegistry(logOutputOnConsole: Boolean) extends WithLogger {
   private val pluginInstances = mutable.Map[String, PluginInstance]()
 
   /**
@@ -31,7 +31,7 @@ class PluginInstanceRegistry extends WithLogger {
       // The plugin instance is created here. Why: A plugin, which could not be created
       // e.g. due to version issues or code failures has no reason to be in the list of plugin instances
       val instance = new PluginInstance(instanceName, pluginType)
-      if (instance.createPluginInstanceWithDefaultManager) {
+      if (instance.createPluginInstanceWithDefaultManager(logOutputOnConsole)) {
         pluginInstances += instanceName -> instance
         logger info s"Successfully instantiated and added plugin instance '$instanceName' of type '${pluginType.getName}'."
         true

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

@@ -30,6 +30,20 @@ object CLI {
     opt[String]('r', "requirementPackage").action((x, c) =>
       c.copy(requirementPackage = x)).text("path to the package where all requirements are defined")
 
+    // Subject of change. After GUI will be -l (for requireLogin)
+    opt[Unit]('n', "noPassword").action((_, c) =>
+      c.copy(requirePasswordOnStartup = false)).text("set this flag to disable password checking on framework startup")
+
+    opt[String]('d', "pluginDataFolder").action((x, c) =>
+      c.copy(pluginDataPath = x)).text("path to the data folder, accessible from within plugins")
+
+    opt[Int]('w', "webServerPort").action((x, c) =>
+      c.copy(webServerPort = x)).text("default web server port, used eg. for the rest api")
+
+    // Subject of change. After GUI will be -o (enablePluginOutput)
+    opt[Unit]('z', "disableLogOutputOnConsole").action((_, c) =>
+      c.copy(pluginLogOutputOnConsole = false)).text("set this flag to disable plugin log output on console")
+
     help("help").hidden().text("prints this usage text")
 
     note("\nFor more information, please visit http://codeoverflow.org/")
@@ -55,7 +69,11 @@ object CLI {
   case class Config(pluginFolderPath: String = "plugins/",
                     configFolderPath: String = "config/",
                     requirementPackage: String = "org.codeoverflow.chatoverflow.requirement",
-                    ui: UI = UI.BOTH)
+                    ui: UI = UI.BOTH,
+                    requirePasswordOnStartup: Boolean = true,
+                    pluginDataPath: String = "data",
+                    webServerPort: Int = 2400,
+                    pluginLogOutputOnConsole: Boolean = true)
 
   object UI extends Enumeration {
     type UI = Value

src/main/scala/org/codeoverflow/chatoverflow/ui/web/rest/DTOs.scala

@@ -8,7 +8,7 @@ object DTOs {
   case class PluginInstance(instanceName: String, pluginName: String, pluginAuthor: String, isRunning: Boolean, requirementIDs: Seq[String])
 
   case class ConfigInfo(name: String, apiMajorVersion: Int, apiMinorVersion: Int, pluginFolderPath: String,
-                        configFolderPath: String, requirementPackage: String)
+                        configFolderPath: String, requirementPackage: String, pluginDataPath: String)
 
   case class Requirement(uniqueRequirementId: String, name: String, isOptional: Boolean, isSet: Boolean, value: String, targetType: String)
 

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

@@ -1,5 +1,6 @@
 package org.codeoverflow.chatoverflow.ui.web.rest.config
 
+import org.codeoverflow.chatoverflow.Launcher
 import org.codeoverflow.chatoverflow.api.APIVersion
 import org.codeoverflow.chatoverflow.ui.web.JsonServlet
 import org.codeoverflow.chatoverflow.ui.web.rest.DTOs.{ConfigInfo, Password, ResultMessage}
@@ -10,7 +11,7 @@ class ConfigController(implicit val swagger: Swagger) extends JsonServlet with C
   get("/", operation(getConfig)) {
     ConfigInfo("Chat Overflow", APIVersion.MAJOR_VERSION,
       APIVersion.MINOR_VERSION, chatOverflow.pluginFolderPath,
-      chatOverflow.configFolderPath, chatOverflow.requirementPackage)
+      chatOverflow.configFolderPath, chatOverflow.requirementPackage, Launcher.pluginDataPath)
   }
 
   post("/save", operation(postSave)) {
@@ -36,6 +37,4 @@ class ConfigController(implicit val swagger: Swagger) extends JsonServlet with C
   }
 
   // TODO: Handle first time login / Creation of the config files (same as postLogin above...?)
-
-  // TODO: After this: Add the flags (pw, log output, data folder) and update the ConfigInfo
 }