/******************************************************************************
 * Product: Adempiere ERP & CRM Smart Business Solution                       *
 * Copyright (C) 1999-2006 Adempiere, Inc. All Rights Reserved.                *
 * This program is free software; you can redistribute it and/or modify it    *
 * under the terms version 2 of the GNU General Public License as published   *
 * by the Free Software Foundation. This program 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 General Public License for more details.                       *
 * You should have received a copy of the GNU General Public License along    *
 * with this program; if not, write to the Free Software Foundation, Inc.,    *
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.                     *
 *
 * Copyright (C) 2005 Robert Klein. robeklein@hotmail.com                     *
 * Contributor(s): Low Heng Sin hengsin@avantz.com                            *
 *****************************************************************************/
package org.adempiere.pipo2;

import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;
import java.math.BigDecimal;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import java.util.logging.Level;

import javax.xml.transform.sax.TransformerHandler;

import org.adempiere.pipo2.exception.DatabaseAccessException;
import org.compiere.model.MColumn;
import org.compiere.model.MTable;
import org.compiere.model.PO;
import org.compiere.model.POInfo;
import org.compiere.model.X_AD_Package_Imp_Backup;
import org.compiere.model.X_AD_Package_Imp_Detail;
import org.compiere.util.CLogger;
import org.compiere.util.DB;
import org.compiere.util.Env;
import org.compiere.util.Util;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.AttributesImpl;

/**
 *
 * @author hengsin
 *
 */
public abstract class AbstractElementHandler implements ElementHandler {

	protected transient CLogger log = CLogger.getCLogger(getClass());

	/**
	 * @param ctx
	 * @param type
	 * @param tableName
	 * @param tableId
	 * @return X_AD_Package_Imp_Detail
	 */
	public X_AD_Package_Imp_Detail createImportDetail(PIPOContext ctx, String type, String tableName, int tableId) {
		X_AD_Package_Imp_Detail impDetail = new X_AD_Package_Imp_Detail(ctx.ctx, 0, getTrxName(ctx));
		impDetail.setAD_Package_Imp_ID(getPackageImpId(ctx.ctx));
		impDetail.setAD_Org_ID(Env.getAD_Org_ID(ctx.ctx) );
		impDetail.setType(type);
		impDetail.setName("");
		impDetail.setAction("");
		impDetail.setRecord_ID(0);
		impDetail.setTableName(tableName);
		impDetail.setAD_Table_ID(tableId);
		impDetail.saveEx(getTrxName(ctx));

		return impDetail;
	}

	/**
     *	Write results to log and records in history table
     *
     *		@param ctx
     *      @param success
     *      @param detail
     *      @param objectName
     *      @param objectID
     *      @param action
     * 		@throws SAXException
     *
     */
    public void logImportDetail (PIPOContext ctx, X_AD_Package_Imp_Detail detail, int success, String objectName, int objectID,
    		String action) throws SAXException{
    	logImportDetail (ctx, detail, success, objectName, objectID, null, action, null, null);
    }

	/**
     *	Write results to log and records in history table
     *
     *		@param ctx
     *      @param success
     *      @param detail
     *      @param objectName
     *      @param objectID
     *      @param objectUU
     *      @param action
     * 		@throws SAXException
     *
     */
    public void logImportDetail (PIPOContext ctx, X_AD_Package_Imp_Detail detail, int success, String objectName, int objectID, String objectUU,
    		String action) throws SAXException{
    	logImportDetail (ctx, detail, success, objectName, objectID, objectUU, action, null, null);
    }

	/**
     *	Write results to log and records in history table
     *
     *		@param ctx
     *      @param success
     *      @param detail
     *      @param objectName
     *      @param objectID
     *      @param action
     *      @param execCode
     *      @param result
     * 		@throws SAXException
     *
     */
    public void logImportDetail (PIPOContext ctx, X_AD_Package_Imp_Detail detail, int success, String objectName, int objectID,
    		String action, String execCode, String result) throws SAXException{
    	logImportDetail (ctx, detail, success, objectName, objectID, null, action, execCode, result);
    }

