#275 Add Support for Play 2.6.x and Elasticsearch 5.x

Author: To-om

project/BuildSettings.scala

@@ -13,7 +13,7 @@ object BasicSettings extends AutoPlugin {
       "-deprecation", // Emit warning and location for usages of deprecated APIs.
       "-feature", // Emit warning and location for usages of features that should be imported explicitly.
       "-unchecked", // Enable additional warnings where generated code depends on assumptions.
-      "-Xfatal-warnings", // Fail the compilation if there are any warnings.
+      //"-Xfatal-warnings", // Fail the compilation if there are any warnings.
       "-Xlint", // Enable recommended additional warnings.
       "-Ywarn-adapted-args", // Warn if an argument list is modified to match the receiver.
       "-Ywarn-dead-code", // Warn when dead code is identified.

project/Dependencies.scala

@@ -1,17 +1,19 @@
 import sbt._
 
 object Dependencies {
-  val scalaVersion = "2.11.8"
+  val scalaVersion = "2.12.3"
 
   object Library {
 
     object Play {
       val version = play.core.PlayVersion.current
       val ws = "com.typesafe.play" %% "play-ws" % version
-      val cache = "com.typesafe.play" %% "play-cache" % version
+      val ahc = "com.typesafe.play" %% "play-ahc-ws" % version
+      val cache = "com.typesafe.play" %% "play-ehcache" % version
       val test = "com.typesafe.play" %% "play-test" % version
       val specs2 = "com.typesafe.play" %% "play-specs2" % version
       val filters = "com.typesafe.play" %% "filters-helpers" % version
+      val guice = "com.typesafe.play" %% "play-guice" % version
       object Specs2 {
         private val version = "3.6.6"
         val matcherExtra = "org.specs2" %% "specs2-matcher-extra" % version
@@ -20,16 +22,16 @@ object Dependencies {
     }
 
     object Specs2 {
-      private val version = "3.6.6"
+      private val version = "3.9.4"
       val core = "org.specs2" %% "specs2-core" % version
       val matcherExtra = "org.specs2" %% "specs2-matcher-extra" % version
       val mock = "org.specs2" %% "specs2-mock" % version
     }
-    val scalaGuice = "net.codingwell" %% "scala-guice" % "4.0.1"
-    val akkaTestkit = "com.typesafe.akka" %% "akka-testkit" % "2.4.7"
-    val reflections = "org.reflections" % "reflections" % "0.9.10"
+    val scalaGuice = "net.codingwell" %% "scala-guice" % "4.1.0"
+    val akkaTestkit = "com.typesafe.akka" %% "akka-testkit" % "2.5.4"
+    val reflections = "org.reflections" % "reflections" % "0.9.11"
     val zip4j = "net.lingala.zip4j" % "zip4j" % "1.3.2"
-    val akkaTest = "com.typesafe.akka" %% "akka-stream-testkit" % "2.4.4"
-    val elastic4play = "org.cert-bdf" %% "elastic4play" % "1.2.1"
+    val akkaTest = "com.typesafe.akka" %% "akka-stream-testkit" % "2.5.4"
+    val elastic4play = "org.cert-bdf" %% "elastic4play" % "1.3-SNAPSHOT"
   }
 }

project/build.properties

@@ -1 +1 @@
-sbt.version=0.13.13
+sbt.version=0.13.16

project/plugins.sbt

@@ -1,7 +1,7 @@
 // Comment to get more information during initialization
 logLevel := Level.Info
 
-addSbtPlugin("com.typesafe.play" % "sbt-plugin" % "2.5.14")
+addSbtPlugin("com.typesafe.play" % "sbt-plugin" % "2.6.3")
 
 addSbtPlugin("me.lessis" % "bintray-sbt" % "0.3.0")
 

thehive-backend/app/connectors/Connectors.scala

@@ -1,30 +1,34 @@
 package connectors
 
-import javax.inject.Inject
+import javax.inject.{ Inject, Singleton }
+
+import scala.collection.immutable
 
-import com.google.inject.AbstractModule
-import net.codingwell.scalaguice.{ ScalaModule, ScalaMultibinder }
 import play.api.libs.json.{ JsObject, Json }
-import play.api.mvc.{ Action, Handler, RequestHeader, Results }
+import play.api.mvc._
 import play.api.routing.sird.UrlContext
 import play.api.routing.{ Router, SimpleRouter }
 
-import scala.collection.immutable
+import com.google.inject.AbstractModule
+import net.codingwell.scalaguice.{ ScalaModule, ScalaMultibinder }
 
 trait Connector {
   val name: String
   val router: Router
   val status: JsObject = Json.obj("enabled" → true)
 }
 
-class ConnectorRouter @Inject() (connectors: immutable.Set[Connector]) extends SimpleRouter {
+@Singleton
+class ConnectorRouter @Inject() (
+    connectors: immutable.Set[Connector],
+    actionBuilder: DefaultActionBuilder) extends SimpleRouter {
   def get(connectorName: String): Option[Connector] = connectors.find(_.name == connectorName)
 
   def routes: PartialFunction[RequestHeader, Handler] = {
     case request @ p"/$connector/$path<.*>" ⇒
       get(connector)
         .flatMap(_.router.withPrefix(s"/$connector/").handlerFor(request))
-        .getOrElse(Action { _ ⇒ Results.NotFound(s"connector $connector not found") })
+        .getOrElse(actionBuilder { _ ⇒ Results.NotFound(s"connector $connector not found") })
   }
 }
 

thehive-backend/app/controllers/AlertCtrl.scala

@@ -2,21 +2,23 @@ package controllers
 
 import javax.inject.{ Inject, Singleton }
 
+import scala.concurrent.{ ExecutionContext, Future }
+import scala.util.Try
+
+import play.api.Logger
+import play.api.http.Status
+import play.api.libs.json.{ JsArray, JsObject, Json }
+import play.api.mvc._
+
 import akka.stream.Materializer
+import services.JsonFormat.caseSimilarityWrites
+import services.{ AlertSrv, CaseSrv }
+
 import org.elastic4play.controllers.{ Authenticated, Fields, FieldsBodyParser, Renderer }
 import org.elastic4play.models.JsonFormat.baseModelEntityWrites
 import org.elastic4play.services.JsonFormat.{ aggReads, queryReads }
 import org.elastic4play.services._
 import org.elastic4play.{ BadRequestError, Timed }
-import play.api.Logger
-import play.api.http.Status
-import play.api.libs.json.{ JsArray, JsObject, Json }
-import play.api.mvc.{ Action, AnyContent, Controller }
-import services.{ AlertSrv, CaseSrv }
-import services.JsonFormat.caseSimilarityWrites
-
-import scala.concurrent.{ ExecutionContext, Future }
-import scala.util.Try
 
 @Singleton
 class AlertCtrl @Inject() (
@@ -25,11 +27,12 @@ class AlertCtrl @Inject() (
     auxSrv: AuxSrv,
     authenticated: Authenticated,
     renderer: Renderer,
+    components: ControllerComponents,
     fieldsBodyParser: FieldsBodyParser,
     implicit val ec: ExecutionContext,
-    implicit val mat: Materializer) extends Controller with Status {
+    implicit val mat: Materializer) extends AbstractController(components) with Status {
 
-  val log = Logger(getClass)
+  private[AlertCtrl] lazy val logger = Logger(getClass)
 
   @Timed
   def create(): Action[Fields] = authenticated(Role.write).async(fieldsBodyParser) { implicit request ⇒

thehive-backend/app/controllers/ArtifactCtrl.scala

@@ -3,25 +3,28 @@ package controllers
 import javax.inject.{ Inject, Singleton }
 
 import scala.concurrent.{ ExecutionContext, Future }
+
 import play.api.http.Status
 import play.api.libs.json.JsArray
-import play.api.mvc.{ Action, AnyContent, Controller }
-import org.elastic4play.{ BadRequestError, Timed }
+import play.api.mvc._
+
+import services.ArtifactSrv
+
 import org.elastic4play.controllers.{ Authenticated, Fields, FieldsBodyParser, Renderer }
 import org.elastic4play.models.JsonFormat.baseModelEntityWrites
-import org.elastic4play.services.{ Agg, AuxSrv }
-import org.elastic4play.services.{ QueryDSL, QueryDef, Role }
 import org.elastic4play.services.JsonFormat.{ aggReads, queryReads }
-import services.ArtifactSrv
+import org.elastic4play.services._
+import org.elastic4play.{ BadRequestError, Timed }
 
 @Singleton
 class ArtifactCtrl @Inject() (
     artifactSrv: ArtifactSrv,
     auxSrv: AuxSrv,
     authenticated: Authenticated,
     renderer: Renderer,
+    components: ControllerComponents,
     fieldsBodyParser: FieldsBodyParser,
-    implicit val ec: ExecutionContext) extends Controller with Status {
+    implicit val ec: ExecutionContext) extends AbstractController(components) with Status {
 
   @Timed
   def create(caseId: String): Action[Fields] = authenticated(Role.write).async(fieldsBodyParser) { implicit request ⇒

thehive-backend/app/controllers/Asset.scala

@@ -2,21 +2,23 @@ package controllers
 
 import javax.inject.{ Inject, Singleton }
 
+import scala.concurrent.ExecutionContext
+
 import play.api.Environment
-import play.api.http.HttpErrorHandler
-import play.api.mvc.{ Action, AnyContent, Controller }
+import play.api.http.{ FileMimeTypes, HttpErrorHandler }
+import play.api.mvc.{ Action, AnyContent }
 
 trait AssetCtrl {
   def get(file: String): Action[AnyContent]
 }
 
 @Singleton
-class AssetCtrlProd @Inject() (errorHandler: HttpErrorHandler) extends Assets(errorHandler) with AssetCtrl {
+class AssetCtrlProd @Inject() (errorHandler: HttpErrorHandler, meta: AssetsMetadata) extends Assets(errorHandler, meta) with AssetCtrl {
   def get(file: String): Action[AnyContent] = at("/ui", file)
 }
 
 @Singleton
-class AssetCtrlDev @Inject() (environment: Environment) extends ExternalAssets(environment) with AssetCtrl {
+class AssetCtrlDev @Inject() (environment: Environment)(implicit ec: ExecutionContext, fileMimeTypes: FileMimeTypes) extends ExternalAssets(environment) with AssetCtrl {
   def get(file: String): Action[AnyContent] = {
     if (file.startsWith("bower_components/")) {
       at("ui", file)

thehive-backend/app/controllers/AttachmentCtrl.scala

@@ -1,41 +1,48 @@
 package controllers
 
+import java.nio.file.Files
 import javax.inject.{ Inject, Singleton }
 
-import akka.stream.scaladsl.FileIO
-import play.api.Configuration
 import play.api.http.HttpEntity
-import play.api.libs.Files.TemporaryFile
+import play.api.libs.Files.DefaultTemporaryFileCreator
 import play.api.mvc._
+import play.api.{ Configuration, mvc }
+
+import akka.stream.scaladsl.FileIO
 import net.lingala.zip4j.core.ZipFile
 import net.lingala.zip4j.model.ZipParameters
 import net.lingala.zip4j.util.Zip4jConstants
+
 import org.elastic4play.Timed
-import org.elastic4play.services.{ AttachmentSrv, Role }
-import org.elastic4play.models.AttachmentAttributeFormat
+import org.elastic4play.controllers.{ Authenticated, Renderer }
 import org.elastic4play.models.AttachmentAttributeFormat
-import org.elastic4play.controllers.Authenticated
-import org.elastic4play.controllers.Renderer
+import org.elastic4play.services.{ AttachmentSrv, Role }
 
 /**
  * Controller used to access stored attachments (plain or zipped)
  */
 @Singleton
 class AttachmentCtrl(
     password: String,
+    tempFileCreator: DefaultTemporaryFileCreator,
     attachmentSrv: AttachmentSrv,
     authenticated: Authenticated,
-    renderer: Renderer) extends Controller {
+    components: ControllerComponents,
+    renderer: Renderer) extends AbstractController(components) {
 
   @Inject() def this(
     configuration: Configuration,
+    tempFileCreator: DefaultTemporaryFileCreator,
     attachmentSrv: AttachmentSrv,
     authenticated: Authenticated,
+    components: ControllerComponents,
     renderer: Renderer) =
     this(
-      configuration.getString("datastore.attachment.password").get,
+      configuration.get[String]("datastore.attachment.password"),
+      tempFileCreator,
       attachmentSrv,
       authenticated,
+      components,
       renderer)
 
   /**
@@ -47,8 +54,8 @@ class AttachmentCtrl(
   def download(hash: String, name: Option[String]): Action[AnyContent] = authenticated(Role.read) { implicit request ⇒
     if (hash.startsWith("{{")) // angularjs hack
       NoContent
-    else if (!name.getOrElse("").intersect(AttachmentAttributeFormat.forbiddenChar).isEmpty())
-      BadRequest("File name is invalid")
+    else if (!name.getOrElse("").intersect(AttachmentAttributeFormat.forbiddenChar).isEmpty)
+      mvc.Results.BadRequest("File name is invalid")
     else
       Result(
         header = ResponseHeader(
@@ -66,12 +73,12 @@ class AttachmentCtrl(
    */
   @Timed("controllers.AttachmentCtrl.downloadZip")
   def downloadZip(hash: String, name: Option[String]): Action[AnyContent] = authenticated(Role.read) { implicit request ⇒
-    if (!name.getOrElse("").intersect(AttachmentAttributeFormat.forbiddenChar).isEmpty())
+    if (!name.getOrElse("").intersect(AttachmentAttributeFormat.forbiddenChar).isEmpty)
       BadRequest("File name is invalid")
     else {
-      val f = TemporaryFile("zip", hash).file
-      f.delete()
-      val zipFile = new ZipFile(f)
+      val f = tempFileCreator.create("zip", hash).path
+      Files.delete(f)
+      val zipFile = new ZipFile(f.toFile)
       val zipParams = new ZipParameters
       zipParams.setCompressionLevel(Zip4jConstants.DEFLATE_LEVEL_FASTEST)
       zipParams.setEncryptFiles(true)
@@ -88,8 +95,8 @@ class AttachmentCtrl(
             "Content-Disposition" → s"""attachment; filename="${name.getOrElse(hash)}.zip"""",
             "Content-Type" → "application/zip",
             "Content-Transfer-Encoding" → "binary",
-            "Content-Length" → f.length.toString)),
-        body   = HttpEntity.Streamed(FileIO.fromPath(f.toPath), Some(f.length), Some("application/zip")))
+            "Content-Length" → Files.size(f).toString)),
+        body   = HttpEntity.Streamed(FileIO.fromPath(f), Some(Files.size(f)), Some("application/zip")))
     }
   }
 }

thehive-backend/app/controllers/AuthenticationCtrl.scala

@@ -2,15 +2,17 @@ package controllers
 
 import javax.inject.{ Inject, Singleton }
 
+import scala.concurrent.{ ExecutionContext, Future }
+
+import play.api.mvc._
+
 import models.UserStatus
-import org.elastic4play.{ AuthorizationError, Timed }
+import services.UserSrv
+
 import org.elastic4play.controllers.{ Authenticated, Fields, FieldsBodyParser, Renderer }
 import org.elastic4play.database.DBIndex
 import org.elastic4play.services.AuthSrv
-import play.api.mvc.{ Action, Controller, Results }
-import services.UserSrv
-
-import scala.concurrent.{ ExecutionContext, Future }
+import org.elastic4play.{ AuthorizationError, Timed }
 
 @Singleton
 class AuthenticationCtrl @Inject() (
@@ -19,8 +21,9 @@ class AuthenticationCtrl @Inject() (
     authenticated: Authenticated,
     dbIndex: DBIndex,
     renderer: Renderer,
+    components: ControllerComponents,
     fieldsBodyParser: FieldsBodyParser,
-    implicit val ec: ExecutionContext) extends Controller {
+    implicit val ec: ExecutionContext) extends AbstractController(components) {
 
   @Timed
   def login: Action[Fields] = Action.async(fieldsBodyParser) { implicit request ⇒