Merge pull request #54 from delphi-hub/develop

Pre-Release Merge

Author: bhermann

.travis.yml

@@ -1,3 +1,8 @@
 language: scala
 scala:
-  -  2.12.4
+  -  2.12.4
+script:
+  - 'if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then sbt ++$TRAVIS_SCALA_VERSION test; fi'
+  - 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then sbt ++$TRAVIS_SCALA_VERSION coverage test coverageReport coverageAggregate codacyCoverage; fi'
+after_success:
+  - 'if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then bash <(curl -s https://codecov.io/bash); fi'

CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contribution Guide
+
+We follow the GitHub [Fork & Pull][forkandpull] and [Git Flow][gitflow] workflow in this project.
+Please fork the official repository, develop in a branch based on the
+current develop branch, and submit a pull request (PR) after you are done.
+
+[forkandpull]: https://help.github.com/articles/about-pull-requests/
+[gitflow]: http://nvie.com/posts/a-successful-git-branching-model/
+
+## Checklist before submitting a Pull Request
+
+Before you submit your PR, please go through this list and check if
+your request fulfills these points.
+
+- Do you have more changes/additions/deletions in your PR than you expected?
+- Do you have tests for your changes?
+- Do all tests of the project succeed?
+- Is your pull request based on the `develop` branch? [(cf. GitFlow)][gitflow]
+
+If you check these items before, your pull request is more likely to be
+included into the project quickly.
+

LICENSE

