src/Module/Admin/Federation.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2022, 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\Protocol;
  25 use Friendica\Core\Renderer;
  26 use Friendica\Database\DBA;
  27 use Friendica\DI;
  28 use Friendica\Model\GServer;
  29 use Friendica\Module\BaseAdmin;
  30
  31 class Federation extends BaseAdmin
  32 {
  33         protected function content(array $request = []): string
  34         {
  35                 parent::content();
  36
  37                 // get counts on active federation systems this node is knowing
  38                 // We list the more common systems by name. The rest is counted as "other"
  39                 $systems = [
  40                         'friendica'    => ['name' => 'Friendica', 'color' => '#ffc018'], // orange from the logo
  41                         'birdsitelive' => ['name' => 'BirdsiteLIVE', 'color' => '#1b6ec2'], // Color from the page
  42                         'bookwyrm'     => ['name' => 'BookWyrm', 'color' => '#00d1b2'], // Color from the page
  43                         'diaspora'     => ['name' => 'Diaspora', 'color' => '#a1a1a1'], // logo is black and white, makes a gray
  44                         'funkwhale'    => ['name' => 'Funkwhale', 'color' => '#4082B4'], // From the homepage
  45                         'gnusocial'    => ['name' => 'GNU Social/Statusnet', 'color' => '#a22430'], // dark red from the logo
  46                         'hometown'     => ['name' => 'Hometown', 'color' => '#1f70c1'], // Color from the Patreon page
  47                         'hubzilla'     => ['name' => 'Hubzilla/Red Matrix', 'color' => '#43488a'], // blue from the logo
  48                         'lemmy'        => ['name' => 'Lemmy', 'color' => '#00c853'], // Green from the page
  49                         'mastodon'     => ['name' => 'Mastodon', 'color' => '#1a9df9'], // blue from the Mastodon logo
  50                         'misskey'      => ['name' => 'Misskey', 'color' => '#ccfefd'], // Font color of the homepage
  51                         'mobilizon'    => ['name' => 'Mobilizon', 'color' => '#ffd599'], // Background color of parts of the homepage
  52                         'nextcloud'    => ['name' => 'Nextcloud', 'color' => '#1cafff'], // Logo color
  53                         'mistpark'     => ['name' => 'Nomad projects (Mistpark, Osada, Roadhouse, Zap)', 'color' => '#348a4a'], // Green like the Mistpark green
  54                         'peertube'     => ['name' => 'Peertube', 'color' => '#ffad5c'], // One of the logo colors
  55                         'pixelfed'     => ['name' => 'Pixelfed', 'color' => '#11da47'], // One of the logo colors
  56                         'pleroma'      => ['name' => 'Pleroma', 'color' => '#E46F0F'], // Orange from the text that is used on Pleroma instances
  57                         'plume'        => ['name' => 'Plume', 'color' => '#7765e3'], // From the homepage
  58                         'relay'        => ['name' => 'ActivityPub Relay', 'color' => '#888888'], // Grey like the second color of the ActivityPub logo
  59                         'socialhome'   => ['name' => 'SocialHome', 'color' => '#52056b'], // lilac from the Django Image used at the Socialhome homepage
  60                         'wordpress'    => ['name' => 'WordPress', 'color' => '#016087'], // Background color of the homepage
  61                         'write.as'     => ['name' => 'Write.as', 'color' => '#00ace3'], // Border color of the homepage
  62                         'writefreely'  => ['name' => 'WriteFreely', 'color' => '#292929'], // Font color of the homepage
  63                         'other'        => ['name' => DI::l10n()->t('Other'), 'color' => '#F1007E'], // ActivityPub main color
  64                 ];
  65
  66                 $platforms = array_keys($systems);
  67
  68                 $counts = [];
  69                 foreach ($platforms as $platform) {
  70                         $counts[$platform] = [];
  71                 }
  72
  73                 $total    = 0;
  74                 $users    = 0;
  75                 $month    = 0;
  76                 $halfyear = 0;
  77                 $posts    = 0;
  78
  79                 $gservers = DBA::p("SELECT COUNT(*) AS `total`, SUM(`registered-users`) AS `users`,
  80                         SUM(IFNULL(`local-posts`, 0) + IFNULL(`local-comments`, 0)) AS `posts`,
  81                         SUM(IFNULL(`active-month-users`, `active-week-users`)) AS `month`,
  82                         SUM(IFNULL(`active-halfyear-users`, `active-week-users`)) AS `halfyear`, `platform`,
  83                         ANY_VALUE(`network`) AS `network`, MAX(`version`) AS `version`
  84                         FROM `gserver` WHERE NOT `failed` AND `detection-method` != ? AND NOT `network` IN (?, ?) GROUP BY `platform`", GServer::DETECT_MANUAL, Protocol::PHANTOM, Protocol::FEED);
  85                 while ($gserver = DBA::fetch($gservers)) {
  86                         $total    += $gserver['total'];
  87                         $users    += $gserver['users'];
  88                         $month    += $gserver['month'];
  89                         $halfyear += $gserver['halfyear'];
  90                         $posts    += $gserver['posts'];
  91
  92                         $versionCounts = [];
  93                         $versions = DBA::p("SELECT COUNT(*) AS `total`, `version` FROM `gserver`
  94                                 WHERE NOT `failed` AND `platform` = ? AND `detection-method` != ? AND NOT `network` IN (?, ?)
  95                                 GROUP BY `version` ORDER BY `version`", $gserver['platform'], GServer::DETECT_MANUAL, Protocol::PHANTOM, Protocol::FEED);
  96                         while ($version = DBA::fetch($versions)) {
  97                                 $version['version'] = str_replace(["\n", "\r", "\t"], " ", $version['version']);
  98
  99                                 if (in_array($gserver['platform'], ['Red Matrix', 'redmatrix', 'red'])) {
 100                                         $version['version'] = 'Red ' . $version['version'];
 101                                 } elseif (in_array($gserver['platform'], ['osada', 'mistpark', 'roadhouse', 'zap'])) {
 102                                         $version['version'] = $gserver['platform'] . ' ' . $version['version'];
 103                                 } elseif (in_array($gserver['platform'], ['activityrelay', 'pub-relay', 'selective-relay', 'aoderelay'])) {
 104                                         $version['version'] = $gserver['platform'] . '-' . $version['version'];
 105                                 }
 106
 107                                 $versionCounts[] = $version;
 108                         }
 109                         DBA::close($versions);
 110
 111                         $platform = $gserver['platform'] = strtolower($gserver['platform']);
 112
 113                         if ($platform == 'friendika') {
 114                                 $platform = 'friendica';
 115                         } elseif (in_array($platform, ['red matrix', 'redmatrix', 'red'])) {
 116                                 $platform = 'hubzilla';
 117                         } elseif (in_array($platform, ['mistpark', 'osada', 'roadhouse', 'zap'])) {
 118                                 $platform = 'mistpark';
 119                         } elseif(stristr($platform, 'pleroma')) {
 120                                 $platform = 'pleroma';
 121                         } elseif(stristr($platform, 'statusnet')) {
 122                                 $platform = 'gnusocial';
 123                         } elseif(stristr($platform, 'wordpress')) {
 124                                 $platform = 'wordpress';
 125                         } elseif (in_array($platform, ['activityrelay', 'pub-relay', 'selective-relay', 'aoderelay'])) {
 126                                 $platform = 'relay';
 127                         } elseif (!in_array($platform, $platforms)) {
 128                                 $platform = 'other';
 129                         }
 130
 131                         if ($platform != $gserver['platform']) {
 132                                 if ($platform == 'other') {
 133                                         $versionCounts = $counts[$platform][1] ?? [];
 134                                         $versionCounts[] = ['version' => $gserver['platform'] ?: DI::l10n()->t('unknown'), 'total' => $gserver['total']];
 135                                         $gserver['version'] = '';
 136                                 } else {
 137                                         $versionCounts = array_merge($versionCounts, $counts[$platform][1] ?? []);
 138                                 }
 139
 140                                 $gserver['platform']  = $platform;
 141                                 $gserver['total']    += $counts[$platform][0]['total'] ?? 0;
 142                                 $gserver['users']    += $counts[$platform][0]['users'] ?? 0;
 143                                 $gserver['month']    += $counts[$platform][0]['month'] ?? 0;
 144                                 $gserver['halfyear'] += $counts[$platform][0]['halfyear'] ?? 0;
 145                                 $gserver['posts']    += $counts[$platform][0]['posts'] ?? 0;
 146                         }
 147
 148                         if ($platform == 'friendica') {
 149                                 $versionCounts = self::reformaFriendicaVersions($versionCounts);
 150                         } elseif ($platform == 'pleroma') {
 151                                 $versionCounts = self::reformaPleromaVersions($versionCounts);
 152                         } elseif ($platform == 'diaspora') {
 153                                 $versionCounts = self::reformaDiasporaVersions($versionCounts);
 154                         } elseif ($platform == 'relay') {
 155                                 $versionCounts = self::reformatRelayVersions($versionCounts);
 156                         } elseif (in_array($platform, ['funkwhale', 'mastodon', 'mobilizon', 'misskey'])) {
 157                                 $versionCounts = self::removeVersionSuffixes($versionCounts);
 158                         }
 159
 160                         if (!in_array($platform, ['other', 'relay', 'mistpark'])) {
 161                                 $versionCounts = self::sortVersion($versionCounts);
 162                         } else {
 163                                 ksort($versionCounts);
 164                         }
 165
 166                         $gserver['platform']    = $systems[$platform]['name'];
 167                         $gserver['totallbl']    = DI::l10n()->t('%s total systems', number_format($gserver['total']));
 168                         $gserver['monthlbl']    = DI::l10n()->t('%s active users last month', number_format($gserver['month']));
 169                         $gserver['halfyearlbl'] = DI::l10n()->t('%s active users last six month', number_format($gserver['halfyear']));
 170                         $gserver['userslbl']    = DI::l10n()->t('%s registered users', number_format($gserver['users']));
 171                         $gserver['postslbl']    = DI::l10n()->t('%s local posts', number_format($gserver['posts']));
 172
 173                         if (($gserver['users'] > 0) && ($gserver['posts'] > 0)) {
 174                                 $gserver['postsuserlbl'] = DI::l10n()->t('%s posts per user', number_format($gserver['posts'] / $gserver['users'], 1));
 175                         } else {
 176                                 $gserver['postsuserlbl'] = '';
 177                         }
 178                         if (($gserver['users'] > 0) && ($gserver['total'] > 0)) {
 179                                 $gserver['userssystemlbl'] = DI::l10n()->t('%s users per system', number_format($gserver['users'] / $gserver['total'], 1));
 180                         } else {
 181                                 $gserver['userssystemlbl'] = '';
 182                         }
 183
 184                         $counts[$platform] = [$gserver, $versionCounts, str_replace([' ', '%', '.'], '', $platform), $systems[$platform]['color']];
 185                 }
 186                 DBA::close($gserver);
 187
 188                 // some helpful text
 189                 $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.');
 190
 191                 // load the template, replace the macros and return the page content
 192                 $t = Renderer::getMarkupTemplate('admin/federation.tpl');
 193                 return Renderer::replaceMacros($t, [
 194                         '$title' => DI::l10n()->t('Administration'),
 195                         '$page' => DI::l10n()->t('Federation Statistics'),
 196                         '$intro' => $intro,
 197                         '$counts' => $counts,
 198                         '$version' => FRIENDICA_VERSION,
 199                         '$legendtext' => DI::l10n()->t('Currently this node is aware of %s nodes (%s active users last month, %s active users last six month, %s registered users in total) from the following platforms:', number_format($total), number_format($month), number_format($halfyear), number_format($users)),
 200                 ]);
 201         }
 202
 203         /**
 204          * early friendica versions have the format x.x.xxxx where xxxx is the
 205          * DB version stamp; those should be operated out and versions be combined
 206          *
 207          * @param array $versionCounts list of version numbers
 208          * @return array with cleaned version numbers
 209          */
 210         private static function reformaFriendicaVersions(array $versionCounts)
 211         {
 212                 $newV = [];
 213                 $newVv = [];
 214                 foreach ($versionCounts as $vv) {
 215                         $newVC = $vv['total'];
 216                         $newVV = $vv['version'];
 217                         $lastDot = strrpos($newVV, '.');
 218                         $firstDash = strpos($newVV, '-');
 219                         $len = strlen($newVV) - 1;
 220                         if (($lastDot == $len - 4) && (!strrpos($newVV, '-rc') == $len - 3) && (!$firstDash == $len - 1)) {
 221                                 $newVV = substr($newVV, 0, $lastDot);
 222                         }
 223                         if (isset($newV[$newVV])) {
 224                                 $newV[$newVV] += $newVC;
 225                         } else {
 226                                 $newV[$newVV] = $newVC;
 227                         }
 228                 }
 229                 foreach ($newV as $key => $value) {
 230                         array_push($newVv, ['total' => $value, 'version' => $key]);
 231                 }
 232                 $versionCounts = $newVv;
 233
 234                 return $versionCounts;
 235         }
 236
 237         /**
 238          * in the DB the Diaspora versions have the format x.x.x.x-xx the last
 239          * part (-xx) should be removed to clean up the versions from the "head
 240          * commit" information and combined into a single entry for x.x.x.x
 241          *
 242          * @param array $versionCounts list of version numbers
 243          * @return array with cleaned version numbers
 244          */
 245         private static function reformaDiasporaVersions(array $versionCounts)
 246         {
 247                 $newV = [];
 248                 $newVv = [];
 249                 foreach ($versionCounts as $vv) {
 250                         $newVC = $vv['total'];
 251                         $newVV = $vv['version'];
 252                         $posDash = strpos($newVV, '-');
 253                         if ($posDash) {
 254                                 $newVV = substr($newVV, 0, $posDash);
 255                         }
 256                         if (isset($newV[$newVV])) {
 257                                 $newV[$newVV] += $newVC;
 258                         } else {
 259                                 $newV[$newVV] = $newVC;
 260                         }
 261                 }
 262                 foreach ($newV as $key => $value) {
 263                         array_push($newVv, ['total' => $value, 'version' => $key]);
 264                 }
 265                 $versionCounts = $newVv;
 266
 267                 return $versionCounts;
 268         }
 269
 270         /**
 271          * Clean up Pleroma version numbers
 272          *
 273          * @param array $versionCounts list of version numbers
 274          * @return array with cleaned version numbers
 275          */
 276         private static function reformaPleromaVersions(array $versionCounts)
 277         {
 278                 $compacted = [];
 279                 foreach ($versionCounts as $key => $value) {
 280                         $version = $versionCounts[$key]['version'];
 281                         $parts = explode(' ', trim($version));
 282                         do {
 283                                 $part = array_pop($parts);
 284                         } while (!empty($parts) && ((strlen($part) >= 40) || (strlen($part) <= 3)));
 285                         // only take the x.x.x part of the version, not the "release" after the dash
 286                         if (!empty($part) && strpos($part, '-')) {
 287                                 $part = explode('-', $part)[0];
 288                         }
 289                         if (!empty($part)) {
 290                                 if (empty($compacted[$part])) {
 291                                         $compacted[$part] = $versionCounts[$key]['total'];
 292                                 } else {
 293                                         $compacted[$part] += $versionCounts[$key]['total'];
 294                                 }
 295                         }
 296                 }
 297
 298                 $versionCounts = [];
 299                 foreach ($compacted as $version => $pl_total) {
 300                         $versionCounts[] = ['version' => $version, 'total' => $pl_total];
 301                 }
 302
 303                 return $versionCounts;
 304         }
 305
 306         /**
 307          * Clean up version numbers
 308          *
 309          * @param array $versionCounts list of version numbers
 310          * @return array with cleaned version numbers
 311          */
 312         private static function removeVersionSuffixes(array $versionCounts)
 313         {
 314                 $compacted = [];
 315                 foreach ($versionCounts as $key => $value) {
 316                         $version = $versionCounts[$key]['version'];
 317
 318                         foreach ([' ', '+', '-', '#', '_', '~'] as $delimiter) {
 319                                 $parts = explode($delimiter, trim($version));
 320                                 $version = array_shift($parts);
 321                         }
 322
 323                         if (empty($compacted[$version])) {
 324                                 $compacted[$version] = $versionCounts[$key]['total'];
 325                         } else {
 326                                 $compacted[$version] += $versionCounts[$key]['total'];
 327                         }
 328                 }
 329
 330                 $versionCounts = [];
 331                 foreach ($compacted as $version => $pl_total) {
 332                         $versionCounts[] = ['version' => $version, 'total' => $pl_total];
 333                 }
 334
 335                 return $versionCounts;
 336         }
 337
 338         /**
 339          * Clean up relay version numbers
 340          *
 341          * @param array $versionCounts list of version numbers
 342          * @return array with cleaned version numbers
 343          */
 344         private static function reformatRelayVersions(array $versionCounts)
 345         {
 346                 $compacted = [];
 347                 foreach ($versionCounts as $key => $value) {
 348                         $version = $versionCounts[$key]['version'];
 349
 350                         $parts = explode(' ', trim($version));
 351                         $version = array_shift($parts);
 352
 353                         if (empty($compacted[$version])) {
 354                                 $compacted[$version] = $versionCounts[$key]['total'];
 355                         } else {
 356                                 $compacted[$version] += $versionCounts[$key]['total'];
 357                         }
 358                 }
 359
 360                 $versionCounts = [];
 361                 foreach ($compacted as $version => $pl_total) {
 362                         $versionCounts[] = ['version' => $version, 'total' => $pl_total];
 363                 }
 364
 365                 return $versionCounts;
 366         }
 367
 368         /**
 369          * Reformat, sort and compact version numbers
 370          *
 371          * @param array $versionCounts list of version numbers
 372          * @return array with reformatted version numbers
 373          */
 374         private static function sortVersion(array $versionCounts)
 375         {
 376                 //
 377                 // clean up version numbers
 378                 //
 379                 // some platforms do not provide version information, add a unkown there
 380                 // to the version string for the displayed list.
 381                 foreach ($versionCounts as $key => $value) {
 382                         if ($versionCounts[$key]['version'] == '') {
 383                                 $versionCounts[$key] = ['total' => $versionCounts[$key]['total'], 'version' => DI::l10n()->t('unknown')];
 384                         }
 385                 }
 386
 387                 // Assure that the versions are sorted correctly
 388                 $v2 = [];
 389                 $versions = [];
 390                 foreach ($versionCounts as $vv) {
 391                         $version = trim(strip_tags($vv["version"]));
 392                         $v2[$version] = $vv;
 393                         $versions[] = $version;
 394                 }
 395
 396                 usort($versions, 'version_compare');
 397
 398                 $versionCounts = [];
 399                 foreach ($versions as $version) {
 400                         $versionCounts[] = $v2[$version];
 401                 }
 402
 403                 return $versionCounts;
 404         }
 405 }