Better check of the MAX LRTs that a user can schedule

- ECTS Summe gewichtet (current Sum)

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'] = 24;
+
+// List of existing LRT types
+$config['lrt_types'] = array('LRTDummy');
+

application/controllers/jobs/LongRunTaskExecJob.php

@@ -0,0 +1,112 @@
+<?php
+
+if (!defined("BASEPATH")) exit("No direct script access allowed");
+
+/**
+ * - 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 a Job Queue Worker that gets scheduled LRTs from the queue and executes them
+ * - Once all the LRTs have been started checks if there are LRTs that are running for too long and kills them
+ */
+class LongRunTaskExecJob extends JOB_Controller
+{
+	/**
+	 * Constructor
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+
+		// Changes the needed configs for LogLib
+		$this->LogLibJob->setConfigs(
+			array(
+				'dbExecuteUser' => get_class($this),
+				'requestId' => 'LRT'
+			)
+		);
+
+		// Loads LongRunTaskLib library
+		$this->load->library('LongRunTaskLib');
+	}
+
+	/**
+	 * Executes all the new LRTs
+	 */
+	public function execEmAll()
+	{
+		$this->logInfo('Execute long run tasks started');
+
+		// Get all the LRTs that is possible to execute now
+		$lrtsResult = $this->longruntasklib->getNewLRTs();
+		// If an error occurred then return it
+		if (isError($lrtsResult)) return $lrtsResult;
+
+		if (hasData($lrtsResult))
+		{
+			// For each LRT
+			foreach (getData($lrtsResult) as $lrt)
+			{
+				// Execute the task
+				$executeLrtResult = $this->longruntasklib->executeLrt($lrt);
+				if (isError($executeLrtResult)) $this->logError($executeLrtResult);
+			}
+		}
+
+		$this->logInfo('Execute long run tasks ended');
+	}
+
+	/**
+	 * Kills all the hanging LRTs
+	 */
+	public function killHangingLRTs()
+	{
+		$this->logInfo('Kill hanging LRTs started');
+
+		// Get all the LRTs that is possible to execute now
+		$lrtsResult = $this->longruntasklib->getHangingLRTs();
+		// If an error occurred then return it
+		if (isError($lrtsResult)) return $lrtsResult;
+
+		if (hasData($lrtsResult))
+		{
+			// For each LRT
+			foreach (getData($lrtsResult) as $lrt)
+			{
+				// Kill the task
+				$killLrtResult = $this->longruntasklib->killLrt($lrt);
+				if (isError($killLrtResult)) $this->logError($killLrtResult);
+			}
+		}
+
+		$this->logInfo('Kill hanging LRTs ended');
+	}
+
+	/**
+	 * 
+	 */
+	public function checkExecution()
+	{
+		$this->logInfo('Check execution long run tasks started');
+
+		// Get the related LRT data from the queue
+		$lrtsResult = $this->longruntasklib->getRunningLRTs();
+		// If an error occurred then return it
+		if (isError($lrtsResult)) return $lrtsResult;
+
+		// If there are running LRTs
+		if (hasData($lrtsResult))
+		{
+			// For each LRT
+			foreach (getData($lrtsResult) as $lrt)
+			{
+				// Check the LRT execution
+				$checkExecutionResult = $this->longruntasklib->checkExecution($lrt);
+				if (isError($checkExecutionResult)) $this->logError($checkExecutionResult);
+			}
+		}
+
+		$this->logInfo('Check execution long run tasks ended');
+	}
+}
+

application/controllers/lrts/LRTDummy.php

@@ -0,0 +1,82 @@
+<?php
+
+if (!defined("BASEPATH")) exit("No direct script access allowed");
+
+/**
+ * Testing LRT to check if the LRT system is working properly
+ * This will be called by the LongRunTaskExecJob
+ */
+class LRTDummy extends LRT_Controller
+{
+	/**
+	 * This method must be implemented!
+	 */
+	public function run($jobid)
+	{
+		$this->logInfo('Long run tasks '.get_class($this).' started');
+
+		$this->_doIt($jobid);
+
+		$this->logInfo('Long run tasks '.get_class($this).' ended');
+	}
+
+	/**
+	 * Loops on the number of seconds provided by the LRT input
+	 * Sleeps every time 1 sec
+	 * Writes the progress
+	 * Writes the output
+	 */
+	private function _doIt($jobid)
+	{
+		// Get the LRT record related to the provided jobid
+		$lrtResult = $this->getLrt($jobid);
+
+		// If an error occurred or the record has not been found
+		if (isError($lrtResult))
+		{
+			$this->logError($lrtResult);
+			return;
+		}
+		if (!hasData($lrtResult))
+		{
+			$this->logError('LRT not found in database');
+			return;
+		}
+		
+		// Get the record
+		$lrt = getData($lrtResult)[0];
+
+		// Get and check the input
+		$input = json_decode($lrt->{LongRunTaskLib::PROPERTY_INPUT});
+		if ($input == null)
+		{
+			$this->logError('LRT input is not a valid json');
+			return;
+		}
+
+		// Operation
+		for ($i = 0; $i < (int)$input->sleep; $i++)
+		{
+			sleep(1);
+			// Set the progress
+			$setProgressResult = $this->setProgress($jobid, (($i + 1) / (int)$input->sleep) * 100);
+			if (isError($setProgressResult))
+			{
+				$this->logError($setProgressResult);
+				return;
+			}
+		}
+
+		$sleepMsg = 'The user '.$lrt->{LongRunTaskLib::PROPERTY_UID}.' slept for '.$input->sleep.' seconds';
+
+		$this->logInfo($sleepMsg);
+
+		// Set the output
+		$setOutputResult = $this->setOutput($jobid, $sleepMsg);
+		if (isError($setOutputResult))
+		{
+			$this->logError($setOutputResult);
+		}
+	}
+}
+

