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