Added login rest endpoint.

Author: sebinside

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

@@ -53,42 +53,47 @@ class ChatOverflow(val pluginFolderPath: String,
     logger debug "Finished updating type registry."
 
     logger debug "Loading configs and credentials."
-    askForPassword()
-    load()
+    // TODO: Add flag for asking for the password on the console prior to the gui
+    //askForPassword()
+    //load()
     logger debug "Finished loading configs and credentials."
 
     logger debug "Finished initialization."
   }
 
-  private def askForPassword(): Unit = {
-    val password = if (System.console() != null)
-        System.console().readPassword("Please enter password (Input hidden) > ")
-      else
-        scala.io.StdIn.readLine("Please enter password (Input NOT hidden) > ").toCharArray
-    credentialsService.setPassword(password)
-  }
-
-  private def enableFrameworkSecurity(): Unit = {
-    Policy.setPolicy(new SandboxSecurityPolicy)
-    System.setSecurityManager(new SecurityManager)
-  }
-
   /**
     * Loads all config settings and credentials from the config folder.
     */
-  def load(): Unit = {
+  def load(): Boolean = {
     val currentTime = System.currentTimeMillis()
+    var success = true
 
     // Start by loading connectors
-    configService.loadConnectors()
+    if (!configService.loadConnectors())
+      success = false
 
     // Then load credentials that can be put into the connectors
-    credentialsService.load()
+    if (!credentialsService.load())
+      success = false
 
     // Finish by loading plugin instances
     configService.loadPluginInstances(pluginInstanceRegistry, pluginFramework, typeRegistry)
 
     logger info s"Loading took ${System.currentTimeMillis() - currentTime} ms."
+    success
+  }
+
+  private def enableFrameworkSecurity(): Unit = {
+    Policy.setPolicy(new SandboxSecurityPolicy)
+    System.setSecurityManager(new SecurityManager)
+  }
+
+  private def askForPassword(): Unit = {
+    val password = if (System.console() != null)
+      System.console().readPassword("Please enter password (Input hidden) > ")
+    else
+      scala.io.StdIn.readLine("Please enter password (Input NOT hidden) > ").toCharArray
+    credentialsService.setPassword(password)
   }
 
   /**

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

@@ -22,6 +22,10 @@ class CredentialsService(val credentialsFilePath: String) extends WithLogger {
     */
   def setPassword(password: Array[Char]): Unit = this.password = password
 
+  def isLoggedIn: Boolean = {
+    password.length > 0
+  }
+
   /**
     * Loads the credentials form the credentials file and decrypts them.
     *
@@ -45,7 +49,7 @@ class CredentialsService(val credentialsFilePath: String) extends WithLogger {
         encrypted.close
 
         if (decrypted.isEmpty) {
-          logger error "Wrong password. Unable to load credentials."
+          logger warn "Wrong password. Unable to load credentials."
           false
         } else {
           logger info "Password correct."

src/main/scala/org/codeoverflow/chatoverflow/ui/web/SwaggerSupport.scala

@@ -6,6 +6,11 @@ import org.json4s.{JValue, _}
 import org.scalatra.ScalatraServlet
 import org.scalatra.swagger.{Api, ApiInfo, JacksonSwaggerBase, Swagger}
 
+/**
+  * The open API servlet provides a generated swagger.json with the api definitions of the framework.
+  *
+  * @param swagger the swagger framework, implicitly passed from the Scalatra Bootstrap
+  */
 class OpenAPIServlet(implicit val swagger: Swagger) extends ScalatraServlet with JacksonSwaggerBase {
 
   /**

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

@@ -30,4 +30,6 @@ object DTOs {
 
   case class ConnectorRef(sourceIdentifier: String, uniqueTypeString: String)
 
+  case class Password(password: String)
+
 }

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

@@ -2,7 +2,7 @@ package org.codeoverflow.chatoverflow.ui.web.rest.config
 
 import org.codeoverflow.chatoverflow.api.APIVersion
 import org.codeoverflow.chatoverflow.ui.web.JsonServlet
-import org.codeoverflow.chatoverflow.ui.web.rest.DTOs.ConfigInfo
+import org.codeoverflow.chatoverflow.ui.web.rest.DTOs.{ConfigInfo, Password, ResultMessage}
 import org.scalatra.swagger._
 
 class ConfigController(implicit val swagger: Swagger) extends JsonServlet with ConfigControllerDefinition {
@@ -12,4 +12,30 @@ class ConfigController(implicit val swagger: Swagger) extends JsonServlet with C
       APIVersion.MINOR_VERSION, chatOverflow.pluginFolderPath,
       chatOverflow.configFolderPath, chatOverflow.requirementPackage)
   }
+
+  post("/save", operation(postSave)) {
+    chatOverflow.save()
+    true
+  }
+
+  get("/login", operation(getLogin)) {
+    chatOverflow.credentialsService.isLoggedIn
+  }
+
+  post("/login", operation(postLogin)) {
+    parsedAs[Password] {
+      case Password(password) =>
+        chatOverflow.credentialsService.setPassword(password.toCharArray)
+        if (!chatOverflow.load()) {
+          // TODO: Could have more details with a more detailed loading process
+          ResultMessage(success = false, "Unable to load. Wrong password?")
+        } else {
+          ResultMessage(success = true)
+        }
+    }
+  }
+
+  // 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
 }

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

@@ -1,6 +1,6 @@
 package org.codeoverflow.chatoverflow.ui.web.rest.config
 
-import org.codeoverflow.chatoverflow.ui.web.rest.DTOs.ConfigInfo
+import org.codeoverflow.chatoverflow.ui.web.rest.DTOs.{ConfigInfo, Password, ResultMessage}
 import org.scalatra.swagger.SwaggerSupport
 import org.scalatra.swagger.SwaggerSupportSyntax.OperationBuilder
 
@@ -11,5 +11,21 @@ trait ConfigControllerDefinition extends SwaggerSupport {
       summary "Shows general information and settings."
       description "Shows API version and chat overflow startup settings.")
 
+  val postSave: OperationBuilder =
+    (apiOperation[Boolean]("postSave")
+      summary "Triggers the saving process of the framework manually."
+      description "Triggers saving of credentials and configuration. Should not be needed manually.")
+
+  val getLogin: OperationBuilder =
+    (apiOperation[Boolean]("getLogin")
+      summary "Returns if the framework is already supplied with a password to decrypt its credentials."
+      description "Returns true, if a password has been set. Note that this says nothing about its correctness.")
+
+  val postLogin: OperationBuilder =
+    (apiOperation[ResultMessage]("postLogin")
+      summary "Logs in the the framework with the given password, loads config and credentials."
+      description "Tries to decrypt the credentials using the provided password. Does load configuration and credentials."
+      parameter bodyParam[Password]("body").description("Requires the user framework password."))
+
   override protected def applicationDescription: String = "Handles configuration and information retrieval."
 }