Metacat

/**

 *  '$RCSfile$'

 *    Purpose: A Class that handles scheduling workflow jobs 

 *  Copyright: 2009 Regents of the University of California and the

 *             National Center for Ecological Analysis and Synthesis

 *    Authors: Michael Daigle

 * 

 *   '$Author: daigle $'

 *     '$Date: 2009-03-25 13:41:15 -0800 (Wed, 25 Mar 2009) $'

 * '$Revision: 4861 $'

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License as published by

 * the Free Software Foundation; either version 2 of the License, or

 * (at your option) any later version.

 *

 * 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

 */

package edu.ucsb.nceas.metacat.workflow;

import java.io.IOException;

import java.util.Calendar;

import java.util.Hashtable;

import java.util.HashMap;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import javax.servlet.ServletException;

import org.apache.log4j.Logger;

import edu.ucsb.nceas.metacat.MetaCatServlet;

import edu.ucsb.nceas.metacat.scheduler.BaseScheduler;

import edu.ucsb.nceas.metacat.scheduler.ScheduledJobAccess;

import edu.ucsb.nceas.metacat.scheduler.ScheduledJobDAO;

import edu.ucsb.nceas.metacat.scheduler.ScheduledJobParamDAO;

import edu.ucsb.nceas.metacat.scheduler.SchedulerService;

import edu.ucsb.nceas.metacat.scheduler.MetacatSchedulerException;

import edu.ucsb.nceas.metacat.shared.AccessException;

import edu.ucsb.nceas.metacat.shared.ServiceException;

import edu.ucsb.nceas.metacat.util.ErrorSendingErrorException;

import edu.ucsb.nceas.metacat.util.ResponseUtil;

import edu.ucsb.nceas.metacat.util.RequestUtil;

import edu.ucsb.nceas.utilities.DateUtil;

import edu.ucsb.nceas.utilities.UtilException;

/**

 * @author daigle

 *

 */

/**

 * @author daigle

 *

 */

public class WorkflowScheduler extends BaseScheduler {

	private static WorkflowScheduler workflowScheduler = null;

	private static Logger logMetacat = Logger.getLogger(WorkflowScheduler.class);

	private static String WORKFLOW_JOB_GROUP = "workflow";

	private static String WORKFLOW_JOB_CLASS = "edu.ucsb.nceas.metacat.workflow.WorkflowJob";

	/**

	 * private constructor since this is a singleton

	 */

	private WorkflowScheduler()  {}

	/**

	 * Get the single instance of SchedulerService.

	 * 

	 * @return the single instance of SchedulerService

	 */

	public static WorkflowScheduler getInstance() {

		if (workflowScheduler == null) {

			workflowScheduler = new WorkflowScheduler();

		}

		return workflowScheduler;

	}

	/**

	 * Scheduling a workflow

	 * 

	 * @param request

	 *            the servlet request object

	 * @param response

	 *            the servlet response object

	 * @param params

	 *            the request parameters

	 * @param username

	 *            the user

	 * @param groups

	 *            the user's group

	 */