application/controllers/system/LRTTest.php

@@ -0,0 +1,56 @@
+<?php
+
+if (!defined('BASEPATH')) exit('No direct script access allowed');
+
+use \stdClass as stdClass;
+
+/**
+ * 
+ */
+class LRTTest extends Auth_Controller
+{
+	/**
+	 *
+	 */
+	public function __construct()
+	{
+		parent::__construct(
+			array(
+				'index' => 'system/developer:r',
+				'lrt1min' => 'system/developer:r',
+			)
+		);
+
+		// Loads LongRunTaskLib library
+		$this->load->library('LongRunTaskLib');
+	}
+
+	// -----------------------------------------------------------------------------------------------------------------
+	// Public methods
+
+	/**
+	 * Everything has a beginning
+	 */
+	public function index()
+	{
+		$this->load->view('system/lrtTest.php');
+	}
+
+	/**
+	 *
+	 */
+	public function lrt1min()
+	{
+		$lrtInput = new stdClass();
+		$lrtInput->sleep = 1; // Sleep for 1 min
+
+		$this->outputJsonSuccess(
+			$this->longruntasklib->addNewLrtToQueue(
+				'LRTDummy', // LRT type
+				getAuthUID(), // UID executer
+				$lrtInput // LRT input
+			)
+		);
+	}
+}
+

application/core/LRT_Controller.php

@@ -0,0 +1,69 @@
+<?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
+ * - Any implementation of a Long Run Task should extends this class to
+ * properly operate with the LRT system
+ */
+abstract class LRT_Controller extends JOB_Controller
+{
+	/**
+	 * Constructor
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+
+		// Changes the needed configs for LogLib
+		$this->LogLibJob->setConfigs(
+			array(
+				'dbExecuteUser' => get_class($this),
+				'requestId' => 'LRT'
+			)
+		);
+
+		// Loads LongRunTaskLib library
+		$this->load->library('LongRunTaskLib');
+	}
+
+	//------------------------------------------------------------------------------------------------------------------
+	// Public methods
+
+	abstract public function run($jobid);
+
+	//------------------------------------------------------------------------------------------------------------------
+	// Protected methods
+
+	/**
+	 *
+	 */
+	protected function getLrt($jobid)
+	{
+		return $this->longruntasklib->getLrt($jobid);
+	}
+
+	/**
+	 * 
+	 */
+	protected function setProgress($jobid, $progress)
+	{
+		return $this->longruntasklib->setProgress($jobid, $progress);
+	}
+
+	/**
+	 * 
+	 */
+	protected function setOutput($jobid, $output)
+	{
+		return $this->longruntasklib->setOutuput($jobid, $output);
+	}
+}
+

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();
@@ -62,14 +64,29 @@ class JobsQueueLib
 	 */
 	public function getOldestJobs($type, $maxAmount = null)
 	{
-		$this->_ci->JobsQueueModel->resetQuery();
-
-		$this->_ci->JobsQueueModel->addOrder('creationtime', 'ASC');
+		$types = $type; // default is array
+		$limit = 0; // default query limit
 
 		// If the maximum amount of jobs to retrieve have been specified
-		if (is_numeric($maxAmount)) $this->_ci->JobsQueueModel->addLimit($maxAmount);
+		if (is_numeric($maxAmount)) $limit = $maxAmount;
 
-		return $this->_ci->JobsQueueModel->loadWhere(array('status' => self::STATUS_NEW, 'type' => $type));
+		// If it is a string then include it into an array
+		if (!isEmptyString($type) && is_string($type)) $types = array($type);
+
+		// Return the result of the query
+		return $this->_ci->JobsQueueModel->execReadOnlyQuery('
+			SELECT jq.*
+			  FROM system.tbl_jobsqueue jq
+			 WHERE jq.type IN ?
+			   AND jq.status = ?
+		      ORDER BY jq.creationtime DESC
+			 LIMIT ?',
+			array(
+				$types,
+				self::STATUS_NEW,
+				$limit
+			)
+		);
 	}
 
 	/**
@@ -77,11 +94,23 @@ class JobsQueueLib
 	 */
 	public function getJobsByTypeStatus($type, $status)
 	{
-		$this->_ci->JobsQueueModel->resetQuery();
+		$types = $type; // default is array
 
-		$this->_ci->JobsQueueModel->addOrder('creationtime', 'DESC');
+		// If it is a string then include it into an array
+		if (!isEmptyString($type) && is_string($type)) $types = array($type);
 
-		return $this->_ci->JobsQueueModel->loadWhere(array('status' => $status, 'type' => $type));
+		// Return the result of the query
+		return $this->_ci->JobsQueueModel->execReadOnlyQuery('
+			SELECT jq.*
+			  FROM system.tbl_jobsqueue jq
+			 WHERE jq.type IN ?
+			   AND jq.status = ?
+		      ORDER BY jq.creationtime DESC',
+			array(
+				$types,
+				$status
+			)
+		);
 	}
 
 	/**
@@ -253,8 +282,30 @@ class JobsQueueLib
 		return array($job);
 	}
 
+	//------------------------------------------------------------------------------------------------------------------
+	// Protected methods
+
+	/**
+	 * Checks if the given job contains a valid type
+	 */
+	protected function _checkJobType($type, $types)
+	{
+		return $this->_inArray($type, $types, self::PROPERTY_TYPE);
+	}
+
 	//------------------------------------------------------------------------------------------------------------------
 	// Private methods
