org.scalatra.twirl.ScalatraFormsHelpers.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scalatra-twirl-javax_3 Show documentation
Twirl integration with Scalatra
The newest version!
package org.scalatra.twirl

import org.scalatra.ServletCompat.http.HttpServletRequest

import org.scalatra.MultiParams
import play.twirl.api.Html

trait ScalatraFormsHelpers {

  private val RequestAttributeParamsKey = "org.scalatra.forms.params"
  private val RequestAttributeErrorsKey = "org.scalatra.forms.errors"

  /**
   * Render a text field.
   */
  def text(name: String, attributes: (String, String)*)(implicit request: HttpServletRequest): Html = {
    Html(s"""""")
  }

  /**
   * Render a password field.
   */
  def password(name: String, attributes: (String, String)*)(implicit request: HttpServletRequest): Html = {
    Html(s"""""")
  }

  /**
   * Render a textarea.
   */
  def textarea(name: String, attributes: (String, String)*)(implicit request: HttpServletRequest): Html = {
    Html(s"""${escape(param(name))}""")
  }

  /**
   * Render a checkbox.
   */
  def checkbox(name: String, value: String, attributes: (String, String)*)(implicit request: HttpServletRequest): Html = {
    val checked = if (params(name).contains(value)) "checked" else ""
    Html(s"""""")
  }

  /**
   * Render a radio button.
   */
  def radio(name: String, value: String, attributes: (String, String)*)(implicit request: HttpServletRequest): Html = {
    val checked = if (param(name) == value) "checked" else ""
    Html(s"""""")
  }

  /**
   * Render a select box.
   */
  def select(name: String, values: Seq[(String, String)], multiple: Boolean, attributes: (String, String)*)(implicit request: HttpServletRequest): Html = {
    val sb = new StringBuilder()
    sb.append(s"""")
    Html(sb.toString)
  }

  /**
   * Retrieve an error message of the specified field.
   */
  def error(name: String)(implicit request: HttpServletRequest): Option[String] = {
    Option(request.getAttribute(RequestAttributeErrorsKey)).flatMap { errors =>
      errors.asInstanceOf[Seq[(String, String)]].find(_._1 == name).map(_._2)
    }
  }

  /**
   * Retrieve all error messages of the specified field.
   */
  def errors(name: String)(implicit request: HttpServletRequest): Seq[String] = {
    Option(request.getAttribute(RequestAttributeErrorsKey)).map { errors =>
      errors.asInstanceOf[Seq[(String, String)]].collect { case error if error._1 == name => error._2 }
    }.getOrElse(Nil)
  }

  private def escape(value: String): String = {
    value.replace("&", "&").replace("<", "<").replace(">", ">").replace("\"", """)
  }

  private def params(name: String)(implicit request: HttpServletRequest): Seq[String] = {
    Option(request.getAttribute(RequestAttributeParamsKey)).flatMap { params =>
      params.asInstanceOf[MultiParams].get(name)
    }.getOrElse(Nil)
  }

  private def param(name: String)(implicit request: HttpServletRequest): String = {
    params(name).headOption.getOrElse("")
  }

  private def attrs(attrs: (String, String)*): String = {
    attrs.map { case (name, value) => s"""${escape(name)}="${escape(value)}"""" }.mkString(" ")
  }

}

/**
 * Use helper methods defined in `ScalatraFormsHelpers` in Twirl templates as follows:
 *
 * {{{
 * @()(implicit request: javax.servlet.http.HttpServletRequest)
 * @import org.scalatra.twirl.forms._
 *
 * 
 *   UserId: @text("userName") @errors("userName")

 *   Password: @password("password") @errors("password")

 *   
 * 
 * }}}
 */
object forms extends ScalatraFormsHelpers