]> git.mxchange.org Git - friendica.git/blobdiff - include/poller.php
Removed some more unneeded stuff
[friendica.git] / include / poller.php
index 2e036247e237cf06c40d5f514300b2c57e1a1525..89ab85a1f5f420a09c4b33365595f2a9c28fbc7c 100644 (file)
@@ -11,11 +11,10 @@ if (!file_exists("boot.php") AND (sizeof($_SERVER["argv"]) != 0)) {
 }
 
 use \Friendica\Core\Config;
-use \Friendica\Core\PConfig;
 
 require_once("boot.php");
 
-function poller_run(&$argv, &$argc){
+function poller_run($argv, $argc){
        global $a, $db;
 
        if(is_null($a)) {
@@ -29,141 +28,240 @@ function poller_run(&$argv, &$argc){
                unset($db_host, $db_user, $db_pass, $db_data);
        };
 
+       Config::load();
+
        // Quit when in maintenance
-       if (get_config('system', 'maintenance', true))
+       if (Config::get('system', 'maintenance', true)) {
                return;
+       }
 
-       $a->start_process();
+       $a->set_baseurl(Config::get('system', 'url'));
 
-       $mypid = getmypid();
+       load_hooks();
 
-       if ($a->max_processes_reached())
-               return;
-
-       if (poller_max_connections_reached())
-               return;
+       $a->start_process();
 
-       if (App::maxload_reached())
+       if (poller_max_connections_reached()) {
                return;
+       }
 
-       // Checking the number of workers
-       if (poller_too_much_workers()) {
-               poller_kill_stale_workers();
+       if ($a->maxload_reached()) {
                return;
        }
 
        if(($argc <= 1) OR ($argv[1] != "no_cron")) {
-               // Run the cron job that calls all other jobs
-               proc_run(PRIORITY_MEDIUM, "include/cron.php");
+               poller_run_cron();
+       }
 
-               // Run the cronhooks job separately from cron for being able to use a different timing
-               proc_run(PRIORITY_MEDIUM, "include/cronhooks.php");
+       if ($a->max_processes_reached()) {
+               return;
+       }
 
-               // Cleaning dead processes
+       // Checking the number of workers
+       if (poller_too_much_workers()) {
                poller_kill_stale_workers();
-       } else
-               // Sleep four seconds before checking for running processes again to avoid having too many workers
-               sleep(4);
-
-       // Checking number of workers
-       if (poller_too_much_workers())
                return;
-
-       $cooldown = Config::get("system", "worker_cooldown", 0);
+       }
 
        $starttime = time();
 
        while ($r = poller_worker_process()) {
 
-               // Quit when in maintenance
-               if (get_config('system', 'maintenance', true))
+               // Count active workers and compare them with a maximum value that depends on the load
+               if (poller_too_much_workers()) {
                        return;
+               }
 
-               // Constantly check the number of parallel database processes
-               if ($a->max_processes_reached())
+               if (!poller_execute($r[0])) {
                        return;
+               }
 
-               // Constantly check the number of available database connections to let the frontend be accessible at any time
-               if (poller_max_connections_reached())
+               // Quit the poller once every hour
+               if (time() > ($starttime + 3600))
                        return;
+       }
 
-               // Count active workers and compare them with a maximum value that depends on the load
-               if (poller_too_much_workers())
-                       return;
+}
 
-               $upd = q("UPDATE `workerqueue` SET `executed` = '%s', `pid` = %d WHERE `id` = %d AND `pid` = 0",
-                       dbesc(datetime_convert()),
-                       intval($mypid),
-                       intval($r[0]["id"]));
+/**
+ * @brief Execute a worker entry
+ *
+ * @param array $queue Workerqueue entry
+ *
+ * @return boolean "true" if further processing should be stopped
+ */
+function poller_execute($queue) {
 
-               if (!$upd) {
-                       logger("Couldn't update queue entry ".$r[0]["id"]." - skip this execution", LOGGER_DEBUG);
-                       q("COMMIT");
-                       continue;
-               }
+       $a = get_app();
 
-               // Assure that there are no tasks executed twice
-               $id = q("SELECT `pid`, `executed` FROM `workerqueue` WHERE `id` = %d", intval($r[0]["id"]));
-               if (!$id) {
-                       logger("Queue item ".$r[0]["id"]." vanished - skip this execution", LOGGER_DEBUG);
-                       q("COMMIT");
-                       continue;
-               } elseif ((strtotime($id[0]["executed"]) <= 0) OR ($id[0]["pid"] == 0)) {
-                       logger("Entry for queue item ".$r[0]["id"]." wasn't stored - skip this execution", LOGGER_DEBUG);
-                       q("COMMIT");
-                       continue;
-               } elseif ($id[0]["pid"] != $mypid) {
-                       logger("Queue item ".$r[0]["id"]." is to be executed by process ".$id[0]["pid"]." and not by me (".$mypid.") - skip this execution", LOGGER_DEBUG);
-                       q("COMMIT");
-                       continue;
-               }
+       $mypid = getmypid();
+
+       // Quit when in maintenance
+       if (Config::get('system', 'maintenance', true)) {
+               return false;
+       }
+
+       // Constantly check the number of parallel database processes
+       if ($a->max_processes_reached()) {
+               return false;
+       }
+
+       // Constantly check the number of available database connections to let the frontend be accessible at any time
+       if (poller_max_connections_reached()) {
+               return false;
+       }
+
+       $upd = q("UPDATE `workerqueue` SET `executed` = '%s', `pid` = %d WHERE `id` = %d AND `pid` = 0",
+               dbesc(datetime_convert()),
+               intval($mypid),
+               intval($queue["id"]));
+
+       if (!$upd) {
+               logger("Couldn't update queue entry ".$queue["id"]." - skip this execution", LOGGER_DEBUG);
                q("COMMIT");
+               return true;
+       }
 
-               $argv = json_decode($r[0]["parameter"]);
+       // Assure that there are no tasks executed twice
+       $id = q("SELECT `pid`, `executed` FROM `workerqueue` WHERE `id` = %d", intval($queue["id"]));
+       if (!$id) {
+               logger("Queue item ".$queue["id"]." vanished - skip this execution", LOGGER_DEBUG);
+               q("COMMIT");
+               return true;
+       } elseif ((strtotime($id[0]["executed"]) <= 0) OR ($id[0]["pid"] == 0)) {
+               logger("Entry for queue item ".$queue["id"]." wasn't stored - skip this execution", LOGGER_DEBUG);
+               q("COMMIT");
+               return true;
+       } elseif ($id[0]["pid"] != $mypid) {
+               logger("Queue item ".$queue["id"]." is to be executed by process ".$id[0]["pid"]." and not by me (".$mypid.") - skip this execution", LOGGER_DEBUG);
+               q("COMMIT");
+               return true;
+       }
+       q("COMMIT");
 
-               $argc = count($argv);
+       $argv = json_decode($queue["parameter"]);
 
-               // Check for existance and validity of the include file
-               $include = $argv[0];
+       // Check for existance and validity of the include file
+       $include = $argv[0];
 
-               if (!validate_include($include)) {
-                       logger("Include file ".$argv[0]." is not valid!");
-                       q("DELETE FROM `workerqueue` WHERE `id` = %d", intval($r[0]["id"]));
-                       continue;
-               }
+       if (!validate_include($include)) {
+               logger("Include file ".$argv[0]." is not valid!");
+               q("DELETE FROM `workerqueue` WHERE `id` = %d", intval($queue["id"]));
+               return true;
+       }
 
-               require_once($include);
+       require_once($include);
 
-               $funcname = str_replace(".php", "", basename($argv[0]))."_run";
+       $funcname = str_replace(".php", "", basename($argv[0]))."_run";
 
-               if (function_exists($funcname)) {
-                       logger("Process ".$mypid." - Prio ".$r[0]["priority"]." - ID ".$r[0]["id"].": ".$funcname." ".$r[0]["parameter"]);
+       if (function_exists($funcname)) {
 
-                       // For better logging create a new process id for every worker call
-                       // But preserve the old one for the worker
-                       $old_process_id = $a->process_id;
-                       $a->process_id = uniqid("wrk", true);
+               poller_exec_function($queue, $funcname, $argv);
 
-                       $funcname($argv, $argc);
+               q("DELETE FROM `workerqueue` WHERE `id` = %d", intval($queue["id"]));
+       } else {
+               logger("Function ".$funcname." does not exist");
+       }
 
-                       $a->process_id = $old_process_id;
+       return true;
+}
 
-                       if ($cooldown > 0) {
-                               logger("Process ".$mypid." - Prio ".$r[0]["priority"]." - ID ".$r[0]["id"].": ".$funcname." - in cooldown for ".$cooldown." seconds");
-                               sleep($cooldown);
-                       }
+/**
+ * @brief Execute a function from the queue
+ *
+ * @param array $queue Workerqueue entry
+ * @param string $funcname name of the function
+ * @param array $argv Array of values to be passed to the function
+ */
+function poller_exec_function($queue, $funcname, $argv) {
 
-                       logger("Process ".$mypid." - Prio ".$r[0]["priority"]." - ID ".$r[0]["id"].": ".$funcname." - done");
+       $a = get_app();
 
-                       q("DELETE FROM `workerqueue` WHERE `id` = %d", intval($r[0]["id"]));
-               } else
-                       logger("Function ".$funcname." does not exist");
+       $mypid = getmypid();
 
-               // Quit the poller once every hour
-               if (time() > ($starttime + 3600))
-                       return;
+       $argc = count($argv);
+
+       logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." ".$queue["parameter"]);
+
+       $stamp = (float)microtime(true);
+
+       // We use the callstack here to analyze the performance of executed worker entries.
+       // For this reason the variables have to be initialized.
+       if (Config::get("system", "profiler")) {
+               $a->performance["start"] = microtime(true);
+               $a->performance["database"] = 0;
+               $a->performance["database_write"] = 0;
+               $a->performance["network"] = 0;
+               $a->performance["file"] = 0;
+               $a->performance["rendering"] = 0;
+               $a->performance["parser"] = 0;
+               $a->performance["marktime"] = 0;
+               $a->performance["markstart"] = microtime(true);
+               $a->callstack = array();
        }
 
+       // For better logging create a new process id for every worker call
+       // But preserve the old one for the worker
+       $old_process_id = $a->process_id;
+       $a->process_id = uniqid("wrk", true);
+
+       $funcname($argv, $argc);
+
+       $a->process_id = $old_process_id;
+
+       $duration = number_format(microtime(true) - $stamp, 3);
+
+       logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - done in ".$duration." seconds.");
+
+       // Write down the performance values into the log
+       if (Config::get("system", "profiler")) {
+               $duration = microtime(true)-$a->performance["start"];
+
+               if (Config::get("rendertime", "callstack")) {
+                       if (isset($a->callstack["database"])) {
+                               $o = "\nDatabase Read:\n";
+                               foreach ($a->callstack["database"] AS $func => $time) {
+                                       $time = round($time, 3);
+                                       if ($time > 0)
+                                               $o .= $func.": ".$time."\n";
+                               }
+                       }
+                       if (isset($a->callstack["database_write"])) {
+                               $o .= "\nDatabase Write:\n";
+                               foreach ($a->callstack["database_write"] AS $func => $time) {
+                                       $time = round($time, 3);
+                                       if ($time > 0)
+                                               $o .= $func.": ".$time."\n";
+                               }
+                       }
+                       if (isset($a->callstack["network"])) {
+                               $o .= "\nNetwork:\n";
+                               foreach ($a->callstack["network"] AS $func => $time) {
+                                       $time = round($time, 3);
+                                       if ($time > 0)
+                                               $o .= $func.": ".$time."\n";
+                               }
+                       }
+               } else {
+                       $o = '';
+               }
+
+               logger("ID ".$queue["id"].": ".$funcname.": ".sprintf("DB: %s/%s, Net: %s, I/O: %s, Other: %s, Total: %s".$o,
+                       number_format($a->performance["database"] - $a->performance["database_write"], 2),
+                       number_format($a->performance["database_write"], 2),
+                       number_format($a->performance["network"], 2),
+                       number_format($a->performance["file"], 2),
+                       number_format($duration - ($a->performance["database"] + $a->performance["network"] + $a->performance["file"]), 2),
+                       number_format($duration, 2)),
+                       LOGGER_DEBUG);
+       }
+
+       $cooldown = Config::get("system", "worker_cooldown", 0);
+
+       if ($cooldown > 0) {
+               logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - in cooldown for ".$cooldown." seconds");
+               sleep($cooldown);
+       }
 }
 
 /**
@@ -174,12 +272,10 @@ function poller_run(&$argv, &$argc){
 function poller_max_connections_reached() {
 
        // Fetch the max value from the config. This is needed when the system cannot detect the correct value by itself.
-       $max = get_config("system", "max_connections");
+       $max = Config::get("system", "max_connections");
 
        // Fetch the percentage level where the poller will get active
-       $maxlevel = get_config("system", "max_connections_level");
-       if ($maxlevel == 0)
-               $maxlevel = 75;
+       $maxlevel = Config::get("system", "max_connections_level", 75);
 
        if ($max == 0) {
                // the maximum number of possible user connections can be a system variable
@@ -202,7 +298,7 @@ function poller_max_connections_reached() {
        // The processlist only shows entries of the current user
        if ($max != 0) {
                $r = q("SHOW PROCESSLIST");
-               if (!$r)
+               if (!dbm::is_result($r))
                        return false;
 
                $used = count($r);
@@ -295,13 +391,13 @@ function poller_kill_stale_workers() {
                }
 }
 
+/**
+ * @brief Checks if the number of active workers exceeds the given limits
+ *
+ * @return bool Are there too much workers running?
+ */
 function poller_too_much_workers() {
-
-
-       $queues = get_config("system", "worker_queues");
-
-       if ($queues == 0)
-               $queues = 4;
+       $queues = Config::get("system", "worker_queues", 4);
 
        $maxqueues = $queues;
 
@@ -310,9 +406,7 @@ function poller_too_much_workers() {
        // Decrease the number of workers at higher load
        $load = current_load();
        if($load) {
-               $maxsysload = intval(get_config('system','maxloadavg'));
-               if($maxsysload < 1)
-                       $maxsysload = 50;
+               $maxsysload = intval(Config::get("system", "maxloadavg", 50));
 
                $maxworkers = $queues;
 
@@ -362,9 +456,9 @@ function poller_too_much_workers() {
                logger("Load: ".$load."/".$maxsysload." - processes: ".$active."/".$entries." (".$processlist.") - maximum: ".$queues."/".$maxqueues, LOGGER_DEBUG);
 
                // Are there fewer workers running as possible? Then fork a new one.
-               if (!get_config("system", "worker_dont_fork") AND ($queues > ($active + 1)) AND ($entries > 1)) {
+               if (!Config::get("system", "worker_dont_fork") AND ($queues > ($active + 1)) AND ($entries > 1)) {
                        logger("Active workers: ".$active."/".$queues." Fork a new worker.", LOGGER_DEBUG);
-                       $args = array("php", "include/poller.php", "no_cron");
+                       $args = array("include/poller.php", "no_cron");
                        $a = get_app();
                        $a->proc_run($args);
                }
@@ -373,6 +467,11 @@ function poller_too_much_workers() {
        return($active >= $queues);
 }
 
+/**
+ * @brief Returns the number of active poller processes
+ *
+ * @return integer Number of active poller processes
+ */
 function poller_active_workers() {
        $workers = q("SELECT COUNT(*) AS `processes` FROM `process` WHERE `command` = 'poller.php'");
 
@@ -394,8 +493,7 @@ function poller_passing_slow(&$highest_priority) {
 
        $r = q("SELECT `priority`
                FROM `process`
-               INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid`
-               WHERE `process`.`command` = 'poller.php'");
+               INNER JOIN `workerqueue` ON `workerqueue`.`pid` = `process`.`pid`");
 
        // No active processes at all? Fine
        if (!dbm::is_result($r))
@@ -435,7 +533,6 @@ function poller_passing_slow(&$highest_priority) {
  *
  * @return string SQL statement
  */
-
 function poller_worker_process() {
 
        q("START TRANSACTION;");
@@ -464,6 +561,99 @@ function poller_worker_process() {
        return $r;
 }
 
+/**
+ * @brief Call the front end worker
+ */
+function call_worker() {
+       if (!Config::get("system", "frontend_worker")) {
+               return;
+       }
+
+       $url = App::get_baseurl()."/worker";
+       fetch_url($url, false, $redirects, 1);
+}
+
+/**
+ * @brief Call the front end worker if there aren't any active
+ */
+function call_worker_if_idle() {
+       if (!Config::get("system", "frontend_worker")) {
+               return;
+       }
+
+       // Do we have "proc_open"? Then we can fork the poller
+       if (function_exists("proc_open")) {
+               // When was the last time that we called the worker?
+               // Less than one minute? Then we quit
+               if ((time() - Config::get("system", "worker_started")) < 60) {
+                       return;
+               }
+
+               set_config("system", "worker_started", time());
+
+               // Do we have enough running workers? Then we quit here.
+               if (poller_too_much_workers()) {
+                       // Cleaning dead processes
+                       poller_kill_stale_workers();
+                       get_app()->remove_inactive_processes();
+
+                       return;
+               }
+
+               poller_run_cron();
+
+               logger('Call poller', LOGGER_DEBUG);
+
+               $args = array("include/poller.php", "no_cron");
+               $a = get_app();
+               $a->proc_run($args);
+               return;
+       }
+
+       // We cannot execute background processes.
+       // We now run the processes from the frontend.
+       // This won't work with long running processes.
+       poller_run_cron();
+
+       clear_worker_processes();
+
+       $workers = q("SELECT COUNT(*) AS `processes` FROM `process` WHERE `command` = 'worker.php'");
+
+       if ($workers[0]["processes"] == 0) {
+               call_worker();
+       }
+}
+
+/**
+ * @brief Removes long running worker processes
+ */
+function clear_worker_processes() {
+       $timeout = Config::get("system", "frontend_worker_timeout", 10);
+
+       /// @todo We should clean up the corresponding workerqueue entries as well
+       q("DELETE FROM `process` WHERE `created` < '%s' AND `command` = 'worker.php'",
+               dbesc(datetime_convert('UTC','UTC',"now - ".$timeout." minutes")));
+}
+
+/**
+ * @brief Runs the cron processes
+ */
+function poller_run_cron() {
+       logger('Add cron entries', LOGGER_DEBUG);
+
+       // Check for spooled items
+       proc_run(PRIORITY_HIGH, "include/spool_post.php");
+
+       // Run the cron job that calls all other jobs
+       proc_run(PRIORITY_MEDIUM, "include/cron.php");
+
+       // Run the cronhooks job separately from cron for being able to use a different timing
+       proc_run(PRIORITY_MEDIUM, "include/cronhooks.php");
+
+       // Cleaning dead processes
+       poller_kill_stale_workers();
+}
+
 if (array_search(__file__,get_included_files())===0){
        poller_run($_SERVER["argv"],$_SERVER["argc"]);