net.liftweb.http.S.scala Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2006-2011 WorldWide Conferencing, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.liftweb
package http
import java.util.{Locale, ResourceBundle, TimeZone}
import scala.collection.mutable.{HashMap, ListBuffer}
import scala.xml._
import common._
import actor.{LAFuture, LAScheduler}
import util._
import Helpers._
import js._
import provider._
import http.rest.RestContinuation
class SJBridge {
def s = S
}
/**
* An object representing the current state of the HTTP request and response.
* It uses the DynamicVariable construct such that each thread has its own
* local session info without passing a huge state construct around. The S object
* is initialized by LiftSession on request startup.
*
* @see LiftSession
* @see LiftFilter
*/
object S extends S {
/**
* RewriteHolder holds a partial function that re-writes an incoming request. It is
* used for per-session rewrites, as opposed to global rewrites, which are handled
* by the LiftRules.rewrite RulesSeq. This case class exists so that RewritePFs may
* be manipulated by name. See S.addSessionRewriter for example usage.
*
* @see # sessionRewriter
* @see # addSessionRewriter
* @see # clearSessionRewriter
* @see # removeSessionRewriter
* @see LiftRules # rewrite
*/
case class RewriteHolder(name: String, rewrite: LiftRules.RewritePF)
/**
* DispatchHolder holds a partial function that maps a Req to a LiftResponse. It is
* used for per-session dispatch, as opposed to global dispatch, which are handled
* by the LiftRules.dispatch RulesSeq. This case class exists so that DispatchPFs may
* be manipulated by name. See S.addHighLevelSessionDispatcher for example usage.
*
* @see LiftResponse
* @see LiftRules # dispatch
* @see # highLevelSessionDispatchList
* @see # addHighLevelSessionDispatcher
* @see # removeHighLevelSessionDispatcher
* @see # clearHighLevelSessionDispatcher
*/
case class DispatchHolder(name: String, dispatch: LiftRules.DispatchPF)
/**
* The CookieHolder class holds information about cookies to be sent during
* the session, as well as utility methods for adding and deleting cookies. It
* is used internally.
*
* @see # _responseCookies
* @see # _init
* @see # addCookie
* @see # deleteCookie
* @see # receivedCookies
* @see # responseCookies
* @see # findCookie
*/
case class CookieHolder(inCookies: List[HTTPCookie], outCookies: List[HTTPCookie]) {
def add(in: HTTPCookie) = CookieHolder(inCookies, in :: outCookies.filter(_.name != in.name))
def delete(name: String) = {
add(HTTPCookie(name, "").setMaxAge(0))
}
def delete(old: HTTPCookie) =
add(old.setMaxAge(0).setValue(""))
}
final case class PFPromoter[A, B](pff: () => PartialFunction[A, B])
object PFPromoter {
implicit def fromPF[A, B](pf: PartialFunction[A, B]): PFPromoter[A, B] = new PFPromoter[A, B](() => pf)
implicit def fromFunc[A, B](pff: () => PartialFunction[A, B]): PFPromoter[A, B] = new PFPromoter[A, B](pff)
}
private[http] class ProxyFuncHolder(proxyTo: AFuncHolder, _owner: Box[String]) extends AFuncHolder {
def this(proxyTo: AFuncHolder) = this (proxyTo, Empty)
def owner: Box[String] = _owner or proxyTo.owner
def apply(in: List[String]): Any = proxyTo.apply(in)
override def apply(in: FileParamHolder): Any = proxyTo.apply(in)
override def supportsFileParams_? : Boolean = proxyTo.supportsFileParams_?
override private[http] def lastSeen: Long = proxyTo.lastSeen
override private[http] def lastSeen_=(when: Long) = proxyTo.lastSeen = when
override def sessionLife = proxyTo.sessionLife
}
/**
* Impersonates a function that will be called when uploading files
*/
private final class BinFuncHolder(val func: FileParamHolder => Any, val owner: Box[String]) extends AFuncHolder with Serializable{
def apply(in: List[String]): Unit = {logger.info("You attempted to call a 'File Upload' function with a normal parameter. Did you forget to 'enctype' to 'multipart/form-data'?")}
override def apply(in: FileParamHolder) = func(in)
override def supportsFileParams_? : Boolean = true
}
object BinFuncHolder {
def apply(func: FileParamHolder => Any): AFuncHolder = new BinFuncHolder(func, Empty)
def apply(func: FileParamHolder => Any, owner: Box[String]): AFuncHolder = new BinFuncHolder(func, owner)
}
object SFuncHolder {
def apply(func: String => Any): AFuncHolder = new SFuncHolder(func, Empty)
def apply(func: String => Any, owner: Box[String]): AFuncHolder = new SFuncHolder(func, owner)
}
/**
* Impersonates a function that is executed on HTTP requests from client. The function
* takes a String as the only parameter and returns an Any.
*/
private final class SFuncHolder(val func: String => Any, val owner: Box[String]) extends AFuncHolder with Serializable{
def this(func: String => Any) = this (func, Empty)
def apply(in: List[String]): Any = in.headOption.toList.map(func(_))
}
object LFuncHolder {
def apply(func: List[String] => Any): AFuncHolder = new LFuncHolder(func, Empty)
def apply(func: List[String] => Any, owner: Box[String]): AFuncHolder = new LFuncHolder(func, owner)
}
/**
* Impersonates a function that is executed on HTTP requests from client. The function
* takes a List[String] as the only parameter and returns an Any.
*/
private final class LFuncHolder(val func: List[String] => Any, val owner: Box[String]) extends AFuncHolder with Serializable {
def apply(in: List[String]): Any = func(in)
}
object NFuncHolder {
def apply(func: () => Any): AFuncHolder = new NFuncHolder(func, Empty)
def apply(func: () => Any, owner: Box[String]): AFuncHolder = new NFuncHolder(func, owner)
}
/**
* Impersonates a function that is executed on HTTP requests from client. The function
* takes zero arguments and returns an Any.
*/
private final class NFuncHolder(val func: () => Any, val owner: Box[String]) extends AFuncHolder with Serializable{
def apply(in: List[String]): Any = in.headOption.toList.map(s => func())
}
/**
* Abstrats a function that is executed on HTTP requests from client.
*/
sealed trait AFuncHolder extends Function1[List[String], Any] with Serializable{
def owner: Box[String]
def apply(in: List[String]): Any
def apply(in: FileParamHolder): Any = {
error("Attempt to apply file upload to a non-file upload handler")
}
def supportsFileParams_? : Boolean = false
def duplicate(newOwner: String): AFuncHolder = new ProxyFuncHolder(this, Full(newOwner))
@volatile private[this] var _lastSeen: Long = millis
private[http] def lastSeen = _lastSeen
private[http] def lastSeen_=(when: Long) = _lastSeen = when
def sessionLife: Boolean = _sessionLife
private[this] val _sessionLife: Boolean = functionLifespan_?
}
/**
* We create one of these dudes and put it
*/
private[http] final case class PageStateHolder(owner: Box[String], session: LiftSession) extends AFuncHolder {
/**
* Private no-arg constructor needed for deserialization.
*/
private[this] def this() = this(Empty, null)
private val loc = S.location
private val snapshot: Function1[Function0[Any], Any] = RequestVarHandler.generateSnapshotRestorer()
override def sessionLife: Boolean = false
def apply(in: List[String]): Any = {
error("You shouldn't really be calling apply on this dude...")
}
def runInContext[T](f: => T): T = {
val ret = snapshot(() => f).asInstanceOf[T]
ret
}
}
/**
* The companion object that generates AFuncHolders from other functions
*/
object AFuncHolder {
implicit def strToAnyAF(f: String => Any): AFuncHolder =
SFuncHolder(f)
implicit def unitToAF(f: () => Any): AFuncHolder = NFuncHolder(f)
implicit def listStrToAF(f: List[String] => Any): AFuncHolder =
LFuncHolder(f)
implicit def boolToAF(f: Boolean => Any): AFuncHolder =
LFuncHolder(lst => f(lst.foldLeft(false)(
(v, str) => v || Helpers.toBoolean(str))))
}
}
/**
* An object representing the current state of the HTTP request and response.
* It uses the DynamicVariable construct such that each thread has its own
* local session info without passing a huge state construct around. The S object
* is initialized by LiftSession on request startup.
*
* @see LiftSession
* @see LiftFilter
*/
trait S extends HasParams with Loggable with UserAgentCalculator {
import S._
/*
* The current session state is contained in the following val/vars:
*/
/**
* Holds the current Req (request) on a per-thread basis.
* @see Req
*/
private val _request = new ThreadGlobal[Req]
/**
* Holds the current functions mappings for this session.
*
* @see # functionMap
* @see # addFunctionMap
* @see # clearFunctionMap
*/
private val __functionMap = new ThreadGlobal[Map[String, AFuncHolder]]
/**
* This is simply a flag so that we know whether or not the state for the S object
* has been initialized for our current scope.
*
* @see # inStatefulScope_ ?
* @see # initIfUninitted
*/
private val inS = (new ThreadGlobal[Boolean]).set(false)
/**
* The _snippetMap holds mappings from snippet names to snippet functions. These mappings
* are valid only in the current request. This val
* is typically modified using the mapSnippet method.
*
* @see # mapSnippet
* @see # locateMappedSnippet
*/
private[http] object _snippetMap extends RequestVar[Map[String, NodeSeq => NodeSeq]](Map())
/**
* Holds the attributes that are set on the current snippet tag. Attributes are available
* to snippet functions via the S.attr and S.attrs methods. The attributes are held in a
* tuple, representing (most recent attributes, full attribute stack).
*
* @see # attrs
* @see # attr
*/
private val _attrs = new ThreadGlobal[(MetaData,List[(Either[String, (String, String)], String)])]
/**
* Holds the per-request LiftSession instance.
*
* @see LiftSession
* @see # session
*/
private val _sessionInfo = new ThreadGlobal[LiftSession]
/**
* Holds a list of ResourceBundles for this request.
*
* @see # resourceBundles
* @see LiftRules # resourceNames
* @see LiftRules # resourceBundleFactories
*/
private val _resBundle = new ThreadGlobal[List[ResourceBundle]]
private[http] object _statefulSnip extends RequestVar[Map[String, DispatchSnippet]](Map())
private val _responseHeaders = new ThreadGlobal[ResponseInfoHolder]
private val _responseCookies = new ThreadGlobal[CookieHolder]
private val _lifeTime = new ThreadGlobal[Boolean]
private val autoCleanUp = new ThreadGlobal[Boolean]
private val _oneShot = new ThreadGlobal[Boolean]
private val _disableTestFuncNames = new ThreadGlobal[Boolean]
private object _originalRequest extends RequestVar[Box[Req]](Empty)
private object _exceptionThrown extends TransientRequestVar(false)
private object postFuncs extends TransientRequestVar(new ListBuffer[() => Unit])
/**
* During an Ajax call made on a Comet component, make the Req's
* params available
*/
private object paramsForComet extends TransientRequestVar[Map[String, List[String]]](Map())
/**
* We can now collect JavaScript to append to the outgoing request,
* no matter the format of the outgoing request
*/
private object _jsToAppend extends TransientRequestVar(new ListBuffer[JsCmd])
private object _globalJsToAppend extends TransientRequestVar(new ListBuffer[JsCmd])
/**
* We can now collect Elems to put in the head tag
*/
private object _headTags extends TransientRequestVar(new ListBuffer[Elem])
/**
* We can now collect Elems to put at the end of the body
*/
private object _tailTags extends TransientRequestVar(new ListBuffer[Elem])
// Set of CometVersionPairs for comets that should be tracked on
// the page that is currently being rendered or that called this AJAX
// callback.
private[liftweb] object requestCometVersions extends TransientRequestVar[Set[CometVersionPair]](Set.empty)
private object p_queryLog extends TransientRequestVar(new ListBuffer[(String, Long)])
private object p_notice extends TransientRequestVar(new ListBuffer[(NoticeType.Value, NodeSeq, Box[String])])
/**
* This method returns true if the S object has been initialized for our current scope. If
* the S object has not been initialized then functionality on S will not work.
*/
def inStatefulScope_? : Boolean = inS.value
/**
* Get a Req representing our current HTTP request.
*
* @return A Full(Req) if one has been initialized on the calling thread, Empty otherwise.
*
* @see Req
*/
def request: Box[Req] = _request.box or CurrentReq.box
/**
* If this is an Ajax request, return the original request that created the page. The original
* request is useful because it has the original path which is helpful for localization purposes.
*
* @return the original request or if that's not available, the current request
*/
def originalRequest: Box[Req] = _originalRequest.get or request
private[http] object CurrentLocation extends RequestVar[Box[sitemap.Loc[_]]](request.flatMap(_.location))
def location: Box[sitemap.Loc[_]] = CurrentLocation.is or {
//try again in case CurrentLocation was accessed before the request was available
request flatMap { r => CurrentLocation(r.location) }
}
/**
* The user agent of the current request, if any.
**/
def userAgent = request.flatMap(_.userAgent)
/**
* An exception was thrown during the processing of this request.
* This is tested to see if the transaction should be rolled back
*/
def assertExceptionThrown(): Unit = {_exceptionThrown.set(true)}
/**
* Was an exception thrown during the processing of the current request?
*/
def exceptionThrown_? : Boolean = _exceptionThrown.get
/**
* @return a List of any Cookies that have been set for this Response. If you want
* a specific cookie, use findCookie.
*
* @see net.liftweb.http.provider.HTTPCookie
* @see # findCookie ( String )
* @see # addCookie ( Cookie )
* @see # deleteCookie ( Cookie )
* @see # deleteCookie ( String )
*/
def receivedCookies: List[HTTPCookie] =
for (rc <- Box.legacyNullTest(_responseCookies.value).toList; c <- rc.inCookies)
yield c.clone().asInstanceOf[HTTPCookie]
/**
* Finds a cookie with the given name that was sent in the request.
*
* @param name - the name of the cookie to find
*
* @return Full ( cookie ) if the cookie exists, Empty otherwise
*
* @see net.liftweb.http.provider.HTTPCookie
* @see # receivedCookies
* @see # addCookie ( Cookie )
* @see # deleteCookie ( Cookie )
* @see # deleteCookie ( String )
*/
def findCookie(name: String): Box[HTTPCookie] =
Box.legacyNullTest(_responseCookies.value).flatMap(
rc => Box(rc.inCookies.filter(_.name == name)).
map(_.clone().asInstanceOf[HTTPCookie]))
/**
* Get the cookie value for the given cookie
*/
def cookieValue(name: String): Box[String] =
for {
cookie <- findCookie(name)
value <- cookie.value
} yield value
def currentCometActor: Box[LiftCometActor] = CurrentCometActor.box
/**
* @return a List of any Cookies that have been added to the response to be sent
* back to the user. If you want the cookies that were sent with the request, see
* receivedCookies.
*
* @see net.liftweb.http.provider.HTTPCookie
* @see # receivedCookies
*/
def responseCookies: List[HTTPCookie] = Box.legacyNullTest(_responseCookies.value).
toList.flatMap(_.outCookies)
/**
* Adds a Cookie to the List[Cookies] that will be sent with the Response.
*
* If you wish to delete a Cookie as part of the Response, use the deleteCookie
* method.
*
* An example of adding and removing a Cookie is:
*
*
* import net.liftweb.http.provider.HTTPCookie
*
* class MySnippet {
* final val cookieName = "Fred"
*
* def cookieDemo (xhtml : NodeSeq) : NodeSeq = {
* var cookieVal = S.findCookie(cookieName).map(_.getvalue) openOr ""
*
* def setCookie() {
* val cookie = HTTPCookie(cookieName, cookieVal).setMaxAge(3600) // 3600 seconds, or one hour
* S.addCookie(cookie)
* }
*
* bind("cookie", xhtml,
* "value" -> SHtml.text(cookieVal, cookieVal = _),
* "add" -> SHtml.submit("Add", setCookie)
* "remove" -> SHtml.link(S.uri, () => S.deleteCookie(cookieName), "Delete Cookie")
* )
* }
* }
*
*
* @see net.liftweb.http.provider.HTTPCookie
* @see # deleteCookie ( Cookie )
* @see # deleteCookie ( String )
* @see # responseCookies
*/
def addCookie(cookie: HTTPCookie): Unit = {
Box.legacyNullTest(_responseCookies.value).foreach(rc =>
_responseCookies.set(rc.add(cookie))
)
}
/**
* Deletes the cookie from the user's browser.
*
* @param cookie the Cookie to delete
*
* @see net.liftweb.http.provider.HTTPCookie
* @see # addCookie ( Cookie )
* @see # deleteCookie ( String )
*/
def deleteCookie(cookie: HTTPCookie): Unit = {
Box.legacyNullTest(_responseCookies.value).foreach(rc =>
_responseCookies.set(rc.delete(cookie))
)
}
/**
* Deletes the cookie from the user's browser.
*
* @param name the name of the cookie to delete
*
* @see net.liftweb.http.provider.HTTPCookie
* @see # addCookie ( Cookie )
* @see # deleteCookie ( Cookie )
*/
def deleteCookie(name: String): Unit = {
Box.legacyNullTest(_responseCookies.value).foreach(rc =>
_responseCookies.set(rc.delete(name))
)
}
/**
* Find a template based on the snippet attribute "template"
*/
// TODO: Is this used anywhere? - DCB
def templateFromTemplateAttr: Box[NodeSeq] =
for (templateName <- attr("template") ?~ "Template Attribute missing";
tmplList = templateName.roboSplit("/");
template <- Templates(tmplList) ?~
"couldn't find template") yield template
/**
* Returns the Locale for this request based on the LiftRules.localeCalculator
* method.
*
* @see LiftRules.localeCalculator ( HTTPRequest )
* @see java.util.Locale
*/
def locale: Locale = LiftRules.localeCalculator(containerRequest)
/**
* Return the current timezone based on the LiftRules.timeZoneCalculator
* method.
*
* @see LiftRules.timeZoneCalculator ( HTTPRequest )
* @see java.util.TimeZone
*/
def timeZone: TimeZone =
LiftRules.timeZoneCalculator(containerRequest)
/**
* A boolean indicating whether or not the response should be rendered with
* special accomodations for IE 6 / 7 / 8 compatibility.
*
* @return true if this response should be rendered in
* IE 6/7/8 compatibility mode.
*
* @see LiftSession.legacyIeCompatibilityMode
* @see LiftRules.calcIEMode
* @see Req.isIE6
* @see Req.isIE7
* @see Req.isIE8
* @see Req.isIE
*/
def legacyIeCompatibilityMode: Boolean = session.map(_.legacyIeCompatibilityMode.is) openOr false // LiftRules.calcIEMode()
/**
* Get the current instance of HtmlProperties
*/
def htmlProperties: HtmlProperties = {
session.map(_.requestHtmlProperties.is) openOr
LiftRules.htmlProperties.vend(
S.request openOr Req.nil
)
}
/**
* Return a List of the LiftRules.DispatchPF functions that are set for this
* session. See addHighLevelSessionDispatcher for an example of how these are
* used.
*
* @see LiftRules.DispatchPF
* @see # addHighLevelSessionDispatcher ( String, LiftRules.DispatchPF )
* @see # removeHighLevelSessionDispatcher ( String )
* @see # clearHighLevelSessionDispatcher
*/
def highLevelSessionDispatcher: List[LiftRules.DispatchPF] = highLevelSessionDispatchList.map(_.dispatch)
/**
* Return the list of DispatchHolders set for this session.
*
* @see DispatchHolder
*/
def highLevelSessionDispatchList: List[DispatchHolder] =
session map (_.highLevelSessionDispatcher.toList.map(t => DispatchHolder(t._1, t._2))) openOr Nil
/**
* Adds a dispatch function for the current session, as opposed to a global
* dispatch through LiftRules.dispatch. An example would be if we wanted a user
* to be able to download a document only when logged in. First, we define
* a dispatch function to handle the download, specific to a given user:
*
*
* def getDocument(userId : Long)() : Box[LiftResponse] = { ... }
*
*
* Then, in the login/logout handling snippets, we could install and remove
* the custom dispatch as appropriate:
*
*
* def login(xhtml : NodeSeq) : NodeSeq = {
* def doAuth () {
* ...
* if (user.loggedIn_?) {
* S.addHighLevelSessionDispatcher("docDownload", {
* case Req(List("download", "docs"), _, _) => getDocument(user.id)
* } )
* }
* }
*
* def logout(xhtml : NodeSeq) : NodeSeq = {
* def doLogout () {
* ...
* S.removeHighLevelSessionDispatcher("docDownload")
* // or, if more than one dispatch has been installed, this is simpler
* S.clearHighLevelSessionDispatcher
* }
* }
*
*
* It's important to note that per-session dispatch takes precedence over
* LiftRules.dispatch, so you can override things set there.
*
* @param name A name for the dispatch. This can be used to remove it later by name.
* @param disp The dispatch partial function
*
* @see LiftRules.DispatchPF
* @see LiftRules.dispatch
* @see # removeHighLevelSessionDispatcher
* @see # clearHighLevelSessionDispatcher
*/
def addHighLevelSessionDispatcher(name: String, disp: LiftRules.DispatchPF) =
session map (_.highLevelSessionDispatcher += (name -> disp))
/**
* Removes a custom dispatch function for the current session. See
* addHighLevelSessionDispatcher for an example of usage.
*
* @param name The name of the custom dispatch to be removed.
*
* @see LiftRules.DispatchPF
* @see LiftRules.dispatch
* @see # addHighLevelSessionDispatcher
* @see # clearHighLevelSessionDispatcher
*/
def removeHighLevelSessionDispatcher(name: String) =
session map (_.highLevelSessionDispatcher -= name)
/**
* Clears all custom dispatch functions from the current session. See
* addHighLevelSessionDispatcher for an example of usage.
*
* @see LiftRules.DispatchPF
* @see LiftRules.dispatch
* @see # addHighLevelSessionDispatcher
* @see # clearHighLevelSessionDispatcher
*/
def clearHighLevelSessionDispatcher = session map (_.highLevelSessionDispatcher.clear())
/**
* Return the list of RewriteHolders set for this session. See addSessionRewriter
* for an example of how to use per-session rewrites.
*
* @see RewriteHolder
* @see LiftRules # rewrite
*/
def sessionRewriter: List[RewriteHolder] =
session map (_.sessionRewriter.toList.map(t => RewriteHolder(t._1, t._2))) openOr Nil
/**
* Adds a per-session rewrite function. This can be used if you only want a particular rewrite
* to be valid within a given session. Per-session rewrites take priority over rewrites set in
* LiftRules.rewrite, so you can use this mechanism to override global functionality. For example,
* you could set up a global rule to make requests for the "account profile" page go back to the home
* page by default:
*
*
* package bootstrap.liftweb
* ... imports ...
* class Boot {
* def boot {
* LiftRules.rewrite.append {
* case RewriteRequest(ParsePath(List("profile")), _, _, _) =>
* RewriteResponse(List("index"))
* }
* }
* }
*
*
* Then, in your login snippet, you could set up a per-session rewrite to the correct template:
*
*
* def loginSnippet (xhtml : NodeSeq) : NodeSeq = {
* ...
* def doLogin () {
* ...
* S.addSessionRewriter("profile", {
* case RewriteRequest(ParsePath(List("profile")), _, _, _) =>
* RewriteResponse(List("viewProfile"), Map("user" -> user.id))
* }
* ...
* }
* ...
* }
*
*
* And in your logout snippet you can remove the rewrite:
*
*
* def doLogout () {
* S.removeSessionRewriter("profile")
* // or
* S.clearSessionRewriter
* }
*
*
*
* @param name A name for the rewrite function so that it can be replaced or deleted later.
* @param rw The rewrite partial function
*
* @see LiftRules.rewrite
* @see # sessionRewriter
* @see # removeSessionRewriter
* @see # clearSessionRewriter
*/
def addSessionRewriter(name: String, rw: LiftRules.RewritePF) =
session map (_.sessionRewriter += (name -> rw))
/**
* Removes the given per-session rewriter. See addSessionRewriter for an
* example of usage.
*
* @see LiftRules.rewrite
* @see # addSessionRewriter
* @see # clearSessionRewriter
*/
def removeSessionRewriter(name: String) =
session map (_.sessionRewriter -= name)
/**
* Put the given Elem in the head tag. The Elems
* will be de-dupped so no problems adding the
* same style tag multiple times
*/
def putInHead(elem: Elem): Unit = _headTags.is += elem
/**
* Get the accumulated Elems for head
*
* @see putInHead
*/
def forHead(): List[Elem] = _headTags.is.toList
/**
* Put the given Elem at the end of the body tag.
*/
def putAtEndOfBody(elem: Elem): Unit = _tailTags.is += elem
/**
* Get the accumulated Elems for the end of the body
*
* @see putAtEndOfBody
*/
def atEndOfBody(): List[Elem] = _tailTags.is.toList
/**
* Add a comet to the list of comets that should be registered to
* receive updates on the page currently being rendered or on the page
* that invoked the currently running callback.
*/
def addComet(cometActor: LiftCometActor): Unit = {
requestCometVersions.set(
requestCometVersions.is + CVP(cometActor.uniqueId, cometActor.lastRenderTime)
)
}
/**
* As with {findOrBuildComet[T]}, but specify the type as a `String`. If the
* comet doesn't already exist, the comet type is first looked up via
* `LiftRules.cometCreationFactory`, and then as a class name in the comet
* packages designated by `LiftRules.buildPackage("comet")`.
*
* If `receiveUpdates` is `true`, updates to this comet will be pushed to
* the page currently being rendered or to the page that is currently
* invoking an AJAX callback. You can also separately register a comet to
* receive updates like this using {S.addComet}.
*/
def findOrCreateComet(
cometType: String,
cometName: Box[String] = Empty,
cometHtml: NodeSeq = NodeSeq.Empty,
cometAttributes: Map[String, String] = Map.empty,
receiveUpdatesOnPage: Boolean = false
): Box[LiftCometActor] = {
for {
session <- session ?~ "Comet lookup and creation requires a session."
cometActor <- session.findOrCreateComet(cometType, cometName, cometHtml, cometAttributes)
} yield {
if (receiveUpdatesOnPage)
addComet(cometActor)
cometActor
}
}
/**
* Find or build a comet actor of the given type `T` with the given
* configuration parameters. If a comet of that type with that name already
* exists, it is returned; otherwise, a new one of that type is created and
* set up, then returned.
*
* If `receiveUpdates` is `true`, updates to this comet will be pushed to
* the page currently being rendered or to the page that is currently
* invoking an AJAX callback. You can also separately register a comet to
* receive updates like this using {S.addComet}.
*/
def findOrCreateComet[T <: LiftCometActor](
cometName: Box[String],
cometHtml: NodeSeq,
cometAttributes: Map[String, String],
receiveUpdatesOnPage: Boolean
)(implicit cometManifest: Manifest[T]): Box[T] = {
for {
session <- session ?~ "Comet lookup and creation requires a session."
cometActor <- session.findOrCreateComet[T](cometName, cometHtml, cometAttributes)
} yield {
if (receiveUpdatesOnPage)
addComet(cometActor)
cometActor
}
}
/**
* Sometimes it's helpful to accumulate JavaScript as part of servicing
* a request. For example, you may want to accumulate the JavaScript
* as part of an Ajax response or a Comet Rendering or
* as part of a regular HTML rendering. Call `S.appendJs(jsCmd)`.
* The accumulated Javascript will be emitted as part of the response,
* wrapped in an `OnLoad` to ensure that it executes after
* the entire dom is available. If for some reason you need to run
* javascript at the top-level scope, use appendGlobalJs.
*/
def appendJs(js: JsCmd): Unit = _jsToAppend.is += js
/**
* Sometimes it's helpful to accumulate JavaScript as part of servicing
* a request. For example, you may want to accumulate the JavaScript
* as part of an Ajax response or a Comet Rendering or
* as part of a regular HTML rendering. Call `S.appendJs(jsCmd)`.
* The accumulated Javascript will be emitted as part of the response,
* wrapped in an `OnLoad` to ensure that it executes after
* the entire dom is available. If for some reason you need to run
* javascript at the top-level scope, use `appendGlobalJs`.
*/
def appendJs(js: Seq[JsCmd]): Unit = _jsToAppend.is ++= js
/**
* Add javascript to the page rendering that
* will execute in the global scope.
* Usually you should use `appendJs`, so that the javascript
* runs after the entire dom is available. If you need to
* declare a global var or you want javascript to execute
* immediately with no guarantee that the entire dom is available,
* you may use `appendGlobalJs`.
*/
def appendGlobalJs(js: JsCmd*): Unit = _globalJsToAppend.is ++= js
/**
* Generates the JsCmd needed to initialize comets in
* `S.requestCometVersions` on the client.
*/
private def commandsForComets: List[JsCmd] = {
val cometVersions = requestCometVersions.is
requestCometVersions.set(Set())
if (cometVersions.nonEmpty) {
List(
js.JE.Call(
"lift.registerComets",
js.JE.JsObj(
cometVersions.toList.map {
case CometVersionPair(guid, version) =>
(guid, js.JE.Num(version))
}: _*
),
// Don't kick off a new comet request client-side if we're responding
// to a comet request right now.
! currentCometActor.isDefined
).cmd
)
} else {
Nil
}
}
/**
* Get the accumulated JavaScript
*
* @see appendJs
*/
def jsToAppend(clearAfterReading: Boolean = false): List[JsCmd] = {
import js.JsCmds._
val globalJs = _globalJsToAppend.is.toList
val postPageJs =
S.session.toList.flatMap { session =>
session.postPageJavaScript(RenderVersion.get ::
currentCometActor.map(_.uniqueId).toList)
}
val cometJs = commandsForComets
val allJs =
globalJs ::: {
postPageJs ::: cometJs ::: _jsToAppend.is.toList match {
case Nil =>
Nil
case loadJs =>
List(OnLoad(loadJs))
}
}
if (clearAfterReading) {
_globalJsToAppend(ListBuffer())
_jsToAppend(ListBuffer())
}
allJs
}
/**
* Clears the per-session rewrite table. See addSessionRewriter for an
* example of usage.
*
* @see LiftRules.rewrite
* @see # addSessionRewriter
* @see # removeSessionRewriter
*/
def clearSessionRewriter = session map (_.sessionRewriter.clear())
/**
* Test the current request to see if it's a POST. This is a thin wrapper
* over Req.post_?
*
* @return true if the request is a POST request, false
* otherwise.
*/
def post_? = request.map(_.post_?).openOr(false)
/**
* Localize the incoming string based on a resource bundle for the current locale. The
* localized string is converted to an XML element if necessary via the LiftRules.localizeStringToXml
* function (the default behavior is to wrap it in a Text element). If the lookup fails for a given resource
* bundle (e.g. a null is returned), then the LiftRules.localizationLookupFailureNotice
* function is called with the input string and locale.
*
* @param str the string or ID to localize
*
* @return A Full box containing the localized XML or Empty if there's no way to do localization
*
* @see # locale
* @see # resourceBundles
* @see LiftRules.localizeStringToXml
* @see LiftRules.localizationLookupFailureNotice
* @see # loc ( String, NodeSeq )
*/
def loc(str: String): Box[NodeSeq] =
resourceBundles.flatMap(r => tryo(r.getObject(str) match {
case null => LiftRules.localizationLookupFailureNotice.foreach(_(str, locale)); Empty
case s: String => Full(LiftRules.localizeStringToXml(s))
case g: Group => Full(g)
case e: Elem => Full(e)
case n: Node => Full(n)
case ns: NodeSeq => Full(ns)
case x => Full(Text(x.toString))
}).flatMap(s => s)).find(e => true)
/**
* Localize the incoming string based on a resource bundle for the current locale,
* with a default value to to return if localization fails.
*
* @param str the string or ID to localize
* @param dflt the default string to return if localization fails
*
* @return the localized XHTML or default value
*
* @see # loc ( String )
*/
def loc(str: String, dflt: NodeSeq): NodeSeq = loc(str).openOr(dflt)
/**
* Localize the incoming string based on a resource bundle for the current locale. The
* localized string is converted to an XML element if necessary via the LiftRules.localizeStringToXml
* function (the default behavior is to wrap it in a Text element). If the lookup fails for a given resource
* bundle (e.g. a null is returned), then the LiftRules.localizationLookupFailureNotice
* function is called with the input string and locale. The
* function is applied to the result/
*
* @param str the string or ID to localize
* @param xform the function that transforms the NodeSeq
*
* @return A Full box containing the localized XML or Empty if there's no way to do localization
*
* @see # locale
* @see # resourceBundles
* @see LiftRules.localizeStringToXml
* @see LiftRules.localizationLookupFailureNotice
* @see # loc ( String, NodeSeq )
*/
def loc(str: String, xform: NodeSeq => NodeSeq): Box[NodeSeq] =
S.loc(str).map(xform)
/**
* Get a List of the resource bundles for the current locale. The resource bundles are defined by
* the LiftRules.resourceNames and LiftRules.resourceBundleFactories variables.
* If you do not define an entry for a particular key, we fall back to using
* Lift's core entries.
*
* @see LiftRules.resourceNames
* @see LiftRules.resourceBundleFactories
*/
def resourceBundles: List[ResourceBundle] = resourceBundles(locale) ++ liftCoreResourceBundle.toList
def resourceBundles(loc: Locale): List[ResourceBundle] = {
_resBundle.box match {
case Full(Nil) => {
_resBundle.set(
LiftRules.resourceForCurrentLoc.vend() :::
LiftRules.resourceNames.flatMap(name => tryo{
if (Props.devMode) {
tryo{
val clz = this.getClass.getClassLoader.loadClass("java.util.ResourceBundle")
val meth = clz.getDeclaredMethods.
filter{m => m.getName == "clearCache" && m.getParameterTypes.length == 0}.
toList.head
meth.invoke(null)
}
}
List(ResourceBundle.getBundle(name, loc))
}.openOr(
NamedPF.applyBox((name, loc), LiftRules.resourceBundleFactories.toList).map(List(_)) openOr Nil
)))
_resBundle.value
}
case Full(bundles) => bundles
case _ => throw new IllegalStateException("Attempted to use resource bundles outside of an initialized S scope. " +
"S only usable when initialized, such as during request processing. " +
"Did you call S.? from Boot?")
}
}
private object _liftCoreResBundle extends
RequestVar[Box[ResourceBundle]](tryo(ResourceBundle.getBundle(LiftRules.liftCoreResourceName, locale)))
/**
* Get the lift core resource bundle for the current locale as defined by the
* LiftRules.liftCoreResourceName varibale.
*
* @see LiftRules.liftCoreResourceName
*/
def liftCoreResourceBundle: Box[ResourceBundle] = _liftCoreResBundle.is
private object resourceValueCache extends TransientRequestMemoize[(String, Locale), String]
/**
* Get a localized string or return the original string.
* We first try your own bundle resources, if that fails, we try
* Lift's core bundle.
*
* @param str the string to localize
*
* @return the localized version of the string
*
* @see # resourceBundles
*/
def ?(str: String): String = resourceValueCache.get(str -> locale, ?!(str, resourceBundles))
/**
* Get a localized string or return the original string.
* We first try your own bundle resources, if that fails, we try
* Lift's core bundle.
*
* @param str the string to localize
*
* @param locale specific locale that should be used to localize this string
*
* @return the localized version of the string
*
* @see # resourceBundles
*/
def ?(str: String, locale: Locale): String = resourceValueCache.get(str -> locale, ?!(str, resourceBundles(locale)))
/**
* Attempt to localize and then format the given string. This uses the String.format method
* to format the localized string.
* We first try your own bundle resources, if that fails, we try
* Lift's core bundle.
*
* @param str the string to localize
* @param params the var-arg parameters applied for string formatting
*
* @return the localized and formatted version of the string
*
* @see String.format
* @see # resourceBundles
*/
def ?(str: String, params: Any*): String =
if (params.length == 0)
?(str)
else
String.format(locale, ?(str), params.flatMap {case s: AnyRef => List(s) case _ => Nil}.toArray: _*)
private def ?!(str: String, resBundle: List[ResourceBundle]): String = resBundle.flatMap(r => tryo(r.getObject(str) match {
case s: String => Full(s)
case n: Node => Full(n.text)
case ns: NodeSeq => Full(ns.text)
case _ => Empty
}).flatMap(s => s)).find(s => true) getOrElse {
LiftRules.localizationLookupFailureNotice.foreach(_(str, locale));
str
}
/**
* Test the current request to see if it's a GET. This is a thin wrapper on Req.get_?
*
* @return true if the request is a GET, false otherwise.
*
* @see Req.get_ ?
*/
def get_? = request.map(_.get_?).openOr(false)
/**
* Returns the logical page_id of the current request. All RequestVars for a current page share this id.
*/
def renderVersion: String = RenderVersion.get
/**
* The URI of the current request (not re-written). The URI is the portion of the request
* URL after the context path. For example, with a context path of "myApp",
* Lift would return the following URIs for the given requests:
*
*
*
* HTTP request URI
*
*
* http://foo.com/myApp/foo/bar.html /foo/bar.html
*
*
* http://foo.com/myApp/test/ /test/
*
*
* http://foo.com/myApp/item.html?id=42 /item.html
*
*
*
* If you want the full URI, including the context path, you should retrieve it
* from the underlying HTTPRequest. You could do something like:
*
*
* val fullURI = S.request.map(_.request.getRequestURI) openOr ("Undefined")
*
*
* The URI may be used to provide a link back to the same page as the current request:
*
*
* bind(...,
* "selflink" -> SHtml.link(S.uri, { () => ... }, Text("Self link")),
* ...)
*
*
* @see Req.uri
* @see net.liftweb.http.provider.HTTPRequest.uri
*/
def uri: String = request.map(_.uri).openOr("/")
/**
* Returns the query string for the current request
*/
def queryString: Box[String] = for {
req <- request
queryString <- req.request.queryString
} yield queryString
def uriAndQueryString: Box[String] = for {
req <- this.request
} yield req.uri + (queryString.map(s => "?"+s) openOr "")
/**
* Run any configured exception handlers and make sure errors in
* the handlers are ignored
*/
def runExceptionHandlers(req: Req, orig: Throwable): Box[LiftResponse] = {
S.assertExceptionThrown()
tryo{(t: Throwable) =>
logger.error("An error occurred while running error handlers", t)
logger.error("Original error causing error handlers to be run", orig)} {
NamedPF.applyBox((Props.mode, req, orig), LiftRules.exceptionHandler.toList);
} openOr Full(PlainTextResponse("An error has occurred while processing an error using the functions in LiftRules.exceptionHandler. Check the log for details.", 500))
}
private object _skipXmlHeader extends TransientRequestVar(false)
/**
* If true, then the xml header at the beginning of
* the returned XHTML page will not be inserted.
*
*/
def skipXmlHeader: Boolean = _skipXmlHeader.is
/**
* Set the skipXmlHeader flag
*/
def skipXmlHeader_=(in: Boolean): Unit = _skipXmlHeader.set(in)
/**
* Redirects the browser to a given URL. Note that the underlying mechanism for redirects is to
* throw a ResponseShortcutException, so if you're doing the redirect within a try/catch block,
* you need to make sure to either ignore the redirect exception or rethrow it. Two possible
* approaches would be:
*
*
* ...
* try {
* // your code here
* S.redirectTo(...)
* } catch {
* case e: Exception if !e.isInstanceOf[LiftFlowOfControlException] => ...
* }
*
*
* or
*
*
* ...
* try {
* // your code here
* S.redirectTo(...)
* } catch {
* case rse: LiftFlowOfControlException => throw rse
* case e: Exception => ...
* }
*
*
* @param where The new URL to redirect to.
*
* @see ResponseShortcutException
* @see # redirectTo ( String, ( ) => Unit)
*/
def redirectTo(where: String): Nothing = throw ResponseShortcutException.redirect(where)
/**
* Redirects the browser to a given URL and registers a function that will be executed when the browser
* accesses the new URL. Otherwise the function is exactly the same as S.redirectTo(String), which has
* example documentation. Note that if the URL that you redirect to must be part of your web application
* or the function won't be executed. This is because the function is only registered locally.
*
* @param where The new URL to redirect to.
* @param func The function to be executed when the redirect is accessed.
*
* @see # redirectTo ( String )
*/
def redirectTo(where: String, func: () => Unit): Nothing =
throw ResponseShortcutException.redirect(where, func)
/**
* Redirects the browser to a given URL. Note that the underlying mechanism for redirects is to
* throw a ResponseShortcutException, so if you're doing the redirect within a try/catch block,
* you need to make sure to either ignore the redirect exception or rethrow it. Two possible
* approaches would be:
*
*
* ...
* try {
* // your code here
* S.seeOther(...)
* } catch {
* case e: Exception if !e.instanceOf[LiftFlowOfControlException] => ...
* }
*
*
* or
*
*
* ...
* try {
* // your code here
* S.seeOther(...)
* } catch {
* case rse: LiftFlowOfControlException => throw rse
* case e: Exception => ...
* }
*
*
* @param where The new URL to redirect to.
*
* @see ResponseShortcutException
* @see # seeOther ( String, ( ) => Unit)
*/
def seeOther[T](where: String): T = throw ResponseShortcutException.seeOther(where)
/**
* Redirects the browser to a given URL and registers a function that will be executed when the browser
* accesses the new URL. Otherwise the function is exactly the same as S.seeOther(String), which has
* example documentation. Note that if the URL that you redirect to must be part of your web application
* or the function won't be executed. This is because the function is only registered locally.
*
* @param where The new URL to redirect to.
* @param func The function to be executed when the redirect is accessed.
*
* @see # seeOther ( String )
*/
def seeOther[T](where: String, func: () => Unit): T =
throw ResponseShortcutException.seeOther(where, func)
private[http] object oldNotices extends
TransientRequestVar[Seq[(NoticeType.Value, NodeSeq, Box[String])]](Nil)
/**
* Initialize the current request session. Generally this is handled by Lift during request
* processing, but this method is available in case you want to use S outside the scope
* of a request (standard HTTP or Comet).
*
* @param request The Req instance for this request
* @param session the LiftSession for this request
* @param f Function to execute within the scope of the request and session
*/
def init[B](request: Box[Req], session: LiftSession)(f: => B): B = {
if (inS.value) f
else {
if (request.map(_.stateless_?).openOr(false) ){
session.doAsStateless(_init(request, session)(() => f))
} else {
_init(request, session)(() => f)
}
}
}
def statelessInit[B](request: Req)(f: => B): B = {
session match {
case Full(s) if s.stateful_? => {
throw new StateInStatelessException(
"Attempt to initialize a stateless session within the context "+
"of a stateful session")
}
case Full(_) => f
case _ => {
val fakeSess = LiftRules.statelessSession.vend.apply(request)
try {
_init(Box !! request, fakeSess)(() => f)
} finally {
// ActorPing.schedule(() => fakeSess.doShutDown(), 0 seconds)
}
}
}
}
/**
* The current LiftSession.
*/
def session: Box[LiftSession] = Box.legacyNullTest(_sessionInfo.value)
/**
* Creates `LAFuture` instance aware of the current request and session. Each `LAFuture` returned by chained
* transformation method (e.g. `map`, `flatMap`) will be also request/session-aware. However, it's
* important to bear in mind that initial session or request are not propagated to chained methods. It's required
* that current execution thread for chained method has request or session available in scope if reading/writing
* some data to it as a part of chained method execution.
*/
def sessionFuture[T](task: => T, scheduler: LAScheduler = LAScheduler): LAFuture[T] =
LAFutureWithSession.withCurrentSession(task, scheduler)
/**
* Log a query for the given request. The query log can be tested to see
* if queries for the particular page rendering took too long. The query log
* starts empty for each new request. net.liftweb.mapper.DB.queryCollector is a
* method that can be used as a log function for the net.liftweb.mapper.DB.addLogFunc
* method to enable logging of Mapper queries. You would set it up in your bootstrap like:
*
*
* import net.liftweb.mapper.DB
* import net.liftweb.http.S
* class Boot {
* def boot {
* ...
* DB.addLogFunc(DB.queryCollector)
* ...
* }
* }
*
*
* Note that the query log is simply stored as a List and is not sent to any output
* by default. To retrieve the List of query log items, use S.queryLog. You can also
* provide your own analysis function that will process the query log via S.addAnalyzer.
*
* @see # queryLog
* @see # addAnalyzer
* @see net.liftweb.mapper.DB.addLogFunc
*/
def logQuery(query: String, time: Long) = p_queryLog.is += ((query, time))
/**
* Given a snippet class name, return the cached or predefined stateful snippet for
* that class
*/
def snippetForClass(cls: String): Box[DispatchSnippet] =
_statefulSnip.is.get(cls)
/**
* Register a stateful snippet for a given class name. Only registers if the name
* is not already set.
*/
def addSnippetForClass(cls: String, inst: DispatchSnippet): Unit = {
if (!_statefulSnip.is.contains(cls)) {
inst match {
case si: StatefulSnippet => si.addName(cls) // addresses
case _ =>
}
_statefulSnip.set(_statefulSnip.is.updated(cls, inst))
}
}
/**
* Register a stateful snippet for a given class name. The addSnippetForClass
* method is preferred
*/
def overrideSnippetForClass(cls: String, inst: DispatchSnippet): Unit = {
inst match {
case si: StatefulSnippet => si.addName(cls) // addresses
case _ =>
}
_statefulSnip.set(_statefulSnip.is.updated(cls, inst))
}
private[http] def unsetSnippetForClass(cls: String): Unit =
_statefulSnip.set(_statefulSnip.is - cls)
private var _queryAnalyzer: List[(Box[Req], Long,
List[(String, Long)]) => Any] = Nil
/**
* Add a query analyzer (passed queries for analysis or logging). The analyzer
* methods are executed with the request, total time to process the request, and
* the List of query log entries once the current request completes.
*
* @see # logQuery
* @see # queryLog
*/
def addAnalyzer(f: (Box[Req], Long,
List[(String, Long)]) => Any): Unit =
_queryAnalyzer = _queryAnalyzer ::: List(f)
private var aroundRequest: List[LoanWrapper] = Nil
private def doAround[B](ar: List[LoanWrapper])(f: => B): B =
ar match {
case Nil => f
case x :: xs => x(doAround(xs)(f))
}
/**
* You can wrap the handling of an HTTP request with your own wrapper. The wrapper can
* execute code before and after the request is processed (but still have S scope).
* This allows for query analysis, etc. See S.addAround(LoanWrapper) for an example.
* This version of the method takes a list of LoanWrappers that are applied in order.
* This method is *NOT* intended to change the generated HTTP request or
* to respond to requests early. LoanWrappers are there to set up
* and take down state *ONLY*. The LoanWrapper may be called outside
* the scope of an HTTP request (e.g., as part of an Actor invocation).
*
* @see # addAround ( LoanWrapper )
* @see LoanWrapper
*/
def addAround(lw: List[LoanWrapper]): Unit = aroundRequest = lw ::: aroundRequest
/**
* You can wrap the handling of an HTTP request with your own wrapper. The wrapper can
* execute code before and after the request is processed (but still have S scope).
* This allows for query analysis, etc. Wrappers are chained, much like servlet filters,
* so you can layer processing on the request. As an example, let's look at a wrapper that opens
* a resource and makes it available via a RequestVar, then closes the resource when finished:
*
*
* import net.liftweb.http.{ ResourceVar,S }
* import net.liftweb.util.LoanWrapper
*
* // Where "ResourceType" is defined by you
* object myResource extends ResourceVar[ResourceType](...)
*
* class Boot {
* def boot {
* ...
* S.addAround(
* new LoanWrapper {
* def apply[T](f: => T) : T = {
* myResource(... code to open and return a resource instance ...)
* f() // This call propagates the request further down the "chain" for template processing, etc.
* myResource.is.close() // Release the resource
* }
* }
* )
* ...
* }
* }
*
* This method is *NOT* intended to change the generated HTTP request or
* to respond to requests early. LoanWrappers are there to set up
* and take down state *ONLY*. The LoanWrapper may be called outside
* the scope of an HTTP request (e.g., as part of an Actor invocation).
*
* @see # addAround ( LoanWrapper )
* @see LoanWrapper
*/
def addAround(lw: LoanWrapper): Unit = aroundRequest = lw :: aroundRequest
/**
* Get a list of the logged queries. These log entries are added via the logQuery method, which
* has a more detailed explanation of usage.
*
* @see # logQuery ( String, Long )
* @see # addAnalyzer
*/
def queryLog: List[(String, Long)] = p_queryLog.is.toList
private def wrapQuery[B](f: () => B): B = {
val begin = millis
try {
f()
} finally {
val time = millis - begin
_queryAnalyzer.foreach(_(request, time, queryLog))
}
}
/**
* Sets a HTTP response header attribute. For example, you could set a "Warn" header in
* your response:
*
*
* ...
* S.setHeader("Warn", "The cheese is old and moldy")
* ...
*
*
* @see # getHeaders
*/
def setHeader(name: String, value: String): Unit = {
Box.legacyNullTest(_responseHeaders.value).foreach(
rh =>
rh.headers = rh.headers + (name -> value)
)
}
/**
* Synonym for S.setHeader. Exists to provide the converse to
* S.getResponseHeader.
*/
def setResponseHeader(name: String, value: String): Unit = {
setHeader(name, value)
}
/**
* Returns the currently set HTTP response headers as a List[(String, String)]. To retrieve
* a specific response header, use S.getResponseHeader. If you want to
* get request headers (those sent by the client), use Req.getHeaders
* or S.getRequestHeader.
*
* @see # setHeader ( String, String )
* @see # getResponseHeader ( String )
* @see # getRequestHeader ( String )
*/
def getResponseHeaders(in: List[(String, String)]): List[(String, String)] = {
Box.legacyNullTest(_responseHeaders.value).map(
rh =>
rh.headers.iterator.toList :::
in.filter {case (n, v) => !rh.headers.contains(n)}
).openOr(Nil)
}
/**
* Returns the current set value of the given HTTP response header as a Box. If
* you want a request header, use Req.getHeader or S.getRequestHeader.
*
* @param name The name of the HTTP header to retrieve
* @return A Full(value) or Empty if the header isn't set
*
* @see # setHeader ( String, String )
* @see # getResponseHeaders ( List[ ( String, String ) ] )
* @see # getRequestHeader ( String )
*/
def getResponseHeader(name: String): Box[String] = {
Box.legacyNullTest(_responseHeaders.value).map(
rh => Box(rh.headers.get(name))
).openOr(Empty)
}
/**
* Returns the current value of the given HTTP request header as a Box. This is
* really just a thin wrapper on Req.header(String). For response headers, see
* S.getHeaders, S.setHeader, or S.getHeader.
*
* @param name The name of the HTTP header to retrieve
* @return A Full(value) or Empty if the header isn't set
*
* @see Req # header ( String )
* @see # getHeader ( String )
* @see # setHeader ( String, String )
* @see # getHeaders ( List[ ( String, String ) ] )
*/
def getRequestHeader(name: String): Box[String] =
for (req <- request;
hdr <- req.header(name))
yield hdr
/**
* Sets the document type for the response. If this is not set, the DocType for Lift responses
* defaults to XHTML 1.0 Transitional.
*
* @see getDocType
* @see ResponseInfo.docType
* @see DocType
*/
def setDocType(what: Box[String]): Unit = {
Box.legacyNullTest(_responseHeaders.value).foreach(
rh =>
rh.docType = what
)
}
/**
* Returns the document type that was set for the response. The default is XHTML 1.0
* Transitional.
*
* @see setDocType
* @see DocType
*/
def getDocType: (Boolean, Box[String]) = Box.legacyNullTest(_responseHeaders.value).map(
rh => (rh.overrodeDocType, rh.docType)
).openOr((false, Empty))
private object _skipDocType extends TransientRequestVar(false)
/**
* When this is true, Lift will not emit a DocType definition at the start of the response
* content. If you're sending XHTML and this is set to true, you need to include the DocType
* in your template.
*
* @see # skipDocType_ =(Boolean)
*/
def skipDocType: Boolean = _skipDocType.is
/**
* Sets Lift's DocType behavior. If this is set to true, Lift will not emit a DocType definition
* at the start of the response content. If you're sending XHTML and this is set to true, you need
* to include the DocType in your template.
*
* @param skip Set to true to prevent Lift from emitting a DocType in its response
*
* @see # skipDocType
*/
def skipDocType_=(skip: Boolean): Unit = {_skipDocType.set(skip)}
/**
* Adds a cleanup function that will be executed at the end of the request pocessing.
* Exceptions thrown from these functions will be swallowed, so make sure to handle any
* expected exceptions within your function.
*
* @param f The function to execute at the end of the request.
*/
def addCleanupFunc(f: () => Unit): Unit = postFuncs.is += f
/**
* Are we currently in the scope of a stateful request
*/
def statefulRequest_? : Boolean = session match {
case Full(s) => s.stateful_?
case _ => false
}
private def _nest2InnerInit[B](f: () => B): B = {
__functionMap.doWith(Map()) {
doAround(aroundRequest) {
try {
wrapQuery {
val req = this.request
session match {
case Full(s) if s.stateful_? =>
LiftRules.earlyInStateful.toList.foreach(_(req))
case Full(s) =>
LiftRules.earlyInStateless.toList.foreach(_(req))
case _ =>
}
f
}
} finally {
postFuncs.is.foreach(f => tryo(f()))
}
}
}
}
private def doStatefulRewrite(old: Box[Req]): Box[Req] = {
// Don't even try to rewrite Req.nil
old.map { req =>
if (statefulRequest_? && req.path.partPath.nonEmpty && (req.request ne null) ) {
Req(req, S.sessionRewriter.map(_.rewrite) :::
LiftRules.statefulRewrite.toList, Nil,
LiftRules.statelessReqTest.toList)
} else {
req
}
}
}
private def _innerInit[B](request: Box[Req], f: () => B): B = {
_lifeTime.doWith(false) {
_attrs.doWith((Null,Nil)) {
_resBundle.doWith(Nil) {
inS.doWith(true) {
val statefulRequest = doStatefulRewrite(request)
withReq(statefulRequest) {
// set the request for standard requests
if (statefulRequest.map(_.standardRequest_?).openOr(false))
_originalRequest.set(statefulRequest)
_nest2InnerInit(f)
}
}
}
}
}
}
private[http] def withReq[T](req: Box[Req])(f: => T): T = {
CurrentReq.doWith(req openOr null) {
_request.doWith(req openOr null) {
f
}
}
}
/**
* @return a List[Cookie] even if the underlying request's Cookies are null.
*/
private def getCookies(request: Box[HTTPRequest]): List[HTTPCookie] =
for (r <- (request).toList;
ca <- Box.legacyNullTest(r.cookies).toList;
c <- ca) yield c
private def _init[B](request: Box[Req], session: LiftSession)(f: () => B): B = {
this._request.doWith(request.openOr(null)) {
_sessionInfo.doWith(session) {
_responseHeaders.doWith(new ResponseInfoHolder) {
TransientRequestVarHandler(Full(session),
RequestVarHandler(Full(session),
_responseCookies.doWith(CookieHolder(getCookies(containerRequest), Nil)) {
if (Props.devMode) LiftRules.siteMap // materialize the sitemap very early
_innerInit(request, f)
}
)
)
}
}
}
}
/**
* This method is a convenience accessor for LiftRules.loggedInTest. You can define your own
* function to check to see if a user is logged in there and this will call it.
*
* @see LiftRules.loggedInTest
*
* @return the value from executing LiftRules.loggedInTest, or false if a test function
* is not defined.
*/
def loggedIn_? : Boolean = LiftRules.loggedInTest.map(_.apply()) openOr false
/**
* Returns the 'Referer' HTTP header attribute.
*/
def referer: Box[String] = containerRequest.flatMap(_.header("Referer"))
/**
* Functions that are mapped to HTML elements are, by default,
* garbage collected if they are not seen in the browser in the last 10 minutes (defined in LiftRules.unusedFunctionsLifeTime).
* In some cases (e.g., JSON handlers), you may want to extend the
* lifespan of the functions to the lifespan of the session.
*
* @param span If true, extend the mapped function lifetime to the life of the session
* @param f A function to execute in the context of specified span
*
* @see LiftRules.unusedFunctionsLifeTime
*/
def functionLifespan[T](span: Boolean)(f: => T): T =
_lifeTime.doWith(span)(f)
/**
* Returns whether functions are currently extended to the lifetime of the session.
*
* @return true if mapped functions will currently last the life of the session.
*/
def functionLifespan_? : Boolean = _lifeTime.box openOr false
/**
* Get a list of current attributes. Each attribute item is a pair of (key,value). The key
* is an Either that depends on whether the attribute is prefixed or not. If the attribute
* is prefixed, the key is a Right((prefix, name)). If the attribute is unprefixed then the
* key is a Left(name). For example, the following table shows how various tag attributes
* would be represented:
*
*
*
* Snippet Tag
* Parsed attrs
*
*
* <lift:MySnippet testname="test" />
* List((Left("testname"), "test"))
*
*
* <lift:MySnippet anchor:name="test" />
* List((Right(("anchor", "name")), "test"))
*
*
*
* The prefixedAttrsToMap method provides a convenient way to retrieve only attributes with
* a given prefix. The prefixedAttrsToMetaData method can be used to add attributes onto an XML
* node
*
* @see # prefixedAttrsToMap ( String )
* @see # prefixedAttrsToMap ( String, Map )
* @see # prefixedAttrsToMetaData ( String )
* @see # prefixedAttrsToMetaData ( String, Map )
*/
def attrs: List[(Either[String, (String, String)], String)] = _attrs.value match {
case null => Nil
case (current,full) => full
}
/**
* Returns the S attributes that are prefixed by 'prefix' parameter as a Map[String, String]
* that will be 'merged' with the 'start' Map
*
* @param prefix the prefix to be matched
* @param start the initial Map
*
* @return Map[String, String]
*
* @see # prefixedAttrsToMap ( String )
* @see # prefixedAttrsToMetaData ( String )
* @see # prefixedAttrsToMetaData ( String, Map )
*
*/
def prefixedAttrsToMap(prefix: String, start: Map[String, String]): Map[String, String] =
attrs.reverse.flatMap {
case (Right((pre, name)), value) if pre == prefix => List((name, value))
case (Left(name), value) if name.startsWith(prefix + ":") => List(name.substring(prefix.length + 1) -> value)
case _ => Nil
}.foldRight(start) {
case ((name, value), at) => at + (name -> value)
}
/**
* Returns the S attributes that are prefixed by 'prefix' parameter as a Map[String, String]
*
* @param prefix the prefix to be matched
*
* @return Map[String, String]
*
* @see # prefixedAttrsToMap ( String, Map )
* @see # prefixedAttrsToMetaData ( String )
* @see # prefixedAttrsToMetaData ( String, Map )
*
*/
def prefixedAttrsToMap(prefix: String): Map[String, String] =
prefixedAttrsToMap(prefix: String, Map.empty)
/**
* Returns the S attributes that are prefixed by 'prefix' parameter as a MetaData.
* The start Map will be 'merged' with the Map resulted after prefix matching and
* the result Map will be converted to a MetaData. The MetaData can be used to add attributes
* back onto XML elements via Scala's '%' method. For example, if we wanted to add
* attributes prefixed with "anchor" to any <a> elements we create, we could
* do something like:
*
*
* val myLink = (...) % S.prefixedAttrsToMetaData("anchor", Map("id" -> "myAnchor"))
*
*
* @param prefix the prefix to be matched
* @param start the initial Map
*
* @return MetaData representing the combination of current attributes plus the start Map of attributes
*
* @see # prefixedAttrsToMap ( String )
* @see # prefixedAttrsToMap ( String, Map )
* @see # prefixedAttrsToMetaData ( String )
*
*/
def prefixedAttrsToMetaData(prefix: String, start: Map[String, String]): MetaData =
mapToAttrs(prefixedAttrsToMap(prefix, start))
/**
* Similar with prefixedAttrsToMetaData(prefix: String, start: Map[String, String])
* but there is no 'start' Map
*/
def prefixedAttrsToMetaData(prefix: String): MetaData = prefixedAttrsToMetaData(prefix, Map.empty)
/**
* Converts a Map[String, String] into a MetaData instance. This can be used to
* add attributes to an XML element based on a map of attribute->value pairs. See
* prefixedAttrsToMetaData(String,Map) for an example.
*
* @param in The map of attributes
*
* @return MetaData representing the Map of attributes as unprefixed attributes.
*
* @see # prefixedAttrsToMetaData ( String, Map )
*
*/
def mapToAttrs(in: Map[String, String]): MetaData =
in.foldLeft[MetaData](Null) {
case (md, (name, value)) => new UnprefixedAttribute(name, value, md)
}
/**
* Converts the S.attrs to a Map[String, String]. The key of the map depends on whether
* the attribute is prefixed or not. Prefixed attributes have keys of the form
* "prefix:name", while unprefixed attributes have keys of the form "name". If you only want
* attributes for a specific prefix, use prefixedAttrsToMap.
*
* @see # prefixedAttrsToMap ( String )
* @see # prefixedAttrsToMap ( String, Map )
*/
def attrsFlattenToMap: Map[String, String] = Map.empty ++ attrs.flatMap {
case (Left(key), value) => List((key, value))
case (Right((prefix, key)), value) => List((prefix + ":" + key, value))
case _ => Nil
}
/**
* Converts S.attrs attributes to a MetaData object that can be used to add
* attributes to one or more XML elements. Similar to prefixedAttrsToMetaData, except
* that it handles both prefixed and unprefixed attributes. This version of the method will
* use all of the currently set attributes from S.attrs. If you want to filter it, use the
* attrsToMetaData(String => Boolean) version, which allows you to specify a predicate
* function for filtering. For example, if you want all of the current attributes to be
* added to a div tag, you could do:
*
*
* val myDiv = ( {...} ) % S.attrsToMetaData
*
*
* @return a MetaData instance representing all attributes in S.attrs
*
* @see # attrsToMetaData ( String = > Boolean )
*/
def attrsToMetaData: MetaData = attrsToMetaData(ignore => true)
/**
* Similar to S.attrsToMetaData, but lets you specify a predicate function that filters the
* generated MetaData. For example, if you only wanted the "id" attribute, you could do:
*
*
* val myDiv = ( {...} ) % S.attrsToMetaData(_.equalsIgnoreCase("id"))
*
*
* @param predicate The predicate function which is executed for each attribute name. If the function
* returns true, then the attribute is included in the MetaData.
*
* @see # attrsToMetaData
*
*/
def attrsToMetaData(predicate: String => Boolean): MetaData = {
attrs.foldLeft[MetaData](Null) {
case (md, (Left(name), value)) if (predicate(name)) => new UnprefixedAttribute(name, value, md)
case (md, (Right((prefix, name)), value)) if (predicate(name)) => new PrefixedAttribute(prefix, name, value, md)
case _ => Null
}
}
/**
* Converts S.attrs attributes to a MetaData object that can be used to add
* attributes to one or more XML elements. Similar to prefixedAttrsToMetaData, except
* that it handles both prefixed and unprefixed attributes. This version of the method will
* use all of the currently set attributes from S.attrs. If you want to filter it, use the
* currentAttrsToMetaData(String => Boolean) version, which allows you to specify a predicate
* function for filtering. For example, if you want all of the current attributes to be
* added to a div tag, you could do:
*
*
* val myDiv = ( {...} ) % S.attrsToMetaData
*
*
* @return a MetaData instance representing all attributes in S.attrs
*
* @see # attrsToMetaData ( String = > Boolean )
*/
def currentAttrsToMetaData: MetaData = currentAttrsToMetaData(ignore => true)
/**
* Similar to S.attrsToMetaData, but lets you specify a predicate function that filters the
* generated MetaData. For example, if you only wanted the "id" attribute, you could do:
*
*
* val myDiv = ( {...} ) % S.attrsToMetaData(_.equalsIgnoreCase("id"))
*
*
* @param predicate The predicate function which is executed for each attribute name. If the function
* returns true, then the attribute is included in the MetaData.
*
* @see # attrsToMetaData
*
*/
def currentAttrsToMetaData(predicate: String => Boolean): MetaData = {
currentAttrs.filter(a => predicate(a.key))
}
/**
* Find and process a template. This can be used to load a template from within some other Lift processing,
* such as a snippet or view. If you just want to retrieve the XML contents of a template, use
* Templates.apply.
*
* @param path The path for the template that you want to process
* @param snips any snippet mapping specific to this template run
* @return a Full Box containing the processed template, or a Failure if the template could not be found.
*
* @see TempalateFinder # apply
*/
def runTemplate(path: List[String], snips: (String, NodeSeq => NodeSeq)*): Box[NodeSeq] =
mapSnippetsWith(snips :_*) {
for{
t <- Templates(path) ?~ ("Couldn't find template " + path)
sess <- session ?~ "No current session"
} yield sess.processSurroundAndInclude(path.mkString("/", "/", ""), t)
}
/**
* Evaluate a template for snippets. This can be used to run a template
* from within some other Lift processing,
* such as a snippet or view.
*
* @param template the HTML template to run through the Snippet re-writing process
* @param snips any snippet mapping specific to this template run
* @return a Full Box containing the processed template, or a Failure if the template could not be found.
*/
def eval(template: NodeSeq, snips: (String, NodeSeq => NodeSeq)*): Box[NodeSeq] =
mapSnippetsWith(snips :_*) {
for{
sess <- session ?~ "No current session"
} yield sess.processSurroundAndInclude("HTML Constant", template)
}
/**
* Used to get an attribute by its name. There are several means to getting
* attributes:
*
*
// Get a Box for the attribute:
val myAttr = S.attr("test") openOr "Not found"
// Get an attribute or return a default value:
val myAttr = S.attr("name", "Fred")
// Apply a transform function on the attribute value, or return an Empty:
val pageSize = S.attr("count", _.toInt) openOr 20
// There are also prefixed versions:
val prefixedAttr = S.attr("prefix", "name") openOr "Not found"
*
*
* Note that this uses the data held in S.attrs, which means that
* it will find attributes through the entire snippet nesting stack.
* For example, given the snippets:
*
*
* <lift:MyStuff.snippetA foo="bar">
* <lift.MyStuff.snippetB>...</lift.MyStuff.snippetB>
* </lift:MyStuff.snippetA>
*
*
* Calling S.attr("foo") from snippetB will return
* Full("bar").
*/
object attr extends AttrHelper[Box] {
type Info = String
protected def findAttr(key: String): Option[Info] =
attrs.find {
case (Left(v), _) if v == key => true
case _ => false
}.map(_._2)
protected def findAttr(prefix: String, key: String): Option[Info] =
attrs.find {
case (Right((p, n)), _) if (p == prefix && n == key) => true
case _ => false
}.map(_._2)
protected def convert[T](in: Option[T]): Box[T] = Box(in)
/**
* Returns the unprefixed attribute value as an Option[NodeSeq]
* for easy addition to the attributes
*/
def ~(key: String): Option[NodeSeq] = apply(key).toOption.map(Text(_))
/**
* Returns the prefixed attribute value as an Option[NodeSeq]
* for easy addition to the attributes
*/
def ~(prefix: String, key: String): Option[NodeSeq] = apply(prefix, key).toOption.map(Text(_))
}
/**
* Sometimes, in the course of eager evaluation, it becomes necessary
* to clear attribtues so they do not polute the eagerly evaluated stuff.
* When you need to clear the attributes, wrap your code block in clearAttrs
* and have fun.
*
* @param f the call-by-name code block to run where the attributes are clear
* @tparam T the return type of the code block
* @return the return value of the code block
*/
def clearAttrs[T](f: => T):T = {
_attrs.doWith((Null, Nil))(f)
}
/**
* A function that will eagerly evaluate a template.
*/
def eagerEval : NodeSeq => NodeSeq = ns => {
S.session match {
case Full(session) => session.processSurroundAndInclude("Eager Eval", ns)
case _ => ns
}
}
/**
* Initialize the current request session if it's not already initialized.
* Generally this is handled by Lift during request processing, but this
* method is available in case you want to use S outside the scope
* of a request (standard HTTP or Comet).
*
* @param session the LiftSession for this request
* @param f A function to execute within the scope of the session
*/
def initIfUninitted[B](session: LiftSession)(f: => B): B = {
if (inS.value) f
else init(Empty, session)(f)
}
/**
* Retrieves the attributes from the most recently executed
* snippet element.
*
* For example, given the snippets:
*
*
* <lift:MyStuff.snippetA foo="bar">
* <lift.MyStuff.snippetB>...</lift.MyStuff.snippetB>
* </lift:MyStuff.snippetA>
*
*
* S.currentAttrs will return Nil.
*
* If you want a particular attribute, the S.currentAttr
* helper object simplifies things considerably.
*/
def currentAttrs: MetaData = _attrs.value match {
case null => Null
case (current, full) => current
}
/**
* Temporarily adds the given attributes to the current set, then executes the given function.
*
* @param attrs The attributes to set temporarily
*/
def withAttrs[T](attrs: MetaData)(f: => T): T = {
val currentStack = _attrs.value._2
val newFrame = attrs.toList.map {
case pa: PrefixedAttribute => (Right(pa.pre, pa.key), pa.value.text)
case m => (Left(m.key), m.value.text)
}
_attrs.doWith((attrs, newFrame ::: currentStack))(f)
}
/**
* Used to get an attribute by its name from the current
* snippet element. There are several means to getting
* attributes:
*
*
// Get a Box for the attribute:
val myAttr = S.currentAttr("test") openOr "Not found"
// Get an attribute or return a default value:
val myAttr = S.currentAttr("name", "Fred")
// Apply a transform function on the attribute value, or return an Empty:
val pageSize = S.currentAttr("count", _.toInt) openOr 20
// There are also prefixed versions:
val prefixedAttr = S.currentAttr("prefix", "name") openOr "Not found"
*
*
* Note that this uses the data held in S.currentAttrs, which means that
* it will only find attributes from the current snippet element.
* For example, given the snippets:
*
*
* <lift:MyStuff.snippetA foo="bar">
* <lift.MyStuff.snippetB>...</lift.MyStuff.snippetB>
* </lift:MyStuff.snippetA>
*
*
* Calling S.currentAttr("foo") from snippetB will return
* Empty.
*/
object currentAttr extends AttrHelper[Box] {
type Info = String
protected def findAttr(key: String): Option[Info] =
currentAttrs.toList.find{ _.key == key }.map(_.value.text)
protected def findAttr(prefix: String, key: String): Option[Info] =
currentAttrs.toList.find{ _.prefixedKey == (prefix + ":" + key) }.map(_.value.text)
protected def convert[T](in: Option[T]): Box[T] = Box(in)
/**
* Returns the unprefixed attribute value as an Option[NodeSeq]
* for easy addition to the attributes
*/
def ~(key: String): Option[NodeSeq] = apply(key).toOption.map(Text(_))
/**
* Returns the prefixed attribute value as an Option[NodeSeq]
* for easy addition to the attributes
*/
def ~(prefix: String, key: String): Option[NodeSeq] = apply(prefix, key).toOption.map(Text(_))
}
/**
* Returns the LiftSession parameter denominated by 'what'.
*
* @see # getSessionAttribute
* @see # set
* @see # setSessionAttribute
* @see # unset
* @see # unsetSessionAttribute
*/
def get(what: String): Box[String] = session.flatMap(_.get[String](what))
/**
* Returns the HttpSession parameter denominated by 'what'
*
* @see # get
* @see # set
* @see # setSessionAttribute
* @see # unset
* @see # unsetSessionAttribute
*
*/
def getSessionAttribute(what: String): Box[String] = containerSession.flatMap(_.attribute(what) match {case s: String => Full(s) case _ => Empty})
/**
* Returns the HttpSession
*/
def containerSession: Box[HTTPSession] = session.flatMap(_.httpSession).or(containerRequest.map(_.session))
/**
* Returns the 'type' S attribute. This corresponds to the current Snippet's name. For example, the snippet:
*
*
<lift:Hello.world />
*
*
* Will return "Hello.world".
*/
def invokedAs: String = (currentSnippet or attr("type")) openOr ""
/**
* Sets a HttpSession attribute
*
* @see # get
* @see # getSessionAttribute
* @see # set
* @see # unset
* @see # unsetSessionAttribute
*
*/
def setSessionAttribute(name: String, value: String) = containerSession.foreach(_.setAttribute(name, value))
/**
* Sets a LiftSession attribute
*
* @see # get
* @see # getSessionAttribute
* @see # setSessionAttribute
* @see # unset
* @see # unsetSessionAttribute
*
*/
def set(name: String, value: String) = session.foreach(_.set(name, value))
/**
* Removes a HttpSession attribute
*
* @see # get
* @see # getSessionAttribute
* @see # set
* @see # setSessionAttribute
* @see # unset
*
*/
def unsetSessionAttribute(name: String) = containerSession.foreach(_.removeAttribute(name))
/**
* Removes a LiftSession attribute
*
* @see # get
* @see # getSessionAttribute
* @see # set
* @see # setSessionAttribute
* @see # unsetSessionAttribute
*
*/
def unset(name: String) = session.foreach(_.unset(name))
/**
* The current container request
*/
def containerRequest: Box[HTTPRequest] =
request.flatMap(r => Box !! r.request)
/**
* The hostname to which the request was sent. This is taken from the "Host" HTTP header, or if that
* does not exist, the DNS name or IP address of the server.
*/
def hostName: String = request.map(_.hostName) openOr Req.localHostName
/**
* The host and path of the request up to and including the context path. This does
* not include the template path or query string.
*/
def hostAndPath: String = request.map(_.hostAndPath) openOr ""
/**
* Get a map of function name bindings that are used for form and other processing. Using these
* bindings is considered advanced functionality.
*/
def functionMap: Map[String, AFuncHolder] = __functionMap.box.openOr(Map())
private def testFunctionMap[T](f: => T): T =
session match {
case Full(s) if s.stateful_? => f
case _ => throw new StateInStatelessException(
"Accessing function map information outside of a stateful session")
}
/**
* Clears the function map. potentially very destuctive... use at your own risk!
*/
def clearFunctionMap: Unit = {
if (__functionMap.box.map(_.size).openOr(0) > 0) {
// Issue #1037
testFunctionMap {
__functionMap.box.foreach(ignore => __functionMap.set(Map()))
}
}
}
/**
* The current context path for the deployment.
*/
def contextPath: String = (request.map(_.contextPath) or session.map(_.contextPath)) openOr ""
/**
* Finds a snippet function by name.
*
* @see LiftRules.snippets
*/
def locateSnippet(name: String): Box[NodeSeq => NodeSeq] = {
val snippet = if (name.indexOf(".") != -1) name.roboSplit("\\.") else name.roboSplit(":")
NamedPF.applyBox(snippet, LiftRules.snippets.toList)
}
private object _currentSnippetNodeSeq extends ThreadGlobal[NodeSeq]
/**
* The code block is executed while setting the current raw NodeSeq
* for access elsewhere
*
* @param ns the current NodeSeq
* @param f the call-by-name value to return (the code block to execute)
* @tparam T the type that f returns
* @return the value the the expression returns
*/
def withCurrentSnippetNodeSeq[T](ns: NodeSeq)(f: => T): T =
_currentSnippetNodeSeq.doWith(ns)(f)
/**
* The current raw NodeSeq that resulted in a snippet invocation
* @return The current raw NodeSeq that resulted in a snippet invocation
*/
def currentSnippetNodeSeq: Box[NodeSeq] = _currentSnippetNodeSeq.box
private object _ignoreFailedSnippets extends ThreadGlobal[Boolean]
/**
* Set the ignore snippet error mode. In this mode, any
* snippet failures (usually snippets not being invocable) will be
* ignored and the original NodeSeq will be returned.
*
* This is useful if you want to do an initial pass of a page with a white-list
* of snippets, but not run every snippet on the page.
*
* @param ignore sets the ignore flag
* @param f the code block to execute
* @tparam T the return type of the code block
* @return the return of the code block
*/
def runSnippetsWithIgnoreFailed[T](ignore: Boolean)(f: => T): T =
_ignoreFailedSnippets.doWith(ignore)(f)
/**
*
* @return should failed snippets be ignored and have the original NodeSeq
* returned?
*/
def ignoreFailedSnippets: Boolean = _ignoreFailedSnippets.box openOr false
private object _currentSnippet extends RequestVar[Box[String]](Empty)
private[http] def doSnippet[T](name: String)(f: => T): T = {
val old = _currentSnippet.is
try {
_currentSnippet.set(Full(name))
f
} finally {
_currentSnippet.set(old)
}
}
def currentSnippet: Box[String] = _currentSnippet.is
def locateMappedSnippet(name: String): Box[NodeSeq => NodeSeq] = _snippetMap.is.get(name)
/**
* Associates a name with a snippet function 'func'. This can be used to change a snippet
* mapping on a per-request basis. For example, if we have a page that we want to change
* behavior on based on query parameters, we could use mapSnippet to programmatically determine
* which snippet function to use for a given snippet in the template. Our code would look like:
*
*
import scala.xml.{ NodeSeq,Text }
class SnipMap {
def topSnippet (xhtml : NodeSeq) : NodeSeq = {
if (S.param("showAll").isDefined) {
S.mapSnippet("listing", listing)
} else {
S.mapSnippet("listing", { ignore => Text("") } )
}
...
}
def listing(xhtml : NodeSeq) : NodeSeq = {
...
}
*
* Then, your template would simply look like:
*
*
<lift:surround with="default" at="content">
...
<p><lift:SnipMap.topSnippet /></p>
<p><lift:listing /></p>
</lift:surround>
*
*
* Snippets are processed in the order that they're defined in the
* template, so if you want to use this approach make sure that
* the snippet that defines the mapping comes before the snippet that
* is being mapped. Also note that these mappings are per-request, and are
* discarded after the current request is processed.
*
* @param name The name of the snippet that you want to map (the part after "<lift:").
* @param func The snippet function to map to.
*/
def mapSnippet(name: String, func: NodeSeq => NodeSeq): Unit = {_snippetMap.set(_snippetMap.is.updated(name, func))}
/**
* The are times when it's helpful to define snippets for a certain
* call stack... snippets that are local purpose. Use doWithSnippets
* to temporarily define snippet mappings for the life of f.
*/
def mapSnippetsWith[T](snips: (String, NodeSeq => NodeSeq)*)(f: => T): T = {
val newMap = _snippetMap.is ++ snips
_snippetMap.doWith(newMap)(f)
}
private def updateFunctionMap(name: String, value: AFuncHolder): Unit = {
__functionMap.box match {
case Full(old) => __functionMap.set(old + ((name, value)))
case _ =>
}
}
/**
* Associates a name with a function impersonated by AFuncHolder. These are basically functions
* that are executed when a request contains the 'name' request parameter.
*/
def addFunctionMap(name: String, value: AFuncHolder) = {
testFunctionMap {
(autoCleanUp.box, _oneShot.box) match {
case (Full(true), _) => {
updateFunctionMap(name,
new S.ProxyFuncHolder(value) {
var shot = false
override def apply(in: List[String]): Any = {
synchronized {
if (!shot) {
shot = true
S.session.map(_.removeFunction(name))
value.apply(in)
} else {
js.JsCmds.Noop
}
}
}
override def apply(in: FileParamHolder): Any = {
synchronized {
if (!shot) {
shot = true
S.session.map(_.removeFunction(name))
value.apply(in)
} else {
js.JsCmds.Noop
}
}
}
})
}
case (_, Full(true)) => {
updateFunctionMap(name,
new S.ProxyFuncHolder(value) {
var shot = false
lazy val theFuture: LAFuture[Any] = {
S.session.map(_.removeFunction(name))
val future: LAFuture[Any] = new LAFuture
updateFunctionMap(name, new S.ProxyFuncHolder(value) {
override def apply(in: List[String]): Any = future.get(5000).openOrThrowException("legacy code")
override def apply(in: FileParamHolder): Any = future.get(5000).openOrThrowException("legacy code")
})
future
}
def fixShot(): Boolean = synchronized {
val ret = shot
shot = true
ret
}
override def apply(in: List[String]): Any = {
val ns = fixShot()
if (ns) {
theFuture.get(5000).openOrThrowException("legacy code")
} else {
val future = theFuture
try {
val ret = value.apply(in)
future.satisfy(ret)
ret
} catch {
case e: Exception => future.satisfy(e); throw e
}
}
}
override def apply(in: FileParamHolder): Any = {
val ns = fixShot()
if (ns) {
theFuture.get(5000).openOrThrowException("legacy code")
} else {
val future = theFuture
try {
val ret = value.apply(in)
future.satisfy(ret)
ret
} catch {
case e: Exception => future.satisfy(e); throw e
}
}
}
})
}
case _ =>
updateFunctionMap(name, value)
}
}
}
/**
* Decorates an URL with jsessionid parameter in case cookies are disabled from the container. Also
* it appends general purpose parameters defined by LiftRules.urlDecorate
*/
def encodeURL(url: String) = {
URLRewriter.rewriteFunc map (_(url)) openOr url
}
private[http] object _formGroup extends TransientRequestVar[Box[Int]](Empty)
private object formItemNumber extends TransientRequestVar[Int](0)
private def notLiftOrScala(in: StackTraceElement): Boolean =
in.getClassName match {
case s if s.startsWith("net.liftweb") => false
case s if s.startsWith("scala") => false
case _ => true
}
def disableTestFuncNames_? : Boolean = _disableTestFuncNames.box openOr false
def disableTestFuncNames[T](f: => T): T =
_disableTestFuncNames.doWith(true) {
f
}
def formFuncName: String = LiftRules.funcNameGenerator()
/** Default func-name logic during test-mode. */
def generateTestFuncName: String =
if (disableTestFuncNames_?)
generateFuncName
else
generatePredictableFuncName
/** Generates a func-name based on the location in the call-site source code. */
def generatePredictableFuncName: String = {
val bump: Long = ((_formGroup.is openOr 0) + 1000L) * 100000L
val num: Int = formItemNumber.is
formItemNumber.set(num + 1)
import java.text._
val prefix: String = new DecimalFormat("00000000000000000").format(bump + num)
// take the first 2 non-Lift/non-Scala stack frames for use as hash issue 174
"f" + prefix + "_" + Helpers.hashHex((new Exception).getStackTrace.toList.filter(notLiftOrScala).take(2).map(_.toString).mkString(","))
}
/** Standard func-name logic. This is the default routine. */
def generateFuncName: String =
_formGroup.is match {
case Full(x) => Helpers.nextFuncName(x.toLong * 100000L)
case _ => Helpers.nextFuncName
}
def formGroup[T](group: Int)(f: => T): T = {
val x = _formGroup.is
_formGroup.set(Full(group))
try {
f
} finally {
_formGroup.set(x)
}
}
import json.JsonAST._
/**
* Build a handler for incoming JSON commands based on the new Json Parser
*
* @param f - partial function against a returning a JsCmds
*
* @return ( JsonCall, JsCmd )
*/
def createJsonFunc(f: PFPromoter[JValue, JsCmd]): (JsonCall, JsCmd) = createJsonFunc(Empty, Empty, f)
/**
* Build a handler for incoming JSON commands based on the new Json Parser
*
* @param onError -- the JavaScript to execute client-side if the request is not processed by the server
* @param f - partial function against a returning a JsCmds
*
* @return ( JsonCall, JsCmd )
*/
def createJsonFunc(onError: JsCmd, f: PFPromoter[JValue, JsCmd]): (JsonCall, JsCmd) =
createJsonFunc(Empty, Full(onError), f)
/**
* Build a handler for incoming JSON commands based on the new Json Parser. You
* can use the helpful Extractor in net.liftweb.util.JsonCommand
*
* @param name -- the optional name of the command (placed in a comment for testing)
* @param onError -- the JavaScript to execute client-side if the request is not processed by the server
* @param f - partial function against a returning a JsCmds
*
* @return ( JsonCall, JsCmd )
*/
def createJsonFunc(name: Box[String], onError: Box[JsCmd], pfp: PFPromoter[JValue, JsCmd]): (JsonCall, JsCmd) = {
functionLifespan(true) {
val key = formFuncName
import json._
def jsonCallback(in: List[String]): JsCmd = {
val f = pfp.pff()
for {
line <- in
parsed <- JsonParser.parseOpt(line) if f.isDefinedAt(parsed)
} yield f(parsed)}.foldLeft(JsCmds.Noop)(_ & _)
val onErrorFunc: String =
onError.map(f => JsCmds.Run("function onError_" + key + "() {" + f.toJsCmd + """
}
""").toJsCmd) openOr ""
val onErrorParam = onError.map(f => "onError_" + key) openOr "null"
val af: AFuncHolder = jsonCallback _
addFunctionMap(key, af)
(JsonCall(key), JsCmds.Run(name.map(n => onErrorFunc +
"/* JSON Func " + n + " $$ " + key + " */").openOr("") +
"function " + key + "(obj) {lift.ajax(" +
"'" + key + "='+ encodeURIComponent(" +
LiftRules.jsArtifacts.
jsonStringify(JE.JsRaw("obj")).
toJsCmd + "), null," + onErrorParam + ");}"))
}
}
/**
* Returns the JsCmd that holds the notices markup
*
*/
private[http] def noticesToJsCmd: JsCmd = LiftRules.noticesToJsCmd()
implicit def stuff2ToUnpref(in: (Symbol, Any)): UnprefixedAttribute = new UnprefixedAttribute(in._1.name, Text(in._2.toString), Null)
/**
* Attaches to this uri and parameter that has function f associated with. When
* this request is submitted to server the function will be executed and then
* it is automatically cleaned up from functions caches.
*/
def mapFuncToURI(uri: String, f: () => Unit): String = {
session map (_ attachRedirectFunc (uri, Box.legacyNullTest(f))) openOr uri
}
/**
* Execute code synchronized to the current session object
*/
def synchronizeForSession[T](f: => T): T = {
session match {
case Full(s) => s.synchronized(f)
case _ => f
}
}
/**
* Maps a function with an random generated and name
*/
def fmapFunc[T](in: AFuncHolder)(f: String => T): T = {
val name = formFuncName
addFunctionMap(name, in)
f(name)
}
/**
* Wrap an AFuncHolder with the current snippet and Loc context so that for Ajax calls, the original snippets,
* RequestVars and Loc (location) are populated
*
* @param f the AFuncHolder that you want to wrap with execution context
*/
def contextFuncBuilder(f: S.AFuncHolder): S.AFuncHolder = S.session match {
case Full(s) => s.contextFuncBuilder(f)
case _ => f
}
def render(xhtml: NodeSeq, httpRequest: HTTPRequest): NodeSeq = {
def doRender(session: LiftSession): NodeSeq =
session.processSurroundAndInclude("external render", xhtml)
if (inS.value) doRender(session.openOrThrowException("legacy code"))
else {
val req = Req(httpRequest, LiftRules.statelessRewrite.toList,
Nil,
LiftRules.statelessReqTest.toList,
System.nanoTime)
CurrentReq.doWith(req) {
val ses: LiftSession = SessionMaster.getSession(httpRequest,
Empty) match {
case Full(ret) =>
ret.fixSessionTime()
ret
case _ =>
val ret = LiftSession(httpRequest.session, req.contextPath)
ret.fixSessionTime()
SessionMaster.addSession(ret,
req,
httpRequest.userAgent,
SessionMaster.getIpFromReq(req))
ret
}
init(Box !! req, ses) {
doRender(ses)
}
}
}
}
/**
* Maps a function that will be called with a parsed JValue and should
* return a JsCmd to be sent back to the browser. Note that if the
* passed JSON does not parse, the function will not be invoked.
*/
def jsonFmapFunc[T](in: JValue => JsCmd)(f: String => T)(implicit dummy: AvoidTypeErasureIssues1): T = {
import json._
val name = formFuncName
addFunctionMap(name, SFuncHolder((s: String) => JsonParser.parseOpt(s).map(in) getOrElse JsCmds.Noop))
f(name)
}
/**
* Returns all the HTTP parameters having 'n' name
*/
def params(n: String): List[String] =
paramsForComet.get.get(n) getOrElse
request.flatMap(_.params.get(n)).openOr(Nil)
/**
* Returns the HTTP parameter having 'n' name
*/
def param(n: String): Box[String] =
paramsForComet.get.get(n).flatMap(_.headOption) orElse
request.flatMap(r => Box(r.param(n)))
/**
* Set the paramsForComet and run the function
*/
private[http] def doCometParams[T](map: Map[String, List[String]])(f: => T): T = {
paramsForComet.doWith(map)(f)
}
/**
* Sets an ERROR notice as a plain text
*/
def error(n: String): Unit = {error(Text(n))}
/**
* Sets an ERROR notice as an XML sequence
*/
def error(n: NodeSeq): Unit = {p_notice.is += ((NoticeType.Error, n, Empty))}
/**
* Sets an ERROR notice as an XML sequence and associates it with an id
*/
def error(id: String, n: NodeSeq): Unit = {p_notice.is += ((NoticeType.Error, n, Full(id)))}
/**
* Sets an ERROR notice as plain text and associates it with an id
*/
def error(id: String, n: String): Unit = {error(id, Text(n))}
/**
* Sets a NOTICE notice as plain text
*/
def notice(n: String): Unit = {notice(Text(n))}
/**
* Sets a NOTICE notice as an XML sequence
*/
def notice(n: NodeSeq): Unit = {p_notice.is += ((NoticeType.Notice, n, Empty))}
/**
* Sets a NOTICE notice as and XML sequence and associates it with an id
*/
def notice(id: String, n: NodeSeq): Unit = {p_notice.is += ((NoticeType.Notice, n, Full(id)))}
/**
* Sets a NOTICE notice as plai text and associates it with an id
*/
def notice(id: String, n: String): Unit = {notice(id, Text(n))}
/**
* Sets a WARNING notice as plain text
*/
def warning(n: String): Unit = {warning(Text(n))}
/**
* Sets a WARNING notice as an XML sequence
*/
def warning(n: NodeSeq): Unit = {p_notice += ((NoticeType.Warning, n, Empty))}
/**
* Sets a WARNING notice as an XML sequence and associates it with an id
*/
def warning(id: String, n: NodeSeq): Unit = {p_notice += ((NoticeType.Warning, n, Full(id)))}
/**
* Sets a WARNING notice as plain text and associates it with an id
*/
def warning(id: String, n: String): Unit = {warning(id, Text(n))}
/**
* Sets an ERROR notices from a List[FieldError]
*/
def error(vi: List[FieldError]): Unit = {p_notice ++= vi.map {i => (NoticeType.Error, i.msg, i.field.uniqueFieldId)}}
private[http] def message(msg: String, notice: NoticeType.Value): Unit = {message(Text(msg), notice)}
private[http] def message(msg: NodeSeq, notice: NoticeType.Value): Unit = {p_notice += ((notice, msg, Empty))}
/**
* Add a whole list of notices
*/
def appendNotices(list: Seq[(NoticeType.Value, NodeSeq, Box[String])]): Unit = {p_notice.is ++= list}
/**
* Returns the current notices
*/
def getNotices: List[(NoticeType.Value, NodeSeq, Box[String])] = p_notice.toList
/**
* Returns the current and "old" notices
*/
def getAllNotices: List[(NoticeType.Value, NodeSeq, Box[String])] = p_notice.toList ++ oldNotices.is
/**
* Returns only ERROR notices
*/
def errors: List[(NodeSeq, Box[String])] = List(oldNotices.is, p_notice.is).flatMap(_.filter(_._1 == NoticeType.Error).map(n => (n._2, n._3)))
/**
* Returns only NOTICE notices
*/
def notices: List[(NodeSeq, Box[String])] = List(oldNotices.is, p_notice.is).flatMap(_.filter(_._1 == NoticeType.Notice).map(n => (n._2, n._3)))
/**
* Returns only WARNING notices
*/
def warnings: List[(NodeSeq, Box[String])] = List(oldNotices.is, p_notice.is).flatMap(_.filter(_._1 == NoticeType.Warning).map(n => (n._2, n._3)))
/**
* Clears up the notices
*/
def clearCurrentNotices: Unit = {p_notice.is.clear()}
/**
* Returns the messages provided by list function that are associated with id
*
* @param id - the lookup id
* @param f - the function that returns the messages
*/
def messagesById(id: String)(f: => List[(NodeSeq, Box[String])]): List[NodeSeq] = f filter (_._2 map (_ equals id) openOr false) map (_._1)
/**
* Returns all messages, associated with any id or not
*
* @param f - the function that returns the messages
*/
def messages(f: => List[(NodeSeq, Box[String])]): List[NodeSeq] = f map (_._1)
/**
* Returns the messages that are not associated with any id
*
* @param f - the function that returns the messages
*/
def noIdMessages(f: => List[(NodeSeq, Box[String])]): List[NodeSeq] = {
f.collect {
case (message, Empty) => message
}
}
/**
* Returns the messages that are associated with any id.
* Messages associated with the same id will be enlisted.
*
* @param f - the function that returns the messages
*/
def idMessages(f: => List[(NodeSeq, Box[String])]): List[(String, List[NodeSeq])] = {
val res = new HashMap[String, List[NodeSeq]]
f.filter(_._2.isEmpty == false).foreach(_ match {
case (node, id) =>
val key = id openOrThrowException("legacy code")
res += (key -> (res.getOrElseUpdate(key, Nil) ::: List(node)))
})
res.toList
}
implicit def tuple2FieldError(t: (FieldIdentifier, NodeSeq)) : FieldError = FieldError(t._1, t._2)
/**
* Use this in DispatchPF for processing REST requests asynchronously. Note that
* this must be called in a stateful context, therefore the S state must be a valid one.
*
* @param f - the user function that does the actual computation. This function
* takes one parameter which is the function that must be invoked
* for returning the actual response to the client. Note that f function
* is invoked asynchronously in the context of a different thread.
*
*/
def respondAsync(f: => Box[LiftResponse]): () => Box[LiftResponse] = {
RestContinuation.async {reply => reply(f.openOr(EmptyResponse))}
}
/**
* If you bind functions (i.e. using SHtml helpers) inside the closure passed to callOnce,
* after your function is invoked, it will be automatically removed from functions cache so
* that it cannot be invoked again.
*/
def callOnce[T](f: => T): T = {
autoCleanUp.doWith(true) {
f
}
}
/**
* All functions created inside the oneShot scope
* will only be called once and their results will be
* cached and served again if the same function is invoked
*/
def oneShot[T](f: => T): T =
_oneShot.doWith(true) {
f
}
}
/**
* Defines the notices types
*/
object NoticeType extends Serializable{
sealed abstract class Value(val title : String) {
def lowerCaseTitle = title.toLowerCase
// The element ID to use for notice divs
def id : String = LiftRules.noticesContainerId + "_" + lowerCaseTitle
// The element that will define the title to use in notice messages
def titleTag : String = lowerCaseTitle + "_msg"
def styleTag : String = lowerCaseTitle + "_class"
}
object Notice extends Value("Notice")
object Warning extends Value("Warning")
object Error extends Value("Error")
}