/*
    * $Header: /cvsroot/jdbforms/dbforms/src/org/dbforms/event/AbstractDatabaseEvent.java,v 1.1 2005/11/30 20:31:17 hkollmann Exp $
    * $Revision: 1.1 $
    * $Date: 2005/11/30 20:31:17 $
    *
    * DbForms - a Rapid Application Development Framework
    * Copyright (C) 2001 Joachim Peer <joepeer@excite.com>
    *
    * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU Lesser General Public
   * License as published by the Free Software Foundation; either
   * version 2.1 of the License, or (at your option) any later version.
   *
   * This library is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   * Lesser General Public License for more details.
   *
   * You should have received a copy of the GNU Lesser General Public
   * License along with this library; if not, write to the Free Software
   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
   */
  package org.dbforms.event;
  
  import org.apache.commons.logging.Log;
  import org.apache.commons.logging.LogFactory;
  
  import org.dbforms.config.Constants;
  import org.dbforms.config.DbFormsConfig;
  import org.dbforms.config.Field;
  import org.dbforms.config.FieldTypes;
  import org.dbforms.config.FieldValue;
  import org.dbforms.config.FieldValues;
  import org.dbforms.config.MultipleValidationException;
  
  import org.dbforms.event.eventtype.EventType;
  
  import org.dbforms.util.MessageResources;
  import org.dbforms.util.ParseUtil;
  import org.dbforms.util.Util;
  
  import java.io.UnsupportedEncodingException;
  
  import java.sql.Connection;
  import java.sql.SQLException;
  
  import java.util.Iterator;
  import java.util.Vector;
  
  import javax.servlet.ServletContext;
  import javax.servlet.http.HttpServletRequest;
  
  /***
   * Abstract base class for all web-events related to database operations like
   * inserts, updates, deletes.
   * 
   * @author Joe Peer
   */
  public abstract class AbstractDatabaseEvent extends AbstractWebEvent {
  	private static Log logCat = LogFactory
  			.getLog(AbstractDatabaseEvent.class.getName()); // logging category for this
  													// class
  
  	/*** key identifier */
  	private String keyId;
  
  	/***
  	 * Creates a new DatabaseEvent object.
  	 * 
  	 * @param tableId
  	 *            the table id
  	 * @param keyId
  	 *            the key id
  	 * @param request
  	 *            the request object
  	 * @param config
  	 *            the configuration object
  	 */
  	public AbstractDatabaseEvent(int tableId, String keyId, HttpServletRequest request,
  			DbFormsConfig config) {
  		super(tableId, request, config);
  		this.keyId = keyId;
  	}
  
  	/***
  	 * Get the hash table containing the form field names and values taken from
  	 * the request object. <br>
  	 * Example of a request parameter:<br>
  	 * <code>name  = f_0_insroot_6 value = foo-bar </code>
  	 * 
  	 * @return the hash map containing the names and values taken from the
  	 *         request object
  	 */
  
  	// must be public because protected will break cactus testing!
  	public abstract FieldValues getFieldValues();
  
  	/***
  	 * Get the keyId parameter value
 	 * 
 	 * @return keyId parameter value
 	 */
 	public String getKeyId() {
 		return keyId;
 	}
 
 	/***
 	 * DO the validation of the form with Commons-Validator.
 	 * 
 	 * @param formValidatorName
 	 *            The form name to retreive in validation.xml
 	 * @param context
 	 *            The servlet context we are processing
 	 * 
 	 * @exception MultipleValidationException
 	 *                The Vector of errors throwed with this exception
 	 */
 	public void doValidation(String formValidatorName, ServletContext context)
 			throws MultipleValidationException {
 	}
 
 	/***
 	 * Process this event.
 	 * 
 	 * @param con
 	 *            the jdbc connection object
 	 * 
 	 * @throws SQLException
 	 *             if any data access error occurs
 	 * @throws MultipleValidationException
 	 *             if any validation error occurs
 	 */
 	public abstract void processEvent(Connection con) throws SQLException,
 			MultipleValidationException;
 
 	/***
 	 * Get the FieldValues object representing the collection of FieldValue
 	 * objects builded from the request parameters
 	 * 
 	 * @param insertMode
 	 *            true DOCUMENT ME!
 	 * 
 	 * @return the FieldValues object representing the collection of FieldValue
 	 *         objects builded from the request parameters
 	 */
 	protected FieldValues getFieldValues(boolean insertMode) {
 		FieldValues result = new FieldValues();
 		String paramStub = (Constants.FIELDNAME_PREFIX
 				+ getTable().getId()
 				+ "_"
 				+ (EventType.EVENT_DATABASE_INSERT.equals(getType()) ? Constants.FIELDNAME_INSERTPREFIX
 						: "") + keyId + "_");
 		Vector params = ParseUtil.getParametersStartingWith(getRequest(),
 				paramStub);
 
 		// Always doit in insert or delete mode
 		boolean doIt = insertMode;
 
 		// First check if update is necessary
 		if (!doIt) {
 			Iterator e = params.iterator();
 
 			while (e.hasNext()) {
 				String param = (String) e.next();
 
 				// value of the named parameter;
 				String value = ParseUtil.getParameter(getRequest(), param);
 
 				// old value of the named parameter;
 				String oldValue = ParseUtil.getParameter(getRequest(),
 						Constants.FIELDNAME_OLDVALUETAG + param);
 
 				// if they are not equals, set the update flag for this field
 				// and exit from the loop;
 				doIt = !value.equals(oldValue);
 
 				if (doIt) {
 					break;
 				}
 			}
 		}
 
 		// if update is necessary then do update for all data columns
 		if (doIt) {
 			Iterator e = params.iterator();
 
 			while (e.hasNext()) {
 				String param = (String) e.next();
 
 				int iiFieldId = Integer.parseInt(param.substring(paramStub
 						.length()));
 				Field f = getTable().getField(iiFieldId);
 
 				String value = f.getEscaper().unescapeHTML(
 						ParseUtil.getParameter(getRequest(), param));
 				FieldValue fv = new FieldValue(f, value);
 
 				fv.setOldValue(f.getEscaper().unescapeHTML(
 						ParseUtil.getParameter(getRequest(),
 								Constants.FIELDNAME_OLDVALUETAG + param)));
 				fv.setPattern(ParseUtil.getParameter(getRequest(),
 						Constants.FIELDNAME_PATTERNTAG + param));
 				fv.setLocale(MessageResources.getLocale(getRequest()));
 
 				if ((f.getType() == FieldTypes.BLOB)
 						|| (f.getType() == FieldTypes.DISKBLOB)) {
 					// in case of a BLOB or DISKBLOB save get the FileHolder for
 					// later use
 					fv.setFileHolder(ParseUtil.getFileHolder(getRequest(), "f_"
 							+ getTable().getId()
 							+ "_"
 							+ (insertMode ? Constants.FIELDNAME_INSERTPREFIX
 									: "") + keyId + "_" + iiFieldId));
 				}
 
 				result.put(fv);
 			}
 		}
 
 		return result;
 	}
 
 	/***
 	 * Return the key values string from the request object
 	 * 
 	 * @return the key values string from the request object
 	 */
 	protected String getKeyValues() {
 		String key = null;
 
 		try {
 			key = ParseUtil.getParameter(getRequest(), "k_"
 					+ getTable().getId() + "_" + keyId);
 			key = Util.decode(key, getRequest().getCharacterEncoding());
 			logCat.info("::getKeyValues - key: " + key);
 		} catch (UnsupportedEncodingException e) {
 			logCat.error(e);
 		}
 
 		return key;
 	}
 }