	public void scheduleJob(HttpServletRequest request, HttpServletResponse response, 

			Hashtable<String, String[]> params, String username,

			String[] groups) throws MetacatSchedulerException {

		String delays[] = params.get("delay");

		String startTimes[] = params.get("starttime");

		String endTimes[] = params.get("endtime");

		HashMap<String, String> jobParams = new HashMap<String, String>();

		Calendar startCal = null;

		Calendar endCal = null;

		try {

			SchedulerService schedulerService = SchedulerService.getInstance();

			// get start time or delay.  Start time takes precedence if both exist.

			if (startTimes != null && startTimes.length > 0) {

				startCal = DateUtil.humanReadableToCalendar(startTimes[0], "MM/dd/yyyy HH:mm:ss");

			} else if (delays != null && delays.length > 0) {

				startCal = schedulerService.getStartDateFromDelay(delays[0]);

			} else {

				// if delay and starttime were not provided, set date to now.

				startCal = Calendar.getInstance();

			}

			// get end time.  null is fine.

			if (endTimes != null && endTimes.length > 0) {

				endCal = DateUtil.humanReadableToCalendar(endTimes[0], "MM/dd/yyyy HH:mm:ss");

			} 

			// interval value must exist

			String intervalValues[] = params.get("intervalvalue");

			if (intervalValues == null || intervalValues.length == 0) {

				throw new MetacatSchedulerException("WorkflowScheduler.scheduleJob - intervalvalue field must be populated "

								+ "in scheduler parameters when scheduling job.");

			}

			String intervalStrValue = intervalValues[0];

			int intervalValue = Integer.parseInt(intervalStrValue);

			// interval unit must exist

			String intervalUnits[] = params.get("intervalunit");

			if (intervalUnits == null || intervalUnits.length == 0) {

				throw new MetacatSchedulerException("WorkflowScheduler.scheduleJob - intervalunit field must be populated "

								+ "in scheduler parameters when scheduling job.");

			}

			String intervalUnit = intervalUnits[0];

			// workflow id must exist.  Add to job params

			String workflowids[] = params.get("workflowid");

			if (workflowids == null || workflowids.length == 0) {

				throw new MetacatSchedulerException("WorkflowScheduler.scheduleJob - workflowid field must be populated "

								+ "in scheduler parameters when scheduling job.");

			}

			jobParams.put("workflowid", workflowids[0]);

			// kar id must exist.  Add to job params

			String karids[] = params.get("karid");

			if (karids == null || karids.length == 0) {

				throw new MetacatSchedulerException("WorkflowScheduler.scheduleJob - karid field must be populated "

								+ "in scheduler parameters when scheduling job.");

			}

			jobParams.put("karid", karids[0]);

			// workflow name unit must exist.  Add to job params

			String workflownames[] = params.get("workflowname");

			if (workflownames == null || workflownames.length == 0) {

				throw new MetacatSchedulerException("WorkflowScheduler.scheduleJob - workflowname field must be populated "

								+ "in scheduler parameters when scheduling job.");

			}

			jobParams.put("workflowname", workflownames[0]);

			String jobName = WORKFLOW_JOB_GROUP

					+ Calendar.getInstance().getTimeInMillis();

			// Schedule the job

			String xmlResult = schedulerService.scheduleJob(jobName, startCal, endCal, intervalValue, intervalUnit,

					WORKFLOW_JOB_CLASS, WORKFLOW_JOB_GROUP, jobParams, username, groups);

			// if there is a forwardto param on the request, then send the user to the page

			// referenced in that param, otherwise, just send the xml back.

			String forwardtos[] = params.get("forwardto");

			String forwardto = null;

			if (forwardtos != null && forwardtos.length > 0) {

				forwardto = forwardtos[0];

			}

			if (forwardto != null) {

				String qformats[] = params.get("qformat");

				String qformat = null;

				if (qformats != null && qformats.length > 0) {

					qformat = qformats[0];

				}

				String destination = "/style/skins/" + qformat + "/" + forwardto

					+ "?workflowid=" + jobParams.get("workflowid") 

					+ "&karid=" + jobParams.get("karid");			

				RequestUtil.forwardRequest(request, response, destination);

			} else {

				ResponseUtil.sendSuccessXML(response, xmlResult);

			}

		} catch (UtilException ue) {

			throw new MetacatSchedulerException("WorkflowScheduler.scheduleJob - Utility issue when scheduling job: " + ue.getMessage());

		} catch (ServiceException se) {

			throw new MetacatSchedulerException("WorkflowScheduler.scheduleJob - Service issue when scheduling job", se);

		} catch (IOException ioe) {

			throw new MetacatSchedulerException("WorkflowScheduler.scheduleJob - I/O issue when scheduling job: " + ioe.getMessage());

		} catch (ServletException se) {

			throw new MetacatSchedulerException("WorkflowScheduler.scheduleJob - Servlet issue when scheduling job: " + se.getMessage());

		} catch (ErrorSendingErrorException esee) {

			throw new MetacatSchedulerException("WorkflowScheduler.scheduleJob - Issue sending error when scheduling job: " + esee.getMessage());			

		}

	}

	/**

	 * Unschedule a job

	 * 

	 * @param request

	 *            the servlet request object

	 * @param response

	 *            the servlet response object

	 * @param params

	 *            the request parameters

	 * @param username

	 *            the user

	 * @param groups

	 *            the user's group

	 */

