]> git.mxchange.org Git - friendica.git/blobdiff - src/Core/Worker.php
Merge pull request #11506 from annando/featured-worker
[friendica.git] / src / Core / Worker.php
index 3d3e11d8dd642e7c20eb9716fb3d439465a0fe2c..e29cf765a4fa38c5885798ef396cc0c6a9b8f89a 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2010-2021, the Friendica project
+ * @copyright Copyright (C) 2010-2022, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -22,7 +22,7 @@
 namespace Friendica\Core;
 
 use Friendica\App\Mode;
-use Friendica\Core;
+use Friendica\Core\Worker\Entity\Process;
 use Friendica\Database\DBA;
 use Friendica\DI;
 use Friendica\Util\DateTimeFormat;
@@ -51,26 +51,29 @@ class Worker
        private static $last_update;
        private static $state;
        private static $daemon_mode = null;
+       /** @var Process */
+       private static $process;
 
        /**
         * Processes the tasks that are in the workerqueue table
         *
         * @param boolean $run_cron Should the cron processes be executed?
+        * @param Process $process  The current running process
         * @return void
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       public static function processQueue($run_cron = true)
+       public static function processQueue($run_cron, Process $process)
        {
                self::$up_start = microtime(true);
 
                // At first check the maximum load. We shouldn't continue with a high load
-               if (DI::process()->isMaxLoadReached()) {
+               if (DI::system()->isMaxLoadReached()) {
                        Logger::notice('Pre check: maximum load reached, quitting.');
                        return;
                }
 
                // We now start the process. This is done after the load check since this could increase the load.
-               DI::process()->start();
+               self::$process = $process;
 
                // Kill stale processes every 5 minutes
                $last_cleanup = DI::config()->get('system', 'worker_last_cleaned', 0);
@@ -101,8 +104,7 @@ class Worker
                        // Don't refetch when a worker fetches tasks for multiple workers
                        $refetched = DI::config()->get('system', 'worker_multiple_fetch');
                        foreach ($r as $entry) {
-                               // Assure that the priority is an integer value
-                               $entry['priority'] = (int)$entry['priority'];
+                               $entry = self::checkPriority($entry);
 
                                // The work will be done
                                if (!self::execute($entry)) {
@@ -134,7 +136,7 @@ class Worker
                                        }
 
                                        // Check free memory
-                                       if (DI::process()->isMinMemoryReached()) {
+                                       if (DI::system()->isMinMemoryReached()) {
                                                Logger::warning('Memory limit reached, quitting.');
                                                DI::lock()->release(self::LOCK_WORKER);
                                                return;
@@ -147,7 +149,7 @@ class Worker
                        // Quit the worker once every cron interval
                        if (time() > ($starttime + (DI::config()->get('system', 'cron_interval') * 60))) {
                                Logger::info('Process lifetime reached, respawning.');
-                               self::unclaimProcess();
+                               self::unclaimProcess($process);
                                if (self::isDaemonMode()) {
                                        self::IPCSetJobState(true);
                                } else {
@@ -164,6 +166,24 @@ class Worker
                Logger::info("Couldn't select a workerqueue entry, quitting process", ['pid' => getmypid()]);
        }
 
+       /**
+        * Check and fix the priority of a worker task
+        * @param array $entry
+        * @return array
+        */
+       private static function checkPriority(array $entry)
+       {
+               $entry['priority'] = (int)$entry['priority'];
+
+               if (!in_array($entry['priority'], PRIORITIES)) {
+                       Logger::warning('Invalid priority', ['entry' => $entry, 'callstack' => System::callstack(20)]);
+                       DBA::update('workerqueue', ['priority' => PRIORITY_MEDIUM], ['id' => $entry['id']]);
+                       $entry['priority'] = PRIORITY_MEDIUM;
+               }
+
+               return $entry;
+       }
+
        /**
         * Checks if the system is ready.
         *
@@ -180,7 +200,7 @@ class Worker
                }
 
                // Do we have too few memory?
-               if (DI::process()->isMinMemoryReached()) {
+               if (DI::system()->isMinMemoryReached()) {
                        Logger::warning('Memory limit reached, quitting.');
                        return false;
                }
@@ -192,7 +212,7 @@ class Worker
                }
 
                // Possibly there are too much database processes that block the system
-               if (DI::process()->isMaxProcessesReached()) {
+               if (DI::system()->isMaxProcessesReached()) {
                        Logger::warning('Maximum processes reached, quitting.');
                        return false;
                }
@@ -257,7 +277,7 @@ class Worker
                $workerqueue = DBA::selectFirst('workerqueue', ['priority'], $condition, ['order' => ['priority']]);
                self::$db_duration += (microtime(true) - $stamp);
                if (DBA::isResult($workerqueue)) {
-                       return $workerqueue["priority"];
+                       return $workerqueue['priority'];
                } else {
                        return 0;
                }
@@ -277,6 +297,44 @@ class Worker
                return DBA::exists('workerqueue', $condition);
        }
 
+       /**
+        * Checks if the given file is valid to be included
+        *
+        * @param mixed $file
+        * @return bool
+        */
+       private static function validateInclude(&$file)
+       {
+               $orig_file = $file;
+
+               $file = realpath($file);
+
+               if (strpos($file, getcwd()) !== 0) {
+                       return false;
+               }
+
+               $file = str_replace(getcwd() . "/", "", $file, $count);
+               if ($count != 1) {
+                       return false;
+               }
+
+               if ($orig_file !== $file) {
+                       return false;
+               }
+
+               $valid = false;
+               if (strpos($file, "include/") === 0) {
+                       $valid = true;
+               }
+
+               if (strpos($file, "addon/") === 0) {
+                       $valid = true;
+               }
+
+               // Simply return flag
+               return $valid;
+       }
+
        /**
         * Execute a worker entry
         *
@@ -296,7 +354,7 @@ class Worker
                }
 
                // Constantly check the number of parallel database processes
-               if (DI::process()->isMaxProcessesReached()) {
+               if (DI::system()->isMaxProcessesReached()) {
                        Logger::warning("Max processes reached for process", ['pid' => $mypid]);
                        return false;
                }
@@ -360,7 +418,7 @@ class Worker
                        $include = "include/".$include.".php";
                }
 
-               if (!validate_include($include)) {
+               if (!self::validateInclude($include)) {
                        Logger::warning("Include file is not valid", ['file' => $argv[0]]);
                        $stamp = (float)microtime(true);
                        DBA::delete('workerqueue', ['id' => $queue["id"]]);
@@ -424,13 +482,13 @@ class Worker
 
                $cooldown = DI::config()->get("system", "worker_cooldown", 0);
                if ($cooldown > 0) {
-                       Logger::info('Pre execution cooldown.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'cooldown' => $cooldown]);
+                       Logger::info('Pre execution cooldown.', ['priority' => $queue['priority'], 'id' => $queue["id"], 'cooldown' => $cooldown]);
                        sleep($cooldown);
                }
 
                Logger::enableWorker($funcname);
 
-               Logger::info("Process start.", ['priority' => $queue["priority"], 'id' => $queue["id"]]);
+               Logger::info("Process start.", ['priority' => $queue['priority'], 'id' => $queue["id"]]);
 
                $stamp = (float)microtime(true);
 
@@ -438,11 +496,6 @@ class Worker
                // For this reason the variables have to be initialized.
                DI::profiler()->reset();
 
-               if (!in_array($queue['priority'], PRIORITIES)) {
-                       Logger::warning('Invalid priority', ['queue' => $queue, 'callstack' => System::callstack(20)]);
-                       $queue['priority'] = PRIORITY_MEDIUM;
-               }
-
                $a->setQueue($queue);
 
                $up_duration = microtime(true) - self::$up_start;
@@ -487,21 +540,21 @@ class Worker
                self::$lock_duration = 0;
 
                if ($duration > 3600) {
-                       Logger::info('Longer than 1 hour.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
+                       Logger::info('Longer than 1 hour.', ['priority' => $queue['priority'], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
                } elseif ($duration > 600) {
-                       Logger::info('Longer than 10 minutes.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
+                       Logger::info('Longer than 10 minutes.', ['priority' => $queue['priority'], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
                } elseif ($duration > 300) {
-                       Logger::info('Longer than 5 minutes.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
+                       Logger::info('Longer than 5 minutes.', ['priority' => $queue['priority'], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
                } elseif ($duration > 120) {
-                       Logger::info('Longer than 2 minutes.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
+                       Logger::info('Longer than 2 minutes.', ['priority' => $queue['priority'], 'id' => $queue["id"], 'duration' => round($duration/60, 3)]);
                }
 
-               Logger::info('Process done.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'duration' => round($duration, 3)]);
+               Logger::info('Process done.', ['priority' => $queue['priority'], 'id' => $queue["id"], 'duration' => round($duration, 3)]);
 
                DI::profiler()->saveLog(DI::logger(), "ID " . $queue["id"] . ": " . $funcname);
 
                if ($cooldown > 0) {
-                       Logger::info('Post execution cooldown.', ['priority' => $queue["priority"], 'id' => $queue["id"], 'cooldown' => $cooldown]);
+                       Logger::info('Post execution cooldown.', ['priority' => $queue['priority'], 'id' => $queue["id"], 'cooldown' => $cooldown]);
                        sleep($cooldown);
                }
        }
@@ -607,6 +660,8 @@ class Worker
                self::$db_duration += (microtime(true) - $stamp);
 
                while ($entry = DBA::fetch($entries)) {
+                       $entry = self::checkPriority($entry);
+
                        if (!posix_kill($entry["pid"], 0)) {
                                $stamp = (float)microtime(true);
                                DBA::update(
@@ -618,14 +673,10 @@ class Worker
                                self::$db_duration_write += (microtime(true) - $stamp);
                        } else {
                                // Kill long running processes
-                               // Check if the priority is in a valid range
-                               if (!in_array($entry["priority"], [PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_MEDIUM, PRIORITY_LOW, PRIORITY_NEGLIGIBLE])) {
-                                       $entry["priority"] = PRIORITY_MEDIUM;
-                               }
 
                                // Define the maximum durations
                                $max_duration_defaults = [PRIORITY_CRITICAL => 720, PRIORITY_HIGH => 10, PRIORITY_MEDIUM => 60, PRIORITY_LOW => 180, PRIORITY_NEGLIGIBLE => 720];
-                               $max_duration = $max_duration_defaults[$entry["priority"]];
+                               $max_duration = $max_duration_defaults[$entry['priority']];
 
                                $argv = json_decode($entry['parameter'], true);
                                if (!empty($entry['command'])) {
@@ -647,12 +698,12 @@ class Worker
                                        // We killed the stale process.
                                        // To avoid a blocking situation we reschedule the process at the beginning of the queue.
                                        // Additionally we are lowering the priority. (But not PRIORITY_CRITICAL)
-                                       $new_priority = $entry["priority"];
-                                       if ($entry["priority"] == PRIORITY_HIGH) {
+                                       $new_priority = $entry['priority'];
+                                       if ($entry['priority'] == PRIORITY_HIGH) {
                                                $new_priority = PRIORITY_MEDIUM;
-                                       } elseif ($entry["priority"] == PRIORITY_MEDIUM) {
+                                       } elseif ($entry['priority'] == PRIORITY_MEDIUM) {
                                                $new_priority = PRIORITY_LOW;
-                                       } elseif ($entry["priority"] != PRIORITY_CRITICAL) {
+                                       } elseif ($entry['priority'] != PRIORITY_CRITICAL) {
                                                $new_priority = PRIORITY_NEGLIGIBLE;
                                        }
                                        $stamp = (float)microtime(true);
@@ -712,13 +763,10 @@ class Worker
                                        }
 
                                        $stamp = (float)microtime(true);
-                                       $jobs = DBA::p("SELECT COUNT(*) AS `jobs` FROM `workerqueue` WHERE `done` AND `executed` > UTC_TIMESTAMP() - INTERVAL ? MINUTE", $interval);
+                                       $jobs = DBA::count('workerqueue', ["`done` AND `executed` > ?", DateTimeFormat::utc('now - ' . $interval . ' minute')]);
                                        self::$db_duration += (microtime(true) - $stamp);
                                        self::$db_duration_stat += (microtime(true) - $stamp);
-                                       if ($job = DBA::fetch($jobs)) {
-                                               $jobs_per_minute[$interval] = number_format($job['jobs'] / $interval, 0);
-                                       }
-                                       DBA::close($jobs);
+                                       $jobs_per_minute[$interval] = number_format($jobs / $interval, 0);
                                }
                                $processlist = ' - jpm: '.implode('/', $jobs_per_minute);
                        }
@@ -739,15 +787,12 @@ class Worker
                                self::$db_duration_stat += (microtime(true) - $stamp);
                                while ($entry = DBA::fetch($jobs)) {
                                        $stamp = (float)microtime(true);
-                                       $processes = DBA::p("SELECT COUNT(*) AS `running` FROM `workerqueue-view` WHERE `priority` = ?", $entry["priority"]);
+                                       $running = DBA::count('workerqueue-view', ['priority' => $entry['priority']]);
                                        self::$db_duration += (microtime(true) - $stamp);
                                        self::$db_duration_stat += (microtime(true) - $stamp);
-                                       if ($process = DBA::fetch($processes)) {
-                                               $idle_workers -= $process["running"];
-                                               $waiting_processes += $entry["entries"];
-                                               $listitem[$entry["priority"]] = $entry["priority"].":".$process["running"]."/".$entry["entries"];
-                                       }
-                                       DBA::close($processes);
+                                       $idle_workers -= $running;
+                                       $waiting_processes += $entry["entries"];
+                                       $listitem[$entry['priority']] = $entry['priority'] . ":" . $running . "/" . $entry["entries"];
                                }
                                DBA::close($jobs);
                        } else {
@@ -759,7 +804,7 @@ class Worker
 
                                while ($entry = DBA::fetch($jobs)) {
                                        $idle_workers -= $entry["running"];
-                                       $listitem[$entry["priority"]] = $entry["priority"].":".$entry["running"];
+                                       $listitem[$entry['priority']] = $entry['priority'].":".$entry["running"];
                                }
                                DBA::close($jobs);
                        }
@@ -810,7 +855,7 @@ class Worker
        private static function activeWorkers()
        {
                $stamp = (float)microtime(true);
-               $count = DBA::count('process', ['command' => 'Worker.php']);
+               $count = DI::process()->countCommand('Worker.php');
                self::$db_duration += (microtime(true) - $stamp);
                self::$db_duration_count += (microtime(true) - $stamp);
                return $count;
@@ -1073,15 +1118,15 @@ class Worker
        /**
         * Removes a workerqueue entry from the current process
         *
+        * @param Process $process the process behind the workerqueue
+        *
         * @return void
         * @throws \Exception
         */
