]> git.wh0rd.org - tt-rss.git/blame - update.php
move example plugins to -contrib
[tt-rss.git] / update.php
CommitLineData
ece78711 1#!/usr/bin/env php
fecd57c8 2<?php
88e8fb3a
AD
3 set_include_path(dirname(__FILE__) ."/include" . PATH_SEPARATOR .
4 get_include_path());
107d0cf3 5
661135c7
AD
6 define('DISABLE_SESSIONS', true);
7
9b27cec8
AD
8 chdir(dirname(__FILE__));
9
404e2e36 10 require_once "autoload.php";
fb074239 11 require_once "functions.php";
2c08214a 12 require_once "rssfuncs.php";
81596c66 13 require_once "config.php";
f02713bb 14 require_once "sanity_check.php";
81596c66 15 require_once "db.php";
661135c7 16 require_once "db-prefs.php";
661135c7 17
3de78afd
AD
18 if (!defined('PHP_EXECUTABLE'))
19 define('PHP_EXECUTABLE', '/usr/bin/php');
20
6322ac79 21 init_plugins();
73f28fe9 22
764555ff
AD
23 $longopts = array("feeds",
24 "feedbrowser",
25 "daemon",
26 "daemon-loop",
27 "task:",
28 "cleanup-tags",
29 "quiet",
2191eb7a 30 "log:",
764555ff 31 "indexes",
7440a7fe 32 "pidlock:",
b4c47f7e 33 "update-schema",
764555ff
AD
34 "convert-filters",
35 "force-update",
36 "list-plugins",
37 "help");
38
1ffe3391 39 foreach (PluginHost::getInstance()->get_commands() as $command => $data) {
4cf0f9a9 40 array_push($longopts, $command . $data["suffix"]);
764555ff
AD
41 }
42
43 $options = getopt("", $longopts);
3de78afd 44
764555ff 45 if (count($options) == 0 && !defined('STDIN')) {
366f06f7
AD
46 ?> <html>
47 <head>
3de78afd 48 <title>Tiny Tiny RSS data update script.</title>
366f06f7
AD
49 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
50 <link rel="stylesheet" type="text/css" href="utility.css">
51 </head>
52
53 <body>
884d1650 54 <div class="floatingLogo"><img src="images/logo_small.png"></div>
3de78afd 55 <h1><?php echo __("Tiny Tiny RSS data update script.") ?></h1>
366f06f7 56
3de78afd 57 <?php print_error("Please run this script from the command line. Use option \"-help\" to display command help if this error is displayed erroneously."); ?>
366f06f7
AD
58
59 </body></html>
60 <?php
61 exit;
62 }
63
764555ff 64 if (count($options) == 0 || isset($options["help"]) ) {
661135c7
AD
65 print "Tiny Tiny RSS data update script.\n\n";
66 print "Options:\n";
764555ff
AD
67 print " --feeds - update feeds\n";
68 print " --feedbrowser - update feedbrowser\n";
69 print " --daemon - start single-process update daemon\n";
70 print " --task N - create lockfile using this task id\n";
71 print " --cleanup-tags - perform tags table maintenance\n";
dc24b520 72 print " --quiet - don't output messages to stdout\n";
2191eb7a 73 print " --log FILE - log messages to FILE\n";
764555ff 74 print " --indexes - recreate missing schema indexes\n";
b4c47f7e 75 print " --update-schema - update database schema\n";
764555ff
AD
76 print " --convert-filters - convert type1 filters to type2\n";
77 print " --force-update - force update of all feeds\n";
78 print " --list-plugins - list all available plugins\n";
79 print " --help - show this help\n";
73f28fe9
AD
80 print "Plugin options:\n";
81
1ffe3391 82 foreach (PluginHost::getInstance()->get_commands() as $command => $data) {
4cf0f9a9
AD
83 $args = $data['arghelp'];
84 printf(" --%-19s - %s\n", "$command $args", $data["description"]);
73f28fe9
AD
85 }
86
661135c7 87 return;
81596c66 88 }
87b9fb65 89
0186be6a
AD
90 if (!isset($options['daemon'])) {
91 require_once "errorhandler.php";
92 }
93
857efe49 94 if (!isset($options['update-schema'])) {
6322ac79 95 $schema_version = get_schema_version();
857efe49
AD
96
97 if ($schema_version != SCHEMA_VERSION) {
98 die("Schema version is wrong, please upgrade the database.\n");
99 }
100 }
101
dc24b520
AD
102 define('QUIET', isset($options['quiet']));
103
2191eb7a
AD
104 if (isset($options["log"])) {
105 _debug("Logging to " . $options["log"]);
106 define('LOGFILE', $options["log"]);
107 }
108
764555ff 109 if (!isset($options["daemon"])) {
661135c7
AD
110 $lock_filename = "update.lock";
111 } else {
112 $lock_filename = "update_daemon.lock";
113 }
fecd57c8 114
764555ff
AD
115 if (isset($options["task"])) {
116 _debug("Using task id " . $options["task"]);
117 $lock_filename = $lock_filename . "-task_" . $options["task"];
118 }
119
7440a7fe
AD
120 if (isset($options["pidlock"])) {
121 $my_pid = $options["pidlock"];
122 $lock_filename = "update_daemon-$my_pid.lock";
123
124 }
125
126 _debug("Lock: $lock_filename");
127
661135c7
AD
128 $lock_handle = make_lockfile($lock_filename);
129 $must_exit = false;
fecd57c8 130
8a386529 131 if (isset($options["task"]) && isset($options["pidlock"])) {
7440a7fe
AD
132 $waits = $options["task"] * 5;
133 _debug("Waiting before update ($waits)");
134 sleep($waits);
135 }
136
661135c7
AD
137 // Try to lock a file in order to avoid concurrent update.
138 if (!$lock_handle) {
139 die("error: Can't create lockfile ($lock_filename). ".
140 "Maybe another update process is already running.\n");
141 }
fecd57c8 142
764555ff
AD
143 if (isset($options["force-update"])) {
144 _debug("marking all feeds as needing update...");
145
6322ac79 146 db_query( "UPDATE ttrss_feeds SET last_update_started = '1970-01-01',
764555ff
AD
147 last_updated = '1970-01-01'");
148 }
149
150 if (isset($options["feeds"])) {
6322ac79 151 update_daemon_common();
e2cf81e2 152 housekeeping_common(true);
f32eb194 153
1ffe3391 154 PluginHost::getInstance()->run_hooks(PluginHost::HOOK_UPDATE_TASK, "hook_update_task", $op);
661135c7 155 }
fecd57c8 156
764555ff 157 if (isset($options["feedbrowser"])) {
6322ac79 158 $count = update_feedbrowser_cache();
661135c7 159 print "Finished, $count feeds processed.\n";
fecd57c8 160 }
661135c7 161
764555ff 162 if (isset($options["daemon"])) {
661135c7 163 while (true) {
0ae9f746
AD
164 $quiet = (isset($options["quiet"])) ? "--quiet" : "";
165
166 passthru(PHP_EXECUTABLE . " " . $argv[0] ." --daemon-loop $quiet");
661135c7
AD
167 _debug("Sleeping for " . DAEMON_SLEEP_INTERVAL . " seconds...");
168 sleep(DAEMON_SLEEP_INTERVAL);
fecd57c8 169 }
81596c66 170 }
9e21a571 171
764555ff 172 if (isset($options["daemon-loop"])) {
661135c7 173 if (!make_stampfile('update_daemon.stamp')) {
e81610d9 174 _debug("warning: unable to create stampfile\n");
661135c7 175 }
9e21a571 176
8cabc200 177 update_daemon_common(isset($options["pidlock"]) ? 50 : DAEMON_FEED_LIMIT);
e2cf81e2 178 housekeeping_common(true);
dbaa4e4a 179
fce451a4 180 PluginHost::getInstance()->run_hooks(PluginHost::HOOK_UPDATE_TASK, "hook_update_task", $op);
fecd57c8 181 }
fecd57c8 182
764555ff 183 if (isset($options["cleanup-tags"])) {
6322ac79 184 $rc = cleanup_tags( 14, 50000);
5439d333 185 _debug("$rc tags deleted.\n");
868650e4
AD
186 }
187
764555ff 188 if (isset($options["indexes"])) {
871f0a7a
AD
189 _debug("PLEASE BACKUP YOUR DATABASE BEFORE PROCEEDING!");
190 _debug("Type 'yes' to continue.");
191
192 if (read_stdin() != 'yes')
193 exit;
194
195 _debug("clearing existing indexes...");
196
197 if (DB_TYPE == "pgsql") {
6322ac79 198 $result = db_query( "SELECT relname FROM
871f0a7a
AD
199 pg_catalog.pg_class WHERE relname LIKE 'ttrss_%'
200 AND relname NOT LIKE '%_pkey'
201 AND relkind = 'i'");
202 } else {
6322ac79 203 $result = db_query( "SELECT index_name,table_name FROM
871f0a7a
AD
204 information_schema.statistics WHERE index_name LIKE 'ttrss_%'");
205 }
206
207 while ($line = db_fetch_assoc($result)) {
208 if (DB_TYPE == "pgsql") {
209 $statement = "DROP INDEX " . $line["relname"];
210 _debug($statement);
211 } else {
212 $statement = "ALTER TABLE ".
213 $line['table_name']." DROP INDEX ".$line['index_name'];
214 _debug($statement);
215 }
6322ac79 216 db_query( $statement, false);
871f0a7a
AD
217 }
218
219 _debug("reading indexes from schema for: " . DB_TYPE);
220
221 $fp = fopen("schema/ttrss_schema_" . DB_TYPE . ".sql", "r");
222 if ($fp) {
223 while ($line = fgets($fp)) {
224 $matches = array();
225
226 if (preg_match("/^create index ([^ ]+) on ([^ ]+)$/i", $line, $matches)) {
227 $index = $matches[1];
228 $table = $matches[2];
229
230 $statement = "CREATE INDEX $index ON $table";
231
232 _debug($statement);
6322ac79 233 db_query( $statement);
871f0a7a
AD
234 }
235 }
236 fclose($fp);
237 } else {
238 _debug("unable to open schema file.");
239 }
240 _debug("all done.");
241 }
242
764555ff 243 if (isset($options["convert-filters"])) {
6aff7845
AD
244 _debug("WARNING: this will remove all existing type2 filters.");
245 _debug("Type 'yes' to continue.");
246
247 if (read_stdin() != 'yes')
248 exit;
249
250 _debug("converting filters...");
251
6322ac79 252 db_query( "DELETE FROM ttrss_filters2");
6aff7845 253
6322ac79 254 $result = db_query( "SELECT * FROM ttrss_filters ORDER BY id");
6aff7845
AD
255
256 while ($line = db_fetch_assoc($result)) {
257 $owner_uid = $line["owner_uid"];
258
37f78940
AD
259 // date filters are removed
260 if ($line["filter_type"] != 5) {
261 $filter = array();
262
263 if (sql_bool_to_bool($line["cat_filter"])) {
264 $feed_id = "CAT:" . (int)$line["cat_id"];
265 } else {
266 $feed_id = (int)$line["feed_id"];
267 }
6aff7845 268
37f78940
AD
269 $filter["enabled"] = $line["enabled"] ? "on" : "off";
270 $filter["rule"] = array(
271 json_encode(array(
272 "reg_exp" => $line["reg_exp"],
273 "feed_id" => $feed_id,
274 "filter_type" => $line["filter_type"])));
6aff7845 275
37f78940
AD
276 $filter["action"] = array(
277 json_encode(array(
278 "action_id" => $line["action_id"],
279 "action_param_label" => $line["action_param"],
280 "action_param" => $line["action_param"])));
6aff7845 281
37f78940 282 // Oh god it's full of hacks
5451903c 283
37f78940
AD
284 $_REQUEST = $filter;
285 $_SESSION["uid"] = $owner_uid;
6aff7845 286
1f294435 287 $filters = new Pref_Filters($_REQUEST);
37f78940
AD
288 $filters->add();
289 }
6aff7845
AD
290 }
291
292 }
293
b4c47f7e
AD
294 if (isset($options["update-schema"])) {
295 _debug("checking for updates (" . DB_TYPE . ")...");
296
0630a100 297 $updater = new DbUpdater(Db::get(), DB_TYPE, SCHEMA_VERSION);
b4c47f7e
AD
298
299 if ($updater->isUpdateRequired()) {
300 _debug("schema update required, version " . $updater->getSchemaVersion() . " to " . SCHEMA_VERSION);
301 _debug("WARNING: please backup your database before continuing.");
302 _debug("Type 'yes' to continue.");
303
304 if (read_stdin() != 'yes')
305 exit;
306
307 for ($i = $updater->getSchemaVersion() + 1; $i <= SCHEMA_VERSION; $i++) {
308 _debug("performing update up to version $i...");
309
310 $result = $updater->performUpdateTo($i);
311
312 _debug($result ? "OK!" : "FAILED!");
313
314 if (!$result) return;
315
316 }
317 } else {
318 _debug("update not required.");
319 }
320
321 }
322
764555ff 323 if (isset($options["list-plugins"])) {
72ff0137 324 $tmppluginhost = new PluginHost(Db::get());
d2a421e3 325 $tmppluginhost->load_all($tmppluginhost::KIND_ALL);
20b86c79
AD
326 $enabled = array_map("trim", explode(",", PLUGINS));
327
328 echo "List of all available plugins:\n";
329
7a866114 330 foreach ($tmppluginhost->get_plugins() as $name => $plugin) {
d2a421e3 331 $about = $plugin->about();
7a866114 332
20b86c79
AD
333 $status = $about[3] ? "system" : "user";
334
335 if (in_array($name, $enabled)) $name .= "*";
336
337 printf("%-50s %-10s v%.2f (by %s)\n%s\n\n",
338 $name, $status, $about[0], $about[2], $about[1]);
7a866114 339 }
20b86c79
AD
340
341 echo "Plugins marked by * are currently enabled for all users.\n";
342
7a866114
AD
343 }
344
1ffe3391 345 PluginHost::getInstance()->run_commands($options);
73f28fe9 346