	public void unScheduleJob(HttpServletRequest request, HttpServletResponse response,

			Hashtable<String, String[]> params, String username, String[] groups)

			throws MetacatSchedulerException {

		try {

			// workflow job id must exist

			String jobNames[] = params.get("workflowjobid");

			if (jobNames == null || jobNames.length == 0) {

				throw new MetacatSchedulerException("SchedulerService.unScheduleJob - workflowjobid " 

						+ "field must be populated in scheduler parameters when unscheduling job.");

			}

			String jobName = jobNames[0];

			// unschedule the job

			SchedulerService schedulerService = SchedulerService.getInstance();

			String xmlResult = schedulerService.unScheduleJob(jobName, username, groups);

			String forwardtos[] = params.get("forwardto");

			String forwardto = null;

			if (forwardtos != null && forwardtos.length > 0) {

				forwardto = forwardtos[0];

			}

			// if there is a forwardto param on the request, then send the user to the page

			// referenced in that param, otherwise, just send the xml back.

			if (forwardto != null) {

				String qformats[] = params.get("qformat");

				String qformat = null;

				if (qformats != null && qformats.length > 0) {

					qformat = qformats[0];

				}

				ScheduledJobAccess jobAccess = new ScheduledJobAccess();

				ScheduledJobDAO jobDAO = jobAccess.getJobByName(jobName);

				// we need to include the workflow id in the forward url

				ScheduledJobParamDAO workflowIdJobParamDAO = jobDAO.getJobParam("workflowid");

				if (workflowIdJobParamDAO == null) {

					throw new MetacatSchedulerException("WorkflowScheduler.unScheduleJob - could not find workflow " 

							+ "id when unscheduling job: " + jobName);

				}	

				// we need to include the workflow id in the forward url

				ScheduledJobParamDAO karJobParamDAO = jobDAO.getJobParam("karid");

				if (karJobParamDAO == null) {

					throw new MetacatSchedulerException("WorkflowScheduler.unScheduleJob - could not find kar " 

							+ "id when unscheduling job: " + jobName);

				}

				// we need to include the workflow id in the url

				ScheduledJobParamDAO workflowNameJobParamDAO = jobDAO.getJobParam("workflowname");

				if (workflowNameJobParamDAO == null) {

					throw new MetacatSchedulerException("WorkflowScheduler.unScheduleJob - could not find workflow " 

							+ "name when unscheduling job: " + jobName);

				}

				String destination = "/style/skins/" + qformat + "/" + forwardto

					+ "?workflowid=" + workflowIdJobParamDAO.getValue() 

					+ "&karid=" + karJobParamDAO.getValue()

					+ "&workflowname=" + workflowNameJobParamDAO.getValue();

				RequestUtil.forwardRequest(request, response, destination.toString());

			} else {

				ResponseUtil.sendSuccessXML(response, xmlResult);

			}

			ResponseUtil.sendSuccessXML(response, xmlResult);

		} catch (ServiceException se) {

			throw new MetacatSchedulerException(

					"WorkflowScheduler.unScheduleJob - Service issue unscheduling job",

					se);

		} catch (Exception e) {

			throw new MetacatSchedulerException(

					"WorkflowScheduler.unScheduleJob - Generic issue unscheduling job: "

							+ e.getMessage());

		}

	}

	/**

	 * reschedule job

	 * 

	 * @param request

	 *            the servlet request object

	 * @param response

	 *            the servlet response object

	 * @param params

	 *            the request parameters

	 * @param username

	 *            the user

	 * @param groups

	 *            the user's group

	 */

