]> git.mxchange.org Git - friendica.git/blobdiff - src/Core/Worker.php
Refactor IManageConfigValues interface
[friendica.git] / src / Core / Worker.php
index 69ca6004ceb5d4ece347c20b677c6ed501bab226..2db9256d13804c372a5e0e98b44c77f67f1eb215 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2010-2022, the Friendica project
+ * @copyright Copyright (C) 2010-2023, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -31,12 +31,20 @@ use Friendica\Util\DateTimeFormat;
  */
 class Worker
 {
-       const PRIORITY_UNDEFINED  = PRIORITY_UNDEFINED;
-       const PRIORITY_CRITICAL   = PRIORITY_CRITICAL;
-       const PRIORITY_HIGH       = PRIORITY_HIGH;
-       const PRIORITY_MEDIUM     = PRIORITY_MEDIUM;
-       const PRIORITY_LOW        = PRIORITY_LOW;
-       const PRIORITY_NEGLIGIBLE = PRIORITY_NEGLIGIBLE;
+       /**
+        * @name Priority
+        *
+        * Process priority for the worker
+        * @{
+        */
+       const PRIORITY_UNDEFINED  = 0;
+       const PRIORITY_CRITICAL   = 10;
+       const PRIORITY_HIGH       = 20;
+       const PRIORITY_MEDIUM     = 30;
+       const PRIORITY_LOW        = 40;
+       const PRIORITY_NEGLIGIBLE = 50;
+       const PRIORITIES          = [self::PRIORITY_CRITICAL, self::PRIORITY_HIGH, self::PRIORITY_MEDIUM, self::PRIORITY_LOW, self::PRIORITY_NEGLIGIBLE];
+       /* @}*/
 
        const STATE_STARTUP    = 1; // Worker is in startup. This takes most time.
        const STATE_LONG_LOOP  = 2; // Worker is processing the whole - long - loop.
@@ -81,9 +89,9 @@ class Worker
                self::$process = $process;
 
                // Kill stale processes every 5 minutes
-               $last_cleanup = DI::config()->get('system', 'worker_last_cleaned', 0);
+               $last_cleanup = DI::keyValue()->get('worker_last_cleaned') ?? 0;
                if (time() > ($last_cleanup + 300)) {
-                       DI::config()->set('system', 'worker_last_cleaned', time());
+                       DI::keyValue()->set( 'worker_last_cleaned', time());
                        Worker\Cron::killStaleWorkers();
                }
 
@@ -307,17 +315,7 @@ class Worker
                        return false;
                }
 
