From 73f28fe979c48a88eb7b4037d7f0f708f8177f4c Mon Sep 17 00:00:00 2001
From: Andrew Dolgov <fox@fakecake.org>
Date: Mon, 24 Dec 2012 09:52:15 +0400
Subject: [PATCH] add support for registering update.php commands; move rest of
the self-updating stuff into updater plugin
---
classes/pluginhost.php | 40 ++++++
include/update_self.php | 234 ---------------------------------
plugins/updater/updater.php | 251 +++++++++++++++++++++++++++++++++++-
update.php | 32 ++---
4 files changed, 302 insertions(+), 255 deletions(-)
delete mode 100644 include/update_self.php
diff --git a/classes/pluginhost.php b/classes/pluginhost.php
index 46415bd21..027d07539 100644
--- a/classes/pluginhost.php
+++ b/classes/pluginhost.php
@@ -4,6 +4,7 @@ class PluginHost {
private $hooks = array();
private $plugins = array();
private $handlers = array();
+ private $commands = array();
const HOOK_ARTICLE_BUTTON = 1;
const HOOK_ARTICLE_FILTER = 2;
@@ -109,5 +110,44 @@ class PluginHost {
return false;
}
+
+ function add_command($command, $description, $sender) {
+ $command = "-" . str_replace("-", "_", strtolower($command));
+
+ $this->commands[$command] = array("description" => $description,
+ "class" => $sender);
+ }
+
+ function del_command($command) {
+ $command = "-" . strtolower($command);
+
+ unset($this->commands[$command]);
+ }
+
+ function lookup_command($command) {
+ $command = "-" . strtolower($command);
+
+ if (is_array($this->commands[$command])) {
+ return $this->commands[$command]["class"];
+ } else {
+ return false;
+ }
+
+ return false;
+ }
+
+ function get_commands() {
+ return $this->commands;
+ }
+
+ function run_commands($args) {
+ foreach ($this->get_commands() as $command => $data) {
+ if (in_array($command, $args)) {
+ $command = str_replace("-", "", $command);
+ $data["class"]->$command($args);
+ }
+ }
+ }
+
}
?>
diff --git a/include/update_self.php b/include/update_self.php
deleted file mode 100644
index cb3482ab0..000000000
--- a/include/update_self.php
+++ /dev/null
@@ -1,234 +0,0 @@
-<?php
- function update_self_step($link, $step, $params, $force = false) {
- // __FILE__ is in include/ so we need to go one level up
- $work_dir = dirname(dirname(__FILE__));
- $parent_dir = dirname($work_dir);
-
- if (!chdir($work_dir)) {
- array_push($log, "Unable to change to work directory: $work_dir");
- $stop = true; break;
- }
-
- $stop = false;
- $log = array();
- if (!is_array($params)) $params = array();
-
- switch ($step) {
- case 0:
- array_push($log, "Work directory: $work_dir");
-
- if (!is_writable($work_dir) && !is_writable("$parent_dir")) {
- $user = posix_getpwuid(posix_geteuid());
- $user = $user["name"];
- array_push($log, "Both tt-rss and parent directories should be writable as current user ($user).");
- $stop = true; break;
- }
-
- if (!file_exists("$work_dir/config.php") || !file_exists("$work_dir/include/sanity_check.php")) {
- array_push($log, "Work directory $work_dir doesn't look like tt-rss installation.");
- $stop = true; break;
- }
-
- if (!is_writable(sys_get_temp_dir())) {
- array_push($log, "System temporary directory should be writable as current user.");
- $stop = true; break;
- }
-
- array_push($log, "Checking for tar...");
-
- $system_rc = 0;
- system("tar --version >/dev/null", $system_rc);
-
- if ($system_rc != 0) {
- array_push($log, "Could not run tar executable (RC=$system_rc).");
- $stop = true; break;
- }
-
- array_push($log, "Checking for latest version...");
-
- $version_info = json_decode(fetch_file_contents("http://tt-rss.org/version.php"),
- true);
-
- if (!is_array($version_info)) {
- array_push($log, "Unable to fetch version information.");
- $stop = true; break;
- }
-
- $target_version = $version_info["version"];
- $target_dir = "$parent_dir/tt-rss-$target_version";
-
- array_push($log, "Target version: $target_version");
- $params["target_version"] = $target_version;
-
- if (version_compare(VERSION, $target_version) != -1 && !$force) {
- array_push($log, "Your Tiny Tiny RSS installation is up to date.");
- $stop = true; break;
- }
-
- if (file_exists($target_dir)) {
- array_push($log, "Target directory $target_dir already exists.");
- $stop = true; break;
- }
-
- break;
- case 1:
- $target_version = $params["target_version"];
-
- array_push($log, "Downloading checksums...");
- $md5sum_data = fetch_file_contents("http://tt-rss.org/download/md5sum.txt");
-
- if (!$md5sum_data) {
- array_push($log, "Could not download checksums.");
- $stop = true; break;
- }
-
- $md5sum_data = explode("\n", $md5sum_data);
-
- foreach ($md5sum_data as $line) {
- $pair = explode(" ", $line);
-
- if ($pair[1] == "tt-rss-$target_version.tar.gz") {
- $target_md5sum = $pair[0];
- break;
- }
- }
-
- if (!$target_md5sum) {
- array_push($log, "Unable to locate checksum for target version.");
- $stop = true; break;
- }
-
- $params["target_md5sum"] = $target_md5sum;
-
- break;
- case 2:
- $target_version = $params["target_version"];
- $target_md5sum = $params["target_md5sum"];
-
- array_push($log, "Downloading distribution tarball...");
-
- $tarball_url = "http://tt-rss.org/download/tt-rss-$target_version.tar.gz";
- $data = fetch_file_contents($tarball_url);
-
- if (!$data) {
- array_push($log, "Could not download distribution tarball ($tarball_url).");
- $stop = true; break;
- }
-
- array_push($log, "Verifying tarball checksum...");
-
- $test_md5sum = md5($data);
-
- if ($test_md5sum != $target_md5sum) {
- array_push($log, "Downloaded checksum doesn't match (got $test_md5sum, expected $target_md5sum).");
- $stop = true; break;
- }
-
- $tmp_file = tempnam(sys_get_temp_dir(), 'tt-rss');
- array_push($log, "Saving download to $tmp_file");
-
- if (!file_put_contents($tmp_file, $data)) {
- array_push($log, "Unable to save download.");
- $stop = true; break;
- }
-
- $params["tmp_file"] = $tmp_file;
-
- break;
- case 3:
- $tmp_file = $params["tmp_file"];
- $target_version = $params["target_version"];
-
- if (!chdir($parent_dir)) {
- array_push($log, "Unable to change into parent directory.");
- $stop = true; break;
- }
-
- $old_dir = tmpdirname($parent_dir, "tt-rss-old");
-
- array_push($log, "Renaming tt-rss directory to ".basename($old_dir));
- if (!rename($work_dir, $old_dir)) {
- array_push($log, "Unable to rename tt-rss directory.");
- $stop = true; break;
- }
-
- array_push($log, "Extracting tarball...");
- system("tar zxf $tmp_file", $system_rc);
-
- if ($system_rc != 0) {
- array_push($log, "Error while extracting tarball (RC=$system_rc).");
- $stop = true; break;
- }
-
- $target_dir = "$parent_dir/tt-rss-$target_version";
-
- array_push($log, "Renaming target directory...");
- if (!rename($target_dir, $work_dir)) {
- array_push($log, "Unable to rename target directory.");
- $stop = true; break;
- }
-
- if (!chdir($work_dir)) {
- array_push($log, "Unable to change to work directory: $work_dir");
- $stop = true; break;
- }
-
- array_push($log, "Copying config.php...");
- if (!copy("$old_dir/config.php", "$work_dir/config.php")) {
- array_push($log, "Unable to copy config.php to $work_dir.");
- $stop = true; break;
- }
-
- array_push($log, "Cleaning up...");
- unlink($tmp_file);
-
- array_push($log, "Fixing permissions...");
-
- $directories = array(
- CACHE_DIR,
- CACHE_DIR . "/htmlpurifier",
- CACHE_DIR . "/export",
- CACHE_DIR . "/images",
- CACHE_DIR . "/magpie",
- CACHE_DIR . "/simplepie",
- ICONS_DIR,
- LOCK_DIRECTORY);
-
- foreach ($directories as $dir) {
- array_push($log, "-> $dir");
- chmod($dir, 0777);
- }
-
- array_push($log, "Upgrade completed.");
- array_push($log, "Your old tt-rss directory is saved at $old_dir. ".
- "Please migrate locally modified files (if any) and remove it.");
- array_push($log, "You might need to re-enter current directory in shell to see new files.");
-
- $stop = true;
- break;
- default:
- $stop = true;
- }
-
- return array("step" => $step, "stop" => $stop, "params" => $params, "log" => $log);
- }
-
-
- function update_self($link, $force = false) {
- $step = 0;
- $stop = false;
- $params = array();
-
- while (!$stop) {
- $rc = update_self_step($link, $step, $params, $force);
-
- $params = $rc['params'];
- $stop = $rc['stop'];
-
- foreach ($rc['log'] as $line) {
- _debug($line);
- }
- ++$step;
- }
- }
-?>
diff --git a/plugins/updater/updater.php b/plugins/updater/updater.php
index f88ebe409..7fdda5fff 100644
--- a/plugins/updater/updater.php
+++ b/plugins/updater/updater.php
@@ -9,6 +9,253 @@ class Updater extends Plugin {
$this->host = $host;
$host->add_hook($host::HOOK_PREFS_TAB, $this);
+
+ $host->add_command("update-self",
+ "update tt-rss installation to latest version",
+ $this);
+ }
+
+ function update_self_step($link, $step, $params, $force = false) {
+ // __FILE__ is in plugins/updater so we need to go one level up
+ $work_dir = dirname(dirname(dirname(__FILE__)));
+ $parent_dir = dirname($work_dir);
+
+ if (!chdir($work_dir)) {
+ array_push($log, "Unable to change to work directory: $work_dir");
+ $stop = true; break;
+ }
+
+ $stop = false;
+ $log = array();
+ if (!is_array($params)) $params = array();
+
+ switch ($step) {
+ case 0:
+ array_push($log, "Work directory: $work_dir");
+
+ if (!is_writable($work_dir) && !is_writable("$parent_dir")) {
+ $user = posix_getpwuid(posix_geteuid());
+ $user = $user["name"];
+ array_push($log, "Both tt-rss and parent directories should be writable as current user ($user).");
+ $stop = true; break;
+ }
+
+ if (!file_exists("$work_dir/config.php") || !file_exists("$work_dir/include/sanity_check.php")) {
+ array_push($log, "Work directory $work_dir doesn't look like tt-rss installation.");
+ $stop = true; break;
+ }
+
+ if (!is_writable(sys_get_temp_dir())) {
+ array_push($log, "System temporary directory should be writable as current user.");
+ $stop = true; break;
+ }
+
+ array_push($log, "Checking for tar...");
+
+ $system_rc = 0;
+ system("tar --version >/dev/null", $system_rc);
+
+ if ($system_rc != 0) {
+ array_push($log, "Could not run tar executable (RC=$system_rc).");
+ $stop = true; break;
+ }
+
+ array_push($log, "Checking for latest version...");
+
+ $version_info = json_decode(fetch_file_contents("http://tt-rss.org/version.php"),
+ true);
+
+ if (!is_array($version_info)) {
+ array_push($log, "Unable to fetch version information.");
+ $stop = true; break;
+ }
+
+ $target_version = $version_info["version"];
+ $target_dir = "$parent_dir/tt-rss-$target_version";
+
+ array_push($log, "Target version: $target_version");
+ $params["target_version"] = $target_version;
+
+ if (version_compare(VERSION, $target_version) != -1 && !$force) {
+ array_push($log, "Your Tiny Tiny RSS installation is up to date.");
+ $stop = true; break;
+ }
+
+ if (file_exists($target_dir)) {
+ array_push($log, "Target directory $target_dir already exists.");
+ $stop = true; break;
+ }
+
+ break;
+ case 1:
+ $target_version = $params["target_version"];
+
+ array_push($log, "Downloading checksums...");
+ $md5sum_data = fetch_file_contents("http://tt-rss.org/download/md5sum.txt");
+
+ if (!$md5sum_data) {
+ array_push($log, "Could not download checksums.");
+ $stop = true; break;
+ }
+
+ $md5sum_data = explode("\n", $md5sum_data);
+
+ foreach ($md5sum_data as $line) {
+ $pair = explode(" ", $line);
+
+ if ($pair[1] == "tt-rss-$target_version.tar.gz") {
+ $target_md5sum = $pair[0];
+ break;
+ }
+ }
+
+ if (!$target_md5sum) {
+ array_push($log, "Unable to locate checksum for target version.");
+ $stop = true; break;
+ }
+
+ $params["target_md5sum"] = $target_md5sum;
+
+ break;
+ case 2:
+ $target_version = $params["target_version"];
+ $target_md5sum = $params["target_md5sum"];
+
+ array_push($log, "Downloading distribution tarball...");
+
+ $tarball_url = "http://tt-rss.org/download/tt-rss-$target_version.tar.gz";
+ $data = fetch_file_contents($tarball_url);
+
+ if (!$data) {
+ array_push($log, "Could not download distribution tarball ($tarball_url).");
+ $stop = true; break;
+ }
+
+ array_push($log, "Verifying tarball checksum...");
+
+ $test_md5sum = md5($data);
+
+ if ($test_md5sum != $target_md5sum) {
+ array_push($log, "Downloaded checksum doesn't match (got $test_md5sum, expected $target_md5sum).");
+ $stop = true; break;
+ }
+
+ $tmp_file = tempnam(sys_get_temp_dir(), 'tt-rss');
+ array_push($log, "Saving download to $tmp_file");
+
+ if (!file_put_contents($tmp_file, $data)) {
+ array_push($log, "Unable to save download.");
+ $stop = true; break;
+ }
+
+ $params["tmp_file"] = $tmp_file;
+
+ break;
+ case 3:
+ $tmp_file = $params["tmp_file"];
+ $target_version = $params["target_version"];
+
+ if (!chdir($parent_dir)) {
+ array_push($log, "Unable to change into parent directory.");
+ $stop = true; break;
+ }
+
+ $old_dir = tmpdirname($parent_dir, "tt-rss-old");
+
+ array_push($log, "Renaming tt-rss directory to ".basename($old_dir));
+ if (!rename($work_dir, $old_dir)) {
+ array_push($log, "Unable to rename tt-rss directory.");
+ $stop = true; break;
+ }
+
+ array_push($log, "Extracting tarball...");
+ system("tar zxf $tmp_file", $system_rc);
+
+ if ($system_rc != 0) {
+ array_push($log, "Error while extracting tarball (RC=$system_rc).");
+ $stop = true; break;
+ }
+
+ $target_dir = "$parent_dir/tt-rss-$target_version";
+
+ array_push($log, "Renaming target directory...");
+ if (!rename($target_dir, $work_dir)) {
+ array_push($log, "Unable to rename target directory.");
+ $stop = true; break;
+ }
+
+ if (!chdir($work_dir)) {
+ array_push($log, "Unable to change to work directory: $work_dir");
+ $stop = true; break;
+ }
+
+ array_push($log, "Copying config.php...");
+ if (!copy("$old_dir/config.php", "$work_dir/config.php")) {
+ array_push($log, "Unable to copy config.php to $work_dir.");
+ $stop = true; break;
+ }
+
+ array_push($log, "Cleaning up...");
+ unlink($tmp_file);
+
+ array_push($log, "Fixing permissions...");
+
+ $directories = array(
+ CACHE_DIR,
+ CACHE_DIR . "/htmlpurifier",
+ CACHE_DIR . "/export",
+ CACHE_DIR . "/images",
+ CACHE_DIR . "/magpie",
+ CACHE_DIR . "/simplepie",
+ ICONS_DIR,
+ LOCK_DIRECTORY);
+
+ foreach ($directories as $dir) {
+ array_push($log, "-> $dir");
+ chmod($dir, 0777);
+ }
+
+ array_push($log, "Upgrade completed.");
+ array_push($log, "Your old tt-rss directory is saved at $old_dir. ".
+ "Please migrate locally modified files (if any) and remove it.");
+ array_push($log, "You might need to re-enter current directory in shell to see new files.");
+
+ $stop = true;
+ break;
+ default:
+ $stop = true;
+ }
+
+ return array("step" => $step, "stop" => $stop, "params" => $params, "log" => $log);
+ }
+
+ function update_self_cli($link, $force = false) {
+ $step = 0;
+ $stop = false;
+ $params = array();
+
+ while (!$stop) {
+ $rc = $this->update_self_step($link, $step, $params, $force);
+
+ $params = $rc['params'];
+ $stop = $rc['stop'];
+
+ foreach ($rc['log'] as $line) {
+ _debug($line);
+ }
+ ++$step;
+ }
+ }
+
+ function update_self($args) {
+ _debug("Warning: self-updating is experimental. Use at your own risk.");
+ _debug("Please backup your tt-rss directory before continuing. Your database will not be modified.");
+ _debug("Type 'yes' to continue.");
+
+ if (read_stdin() != 'yes')
+ exit;
+
+ $this->update_self_cli($link, in_array("-force", $args));
}
function get_prefs_js() {
@@ -64,9 +311,7 @@ class Updater extends Plugin {
$force = (bool) $_REQUEST["force"];
if (($_SESSION["access_level"] >= 10 || SINGLE_USER_MODE) && CHECK_FOR_NEW_VERSION) {
- include "update_self.php";
-
- print json_encode(update_self_step($this->link, $step, $params, $force));
+ print json_encode($this->update_self_step($this->link, $step, $params, $force));
}
}
diff --git a/update.php b/update.php
index 8a5512efb..d039d062e 100755
--- a/update.php
+++ b/update.php
@@ -13,11 +13,16 @@
require_once "config.php";
require_once "db.php";
require_once "db-prefs.php";
- require_once "update_self.php";
if (!defined('PHP_EXECUTABLE'))
define('PHP_EXECUTABLE', '/usr/bin/php');
+ // Create a database connection.
+ $link = db_connect(DB_HOST, DB_USER, DB_PASS, DB_NAME);
+
+ init_connection($link);
+
+
$op = $argv;
if (count($argv) == 0 && !defined('STDIN')) {
@@ -48,12 +53,17 @@
print " -cleanup-tags - perform tags table maintenance\n";
print " -get-feeds - receive popular feeds from linked instances\n";
print " -import USER FILE - import articles from XML\n";
- print " -update-self - update tt-rss installation to latest version\n";
print " -quiet - don't show messages\n";
print " -indexes - recreate missing schema indexes\n";
print " -convert-filters - convert type1 filters to type2\n";
print " -force-update - force update of all feeds\n";
print " -help - show this help\n";
+ print "Plugin options:\n";
+
+ foreach ($pluginhost->get_commands() as $command => $data) {
+ printf(" %-19s - %s\n", "$command", $data["description"]);
+ }
+
return;
}
@@ -74,11 +84,6 @@
"Maybe another update process is already running.\n");
}
- // Create a database connection.
- $link = db_connect(DB_HOST, DB_USER, DB_PASS, DB_NAME);
-
- init_connection($link);
-
if (in_array("-feeds", $op)) {
// Update all feeds needing a update.
update_daemon_common($link);
@@ -228,17 +233,6 @@
_debug("all done.");
}
- if (in_array("-update-self", $op)) {
- _debug("Warning: self-updating is experimental. Use at your own risk.");
- _debug("Please backup your tt-rss directory before continuing. Your database will not be modified.");
- _debug("Type 'yes' to continue.");
-
- if (read_stdin() != 'yes')
- exit;
-
- update_self($link, in_array("-force", $op));
- }
-
if (in_array("-convert-filters", $op)) {
_debug("WARNING: this will remove all existing type2 filters.");
_debug("Type 'yes' to continue.");
@@ -297,6 +291,8 @@
last_updated = '1970-01-01'");
}
+ $pluginhost->run_commands($op);
+
db_close($link);
if ($lock_handle != false) {
--
GitLab