src/Module/Admin/Summary.php

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