update.php

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