update.php 12 KB

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