/******************************************************************************
 * Product: iDempiere ERP & CRM Smart Business Solution                       *
 * Copyright (C) 1999-2012 ComPiere, 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.                     *
 * For the text or an alternative of this public license, you may reach us    *
 * ComPiere, Inc., 2620 Augustine Dr. #245, Santa Clara, CA 95054, USA        *
 * or via info@compiere.org or http://www.compiere.org/license.html           *
 *****************************************************************************/
package org.compiere.model;

import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.text.ChoiceFormat;
import java.text.DecimalFormat;
import java.text.Format;
import java.text.MessageFormat;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Properties;
import java.util.logging.Level;

import org.adempiere.base.event.EventManager;
import org.adempiere.base.event.EventProperty;
import org.compiere.util.CCache;
import org.compiere.util.CLogger;
import org.compiere.util.DB;
import org.compiere.util.Env;
import org.compiere.util.Msg;
import org.idempiere.cache.ImmutablePOCache;
import org.idempiere.cache.ImmutablePOSupport;
import org.osgi.service.event.Event;

/**
 *	Data Status Line Model
 *	
 *  @author Nicolas Micoud
 *  @version $Id: MStatusLine.java
 */
public class MStatusLine extends X_AD_StatusLine implements ImmutablePOSupport
{
	/**
	 * generated serial id
	 */
	private static final long serialVersionUID = -1542116796861052734L;

	/**	Logging								*/
	private static CLogger		s_log = CLogger.getCLogger(MStatusLine.class);
	/** Status Line Cache				*/
	private static ImmutablePOCache<String, MStatusLine> s_cache = new ImmutablePOCache<String, MStatusLine>(Table_Name, 10);
	private static CCache<String, MStatusLine[]> s_cachew = new CCache<String, MStatusLine[]>(Table_Name, Table_Name+"|MStatusLine[]", 10);

	public static final String BEFORE_PARSE_STATUS_LINE = "idempiere/statusLine/beforeParse";
	public static final String EVENT_WINDOWNO = "event.windowno";

    /**
     * UUID based Constructor
     * @param ctx  Context
     * @param AD_StatusLine_UU  UUID key
     * @param trxName Transaction
     */
    public MStatusLine(Properties ctx, String AD_StatusLine_UU, String trxName) {
        super(ctx, AD_StatusLine_UU, trxName);
    }

	/**
	 * 	Standard Constructor
	 *	@param ctx context
	 *	@param AD_StatusLine_ID
	 *	@param trxName transaction
	 */
	public MStatusLine (Properties ctx, int AD_StatusLine_ID, String trxName)
	{
		super (ctx, AD_StatusLine_ID, trxName);
	}	//	MStatusLine

	/**
	 * 	Load Constructor
	 *	@param ctx context
	 *	@param rs result set
	 *	@param trxName transaction
	 */
	public MStatusLine (Properties ctx, ResultSet rs, String trxName)
	{
		super(ctx, rs, trxName);
	}	//	MStatusLine

	/**
	 * Copy constructor
	 * @param copy
	 */
	public MStatusLine(MStatusLine copy) 
	{
		this(Env.getCtx(), copy);
	}

	/**
	 * Copy constructor
	 * @param ctx
	 * @param copy
	 */
	public MStatusLine(Properties ctx, MStatusLine copy) 
	{
		this(ctx, copy, (String) null);
	}

	/**
	 * Copy constructor
	 * @param ctx
	 * @param copy
	 * @param trxName
	 */
	public MStatusLine(Properties ctx, MStatusLine copy, String trxName) 
	{
		this(ctx, 0, trxName);
		copyPO(copy);
	}
	
