/** Sets up the charset for the request and response based on
* {@link #getPreferredLocale(HttpSession,ServletRequest)}. After setting up, you shall invoke
* {@link #cleanup} before exiting.
*
* <pre><code> final Object old = setup(request, response, null);
* try {
* ....
* } finally {
* cleanup(request, old);
* }
*
* <p>It is OK to call this method multiple time, since it is smart
* enough to ignore redundant calls.
*
* <p>{@link CharsetFilter} actually use this method to setup
* the proper charset and locale. By mapping {@link CharsetFilter} to
* all servlets, the encoding charset could be prepared correctly.
* However, if you are writing libraries to be as independent of
* web.xml as possible, you might choose to invoke this method directly.
*
* @param sess the session to look for the preferred locale. Ignored if null.
* @param charset the response's charset. If null or empty,
* response.setCharacterEncoding won't be called, i.e., the container's
* default is used.
* @return an object that must be passed to {@link #cleanup}
*/
public static final Object setup(
HttpSession sess, ServletRequest request, ServletResponse response, String charset) {
if (hasSetup(request)) // processed before?
return Objects.UNKNOWN;
final Locale locale = getPreferredLocale(sess, request);
response.setLocale(locale);
if (charset != null && charset.length() > 0) {
try {
if (Servlets.isServlet24()) {
response.setCharacterEncoding(charset);
} else {
// don't access 2.4 API: setCharacterEncoding, getContentType
response.setContentType(";charset=" + charset);
}
} catch (Throwable ex) {
try {
final String v = response.getCharacterEncoding();
if (!Objects.equals(v, charset))
log.warn("Unable to set response's charset: " + charset + " (current=" + v + ')', ex);
} catch (Throwable t) { // just in case
}
}
}
if (request.getCharacterEncoding() == null) {
charset = response.getCharacterEncoding();
try {
request.setCharacterEncoding(charset);
} catch (Throwable ex) {
final String v = request.getCharacterEncoding();
if (!Objects.equals(v, charset))
log.warn(
"Unable to set request's charset: "
+ charset
+ " (current="
+ v
+ "): "
+ Exceptions.getMessage(ex));
}
}
markSetup(request, true);
return Locales.setThreadLocal(locale);
}
/**
* Process asynchronous update requests from the client.
*
* @since 3.0.0
*/
protected void process(Session sess, HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
final String errClient = request.getHeader("ZK-Error-Report");
if (errClient != null)
if (log.debugable())
log.debug("Error found at client: " + errClient + "\n" + Servlets.getDetail(request));
// parse desktop ID
final WebApp wapp = sess.getWebApp();
final WebAppCtrl wappc = (WebAppCtrl) wapp;
final AuDecoder audec = getAuDecoder(wapp);
final String dtid = audec.getDesktopId(request);
if (dtid == null) {
// Bug 1929139: incomplete request (IE only)
if (log.debugable()) {
final String msg = "Incomplete request\n" + Servlets.getDetail(request);
log.debug(msg);
}
response.sendError(467, "Incomplete request");
return;
}
Desktop desktop = getDesktop(sess, dtid);
if (desktop == null) {
final String cmdId = audec.getFirstCommand(request);
if (!"rmDesktop".equals(cmdId))
desktop = recoverDesktop(sess, request, response, wappc, dtid);
if (desktop == null) {
response.setIntHeader("ZK-Error", response.SC_GONE); // denote timeout
sessionTimeout(request, response, wapp, dtid);
return;
}
}
WebManager.setDesktop(request, desktop);
// reason: a new page might be created (such as include)
final String sid = request.getHeader("ZK-SID");
if (sid != null) // Some client might not have ZK-SID
response.setHeader("ZK-SID", sid);
// parse commands
final Configuration config = wapp.getConfiguration();
final List aureqs;
boolean keepAlive = false;
try {
final boolean timerKeepAlive = config.isTimerKeepAlive();
aureqs = audec.decode(request, desktop);
for (Iterator it = aureqs.iterator(); it.hasNext(); ) {
final String cmdId = ((AuRequest) it.next()).getCommand();
keepAlive = !(!timerKeepAlive && Events.ON_TIMER.equals(cmdId)) && !"dummy".equals(cmdId);
// dummy is used for PollingServerPush for piggyback
if (keepAlive) break; // done
}
} catch (Throwable ex) {
log.warningBriefly(ex);
responseError(request, response, Exceptions.getMessage(ex));
return;
}
if (aureqs.isEmpty()) {
final String errmsg = "Illegal request: cmd required";
log.debug(errmsg);
responseError(request, response, errmsg);
return;
}
((SessionCtrl) sess).notifyClientRequest(keepAlive);
// if (log.debugable()) log.debug("AU request: "+aureqs);
final DesktopCtrl desktopCtrl = (DesktopCtrl) desktop;
final Execution exec = new ExecutionImpl(getServletContext(), request, response, desktop, null);
if (sid != null) ((ExecutionCtrl) exec).setRequestId(sid);
final AuWriter out = AuWriters.newInstance();
out.setCompress(_compress);
out.open(
request,
response,
desktop.getDevice().isSupported(Device.RESEND)
? getProcessTimeout(config.getResendDelay())
: 0);
// Note: getResendDelay() might return nonpositive
try {
wappc.getUiEngine().execUpdate(exec, aureqs, out);
} catch (RequestOutOfSequenceException ex) {
log.warning(ex.getMessage());
response.setHeader("ZK-SID", sid);
response.setIntHeader("ZK-Error", AuResponse.SC_OUT_OF_SEQUENCE);
}
out.close(request, response);
}