Issues: enabled extensions to produce own plausichecks, IssueResolver: moved directory names to constants, deleted unused IIssueExistsChecker

application/core/IIssueExistsChecker.php

@@ -1,21 +0,0 @@
-<?php
-
-/**
- * Interface defining method to implement for issue producer (from core and extensions)
- */
-interface IIssueExistsChecker
-{
-	/**
-	 * Checks if an issue exists.
-	 * @param array $params parameters needed for issue detection
-	 * @return object with success(true) if issue exists, success(false) otherwise
-	 */
-	public function checkIfIssueExists($paramsForChecking);
-
-	/**
-	 * Produces an issue.
-	 * @param array $params parameters needed for issue detection
-	 * @return object with success(true) if issue exists, success(false) otherwise
-	 */
-	//public function produceIssue($person_id, $oe_kurzbz, $paramsForProducing);
-}

application/core/IssueResolver_Controller.php

@@ -6,6 +6,8 @@
 abstract class IssueResolver_Controller extends JOB_Controller
 {
 	const CI_PATH = 'application';
+	const CI_LIBRARY_FOLDER = 'libraries';
+	const EXTENSIONS_FOLDER = 'extensions';
 	const ISSUE_RESOLVERS_FOLDER = 'issues/resolvers';
 	const CHECK_ISSUE_RESOLVED_METHOD_NAME = 'checkIfIssueIsResolved';
 
@@ -60,10 +62,17 @@ abstract class IssueResolver_Controller extends JOB_Controller
 						isset($issue->behebung_parameter) ? json_decode($issue->behebung_parameter, true) : array()
 					);
 
-					// if called from extension (extension name set), path includes extension names, otherwise it is the core library folder
-					$libRootPath = isset($this->_extensionName) ? 'extensions/' . $this->_extensionName . '/' : '';
+					// TODO: what if extension/library folder changes?
+
+					// if called from extension (extension name set), path includes extension names
+					$libRootPath = isset($this->_extensionName) ? self::EXTENSIONS_FOLDER . '/' . $this->_extensionName . '/' : '';
+
+					// path for loading issue library
 					$issuesLibPath = $libRootPath . self::ISSUE_RESOLVERS_FOLDER . '/';
-					$issuesLibFilePath = DOC_ROOT . self::CI_PATH . '/' . $libRootPath . 'libraries/' . self::ISSUE_RESOLVERS_FOLDER . '/' . $libName . '.php';
+
+					// file path of library for check if file exists
+					$issuesLibFilePath = DOC_ROOT . self::CI_PATH
+						. '/' . $libRootPath . self::CI_LIBRARY_FOLDER . '/' . self::ISSUE_RESOLVERS_FOLDER . '/' . $libName . '.php';
 
 					// check if library file exists
 					if (!file_exists($issuesLibFilePath))

application/core/PlausiIssueProducer_Controller.php

@@ -0,0 +1,66 @@
+<?php
+
+/**
+ * Job for producing Plausicheck issues
+ */
+abstract class PlausiIssueProducer_Controller extends JOB_Controller
+{
+	protected $_fehlerLibMappings;
+
+	public function __construct()
+	{
+		parent::__construct();
+
+		$this->load->library('issues/PlausicheckProducerLib');
+		$this->load->library('IssuesLib');
+	}
+
+	/**
+	 * Runs issue production job.
+	 * @param studiensemester_kurzbz string job is run for students of a certain semester.
+	 * @param studiengang_kz int job is run for students of certain Studiengang.
+	 */
+	public function run($studiensemester_kurzbz = null, $studiengang_kz = null)
+	{
+		$this->logInfo("Plausicheck issue producer job started");
+
+		// get the data returned by Plausicheck
+		foreach ($this->_fehlerLibMappings as $fehler_kurzbz => $libName)
+		{
+			// execute the check
+			$this->logInfo("Checking " . $fehler_kurzbz . "...");
+			$plausicheckRes = $this->plausicheckproducerlib->producePlausicheckIssue(
+				$libName,
+				$studiensemester_kurzbz,
+				$studiengang_kz
+			);
+
+			if (isError($plausicheckRes)) $this->logError(getError($plausicheckRes));
+
+			if (hasData($plausicheckRes))
+			{
+				$plausicheckData = getData($plausicheckRes);
+
+				foreach ($plausicheckData as $plausiData)
+				{
+					// get the data needed for issue production
+					$person_id = isset($plausiData['person_id']) ? $plausiData['person_id'] : null;
+					$oe_kurzbz = isset($plausiData['oe_kurzbz']) ? $plausiData['oe_kurzbz'] : null;
+					$fehlertext_params = isset($plausiData['fehlertext_params']) ? $plausiData['fehlertext_params'] : null;
+					$resolution_params = isset($plausiData['resolution_params']) ? $plausiData['resolution_params'] : null;
+
+					// write the issue
+					$addIssueRes = $this->issueslib->addFhcIssue($fehler_kurzbz, $person_id, $oe_kurzbz, $fehlertext_params, $resolution_params);
+
+					// log if error, or log info if inserted new issue
+					if (isError($addIssueRes))
+						$this->logError(getError($addIssueRes));
+					elseif (hasData($addIssueRes) && is_integer(getData($addIssueRes)))
+						$this->logInfo("Plausicheck issue " . $fehler_kurzbz . " successfully produced, person_id: " . $person_id);
+				}
+			}
+		}
+
+		$this->logInfo("Plausicheck issue producer job stopped");
+	}
+}