/*
    * Copyright (c) 2001 - 2005 ivata limited.
    * All rights reserved.
    * -----------------------------------------------------------------------------
    * ivata masks may be redistributed under the GNU General Public
    * License as published by the Free Software Foundation;
    * version 2 of the License.
    *
    * These programs are free software; you can redistribute them and/or
   * modify them under the terms of the GNU General Public License
   * as published by the Free Software Foundation; version 2 of the License.
   *
   * These programs are distributed in the hope that they will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   *
   * See the GNU General Public License in the file LICENSE.txt for more
   * details.
   *
   * If you would like a copy of the GNU General Public License write to
   *
   * Free Software Foundation, Inc.
   * 59 Temple Place - Suite 330
   * Boston, MA 02111-1307, USA.
   *
   *
   * To arrange commercial support and licensing, contact ivata at
   *                  http://www.ivata.com/contact.jsp
   * -----------------------------------------------------------------------------
   * $Log: ValidationErrorsConvertor.java,v $
   * Revision 1.6  2005/04/09 18:04:19  colinmacleod
   * Changed copyright text to GPL v2 explicitly.
   *
   * Revision 1.5  2005/03/10 10:44:35  colinmacleod
   * Fixed validation conversion of Struts classes to
   * ivata masks validation errors.
   *
   * Revision 1.4  2005/01/19 13:14:02  colinmacleod
   * Renamed CausedByException to SystemException.
   *
   * Revision 1.3  2005/01/07 08:08:25  colinmacleod
   * Moved up a version number.
   * Changed copyright notices to 2005.
   * Updated the documentation:
   *   - started working on multiproject:site docu.
   *   - changed the logo.
   * Added checkstyle and fixed LOADS of style issues.
   * Added separate thirdparty subproject.
   * Added struts (in web), util and webgui (in webtheme) from ivata op.
   *
   * Revision 1.2  2004/12/23 21:28:32  colinmacleod
   * Modifications to add ivata op compatibility.
   *
   * Revision 1.1.1.1  2004/05/16 20:40:33  colinmacleod
   * Ready for 0.1 release
   *
   * Revision 1.3  2004/03/21 21:16:23  colinmacleod
   * Shortened name to ivata op.
   *
   * Revision 1.2  2004/02/01 22:07:29  colinmacleod
   * Added full names to author tags
   *
   * Revision 1.1  2004/01/29 13:48:41  janboros
   * Moved ivata op to SourceForge
   *
   * Revision 1.5  2003/02/26 17:10:38  peter
   * toActionError: the bundle is located by java.util, not struts
   *
   * Revision 1.4  2003/02/24 19:08:17  colin
   * *** empty log message ***
   *
   * Revision 1.3  2003/02/20 20:24:11  colin
   * improved validation by adding ValidationField and ValidationException
   *
   * Revision 1.2  2003/02/04 17:36:47  colin
   * copyright notice
   *
   * Revision 1.1  2002/11/12 10:41:12  colin
   * first version in CVS. encapsulates Struts class ActionErrors
   * -----------------------------------------------------------------------------
   */
  package com.ivata.mask.web.struts;
  import java.util.Iterator;
  import java.util.List;
  import java.util.Locale;
  import java.util.Vector;
  
  import org.apache.log4j.Logger;
  import org.apache.struts.action.ActionErrors;
  import org.apache.struts.action.ActionMessage;
  
  import com.ivata.mask.field.Field;
  import com.ivata.mask.util.SystemException;
  import com.ivata.mask.validation.ValidationError;
  import com.ivata.mask.validation.ValidationErrors;
  import com.ivata.mask.web.struts.util.MessageResourcesHandling;
  /***
   * <p>
   * Converts ivata masks validation errors to struts action errors. This class
  * has been split off from <code>ValidationErrors</code>, which was
  * originally a part of <a href="http://www.ivata.org">ivata op </a> and <a
  * href="http://www.ivata.com/portal">ivata team portal </a>.
  * </p>.
  *
  * @since ivata masks 0.4 (2002-11-11)
  * @author Colin MacLeod
  * <a href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com</a>
  * @version $Revision: 1.6 $
  * @see ValidationError
  * @see org.apache.struts.action.ActionErrors
  */
 public final class ValidationErrorsConvertor {
     /***
      * Refer to {@link Logger}.
      */
     private static Logger log =
         Logger.getLogger(ValidationErrorsConvertor.class);
     /***
      * Default text to use when there is no field.
      */
     private static final String NONE_FIELD = "[None]";
     /***
      * Private helper to avoid repetition. Get the label for the field specified
      * and default it if the label is not available.
      *
      * @param locale Refer to {@link #toActionErrors}.
      * @param bundle name of the resource bundle used to translate the field
      * label.
      * @param resourceFieldPath path within the bundle which prefixes the field
      * name.
      * @param field field whose label should be retrieved.
      * @return localized text for this label.
      * @throws SystemException Refer to
      * @link MessageResourcesHandling#getDefaultLabel}.
      */
     private static String getFieldLabel(Locale locale, String bundle,
             String resourceFieldPath, Field field)
             throws SystemException {
         String fieldLabel;
         try {
             fieldLabel = MessageResourcesHandling.getDefaultLabel(
                 locale, bundle, field.getName(),
                 null, null, resourceFieldPath, null,
                 false,
                 false);
         } catch (Exception e) {
             // just log this exception - we don't want to report errors about
             // our error-handing - it could go on forever ;-)
             log.error(e);
             fieldLabel = null;
         }
         // if we can't find a label, just put out what we know
         // about this field - it will be better than [null]
         if (fieldLabel == null) {
             fieldLabel = bundle
                     + "-"
                     + resourceFieldPath
                     + "-"
                     + field.getName();
             log.error("No label found for "
                     + "field '"
                     + fieldLabel
                     + "'");
         }
         return fieldLabel;
     }
     /***
      * <p>
      * Convert the errors to instances of <code>ActionError</code> for use in
      * a <strong>Struts </strong> project.
      * </p>
      *
      * @param messages This instance is used to localize the error strings.
      * @param validationErrors contains error references which should be
      * converted to plain text errors.
      * @return {@link org.apache.struts.action.ActionErrors ActionErrors}
      *         collection containing <code>ActionError</code> instances whose
      *         contents mirror that of the <code>ValidationError</code>
      *         instances this instance contains.
      * @throws SystemException if the message resources are undefined.
      */
     public static ActionErrors toActionErrors(
             final ValidationErrors validationErrors,
             final Locale locale)
             throws SystemException {
         assert (validationErrors != null);
 
         List errors = validationErrors.getErrors();
         ActionErrors actionErrors = new ActionErrors();
         for (Iterator i = errors.iterator(); i.hasNext();) {
             ValidationError error = (ValidationError) i.next();
             Field field = error.getField();
             String key = error.getErrorKey();
             List originalParameters = error.getParameters();
             // convert any parameters from ValidationField to basic type
             Vector parameters = new Vector();
             // the first parameter is always the field itself
             String fieldName;
             if (field == null) {
                 fieldName= NONE_FIELD;
                 parameters.add(NONE_FIELD);
             } else {
                 fieldName = field.getName();
                 parameters.add(getFieldLabel(locale, error.getBundle(),
                         error.getResourceFieldPath(), field));
             }
 
             if (originalParameters != null) {
                 for (Iterator j = originalParameters.iterator(); j.hasNext();) {
                     Object parameter = j.next();
                     if (parameter instanceof Field) {
                         String label = getFieldLabel(locale, error.getBundle(),
                                 error.getResourceFieldPath(),
                                 (Field) parameter);
                         parameters.add(label);
                     } else {
                         parameters.add(parameter);
                     }
                 }
             }
             // 0 parameters
             int count;
             count = parameters.size();
             int parameterCount = 0;
             if ((parameters == null) || (count == parameterCount++)) {
                 actionErrors.add(fieldName, new ActionMessage(key));
             // 1 parameter
             } else if (count == parameterCount++) {
                 actionErrors.add(fieldName,
                         new ActionMessage(key, parameters.get(0)));
             // 2 parameters
             } else if (count == parameterCount++) {
                 parameterCount = 0;
                 actionErrors.add(fieldName,
                         new ActionMessage(key,
                                 parameters.get(parameterCount++),
                                 parameters.get(parameterCount++)));
             // 3 parameters
             } else if (count == parameterCount++) {
                 parameterCount = 0;
                 actionErrors.add(fieldName,
                         new ActionMessage(key,
                                 parameters.get(parameterCount++),
                                 parameters.get(parameterCount++),
                                 parameters.get(parameterCount++)));
             // 4 parameters or more
             } else if (count >= parameterCount){
                 // can't go beyond this limit yet TODO: horrid, magic number
                 // workaround stuff here :-)
                 if (count > parameterCount) {
                     log.warn(parameterCount
                             + " parameters "
                             + " encountered for key '"
                             + key
                             + "'. All parameters are: "
                             + parameters
                             + ". ActionMessage constructor only lets us have "
                             + "the first 4 - the rest will be ignored.");
                 }
                 parameterCount = 0;
                 actionErrors.add(fieldName,
                         new ActionMessage(key,
                                 parameters.get(parameterCount++),
                                 parameters.get(parameterCount++),
                                 parameters.get(parameterCount++),
                                 parameters.get(parameterCount++)));
             // more are not allowed :-(
             }
         }
         return actionErrors;
     }
 
     /***
      * Private constructor enforces utility class behavior.
      */
     private ValidationErrorsConvertor () {
     }
 }