	public void reScheduleJob(HttpServletRequest request, HttpServletResponse response, 

			Hashtable<String, String[]> params, String username,

			String[] groups) throws MetacatSchedulerException {

		try {

			// workflow job id must exist

			String jobNames[] = params.get("workflowjobid");	

			if (jobNames == null || jobNames.length == 0) {

				throw new MetacatSchedulerException("WorkflowScheduler.reScheduleJob - workflowjobid field must be populated "

						+ "in scheduler parameters when rescheduling job.");

			}			

			String jobName = jobNames[0];

			ScheduledJobAccess jobAccess = new ScheduledJobAccess();

			ScheduledJobDAO jobDAO = jobAccess.getJobByName(jobName);

			// reschedule the job

			SchedulerService schedulerService = SchedulerService.getInstance();

			String result = schedulerService.rescheduleJob(jobDAO, username, groups);

			// if there is a forwardto param on the request, then send the user to the page

			// referenced in that param, otherwise, just send the xml back.

			String forwardtos[] = params.get("forwardto");

			String forwardto = null;

			if (forwardtos != null && forwardtos.length > 0) {

				forwardto = forwardtos[0];

			}

			if (forwardto != null) {

				String qformats[] = params.get("qformat");

				String qformat = null;

				if (qformats != null && qformats.length > 0) {

					qformat = qformats[0];

				}

				// we need to include the workflow id in the url

				ScheduledJobParamDAO workflowIdJobParamDAO = jobDAO.getAllJobParams().get("workflowid");

				if (workflowIdJobParamDAO == null) {

					throw new MetacatSchedulerException("WorkflowScheduler.reScheduleJob - could not find workflow " 

							+ "id when deleting job: " + jobName);

				}

				// we need to include the workflow id in the url

				ScheduledJobParamDAO karJobParamDAO = jobDAO.getJobParam("karid");

				if (karJobParamDAO == null) {

					throw new MetacatSchedulerException("WorkflowScheduler.reScheduleJob - could not find kar " 

							+ "id when deleting job: " + jobName);

				}

				// we need to include the workflow id in the url

				ScheduledJobParamDAO workflowNameJobParamDAO = jobDAO.getJobParam("workflowname");

				if (workflowNameJobParamDAO == null) {

					throw new MetacatSchedulerException("WorkflowScheduler.reScheduleJob - could not find workflow " 

							+ "name when deleting job: " + jobName);

				}

				String destination = "/style/skins/" + qformat + "/" + forwardto

					+ "?workflowid=" + workflowIdJobParamDAO.getValue()	

					+ "&karid=" + karJobParamDAO.getValue()

					+ "&workflowname=" + workflowNameJobParamDAO.getValue();

				RequestUtil.forwardRequest(request, response, destination);

			} else {

				ResponseUtil.sendSuccessXML(response, result);

			}

		} catch (AccessException ae) {

			throw new MetacatSchedulerException("WorkflowScheduler.scheduleJob - DB access issue when scheduling job  : ", ae);

		} catch (ServiceException se) {

			throw new MetacatSchedulerException("WorkflowScheduler.scheduleJob - Service issue scheduling job", se);

		} catch (IOException ioe) {

			throw new MetacatSchedulerException("WorkflowScheduler.scheduleJob - I/O issue scheduling job: " + ioe.getMessage());

		} catch (ServletException se) {

			throw new MetacatSchedulerException("WorkflowScheduler.scheduleJob - Servlet issue scheduling job: " + se.getMessage());

		} catch (ErrorSendingErrorException esee) {

			throw new MetacatSchedulerException("WorkflowScheduler.scheduleJob - Issue sending erro when scheduling job: " + esee.getMessage());			

		}

	}

	/**

	 * delete job - to be implemented

	 */

