package org.apache.turbine.services.intake.validator;

/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2001 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" and
 *    "Apache Turbine" must not be used to endorse or promote products
 *    derived from this software without prior written permission. For
 *    written permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache",
 *    "Apache Turbine", nor may "Apache" appear in their name, without
 *    prior written permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

import java.util.Map;
import java.util.Date;

import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.text.ParseException;

import org.apache.turbine.util.Log;
import org.apache.turbine.util.TurbineException;

/**
 * Validates numbers with the following constraints in addition to those
 * listed in DefaultValidator.
 *
 * <table>
 * <tr><th>Name</th><th>Valid Values</th><th>Default Value</th></tr>
 * <tr>
 * <td>format</td>
 * <td>Desired date format</td>
 * <td>&nbsp;</td>
 * </tr>
 * <tr>
 * <td>notADateMessage</td>
 * <td>Some text</td>
 * <td>Entry was not a valid number</td>
 * </tr>
 * </table>
 *
 * @author <a href="mailto:ian.lim@ebyssness.com>Ian Lim</a>
 * @version $Id$
 */

public class DateValidator extends DefaultValidator {

    private static String INVALID_DATE = "Entry was not a valid date";
    protected String invalidDateMessage;
    protected DateFormat _dateFormat = null;
    protected String _dateFormatMessage = null;

    /**
     * Another constructor
     */
    public DateValidator( Map paramMap )
        throws TurbineException
    {
        init( paramMap );
    }

    /**
     * Default constructor
     */
    public DateValidator(){}

    /**
     * Extract the relevant parameters from the constraints listed
     * in <input-param> tags within the intake.xml file.
     *
     * @param inputParameters a <code>Map</code> of <code>InputParam</code>'s
     * containing constraints on the input.
     * @exception TurbineException if an error occurs
     */
    public void init(Map paramMap)
        throws TurbineException
    {
        super.init( paramMap );

        doInit( paramMap );

        Constraint constraint = (Constraint)paramMap.get( "notADateMessage" );
        if ( constraint != null )
        {
            String param = constraint.getValue();
            if ( param != null && param.length() != 0 )
            {
                invalidDateMessage = param;
            }
            else if ( constraint.getMessage().length() != 0 )
            {
                invalidDateMessage = constraint.getMessage();
            }
            else
            {
                invalidDateMessage = getInvalidDateMessage();
            }
        }
        else
        {
            invalidDateMessage = getInvalidDateMessage();
        }
    }

    /**
     * Returns the default invalid message
     * @return default invalid date message
     */
    protected String getInvalidDateMessage()
    {
        return INVALID_DATE;
    }

    /**
     *
     */
    protected void doInit( Map paramMap )
    {
        _dateFormat = null;

        Constraint constraint = (Constraint)paramMap.get( "format" );
        if ( constraint != null )
        {
            String param = constraint.getValue();
            _dateFormat = new SimpleDateFormat( param );
            _dateFormatMessage = constraint.getMessage();
        }

        /**
        constraint = (Constraint)paramMap.get("maxValue");
        if ( constraint != null )
        {
            String param = constraint.getValue();
            maxValue = new BigDecimal(param);
            maxValueMessage = constraint.getMessage();
        }
        **/
    }

    /**
     * Determine whether a testValue meets the criteria specified
     * in the constraints defined for this validator
     *
     * @param testValue a <code>String</code> to be tested
     * @exception ValidationException containing an error message if the
     * testValue did not pass the validation tests.
     */
    protected void doAssertValidity( String testValue )
        throws ValidationException
    {
        // Log.debug( "\n\n!!! Entering doAssertValidity method. Testvalue = ", testValue );
        Date date = null;
        try
        {
            date = _dateFormat.parse( testValue );
            Log.debug(    "\n\n!!! _dateFormat = " + _dateFormat
                        + "; test value = " + testValue
                        + "; result = " + date
                    );

            if( date == null )
            {
                logError();
            }
        }
        catch( ParseException e )
        {
            logError();
        }
    }

    /**
     * Throws an error
     */
    private void logError() throws ValidationException
    {
        message = invalidDateMessage;
        throw new ValidationException( invalidDateMessage );
    }
}