Merge branch 'master' into feature-6237/Phrases_system_MkIII

application/helpers/hlp_common_helper.php

@@ -1,24 +1,25 @@
 <?php
-
 /**
- * FH-Complete
+ * Copyright (C) 2022 fhcomplete.org
  *
- * @package		FHC-Helper
- * @author		FHC-Team
- * @copyright	Copyright (c) 2016 fhcomplete.org
- * @license		GPLv3
- * @since		Version 1.0.0
- */
-
-/**
- * FHC Helper
+ * 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.
  *
- * @subpackage	Helpers
- * @category	Helpers
+ * 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/>.
  */
 
 if (! defined('BASEPATH')) exit('No direct script access allowed');
 
+use \DateTime as DateTime;
+
 // ------------------------------------------------------------------------
 // Collection of utility functions for general purpose
 // ------------------------------------------------------------------------
@@ -42,15 +43,19 @@ function generateToken($length = 64)
 		{
 			$firstGeneratedToken = random_bytes($length); // try to generates cryptographically secure pseudo-random bytes...
 		}
-		catch (Exception $e) { $firstGeneratedToken = null; } // if fails $firstGeneratedToken is set to null
+		catch (Exception $e)
+		{
+			// If fails $firstGeneratedToken is set to null
+			$firstGeneratedToken = null;
+		}
 	}
 	// For PHP >= 5.3 and < 7 and openssl is available
 	elseif (function_exists('openssl_random_pseudo_bytes'))
 	{
 		$firstGeneratedToken = openssl_random_pseudo_bytes($length, $strong);
 		// If the token generation ended with errors OR the generated token is NOT strong enough
-        if ($firstGeneratedToken == false || $strong == false) $firstGeneratedToken = null; // $firstGeneratedToken is set to null
-    }
+		if ($firstGeneratedToken == false || $strong == false) $firstGeneratedToken = null; // $firstGeneratedToken is set to null
+	}
 
 	if ($firstGeneratedToken != null) // If everything was fine
 	{
@@ -107,10 +112,7 @@ function var_dump_to_error_log($parameter)
 function loadResource($path, $resources = null, $subdir = false)
 {
 	// Place a / character at the and of the string if not present
-	if (strrpos($path, '/') < strlen($path) - 1)
-	{
-		$path .= '/';
-	}
+	if (strrpos($path, '/') < strlen($path) - 1) $path .= '/';
 
 	// Loads in $tmpResources all the given resources
 	$tmpResources = $resources;
@@ -125,28 +127,36 @@ function loadResource($path, $resources = null, $subdir = false)
 
 	// Loads in $tmpPaths path and eventually the subdirectories
 	$tmpPaths = array($path);
-	// NOTE: Used @ to prevent ugly error messages
-	if (is_dir($path) && ($dirHandler = @opendir($path)) !== false)
+
+	// If path is a directory
+	if (is_dir($path))
 	{
-		// Reads all file system entries present in path
-		while (($entry = readdir($dirHandler)) !== false)
+		// NOTE: Used @ to prevent ugly error messages
+		$dirHandler = @opendir($path);
+
+		// Successfully opened
+		if ($dirHandler !== false)
 		{
-			// If entry is a directory but not the current and subdirectories should be loaded
-			if ($subdir === true && $entry != '.' && $entry != '..' && is_dir($entry))
+			// Reads all file system entries present in path
+			while (($entry = readdir($dirHandler)) !== false)
 			{
-				$tmpPaths[] = $entry;
-			}
-			// If no resources are specified and the current file system entry is a file
-			if ($resources == null && is_file($path.$entry))
-			{
-				// If the current entry is a php file store the name without extension
-				if ($entry != ($tmpName = str_replace('.php', '', $entry)))
+				// If entry is a directory but not the current and subdirectories should be loaded
+				if ($subdir === true && $entry != '.' && $entry != '..' && is_dir($path.$entry))
 				{
-					$tmpResources[] = $tmpName;
+					$tmpPaths[] = $path.$entry.'/';
+				}
+				// If no resources are specified and the current file system entry is a file
+				if ($resources == null && is_file($path.$entry))
+				{
+					// Name without php extension
+					$tmpName = str_replace('.php', '', $entry);
+
+					// If the current entry is a php file store the name without extension
+					if ($entry != $tmpName) $tmpResources[] = $tmpName;
 				}
 			}
+			closedir($dirHandler);
 		}
-		closedir($dirHandler);
 	}
 
 	// Loops through the resources
@@ -156,10 +166,7 @@ function loadResource($path, $resources = null, $subdir = false)
 		foreach ($tmpPaths as $tmpPath)
 		{
 			$fileName = $tmpPath.$tmpResource.'.php'; // Php extension
-			if (file_exists($fileName))
-			{
-				include_once($fileName);
-			}
+			if (file_exists($fileName)) include_once($fileName);
 		}
 	}
 }
