Long Run Tasks first draft

application/config/lrt.php

@@ -0,0 +1,20 @@
+<?php
+
+/**
+ * Configs for the Long Run Tasks
+ */
+
+if (! defined('BASEPATH')) exit('No direct script access allowed');
+
+// Maximum LRTs for a single user in parallel
+$config['lrt_max_number_single_user'] = 10;
+
+// Maximum LRTs for the whole system in parallel
+$config['lrt_max_number_system'] = 100;
+
+// Maximum running time in hours for a single LRT before killing it
+$config['lrt_max_run_timeout'] = 48;
+
+// List of existing LRT types
+$config['lrt_types'] = array('LRTDocumentConvertion');
+

application/core/LRT_Controller.php

@@ -0,0 +1,73 @@
+<?php
+
+if (!defined("BASEPATH")) exit("No direct script access allowed");
+
+/**
+ * Long Run Task
+ *
+ * This controller acts as interface of the LongRunTaskLib that contains
+ * all the needed functionalities to operate with the Long Run Task system
+ * that is built on top of the Jobs Queue System
+ * This is an abstract class that provide basic functionalities,
+ * it has to be extended to broaden its logic
+ */
+abstract class LRT_Controller extends JQW_Controller
+{
+	/**
+	 * Constructor
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+
+		// Changes the needed configs for LogLib
+		$this->LogLibJob->setConfigs(
+			array(
+				'dbExecuteUser' => 'LRTs queue system',
+				'requestId' => 'LTR'
+			)
+		);
+
+		// Loads LongRunTaskLib library
+		$this->load->library('LongRunTaskLib');
+	}
+
+	//------------------------------------------------------------------------------------------------------------------
+	// Protected methods
+
+	/**
+	 * Get the oldest added LRTs to the queue having status = new
+	 */
+	protected function getLRTs()
+	{
+		$lrts = $this->longruntasklib->getLRTs();
+
+		// If an error occurred then log it in database
+		if (isError($lrts)) $this->logError(getError($lrts));
+
+		return $lrts;
+	}
+
+	/**
+	 *
+	 */
+	protected function addNewLRTsToQueue($type, $lrts)
+	{
+		$result = $this->longruntasklib->addNewLRTsToQueue($type, $lrts);
+
+		// If an error occurred then log it in database
+		if (isError($result)) $this->logError(getError($result), $type);
+
+		return $result;
+	}
+
+	/**
+	 * Utility method to generate a job with the given parameters and return it inside an array
+	 * ready to be used by addNewJobsToQueue and updateJobsQueue
+	 */
+	protected function generateJobs($status, $input)
+	{
+		return JobsQueueLib::generateJobs($status, $input);
+	}
+}
+

application/libraries/AuthLib.php

@@ -64,7 +64,7 @@ class AuthLib
 		{
 			// - The uid must be NOT an empty string
 			// - The current user should NOT be already logged as the given uid
-			if (!isEmptyString($uid) && $this->getAuthObj()->{self::AO_USERNAME} != $uid)
+			if (!isEmptyString($uid) && $this->getAuthObj()->username != $uid)
 			{
 				$this->_ci->load->library('PermissionLib'); // Loads permissions library
 
@@ -75,28 +75,8 @@ class AuthLib
 					$loginAS = $this->_createAuthObjByPerson(array('uid' => $uid));
 					if (isSuccess($loginAS))
 					{
-						$authObj = getData($loginAS); // get the authenticate object
-
 						// Store the new authentication object in authentication session
-						setSessionElement(self::SESSION_NAME, self::SESSION_AUTH_OBJ, $authObj);
-
-						$authObjOrigin = getSessionElement(self::SESSION_NAME, self::SESSION_AUTH_OBJ_ORIGIN);
-
-						// Load the LogLib
-						$this->_ci->load->library('LogLib');
-						// Setup the LogLib
-						$this->_ci->loglib->setConfigs(
-							array(
-								'dbLogType' => 'API', // required
-								'dbExecuteUser' => $authObjOrigin->{self::AO_USERNAME}, // current logged user
-								'requestId' => 'API'
-							)
-						);
-						// Log into the database
-						$this->_ci->loglib->logInfoDB(
-							'The user "'.$authObjOrigin->{self::AO_USERNAME}.'" has changed identity with the user "'.$authObj->{self::AO_USERNAME}.
-							'" and person id '.$authObj->{self::AO_PERSON_ID}
-						);
+						setSessionElement(self::SESSION_NAME, self::SESSION_AUTH_OBJ, getData($loginAS));
 					}
 				}
 				else
@@ -125,7 +105,7 @@ class AuthLib
 		{
 			// - The person id must be a number
 			// - The current user should NOT be already logged as the given person id
-			if (is_numeric($person_id) && $this->getAuthObj()->{self::AO_PERSON_ID} != $person_id)
+			if (is_numeric($person_id) && $this->getAuthObj()->person_id != $person_id)
 			{
 				$this->_ci->load->library('PermissionLib'); // Loads permissions library
 
@@ -144,24 +124,6 @@ class AuthLib
 							{
 								// Store the new authentication object in authentication session
 								setSessionElement(self::SESSION_NAME, self::SESSION_AUTH_OBJ, $authObj);
-
-								$authObjOrigin = getSessionElement(self::SESSION_NAME, self::SESSION_AUTH_OBJ_ORIGIN);
-
-								// Load the LogLib
-								$this->_ci->load->library('LogLib');
-								// Setup the LogLib
-								$this->_ci->loglib->setConfigs(
-									array(
-										'dbLogType' => 'API', // required
-										'dbExecuteUser' => $authObjOrigin->{self::AO_USERNAME}, // current logged user
-										'requestId' => 'API'
-									)
-								);
-								// Log into the database
-								$this->_ci->loglib->logInfoDB(
-									'The user "'.$authObjOrigin->{self::AO_USERNAME}.'" has changed identity with the user "'.$authObj->{self::AO_USERNAME}.
-									'" and person id '.$authObj->{self::AO_PERSON_ID}
-								);
 							}
 							else // if does NOT have permissions
 							{
@@ -210,22 +172,6 @@ class AuthLib
 			// The LoginAs account is logged out
 			// The user is again connected with its real account
 			setSessionElement(self::SESSION_NAME, self::SESSION_AUTH_OBJ, $authObjOrigin);
-
-			// Load the LogLib
-			$this->_ci->load->library('LogLib');
-			// Setup the LogLib
-			$this->_ci->loglib->setConfigs(
-				array(
-					'dbLogType' => 'API', // required
-					'dbExecuteUser' => $authObjOrigin->{self::AO_USERNAME}, // current logged user
-					'requestId' => 'API'
-				)
-			);
-			// Log into the database
-			$this->_ci->loglib->logInfoDB(
-				'The user "'.$authObjOrigin->{self::AO_USERNAME}.'" has logout from the user "'.$authObj->{self::AO_USERNAME}.
-				'" and person id '.$authObj->{self::AO_PERSON_ID}
-			);
 		}
 	}
 
@@ -662,4 +608,3 @@ class AuthLib
 		return $finalUserBasicDataByUID;
 	}
 }
