4 * @copyright Copyright (C) 2010-2023, the Friendica project
6 * @license GNU AGPL version 3 or any later version
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU Affero General Public License as
10 * published by the Free Software Foundation, either version 3 of the
11 * License, or (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU Affero General Public License for more details.
18 * You should have received a copy of the GNU Affero General Public License
19 * along with this program. If not, see <https://www.gnu.org/licenses/>.
24 * Run the worker from a daemon.
26 * This script was taken from http://php.net/manual/en/function.pcntl-fork.php
28 if (php_sapi_name() !== 'cli') {
29 header($_SERVER['SERVER_PROTOCOL'] . ' 403 Forbidden');
34 use Friendica\App\Mode;
35 use Friendica\Core\Logger;
36 use Friendica\Core\Worker;
37 use Friendica\Database\DBA;
39 use Friendica\Util\DateTimeFormat;
40 use Psr\Log\LoggerInterface;
44 $longopts = ['foreground'];
45 $options = getopt($shortopts, $longopts);
47 // Ensure that daemon.php is executed from the base path of the installation
48 if (!file_exists('index.php') && (sizeof($_SERVER['argv']) != 0)) {
49 $directory = dirname($_SERVER['argv'][0]);
51 if (substr($directory, 0, 1) != '/') {
52 $directory = $_SERVER['PWD'] . '/' . $directory;
54 $directory = realpath($directory . '/..');
59 require dirname(__DIR__) . '/vendor/autoload.php';
61 $dice = (new Dice())->addRules(include __DIR__ . '/../static/dependencies.config.php');
62 $dice = $dice->addRule(LoggerInterface::class,['constructParams' => ['daemon']]);
65 \Friendica\Core\Logger\Handler\ErrorHandler::register($dice->create(\Psr\Log\LoggerInterface::class));
67 if (DI::mode()->isInstall()) {
68 die("Friendica isn't properly installed yet.\n");
71 DI::mode()->setExecutor(Mode::DAEMON);
73 DI::config()->reload();
75 if (empty(DI::config()->get('system', 'pidfile'))) {
77 Please set system.pidfile in config/local.config.php. For example:
80 'pidfile' => '/path/to/daemon.pid',
86 $pidfile = DI::config()->get('system', 'pidfile');
88 if (in_array('start', $_SERVER['argv'])) {
92 if (in_array('stop', $_SERVER['argv'])) {
96 if (in_array('status', $_SERVER['argv'])) {
100 $foreground = array_key_exists('f', $options) || array_key_exists('foreground', $options);
103 die("Please use either 'start', 'stop' or 'status'.\n");
106 if (empty($_SERVER['argv'][0])) {
107 die("Unexpected script behaviour. This message should never occur.\n");
112 if (is_readable($pidfile)) {
113 $pid = intval(file_get_contents($pidfile));
116 if (empty($pid) && in_array($mode, ['stop', 'status'])) {
117 DI::keyValue()->set('worker_daemon_mode', false);
118 die("Pidfile wasn't found. Is the daemon running?\n");
121 if ($mode == 'status') {
122 if (posix_kill($pid, 0)) {
123 die("Daemon process $pid is running.\n");
128 DI::keyValue()->set('worker_daemon_mode', false);
129 die("Daemon process $pid isn't running.\n");
132 if ($mode == 'stop') {
133 posix_kill($pid, SIGTERM);
137 Logger::notice('Worker daemon process was killed', ['pid' => $pid]);
139 DI::keyValue()->set('worker_daemon_mode', false);
140 die("Worker daemon process $pid was killed.\n");
143 if (!empty($pid) && posix_kill($pid, 0)) {
144 die("Daemon process $pid is already running.\n");
147 Logger::notice('Starting worker daemon.', ['pid' => $pid]);
150 echo "Starting worker daemon.\n";
154 // Fork a daemon process
157 echo "Daemon couldn't be forked.\n";
158 Logger::warning('Could not fork daemon');
161 // The parent process continues here
162 echo 'Child process started with pid ' . $pid . ".\n";
163 Logger::notice('Child process started', ['pid' => $pid]);
164 file_put_contents($pidfile, $pid);
168 // We now are in the child process
169 register_shutdown_function('shutdown');
171 // Make the child the main process, detach it from the terminal
172 if (posix_setsid() < 0) {
176 // Closing all existing connections with the outside
179 // And now connect the database again
183 DI::keyValue()->set('worker_daemon_mode', true);
185 // Just to be sure that this script really runs endlessly
188 $wait_interval = intval(DI::config()->get('system', 'cron_interval', 5)) * 60;
193 // Now running as a daemon.
195 if (!$do_cron && ($last_cron + $wait_interval) < time()) {
196 Logger::info('Forcing cron worker call.', ['pid' => $pid]);
200 if ($do_cron || (!DI::system()->isMaxLoadReached() && Worker::entriesExists() && Worker::isReady())) {
201 Worker::spawnWorker($do_cron);
203 Logger::info('Cool down for 5 seconds', ['pid' => $pid]);
208 // We force a reconnect of the database connection.
209 // This is done to ensure that the connection don't get lost over time.
216 Logger::info('Sleeping', ['pid' => $pid, 'until' => gmdate(DateTimeFormat::MYSQL, $start + $wait_interval)]);
219 $seconds = (time() - $start);
221 // logarithmic wait time calculation.
222 // Background: After jobs had been started, they often fork many workers.
223 // To not waste too much time, the sleep period increases.
224 $arg = (($seconds + 1) / ($wait_interval / 9)) + 1;
225 $sleep = min(1000000, round(log10($arg) * 1000000, 0));
228 $pid = pcntl_waitpid(-1, $status, WNOHANG);
230 Logger::info('Children quit via pcntl_waitpid', ['pid' => $pid, 'status' => $status]);
233 $timeout = ($seconds >= $wait_interval);
234 } while (!$timeout && !Worker\IPC::JobsExists());
238 Logger::info('Woke up after $wait_interval seconds.', ['pid' => $pid, 'sleep' => $wait_interval]);
241 Logger::info('Worker jobs are calling to be forked.', ['pid' => $pid]);
245 function shutdown() {
246 posix_kill(posix_getpid(), SIGHUP);