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                         "list-plugins",
  37                         "help");
  38
  39         foreach (PluginHost::getInstance()->get_commands() as $command => $data) {
  40                 array_push($longopts, $command . $data["suffix"]);
  41         }
  42
  43         $options = getopt("", $longopts);
  44
  45         if (count($options) == 0 && !defined('STDIN')) {
  46                 ?> <html>
  47                 <head>
  48                 <title>Tiny Tiny RSS data update script.</title>
  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>
  54                 <div class="floatingLogo"><img src="images/logo_small.png"></div>
  55                 <h1><?php echo __("Tiny Tiny RSS data update script.") ?></h1>
  56
  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
  59                 </body></html>
  60         <?php
  61                 exit;
  62         }
  63
  64         if (count($options) == 0 || isset($options["help"]) ) {
  65                 print "Tiny Tiny RSS data update script.\n\n";
  66                 print "Options:\n";
  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";
  72                 print "  --quiet              - don't output messages to stdout\n";
  73                 print "  --log FILE           - log messages to FILE\n";
  74                 print "  --indexes            - recreate missing schema indexes\n";
  75                 print "  --update-schema      - update database schema\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 "  --help               - show this help\n";
  80                 print "Plugin options:\n";
  81
  82                 foreach (PluginHost::getInstance()->get_commands() as $command => $data) {
  83                         $args = $data['arghelp'];
  84                         printf(" --%-19s - %s\n", "$command $args", $data["description"]);
  85                 }
  86
  87                 return;
  88         }
  89
  90         if (!isset($options['daemon'])) {
  91                 require_once "errorhandler.php";
  92         }
  93
  94         if (!isset($options['update-schema'])) {
  95                 $schema_version = get_schema_version();
  96
  97                 if ($schema_version != SCHEMA_VERSION) {
  98                         die("Schema version is wrong, please upgrade the database.\n");
  99                 }
 100         }
 101
 102         define('QUIET', isset($options['quiet']));
 103
 104         if (isset($options["log"])) {
 105                 _debug("Logging to " . $options["log"]);
 106                 define('LOGFILE', $options["log"]);
 107         }
 108
 109         if (!isset($options["daemon"])) {
 110                 $lock_filename = "update.lock";
 111         } else {
 112                 $lock_filename = "update_daemon.lock";
 113         }
 114
 115         if (isset($options["task"])) {
 116                 _debug("Using task id " . $options["task"]);
 117                 $lock_filename = $lock_filename . "-task_" . $options["task"];
 118         }
 119
 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
 128         $lock_handle = make_lockfile($lock_filename);
 129         $must_exit = false;
 130
 131         if (isset($options["task"]) && isset($options["pidlock"])) {
 132                 $waits = $options["task"] * 5;
 133                 _debug("Waiting before update ($waits)");
 134                 sleep($waits);
 135         }
 136
 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         }
 142
 143         if (isset($options["force-update"])) {
 144                 _debug("marking all feeds as needing update...");
 145
 146                 db_query( "UPDATE ttrss_feeds SET last_update_started = '1970-01-01',
 147                                 last_updated = '1970-01-01'");
 148         }
 149
 150         if (isset($options["feeds"])) {
 151                 // Update all feeds needing a update.
 152                 update_daemon_common();
 153
 154                 // Update feedbrowser
 155                 $count = update_feedbrowser_cache();
 156                 _debug("Feedbrowser updated, $count feeds processed.");
 157
 158                 // Purge orphans and cleanup tags
 159                 purge_orphans( true);
 160
 161                 $rc = cleanup_tags( 14, 50000);
 162                 _debug("Cleaned $rc cached tags.");
 163
 164                 PluginHost::getInstance()->run_hooks(PluginHost::HOOK_UPDATE_TASK, "hook_update_task", $op);
 165         }
 166
 167         if (isset($options["feedbrowser"])) {
 168                 $count = update_feedbrowser_cache();
 169                 print "Finished, $count feeds processed.\n";
 170         }
 171
 172         if (isset($options["daemon"])) {
 173                 while (true) {
 174                         $quiet = (isset($options["quiet"])) ? "--quiet" : "";
 175
 176                         passthru(PHP_EXECUTABLE . " " . $argv[0] ." --daemon-loop $quiet");
 177                         _debug("Sleeping for " . DAEMON_SLEEP_INTERVAL . " seconds...");
 178                         sleep(DAEMON_SLEEP_INTERVAL);
 179                 }
 180         }
 181
 182         if (isset($options["daemon-loop"])) {
 183                 if (!make_stampfile('update_daemon.stamp')) {
 184                         _debug("warning: unable to create stampfile\n");
 185                 }
 186
 187                 // Call to the feed batch update function
 188                 // or regenerate feedbrowser cache
 189
 190                 if (rand(0,100) > 30) {
 191                         update_daemon_common();
 192                 } else {
 193                         $count = update_feedbrowser_cache();
 194                         _debug("Feedbrowser updated, $count feeds processed.");
 195
 196                         purge_orphans( true);
 197
 198                         $rc = cleanup_tags( 14, 50000);
 199
 200                         _debug("Cleaned $rc cached tags.");
 201
 202                         PluginHost::getInstance()->run_hooks(PluginHost::HOOK_UPDATE_TASK, "hook_update_task", $op);
 203                 }
 204
 205         }
 206
 207         if (isset($options["cleanup-tags"])) {
 208                 $rc = cleanup_tags( 14, 50000);
 209                 _debug("$rc tags deleted.\n");
 210         }
 211
 212         if (isset($options["indexes"])) {
 213                 _debug("PLEASE BACKUP YOUR DATABASE BEFORE PROCEEDING!");
 214                 _debug("Type 'yes' to continue.");
 215
 216                 if (read_stdin() != 'yes')
 217                         exit;
 218
 219                 _debug("clearing existing indexes...");
 220
 221                 if (DB_TYPE == "pgsql") {
 222                         $result = db_query( "SELECT relname FROM
 223                                 pg_catalog.pg_class WHERE relname LIKE 'ttrss_%'
 224                                         AND relname NOT LIKE '%_pkey'
 225                                 AND relkind = 'i'");
 226                 } else {
 227                         $result = db_query( "SELECT index_name,table_name FROM
 228                                 information_schema.statistics WHERE index_name LIKE 'ttrss_%'");
 229                 }
 230
 231                 while ($line = db_fetch_assoc($result)) {
 232                         if (DB_TYPE == "pgsql") {
 233                                 $statement = "DROP INDEX " . $line["relname"];
 234                                 _debug($statement);
 235                         } else {
 236                                 $statement = "ALTER TABLE ".
 237                                         $line['table_name']." DROP INDEX ".$line['index_name'];
 238                                 _debug($statement);
 239                         }
 240                         db_query( $statement, false);
 241                 }
 242
 243                 _debug("reading indexes from schema for: " . DB_TYPE);
 244
 245                 $fp = fopen("schema/ttrss_schema_" . DB_TYPE . ".sql", "r");
 246                 if ($fp) {
 247                         while ($line = fgets($fp)) {
 248                                 $matches = array();
 249
 250                                 if (preg_match("/^create index ([^ ]+) on ([^ ]+)$/i", $line, $matches)) {
 251                                         $index = $matches[1];
 252                                         $table = $matches[2];
 253
 254                                         $statement = "CREATE INDEX $index ON $table";
 255
 256                                         _debug($statement);
 257                                         db_query( $statement);
 258                                 }
 259                         }
 260                         fclose($fp);
 261                 } else {
 262                         _debug("unable to open schema file.");
 263                 }
 264                 _debug("all done.");
 265         }
 266
 267         if (isset($options["convert-filters"])) {
 268                 _debug("WARNING: this will remove all existing type2 filters.");
 269                 _debug("Type 'yes' to continue.");
 270
 271                 if (read_stdin() != 'yes')
 272                         exit;
 273
 274                 _debug("converting filters...");
 275
 276                 db_query( "DELETE FROM ttrss_filters2");
 277
 278                 $result = db_query( "SELECT * FROM ttrss_filters ORDER BY id");
 279
 280                 while ($line = db_fetch_assoc($result)) {
 281                         $owner_uid = $line["owner_uid"];
 282
 283                         // date filters are removed
 284                         if ($line["filter_type"] != 5) {
 285                                 $filter = array();
 286
 287                                 if (sql_bool_to_bool($line["cat_filter"])) {
 288                                         $feed_id = "CAT:" . (int)$line["cat_id"];
 289                                 } else {
 290                                         $feed_id = (int)$line["feed_id"];
 291                                 }
 292
 293                                 $filter["enabled"] = $line["enabled"] ? "on" : "off";
 294                                 $filter["rule"] = array(
 295                                         json_encode(array(
 296                                                 "reg_exp" => $line["reg_exp"],
 297                                                 "feed_id" => $feed_id,
 298                                                 "filter_type" => $line["filter_type"])));
 299
 300                                 $filter["action"] = array(
 301                                         json_encode(array(
 302                                                 "action_id" => $line["action_id"],
 303                                                 "action_param_label" => $line["action_param"],
 304                                                 "action_param" => $line["action_param"])));
 305
 306                                 // Oh god it's full of hacks
 307
 308                                 $_REQUEST = $filter;
 309                                 $_SESSION["uid"] = $owner_uid;
 310
 311                                 $filters = new Pref_Filters( $_REQUEST);
 312                                 $filters->add();
 313                         }
 314                 }
 315
 316         }
 317
 318         if (isset($options["update-schema"])) {
 319                 _debug("checking for updates (" . DB_TYPE . ")...");
 320
 321                 $updater = new DbUpdater(Db::get(), DB_TYPE, SCHEMA_VERSION);
 322
 323                 if ($updater->isUpdateRequired()) {
 324                         _debug("schema update required, version " . $updater->getSchemaVersion() . " to " . SCHEMA_VERSION);
 325                         _debug("WARNING: please backup your database before continuing.");
 326                         _debug("Type 'yes' to continue.");
 327
 328                         if (read_stdin() != 'yes')
 329                                 exit;
 330
 331                         for ($i = $updater->getSchemaVersion() + 1; $i <= SCHEMA_VERSION; $i++) {
 332                                 _debug("performing update up to version $i...");
 333
 334                                 $result = $updater->performUpdateTo($i);
 335
 336                                 _debug($result ? "OK!" : "FAILED!");
 337
 338                                 if (!$result) return;
 339
 340                         }
 341                 } else {
 342                         _debug("update not required.");
 343                 }
 344
 345         }
 346
 347         if (isset($options["list-plugins"])) {
 348                 $tmppluginhost = new PluginHost(Db::get());
 349                 $tmppluginhost->load_all($tmppluginhost::KIND_ALL);
 350                 $enabled = array_map("trim", explode(",", PLUGINS));
 351
 352                 echo "List of all available plugins:\n";
 353
 354                 foreach ($tmppluginhost->get_plugins() as $name => $plugin) {
 355                         $about = $plugin->about();
 356
 357                         $status = $about[3] ? "system" : "user";
 358
 359                         if (in_array($name, $enabled)) $name .= "*";
 360
 361                         printf("%-50s %-10s v%.2f (by %s)\n%s\n\n",
 362                                 $name, $status, $about[0], $about[2], $about[1]);
 363                 }
 364
 365                 echo "Plugins marked by * are currently enabled for all users.\n";
 366
 367         }
 368
 369         PluginHost::getInstance()->run_commands($options);
 370
 371         if ($lock_handle != false) {
 372                 fclose($lock_handle);
 373         }
 374
 375         if (file_exists(LOCK_DIRECTORY . "/$lock_filename"))
 376                 unlink(LOCK_DIRECTORY . "/$lock_filename");
 377 ?>