<?php namespace Friendica\Core; use Friendica\Database\DBA; use Friendica\Database\DBStructure; class Update { const SUCCESS = 0; const FAILED = 1; /** * @brief Function to check if the Database structure needs an update. * * @param boolean $via_worker boolean Is the check run via the worker? */ public static function check($via_worker) { $build = Config::get('system', 'build'); if (empty($build)) { Config::set('system', 'build', DB_UPDATE_VERSION - 1); $build = DB_UPDATE_VERSION - 1; } // We don't support upgrading from very old versions anymore if ($build < NEW_UPDATE_ROUTINE_VERSION) { die('You try to update from a version prior to database version 1170. The direct upgrade path is not supported. Please update to version 3.5.4 before updating to this version.'); } if ($build < DB_UPDATE_VERSION) { // When we cannot execute the database update via the worker, we will do it directly if (!Worker::add(PRIORITY_CRITICAL, 'DBUpdate') && $via_worker) { self::run(); } } } /** * Automatic database updates * * @param bool $force Force the Update-Check even if the lock is set * @param bool $verbose Run the Update-Check verbose * @param bool $sendMail Sends a Mail to the administrator in case of success/failure * * @return string Empty string if the update is successful, error messages otherwise */ public static function run($force = false, $verbose = false, $sendMail = true) { // In force mode, we release the dbupdate lock first // Necessary in case of an stuck update if ($force) { Lock::release('dbupdate'); } $build = Config::get('system', 'build'); if (empty($build) || ($build > DB_UPDATE_VERSION)) { $build = DB_UPDATE_VERSION - 1; Config::set('system', 'build', $build); } if ($build != DB_UPDATE_VERSION) { require_once 'update.php'; $stored = intval($build); $current = intval(DB_UPDATE_VERSION); if ($stored < $current) { Config::load('database'); // Compare the current structure with the defined structure // If the Lock is acquired, never release it automatically to avoid double updates if (Lock::acquire('dbupdate', 120, Cache::INFINITE)) { // run the pre_update_nnnn functions in update.php for ($x = $stored + 1; $x <= $current; $x++) { $r = self::runUpdateFunction($x, 'pre_update'); if (!$r) { break; } } // update the structure in one call $retval = DBStructure::update($verbose, true); if ($retval) { if ($sendMail) { self::updateFailed( DB_UPDATE_VERSION, $retval ); } Lock::release('dbupdate'); return $retval; } else { Config::set('database', 'last_successful_update', $current); Config::set('database', 'last_successful_update_time', time()); } // run the update_nnnn functions in update.php for ($x = $stored + 1; $x <= $current; $x++) { $r = self::runUpdateFunction($x, 'update'); if (!$r) { break; } } if ($sendMail) { self::updateSuccessfull($stored, $current); } Lock::release('dbupdate'); } } } return ''; } /** * Executes a specific update function * * @param int $x the DB version number of the function * @param string $prefix the prefix of the function (update, pre_update) * * @return bool true, if the update function worked */ public static function runUpdateFunction($x, $prefix) { $funcname = $prefix . '_' . $x; if (function_exists($funcname)) { // There could be a lot of processes running or about to run. // We want exactly one process to run the update command. // So store the fact that we're taking responsibility // after first checking to see if somebody else already has. // If the update fails or times-out completely you may need to // delete the config entry to try again. if (Lock::acquire('dbupdate_function', 120,Cache::INFINITE)) { // call the specific update $retval = $funcname(); if ($retval) { //send the administrator an e-mail self::updateFailed( $x, L10n::t('Update %s failed. See error logs.', $x) ); Lock::release('dbupdate_function'); return false; } else { Config::set('database', 'last_successful_update_function', $funcname); Config::set('database', 'last_successful_update_function_time', time()); if ($prefix == 'update') { Config::set('system', 'build', $x); } Lock::release('dbupdate_function'); return true; } } } else { Logger::log('Skipping \'' . $funcname . '\' without executing', Logger::DEBUG); Config::set('database', 'last_successful_update_function', $funcname); Config::set('database', 'last_successful_update_function_time', time()); if ($prefix == 'update') { Config::set('system', 'build', $x); } return true; } } /** * send the email and do what is needed to do on update fails * * @param int $update_id number of failed update * @param string $error_message error message */ private static function updateFailed($update_id, $error_message) { //send the administrators an e-mail $admin_mail_list = "'".implode("','", array_map(['Friendica\Database\DBA', 'escape'], explode(",", str_replace(" ", "", Config::get('config', 'admin_email')))))."'"; $adminlist = DBA::select('user', ['uid', 'language', 'email'], ['`email` IN (%s)', $admin_mail_list]); // No valid result? if (!DBA::isResult($adminlist)) { Logger::log(sprintf('Cannot notify administrators about update_id=%d, error_message=%s', $update_id, $error_message), Logger::INFO); // Don't continue return; } // every admin could had different language foreach ($adminlist as $admin) { $lang = (($admin['language'])?$admin['language']:'en'); L10n::pushLang($lang); $preamble = deindent(L10n::t(" The friendica developers released update %s recently, but when I tried to install it, something went terribly wrong. This needs to be fixed soon and I can't do it alone. Please contact a friendica developer if you can not help me on your own. My database might be invalid.", $update_id)); $body = L10n::t("The error message is\n[pre]%s[/pre]", $error_message); notification([ 'uid' => $admin['uid'], 'type' => SYSTEM_EMAIL, 'to_email' => $admin['email'], 'preamble' => $preamble, 'body' => $body, 'language' => $lang] ); L10n::popLang(); } //try the logger Logger::log("CRITICAL: Database structure update failed: " . $error_message); } private static function updateSuccessfull($from_build, $to_build) { //send the administrators an e-mail $admin_mail_list = "'".implode("','", array_map(['Friendica\Database\DBA', 'escape'], explode(",", str_replace(" ", "", Config::get('config', 'admin_email')))))."'"; $adminlist = DBA::select('user', ['uid', 'language', 'email'], ['`email` IN (%s)', $admin_mail_list]); if (DBA::isResult($adminlist)) { // every admin could had different language foreach ($adminlist as $admin) { $lang = (($admin['language']) ? $admin['language'] : 'en'); L10n::pushLang($lang); $preamble = deindent(L10n::t(" The friendica database was successfully updated from %s to %s.", $from_build, $to_build)); notification([ 'uid' => $admin['uid'], 'type' => SYSTEM_EMAIL, 'to_email' => $admin['email'], 'preamble' => $preamble, 'body' => $preamble, 'language' => $lang] ); L10n::popLang(); } } //try the logger Logger::log("Database structure update successful.", Logger::TRACE); } }