update.php 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437
  1. #!/usr/bin/env php
  2. <?php
  3. set_include_path(dirname(__FILE__) ."/include" . PATH_SEPARATOR .
  4. get_include_path());
  5. define('DISABLE_SESSIONS', true);
  6. chdir(dirname(__FILE__));
  7. require_once "autoload.php";
  8. require_once "functions.php";
  9. require_once "config.php";
  10. require_once "sanity_check.php";
  11. require_once "db.php";
  12. require_once "db-prefs.php";
  13. if (!defined('PHP_EXECUTABLE'))
  14. define('PHP_EXECUTABLE', '/usr/bin/php');
  15. $pdo = Db::pdo();
  16. init_plugins();
  17. $longopts = array("feeds",
  18. "feedbrowser",
  19. "daemon",
  20. "daemon-loop",
  21. "task:",
  22. "cleanup-tags",
  23. "quiet",
  24. "log:",
  25. "log-level:",
  26. "indexes",
  27. "pidlock:",
  28. "update-schema",
  29. "convert-filters",
  30. "force-update",
  31. "gen-search-idx",
  32. "list-plugins",
  33. "debug-feed:",
  34. "force-refetch",
  35. "force-rehash",
  36. "help");
  37. foreach (PluginHost::getInstance()->get_commands() as $command => $data) {
  38. array_push($longopts, $command . $data["suffix"]);
  39. }
  40. $options = getopt("", $longopts);
  41. if (!is_array($options)) {
  42. die("error: getopt() failed. ".
  43. "Most probably you are using PHP CGI to run this script ".
  44. "instead of required PHP CLI. Check tt-rss wiki page on updating feeds for ".
  45. "additional information.\n");
  46. }
  47. if (count($options) == 0 && !defined('STDIN')) {
  48. ?>
  49. <!DOCTYPE html>
  50. <html>
  51. <head>
  52. <title>Tiny Tiny RSS data update script.</title>
  53. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  54. </head>
  55. <body>
  56. <h1><?php echo __("Tiny Tiny RSS data update script.") ?></h1>
  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."); ?>
  58. </body></html>
  59. <?php
  60. exit;
  61. }
  62. if (count($options) == 0 || isset($options["help"]) ) {
  63. print "Tiny Tiny RSS data update script.\n\n";
  64. print "Options:\n";
  65. print " --feeds - update feeds\n";
  66. print " --feedbrowser - update feedbrowser\n";
  67. print " --daemon - start single-process update daemon\n";
  68. print " --task N - create lockfile using this task id\n";
  69. print " --cleanup-tags - perform tags table maintenance\n";
  70. print " --quiet - don't output messages to stdout\n";
  71. print " --log FILE - log messages to FILE\n";
  72. print " --log-level N - log verbosity level\n";
  73. print " --indexes - recreate missing schema indexes\n";
  74. print " --update-schema - update database schema\n";
  75. print " --gen-search-idx - generate basic PostgreSQL fulltext search index\n";
  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 " --debug-feed N - perform debug update of feed N\n";
  80. print " --force-refetch - debug update: force refetch feed data\n";
  81. print " --force-rehash - debug update: force rehash articles\n";
  82. print " --help - show this help\n";
  83. print "Plugin options:\n";
  84. foreach (PluginHost::getInstance()->get_commands() as $command => $data) {
  85. $args = $data['arghelp'];
  86. printf(" --%-19s - %s\n", "$command $args", $data["description"]);
  87. }
  88. return;
  89. }
  90. if (!isset($options['daemon'])) {
  91. require_once "errorhandler.php";
  92. }
  93. if (!isset($options['update-schema'])) {
  94. $schema_version = get_schema_version();
  95. if ($schema_version != SCHEMA_VERSION) {
  96. die("Schema version is wrong, please upgrade the database.\n");
  97. }
  98. }
  99. Debug::set_enabled(true);
  100. if (isset($options["log-level"])) {
  101. Debug::set_loglevel((int)$options["log-level"]);
  102. }
  103. if (isset($options["log"])) {
  104. Debug::set_quiet(isset($options['quiet']));
  105. Debug::set_logfile($options["log"]);
  106. Debug::log("Logging to " . $options["log"]);
  107. } else {
  108. if (isset($options['quiet'])) {
  109. Debug::set_loglevel(Debug::$LOG_DISABLED);
  110. }
  111. }
  112. if (!isset($options["daemon"])) {
  113. $lock_filename = "update.lock";
  114. } else {
  115. $lock_filename = "update_daemon.lock";
  116. }
  117. if (isset($options["task"])) {
  118. Debug::log("Using task id " . $options["task"]);
  119. $lock_filename = $lock_filename . "-task_" . $options["task"];
  120. }
  121. if (isset($options["pidlock"])) {
  122. $my_pid = $options["pidlock"];
  123. $lock_filename = "update_daemon-$my_pid.lock";
  124. }
  125. Debug::log("Lock: $lock_filename");
  126. $lock_handle = make_lockfile($lock_filename);
  127. $must_exit = false;
  128. if (isset($options["task"]) && isset($options["pidlock"])) {
  129. $waits = $options["task"] * 5;
  130. Debug::log("Waiting before update ($waits)");
  131. sleep($waits);
  132. }
  133. // Try to lock a file in order to avoid concurrent update.
  134. if (!$lock_handle) {
  135. die("error: Can't create lockfile ($lock_filename). ".
  136. "Maybe another update process is already running.\n");
  137. }
  138. if (isset($options["force-update"])) {
  139. Debug::log("marking all feeds as needing update...");
  140. $pdo->query( "UPDATE ttrss_feeds SET
  141. last_update_started = '1970-01-01', last_updated = '1970-01-01'");
  142. }
  143. if (isset($options["feeds"])) {
  144. RSSUtils::update_daemon_common();
  145. RSSUtils::housekeeping_common(true);
  146. PluginHost::getInstance()->run_hooks(PluginHost::HOOK_UPDATE_TASK, "hook_update_task", $op);
  147. }
  148. if (isset($options["feedbrowser"])) {
  149. $count = RSSUtils::update_feedbrowser_cache();
  150. print "Finished, $count feeds processed.\n";
  151. }
  152. if (isset($options["daemon"])) {
  153. while (true) {
  154. $quiet = (isset($options["quiet"])) ? "--quiet" : "";
  155. $log = isset($options['log']) ? '--log '.$options['log'] : '';
  156. $log_level = isset($options['log-level']) ? '--log-level '.$options['log-level'] : '';
  157. passthru(PHP_EXECUTABLE . " " . $argv[0] ." --daemon-loop $quiet $log $log_level");
  158. // let's enforce a minimum spawn interval as to not forkbomb the host
  159. $spawn_interval = max(60, DAEMON_SLEEP_INTERVAL);
  160. Debug::log("Sleeping for $spawn_interval seconds...");
  161. sleep($spawn_interval);
  162. }
  163. }
  164. if (isset($options["daemon-loop"])) {
  165. if (!make_stampfile('update_daemon.stamp')) {
  166. Debug::log("warning: unable to create stampfile\n");
  167. }
  168. RSSUtils::update_daemon_common(isset($options["pidlock"]) ? 50 : DAEMON_FEED_LIMIT);
  169. if (!isset($options["pidlock"]) || $options["task"] == 0)
  170. RSSUtils::housekeeping_common(true);
  171. PluginHost::getInstance()->run_hooks(PluginHost::HOOK_UPDATE_TASK, "hook_update_task", $op);
  172. }
  173. if (isset($options["cleanup-tags"])) {
  174. $rc = cleanup_tags( 14, 50000);
  175. Debug::log("$rc tags deleted.\n");
  176. }
  177. if (isset($options["indexes"])) {
  178. Debug::log("PLEASE BACKUP YOUR DATABASE BEFORE PROCEEDING!");
  179. Debug::log("Type 'yes' to continue.");
  180. if (read_stdin() != 'yes')
  181. exit;
  182. Debug::log("clearing existing indexes...");
  183. if (DB_TYPE == "pgsql") {
  184. $sth = $pdo->query( "SELECT relname FROM
  185. pg_catalog.pg_class WHERE relname LIKE 'ttrss_%'
  186. AND relname NOT LIKE '%_pkey'
  187. AND relkind = 'i'");
  188. } else {
  189. $sth = $pdo->query( "SELECT index_name,table_name FROM
  190. information_schema.statistics WHERE index_name LIKE 'ttrss_%'");
  191. }
  192. while ($line = $sth->fetch()) {
  193. if (DB_TYPE == "pgsql") {
  194. $statement = "DROP INDEX " . $line["relname"];
  195. Debug::log($statement);
  196. } else {
  197. $statement = "ALTER TABLE ".
  198. $line['table_name']." DROP INDEX ".$line['index_name'];
  199. Debug::log($statement);
  200. }
  201. $pdo->query($statement);
  202. }
  203. Debug::log("reading indexes from schema for: " . DB_TYPE);
  204. $fp = fopen("schema/ttrss_schema_" . DB_TYPE . ".sql", "r");
  205. if ($fp) {
  206. while ($line = fgets($fp)) {
  207. $matches = array();
  208. if (preg_match("/^create index ([^ ]+) on ([^ ]+)$/i", $line, $matches)) {
  209. $index = $matches[1];
  210. $table = $matches[2];
  211. $statement = "CREATE INDEX $index ON $table";
  212. Debug::log($statement);
  213. $pdo->query($statement);
  214. }
  215. }
  216. fclose($fp);
  217. } else {
  218. Debug::log("unable to open schema file.");
  219. }
  220. Debug::log("all done.");
  221. }
  222. if (isset($options["convert-filters"])) {
  223. Debug::log("WARNING: this will remove all existing type2 filters.");
  224. Debug::log("Type 'yes' to continue.");
  225. if (read_stdin() != 'yes')
  226. exit;
  227. Debug::log("converting filters...");
  228. $pdo->query("DELETE FROM ttrss_filters2");
  229. $res = $pdo->query("SELECT * FROM ttrss_filters ORDER BY id");
  230. while ($line = $res->fetch()) {
  231. $owner_uid = $line["owner_uid"];
  232. // date filters are removed
  233. if ($line["filter_type"] != 5) {
  234. $filter = array();
  235. if (sql_bool_to_bool($line["cat_filter"])) {
  236. $feed_id = "CAT:" . (int)$line["cat_id"];
  237. } else {
  238. $feed_id = (int)$line["feed_id"];
  239. }
  240. $filter["enabled"] = $line["enabled"] ? "on" : "off";
  241. $filter["rule"] = array(
  242. json_encode(array(
  243. "reg_exp" => $line["reg_exp"],
  244. "feed_id" => $feed_id,
  245. "filter_type" => $line["filter_type"])));
  246. $filter["action"] = array(
  247. json_encode(array(
  248. "action_id" => $line["action_id"],
  249. "action_param_label" => $line["action_param"],
  250. "action_param" => $line["action_param"])));
  251. // Oh god it's full of hacks
  252. $_REQUEST = $filter;
  253. $_SESSION["uid"] = $owner_uid;
  254. $filters = new Pref_Filters($_REQUEST);
  255. $filters->add();
  256. }
  257. }
  258. }
  259. if (isset($options["update-schema"])) {
  260. Debug::log("checking for updates (" . DB_TYPE . ")...");
  261. $updater = new DbUpdater(Db::pdo(), DB_TYPE, SCHEMA_VERSION);
  262. if ($updater->isUpdateRequired()) {
  263. Debug::log("schema update required, version " . $updater->getSchemaVersion() . " to " . SCHEMA_VERSION);
  264. Debug::log("WARNING: please backup your database before continuing.");
  265. Debug::log("Type 'yes' to continue.");
  266. if (read_stdin() != 'yes')
  267. exit;
  268. for ($i = $updater->getSchemaVersion() + 1; $i <= SCHEMA_VERSION; $i++) {
  269. Debug::log("performing update up to version $i...");
  270. $result = $updater->performUpdateTo($i, false);
  271. Debug::log($result ? "OK!" : "FAILED!");
  272. if (!$result) return;
  273. }
  274. } else {
  275. Debug::log("update not required.");
  276. }
  277. }
  278. if (isset($options["gen-search-idx"])) {
  279. echo "Generating search index (stemming set to English)...\n";
  280. $res = $pdo->query("SELECT COUNT(id) AS count FROM ttrss_entries WHERE tsvector_combined IS NULL");
  281. $row = $res->fetch();
  282. $count = $row['count'];
  283. print "Articles to process: $count.\n";
  284. $limit = 500;
  285. $processed = 0;
  286. $sth = $pdo->prepare("SELECT id, title, content FROM ttrss_entries WHERE
  287. tsvector_combined IS NULL ORDER BY id LIMIT ?");
  288. $sth->execute([$limit]);
  289. $usth = $pdo->prepare("UPDATE ttrss_entries
  290. SET tsvector_combined = to_tsvector('english', ?) WHERE id = ?");
  291. while (true) {
  292. while ($line = $sth->fetch()) {
  293. $tsvector_combined = mb_substr(strip_tags($line["title"] . " " . $line["content"]), 0, 1000000);
  294. $usth->execute([$tsvector_combined, $line['id']]);
  295. $processed++;
  296. }
  297. print "Processed $processed articles...\n";
  298. if ($processed < $limit) {
  299. echo "All done.\n";
  300. break;
  301. }
  302. }
  303. }
  304. if (isset($options["list-plugins"])) {
  305. $tmppluginhost = new PluginHost();
  306. $tmppluginhost->load_all($tmppluginhost::KIND_ALL, false);
  307. $enabled = array_map("trim", explode(",", PLUGINS));
  308. echo "List of all available plugins:\n";
  309. foreach ($tmppluginhost->get_plugins() as $name => $plugin) {
  310. $about = $plugin->about();
  311. $status = $about[3] ? "system" : "user";
  312. if (in_array($name, $enabled)) $name .= "*";
  313. printf("%-50s %-10s v%.2f (by %s)\n%s\n\n",
  314. $name, $status, $about[0], $about[2], $about[1]);
  315. }
  316. echo "Plugins marked by * are currently enabled for all users.\n";
  317. }
  318. if (isset($options["debug-feed"])) {
  319. $feed = $options["debug-feed"];
  320. if (isset($options["force-refetch"])) $_REQUEST["force_refetch"] = true;
  321. if (isset($options["force-rehash"])) $_REQUEST["force_rehash"] = true;
  322. Debug::set_loglevel(Debug::$LOG_EXTENDED);
  323. $rc = RSSUtils::update_rss_feed($feed) != false ? 0 : 1;
  324. exit($rc);
  325. }
  326. PluginHost::getInstance()->run_commands($options);
  327. if (file_exists(LOCK_DIRECTORY . "/$lock_filename"))
  328. if (strtoupper(substr(PHP_OS, 0, 3)) == 'WIN')
  329. fclose($lock_handle);
  330. unlink(LOCK_DIRECTORY . "/$lock_filename");
  331. ?>