package er.ajax;
import java.util.Collection;
import org.jabsorb.JSONSerializer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.webobjects.appserver.WOApplication;
import com.webobjects.appserver.WOAssociation;
import com.webobjects.appserver.WOComponent;
import com.webobjects.appserver.WOContext;
import com.webobjects.appserver.WOMessage;
import com.webobjects.appserver.WORequest;
import com.webobjects.appserver.WOResponse;
import com.webobjects.foundation.NSArray;
import com.webobjects.foundation.NSDictionary;
import com.webobjects.foundation.NSMutableDictionary;
import er.extensions.appserver.ERXRedirect;
import er.extensions.appserver.ERXResourceManager;
import er.extensions.appserver.ERXResponseRewriter;
import er.extensions.appserver.ERXWOContext;
import er.extensions.appserver.ajax.ERXAjaxApplication;
import er.extensions.appserver.ajax.ERXAjaxSession;
import er.extensions.formatters.ERXNumberFormatter;
import er.extensions.formatters.ERXTimestampFormatter;
import er.extensions.foundation.ERXProperties;
import er.extensions.foundation.ERXStringUtilities;
/**
*
* @property er.ajax.compressed
* @property er.extensions.ERXResponseRewriter.javascriptTypeAttribute
*/
public class AjaxUtils {
private final static Logger log = LoggerFactory.getLogger(AjaxUtils.class);
private static final String SECURE_RESOURCES_KEY = "er.ajax.secureResources";
/**
* If the value is null, this returns "null", otherwise it returns '[value]'.
* @param value the value to quote
* @return the quoted value or "null"
*/
public static String quote(String value) {
return value == null ? "null" : "'" + value.replaceAll("'", "\\\\'") + "'";
}
/**
* Return whether or not the given request is an Ajax request.
*
* @param request the request the check
*
* @return if it an Ajax request the <code>true</code>
*/
public static boolean isAjaxRequest(WORequest request) {
return ERXAjaxApplication.isAjaxRequest(request);
}
public static void setPageReplacementCacheKey(WOContext _context, String _key) {
_context.request().setHeader(_key, ERXAjaxSession.PAGE_REPLACEMENT_CACHE_LOOKUP_KEY);
}
/**
* Creates a response for the given context (which can be null), sets the charset to UTF-8, the connection to
* keep-alive and flags it as a Ajax request by adding an AJAX_REQUEST_KEY header. You can check this header in the
* session to decide if you want to save the request or not.
*
* @param request the current request
* @param context the current context
* @return a new Ajax response
*/
public static AjaxResponse createResponse(WORequest request, WOContext context) {
AjaxResponse response = null;
if (context != null && context.response() != null) {
WOResponse existingResponse = context.response();
if (existingResponse instanceof AjaxResponse) {
response = (AjaxResponse) existingResponse;
}
else {
response = new AjaxResponse(request, context);
response.setHeaders(existingResponse.headers());
response.setUserInfo(existingResponse.userInfo());
response.appendContentString(existingResponse.contentString());
}
}
if (response == null) {
response = new AjaxResponse(request, context);
response.setHeader("text/plain; charset=utf-8", "content-type");
}
if (context != null) {
context._setResponse(response);
}
// Encode using UTF-8, although We are actually ASCII clean as all
// unicode data is JSON escaped using backslash u. This is less data
// efficient for foreign character sets but it is needed to support
// naughty browsers such as Konqueror and Safari which do not honour the
// charset set in the response
response.setHeader("Connection", "keep-alive");
response.setHeader(ERXAjaxSession.DONT_STORE_PAGE, ERXAjaxSession.DONT_STORE_PAGE);
return response;
}
/**
* Adds a script tag with a correct resource URL in the HTML head tag if it isn't already present in the response.
*
* @param context
* the context
* @param response
* the response to write into
* @param framework
* the framework that contains the file
* @param fileName
* the name of the javascript file to add
*/
public static void addScriptResourceInHead(WOContext context, WOResponse response, String framework, String fileName) {
String processedFileName = fileName;
// PROTOTYPE MISC
if (ERXProperties.booleanForKey("er.ajax.compressed") && ("prototype.js".equals(fileName) || "scriptaculous.js".equals(fileName))) {
processedFileName = "sc-17-proto-15-compressed.js";
}
ERXResponseRewriter.addScriptResourceInHead(response, context, framework, processedFileName);
}
/**
* Calls {@link #addScriptResourceInHead(WOContext, WOResponse, String, String)} with "Ajax" as framework.
*
* @param context
* the context
* @param response
* the response to write into
* @param fileName
* the name of the javascript file to add
*/
public static void addScriptResourceInHead(WOContext context, WOResponse response, String fileName) {
AjaxUtils.addScriptResourceInHead(context, response, "Ajax", fileName);
}
/**
* Calls {@link er.extensions.appserver.ERXResponseRewriter#addStylesheetResourceInHead(WOResponse, WOContext, String, String)}
*
* @param context
* the context
* @param response
* the response to write into
* @param framework
* the framework that contains the file
* @param fileName
* the name of the CSS file to add
*/
public static void addStylesheetResourceInHead(WOContext context, WOResponse response, String framework, String fileName) {
ERXResponseRewriter.addStylesheetResourceInHead(response, context, framework, fileName);
}
/**
* Calls {@link #addStylesheetResourceInHead(WOContext, WOResponse, String, String)} with "Ajax" as framework.
*
* @param context
* the context
* @param response
* the response to write into
* @param fileName
* the name of the CSS file to add
*/
public static void addStylesheetResourceInHead(WOContext context, WOResponse response, String fileName) {
AjaxUtils.addStylesheetResourceInHead(context, response, "Ajax", fileName);
}
/**
* Calls {@link er.extensions.appserver.ERXResponseRewriter#addScriptCodeInHead(WOResponse, WOContext, String)}.
*
* @param response
* the response to write into
* @param context
* the context
* @param script
* the javascript code to insert
*/
public static void addScriptCodeInHead(WOResponse response, WOContext context, String script) {
ERXResponseRewriter.addScriptCodeInHead(response, context, script);
}
public static boolean shouldHandleRequest(WORequest request, WOContext context, String containerID) {
String elementID = context.elementID();
String senderID = context.senderID();
String updateContainerID = null;
if (containerID != null) {
if (AjaxResponse.isAjaxUpdatePass(request)) {
updateContainerID = AjaxUpdateContainer.updateContainerID(request);
}
}
boolean shouldHandleRequest = elementID != null && (elementID.equals(senderID) || (containerID != null && containerID.equals(updateContainerID)) || elementID.equals(ERXAjaxApplication.ajaxSubmitButtonName(request)));
return shouldHandleRequest;
}
/**
* Returns an {@link er.ajax.AjaxResponse} with the given javascript as the body of the response.
*
* @param context the context
* @param javascript the javascript to send
* @return a new response
*/
public static WOResponse javascriptResponse(String javascript, WOContext context) {
WORequest request = context.request();
AjaxResponse response = AjaxUtils.createResponse(request, context);
AjaxUtils.appendScriptHeaderIfNecessary(request, response);
response.appendContentString(javascript);
AjaxUtils.appendScriptFooterIfNecessary(request, response);
return response;
}
/**
* Shortcut for appendScript.
*
* @param context the context
* @param script the script to append
*/
public static void appendScript(WOContext context, String script) {
AjaxUtils.appendScript(context.request(), context.response(), script);
}
/**
* Appends the given javascript to the response, surrounding it in a script header/footer if necessary.
*
* @param request the request
* @param response the response
* @param script the script to append
*/
public static void appendScript(WORequest request, WOResponse response, String script) {
AjaxUtils.appendScriptHeaderIfNecessary(request, response);
response.appendContentString(script);
AjaxUtils.appendScriptFooterIfNecessary(request, response);
}
public static void appendScriptHeaderIfNecessary(WORequest request, WOResponse response) {
if (AjaxUpdateContainer.hasUpdateContainerID(request)) {
AjaxUtils.appendScriptHeader(response);
}
else {
response.setHeader("text/javascript", "Content-Type");
}
}
public static void appendScriptHeader(WOResponse response) {
ERXResponseRewriter.appendScriptTagOpener(response);
}
public static void appendScriptFooterIfNecessary(WORequest request, WOResponse response) {
if (AjaxUpdateContainer.hasUpdateContainerID(request)) {
AjaxUtils.appendScriptFooter(response);
}
}
public static void appendScriptFooter(WOResponse response) {
ERXResponseRewriter.appendScriptTagCloser(response);
}
/**
* Returns the array bound to the given association.
*
* @param <T> the array type
* @param component the component to resolve against
* @param association the association to retrieve a value for
* @return an array (or null)
*/
public static <T> NSArray<T> arrayValueForAssociation(WOComponent component, WOAssociation association) {
NSArray<T> array = null;
if (association != null) {
array = AjaxUtils.arrayValueForObject(association.valueInComponent(component));
}
return array;
}
/**
* Returns the array bound to the given binding name.
*
* @param <T> the array type
* @param component the component to resolve against
* @param bindingName the name of the binding
* @return an array (or null)
*/
public static <T> NSArray<T> arrayValueForBinding(WOComponent component, String bindingName) {
return AjaxUtils.arrayValueForObject(component.valueForBinding(bindingName));
}
/**
* Returns the array for the given object. If the object is a string, it will be parsed as a
* JSON value.
*
* @param <T> the array type
* @param value the object value
* @return an array (or null)
*/
@SuppressWarnings("unchecked")
public static <T> NSArray<T> arrayValueForObject(Object value) {
NSArray arrayValue;
if (value == null) {
arrayValue = null;
}
else if (value instanceof NSArray) {
arrayValue = (NSArray<T>) value;
}
else if (value instanceof String) {
try {
String strValue = ((String) value).trim();
if (!strValue.startsWith("[")) {
strValue = "[" + strValue + "]";
}
JSONSerializer serializer = new JSONSerializer();
serializer.registerDefaultSerializers();
Object objValue = serializer.fromJSON(strValue);
if (objValue.getClass().isArray()) {
arrayValue = new NSArray((Object[]) objValue);
}
else if (objValue instanceof Collection) {
arrayValue = new NSArray((Collection) objValue);
}
else {
arrayValue = new NSArray(objValue);
}
}
catch (Throwable e) {
throw new IllegalArgumentException("Failed to convert String to array.", e);
}
}
else {
throw new IllegalArgumentException("Unable to convert '" + value + "' to an array.");
}
return arrayValue;
}
/**
* Returns an Ajax component action url. Using an ajax component action urls guarantees that caching during your
* ajax request will be handled appropriately.
*
* @param context
* the context of the request
* @return an ajax request url.
*/
public static String ajaxComponentActionUrl(WOContext context) {
String actionUrl = context.componentActionURL();
if (AjaxRequestHandler.useAjaxRequestHandler()) {
actionUrl = actionUrl.replaceFirst("/" + WOApplication.application().componentRequestHandlerKey() + "/", "/" + AjaxRequestHandler.AjaxRequestHandlerKey + "/");
}
return actionUrl;
}
public static void appendTagAttributeAndValue(WOResponse response, WOContext context, WOComponent component, NSDictionary<String, WOAssociation> associations, String name) {
AjaxUtils.appendTagAttributeAndValue(response, context, component, associations, name, null);
}
public static void appendTagAttributeAndValue(WOResponse response, WOContext context, WOComponent component, NSDictionary<String, WOAssociation> associations, String name, String appendValue) {
AjaxUtils.appendTagAttributeAndValue(response, context, component, name, associations.objectForKey(name), appendValue);
}
public static void appendTagAttributeAndValue(WOResponse response, WOContext context, WOComponent component, String name, WOAssociation association) {
AjaxUtils.appendTagAttributeAndValue(response, context, component, name, association, null);
}
public static void appendTagAttributeAndValue(WOResponse response, WOContext context, WOComponent component, String name, WOAssociation association, String appendValue) {
if (association != null || appendValue != null) {
String value = null;
if (association != null) {
value = (String) association.valueInComponent(component);
}
if (value == null || value.length() == 0) {
value = appendValue;
}
else if (appendValue != null && appendValue.length() > 0) {
if (!value.endsWith(";")) {
value += ";";
}
value += appendValue;
}
if (value != null) {
response._appendTagAttributeAndValue(name, value, true);
}
}
}
/**
* Creates (or modifies if already created) an AjaxResponse to redirect to the passed component with a component action.
* Anything previously written to the AjaxResponse is preserved.
*
* @param component full page WOComponent instance to redirect to
*/
public static void redirectTo(WOComponent component) {
WOContext context = component.context();
ERXRedirect redirect = (ERXRedirect)component.pageWithName(ERXRedirect.class.getName());
redirect.setComponent(component);
redirect.appendToResponse(AjaxUtils.createResponse(context.request(), context), context);
}
/**
* <code>updateDomElement</code> appends JavaScript code to the given
* AjaxResponse that updates the content of the DOM Element with the given
* ID to the specified value. Useful if you want to update multiple small
* regions on a page with a single request, e.g. when an AjaxObserveField
* triggers an action.
* <p>
* This method is also available on instances. The example
* below uses the method on AjaxResponse.
*
* <code><pre>
* public WOActionResults cartItemChanged() {
* ShoppingCart cart; // assume this exists
* ShoppingCartItem item; // assume this exists
* AjaxResponse response = AjaxUtils.createResponse(context().request(), context());
* response.appendScriptHeaderIfNecessary();
* response.updateDomElement("orderAmount_" + item.primaryKey(), item.orderAmount(), "#,##0.", null, null);
* response.updateDomElement("price_" + item.primaryKey(), item.priceForOrderAmount(), "#,##0.00", null, null);
* response.updateDomElement("shoppingCartPrice", cart.totalPrice(), "#,##0.00", null, null);
* response.appendScriptFooterIfNecessary();
* return response;
* }
* </code></pre>
*
* @see AjaxResponse#updateDomElement(String, Object, String, String, String)
* @see AjaxResponse#updateDomElement(String, Object)
*
* @param response
* The response to append the JavaScript to
* @param id
* ID of the DOM element to update
* @param value
* The new value
* @param numberFormat
* optional number format to format the value with
* @param dateFormat
* optional date format to format the value with
* @param valueWhenEmpty
* string to use when value is null
*/
public static void updateDomElement(WOResponse response, String id, Object value, String numberFormat, String dateFormat, String valueWhenEmpty) {
if (numberFormat != null && dateFormat != null)
throw new IllegalArgumentException("You can only specify a numberFormat or a dateFormat, not both.");
if (value == null && valueWhenEmpty != null) {
value = valueWhenEmpty;
}
else {
try {
if (numberFormat != null) {
value = ERXNumberFormatter.numberFormatterForPattern(numberFormat).format(value);
}
if (dateFormat != null) {
value = ERXTimestampFormatter.dateFormatterForPattern(dateFormat).format(value);
}
}
catch (Exception e) {
log.error("Could not parse value '{}'", value, e);
value = null;
}
}
response.appendContentString("Element.update('" + id + "'," + AjaxValue.javaScriptEscaped(value) + ");");
}
}