src/Module/Admin/Federation.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\Renderer;
  25 use Friendica\Database\DBA;
  26 use Friendica\DI;
  27 use Friendica\Module\BaseAdmin;
  28
  29 class Federation extends BaseAdmin
  30 {
  31         public static function content(array $parameters = [])
  32         {
  33                 parent::content($parameters);
  34
  35                 // get counts on active federation systems this node is knowing
  36                 // We list the more common systems by name. The rest is counted as "other"
  37                 $systems = [
  38                         'friendica'   => ['name' => 'Friendica', 'color' => '#ffc018'], // orange from the logo
  39                         'diaspora'    => ['name' => 'Diaspora', 'color' => '#a1a1a1'], // logo is black and white, makes a gray
  40                         'funkwhale'   => ['name' => 'Funkwhale', 'color' => '#4082B4'], // From the homepage
  41                         'gnusocial'   => ['name' => 'GNU Social/Statusnet', 'color' => '#a22430'], // dark red from the logo
  42                         'hubzilla'    => ['name' => 'Hubzilla/Red Matrix', 'color' => '#43488a'], // blue from the logo
  43                         'mastodon'    => ['name' => 'Mastodon', 'color' => '#1a9df9'], // blue from the Mastodon logo
  44                         'misskey'     => ['name' => 'Misskey', 'color' => '#ccfefd'], // Font color of the homepage
  45                         'peertube'    => ['name' => 'Peertube', 'color' => '#ffad5c'], // One of the logo colors
  46                         'pixelfed'    => ['name' => 'Pixelfed', 'color' => '#11da47'], // One of the logo colors
  47                         'pleroma'     => ['name' => 'Pleroma', 'color' => '#E46F0F'], // Orange from the text that is used on Pleroma instances
  48                         'plume'       => ['name' => 'Plume', 'color' => '#7765e3'], // From the homepage
  49                         'socialhome'  => ['name' => 'SocialHome', 'color' => '#52056b'], // lilac from the Django Image used at the Socialhome homepage
  50                         'wordpress'   => ['name' => 'WordPress', 'color' => '#016087'], // Background color of the homepage
  51                         'writefreely' => ['name' => 'WriteFreely', 'color' => '#292929'], // Font color of the homepage
  52                         'other'       => ['name' => DI::l10n()->t('Other'), 'color' => '#F1007E'], // ActivityPub main color
  53                 ];
  54
  55                 $platforms = array_keys($systems);
  56
  57                 $counts = [];
  58                 foreach ($platforms as $platform) {
  59                         $counts[$platform] = [];
  60                 }
  61
  62                 $total = 0;
  63                 $users = 0;
  64
  65                 $gservers = DBA::p("SELECT COUNT(*) AS `total`, SUM(`registered-users`) AS `users`, `platform`,
  66                         ANY_VALUE(`network`) AS `network`, MAX(`version`) AS `version`
  67                         FROM `gserver` WHERE NOT `failed` GROUP BY `platform`");
  68                 while ($gserver = DBA::fetch($gservers)) {
  69                         $total += $gserver['total'];
  70                         $users += $gserver['users'];
  71
  72                         $versionCounts = [];
  73                         $versions = DBA::p("SELECT COUNT(*) AS `total`, `version` FROM `gserver`
  74                                 WHERE NOT `failed` AND `platform` = ?
  75                                 GROUP BY `version` ORDER BY `version`", $gserver['platform']);
  76                         while ($version = DBA::fetch($versions)) {
  77                                 $version['version'] = str_replace(["\n", "\r", "\t"], " ", $version['version']);
  78
  79                                 if (in_array($gserver['platform'], ['Red Matrix', 'redmatrix', 'red'])) {
  80                                         $version['version'] = 'Red ' . $version['version'];
  81                                 }
  82
  83                                 $versionCounts[] = $version;
  84                         }
  85                         DBA::close($versions);
  86
  87                         $platform = $gserver['platform'] = strtolower($gserver['platform']);
  88
  89                         if ($platform == 'friendika') {
  90                                 $platform = 'friendica';
  91                         } elseif (in_array($platform, ['red matrix', 'redmatrix', 'red'])) {
  92                                 $platform = 'hubzilla';
  93                         } elseif(stristr($platform, 'pleroma')) {
  94                                 $platform = 'pleroma';
  95                         } elseif(stristr($platform, 'statusnet')) {
  96                                 $platform = 'gnusocial';
  97                         } elseif(stristr($platform, 'wordpress')) {
  98                                 $platform = 'wordpress';
  99                         } elseif (!in_array($platform, $platforms)) {
 100                                 $platform = 'other';
 101                         }
 102
 103                         if ($platform != $gserver['platform']) {
 104                                 if ($platform == 'other') {
 105                                         $versionCounts = $counts[$platform][1] ?? [];
 106                                         $versionCounts[] = ['version' => $gserver['platform'] ?: DI::l10n()->t('unknown'), 'total' => $gserver['total']];
 107                                         $gserver['version'] = '';
 108                                 } else {
 109                                         $versionCounts = array_merge($versionCounts, $counts[$platform][1] ?? []);
 110                                 }
 111
 112                                 $gserver['platform'] = $platform;
 113                                 $gserver['total'] += $counts[$platform][0]['total'] ?? 0;
 114                                 $gserver['users'] += $counts[$platform][0]['users'] ?? 0;
 115                         }
 116
 117                         if ($platform == 'friendica') {
 118                                 $versionCounts = self::reformaFriendicaVersions($versionCounts);
 119                         } elseif ($platform == 'pleroma') {
 120                                 $versionCounts = self::reformaPleromaVersions($versionCounts);
 121                         } elseif ($platform == 'diaspora') {
 122                                 $versionCounts = self::reformaDiasporaVersions($versionCounts);
 123                         }
 124
 125                         $versionCounts = self::sortVersion($versionCounts);
 126
 127                         $gserver['platform'] = $systems[$platform]['name'];
 128
 129                         $counts[$platform] = [$gserver, $versionCounts, str_replace([' ', '%'], '', $platform), $systems[$platform]['color']];
 130                 }
 131                 DBA::close($gserver);
 132
 133                 // some helpful text
 134                 $intro = DI::l10n()->t('This page offers you some numbers to the known part of the federated social network your Friendica node is part of. These numbers are not complete but only reflect the part of the network your node is aware of.');
 135
 136                 // load the template, replace the macros and return the page content
 137                 $t = Renderer::getMarkupTemplate('admin/federation.tpl');
 138                 return Renderer::replaceMacros($t, [
 139                         '$title' => DI::l10n()->t('Administration'),
 140                         '$page' => DI::l10n()->t('Federation Statistics'),
 141                         '$intro' => $intro,
 142                         '$counts' => $counts,
 143                         '$version' => FRIENDICA_VERSION,
 144                         '$legendtext' => DI::l10n()->t('Currently this node is aware of %d nodes with %d registered users from the following platforms:', $total, $users),
 145                 ]);
 146         }
 147
 148         /**
 149          * early friendica versions have the format x.x.xxxx where xxxx is the
 150          * DB version stamp; those should be operated out and versions be combined
 151          *
 152          * @param array $versionCounts list of version numbers
 153          * @return array with cleaned version numbers
 154          */
 155         private static function reformaFriendicaVersions(array $versionCounts)
 156         {
 157                 $newV = [];
 158                 $newVv = [];
 159                 foreach ($versionCounts as $vv) {
 160                         $newVC = $vv['total'];
 161                         $newVV = $vv['version'];
 162                         $lastDot = strrpos($newVV, '.');
 163                         $len = strlen($newVV) - 1;
 164                         if (($lastDot == $len - 4) && (!strrpos($newVV, '-rc') == $len - 3)) {
 165                                 $newVV = substr($newVV, 0, $lastDot);
 166                         }
 167                         if (isset($newV[$newVV])) {
 168                                 $newV[$newVV] += $newVC;
 169                         } else {
 170                                 $newV[$newVV] = $newVC;
 171                         }
 172                 }
 173                 foreach ($newV as $key => $value) {
 174                         array_push($newVv, ['total' => $value, 'version' => $key]);
 175                 }
 176                 $versionCounts = $newVv;
 177
 178                 return $versionCounts;
 179         }
 180
 181         /**
 182          * in the DB the Diaspora versions have the format x.x.x.x-xx the last
 183          * part (-xx) should be removed to clean up the versions from the "head
 184          * commit" information and combined into a single entry for x.x.x.x
 185          *
 186          * @param array $versionCounts list of version numbers
 187          * @return array with cleaned version numbers
 188          */
 189         private static function reformaDiasporaVersions(array $versionCounts)
 190         {
 191                 $newV = [];
 192                 $newVv = [];
 193                 foreach ($versionCounts as $vv) {
 194                         $newVC = $vv['total'];
 195                         $newVV = $vv['version'];
 196                         $posDash = strpos($newVV, '-');
 197                         if ($posDash) {
 198                                 $newVV = substr($newVV, 0, $posDash);
 199                         }
 200                         if (isset($newV[$newVV])) {
 201                                 $newV[$newVV] += $newVC;
 202                         } else {
 203                                 $newV[$newVV] = $newVC;
 204                         }
 205                 }
 206                 foreach ($newV as $key => $value) {
 207                         array_push($newVv, ['total' => $value, 'version' => $key]);
 208                 }
 209                 $versionCounts = $newVv;
 210
 211                 return $versionCounts;
 212         }
 213
 214         /**
 215          * Clean up Pleroma version numbers
 216          *
 217          * @param array $versionCounts list of version numbers
 218          * @return array with cleaned version numbers
 219          */
 220         private static function reformaPleromaVersions(array $versionCounts)
 221         {
 222                 $compacted = [];
 223                 foreach ($versionCounts as $key => $value) {
 224                         $version = $versionCounts[$key]['version'];
 225                         $parts = explode(' ', trim($version));
 226                         do {
 227                                 $part = array_pop($parts);
 228                         } while (!empty($parts) && ((strlen($part) >= 40) || (strlen($part) <= 3)));
 229                         // only take the x.x.x part of the version, not the "release" after the dash
 230                         if (!empty($part) && strpos($part, '-')) {
 231                                 $part = explode('-', $part)[0];
 232                         }
 233                         if (!empty($part)) {
 234                                 if (empty($compacted[$part])) {
 235                                         $compacted[$part] = $versionCounts[$key]['total'];
 236                                 } else {
 237                                         $compacted[$part] += $versionCounts[$key]['total'];
 238                                 }
 239                         }
 240                 }
 241
 242                 $versionCounts = [];
 243                 foreach ($compacted as $version => $pl_total) {
 244                         $versionCounts[] = ['version' => $version, 'total' => $pl_total];
 245                 }
 246
 247                 return $versionCounts;
 248         }
 249
 250         /**
 251          * Reformat, sort and compact version numbers
 252          *
 253          * @param array $versionCounts list of version numbers
 254          * @return array with reformatted version numbers
 255          */
 256         private static function sortVersion(array $versionCounts)
 257         {
 258                 //
 259                 // clean up version numbers
 260                 //
 261                 // some platforms do not provide version information, add a unkown there
 262                 // to the version string for the displayed list.
 263                 foreach ($versionCounts as $key => $value) {
 264                         if ($versionCounts[$key]['version'] == '') {
 265                                 $versionCounts[$key] = ['total' => $versionCounts[$key]['total'], 'version' => DI::l10n()->t('unknown')];
 266                         }
 267                 }
 268
 269                 // Assure that the versions are sorted correctly
 270                 $v2 = [];
 271                 $versions = [];
 272                 foreach ($versionCounts as $vv) {
 273                         $version = trim(strip_tags($vv["version"]));
 274                         $v2[$version] = $vv;
 275                         $versions[] = $version;
 276                 }
 277
 278                 usort($versions, 'version_compare');
 279
 280                 $versionCounts = [];
 281                 foreach ($versions as $version) {
 282                         $versionCounts[] = $v2[$version];
 283                 }
 284
 285                 return $versionCounts;
 286         }
 287 }