@@ -175,18 +175,7 @@
 
    END OF TERMS AND CONDITIONS
 
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "[]"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2018 The Delphi Team (represented by Ben Hermann)
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -0,0 +1,54 @@
+# Delphi Management Console
+
+A management console for the Delphi platform.
+
+We are currently in pre-alpha state! There is no release and the code in
+this repository is purely experimental!
+
+|branch | status | codacy |
+| :---: | :---: | :---: |
+| master | [![Build Status](https://travis-ci.org/delphi-hub/delphi-management.svg?branch=master)](https://travis-ci.org/delphi-hub/delphi-management) | [![Codacy Badge](https://api.codacy.com/project/badge/Grade/0a50d2132e6b46adb6f6eb36b6ddc4e7)](https://www.codacy.com/app/delphi-hub/delphi-management?utm_source=github.com&utm_medium=referral&utm_content=delphi-hub/delphi-management&utm_campaign=Badge_Grade)|
+| develop | [![Build Status](https://travis-ci.org/delphi-hub/delphi-management.svg?branch=develop)](https://travis-ci.org/delphi-hub/delphi-management) | [![Codacy Badge](https://api.codacy.com/project/badge/Grade/0a50d2132e6b46adb6f6eb36b6ddc4e7?branch=develop)](https://www.codacy.com/app/delphi-hub/delphi-management?utm_source=github.com&utm_medium=referral&utm_content=delphi-hub/delphi-management&utm_campaign=Badge_Grade) |
+
+## What is the Delphi Management Console?
+
+It is a web application to allow administrators to control the crawling process.
+
+## How does it work?
+
+It takes commands from authenticated administrators over the web interface and issues the appropriate steps in the crawler.
+
+## How can I use it?
+
+For any deployed instance you need an administrator account to interact with the application.
+You can start your own instance by executing
+```
+sbt run
+```
+
+## Community
+
+Feel welcome to join our chatroom on Gitter: [![Join the chat at https://gitter.im/delphi-hub/delphi](https://badges.gitter.im/delphi-hub/delphi.svg)](https://gitter.im/delphi-hub/delphi?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+
+## Contributing
+
+Contributions are *very* welcome!
+
+Before contributing, please read our [Code of Conduct](CODE_OF_CONDUCT.md).
+
+Refer to the [Contribution Guide](CONTRIBUTING.md) for details about the workflow.
+We use Pull Requests to collect contributions. Especially look out for "help wanted" issues
+[![GitHub issues by-label](https://img.shields.io/github/issues/delphi-hub/delphi-management/help%20wanted.svg)](https://github.com/delphi-hub/delphi-management/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22),
+but feel free to work on other issues as well.
+You can ask for clarification in the issues directly, or use our Gitter
+chat for a more interactive experience.
+
+[![GitHub issues](https://img.shields.io/github/issues/delphi-hub/delphi-management.svg)](https://github.com/delphi-hub/delphi-management/issues)
+
+
+## License
+
+The Delphi CLI is open source and available under Apache 2 License.
+
+[![GitHub license](https://img.shields.io/github/license/delphi-hub/delphi-management.svg)](https://github.com/delphi-hub/delphi-management/blob/master/LICENSE)

app/controllers/AuthController.scala

@@ -0,0 +1,128 @@
+package controllers
+
+import javax.inject.Inject
+
+import scala.concurrent.Future
+import scala.concurrent.duration.FiniteDuration
+import net.ceedubs.ficus.Ficus.{finiteDurationReader, toFicusConfig, optionValueReader}
+import com.mohiva.play.silhouette.api.Authenticator.Implicits.RichDateTime
+import com.mohiva.play.silhouette.api.{Environment, Silhouette}
+import com.mohiva.play.silhouette.api.exceptions.ProviderException
+import com.mohiva.play.silhouette.api.util.Credentials
+import com.mohiva.play.silhouette.impl.providers.CredentialsProvider
+import play.api.Configuration
+import play.api.data.Form
+import play.api.data.Forms.{boolean, email, mapping, nonEmptyText}
+import play.api.mvc.{AbstractController, Action, AnyContent, ControllerComponents}
+import play.api.i18n.{I18nSupport, Messages, MessagesApi}
+import scala.concurrent.ExecutionContext.Implicits.global
+import services.UserService
+import org.joda.time.DateTime
+import AuthForms.SignInForm
+import utils.auth.DefaultEnv
+
+/**
+  * Form used to store the three input variables when logging in: E-Mail, Password, RememberMe
+  */
+object AuthForms {
+
+  case class SignInData(email:String, password:String, rememberMe:Boolean)
+  val SignInForm = Form(mapping(
+    "email" -> email,
+    "password" -> nonEmptyText,
+    "rememberMe" -> boolean
+  )(SignInData.apply)(SignInData.unapply)
+  )
+
+}
+
+/**
+  * Controller handling authentification related GET requests
+  *
+  * @param messagesApi Injected handle of current play MessagesApi
+  * @param env Injected handle of current silhouette Environment
+  * @param credentialsProvider Injected handle of the CredetialsProvider
+  * @param userService Injected handle of the current UserService (defined in services/UserService.scala, bound in Module.scala)
+  * @param configuration Injected handle of current application configuration
+  * @param cc Injected handle of current ControllerComponents, needed to extend superclass AbstractController
+  * @param silhouette Injected handle of current silhouette instance
+  */
+class AuthController @Inject() (
+                       override val messagesApi:MessagesApi,
+                       val env:Environment[DefaultEnv],
+                       credentialsProvider: CredentialsProvider,
+                       userService: UserService,
+                       configuration: Configuration,
+                       cc: ControllerComponents,
+                       silhouette: Silhouette[DefaultEnv]) extends AbstractController(cc) with I18nSupport{
+
+
+
+  /**
+    * Called on GET /auth/signIn, will show the signIn page. If the user already is logged on, he will be redirected to
+    * the index page
+    *
+    * @return Action redirecting the user
+    */
+  def signIn: Action[AnyContent] = silhouette.UserAwareAction.async { implicit request =>
+    Future.successful(request.identity match {
+      case Some(_) => Redirect(routes.HomeController.index())
+      case None => Ok(views.html.auth.signIn(SignInForm))
+    })
+  }
+
+  /**
+    * Called when the user hits Enter / Login-Button on the login-page. Validates login data from the Form defined above
+    * and redirects the user to the index page if supplied credentials are valid. Handles any error during login.
+    *
+    * @return Corrsponding action
+    */
+  def authenticate : Action[AnyContent] = Action.async { implicit request =>
+    SignInForm.bindFromRequest.fold(
+      bogusForm => Future.successful(BadRequest(views.html.auth.signIn(bogusForm))),
+      signInData => {
+        val credentials = Credentials(signInData.email, signInData.password)
+        credentialsProvider.authenticate(credentials).flatMap { loginInfo =>
+          userService.retrieve(loginInfo).flatMap {
+            case None =>
+              Future.successful(Redirect(routes.AuthController.signIn()).flashing("error" -> Messages("error.noUser")))
+            case Some(user) if !user.profileFor(loginInfo).exists(_.confirmed) =>
+              Future.successful(Redirect(routes.AuthController.signIn()).flashing("error" -> Messages("error.unregistered", signInData.email)))
+            case Some(_) => for {
+              authenticator <- env.authenticatorService.create(loginInfo).map {
+                case authenticator:Any if signInData.rememberMe =>
+                  val c = configuration.underlying
+                  authenticator.copy(
+                    expirationDateTime = new DateTime() + c.as[FiniteDuration]("silhouette.authenticator.rememberMe.authenticatorExpiry"),
+                    idleTimeout = c.getAs[FiniteDuration]("silhouette.authenticator.rememberMe.authenticatorIdleTimeout"),
+                    cookieMaxAge = c.getAs[FiniteDuration]("silhouette.authenticator.rememberMe.cookieMaxAge")
+                  )
+                case authenticator:Any => authenticator
+              }
+              value <- env.authenticatorService.init(authenticator)
+              result <- env.authenticatorService.embed(value, Redirect(routes.HomeController.index()))
+            } yield result
+          }
+        }.recover {
+          case _:ProviderException => Redirect(routes.AuthController.signIn()).flashing("error" -> Messages("error.invalidCredentials"))
+        }
+      }
+    )
+  }
+
+  /**
+    * Called when signing out. Deletes the cookie that marked the user as logged in, and redirects him to the index page, which
+    * will again redirect him to the signin page
+    *
+    * @return Action redirecting the user
+    */
+  def signOut : Action[AnyContent] = silhouette.SecuredAction.async { implicit request =>
+    env.authenticatorService.discard(request.authenticator, Redirect(routes.HomeController.index()))
+  }
+
+
+
+
+
+
+}

app/controllers/HomeController.scala

@@ -1,22 +1,32 @@
 package controllers
 
-import javax.inject._
-import play.api.mvc._
+import com.mohiva.play.silhouette.api.Silhouette
+import javax.inject.{Inject,Singleton}
+import play.api.i18n.{I18nSupport, MessagesApi}
+import play.api.mvc.{AbstractController, Action, AnyContent, ControllerComponents}
+import utils.auth.DefaultEnv
+import utils.ErrorHandler
 
 /**
-  * Created by benhermann on 02.01.18.
+  * Controller handling GET requests for the index page
+  *
+  * @param messageApi Injected handle of current play MessagesApi
+  * @param cc Injected handle of ControllerComponents, needed to extend superclass AbstractController
+  * @param silhouette Injected handle of current Silhouette instance
   */
 @Singleton
-class HomeController @Inject()(cc: ControllerComponents) extends AbstractController(cc) {
+class HomeController @Inject()(messageApi: MessagesApi,
+                               cc: ControllerComponents,
+                               silhouette: Silhouette[DefaultEnv]) extends AbstractController(cc) with I18nSupport{
 
   /**
-    * Create an Action to render an HTML page with a welcome message.
-    * The configuration in the `routes` file means that this method
-    * will be called when the application receives a `GET` request with
-    * a path of `/`.
+    * Create a SecuredAction to render the index page when receiving GET with path '/'. If the user is not logged in,
+    * the passed instance of MyErrorHandler will redirect him to the login page.
     */
-  def index = Action {
-    Ok(views.html.index("Delphi - Management Interface"))
-  }
 
+  def index : Action[AnyContent] = silhouette.SecuredAction(new ErrorHandler(messageApi)) { implicit request => {
+
+    Ok(views.html.index(Option(request.identity), Option(request.authenticator.loginInfo), Option(JavaVersion(None)), Option(HostName(None)),Option(ScalaVersion(None)), Option(PlatformName(None))))
+  }
+  }
 }

app/controllers/SystemInfo.scala

@@ -0,0 +1,42 @@
+package controllers
+
+import java.net.InetAddress
+import play.core.PlayVersion
+
+  object JavaVersion {
+  def apply(javaVersionPrefix: Option[String]): String = {
+    val version = sys.props.get("java.version") getOrElse {sys.error("failed to get system property java.version")}
+
+    javaVersionPrefix match {
+      case Some(prefix) =>
+        if (!version.startsWith(prefix)) {
+          sys.error(s"javac version ${version} may not be used to publish, it has to start with ${prefix} due to javaVersionPrefix setting")
+        }
+      case None =>
+    }
+    version
+  }
+}
+
+object HostName {
+  def apply(host: Option[String]): String = {    
+   var hostname = InetAddress.getLocalHost().getHostName()
+   hostname
+  }
+}
+
+object PlatformName {
+  def apply(platform: Option[String]): String = {
+    var os = "os.name";
+    var version = "os.version";
+    var osVersion = System.getProperty(os) + " " + System.getProperty(version)
+    osVersion
+  }
+}
+
+object ScalaVersion {
+  def apply(browser: Option[String]): String = {
+    var scalaVersion = PlayVersion.current
+    scalaVersion
+  }
+}

app/daos/MockAdminUser.scala

@@ -0,0 +1,40 @@
+package daos
+
+import java.util.UUID
+
+import com.mohiva.play.silhouette.api.LoginInfo
+import com.mohiva.play.silhouette.api.util.PasswordHasher
+import com.mohiva.play.silhouette.impl.providers.CredentialsProvider
+import javax.inject.Inject
+import models.{Profile, User}
+import play.api.Configuration
+
+/**
+  * Class providing access to a mocked administrator user object
+  */
+class MockAdminUser @Inject() (configuration: Configuration){
+
+  //Define constant values for fake user
+  val adminMail : String = configuration.underlying.getString("mock.admin.email")
+  val adminFullName = "Delphi Administrator"
+  val adminFirstName = "Delphi"
+  val adminLastName = "Administrator"
+  val adminPassword :String = configuration.underlying.getString("mock.admin.password")
+
+  /**
+    * Provide access to the User object
+    * @param passwordHasher PasswordHasher to user for PasswordInfo
+    * @return
+    */
+  def getAdminUserMock(passwordHasher:PasswordHasher) : User = User(
+      id = UUID.randomUUID(),
+      profiles=List(Profile(loginInfo = LoginInfo(CredentialsProvider.ID,adminMail),
+        confirmed = true, email = Option(adminMail),
+        firstName = Option(adminFirstName),
+        lastName = Option(adminLastName),
+        fullName = Option(adminFullName),
+        passwordInfo = Option(passwordHasher.hash(adminPassword) )
+      ))
+    )
+
+}