2nd draft

application/libraries/LongRunTaskLib.php

@@ -2,14 +2,20 @@
 
 if (!defined('BASEPATH')) exit('No direct script access allowed');
 
+require_once 'JobsQueueLib.php';
+
 /**
  * Library that contains all the needed functionalities to operate with the Long Run Tasks
  */
 class LongRunTaskLib extends JobsQueueLib
 {
+	// Config names
 	const CFG_LRT_MAX_NUMBER_SYSTEM = 'lrt_max_number_system';
 	const CFG_LRT_TYPES = 'lrt_types';
 
+	// LRT object properties
+	const PROPERTY_UID = 'uid';
+
 	/**
 	 * Constructor
 	 */
@@ -22,7 +28,7 @@ class LongRunTaskLib extends JobsQueueLib
 	}
 
 	//------------------------------------------------------------------------------------------------------------------
-	// Public methods
+	// Public methods used by the LongRunTaskExecJob
 
 	/**
 	 * Get the oldest added LRTs to the queue having status = new
@@ -32,35 +38,109 @@ class LongRunTaskLib extends JobsQueueLib
 	public function getLRTs()
 	{
 		// Get all the running LRTs
-		$runningLrtsResult = $this->getJobsByTypeStatus($this->_ci->config->item(self::CFG_LRT_TYPES)), JobsQueueLib::STATUS_RUNNING);
+		$runningLrtsResult = $this->getJobsByTypeStatus($this->_ci->config->item(self::CFG_LRT_TYPES), JobsQueueLib::STATUS_RUNNING);
 
 		if (isError($runningLrtsResult)) return $runningLrtsResult;
 
 		// The number of the currently running LRTs - the maximum LRTs for the system
-		$max_number_of_lrts = $this->_ci->config->item(self::CFG_LRT_MAX_NUMBER_SYSTEM)) - count(getData($runningLrtsResult));
+		$max_number_of_lrts = $this->_ci->config->item(self::CFG_LRT_MAX_NUMBER_SYSTEM) - count(getData($runningLrtsResult));
 
 		// Get the oldest LRTs added to the queue
-		return $this->getOldestJobs($this->_ci->config->item(self::CFG_LRT_TYPES)), $max_number_of_lrts);
+		return $this->getOldestJobs($this->_ci->config->item(self::CFG_LRT_TYPES), $max_number_of_lrts);
 	}
 
 	/**
-	 *
+	 * 
 	 */
-	public function addNewLRTsToQueue($type, $lrts)
+	public function executeLrt($lrt)
 	{
-		return $this->addNewJobsToQueue($type, $lrts);
+		// If does _not_ exist a LRT implementation for this LRT type, then return an error
+		if ((include_once 'application/controllers/lrts/'.$lrt->{self::PROPERTY_TYPE}.'.php') !== true)
+		{
+			return error('The required LRT implementation has not been found');
+		}
+
+		// Execute the LRT implementation (a CI controller from CLI) providing as parameter the jobid
+		exec(
+			// Command
+			'/usr/bin/php '.APPPATH.'../index.ci.php lrts/'.$lrt->{self::PROPERTY_TYPE}.'/run '.$lrt->{self::PROPERTY_JOBID}.' &',
+			$output, // Here goes the output from the standard output and error
+			$return_var // Status of the command once executed (== 0 success, !=0 error)
+		);
 	}
 
 	//------------------------------------------------------------------------------------------------------------------
-	// Public static methods
+	// Public methods used by the front end applications (standard controllers/end points, ex. controllers/system/LRTTest.php)
 
 	/**
-	 * Utility method to generate a LTR with the given parameters and return it inside an array
-	 * ready to be used by addNewLRTsToQueue
+	 * Add a single LRT to the queue
 	 */
-	public static function generateLtrs($status, $input)
+	public function addNewLrtToQueue($type, $uid, $lrtInput)
 	{
-		return self::generateJobs($status, $input);
+		// Checks parameters
+		if (isEmptyString($type)) return error('The provided type parameter is not a valid string');
+		if (isEmptyString($uid)) return error('The provided uid parameter is not a valid string');
+
+		// Convert input to JSON and check it
+		$jsonLrtInput = json_encode($lrtInput);
+		if ($jsonLrtInput == null) return error('The provided LRT input is not valid');
+
+		// Get all the job types
+		$dbResult = $this->_ci->JobTypesModel->load();
+		if (isError($dbResult)) return $dbResult;
+		$types = getData($dbResult);
+
+		// If the given type is not present in database
+		if (!$this->_checkJobType($type, $types)) return error('The provided type parameter is not valid');
+
+		// Get all the job statuses
+		$dbResult = $this->_ci->JobStatusesModel->load();
+		if (isError($dbResult)) return $dbResult;
+		$statuses = getData($dbResult);
+
+		// Create an object that represent the new tbl_jobsqueue record with the provided input
+		$lrt = $this->generateJobs(self::STATUS_NEW, $jsonLrtInput)[0];
+
+		// What you asked is what you get!
+		$lrt->{self::PROPERTY_TYPE} = $type;
+		$lrt->{self::PROPERTY_UID} = $uid;
+
+		// Try to insert the single lrt into database
+		$dbNewLrtResult = $this->_ci->JobsQueueModel->insert($lrt);
+
+		// If an error occurred during while inserting in database
+		if (isError($dbNewLrtResult)) return $dbNewLrtResult;
+
+		return success('LRT added to the queue');
+	}
+
+	//------------------------------------------------------------------------------------------------------------------
+	// Public methods used by the LRT implementation (controllers/ltrs/*, ex. controllers/ltrs/LRTDummy)
+
+	/**
+	 * Return a single record from the 
+	 */
+	public function getLrt($jobid)
+	{
+		$this->_ci->JobsQueueModel->resetQuery();
+
+		return $this->_ci->JobsQueueModel->loadWhere(array('jobid' => $jobid));
+	}
+
+	/**
+	 * 
+	 */
+	public function setProgress($jobid, $progress)
+	{
+		return $this->_ci->JobsQueueModel->update($jobid, array('progress' => $progress));
+	}
+
+	/**
+	 * 
+	 */
+	public function setOutuput($jobid, $output)
+	{
+		return $this->_ci->JobsQueueModel->update($jobid, array('output' => json_encode($output)));
 	}
 }