src/Module/Admin/Summary.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Module\Admin;
  23
  24 use Friendica\App;
  25 use Friendica\Core\Addon;
  26 use Friendica\Core\Config\Util\ConfigFileManager;
  27 use Friendica\Core\Config\ValueObject\Cache;
  28 use Friendica\Core\Renderer;
  29 use Friendica\Core\Update;
  30 use Friendica\Database\DBA;
  31 use Friendica\Database\DBStructure;
  32 use Friendica\DI;
  33 use Friendica\Core\Config\Factory\Config;
  34 use Friendica\Module\BaseAdmin;
  35 use Friendica\Network\HTTPClient\Client\HttpClientAccept;
  36 use Friendica\Network\HTTPException\ServiceUnavailableException;
  37 use Friendica\Network\Probe;
  38 use Friendica\Util\DateTimeFormat;
  39
  40 class Summary extends BaseAdmin
  41 {
  42         protected function content(array $request = []): string
  43         {
  44                 parent::content();
  45
  46                 $a = DI::app();
  47
  48                 // are there MyISAM tables in the DB? If so, trigger a warning message
  49                 $warningtext = [];
  50
  51                 $templateEngine = Renderer::getTemplateEngine();
  52                 $errors = [];
  53                 $templateEngine->testInstall($errors);
  54                 foreach ($errors as $error) {
  55                         $warningtext[] = DI::l10n()->t('Template engine (%s) error: %s', $templateEngine::$name, $error);
  56                 }
  57
  58                 if (DBA::count('information_schema.tables', ['engine' => 'myisam', 'table_schema' => DBA::databaseName()])) {
  59                         $warningtext[] = DI::l10n()->t('Your DB still runs with MyISAM tables. You should change the engine type to InnoDB. As Friendica will use InnoDB only features in the future, you should change this! See <a href="%s">here</a> for a guide that may be helpful converting the table engines. You may also use the command <tt>php bin/console.php dbstructure toinnodb</tt> of your Friendica installation for an automatic conversion.<br />', 'https://dev.mysql.com/doc/refman/5.7/en/converting-tables-to-innodb.html');
  60                 }
  61
  62                 // are there InnoDB tables in Antelope in the DB? If so, trigger a warning message
  63                 if (DBA::count('information_schema.tables', ['ENGINE' => 'InnoDB', 'ROW_FORMAT' => ['COMPACT', 'REDUNDANT'], 'table_schema' => DBA::databaseName()])) {
  64                         $warningtext[] = DI::l10n()->t('Your DB still runs with InnoDB tables in the Antelope file format. You should change the file format to Barracuda. Friendica is using features that are not provided by the Antelope format. See <a href="%s">here</a> for a guide that may be helpful converting the table engines. You may also use the command <tt>php bin/console.php dbstructure toinnodb</tt> of your Friendica installation for an automatic conversion.<br />', 'https://dev.mysql.com/doc/refman/5.7/en/innodb-file-format.html');
  65                 }
  66
  67                 // Avoid the database error 1615 "Prepared statement needs to be re-prepared", see https://github.com/friendica/friendica/issues/8550
  68                 if (!DI::config()->get('database', 'pdo_emulate_prepares')) {
  69                         $table_definition_cache = DBA::getVariable('table_definition_cache');
  70                         $table_open_cache = DBA::getVariable('table_open_cache');
  71                         if (!empty($table_definition_cache) && !empty($table_open_cache)) {
  72                                 $suggested_definition_cache = min(400 + round($table_open_cache / 2, 1), 2000);
  73                                 if ($suggested_definition_cache > $table_definition_cache) {
  74                                         $warningtext[] = DI::l10n()->t('Your table_definition_cache is too low (%d). This can lead to the database error "Prepared statement needs to be re-prepared". Please set it at least to %d. See <a href="%s">here</a> for more information.<br />', $table_definition_cache, $suggested_definition_cache, 'https://dev.mysql.com/doc/refman/5.7/en/server-system-variables.html#sysvar_table_definition_cache');
  75                                 }
  76                         }
  77                 }
  78
  79                 // Check if github.com/friendica/stable/VERSION is higher then
  80                 // the local version of Friendica. Check is opt-in, source may be stable or develop branch
  81                 if (DI::config()->get('system', 'check_new_version_url', 'none') != 'none') {
  82                         $gitversion = DI::keyValue()->get('git_friendica_version') ?? '';
  83
  84                         if (version_compare(App::VERSION, $gitversion) < 0) {
  85                                 $warningtext[] = DI::l10n()->t('There is a new version of Friendica available for download. Your current version is %1$s, upstream version is %2$s', App::VERSION, $gitversion);
  86                         }
  87                 }
  88
  89                 if (DI::config()->get('system', 'dbupdate', DBStructure::UPDATE_NOT_CHECKED) == DBStructure::UPDATE_NOT_CHECKED) {
  90                         DBStructure::performUpdate();
  91                 }
  92
  93                 if (DI::config()->get('system', 'dbupdate') == DBStructure::UPDATE_FAILED) {
  94                         $warningtext[] = DI::l10n()->t('The database update failed. Please run "php bin/console.php dbstructure update" from the command line and have a look at the errors that might appear.');
  95                 }
  96
  97                 if (DI::config()->get('system', 'update') == Update::FAILED) {
  98                         $warningtext[] = DI::l10n()->t('The last update failed. Please run "php bin/console.php dbstructure update" from the command line and have a look at the errors that might appear. (Some of the errors are possibly inside the logfile.)');
  99                 }
 100
 101                 if (empty(DI::config()->get('system', 'url'))) {
 102                         $warningtext[] = DI::l10n()->t('The system.url entry is missing. This is a low level setting and can lead to unexpected behavior. Please add a valid entry as soon as possible in the config file or per console command!');
 103                 }
 104
 105                 $last_worker_call = DI::keyValue()->get('last_worker_execution');
 106                 if (!$last_worker_call) {
 107                         $warningtext[] = DI::l10n()->t('The worker was never executed. Please check your database structure!');
 108                 } elseif ((strtotime(DateTimeFormat::utcNow()) - strtotime($last_worker_call)) > 60 * 60) {
 109                         $warningtext[] = DI::l10n()->t('The last worker execution was on %s UTC. This is older than one hour. Please check your crontab settings.', $last_worker_call);
 110                 }
 111
 112                 // Legacy config file warning
 113                 if (file_exists('.htconfig.php')) {
 114                         $warningtext[] = DI::l10n()->t('Friendica\'s configuration now is stored in config/local.config.php, please copy config/local-sample.config.php and move your config from <code>.htconfig.php</code>. See <a href="%s">the Config help page</a> for help with the transition.', DI::baseUrl() . '/help/Config');
 115                 }
 116
 117                 if (file_exists('config/local.ini.php')) {
 118                         $warningtext[] = DI::l10n()->t('Friendica\'s configuration now is stored in config/local.config.php, please copy config/local-sample.config.php and move your config from <code>config/local.ini.php</code>. See <a href="%s">the Config help page</a> for help with the transition.', DI::baseUrl() . '/help/Config');
 119                 }
 120
 121                 // Check server vitality
 122                 if (!self::checkSelfHostMeta()) {
 123                         $well_known = DI::baseUrl() . Probe::HOST_META;
 124                         $warningtext[] = DI::l10n()->t('<a href="%s">%s</a> is not reachable on your system. This is a severe configuration issue that prevents server to server communication. See <a href="%s">the installation page</a> for help.',
 125                                 $well_known, $well_known, DI::baseUrl() . '/help/Install');
 126                 }
 127
 128                 // Check logfile permission
 129                 if (($return = DI::logCheck()->checkLogfile()) !== null) {
 130                         $warningtext[] = $return;
 131                 }
 132                 if (($return = DI::logCheck()->checkDebugLogfile()) !== null) {
 133                         $warningtext[] = $return;
 134                 }
 135
 136                 // check legacy basepath settings
 137                 $configLoader = (new Config())->createConfigFileManager($a->getBasePath(), $_SERVER);
 138                 $configCache = new Cache();
 139                 $configLoader->setupCache($configCache);
 140                 $confBasepath = $configCache->get('system', 'basepath');
 141                 $currBasepath = DI::config()->get('system', 'basepath');
 142                 if ($confBasepath !== $currBasepath || !is_dir($currBasepath)) {
 143                         if (is_dir($confBasepath) && DI::config()->set('system', 'basepath', $confBasepath)) {
 144                                 DI::logger()->info('Friendica\'s system.basepath was updated successfully.', [
 145                                         'from' => $currBasepath,
 146                                         'to'   => $confBasepath,
 147                                 ]);
 148                                 $warningtext[] = DI::l10n()->t('Friendica\'s system.basepath was updated from \'%s\' to \'%s\'. Please remove the system.basepath from your db to avoid differences.',
 149                                         $currBasepath,
 150                                         $confBasepath);
 151                         } elseif (!is_dir($currBasepath)) {
 152                                 DI::logger()->alert('Friendica\'s system.basepath is wrong.', [
 153                                         'from' => $currBasepath,
 154                                         'to'   => $confBasepath,
 155                                 ]);
 156                                 $warningtext[] = DI::l10n()->t('Friendica\'s current system.basepath \'%s\' is wrong and the config file \'%s\' isn\'t used.',
 157                                         $currBasepath,
 158                                         $confBasepath);
 159                         } else {
 160                                 DI::logger()->alert('Friendica\'s system.basepath is wrong.', [
 161                                         'from' => $currBasepath,
 162                                         'to'   => $confBasepath,
 163                                 ]);
 164                                 $warningtext[] = DI::l10n()->t('Friendica\'s current system.basepath \'%s\' is not equal to the config file \'%s\'. Please fix your configuration.',
 165                                         $currBasepath,
 166                                         $confBasepath);
 167                         }
 168                 }
 169
 170                 $deferred = DBA::count('workerqueue', ['NOT `done` AND `retrial` > ?', 0]);
 171
 172                 $workerqueue = DBA::count('workerqueue', ['NOT `done` AND `retrial` = ?', 0]);
 173
 174                 // We can do better, but this is a quick queue status
 175                 $queues = ['label' => DI::l10n()->t('Message queues'), 'deferred' => $deferred, 'workerq' => $workerqueue];
 176
 177                 $variables = DBA::toArray(DBA::p('SHOW variables LIKE "max_allowed_packet"'));
 178                 $max_allowed_packet = $variables ? $variables[0]['Value'] : 0;
 179
 180                 $server_settings = [
 181                         'label' => DI::l10n()->t('Server Settings'),
 182                         'php'   => [
 183                                 'version'             => phpversion(),
 184                                 'php.ini'             => php_ini_loaded_file(),
 185                                 'upload_max_filesize' => ini_get('upload_max_filesize'),
 186                                 'post_max_size'       => ini_get('post_max_size'),
 187                                 'memory_limit'        => ini_get('memory_limit')
 188                         ],
 189                         'mysql' => [
 190                                 'max_allowed_packet' => $max_allowed_packet
 191                         ]
 192                 ];
 193
 194                 $t = Renderer::getMarkupTemplate('admin/summary.tpl');
 195                 return Renderer::replaceMacros($t, [
 196                         '$title'          => DI::l10n()->t('Administration'),
 197                         '$page'           => DI::l10n()->t('Summary'),
 198                         '$queues'         => $queues,
 199                         '$version'        => [DI::l10n()->t('Version'), App::VERSION],
 200                         '$platform'       => App::PLATFORM,
 201                         '$codename'       => App::CODENAME,
 202                         '$build'          => DI::config()->get('system', 'build'),
 203                         '$addons'         => [DI::l10n()->t('Active addons'), Addon::getEnabledList()],
 204                         '$serversettings' => $server_settings,
 205                         '$warningtext'    => $warningtext,
 206                 ]);
 207         }
 208
 209         private static function checkSelfHostMeta()
 210         {
 211                 // Fetch the host-meta to check if this really is a vital server
 212                 return DI::httpClient()->get(DI::baseUrl() . Probe::HOST_META, HttpClientAccept::XRD_XML)->isSuccess();
 213         }
 214
 215 }