require_once("boot.php");
-function poller_run(&$argv, &$argc){
+function poller_run($argv, $argc){
global $a, $db;
if(is_null($a)) {
$a->start_process();
- $mypid = getmypid();
-
if ($a->max_processes_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");
-
- // 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();
+ poller_run_cron();
} else
// Sleep four seconds before checking for running processes again to avoid having too many workers
sleep(4);
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();
+
+ $cooldown = Config::get("system", "worker_cooldown", 0);
+
+ // Quit when in maintenance
+ if (get_config('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];
+ $argc = count($argv);
- if (!validate_include($include)) {
- logger("Include file ".$argv[0]." is not valid!");
- q("DELETE FROM `workerqueue` WHERE `id` = %d", intval($r[0]["id"]));
- continue;
- }
+ // Check for existance and validity of the include file
+ $include = $argv[0];
- require_once($include);
+ if (!validate_include($include)) {
+ logger("Include file ".$argv[0]." is not valid!");
+ q("DELETE FROM `workerqueue` WHERE `id` = %d", intval($queue["id"]));
+ return true;
+ }
- $funcname = str_replace(".php", "", basename($argv[0]))."_run";
+ require_once($include);
- if (function_exists($funcname)) {
- logger("Process ".$mypid." - Prio ".$r[0]["priority"]." - ID ".$r[0]["id"].": ".$funcname." ".$r[0]["parameter"]);
+ $funcname = str_replace(".php", "", basename($argv[0]))."_run";
- // 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);
+ if (function_exists($funcname)) {
+ logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." ".$queue["parameter"]);
- $funcname($argv, $argc);
+ // 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);
- $a->process_id = $old_process_id;
+ $funcname($argv, $argc);
- if ($cooldown > 0) {
- logger("Process ".$mypid." - Prio ".$r[0]["priority"]." - ID ".$r[0]["id"].": ".$funcname." - in cooldown for ".$cooldown." seconds");
- sleep($cooldown);
- }
+ $a->process_id = $old_process_id;
- logger("Process ".$mypid." - Prio ".$r[0]["priority"]." - ID ".$r[0]["id"].": ".$funcname." - done");
+ if ($cooldown > 0) {
+ logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - in cooldown for ".$cooldown." seconds");
+ sleep($cooldown);
+ }
- q("DELETE FROM `workerqueue` WHERE `id` = %d", intval($r[0]["id"]));
- } else
- logger("Function ".$funcname." does not exist");
+ logger("Process ".$mypid." - Prio ".$queue["priority"]." - ID ".$queue["id"].": ".$funcname." - done");
- // Quit the poller once every hour
- if (time() > ($starttime + 3600))
- return;
+ q("DELETE FROM `workerqueue` WHERE `id` = %d", intval($queue["id"]));
+ } else {
+ logger("Function ".$funcname." does not exist");
}
+ return true;
}
/**
}
}
+/**
+ * @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() {
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'");
$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))
*
* @return string SQL statement
*/
-
function poller_worker_process() {
q("START TRANSACTION;");
return $r;
}
+/**
+ * @brief Call the front end worker
+ */
+function call_worker() {
+ if (!get_config("system", "frontend_worker")) {
+ return;
+ }
+
+ $url = get_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 (!get_config("system", "frontend_worker")) {
+ return;
+ }
+
+ 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() {
+ // 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"]);
--- /dev/null
+<?php
+/**
+ * @file util/daemon.php
+ * @brief Run the poller from a daemon.
+ *
+ * This script was taken from http://php.net/manual/en/function.pcntl-fork.php
+ */
+function shutdown() {
+ posix_kill(posix_getpid(), SIGHUP);
+}
+
+if (in_array("start", $_SERVER["argv"])) {
+ $mode = "start";
+}
+
+if (in_array("stop", $_SERVER["argv"])) {
+ $mode = "stop";
+}
+
+if (in_array("status", $_SERVER["argv"])) {
+ $mode = "status";
+}
+
+if (!isset($mode)) {
+ die("Please use either 'start', 'stop' or 'status'.\n");
+}
+
+@include(".htconfig.php");
+
+if (!isset($pidfile)) {
+ die('Please specify a pid file in the variable $pidfile in the .htconfig.php. For example:'."\n".
+ '$pidfile = "/path/to/daemon.pid";'."\n");
+}
+
+if (in_array($mode, array("stop", "status"))) {
+ $pid = @file_get_contents($pidfile);
+
+ if (!$pid) {
+ die("Pidfile wasn't found. Is the daemon running?\n");
+ }
+}
+
+if ($mode == "status") {
+ if (posix_kill($pid, 0)) {
+ die("Daemon process $pid is running.\n");
+ }
+
+ unlink($pidfile);
+
+ die("Daemon process $pid isn't running.\n");
+}
+
+if ($mode == "stop") {
+ posix_kill($pid, SIGTERM);
+
+ unlink($pidfile);
+
+ die("Worker daemon process $pid was killed.\n");
+}
+
+echo "Starting worker daemon.\n";
+
+if (isset($a->config['php_path'])) {
+ $php = $a->config['php_path'];
+} else {
+ $php = "php";
+}
+
+// Switch over to daemon mode.
+if ($pid = pcntl_fork())
+ return; // Parent
+
+fclose(STDIN); // Close all of the standard
+fclose(STDOUT); // file descriptors as we
+fclose(STDERR); // are running as a daemon.
+
+register_shutdown_function('shutdown');
+
+if (posix_setsid() < 0)
+ return;
+
+if ($pid = pcntl_fork())
+ return; // Parent
+
+$pid = getmypid();
+file_put_contents($pidfile, $pid);
+
+// Now running as a daemon.
+while (true) {
+ // Just to be sure that this script really runs endlessly
+ set_time_limit(0);
+
+ // Call the poller
+ $cmdline = $php.' include/poller.php';
+
+ exec($cmdline);
+
+ // Now sleep for 5 minutes
+ sleep(300);
+}
+?>