plugins/updater/init.php

   1 <?php
   2 class Updater extends Plugin {
   3
   4         private $link;
   5         private $host;
   6
   7         function about() {
   8                 return array(1.0,
   9                         "Updates tt-rss installation to latest version.",
  10                         "fox",
  11                         true);
  12         }
  13
  14         function init($host) {
  15                 $this->link = $host->get_link();
  16                 $this->host = $host;
  17
  18                 $host->add_hook($host::HOOK_PREFS_TAB, $this);
  19
  20                 $host->add_command("update-self",
  21                         "update tt-rss installation to latest version",
  22                         $this);
  23         }
  24
  25         function update_self_step($link, $step, $params, $force = false) {
  26                 // __FILE__ is in plugins/updater so we need to go one level up
  27                 $work_dir = dirname(dirname(dirname(__FILE__)));
  28                 $parent_dir = dirname($work_dir);
  29
  30                 $log = array();
  31                 if (!is_array($params)) $params = array();
  32
  33                 $stop = false;
  34
  35                 if (!chdir($work_dir)) {
  36                         array_push($log, "Unable to change to work directory: $work_dir");
  37                         $stop = true;
  38                 }
  39
  40                 if (!$stop) {
  41                         switch ($step) {
  42                         case 0:
  43                                 array_push($log, "Work directory: $work_dir");
  44
  45                                 if (!is_writable($work_dir) && !is_writable("$parent_dir")) {
  46                                         $user = posix_getpwuid(posix_geteuid());
  47                                         $user = $user["name"];
  48                                         array_push($log, "Both tt-rss and parent directories should be writable as current user ($user).");
  49                                         $stop = true; break;
  50                                 }
  51
  52                                 if (!file_exists("$work_dir/config.php") || !file_exists("$work_dir/include/sanity_check.php")) {
  53                                         array_push($log, "Work directory $work_dir doesn't look like tt-rss installation.");
  54                                         $stop = true; break;
  55                                 }
  56
  57                                 if (!is_writable(sys_get_temp_dir())) {
  58                                         array_push($log, "System temporary directory should be writable as current user.");
  59                                         $stop = true; break;
  60                                 }
  61
  62                                 array_push($log, "Checking for tar...");
  63
  64                                 $system_rc = 0;
  65                                 system("which tar >/dev/null", $system_rc);
  66
  67                                 if ($system_rc != 0) {
  68                                         array_push($log, "Could not run tar executable (RC=$system_rc).");
  69                                         $stop = true; break;
  70                                 }
  71
  72                                 array_push($log, "Checking for gunzip...");
  73
  74                                 $system_rc = 0;
  75                                 system("which gunzip >/dev/null", $system_rc);
  76
  77                                 if ($system_rc != 0) {
  78                                         array_push($log, "Could not run gunzip executable (RC=$system_rc).");
  79                                         $stop = true; break;
  80                                 }
  81
  82                                 array_push($log, "Checking for latest version...");
  83
  84                                 $version_info = json_decode(fetch_file_contents("http://tt-rss.org/version.php"),
  85                                         true);
  86
  87                                 if (!is_array($version_info)) {
  88                                         array_push($log, "Unable to fetch version information.");
  89                                         $stop = true; break;
  90                                 }
  91
  92                                 $target_version = $version_info["version"];
  93                                 $target_dir = "$parent_dir/Tiny-Tiny-RSS-$target_version";
  94
  95                                 array_push($log, "Target version: $target_version");
  96                                 $params["target_version"] = $target_version;
  97
  98                                 if (version_compare(VERSION, $target_version) != -1 && !$force) {
  99                                         array_push($log, "Your Tiny Tiny RSS installation is up to date.");
 100                                         $stop = true; break;
 101                                 }
 102
 103                                 if (file_exists($target_dir)) {
 104                                         array_push($log, "Target directory $target_dir already exists.");
 105                                         $stop = true; break;
 106                                 }
 107
 108                                 break;
 109                         case 1:
 110                                 $target_version = $params["target_version"];
 111
 112 /*                              array_push($log, "Downloading checksums...");
 113                                 $md5sum_data = fetch_file_contents("http://tt-rss.org/download/md5sum.txt");
 114
 115                                 if (!$md5sum_data) {
 116                                         array_push($log, "Could not download checksums.");
 117                                         $stop = true; break;
 118                                 }
 119
 120                                 $md5sum_data = explode("\n", $md5sum_data);
 121
 122                                 foreach ($md5sum_data as $line) {
 123                                         $pair = explode("  ", $line);
 124
 125                                         if ($pair[1] == "tt-rss-$target_version.tar.gz") {
 126                                                 $target_md5sum = $pair[0];
 127                                                 break;
 128                                         }
 129                                 }
 130
 131                                 if (!$target_md5sum) {
 132                                         array_push($log, "Unable to locate checksum for target version.");
 133                                         $stop = true; break;
 134                                 }
 135
 136                                 $params["target_md5sum"] = $target_md5sum; */
 137
 138                                 array_push($log, "Proceeding to download...");
 139
 140                                 break;
 141                         case 2:
 142                                 $target_version = $params["target_version"];
 143                                 // $target_md5sum = $params["target_md5sum"];
 144
 145                                 array_push($log, "Downloading distribution tarball...");
 146
 147                                 $tarball_url = "https://github.com/gothfox/Tiny-Tiny-RSS/archive/$target_version.tar.gz";
 148                                 $data = fetch_file_contents($tarball_url);
 149
 150                                 if (!$data) {
 151                                         array_push($log, "Could not download distribution tarball ($tarball_url).");
 152                                         $stop = true; break;
 153                                 }
 154
 155                                 /* array_push($log, "Verifying tarball checksum...");
 156
 157                                 $test_md5sum = md5($data);
 158
 159                                 if ($test_md5sum != $target_md5sum) {
 160                                         array_push($log, "Downloaded checksum doesn't match (got $test_md5sum, expected $target_md5sum).");
 161                                         $stop = true; break;
 162                                 } */
 163
 164                                 $tmp_file = tempnam(sys_get_temp_dir(), 'tt-rss');
 165                                 array_push($log, "Saving download to $tmp_file");
 166
 167                                 if (!file_put_contents($tmp_file, $data)) {
 168                                         array_push($log, "Unable to save download.");
 169                                         $stop = true; break;
 170                                 }
 171
 172                                 $params["tmp_file"] = $tmp_file;
 173
 174                                 break;
 175                         case 3:
 176                                 $tmp_file = $params["tmp_file"];
 177                                 $target_version = $params["target_version"];
 178
 179                                 if (!chdir($parent_dir)) {
 180                                         array_push($log, "Unable to change into parent directory.");
 181                                         $stop = true; break;
 182                                 }
 183
 184                                 array_push($log, "Extracting tarball...");
 185                                 system("tar zxf $tmp_file", $system_rc);
 186
 187                                 if ($system_rc != 0) {
 188                                         array_push($log, "Error while extracting tarball (RC=$system_rc).");
 189                                         $stop = true; break;
 190                                 }
 191
 192                                 $target_dir = "$parent_dir/Tiny-Tiny-RSS-$target_version";
 193
 194                                 if (!is_dir($target_dir)) {
 195                                         array_push($log, "Target directory ($target_dir) not found.");
 196                                         $stop = true; break;
 197                                 }
 198
 199                                 $old_dir = tmpdirname($parent_dir, "tt-rss-old");
 200
 201                                 array_push($log, "Renaming tt-rss directory to ".basename($old_dir));
 202                                 if (!rename($work_dir, $old_dir)) {
 203                                         array_push($log, "Unable to rename tt-rss directory.");
 204                                         $stop = true; break;
 205                                 }
 206
 207                                 array_push($log, "Renaming target directory...");
 208                                 if (!rename($target_dir, $work_dir)) {
 209                                         array_push($log, "Unable to rename target directory.");
 210                                         $stop = true; break;
 211                                 }
 212
 213                                 if (!chdir($work_dir)) {
 214                                         array_push($log, "Unable to change to work directory: $work_dir");
 215                                         $stop = true; break;
 216                                 }
 217
 218                                 array_push($log, "Copying config.php...");
 219                                 if (!copy("$old_dir/config.php", "$work_dir/config.php")) {
 220                                         array_push($log, "Unable to copy config.php to $work_dir.");
 221                                         $stop = true; break;
 222                                 }
 223
 224                                 array_push($log, "Cleaning up...");
 225                                 unlink($tmp_file);
 226
 227                                 array_push($log, "Fixing permissions...");
 228
 229                                 $directories = array(
 230                                         CACHE_DIR,
 231                                         CACHE_DIR . "/export",
 232                                         CACHE_DIR . "/images",
 233                                         CACHE_DIR . "/js",
 234                                         CACHE_DIR . "/simplepie",
 235                                         ICONS_DIR,
 236                                         LOCK_DIRECTORY);
 237
 238                                 foreach ($directories as $dir) {
 239                                         array_push($log, "-> $dir");
 240                                         chmod($dir, 0777);
 241                                 }
 242
 243                                 if (ICONS_DIR == "feed-icons") {
 244                                         array_push($log, "Migrating feed icons...");
 245
 246                                         $icons = glob("$old_dir/feed-icons/*.ico");
 247                                         $icons_copied = 0;
 248
 249                                         foreach ($icons as $icon) {
 250                                                 $icon = basename($icon);
 251
 252                                                 if (copy("$old_dir/feed-icons/$icon", "$work_dir/feed-icons/$icon")) {
 253                                                         ++$icons_copied;
 254                                                 }
 255                                         }
 256
 257                                         array_push($log, "Done; $icons_copied files copied");
 258
 259                                 } else {
 260                                         array_push($log, "Not migrating feed icons, ICONS_DIR modified.");
 261                                 }
 262
 263                                 array_push($log, "Upgrade completed.");
 264                                 array_push($log, "Your old tt-rss directory is saved at $old_dir. ".
 265                                         "Please migrate locally modified files (if any) and remove it.");
 266                                 array_push($log, "You might need to re-enter current directory in shell to see new files.");
 267
 268                                 $stop = true;
 269                                 break;
 270                         default:
 271                                 $stop = true;
 272                         }
 273                 }
 274
 275                 return array("step" => $step, "stop" => $stop, "params" => $params, "log" => $log);
 276         }
 277
 278         function update_self_cli($link, $force = false) {
 279                 $step = 0;
 280                 $stop = false;
 281                 $params = array();
 282
 283                 while (!$stop) {
 284                         $rc = $this->update_self_step($link, $step, $params, $force);
 285
 286                         $params = $rc['params'];
 287                         $stop = $rc['stop'];
 288
 289                         foreach ($rc['log'] as $line) {
 290                                 _debug($line);
 291                         }
 292                         ++$step;
 293                 }
 294         }
 295
 296         function update_self($args) {
 297                 _debug("Warning: self-updating is experimental. Use at your own risk.");
 298                 _debug("Please backup your tt-rss directory before continuing. Your database will not be modified.");
 299                 _debug("Type 'yes' to continue.");
 300
 301                 $input = read_stdin();
 302
 303                 if ($input != 'yes' && $input != 'force')
 304                         exit;
 305
 306                 $this->update_self_cli($link, $input == 'force');
 307         }
 308
 309         function get_prefs_js() {
 310                 return file_get_contents(dirname(__FILE__) . "/updater.js");
 311         }
 312
 313         function hook_prefs_tab($args) {
 314                 if ($args != "prefPrefs") return;
 315
 316                 if (($_SESSION["access_level"] >= 10 || SINGLE_USER_MODE) && CHECK_FOR_NEW_VERSION) {
 317                         print "<div dojoType=\"dijit.layout.AccordionPane\" title=\"".__('Update Tiny Tiny RSS')."\">";
 318
 319                         if ($_SESSION["pref_last_version_check"] + 86400 + rand(-1000, 1000) < time()) {
 320                                 $_SESSION["version_data"] = @check_for_update($this->link);
 321                                 $_SESSION["pref_last_version_check"] = time();
 322                         }
 323
 324                         if (is_array($_SESSION["version_data"])) {
 325                                 $version = $_SESSION["version_data"]["version"];
 326                                 print_notice(T_sprintf("New version of Tiny Tiny RSS is available (%s).", "<b>$version</b>"));
 327
 328                                 print "<p><button dojoType=\"dijit.form.Button\" onclick=\"return updateSelf()\">".
 329                                         __('Update Tiny Tiny RSS')."</button></p>";
 330
 331                         } else {
 332                                 print_notice(__("Your Tiny Tiny RSS installation is up to date."));
 333                         }
 334
 335                         print "</div>"; #pane
 336                 }
 337         }
 338
 339         function updateSelf() {
 340                 print "<form style='display : block' name='self_update_form' id='self_update_form'>";
 341
 342                 print "<div class='error'>".__("Do not close this dialog until updating is finished. Backup your tt-rss directory before continuing.")."</div>";
 343
 344                 print "<ul class='selfUpdateList' id='self_update_log'>";
 345                 print "<li>" . __("Ready to update.") . "</li>";
 346                 print "</ul>";
 347
 348                 print "<div class='dlgButtons'>";
 349                 print "<button id=\"self_update_start_btn\" dojoType=\"dijit.form.Button\" onclick=\"return dijit.byId('updateSelfDlg').start()\" >".
 350                         __("Start update")."</button>";
 351                 print "<button id=\"self_update_stop_btn\" onclick=\"return dijit.byId('updateSelfDlg').close()\" dojoType=\"dijit.form.Button\">".
 352                         __("Close this window")."</button>";
 353                 print "</div>";
 354                 print "</form>";
 355         }
 356
 357         function performUpdate() {
 358                 $step = (int) $_REQUEST["step"];
 359                 $params = json_decode($_REQUEST["params"], true);
 360                 $force = (bool) $_REQUEST["force"];
 361
 362                 if (($_SESSION["access_level"] >= 10 || SINGLE_USER_MODE) && CHECK_FOR_NEW_VERSION) {
 363                         print   json_encode($this->update_self_step($this->link, $step, $params, $force));
 364                 }
 365         }
 366
 367 }
 368 ?>