<?php
/**
- * @copyright Copyright (C) 2020, Friendica
+ * @copyright Copyright (C) 2010-2022, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
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;
private static $lock_duration = 0;
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(bool $run_cron, Process $process)
{
- // Ensure that all "strtotime" operations do run timezone independent
- date_default_timezone_set('UTC');
-
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);
if (time() > ($last_cleanup + 300)) {
DI::config()->set('system', 'worker_last_cleaned', time());
- self::killStaleWorkers();
+ Worker\Cron::killStaleWorkers();
}
// Check if the system is ready
// Now we start additional cron processes if we should do so
if ($run_cron) {
- self::runCron();
+ Worker\Cron::run();
}
$last_check = $starttime = time();
// We fetch the next queue entry that is about to be executed
while ($r = self::workerProcess()) {
- if (self::IPCJobsExists(getmypid())) {
- self::IPCSetJobState(false, getmypid());
+ if (Worker\IPC::JobsExists(getmypid())) {
+ Worker\IPC::DeleteJobState(getmypid());
}
+
// 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'];
-
// The work will be done
if (!self::execute($entry)) {
- Logger::notice('Process execution failed, quitting.');
+ Logger::warning('Process execution failed, quitting.', ['entry' => $entry]);
return;
}
}
// Check free memory
- if (DI::process()->isMinMemoryReached()) {
+ if (DI::system()->isMinMemoryReached()) {
Logger::warning('Memory limit reached, quitting.');
DI::lock()->release(self::LOCK_WORKER);
return;
// 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();
- if (self::isDaemonMode()) {
- self::IPCSetJobState(true);
+ self::unclaimProcess($process);
+ if (Worker\Daemon::isMode()) {
+ Worker\IPC::SetJobState(true);
} else {
self::spawnWorker();
}
}
// Cleaning up. Possibly not needed, but it doesn't harm anything.
- if (self::isDaemonMode()) {
- self::IPCSetJobState(false);
+ if (Worker\Daemon::isMode()) {
+ Worker\IPC::SetJobState(false);
}
Logger::info("Couldn't select a workerqueue entry, quitting process", ['pid' => getmypid()]);
}
*
* @return boolean
*/
- public static function isReady()
+ public static function isReady(): bool
{
// Count active workers and compare them with a maximum value that depends on the load
if (self::tooMuchWorkers()) {
}
// Do we have too few memory?
- if (DI::process()->isMinMemoryReached()) {
+ if (DI::system()->isMinMemoryReached()) {
Logger::warning('Memory limit reached, quitting.');
return false;
}
}
// 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;
}
* @return boolean Returns "true" if tasks are existing
* @throws \Exception
*/
- public static function entriesExists()
+ public static function entriesExists(): bool
{
$stamp = (float)microtime(true);
$exists = DBA::exists('workerqueue', ["NOT `done` AND `pid` = 0 AND `next_try` < ?", DateTimeFormat::utcNow()]);
* @return integer Number of deferred entries in the worker queue
* @throws \Exception
*/
- private static function deferredEntries()
+ private static function deferredEntries(): int
{
$stamp = (float)microtime(true);
$count = DBA::count('workerqueue', ["NOT `done` AND `pid` = 0 AND `retrial` > ?", 0]);
* @return integer Number of non executed entries in the worker queue
* @throws \Exception
*/
- private static function totalEntries()
+ private static function totalEntries(): int
{
$stamp = (float)microtime(true);
$count = DBA::count('workerqueue', ['done' => false, 'pid' => 0]);
* @return integer Number of active worker processes
* @throws \Exception
*/
- private static function highestPriority()
+ private static function highestPriority(): int
{
$stamp = (float)microtime(true);
$condition = ["`pid` = 0 AND NOT `done` AND `next_try` < ?", DateTimeFormat::utcNow()];
$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;
}
* @return integer Is there a process running with that priority?
* @throws \Exception
*/
- private static function processWithPriorityActive($priority)
+ private static function processWithPriorityActive(int $priority): int
{
$condition = ["`priority` <= ? AND `pid` != 0 AND NOT `done`", $priority];
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): bool
+ {
+ $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
*
* @return boolean "true" if further processing should be stopped
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public static function execute($queue)
+ public static function execute(array $queue): bool
{
$mypid = getmypid();
}
// 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;
}
}
$argv = json_decode($queue['parameter'], true);
+ if (!is_array($argv)) {
+ $argv = [];
+ }
+
if (!empty($queue['command'])) {
array_unshift($argv, $queue['command']);
}
$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"]]);
* @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- private static function execFunction($queue, $funcname, $argv, $method_call)
+ private static function execFunction(array $queue, string $funcname, array $argv, bool $method_call)
{
$a = DI::app();
$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);
// 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->queue = $queue;
+ $a->setQueue($queue);
$up_duration = microtime(true) - self::$up_start;
Logger::disableWorker();
- unset($a->queue);
+ $a->setQueue([]);
$duration = (microtime(true) - $stamp);
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);
}
}
* @return bool Are more than 3/4 of the maximum connections used?
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- private static function maxConnectionsReached()
+ private static function maxConnectionsReached(): bool
{
// Fetch the max value from the config. This is needed when the system cannot detect the correct value by itself.
$max = DI::config()->get("system", "max_connections");
return true;
}
- /**
- * fix the queue entry if the worker process died
- *
- * @return void
- * @throws \Exception
- */
- private static function killStaleWorkers()
- {
- $stamp = (float)microtime(true);
- $entries = DBA::select(
- 'workerqueue',
- ['id', 'pid', 'executed', 'priority', 'command', 'parameter'],
- ['NOT `done` AND `pid` != 0'],
- ['order' => ['priority', 'retrial', 'created']]
- );
- self::$db_duration += (microtime(true) - $stamp);
-
- while ($entry = DBA::fetch($entries)) {
- if (!posix_kill($entry["pid"], 0)) {
- $stamp = (float)microtime(true);
- DBA::update(
- 'workerqueue',
- ['executed' => DBA::NULL_DATETIME, 'pid' => 0],
- ['id' => $entry["id"]]
- );
- self::$db_duration += (microtime(true) - $stamp);
- 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"]];
-
- $argv = json_decode($entry['parameter'], true);
- if (!empty($entry['command'])) {
- $command = $entry['command'];
- } elseif (!empty($argv)) {
- $command = array_shift($argv);
- } else {
- return;
- }
-
- $command = basename($command);
-
- // How long is the process already running?
- $duration = (time() - strtotime($entry["executed"])) / 60;
- if ($duration > $max_duration) {
- Logger::notice('Worker process took too much time - killed', ['duration' => number_format($duration, 3), 'max' => $max_duration, 'id' => $entry["id"], 'pid' => $entry["pid"], 'command' => $command]);
- posix_kill($entry["pid"], SIGTERM);
-
- // 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 = PRIORITY_MEDIUM;
- } elseif ($entry["priority"] == PRIORITY_MEDIUM) {
- $new_priority = PRIORITY_LOW;
- } elseif ($entry["priority"] != PRIORITY_CRITICAL) {
- $new_priority = PRIORITY_NEGLIGIBLE;
- }
- $stamp = (float)microtime(true);
- DBA::update(
- 'workerqueue',
- ['executed' => DBA::NULL_DATETIME, 'created' => DateTimeFormat::utcNow(), 'priority' => $new_priority, 'pid' => 0],
- ['id' => $entry["id"]]
- );
- self::$db_duration += (microtime(true) - $stamp);
- self::$db_duration_write += (microtime(true) - $stamp);
- } else {
- Logger::info('Process runtime is okay', ['duration' => number_format($duration, 3), 'max' => $max_duration, 'id' => $entry["id"], 'pid' => $entry["pid"], 'command' => $command]);
- }
- }
- }
- DBA::close($entries);
- }
/**
* Checks if the number of active workers exceeds the given limits
* @return bool Are there too much workers running?
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- private static function tooMuchWorkers()
+ private static function tooMuchWorkers(): bool
{
$queues = DI::config()->get("system", "worker_queues", 10);
}
$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);
}
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 {
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);
}
// Are there fewer workers running as possible? Then fork a new one.
if (!DI::config()->get("system", "worker_dont_fork", false) && ($queues > ($active + 1)) && self::entriesExists()) {
Logger::info("There are fewer workers as possible, fork a new worker.", ['active' => $active, 'queues' => $queues]);
- if (self::isDaemonMode()) {
- self::IPCSetJobState(true);
+ if (Worker\Daemon::isMode()) {
+ Worker\IPC::SetJobState(true);
} else {
self::spawnWorker();
}
}
// if there are too much worker, we don't spawn a new one.
- if (self::isDaemonMode() && ($active > $queues)) {
- self::IPCSetJobState(false);
+ if (Worker\Daemon::isMode() && ($active > $queues)) {
+ Worker\IPC::SetJobState(false);
}
return $active > $queues;
* @return integer Number of active worker processes
* @throws \Exception
*/
- private static function activeWorkers()
+ private static function activeWorkers(): int
{
$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;
* @return array List of worker process ids
* @throws \Exception
*/
- private static function getWorkerPIDList()
+ private static function getWorkerPIDList(): array
{
$ids = [];
$stamp = (float)microtime(true);
$queues = DBA::p("SELECT `process`.`pid`, COUNT(`workerqueue`.`pid`) AS `entries` FROM `process`
- LEFT JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `workerqueue`.`done`
+ LEFT JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid` AND NOT `workerqueue`.`done`
GROUP BY `process`.`pid`");
while ($queue = DBA::fetch($queues)) {
$ids[$queue['pid']] = $queue['entries'];
/**
* Returns waiting jobs for the current process id
*
- * @return array waiting workerqueue jobs
+ * @return array|bool waiting workerqueue jobs or FALSE on failture
* @throws \Exception
*/
private static function getWaitingJobForPID()
* @return array array with next jobs
* @throws \Exception
*/
- private static function nextProcess(int $limit)
+ private static function nextProcess(int $limit): array
{
$priority = self::nextPriority();
if (empty($priority)) {
/**
* Returns the priority of the next workerqueue job
*
- * @return string priority
+ * @return string|bool priority or FALSE on failure
* @throws \Exception
*/
private static function nextPriority()
/**
* Find and claim the next worker process for us
*
- * @return boolean Have we found something?
+ * @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
private static function findWorkerProcesses()
* @return array worker processes
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public static function workerProcess()
+ public static function workerProcess(): array
{
// There can already be jobs for us in the queue.
$waiting = self::getWaitingJobForPID();
$stamp = (float)microtime(true);
if (!DI::lock()->acquire(self::LOCK_PROCESS)) {
- return false;
+ return [];
}
self::$lock_duration += (microtime(true) - $stamp);
DI::lock()->release(self::LOCK_PROCESS);
- return self::getWaitingJobForPID();
+ // Prevents "Return value of Friendica\Core\Worker::workerProcess() must be of the type array, bool returned"
+ $process = self::getWaitingJobForPID();
+ return (is_array($process) ? $process : []);
}
/**
* 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);
}
- /**
- * Call the front end worker
- *
- * @return void
- * @throws \Friendica\Network\HTTPException\InternalServerErrorException
- */
- public static function callWorker()
- {
- if (!DI::config()->get("system", "frontend_worker")) {
- return;
- }
-
- $url = DI::baseUrl() . '/worker';
- DI::httpRequest()->fetch($url, 1);
- }
-
- /**
- * Call the front end worker if there aren't any active
- *
- * @return void
- * @throws \Friendica\Network\HTTPException\InternalServerErrorException
- */
- public static function executeIfIdle()
- {
- self::checkDaemonState();
-
- if (!DI::config()->get("system", "frontend_worker")) {
- return;
- }
-
- // Do we have "proc_open"? Then we can fork the worker
- if (function_exists("proc_open")) {
- // When was the last time that we called the worker?
- // Less than one minute? Then we quit
- if ((time() - DI::config()->get("system", "worker_started")) < 60) {
- return;
- }
-
- DI::config()->set("system", "worker_started", time());
-
- // Do we have enough running workers? Then we quit here.
- if (self::tooMuchWorkers()) {
- // Cleaning dead processes
- self::killStaleWorkers();
- DI::modelProcess()->deleteInactive();
-
- return;
- }
-
- self::runCron();
-
- Logger::info('Call worker');
- self::spawnWorker();
- return;
- }
-
- // We cannot execute background processes.
- // We now run the processes from the frontend.
- // This won't work with long running processes.
- self::runCron();
-
- self::clearProcesses();
-
- $workers = self::activeWorkers();
-
- if ($workers == 0) {
- self::callWorker();
- }
- }
-
- /**
- * Removes long running worker processes
- *
- * @return void
- * @throws \Friendica\Network\HTTPException\InternalServerErrorException
- */
- public static function clearProcesses()
- {
- $timeout = DI::config()->get("system", "frontend_worker_timeout", 10);
-
- /// @todo We should clean up the corresponding workerqueue entries as well
- $stamp = (float)microtime(true);
- $condition = ["`created` < ? AND `command` = 'worker.php'",
- DateTimeFormat::utc("now - ".$timeout." minutes")];
- DBA::delete('process', $condition);
- self::$db_duration = (microtime(true) - $stamp);
- self::$db_duration_write += (microtime(true) - $stamp);
- }
-
- /**
- * Runs the cron processes
- *
- * @return void
- * @throws \Friendica\Network\HTTPException\InternalServerErrorException
- */
- private static function runCron()
- {
- Logger::info('Add cron entries');
-
- // Check for spooled items
- self::add(['priority' => PRIORITY_HIGH, 'force_priority' => true], 'SpoolPost');
-
- // Run the cron job that calls all other jobs
- self::add(['priority' => PRIORITY_MEDIUM, 'force_priority' => true], 'Cron');
-
- // Cleaning dead processes
- self::killStaleWorkers();
- }
-
/**
* Fork a child process
*
*/
private static function forkProcess(bool $do_cron)
{
- if (DI::process()->isMinMemoryReached()) {
+ if (DI::system()->isMinMemoryReached()) {
Logger::warning('Memory limit reached - quitting');
return;
}
} elseif ($pid) {
// The parent process continues here
DBA::connect();
+
+ Worker\IPC::SetJobState(true, $pid);
Logger::info('Spawned new worker', ['pid' => $pid]);
- self::IPCSetJobState(true, $pid);
$cycles = 0;
- while (self::IPCJobsExists($pid) && (++$cycles < 100)) {
+ while (Worker\IPC::JobsExists($pid) && (++$cycles < 100)) {
usleep(10000);
}
// We now are in the new worker
DBA::connect();
- Logger::info('Worker spawned', ['pid' => getmypid()]);
+
+ DI::flushLogger();
+ $process = DI::process()->create(getmypid(), basename(__FILE__));
$cycles = 0;
- while (!self::IPCJobsExists($pid) && (++$cycles < 100)) {
+ while (!Worker\IPC::JobsExists($process->pid) && (++$cycles < 100)) {
usleep(10000);
}
- Logger::info('Parent is ready', ['pid' => getmypid(), '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, getmypid());
- DI::process()->end();
- Logger::info('Worker ended', ['pid' => getmypid()]);
+ Worker\IPC::SetJobState(false, $process->pid);
+ DI::process()->delete($process);
+ Logger::info('Worker ended', ['pid' => $process->pid]);
exit();
}
* @return void
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public static function spawnWorker($do_cron = false)
+ public static function spawnWorker(bool $do_cron = false)
{
- if (self::isDaemonMode() && DI::config()->get('system', 'worker_fork')) {
+ if (Worker\Daemon::isMode() && 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);
+ if (Worker\Daemon::isMode()) {
+ Worker\IPC::SetJobState(false);
}
}
* or: Worker::add(PRIORITY_HIGH, "Notifier", Delivery::DELETION, $drop_id);
* or: Worker::add(array('priority' => PRIORITY_HIGH, 'dont_fork' => true), "Delivery", $post_id);
*
- * @return boolean "false" if worker queue entry already existed or there had been an error
+ * @return int "0" if worker queue entry already existed or there had been an error, otherwise the ID of the worker task
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
* @note $cmd and string args are surrounded with ""
*
* array $arr
*
*/
- public static function add($cmd)
+ public static function add(...$args)
{
- $args = func_get_args();
-
if (!count($args)) {
- return false;
+ return 0;
}
$arr = ['args' => $args, 'run_cmd' => true];
Hook::callAll("proc_run", $arr);
if (!$arr['run_cmd'] || !count($args)) {
- return true;
+ return 1;
}
$priority = PRIORITY_MEDIUM;
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);
$parameters = json_encode($args);
$found = DBA::exists('workerqueue', ['command' => $command, 'parameter' => $parameters, 'done' => false]);
- $added = 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;
}
// Quit if there was a database error - a precaution for the update process to 3.5.3
if (DBA::errorNo() != 0) {
- return false;
+ return 0;
}
if (!$found) {
- $added = DBA::insert('workerqueue', ['command' => $command, 'parameter' => $parameters, 'created' => $created,
- 'priority' => $priority, 'next_try' => $delayed]);
- if (!$added) {
- return false;
+ if (!DBA::insert('workerqueue', ['command' => $command, 'parameter' => $parameters, 'created' => $created,
+ 'priority' => $priority, 'next_try' => $delayed])) {
+ return 0;
}
+ $added = DBA::lastInsertId();
} elseif ($force_priority) {
DBA::update('workerqueue', ['priority' => $priority], ['command' => $command, 'parameter' => $parameters, 'done' => false, 'pid' => 0]);
}
// Set the IPC flag to ensure an immediate process execution via daemon
- if (self::isDaemonMode()) {
- self::IPCSetJobState(true);
+ if (Worker\Daemon::isMode()) {
+ Worker\IPC::SetJobState(true);
}
- self::checkDaemonState();
+ Worker\Daemon::checkState();
// Should we quit and wait for the worker to be called as a cronjob?
if ($dont_fork) {
}
// Quit on daemon mode
- if (self::isDaemonMode()) {
+ if (Worker\Daemon::isMode()) {
return $added;
}
return $added;
}
- public static function countWorkersByCommand(string $command)
+ public static function countWorkersByCommand(string $command): int
{
return DBA::count('workerqueue', ['done' => false, 'pid' => 0, 'command' => $command]);
}
* @param integer $max_level maximum retrial level
* @return integer the next retrial level value
*/
- private static function getNextRetrial($queue, $max_level)
+ private static function getNextRetrial(array $queue, int $max_level): int
{
$created = strtotime($queue['created']);
$retrial_time = time() - $created;
* Defers the current worker entry
*
* @return boolean had the entry been deferred?
+ * @throws \Exception
*/
- public static function defer()
+ public static function defer(): bool
{
- if (empty(DI::app()->queue)) {
+ $queue = DI::app()->getQueue();
+
+ if (empty($queue)) {
return false;
}
- $queue = DI::app()->queue;
-
- $retrial = $queue['retrial'];
$id = $queue['id'];
$priority = $queue['priority'];
return true;
}
- /**
- * Set the flag if some job is waiting
- *
- * @param boolean $jobs Is there a waiting job?
- * @throws \Exception
- */
- public static function IPCSetJobState(bool $jobs, int $key = 0)
- {
- $stamp = (float)microtime(true);
- DBA::replace('worker-ipc', ['jobs' => $jobs, 'key' => $key]);
- self::$db_duration += (microtime(true) - $stamp);
- self::$db_duration_write += (microtime(true) - $stamp);
- }
-
- /**
- * Checks if some worker job waits to be executed
- *
- * @return bool
- * @throws \Exception
- */
- public static function IPCJobsExists(int $key = 0)
- {
- $stamp = (float)microtime(true);
- $row = DBA::selectFirst('worker-ipc', ['jobs'], ['key' => $key]);
- self::$db_duration += (microtime(true) - $stamp);
-
- // When we don't have a row, no job is running
- if (!DBA::isResult($row)) {
- return false;
- }
-
- return (bool)$row['jobs'];
- }
-
- /**
- * Checks if the worker is running in the daemon mode.
- *
- * @return boolean
- */
- public static function isDaemonMode()
- {
- if (!is_null(self::$daemon_mode)) {
- return self::$daemon_mode;
- }
-
- if (DI::mode()->getExecutor() == Mode::DAEMON) {
- return true;
- }
-
- $daemon_mode = DI::config()->get('system', 'worker_daemon_mode', false, true);
- if ($daemon_mode) {
- return $daemon_mode;
- }
-
- if (!function_exists('pcntl_fork')) {
- self::$daemon_mode = false;
- return false;
- }
-
- $pidfile = DI::config()->get('system', 'pidfile');
- if (empty($pidfile)) {
- // No pid file, no daemon
- self::$daemon_mode = false;
- return false;
- }
-
- if (!is_readable($pidfile)) {
- // No pid file. We assume that the daemon had been intentionally stopped.
- self::$daemon_mode = false;
- return false;
- }
-
- $pid = intval(file_get_contents($pidfile));
- $running = posix_kill($pid, 0);
-
- self::$daemon_mode = $running;
- return $running;
- }
-
- /**
- * Test if the daemon is running. If not, it will be started
- *
- * @return void
- */
- private static function checkDaemonState()
- {
- if (!DI::config()->get('system', 'daemon_watchdog', false)) {
- return;
- }
-
- if (!DI::mode()->isNormal()) {
- return;
- }
-
- // Check every minute if the daemon is running
- if (DI::config()->get('system', 'last_daemon_check', 0) + 60 > time()) {
- return;
- }
-
- DI::config()->set('system', 'last_daemon_check', time());
-
- $pidfile = DI::config()->get('system', 'pidfile');
- if (empty($pidfile)) {
- // No pid file, no daemon
- return;
- }
-
- if (!is_readable($pidfile)) {
- // No pid file. We assume that the daemon had been intentionally stopped.
- return;
- }
-
- $pid = intval(file_get_contents($pidfile));
- if (posix_kill($pid, 0)) {
- Logger::info('Daemon process is running', ['pid' => $pid]);
- return;
- }
-
- Logger::warning('Daemon process is not running', ['pid' => $pid]);
-
- self::spawnDaemon();
- }
-
- /**
- * Spawn a new daemon process
- *
- * @return void
- */
- private static function spawnDaemon()
- {
- 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']);
- Logger::notice('New daemon process started');
- }
-
/**
* Check if the system is inside the defined maintenance window
*
+ * @param bool $check_last_execution Whether check last execution
* @return boolean
*/
- public static function isInMaintenanceWindow(bool $check_last_execution = false)
+ public static function isInMaintenanceWindow(bool $check_last_execution = false): bool
{
// Calculate the seconds of the start end end of the maintenance window
$start = strtotime(DI::config()->get('system', 'maintenance_start')) % 86400;
} else {
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)]);
}
-
+
return $execute;
}
}
projects / friendica.git / blobdiff