-       public static function unclaimProcess()
+       public static function unclaimProcess(Process $process)
        {
-               $mypid = getmypid();
-
                $stamp = (float)microtime(true);
-               DBA::update('workerqueue', ['executed' => DBA::NULL_DATETIME, 'pid' => 0], ['pid' => $mypid, 'done' => false]);
+               DBA::update('workerqueue', ['executed' => DBA::NULL_DATETIME, 'pid' => 0], ['pid' => $process->pid, 'done' => false]);
                self::$db_duration += (microtime(true) - $stamp);
                self::$db_duration_write += (microtime(true) - $stamp);
        }
@@ -1104,6 +1149,32 @@ class Worker
 
                // Cleaning dead processes
                self::killStaleWorkers();
+
+               // Remove old entries from the workerqueue
+               self::cleanWorkerQueue();
+       }
+
+       /**
+        * Remove old entries from the workerqueue
+        *
+        * @return void
+        */
+       private static function cleanWorkerQueue()
+       {
+               DBA::delete('workerqueue', ["`done` AND `executed` < ?", DateTimeFormat::utc('now - 1 hour')]);
+
+               // Optimizing this table only last seconds
+               if (DI::config()->get('system', 'optimize_tables')) {
+                       // We are acquiring the two locks from the worker to avoid locking problems
+                       if (DI::lock()->acquire(Worker::LOCK_PROCESS, 10)) {
+                               if (DI::lock()->acquire(Worker::LOCK_WORKER, 10)) {
+                                       DBA::e("OPTIMIZE TABLE `workerqueue`");
+                                       DBA::e("OPTIMIZE TABLE `process`");
+                                       DI::lock()->release(Worker::LOCK_WORKER);
+                               }
+                               DI::lock()->release(Worker::LOCK_PROCESS);
+                       }
+               }
        }
 
        /**
@@ -1114,7 +1185,7 @@ class Worker
         */
        private static function forkProcess(bool $do_cron)
        {
-               if (DI::process()->isMinMemoryReached()) {
+               if (DI::system()->isMinMemoryReached()) {
                        Logger::warning('Memory limit reached - quitting');
                        return;
                }
@@ -1144,26 +1215,25 @@ class Worker
                }
 
                // We now are in the new worker
-               $pid = getmypid();
-
                DBA::connect();
-               /// @todo Reinitialize the logger to set a new process_id and uid
-               DI::process()->setPid($pid);
+
+               DI::flushLogger();
+               $process = DI::process()->create(getmypid(), basename(__FILE__));
 
                $cycles = 0;
-               while (!self::IPCJobsExists($pid) && (++$cycles < 100)) {
+               while (!self::IPCJobsExists($process->pid) && (++$cycles < 100)) {
                        usleep(10000);
                }
 
-               Logger::info('Worker spawned', ['pid' => $pid, 'wait_cycles' => $cycles]);
+               Logger::info('Worker spawned', ['pid' => $process->pid, 'wait_cycles' => $cycles]);
 
-               self::processQueue($do_cron);
+               self::processQueue($do_cron, $process);
 
-               self::unclaimProcess();
+               self::unclaimProcess($process);
 
-               self::IPCSetJobState(false, $pid);
-               DI::process()->end();
-               Logger::info('Worker ended', ['pid' => $pid]);
+               self::IPCSetJobState(false, $process->pid);
+               DI::process()->delete($process);
+               Logger::info('Worker ended', ['pid' => $process->pid]);
                exit();
        }
 
@@ -1179,9 +1249,7 @@ class Worker
                if (self::isDaemonMode() && DI::config()->get('system', 'worker_fork')) {
                        self::forkProcess($do_cron);
                } else {
-                       $process = new Core\Process(DI::logger(), DI::mode(), DI::config(),
-                               DI::modelProcess(), DI::app()->getBasePath(), getmypid());
-                       $process->run('bin/worker.php', ['no_cron' => !$do_cron]);
+                       DI::system()->run('bin/worker.php', ['no_cron' => !$do_cron]);
                }
                if (self::isDaemonMode()) {
                        self::IPCSetJobState(false);
@@ -1205,10 +1273,8 @@ class Worker
         *    array $arr
         *
         */
-       public static function add($cmd)
+       public static function add(...$args)
        {
-               $args = func_get_args();
-
                if (!count($args)) {
                        return 0;
                }
@@ -1247,6 +1313,8 @@ class Worker
                        if (isset($run_parameter['force_priority'])) {
                                $force_priority = $run_parameter['force_priority'];
                        }
+               } else {
+                       throw new \InvalidArgumentException('Priority number or task parameter array expected as first argument');
                }
 
                $command = array_shift($args);
@@ -1254,7 +1322,7 @@ class Worker
                $found = DBA::exists('workerqueue', ['command' => $command, 'parameter' => $parameters, 'done' => false]);
                $added = 0;
 
-               if (!in_array($priority, PRIORITIES)) {
+               if (!is_int($priority) || !in_array($priority, PRIORITIES)) {
                        Logger::warning('Invalid priority', ['priority' => $priority, 'command' => $command, 'callstack' => System::callstack(20)]);
                        $priority = PRIORITY_MEDIUM;
                }
@@ -1345,8 +1413,9 @@ class Worker
         * Defers the current worker entry
         *
         * @return boolean had the entry been deferred?
+        * @throws \Exception
         */
-       public static function defer()
+       public static function defer(): bool
        {
                $queue = DI::app()->getQueue();
 
@@ -1354,7 +1423,8 @@ class Worker
                        return false;
                }
 
-               $retrial = $queue['retrial'];
+               $queue = self::checkPriority($queue);
+
                $id = $queue['id'];
                $priority = $queue['priority'];
 
@@ -1539,8 +1609,7 @@ class Worker
                Logger::notice('Starting new daemon process');
                $command = 'bin/daemon.php';
                $a = DI::app();
-               $process = new Core\Process(DI::logger(), DI::mode(), DI::config(), DI::modelProcess(), $a->getBasePath(), getmypid());
-               $process->run($command, ['start']);
+               DI::system()->run($command, ['start']);
                Logger::notice('New daemon process started');
        }