org.zkoss.zk.ui.http.Utils Maven / Gradle / Ivy

Go to download
/* Utils.java

	Purpose:
		
	Description:
		
	History:
		Wed Jul  4 21:36:13     2007, Created by tomyeh

Copyright (C) 2007 Potix Corporation. All Rights Reserved.

{{IS_RIGHT
	This program is distributed under LGPL Version 2.1 in the hope that
	it will be useful, but WITHOUT ANY WARRANTY.
}}IS_RIGHT
*/
package org.zkoss.zk.ui.http;

import java.io.IOException;
import java.util.Calendar;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;

import jakarta.servlet.ServletContext;
import jakarta.servlet.ServletException;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import jakarta.servlet.http.HttpSession;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import org.zkoss.html.HTMLs;
import org.zkoss.lang.Exceptions;
import org.zkoss.lang.Library;
import org.zkoss.mesg.Messages;
import org.zkoss.web.Attributes;
import org.zkoss.web.servlet.Servlets;
import org.zkoss.web.util.resource.ClassWebResource;
import org.zkoss.web.util.resource.Extendlet;
import org.zkoss.xml.XMLs;
import org.zkoss.zk.mesg.MZk;
import org.zkoss.zk.ui.Component;
import org.zkoss.zk.ui.Desktop;
import org.zkoss.zk.ui.Execution;
import org.zkoss.zk.ui.Executions;
import org.zkoss.zk.ui.Page;
import org.zkoss.zk.ui.Session;
import org.zkoss.zk.ui.Sessions;
import org.zkoss.zk.ui.UiException;
import org.zkoss.zk.ui.WebApp;
import org.zkoss.zk.ui.ext.Includer;
import org.zkoss.zk.ui.sys.ExecutionCtrl;
import org.zkoss.zk.ui.sys.PageCtrl;

/**
 * A collection of utilities for this package.
 *
 * @author tomyeh
 * @since 2.4.1
 */
public class Utils {
	private static Logger log = LoggerFactory.getLogger(Utils.class);

	/** Update the status of debug-js.
	 * It is called by {@link org.zkoss.zk.ui.util.Configuration#setDebugJS}
	 * to change the loading of JavaScript files dynamically.
	 * @since 5.0.3
	 */
	public static void updateDebugJS(WebApp wapp, boolean debug) {
		final WebManager wm = WebManager.getWebManagerIfAny(wapp);
		if (wm != null) {
			final ClassWebResource cwr = wm.getClassWebResource();
			cwr.setDebugJS(debug);
			final Extendlet ext = cwr.getExtendlet("wpd");
			if (ext instanceof WpdExtendlet)
				((WpdExtendlet) ext).setDebugJS(debug);
		}
	}

	/** Returns the first day of the week, or -1 if no defined by the application.
	 * It is the same as getFirstDayOfWeek(Sessions.getCurrent()).
	 * @since 5.0.3
	 */
	public static final int getFirstDayOfWeek() {
		return getFirstDayOfWeek(Sessions.getCurrent());
	}

	/** Returns the first day of the week of the given session, or -1 if no defined by the application.
	 * It searches the following attributes and properties until found.
	 * Notice that it doesn't look for {@link java.util.Calendar#getFirstDayOfWeek}.
	 * 
	 * Session attribute: {@link Attributes#PREFERRED_FIRST_DAY_OF_WEEK}
	 * Application attribute: {@link Attributes#PREFERRED_FIRST_DAY_OF_WEEK}
	 * Library property: {@link Attributes#PREFERRED_FIRST_DAY_OF_WEEK}
	 * 
	 * @param sess the session to look at. Ignored if null.
	 * @since 5.0.3
	 */
	public static final int getFirstDayOfWeek(Session sess) {
		int firstDayOfWeek = -1;
		try {
			Object o = null;
			if (sess != null) {
				o = sess.getAttribute(Attributes.PREFERRED_FIRST_DAY_OF_WEEK);
				if (o == null) {
					final Object hsess = sess.getNativeSession();
					if (hsess instanceof HttpSession)
						o = ((HttpSession) hsess).getServletContext()
								.getAttribute(Attributes.PREFERRED_FIRST_DAY_OF_WEEK);
				}
			}
			if (o == null)
				o = Library.getProperty(Attributes.PREFERRED_FIRST_DAY_OF_WEEK);

			if (o instanceof Integer)
				firstDayOfWeek = ((Integer) o).intValue();
			else if (o instanceof String)
				firstDayOfWeek = Integer.parseInt((String) o);
		} catch (Throwable ex) { //ignore
		}
		if (firstDayOfWeek < Calendar.SUNDAY || firstDayOfWeek > Calendar.SATURDAY)
			firstDayOfWeek = -1;
		return firstDayOfWeek;
	}

