2017-12-04 19:12:22 +01:00
|
|
|
<?php
|
|
|
|
/**
|
2022-01-02 08:27:47 +01:00
|
|
|
* @copyright Copyright (C) 2010-2022, the Friendica project
|
2020-02-09 16:18:46 +01:00
|
|
|
*
|
|
|
|
* @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/>.
|
|
|
|
*
|
2017-12-04 19:12:22 +01:00
|
|
|
*/
|
2020-02-09 16:18:46 +01:00
|
|
|
|
2017-12-04 19:12:22 +01:00
|
|
|
namespace Friendica\Util;
|
|
|
|
|
|
|
|
/**
|
2020-01-19 07:05:23 +01:00
|
|
|
* Pidfile class
|
2017-12-04 19:12:22 +01:00
|
|
|
*/
|
2017-12-17 21:24:57 +01:00
|
|
|
class PidFile
|
2017-12-04 19:12:22 +01:00
|
|
|
{
|
|
|
|
/**
|
2020-01-19 07:05:23 +01:00
|
|
|
* Read the pid from a given pid file
|
2017-12-09 18:49:11 +01:00
|
|
|
*
|
|
|
|
* @param string $file Filename of pid file
|
|
|
|
*
|
|
|
|
* @return boolean|string PID or "false" if not existent
|
2017-12-04 19:12:22 +01:00
|
|
|
*/
|
2017-12-09 18:49:11 +01:00
|
|
|
static private function pidFromFile($file) {
|
|
|
|
if (!file_exists($file)) {
|
|
|
|
return false;
|
2017-12-04 19:12:22 +01:00
|
|
|
}
|
|
|
|
|
2017-12-09 18:49:11 +01:00
|
|
|
return trim(@file_get_contents($file));
|
2017-12-04 19:12:22 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2020-01-19 07:05:23 +01:00
|
|
|
* Is there a running process with the given pid file
|
2017-12-09 18:49:11 +01:00
|
|
|
*
|
|
|
|
* @param string $file Filename of pid file
|
|
|
|
*
|
|
|
|
* @return boolean Is it running?
|
2017-12-04 19:12:22 +01:00
|
|
|
*/
|
2017-12-09 18:49:11 +01:00
|
|
|
static public function isRunningProcess($file) {
|
|
|
|
$pid = self::pidFromFile($file);
|
|
|
|
|
|
|
|
if (!$pid) {
|
|
|
|
return false;
|
2017-12-04 19:12:22 +01:00
|
|
|
}
|
|
|
|
|
2017-12-09 18:49:11 +01:00
|
|
|
// Is the process running?
|
|
|
|
$running = posix_kill($pid, 0);
|
|
|
|
|
|
|
|
// If not, then we will kill the stale file
|
|
|
|
if (!$running) {
|
|
|
|
self::delete($file);
|
|
|
|
}
|
|
|
|
return $running;
|
2017-12-09 10:46:21 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2020-01-19 07:05:23 +01:00
|
|
|
* Kills a process from a given pid file
|
2017-12-09 18:49:11 +01:00
|
|
|
*
|
|
|
|
* @param string $file Filename of pid file
|
|
|
|
*
|
|
|
|
* @return boolean Was it killed successfully?
|
2017-12-04 19:12:22 +01:00
|
|
|
*/
|
2017-12-09 18:49:11 +01:00
|
|
|
static public function killProcess($file) {
|
|
|
|
$pid = self::pidFromFile($file);
|
|
|
|
|
|
|
|
// We don't have a process id? then we quit
|
|
|
|
if (!$pid) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
// We now kill the process
|
|
|
|
$killed = posix_kill($pid, SIGTERM);
|
|
|
|
|
|
|
|
// If we killed the process successfully, we can remove the pidfile
|
|
|
|
if ($killed) {
|
|
|
|
self::delete($file);
|
|
|
|
}
|
|
|
|
return $killed;
|
2017-12-04 19:12:22 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2020-01-19 07:05:23 +01:00
|
|
|
* Creates a pid file
|
2017-12-09 18:49:11 +01:00
|
|
|
*
|
|
|
|
* @param string $file Filename of pid file
|
|
|
|
*
|
|
|
|
* @return boolean|string PID or "false" if not created
|
2017-12-04 19:12:22 +01:00
|
|
|
*/
|
2022-06-21 11:44:23 +02:00
|
|
|
static public function create(string $file)
|
|
|
|
{
|
2017-12-09 18:49:11 +01:00
|
|
|
$pid = self::pidFromFile($file);
|
|
|
|
|
|
|
|
// We have a process id? then we quit
|
|
|
|
if ($pid) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
$pid = getmypid();
|
|
|
|
file_put_contents($file, $pid);
|
|
|
|
|
|
|
|
// Now we check if everything is okay
|
|
|
|
return self::pidFromFile($file);
|
2017-12-04 19:12:22 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2020-01-19 07:05:23 +01:00
|
|
|
* Deletes a given pid file
|
2017-12-09 18:49:11 +01:00
|
|
|
*
|
|
|
|
* @param string $file Filename of pid file
|
|
|
|
*
|
|
|
|
* @return boolean Is it running?
|
2017-12-04 19:12:22 +01:00
|
|
|
*/
|
2022-06-21 11:44:23 +02:00
|
|
|
static public function delete(string $file): bool
|
|
|
|
{
|
2017-12-09 18:49:11 +01:00
|
|
|
return @unlink($file);
|
2017-12-04 19:12:22 +01:00
|
|
|
}
|
|
|
|
}
|