	/**
     *	Write results to log and records in history table
     *
     *		@param ctx
     *      @param success
     *      @param detail
     *      @param objectName
     *      @param objectID
     *      @param objectUU
     *      @param action
     *      @param execCode
     *      @param result
     * 		@throws SAXException
     *
     */
    public void logImportDetail (PIPOContext ctx, X_AD_Package_Imp_Detail detail, int success, String objectName, int objectID, String objectUU,
    		String action, String execCode, String result) throws SAXException{
		String msgSuccess = success == 1 ? "Success" : "Failure";

		// try to figure out the UUID when empty
		if (Util.isEmpty(objectUU) && objectID > 0 && detail.getAD_Table_ID() > 0) {
			MTable table = MTable.get(ctx.ctx, detail.getAD_Table_ID(), getTrxName(ctx));
			PO po = table.getPO(objectID, getTrxName(ctx));
			if (po != null)
				objectUU = po.get_UUID();
		}

		detail.setName(objectName);
		detail.setAction(action);
		detail.setSuccess(msgSuccess);
		if (execCode != null)
			detail.setExecCode(execCode);
		if (result != null)
			detail.setResult(result);
		if (objectID >= 0)
			detail.setRecord_ID(objectID);
		if (!Util.isEmpty(objectUU))
			detail.setRecord_UU(objectUU);
		ctx.packIn.addImportDetail(detail);
		StringBuilder msg = new StringBuilder(action).append(" ");
		if (detail.getTableName() != null)
			msg.append(detail.getTableName());
		msg.append("=").append(objectName).append("[").append(objectID).append("]");
		if (success == 1)
			ctx.packIn.getNotifier().addSuccessLine(msg.toString());
		else
			ctx.packIn.getNotifier().addFailureLine(msg.toString());
    }

    /**
     *	Make backup copy of record.
	 * @param ctx
	 * @param AD_Package_Imp_Detail_ID
	 * @param tableName
	 * @param from
	 */
	public void backupRecord(PIPOContext ctx, int AD_Package_Imp_Detail_ID, String tableName,PO from){

    	// Create new record
		MTable mTable = MTable.get(ctx.ctx, tableName, getTrxName(ctx));
    	int tableID = mTable.getAD_Table_ID();    			
		POInfo poInfo = POInfo.getPOInfo(ctx.ctx, tableID);

		PreparedStatement pstmtReferenceId = DB.prepareStatement("SELECT AD_Reference_ID FROM AD_COLUMN WHERE AD_Column_ID = ?", getTrxName(ctx));
		ResultSet rs=null;

	    try{
			for (int i = 0; i < poInfo.getColumnCount(); i++){

				if (from.is_ValueChanged(i)) {
					MColumn mColumn = mTable.getColumn(poInfo.getColumnName(i));
					int columnID = mColumn.getAD_Column_ID();
	
					int referenceID=0;
	
					pstmtReferenceId.setInt(1,columnID);
					rs = pstmtReferenceId.executeQuery();
	
					if (rs.next())
						referenceID = rs.getInt(1);
	
		    		X_AD_Package_Imp_Backup backup = new X_AD_Package_Imp_Backup(ctx.ctx, 0, getTrxName(ctx));
		    		backup.setAD_Org_ID(Env.getAD_Org_ID(ctx.ctx));
		    		backup.setAD_Package_Imp_ID(getPackageImpId(ctx.ctx));
		    		backup.setAD_Package_Imp_Detail_ID(AD_Package_Imp_Detail_ID);
		    		backup.setAD_Table_ID(tableID);
	
		    		backup.setAD_Column_ID(columnID);
		    		backup.setAD_Reference_ID(referenceID);
		    		Object value = from.get_ValueOld(i);
					backup.setColValue(value != null ? value.toString() : null);
	
					backup.saveEx();
				}
		    }
		}
	    catch(Exception e)
		{
			throw new DatabaseAccessException(e);
		}
	    finally
	    {
	    	DB.close(rs, pstmtReferenceId);
	    }
    }

	/**
     *	Open input file for processing
     * @param filePath file with path
     * @return
     */
    public FileInputStream OpenInputfile (String filePath) {

    	FileInputStream fileTarget = null;

    	try {
    		fileTarget = new FileInputStream(filePath);
    	}
    	catch (FileNotFoundException e ) {
    		System.out.println("File not found: " + filePath);

    		return null;
    	}
    	return fileTarget;
    }

    /**
     *	Open output file for processing
     * @param filePath file with path
     * @return
     */
    public OutputStream OpenOutputfile (String filePath) {

    	OutputStream fileTarget = null;

    	try {
    		fileTarget = new FileOutputStream(filePath);
    	}
    	catch (FileNotFoundException e ) {
    		System.out.println("File not found: " + filePath);

    		return null;
    	}
    	return fileTarget;
    }