+	
+	/**
+	 * Drop not allowed properties from the given job
+	 */
+	private function _dropNotAllowedPropertiesNewJob(&$job)
+	{
+		unset($job->{self::PROPERTY_JOBID});
+		unset($job->{self::PROPERTY_CREATIONTIME});
+		unset($job->{self::PROPERTY_TYPE});
+	}
+
 
 	/**
 	 * Checks the job object structure when needed for insert
@@ -281,34 +332,6 @@ class JobsQueueLib
 		return false; // better sorry than wrong
 	}
 
-	/**
-	 * Checks the job object structure when needed for update
-	 */
-	private function _checkUpdateJobStructure(&$job)
-	{
-		// If job is a valid object
-		if (is_object($job) && property_exists($job, self::PROPERTY_JOBID)) return true; // it is valid!
-
-		// If not object then object it!
-		if (!is_object($job)) $job = new stdClass();
-
-		// If an error property was not already previously stored then store an error message in job object
-		if (!property_exists($job, self::PROPERTY_ERROR))
-		{
-			$job->{self::PROPERTY_ERROR} = 'The structure of the provided job is not valid';
-		}
-
-		return false; // better sorry than wrong
-	}
-
-	/**
-	 * Checks if the given job contains a valid type
-	 */
-	private function _checkJobType($type, $types)
-	{
-		return $this->_inArray($type, $types, self::PROPERTY_TYPE);
-	}
-
 	/**
 	 * Checks if the given job contains a valid status
 	 */
@@ -333,6 +356,26 @@ class JobsQueueLib
 		return $found;
 	}
 
+	/**
+	 * Checks the job object structure when needed for update
+	 */
+	private function _checkUpdateJobStructure(&$job)
+	{
+		// If job is a valid object
+		if (is_object($job) && property_exists($job, self::PROPERTY_JOBID)) return true; // it is valid!
+
+		// If not object then object it!
+		if (!is_object($job)) $job = new stdClass();
+
+		// If an error property was not already previously stored then store an error message in job object
+		if (!property_exists($job, self::PROPERTY_ERROR))
+		{
+			$job->{self::PROPERTY_ERROR} = 'The structure of the provided job is not valid';
+		}
+
+		return false; // better sorry than wrong
+	}
+
 	/**
 	 * Search in an array the given value
 	 * The elements of the given array are objects
@@ -354,16 +397,6 @@ class JobsQueueLib
 		return $found;
 	}
 
-	/**
-	 * Drop not allowed properties from the given job
-	 */
-	private function _dropNotAllowedPropertiesNewJob(&$job)
-	{
-		unset($job->{self::PROPERTY_JOBID});
-		unset($job->{self::PROPERTY_CREATIONTIME});
-		unset($job->{self::PROPERTY_TYPE});
-	}
-
 	/**
 	 * Drop not allowed properties from the given job
 	 */

application/libraries/LongRunTaskLib.php