@@ -349,5 +356,162 @@ function sanitizeProblemChars($str)
 		'ss' => '/&szlig;/'
 	);
 
-	return preg_replace($acentos, array_keys($acentos), htmlentities($str, ENT_NOQUOTES | ENT_HTML5, $enc));
+	$tmp = preg_replace($acentos, array_keys($acentos), htmlentities($str, ENT_NOQUOTES | ENT_HTML5, $enc));
+	return html_entity_decode($tmp, ENT_NOQUOTES | ENT_HTML5, $enc);
+}
+
+/**
+ *
+ */
+function findResource($path, $resource, $subdir = false, $extraDir = null)
+{
+	// Place a / character at the and of the string if not present
+	if (strrpos($path, '/') < strlen($path) - 1) $path .= '/';
+
+	// Loads in $tmpPaths path and eventually the subdirectories
+	$tmpPaths = array($path);
+	if (is_dir($path))
+	{
+		// NOTE: Used @ to prevent ugly error messages
+		$dirHandler = @opendir($path);
+
+		// Successfully opened
+		if ($dirHandler !== false)
+		{
+			// Reads all file system entries present in path
+			while (($entry = readdir($dirHandler)) !== false)
+			{
+				// If entry is a directory but not the current and subdirectories should be loaded
+				if ($subdir === true && $entry != '.' && $entry != '..' && is_dir($path.$entry))
+				{
+					if ($extraDir == null)
+					{
+						$tmpPaths[] = $path.$entry.'/';
+					}
+					else
+					{
+						$tmpPaths[] = $path.$entry.'/'.$extraDir.'/';
+					}
+				}
+			}
+			closedir($dirHandler);
+		}
+	}
+
+	// Loops through the paths
+	foreach ($tmpPaths as $tmpPath)
+	{
+		$fileName = $tmpPath.$resource.'.php'; // Php extension
+		if (file_exists($fileName)) return $fileName;
+	}
+
+	return null;
+}
+
+/**
+ * check if String can be converted to a date
+ */
+function isValidDate($dateString)
+{
+	try
+	{
+		return (new DateTime($dateString)) !== false;
+	}
+	catch(Exception $e)
+	{
+		return false;
+	}
+}
+
+
+// ------------------------------------------------------------------------
+// PHP functions that don't exist in older versions
+// ------------------------------------------------------------------------
+
+/**
+ * Returns true if the given array is sequential
+ */
+if (!function_exists('array_is_list')) {
+    function array_is_list(array $arr)
+    {
+        if ($arr === []) {
+            return true;
+        }
+        return array_keys($arr) === range(0, count($arr) - 1);
+    }
+}
+
+// ------------------------------------------------------------------------
+// Collection of utility functions for form validation purposes
+// ------------------------------------------------------------------------
+
+/**
+ * check if string can be converted to a date
+ */
+function is_valid_date($dateString)
+{
+	try
+	{
+		return (new DateTime($dateString)) !== false;
+	}
+	catch(Exception $e)
+	{
+		return false;
+	}
+}
+
+/**
+ * check if given permissions are met
+ */
+function has_write_permissions($value, $permissions = '')
+{
+	if (!$permissions)
+		$permissions = $value;
+	$permissions = explode(',', $permissions);
+
+	$CI =& get_instance();
+	$CI->load->library('AuthLib');
+	$CI->load->library('PermissionLib');
+
+	return $CI->permissionlib->hasAtLeastOne(
+		$permissions,
+		'sometable',
+		PermissionLib::WRITE_RIGHT
+	);
+}
+
+/**
+ * check if has permissions for a studiengang_kz
+ */
+function has_permissions_for_stg($studiengang_kz, $permissions = '')
+{
+	if (!$permissions)
+		return false;
+	$permissions = explode(',', $permissions);
+
+	$CI =& get_instance();
+	$CI->load->library('AuthLib');
+	$CI->load->library('PermissionLib');
+
+	foreach ($permissions as $perm) {
+		if (strpos($perm, PermissionLib::PERMISSION_SEPARATOR) === false) {
+			$CI->addError(
+				'The given permission does not use the correct format',
+				FHCAPI_Controller::ERROR_TYPE_GENERAL
+			);
+			return false;
+		}
+
+		list($perm, $accesstype) = explode(PermissionLib::PERMISSION_SEPARATOR, $perm);
+		$at = '';
+		if (strpos($accesstype, PermissionLib::READ_RIGHT) !== false)
+			$at = PermissionLib::SELECT_RIGHT; // S
+		if (strpos($accesstype, PermissionLib::WRITE_RIGHT) !== false)
+			$at .= PermissionLib::REPLACE_RIGHT.PermissionLib::DELETE_RIGHT; // UID
+
+		if ($CI->permissionlib->isBerechtigt($perm, $at, $studiengang_kz))
+			return true;
+	}
+
+	return false;
 }

