3 * @copyright Copyright (C) 2020, Friendica
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Core;
24 use Friendica\App\Mode;
26 use Friendica\Database\DBA;
28 use Friendica\Util\DateTimeFormat;
31 * Contains the class for the worker background job processing
35 const STATE_STARTUP = 1; // Worker is in startup. This takes most time.
36 const STATE_LONG_LOOP = 2; // Worker is processing the whole - long - loop.
37 const STATE_REFETCH = 3; // Worker had refetched jobs in the execution loop.
38 const STATE_SHORT_LOOP = 4; // Worker is processing preassigned jobs, thus saving much time.
40 const FAST_COMMANDS = ['APDelivery', 'Delivery'];
42 const LOCK_PROCESS = 'worker_process';
43 const LOCK_WORKER = 'worker';
45 private static $up_start;
46 private static $db_duration = 0;
47 private static $db_duration_count = 0;
48 private static $db_duration_write = 0;
49 private static $db_duration_stat = 0;
50 private static $lock_duration = 0;
51 private static $last_update;
52 private static $state;
53 private static $daemon_mode = null;
56 * Processes the tasks that are in the workerqueue table
58 * @param boolean $run_cron Should the cron processes be executed?
60 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
62 public static function processQueue($run_cron = true)
64 // Ensure that all "strtotime" operations do run timezone independent
65 date_default_timezone_set('UTC');
67 self::$up_start = microtime(true);
69 // At first check the maximum load. We shouldn't continue with a high load
70 if (DI::process()->isMaxLoadReached()) {
71 Logger::notice('Pre check: maximum load reached, quitting.');
75 // We now start the process. This is done after the load check since this could increase the load.
76 DI::process()->start();
78 // Kill stale processes every 5 minutes
79 $last_cleanup = DI::config()->get('system', 'worker_last_cleaned', 0);
80 if (time() > ($last_cleanup + 300)) {
81 DI::config()->set('system', 'worker_last_cleaned', time());
82 self::killStaleWorkers();
85 // Check if the system is ready
86 if (!self::isReady()) {
90 // Now we start additional cron processes if we should do so
95 $last_check = $starttime = time();
96 self::$state = self::STATE_STARTUP;
98 // We fetch the next queue entry that is about to be executed
99 while ($r = self::workerProcess()) {
100 if (self::IPCJobsExists(getmypid())) {
101 self::IPCDeleteJobState(getmypid());
104 // Don't refetch when a worker fetches tasks for multiple workers
105 $refetched = DI::config()->get('system', 'worker_multiple_fetch');
106 foreach ($r as $entry) {
107 // Assure that the priority is an integer value
108 $entry['priority'] = (int)$entry['priority'];
110 // The work will be done
111 if (!self::execute($entry)) {
112 Logger::notice('Process execution failed, quitting.');
116 // Trying to fetch new processes - but only once when successful
117 if (!$refetched && DI::lock()->acquire(self::LOCK_PROCESS, 0)) {
118 self::findWorkerProcesses();
119 DI::lock()->release(self::LOCK_PROCESS);
120 self::$state = self::STATE_REFETCH;
123 self::$state = self::STATE_SHORT_LOOP;
127 // To avoid the quitting of multiple workers only one worker at a time will execute the check
128 if ((time() > $last_check + 5) && !self::getWaitingJobForPID()) {
129 self::$state = self::STATE_LONG_LOOP;
131 if (DI::lock()->acquire(self::LOCK_WORKER, 0)) {
132 // Count active workers and compare them with a maximum value that depends on the load
133 if (self::tooMuchWorkers()) {
134 Logger::notice('Active worker limit reached, quitting.');
135 DI::lock()->release(self::LOCK_WORKER);
140 if (DI::process()->isMinMemoryReached()) {
141 Logger::warning('Memory limit reached, quitting.');
142 DI::lock()->release(self::LOCK_WORKER);
145 DI::lock()->release(self::LOCK_WORKER);
147 $last_check = time();
150 // Quit the worker once every cron interval
151 if (time() > ($starttime + (DI::config()->get('system', 'cron_interval') * 60))) {
152 Logger::info('Process lifetime reached, respawning.');
153 self::unclaimProcess();
154 if (self::isDaemonMode()) {
155 self::IPCSetJobState(true);
163 // Cleaning up. Possibly not needed, but it doesn't harm anything.
164 if (self::isDaemonMode()) {
165 self::IPCSetJobState(false);
167 Logger::info("Couldn't select a workerqueue entry, quitting process", ['pid' => getmypid()]);
171 * Checks if the system is ready.
173 * Several system parameters like memory, connections and processes are checked.
177 public static function isReady()
179 // Count active workers and compare them with a maximum value that depends on the load
180 if (self::tooMuchWorkers()) {
181 Logger::notice('Active worker limit reached, quitting.');
185 // Do we have too few memory?
186 if (DI::process()->isMinMemoryReached()) {
187 Logger::warning('Memory limit reached, quitting.');
191 // Possibly there are too much database connections
192 if (self::maxConnectionsReached()) {
193 Logger::warning('Maximum connections reached, quitting.');
197 // Possibly there are too much database processes that block the system
198 if (DI::process()->isMaxProcessesReached()) {
199 Logger::warning('Maximum processes reached, quitting.');
207 * Check if non executed tasks do exist in the worker queue
209 * @return boolean Returns "true" if tasks are existing
212 public static function entriesExists()
214 $stamp = (float)microtime(true);
215 $exists = DBA::exists('workerqueue', ["NOT `done` AND `pid` = 0 AND `next_try` < ?", DateTimeFormat::utcNow()]);
216 self::$db_duration += (microtime(true) - $stamp);
221 * Returns the number of deferred entries in the worker queue
223 * @return integer Number of deferred entries in the worker queue
226 private static function deferredEntries()
228 $stamp = (float)microtime(true);
229 $count = DBA::count('workerqueue', ["NOT `done` AND `pid` = 0 AND `retrial` > ?", 0]);
230 self::$db_duration += (microtime(true) - $stamp);
231 self::$db_duration_count += (microtime(true) - $stamp);
236 * Returns the number of non executed entries in the worker queue
238 * @return integer Number of non executed entries in the worker queue
241 private static function totalEntries()
243 $stamp = (float)microtime(true);
244 $count = DBA::count('workerqueue', ['done' => false, 'pid' => 0]);
245 self::$db_duration += (microtime(true) - $stamp);
246 self::$db_duration_count += (microtime(true) - $stamp);
251 * Returns the highest priority in the worker queue that isn't executed
253 * @return integer Number of active worker processes
256 private static function highestPriority()
258 $stamp = (float)microtime(true);
259 $condition = ["`pid` = 0 AND NOT `done` AND `next_try` < ?", DateTimeFormat::utcNow()];
260 $workerqueue = DBA::selectFirst('workerqueue', ['priority'], $condition, ['order' => ['priority']]);
261 self::$db_duration += (microtime(true) - $stamp);
262 if (DBA::isResult($workerqueue)) {
263 return $workerqueue["priority"];
270 * Returns if a process with the given priority is running
272 * @param integer $priority The priority that should be checked
274 * @return integer Is there a process running with that priority?
277 private static function processWithPriorityActive($priority)
279 $condition = ["`priority` <= ? AND `pid` != 0 AND NOT `done`", $priority];
280 return DBA::exists('workerqueue', $condition);
284 * Execute a worker entry
286 * @param array $queue Workerqueue entry
288 * @return boolean "true" if further processing should be stopped
289 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
291 public static function execute($queue)
295 // Quit when in maintenance
296 if (DI::config()->get('system', 'maintenance', false, true)) {
297 Logger::notice("Maintenance mode - quit process", ['pid' => $mypid]);
301 // Constantly check the number of parallel database processes
302 if (DI::process()->isMaxProcessesReached()) {
303 Logger::warning("Max processes reached for process", ['pid' => $mypid]);
307 // Constantly check the number of available database connections to let the frontend be accessible at any time
308 if (self::maxConnectionsReached()) {
309 Logger::warning("Max connection reached for process", ['pid' => $mypid]);
313 $argv = json_decode($queue['parameter'], true);
314 if (!empty($queue['command'])) {
315 array_unshift($argv, $queue['command']);
319 Logger::warning('Parameter is empty', ['queue' => $queue]);
323 // Check for existance and validity of the include file
326 if (method_exists(sprintf('Friendica\Worker\%s', $include), 'execute')) {
327 // We constantly update the "executed" date every minute to avoid being killed too soon
328 if (!isset(self::$last_update)) {
329 self::$last_update = strtotime($queue["executed"]);
332 $age = (time() - self::$last_update) / 60;
333 self::$last_update = time();
336 $stamp = (float)microtime(true);
337 DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow()], ['pid' => $mypid, 'done' => false]);
338 self::$db_duration += (microtime(true) - $stamp);
339 self::$db_duration_write += (microtime(true) - $stamp);
344 self::execFunction($queue, $include, $argv, true);
346 $stamp = (float)microtime(true);
347 $condition = ["`id` = ? AND `next_try` < ?", $queue['id'], DateTimeFormat::utcNow()];
348 if (DBA::update('workerqueue', ['done' => true], $condition)) {
349 DI::config()->set('system', 'last_worker_execution', DateTimeFormat::utcNow());
351 self::$db_duration = (microtime(true) - $stamp);
352 self::$db_duration_write += (microtime(true) - $stamp);
357 // The script could be provided as full path or only with the function name
358 if ($include == basename($include)) {
359 $include = "include/".$include.".php";
362 if (!validate_include($include)) {
363 Logger::warning("Include file is not valid", ['file' => $argv[0]]);
364 $stamp = (float)microtime(true);
365 DBA::delete('workerqueue', ['id' => $queue["id"]]);
366 self::$db_duration = (microtime(true) - $stamp);
367 self::$db_duration_write += (microtime(true) - $stamp);
371 require_once $include;
373 $funcname = str_replace(".php", "", basename($argv[0]))."_run";
375 if (function_exists($funcname)) {
376 // We constantly update the "executed" date every minute to avoid being killed too soon
377 if (!isset(self::$last_update)) {
378 self::$last_update = strtotime($queue["executed"]);
381 $age = (time() - self::$last_update) / 60;
382 self::$last_update = time();
385 $stamp = (float)microtime(true);
386 DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow()], ['pid' => $mypid, 'done' => false]);
387 self::$db_duration += (microtime(true) - $stamp);
388 self::$db_duration_write += (microtime(true) - $stamp);
391 self::execFunction($queue, $funcname, $argv, false);
393 $stamp = (float)microtime(true);
394 if (DBA::update('workerqueue', ['done' => true], ['id' => $queue["id"]])) {
395 DI::config()->set('system', 'last_worker_execution', DateTimeFormat::utcNow());
397 self::$db_duration = (microtime(true) - $stamp);
398 self::$db_duration_write += (microtime(true) - $stamp);
400 Logger::warning("Function does not exist", ['function' => $funcname]);
401 $stamp = (float)microtime(true);
402 DBA::delete('workerqueue', ['id' => $queue["id"]]);
403 self::$db_duration = (microtime(true) - $stamp);
404 self::$db_duration_write += (microtime(true) - $stamp);
411 * Execute a function from the queue
413 * @param array $queue Workerqueue entry
414 * @param string $funcname name of the function
415 * @param array $argv Array of values to be passed to the function
416 * @param boolean $method_call boolean
418 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
420 private static function execFunction($queue, $funcname, $argv, $method_call)
424 $cooldown = DI::config()->get("system", "worker_cooldown", 0);
426 Logger::info('Pre execution cooldown.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'cooldown' => $cooldown]);
430 Logger::enableWorker($funcname);
432 Logger::info("Process start.", ['priority' => $queue["priority"], 'id' => $queue["id"]]);
434 $stamp = (float)microtime(true);
436 // We use the callstack here to analyze the performance of executed worker entries.
437 // For this reason the variables have to be initialized.
438 DI::profiler()->reset();
440 if (!in_array($queue['priority'], PRIORITIES)) {
441 Logger::warning('Invalid priority', ['queue' => $queue, 'callstack' => System::callstack(20)]);
442 $queue['priority'] = PRIORITY_MEDIUM;
447 $up_duration = microtime(true) - self::$up_start;
449 // Reset global data to avoid interferences
452 // Set the workerLogger as new default logger
454 call_user_func_array(sprintf('Friendica\Worker\%s::execute', $funcname), $argv);
456 $funcname($argv, count($argv));
459 Logger::disableWorker();
463 $duration = (microtime(true) - $stamp);
465 /* With these values we can analyze how effective the worker is.
466 * The database and rest time should be low since this is the unproductive time.
467 * The execution time is the productive time.
468 * By changing parameters like the maximum number of workers we can check the effectivness.
470 $dbtotal = round(self::$db_duration, 2);
471 $dbread = round(self::$db_duration - (self::$db_duration_count + self::$db_duration_write + self::$db_duration_stat), 2);
472 $dbcount = round(self::$db_duration_count, 2);
473 $dbstat = round(self::$db_duration_stat, 2);
474 $dbwrite = round(self::$db_duration_write, 2);
475 $dblock = round(self::$lock_duration, 2);
476 $rest = round(max(0, $up_duration - (self::$db_duration + self::$lock_duration)), 2);
477 $exec = round($duration, 2);
479 Logger::info('Performance:', ['state' => self::$state, 'count' => $dbcount, 'stat' => $dbstat, 'write' => $dbwrite, 'lock' => $dblock, 'total' => $dbtotal, 'rest' => $rest, 'exec' => $exec]);
481 self::$up_start = microtime(true);
482 self::$db_duration = 0;
483 self::$db_duration_count = 0;
484 self::$db_duration_stat = 0;
485 self::$db_duration_write = 0;
486 self::$lock_duration = 0;
488 if ($duration > 3600) {
489 Logger::info('Longer than 1 hour.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
490 } elseif ($duration > 600) {
491 Logger::info('Longer than 10 minutes.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
492 } elseif ($duration > 300) {
493 Logger::info('Longer than 5 minutes.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
494 } elseif ($duration > 120) {
495 Logger::info('Longer than 2 minutes.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
498 Logger::info('Process done.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration, 3)]);
500 DI::profiler()->saveLog(DI::logger(), "ID " . $queue["id"] . ": " . $funcname);
503 Logger::info('Post execution cooldown.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'cooldown' => $cooldown]);
509 * Checks if the number of database connections has reached a critical limit.
511 * @return bool Are more than 3/4 of the maximum connections used?
512 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
514 private static function maxConnectionsReached()
516 // Fetch the max value from the config. This is needed when the system cannot detect the correct value by itself.
517 $max = DI::config()->get("system", "max_connections");
519 // Fetch the percentage level where the worker will get active
520 $maxlevel = DI::config()->get("system", "max_connections_level", 75);
523 // the maximum number of possible user connections can be a system variable
524 $r = DBA::fetchFirst("SHOW VARIABLES WHERE `variable_name` = 'max_user_connections'");
525 if (DBA::isResult($r)) {
528 // Or it can be granted. This overrides the system variable
529 $stamp = (float)microtime(true);
530 $r = DBA::p('SHOW GRANTS');
531 self::$db_duration += (microtime(true) - $stamp);
532 while ($grants = DBA::fetch($r)) {
533 $grant = array_pop($grants);
534 if (stristr($grant, "GRANT USAGE ON")) {
535 if (preg_match("/WITH MAX_USER_CONNECTIONS (\d*)/", $grant, $match)) {
543 // If $max is set we will use the processlist to determine the current number of connections
544 // The processlist only shows entries of the current user
546 $stamp = (float)microtime(true);
547 $r = DBA::p('SHOW PROCESSLIST');
548 self::$db_duration += (microtime(true) - $stamp);
549 $used = DBA::numRows($r);
552 Logger::info("Connection usage (user values)", ['usage' => $used, 'max' => $max]);
554 $level = ($used / $max) * 100;
556 if ($level >= $maxlevel) {
557 Logger::warning("Maximum level (".$maxlevel."%) of user connections reached: ".$used."/".$max);
562 // We will now check for the system values.
563 // This limit could be reached although the user limits are fine.
564 $r = DBA::fetchFirst("SHOW VARIABLES WHERE `variable_name` = 'max_connections'");
565 if (!DBA::isResult($r)) {
568 $max = intval($r["Value"]);
572 $r = DBA::fetchFirst("SHOW STATUS WHERE `variable_name` = 'Threads_connected'");
573 if (!DBA::isResult($r)) {
576 $used = intval($r["Value"]);
580 Logger::info("Connection usage (system values)", ['used' => $used, 'max' => $max]);
582 $level = $used / $max * 100;
584 if ($level < $maxlevel) {
587 Logger::warning("Maximum level (".$level."%) of system connections reached: ".$used."/".$max);
592 * fix the queue entry if the worker process died
597 private static function killStaleWorkers()
599 $stamp = (float)microtime(true);
600 $entries = DBA::select(
602 ['id', 'pid', 'executed', 'priority', 'command', 'parameter'],
603 ['NOT `done` AND `pid` != 0'],
604 ['order' => ['priority', 'retrial', 'created']]
606 self::$db_duration += (microtime(true) - $stamp);
608 while ($entry = DBA::fetch($entries)) {
609 if (!posix_kill($entry["pid"], 0)) {
610 $stamp = (float)microtime(true);
613 ['executed' => DBA::NULL_DATETIME, 'pid' => 0],
614 ['id' => $entry["id"]]
616 self::$db_duration += (microtime(true) - $stamp);
617 self::$db_duration_write += (microtime(true) - $stamp);
619 // Kill long running processes
620 // Check if the priority is in a valid range
621 if (!in_array($entry["priority"], [PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE])) {
622 $entry["priority"] = PRIORITY_MEDIUM;
625 // Define the maximum durations
626 $max_duration_defaults = [PRIORITY_CRITICAL => 720, PRIORITY_HIGH => 10, PRIORITY_MEDIUM => 60, PRIORITY_LOW => 180, PRIORITY_NEGLIGIBLE => 720];
627 $max_duration = $max_duration_defaults[$entry["priority"]];
629 $argv = json_decode($entry['parameter'], true);
630 if (!empty($entry['command'])) {
631 $command = $entry['command'];
632 } elseif (!empty($argv)) {
633 $command = array_shift($argv);
638 $command = basename($command);
640 // How long is the process already running?
641 $duration = (time() - strtotime($entry["executed"])) / 60;
642 if ($duration > $max_duration) {
643 Logger::notice('Worker process took too much time - killed', ['duration' => number_format($duration, 3), 'max' => $max_duration, 'id' => $entry["id"], 'pid' => $entry["pid"], 'command' => $command]);
644 posix_kill($entry["pid"], SIGTERM);
646 // We killed the stale process.
647 // To avoid a blocking situation we reschedule the process at the beginning of the queue.
648 // Additionally we are lowering the priority. (But not PRIORITY_CRITICAL)
649 $new_priority = $entry["priority"];
650 if ($entry["priority"] == PRIORITY_HIGH) {
651 $new_priority = PRIORITY_MEDIUM;
652 } elseif ($entry["priority"] == PRIORITY_MEDIUM) {
653 $new_priority = PRIORITY_LOW;
654 } elseif ($entry["priority"] != PRIORITY_CRITICAL) {
655 $new_priority = PRIORITY_NEGLIGIBLE;
657 $stamp = (float)microtime(true);
660 ['executed' => DBA::NULL_DATETIME, 'created' => DateTimeFormat::utcNow(), 'priority' => $new_priority, 'pid' => 0],
661 ['id' => $entry["id"]]
663 self::$db_duration += (microtime(true) - $stamp);
664 self::$db_duration_write += (microtime(true) - $stamp);
666 Logger::info('Process runtime is okay', ['duration' => number_format($duration, 3), 'max' => $max_duration, 'id' => $entry["id"], 'pid' => $entry["pid"], 'command' => $command]);
670 DBA::close($entries);
674 * Checks if the number of active workers exceeds the given limits
676 * @return bool Are there too much workers running?
677 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
679 private static function tooMuchWorkers()
681 $queues = DI::config()->get("system", "worker_queues", 10);
683 $maxqueues = $queues;
685 $active = self::activeWorkers();
687 // Decrease the number of workers at higher load
688 $load = System::currentLoad();
690 $maxsysload = intval(DI::config()->get("system", "maxloadavg", 20));
692 /* Default exponent 3 causes queues to rapidly decrease as load increases.
693 * If you have 20 max queues at idle, then you get only 5 queues at 37.1% of $maxsysload.
694 * For some environments, this rapid decrease is not needed.
695 * With exponent 1, you could have 20 max queues at idle and 13 at 37% of $maxsysload.
697 $exponent = intval(DI::config()->get('system', 'worker_load_exponent', 3));
698 $slope = pow(max(0, $maxsysload - $load) / $maxsysload, $exponent);
699 $queues = intval(ceil($slope * $maxqueues));
703 if (DI::config()->get('system', 'worker_jpm')) {
704 $intervals = explode(',', DI::config()->get('system', 'worker_jpm_range'));
705 $jobs_per_minute = [];
706 foreach ($intervals as $interval) {
707 if ($interval == 0) {
710 $interval = (int)$interval;
713 $stamp = (float)microtime(true);
714 $jobs = DBA::p("SELECT COUNT(*) AS `jobs` FROM `workerqueue` WHERE `done` AND `executed` > UTC_TIMESTAMP() - INTERVAL ? MINUTE", $interval);
715 self::$db_duration += (microtime(true) - $stamp);
716 self::$db_duration_stat += (microtime(true) - $stamp);
717 if ($job = DBA::fetch($jobs)) {
718 $jobs_per_minute[$interval] = number_format($job['jobs'] / $interval, 0);
722 $processlist = ' - jpm: '.implode('/', $jobs_per_minute);
725 // Create a list of queue entries grouped by their priority
726 $listitem = [0 => ''];
728 $idle_workers = $active;
730 $deferred = self::deferredEntries();
732 if (DI::config()->get('system', 'worker_debug')) {
733 $waiting_processes = 0;
734 // Now adding all processes with workerqueue entries
735 $stamp = (float)microtime(true);
736 $jobs = DBA::p("SELECT COUNT(*) AS `entries`, `priority` FROM `workerqueue` WHERE NOT `done` GROUP BY `priority`");
737 self::$db_duration += (microtime(true) - $stamp);
738 self::$db_duration_stat += (microtime(true) - $stamp);
739 while ($entry = DBA::fetch($jobs)) {
740 $stamp = (float)microtime(true);
741 $processes = DBA::p("SELECT COUNT(*) AS `running` FROM `workerqueue-view` WHERE `priority` = ?", $entry["priority"]);
742 self::$db_duration += (microtime(true) - $stamp);
743 self::$db_duration_stat += (microtime(true) - $stamp);
744 if ($process = DBA::fetch($processes)) {
745 $idle_workers -= $process["running"];
746 $waiting_processes += $entry["entries"];
747 $listitem[$entry["priority"]] = $entry["priority"].":".$process["running"]."/".$entry["entries"];
749 DBA::close($processes);
753 $waiting_processes = self::totalEntries();
754 $stamp = (float)microtime(true);
755 $jobs = DBA::p("SELECT COUNT(*) AS `running`, `priority` FROM `workerqueue-view` GROUP BY `priority` ORDER BY `priority`");
756 self::$db_duration += (microtime(true) - $stamp);
757 self::$db_duration_stat += (microtime(true) - $stamp);
759 while ($entry = DBA::fetch($jobs)) {
760 $idle_workers -= $entry["running"];
761 $listitem[$entry["priority"]] = $entry["priority"].":".$entry["running"];
766 $waiting_processes -= $deferred;
768 $listitem[0] = "0:" . max(0, $idle_workers);
770 $processlist .= ' ('.implode(', ', $listitem).')';
772 if (DI::config()->get("system", "worker_fastlane", false) && ($queues > 0) && ($active >= $queues) && self::entriesExists()) {
773 $top_priority = self::highestPriority();
774 $high_running = self::processWithPriorityActive($top_priority);
776 if (!$high_running && ($top_priority > PRIORITY_UNDEFINED) && ($top_priority < PRIORITY_NEGLIGIBLE)) {
777 Logger::info("Jobs with a higher priority are waiting but none is executed. Open a fastlane.", ['priority' => $top_priority]);
778 $queues = $active + 1;
782 Logger::notice("Load: " . $load ."/" . $maxsysload . " - processes: " . $deferred . "/" . $active . "/" . $waiting_processes . $processlist . " - maximum: " . $queues . "/" . $maxqueues);
784 // Are there fewer workers running as possible? Then fork a new one.
785 if (!DI::config()->get("system", "worker_dont_fork", false) && ($queues > ($active + 1)) && self::entriesExists()) {
786 Logger::info("There are fewer workers as possible, fork a new worker.", ['active' => $active, 'queues' => $queues]);
787 if (self::isDaemonMode()) {
788 self::IPCSetJobState(true);
795 // if there are too much worker, we don't spawn a new one.
796 if (self::isDaemonMode() && ($active > $queues)) {
797 self::IPCSetJobState(false);
800 return $active > $queues;
804 * Returns the number of active worker processes
806 * @return integer Number of active worker processes
809 private static function activeWorkers()
811 $stamp = (float)microtime(true);
812 $count = DBA::count('process', ['command' => 'Worker.php']);
813 self::$db_duration += (microtime(true) - $stamp);
814 self::$db_duration_count += (microtime(true) - $stamp);
819 * Returns the number of active worker processes
821 * @return array List of worker process ids
824 private static function getWorkerPIDList()
827 $stamp = (float)microtime(true);
829 $queues = DBA::p("SELECT `process`.`pid`, COUNT(`workerqueue`.`pid`) AS `entries` FROM `process`
830 LEFT JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `workerqueue`.`done`
831 GROUP BY `process`.`pid`");
832 while ($queue = DBA::fetch($queues)) {
833 $ids[$queue['pid']] = $queue['entries'];
837 self::$db_duration += (microtime(true) - $stamp);
838 self::$db_duration_count += (microtime(true) - $stamp);
843 * Returns waiting jobs for the current process id
845 * @return array waiting workerqueue jobs
848 private static function getWaitingJobForPID()
850 $stamp = (float)microtime(true);
851 $r = DBA::select('workerqueue', [], ['pid' => getmypid(), 'done' => false]);
852 self::$db_duration += (microtime(true) - $stamp);
853 if (DBA::isResult($r)) {
854 return DBA::toArray($r);
862 * Returns the next jobs that should be executed
864 * @return array array with next jobs
867 private static function nextProcess(int $limit)
869 $priority = self::nextPriority();
870 if (empty($priority)) {
871 Logger::info('No tasks found');
876 $stamp = (float)microtime(true);
877 $condition = ["`priority` = ? AND `pid` = 0 AND NOT `done` AND `next_try` < ?", $priority, DateTimeFormat::utcNow()];
878 $tasks = DBA::select('workerqueue', ['id', 'command', 'parameter'], $condition, ['limit' => $limit, 'order' => ['retrial', 'created']]);
879 self::$db_duration += (microtime(true) - $stamp);
880 while ($task = DBA::fetch($tasks)) {
881 $ids[] = $task['id'];
882 // Only continue that loop while we are storing commands that can be processed quickly
883 if (!empty($task['command'])) {
884 $command = $task['command'];
886 $command = json_decode($task['parameter'])[0];
889 if (!in_array($command, self::FAST_COMMANDS)) {
895 Logger::info('Found:', ['priority' => $priority, 'id' => $ids]);
900 * Returns the priority of the next workerqueue job
902 * @return string priority
905 private static function nextPriority()
908 $priorities = [PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE];
909 foreach ($priorities as $priority) {
910 $stamp = (float)microtime(true);
911 if (DBA::exists('workerqueue', ["`priority` = ? AND `pid` = 0 AND NOT `done` AND `next_try` < ?", $priority, DateTimeFormat::utcNow()])) {
912 $waiting[$priority] = true;
914 self::$db_duration += (microtime(true) - $stamp);
917 if (!empty($waiting[PRIORITY_CRITICAL])) {
918 return PRIORITY_CRITICAL;
923 $stamp = (float)microtime(true);
924 $processes = DBA::p("SELECT COUNT(DISTINCT(`pid`)) AS `running`, `priority` FROM `workerqueue-view` GROUP BY `priority`");
925 self::$db_duration += (microtime(true) - $stamp);
926 while ($process = DBA::fetch($processes)) {
927 $running[$process['priority']] = $process['running'];
928 $running_total += $process['running'];
930 DBA::close($processes);
932 foreach ($priorities as $priority) {
933 if (!empty($waiting[$priority]) && empty($running[$priority])) {
934 Logger::info('No running worker found with priority {priority} - assigning it.', ['priority' => $priority]);
939 $active = max(self::activeWorkers(), $running_total);
940 $priorities = max(count($waiting), count($running));
944 for ($i = 1; $i <= $priorities; ++$i) {
945 $total += pow($i, $exponent);
949 for ($i = 1; $i <= $priorities; ++$i) {
950 $limit[$priorities - $i] = max(1, round($active * (pow($i, $exponent) / $total)));
954 foreach ($running as $priority => $workers) {
955 if ($workers < $limit[$i++]) {
956 Logger::info('Priority {priority} has got {workers} workers out of a limit of {limit}', ['priority' => $priority, 'workers' => $workers, 'limit' => $limit[$i - 1]]);
961 if (!empty($waiting)) {
962 $priority = array_keys($waiting)[0];
963 Logger::info('No underassigned priority found, now taking the highest priority.', ['priority' => $priority]);
971 * Find and claim the next worker process for us
973 * @return boolean Have we found something?
974 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
976 private static function findWorkerProcesses()
978 $fetch_limit = DI::config()->get('system', 'worker_fetch_limit', 1);
980 if (DI::config()->get('system', 'worker_multiple_fetch')) {
982 foreach (self::getWorkerPIDList() as $pid => $count) {
983 if ($count <= $fetch_limit) {
990 $limit = $fetch_limit * count($pids);
992 $pids = [getmypid()];
993 $limit = $fetch_limit;
996 $ids = self::nextProcess($limit);
997 $limit -= count($ids);
999 // If there is not enough results we check without priority limit
1001 $stamp = (float)microtime(true);
1002 $condition = ["`pid` = 0 AND NOT `done` AND `next_try` < ?", DateTimeFormat::utcNow()];
1003 $tasks = DBA::select('workerqueue', ['id', 'command', 'parameter'], $condition, ['limit' => $limit, 'order' => ['priority', 'retrial', 'created']]);
1004 self::$db_duration += (microtime(true) - $stamp);
1006 while ($task = DBA::fetch($tasks)) {
1007 $ids[] = $task['id'];
1008 // Only continue that loop while we are storing commands that can be processed quickly
1009 if (!empty($task['command'])) {
1010 $command = $task['command'];
1012 $command = json_decode($task['parameter'])[0];
1014 if (!in_array($command, self::FAST_COMMANDS)) {
1025 // Assign the task ids to the workers
1027 foreach (array_unique($ids) as $id) {
1030 $pid = reset($pids);
1032 $worker[$pid][] = $id;
1035 $stamp = (float)microtime(true);
1036 foreach ($worker as $worker_pid => $worker_ids) {
1037 Logger::info('Set queue entry', ['pid' => $worker_pid, 'ids' => $worker_ids]);
1038 DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow(), 'pid' => $worker_pid],
1039 ['id' => $worker_ids, 'done' => false, 'pid' => 0]);
1041 self::$db_duration += (microtime(true) - $stamp);
1042 self::$db_duration_write += (microtime(true) - $stamp);
1046 * Returns the next worker process
1048 * @return array worker processes
1049 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1051 public static function workerProcess()
1053 // There can already be jobs for us in the queue.
1054 $waiting = self::getWaitingJobForPID();
1055 if (!empty($waiting)) {
1059 $stamp = (float)microtime(true);
1060 if (!DI::lock()->acquire(self::LOCK_PROCESS)) {
1063 self::$lock_duration += (microtime(true) - $stamp);
1065 self::findWorkerProcesses();
1067 DI::lock()->release(self::LOCK_PROCESS);
1069 return self::getWaitingJobForPID();
1073 * Removes a workerqueue entry from the current process
1076 * @throws \Exception
1078 public static function unclaimProcess()
1080 $mypid = getmypid();
1082 $stamp = (float)microtime(true);
1083 DBA::update('workerqueue', ['executed' => DBA::NULL_DATETIME, 'pid' => 0], ['pid' => $mypid, 'done' => false]);
1084 self::$db_duration += (microtime(true) - $stamp);
1085 self::$db_duration_write += (microtime(true) - $stamp);
1089 * Call the front end worker
1092 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1094 public static function callWorker()
1096 if (!DI::config()->get("system", "frontend_worker")) {
1100 $url = DI::baseUrl() . '/worker';
1101 DI::httpRequest()->fetch($url, 1);
1105 * Call the front end worker if there aren't any active
1108 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1110 public static function executeIfIdle()
1112 self::checkDaemonState();
1114 if (!DI::config()->get("system", "frontend_worker")) {
1118 // Do we have "proc_open"? Then we can fork the worker
1119 if (function_exists("proc_open")) {
1120 // When was the last time that we called the worker?
1121 // Less than one minute? Then we quit
1122 if ((time() - DI::config()->get("system", "worker_started")) < 60) {
1126 DI::config()->set("system", "worker_started", time());
1128 // Do we have enough running workers? Then we quit here.
1129 if (self::tooMuchWorkers()) {
1130 // Cleaning dead processes
1131 self::killStaleWorkers();
1132 DI::modelProcess()->deleteInactive();
1139 Logger::info('Call worker');
1140 self::spawnWorker();
1144 // We cannot execute background processes.
1145 // We now run the processes from the frontend.
1146 // This won't work with long running processes.
1149 self::clearProcesses();
1151 $workers = self::activeWorkers();
1153 if ($workers == 0) {
1159 * Removes long running worker processes
1162 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1164 public static function clearProcesses()
1166 $timeout = DI::config()->get("system", "frontend_worker_timeout", 10);
1168 /// @todo We should clean up the corresponding workerqueue entries as well
1169 $stamp = (float)microtime(true);
1170 $condition = ["`created` < ? AND `command` = 'worker.php'",
1171 DateTimeFormat::utc("now - ".$timeout." minutes")];
1172 DBA::delete('process', $condition);
1173 self::$db_duration = (microtime(true) - $stamp);
1174 self::$db_duration_write += (microtime(true) - $stamp);
1178 * Runs the cron processes
1181 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1183 private static function runCron()
1185 Logger::info('Add cron entries');
1187 // Check for spooled items
1188 self::add(['priority' => PRIORITY_HIGH, 'force_priority' => true], 'SpoolPost');
1190 // Run the cron job that calls all other jobs
1191 self::add(['priority' => PRIORITY_MEDIUM, 'force_priority' => true], 'Cron');
1193 // Cleaning dead processes
1194 self::killStaleWorkers();
1198 * Fork a child process
1200 * @param boolean $do_cron
1203 private static function forkProcess(bool $do_cron)
1205 if (DI::process()->isMinMemoryReached()) {
1206 Logger::warning('Memory limit reached - quitting');
1210 // Children inherit their parent's database connection.
1211 // To avoid problems we disconnect and connect both parent and child
1213 $pid = pcntl_fork();
1216 Logger::warning('Could not spawn worker');
1219 // The parent process continues here
1222 self::IPCSetJobState(true, $pid);
1223 Logger::info('Spawned new worker', ['pid' => $pid]);
1226 while (self::IPCJobsExists($pid) && (++$cycles < 100)) {
1230 Logger::info('Spawned worker is ready', ['pid' => $pid, 'wait_cycles' => $cycles]);
1234 // We now are in the new worker
1236 /// @todo Reinitialize the logger to set a new process_id and uid
1239 while (!self::IPCJobsExists($pid) && (++$cycles < 100)) {
1243 Logger::info('Worker spawned', ['pid' => getmypid(), 'wait_cycles' => $cycles]);
1245 self::processQueue($do_cron);
1247 self::unclaimProcess();
1249 self::IPCSetJobState(false, getmypid());
1250 DI::process()->end();
1251 Logger::info('Worker ended', ['pid' => getmypid()]);
1256 * Spawns a new worker
1258 * @param bool $do_cron
1260 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1262 public static function spawnWorker($do_cron = false)
1264 if (self::isDaemonMode() && DI::config()->get('system', 'worker_fork')) {
1265 self::forkProcess($do_cron);
1267 $process = new Core\Process(DI::logger(), DI::mode(), DI::config(),
1268 DI::modelProcess(), DI::app()->getBasePath(), getmypid());
1269 $process->run('bin/worker.php', ['no_cron' => !$do_cron]);
1271 if (self::isDaemonMode()) {
1272 self::IPCSetJobState(false);
1277 * Adds tasks to the worker queue
1279 * @param (integer|array) priority or parameter array, strings are deprecated and are ignored
1281 * next args are passed as $cmd command line
1282 * or: Worker::add(PRIORITY_HIGH, "Notifier", Delivery::DELETION, $drop_id);
1283 * or: Worker::add(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "Delivery", $post_id);
1285 * @return boolean "false" if worker queue entry already existed or there had been an error
1286 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1287 * @note $cmd and string args are surrounded with ""
1293 public static function add($cmd)
1295 $args = func_get_args();
1297 if (!count($args)) {
1301 $arr = ['args' => $args, 'run_cmd' => true];
1303 Hook::callAll("proc_run", $arr);
1304 if (!$arr['run_cmd'] || !count($args)) {
1308 $priority = PRIORITY_MEDIUM;
1309 // Don't fork from frontend tasks by default
1310 $dont_fork = DI::config()->get("system", "worker_dont_fork", false) || !DI::mode()->isBackend();
1311 $created = DateTimeFormat::utcNow();
1312 $delayed = DBA::NULL_DATETIME;
1313 $force_priority = false;
1315 $run_parameter = array_shift($args);
1317 if (is_int($run_parameter)) {
1318 $priority = $run_parameter;
1319 } elseif (is_array($run_parameter)) {
1320 if (isset($run_parameter['delayed'])) {
1321 $delayed = $run_parameter['delayed'];
1323 if (isset($run_parameter['priority'])) {
1324 $priority = $run_parameter['priority'];
1326 if (isset($run_parameter['created'])) {
1327 $created = $run_parameter['created'];
1329 if (isset($run_parameter['dont_fork'])) {
1330 $dont_fork = $run_parameter['dont_fork'];
1332 if (isset($run_parameter['force_priority'])) {
1333 $force_priority = $run_parameter['force_priority'];
1337 $command = array_shift($args);
1338 $parameters = json_encode($args);
1339 $found = DBA::exists('workerqueue', ['command' => $command, 'parameter' => $parameters, 'done' => false]);
1342 if (!in_array($priority, PRIORITIES)) {
1343 Logger::warning('Invalid priority', ['priority' => $priority, 'command' => $command, 'callstack' => System::callstack(20)]);
1344 $priority = PRIORITY_MEDIUM;
1347 // Quit if there was a database error - a precaution for the update process to 3.5.3
1348 if (DBA::errorNo() != 0) {
1353 $added = DBA::insert('workerqueue', ['command' => $command, 'parameter' => $parameters, 'created' => $created,
1354 'priority' => $priority, 'next_try' => $delayed]);
1358 } elseif ($force_priority) {
1359 DBA::update('workerqueue', ['priority' => $priority], ['command' => $command, 'parameter' => $parameters, 'done' => false, 'pid' => 0]);
1362 // Set the IPC flag to ensure an immediate process execution via daemon
1363 if (self::isDaemonMode()) {
1364 self::IPCSetJobState(true);
1367 self::checkDaemonState();
1369 // Should we quit and wait for the worker to be called as a cronjob?
1374 // If there is a lock then we don't have to check for too much worker
1375 if (!DI::lock()->acquire(self::LOCK_WORKER, 0)) {
1379 // If there are already enough workers running, don't fork another one
1380 $quit = self::tooMuchWorkers();
1381 DI::lock()->release(self::LOCK_WORKER);
1387 // Quit on daemon mode
1388 if (self::isDaemonMode()) {
1392 // Now call the worker to execute the jobs that we just added to the queue
1393 self::spawnWorker();
1398 public static function countWorkersByCommand(string $command)
1400 return DBA::count('workerqueue', ['done' => false, 'pid' => 0, 'command' => $command]);
1404 * Returns the next retrial level for worker jobs.
1405 * This function will skip levels when jobs are older.
1407 * @param array $queue Worker queue entry
1408 * @param integer $max_level maximum retrial level
1409 * @return integer the next retrial level value
1411 private static function getNextRetrial($queue, $max_level)
1413 $created = strtotime($queue['created']);
1414 $retrial_time = time() - $created;
1416 $new_retrial = $queue['retrial'] + 1;
1418 for ($retrial = 0; $retrial <= $max_level + 1; ++$retrial) {
1419 $delay = (($retrial + 3) ** 4) + (rand(1, 30) * ($retrial + 1));
1421 if (($total < $retrial_time) && ($retrial > $queue['retrial'])) {
1422 $new_retrial = $retrial;
1425 Logger::notice('New retrial for task', ['id' => $queue['id'], 'created' => $queue['created'], 'old' => $queue['retrial'], 'new' => $new_retrial]);
1426 return $new_retrial;
1430 * Defers the current worker entry
1432 * @return boolean had the entry been deferred?
1434 public static function defer()
1436 if (empty(DI::app()->queue)) {
1440 $queue = DI::app()->queue;
1442 $retrial = $queue['retrial'];
1444 $priority = $queue['priority'];
1446 $max_level = DI::config()->get('system', 'worker_defer_limit');
1448 $new_retrial = self::getNextRetrial($queue, $max_level);
1450 if ($new_retrial > $max_level) {
1451 Logger::notice('The task exceeded the maximum retry count', ['id' => $id, 'created' => $queue['created'], 'old_prio' => $queue['priority'], 'old_retrial' => $queue['retrial'], 'max_level' => $max_level, 'retrial' => $new_retrial]);
1455 // Calculate the delay until the next trial
1456 $delay = (($new_retrial + 2) ** 4) + (rand(1, 30) * ($new_retrial));
1457 $next = DateTimeFormat::utc('now + ' . $delay . ' seconds');
1459 if (($priority < PRIORITY_MEDIUM) && ($new_retrial > 3)) {
1460 $priority = PRIORITY_MEDIUM;
1461 } elseif (($priority < PRIORITY_LOW) && ($new_retrial > 6)) {
1462 $priority = PRIORITY_LOW;
1463 } elseif (($priority < PRIORITY_NEGLIGIBLE) && ($new_retrial > 8)) {
1464 $priority = PRIORITY_NEGLIGIBLE;
1467 Logger::info('Deferred task', ['id' => $id, 'retrial' => $new_retrial, 'created' => $queue['created'], 'next_execution' => $next, 'old_prio' => $queue['priority'], 'new_prio' => $priority]);
1469 $stamp = (float)microtime(true);
1470 $fields = ['retrial' => $new_retrial, 'next_try' => $next, 'executed' => DBA::NULL_DATETIME, 'pid' => 0, 'priority' => $priority];
1471 DBA::update('workerqueue', $fields, ['id' => $id]);
1472 self::$db_duration += (microtime(true) - $stamp);
1473 self::$db_duration_write += (microtime(true) - $stamp);
1479 * Set the flag if some job is waiting
1481 * @param boolean $jobs Is there a waiting job?
1482 * @param int $key Key number
1483 * @throws \Exception
1485 public static function IPCSetJobState(bool $jobs, int $key = 0)
1487 $stamp = (float)microtime(true);
1488 DBA::replace('worker-ipc', ['jobs' => $jobs, 'key' => $key]);
1489 self::$db_duration += (microtime(true) - $stamp);
1490 self::$db_duration_write += (microtime(true) - $stamp);
1494 * Delete a key entry
1496 * @param int $key Key number
1497 * @throws \Exception
1499 public static function IPCDeleteJobState(int $key)
1501 $stamp = (float)microtime(true);
1502 DBA::delete('worker-ipc', ['key' => $key]);
1503 self::$db_duration += (microtime(true) - $stamp);
1504 self::$db_duration_write += (microtime(true) - $stamp);
1508 * Checks if some worker job waits to be executed
1510 * @param int $key Key number
1512 * @throws \Exception
1514 public static function IPCJobsExists(int $key = 0)
1516 $stamp = (float)microtime(true);
1517 $row = DBA::selectFirst('worker-ipc', ['jobs'], ['key' => $key]);
1518 self::$db_duration += (microtime(true) - $stamp);
1520 // When we don't have a row, no job is running
1521 if (!DBA::isResult($row)) {
1525 return (bool)$row['jobs'];
1529 * Checks if the worker is running in the daemon mode.
1533 public static function isDaemonMode()
1535 if (!is_null(self::$daemon_mode)) {
1536 return self::$daemon_mode;
1539 if (DI::mode()->getExecutor() == Mode::DAEMON) {
1543 $daemon_mode = DI::config()->get('system', 'worker_daemon_mode', false, true);
1545 return $daemon_mode;
1548 if (!function_exists('pcntl_fork')) {
1549 self::$daemon_mode = false;
1553 $pidfile = DI::config()->get('system', 'pidfile');
1554 if (empty($pidfile)) {
1555 // No pid file, no daemon
1556 self::$daemon_mode = false;
1560 if (!is_readable($pidfile)) {
1561 // No pid file. We assume that the daemon had been intentionally stopped.
1562 self::$daemon_mode = false;
1566 $pid = intval(file_get_contents($pidfile));
1567 $running = posix_kill($pid, 0);
1569 self::$daemon_mode = $running;
1574 * Test if the daemon is running. If not, it will be started
1578 private static function checkDaemonState()
1580 if (!DI::config()->get('system', 'daemon_watchdog', false)) {
1584 if (!DI::mode()->isNormal()) {
1588 // Check every minute if the daemon is running
1589 if (DI::config()->get('system', 'last_daemon_check', 0) + 60 > time()) {
1593 DI::config()->set('system', 'last_daemon_check', time());
1595 $pidfile = DI::config()->get('system', 'pidfile');
1596 if (empty($pidfile)) {
1597 // No pid file, no daemon
1601 if (!is_readable($pidfile)) {
1602 // No pid file. We assume that the daemon had been intentionally stopped.
1606 $pid = intval(file_get_contents($pidfile));
1607 if (posix_kill($pid, 0)) {
1608 Logger::info('Daemon process is running', ['pid' => $pid]);
1612 Logger::warning('Daemon process is not running', ['pid' => $pid]);
1614 self::spawnDaemon();
1618 * Spawn a new daemon process
1622 private static function spawnDaemon()
1624 Logger::notice('Starting new daemon process');
1625 $command = 'bin/daemon.php';
1627 $process = new Core\Process(DI::logger(), DI::mode(), DI::config(), DI::modelProcess(), $a->getBasePath(), getmypid());
1628 $process->run($command, ['start']);
1629 Logger::notice('New daemon process started');
1633 * Check if the system is inside the defined maintenance window
1637 public static function isInMaintenanceWindow(bool $check_last_execution = false)
1639 // Calculate the seconds of the start end end of the maintenance window
1640 $start = strtotime(DI::config()->get('system', 'maintenance_start')) % 86400;
1641 $end = strtotime(DI::config()->get('system', 'maintenance_end')) % 86400;
1643 Logger::info('Maintenance window', ['start' => date('H:i:s', $start), 'end' => date('H:i:s', $end)]);
1645 if ($check_last_execution) {
1646 // Calculate the window duration
1647 $duration = max($start, $end) - min($start, $end);
1649 // Quit when the last cron execution had been after the previous window
1650 $last_cron = DI::config()->get('system', 'last_cron_daily');
1651 if ($last_cron + $duration > time()) {
1652 Logger::info('The Daily cron had been executed recently', ['last' => date(DateTimeFormat::MYSQL, $last_cron), 'start' => date('H:i:s', $start), 'end' => date('H:i:s', $end)]);
1657 $current = time() % 86400;
1659 if ($start < $end) {
1660 // Execute if we are inside the window
1661 $execute = ($current >= $start) && ($current <= $end);
1663 // Don't execute if we are outside the window
1664 $execute = !(($current > $end) && ($current < $start));
1668 Logger::info('We are inside the maintenance window', ['current' => date('H:i:s', $current), 'start' => date('H:i:s', $start), 'end' => date('H:i:s', $end)]);
1670 Logger::info('We are outside the maintenance window', ['current' => date('H:i:s', $current), 'start' => date('H:i:s', $start), 'end' => date('H:i:s', $end)]);