	public void deleteJob(HttpServletRequest request, HttpServletResponse response, 

			Hashtable<String, String[]> params, String username, String[] groups) throws MetacatSchedulerException {

		 try {

		// workflow job id must exist

		String jobNames[] = params.get("workflowjobid");	

		if (jobNames == null || jobNames.length == 0) {

			throw new MetacatSchedulerException("WorkflowScheduler.deleteJob - workflowjobid field must be populated "

					+ "in scheduler parameters when deleting job.");

		}			

		String jobName = jobNames[0];

		ScheduledJobAccess jobAccess = new ScheduledJobAccess();

		ScheduledJobDAO jobDAO = jobAccess.getJobByName(jobName);

		// delete the job

		SchedulerService schedulerService = SchedulerService.getInstance();

		String result = schedulerService.deleteJob(jobDAO, username, groups);

		// if there is a forwardto param on the request, then send the user to the page

		// referenced in that param, otherwise, just send the xml back.

		String forwardtos[] = params.get("forwardto");

		String forwardto = null;

		if (forwardtos != null && forwardtos.length > 0) {

			forwardto = forwardtos[0];

		}

		if (forwardto != null) {

			String qformats[] = params.get("qformat");

			String qformat = null;

			if (qformats != null && qformats.length > 0) {

				qformat = qformats[0];

			}

			// we need to include the workflow id in the url

			ScheduledJobParamDAO workflowIdJobParamDAO = jobDAO.getAllJobParams().get("workflowid");

			if (workflowIdJobParamDAO == null) {

				throw new MetacatSchedulerException("WorkflowScheduler.deleteJob - could not find workflow " 

						+ "id when deleting job: " + jobName);

			}

			// we need to include the workflow id in the url

			ScheduledJobParamDAO karJobParamDAO = jobDAO.getJobParam("karid");

			if (karJobParamDAO == null) {

				throw new MetacatSchedulerException("WorkflowScheduler.deleteJob - could not find kar " 

						+ "id when deleting job: " + jobName);

			}

			// we need to include the workflow id in the url

			ScheduledJobParamDAO workflowNameJobParamDAO = jobDAO.getJobParam("workflowname");

			if (workflowNameJobParamDAO == null) {

				throw new MetacatSchedulerException("WorkflowScheduler.deleteJob - could not find workflow " 

						+ "name when deleting job: " + jobName);

			}

			String destination = "/style/skins/" + qformat + "/" + forwardto

				+ "?workflowid=" + workflowIdJobParamDAO.getValue()	

				+ "&karid=" + karJobParamDAO.getValue()

				+ "&workflowname=" + workflowNameJobParamDAO.getValue();

			RequestUtil.forwardRequest(request, response, destination);

		} else {

			ResponseUtil.sendSuccessXML(response, result);

		}

		} catch (AccessException ae) {

				throw new MetacatSchedulerException("WorkflowScheduler.deleteJob - DB access issue when deleting job  : ", ae);

		} catch (ServiceException se) {

			throw new MetacatSchedulerException("WorkflowScheduler.deleteJob - Service issue deleting job", se);

		} catch (IOException ioe) {

			throw new MetacatSchedulerException("WorkflowScheduler.deleteJob - I/O issue deleting job: " + ioe.getMessage());

		} catch (ServletException se) {

			throw new MetacatSchedulerException("WorkflowScheduler.deleteJob - Servlet issue deleting job: " + se.getMessage());

		} catch (ErrorSendingErrorException esee) {

			throw new MetacatSchedulerException("WorkflowScheduler.deleteJob - Issue sending erro when deleting job: " + esee.getMessage());			

		}

	}

	/**

	 * get job information for a given workflow in xml format

	 * 

	 * @param request

	 *            the servlet request object

	 * @param response

	 *            the servlet response object

	 * @param params

	 *            the request parameters

	 * @param username

	 *            the user

	 * @param groups

	 *            the user's group

	 */

	public void getJobs(HttpServletRequest request, HttpServletResponse response, 

			Hashtable<String, String[]> params, String username, String[] groups) throws MetacatSchedulerException {

		String workFlowId = null;

		String qformat = "";

		String workFlowIds[] = params.get("workflowid");

		if (workFlowIds != null && workFlowIds.length != 0) {

			workFlowId = workFlowIds[0];

		}

        if (params.containsKey("qformat")) {

            qformat = params.get("qformat")[0];

        }

		try {

			// get the job info in xml format

			String xmlResult = SchedulerService.getInstance().getJobsInfoXML(WORKFLOW_JOB_GROUP, "workflowid", workFlowId);

			logMetacat.debug("WorkflowScheduler.getJobs - xmlResult: " + xmlResult);

			if (qformat == null || qformat.equals(MetaCatServlet.XMLFORMAT)) {

				ResponseUtil.send(response, xmlResult);

			} else {				

				ResponseUtil.transformAndSendXML(response, xmlResult, "-//NCEAS//scheduledWorkflowResultset//EN", 

					"-//W3C//HTML//EN", qformat, params);

			}

		} catch (ServiceException se) {

			throw new MetacatSchedulerException("WorkflowScheduler.getJobs - Service issue getting jobs", se);

		} catch (Exception e) {

			throw new MetacatSchedulerException("WorkflowScheduler.getJobs - Generic issue getting jobs: " 

					+ e.getMessage());

		}		

	}	

}