]> git.wh0rd.org - tt-rss.git/blob - update_daemon2.php
update_daemon: use getopt; make things a bit more configurable, add help
[tt-rss.git] / update_daemon2.php
1 #!/usr/bin/env php
2 <?php
3 set_include_path(dirname(__FILE__) ."/include" . PATH_SEPARATOR .
4 get_include_path());
5
6 declare(ticks = 1);
7 chdir(dirname(__FILE__));
8
9 define('DISABLE_SESSIONS', true);
10
11 require_once "version.php";
12
13 if (strpos(VERSION, ".99") !== false || getenv('DAEMON_XDEBUG')) {
14 define('DAEMON_EXTENDED_DEBUG', true);
15 }
16
17 require_once "functions.php";
18 require_once "rssfuncs.php";
19 require_once "sanity_check.php";
20 require_once "config.php";
21 require_once "db.php";
22 require_once "db-prefs.php";
23
24 // defaults
25 define('PURGE_INTERVAL', 3600); // seconds
26 define('MAX_CHILD_RUNTIME', 600); // seconds
27 define('MAX_JOBS', 2);
28 define('SPAWN_INTERVAL', DAEMON_SLEEP_INTERVAL); // seconds
29
30 if (!function_exists('pcntl_fork')) {
31 die("error: This script requires PHP compiled with PCNTL module.\n");
32 }
33
34 $master_handlers_installed = false;
35
36 $children = array();
37 $ctimes = array();
38
39 $last_checkpoint = -1;
40
41 function reap_children() {
42 global $children;
43 global $ctimes;
44
45 $tmp = array();
46
47 foreach ($children as $pid) {
48 if (pcntl_waitpid($pid, $status, WNOHANG) != $pid) {
49
50 if (file_is_locked("update_daemon-$pid.lock")) {
51 array_push($tmp, $pid);
52 } else {
53 _debug("[reap_children] child $pid seems active but lockfile is unlocked.");
54 unset($ctimes[$pid]);
55
56 }
57 } else {
58 _debug("[reap_children] child $pid reaped.");
59 unset($ctimes[$pid]);
60 }
61 }
62
63 $children = $tmp;
64
65 return count($tmp);
66 }
67
68 function check_ctimes() {
69 global $ctimes;
70
71 foreach (array_keys($ctimes) as $pid) {
72 $started = $ctimes[$pid];
73
74 if (time() - $started > MAX_CHILD_RUNTIME) {
75 _debug("[MASTER] child process $pid seems to be stuck, aborting...");
76 posix_kill($pid, SIGKILL);
77 }
78 }
79 }
80
81 function sigchld_handler($signal) {
82 $running_jobs = reap_children();
83
84 _debug("[SIGCHLD] jobs left: $running_jobs");
85
86 pcntl_waitpid(-1, $status, WNOHANG);
87 }
88
89 function shutdown($caller_pid) {
90 if ($caller_pid == posix_getpid()) {
91 if (file_exists(LOCK_DIRECTORY . "/update_daemon.lock")) {
92 _debug("removing lockfile (master)...");
93 unlink(LOCK_DIRECTORY . "/update_daemon.lock");
94 }
95 }
96 }
97
98 function task_shutdown() {
99 $pid = posix_getpid();
100
101 if (file_exists(LOCK_DIRECTORY . "/update_daemon-$pid.lock")) {
102 _debug("removing lockfile ($pid)...");
103 unlink(LOCK_DIRECTORY . "/update_daemon-$pid.lock");
104 }
105 }
106
107 function sigint_handler() {
108 _debug("[MASTER] SIG_INT received.\n");
109 shutdown(posix_getpid());
110 die;
111 }
112
113 function task_sigint_handler() {
114 _debug("[TASK] SIG_INT received.\n");
115 task_shutdown();
116 die;
117 }
118
119 pcntl_signal(SIGCHLD, 'sigchld_handler');
120
121 $longopts = array("log:",
122 "tasks:",
123 "interval",
124 "help");
125
126 $options = getopt("", $longopts);
127
128 if (isset($options["help"]) ) {
129 print "Tiny Tiny RSS update daemon.\n\n";
130 print "Options:\n";
131 print " --log FILE - log messages to FILE\n";
132 print " --tasks N - amount of update tasks to spawn\n";
133 print " default: " . MAX_JOBS . "\n";
134 print " --interval N - task spawn interval\n";
135 print " default: " . SPAWN_INTERVAL . " seconds.\n";
136 print " --quiet - don't output messages to stdout\n";
137 return;
138 }
139
140 define('QUIET', isset($options['quiet']));
141
142 if (isset($options["tasks"])) {
143 _debug("Set to spawn " . $options["tasks"] . " children.");
144 $max_jobs = $option["tasks"];
145 } else {
146 $max_jobs = MAX_JOBS;
147 }
148
149 if (isset($options["interval"])) {
150 _debug("Spawn interval: " . $options["interval"] . " seconds.");
151 $spawn_interval = $option["interval"];
152 } else {
153 $spawn_interval = SPAWN_INTERVAL;
154 }
155
156 if (isset($options["log"])) {
157 _debug("Logging to " . $options["log"]);
158 define('LOGFILE', $options["log"]);
159 }
160
161 if (file_is_locked("update_daemon.lock")) {
162 die("error: Can't create lockfile. ".
163 "Maybe another daemon is already running.\n");
164 }
165
166 // Try to lock a file in order to avoid concurrent update.
167 $lock_handle = make_lockfile("update_daemon.lock");
168
169 if (!$lock_handle) {
170 die("error: Can't create lockfile. ".
171 "Maybe another daemon is already running.\n");
172 }
173
174 // Testing database connection.
175 // It is unnecessary to start the fork loop if database is not ok.
176 $link = db_connect(DB_HOST, DB_USER, DB_PASS, DB_NAME);
177
178 if (!init_connection($link)) return;
179
180 db_close($link);
181
182 while (true) {
183
184 // Since sleep is interupted by SIGCHLD, we need another way to
185 // respect the spawn interval
186 $next_spawn = $last_checkpoint + $spawn_interval - time();
187
188 if ($next_spawn % 10 == 0) {
189 $running_jobs = count($children);
190 _debug("[MASTER] active jobs: $running_jobs, next spawn at $next_spawn sec.");
191 }
192
193 if ($last_checkpoint + $spawn_interval < time()) {
194
195 check_ctimes();
196 reap_children();
197
198 for ($j = count($children); $j < $max_jobs; $j++) {
199 $pid = pcntl_fork();
200 if ($pid == -1) {
201 die("fork failed!\n");
202 } else if ($pid) {
203
204 if (!$master_handlers_installed) {
205 _debug("[MASTER] installing shutdown handlers");
206 pcntl_signal(SIGINT, 'sigint_handler');
207 register_shutdown_function('shutdown', posix_getpid());
208 $master_handlers_installed = true;
209 }
210
211 _debug("[MASTER] spawned client $j [PID:$pid]...");
212 array_push($children, $pid);
213 $ctimes[$pid] = time();
214 } else {
215 pcntl_signal(SIGCHLD, SIG_IGN);
216 pcntl_signal(SIGINT, 'task_sigint_handler');
217
218 register_shutdown_function('task_shutdown');
219
220 $my_pid = posix_getpid();
221 $lock_filename = "update_daemon-$my_pid.lock";
222
223 $lock_handle = make_lockfile($lock_filename);
224
225 if (!$lock_handle) {
226 die("error: Can't create lockfile ($lock_filename). ".
227 "Maybe another daemon is already running.\n");
228 }
229
230 // ****** Updating RSS code *******
231 // Only run in fork process.
232
233 $start_timestamp = time();
234
235 $link = db_connect(DB_HOST, DB_USER, DB_PASS, DB_NAME);
236
237 if (!init_connection($link)) return;
238
239 // We disable stamp file, since it is of no use in a multiprocess update.
240 // not really, tho for the time being -fox
241 if (!make_stampfile('update_daemon.stamp')) {
242 die("error: unable to create stampfile\n");
243 }
244
245 // Call to the feed batch update function
246 // or regenerate feedbrowser cache
247
248 if (rand(0,100) > 30) {
249 update_daemon_common($link);
250 } else {
251 $count = update_feedbrowser_cache($link);
252 _debug("Feedbrowser updated, $count feeds processed.");
253
254 purge_orphans($link, true);
255
256 $rc = cleanup_tags($link, 14, 50000);
257
258 _debug("Cleaned $rc cached tags.");
259
260 global $pluginhost;
261 $pluginhost->run_hooks($pluginhost::HOOK_UPDATE_TASK, "hook_update_task", $op);
262 }
263
264 _debug("Elapsed time: " . (time() - $start_timestamp) . " second(s)");
265
266 db_close($link);
267
268 // We are in a fork.
269 // We wait a little before exiting to avoid to be faster than our parent process.
270 sleep(1);
271
272 unlink(LOCK_DIRECTORY . "/$lock_filename");
273
274 // We exit in order to avoid fork bombing.
275 exit(0);
276 }
277
278 // We wait a little time before the next fork, in order to let the first fork
279 // mark the feeds it update :
280 sleep(1);
281 }
282 $last_checkpoint = time();
283 }
284 sleep(1);
285 }
286
287 ?>