namespace Friendica\Core;
+use Friendica\App;
+use Friendica\Core\Config\Cache\IConfigCache;
use Friendica\Database\DBA;
use Friendica\Database\DBStructure;
+use Friendica\Util\BasePath;
+use Friendica\Util\Config\ConfigFileLoader;
+use Friendica\Util\Config\ConfigFileSaver;
use Friendica\Util\Strings;
class Update
/**
* @brief Function to check if the Database structure needs an update.
*
- * @param string $basePath The base path of this application
- * @param boolean $via_worker boolean Is the check run via the worker?
+ * @param string $basePath The base path of this application
+ * @param boolean $via_worker Is the check run via the worker?
+ * @param App\Mode $mode The current app mode
+ *
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public static function check($basePath, $via_worker)
+ public static function check($basePath, $via_worker, App\Mode $mode)
{
if (!DBA::connected()) {
return;
}
+ // Check if the config files are set correctly
+ self::checkConfigFile($basePath, $mode);
+
+ // Don't check the status if the last update was failed
+ if (Config::get('system', 'update', Update::SUCCESS, true) == Update::FAILED) {
+ return;
+ }
+
$build = Config::get('system', 'build');
if (empty($build)) {
}
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) {
+ if ($via_worker) {
+ // Calling the database update directly via the worker enables us to perform database changes to the workerqueue table itself.
+ // This is a fallback, since normally the database update will be performed by a worker job.
+ // This worker job doesn't work for changes to the "workerqueue" table itself.
self::run($basePath);
+ } else {
+ Worker::add(PRIORITY_CRITICAL, 'DBUpdate');
}
}
}
* Automatic database updates
*
* @param string $basePath The base path of this application
- * @param bool $force Force the Update-Check even if the lock is set
+ * @param bool $force Force the Update-Check even if the database version doesn't match
+ * @param bool $override Overrides any running/stuck updates
* @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
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- public static function run($basePath, $force = false, $verbose = false, $sendMail = true)
+ public static function run($basePath, $force = false, $override = 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');
+ if ($override) {
+ Lock::release('dbupdate', true);
}
- $build = Config::get('system', 'build');
+ $build = Config::get('system', 'build', null, true);
if (empty($build) || ($build > DB_UPDATE_VERSION)) {
$build = DB_UPDATE_VERSION - 1;
Config::set('system', 'build', $build);
}
- if ($build != DB_UPDATE_VERSION) {
+ if ($build != DB_UPDATE_VERSION || $force) {
require_once 'update.php';
$stored = intval($build);
$current = intval(DB_UPDATE_VERSION);
- if ($stored < $current) {
+ if ($stored < $current || $force) {
Config::load('database');
- Logger::log('Update from \'' . $stored . '\' to \'' . $current . '\' - starting', Logger::DEBUG);
+ Logger::info('Update starting.', ['from' => $stored, 'to' => $current]);
// 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)) {
+ // Checks if the build changed during Lock acquiring (so no double update occurs)
+ $retryBuild = Config::get('system', 'build', null, true);
+ if ($retryBuild !== $build) {
+ Logger::info('Update already done.', ['from' => $stored, 'to' => $current]);
+ Lock::release('dbupdate');
+ return '';
+ }
+
// 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;
+ Config::set('system', 'update', Update::FAILED);
+ Lock::release('dbupdate');
+ return $r;
}
}
$retval
);
}
- Logger::log('ERROR: Update from \'' . $stored . '\' to \'' . $current . '\' - failed: ' - $retval, Logger::ALL);
+ Logger::error('Update ERROR.', ['from' => $stored, 'to' => $current, 'retval' => $retval]);
+ Config::set('system', 'update', Update::FAILED);
Lock::release('dbupdate');
return $retval;
} else {
Config::set('database', 'last_successful_update', $current);
Config::set('database', 'last_successful_update_time', time());
- Logger::log('Update from \'' . $stored . '\' to \'' . $current . '\' - finished', Logger::DEBUG);
+ Logger::info('Update finished.', ['from' => $stored, 'to' => $current]);
}
// run the update_nnnn functions in update.php
for ($x = $stored + 1; $x <= $current; $x++) {
$r = self::runUpdateFunction($x, 'update');
if (!$r) {
- break;
+ Config::set('system', 'update', Update::FAILED);
+ Lock::release('dbupdate');
+ return $r;
}
}
- Logger::log('Update from \'' . $stored . '\' to \'' . $current . '\' - successful', Logger::DEBUG);
+ Logger::notice('Update success.', ['from' => $stored, 'to' => $current]);
if ($sendMail) {
self::updateSuccessfull($stored, $current);
}
+ Config::set('system', 'update', Update::SUCCESS);
Lock::release('dbupdate');
}
}
- } elseif ($force) {
- DBStructure::update($basePath, $verbose, true);
}
return '';
{
$funcname = $prefix . '_' . $x;
- Logger::log('Update function \'' . $funcname . '\' - start', Logger::DEBUG);
+ Logger::info('Update function start.', ['function' => $funcname]);
if (function_exists($funcname)) {
// There could be a lot of processes running or about to run.
$x,
L10n::t('Update %s failed. See error logs.', $x)
);
- Logger::log('ERROR: Update function \'' . $funcname . '\' - failed: ' . $retval, Logger::ALL);
+ Logger::error('Update function ERROR.', ['function' => $funcname, 'retval' => $retval]);
Lock::release('dbupdate_function');
return false;
} else {
}
Lock::release('dbupdate_function');
- Logger::log('Update function \'' . $funcname . '\' - finished', Logger::DEBUG);
+ Logger::info('Update function finished.', ['function' => $funcname]);
return true;
}
}
} else {
- Logger::log('Skipping \'' . $funcname . '\' without executing', Logger::DEBUG);
+ Logger::info('Update function skipped.', ['function' => $funcname]);
Config::set('database', 'last_successful_update_function', $funcname);
Config::set('database', 'last_successful_update_function_time', time());
}
}
+ /**
+ * Checks the config settings and saves given config values into the config file
+ *
+ * @param string $basePath The basepath of Friendica
+ * @param App\Mode $$mode The current App mode
+ *
+ * @return bool True, if something has been saved
+ */
+ public static function checkConfigFile($basePath, App\Mode $mode)
+ {
+ if (empty($basePath)) {
+ $basePath = BasePath::create(dirname(__DIR__, 2));
+ }
+
+ $config = [
+ 'config' => [
+ 'hostname' => [
+ 'allowEmpty' => false,
+ 'default' => '',
+ ],
+ ],
+ 'system' => [
+ 'basepath' => [
+ 'allowEmpty' => false,
+ 'default' => $basePath,
+ ],
+ ]
+ ];
+
+ $configFileLoader = new ConfigFileLoader($basePath, $mode);
+ $configCache = new Config\Cache\ConfigCache();
+ $configFileLoader->setupCache($configCache, true);
+
+ // checks if something is to update, otherwise skip this function at all
+ $missingConfig = $configCache->keyDiff($config);
+ if (empty($missingConfig)) {
+ return true;
+ }
+
+ // We just want one update process
+ if (Lock::acquire('config_update')) {
+ $configFileSaver = new ConfigFileSaver($basePath);
+
+ $updated = false;
+ $toDelete = [];
+
+ foreach ($missingConfig as $category => $keys) {
+ foreach ($keys as $key => $value) {
+ if (self::updateConfigEntry($configCache, $configFileSaver, $category, $key, $value['allowEmpty'], $value['default'])) {
+ $toDelete[] = ['cat' => $category, 'key' => $key];
+ $updated = true;
+ };
+ }
+ }
+
+ // In case there is nothing to do, skip the update
+ if (!$updated) {
+ Lock::release('config_update');
+ return true;
+ }
+
+ if (!$configFileSaver->saveToConfigFile()) {
+ Logger::alert('Config entry update failed - maybe wrong permission?');
+ Lock::release('config_update');
+ return false;
+ }
+
+ // After the successful save, remove the db values
+ foreach ($toDelete as $delete) {
+ DBA::delete('config', ['cat' => $delete['cat'], 'k' => $delete['key']]);
+ }
+
+ Lock::release('config_update');
+ }
+
+ return true;
+ }
+
+ /**
+ * Adds a value to the ConfigFileSave in case it isn't already updated
+ *
+ * @param IConfigCache $configCache The cached config file
+ * @param ConfigFileSaver $configFileSaver The config file saver
+ * @param string $cat The config category
+ * @param string $key The config key
+ * @param bool $allowEmpty If true, empty values are valid (Default there has to be a variable)
+ * @param string $default A default value, if none of the settings are valid
+ *
+ * @return boolean True, if a value was updated
+ *
+ * @throws \Exception if DBA or Logger doesn't work
+ */
+ private static function updateConfigEntry(
+ IConfigCache $configCache,
+ ConfigFileSaver $configFileSaver,
+ $cat,
+ $key,
+ $allowEmpty = false,
+ $default = '')
+ {
+
+ // check if the config file differs from the whole configuration (= The db contains other values)
+ $fileValue = $configCache->get($cat, $key);
+ $dbConfig = DBA::selectFirst('config', ['v'], ['cat' => $cat, 'k' => $key]);
+
+ if (DBA::isResult($dbConfig)) {
+ $dbValue = $dbConfig['v'];
+ } else {
+ $dbValue = null;
+ }
+
+ // If the db contains a config value, check it
+ if ((
+ ($allowEmpty && isset($dbValue)) ||
+ (!$allowEmpty && !empty($dbValue))
+ ) &&
+ $fileValue !== $dbValue) {
+ Logger::info('Difference in config found', ['cat' => $cat, 'key' => $key, 'file' => $fileValue, 'db' => $dbValue]);
+ $configFileSaver->addConfigValue($cat, $key, $dbValue);
+ return true;
+
+ // If both config values are not set, use the default value
+ } elseif (
+ ($allowEmpty && !isset($fileValue) && !isset($dbValue)) ||
+ (!$allowEmpty && empty($fileValue) && empty($dbValue) && !empty($default))) {
+
+ Logger::info('Using default for config', ['cat' => $cat, 'key' => $key, 'value' => $default]);
+ $configFileSaver->addConfigValue($cat, $key, $default);
+ return true;
+
+ // If either the file config value isn't empty or the db value is the same as the
+ // file config value, skip it
+ } else {
+ Logger::debug('No Difference in config found', ['cat' => $cat, 'key' => $key, 'value' => $fileValue, 'db' => $dbValue]);
+ return false;
+ }
+ }
+
/**
* send the email and do what is needed to do on update fails
*
*/
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]);
+ $condition = ['email' => explode(",", str_replace(" ", "", Config::get('config', 'admin_email'))), 'parent-uid' => 0];
+ $adminlist = DBA::select('user', ['uid', 'language', 'email'], $condition, ['order' => ['uid']]);
// 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);
+ Logger::warning('Cannot notify administrators .', ['update' => $update_id, 'message' => $error_message]);
// Don't continue
return;
}
+ $sent = [];
+
// every admin could had different language
- foreach ($adminlist as $admin) {
+ while ($admin = DBA::fetch($adminlist)) {
+ if (in_array($admin['email'], $sent)) {
+ continue;
+ }
+ $sent[] = $admin['email'];
+
$lang = (($admin['language'])?$admin['language']:'en');
L10n::pushLang($lang);
}
//try the logger
- Logger::log("CRITICAL: Database structure update failed: " . $error_message);
+ Logger::alert('Database structure update FAILED.', ['error' => $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]);
+ $condition = ['email' => explode(",", str_replace(" ", "", Config::get('config', 'admin_email'))), 'parent-uid' => 0];
+ $adminlist = DBA::select('user', ['uid', 'language', 'email'], $condition, ['order' => ['uid']]);
if (DBA::isResult($adminlist)) {
+ $sent = [];
+
// every admin could had different language
- foreach ($adminlist as $admin) {
+ while ($admin = DBA::fetch($adminlist)) {
+ if (in_array($admin['email'], $sent)) {
+ continue;
+ }
+ $sent[] = $admin['email'];
+
$lang = (($admin['language']) ? $admin['language'] : 'en');
L10n::pushLang($lang);
}
//try the logger
- Logger::log("Database structure update successful.", Logger::TRACE);
+ Logger::debug('Database structure update successful.');
}
}
projects / friendica.git / blobdiff