src/Module/Admin/Summary.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2021, 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\Core\Addon;
  25 use Friendica\Core\Config\ValueObject\Cache;
  26 use Friendica\Core\Logger;
  27 use Friendica\Core\Renderer;
  28 use Friendica\Core\Update;
  29 use Friendica\Database\DBA;
  30 use Friendica\Database\DBStructure;
  31 use Friendica\DI;
  32 use Friendica\Core\Config\Factory\Config;
  33 use Friendica\Model\Register;
  34 use Friendica\Module\BaseAdmin;
  35 use Friendica\Network\HTTPException\ServiceUnavailableException;
  36 use Friendica\Util\DateTimeFormat;
  37
  38 class Summary extends BaseAdmin
  39 {
  40         public static function content()
  41         {
  42                 parent::content();
  43
  44                 $a = DI::app();
  45
  46                 // are there MyISAM tables in the DB? If so, trigger a warning message
  47                 $warningtext = [];
  48
  49                 $templateEngine = Renderer::getTemplateEngine();
  50                 $errors = [];
  51                 $templateEngine->testInstall($errors);
  52                 foreach ($errors as $error) {
  53                         $warningtext[] = DI::l10n()->t('Template engine (%s) error: %s', $templateEngine::$name, $error);
  54                 }
  55
  56                 if (DBA::count(['information_schema' => 'tables'], ['engine' => 'myisam', 'table_schema' => DBA::databaseName()])) {
  57                         $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');
  58                 }
  59
  60                 // are there InnoDB tables in Antelope in the DB? If so, trigger a warning message
  61                 if (DBA::count(['information_schema' => 'tables'], ['ENGINE' => 'InnoDB', 'ROW_FORMAT' => ['COMPACT', 'REDUNDANT'], 'table_schema' => DBA::databaseName()])) {
  62                         $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');
  63                 }
  64
  65                 // Avoid the database error 1615 "Prepared statement needs to be re-prepared", see https://github.com/friendica/friendica/issues/8550
  66                 if (!DI::config()->get('database', 'pdo_emulate_prepares')) {
  67                         $table_definition_cache = DBA::getVariable('table_definition_cache');
  68                         $table_open_cache = DBA::getVariable('table_open_cache');
  69                         if (!empty($table_definition_cache) && !empty($table_open_cache)) {
  70                                 $suggested_definition_cache = min(400 + round($table_open_cache / 2, 1), 2000);
  71                                 if ($suggested_definition_cache > $table_definition_cache) {
  72                                         $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');
  73                                 }
  74                         }
  75                 }
  76
  77                 // Check if github.com/friendica/stable/VERSION is higher then
  78                 // the local version of Friendica. Check is opt-in, source may be stable or develop branch
  79                 if (DI::config()->get('system', 'check_new_version_url', 'none') != 'none') {
  80                         $gitversion = DI::config()->get('system', 'git_friendica_version');
  81                         if (version_compare(FRIENDICA_VERSION, $gitversion) < 0) {
  82                                 $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', FRIENDICA_VERSION, $gitversion);
  83                         }
  84                 }
  85
  86                 if (DI::config()->get('system', 'dbupdate', DBStructure::UPDATE_NOT_CHECKED) == DBStructure::UPDATE_NOT_CHECKED) {
  87                         DBStructure::performUpdate();
  88                 }
  89
  90                 if (DI::config()->get('system', 'dbupdate') == DBStructure::UPDATE_FAILED) {
  91                         $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.');
  92                 }
  93
  94                 if (DI::config()->get('system', 'update') == Update::FAILED) {
  95                         $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.)');
  96                 }
  97
  98                 $last_worker_call = DI::config()->get('system', 'last_worker_execution', false);
  99                 if (!$last_worker_call) {
 100                         $warningtext[] = DI::l10n()->t('The worker was never executed. Please check your database structure!');
 101                 } elseif ((strtotime(DateTimeFormat::utcNow()) - strtotime($last_worker_call)) > 60 * 60) {
 102                         $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);
 103                 }
 104
 105                 // Legacy config file warning
 106                 if (file_exists('.htconfig.php')) {
 107                         $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()->get() . '/help/Config');
 108                 }
 109
 110                 if (file_exists('config/local.ini.php')) {
 111                         $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()->get() . '/help/Config');
 112                 }
 113
 114                 // Check server vitality
 115                 if (!self::checkSelfHostMeta()) {
 116                         $well_known = DI::baseUrl()->get() . '/.well-known/host-meta';
 117                         $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.',
 118                                 $well_known, $well_known, DI::baseUrl()->get() . '/help/Install');
 119                 }
 120
 121                 // Check logfile permission
 122                 if (DI::config()->get('system', 'debugging')) {
 123                         $file = DI::config()->get('system', 'logfile');
 124
 125                         $fileSystem = DI::fs();
 126
 127                         try {
 128                                 $stream = $fileSystem->createStream($file);
 129
 130                                 if (!isset($stream)) {
 131                                         throw new ServiceUnavailableException('Stream is null.');
 132                                 }
 133
 134                         } catch (\Throwable $exception) {
 135                                 $warningtext[] = DI::l10n()->t('The logfile \'%s\' is not usable. No logging possible (error: \'%s\')', $file, $exception->getMessage());
 136                         }
 137
 138                         $file = DI::config()->get('system', 'dlogfile');
 139
 140                         try {
 141                                 if (!empty($file)) {
 142                                         $stream = $fileSystem->createStream($file);
 143
 144                                         if (!isset($stream)) {
 145                                                 throw new ServiceUnavailableException('Stream is null.');
 146                                         }
 147                                 }
 148                         } catch (\Throwable $exception) {
 149                                 $warningtext[] = DI::l10n()->t('The debug logfile \'%s\' is not usable. No logging possible (error: \'%s\')', $file, $exception->getMessage());
 150                         }
 151                 }
 152
 153                 // check legacy basepath settings
 154                 $configLoader = (new Config())->createConfigFileLoader($a->getBasePath(), $_SERVER);
 155                 $configCache = new Cache();
 156                 $configLoader->setupCache($configCache);
 157                 $confBasepath = $configCache->get('system', 'basepath');
 158                 $currBasepath = DI::config()->get('system', 'basepath');
 159                 if ($confBasepath !== $currBasepath || !is_dir($currBasepath)) {
 160                         if (is_dir($confBasepath) && DI::config()->set('system', 'basepath', $confBasepath)) {
 161                                 DI::logger()->info('Friendica\'s system.basepath was updated successfully.', [
 162                                         'from' => $currBasepath,
 163                                         'to'   => $confBasepath,
 164                                 ]);
 165                                 $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.',
 166                                         $currBasepath,
 167                                         $confBasepath);
 168                         } elseif (!is_dir($currBasepath)) {
 169                                 DI::logger()->alert('Friendica\'s system.basepath is wrong.', [
 170                                         'from' => $currBasepath,
 171                                         'to'   => $confBasepath,
 172                                 ]);
 173                                 $warningtext[] = DI::l10n()->t('Friendica\'s current system.basepath \'%s\' is wrong and the config file \'%s\' isn\'t used.',
 174                                         $currBasepath,
 175                                         $confBasepath);
 176                         } else {
 177                                 DI::logger()->alert('Friendica\'s system.basepath is wrong.', [
 178                                         'from' => $currBasepath,
 179                                         'to'   => $confBasepath,
 180                                 ]);
 181                                 $warningtext[] = DI::l10n()->t('Friendica\'s current system.basepath \'%s\' is not equal to the config file \'%s\'. Please fix your configuration.',
 182                                         $currBasepath,
 183                                         $confBasepath);
 184                         }
 185                 }
 186
 187                 $accounts = [
 188                         [DI::l10n()->t('Normal Account'), 0],
 189                         [DI::l10n()->t('Automatic Follower Account'), 0],
 190                         [DI::l10n()->t('Public Forum Account'), 0],
 191                         [DI::l10n()->t('Automatic Friend Account'), 0],
 192                         [DI::l10n()->t('Blog Account'), 0],
 193                         [DI::l10n()->t('Private Forum Account'), 0]
 194                 ];
 195
 196                 $users = 0;
 197                 $pageFlagsCountStmt = DBA::p('SELECT `page-flags`, COUNT(`uid`) AS `count` FROM `user` WHERE `uid` != ? GROUP BY `page-flags`', 0);
 198                 while ($pageFlagsCount = DBA::fetch($pageFlagsCountStmt)) {
 199                         $accounts[$pageFlagsCount['page-flags']][1] = $pageFlagsCount['count'];
 200                         $users += $pageFlagsCount['count'];
 201                 }
 202                 DBA::close($pageFlagsCountStmt);
 203
 204                 Logger::debug('accounts', ['accounts' => $accounts]);
 205
 206                 $pending = Register::getPendingCount();
 207
 208                 $deferred = DBA::count('workerqueue', ['NOT `done` AND `retrial` > ?', 0]);
 209
 210                 $workerqueue = DBA::count('workerqueue', ['NOT `done` AND `retrial` = ?', 0]);
 211
 212                 // We can do better, but this is a quick queue status
 213                 $queues = ['label' => DI::l10n()->t('Message queues'), 'deferred' => $deferred, 'workerq' => $workerqueue];
 214
 215                 $variables = DBA::toArray(DBA::p('SHOW variables LIKE "max_allowed_packet"'));
 216                 $max_allowed_packet = $variables ? $variables[0]['Value'] : 0;
 217
 218                 $server_settings = [
 219                         'label' => DI::l10n()->t('Server Settings'),
 220                         'php' => [
 221                                 'upload_max_filesize' => ini_get('upload_max_filesize'),
 222                                 'post_max_size' => ini_get('post_max_size'),
 223                                 'memory_limit' => ini_get('memory_limit')
 224                         ],
 225                         'mysql' => [
 226                                 'max_allowed_packet' => $max_allowed_packet
 227                         ]
 228                 ];
 229
 230                 $t = Renderer::getMarkupTemplate('admin/summary.tpl');
 231                 return Renderer::replaceMacros($t, [
 232                         '$title' => DI::l10n()->t('Administration'),
 233                         '$page' => DI::l10n()->t('Summary'),
 234                         '$queues' => $queues,
 235                         '$users' => [DI::l10n()->t('Registered users'), $users],
 236                         '$accounts' => $accounts,
 237                         '$pending' => [DI::l10n()->t('Pending registrations'), $pending],
 238                         '$version' => [DI::l10n()->t('Version'), FRIENDICA_VERSION],
 239                         '$platform' => FRIENDICA_PLATFORM,
 240                         '$codename' => FRIENDICA_CODENAME,
 241                         '$build' => DI::config()->get('system', 'build'),
 242                         '$addons' => [DI::l10n()->t('Active addons'), Addon::getEnabledList()],
 243                         '$serversettings' => $server_settings,
 244                         '$warningtext' => $warningtext
 245                 ]);
 246         }
 247
 248         private static function checkSelfHostMeta()
 249         {
 250                 // Fetch the host-meta to check if this really is a vital server
 251                 return DI::httpClient()->get(DI::baseUrl()->get() . '/.well-known/host-meta')->isSuccess();
 252         }
 253
 254 }