<?php
/**
* @version	$Id: scheduled_task_manager.php 16188 2015-05-19 00:37:18Z alex $
* @package	In-Portal
* @copyright	Copyright (C) 1997 - 2010 Intechnic. All rights reserved.
* @license      GNU/GPL
* In-Portal is Open Source software.
* This means that this software may have been modified pursuant
* the GNU General Public License, and as distributed it includes
* or is derivative of works licensed under the GNU General Public License
* or other free or open source software licenses.
* See http://www.in-portal.org/license for copyright notices and details.
*/

defined('FULL_PATH') or die('restricted access!');

class kScheduledTaskManager extends kBase implements kiCacheable {

	/**
	 * Events, that should be run after parser initialization
	 *
	 * @var Array
	 * @access protected
	 */
	protected $tasks = Array ();

	/**
	 * Sets data from cache to object
	 *
	 * @param Array $data
	 * @access public
	 */
	public function setFromCache(&$data)
	{
		$this->tasks = $data['EventManager.scheduledTasks'];
	}

	/**
	 * Gets object data for caching
	 *
	 * @return Array
	 * @access public
	 */
	public function getToCache()
	{
		return Array (
			'EventManager.scheduledTasks' => $this->tasks,
		);
	}

	/**
	 * Returns information about registered scheduled tasks
	 *
	 * @param bool $from_cache
	 * @return Array
	 * @access public
	 */
	public function getAll($from_cache = false)
	{
		static $scheduled_tasks = null;

		if ( $from_cache ) {
			return $this->tasks;
		}

		if ( !isset($scheduled_tasks) ) {
			$timeout_clause = 'LastRunStatus = ' . ScheduledTask::LAST_RUN_RUNNING . ' AND Timeout > 0 AND ' . time() . ' - LastRunOn > Timeout';

			$sql = 'SELECT *
					FROM ' . $this->Application->getUnitConfig('scheduled-task')->getTableName() . '
					WHERE (Status = ' . STATUS_ACTIVE . ') AND ((LastRunStatus != ' . ScheduledTask::LAST_RUN_RUNNING . ') OR (' . $timeout_clause . '))';
			$scheduled_tasks = $this->Conn->Query($sql, 'Name');
		}

		return $scheduled_tasks;
	}

	/**
	 * Add new scheduled task
	 *
	 * @param string $short_name name to be used to store last maintenance run info
	 * @param string $event_string
	 * @param int $run_schedule run schedule like for Cron
	 * @param string $module
	 * @param int $status
	 * @access public
	 */
	public function add($short_name, $event_string, $run_schedule, $module, $status = STATUS_ACTIVE)
	{
		$this->tasks[$short_name] = Array (
			'Event' => $event_string, 'RunSchedule' => $run_schedule, 'Module' => $module, 'Status' => $status
		);
	}

	/**
	 * Run registered scheduled tasks with specified event type
	 *
	 * @param bool $from_cron
	 * @access public
	 */
	public function runAll($from_cron = false)
	{
		if ( defined('IS_INSTALL') ) {
			return ;
		}

		$use_cron = $this->Application->ConfigValue('RunScheduledTasksFromCron');

		if ( ($use_cron && !$from_cron) || (!$use_cron && $from_cron) ) {
			// match execution place with one, set in config
			return ;
		}

		ignore_user_abort(true);
		set_time_limit(0);

		$events_source = $this->getAll();

		$user_id = $this->Application->RecallVar('user_id');
		$this->Application->StoreVar('user_id', USER_ROOT, true); // to prevent permission checking inside events, true for optional storage

		$site_helper = $this->Application->recallObject('SiteHelper');
		/* @var $site_helper SiteHelper */

		$site_domain_id = $site_helper->getDomainByName('DomainName', DOMAIN);

		foreach ($events_source as $short_name => $event_data) {
			if ( $site_domain_id && $event_data['SiteDomainLimitation'] != '' ) {
				$site_domains = explode('|', substr($event_data['SiteDomainLimitation'], 1, -1));

				if ( !in_array($site_domain_id, $site_domains) ) {
					// scheduled task isn't allowed on this site domain
					continue;
				}
			}

			// remember LastTimeoutOn only for events that are still running and will be reset
			if ( $event_data['LastRunStatus'] == ScheduledTask::LAST_RUN_RUNNING ) {
				$this->update($event_data, Array ('LastTimeoutOn' => time()));
			}

			$next_run = (int)$event_data['NextRunOn'];

			if ($next_run && ($next_run > time())) {
				continue;
			}

			$this->run($event_data);
		}

		$this->Application->StoreVar('user_id', $user_id, $user_id == USER_GUEST);
	}

	/**
	 * Runs scheduled task based on given data
	 *
	 * @param Array $scheduled_task_data
	 * @return bool
	 * @access public
	 */
	public function run($scheduled_task_data)
	{
		$event = new kEvent($scheduled_task_data['Event']);

		if ( !$this->Application->prefixRegistred($event->Prefix) ) {
			// don't process scheduled tasks, left from disabled modules
			return false;
		}

		$cron_helper = $this->Application->recallObject('kCronHelper');
		/* @var $cron_helper kCronHelper */

		$start_time = time();

		// remember, when scheduled task execution started
		$fields_hash = Array (
			'LastRunOn' => $start_time,
			'LastRunStatus' => ScheduledTask::LAST_RUN_RUNNING,
			'NextRunOn' => $cron_helper->getMatch($scheduled_task_data['RunSchedule'], $start_time),
		);

		$this->update($scheduled_task_data, $fields_hash);

		$scheduled_task = $this->Application->recallObject('scheduled-task', null, Array ('skip_autoload' => true));
		/* @var $scheduled_task kDBItem */

		$scheduled_task->LoadFromHash($scheduled_task_data);

		$event->redirect = false;

		// The fake MasterEvent is needed so that $event can access $scheduled_task!
		$event->MasterEvent = new kEvent('scheduled-task:OnRun');
		$this->Application->HandleEvent($event);

		$now = time();
		$next_run = $cron_helper->getMatch($scheduled_task_data['RunSchedule'], $start_time);

		while ($next_run < $now) {
			// in case event execution took longer, then RunSchedule (don't use <=, because RunSchedule can be 0)
			$next_run = $cron_helper->getMatch($scheduled_task_data['RunSchedule'], $next_run);
		}

		// remember, when scheduled task execution ended
		$fields_hash = Array (
			'NextRunOn' => $next_run,
			'RunTime' => $now - $start_time,
			'LastRunStatus' => $event->status == kEvent::erSUCCESS ? ScheduledTask::LAST_RUN_SUCCEEDED : ScheduledTask::LAST_RUN_FAILED,
		);

		$this->update($scheduled_task_data, $fields_hash);

		return true;
	}

	/**
	 * Updates scheduled task record with latest changes about it's invocation progress
	 *
	 * @param Array $scheduled_task_data
	 * @param Array $fields_hash
	 * @return void
	 * @access protected
	 */
	protected function update(&$scheduled_task_data, $fields_hash)
	{
		$this->Conn->doUpdate(
			$fields_hash,
			$this->Application->getUnitConfig('scheduled-task')->getTableName(),
			'Name = ' . $this->Conn->qstr($scheduled_task_data['Name'])
		);

		$scheduled_task_data = array_merge($scheduled_task_data, $fields_hash);
	}
}