Merge pull request #8271 from MrPetovan/bug/8229-frio-mobile-back-to-top

[friendica.git] / src / Util / Pidfile.php

diff --git a/src/Util/Pidfile.php b/src/Util/Pidfile.php
index 6d940c646905bfbfce0f68cdbd62a335c01eff93..6d4c0c51089aa6bb137d3ea8f0870d88d4c579a5 100644 (file)
--- a/src/Util/Pidfile.php
+++ b/src/Util/Pidfile.php
@@ -1,86 +1,125 @@
 <?php
 /**
- * @file src/Util/Pidfile.php
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @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/>.
+ *
  */
+
 namespace Friendica\Util;
 
 /**
- * @brief Pidfile class
+ * Pidfile class
  */
-class Pidfile
+class PidFile
 {
-       private $file;
-       private $running;
-       private $pid;
-
        /**
-        * @param string $dir  path
-        * @param string $name filename
-        * @return void
+        * Read the pid from a given pid file
+        *
+        * @param string $file Filename of pid file
+        *
+        * @return boolean|string PID or "false" if not existent
         */
-       public function __construct($dir, $name)
-       {
-               $this->file = "$dir/$name";
-               $this->running = false;
-
-               if (file_exists($this->file)) {
-                       $this->pid = trim(@file_get_contents($this->file));
-                       if (($this->pid != "") && posix_kill($this->pid, 0)) {
-                               $this->running = true;
-                       }
+       static private function pidFromFile($file) {
+               if (!file_exists($file)) {
+                       return false;
                }
 
-               if (!$this->running) {
-                       $this->pid = getmypid();
-                       file_put_contents($this->file, $this->pid);
-               }
+               return trim(@file_get_contents($file));
        }
 
        /**
-        * @return void
+        * Is there a running process with the given pid file
+        *
+        * @param string $file Filename of pid file
+        *
+        * @return boolean Is it running?
         */
-       public function __destruct()
-       {
-               if (!$this->running && file_exists($this->file)) {
-                       @unlink($this->file);
+       static public function isRunningProcess($file) {
+               $pid = self::pidFromFile($file);
+
+               if (!$pid) {
+                       return false;
                }
-       }
 
-       /**
-        * @brief Check if a process with this pid file is already running
-        * @return boolean Is it running?
-        */
-       public function isRunning()
-       {
-               return $this->running;
+               // 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;
        }
 
        /**
-        * @brief Return the pid of the process
-        * @return boolean process id
+        * Kills a process from a given pid file
+        *
+        * @param string $file Filename of pid file
+        *
+        * @return boolean Was it killed successfully?
         */
-       public function pid()
-       {
-               return $this->pid;
+       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;
        }
 
        /**
-        * @brief Returns the seconds that the old process was running
-        * @return integer run time of the old process
+        * Creates a pid file
+        *
+        * @param string $file Filename of pid file
+        *
+        * @return boolean|string PID or "false" if not created
         */
-       public function runningTime()
-       {
-               return time() - @filectime($this->file);
+       static public function create($file) {
+               $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);
        }
 
        /**
-        * @brief Kills the old process
-        * @return boolean
+        * Deletes a given pid file
+        *
+        * @param string $file Filename of pid file
+        *
+        * @return boolean Is it running?
         */
-       public function kill()
-       {
-               if (!empty($this->pid)) {
-                       return posix_kill($this->pid, SIGTERM);
-               }
+       static public function delete($file) {
+               return @unlink($file);
        }
 }