	/**
	 * Get the status line defined for the window|tab|table (immutable)
	 * @param window_ID
	 * @param tab_ID
	 * @param table_ID
	 * @return first status line discovered, from particular to general, first check win+tab, then just win, then just tab
	 */
	public static MStatusLine getSL(int window_ID, int tab_ID, int table_ID) {
		StringBuilder key = new StringBuilder().append(window_ID).append("|").append(tab_ID).append("|").append(table_ID);
		MStatusLine retValue = null;
		if (s_cache.containsKey(key.toString()))
		{
			retValue = s_cache.get(key.toString());
			if (s_log.isLoggable(Level.FINEST)) s_log.finest("Cache: " + retValue);
			return retValue;
		}

		String sql = ""
				+ "SELECT slu.AD_StatusLine_ID "
				+ "FROM   AD_StatusLineUsedIn slu "
				+ "JOIN AD_StatusLine sl ON (sl.AD_StatusLine_ID = slu.AD_StatusLine_ID) "
				+ "WHERE  slu.IsActive = 'Y' "
				+ "       AND sl.IsActive = 'Y' "
				+ "       AND slu.IsStatusLine = 'Y' "
				+ "       AND slu.AD_Window_ID = ? "
				+ "       AND slu.AD_Tab_ID = ?";
		int slid = DB.getSQLValueEx(null, sql, window_ID, tab_ID);
		if (slid <= 0) {
			sql = ""
					+ "SELECT slu.AD_StatusLine_ID "
					+ "FROM   AD_StatusLineUsedIn slu "
					+ "JOIN AD_StatusLine sl ON (sl.AD_StatusLine_ID = slu.AD_StatusLine_ID) "
					+ "WHERE  slu.IsActive = 'Y' "
					+ "       AND sl.IsActive = 'Y' "
					+ "       AND slu.IsStatusLine = 'Y' "
					+ "       AND slu.AD_Window_ID = ? "
					+ "       AND slu.AD_Tab_ID IS NULL";
			slid = DB.getSQLValueEx(null, sql, window_ID);
		}
		if (slid <= 0) {
			sql = ""
					+ "SELECT slu.AD_StatusLine_ID "
					+ "FROM   AD_StatusLineUsedIn slu "
					+ "JOIN AD_StatusLine sl ON (sl.AD_StatusLine_ID = slu.AD_StatusLine_ID) "
					+ "WHERE  slu.IsActive = 'Y' "
					+ "       AND sl.IsActive = 'Y' "
					+ "       AND slu.IsStatusLine = 'Y' "
					+ "       AND slu.AD_Table_ID = ?";
			slid = DB.getSQLValueEx(null, sql, table_ID);
		}
		if (slid > 0) {
			retValue = new MStatusLine(Env.getCtx(), slid, null);
		}
		s_cache.put(key.toString(), retValue, e -> new MStatusLine(Env.getCtx(), e));
		return retValue;
	}

	/**
	 * Get the widget lines defined for the window and tab and table (immutable)
	 * @param window_ID
	 * @param tab_ID
	 * @param table_ID
	 * @return array of widget lines discovered for table or specific tab or general window
	 */
	public static MStatusLine[] getStatusLinesWidget(int window_ID, int tab_ID, int table_ID) {
		return getStatusLinesWidget(window_ID, tab_ID, table_ID, 0);
	}
	