application/helpers/hlp_header_helper.php

@@ -1,12 +1,20 @@
 <?php
-
 /**
- * FH-Complete
+ * Copyright (C) 2025 FH Technikum-Wien
  *
- * @package		FHC-Helper
- * @author		FHC-Team
- * @copyright		Copyright (c) 2022 fhcomplete.org
- * @license		GPLv3
+ * 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 2 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, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  */
 
 if (! defined('BASEPATH')) exit('No direct script access allowed');
@@ -79,15 +87,37 @@ function generateCSSsInclude($CSSs)
  */
 function generateJSDataStorageObject($indexPage, $calledPath, $calledMethod)
 {
+	$ci =& get_instance();
+	$ci->load->config('theme');
+	$ci->load->model('system/Sprache_model','SpracheModel');
+	$server_language = getData($ci->SpracheModel->loadWhere(['content' => true]));
+	$server_language = array_map(function($language){
+		return ['sprache'=>$language->sprache, 'LC_Time'=>$language->locale, 'bezeichnung'=>$language->bezeichnung[$language->index-1]];
+	}, $server_language);
+	$user_language = getUserLanguage();
+
+	$ci->load->config('javascript');
+	$systemerror_mailto = $ci->config->item('systemerror_mailto');
+
+	$FHC_JS_DATA_STORAGE_OBJECT = array(
+		'app_root' => APP_ROOT,
+		'ci_router' => $indexPage,
+		'called_path' => $calledPath,
+		'called_method' => $calledMethod,
+		'server_languages' => $server_language,
+		'user_language' => $user_language,
+		'timezone' => date_default_timezone_get(),
+		'systemerror_mailto' => $systemerror_mailto,
+		'theme' => [
+			'name'=>$ci->config->item('theme_name'),
+			'modes'=>$ci->config->item('theme_modes'),
+		]
+	);
+
 	$toPrint = "\n";
 	$toPrint .= '<script type="text/javascript">';
 	$toPrint .= '
-		var FHC_JS_DATA_STORAGE_OBJECT = {
-			app_root: "'.APP_ROOT.'",
-			ci_router: "'.$indexPage.'",
-			called_path: "'.$calledPath.'",
-			called_method: "'.$calledMethod.'"
-		};';
+		var FHC_JS_DATA_STORAGE_OBJECT = '.json_encode($FHC_JS_DATA_STORAGE_OBJECT).';';
 	$toPrint .= "\n";
 	$toPrint .= '</script>';
 	$toPrint .= "\n\n";
@@ -139,6 +169,31 @@ function generateJSsInclude($JSs)
 	}
 }
 
