Merge pull request #3341 from jeedom/fix/add-safe-guard-scenario

Fix & improvement: add safe guard in scenario in "for" loop, "wait" & "sleep" actions

Author: Mips2648

core/class/config.class.php

@@ -44,7 +44,9 @@ public static function getDefaultConfiguration(string $_plugin = 'core'): array
 
 			if (file_exists(__DIR__ . '/../../data/custom/custom.config.ini')) {
 				$custom =  parse_ini_file(__DIR__ . '/../../data/custom/custom.config.ini', true);
-				self::$defaultConfiguration[$_plugin]['core'] = array_merge(self::$defaultConfiguration[$_plugin]['core'], $custom['core']);
+				if (isset($custom['core'])) {
+					self::$defaultConfiguration[$_plugin]['core'] = array_merge(self::$defaultConfiguration[$_plugin]['core'], $custom['core']);
+				}
 			}
 		} else {
 			self::$defaultConfiguration[$_plugin] = array();

core/class/scenarioElement.class.php

@@ -202,9 +202,15 @@ public function execute(&$_scenario = null) {
 			if (!is_numeric($limits)) {
 				throw new Exception(__('La condition pour une boucle doit être numérique :', __FILE__) . ' ' . $limits);
 			}
+			$endTime = time() + (int)config::byKey('scenario::element::maxExecutionTime', 'core', 3600);
 			$return = false;
 			for ($i = 1; $i <= $limits; $i++) {
 				$return = $this->getSubElement('do')->execute($_scenario);
+				if (time() > $endTime) {
+					$_scenario->setLog(__('[For] Arrêt de la boucle pour cause de durée d\'exécution trop longue', __FILE__));
+					return false;
+				}
+				sleep(1);
 			}
 			return $return;
 		} elseif ($this->getType() == 'while') {
@@ -226,13 +232,13 @@ public function execute(&$_scenario = null) {
 				message::add('scenario', $message, $action, $logicalId);
 				return;
 			}
-			$endTime = time() + 3600;
+			$endTime = time() + (int)config::byKey('scenario::element::maxExecutionTime', 'core', 3600);
 			$return = false;
 			while ($result) {
 				$return = $this->getSubElement('do')->execute($_scenario);
 				if (time() > $endTime) {
 					$_scenario->setLog(__('[While] Arrêt de la boucle pour cause de durée d\'exécution trop longue', __FILE__));
-					return;
+					return false;
 				}
 				sleep(1);
 				$result = $this->getSubElement('while')->execute($_scenario);

core/class/scenarioExpression.class.php

@@ -468,21 +468,28 @@ public static function maxBetween($_cmd_id, $_startDate, $_endDate, $_round = 1)
 		return round($historyStatistique['max'], $_round);
 	}
 
-	public static function wait($_condition, $_timeout = 7200) {
+	public static function wait($_condition, $_timeout = null, $_scenario = null) {
 		$result = false;
 		$occurence = 0;
-		$limit = 7200;
-		$timeout = jeedom::evaluateExpression($_timeout);
-		$limit = (is_numeric($timeout)) ? $timeout : 7200;
-		while ($result !== true) {
-			$result = jeedom::evaluateExpression($_condition);
-			if ($occurence > $limit) {
-				return 0;
+
+		$limit = (int)config::byKey('scenario::element::maxExecutionTime', 'core', 3600);
+		$timeout = is_string($_timeout) ? jeedom::evaluateExpression($_timeout, $_scenario) : $_timeout;
+
+		if (is_numeric($timeout) && $timeout > 0) {
+			$limit = min((int) $timeout, $limit);
+		}
+		if ($_scenario !== null && is_object($_scenario)) {
+			$_scenario->setLog(sprintf(__('[Wait] Début du wait, timeout: %ss', __FILE__), $limit));
+		}
+		while ($occurence < $limit) {
+			$result = jeedom::evaluateExpression($_condition, $_scenario);
+			if ($result === true) {
+				return 1;
 			}
 			$occurence++;
 			sleep(1);
 		}
-		return 1;
+		return 0;
 	}
 
 	public static function minBetween($_cmd_id, $_startDate, $_endDate, $_round = 1) {
@@ -1435,40 +1442,29 @@ public function execute(?scenario &$scenario = null) {
 					if (!isset($options['condition'])) {
 						return;
 					}
-					$result = false;
-					$occurence = 0;
-					$limit = 7200;
-					if (isset($options['timeout'])) {
-						$timeout = jeedom::evaluateExpression($options['timeout']);
-						$limit = (is_numeric($timeout)) ? $timeout : 7200;
-					}
-					while (!$result) {
-						$expression = self::setTags($options['condition'], $scenario, true);
-						$result = evaluate($expression);
-						if ($occurence > $limit) {
-							$this->setLog($scenario, __('[Wait] Condition valide par dépassement de temps :', __FILE__) . ' ' . $expression . ' => ' . $result);
-							return;
-						}
-						$occurence++;
-						sleep(1);
+					$result = self::wait($options['condition'], $options['timeout'], $scenario);
+					$expression = self::setTags($options['condition'], $scenario, true);
+					if ($result === 0) {
+						$this->setLog($scenario, sprintf(__('[Wait] Dépassement du timeout: %s', __FILE__), $expression));
+					} else {
+						$this->setLog($scenario, sprintf(__('[Wait] Condition valide: %s', __FILE__), $expression));
 					}
-					$this->setLog($scenario, __('[Wait] Condition valide :', __FILE__) . ' ' . $expression . ' => ' . $result);
 					return;
 				} elseif ($this->getExpression() == 'sleep') {
 					if (isset($options['duration'])) {
 						try {
-							$options['duration'] = floatval(evaluate($options['duration']));
-						} catch (Exception $e) {
-						} catch (Error $e) {
-						}
-						if ((is_float($options['duration']) || is_int($options['duration'])) && $options['duration'] > 0) {
-							$this->setLog($scenario, __('Pause de', __FILE__) . ' ' . $options['duration'] . ' ' . __('seconde(s)', __FILE__));
-							if ($options['duration'] < 1) {
-								usleep($options['duration'] * 1000000);
+							$duration = floatval(jeedom::evaluateExpression($options['duration'], $scenario));
+							if ($duration > 0) {
+								$seconds = min($duration, (int)config::byKey('scenario::element::maxExecutionTime', 'core', 3600));
+								$this->setLog($scenario, sprintf(__('Pause de %s seconde(s)', __FILE__), $seconds));
+								if ($seconds < 1) {
+									usleep((int) round($seconds * 1000000));
+									return;
+								}
+								sleep((int) floor($seconds));
 								return;
 							}
-							sleep($options['duration']);
-							return;
+						} catch (\Throwable $e) {
 						}
 					}
 					$this->setLog($scenario, $GLOBALS['JEEDOM_SCLOG_TEXT']['invalidDuration']['txt'] . $options['duration']);

core/config/default.config.ini

@@ -99,14 +99,15 @@ battery::warning = 30
 battery::danger = 5
 numberOfTryBeforeEqLogicDisable = 3
 
-;deamon
+;daemon
 deamonsSleepTime = 1
 
 ;event
 event::waitPollingTime = 1
 
-;Scénario
+;Scenario
 enableScenario = 1
+scenario::element::maxExecutionTime = 3600
 
 ;Update
 update::allowCore = 1