@@ -0,0 +1,333 @@
+<?php
+
+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';
+	const CFG_LRT_MAX_RUN = 'lrt_max_run_timeout';
+	const CFG_LRT_MAX_NUMBER_USER = 'lrt_max_number_single_user';
+
+	// LRT object properties
+	const PROPERTY_UID = 'uid';
+	const PROPERTY_PID = 'pid';
+
+	/**
+	 * Constructor
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+
+		// Loads the Long Run Tasks configs
+		$this->_ci->config->load('lrt');
+	}
+
+	//------------------------------------------------------------------------------------------------------------------
+	// Public methods used by the LongRunTaskExecJob
+
+	/**
+	 * 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 getNewLRTs()
+	{
+		// 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);
+	}
+
+	/**
+	 * Get all the LRT that are running more then CFG_LRT_MAX_RUN hours
+	 */
+	public function getHangingLRTs()
+	{
+		// Return the result of the query
+		return $this->_ci->JobsQueueModel->execReadOnlyQuery('
+			SELECT jq.*
+		          FROM system.tbl_jobsqueue jq
+			 WHERE jq.type IN ?
+			   AND jq.status = ?
+			   AND jq.starttime < NOW() - INTERVAL \''.$this->_ci->config->item(self::CFG_LRT_MAX_RUN).' hours\'
+		      ORDER BY jq.creationtime DESC',
+			array(
+				$this->_ci->config->item(self::CFG_LRT_TYPES),
+				JobsQueueLib::STATUS_RUNNING
+			)
+		);
+	}
+
+	/**
+	 * Get all the LRT that are currently running
+	 */
+	public function getRunningLRTs()
+	{
+		// Return the result of the query
+		return $this->_ci->JobsQueueModel->execReadOnlyQuery('
+			SELECT jq.*
+		          FROM system.tbl_jobsqueue jq
+			 WHERE jq.type IN ?
+			   AND jq.status = ?
+		      ORDER BY jq.creationtime DESC',
+			array(
+				$this->_ci->config->item(self::CFG_LRT_TYPES),
+				JobsQueueLib::STATUS_RUNNING
+			)
+		);
+	}
+
+	/**
+	 * Execute a LRT in background
+	 * - Checks if the wanted LRT exists in the applcation/controllers/lrts directory
+	 * - Then executes it in background via CI CLI
+	 * - Stores the LRT pid into the database
+	 */
+	public function executeLrt($lrt)
+	{
+		$output = array();
+
+		// If does _not_ exist a LRT implementation for this LRT type, then return an error
+		if (!file_exists(APPPATH.'controllers/lrts/'.$lrt->{self::PROPERTY_TYPE}.'.php'))
+		{
+			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
+			sprintf(
+				'/usr/bin/php %s/../index.ci.php lrts/%s/run %s > /dev/null 2>&1 & echo $!',
+				APPPATH,
+				$lrt->{self::PROPERTY_TYPE},
+				$lrt->{self::PROPERTY_JOBID}
+			),
+			$output // Here goes the output from the standard output and error
+		);
+
+		// If a pid has not been returned
+		if (isEmptyArray($output) || !is_numeric($output[0])) return error('Not a valid pid has been returned');
+
+		// Set the pid, status and starttime of this LRT into the database
+		$updateLrtResult = $this->_ci->JobsQueueModel->update(
+			$lrt->{self::PROPERTY_JOBID},
+			array(
+				'pid' => $output[0],
+				'starttime' => 'NOW()',
+				'status' => self::STATUS_RUNNING
+			)
+		);
+		if (isError($updateLrtResult)) return $updateLrtResult;
+	}
+
+	/**
+	 * Kill the provided LRT
+	 * To avoid to kill a process that is not this LRT,
+	 * since the same PID can be assigned to another process once this ended
+	 */
+	public function killLrt($lrt)
+	{
+		// Try to get the pid of this LRT from the system
+		$pid = exec(
+			sprintf(
+				'ps -eo pid,cmd | grep "index.ci.php lrts/%s/run %s" | grep -v grep | awk \'{print $1}\'',
+				$lrt->{self::PROPERTY_TYPE},
+				$lrt->{self::PROPERTY_JOBID}
+			)
+		);
+
+		// If the pid is the same then kill the process with a SIGKILL
+		if ($pid == $lrt->{self::PROPERTY_PID}) exec('kill -9 '.$lrt->{self::PROPERTY_PID}.' > /dev/null 2>&1');
+
+		// Set the LRT as failed in any case
+		$lrtExecFailedResult = $this->_ci->JobsQueueModel->update(
+			$lrt->{self::PROPERTY_JOBID},
+			array(
+				'endtime' => 'NOW()',
+				'status' => self::STATUS_FAILED
+			)
+		);
+		// If an error occurred then return it
+		if (isError($lrtExecFailedResult)) return $lrtExecFailedResult;
+	}
+
+	/**
+	 *
+	 */
+	public function checkExecution($lrt)
+	{
+		// If the LRT stopped running
+		if (!$this->_isRunning($lrt))
+		{
+			// Loads MessageLib library
+			$this->_ci->load->library('MessageLib');
+			// Load the BenutzerModel
+			$this->_ci->load->model('person/Benutzer_model', 'BenutzerModel');
+
+			// Get the benutzer for this uid
+			$benutzerResult = $this->_ci->BenutzerModel->loadWhere(array('uid' => $lrt->{LongRunTaskLib::PROPERTY_UID}));
+			// If an error occurred then return it
+			if (isError($benutzerResult)) return $benutzerResult;
+			// If no benutzer has been found
+			if (!hasData($benutzerResult)) return error('No benutzer found, uid: '.$lrt->{LongRunTaskLib::PROPERTY_UID});
+
+			$benutzer = getData($benutzerResult)[0];
+
+			// Sends a message to the user
+			$messageResult = $this->_ci->messagelib->sendMessageUser(
+			        $benutzer->person_id,
+			        'Long run task ended',
+			        'The long run task '.$lrt->{self::PROPERTY_TYPE}.' ended, output: '.$lrt->{self::PROPERTY_OUTPUT}
+			);
+			// If an error occurred then return it
+			if (isError($messageResult)) return $messageResult;
+
+			// Set the LRT as done
+			$lrtExecOverResult = $this->_ci->JobsQueueModel->update(
+				$lrt->{self::PROPERTY_JOBID},
+				array(
+					'endtime' => 'NOW()',
+					'status' => self::STATUS_DONE
+				)
+			);
+			// If an error occurred then return it
+			if (isError($lrtExecOverResult)) return $lrtExecOverResult;
+		}
+	}
+
+	//------------------------------------------------------------------------------------------------------------------
+	// Public methods used by the front end applications (standard controllers/end points, ex. controllers/system/LRTTest.php)
+
+	/**
+	 * Add a single LRT to the queue
+	 */
+	public function addNewLrtToQueue($type, $uid, $lrtInput)
+	{
+		// 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');
+
+		// Get all the running task for this uid
+		// Return the result of the query
+                $runningLRTbyUIDResult = $this->_ci->JobsQueueModel->execReadOnlyQuery('
+			SELECT jq.*
+			  FROM system.tbl_jobsqueue jq
+			 WHERE jq.status IN ?
+			   AND jq.uid = ?
+			',
+			array(
+				array(
+					self::STATUS_NEW,
+					self::STATUS_RUNNING
+				),
+				$uid
+			)
+                );
+
+		// If an error occurred then return it
+		if (isError($runningLRTbyUIDResult)) return $runningLRTbyUIDResult;
+
+		// If the running tasks for this user are too many
+		if (count(getData($runningLRTbyUIDResult)) >= $this->_ci->config->item(self::CFG_LRT_MAX_NUMBER_USER))
+		{
+			return error('Too many running tasks for this user');
+		}
+
+		// 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)));
+	}
+
+	//------------------------------------------------------------------------------------------------------------------
+	// Private methods
+
+	/**
+	 * Return true if the LRT is still running
+	 */
+	private function _isRunning($lrt)
+	{
+		// Try to get the pid of this LRT from the system
+		$pid = exec(
+			sprintf(
+				'ps -eo pid,cmd | grep "index.ci.php lrts/%s/run %s" | grep -v grep | awk \'{print $1}\'',
+				$lrt->{self::PROPERTY_TYPE},
+				$lrt->{self::PROPERTY_JOBID}
+			)
+		);
+
+		// If the pid is the same then the LRT is still running
+		return $pid == $lrt->{self::PROPERTY_PID};
+	}
+}
+