+/**
+ * Generates tags for the javascript modules you want to include, the parameter could by a string or an array of strings
+ */
+function generateJSModulesInclude($JSModules)
+{
+	$jsInclude = '<script type="module" src="%s"></script>';
+
+	$ci =& get_instance();
+	$cachetoken = '?'.$ci->config->item('fhcomplete_build_version');
+
+	if (isset($JSModules))
+	{
+		$tmpJSs = is_array($JSModules) ? $JSModules : array($JSModules);
+
+		for ($tmpJSsCounter = 0; $tmpJSsCounter < count($tmpJSs); $tmpJSsCounter++)
+		{
+			$toPrint = sprintf($jsInclude, base_url($tmpJSs[$tmpJSsCounter].$cachetoken)).PHP_EOL;
+
+			if ($tmpJSsCounter > 0) $toPrint = "\t\t".$toPrint;
+
+			echo $toPrint;
+		}
+	}
+}
+
 /**
  * Generates all the includes needed by the Addons
  */
@@ -146,19 +201,26 @@ function generateAddonsJSsInclude($calledFrom)
 {
 	$aktive_addons = array_filter(explode(";", ACTIVE_ADDONS));
 
+	// For each active addon
 	foreach ($aktive_addons as $addon)
 	{
+		// Build the path to the hook file
 		$hookfile = DOC_ROOT.'addons/'.$addon.'/hooks.config.inc.php';
+
+		// If the hook file exists
 		if (file_exists($hookfile))
 		{
-			$js_hooks = null; // declare variable
+			$js_hooks = array(); // default value
 
-			include($hookfile); // include the hook file
+			include($hookfile); // include the hook file where the array js_hooks should be setup
 
-			if (array_key_exists($calledFrom, $js_hooks))
+			// If it contains the provided key calledFrom
+			if (key_exists($calledFrom, $js_hooks))
 			{
 				foreach ($js_hooks[$calledFrom] as $js_file)
+				{
 					generateJSsInclude('addons/'.$addon.'/'.$js_file);
+				}
 			}
 		}
 	}
@@ -174,3 +236,14 @@ function generateBackwardCompatibleJSMsIe($js)
 	echo "<![endif]-->\n";
 }
 
+/**
+ * Constructs an accessibility skipLink https://www.w3schools.com/accessibility/accessibility_skip_links.php
+ */
+function generateSkipLink($skipID)
+{
+	$toPrint = '<a id="skiplink" href="';
+	$toPrint.=$skipID;
+	$toPrint.='" class="fhcSkipLink" aria-label="Skip to main content"></a>';
+	echo $toPrint;
+}
+

application/helpers/hlp_return_object_helper.php