-               $valid = false;
-               if (strpos($file, 'include/') === 0) {
-                       $valid = true;
-               }
-
-               if (strpos($file, 'addon/') === 0) {
-                       $valid = true;
-               }
-
-               // Simply return flag
-               return $valid;
+               return (strpos($file, 'addon/') === 0);
        }
 
        /**
@@ -333,7 +331,7 @@ class Worker
                $mypid = getmypid();
 
                // Quit when in maintenance
-               if (DI::config()->get('system', 'maintenance', false, true)) {
+               if (DI::config()->get('system', 'maintenance', false)) {
                        Logger::notice('Maintenance mode - quit process', ['pid' => $mypid]);
                        return false;
                }
@@ -390,7 +388,7 @@ class Worker
                        $stamp = (float)microtime(true);
                        $condition = ["`id` = ? AND `next_try` < ?", $queue['id'], DateTimeFormat::utcNow()];
                        if (DBA::update('workerqueue', ['done' => true], $condition)) {
-                               DI::config()->set('system', 'last_worker_execution', DateTimeFormat::utcNow());
+                               DI::keyValue()->set('last_worker_execution', DateTimeFormat::utcNow());
                        }
                        self::$db_duration = (microtime(true) - $stamp);
                        self::$db_duration_write += (microtime(true) - $stamp);
@@ -398,11 +396,6 @@ class Worker
                        return true;
                }
 
-               // The script could be provided as full path or only with the function name
-               if ($include == basename($include)) {
-                       $include = 'include/' . $include . '.php';
-               }
-
                if (!self::validateInclude($include)) {
                        Logger::warning('Include file is not valid', ['file' => $argv[0]]);
                        $stamp = (float)microtime(true);
@@ -436,7 +429,7 @@ class Worker
 
                        $stamp = (float)microtime(true);
                        if (DBA::update('workerqueue', ['done' => true], ['id' => $queue['id']])) {
-                               DI::config()->set('system', 'last_worker_execution', DateTimeFormat::utcNow());
+                               DI::keyValue()->set('last_worker_execution', DateTimeFormat::utcNow());
                        }
                        self::$db_duration = (microtime(true) - $stamp);
                        self::$db_duration_write += (microtime(true) - $stamp);
@@ -461,11 +454,15 @@ class Worker
                $load_cooldown      = DI::config()->get('system', 'worker_load_cooldown');
                $processes_cooldown = DI::config()->get('system', 'worker_processes_cooldown');
 
+               if ($load_cooldown == 0) {
+                       $load_cooldown = DI::config()->get('system', 'maxloadavg');
+               }
+
                if (($load_cooldown == 0) && ($processes_cooldown == 0)) {
                        return false;
                }
 
-               $load = System::getLoadAvg();
+               $load = System::getLoadAvg($processes_cooldown != 0);
                if (empty($load)) {
                        return false;
                }
@@ -501,13 +498,17 @@ class Worker
                $load_cooldown      = DI::config()->get('system', 'worker_load_cooldown');
                $processes_cooldown = DI::config()->get('system', 'worker_processes_cooldown');
 
+               if ($load_cooldown == 0) {
+                       $load_cooldown = DI::config()->get('system', 'maxloadavg');
+               }
+
                if (($load_cooldown == 0) && ($processes_cooldown == 0)) {
                        return;
                }
 
                $sleeping = false;
 
-               while ($load = System::getLoadAvg()) {
+               while ($load = System::getLoadAvg($processes_cooldown != 0)) {
                        if (($load_cooldown > 0) && ($load['average1'] > $load_cooldown)) {
                                if (!$sleeping) {
                                        Logger::notice('Load induced pre execution cooldown.', ['max' => $load_cooldown, 'load' => $load, 'called-by' => System::callstack(1)]);
@@ -567,7 +568,15 @@ class Worker
 
                // Set the workerLogger as new default logger
                if ($method_call) {
-                       call_user_func_array(sprintf('Friendica\Worker\%s::execute', $funcname), $argv);
+                       try {
+                               call_user_func_array(sprintf('Friendica\Worker\%s::execute', $funcname), $argv);
+                       } catch (\TypeError $e) {
+                               // No need to defer a worker queue entry if the arguments are invalid
+                               Logger::notice('Wrong worker arguments', ['class' => $funcname, 'argv' => $argv, 'queue' => $queue, 'message' => $e->getMessage()]);
+                       } catch (\Throwable $e) {
+                               Logger::error('Uncaught exception in worker execution', ['class' => get_class($e), 'message' => $e->getMessage(), 'code' => $e->getCode(), 'file' => $e->getFile() . ':' . $e->getLine(), 'trace' => $e->getTraceAsString(), 'previous' => $e->getPrevious()]);
+                               Worker::defer();
+                       }
                } else {
                        $funcname($argv, count($argv));
                }
@@ -799,7 +808,7 @@ class Worker
                                $top_priority = self::highestPriority();
                                $high_running = self::processWithPriorityActive($top_priority);
 
-                               if (!$high_running && ($top_priority > PRIORITY_UNDEFINED) && ($top_priority < PRIORITY_NEGLIGIBLE)) {
+                               if (!$high_running && ($top_priority > self::PRIORITY_UNDEFINED) && ($top_priority < self::PRIORITY_NEGLIGIBLE)) {
                                        Logger::info('Jobs with a higher priority are waiting but none is executed. Open a fastlane.', ['priority' => $top_priority]);
                                        $queues = $active + 1;
                                }
@@ -931,7 +940,7 @@ class Worker
        private static function nextPriority()
        {
                $waiting = [];
-               $priorities = [PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE];
+               $priorities = [self::PRIORITY_CRITICAL, self::PRIORITY_HIGH, self::PRIORITY_MEDIUM, self::PRIORITY_LOW, self::PRIORITY_NEGLIGIBLE];
                foreach ($priorities as $priority) {
                        $stamp = (float)microtime(true);
                        if (DBA::exists('workerqueue', ["`priority` = ? AND `pid` = 0 AND NOT `done` AND `next_try` < ?", $priority, DateTimeFormat::utcNow()])) {
@@ -940,8 +949,8 @@ class Worker
                        self::$db_duration += (microtime(true) - $stamp);
                }
 
-               if (!empty($waiting[PRIORITY_CRITICAL])) {
-                       return PRIORITY_CRITICAL;
+               if (!empty($waiting[self::PRIORITY_CRITICAL])) {
+                       return self::PRIORITY_CRITICAL;
                }
 
                $running = [];
@@ -1198,8 +1207,8 @@ class Worker
         * @param (integer|array) priority or parameter array, strings are deprecated and are ignored
         *
         * next args are passed as $cmd command line
-        * or: Worker::add(PRIORITY_HIGH, 'Notifier', Delivery::DELETION, $drop_id);
-        * or: Worker::add(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), 'Delivery', $post_id);
+        * or: Worker::add(Worker::PRIORITY_HIGH, 'Notifier', Delivery::DELETION, $drop_id);
+        * or: Worker::add(array('priority' => Worker::PRIORITY_HIGH, 'dont_fork' => true), 'Delivery', $post_id);
         *
         * @return int '0' if worker queue entry already existed or there had been an error, otherwise the ID of the worker task
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
@@ -1222,7 +1231,7 @@ class Worker
                        return 1;
                }
 
-               $priority = PRIORITY_MEDIUM;
+               $priority = self::PRIORITY_MEDIUM;
                // Don't fork from frontend tasks by default
                $dont_fork = DI::config()->get('system', 'worker_dont_fork', false) || !DI::mode()->isBackend();
                $created = DateTimeFormat::utcNow();
@@ -1255,12 +1264,12 @@ class Worker
 
                $command = array_shift($args);
                $parameters = json_encode($args);
-               $found = DBA::exists('workerqueue', ['command' => $command, 'parameter' => $parameters, 'done' => false]);
+               $queue = DBA::selectFirst('workerqueue', ['id', 'priority'], ['command' => $command, 'parameter' => $parameters, 'done' => false]);
                $added = 0;
 
-               if (!is_int($priority) || !in_array($priority, PRIORITIES)) {
+               if (!is_int($priority) || !in_array($priority, self::PRIORITIES)) {
                        Logger::warning('Invalid priority', ['priority' => $priority, 'command' => $command, 'callstack' => System::callstack(20)]);
-                       $priority = PRIORITY_MEDIUM;
+                       $priority = self::PRIORITY_MEDIUM;
                }
 
                // Quit if there was a database error - a precaution for the update process to 3.5.3
@@ -1268,14 +1277,17 @@ class Worker
                        return 0;
                }
 
-               if (!$found) {
+               if (empty($queue)) {
                        if (!DBA::insert('workerqueue', ['command' => $command, 'parameter' => $parameters, 'created' => $created,
                                'priority' => $priority, 'next_try' => $delayed])) {
                                return 0;
                        }
                        $added = DBA::lastInsertId();
                } elseif ($force_priority) {
-                       DBA::update('workerqueue', ['priority' => $priority], ['command' => $command, 'parameter' => $parameters, 'done' => false, 'pid' => 0]);
+                       $ret = DBA::update('workerqueue', ['priority' => $priority], ['command' => $command, 'parameter' => $parameters, 'done' => false, 'pid' => 0]);
+                       if ($ret && ($priority != $queue['priority'])) {
+                               $added = $queue['id'];
+                       }
                }
 
                // Set the IPC flag to ensure an immediate process execution via daemon
@@ -1375,12 +1387,12 @@ class Worker
                $delay = (($new_retrial + 2) ** 4) + (rand(1, 30) * ($new_retrial));
                $next = DateTimeFormat::utc('now + ' . $delay . ' seconds');
 
-               if (($priority < PRIORITY_MEDIUM) && ($new_retrial > 3)) {
-                       $priority = PRIORITY_MEDIUM;
-               } elseif (($priority < PRIORITY_LOW) && ($new_retrial > 6)) {
-                       $priority = PRIORITY_LOW;
-               } elseif (($priority < PRIORITY_NEGLIGIBLE) && ($new_retrial > 8)) {
-                       $priority = PRIORITY_NEGLIGIBLE;
+               if (($priority < self::PRIORITY_MEDIUM) && ($new_retrial > 3)) {
+                       $priority = self::PRIORITY_MEDIUM;
+               } elseif (($priority < self::PRIORITY_LOW) && ($new_retrial > 6)) {
+                       $priority = self::PRIORITY_LOW;
+               } elseif (($priority < self::PRIORITY_NEGLIGIBLE) && ($new_retrial > 8)) {
+                       $priority = self::PRIORITY_NEGLIGIBLE;
                }
 
                Logger::info('Deferred task', ['id' => $id, 'retrial' => $new_retrial, 'created' => $queue['created'], 'next_execution' => $next, 'old_prio' => $queue['priority'], 'new_prio' => $priority]);
@@ -1413,7 +1425,7 @@ class Worker
                        $duration = max($start, $end) - min($start, $end);
 
                        // Quit when the last cron execution had been after the previous window
-                       $last_cron = DI::config()->get('system', 'last_cron_daily');
+                       $last_cron = DI::keyValue()->get('last_cron_daily');
                        if ($last_cron + $duration > time()) {
                                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)]);
                                return false;