src/Core/Worker.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  *
  20  */
  21
  22 namespace Friendica\Core;
  23
  24 use Friendica\Core\Worker\Entity\Process;
  25 use Friendica\Database\DBA;
  26 use Friendica\DI;
  27 use Friendica\Util\DateTimeFormat;
  28
  29 /**
  30  * Contains the class for the worker background job processing
  31  */
  32 class Worker
  33 {
  34         /**
  35          * @name Priority
  36          *
  37          * Process priority for the worker
  38          * @{
  39          */
  40         const PRIORITY_UNDEFINED  = 0;
  41         const PRIORITY_CRITICAL   = 10;
  42         const PRIORITY_HIGH       = 20;
  43         const PRIORITY_MEDIUM     = 30;
  44         const PRIORITY_LOW        = 40;
  45         const PRIORITY_NEGLIGIBLE = 50;
  46         const PRIORITIES          = [self::PRIORITY_CRITICAL, self::PRIORITY_HIGH, self::PRIORITY_MEDIUM, self::PRIORITY_LOW, self::PRIORITY_NEGLIGIBLE];
  47         /* @}*/
  48
  49         const STATE_STARTUP    = 1; // Worker is in startup. This takes most time.
  50         const STATE_LONG_LOOP  = 2; // Worker is processing the whole - long - loop.
  51         const STATE_REFETCH    = 3; // Worker had refetched jobs in the execution loop.
  52         const STATE_SHORT_LOOP = 4; // Worker is processing preassigned jobs, thus saving much time.
  53
  54         const FAST_COMMANDS = ['APDelivery', 'Delivery'];
  55
  56         const LOCK_PROCESS = 'worker_process';
  57         const LOCK_WORKER = 'worker';
  58
  59         private static $up_start;
  60         private static $db_duration = 0;
  61         private static $db_duration_count = 0;
  62         private static $db_duration_write = 0;
  63         private static $db_duration_stat = 0;
  64         private static $lock_duration = 0;
  65         private static $last_update;
  66         private static $state;
  67         /** @var Process */
  68         private static $process;
  69
  70         /**
  71          * Processes the tasks that are in the workerqueue table
  72          *
  73          * @param boolean $run_cron Should the cron processes be executed?
  74          * @param Process $process  The current running process
  75          * @return void
  76          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
  77          */
  78         public static function processQueue(bool $run_cron, Process $process)
  79         {
  80                 self::$up_start = microtime(true);
  81
  82                 // At first check the maximum load. We shouldn't continue with a high load
  83                 if (DI::system()->isMaxLoadReached()) {
  84                         Logger::notice('Pre check: maximum load reached, quitting.');
  85                         return;
  86                 }
  87
  88                 // We now start the process. This is done after the load check since this could increase the load.
  89                 self::$process = $process;
  90
  91                 // Kill stale processes every 5 minutes
  92                 $last_cleanup = DI::keyValue()->get('worker_last_cleaned') ?? 0;
  93                 if (time() > ($last_cleanup + 300)) {
  94                         DI::keyValue()->set( 'worker_last_cleaned', time());
  95                         Worker\Cron::killStaleWorkers();
  96                 }
  97
  98                 // Check if the system is ready
  99                 if (!self::isReady()) {
 100                         return;
 101                 }
 102
 103                 // Now we start additional cron processes if we should do so
 104                 if ($run_cron) {
 105                         Worker\Cron::run();
 106                 }
 107
 108                 $last_check = $starttime = time();
 109                 self::$state = self::STATE_STARTUP;
 110
 111                 // We fetch the next queue entry that is about to be executed
 112                 while ($r = self::workerProcess()) {
 113                         if (Worker\IPC::JobsExists(getmypid())) {
 114                                 Worker\IPC::DeleteJobState(getmypid());
 115                         }
 116
 117                         // Don't refetch when a worker fetches tasks for multiple workers
 118                         $refetched = DI::config()->get('system', 'worker_multiple_fetch');
 119                         foreach ($r as $entry) {
 120                                 // The work will be done
 121                                 if (!self::execute($entry)) {
 122                                         Logger::warning('Process execution failed, quitting.', ['entry' => $entry]);
 123                                         return;
 124                                 }
 125
 126                                 // Trying to fetch new processes - but only once when successful
 127                                 if (!$refetched && DI::lock()->acquire(self::LOCK_PROCESS, 0)) {
 128                                         self::findWorkerProcesses();
 129                                         DI::lock()->release(self::LOCK_PROCESS);
 130                                         self::$state = self::STATE_REFETCH;
 131                                         $refetched = true;
 132                                 } else {
 133                                         self::$state = self::STATE_SHORT_LOOP;
 134                                 }
 135                         }
 136
 137                         // To avoid the quitting of multiple workers only one worker at a time will execute the check
 138                         if ((time() > $last_check + 5) && !self::getWaitingJobForPID()) {
 139                                 self::$state = self::STATE_LONG_LOOP;
 140
 141                                 if (DI::lock()->acquire(self::LOCK_WORKER, 0)) {
 142                                 // Count active workers and compare them with a maximum value that depends on the load
 143                                         if (self::tooMuchWorkers()) {
 144                                                 Logger::notice('Active worker limit reached, quitting.');
 145                                                 DI::lock()->release(self::LOCK_WORKER);
 146                                                 return;
 147                                         }
 148
 149                                         // Check free memory
 150                                         if (DI::system()->isMinMemoryReached()) {
 151                                                 Logger::warning('Memory limit reached, quitting.');
 152                                                 DI::lock()->release(self::LOCK_WORKER);
 153                                                 return;
 154                                         }
 155                                         DI::lock()->release(self::LOCK_WORKER);
 156                                 }
 157                                 $last_check = time();
 158                         }
 159
 160                         // Quit the worker once every cron interval
 161                         if (time() > ($starttime + (DI::config()->get('system', 'cron_interval') * 60)) && !self::systemLimitReached()) {
 162                                 Logger::info('Process lifetime reached, respawning.');
 163                                 self::unclaimProcess($process);
 164                                 if (Worker\Daemon::isMode()) {
 165                                         Worker\IPC::SetJobState(true);
 166                                 } else {
 167                                         self::spawnWorker();
 168                                 }
 169                                 return;
 170                         }
 171                 }
 172
 173                 // Cleaning up. Possibly not needed, but it doesn't harm anything.
 174                 if (Worker\Daemon::isMode()) {
 175                         Worker\IPC::SetJobState(false);
 176                 }
 177                 Logger::info("Couldn't select a workerqueue entry, quitting process", ['pid' => getmypid()]);
 178         }
 179
 180         /**
 181          * Checks if the system is ready.
 182          *
 183          * Several system parameters like memory, connections and processes are checked.
 184          *
 185          * @return boolean
 186          */
 187         public static function isReady(): bool
 188         {
 189                 // Count active workers and compare them with a maximum value that depends on the load
 190                 if (self::tooMuchWorkers()) {
 191                         Logger::notice('Active worker limit reached, quitting.');
 192                         return false;
 193                 }
 194
 195                 // Do we have too few memory?
 196                 if (DI::system()->isMinMemoryReached()) {
 197                         Logger::warning('Memory limit reached, quitting.');
 198                         return false;
 199                 }
 200
 201                 // Possibly there are too much database connections
 202                 if (self::maxConnectionsReached()) {
 203                         Logger::warning('Maximum connections reached, quitting.');
 204                         return false;
 205                 }
 206
 207                 // Possibly there are too much database processes that block the system
 208                 if (DI::system()->isMaxProcessesReached()) {
 209                         Logger::warning('Maximum processes reached, quitting.');
 210                         return false;
 211                 }
 212
 213                 return true;
 214         }
 215
 216         /**
 217          * Check if non executed tasks do exist in the worker queue
 218          *
 219          * @return boolean Returns "true" if tasks are existing
 220          * @throws \Exception
 221          */
 222         public static function entriesExists(): bool
 223         {
 224                 $stamp = (float)microtime(true);
 225                 $exists = DBA::exists('workerqueue', ["NOT `done` AND `pid` = 0 AND `next_try` < ?", DateTimeFormat::utcNow()]);
 226                 self::$db_duration += (microtime(true) - $stamp);
 227                 return $exists;
 228         }
 229
 230         /**
 231          * Returns the number of deferred entries in the worker queue
 232          *
 233          * @return integer Number of deferred entries in the worker queue
 234          * @throws \Exception
 235          */
 236         private static function deferredEntries(): int
 237         {
 238                 $stamp = (float)microtime(true);
 239                 $count = DBA::count('workerqueue', ["NOT `done` AND `pid` = 0 AND `retrial` > ?", 0]);
 240                 self::$db_duration += (microtime(true) - $stamp);
 241                 self::$db_duration_count += (microtime(true) - $stamp);
 242                 return $count;
 243         }
 244
 245         /**
 246          * Returns the number of non executed entries in the worker queue
 247          *
 248          * @return integer Number of non executed entries in the worker queue
 249          * @throws \Exception
 250          */
 251         private static function totalEntries(): int
 252         {
 253                 $stamp = (float)microtime(true);
 254                 $count = DBA::count('workerqueue', ['done' => false, 'pid' => 0]);
 255                 self::$db_duration += (microtime(true) - $stamp);
 256                 self::$db_duration_count += (microtime(true) - $stamp);
 257                 return $count;
 258         }
 259
 260         /**
 261          * Returns the highest priority in the worker queue that isn't executed
 262          *
 263          * @return integer Number of active worker processes
 264          * @throws \Exception
 265          */
 266         private static function highestPriority(): int
 267         {
 268                 $stamp = (float)microtime(true);
 269                 $condition = ["`pid` = 0 AND NOT `done` AND `next_try` < ?", DateTimeFormat::utcNow()];
 270                 $workerqueue = DBA::selectFirst('workerqueue', ['priority'], $condition, ['order' => ['priority']]);
 271                 self::$db_duration += (microtime(true) - $stamp);
 272                 if (DBA::isResult($workerqueue)) {
 273                         return $workerqueue['priority'];
 274                 } else {
 275                         return 0;
 276                 }
 277         }
 278
 279         /**
 280          * Returns if a process with the given priority is running
 281          *
 282          * @param integer $priority The priority that should be checked
 283          *
 284          * @return integer Is there a process running with that priority?
 285          * @throws \Exception
 286          */
 287         private static function processWithPriorityActive(int $priority): int
 288         {
 289                 $condition = ["`priority` <= ? AND `pid` != 0 AND NOT `done`", $priority];
 290                 return DBA::exists('workerqueue', $condition);
 291         }
 292
 293         /**
 294          * Checks if the given file is valid to be included
 295          *
 296          * @param mixed $file
 297          * @return bool
 298          */
 299         private static function validateInclude(&$file): bool
 300         {
 301                 $orig_file = $file;
 302
 303                 $file = realpath($file);
 304
 305                 if (strpos($file, getcwd()) !== 0) {
 306                         return false;
 307                 }
 308
 309                 $file = str_replace(getcwd() . '/', '', $file, $count);
 310                 if ($count != 1) {
 311                         return false;
 312                 }
 313
 314                 if ($orig_file !== $file) {
 315                         return false;
 316                 }
 317
 318                 return (strpos($file, 'addon/') === 0);
 319         }
 320
 321         /**
 322          * Execute a worker entry
 323          *
 324          * @param array $queue Workerqueue entry
 325          *
 326          * @return boolean "true" if further processing should be stopped
 327          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 328          */
 329         public static function execute(array $queue): bool
 330         {
 331                 $mypid = getmypid();
 332
 333                 // Quit when in maintenance
 334                 if (DI::config()->get('system', 'maintenance', false, true)) {
 335                         Logger::notice('Maintenance mode - quit process', ['pid' => $mypid]);
 336                         return false;
 337                 }
 338
 339                 // Constantly check the number of parallel database processes
 340                 if (DI::system()->isMaxProcessesReached()) {
 341                         Logger::warning('Max processes reached for process', ['pid' => $mypid]);
 342                         return false;
 343                 }
 344
 345                 // Constantly check the number of available database connections to let the frontend be accessible at any time
 346                 if (self::maxConnectionsReached()) {
 347                         Logger::warning('Max connection reached for process', ['pid' => $mypid]);
 348                         return false;
 349                 }
 350
 351                 $argv = json_decode($queue['parameter'], true);
 352                 if (!is_array($argv)) {
 353                         $argv = [];
 354                 }
 355
 356                 if (!empty($queue['command'])) {
 357                         array_unshift($argv, $queue['command']);
 358                 }
 359
 360                 if (empty($argv)) {
 361                         Logger::warning('Parameter is empty', ['queue' => $queue]);
 362                         return false;
 363                 }
 364
 365                 // Check for existance and validity of the include file
 366                 $include = $argv[0];
 367
 368                 if (method_exists(sprintf('Friendica\Worker\%s', $include), 'execute')) {
 369                         // We constantly update the "executed" date every minute to avoid being killed too soon
 370                         if (!isset(self::$last_update)) {
 371                                 self::$last_update = strtotime($queue['executed']);
 372                         }
 373
 374                         $age = (time() - self::$last_update) / 60;
 375                         self::$last_update = time();
 376
 377                         if ($age > 1) {
 378                                 $stamp = (float)microtime(true);
 379                                 DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow()], ['pid' => $mypid, 'done' => false]);
 380                                 self::$db_duration += (microtime(true) - $stamp);
 381                                 self::$db_duration_write += (microtime(true) - $stamp);
 382                         }
 383
 384                         array_shift($argv);
 385
 386                         self::execFunction($queue, $include, $argv, true);
 387
 388                         $stamp = (float)microtime(true);
 389                         $condition = ["`id` = ? AND `next_try` < ?", $queue['id'], DateTimeFormat::utcNow()];
 390                         if (DBA::update('workerqueue', ['done' => true], $condition)) {
 391                                 DI::keyValue()->set('last_worker_execution', DateTimeFormat::utcNow());
 392                         }
 393                         self::$db_duration = (microtime(true) - $stamp);
 394                         self::$db_duration_write += (microtime(true) - $stamp);
 395
 396                         return true;
 397                 }
 398
 399                 if (!self::validateInclude($include)) {
 400                         Logger::warning('Include file is not valid', ['file' => $argv[0]]);
 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);
 405                         return true;
 406                 }
 407
 408                 require_once $include;
 409
 410                 $funcname = str_replace('.php', '', basename($argv[0])) .'_run';
 411
 412                 if (function_exists($funcname)) {
 413                         // We constantly update the "executed" date every minute to avoid being killed too soon
 414                         if (!isset(self::$last_update)) {
 415                                 self::$last_update = strtotime($queue['executed']);
 416                         }
 417
 418                         $age = (time() - self::$last_update) / 60;
 419                         self::$last_update = time();
 420
 421                         if ($age > 1) {
 422                                 $stamp = (float)microtime(true);
 423                                 DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow()], ['pid' => $mypid, 'done' => false]);
 424                                 self::$db_duration += (microtime(true) - $stamp);
 425                                 self::$db_duration_write += (microtime(true) - $stamp);
 426                         }
 427
 428                         self::execFunction($queue, $funcname, $argv, false);
 429
 430                         $stamp = (float)microtime(true);
 431                         if (DBA::update('workerqueue', ['done' => true], ['id' => $queue['id']])) {
 432                                 DI::keyValue()->set('last_worker_execution', DateTimeFormat::utcNow());
 433                         }
 434                         self::$db_duration = (microtime(true) - $stamp);
 435                         self::$db_duration_write += (microtime(true) - $stamp);
 436                 } else {
 437                         Logger::warning('Function does not exist', ['function' => $funcname]);
 438                         $stamp = (float)microtime(true);
 439                         DBA::delete('workerqueue', ['id' => $queue['id']]);
 440                         self::$db_duration = (microtime(true) - $stamp);
 441                         self::$db_duration_write += (microtime(true) - $stamp);
 442                 }
 443
 444                 return true;
 445         }
 446
 447         /**
 448          * Checks if system limits are reached.
 449          *
 450          * @return boolean
 451          */
 452         private static function systemLimitReached(): bool
 453         {
 454                 $load_cooldown      = DI::config()->get('system', 'worker_load_cooldown');
 455                 $processes_cooldown = DI::config()->get('system', 'worker_processes_cooldown');
 456
 457                 if ($load_cooldown == 0) {
 458                         $load_cooldown = DI::config()->get('system', 'maxloadavg');
 459                 }
 460
 461                 if (($load_cooldown == 0) && ($processes_cooldown == 0)) {
 462                         return false;
 463                 }
 464
 465                 $load = System::getLoadAvg($processes_cooldown != 0);
 466                 if (empty($load)) {
 467                         return false;
 468                 }
 469
 470                 if (($load_cooldown > 0) && ($load['average1'] > $load_cooldown)) {
 471                         return true;
 472                 }
 473
 474                 if (($processes_cooldown > 0) && ($load['scheduled'] > $processes_cooldown)) {
 475                         return true;
 476                 }
 477
 478                 return false;
 479         }
 480
 481         /**
 482          * Slow the execution down if the system load is too high
 483          *
 484          * @return void
 485          */
 486         public static function coolDown()
 487         {
 488                 $cooldown = DI::config()->get('system', 'worker_cooldown', 0);
 489                 if ($cooldown > 0) {
 490                         Logger::debug('Wait for cooldown.', ['cooldown' => $cooldown]);
 491                         if ($cooldown < 1) {
 492                                 usleep($cooldown * 1000000);
 493                         } else {
 494                                 sleep($cooldown);
 495                         }
 496                 }
 497
 498                 $load_cooldown      = DI::config()->get('system', 'worker_load_cooldown');
 499                 $processes_cooldown = DI::config()->get('system', 'worker_processes_cooldown');
 500
 501                 if ($load_cooldown == 0) {
 502                         $load_cooldown = DI::config()->get('system', 'maxloadavg');
 503                 }
 504
 505                 if (($load_cooldown == 0) && ($processes_cooldown == 0)) {
 506                         return;
 507                 }
 508
 509                 $sleeping = false;
 510
 511                 while ($load = System::getLoadAvg($processes_cooldown != 0)) {
 512                         if (($load_cooldown > 0) && ($load['average1'] > $load_cooldown)) {
 513                                 if (!$sleeping) {
 514                                         Logger::notice('Load induced pre execution cooldown.', ['max' => $load_cooldown, 'load' => $load, 'called-by' => System::callstack(1)]);
 515                                         $sleeping = true;
 516                                 }
 517                                 sleep(1);
 518                                 continue;
 519                         }
 520                         if (($processes_cooldown > 0) && ($load['scheduled'] > $processes_cooldown)) {
 521                                 if (!$sleeping) {
 522                                         Logger::notice('Process induced pre execution cooldown.', ['max' => $processes_cooldown, 'load' => $load, 'called-by' => System::callstack(1)]);
 523                                         $sleeping = true;
 524                                 }
 525                                 sleep(1);
 526                                 continue;
 527                         }
 528                         break;
 529                 }
 530
 531                 if ($sleeping) {
 532                         Logger::notice('Cooldown ended.', ['max-load' => $load_cooldown, 'max-processes' => $processes_cooldown, 'load' => $load, 'called-by' => System::callstack(1)]);
 533                 }
 534         }
 535
 536         /**
 537          * Execute a function from the queue
 538          *
 539          * @param array   $queue       Workerqueue entry
 540          * @param string  $funcname    name of the function
 541          * @param array   $argv        Array of values to be passed to the function
 542          * @param boolean $method_call boolean
 543          * @return void
 544          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 545          */
 546         private static function execFunction(array $queue, string $funcname, array $argv, bool $method_call)
 547         {
 548                 $a = DI::app();
 549
 550                 self::coolDown();
 551
 552                 Logger::enableWorker($funcname);
 553
 554                 Logger::info('Process start.', ['priority' => $queue['priority'], 'id' => $queue['id']]);
 555
 556                 $stamp = (float)microtime(true);
 557
 558                 // We use the callstack here to analyze the performance of executed worker entries.
 559                 // For this reason the variables have to be initialized.
 560                 DI::profiler()->reset();
 561
 562                 $a->setQueue($queue);
 563
 564                 $up_duration = microtime(true) - self::$up_start;
 565
 566                 // Reset global data to avoid interferences
 567                 unset($_SESSION);
 568
 569                 // Set the workerLogger as new default logger
 570                 if ($method_call) {
 571                         try {
 572                                 call_user_func_array(sprintf('Friendica\Worker\%s::execute', $funcname), $argv);
 573                         } catch (\TypeError $e) {
 574                                 // No need to defer a worker queue entry if the arguments are invalid
 575                                 Logger::notice('Wrong worker arguments', ['class' => $funcname, 'argv' => $argv, 'queue' => $queue, 'message' => $e->getMessage()]);
 576                         } catch (\Throwable $e) {
 577                                 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()]);
 578                                 Worker::defer();
 579                         }
 580                 } else {
 581                         $funcname($argv, count($argv));
 582                 }
 583
 584                 Logger::disableWorker();
 585
 586                 $a->setQueue([]);
 587
 588                 $duration = (microtime(true) - $stamp);
 589
 590                 /* With these values we can analyze how effective the worker is.
 591                  * The database and rest time should be low since this is the unproductive time.
 592                  * The execution time is the productive time.
 593                  * By changing parameters like the maximum number of workers we can check the effectivness.
 594                 */
 595                 $dbtotal = round(self::$db_duration, 2);
 596                 $dbread  = round(self::$db_duration - (self::$db_duration_count + self::$db_duration_write + self::$db_duration_stat), 2);
 597                 $dbcount = round(self::$db_duration_count, 2);
 598                 $dbstat  = round(self::$db_duration_stat, 2);
 599                 $dbwrite = round(self::$db_duration_write, 2);
 600                 $dblock  = round(self::$lock_duration, 2);
 601                 $rest    = round(max(0, $up_duration - (self::$db_duration + self::$lock_duration)), 2);
 602                 $exec    = round($duration, 2);
 603
 604                 Logger::info('Performance:', ['state' => self::$state, 'count' => $dbcount, 'stat' => $dbstat, 'write' => $dbwrite, 'lock' => $dblock, 'total' => $dbtotal, 'rest' => $rest, 'exec' => $exec]);
 605
 606                 self::coolDown();
 607
 608                 self::$up_start = microtime(true);
 609                 self::$db_duration = 0;
 610                 self::$db_duration_count = 0;
 611                 self::$db_duration_stat = 0;
 612                 self::$db_duration_write = 0;
 613                 self::$lock_duration = 0;
 614
 615                 if ($duration > 3600) {
 616                         Logger::info('Longer than 1 hour.', ['priority' => $queue['priority'], 'id' => $queue['id'], 'duration' => round($duration/60, 3)]);
 617                 } elseif ($duration > 600) {
 618                         Logger::info('Longer than 10 minutes.', ['priority' => $queue['priority'], 'id' => $queue['id'], 'duration' => round($duration/60, 3)]);
 619                 } elseif ($duration > 300) {
 620                         Logger::info('Longer than 5 minutes.', ['priority' => $queue['priority'], 'id' => $queue['id'], 'duration' => round($duration/60, 3)]);
 621                 } elseif ($duration > 120) {
 622                         Logger::info('Longer than 2 minutes.', ['priority' => $queue['priority'], 'id' => $queue['id'], 'duration' => round($duration/60, 3)]);
 623                 }
 624
 625                 Logger::info('Process done.', ['priority' => $queue['priority'], 'id' => $queue['id'], 'duration' => round($duration, 3)]);
 626
 627                 DI::profiler()->saveLog(DI::logger(), 'ID ' . $queue['id'] . ': ' . $funcname);
 628         }
 629
 630         /**
 631          * Checks if the number of database connections has reached a critical limit.
 632          *
 633          * @return bool Are more than 3/4 of the maximum connections used?
 634          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 635          */
 636         private static function maxConnectionsReached(): bool
 637         {
 638                 // Fetch the max value from the config. This is needed when the system cannot detect the correct value by itself.
 639                 $max = DI::config()->get('system', 'max_connections');
 640
 641                 // Fetch the percentage level where the worker will get active
 642                 $maxlevel = DI::config()->get('system', 'max_connections_level', 75);
 643
 644                 if ($max == 0) {
 645                         // the maximum number of possible user connections can be a system variable
 646                         $r = DBA::fetchFirst("SHOW VARIABLES WHERE `variable_name` = 'max_user_connections'");
 647                         if (DBA::isResult($r)) {
 648                                 $max = $r['Value'];
 649                         }
 650                         // Or it can be granted. This overrides the system variable
 651                         $stamp = (float)microtime(true);
 652                         $r = DBA::p('SHOW GRANTS');
 653                         self::$db_duration += (microtime(true) - $stamp);
 654                         while ($grants = DBA::fetch($r)) {
 655                                 $grant = array_pop($grants);
 656                                 if (stristr($grant, "GRANT USAGE ON")) {
 657                                         if (preg_match("/WITH MAX_USER_CONNECTIONS (\d*)/", $grant, $match)) {
 658                                                 $max = $match[1];
 659                                         }
 660                                 }
 661                         }
 662                         DBA::close($r);
 663                 }
 664
 665                 // If $max is set we will use the processlist to determine the current number of connections
 666                 // The processlist only shows entries of the current user
 667                 if ($max != 0) {
 668                         $stamp = (float)microtime(true);
 669                         $r = DBA::p('SHOW PROCESSLIST');
 670                         self::$db_duration += (microtime(true) - $stamp);
 671                         $used = DBA::numRows($r);
 672                         DBA::close($r);
 673
 674                         Logger::info('Connection usage (user values)', ['usage' => $used, 'max' => $max]);
 675
 676                         $level = ($used / $max) * 100;
 677
 678                         if ($level >= $maxlevel) {
 679                                 Logger::warning('Maximum level (' . $maxlevel . '%) of user connections reached: ' . $used .'/' . $max);
 680                                 return true;
 681                         }
 682                 }
 683
 684                 // We will now check for the system values.
 685                 // This limit could be reached although the user limits are fine.
 686                 $r = DBA::fetchFirst("SHOW VARIABLES WHERE `variable_name` = 'max_connections'");
 687                 if (!DBA::isResult($r)) {
 688                         return false;
 689                 }
 690                 $max = intval($r['Value']);
 691                 if ($max == 0) {
 692                         return false;
 693                 }
 694                 $r = DBA::fetchFirst("SHOW STATUS WHERE `variable_name` = 'Threads_connected'");
 695                 if (!DBA::isResult($r)) {
 696                         return false;
 697                 }
 698                 $used = intval($r['Value']);
 699                 if ($used == 0) {
 700                         return false;
 701                 }
 702                 Logger::info('Connection usage (system values)', ['used' => $used, 'max' => $max]);
 703
 704                 $level = $used / $max * 100;
 705
 706                 if ($level < $maxlevel) {
 707                         return false;
 708                 }
 709                 Logger::warning('Maximum level (' . $level . '%) of system connections reached: ' . $used . '/' . $max);
 710                 return true;
 711         }
 712
 713
 714         /**
 715          * Checks if the number of active workers exceeds the given limits
 716          *
 717          * @return bool Are there too much workers running?
 718          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 719          */
 720         private static function tooMuchWorkers(): bool
 721         {
 722                 $queues = DI::config()->get('system', 'worker_queues', 10);
 723
 724                 $maxqueues = $queues;
 725
 726                 $active = self::activeWorkers();
 727
 728                 // Decrease the number of workers at higher load
 729                 $load = System::currentLoad();
 730                 if ($load) {
 731                         $maxsysload = intval(DI::config()->get('system', 'maxloadavg', 20));
 732
 733                         /* Default exponent 3 causes queues to rapidly decrease as load increases.
 734                          * If you have 20 max queues at idle, then you get only 5 queues at 37.1% of $maxsysload.
 735                          * For some environments, this rapid decrease is not needed.
 736                          * With exponent 1, you could have 20 max queues at idle and 13 at 37% of $maxsysload.
 737                          */
 738                         $exponent = intval(DI::config()->get('system', 'worker_load_exponent', 3));
 739                         $slope = pow(max(0, $maxsysload - $load) / $maxsysload, $exponent);
 740                         $queues = intval(ceil($slope * $maxqueues));
 741
 742                         $processlist = '';
 743
 744                         if (DI::config()->get('system', 'worker_jpm')) {
 745                                 $intervals = explode(',', DI::config()->get('system', 'worker_jpm_range'));
 746                                 $jobs_per_minute = [];
 747                                 foreach ($intervals as $interval) {
 748                                         if ($interval == 0) {
 749                                                 continue;
 750                                         } else {
 751                                                 $interval = (int)$interval;
 752                                         }
 753
 754                                         $stamp = (float)microtime(true);
 755                                         $jobs = DBA::count('workerqueue', ["`done` AND `executed` > ?", DateTimeFormat::utc('now - ' . $interval . ' minute')]);
 756                                         self::$db_duration += (microtime(true) - $stamp);
 757                                         self::$db_duration_stat += (microtime(true) - $stamp);
 758                                         $jobs_per_minute[$interval] = number_format($jobs / $interval, 0);
 759                                 }
 760                                 $processlist = ' - jpm: '.implode('/', $jobs_per_minute);
 761                         }
 762
 763                         // Create a list of queue entries grouped by their priority
 764                         $listitem = [0 => ''];
 765
 766                         $idle_workers = $active;
 767
 768                         $deferred = self::deferredEntries();
 769
 770                         if (DI::config()->get('system', 'worker_debug')) {
 771                                 $waiting_processes = 0;
 772                                 // Now adding all processes with workerqueue entries
 773                                 $stamp = (float)microtime(true);
 774                                 $jobs = DBA::p("SELECT COUNT(*) AS `entries`, `priority` FROM `workerqueue` WHERE NOT `done` GROUP BY `priority`");
 775                                 self::$db_duration += (microtime(true) - $stamp);
 776                                 self::$db_duration_stat += (microtime(true) - $stamp);
 777                                 while ($entry = DBA::fetch($jobs)) {
 778                                         $stamp = (float)microtime(true);
 779                                         $running = DBA::count('workerqueue-view', ['priority' => $entry['priority']]);
 780                                         self::$db_duration += (microtime(true) - $stamp);
 781                                         self::$db_duration_stat += (microtime(true) - $stamp);
 782                                         $idle_workers -= $running;
 783                                         $waiting_processes += $entry['entries'];
 784                                         $listitem[$entry['priority']] = $entry['priority'] . ':' . $running . '/' . $entry['entries'];
 785                                 }
 786                                 DBA::close($jobs);
 787                         } else {
 788                                 $waiting_processes =  self::totalEntries();
 789                                 $stamp = (float)microtime(true);
 790                                 $jobs = DBA::p("SELECT COUNT(*) AS `running`, `priority` FROM `workerqueue-view` GROUP BY `priority` ORDER BY `priority`");
 791                                 self::$db_duration += (microtime(true) - $stamp);
 792                                 self::$db_duration_stat += (microtime(true) - $stamp);
 793
 794                                 while ($entry = DBA::fetch($jobs)) {
 795                                         $idle_workers -= $entry['running'];
 796                                         $listitem[$entry['priority']] = $entry['priority'] . ':' . $entry['running'];
 797                                 }
 798                                 DBA::close($jobs);
 799                         }
 800
 801                         $waiting_processes -= $deferred;
 802
 803                         $listitem[0] = '0:' . max(0, $idle_workers);
 804
 805                         $processlist .= ' ('.implode(', ', $listitem).')';
 806
 807                         if (DI::config()->get('system', 'worker_fastlane', false) && ($queues > 0) && ($active >= $queues) && self::entriesExists()) {
 808                                 $top_priority = self::highestPriority();
 809                                 $high_running = self::processWithPriorityActive($top_priority);
 810
 811                                 if (!$high_running && ($top_priority > self::PRIORITY_UNDEFINED) && ($top_priority < self::PRIORITY_NEGLIGIBLE)) {
 812                                         Logger::info('Jobs with a higher priority are waiting but none is executed. Open a fastlane.', ['priority' => $top_priority]);
 813                                         $queues = $active + 1;
 814                                 }
 815                         }
 816
 817                         Logger::notice('Load: ' . $load . '/' . $maxsysload . ' - processes: ' . $deferred . '/' . $active . '/' . $waiting_processes . $processlist . ' - maximum: ' . $queues . '/' . $maxqueues);
 818
 819                         // Are there fewer workers running as possible? Then fork a new one.
 820                         if (!DI::config()->get('system', 'worker_dont_fork', false) && ($queues > ($active + 1)) && self::entriesExists() && !self::systemLimitReached()) {
 821                                 Logger::info('There are fewer workers as possible, fork a new worker.', ['active' => $active, 'queues' => $queues]);
 822                                 if (Worker\Daemon::isMode()) {
 823                                         Worker\IPC::SetJobState(true);
 824                                 } else {
 825                                         self::spawnWorker();
 826                                 }
 827                         }
 828                 }
 829
 830                 // if there are too much worker, we don't spawn a new one.
 831                 if (Worker\Daemon::isMode() && ($active > $queues)) {
 832                         Worker\IPC::SetJobState(false);
 833                 }
 834
 835                 return $active > $queues;
 836         }
 837
 838         /**
 839          * Returns the number of active worker processes
 840          *
 841          * @return integer Number of active worker processes
 842          * @throws \Exception
 843          */
 844         private static function activeWorkers(): int
 845         {
 846                 $stamp = (float)microtime(true);
 847                 $count = DI::process()->countCommand('Worker.php');
 848                 self::$db_duration += (microtime(true) - $stamp);
 849                 self::$db_duration_count += (microtime(true) - $stamp);
 850                 return $count;
 851         }
 852
 853         /**
 854          * Returns the number of active worker processes
 855          *
 856          * @return array List of worker process ids
 857          * @throws \Exception
 858          */
 859         private static function getWorkerPIDList(): array
 860         {
 861                 $ids = [];
 862                 $stamp = (float)microtime(true);
 863
 864                 $queues = DBA::p("SELECT `process`.`pid`, COUNT(`workerqueue`.`pid`) AS `entries` FROM `process`
 865                         LEFT JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `workerqueue`.`done`
 866                         GROUP BY `process`.`pid`");
 867                 while ($queue = DBA::fetch($queues)) {
 868                         $ids[$queue['pid']] = $queue['entries'];
 869                 }
 870                 DBA::close($queues);
 871
 872                 self::$db_duration += (microtime(true) - $stamp);
 873                 self::$db_duration_count += (microtime(true) - $stamp);
 874                 return $ids;
 875         }
 876
 877         /**
 878          * Returns waiting jobs for the current process id
 879          *
 880          * @return array|bool waiting workerqueue jobs or FALSE on failture
 881          * @throws \Exception
 882          */
 883         private static function getWaitingJobForPID()
 884         {
 885                 $stamp = (float)microtime(true);
 886                 $r = DBA::select('workerqueue', [], ['pid' => getmypid(), 'done' => false]);
 887                 self::$db_duration += (microtime(true) - $stamp);
 888                 if (DBA::isResult($r)) {
 889                         return DBA::toArray($r);
 890                 }
 891                 DBA::close($r);
 892
 893                 return false;
 894         }
 895
 896         /**
 897          * Returns the next jobs that should be executed
 898          * @param int $limit
 899          * @return array array with next jobs
 900          * @throws \Exception
 901          */
 902         private static function nextProcess(int $limit): array
 903         {
 904                 $priority = self::nextPriority();
 905                 if (empty($priority)) {
 906                         Logger::info('No tasks found');
 907                         return [];
 908                 }
 909
 910                 $ids = [];
 911                 $stamp = (float)microtime(true);
 912                 $condition = ["`priority` = ? AND `pid` = 0 AND NOT `done` AND `next_try` < ?", $priority, DateTimeFormat::utcNow()];
 913                 $tasks = DBA::select('workerqueue', ['id', 'command', 'parameter'], $condition, ['limit' => $limit, 'order' => ['retrial', 'created']]);
 914                 self::$db_duration += (microtime(true) - $stamp);
 915                 while ($task = DBA::fetch($tasks)) {
 916                         $ids[] = $task['id'];
 917                         // Only continue that loop while we are storing commands that can be processed quickly
 918                         if (!empty($task['command'])) {
 919                                 $command = $task['command'];
 920                         } else {
 921                                 $command = json_decode($task['parameter'])[0];
 922                         }
 923
 924                         if (!in_array($command, self::FAST_COMMANDS)) {
 925                                 break;
 926                         }
 927                 }
 928                 DBA::close($tasks);
 929
 930                 Logger::info('Found:', ['priority' => $priority, 'id' => $ids]);
 931                 return $ids;
 932         }
 933
 934         /**
 935          * Returns the priority of the next workerqueue job
 936          *
 937          * @return string|bool priority or FALSE on failure
 938          * @throws \Exception
 939          */
 940         private static function nextPriority()
 941         {
 942                 $waiting = [];
 943                 $priorities = [self::PRIORITY_CRITICAL, self::PRIORITY_HIGH, self::PRIORITY_MEDIUM, self::PRIORITY_LOW, self::PRIORITY_NEGLIGIBLE];
 944                 foreach ($priorities as $priority) {
 945                         $stamp = (float)microtime(true);
 946                         if (DBA::exists('workerqueue', ["`priority` = ? AND `pid` = 0 AND NOT `done` AND `next_try` < ?", $priority, DateTimeFormat::utcNow()])) {
 947                                 $waiting[$priority] = true;
 948                         }
 949                         self::$db_duration += (microtime(true) - $stamp);
 950                 }
 951
 952                 if (!empty($waiting[self::PRIORITY_CRITICAL])) {
 953                         return self::PRIORITY_CRITICAL;
 954                 }
 955
 956                 $running = [];
 957                 $running_total = 0;
 958                 $stamp = (float)microtime(true);
 959                 $processes = DBA::p("SELECT COUNT(DISTINCT(`pid`)) AS `running`, `priority` FROM `workerqueue-view` GROUP BY `priority`");
 960                 self::$db_duration += (microtime(true) - $stamp);
 961                 while ($process = DBA::fetch($processes)) {
 962                         $running[$process['priority']] = $process['running'];
 963                         $running_total += $process['running'];
 964                 }
 965                 DBA::close($processes);
 966
 967                 foreach ($priorities as $priority) {
 968                         if (!empty($waiting[$priority]) && empty($running[$priority])) {
 969                                 Logger::info('No running worker found with priority {priority} - assigning it.', ['priority' => $priority]);
 970                                 return $priority;
 971                         }
 972                 }
 973
 974                 $active = max(self::activeWorkers(), $running_total);
 975                 $priorities = max(count($waiting), count($running));
 976                 $exponent = 2;
 977
 978                 $total = 0;
 979                 for ($i = 1; $i <= $priorities; ++$i) {
 980                         $total += pow($i, $exponent);
 981                 }
 982
 983                 $limit = [];
 984                 for ($i = 1; $i <= $priorities; ++$i) {
 985                         $limit[$priorities - $i] = max(1, round($active * (pow($i, $exponent) / $total)));
 986                 }
 987
 988                 $i = 0;
 989                 foreach ($running as $priority => $workers) {
 990                         if ($workers < $limit[$i++]) {
 991                                 Logger::info('Priority {priority} has got {workers} workers out of a limit of {limit}', ['priority' => $priority, 'workers' => $workers, 'limit' => $limit[$i - 1]]);
 992                                 return $priority;
 993                         }
 994                 }
 995
 996                 if (!empty($waiting)) {
 997                         $priority = array_keys($waiting)[0];
 998                         Logger::info('No underassigned priority found, now taking the highest priority.', ['priority' => $priority]);
 999                         return $priority;
1000                 }
1001
1002                 return false;
1003         }
1004
1005         /**
1006          * Find and claim the next worker process for us
1007          *
1008          * @return void
1009          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1010          */
1011         private static function findWorkerProcesses()
1012         {
1013                 $fetch_limit = DI::config()->get('system', 'worker_fetch_limit', 1);
1014
1015                 if (DI::config()->get('system', 'worker_multiple_fetch')) {
1016                         $pids = [];
1017                         foreach (self::getWorkerPIDList() as $pid => $count) {
1018                                 if ($count <= $fetch_limit) {
1019                                         $pids[] = $pid;
1020                                 }
1021                         }
1022                         if (empty($pids)) {
1023                                 return;
1024                         }
1025                         $limit = $fetch_limit * count($pids);
1026                 } else {
1027                         $pids = [getmypid()];
1028                         $limit = $fetch_limit;
1029                 }
1030
1031                 $ids = self::nextProcess($limit);
1032                 $limit -= count($ids);
1033
1034                 // If there is not enough results we check without priority limit
1035                 if ($limit > 0) {
1036                         $stamp = (float)microtime(true);
1037                         $condition = ["`pid` = 0 AND NOT `done` AND `next_try` < ?", DateTimeFormat::utcNow()];
1038                         $tasks = DBA::select('workerqueue', ['id', 'command', 'parameter'], $condition, ['limit' => $limit, 'order' => ['priority', 'retrial', 'created']]);
1039                         self::$db_duration += (microtime(true) - $stamp);
1040
1041                         while ($task = DBA::fetch($tasks)) {
1042                                 $ids[] = $task['id'];
1043                                 // Only continue that loop while we are storing commands that can be processed quickly
1044                                 if (!empty($task['command'])) {
1045                                         $command = $task['command'];
1046                                 } else {
1047                                         $command = json_decode($task['parameter'])[0];
1048                                 }
1049                                 if (!in_array($command, self::FAST_COMMANDS)) {
1050                                         break;
1051                                 }
1052                         }
1053                         DBA::close($tasks);
1054                 }
1055
1056                 if (empty($ids)) {
1057                         return;
1058                 }
1059
1060                 // Assign the task ids to the workers
1061                 $worker = [];
1062                 foreach (array_unique($ids) as $id) {
1063                         $pid = next($pids);
1064                         if (!$pid) {
1065                                 $pid = reset($pids);
1066                         }
1067                         $worker[$pid][] = $id;
1068                 }
1069
1070                 $stamp = (float)microtime(true);
1071                 foreach ($worker as $worker_pid => $worker_ids) {
1072                         Logger::info('Set queue entry', ['pid' => $worker_pid, 'ids' => $worker_ids]);
1073                         DBA::update('workerqueue', ['executed' => DateTimeFormat::utcNow(), 'pid' => $worker_pid],
1074                                 ['id' => $worker_ids, 'done' => false, 'pid' => 0]);
1075                 }
1076                 self::$db_duration += (microtime(true) - $stamp);
1077                 self::$db_duration_write += (microtime(true) - $stamp);
1078         }
1079
1080         /**
1081          * Returns the next worker process
1082          *
1083          * @return array worker processes
1084          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1085          */
1086         public static function workerProcess(): array
1087         {
1088                 // There can already be jobs for us in the queue.
1089                 $waiting = self::getWaitingJobForPID();
1090                 if (!empty($waiting)) {
1091                         return $waiting;
1092                 }
1093
1094                 $stamp = (float)microtime(true);
1095                 if (!DI::lock()->acquire(self::LOCK_PROCESS)) {
1096                         return [];
1097                 }
1098                 self::$lock_duration += (microtime(true) - $stamp);
1099
1100                 self::findWorkerProcesses();
1101
1102                 DI::lock()->release(self::LOCK_PROCESS);
1103
1104                 // Prevents "Return value of Friendica\Core\Worker::workerProcess() must be of the type array, bool returned"
1105                 $process = self::getWaitingJobForPID();
1106                 return (is_array($process) ? $process : []);
1107         }
1108
1109         /**
1110          * Removes a workerqueue entry from the current process
1111          *
1112          * @param Process $process the process behind the workerqueue
1113          *
1114          * @return void
1115          * @throws \Exception
1116          */
1117         public static function unclaimProcess(Process $process)
1118         {
1119                 $stamp = (float)microtime(true);
1120                 DBA::update('workerqueue', ['executed' => DBA::NULL_DATETIME, 'pid' => 0], ['pid' => $process->pid, 'done' => false]);
1121                 self::$db_duration += (microtime(true) - $stamp);
1122                 self::$db_duration_write += (microtime(true) - $stamp);
1123         }
1124
1125         /**
1126          * Fork a child process
1127          *
1128          * @param boolean $do_cron
1129          * @return void
1130          */
1131         private static function forkProcess(bool $do_cron)
1132         {
1133                 if (DI::system()->isMinMemoryReached()) {
1134                         Logger::warning('Memory limit reached - quitting');
1135                         return;
1136                 }
1137
1138                 // Children inherit their parent's database connection.
1139                 // To avoid problems we disconnect and connect both parent and child
1140                 DBA::disconnect();
1141                 $pid = pcntl_fork();
1142                 if ($pid == -1) {
1143                         DBA::connect();
1144                         Logger::warning('Could not spawn worker');
1145                         return;
1146                 } elseif ($pid) {
1147                         // The parent process continues here
1148                         DBA::connect();
1149
1150                         Worker\IPC::SetJobState(true, $pid);
1151                         Logger::info('Spawned new worker', ['pid' => $pid]);
1152
1153                         $cycles = 0;
1154                         while (Worker\IPC::JobsExists($pid) && (++$cycles < 100)) {
1155                                 usleep(10000);
1156                         }
1157
1158                         Logger::info('Spawned worker is ready', ['pid' => $pid, 'wait_cycles' => $cycles]);
1159                         return;
1160                 }
1161
1162                 // We now are in the new worker
1163                 DBA::connect();
1164
1165                 DI::flushLogger();
1166                 $process = DI::process()->create(getmypid(), basename(__FILE__));
1167
1168                 $cycles = 0;
1169                 while (!Worker\IPC::JobsExists($process->pid) && (++$cycles < 100)) {
1170                         usleep(10000);
1171                 }
1172
1173                 Logger::info('Worker spawned', ['pid' => $process->pid, 'wait_cycles' => $cycles]);
1174
1175                 self::processQueue($do_cron, $process);
1176
1177                 self::unclaimProcess($process);
1178
1179                 Worker\IPC::SetJobState(false, $process->pid);
1180                 DI::process()->delete($process);
1181                 Logger::info('Worker ended', ['pid' => $process->pid]);
1182                 exit();
1183         }
1184
1185         /**
1186          * Spawns a new worker
1187          *
1188          * @param bool $do_cron
1189          * @return void
1190          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1191          */
1192         public static function spawnWorker(bool $do_cron = false)
1193         {
1194                 if (Worker\Daemon::isMode() && DI::config()->get('system', 'worker_fork')) {
1195                         self::forkProcess($do_cron);
1196                 } else {
1197                         DI::system()->run('bin/worker.php', ['no_cron' => !$do_cron]);
1198                 }
1199                 if (Worker\Daemon::isMode()) {
1200                         Worker\IPC::SetJobState(false);
1201                 }
1202         }
1203
1204         /**
1205          * Adds tasks to the worker queue
1206          *
1207          * @param (integer|array) priority or parameter array, strings are deprecated and are ignored
1208          *
1209          * next args are passed as $cmd command line
1210          * or: Worker::add(Worker::PRIORITY_HIGH, 'Notifier', Delivery::DELETION, $drop_id);
1211          * or: Worker::add(array('priority' => Worker::PRIORITY_HIGH, 'dont_fork' => true), 'Delivery', $post_id);
1212          *
1213          * @return int '0' if worker queue entry already existed or there had been an error, otherwise the ID of the worker task
1214          * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1215          * @note $cmd and string args are surrounded with ''
1216          *
1217          * @hooks 'proc_run'
1218          *    array $arr
1219          *
1220          */
1221         public static function add(...$args)
1222         {
1223                 if (!count($args)) {
1224                         return 0;
1225                 }
1226
1227                 $arr = ['args' => $args, 'run_cmd' => true];
1228
1229                 Hook::callAll('proc_run', $arr);
1230                 if (!$arr['run_cmd'] || !count($args)) {
1231                         return 1;
1232                 }
1233
1234                 $priority = self::PRIORITY_MEDIUM;
1235                 // Don't fork from frontend tasks by default
1236                 $dont_fork = DI::config()->get('system', 'worker_dont_fork', false) || !DI::mode()->isBackend();
1237                 $created = DateTimeFormat::utcNow();
1238                 $delayed = DBA::NULL_DATETIME;
1239                 $force_priority = false;
1240
1241                 $run_parameter = array_shift($args);
1242
1243                 if (is_int($run_parameter)) {
1244                         $priority = $run_parameter;
1245                 } elseif (is_array($run_parameter)) {
1246                         if (isset($run_parameter['delayed'])) {
1247                                 $delayed = $run_parameter['delayed'];
1248                         }
1249                         if (isset($run_parameter['priority'])) {
1250                                 $priority = $run_parameter['priority'];
1251                         }
1252                         if (isset($run_parameter['created'])) {
1253                                 $created = $run_parameter['created'];
1254                         }
1255                         if (isset($run_parameter['dont_fork'])) {
1256                                 $dont_fork = $run_parameter['dont_fork'];
1257                         }
1258                         if (isset($run_parameter['force_priority'])) {
1259                                 $force_priority = $run_parameter['force_priority'];
1260                         }
1261                 } else {
1262                         throw new \InvalidArgumentException('Priority number or task parameter array expected as first argument');
1263                 }
1264
1265                 $command = array_shift($args);
1266                 $parameters = json_encode($args);
1267                 $found = DBA::exists('workerqueue', ['command' => $command, 'parameter' => $parameters, 'done' => false]);
1268                 $added = 0;
1269
1270                 if (!is_int($priority) || !in_array($priority, self::PRIORITIES)) {
1271                         Logger::warning('Invalid priority', ['priority' => $priority, 'command' => $command, 'callstack' => System::callstack(20)]);
1272                         $priority = self::PRIORITY_MEDIUM;
1273                 }
1274
1275                 // Quit if there was a database error - a precaution for the update process to 3.5.3
1276                 if (DBA::errorNo() != 0) {
1277                         return 0;
1278                 }
1279
1280                 if (!$found) {
1281                         if (!DBA::insert('workerqueue', ['command' => $command, 'parameter' => $parameters, 'created' => $created,
1282                                 'priority' => $priority, 'next_try' => $delayed])) {
1283                                 return 0;
1284                         }
1285                         $added = DBA::lastInsertId();
1286                 } elseif ($force_priority) {
1287                         DBA::update('workerqueue', ['priority' => $priority], ['command' => $command, 'parameter' => $parameters, 'done' => false, 'pid' => 0]);
1288                 }
1289
1290                 // Set the IPC flag to ensure an immediate process execution via daemon
1291                 if (Worker\Daemon::isMode()) {
1292                         Worker\IPC::SetJobState(true);
1293                 }
1294
1295                 Worker\Daemon::checkState();
1296
1297                 // Should we quit and wait for the worker to be called as a cronjob?
1298                 if ($dont_fork || self::systemLimitReached()) {
1299                         return $added;
1300                 }
1301
1302                 // If there is a lock then we don't have to check for too much worker
1303                 if (!DI::lock()->acquire(self::LOCK_WORKER, 0)) {
1304                         return $added;
1305                 }
1306
1307                 // If there are already enough workers running, don't fork another one
1308                 $quit = self::tooMuchWorkers();
1309                 DI::lock()->release(self::LOCK_WORKER);
1310
1311                 if ($quit) {
1312                         return $added;
1313                 }
1314
1315                 // Quit on daemon mode
1316                 if (Worker\Daemon::isMode()) {
1317                         return $added;
1318                 }
1319
1320                 // Now call the worker to execute the jobs that we just added to the queue
1321                 self::spawnWorker();
1322
1323                 return $added;
1324         }
1325
1326         public static function countWorkersByCommand(string $command): int
1327         {
1328                 return DBA::count('workerqueue', ['done' => false, 'pid' => 0, 'command' => $command]);
1329         }
1330
1331         /**
1332          * Returns the next retrial level for worker jobs.
1333          * This function will skip levels when jobs are older.
1334          *
1335          * @param array $queue Worker queue entry
1336          * @param integer $max_level maximum retrial level
1337          * @return integer the next retrial level value
1338          */
1339         private static function getNextRetrial(array $queue, int $max_level): int
1340         {
1341                 $created = strtotime($queue['created']);
1342                 $retrial_time = time() - $created;
1343
1344                 $new_retrial = $queue['retrial'] + 1;
1345                 $total = 0;
1346                 for ($retrial = 0; $retrial <= $max_level + 1; ++$retrial) {
1347                         $delay = (($retrial + 3) ** 4) + (rand(1, 30) * ($retrial + 1));
1348                         $total += $delay;
1349                         if (($total < $retrial_time) && ($retrial > $queue['retrial'])) {
1350                                 $new_retrial = $retrial;
1351                         }
1352                 }
1353                 Logger::notice('New retrial for task', ['id' => $queue['id'], 'created' => $queue['created'], 'old' => $queue['retrial'], 'new' => $new_retrial]);
1354                 return $new_retrial;
1355         }
1356
1357         /**
1358          * Defers the current worker entry
1359          *
1360          * @return boolean had the entry been deferred?
1361          * @throws \Exception
1362          */
1363         public static function defer(): bool
1364         {
1365                 $queue = DI::app()->getQueue();
1366
1367                 if (empty($queue)) {
1368                         return false;
1369                 }
1370
1371                 $id = $queue['id'];
1372                 $priority = $queue['priority'];
1373
1374                 $max_level = DI::config()->get('system', 'worker_defer_limit');
1375
1376                 $new_retrial = self::getNextRetrial($queue, $max_level);
1377
1378                 if ($new_retrial > $max_level) {
1379                         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]);
1380                         return false;
1381                 }
1382
1383                 // Calculate the delay until the next trial
1384                 $delay = (($new_retrial + 2) ** 4) + (rand(1, 30) * ($new_retrial));
1385                 $next = DateTimeFormat::utc('now + ' . $delay . ' seconds');
1386
1387                 if (($priority < self::PRIORITY_MEDIUM) && ($new_retrial > 3)) {
1388                         $priority = self::PRIORITY_MEDIUM;
1389                 } elseif (($priority < self::PRIORITY_LOW) && ($new_retrial > 6)) {
1390                         $priority = self::PRIORITY_LOW;
1391                 } elseif (($priority < self::PRIORITY_NEGLIGIBLE) && ($new_retrial > 8)) {
1392                         $priority = self::PRIORITY_NEGLIGIBLE;
1393                 }
1394
1395                 Logger::info('Deferred task', ['id' => $id, 'retrial' => $new_retrial, 'created' => $queue['created'], 'next_execution' => $next, 'old_prio' => $queue['priority'], 'new_prio' => $priority]);
1396
1397                 $stamp = (float)microtime(true);
1398                 $fields = ['retrial' => $new_retrial, 'next_try' => $next, 'executed' => DBA::NULL_DATETIME, 'pid' => 0, 'priority' => $priority];
1399                 DBA::update('workerqueue', $fields, ['id' => $id]);
1400                 self::$db_duration += (microtime(true) - $stamp);
1401                 self::$db_duration_write += (microtime(true) - $stamp);
1402
1403                 return true;
1404         }
1405
1406         /**
1407          * Check if the system is inside the defined maintenance window
1408          *
1409          * @param bool $check_last_execution Whether check last execution
1410          * @return boolean
1411          */
1412         public static function isInMaintenanceWindow(bool $check_last_execution = false): bool
1413         {
1414                 // Calculate the seconds of the start end end of the maintenance window
1415                 $start = strtotime(DI::config()->get('system', 'maintenance_start')) % 86400;
1416                 $end = strtotime(DI::config()->get('system', 'maintenance_end')) % 86400;
1417
1418                 Logger::info('Maintenance window', ['start' => date('H:i:s', $start), 'end' => date('H:i:s', $end)]);
1419
1420                 if ($check_last_execution) {
1421                         // Calculate the window duration
1422                         $duration = max($start, $end) - min($start, $end);
1423
1424                         // Quit when the last cron execution had been after the previous window
1425                         $last_cron = DI::keyValue()->get('last_cron_daily');
1426                         if ($last_cron + $duration > time()) {
1427                                 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)]);
1428                                 return false;
1429                         }
1430                 }
1431
1432                 $current = time() % 86400;
1433
1434                 if ($start < $end) {
1435                         // Execute if we are inside the window
1436                         $execute = ($current >= $start) && ($current <= $end);
1437                 } else {
1438                         // Don't execute if we are outside the window
1439                         $execute = !(($current > $end) && ($current < $start));
1440                 }
1441
1442                 if ($execute) {
1443                         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)]);
1444                 } else {
1445                         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)]);
1446                 }
1447
1448                 return $execute;
1449         }
1450 }