/* * $Id: ServiceUtil.java 7027 2006-03-20 18:21:03Z jaz $ * * Copyright (c) 2001-2005 The Open For Business Project - www.ofbiz.org * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT * OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * */package org.ofbiz.service;import java.sql.Timestamp;import java.util.Calendar;import java.util.Iterator;import java.util.LinkedList;import java.util.List;import java.util.Locale;import java.util.Map;import javax.servlet.http.HttpServletRequest;import javax.transaction.Transaction;import javolution.util.FastMap;import javolution.util.FastList;import org.ofbiz.base.util.Debug;import org.ofbiz.base.util.UtilDateTime;import org.ofbiz.base.util.UtilMisc;import org.ofbiz.base.util.UtilProperties;import org.ofbiz.base.util.UtilValidate;import org.ofbiz.entity.GenericDelegator;import org.ofbiz.entity.GenericEntityException;import org.ofbiz.entity.GenericValue;import org.ofbiz.entity.transaction.TransactionUtil;import org.ofbiz.entity.transaction.GenericTransactionException;import org.ofbiz.entity.condition.EntityCondition;import org.ofbiz.entity.condition.EntityConditionList;import org.ofbiz.entity.condition.EntityExpr;import org.ofbiz.entity.condition.EntityOperator;import org.ofbiz.entity.util.EntityFindOptions;import org.ofbiz.entity.util.EntityListIterator;import org.ofbiz.security.Security;import org.ofbiz.service.config.ServiceConfigUtil;/** * Generic Service Utility Class * * @author     <a href="mailto:jaz@ofbiz.org">Andy Zeneski</a> * @version    $Rev: 7027 $ * @since      2.0 */public class ServiceUtil {    public static final String module = ServiceUtil.class.getName();    public static final String resource = "ServiceErrorUiLabels";    /** A little short-cut method to check to see if a service returned an error */    public static boolean isError(Map results) {        if (results == null || results.get(ModelService.RESPONSE_MESSAGE) == null) {            return false;        }        return ModelService.RESPOND_ERROR.equals(results.get(ModelService.RESPONSE_MESSAGE));    }    public static boolean isFailure(Map results) {        if (results == null || results.get(ModelService.RESPONSE_MESSAGE) == null) {            return false;        }        return ModelService.RESPOND_FAIL.equals(results.get(ModelService.RESPONSE_MESSAGE));    }    /** A small routine used all over to improve code efficiency, make a result map with the message and the error response code */    public static Map returnError(String errorMessage) {        return returnProblem(ModelService.RESPOND_ERROR, errorMessage, null, null, null);    }    /** A small routine used all over to improve code efficiency, make a result map with the message and the error response code */    public static Map returnError(String errorMessage, List errorMessageList) {        return returnProblem(ModelService.RESPOND_ERROR, errorMessage, errorMessageList, null, null);    }    /** A small routine used all over to improve code efficiency, make a result map with the message and the error response code */    public static Map returnError(List errorMessageList) {        return returnProblem(ModelService.RESPOND_ERROR, null, errorMessageList, null, null);    }    public static Map returnFailure(String errorMessage) {        return returnProblem(ModelService.RESPOND_FAIL, errorMessage, null, null, null);    }     public static Map returnFailure(List errorMessageList) {        return returnProblem(ModelService.RESPOND_FAIL, null, errorMessageList, null, null);    }    /** A small routine used all over to improve code efficiency, make a result map with the message and the error response code, also forwards any error messages from the nestedResult */    public static Map returnError(String errorMessage, List errorMessageList, Map errorMessageMap, Map nestedResult) {        return returnProblem(ModelService.RESPOND_ERROR, errorMessage, errorMessageList, errorMessageMap, nestedResult);    }    public static Map returnProblem(String returnType, String errorMessage, List errorMessageList, Map errorMessageMap, Map nestedResult) {        Map result = FastMap.newInstance();        result.put(ModelService.RESPONSE_MESSAGE, returnType);        if (errorMessage != null) {            result.put(ModelService.ERROR_MESSAGE, errorMessage);        }        List errorList = new LinkedList();        if (errorMessageList != null) {            errorList.addAll(errorMessageList);        }        Map errorMap = FastMap.newInstance();        if (errorMessageMap != null) {            errorMap.putAll(errorMessageMap);        }        if (nestedResult != null) {            if (nestedResult.get(ModelService.ERROR_MESSAGE) != null) {                errorList.add(nestedResult.get(ModelService.ERROR_MESSAGE));            }            if (nestedResult.get(ModelService.ERROR_MESSAGE_LIST) != null) {                errorList.addAll((List) nestedResult.get(ModelService.ERROR_MESSAGE_LIST));            }            if (nestedResult.get(ModelService.ERROR_MESSAGE_MAP) != null) {                errorMap.putAll((Map) nestedResult.get(ModelService.ERROR_MESSAGE_MAP));            }        }        if (errorList.size() > 0) {            result.put(ModelService.ERROR_MESSAGE_LIST, errorList);        }        if (errorMap.size() > 0) {            result.put(ModelService.ERROR_MESSAGE_MAP, errorMap);        }        return result;    }    /** A small routine used all over to improve code efficiency, make a result map with the message and the success response code */    public static Map returnSuccess(String successMessage) {        return returnMessage(ModelService.RESPOND_SUCCESS, successMessage);    }    /** A small routine used all over to improve code efficiency, make a result map with the message and the success response code */    public static Map returnSuccess() {        return returnMessage(ModelService.RESPOND_SUCCESS, null);    }    /** A small routine to make a result map with the message and the response code     * NOTE: This brings out some bad points to our message convention: we should be using a single message or message list     *  and what type of message that is should be determined by the RESPONSE_MESSAGE (and there's another annoyance, it should be RESPONSE_CODE)     */    public static Map returnMessage(String code, String message) {        Map result = FastMap.newInstance();        if (code != null) result.put(ModelService.RESPONSE_MESSAGE, code);        if (message != null) result.put(ModelService.SUCCESS_MESSAGE, message);        return result;    }    /** A small routine used all over to improve code efficiency, get the partyId and does a security check     *<b>security check</b>: userLogin partyId must equal partyId, or must have [secEntity][secOperation] permission     */    public static String getPartyIdCheckSecurity(GenericValue userLogin, Security security, Map context, Map result, String secEntity, String secOperation) {        String partyId = (String) context.get("partyId");        Locale locale = getLocale(context);        if (partyId == null || partyId.length() == 0) {            partyId = userLogin.getString("partyId");        }        // partyId might be null, so check it        if (partyId == null || partyId.length() == 0) {            result.put(ModelService.RESPONSE_MESSAGE, ModelService.RESPOND_ERROR);            String errMsg = UtilProperties.getMessage(ServiceUtil.resource, "serviceUtil.party_id_missing", locale) + ".";            result.put(ModelService.ERROR_MESSAGE, errMsg);            return partyId;        }        // <b>security check</b>: userLogin partyId must equal partyId, or must have PARTYMGR_CREATE permission        if (!partyId.equals(userLogin.getString("partyId"))) {            if (!security.hasEntityPermission(secEntity, secOperation, userLogin)) {                result.put(ModelService.RESPONSE_MESSAGE, ModelService.RESPOND_ERROR);                String errMsg = UtilProperties.getMessage(ServiceUtil.resource, "serviceUtil.no_permission_to_operation", locale) + ".";                result.put(ModelService.ERROR_MESSAGE, errMsg);                return partyId;            }        }        return partyId;    }    public static void setMessages(HttpServletRequest request, String errorMessage, String eventMessage, String defaultMessage) {        if (UtilValidate.isNotEmpty(errorMessage))            request.setAttribute("_ERROR_MESSAGE_", errorMessage);        if (UtilValidate.isNotEmpty(eventMessage))            request.setAttribute("_EVENT_MESSAGE_", eventMessage);        if (UtilValidate.isEmpty(errorMessage) && UtilValidate.isEmpty(eventMessage) && UtilValidate.isNotEmpty(defaultMessage))            request.setAttribute("_EVENT_MESSAGE_", defaultMessage);    }    public static void getMessages(HttpServletRequest request, Map result, String defaultMessage) {        getMessages(request, result, defaultMessage, null, null, null, null, null, null);    }    public static void getMessages(HttpServletRequest request, Map result, String defaultMessage,                                   String msgPrefix, String msgSuffix, String errorPrefix, String errorSuffix, String successPrefix, String successSuffix) {        String errorMessage = ServiceUtil.makeErrorMessage(result, msgPrefix, msgSuffix, errorPrefix, errorSuffix);        String successMessage = ServiceUtil.makeSuccessMessage(result, msgPrefix, msgSuffix, successPrefix, successSuffix);        setMessages(request, errorMessage, successMessage, defaultMessage);    }    public static String getErrorMessage(Map result) {        StringBuffer errorMessage = new StringBuffer();        if (result.get(ModelService.ERROR_MESSAGE) != null) errorMessage.append((String) result.get(ModelService.ERROR_MESSAGE));        if (result.get(ModelService.ERROR_MESSAGE_LIST) != null) {            List errors = (List) result.get(ModelService.ERROR_MESSAGE_LIST);            Iterator errorIter = errors.iterator();            while (errorIter.hasNext()) {                // NOTE: this MUST use toString and not cast to String because it may be a MessageString object                String curMessage = errorIter.next().toString();                if (errorMessage.length() > 0) {                    errorMessage.append(", ");                }                errorMessage.append(curMessage);            }        }        return errorMessage.toString();    }    public static String makeErrorMessage(Map result, String msgPrefix, String msgSuffix, String errorPrefix, String errorSuffix) {        if (result == null) {            Debug.logWarning("A null result map was passed", module);            return null;        }        String errorMsg = (String) result.get(ModelService.ERROR_MESSAGE);        List errorMsgList = (List) result.get(ModelService.ERROR_MESSAGE_LIST);        Map errorMsgMap = (Map) result.get(ModelService.ERROR_MESSAGE_MAP);        StringBuffer outMsg = new StringBuffer();        if (errorMsg != null) {            if (msgPrefix != null) outMsg.append(msgPrefix);            outMsg.append(errorMsg);            if (msgSuffix != null) outMsg.append(msgSuffix);        }        outMsg.append(makeMessageList(errorMsgList, msgPrefix, msgSuffix));        if (errorMsgMap != null) {            Iterator mapIter = errorMsgMap.entrySet().iterator();            while (mapIter.hasNext()) {                Map.Entry entry = (Map.Entry) mapIter.next();                outMsg.append(msgPrefix);                outMsg.append(entry.getKey());                outMsg.append(": ");                outMsg.append(entry.getValue());                outMsg.append(msgSuffix);            }        }        if (outMsg.length() > 0) {            StringBuffer strBuf = new StringBuffer();            if (errorPrefix != null) strBuf.append(errorPrefix);            strBuf.append(outMsg.toString());            if (errorSuffix != null) strBuf.append(errorSuffix);            return strBuf.toString();        } else {            return null;        }