-

application/libraries/JobsQueueLib.php

@@ -2,6 +2,8 @@
 
 if (!defined('BASEPATH')) exit('No direct script access allowed');
 
+use \stdClass as stdClass;
+
 /**
  * Library that contains all the needed functionalities to operate with the Jobs Queue System
  */
@@ -24,12 +26,12 @@ class JobsQueueLib
 	const PROPERTY_END_TIME = 'endtime';
 	const PROPERTY_ERROR = 'error';
 
-	private $_ci; // CI instance
+	protected $_ci; // CI instance
 
 	/**
 	 * Constructor
 	 */
-	public function __construct($authenticate = true)
+	public function __construct()
 	{
 		// Gets CI instance
 		$this->_ci =& get_instance();

application/libraries/LongRunTaskLib.php

@@ -0,0 +1,66 @@
+<?php
+
+if (!defined('BASEPATH')) exit('No direct script access allowed');
+
+/**
+ * Library that contains all the needed functionalities to operate with the Long Run Tasks
+ */
+class LongRunTaskLib extends JobsQueueLib
+{
+	const CFG_LRT_MAX_NUMBER_SYSTEM = 'lrt_max_number_system';
+	const CFG_LRT_TYPES = 'lrt_types';
+
+	/**
+	 * Constructor
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+
+		// Loads the Long Run Tasks configs
+		$this->_ci->config->load('lrt');
+	}
+
+	//------------------------------------------------------------------------------------------------------------------
+	// Public methods
+
+	/**
+	 * Get the oldest added LRTs to the queue having status = new
+	 * The maximum number of returned queued LRTs is limited by:
+	 * number of currently running LRTs - maximum allowed number of LRTs for the system
+	 */
+	public function getLRTs()
+	{
+		// Get all the running LRTs
+		$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));
+
+		// Get the oldest LRTs added to the queue
+		return $this->getOldestJobs($this->_ci->config->item(self::CFG_LRT_TYPES)), $max_number_of_lrts);
+	}
+
+	/**
+	 *
+	 */
+	public function addNewLRTsToQueue($type, $lrts)
+	{
+		return $this->addNewJobsToQueue($type, $lrts);
+	}
+
+	//------------------------------------------------------------------------------------------------------------------
+	// Public static methods
+
+	/**
+	 * Utility method to generate a LTR with the given parameters and return it inside an array
+	 * ready to be used by addNewLRTsToQueue
+	 */
+	public static function generateLtrs($status, $input)
+	{
+		return self::generateJobs($status, $input);
+	}
+}
+

system/dbupdate_3.4.php

@@ -94,6 +94,7 @@ require_once('dbupdate_3.4/71399_dashboard_update_widget_paths.php');
 require_once('dbupdate_3.4/71645_studvw_messagetab_ladezeit.php');
 require_once('dbupdate_3.4/71566_studienordnungsdokument_neuer_organisationseinheitstyp_programm.php');
 require_once('dbupdate_3.4/70376_lohnguide.php');
