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