Index: lams_common/src/java/org/lamsfoundation/lams/util/WebUtil.java =================================================================== diff -u -r05db875c7974d705f89231416ff6dfe91a5e70f1 -r0446a5dedf7a152649853da2454ad203ff6189e8 --- lams_common/src/java/org/lamsfoundation/lams/util/WebUtil.java (.../WebUtil.java) (revision 05db875c7974d705f89231416ff6dfe91a5e70f1) +++ lams_common/src/java/org/lamsfoundation/lams/util/WebUtil.java (.../WebUtil.java) (revision 0446a5dedf7a152649853da2454ad203ff6189e8) @@ -1,467 +1,482 @@ package org.lamsfoundation.lams.util; +import java.io.IOException; +import java.io.InputStream; +import java.net.HttpURLConnection; +import java.net.URL; +import java.net.URLConnection; import java.security.Principal; +import java.util.HashMap; +import java.util.Map.Entry; import javax.servlet.http.HttpServletRequest; import org.apache.commons.lang.StringUtils; import org.apache.log4j.Logger; import org.lamsfoundation.lams.learningdesign.TextSearchCondition; import org.lamsfoundation.lams.tool.ToolAccessMode; +import org.lamsfoundation.lams.tool.exception.ToolException; /** * helper methods useful for servlets */ -public class WebUtil -{ - +public class WebUtil { + //--------------------------------------------------------------------- // Class level constants - Session attributs //--------------------------------------------------------------------- - - private static Logger log = Logger.getLogger(WebUtil.class); + private static Logger log = Logger.getLogger(WebUtil.class); - /** - */ - public static boolean isTokenValid(HttpServletRequest req, String tokenName) - { - if (req.getSession() != null) - { - String valueSession = (String) req.getSession() - .getAttribute(tokenName); - String valueRequest = (String) req.getParameter(tokenName); - log.debug("(Session Token) name : " + tokenName + " value : " - + valueSession); - log.debug("(Request Token) name : " + tokenName + " value : " - + valueRequest); - if ((valueSession != null) && (valueRequest != null)) - { - if (valueSession.equals(valueRequest)) - { - return true; - } - } + /** + */ + public static boolean isTokenValid(HttpServletRequest req, String tokenName) { + if (req.getSession() != null) { + String valueSession = (String) req.getSession().getAttribute(tokenName); + String valueRequest = (String) req.getParameter(tokenName); + log.debug("(Session Token) name : " + tokenName + " value : " + valueSession); + log.debug("(Request Token) name : " + tokenName + " value : " + valueRequest); + if ((valueSession != null) && (valueRequest != null)) { + if (valueSession.equals(valueRequest)) { + return true; } - return false; + } } + return false; + } - /** - */ - public static void saveTaskURL(HttpServletRequest req, String[] urls) - { - if (urls != null) - { - if (urls.length == 1) - { - req.setAttribute("urlA", urls[0]); - } - else if (urls.length == 2) - { - req.setAttribute("urlA", urls[0]); - req.setAttribute("urlB", urls[1]); - } - } + /** + */ + public static void saveTaskURL(HttpServletRequest req, String[] urls) { + if (urls != null) { + if (urls.length == 1) { + req.setAttribute("urlA", urls[0]); + } else if (urls.length == 2) { + req.setAttribute("urlA", urls[0]); + req.setAttribute("urlB", urls[1]); + } } + } - /** - */ - public static void saveToken(HttpServletRequest req, - String tokenName, - String tokenValue) - { - if (req.getSession().getAttribute(tokenName) != null) - { - resetToken(req, tokenName); - } - req.getSession().setAttribute(tokenName, tokenValue); - log.debug("(Save Session Token) name : " + tokenName + " value : " - + tokenValue); - + /** + */ + public static void saveToken(HttpServletRequest req, String tokenName, String tokenValue) { + if (req.getSession().getAttribute(tokenName) != null) { + resetToken(req, tokenName); } + req.getSession().setAttribute(tokenName, tokenValue); + log.debug("(Save Session Token) name : " + tokenName + " value : " + tokenValue); - /** - */ - public static String retrieveToken(HttpServletRequest req, String tokenName) - { - return (String) req.getSession().getAttribute(tokenName); - } + } - /** - */ - public static void resetToken(HttpServletRequest req, String tokenName) - { - req.getSession().removeAttribute(tokenName); - } + /** + */ + public static String retrieveToken(HttpServletRequest req, String tokenName) { + return (String) req.getSession().getAttribute(tokenName); + } - /** - * @exception IllegalArgumentException - - * if not set - */ - public static void checkObject(String paramName, Object paramValue) throws IllegalArgumentException - { - boolean isNull = ( paramValue == null ); - if ( ! isNull && String.class.isInstance(paramValue) ) { - String str = (String) paramValue; - isNull = ( str.trim().length() == 0 ); - } - if ( isNull ) { - throw new IllegalArgumentException(paramName + " is required '" - + paramValue + "'"); - } + /** + */ + public static void resetToken(HttpServletRequest req, String tokenName) { + req.getSession().removeAttribute(tokenName); + } + + /** + * @exception IllegalArgumentException - + * if not set + */ + public static void checkObject(String paramName, Object paramValue) throws IllegalArgumentException { + boolean isNull = (paramValue == null); + if (!isNull && String.class.isInstance(paramValue)) { + String str = (String) paramValue; + isNull = (str.trim().length() == 0); } + if (isNull) { + throw new IllegalArgumentException(paramName + " is required '" + paramValue + "'"); + } + } - /** - * @return integer value of paramValue - * @exception IllegalArgumentException - - * if (a) not set and is not optional or (b) not integer - */ - public static Integer checkInteger(String paramName, String paramValue, boolean isOptional) throws IllegalArgumentException - { - try - { - if ( ! isOptional) - checkObject(paramName, paramValue); - String value = paramValue != null ? StringUtils.trimToNull(paramValue) : null; - return value != null ? new Integer(value) : null; - + /** + * @return integer value of paramValue + * @exception IllegalArgumentException - + * if (a) not set and is not optional or (b) not integer + */ + public static Integer checkInteger(String paramName, String paramValue, boolean isOptional) + throws IllegalArgumentException { + try { + if (!isOptional) + checkObject(paramName, paramValue); + String value = paramValue != null ? StringUtils.trimToNull(paramValue) : null; + return value != null ? new Integer(value) : null; - } - catch (NumberFormatException e) - { - throw new IllegalArgumentException(paramName - + " should be an integer '" + paramValue + "'"); - } + } catch (NumberFormatException e) { + throw new IllegalArgumentException(paramName + " should be an integer '" + paramValue + "'"); } + } - /** - * @return long value of paramValue - * @exception IllegalArgumentException - - * if (a) not set and is not optional or (b) not long - */ - public static Long checkLong(String paramName, String paramValue, boolean isOptional) throws IllegalArgumentException - { - try - { - if ( ! isOptional) - checkObject(paramName, paramValue); - String value = paramValue != null ? StringUtils.trimToNull(paramValue) : null; - return value != null ? new Long(value) : null; + /** + * @return long value of paramValue + * @exception IllegalArgumentException - + * if (a) not set and is not optional or (b) not long + */ + public static Long checkLong(String paramName, String paramValue, boolean isOptional) + throws IllegalArgumentException { + try { + if (!isOptional) + checkObject(paramName, paramValue); + String value = paramValue != null ? StringUtils.trimToNull(paramValue) : null; + return value != null ? new Long(value) : null; - } - catch (NumberFormatException e) - { - throw new IllegalArgumentException(paramName - + " should be a long '" + paramValue + "'"); - } + } catch (NumberFormatException e) { + throw new IllegalArgumentException(paramName + " should be a long '" + paramValue + "'"); } + } - /** - * Get a long version of paramValue, throwing an IllegalArgumentException - * if isOptional = false and the is value is null - * @return long value of paramValue - * @exception IllegalArgumentException - - * if not set or not long - */ - public static long checkLong(String paramName, Long paramValue, boolean isOptional) throws IllegalArgumentException - { - if ( ! isOptional) - checkObject(paramName, paramValue); - return paramValue.longValue(); - } + /** + * Get a long version of paramValue, throwing an IllegalArgumentException if + * isOptional = false and the is value is null + * + * @return long value of paramValue + * @exception IllegalArgumentException - + * if not set or not long + */ + public static long checkLong(String paramName, Long paramValue, boolean isOptional) throws IllegalArgumentException { + if (!isOptional) + checkObject(paramName, paramValue); + return paramValue.longValue(); + } - /** - * @return boolean value of paramValue - * @exception IllegalArgumentException - - * if not set or not boolean - */ - public static boolean checkBoolean(String paramName, String paramValue) throws IllegalArgumentException - { + /** + * @return boolean value of paramValue + * @exception IllegalArgumentException - + * if not set or not boolean + */ + public static boolean checkBoolean(String paramName, String paramValue) throws IllegalArgumentException { - checkObject(paramName, paramValue); - return Boolean.valueOf(paramValue.trim()).booleanValue(); - } + checkObject(paramName, paramValue); + return Boolean.valueOf(paramValue.trim()).booleanValue(); + } - /** - * Read an int parameter, throwing exception if null or not a integer - * @param req - - * @param paramName - - * @return parameter value - */ - public static int readIntParam(HttpServletRequest req, String paramName) - { - return checkInteger(paramName, req.getParameter(paramName),false).intValue(); - } + /** + * Read an int parameter, throwing exception if null or not a integer + * + * @param req - + * @param paramName - + * @return parameter value + */ + public static int readIntParam(HttpServletRequest req, String paramName) { + return checkInteger(paramName, req.getParameter(paramName), false).intValue(); + } - /** - * Read an int parameter, throwing exception if ( not optional and null ) or not a integer - * @param req - - * @param paramName - - * @param isOptional - * @return parameter value - */ - public static Integer readIntParam(HttpServletRequest req, String paramName, boolean isOptional) - { - return checkInteger(paramName, req.getParameter(paramName), isOptional); - } + /** + * Read an int parameter, throwing exception if ( not optional and null ) or + * not a integer + * + * @param req - + * @param paramName - + * @param isOptional + * @return parameter value + */ + public static Integer readIntParam(HttpServletRequest req, String paramName, boolean isOptional) { + return checkInteger(paramName, req.getParameter(paramName), isOptional); + } - /** - * Read an long parameter, throwing exception if null or not a long - * @param req - - * @param paramName - - * @return parameter value - */ - public static long readLongParam(HttpServletRequest req, String paramName) - { - return checkLong(paramName, req.getParameter(paramName), false).longValue(); - } + /** + * Read an long parameter, throwing exception if null or not a long + * + * @param req - + * @param paramName - + * @return parameter value + */ + public static long readLongParam(HttpServletRequest req, String paramName) { + return checkLong(paramName, req.getParameter(paramName), false).longValue(); + } - /** - * Read an long parameter, throwing exception if ( not optional and null ) or not a long - * @param req - - * @param paramName - - * @param isOptional - * @return parameter value - */ - public static Long readLongParam(HttpServletRequest req, String paramName, boolean isOptional) - { - return checkLong(paramName, req.getParameter(paramName), isOptional); - } + /** + * Read an long parameter, throwing exception if ( not optional and null ) + * or not a long + * + * @param req - + * @param paramName - + * @param isOptional + * @return parameter value + */ + public static Long readLongParam(HttpServletRequest req, String paramName, boolean isOptional) { + return checkLong(paramName, req.getParameter(paramName), isOptional); + } + /** + * @param req - + * @param paramName - + * @return parameter value + */ + public static String readStrParam(HttpServletRequest req, String paramName) { + return readStrParam(req, paramName, false); + } - /** - * @param req - - * @param paramName - - * @return parameter value - */ - public static String readStrParam(HttpServletRequest req, String paramName) - { - return readStrParam(req, paramName, false); - } + /** + * @param req - + * @param paramName - + * @param isOptional + * @return parameter value + */ + public static String readStrParam(HttpServletRequest req, String paramName, boolean isOptional) { + if (!isOptional) + checkObject(paramName, req.getParameter(paramName)); + return req.getParameter(paramName); + } - /** - * @param req - - * @param paramName - - * @param isOptional - * @return parameter value - */ - public static String readStrParam(HttpServletRequest req, String paramName, boolean isOptional) - { - if (!isOptional) - checkObject(paramName, req.getParameter(paramName)); - return req.getParameter(paramName); + /** + * @param req - + * @param paramName - + * @return parameter value + * @exception IllegalArgumentException - + * if valid boolean parameter value is not found + */ + public static boolean readBooleanParam(HttpServletRequest req, String paramName) throws IllegalArgumentException { + return checkBoolean(paramName, req.getParameter(paramName)); + } + + /** + * @param req - + * @param paramName - + * @param defaultValue - + * if valid boolean parameter value is not found, return this + * value + * @return parameter value + */ + public static boolean readBooleanParam(HttpServletRequest req, String paramName, boolean defaultValue) { + try { + return checkBoolean(paramName, req.getParameter(paramName)); + } catch (IllegalArgumentException e) { + return defaultValue; } + } + public static boolean readBooleanAttr(HttpServletRequest req, String attrName) { + return checkBoolean(attrName, (String) req.getSession().getAttribute(attrName)); + } - /** - * @param req - - * @param paramName - - * @return parameter value - * @exception IllegalArgumentException - - * if valid boolean parameter value is not found - */ - public static boolean readBooleanParam(HttpServletRequest req, - String paramName) throws IllegalArgumentException - { - return checkBoolean(paramName, req.getParameter(paramName)); - } + /** + * TODO default proper exception at lams level to replace RuntimeException + * TODO isTesting should be removed when login is done properly. + * + * @param req - + * @return username from principal object + */ + public static String getUsername(HttpServletRequest req, boolean isTesting) throws RuntimeException { + if (isTesting) + return "test"; - /** - * @param req - - * @param paramName - - * @param defaultValue - - * if valid boolean parameter value is not found, return this - * value - * @return parameter value - */ - public static boolean readBooleanParam(HttpServletRequest req, - String paramName, - boolean defaultValue) - { - try - { - return checkBoolean(paramName, req.getParameter(paramName)); - } - catch (IllegalArgumentException e) - { - return defaultValue; - } - } - - public static boolean readBooleanAttr(HttpServletRequest req, - String attrName) - { - return checkBoolean(attrName, (String)req.getSession().getAttribute(attrName)); - } + Principal prin = req.getUserPrincipal(); + if (prin == null) + throw new RuntimeException("Trying to get username but principal object missing. Request is " + + req.toString()); - /** - * TODO default proper exception at lams level to replace RuntimeException - * TODO isTesting should be removed when login is done properly. - * @param req - - * @return username from principal object - */ - public static String getUsername(HttpServletRequest req,boolean isTesting) throws RuntimeException - { - if(isTesting) - return "test"; - - Principal prin = req.getUserPrincipal(); - if (prin == null) - throw new RuntimeException("Trying to get username but principal object missing. Request is " - + req.toString()); + String username = prin.getName(); + if (username == null) + throw new RuntimeException("Name missing from principal object. Request is " + req.toString() + + " Principal object is " + prin.toString()); - String username = prin.getName(); - if (username == null) - throw new RuntimeException("Name missing from principal object. Request is " - + req.toString() - + " Principal object is " - + prin.toString()); + return username; + } - return username; - } - /** - * Retrieve the tool access mode from http request. This is a utility used by the tools that share an implementation for - * the learner screen. They use mode=learner, mode=author and mode=teacher for learning, preview and monitoring respectively. - * Only used if the tool programmer wants to have one call that supports all three ways of looking at a learner screen. - * + * Retrieve the tool access mode from http request. This is a utility used + * by the tools that share an implementation for the learner screen. They + * use mode=learner, mode=author and mode=teacher for learning, preview and + * monitoring respectively. Only used if the tool programmer wants to have + * one call that supports all three ways of looking at a learner screen. + * * @param request * @param param_mode * @return the ToolAccessMode object */ - public static ToolAccessMode readToolAccessModeParam(HttpServletRequest request, String param_mode,boolean optional) - { - String mode = readStrParam(request, param_mode,optional); - if (mode == null) { - return null; - } else if(mode.equals(ToolAccessMode.AUTHOR.toString())) - return ToolAccessMode.AUTHOR; - else if(mode.equals(ToolAccessMode.LEARNER.toString())) - return ToolAccessMode.LEARNER; - else if(mode.equals(ToolAccessMode.TEACHER.toString())) - return ToolAccessMode.TEACHER; - else - throw new IllegalArgumentException("["+mode+"] is not a legal mode" + - "in LAMS"); + public static ToolAccessMode readToolAccessModeParam(HttpServletRequest request, String param_mode, boolean optional) { + String mode = readStrParam(request, param_mode, optional); + if (mode == null) { + return null; + } else if (mode.equals(ToolAccessMode.AUTHOR.toString())) + return ToolAccessMode.AUTHOR; + else if (mode.equals(ToolAccessMode.LEARNER.toString())) + return ToolAccessMode.LEARNER; + else if (mode.equals(ToolAccessMode.TEACHER.toString())) + return ToolAccessMode.TEACHER; + else + throw new IllegalArgumentException("[" + mode + "] is not a legal mode" + "in LAMS"); } /** - * Retrieve the tool access mode from a string value, presumably from a Form. - * This is a utility used by the tools that share an implementation for the learner screen. - * They use mode=learner, mode=author and mode=teacher for learning, preview and monitoring respectively. - * Only used if the tool programmer wants to have one call that supports all three ways of looking at a learner screen. + * Retrieve the tool access mode from a string value, presumably from a + * Form. This is a utility used by the tools that share an implementation + * for the learner screen. They use mode=learner, mode=author and + * mode=teacher for learning, preview and monitoring respectively. Only used + * if the tool programmer wants to have one call that supports all three + * ways of looking at a learner screen. + * * @param request * @param param_mode * @return the ToolAccessMode object */ - public static ToolAccessMode getToolAccessMode(String modeValue) - { - if ( modeValue != null ) { - if(modeValue.equals(ToolAccessMode.AUTHOR.toString())) - return ToolAccessMode.AUTHOR; - else if(modeValue.equals(ToolAccessMode.LEARNER.toString())) - return ToolAccessMode.LEARNER; - else if(modeValue.equals(ToolAccessMode.TEACHER.toString())) - return ToolAccessMode.TEACHER; - } - throw new IllegalArgumentException("["+modeValue+"] is not a legal mode" + - "in LAMS"); + public static ToolAccessMode getToolAccessMode(String modeValue) { + if (modeValue != null) { + if (modeValue.equals(ToolAccessMode.AUTHOR.toString())) + return ToolAccessMode.AUTHOR; + else if (modeValue.equals(ToolAccessMode.LEARNER.toString())) + return ToolAccessMode.LEARNER; + else if (modeValue.equals(ToolAccessMode.TEACHER.toString())) + return ToolAccessMode.TEACHER; + } + throw new IllegalArgumentException("[" + modeValue + "] is not a legal mode" + "in LAMS"); } /** - *

This helper method create the struts action forward name using the path. - * It will chop all path related characters, such as "/" and ".do".

+ *

+ * This helper method create the struts action forward name using the path. + * It will chop all path related characters, such as "/" and ".do". + *

* - *

For example: - *

  • getStrutsForwardNameFromPath("/DisplayParallelActivity.do") + *

    + * For example: + *

  • getStrutsForwardNameFromPath("/DisplayParallelActivity.do") * = displayParallelActivity
    • *

    * * @param path * @return */ - public static String getStrutsForwardNameFromPath(String path) - { - String pathWithoutSlash = StringUtils.substringAfter(path,"/"); - String orginalForwardName = StringUtils.substringBeforeLast(pathWithoutSlash,".do"); - - return StringUtils.uncapitalize(orginalForwardName); - + public static String getStrutsForwardNameFromPath(String path) { + String pathWithoutSlash = StringUtils.substringAfter(path, "/"); + String orginalForwardName = StringUtils.substringBeforeLast(pathWithoutSlash, ".do"); + + return StringUtils.uncapitalize(orginalForwardName); + } /** * Append a parameter to a requested url. - * @param parameterName the name of the parameter - * @param parameterValue the value of the parameter - * @param learnerUrl the target url + * + * @param parameterName + * the name of the parameter + * @param parameterValue + * the value of the parameter + * @param learnerUrl + * the target url * @return the url with parameter appended. */ - public static String appendParameterToURL(String url, String parameterName, String parameterValue) - { - return appendParameterDeliminator(url) - + parameterName - + "=" - + parameterValue; + public static String appendParameterToURL(String url, String parameterName, String parameterValue) { + return appendParameterDeliminator(url) + parameterName + "=" + parameterValue; } - + /** - *

    This helper append the parameter deliminator for a url.

    - * It is using a null safe String util method to checkup the url String and + *

    + * This helper append the parameter deliminator for a url. + *

    + * It is using a null safe String util method to checkup the url String and * append proper deliminator if necessary. - * @param url the url needs to append deliminator. + * + * @param url + * the url needs to append deliminator. * @return target url with the deliminator; */ - public static String appendParameterDeliminator(String url) - { - if(url==null ) - return null; - else if(StringUtils.containsNone(url,"?")) - return url+"?"; - else - return url+"&"; + public static String appendParameterDeliminator(String url) { + if (url == null) + return null; + else if (StringUtils.containsNone(url, "?")) + return url + "?"; + else + return url + "&"; } - /** Converts a url (such as one from a tool) to a complete url. - * If the url starts with "http" then it is assumed to be a complete url - * and is returned as is. - * Otherwise it assumes starts with the path of the webapp so it is - * appended to the server url from the LAMS Configuration. - * @param url e.g. tool/lanb11/starter/learner.do + /** + * Converts a url (such as one from a tool) to a complete url. If the url + * starts with "http" then it is assumed to be a complete url and is + * returned as is. Otherwise it assumes starts with the path of the webapp + * so it is appended to the server url from the LAMS Configuration. + * + * @param url + * e.g. tool/lanb11/starter/learner.do * @return complete url */ public static String convertToFullURL(String url) { - if ( url == null ) - return null; - else if ( url.startsWith("http") ) - return url; - else { - String serverURL = Configuration.get(ConfigurationKeys.SERVER_URL); - if ( url.charAt(0) == '/' ) - return serverURL + url; - else - return serverURL + '/' + url; - } + if (url == null) + return null; + else if (url.startsWith("http")) + return url; + else { + String serverURL = Configuration.get(ConfigurationKeys.SERVER_URL); + if (url.charAt(0) == '/') + return serverURL + url; + else + return serverURL + '/' + url; + } } - - /** Convert any newslines in a string to
    . If input = null, returns null. */ + /** + * Convert any newslines in a string to
    . If input = null, returns + * null. + */ public static String convertNewlines(String input) { - if ( input != null ) - return input.replaceAll("[\n\r\f]", "
    "); - else - return null; + if (input != null) + return input.replaceAll("[\n\r\f]", "
    "); + else + return null; } /** - * Strips HTML tags and leave "pure" text. Useful for FCKeditor created text. + * Strips HTML tags and leave "pure" text. Useful for FCKeditor created + * text. * * @param text * string to process * @return string after stripping */ public static String removeHTMLtags(String text) { - return text == null ? null : text.replaceAll(TextSearchCondition.BR_TAG_REGEX, " ").replaceAll( - TextSearchCondition.HTML_TAG_REGEX, ""); + return text == null ? null : text.replaceAll(TextSearchCondition.BR_TAG_REGEX, " ").replaceAll( + TextSearchCondition.HTML_TAG_REGEX, ""); } + /** + * Makes a request to the specified url with the specified parameters and + * returns the response inputstream + * + * @param urlStr + * @param params + * @return + * @throws ToolException + * @throws IOException + */ + public static InputStream getResponseInputStreamFromExternalServer(String urlStr, HashMap params) + throws Exception { + if (!urlStr.endsWith("?")) + urlStr += "?"; + + for (Entry entry : params.entrySet()) { + urlStr += "&" + entry.getKey() + "=" + entry.getValue(); + } + + log.debug("Making request to external servlet: " + urlStr); + + URL url = new URL(urlStr); + URLConnection conn = url.openConnection(); + if (!(conn instanceof HttpURLConnection)) { + log.error("Fail to connect to external server though url: " + urlStr); + throw new Exception("Fail to connect to external server though url: " + urlStr); + } + + HttpURLConnection httpConn = (HttpURLConnection) conn; + if (httpConn.getResponseCode() != HttpURLConnection.HTTP_OK) { + log.error("Response code from external server: " + httpConn.getResponseCode() + + " Url: " + urlStr); + } + + InputStream is = url.openConnection().getInputStream(); + if (is == null) { + log.error("Fail to fetch data from external server, return InputStream null: " + urlStr); + throw new Exception("Fail to fetch data from external server, return inputStream null: " + urlStr); + } + + return is; + } + } \ No newline at end of file