+require_once('dbupdate_3.4/76203_Asynchrone_Tasks.php');
 
 // *** Pruefung und hinzufuegen der neuen Attribute und Tabellen
 echo '<H2>Pruefe Tabellen und Attribute!</H2>';
@@ -429,7 +430,7 @@ $tabellen=array(
 	"system.tbl_log" => array("log_id","person_id","zeitpunkt","app","oe_kurzbz","logtype_kurzbz","logdata","insertvon","taetigkeit_kurzbz"),
 	"system.tbl_logtype" => array("logtype_kurzbz", "data_schema"),
 	"system.tbl_filters" => array("filter_id","app","dataset_name","filter_kurzbz","person_id","description","sort","default_filter","filter","oe_kurzbz","statistik_kurzbz"),
-	"system.tbl_jobsqueue" => array("jobid", "type", "creationtime", "status", "input", "output", "starttime", "endtime", "insertvon", "insertamum"),
+	"system.tbl_jobsqueue" => array("jobid", "type", "creationtime", "status", "input", "output", "starttime", "endtime", "insertvon", "insertamum", "pid", "uid", "progress"),
 	"system.tbl_jobstatuses" => array("status"),
 	"system.tbl_jobtriggers" => array("type", "status", "following_type"),
 	"system.tbl_jobtypes" => array("type", "description"),

system/dbupdate_3.4/76203_Asynchrone_Tasks.php

@@ -0,0 +1,59 @@
+<?php
+
+// Add column pid to system.tbl_jobsqueue
+if (!$result = @$db->db_query('SELECT "pid" FROM "system"."tbl_jobsqueue" LIMIT 1'))
+{
+	$qry = 'ALTER TABLE "system"."tbl_jobsqueue" ADD "pid" INT NULL DEFAULT 0;';
+	if (!$db->db_query($qry))
+		echo '<strong>system.tbl_jobsqueue: '.$db->db_last_error().'</strong><br>';
+	else
+		echo '<br>Added column pid to table system.tbl_jobsqueue';
+}
+
+// Add column uid to system.tbl_jobsqueue
+if (!$result = @$db->db_query('SELECT "uid" FROM "system"."tbl_jobsqueue" LIMIT 1'))
+{
+	$qry = 'ALTER TABLE "system"."tbl_jobsqueue" ADD "uid" VARCHAR(32) NULL DEFAULT NULL;';
+	if (!$db->db_query($qry))
+		echo '<strong>system.tbl_jobsqueue: '.$db->db_last_error().'</strong><br>';
+	else
+		echo '<br>Added column uid to table system.tbl_jobsqueue';
+}
+
+// Add column progress to system.tbl_jobsqueue
+if (!$result = @$db->db_query('SELECT "progress" FROM "system"."tbl_jobsqueue" LIMIT 1'))
+{
+	$qry = 'ALTER TABLE "system"."tbl_jobsqueue" ADD "progress" NUMERIC(2,1) NULL DEFAULT 0;';
+	if (!$db->db_query($qry))
+		echo '<strong>system.tbl_jobsqueue: '.$db->db_last_error().'</strong><br>';
+	else
+		echo '<br>Added column progress to table system.tbl_jobsqueue';
+}
+
+// Add foreign key fk_jobsqueue_benutzer_uid on system.tbl_jobsqueue.uid with public.tbl_benutzer.uid
+if ($result = $db->db_query("SELECT conname FROM pg_constraint WHERE conname = 'fk_jobsqueue_benutzer_uid'"))
+{
+	if ($db->db_num_rows($result) == 0)
+	{
+		$qry = 'ALTER TABLE "system"."tbl_jobsqueue" ADD CONSTRAINT "fk_jobsqueue_benutzer_uid" FOREIGN KEY ("uid") REFERENCES "public"."tbl_benutzer" ("uid") ON DELETE RESTRICT ON UPDATE CASCADE;';
+		if (!$db->db_query($qry))
+			echo '<strong>system.tbl_jobsqueue: '.$db->db_last_error().'</strong><br>';
+		else
+			echo '<br>Created foreign key fk_jobsqueue_benutzer_uid';
+	}
+}
+
+// Add new webservice type in system.tbl_webservicetyp
+if ($result = @$db->db_query("SELECT 1 FROM system.tbl_webservicetyp WHERE webservicetyp_kurzbz = 'lrt';"))
+{
+	if ($db->db_num_rows($result) == 0)
+	{
+		$qry = "INSERT INTO system.tbl_webservicetyp(webservicetyp_kurzbz, beschreibung) VALUES('lrt', 'Long Run Task');";
+
+		if (!$db->db_query($qry))
+			echo '<strong>system.tbl_webservicetyp '.$db->db_last_error().'</strong><br>';
+		else
+			echo ' system.tbl_webservicetyp: Added webservice type "lrt"<br>';
+	}
+}
+