@@ -25,6 +25,7 @@ if (! defined('BASEPATH')) exit('No direct script access allowed');
 
 /**
  * Used to create a return object, should not be used directly
+ * @return stdClass
  */
 function _createReturnObject($code, $error, $retval)
 {
@@ -39,7 +40,7 @@ function _createReturnObject($code, $error, $retval)
 /**
  * Success
  *
- * @return  array
+ * @return stdClass
  */
 function success($retval = null, $code = null)
 {
@@ -49,7 +50,7 @@ function success($retval = null, $code = null)
 /**
  * Error
  *
- * @return  array
+ * @return stdClass
  */
 function error($retval = null, $code = null)
 {

application/helpers/hlp_sancho_helper.php

@@ -23,9 +23,6 @@ if (! defined('BASEPATH')) exit('No direct script access allowed');
 // Functions needed in the view FHC-Header
 // ------------------------------------------------------------------------
 
-const DEFAULT_SANCHO_HEADER_IMG = 'sancho_header_DEFAULT.jpg';
-const DEFAULT_SANCHO_FOOTER_IMG = 'sancho_footer_DEFAULT.jpg';
-
 /**
  * Send single Mail with Sancho Design and Layout.
  * @param string $vorlage_kurzbz Name of the template for specific mail content.
@@ -38,27 +35,88 @@ const DEFAULT_SANCHO_FOOTER_IMG = 'sancho_footer_DEFAULT.jpg';
  * @param string $bcc Sets BCC of mail.
  * @return void
  */
-function sendSanchoMail($vorlage_kurzbz, $vorlage_data, $to, $subject, $headerImg = DEFAULT_SANCHO_HEADER_IMG, $footerImg = DEFAULT_SANCHO_FOOTER_IMG, $from = null, $cc = null, $bcc = null)
+function sendSanchoMail(
+	$vorlage_kurzbz,
+	$vorlage_data,
+	$to,
+	$subject,
+	$headerImg = '',
+	$footerImg = '',
+	$from = null,
+	$cc = null,
+	$bcc = null
+)
 {
 	$ci =& get_instance();
 	$ci->load->library('email');
 	$ci->load->library('MailLib');
 
-	$sanchoHeader_img = 'skin/images/sancho/'. $headerImg;
-	$sanchoFooter_img = 'skin/images/sancho/'. $footerImg;
+	$sancho_mail_config = $ci->config->item('mail');
+
 
 	if ($from == '')
 	{
-		$from = 'sancho@'.DOMAIN;
+		$from = ((isset($sancho_mail_config['sancho_mail_default_sender'])
+				&& $sancho_mail_config['sancho_mail_default_sender']) 
+			  ? $sancho_mail_config['sancho_mail_default_sender']
+			  : 'noreply')
+			  . '@' . DOMAIN;
 	}
 
 	// Embed sancho header and footer image
 	// reset important to ensure embedding of images when called in a loop
 	$ci->email->clear(true);  // clear vars and attachments
-	$ci->email->attach($sanchoHeader_img);
-	$ci->email->attach($sanchoFooter_img);
-	$cid_header = $ci->email->attachment_cid($sanchoHeader_img); // sets unique content id for embedding
-	$cid_footer = $ci->email->attachment_cid($sanchoFooter_img); // sets unique content id for embedding
+
+	$cid_header = '';
+	$cid_footer = '';
+
+	if (isset($sancho_mail_config['sancho_mail_use_images']) && $sancho_mail_config['sancho_mail_use_images'])
+	{
+		$sanchoHeader_img = '';
+		$sanchoFooter_img = '';
+
+		if (isset($headerImg) && $headerImg != '')
+		{
+			// use provided header image
+			$sanchoHeader_img = $headerImg;
+		}
+		elseif (isset($sancho_mail_config['sancho_mail_header_img']) && $sancho_mail_config['sancho_mail_header_img'])
+		{
+			// use default header image
+			$sanchoHeader_img = $sancho_mail_config['sancho_mail_header_img'];
+		}
+
+		if (isset($footerImg) && $footerImg != '')
+		{
+			// use provided footer image
+			$sanchoFooter_img = $footerImg;
+		}
+		elseif (isset($sancho_mail_config['sancho_mail_footer_img']) && $sancho_mail_config['sancho_mail_footer_img'])
+		{
+			// use default footer image
+			$sanchoFooter_img =  $sancho_mail_config['sancho_mail_footer_img'];
+		}
+
+		// add image file paths
+		if (isset($sancho_mail_config['sancho_mail_img_path']))
+		{
+			if ($sanchoHeader_img != '')
+			{
+				$sanchoHeader_img = $sancho_mail_config['sancho_mail_img_path'].$sanchoHeader_img;
+			}
+
+			if ($sanchoFooter_img != '')
+			{
+				$sanchoFooter_img = $sancho_mail_config['sancho_mail_img_path'].$sanchoFooter_img;
+			}
+		}
+
+		// attach header and footer
+		$ci->email->attach($sanchoHeader_img, 'inline');
+		$ci->email->attach($sanchoFooter_img, 'inline');
+		$cid_header = $ci->email->attachment_cid($sanchoHeader_img); // sets unique content id for embedding
+		$cid_footer = $ci->email->attachment_cid($sanchoFooter_img); // sets unique content id for embedding
+	}
 
 	// Set specific mail content into specific content template
 	$content = _parseMailContent($vorlage_kurzbz, $vorlage_data);
@@ -74,7 +132,18 @@ function sendSanchoMail($vorlage_kurzbz, $vorlage_data, $to, $subject, $headerIm
 	$body = _parseMailContent('Sancho_Mail_Template', $layout);
 
 	// Send mail
-	$ci->maillib->send($from, $to, $subject, $body, $alias = '', $cc, $bcc, $altMessage = '', $bulk = true, $autogenerated = true);
+	return $ci->maillib->send(
+		$from,
+		$to,
+		$subject,
+		$body,
+		'', // alias
+		$cc,
+		$bcc,
+		'', // altMessage
+		true, // bulk
+		true // autogenerated
+	);
 }
 
 /**