	/**
	 * Returns the start year only for the format using "yy" pattern, change the parse result in the 100 years span after that year.
	 * 2DigitYearStart should not be negative.
	 * for example, start year 1950 will parse [0-49] : 2000-2049 and [50-99] : 1950-1999
	 * Default: 1929
	 * 
Library property: {@link Attributes#PREFERRED_2DIGITYEARSTART}
	 * @since 8.6.2
	 */
	public static final int get2DigitYearStart() throws NumberFormatException {
		String value = Library.getProperty(Attributes.PREFERRED_2DIGITYEARSTART, "1929");
		int yearStart = Integer.parseInt(value);
		if (yearStart < 0) {
			throw new IllegalArgumentException("Library property: 2DigitYearStart should not be negative");
		}
		return yearStart;
	}

	/** Handles exception being thrown when rendering a page.
	 * @param ex the exception being throw. If null, it means the page
	 * is not found.
	 */
	/*package*/ static void handleError(ServletContext ctx, HttpServletRequest request, HttpServletResponse response,
			String path, Throwable err) throws ServletException, IOException {
		if (Servlets.isIncluded(request)) {
			final String msg = err != null
					? Messages.get(MZk.PAGE_FAILED,
							new Object[] { path, Exceptions.getMessage(err),
									Exceptions.formatStackTrace(null, err, null, 6) })
					: Messages.get(MZk.PAGE_NOT_FOUND, new Object[] { path });

			final Map attrs = new HashMap();
			attrs.put(Attributes.ALERT_TYPE, "error");
			attrs.put(Attributes.ALERT, msg);
			Servlets.include(ctx, request, response, "~./html/alert.dsp", attrs, Servlets.PASS_THRU_ATTR);
		} else {
			//If not included, let the Web container handle it
			if (err != null) {
				if (err instanceof ServletException)
					throw (ServletException) err;
				else if (err instanceof IOException)
					throw (IOException) err;
				else
					throw UiException.Aide.wrap(err);
			}
			response.sendError(HttpServletResponse.SC_NOT_FOUND,
					HTMLs.encodeJavaScript(XMLs.escapeXML(path)));
		}
	}

	/** Resets the child page of the owner, if any.
	 */
	/*package*/ static void resetOwner() {
		final Execution exec = Executions.getCurrent();
		if (exec != null) {
			final Component comp = ((ExecutionCtrl) exec).getVisualizer().getOwner();
			if (comp instanceof Includer)
				((Includer) comp).setChildPage(null);
		}
	}

	/** Returns the main page of the desktop.
	 * It assumes there is at most one main page (that is, a page without owner)
	 */
	/*package*/ static Page getMainPage(Desktop desktop) {
		for (Iterator it = desktop.getPages().iterator(); it.hasNext();) {
			final Page page = (Page) it.next();
			if (((PageCtrl) page).getOwner() == null)
				return page;
		}
		return null;
	}

	/** Checks the update URI.
	 * @param updateURI the update URI to be checked.
	 * @param info the info to show if updateURI is incorrect.
	 * @return the update URI (by removing ending / if any)
	 * @exception ServletException if updateURI is incorrect.
	 * @since 5.0.5
	 */
	public static final String checkUpdateURI(String updateURI, String info) throws ServletException {
		if (updateURI == null || (updateURI = updateURI.trim()).length() == 0 || updateURI.charAt(0) != '/')
			throw new ServletException(info + " must be specified and starts with /");
		if (updateURI.indexOf(';') >= 0 || updateURI.indexOf('?') >= 0)
			throw new ServletException(info + " cannot contain ';' or '?'");
		//Jetty will encode URL by appending ';jsess..' and we have to
		//remove it under certain situations, so not allow it
		if (updateURI.charAt(updateURI.length() - 1) == '\\') {
			if (updateURI.length() == 1)
				throw new ServletException(info + " cannot contain only '/'");
			updateURI = updateURI.substring(0, updateURI.length() - 1);
			//remove the trailing '\\' if any
		}
		return updateURI;
	}

	/**
	 * obfuscate object with salt string
	 * @param obj target object
	 * @param salt string
	 * @return hex string
	 */
	/*package*/ static String obfuscateHashWithSalt(Object obj, String salt) {
		return Integer.toHexString(37 * obj.hashCode() + salt.hashCode());
	}
}