friendica/bin/daemon.php

261 lines
6.9 KiB
PHP
Raw Permalink Normal View History

2022-05-21 00:52:44 +02:00
#!/usr/bin/env php
<?php
2016-11-27 23:52:21 +01:00
/**
* @copyright Copyright (C) 2010-2024, the Friendica project
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*
2022-05-20 06:52:18 +02:00
*/
/**
2020-01-19 21:44:01 +01:00
* Run the worker from a daemon.
2022-05-21 00:52:44 +02:00
*
2016-11-27 23:52:21 +01:00
* This script was taken from http://php.net/manual/en/function.pcntl-fork.php
*/
if (php_sapi_name() !== 'cli') {
2022-06-23 01:46:37 +02:00
header($_SERVER['SERVER_PROTOCOL'] . ' 403 Forbidden');
exit();
}
2019-08-05 09:02:55 +02:00
use Dice\Dice;
2021-01-01 20:35:29 +01:00
use Friendica\App\Mode;
2019-02-12 20:12:25 +01:00
use Friendica\Core\Logger;
2023-01-06 12:50:14 +01:00
use Friendica\Core\Update;
use Friendica\Core\Worker;
use Friendica\Database\DBA;
use Friendica\DI;
use Friendica\Util\DateTimeFormat;
2023-07-17 01:56:13 +02:00
use Psr\Log\LoggerInterface;
// Get options
2018-07-24 05:42:44 +02:00
$shortopts = 'f';
$longopts = ['foreground'];
$options = getopt($shortopts, $longopts);
// Ensure that daemon.php is executed from the base path of the installation
if (!file_exists('index.php') && (sizeof($_SERVER['argv']) != 0)) {
2022-06-23 01:46:37 +02:00
$directory = dirname($_SERVER['argv'][0]);
2022-06-23 01:46:37 +02:00
if (substr($directory, 0, 1) != '/') {
$directory = $_SERVER['PWD'] . '/' . $directory;
}
2022-06-23 01:46:37 +02:00
$directory = realpath($directory . '/..');
chdir($directory);
}
require dirname(__DIR__) . '/vendor/autoload.php';
2019-08-05 09:02:55 +02:00
$dice = (new Dice())->addRules(include __DIR__ . '/../static/dependencies.config.php');
2023-07-23 03:21:41 +02:00
/** @var \Friendica\Core\Addon\Capability\ICanLoadAddons $addonLoader */
$addonLoader = $dice->create(\Friendica\Core\Addon\Capability\ICanLoadAddons::class);
$dice = $dice->addRules($addonLoader->getActiveAddonConfig('dependencies'));
2023-07-23 03:21:41 +02:00
$dice = $dice->addRule(LoggerInterface::class, ['constructParams' => [Logger\Capability\LogChannel::DAEMON]]);
DI::init($dice);
2021-10-23 20:46:17 +02:00
\Friendica\Core\Logger\Handler\ErrorHandler::register($dice->create(\Psr\Log\LoggerInterface::class));
if (DI::mode()->isInstall()) {
2018-06-26 02:56:07 +02:00
die("Friendica isn't properly installed yet.\n");
}
2021-01-01 20:35:29 +01:00
DI::mode()->setExecutor(Mode::DAEMON);
2022-12-28 02:07:38 +01:00
DI::config()->reload();
if (empty(DI::config()->get('system', 'pidfile'))) {
die(<<<TXT
Please set system.pidfile in config/local.config.php. For example:
2023-03-30 19:56:51 +02:00
'system' => [
'pidfile' => '/path/to/daemon.pid',
],
TXT
);
}
$pidfile = DI::config()->get('system', 'pidfile');
2022-06-23 01:46:37 +02:00
if (in_array('start', $_SERVER['argv'])) {
$mode = 'start';
}
2022-06-23 01:46:37 +02:00
if (in_array('stop', $_SERVER['argv'])) {
$mode = 'stop';
}
2022-06-23 01:46:37 +02:00
if (in_array('status', $_SERVER['argv'])) {
$mode = 'status';
}
$foreground = array_key_exists('f', $options) || array_key_exists('foreground', $options);
if (!isset($mode)) {
die("Please use either 'start', 'stop' or 'status'.\n");
}
2022-06-23 01:46:37 +02:00
if (empty($_SERVER['argv'][0])) {
2017-12-14 17:38:51 +01:00
die("Unexpected script behaviour. This message should never occur.\n");
}
$pid = null;
if (is_readable($pidfile)) {
$pid = intval(file_get_contents($pidfile));
}
2017-12-14 17:38:51 +01:00
2022-06-23 01:46:37 +02:00
if (empty($pid) && in_array($mode, ['stop', 'status'])) {
DI::keyValue()->set('worker_daemon_mode', false);
die("Pidfile wasn't found. Is the daemon running?\n");
}
2022-06-23 01:46:37 +02:00
if ($mode == 'status') {
if (posix_kill($pid, 0)) {
die("Daemon process $pid is running.\n");
}
unlink($pidfile);
2023-01-03 23:58:33 +01:00
DI::keyValue()->set('worker_daemon_mode', false);
die("Daemon process $pid isn't running.\n");
}
2022-06-23 01:46:37 +02:00
if ($mode == 'stop') {
posix_kill($pid, SIGTERM);
unlink($pidfile);
2022-06-23 01:46:37 +02:00
Logger::notice('Worker daemon process was killed', ['pid' => $pid]);
DI::keyValue()->set('worker_daemon_mode', false);
die("Worker daemon process $pid was killed.\n");
}
if (!empty($pid) && posix_kill($pid, 0)) {
die("Daemon process $pid is already running.\n");
}
2022-06-23 01:46:37 +02:00
Logger::notice('Starting worker daemon.', ['pid' => $pid]);
if (!$foreground) {
echo "Starting worker daemon.\n";
DBA::disconnect();
2021-01-01 20:35:29 +01:00
// Fork a daemon process
$pid = pcntl_fork();
if ($pid == -1) {
echo "Daemon couldn't be forked.\n";
Logger::warning('Could not fork daemon');
exit(1);
} elseif ($pid) {
// The parent process continues here
if (!file_put_contents($pidfile, $pid)) {
echo "Pid file wasn't written.\n";
Logger::warning('Could not store pid file');
posix_kill($pid, SIGTERM);
exit(1);
}
2021-01-01 20:35:29 +01:00
echo 'Child process started with pid ' . $pid . ".\n";
Logger::notice('Child process started', ['pid' => $pid]);
exit(0);
}
// We now are in the child process
register_shutdown_function('shutdown');
2021-01-01 20:35:29 +01:00
// Make the child the main process, detach it from the terminal
if (posix_setsid() < 0) {
return;
}
2021-01-01 20:35:29 +01:00
// Closing all existing connections with the outside
fclose(STDIN);
2021-01-01 20:35:29 +01:00
// And now connect the database again
DBA::connect();
}
DI::keyValue()->set('worker_daemon_mode', true);
// Just to be sure that this script really runs endlessly
set_time_limit(0);
2017-12-14 17:38:51 +01:00
$wait_interval = intval(DI::config()->get('system', 'cron_interval', 5)) * 60;
2017-12-14 17:38:51 +01:00
$do_cron = true;
$last_cron = 0;
// Now running as a daemon.
while (true) {
2023-01-06 12:50:14 +01:00
// Check the database structure and possibly fixes it
Update::check(DI::basePath(), true);
if (!$do_cron && ($last_cron + $wait_interval) < time()) {
2022-06-23 01:46:37 +02:00
Logger::info('Forcing cron worker call.', ['pid' => $pid]);
$do_cron = true;
}
2021-10-24 20:43:59 +02:00
if ($do_cron || (!DI::system()->isMaxLoadReached() && Worker::entriesExists() && Worker::isReady())) {
2020-08-19 20:21:40 +02:00
Worker::spawnWorker($do_cron);
} else {
Logger::info('Cool down for 5 seconds', ['pid' => $pid]);
sleep(5);
2020-08-19 20:21:40 +02:00
}
if ($do_cron) {
// We force a reconnect of the database connection.
// This is done to ensure that the connection don't get lost over time.
DBA::reconnect();
$last_cron = time();
}
$start = time();
2022-06-23 01:46:37 +02:00
Logger::info('Sleeping', ['pid' => $pid, 'until' => gmdate(DateTimeFormat::MYSQL, $start + $wait_interval)]);
do {
$seconds = (time() - $start);
// logarithmic wait time calculation.
// Background: After jobs had been started, they often fork many workers.
// To not waste too much time, the sleep period increases.
$arg = (($seconds + 1) / ($wait_interval / 9)) + 1;
$sleep = min(1000000, round(log10($arg) * 1000000, 0));
usleep($sleep);
2021-01-03 23:57:25 +01:00
$pid = pcntl_waitpid(-1, $status, WNOHANG);
if ($pid > 0) {
Logger::info('Children quit via pcntl_waitpid', ['pid' => $pid, 'status' => $status]);
}
$timeout = ($seconds >= $wait_interval);
} while (!$timeout && !Worker\IPC::JobsExists());
if ($timeout) {
$do_cron = true;
2022-06-23 01:46:37 +02:00
Logger::info('Woke up after $wait_interval seconds.', ['pid' => $pid, 'sleep' => $wait_interval]);
} else {
$do_cron = false;
2022-06-23 01:46:37 +02:00
Logger::info('Worker jobs are calling to be forked.', ['pid' => $pid]);
}
}
function shutdown() {
2023-03-30 19:56:51 +02:00
posix_kill(posix_getpid(), SIGTERM);
posix_kill(posix_getpid(), SIGHUP);
}