plugins/updater/init.php

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