/******************************************************************************
* Product: Adempiere ERP & CRM Smart Business Solution *
* Copyright (C) 1999-2006 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.apps;
import java.util.logging.Level;
import org.adempiere.util.IProcessUI;
import org.adempiere.util.ProcessUtil;
import org.compiere.model.MPInstance;
import org.compiere.model.MRule;
import org.compiere.model.MPInstance.PInstanceInfo;
import org.compiere.print.ReportCtl;
import org.compiere.process.ProcessInfo;
import org.compiere.process.ProcessInfoUtil;
import org.compiere.util.CLogger;
import org.compiere.util.Env;
import org.compiere.util.Ini;
import org.compiere.util.Msg;
import org.compiere.util.Trx;
import org.compiere.util.Util;
import org.compiere.wf.MWFProcess;
/**
* Process Controller Interface.
*
* @author Jorg Janke
* @version $Id: ProcessCtl.java,v 1.2 2006/07/30 00:51:27 jjanke Exp $
* @author Low Heng Sin
* - Added support for having description and parameter in one dialog
* - Added support to run db process remotely on server
*
* @author Teo Sarca, SC ARHIPAC SERVICE SRL
* BF [ 1757523 ] Server Processes are using Server's context
* FR [ 1807922 ] Pocess threads should have a better name
* BF [ 1960523 ] Server Process functionality not working
*/
public abstract class AbstractProcessCtl implements Runnable
{
/**
* Constructor
* @param aProcessUI
* @param WindowNo
* @param pi Process info
* @param trx Transaction
*/
public AbstractProcessCtl (IProcessUI aProcessUI, int WindowNo, ProcessInfo pi, Trx trx)
{
windowno = WindowNo;
m_processUI = aProcessUI;
m_pi = pi;
m_trx = trx;
}
/** Windowno */
private int windowno;
/** Interface to UI (null when process is running as background job, for e.g by scheduler) */
private IProcessUI m_processUI;
/** Process Info */
private ProcessInfo m_pi;
private Trx m_trx;
/** Static Logger */
private static final CLogger log = CLogger.getCLogger (AbstractProcessCtl.class);
/**
* Run this process in a new thread
*/
public void start()
{
Thread thread = new Thread(this);
// Set thread name - teo_sarca FR [ 1807922 ]
if (m_pi != null)
thread.setName(m_pi.getTitle()+"-"+m_pi.getAD_PInstance_ID());
thread.start();
}
/**
* Execute Process Instance and Lock UI.
* Calls lockUI and unlockUI if parent is a ASyncProcess
*
* - Get Process Information
* - Call Class
* - Submit SQL Procedure
* - Run SQL Procedure
*
*/
public void run ()
{
if (log.isLoggable(Level.FINE)) log.fine("AD_PInstance_ID=" + m_pi.getAD_PInstance_ID()
+ ", Record_ID=" + m_pi.getRecord_ID());
// Lock
lock();
// Get Process Information: Name, Procedure Name, ClassName, IsReport, IsDirectPrint
String ProcedureName = "";
String JasperReport = "";
int AD_ReportView_ID = 0;
int AD_Workflow_ID = 0;
boolean IsReport = false;
boolean IsDirectPrint = false;
boolean isPrintPreview = m_pi.isPrintPreview();
try
{
PInstanceInfo info = MPInstance.getPInstanceInfo(m_pi.getAD_PInstance_ID());
if (info != null)
{
m_pi.setTitle (info.name);
updateProgressWindowTitle(m_pi.getTitle());
ProcedureName = info.procedureName;
m_pi.setClassName (info.className);
m_pi.setAD_Process_ID (info.AD_Process_ID);
m_pi.setAD_Process_UU(info.AD_Process_UU);
// Report
if (info.isReport)
{
IsReport = true;
if (info.isDirectPrint && !Ini.isPropertyBool(Ini.P_PRINTPREVIEW)
&& !isPrintPreview )
IsDirectPrint = true;
}
AD_ReportView_ID = info.AD_ReportView_ID;
AD_Workflow_ID = info.AD_Workflow_ID;
//
int estimate = info.estimate;
if (estimate != 0)
{
m_pi.setEstSeconds (estimate + 1); // admin overhead
updateProgressWindowTimerEstimate(m_pi.getEstSeconds());
}
JasperReport = info.jasperReport;
}
else
log.log(Level.SEVERE, "No AD_PInstance_ID=" + m_pi.getAD_PInstance_ID());
}
catch (Throwable e)
{
m_pi.setSummary (Msg.getMsg(Env.getCtx(), "ProcessNoProcedure") + " " + e.getLocalizedMessage(), true);
unlock();
log.log(Level.SEVERE, "run", e);
return;
}
// Not Database Procedure
if (ProcedureName == null)
ProcedureName = "";
/**
* Workflow
*/
if (AD_Workflow_ID > 0)
{
MPInstance pinstance = new MPInstance(Env.getCtx(), m_pi.getAD_PInstance_ID(), null);
pinstance.setIsProcessing(true);
pinstance.saveEx();
try {
startWorkflow (AD_Workflow_ID);
String errmsg = m_pi.getSummary();
pinstance.setResult(!m_pi.isError());
pinstance.setErrorMsg(errmsg);
pinstance.setJsonData(m_pi.getJsonData());
pinstance.saveEx();
unlock();
}
finally {
pinstance.setIsProcessing(false);
pinstance.saveEx();
}
return;
}
// Clear Jasper Report class if it is set to the default Jasper report starter class
boolean isJasper = false;
if (JasperReport != null && JasperReport.trim().length() > 0) {
isJasper = true;
if (ProcessUtil.JASPER_STARTER_CLASS.equals(m_pi.getClassName())) {
m_pi.setClassName(null);
}
}
/**
* Call Process Class
*/
if (m_pi.getClassName() != null)
{
if (isJasper)
{
m_pi.setReportingProcess(true);
}
// Run Class
if (!startProcess())
{
unlock();
return;
}
// No Optional SQL procedure ... done
if (!IsReport && ProcedureName.length() == 0)
{
unlock ();
return;
}
// No Optional Report ... done
if (IsReport && AD_ReportView_ID == 0 && ! isJasper)
{
unlock ();
return;
}
}
/**
* Report submission
*/
// Optional Pre-Report DB Process
if (IsReport && ProcedureName.length() > 0)
{
m_pi.setReportingProcess(true);
if (!startDBProcess(ProcedureName))
{
unlock();
return;
}
} // Pre-Report
if (isJasper)
{
m_pi.setReportingProcess(true);
m_pi.setClassName(ProcessUtil.JASPER_STARTER_CLASS);
startProcess();
MPInstance pinstance = new MPInstance(Env.getCtx(), m_pi.getAD_PInstance_ID(), null);
if (m_pi.getReportType() != null)
pinstance.setReportType(m_pi.getReportType());
String errmsg = pinstance.getErrorMsg();
if (Util.isEmpty(errmsg, true))
errmsg = "Rows=" + String.valueOf(m_pi.getRowCount());
else
errmsg += " Rows=" + m_pi.getRowCount();
pinstance.setErrorMsg(errmsg);
pinstance.saveEx();
unlock();
return;
}
if (IsReport)
{
m_pi.setReportingProcess(true);
// Start Report -----------------------------------------------
boolean ok = ReportCtl.start(m_processUI, windowno, m_pi, IsDirectPrint);
m_pi.setSummary(Msg.getCleanMsg(Env.getCtx(), "Report"), !ok);
MPInstance pinstance = new MPInstance(Env.getCtx(), m_pi.getAD_PInstance_ID(), null);
String errmsg = pinstance.getErrorMsg();
if (Util.isEmpty(errmsg, true))
errmsg = "Rows=" + String.valueOf(m_pi.getRowCount());
else
errmsg += " Rows=" + m_pi.getRowCount();
pinstance.setErrorMsg(errmsg);
pinstance.saveEx();
unlock ();
}
/**
* Run DB Process
*/
else
{
if (!startDBProcess (ProcedureName))
{
unlock();
return;
}
// Success - getResult
ProcessInfoUtil.setSummaryFromDB(m_pi);
unlock();
}
} // run
protected abstract void updateProgressWindowTimerEstimate(int estSeconds);
protected abstract void updateProgressWindowTitle(String title);
/**
* Lock UI and show in progress dialog
*/
protected abstract void lock ();
/**
* Unlock UI and dispose in progress dialog.
*/
protected abstract void unlock ();
protected int getWindowNo()
{
return windowno;
}
protected ProcessInfo getProcessInfo()
{
return m_pi;
}
protected IProcessUI getProcessMonitor()
{
return m_processUI;
}
protected IProcessUI getParent()
{
return getProcessMonitor();
}
@Deprecated
protected boolean isServerProcess()
{
return false;
}
/**
* Start Workflow.
*
* @param AD_Workflow_ID workflow
* @return true if started
*/
private boolean startWorkflow (int AD_Workflow_ID)
{
if (log.isLoggable(Level.FINE)) log.fine(AD_Workflow_ID + " - " + m_pi);
boolean started = false;
if (m_trx != null)
m_pi.setTransactionName(m_trx.getTrxName());
MWFProcess wfProcess = ProcessUtil.startWorkFlow(Env.getCtx(), m_pi, AD_Workflow_ID);
started = wfProcess != null;
return started;
} // startWorkflow
/**
* Start Java Process Class.
* Instantiate the class implementing the interface ProcessCall.
*
* @return true if success
*/
private boolean startProcess ()
{
if (log.isLoggable(Level.FINE)) log.fine(m_pi.toString());
if (m_pi.getClassName().toLowerCase().startsWith(MRule.SCRIPT_PREFIX)) {
m_pi.setProcessUI(m_processUI);
return ProcessUtil.startScriptProcess(Env.getCtx(), m_pi, m_trx);
} else {
return ProcessUtil.startJavaProcess(Env.getCtx(), m_pi, m_trx, true, m_processUI);
}
} // startProcess
/**
* Start Database Process
* @param ProcedureName PL/SQL procedure name
* @return true if success
*/
private boolean startDBProcess (String ProcedureName)
{
// execute on this thread/connection
if (log.isLoggable(Level.FINE)) log.fine(ProcedureName + "(" + m_pi.getAD_PInstance_ID() + ")");
return ProcessUtil.startDatabaseProcedure(m_pi, ProcedureName, m_trx);
} // startDBProcess
} // ProcessCtl