3 * @copyright Copyright (C) 2010-2023, the Friendica project
5 * @license GNU AGPL version 3 or any later version
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.
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.
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/>.
22 namespace Friendica\Module\Admin;
25 use Friendica\Core\Protocol;
26 use Friendica\Core\Renderer;
27 use Friendica\Database\DBA;
29 use Friendica\Model\GServer;
30 use Friendica\Module\BaseAdmin;
32 class Federation extends BaseAdmin
34 protected function content(array $request = []): string
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"
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 'lemmy' => ['name' => 'Lemmy', 'color' => '#00c853'], // Green from the page
57 'mastodon' => ['name' => 'Mastodon', 'color' => '#1a9df9'], // blue from the Mastodon logo
58 'microblog' => ['name' => 'Microblog', 'color' => '#fdb52b'], // Color from the page
59 'misskey' => ['name' => 'Misskey', 'color' => '#ccfefd'], // Font color of the homepage
60 'mobilizon' => ['name' => 'Mobilizon', 'color' => '#ffd599'], // Background color of parts of the homepage
61 'nextcloud' => ['name' => 'Nextcloud', 'color' => '#1cafff'], // Logo color
62 'nomad' => ['name' => 'Nomad projects (Mistpark, Osada, Roadhouse, Streams. Zap)', 'color' => '#348a4a'], // Green like the Mistpark green
63 'owncast' => ['name' => 'Owncast', 'color' => '#007bff'], // Font color of the homepage
64 'peertube' => ['name' => 'Peertube', 'color' => '#ffad5c'], // One of the logo colors
65 'pixelfed' => ['name' => 'Pixelfed', 'color' => '#11da47'], // One of the logo colors
66 'pleroma' => ['name' => 'Pleroma', 'color' => '#E46F0F'], // Orange from the text that is used on Pleroma instances
67 'plume' => ['name' => 'Plume', 'color' => '#7765e3'], // From the homepage
68 'relay' => ['name' => 'ActivityPub Relay', 'color' => '#888888'], // Grey like the second color of the ActivityPub logo
69 'socialhome' => ['name' => 'SocialHome', 'color' => '#52056b'], // lilac from the Django Image used at the Socialhome homepage
70 'takahe' => ['name' => 'Takahē', 'color' => '#26323c'], // Background color of the homepage
71 'wildebeest' => ['name' => 'Wildebeest', 'color' => '#0055dc'], // Color of the mascot
72 'wordpress' => ['name' => 'WordPress', 'color' => '#016087'], // Background color of the homepage
73 'write.as' => ['name' => 'Write.as', 'color' => '#00ace3'], // Border color of the homepage
74 'writefreely' => ['name' => 'WriteFreely', 'color' => '#292929'], // Font color of the homepage
75 'other' => ['name' => DI::l10n()->t('Other'), 'color' => '#F1007E'], // ActivityPub main color
78 $platforms = array_keys($systems);
81 foreach ($platforms as $platform) {
82 $counts[$platform] = [];
91 $gservers = DBA::p("SELECT COUNT(*) AS `total`, SUM(`registered-users`) AS `users`,
92 SUM(IFNULL(`local-posts`, 0) + IFNULL(`local-comments`, 0)) AS `posts`,
93 SUM(IFNULL(`active-month-users`, `active-week-users`)) AS `month`,
94 SUM(IFNULL(`active-halfyear-users`, `active-week-users`)) AS `halfyear`, `platform`,
95 ANY_VALUE(`network`) AS `network`, MAX(`version`) AS `version`
96 FROM `gserver` WHERE NOT `failed` AND `platform` != ? AND `detection-method` != ? AND NOT `network` IN (?, ?) GROUP BY `platform`",
97 '', GServer::DETECT_MANUAL, Protocol::PHANTOM, Protocol::FEED);
98 while ($gserver = DBA::fetch($gservers)) {
99 $total += $gserver['total'];
100 $users += $gserver['users'];
101 $month += $gserver['month'];
102 $halfyear += $gserver['halfyear'];
103 $posts += $gserver['posts'];
106 $versions = DBA::p("SELECT COUNT(*) AS `total`, `version` FROM `gserver`
107 WHERE NOT `failed` AND `platform` = ? AND `detection-method` != ? AND NOT `network` IN (?, ?)
108 GROUP BY `version` ORDER BY `version`", $gserver['platform'], GServer::DETECT_MANUAL, Protocol::PHANTOM, Protocol::FEED);
109 while ($version = DBA::fetch($versions)) {
110 $version['version'] = str_replace(["\n", "\r", "\t"], " ", $version['version']);
112 if (in_array($gserver['platform'], ['Red Matrix', 'redmatrix', 'red'])) {
113 $version['version'] = 'Red ' . $version['version'];
114 } elseif (in_array($gserver['platform'], ['osada', 'mistpark', 'roadhouse', 'streams', 'zap'])) {
115 $version['version'] = $gserver['platform'] . ' ' . $version['version'];
116 } elseif (in_array($gserver['platform'], ['activityrelay', 'pub-relay', 'selective-relay', 'aoderelay'])) {
117 $version['version'] = $gserver['platform'] . '-' . $version['version'];
120 $versionCounts[] = $version;
122 DBA::close($versions);
124 $platform = $gserver['platform'] = strtolower($gserver['platform']);
126 if ($platform == 'friendika') {
127 $platform = 'friendica';
128 } elseif (in_array($platform, ['red matrix', 'redmatrix', 'red'])) {
129 $platform = 'hubzilla';
130 } elseif (in_array($platform, ['osada', 'mistpark', 'roadhouse', 'streams', 'zap'])) {
132 } elseif(stristr($platform, 'pleroma')) {
133 $platform = 'pleroma';
134 } elseif(stristr($platform, 'statusnet')) {
135 $platform = 'gnusocial';
136 } elseif(stristr($platform, 'nextcloud')) {
137 $platform = 'nextcloud';
138 } elseif(stristr($platform, 'wordpress')) {
139 $platform = 'wordpress';
140 } elseif (in_array($platform, ['activityrelay', 'pub-relay', 'selective-relay', 'aoderelay'])) {
142 } elseif (!in_array($platform, $platforms)) {
146 if ($platform != $gserver['platform']) {
147 if ($platform == 'other') {
148 $versionCounts = $counts[$platform][1] ?? [];
149 $versionCounts[] = ['version' => $gserver['platform'] ?: DI::l10n()->t('unknown'), 'total' => $gserver['total']];
150 $gserver['version'] = '';
152 $versionCounts = array_merge($versionCounts, $counts[$platform][1] ?? []);
155 $gserver['platform'] = $platform;
156 $gserver['total'] += $counts[$platform][0]['total'] ?? 0;
157 $gserver['users'] += $counts[$platform][0]['users'] ?? 0;
158 $gserver['month'] += $counts[$platform][0]['month'] ?? 0;
159 $gserver['halfyear'] += $counts[$platform][0]['halfyear'] ?? 0;
160 $gserver['posts'] += $counts[$platform][0]['posts'] ?? 0;
163 if ($platform == 'friendica') {
164 $versionCounts = self::reformaFriendicaVersions($versionCounts);
165 } elseif (in_array($platform, ['pleroma', 'akkoma'])) {
166 $versionCounts = self::reformaPleromaVersions($versionCounts);
167 } elseif ($platform == 'diaspora') {
168 $versionCounts = self::reformaDiasporaVersions($versionCounts);
169 } elseif ($platform == 'relay') {
170 $versionCounts = self::reformatRelayVersions($versionCounts);
171 } elseif (in_array($platform, ['funkwhale', 'mastodon', 'mobilizon', 'misskey', 'gotosocial'])) {
172 $versionCounts = self::removeVersionSuffixes($versionCounts);
175 if (!in_array($platform, ['other', 'relay', 'mistpark'])) {
176 $versionCounts = self::sortVersion($versionCounts);
178 ksort($versionCounts);
181 $gserver['platform'] = $systems[$platform]['name'];
182 $gserver['totallbl'] = DI::l10n()->tt('%2$s total system' , '%2$s total systems' , $gserver['total'], number_format($gserver['total']));
183 $gserver['monthlbl'] = DI::l10n()->tt('%2$s active user last month' , '%2$s active users last month' , $gserver['month'] ?? 0, number_format($gserver['month']));
184 $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']));
185 $gserver['userslbl'] = DI::l10n()->tt('%2$s registered user' , '%2$s registered users' , $gserver['users'], number_format($gserver['users']));
186 $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 if (($gserver['users'] > 0) && ($gserver['posts'] > 0)) {
189 $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 $gserver['postsuserlbl'] = '';
193 if (($gserver['users'] > 0) && ($gserver['total'] > 0)) {
194 $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 $gserver['userssystemlbl'] = '';
199 $counts[$platform] = [$gserver, $versionCounts, str_replace([' ', '%', '.'], '', $platform), $systems[$platform]['color']];
201 DBA::close($gservers);
204 $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 // load the template, replace the macros and return the page content
207 $t = Renderer::getMarkupTemplate('admin/federation.tpl');
208 return Renderer::replaceMacros($t, [
209 '$title' => DI::l10n()->t('Administration'),
210 '$page' => DI::l10n()->t('Federation Statistics'),
212 '$counts' => $counts,
213 '$version' => App::VERSION,
214 '$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)),
219 * early friendica versions have the format x.x.xxxx where xxxx is the
220 * DB version stamp; those should be operated out and versions be combined
222 * @param array $versionCounts list of version numbers
223 * @return array with cleaned version numbers
225 private static function reformaFriendicaVersions(array $versionCounts)
229 foreach ($versionCounts as $vv) {
230 $newVC = $vv['total'];
231 $newVV = $vv['version'];
232 $lastDot = strrpos($newVV, '.');
233 $firstDash = strpos($newVV, '-');
234 $len = strlen($newVV) - 1;
235 if (($lastDot == $len - 4) && (!strrpos($newVV, '-rc') == $len - 3) && (!$firstDash == $len - 1)) {
236 $newVV = substr($newVV, 0, $lastDot);
238 if (isset($newV[$newVV])) {
239 $newV[$newVV] += $newVC;
241 $newV[$newVV] = $newVC;
244 foreach ($newV as $key => $value) {
245 array_push($newVv, ['total' => $value, 'version' => $key]);
247 $versionCounts = $newVv;
249 return $versionCounts;
253 * in the DB the Diaspora versions have the format x.x.x.x-xx the last
254 * part (-xx) should be removed to clean up the versions from the "head
255 * commit" information and combined into a single entry for x.x.x.x
257 * @param array $versionCounts list of version numbers
258 * @return array with cleaned version numbers
260 private static function reformaDiasporaVersions(array $versionCounts)
264 foreach ($versionCounts as $vv) {
265 $newVC = $vv['total'];
266 $newVV = $vv['version'];
267 $posDash = strpos($newVV, '-');
269 $newVV = substr($newVV, 0, $posDash);
271 if (isset($newV[$newVV])) {
272 $newV[$newVV] += $newVC;
274 $newV[$newVV] = $newVC;
277 foreach ($newV as $key => $value) {
278 array_push($newVv, ['total' => $value, 'version' => $key]);
280 $versionCounts = $newVv;
282 return $versionCounts;
286 * Clean up Pleroma version numbers
288 * @param array $versionCounts list of version numbers
289 * @return array with cleaned version numbers
291 private static function reformaPleromaVersions(array $versionCounts)
294 foreach ($versionCounts as $key => $value) {
295 $version = $versionCounts[$key]['version'];
296 $parts = explode(' ', trim($version));
298 $part = array_pop($parts);
299 } while (!empty($parts) && ((strlen($part) >= 40) || (strlen($part) <= 3)));
300 // only take the x.x.x part of the version, not the "release" after the dash
301 if (!empty($part) && strpos($part, '-')) {
302 $part = explode('-', $part)[0];
305 if (empty($compacted[$part])) {
306 $compacted[$part] = $versionCounts[$key]['total'];
308 $compacted[$part] += $versionCounts[$key]['total'];
314 foreach ($compacted as $version => $pl_total) {
315 $versionCounts[] = ['version' => $version, 'total' => $pl_total];
318 return $versionCounts;
322 * Clean up version numbers
324 * @param array $versionCounts list of version numbers
325 * @return array with cleaned version numbers
327 private static function removeVersionSuffixes(array $versionCounts)
330 foreach ($versionCounts as $key => $value) {
331 $version = $versionCounts[$key]['version'];
333 foreach ([' ', '+', '-', '#', '_', '~'] as $delimiter) {
334 $parts = explode($delimiter, trim($version));
335 $version = array_shift($parts);
338 if (empty($compacted[$version])) {
339 $compacted[$version] = $versionCounts[$key]['total'];
341 $compacted[$version] += $versionCounts[$key]['total'];
346 foreach ($compacted as $version => $pl_total) {
347 $versionCounts[] = ['version' => $version, 'total' => $pl_total];
350 return $versionCounts;
354 * Clean up relay version numbers
356 * @param array $versionCounts list of version numbers
357 * @return array with cleaned version numbers
359 private static function reformatRelayVersions(array $versionCounts)
362 foreach ($versionCounts as $key => $value) {
363 $version = $versionCounts[$key]['version'];
365 $parts = explode(' ', trim($version));
366 $version = array_shift($parts);
368 if (empty($compacted[$version])) {
369 $compacted[$version] = $versionCounts[$key]['total'];
371 $compacted[$version] += $versionCounts[$key]['total'];
376 foreach ($compacted as $version => $pl_total) {
377 $versionCounts[] = ['version' => $version, 'total' => $pl_total];
380 return $versionCounts;
384 * Reformat, sort and compact version numbers
386 * @param array $versionCounts list of version numbers
387 * @return array with reformatted version numbers
389 private static function sortVersion(array $versionCounts)
392 // clean up version numbers
394 // some platforms do not provide version information, add a unkown there
395 // to the version string for the displayed list.
396 foreach ($versionCounts as $key => $value) {
397 if ($versionCounts[$key]['version'] == '') {
398 $versionCounts[$key] = ['total' => $versionCounts[$key]['total'], 'version' => DI::l10n()->t('unknown')];
402 // Assure that the versions are sorted correctly
405 foreach ($versionCounts as $vv) {
406 $version = trim(strip_tags($vv["version"]));
408 $versions[] = $version;
411 usort($versions, 'version_compare');
414 foreach ($versions as $version) {
415 $versionCounts[] = $v2[$version];
418 return $versionCounts;