application/views/system/lrtTest.php

@@ -0,0 +1,28 @@
+<?php
+	$includesArray = array(
+		'title' => 'LRT Test Page',
+		'axios027' => true,
+		'bootstrap5' => true,
+		'fontawesome6' => true,
+		'vue3' => true,
+		'navigationcomponent' => true,
+		'phrases' => array(
+			'global',
+			'ui'
+		),
+		'customJSModules' => array('public/js/apps/LRTTest.js'),
+	);
+
+	$this->load->view('templates/FHC-Header', $includesArray);
+?>
+
+	<div id="main">
+
+		<!-- Navigation component -->
+		<core-navigation-cmpt></core-navigation-cmpt>
+
+		<div id="content"></div>
+	</div>
+
+<?php $this->load->view('templates/FHC-Footer', $includesArray); ?>
+

content/statistik/notenspiegel_erweitert.php

@@ -95,37 +95,37 @@ foreach ($result_student as $row)
 if ($uids == '')
 	die('Es befinden sich keine Studierende in diesem Semester');
 
-$qry = "SELECT 
-			lehrveranstaltung_id, bezeichnung, studiengang_kz, semester, ects
-		FROM 
-			lehre.tbl_lehrveranstaltung 
-        WHERE 
-        	lehrveranstaltung_id IN 
-        	(
-				SELECT 
-					distinct lehrveranstaltung_id 
-				FROM 
-					campus.vw_student_lehrveranstaltung, public.tbl_studentlehrverband
-	        	WHERE 
-	        		tbl_studentlehrverband.studiengang_kz=".$db->db_add_param($studiengang_kz, FHC_INTEGER)." AND 
-	        		tbl_studentlehrverband.semester=".$db->db_add_param($semester, FHC_INTEGER)." AND 
-	        		vw_student_lehrveranstaltung.studiensemester_kurzbz=".$db->db_add_param($semester_aktuell)." AND
-	        		uid=student_uid AND 
-	        		vw_student_lehrveranstaltung.studiensemester_kurzbz=tbl_studentlehrverband.studiensemester_kurzbz
+$qry = "SELECT
+		lehrveranstaltung_id, bezeichnung, studiengang_kz, semester, ects
+	FROM
+		lehre.tbl_lehrveranstaltung
+        WHERE
+		lehrveranstaltung_id IN (
+			SELECT
+				DISTINCT lehrveranstaltung_id
+			FROM
+				campus.vw_student_lehrveranstaltung
+				JOIN public.tbl_studentlehrverband ON(student_uid = uid)
+			WHERE
+				tbl_studentlehrverband.studiengang_kz = ".$db->db_add_param($studiengang_kz, FHC_INTEGER)."
+				AND tbl_studentlehrverband.semester = ".$db->db_add_param($semester, FHC_INTEGER)."
+				AND vw_student_lehrveranstaltung.studiensemester_kurzbz = ".$db->db_add_param($semester_aktuell)."
+				AND vw_student_lehrveranstaltung.studiensemester_kurzbz = tbl_studentlehrverband.studiensemester_kurzbz
 	        ) 
-	        AND studiengang_kz<>0
+	        AND studiengang_kz != 0
 	        AND zeugnis
-	    UNION
-	    SELECT
-	    	lehrveranstaltung_id, bezeichnung, studiengang_kz, semester, ects
-	    FROM
-	    	lehre.tbl_lehrveranstaltung JOIN lehre.tbl_zeugnisnote USING(lehrveranstaltung_id)
-	    WHERE
-	    	tbl_lehrveranstaltung.studiengang_kz=".$db->db_add_param($studiengang_kz, FHC_INTEGER)." AND
-	    	tbl_zeugnisnote.student_uid in($uids) AND
-	    	tbl_zeugnisnote.studiensemester_kurzbz=".$db->db_add_param($semester_aktuell)." AND
-	    	zeugnis
-		ORDER BY bezeichnung";
+	UNION
+	SELECT
+		lehrveranstaltung_id, bezeichnung, studiengang_kz, semester, ects
+	FROM
+	    lehre.tbl_lehrveranstaltung
+	    JOIN lehre.tbl_zeugnisnote USING(lehrveranstaltung_id)
+	WHERE
+	    tbl_lehrveranstaltung.studiengang_kz = ".$db->db_add_param($studiengang_kz, FHC_INTEGER)."
+	    AND tbl_zeugnisnote.student_uid IN ($uids)
+	    AND tbl_zeugnisnote.studiensemester_kurzbz = ".$db->db_add_param($semester_aktuell)."
+	    AND zeugnis
+    ORDER BY bezeichnung";
 
 if (!$result_lva = $db->db_query($qry))
 	die('Fehler beim Ermitteln der Lehrveranstaltungen');
@@ -338,6 +338,10 @@ if ($typ == 'xls')
 	}
 	$anzahl_lvspalten = $spalte - 2;
 
