src/Module/Admin/Federation.php

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