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');
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::log('Update from \'' . $stored . '\' to \'' . $current . '\' - starting', Logger::DEBUG);
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 // run the pre_update_nnnn functions in update.php
93 for ($x = $stored + 1; $x <= $current; $x++) {
94 $r = self::runUpdateFunction($x, 'pre_update');
100 // update the structure in one call
101 $retval = DBStructure::update($basePath, $verbose, true);
102 if (!empty($retval)) {
109 Logger::log('ERROR: Update from \'' . $stored . '\' to \'' . $current . '\' - failed: ' - $retval, Logger::ALL);
110 Lock::release('dbupdate');
113 Config::set('database', 'last_successful_update', $current);
114 Config::set('database', 'last_successful_update_time', time());
115 Logger::log('Update from \'' . $stored . '\' to \'' . $current . '\' - finished', Logger::DEBUG);
118 // run the update_nnnn functions in update.php
119 for ($x = $stored + 1; $x <= $current; $x++) {
120 $r = self::runUpdateFunction($x, 'update');
126 Logger::log('Update from \'' . $stored . '\' to \'' . $current . '\' - successful', Logger::DEBUG);
128 self::updateSuccessfull($stored, $current);
131 Lock::release('dbupdate');
140 * Executes a specific update function
142 * @param int $x the DB version number of the function
143 * @param string $prefix the prefix of the function (update, pre_update)
145 * @return bool true, if the update function worked
146 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
148 public static function runUpdateFunction($x, $prefix)
150 $funcname = $prefix . '_' . $x;
152 Logger::log('Update function \'' . $funcname . '\' - start', Logger::DEBUG);
154 if (function_exists($funcname)) {
155 // There could be a lot of processes running or about to run.
156 // We want exactly one process to run the update command.
157 // So store the fact that we're taking responsibility
158 // after first checking to see if somebody else already has.
159 // If the update fails or times-out completely you may need to
160 // delete the config entry to try again.
162 if (Lock::acquire('dbupdate_function', 120,Cache::INFINITE)) {
164 // call the specific update
165 $retval = $funcname();
168 //send the administrator an e-mail
171 L10n::t('Update %s failed. See error logs.', $x)
173 Logger::log('ERROR: Update function \'' . $funcname . '\' - failed: ' . $retval, Logger::ALL);
174 Lock::release('dbupdate_function');
177 Config::set('database', 'last_successful_update_function', $funcname);
178 Config::set('database', 'last_successful_update_function_time', time());
180 if ($prefix == 'update') {
181 Config::set('system', 'build', $x);
184 Lock::release('dbupdate_function');
185 Logger::log('Update function \'' . $funcname . '\' - finished', Logger::DEBUG);
190 Logger::log('Skipping \'' . $funcname . '\' without executing', Logger::DEBUG);
192 Config::set('database', 'last_successful_update_function', $funcname);
193 Config::set('database', 'last_successful_update_function_time', time());
195 if ($prefix == 'update') {
196 Config::set('system', 'build', $x);
204 * send the email and do what is needed to do on update fails
206 * @param int $update_id number of failed update
207 * @param string $error_message error message
208 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
210 private static function updateFailed($update_id, $error_message) {
211 //send the administrators an e-mail
212 $adminlist = DBA::select('user', ['uid', 'language', 'email'], ['email' => explode(",", str_replace(" ", "", Config::get('config', 'admin_email')))]);
215 if (!DBA::isResult($adminlist)) {
216 Logger::log(sprintf('Cannot notify administrators about update_id=%d, error_message=%s', $update_id, $error_message), Logger::INFO);
222 // every admin could had different language
223 foreach ($adminlist as $admin) {
224 $lang = (($admin['language'])?$admin['language']:'en');
225 L10n::pushLang($lang);
227 $preamble = Strings::deindent(L10n::t("
228 The friendica developers released update %s recently,
229 but when I tried to install it, something went terribly wrong.
230 This needs to be fixed soon and I can't do it alone. Please contact a
231 friendica developer if you can not help me on your own. My database might be invalid.",
233 $body = L10n::t("The error message is\n[pre]%s[/pre]", $error_message);
236 'uid' => $admin['uid'],
237 'type' => SYSTEM_EMAIL,
238 'to_email' => $admin['email'],
239 'preamble' => $preamble,
247 Logger::log("CRITICAL: Database structure update failed: " . $error_message);
250 private static function updateSuccessfull($from_build, $to_build)
252 //send the administrators an e-mail
253 $adminlist = DBA::select('user', ['uid', 'language', 'email'], ['email' => explode(",", str_replace(" ", "", Config::get('config', 'admin_email')))]);
255 if (DBA::isResult($adminlist)) {
256 // every admin could had different language
257 foreach ($adminlist as $admin) {
258 $lang = (($admin['language']) ? $admin['language'] : 'en');
259 L10n::pushLang($lang);
261 $preamble = Strings::deindent(L10n::t("
262 The friendica database was successfully updated from %s to %s.",
263 $from_build, $to_build));
266 'uid' => $admin['uid'],
267 'type' => SYSTEM_EMAIL,
268 'to_email' => $admin['email'],
269 'preamble' => $preamble,
278 Logger::log("Database structure update successful.", Logger::TRACE);