net.liftmodules.extras.LiftNotice.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of extras_3.3_2.12 Show documentation
extras
The newest version!
package net.liftmodules.extras

import scala.xml._

import net.liftweb._
import common._
import http._
import http.js._
import JsCmds._
import JE._
import json._
import util.FieldError

/**
  * Class for modeling a Lift notice.
  */
case class LiftNotice(message: NodeSeq, priority: String, id: Option[String] = Empty) {
  def asJValue: JValue = LiftNotice.asJValue(this)
  def asJsCmd: JsCmd = LiftNotice.asJsCmd(this)
}

object LiftNotice {

  val Success = "success"

  private implicit def noticeTypeToString(notice: NoticeType.Value): String = notice.lowerCaseTitle

  def asJValue(notice: LiftNotice): JValue = LiftExtras.noticeConverter.vend.noticeAsJValue(notice)
  def asJsCmd(notice: LiftNotice): JsCmd = LiftExtras.noticeConverter.vend.noticeAsJsCmd(notice)
  def asJsCmd(notices: Seq[LiftNotice]): JsCmd = LiftExtras.noticeConverter.vend.noticesAsJsCmd(notices)

  def info(msg: String): LiftNotice = LiftNotice(Text(msg), NoticeType.Notice, Empty)
  def error(msg: String): LiftNotice = LiftNotice(Text(msg), NoticeType.Error, Empty)
  def warning(msg: String): LiftNotice = LiftNotice(Text(msg), NoticeType.Warning, Empty)
  def success(msg: String): LiftNotice = LiftNotice(Text(msg), Success, Empty)

  def info(msg: String, id: String): LiftNotice = LiftNotice(Text(msg), NoticeType.Notice, Some(id))
  def error(msg: String, id: String): LiftNotice = LiftNotice(Text(msg), NoticeType.Error, Some(id))
  def warning(msg: String, id: String): LiftNotice = LiftNotice(Text(msg), NoticeType.Warning, Some(id))
  def success(msg: String, id: String): LiftNotice = LiftNotice(Text(msg), Success, Some(id))

  def info(msg: NodeSeq): LiftNotice = LiftNotice(msg, NoticeType.Notice, Empty)
  def error(msg: NodeSeq): LiftNotice = LiftNotice(msg, NoticeType.Error, Empty)
  def warning(msg: NodeSeq): LiftNotice = LiftNotice(msg, NoticeType.Warning, Empty)
  def success(msg: NodeSeq): LiftNotice = LiftNotice(msg, Success, Empty)

  def info(msg: NodeSeq, id: String): LiftNotice = LiftNotice(msg, NoticeType.Notice, Some(id))
  def error(msg: NodeSeq, id: String): LiftNotice = LiftNotice(msg, NoticeType.Error, Some(id))
  def warning(msg: NodeSeq, id: String): LiftNotice = LiftNotice(msg, NoticeType.Warning, Some(id))
  def success(msg: NodeSeq, id: String): LiftNotice = LiftNotice(msg, Success, Some(id))

  def allNotices: Seq[LiftNotice] = S.getAllNotices
    .map { case (priority, msg, id) => LiftNotice(msg, priority, id) }

  def fieldErrors(errs: List[FieldError]): Seq[LiftNotice] = errs
    .map { err => LiftNotice(err.msg, NoticeType.Error, err.field.uniqueFieldId) }
}

trait LiftNoticeConverter extends Loggable {
  import JsonDSL._

  def noticeAsJValue(notice: LiftNotice): JValue =
    ("message" -> notice.message.toString) ~
    ("priority" -> notice.priority) ~
    ("id" -> notice.id)

  def CallIdNoticeCmd(id: String, json: JValue): JsCmd =
    Call("$(document).trigger", Str("set-alert-id-%s".format(id)), json)

  def CallNoticesCmd(json: JValue): JsCmd =
    Call("$(document).trigger", Str("add-alerts"), json)

  def noticeAsJsCmd(notice: LiftNotice): JsCmd = notice.id.map { noticeId =>
    CallIdNoticeCmd(noticeId, notice.asJValue)
  } getOrElse {
    CallNoticesCmd(notice.asJValue)
  }

  def noticesAsJsCmd(notices: Seq[LiftNotice]): JsCmd = {
    val noIds = notices.filter(_.id.isEmpty)
    val withIds = notices
      .filterNot(_.id.isEmpty)
      .groupBy[String]{ it => it.id.get }

    val noIdsCall: JsCmd =
      CallNoticesCmd(JArray(noIds.map(_.asJValue).toList))

    val withIdCalls: Iterable[JsCmd] = for {
      (noticeId, notices) <- withIds
    } yield CallIdNoticeCmd(noticeId, JArray(notices.map(_.asJValue).toList))

    withIdCalls.foldLeft(noIdsCall)(_ & _)
  }

  /**
    * Use this to set LiftRules.noticesToJsCmd
    */
  def noticesToJsCmd: JsCmd = {
    val notices = LiftNotice.allNotices
    val callNotices =
      if (notices.length > 0) noticesAsJsCmd(notices)
      else Noop

    Call("$(document).trigger", Str("clear-alerts")) &
    Call("$(document).trigger", Str("clear-alert-id")) &
    callNotices
  }
}

object DefaultLiftNoticeConverter extends LiftNoticeConverter