+	$worksheet->write($zeile, ++$spalte, 'ECTS Summe zugeteilt', $format_bold);
+	$maxlength[$spalte] = 20;
+	$worksheet->write($zeile, ++$spalte, 'ECTS Summe gewichtet', $format_bold);
+	$maxlength[$spalte] = 20;
 	$worksheet->write($zeile, ++$spalte, 'Notendurchschnitt', $format_bold);
 	$maxlength[$spalte] = 15;
 	$worksheet->write($zeile, ++$spalte, "Gewichteter\nNotendurchschnitt", $format_bold_wrap);
@@ -372,9 +376,12 @@ if ($typ == 'xls')
 		$worksheet->write($zeile, ++$spalte, $row_student->gruppe, $format_bold_left);
 		$worksheet->write($zeile, ++$spalte, $row_student->matrikelnr, $format_bold);
 
-		//Alle Zeugnisnoten des Studierenden holen
+		// Alle Zeugnisnoten des Studierenden holen
 		$noten = array();
-		$qry = "SELECT * FROM lehre.tbl_zeugnisnote WHERE student_uid=".$db->db_add_param($row_student->uid)." AND studiensemester_kurzbz=".$db->db_add_param($semester_aktuell);
+		$qry = "SELECT lehrveranstaltung_id, note
+			FROM lehre.tbl_zeugnisnote
+			WHERE student_uid = ".$db->db_add_param($row_student->uid)."
+			AND studiensemester_kurzbz = ".$db->db_add_param($semester_aktuell);
 		if ($result = $db->db_query($qry))
 			while ($row = $db->db_fetch_object($result))
 				$noten[$row->lehrveranstaltung_id] = $row->note;
