3 namespace Friendica\Core;
5 use Friendica\Database\DBA;
6 use Friendica\Database\DBStructure;
7 use Friendica\Util\Strings;
15 * @brief Function to check if the Database structure needs an update.
17 * @param string $basePath The base path of this application
18 * @param boolean $via_worker boolean Is the check run via the worker?
19 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
21 public static function check($basePath, $via_worker)
23 if (!DBA::connected()) {
27 $build = Config::get('system', 'build');
30 Config::set('system', 'build', DB_UPDATE_VERSION - 1);
31 $build = DB_UPDATE_VERSION - 1;
34 // We don't support upgrading from very old versions anymore
35 if ($build < NEW_UPDATE_ROUTINE_VERSION) {
36 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.');
39 if ($build < DB_UPDATE_VERSION) {
41 // Calling the database update directly via the worker enables us to perform database changes to the workerqueue table itself.
42 // This is a fallback, since normally the database update will be performed by a worker job.
43 // This worker job doesn't work for changes to the "workerqueue" table itself.
46 Worker::add(PRIORITY_CRITICAL, 'DBUpdate');
52 * Automatic database updates
54 * @param string $basePath The base path of this application
55 * @param bool $force Force the Update-Check even if the database version doesn't match
56 * @param bool $override Overrides any running/stuck updates
57 * @param bool $verbose Run the Update-Check verbose
58 * @param bool $sendMail Sends a Mail to the administrator in case of success/failure
60 * @return string Empty string if the update is successful, error messages otherwise
61 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
63 public static function run($basePath, $force = false, $override = false, $verbose = false, $sendMail = true)
65 // In force mode, we release the dbupdate lock first
66 // Necessary in case of an stuck update
68 Lock::release('dbupdate', true);
71 $build = Config::get('system', 'build', null, true);
73 if (empty($build) || ($build > DB_UPDATE_VERSION)) {
74 $build = DB_UPDATE_VERSION - 1;
75 Config::set('system', 'build', $build);
78 if ($build != DB_UPDATE_VERSION || $force) {
79 require_once 'update.php';
81 $stored = intval($build);
82 $current = intval(DB_UPDATE_VERSION);
83 if ($stored < $current || $force) {
84 Config::load('database');
86 Logger::info('Update starting.', ['from' => $stored, 'to' => $current]);
88 // Compare the current structure with the defined structure
89 // If the Lock is acquired, never release it automatically to avoid double updates
90 if (Lock::acquire('dbupdate', 120, Cache::INFINITE)) {
92 // Checks if the build changed during Lock acquiring (so no double update occurs)
93 $retryBuild = Config::get('system', 'build', null, true);
94 if ($retryBuild !== $build) {
95 Logger::info('Update already done.', ['from' => $stored, 'to' => $current]);
96 Lock::release('dbupdate');
100 // run the pre_update_nnnn functions in update.php
101 for ($x = $stored + 1; $x <= $current; $x++) {
102 $r = self::runUpdateFunction($x, 'pre_update');
108 // update the structure in one call
109 $retval = DBStructure::update($basePath, $verbose, true);
110 if (!empty($retval)) {
117 Logger::error('Update ERROR.', ['from' => $stored, 'to' => $current, 'retval' => $retval]);
118 Lock::release('dbupdate');
121 Config::set('database', 'last_successful_update', $current);
122 Config::set('database', 'last_successful_update_time', time());
123 Logger::info('Update finished.', ['from' => $stored, 'to' => $current]);
126 // run the update_nnnn functions in update.php
127 for ($x = $stored + 1; $x <= $current; $x++) {
128 $r = self::runUpdateFunction($x, 'update');
134 Logger::notice('Update success.', ['from' => $stored, 'to' => $current]);
136 self::updateSuccessfull($stored, $current);
139 Lock::release('dbupdate');
148 * Executes a specific update function
150 * @param int $x the DB version number of the function
151 * @param string $prefix the prefix of the function (update, pre_update)
153 * @return bool true, if the update function worked
154 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
156 public static function runUpdateFunction($x, $prefix)
158 $funcname = $prefix . '_' . $x;
160 Logger::info('Update function start.', ['function' => $funcname]);
162 if (function_exists($funcname)) {
163 // There could be a lot of processes running or about to run.
164 // We want exactly one process to run the update command.
165 // So store the fact that we're taking responsibility
166 // after first checking to see if somebody else already has.
167 // If the update fails or times-out completely you may need to
168 // delete the config entry to try again.
170 if (Lock::acquire('dbupdate_function', 120,Cache::INFINITE)) {
172 // call the specific update
173 $retval = $funcname();
176 //send the administrator an e-mail
179 L10n::t('Update %s failed. See error logs.', $x)
181 Logger::error('Update function ERROR.', ['function' => $funcname, 'retval' => $retval]);
182 Lock::release('dbupdate_function');
185 Config::set('database', 'last_successful_update_function', $funcname);
186 Config::set('database', 'last_successful_update_function_time', time());
188 if ($prefix == 'update') {
189 Config::set('system', 'build', $x);
192 Lock::release('dbupdate_function');
193 Logger::info('Update function finished.', ['function' => $funcname]);
198 Logger::info('Update function skipped.', ['function' => $funcname]);
200 Config::set('database', 'last_successful_update_function', $funcname);
201 Config::set('database', 'last_successful_update_function_time', time());
203 if ($prefix == 'update') {
204 Config::set('system', 'build', $x);
212 * send the email and do what is needed to do on update fails
214 * @param int $update_id number of failed update
215 * @param string $error_message error message
216 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
218 private static function updateFailed($update_id, $error_message) {
219 //send the administrators an e-mail
220 $condition = ['email' => explode(",", str_replace(" ", "", Config::get('config', 'admin_email'))), 'parent-uid' => 0];
221 $adminlist = DBA::select('user', ['uid', 'language', 'email'], $condition, ['order' => ['uid']]);
224 if (!DBA::isResult($adminlist)) {
225 Logger::warning('Cannot notify administrators .', ['update' => $update_id, 'message' => $error_message]);
233 // every admin could had different language
234 while ($admin = DBA::fetch($adminlist)) {
235 if (in_array($admin['email'], $sent)) {
238 $sent[] = $admin['email'];
240 $lang = (($admin['language'])?$admin['language']:'en');
241 L10n::pushLang($lang);
243 $preamble = Strings::deindent(L10n::t("
244 The friendica developers released update %s recently,
245 but when I tried to install it, something went terribly wrong.
246 This needs to be fixed soon and I can't do it alone. Please contact a
247 friendica developer if you can not help me on your own. My database might be invalid.",
249 $body = L10n::t("The error message is\n[pre]%s[/pre]", $error_message);
252 'uid' => $admin['uid'],
253 'type' => SYSTEM_EMAIL,
254 'to_email' => $admin['email'],
255 'preamble' => $preamble,
263 Logger::alert('Database structure update FAILED.', ['error' => $error_message]);
266 private static function updateSuccessfull($from_build, $to_build)
268 //send the administrators an e-mail
269 $condition = ['email' => explode(",", str_replace(" ", "", Config::get('config', 'admin_email'))), 'parent-uid' => 0];
270 $adminlist = DBA::select('user', ['uid', 'language', 'email'], $condition, ['order' => ['uid']]);
272 if (DBA::isResult($adminlist)) {
275 // every admin could had different language
276 while ($admin = DBA::fetch($adminlist)) {
277 if (in_array($admin['email'], $sent)) {
280 $sent[] = $admin['email'];
282 $lang = (($admin['language']) ? $admin['language'] : 'en');
283 L10n::pushLang($lang);
285 $preamble = Strings::deindent(L10n::t("
286 The friendica database was successfully updated from %s to %s.",
287 $from_build, $to_build));
290 'uid' => $admin['uid'],
291 'type' => SYSTEM_EMAIL,
292 'to_email' => $admin['email'],
293 'preamble' => $preamble,
302 Logger::debug('Database structure update successful.');