| /******************************************************************************* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| *******************************************************************************/ |
| package org.ofbiz.common; |
| |
| import java.awt.Color; |
| import java.awt.Font; |
| import java.awt.FontMetrics; |
| import java.awt.Graphics2D; |
| import java.awt.geom.AffineTransform; |
| import java.awt.image.BufferedImage; |
| import java.io.IOException; |
| import java.io.PrintWriter; |
| import java.io.UnsupportedEncodingException; |
| import java.io.Writer; |
| import java.util.HashMap; |
| import java.util.Iterator; |
| import java.util.List; |
| import java.util.Locale; |
| import java.util.Map; |
| import java.util.Set; |
| |
| import javax.imageio.ImageIO; |
| import javax.servlet.http.HttpServletRequest; |
| import javax.servlet.http.HttpServletResponse; |
| import javax.servlet.http.HttpSession; |
| |
| import javolution.util.FastMap; |
| import net.sf.json.JSON; |
| import net.sf.json.JSONArray; |
| import net.sf.json.JSONObject; |
| import net.sf.json.JSONSerializer; |
| |
| import org.apache.commons.lang.RandomStringUtils; |
| import org.apache.commons.lang.StringUtils; |
| import org.ofbiz.base.util.Debug; |
| import org.ofbiz.base.util.StringUtil; |
| import org.ofbiz.base.util.UtilGenerics; |
| import org.ofbiz.base.util.UtilHttp; |
| import org.ofbiz.base.util.UtilMisc; |
| import org.ofbiz.base.util.UtilProperties; |
| import org.ofbiz.base.util.UtilValidate; |
| import org.ofbiz.base.util.cache.UtilCache; |
| import org.ofbiz.entity.Delegator; |
| import org.ofbiz.entity.GenericEntityException; |
| import org.ofbiz.entity.GenericValue; |
| import org.ofbiz.security.Security; |
| |
| /** |
| * Common Services |
| */ |
| public class CommonEvents { |
| |
| public static final String module = CommonEvents.class.getName(); |
| |
| static final String[] ignoreAttrs = new String[] { // Removed for security reason; _ERROR_MESSAGE_ is kept |
| "javax.servlet.request.key_size", |
| "_CONTEXT_ROOT_", |
| "_FORWARDED_FROM_SERVLET_", |
| "javax.servlet.request.ssl_session", |
| "javax.servlet.request.ssl_session_id", |
| "multiPartMap", |
| "javax.servlet.request.cipher_suite", |
| "targetRequestUri", |
| "_SERVER_ROOT_URL_", |
| "_CONTROL_PATH_", |
| "thisRequestUri" |
| }; |
| |
| private static final UtilCache<String, Map<String, String>> appletSessions = UtilCache.createUtilCache("AppletSessions", 0, 600000, true); |
| |
| public static String checkAppletRequest(HttpServletRequest request, HttpServletResponse response) { |
| Delegator delegator = (Delegator) request.getAttribute("delegator"); |
| String sessionId = request.getParameter("sessionId"); |
| String visitId = request.getParameter("visitId"); |
| sessionId = sessionId.trim(); |
| visitId = visitId.trim(); |
| |
| String responseString = ""; |
| |
| GenericValue visit = null; |
| try { |
| visit = delegator.findOne("Visit", false, "visitId", visitId); |
| } catch (GenericEntityException e) { |
| Debug.logError(e, "Cannot Visit Object", module); |
| } |
| |
| if (visit != null && visit.getString("sessionId").equals(sessionId) && appletSessions.containsKey(sessionId)) { |
| Map<String, String> sessionMap = appletSessions.get(sessionId); |
| if (sessionMap != null && sessionMap.containsKey("followPage")) |
| responseString = sessionMap.remove("followPage"); |
| } |
| |
| try { |
| PrintWriter out = response.getWriter(); |
| response.setContentType("text/plain"); |
| out.println(responseString); |
| out.close(); |
| } catch (IOException e) { |
| Debug.logError(e, "Problems writing servlet output!", module); |
| } |
| |
| return "success"; |
| } |
| |
| public static String receiveAppletRequest(HttpServletRequest request, HttpServletResponse response) { |
| Delegator delegator = (Delegator) request.getAttribute("delegator"); |
| String sessionId = request.getParameter("sessionId"); |
| String visitId = request.getParameter("visitId"); |
| sessionId = sessionId.trim(); |
| visitId = visitId.trim(); |
| |
| String responseString = "ERROR"; |
| |
| GenericValue visit = null; |
| try { |
| visit = delegator.findOne("Visit", false, "visitId", visitId); |
| } catch (GenericEntityException e) { |
| Debug.logError(e, "Cannot Visit Object", module); |
| } |
| |
| if (visit.getString("sessionId").equals(sessionId)) { |
| String currentPage = request.getParameter("currentPage"); |
| Map<String, String> sessionMap = appletSessions.get(sessionId); |
| if (sessionMap != null) { |
| String followers = sessionMap.get("followers"); |
| List<String> folList = StringUtil.split(followers, ","); |
| for (String follower: folList) { |
| Map<String, String> folSesMap = UtilMisc.toMap("followPage", currentPage); |
| appletSessions.put(follower, folSesMap); |
| } |
| } |
| responseString = "OK"; |
| } |
| |
| try { |
| PrintWriter out = response.getWriter(); |
| response.setContentType("text/plain"); |
| out.println(responseString); |
| out.close(); |
| } catch (IOException e) { |
| Debug.logError(e, "Problems writing servlet output!", module); |
| } |
| |
| return "success"; |
| } |
| |
| public static String setAppletFollower(HttpServletRequest request, HttpServletResponse response) { |
| Security security = (Security) request.getAttribute("security"); |
| GenericValue userLogin = (GenericValue) request.getSession().getAttribute("userLogin"); |
| String visitId = request.getParameter("visitId"); |
| if (visitId != null) request.setAttribute("visitId", visitId); |
| if (security.hasPermission("SEND_CONTROL_APPLET", userLogin)) { |
| String followerSessionId = request.getParameter("followerSid"); |
| String followSessionId = request.getParameter("followSid"); |
| Map<String, String> follow = appletSessions.get(followSessionId); |
| if (follow == null) follow = FastMap.newInstance(); |
| String followerListStr = follow.get("followers"); |
| if (followerListStr == null) { |
| followerListStr = followerSessionId; |
| } else { |
| followerListStr = followerListStr + "," + followerSessionId; |
| } |
| appletSessions.put(followSessionId, follow); |
| appletSessions.put(followerSessionId, null); |
| } |
| return "success"; |
| } |
| |
| public static String setFollowerPage(HttpServletRequest request, HttpServletResponse response) { |
| Security security = (Security) request.getAttribute("security"); |
| GenericValue userLogin = (GenericValue) request.getSession().getAttribute("userLogin"); |
| String visitId = request.getParameter("visitId"); |
| if (visitId != null) request.setAttribute("visitId", visitId); |
| if (security.hasPermission("SEND_CONTROL_APPLET", userLogin)) { |
| String followerSessionId = request.getParameter("followerSid"); |
| String pageUrl = request.getParameter("pageUrl"); |
| Map<String, String> follow = appletSessions.get(followerSessionId); |
| if (follow == null) follow = FastMap.newInstance(); |
| follow.put("followPage", pageUrl); |
| appletSessions.put(followerSessionId, follow); |
| } |
| return "success"; |
| } |
| |
| /** Simple event to set the users per-session locale setting. The user's locale |
| * setting should be passed as a "newLocale" request parameter. */ |
| public static String setSessionLocale(HttpServletRequest request, HttpServletResponse response) { |
| String localeString = request.getParameter("newLocale"); |
| if (UtilValidate.isNotEmpty(localeString)) { |
| UtilHttp.setLocale(request, localeString); |
| |
| // update the UserLogin object |
| GenericValue userLogin = (GenericValue) request.getSession().getAttribute("userLogin"); |
| if (userLogin == null) { |
| userLogin = (GenericValue) request.getSession().getAttribute("autoUserLogin"); |
| } |
| |
| if (userLogin != null) { |
| GenericValue ulUpdate = GenericValue.create(userLogin); |
| ulUpdate.set("lastLocale", localeString); |
| try { |
| ulUpdate.store(); |
| userLogin.refreshFromCache(); |
| } catch (GenericEntityException e) { |
| Debug.logWarning(e, module); |
| } |
| } |
| } |
| return "success"; |
| } |
| |
| /** Simple event to set the user's per-session time zone setting. */ |
| public static String setSessionTimeZone(HttpServletRequest request, HttpServletResponse response) { |
| String tzString = request.getParameter("tzId"); |
| if (UtilValidate.isNotEmpty(tzString)) { |
| UtilHttp.setTimeZone(request, tzString); |
| |
| // update the UserLogin object |
| GenericValue userLogin = (GenericValue) request.getSession().getAttribute("userLogin"); |
| if (userLogin == null) { |
| userLogin = (GenericValue) request.getSession().getAttribute("autoUserLogin"); |
| } |
| |
| if (userLogin != null) { |
| GenericValue ulUpdate = GenericValue.create(userLogin); |
| ulUpdate.set("lastTimeZone", tzString); |
| try { |
| ulUpdate.store(); |
| userLogin.refreshFromCache(); |
| } catch (GenericEntityException e) { |
| Debug.logWarning(e, module); |
| } |
| } |
| } |
| return "success"; |
| } |
| |
| /** Simple event to set the users per-session currency uom value */ |
| public static String setSessionCurrencyUom(HttpServletRequest request, HttpServletResponse response) { |
| String currencyUom = request.getParameter("currencyUom"); |
| if (UtilValidate.isNotEmpty(currencyUom)) { |
| // update the session |
| UtilHttp.setCurrencyUom(request.getSession(), currencyUom); |
| |
| // update the UserLogin object |
| GenericValue userLogin = (GenericValue) request.getSession().getAttribute("userLogin"); |
| if (userLogin == null) { |
| userLogin = (GenericValue) request.getSession().getAttribute("autoUserLogin"); |
| } |
| |
| if (userLogin != null) { |
| GenericValue ulUpdate = GenericValue.create(userLogin); |
| ulUpdate.set("lastCurrencyUom", currencyUom); |
| try { |
| ulUpdate.store(); |
| userLogin.refreshFromCache(); |
| } catch (GenericEntityException e) { |
| Debug.logWarning(e, module); |
| } |
| } |
| } |
| return "success"; |
| } |
| |
| public static String jsonResponseFromRequestAttributes(HttpServletRequest request, HttpServletResponse response) { |
| // pull out the service response from the request attribute |
| |
| Map<String, Object> attrMap = UtilHttp.getJSONAttributeMap(request); |
| |
| for (String ignoreAttr : ignoreAttrs) { |
| if (attrMap.containsKey(ignoreAttr)) { |
| attrMap.remove(ignoreAttr); |
| } |
| } |
| |
| // create a JSON Object for return |
| JSONObject json = JSONObject.fromObject(attrMap); |
| writeJSONtoResponse(json, request.getMethod(), response); |
| |
| return "success"; |
| } |
| |
| private static void writeJSONtoResponse(JSON json, String httpMethod, HttpServletResponse response) { |
| String jsonStr = json.toString(); |
| if (jsonStr == null) { |
| Debug.logError("JSON Object was empty; fatal error!", module); |
| return; |
| } |
| |
| // This was added for security reason (OFBIZ-5409), you might need to remove the "//" prefix when handling the JSON response |
| // Though normally you simply have to access the data you want, so should not be annoyed by the "//" prefix |
| if ("GET".equalsIgnoreCase(httpMethod)) { |
| Debug.logWarning("for security reason (OFBIZ-5409) the the '//' prefix was added handling the JSON response. " + |
| "Normally you simply have to access the data you want, so should not be annoyed by the '//' prefix." + |
| "You might need to remove it if you use Ajax GET responses (not recommended)." + |
| "In case, the util.js scrpt is there to help you", module); |
| jsonStr = "//" + jsonStr; |
| } |
| |
| // set the X-JSON content type |
| response.setContentType("application/x-json"); |
| // jsonStr.length is not reliable for unicode characters |
| try { |
| response.setContentLength(jsonStr.getBytes("UTF8").length); |
| } catch (UnsupportedEncodingException e) { |
| Debug.logError("Problems with Json encoding: " + e, module); |
| } |
| |
| // return the JSON String |
| Writer out; |
| try { |
| out = response.getWriter(); |
| out.write(jsonStr); |
| out.flush(); |
| } catch (IOException e) { |
| Debug.logError(e, module); |
| } |
| } |
| |
| |
| public static String getJSONuiLabelArray(HttpServletRequest request, HttpServletResponse response) { |
| String requiredLabels = request.getParameter("requiredLabels"); |
| |
| JSONObject uiLabelObject = null; |
| if (UtilValidate.isNotEmpty(requiredLabels)) { |
| // Transform JSON String to Object |
| uiLabelObject = (JSONObject) JSONSerializer.toJSON(requiredLabels); |
| } |
| |
| JSONObject jsonUiLabel = new JSONObject(); |
| Locale locale = UtilHttp.getLocale(request); |
| if(!uiLabelObject.isEmpty()) { |
| Set<String> resourceSet = UtilGenerics.checkSet(uiLabelObject.keySet()); |
| // Iterate over the resouce set |
| for (String resource : resourceSet) { |
| JSONArray labels = uiLabelObject.getJSONArray(resource); |
| if (labels.isEmpty() || labels == null) { |
| continue; |
| } |
| |
| // Iterate over the uiLabel List |
| Iterator<String> jsonLabelIterator = UtilGenerics.cast(labels.iterator()); |
| JSONArray resourceLabelList = new JSONArray(); |
| while(jsonLabelIterator.hasNext()) { |
| String label = jsonLabelIterator.next(); |
| String receivedLabel = UtilProperties.getMessage(resource, label, locale); |
| if (UtilValidate.isNotEmpty(receivedLabel)) { |
| resourceLabelList.add(receivedLabel); |
| } |
| } |
| jsonUiLabel.element(resource, resourceLabelList); |
| } |
| } |
| |
| writeJSONtoResponse(jsonUiLabel, request.getMethod(), response); |
| return "success"; |
| } |
| |
| public static String getJSONuiLabel(HttpServletRequest request, HttpServletResponse response) { |
| String requiredLabels = request.getParameter("requiredLabel"); |
| |
| JSONObject uiLabelObject = null; |
| if (UtilValidate.isNotEmpty(requiredLabels)) { |
| // Transform JSON String to Object |
| uiLabelObject = (JSONObject) JSONSerializer.toJSON(requiredLabels); |
| } |
| |
| JSONArray jsonUiLabel = new JSONArray(); |
| Locale locale = UtilHttp.getLocale(request); |
| if(!uiLabelObject.isEmpty()) { |
| Set<String> resourceSet = UtilGenerics.checkSet(uiLabelObject.keySet()); |
| // Iterate over the resource set |
| // here we need a keySet because we don't now which label resource to load |
| // the key set should have the size one, if greater or empty error should returned |
| if (UtilValidate.isEmpty(resourceSet)) { |
| Debug.logError("No resource and labels found", module); |
| return "error"; |
| } else if (resourceSet.size() > 1) { |
| Debug.logError("More than one resource found, please use the method: getJSONuiLabelArray", module); |
| return "error"; |
| } |
| |
| for (String resource : resourceSet) { |
| String label = uiLabelObject.getString(resource); |
| if (UtilValidate.isEmail(label)) { |
| continue; |
| } |
| |
| String receivedLabel = UtilProperties.getMessage(resource, label, locale); |
| jsonUiLabel.add(receivedLabel); |
| } |
| } |
| |
| writeJSONtoResponse(jsonUiLabel, request.getMethod(), response); |
| return "success"; |
| } |
| |
| public static String getCaptcha(HttpServletRequest request, HttpServletResponse response) { |
| try { |
| final String captchaSizeConfigName = StringUtils.defaultIfEmpty(request.getParameter("captchaSize"), "default"); |
| final String captchaSizeConfig = UtilProperties.getPropertyValue("captcha.properties", "captcha." + captchaSizeConfigName); |
| final String[] captchaSizeConfigs = captchaSizeConfig.split("\\|"); |
| final String captchaCodeId = StringUtils.defaultIfEmpty(request.getParameter("captchaCodeId"), ""); // this is used to uniquely identify in the user session the attribute where the captcha code for the last captcha for the form is stored |
| |
| final int fontSize = Integer.parseInt(captchaSizeConfigs[0]); |
| final int height = Integer.parseInt(captchaSizeConfigs[1]); |
| final int width = Integer.parseInt(captchaSizeConfigs[2]); |
| final int charsToPrint = UtilProperties.getPropertyAsInteger("captcha.properties", "captcha.code_length", 6); |
| final char[] availableChars = UtilProperties.getPropertyValue("captcha.properties", "captcha.characters").toCharArray(); |
| |
| //It is possible to pass the font size, image width and height with the request as well |
| Color backgroundColor = Color.gray; |
| Color borderColor = Color.DARK_GRAY; |
| Color textColor = Color.ORANGE; |
| Color circleColor = new Color(160, 160, 160); |
| Font textFont = new Font("Arial", Font.PLAIN, fontSize); |
| int circlesToDraw = 6; |
| float horizMargin = 20.0f; |
| double rotationRange = 0.7; // in radians |
| BufferedImage bufferedImage = new BufferedImage(width, height, BufferedImage.TYPE_INT_RGB); |
| |
| Graphics2D g = (Graphics2D) bufferedImage.getGraphics(); |
| |
| g.setColor(backgroundColor); |
| g.fillRect(0, 0, width, height); |
| |
| //Generating some circles for background noise |
| g.setColor(circleColor); |
| for (int i = 0; i < circlesToDraw; i++) { |
| int circleRadius = (int) (Math.random() * height / 2.0); |
| int circleX = (int) (Math.random() * width - circleRadius); |
| int circleY = (int) (Math.random() * height - circleRadius); |
| g.drawOval(circleX, circleY, circleRadius * 2, circleRadius * 2); |
| } |
| g.setColor(textColor); |
| g.setFont(textFont); |
| |
| FontMetrics fontMetrics = g.getFontMetrics(); |
| int maxAdvance = fontMetrics.getMaxAdvance(); |
| int fontHeight = fontMetrics.getHeight(); |
| |
| String captchaCode = RandomStringUtils.random(6, availableChars); |
| |
| float spaceForLetters = -horizMargin * 2 + width; |
| float spacePerChar = spaceForLetters / (charsToPrint - 1.0f); |
| |
| for (int i = 0; i < captchaCode.length(); i++) { |
| |
| // this is a separate canvas used for the character so that |
| // we can rotate it independently |
| int charWidth = fontMetrics.charWidth(captchaCode.charAt(i)); |
| int charDim = Math.max(maxAdvance, fontHeight); |
| int halfCharDim = (charDim / 2); |
| |
| BufferedImage charImage = new BufferedImage(charDim, charDim, BufferedImage.TYPE_INT_ARGB); |
| Graphics2D charGraphics = charImage.createGraphics(); |
| charGraphics.translate(halfCharDim, halfCharDim); |
| double angle = (Math.random() - 0.5) * rotationRange; |
| charGraphics.transform(AffineTransform.getRotateInstance(angle)); |
| charGraphics.translate(-halfCharDim, -halfCharDim); |
| charGraphics.setColor(textColor); |
| charGraphics.setFont(textFont); |
| |
| int charX = (int) (0.5 * charDim - 0.5 * charWidth); |
| charGraphics.drawString("" + captchaCode.charAt(i), charX, |
| ((charDim - fontMetrics.getAscent()) / 2 + fontMetrics.getAscent())); |
| |
| float x = horizMargin + spacePerChar * (i) - charDim / 2.0f; |
| int y = ((height - charDim) / 2); |
| |
| g.drawImage(charImage, (int) x, y, charDim, charDim, null, null); |
| |
| charGraphics.dispose(); |
| } |
| // Drawing the image border |
| g.setColor(borderColor); |
| g.drawRect(0, 0, width - 1, height - 1); |
| g.dispose(); |
| response.setContentType("image/jpeg"); |
| ImageIO.write(bufferedImage, "jpg", response.getOutputStream()); |
| HttpSession session = request.getSession(); |
| Map captchaCodeMap = (Map)session.getAttribute("_CAPTCHA_CODE_"); |
| if (captchaCodeMap == null) { |
| captchaCodeMap = new HashMap(); |
| session.setAttribute("_CAPTCHA_CODE_", captchaCodeMap); |
| } |
| captchaCodeMap.put(captchaCodeId, captchaCode); |
| } catch (Exception ioe) { |
| Debug.logError(ioe.getMessage(), module); |
| } |
| return "success"; |
| } |
| |
| } |
