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