	/**
	 * Get the widget lines defined for the window and tab and table and info window (immutable)
	 * @param window_ID
	 * @param tab_ID
	 * @param table_ID
	 * @param infoWindow_ID
	 * @return array of widget lines discovered for table or specific tab or general window or info window
	 */
	public static MStatusLine[] getStatusLinesWidget(int window_ID, int tab_ID, int table_ID, int infoWindow_ID) {
		StringBuilder key = new StringBuilder().append(window_ID).append("|").append(tab_ID).append("|").append(table_ID).append("|").append(infoWindow_ID);
		MStatusLine[] retValue = null;
		if (s_cachew.containsKey(key.toString()))
		{
			retValue = s_cachew.get(key.toString());
			if (s_log.isLoggable(Level.FINEST)) s_log.finest("Cache: " + retValue);
			return retValue;
		}

		final String sql = ""
				+ "SELECT DISTINCT slu.AD_StatusLine_ID, slu.SeqNo "
				+ "FROM   AD_StatusLineUsedIn slu "
				+ "JOIN AD_StatusLine sl ON (sl.AD_StatusLine_ID = slu.AD_StatusLine_ID) "
				+ "WHERE  slu.IsActive = 'Y' "
				+ "       AND sl.IsActive = 'Y' "
				+ "       AND slu.IsStatusLine = 'N' "
				+ "       AND (slu.AD_Table_ID = ? "
				+ "				OR (slu.AD_Window_ID=? AND slu.AD_Tab_ID=?) "
				+ "				OR (slu.AD_Window_ID=? AND slu.AD_Tab_ID IS NULL)"
				+ "				OR slu.AD_InfoWindow_ID=?) "
				+ "ORDER BY slu.SeqNo";
		int[] wlids = DB.getIDsEx(null, sql, table_ID, window_ID, tab_ID, window_ID, infoWindow_ID);
		if (wlids.length > 0) {
	        ArrayList<MStatusLine> list = new ArrayList<MStatusLine>();
	        for (int wlid : wlids) {
				MStatusLine wl = new MStatusLine(Env.getCtx(), wlid, null);
				wl.markImmutable();
				list.add(wl);
	        }
			//	Convert to array
			retValue = new MStatusLine[list.size()];
			for (int i = 0; i < retValue.length; i++)
			{
				retValue[i] = list.get(i);
			}
		}
		s_cachew.put(key.toString(), retValue);

		return retValue;
	}

	/**
	 * Parse and execute SQL statement. Combine result of execution (first row) with translated AD message.  
	 * @param windowNo
	 * @return AD message formatted output of SQL statement execution result
	 */
	public String parseLine(int windowNo) {
		Event event = EventManager.newEvent(BEFORE_PARSE_STATUS_LINE,
				new EventProperty(EventManager.EVENT_DATA, this), new EventProperty(EVENT_WINDOWNO, windowNo));
		EventManager.getInstance().sendEvent(event);

		String sql = getSQLStatement();

		if (sql.indexOf("@") >= 0) {
			sql = Env.parseContext(Env.getCtx(), windowNo, sql, false, false);
			if (sql.length() == 0) {
				return null;
			}
		}

		MessageFormat mf = null;
		String msgValue = getAD_Message().getValue();
		try
		{
			mf = new MessageFormat(Msg.getMsg(Env.getAD_Language(getCtx()), msgValue), Env.getLanguage(getCtx()).getLocale());
		}
		catch (Exception e)
		{
			log.log(Level.SEVERE, msgValue + "=" + Msg.getMsg(Env.getAD_Language(getCtx()), msgValue), e);
		}
		if (mf == null)
			return null;

		Format[] fmts = mf.getFormatsByArgumentIndex();
		Object[] arguments = new Object[fmts.length];
		boolean filled = false;

		PreparedStatement stmt = null;
		ResultSet rs = null;
		try
		{
			stmt = DB.prepareStatement(sql, null);
			rs = stmt.executeQuery();
			if (rs.next())
			{
				for (int idx = 0; idx < fmts.length; idx++) {
					Format fmt = fmts[idx];
					Object obj;
					if (fmt instanceof DecimalFormat || fmt instanceof ChoiceFormat) {
						obj = rs.getBigDecimal(idx+1);
					} else if (fmt instanceof SimpleDateFormat) {
						obj = rs.getTimestamp(idx+1);
					} else {
						obj = rs.getString(idx+1);
					}
					arguments[idx] = obj;
				}
				filled = true;
			}
		}
		catch (SQLException e)
		{
			log.log(Level.WARNING, sql, e);
		}
		finally
		{
			DB.close(rs, stmt);
			rs = null; stmt = null;
		}
		if (filled)
			return mf.format(arguments);
		return null;
	}

	@Override
	public MStatusLine markImmutable() {
		if (is_Immutable())
			return this;

		makeImmutable();
		return this;
	}

}	//	MStatusLine