    /**
     *	Copyfile
     * @param source
     * @param target
     * @return
     */
    public int copyFile (InputStream source,OutputStream target) {

    	 int byteCount = 0;
    	 int success = 0;
	        try {
	           while (true) {
	              int data = source.read();
	              if (data < 0)
	                 break;
	              target.write(data);
	              byteCount++;
	           }
	           source.close();
	           target.close();
	           if (log.isLoggable(Level.FINER)) log.finer("Successfully copied " + byteCount + " bytes.");
	        }
	        catch (Exception e) {
	           log.log(Level.SEVERE, e.getLocalizedMessage(), e);
	           success = -1;
	        }
	    return success;
    }

    /**
     * Get client id
     * @param ctx
     * @return int
     */
    protected int getClientId(Properties ctx) {
    	return Env.getContextAsInt(ctx, "AD_Client_ID");
    }

    /**
     * Get AD_Package_Imp_ID
     * @param ctx
     * @return int
     */
    protected int getPackageImpId(Properties ctx) {
    	return Env.getContextAsInt(ctx, "AD_Package_Imp_ID");
    }

    /**
     * Get update system maintained dictionary flag
     * @param ctx
     * @return update mode
     */
    protected String getUpdateMode(Properties ctx) {
    	return Env.getContext(ctx, "UpdateMode");
    }

    /**
     * Get current transaction name
     * @param ctx
     * @return transaction name
     */
    protected String getTrxName(PIPOContext ctx) {
    	return ctx.trx != null ? ctx.trx.getTrxName() : null;
    }

    /**
     * @param ctx
     * @return package directory
     */
    protected String getPackageDirectory(Properties ctx) {
    	return Env.getContext(ctx, "PackageDirectory");
    }

    /**
     * Process element by entity type and user setting.
     * @param ctx
     * @param entityType
     * @return boolean
     */
    protected boolean isProcessElement(Properties ctx, String entityType) {
		if (PO.ENTITYTYPE_Dictionary.equals(entityType)
				|| "EE01".equals(entityType)
				|| "EE02".equals(entityType)
				|| "EE04".equals(entityType)
				|| "EE05".equals(entityType)) {
    		return "Y".equalsIgnoreCase(getUpdateMode(ctx));
    	} else {
    		return true;
    	}
    }

    /**
     * return null for empty string ("").
     * @param element
     * @param qName
     * @return string value
     */
    protected String getStringValue(Element element, String qName) {
    	return getStringValue(element, qName, null);
    }

    /**
     * return null for empty string ("").
     * @param element
     * @param qName
     * @return string value
     */
    protected String getStringValue(Element element, String qName, List<String> excludes) {
    	if (element == null) return null;
    	if (qName == null) return null;
    	Element propertyElement = element.properties.get(qName);
    	if (propertyElement == null || propertyElement.contents == null) return null;
    	String s = propertyElement.contents.toString();

    	if (s != null && s.trim().length() > 0 && excludes != null) {
    		excludes.add(qName);
    	}
    	return ((s == null || s.trim().length() == 0) ? null : s.trim());
    }

    /**
     * @param element
     * @param qName
     * @param defaultValue
     * @return boolean
     */
    protected boolean getBooleanValue(Element element, String qName, boolean defaultValue) {
    	String value = element.properties.get(qName).contents.toString();
    	return value != null ? Boolean.valueOf(value).booleanValue() : defaultValue;
    }

    /**
     * @param element
     * @param qName
     * @return BigDecimal
     */
    protected BigDecimal getBigDecimal(Element element, String qName) {
    	String value = element.properties.get(qName).contents.toString();
    	return value != null ? new BigDecimal(value) : null;
    }

    /**
     * @param element
     * @param qName
     * @return int
     */
    protected int getIntValue(Element element, String qName) {
    	Element pe = element.properties.get(qName);
    	String value = pe != null ? pe.contents.toString() : null;
    	return value != null ? Integer.parseInt(value) : 0;
    }

    /**
     * Returns option - Is export-import of AD translations is needed
     * @param ctx
     * @return
     */
    protected boolean isHandleTranslations(Properties ctx) {

    	return "Y".equalsIgnoreCase(Env.getContext(ctx, "isHandleTranslations"));
    }

    /**
     *
     * @param tableName
     * @return list of column to exclude from processing
     */
    protected List<String> defaultExcludeList(String tableName) {
    	List<String> excludes = new ArrayList<String>();
    	excludes.add("ad_client_id");
    	excludes.add("created");
    	excludes.add("createdby");
    	excludes.add("updated");
    	excludes.add("updatedby");
    	return excludes;
    }

