* The WOContext is the context for one HTTP transaction, that is, one * request/response cycle. It provides access to all objects required for * handling the requests, this includes request, response, the session, * the current page and so on. *
* THREAD: WOContext is not threadsafe, its supposed to be used from one thread
* only (the one processing the HTTP request).
*/
public class WOContext extends WOCoreContext
implements IJoContext
{
// TBD: document, eg how they are autocreated and the effect on links which
// got generated before ...
// TBD: move element-id handling to an own class like in SOPE (necessary?)
protected WOSession session;
protected List
* @see deriveLocale()
*
* @return a Java Locale or null if none could be associated with the request
*/
public Locale locale() {
if (this.locale == null)
this.locale = this.deriveLocale();
return this.locale;
}
/**
* Try to derive a Locale from the session or request (LC parameter). You
* might want to override this method in Context subclasses. In application
* code you will usually call the locale() method, not this one.
*
*
* @see locale()
* @see deriveTimeZone()
*
* @return a Java Locale.
*/
public Locale deriveLocale() {
/* first check for an explicit LC request parameter */
if (this.request != null) {
String lc = this.request.stringFormValueForKey("LC");
if (lc != null && lc.length() > 0) {
Locale l = new Locale(lc);
if (l != null) return l;
}
// TBD: check HTTP locale fields? (accept-language header)
// => this is already covered by the languages() based method below
}
/* next check whether the session has a locale assigned */
if (this.hasSession()) {
Locale l = (Locale)this.session().valueForKey("locale");
if (l != null) return l;
}
/* finally ask the WOResourceManager */
return WOResourceManager.localeForLanguages(this.languages());
}
public void setTimeZone(TimeZone _tz) {
this.timezone = _tz;
}
/**
* Returns the Java TimeZone associated with the current transaction. If no
* TimeZone was set using setTimeZone(), the method will call deriveTimeZone()
* to check the session ("timezone" KVC key) or request for additional ways
* to specify a timezone.
*
*
* @see deriveTimeZone()
*
* @return a Java Locale or null if none could be associated with the request
*/
public TimeZone timezone() {
if (this.timezone == null)
this.timezone = this.deriveTimeZone();
return this.timezone;
}
/**
* Try to derive a TimeZone from the session or request (TZ parameter). You
* might want to override this method in Context subclasses. In application
* code you will usually call the timezone() method, not this one.
*
*
* @see timezone()
* @see deriveLocale()
*
* @return a Java TimeZone object
*/
public TimeZone deriveTimeZone() {
/* first check for an explicit LC request parameter */
if (this.request != null) {
String tzname = this.request.stringFormValueForKey("TZ");
if (tzname != null && tzname.length() > 0) {
TimeZone tz = TimeZone.getTimeZone(tzname);
if (tz != null) return tz;
}
}
/* next check whether the session has a locale assigned */
if (this.hasSession()) {
TimeZone tz = (TimeZone)this.session().valueForKey("timezone");
if (tz != null) return tz;
}
return TimeZone.getDefault();
}
/* fragments */
public void setFragmentID(String _fragmentID) {
this.fragmentID = _fragmentID;
}
public String fragmentID() {
return this.fragmentID;
}
public void enableRendering() {
this.isRenderingDisabled = false;
}
public void disableRendering() {
this.isRenderingDisabled = true;
}
public boolean isRenderingDisabled() {
return this.isRenderingDisabled;
}
/* sessions */
public boolean hasSession() {
return this.session != null ? true : false;
}
public boolean hasNewSession() {
return this.hasNewSession;
}
public void setSession(WOSession _sn) {
this.session = _sn;
}
public void setNewSession(WOSession _sn) {
this.setSession(_sn);
this.hasNewSession = true;
}
public WOSession session() {
// TODO: create session on-demand
if (this.session == null) {
this.application.initializeSession(this);
if (this.session == null)
log.warn("missing session in context ...");
}
return this.session;
}
/* resource management */
public WOResourceManager rootResourceManager() {
if (this.application == null) return null;
return this.application().resourceManager();
}
/* components */
public void setPage(WOComponent _page) {
if (_page != null)
_page.ensureAwakeInContext(this);
this.page = _page;
}
public WOComponent page() {
return this.page;
}
public WOComponent component() {
return (this.stackPos == -1 || this.stackPos >= this.componentStack.length)
? null : this.componentStack[this.stackPos];
}
public WOComponent parentComponent() {
return (this.stackPos < 1) ? null : this.componentStack[this.stackPos - 1];
}
public WOElement componentContent() {
return (this.stackPos == -1) ? null : this.contentStack[this.stackPos];
}
public int componentStackCount() {
return this.stackPos + 1;
}
public void enterComponent(WOComponent _component, WOElement _content) {
// TODO: support increasing the array? currently we will raise an exception
/* push component to stack */
this.stackPos++;
if (this.stackPos >= this.componentStack.length) {
log.error("component stack depth exhausted: " + this.stackPos +
"\n context: " + this +
"\n stack:\n" +
UString.componentsJoinedByString(this.componentStack,"\n "));
return;
}
this.componentStack[this.stackPos] = _component;
this.contentStack[this.stackPos] = _content;
/* awake component */
this._awakeComponent(_component);
/* sync with parent */
if (this.stackPos > 0)
_component.pullValuesFromParent();
}
public void leaveComponent(WOComponent _component) {
if (this.stackPos < 0) {
compStackLog.error("empty stack, tried to leave component: " +
_component);
return;
}
/* find component and compare it with the given one */
WOComponent component = (this.stackPos < this.componentStack.length)
? this.componentStack[this.stackPos] : null;
if (_component != null && component != _component) {
compStackLog.error("component leave mismatch: " +
component + " - " + _component);
// TODO: scan stack for _component to see whether the _component is
// upcoming, do something useful
return;
}
/* sync variables back to parent component */
if (this.stackPos > 1)
component.pushValuesToParent();
/* pop component from stack */
this.componentStack[this.stackPos] = null;
this.contentStack[this.stackPos] = null;
this.stackPos--;
}
public Object cursor() {
return this.component();
}
/* maintaining sleep/awake */
protected Set
* Note: this is not the only place which awakes components.
*
* @param _component - the WOComponent
*/
public void _awakeComponent(WOComponent _component) {
if (_component == null)
return;
if (this.awakeComponents.contains(_component)) /* already awake? */
return;
_component._awakeWithContext(this);
this._addAwakeComponent(_component);
}
/**
* Calls the sleep() method on all components which got an awake() call with
* this context.
* This is called in WOApp.handleRequest() before a session is saved to ensure
* that just the necessary state is preserved.
*/
public void sleepComponents() {
boolean sendSleepToPage = true;
for (WOComponent c: this.awakeComponents) {
c._sleepWithContext(this);
if (c == this.page) sendSleepToPage = false;
}
if (sendSleepToPage && this.page != null)
this.page._sleepWithContext(this);
this.awakeComponents.clear();
}
/* forms */
/**
* If a WOForm is entered, it calls this method to remember the fact. Remember
* that forms must not be nested.
*
* @param _flag - a flag denoting whether the form is entered or left
*/
public void setIsInForm(boolean _flag) {
if (this.isInForm && _flag)
log.warn("form is already active.");
this.isInForm = _flag;
}
/**
* Returns whether we are inside an WOForm. Remember that we do NOT track
* <#form> or <form> tags.
*
* @return true if the template is contained in a WOForm, false if not
*/
public boolean isInForm() {
return this.isInForm;
}
/**
* This method is called during the takeValues() phase by WOInput elements to
* register an element as the active one. Eg if a WOSubmitButton encounters
* that its value is set during takeValues() it will set itself as the active
* form element (since only the values of the pressed submit button are
* transmitted, hence can be used to detect the action).
*
* Unlike SOPE the JOPE element id does NOT include the context-id.
*
* @return a unique identifier for the current element (in page scope)
*/
public String elementID() {
return this.elementID.toString();
}
public void appendElementIDComponent(String _id) {
if (this.elementID.length() > 0)
this.elementID.append('.');
this.elementID.append(_id);
}
public void appendElementIDComponent(int _id) {
if (this.elementID.length() > 0)
this.elementID.append('.');
this.elementID.append(_id);
}
/**
* Adds a zero to the element ID. Example:
* Important: this does not add any query parameters (like wosid).
*
* @param _requestHandlerKey - key of the given request handler, eg 'wa'
* @param _requestHandlerPath - path to be handled by the request handler
* @param _qs - properly encoded query string
* @return a URL
*/
public String urlWithRequestHandlerKey
(String _requestHandlerKey, String _requestHandlerPath, String _queryString)
{
// TODO: complete me
StringBuilder sb = new StringBuilder(256);
if (this.request != null) {
String an;
if ((an = this.request.adaptorPrefix()) != null)
sb.append(an);
if ((an = this.request.applicationName()) != null) {
int len = sb.length();
if (len == 0 || sb.charAt(len - 1) != '/')
sb.append("/");
sb.append(an);
}
}
if (_requestHandlerKey != null) {
sb.append("/");
sb.append(_requestHandlerKey);
}
if (_requestHandlerPath != null) {
if (!_requestHandlerPath.startsWith("/")) sb.append("/");
sb.append(_requestHandlerPath);
}
if (_queryString != null && _queryString.length() > 0) {
sb.append("?");
sb.append(_queryString);
}
return sb.toString();
}
/**
* Constructs a component action URL for the currently active element. This
* URL includes the sessionID as well as the currently active elementID.
*
* This method calls urlWithRequestHandlerKey to perform the final assembly.
*
* @return a String with the component action URL
*/
public String componentActionURL() {
WOSession sn;
if ((sn = this.session()) == null) {
log.error("could no return action URL due to missing session");
return null;
}
/*
* This makes the request handler save the page in the session at the
* end of the request (only necessary if the page generates URLs which
* refer the context).
*/
this.savePageRequired = true;
// TODO: generate relative link if the request URL was in the same session
// and used a component action path
// TBD: this should be done in urlWithRequestHandlerKey, no?
return this.urlWithRequestHandlerKey(
this.application.componentRequestHandlerKey(), /* request handler key */
sn.sessionID() + "/" + this.contextID() + "/" + this.elementID(),
null /* query string */);
}
/**
* Generates a URL for the given direct action.
*
* Important: this does not embed a session id! Session ids or query
* session parameters are added to the queryDict by the respective
* WODynamicElement class (usually WOLinkGenerator).
*
* @param _name - a direct action name, eg "Main/default"
* @param _queryDict - set of query parameters to be included in the URL
* @return a URL
*/
@SuppressWarnings("unchecked")
public String directActionURLForActionNamed(String _name, Map _queryDict) {
// TBD: is this correct? This means that the URLs embedded in the HTML
// page are encoded in the same charset like the page. Browsers might
// behave differently (and we should document the behaviour here)
WOMessage r = this.response();
String charset = r != null ? r.contentEncoding() : null;
if (charset == null) charset = WOMessage.defaultURLEncoding();
String qs = UMap.stringForQueryDictionary(_queryDict, charset);
return this.urlWithRequestHandlerKey(
this.application.directActionRequestHandlerKey(), /* rq handler key */
_name, /* path */
qs /* query string */);
}
/**
* Same like directActionURLForActionNamed(name,dict), but this prepares the
* query dictionary with the query session parameters and the session-id (if
* one is active).
*
* @param _name - name of the direct action (eg Main/default)
* @param _queryDict - query parameters
* @param _addSnId - whether to include the session id (?wosid)
* @param _incQuerySession - whether to include the query session
* @return a URL pointing to the direct action
*/
public String directActionURLForActionNamed
(String _name, Map
* Examples:
* Example:
* This basically moves the invoke step to the take values process for form
* values. Actually this should not be strictly necessary?
*
* @param _element - the WOElement for the action (usually an WOInput object)
*/
public void addActiveFormElement(WOElement _element) {
if (this.activeFormElement != null) {
formLog.error("active form element already set: " + _element);
return;
}
if (false)
System.err.println("ACTIVE: " + this.elementID() + ": " + _element);
this.activeFormElement = _element;
// TBD: is this really necessary? The element-id has no relevance?
this.setRequestSenderID(this.elementID());
}
/**
* Returns the element (usually an WOInput) which registered itself as the
* active one during the takeValues() phase.
*
* @return the active form WOElement or null if there was none
*/
public WOElement activeFormElement() {
return this.activeFormElement;
}
/* element IDs */
// TODO: improve speed
/**
* Pseudo public, be very careful when calling this.
*/
public void _setElementID(String _eid) {
this.elementID.setLength(0);
this.elementID.append(_eid);
}
/**
* Returns the element-id of the currently active element. The element-id can
* be assigned manually, or it is an automatically generated path. The id is
* calculated by the path the elements flow and repeat through the template
* tree.
* Careful: this is *not* just the node positions, element ids are
* also added/removed by elements like repetitions or conditions! (the
* contents of a repetition need own IDs, not their index in the tree)
*
* "2.3.4.5" => "2.3.4.5.0"
* "" => "0"
*/
public void appendZeroElementIDComponent() {
this.elementID.append((this.elementID.length() > 0) ? ".0" : "0");
}
/**
* Increments the last part of the element-id. Example
* "2.3.4.5" => "2.3.4.6"
* "2" => "3"
*/
public void incrementLastElementIDComponent() {
int v;
int idx;
// System.err.println("INCR: " + this.elementID);
idx = this.elementID.lastIndexOf(".");
if (idx == -1) {
v = Integer.parseInt(this.elementID.toString());
this.elementID.setLength(0);
}
else {
v = Integer.parseInt(this.elementID.substring(idx + 1 /* skip dot */));
this.elementID.setLength(idx + 1 /* include dot */);
}
v++;
this.elementID.append(v);
}
/**
* Deletes the last part of the element-id. Example
* "2.3.4.5" => "2.3.4"
* "2" => ""
*/
public void deleteLastElementIDComponent() {
int idx;
idx = this.elementID.lastIndexOf(".");
this.elementID.setLength(idx == -1 ? 0 : idx /* exclude dot */);
}
/**
* Completely clears the element-id (to the empty string "").
*/
public void deleteAllElementIDComponents() {
this.elementID.setLength(0);
}
public void setRequestSenderID(String _id) {
this.reqElementID = _id;
}
public String senderID() {
return this.reqElementID;
}
/* URL processing */
/**
* Returns the WOQuerySession attached to the context. This calls the
* WOApplication's restoreQuerySessionInContext() on demand to set up
* the query session.
*
* @return the WOQuerySession assigned to the context
*/
public WOQuerySession querySession() {
if (this.querySession == null && this.application != null)
this.querySession = this.application.restoreQuerySessionInContext(this);
return this.querySession;
}
/**
* This method uses the query session to determine which query parameters
* should be included in a URL. The method is called by URL generating
* dynamic elements (eg WOHyperlink).
*
* @return a set of key/value pairs to be included in the parameters of a URL
*/
public Map
* URL ClientObject Method
* /customers/123/view /customers/123 view
* /customers/123/view/-manage /customers/123/view -manage
* /customers/123 /customers/123
* Note that a Callable itself can be a clientObject. This is because we need
* to modify Callables in the management interface (the -manage example
* above).
*
* @return the clientObject, or null if there was no traversal path
*/
public Object clientObject() {
return this.joTraversalPath != null
? this.joTraversalPath.clientObject()
: null;
}
/**
* Returns the URL path to the clientObject(). This URL is always terminated
* with a slash (so that you can use relative URLs to invoke methods).
*
* /contacts/M2344/
* /tasks/
*
* @return the URL path
*/
public String clientObjectActionURL() {
if (this.joTraversalPath == null)
return null;
if (this.clientObjectURL != null)
return this.clientObjectURL;
String[] path = this.joTraversalPath.pathToClientObject();
if (path == null)
return null;
StringBuilder sb = new StringBuilder(path.length * 16 + 32);
if (path.length == 0)
return this.urlWithRequestHandlerKey(null, "/", null);
final String urlEnc = this.response().contentEncoding();
sb.append("/"); /* root */
for (int i = 0; i < path.length; i++) {
String s = UString.stringByEncodingURLComponent(path[i], urlEnc);
if (s == null) s = path[i];
sb.append(s);
sb.append("/"); /* we always *end* with a slash! */
}
return this.urlWithRequestHandlerKey(null, sb.toString(), null);
}
/**
* Returns the user record which was determined by the JOPE publishing
* process. If no user is set yet, this will attempt to lookup an
* authenticator and use that to derive the user from the request.
*/
public IJoUser activeUser() {
if (this.activeUser != null)
return this.activeUser;
IJoAuthenticator authenticator =
this.lookupAuthenticatorByTraversingLookupPath();
if (authenticator == null) {
log.warn("found no authenticator to determine active user");
return null;
}
if ((this.activeUser = authenticator.userInContext(this)) == null) {
log.warn("authenticator returned no user: " + authenticator);
return null;
}
return this.activeUser;
}
/**
* Walks over the object traversal path in reverse order and checks each of
* the objects whether they implement the IJoAuthenticatorContainer interface.
* If so, the object is asked for an authenticator which is then returned.
*
* @return an IJoAuthenticator or null if none could be located.
*/
protected IJoAuthenticator lookupAuthenticatorByTraversingLookupPath() {
JoTraversalPath joPath = this.joTraversalPath();
if (joPath == null) {
log.warn("no traversalpath is set: " + this);
return null;
}
Object[] path = joPath.objectTraversalPath();
if (path == null || path.length == 0) {
log.warn("traversalpath is empty: " + this);
return null;
}
for (int i = path.length - 1; i >= 0; i--) {
if (path[i] instanceof IJoAuthenticatorContainer) {
IJoAuthenticator authenticator =
((IJoAuthenticatorContainer)path[i]).authenticatorInContext(this);
if (authenticator != null) return authenticator;
}
}
if (this.application instanceof IJoAuthenticatorContainer) {
IJoAuthenticator authenticator =
((IJoAuthenticatorContainer)this.application)
.authenticatorInContext(this);
if (authenticator != null) return authenticator;
}
return null;
}
/* notifications */
public void awake() {
}
public void sleep() {
/* this can happen if an exception occures in handleRequest() */
if (this.awakeComponents != null)
this.sleepComponents();
if (this.session != null)
this.session._sleepWithContext(this);
}
/* description */
@Override
public void appendAttributesToDescription(StringBuilder _d) {
super.appendAttributesToDescription(_d);
if (this.session != null) {
_d.append(" sn=");
_d.append(this.session.sessionID());
}
if (this.elementID != null && this.elementID.length() > 0) {
_d.append(" eid=");
_d.append(this.elementID);
}
WOComponent p = this.page();
if (p != null) _d.append(" page=" + p.name());
WOComponent c = this.component();
if (c != null && c != p) _d.append(" comp=" + c.name());
if (this.joTraversalPath != null) {
String[] pns = this.joTraversalPath.path();
if (pns != null && pns.length > 0) {
_d.append(" path=");
for (int i = 0; i < pns.length; i++) {
if (i != 0) _d.append("/");
_d.append(pns[i]);
}
}
}
if (this.querySession != null)
_d.append(" query-sn=" + this.querySession);
}
}