3 namespace Friendica\Core;
6 use Friendica\Core\Config\Cache\IConfigCache;
7 use Friendica\Database\DBA;
8 use Friendica\Database\DBStructure;
9 use Friendica\Util\BasePath;
10 use Friendica\Util\Config\ConfigFileLoader;
11 use Friendica\Util\Config\ConfigFileSaver;
12 use Friendica\Util\Strings;
20 * @brief Function to check if the Database structure needs an update.
22 * @param string $basePath The base path of this application
23 * @param boolean $via_worker boolean Is the check run via the worker?
24 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
26 public static function check($basePath, $via_worker)
28 if (!DBA::connected()) {
32 // Don't check the status if the last update was failed
33 if (Config::get('system', 'update', Update::SUCCESS, true) == Update::FAILED) {
37 $build = Config::get('system', 'build');
40 Config::set('system', 'build', DB_UPDATE_VERSION - 1);
41 $build = DB_UPDATE_VERSION - 1;
44 // We don't support upgrading from very old versions anymore
45 if ($build < NEW_UPDATE_ROUTINE_VERSION) {
46 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.');
49 if ($build < DB_UPDATE_VERSION) {
51 // Calling the database update directly via the worker enables us to perform database changes to the workerqueue table itself.
52 // This is a fallback, since normally the database update will be performed by a worker job.
53 // This worker job doesn't work for changes to the "workerqueue" table itself.
56 Worker::add(PRIORITY_CRITICAL, 'DBUpdate');
62 * Automatic database updates
64 * @param string $basePath The base path of this application
65 * @param bool $force Force the Update-Check even if the database version doesn't match
66 * @param bool $override Overrides any running/stuck updates
67 * @param bool $verbose Run the Update-Check verbose
68 * @param bool $sendMail Sends a Mail to the administrator in case of success/failure
70 * @return string Empty string if the update is successful, error messages otherwise
71 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
73 public static function run($basePath, $force = false, $override = false, $verbose = false, $sendMail = true)
75 // In force mode, we release the dbupdate lock first
76 // Necessary in case of an stuck update
78 Lock::release('dbupdate', true);
81 $build = Config::get('system', 'build', null, true);
83 if (empty($build) || ($build > DB_UPDATE_VERSION)) {
84 $build = DB_UPDATE_VERSION - 1;
85 Config::set('system', 'build', $build);
88 if ($build != DB_UPDATE_VERSION || $force) {
89 require_once 'update.php';
91 $stored = intval($build);
92 $current = intval(DB_UPDATE_VERSION);
93 if ($stored < $current || $force) {
94 Config::load('database');
96 Logger::info('Update starting.', ['from' => $stored, 'to' => $current]);
98 // Compare the current structure with the defined structure
99 // If the Lock is acquired, never release it automatically to avoid double updates
100 if (Lock::acquire('dbupdate', 120, Cache::INFINITE)) {
102 // Checks if the build changed during Lock acquiring (so no double update occurs)
103 $retryBuild = Config::get('system', 'build', null, true);
104 if ($retryBuild !== $build) {
105 Logger::info('Update already done.', ['from' => $stored, 'to' => $current]);
106 Lock::release('dbupdate');
110 // run the pre_update_nnnn functions in update.php
111 for ($x = $stored + 1; $x <= $current; $x++) {
112 $r = self::runUpdateFunction($x, 'pre_update');
114 Config::set('system', 'update', Update::FAILED);
115 Lock::release('dbupdate');
120 // update the structure in one call
121 $retval = DBStructure::update($basePath, $verbose, true);
122 if (!empty($retval)) {
129 Logger::error('Update ERROR.', ['from' => $stored, 'to' => $current, 'retval' => $retval]);
130 Config::set('system', 'update', Update::FAILED);
131 Lock::release('dbupdate');
134 Config::set('database', 'last_successful_update', $current);
135 Config::set('database', 'last_successful_update_time', time());
136 Logger::info('Update finished.', ['from' => $stored, 'to' => $current]);
139 // run the update_nnnn functions in update.php
140 for ($x = $stored + 1; $x <= $current; $x++) {
141 $r = self::runUpdateFunction($x, 'update');
143 Config::set('system', 'update', Update::FAILED);
144 Lock::release('dbupdate');
149 Logger::notice('Update success.', ['from' => $stored, 'to' => $current]);
151 self::updateSuccessfull($stored, $current);
154 Config::set('system', 'update', Update::SUCCESS);
155 Lock::release('dbupdate');
164 * Executes a specific update function
166 * @param int $x the DB version number of the function
167 * @param string $prefix the prefix of the function (update, pre_update)
169 * @return bool true, if the update function worked
170 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
172 public static function runUpdateFunction($x, $prefix)
174 $funcname = $prefix . '_' . $x;
176 Logger::info('Update function start.', ['function' => $funcname]);
178 if (function_exists($funcname)) {
179 // There could be a lot of processes running or about to run.
180 // We want exactly one process to run the update command.
181 // So store the fact that we're taking responsibility
182 // after first checking to see if somebody else already has.
183 // If the update fails or times-out completely you may need to
184 // delete the config entry to try again.
186 if (Lock::acquire('dbupdate_function', 120,Cache::INFINITE)) {
188 // call the specific update
189 $retval = $funcname();
192 //send the administrator an e-mail
195 L10n::t('Update %s failed. See error logs.', $x)
197 Logger::error('Update function ERROR.', ['function' => $funcname, 'retval' => $retval]);
198 Lock::release('dbupdate_function');
201 Config::set('database', 'last_successful_update_function', $funcname);
202 Config::set('database', 'last_successful_update_function_time', time());
204 if ($prefix == 'update') {
205 Config::set('system', 'build', $x);
208 Lock::release('dbupdate_function');
209 Logger::info('Update function finished.', ['function' => $funcname]);
214 Logger::info('Update function skipped.', ['function' => $funcname]);
216 Config::set('database', 'last_successful_update_function', $funcname);
217 Config::set('database', 'last_successful_update_function_time', time());
219 if ($prefix == 'update') {
220 Config::set('system', 'build', $x);
228 * Checks the config settings and saves given config values into the config file
230 * @param string $basePath The basepath of Friendica
231 * @param App\Mode $mode The Application mode
233 * @return bool True, if something has been saved
235 public static function saveConfigToFile($basePath, App\Mode $mode)
237 $configFileLoader = new ConfigFileLoader($basePath, $mode);
238 $configCache = new Config\Cache\ConfigCache();
239 $configFileLoader->setupCache($configCache, true);
240 $configFileSaver = new ConfigFileSaver($basePath);
244 if (self::updateConfigEntry($configCache, $configFileSaver,'config', 'hostname')) {
248 if (self::updateConfigEntry($configCache, $configFileSaver,'system', 'basepath', BasePath::create(dirname(__DIR__) . '/../'))) {
252 // In case there is nothing to do, skip the update
257 if (!$configFileSaver->saveToConfigFile()) {
258 Logger::alert('Config entry update failed - maybe wrong permission?');
262 DBA::delete('config', ['cat' => 'config', 'k' => 'hostname']);
263 DBA::delete('config', ['cat' => 'system', 'k' => 'basepath']);
269 * Adds a value to the ConfigFileSave in case it isn't already updated
271 * @param IConfigCache $configCache The cached config file
272 * @param ConfigFileSaver $configFileSaver The config file saver
273 * @param string $cat The config category
274 * @param string $key The config key
275 * @param string $default A default value, if none of the settings are valid
277 * @return boolean True, if a value was updated
279 * @throws \Exception if DBA or Logger doesn't work
281 private static function updateConfigEntry(IConfigCache $configCache, ConfigFileSaver $configFileSaver, $cat, $key, $default = '')
283 // check if the config file differs from the whole configuration (= The db contains other values)
284 $fileConfig = $configCache->get($cat, $key);
286 $savedConfig = DBA::selectFirst('config', ['v'], ['cat' => $cat, 'k' => $key]);
288 if (DBA::isResult($savedConfig)) {
289 $savedValue = $savedConfig['v'];
294 // If the db contains a config value, check it
295 if (isset($savedValue) && $fileConfig !== $savedValue) {
296 Logger::info('Difference in config found', ['cat' => $cat, 'key' => $key, 'file' => $fileConfig, 'saved' => $savedValue]);
297 $configFileSaver->addConfigValue($cat, $key, $savedValue);
300 // If both config values are not set, use the default value
301 } elseif (!isset($fileConfig) && !isset($savedValue)) {
302 Logger::info('Using default for config', ['cat' => $cat, 'key' => $key, 'value' => $default]);
303 $configFileSaver->addConfigValue($cat, $key, $default);
306 // If either the file config value isn't empty or the db value is the same as the
307 // file config value, skip it
309 Logger::info('No Difference in config found', ['cat' => $cat, 'key' => $key, 'value' => $fileConfig, 'saved' => $savedValue]);
315 * send the email and do what is needed to do on update fails
317 * @param int $update_id number of failed update
318 * @param string $error_message error message
319 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
321 private static function updateFailed($update_id, $error_message) {
322 //send the administrators an e-mail
323 $condition = ['email' => explode(",", str_replace(" ", "", Config::get('config', 'admin_email'))), 'parent-uid' => 0];
324 $adminlist = DBA::select('user', ['uid', 'language', 'email'], $condition, ['order' => ['uid']]);
327 if (!DBA::isResult($adminlist)) {
328 Logger::warning('Cannot notify administrators .', ['update' => $update_id, 'message' => $error_message]);
336 // every admin could had different language
337 while ($admin = DBA::fetch($adminlist)) {
338 if (in_array($admin['email'], $sent)) {
341 $sent[] = $admin['email'];
343 $lang = (($admin['language'])?$admin['language']:'en');
344 L10n::pushLang($lang);
346 $preamble = Strings::deindent(L10n::t("
347 The friendica developers released update %s recently,
348 but when I tried to install it, something went terribly wrong.
349 This needs to be fixed soon and I can't do it alone. Please contact a
350 friendica developer if you can not help me on your own. My database might be invalid.",
352 $body = L10n::t("The error message is\n[pre]%s[/pre]", $error_message);
355 'uid' => $admin['uid'],
356 'type' => SYSTEM_EMAIL,
357 'to_email' => $admin['email'],
358 'preamble' => $preamble,
366 Logger::alert('Database structure update FAILED.', ['error' => $error_message]);
369 private static function updateSuccessfull($from_build, $to_build)
371 //send the administrators an e-mail
372 $condition = ['email' => explode(",", str_replace(" ", "", Config::get('config', 'admin_email'))), 'parent-uid' => 0];
373 $adminlist = DBA::select('user', ['uid', 'language', 'email'], $condition, ['order' => ['uid']]);
375 if (DBA::isResult($adminlist)) {
378 // every admin could had different language
379 while ($admin = DBA::fetch($adminlist)) {
380 if (in_array($admin['email'], $sent)) {
383 $sent[] = $admin['email'];
385 $lang = (($admin['language']) ? $admin['language'] : 'en');
386 L10n::pushLang($lang);
388 $preamble = Strings::deindent(L10n::t("
389 The friendica database was successfully updated from %s to %s.",
390 $from_build, $to_build));
393 'uid' => $admin['uid'],
394 'type' => SYSTEM_EMAIL,
395 'to_email' => $admin['email'],
396 'preamble' => $preamble,
405 Logger::debug('Database structure update successful.');