    /**
     *
     * @param element
     * @param expectedName
     * @return Parent element record id
     */
    protected Object getParentId(Element element, String expectedName) {
    	if (element.parent != null && element.parent.getElementValue().equals(expectedName) &&
    			(   (element.parent.recordId instanceof Integer && (Integer)element.parent.recordId > 0)
    			 || (element.parent.recordId instanceof String && !Util.isEmpty((String)element.parent.recordId))))
    		return element.parent.recordId;
    	else
    		return 0;
    }

    /**
     *
     * @param element
     * @param expectedName
     * @return true if parent element is defer for next round of processing
     */
    protected boolean isParentDefer(Element element, String expectedName) {
    	if (element.parent != null
    		&& (expectedName == null || element.parent.getElementValue().equals(expectedName))
    		&& element.parent.defer)
    		return true;
    	else
    		return false;
    }

    /**
     *
     * @param element
     * @param expectedName
     * @return true if parent element is being ignore
     */
    protected boolean isParentSkip(Element element, String expectedName) {
    	if (element.parent != null
    		&& (expectedName == null || element.parent.getElementValue().equals(expectedName))
    		&& element.parent.skip)
    		return true;
    	else
    		return false;
    }

    /**
     *
     * @param element
     * @param columnName
     * @return true if value of columnName is office id.
     */
    protected boolean isOfficialId(Element element, String columnName) {
    	int value = getIntValue(element, columnName);
    	if (value > 0 && value <= PackOut.MAX_OFFICIAL_ID)
    		return true;
    	else
    		return false;
    }

    /**
     *
     * @param handler
     * @param qName
     * @param text
     * @throws SAXException
     */
    protected void addTextProperty(TransformerHandler handler, String qName, String text) throws SAXException {
    	AttributesImpl atts = new AttributesImpl();
    	atts.addAttribute("", "", qName, "reference", "property");
		handler.startElement("", "", qName, atts);
		append(handler, text);
		handler.endElement("", "", qName);
	}

    /**
     *
     * @param document
     * @param str
     * @throws SAXException
     */
    protected void append(TransformerHandler document, String str) throws SAXException
	{
		char[] contents = str != null ? str.toCharArray() : new char[0];
		document.characters(contents,0,contents.length);
	}

    /**
     * Find po by uuid or id
     * @param <T>
     * @param ctx
     * @param element
     * @return T
     */
    protected <T extends PO> T findPO(PIPOContext ctx, Element element) {
    	return POFinder.findPO(ctx, element);    			
    }

	protected boolean hasUUIDKey(PIPOContext ctx, Element element) {
    	String tableName = element.getElementValue();
    	String uuidColumn = PO.getUUIDColumnName(tableName);
    	String uuid = null;
    	if (element.properties.containsKey(uuidColumn)) {
    		uuid = element.properties.get(uuidColumn).contents.toString();
    	}
    	return (uuid != null && uuid.trim().length() <= 36);
    }

    protected String getUUIDKey(PIPOContext ctx, Element element) {
    	String tableName = element.getElementValue();
    	String uuidColumn = PO.getUUIDColumnName(tableName);
    	if (element.properties.containsKey(uuidColumn)) {
    		String uuid = element.properties.get(uuidColumn).contents.toString();
    		if (uuid != null && uuid.trim().length() <= 36)
    			return uuid.trim();
    	}
    	return null;
    }
    	
    /**
     *
     * @param atts
     * @param typeName
     */
    protected void addTypeName(AttributesImpl atts, String typeName) {
    	atts.addAttribute("", "", "type", "CDATA", typeName);
    }
    
    protected void verifyPackOutRequirement(PO po) {
    	String uidColumn = po.getUUIDColumnName();
    	String[] keys = po.get_KeyColumns();
    	if (Util.isEmpty((String)po.get_Value(uidColumn)) && (keys == null || keys.length != 1 || po.get_ID() > MTable.MAX_OFFICIAL_ID)) {
			throw new IllegalStateException("2Pack doesn't work with record without official Id and UUID -> " + po.getUUIDColumnName());
		}
    }

	protected boolean isPackOutElement(PIPOContext ctx, PO element) {
		if (ctx.packOut.getFromDate() != null) {
			if (element.getUpdated().compareTo(ctx.packOut.getFromDate()) < 0) {
				return false;
			}
		}
		if (!ctx.packOut.isExportDictionaryEntity() && element.get_ColumnIndex("EntityType") >= 0) {
			Object entityType = element.get_Value("EntityType");
			if (PO.ENTITYTYPE_Dictionary.equals(entityType)
				|| "EE01".equals(entityType)
				|| "EE02".equals(entityType)
				|| "EE04".equals(entityType)
				|| "EE05".equals(entityType)) {
				return false;
			}
		}
		return true;
	}        
}