@@ -382,15 +389,16 @@ if ($typ == 'xls')
 		//Zu jeder Lehrveranstaltungsnote Prüfungstyp (Anzahl der Antritte) holen
 		$pruefungstypen = array();
 		$qry = "SELECT tbl_lehrveranstaltung.lehrveranstaltung_id, pruefungstyp_kurzbz, sort, datum
-					FROM
-						lehre.tbl_pruefung
- 					JOIN
- 						lehre.tbl_lehreinheit using(lehreinheit_id)
- 					JOIN
- 						lehre.tbl_lehrveranstaltung using(lehrveranstaltung_id)
- 					WHERE 
- 						student_uid=".$db->db_add_param($row_student->uid)." AND studiensemester_kurzbz=".$db->db_add_param($semester_aktuell)."
- 					ORDER BY lehrveranstaltung_id, sort, datum";
+			FROM
+				lehre.tbl_pruefung
+			JOIN
+				lehre.tbl_lehreinheit USING(lehreinheit_id)
+			JOIN
+				lehre.tbl_lehrveranstaltung USING(lehrveranstaltung_id)
+			WHERE
+				student_uid = ".$db->db_add_param($row_student->uid)."
+				AND studiensemester_kurzbz = ".$db->db_add_param($semester_aktuell)."
+			ORDER BY lehrveranstaltung_id, sort, datum";
 		if ($result = $db->db_query($qry))
 		{
 			while ($row = $db->db_fetch_object($result))
@@ -399,15 +407,14 @@ if ($typ == 'xls')
 			}
 		}
 
-		//Alle LVs holen zu denen der Studierende zugeteilt ist
+		// Alle LVs holen zu denen der Studierende zugeteilt ist
 		$zugeteilte_lvs = array();
-		$qry = "SELECT distinct lehrveranstaltung_id
-					FROM 
-						campus.vw_student_lehrveranstaltung 
-					WHERE 
-						uid=".$db->db_add_param($row_student->uid)." AND 
-						studiensemester_kurzbz=".$db->db_add_param($semester_aktuell);
-
+		$qry = "SELECT DISTINCT lehrveranstaltung_id
+			FROM
+				campus.vw_student_lehrveranstaltung
+			WHERE
+				uid = ".$db->db_add_param($row_student->uid)."
+				AND studiensemester_kurzbz = ".$db->db_add_param($semester_aktuell);
 		if ($result = $db->db_query($qry))
 			while ($row = $db->db_fetch_object($result))
 				$zugeteilte_lvs[] = $row->lehrveranstaltung_id;
@@ -416,17 +423,20 @@ if ($typ == 'xls')
 		$summe = 0;
 		$rowcount = 0;
 		$summeects = 0;
+		$total_ects = 0;
 		$gewichtetenote = 0;
 
 		while ($rowcount < $db->db_num_rows($result_lva))
 		{
 			$row_lva = $db->db_fetch_object($result_lva, $rowcount);
 			$rowcount++;
+
 			//wenn es eine Note gibt
 			if (isset($noten[$row_lva->lehrveranstaltung_id]))
 			{
 				$note = $noten[$row_lva->lehrveranstaltung_id];
 				$format = 0;
+				$total_ects += $row_lva->ects;
 
 				//wenn für die LV der Studierende eine Nachprüfung hat (z.B. 2 Termin, kommissionelle...)
 				if (isset($pruefungstypen[$row_lva->lehrveranstaltung_id]))
@@ -472,6 +482,7 @@ if ($typ == 'xls')
 				//Keine Note fuer diese LV vorhanden
 				if (in_array($row_lva->lehrveranstaltung_id, $zugeteilte_lvs))
 				{
+					$total_ects += $row_lva->ects;
 					$worksheet->write($zeile, ++$spalte, '', $format_colored_nichteingetragen);
 				}
 				else
@@ -489,6 +500,8 @@ if ($typ == 'xls')
 		if ($summeects != 0)
 			$gewichtetenote /= $summeects;
 
+		$worksheet->write($zeile, ++$spalte, sprintf("%.2f", $total_ects), $format_number);
+		$worksheet->write($zeile, ++$spalte, sprintf("%.2f", $summeects), $format_number);
 		$worksheet->write($zeile, ++$spalte, sprintf("%.2f", $schnitt), $format_number);
 		$worksheet->write($zeile, ++$spalte, sprintf("%.2f", $gewichtetenote), $format_number);
 		if ($gewichtetenote != 0)
@@ -529,6 +542,8 @@ if ($typ == 'xls')
 		$schnitt = $summe_schnitt / $anzahl_schnitt;
 	else
 		$schnitt = 0;
+	$worksheet->write($zeile, ++$spalte, '-', $format_bold_center);
+	$worksheet->write($zeile, ++$spalte, '-', $format_bold_center);
 	$worksheet->write($zeile, ++$spalte, sprintf("%.2f", $schnitt), $format_number);
 	if ($anzahlgewichtet != 0)
 		$summegewichtet = $summegewichtet / $anzahlgewichtet;

public/js/api/LRTTEst.js

@@ -0,0 +1,9 @@
+export default {
+	addNew1MinLrt()
+	{
+		return {
+			method: 'post',
+			url: '/system/LRTTest/lrt1min'
+		};
+	},
+}

public/js/apps/LRTTest.js

@@ -0,0 +1,48 @@
+/**
+ * Copyright (C) 2022 fhcomplete.org
+ *
+ * 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 3 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, see <https://www.gnu.org/licenses/>.
+ */
+
+import PluginsPhrasen from '../plugins/Phrasen.js';
+import {CoreNavigationCmpt} from '../components/navigation/Navigation.js'
+
+import ApiLrt from "../api/LRTTEst.js";
+
+const lrtTestApp = Vue.createApp({
+	data: function() {
+		return {
+		};
+	},
+	components: {
+		CoreNavigationCmpt,
+	},
+	methods: {
+		addNew1MinLrt() {
+			this.$api.call(ApiLrt.addNew1MinLrt())
+			.then(result => {
+				this.dropdowns.studiensemester_array = result.data;
+			})
+			.catch(this.$fhcAlert.handleSystemError);
+		}
+	},
+	template: `
+		<button type="button" class="btn btn-primary" @click="addNew1MinLrt()">Add a 1 min LRT</button>
+	`
+});
+
+FhcApps.makeExtendable(lrtTestApp);
+
+lrtTestApp.use(PluginsPhrasen).mount('#main');
+

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');
 require_once('dbupdate_3.4/75888_reihungstest_mehrfachdurchfuehrung.php');
 
 // *** Pruefung und hinzufuegen der neuen Attribute und Tabellen
@@ -430,7 +431,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 NULL;';
+	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>';
+	}
+}
+

system/filtersupdate.php

@@ -1638,6 +1638,84 @@ $filters = array(
 			}',
 		'oe_kurzbz' => null,
 	),
+	array(
+		'app' => 'core',
+		'dataset_name' => 'logs',
+		'filter_kurzbz' => 'lrts24hours',
+		'description' => '{Last 24 hours LRTs logs}',
+		'sort' => 2,
+		'default_filter' => false,
+		'filter' => '
+			{
+				"name": "All Long Run Tasks logs from the last 24 hours",
+				"columns": [
+					{"name": "RequestId"},
+					{"name": "ExecutionTime"},
+					{"name": "ExecutedBy"},
+					{"name": "Description"},
+					{"name": "Data"}
+				],
+				"filters": [
+					{
+						"name": "WebserviceType",
+						"operation": "contains",
+						"condition": "job"
+					},
+					{
+						"name": "RequestId",
+						"operation": "contains",
+						"condition": "LRT"
+					},
+					{
+						"name": "ExecutionTime",
+						"operation": "lt",
+						"condition": "24",
+						"option": "hours"
+					}
+				]
+			}
+		',
+		'oe_kurzbz' => null,
+	),
+	array(
+		'app' => 'core',
+		'dataset_name' => 'logs',
+		'filter_kurzbz' => 'lrts48hours',
+		'description' => '{Last 48 hours LRTs logs}',
+		'sort' => 2,
+		'default_filter' => false,
+		'filter' => '
+			{
+				"name": "All Long Run Tasks logs from the last 48 hours",
+				"columns": [
+					{"name": "RequestId"},
+					{"name": "ExecutionTime"},
+					{"name": "ExecutedBy"},
+					{"name": "Description"},
+					{"name": "Data"}
+				],
+				"filters": [
+					{
+						"name": "WebserviceType",
+						"operation": "contains",
+						"condition": "job"
+					},
+					{
+						"name": "RequestId",
+						"operation": "contains",
+						"condition": "LRT"
+					},
+					{
+						"name": "ExecutionTime",
+						"operation": "lt",
+						"condition": "48",
+						"option": "hours"
+					}
+				]
+			}
+		',
+		'oe_kurzbz' => null,
+	),
 );
 
 // Loop through the filters array