3 * @copyright Copyright (C) 2010-2022, 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 'mistpark' => ['name' => 'Nomad projects (Mistpark, Osada, Roadhouse, 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 'wordpress' => ['name' => 'WordPress', 'color' => '#016087'], // Background color of the homepage
71 'write.as' => ['name' => 'Write.as', 'color' => '#00ace3'], // Border color of the homepage
72 'writefreely' => ['name' => 'WriteFreely', 'color' => '#292929'], // Font color of the homepage
73 'other' => ['name' => DI::l10n()->t('Other'), 'color' => '#F1007E'], // ActivityPub main color
76 $platforms = array_keys($systems);
79 foreach ($platforms as $platform) {
80 $counts[$platform] = [];
89 $gservers = DBA::p("SELECT COUNT(*) AS `total`, SUM(`registered-users`) AS `users`,
90 SUM(IFNULL(`local-posts`, 0) + IFNULL(`local-comments`, 0)) AS `posts`,
91 SUM(IFNULL(`active-month-users`, `active-week-users`)) AS `month`,
92 SUM(IFNULL(`active-halfyear-users`, `active-week-users`)) AS `halfyear`, `platform`,
93 ANY_VALUE(`network`) AS `network`, MAX(`version`) AS `version`
94 FROM `gserver` WHERE NOT `failed` AND `platform` != ? AND `detection-method` != ? AND NOT `network` IN (?, ?) GROUP BY `platform`",
95 '', GServer::DETECT_MANUAL, Protocol::PHANTOM, Protocol::FEED);
96 while ($gserver = DBA::fetch($gservers)) {
97 $total += $gserver['total'];
98 $users += $gserver['users'];
99 $month += $gserver['month'];
100 $halfyear += $gserver['halfyear'];
101 $posts += $gserver['posts'];
104 $versions = DBA::p("SELECT COUNT(*) AS `total`, `version` FROM `gserver`
105 WHERE NOT `failed` AND `platform` = ? AND `detection-method` != ? AND NOT `network` IN (?, ?)
106 GROUP BY `version` ORDER BY `version`", $gserver['platform'], GServer::DETECT_MANUAL, Protocol::PHANTOM, Protocol::FEED);
107 while ($version = DBA::fetch($versions)) {
108 $version['version'] = str_replace(["\n", "\r", "\t"], " ", $version['version']);
110 if (in_array($gserver['platform'], ['Red Matrix', 'redmatrix', 'red'])) {
111 $version['version'] = 'Red ' . $version['version'];
112 } elseif (in_array($gserver['platform'], ['osada', 'mistpark', 'roadhouse', 'zap', 'macgirvin', 'mkultra'])) {
113 $version['version'] = $gserver['platform'] . ' ' . $version['version'];
114 } elseif (in_array($gserver['platform'], ['activityrelay', 'pub-relay', 'selective-relay', 'aoderelay'])) {
115 $version['version'] = $gserver['platform'] . '-' . $version['version'];
118 $versionCounts[] = $version;
120 DBA::close($versions);
122 $platform = $gserver['platform'] = strtolower($gserver['platform']);
124 if ($platform == 'friendika') {
125 $platform = 'friendica';
126 } elseif (in_array($platform, ['red matrix', 'redmatrix', 'red'])) {
127 $platform = 'hubzilla';
128 } elseif (in_array($platform, ['osada', 'mistpark', 'roadhouse', 'zap', 'macgirvin', 'mkultra'])) {
129 $platform = 'mistpark';
130 } elseif(stristr($platform, 'pleroma')) {
131 $platform = 'pleroma';
132 } elseif(stristr($platform, 'statusnet')) {
133 $platform = 'gnusocial';
134 } elseif(stristr($platform, 'nextcloud')) {
135 $platform = 'nextcloud';
136 } elseif(stristr($platform, 'wordpress')) {
137 $platform = 'wordpress';
138 } elseif (in_array($platform, ['activityrelay', 'pub-relay', 'selective-relay', 'aoderelay'])) {
140 } elseif (!in_array($platform, $platforms)) {
144 if ($platform != $gserver['platform']) {
145 if ($platform == 'other') {
146 $versionCounts = $counts[$platform][1] ?? [];
147 $versionCounts[] = ['version' => $gserver['platform'] ?: DI::l10n()->t('unknown'), 'total' => $gserver['total']];
148 $gserver['version'] = '';
150 $versionCounts = array_merge($versionCounts, $counts[$platform][1] ?? []);
153 $gserver['platform'] = $platform;
154 $gserver['total'] += $counts[$platform][0]['total'] ?? 0;
155 $gserver['users'] += $counts[$platform][0]['users'] ?? 0;
156 $gserver['month'] += $counts[$platform][0]['month'] ?? 0;
157 $gserver['halfyear'] += $counts[$platform][0]['halfyear'] ?? 0;
158 $gserver['posts'] += $counts[$platform][0]['posts'] ?? 0;
161 if ($platform == 'friendica') {
162 $versionCounts = self::reformaFriendicaVersions($versionCounts);
163 } elseif (in_array($platform, ['pleroma', 'akkoma'])) {
164 $versionCounts = self::reformaPleromaVersions($versionCounts);
165 } elseif ($platform == 'diaspora') {
166 $versionCounts = self::reformaDiasporaVersions($versionCounts);
167 } elseif ($platform == 'relay') {
168 $versionCounts = self::reformatRelayVersions($versionCounts);
169 } elseif (in_array($platform, ['funkwhale', 'mastodon', 'mobilizon', 'misskey', 'gotosocial'])) {
170 $versionCounts = self::removeVersionSuffixes($versionCounts);
173 if (!in_array($platform, ['other', 'relay', 'mistpark'])) {
174 $versionCounts = self::sortVersion($versionCounts);
176 ksort($versionCounts);
179 $gserver['platform'] = $systems[$platform]['name'];
180 $gserver['totallbl'] = DI::l10n()->tt('%2$s total system' , '%2$s total systems' , $gserver['total'], number_format($gserver['total']));
181 $gserver['monthlbl'] = DI::l10n()->tt('%2$s active user last month' , '%2$s active users last month' , $gserver['month'] ?? 0, number_format($gserver['month']));
182 $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']));
183 $gserver['userslbl'] = DI::l10n()->tt('%2$s registered user' , '%2$s registered users' , $gserver['users'], number_format($gserver['users']));
184 $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']));
186 if (($gserver['users'] > 0) && ($gserver['posts'] > 0)) {
187 $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));
189 $gserver['postsuserlbl'] = '';
191 if (($gserver['users'] > 0) && ($gserver['total'] > 0)) {
192 $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));
194 $gserver['userssystemlbl'] = '';
197 $counts[$platform] = [$gserver, $versionCounts, str_replace([' ', '%', '.'], '', $platform), $systems[$platform]['color']];
199 DBA::close($gservers);
202 $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.');
204 // load the template, replace the macros and return the page content
205 $t = Renderer::getMarkupTemplate('admin/federation.tpl');
206 return Renderer::replaceMacros($t, [
207 '$title' => DI::l10n()->t('Administration'),
208 '$page' => DI::l10n()->t('Federation Statistics'),
210 '$counts' => $counts,
211 '$version' => App::VERSION,
212 '$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)),
217 * early friendica versions have the format x.x.xxxx where xxxx is the
218 * DB version stamp; those should be operated out and versions be combined
220 * @param array $versionCounts list of version numbers
221 * @return array with cleaned version numbers
223 private static function reformaFriendicaVersions(array $versionCounts)
227 foreach ($versionCounts as $vv) {
228 $newVC = $vv['total'];
229 $newVV = $vv['version'];
230 $lastDot = strrpos($newVV, '.');
231 $firstDash = strpos($newVV, '-');
232 $len = strlen($newVV) - 1;
233 if (($lastDot == $len - 4) && (!strrpos($newVV, '-rc') == $len - 3) && (!$firstDash == $len - 1)) {
234 $newVV = substr($newVV, 0, $lastDot);
236 if (isset($newV[$newVV])) {
237 $newV[$newVV] += $newVC;
239 $newV[$newVV] = $newVC;
242 foreach ($newV as $key => $value) {
243 array_push($newVv, ['total' => $value, 'version' => $key]);
245 $versionCounts = $newVv;
247 return $versionCounts;
251 * in the DB the Diaspora versions have the format x.x.x.x-xx the last
252 * part (-xx) should be removed to clean up the versions from the "head
253 * commit" information and combined into a single entry for x.x.x.x
255 * @param array $versionCounts list of version numbers
256 * @return array with cleaned version numbers
258 private static function reformaDiasporaVersions(array $versionCounts)
262 foreach ($versionCounts as $vv) {
263 $newVC = $vv['total'];
264 $newVV = $vv['version'];
265 $posDash = strpos($newVV, '-');
267 $newVV = substr($newVV, 0, $posDash);
269 if (isset($newV[$newVV])) {
270 $newV[$newVV] += $newVC;
272 $newV[$newVV] = $newVC;
275 foreach ($newV as $key => $value) {
276 array_push($newVv, ['total' => $value, 'version' => $key]);
278 $versionCounts = $newVv;
280 return $versionCounts;
284 * Clean up Pleroma version numbers
286 * @param array $versionCounts list of version numbers
287 * @return array with cleaned version numbers
289 private static function reformaPleromaVersions(array $versionCounts)
292 foreach ($versionCounts as $key => $value) {
293 $version = $versionCounts[$key]['version'];
294 $parts = explode(' ', trim($version));
296 $part = array_pop($parts);
297 } while (!empty($parts) && ((strlen($part) >= 40) || (strlen($part) <= 3)));
298 // only take the x.x.x part of the version, not the "release" after the dash
299 if (!empty($part) && strpos($part, '-')) {
300 $part = explode('-', $part)[0];
303 if (empty($compacted[$part])) {
304 $compacted[$part] = $versionCounts[$key]['total'];
306 $compacted[$part] += $versionCounts[$key]['total'];
312 foreach ($compacted as $version => $pl_total) {
313 $versionCounts[] = ['version' => $version, 'total' => $pl_total];
316 return $versionCounts;
320 * Clean up version numbers
322 * @param array $versionCounts list of version numbers
323 * @return array with cleaned version numbers
325 private static function removeVersionSuffixes(array $versionCounts)
328 foreach ($versionCounts as $key => $value) {
329 $version = $versionCounts[$key]['version'];
331 foreach ([' ', '+', '-', '#', '_', '~'] as $delimiter) {
332 $parts = explode($delimiter, trim($version));
333 $version = array_shift($parts);
336 if (empty($compacted[$version])) {
337 $compacted[$version] = $versionCounts[$key]['total'];
339 $compacted[$version] += $versionCounts[$key]['total'];
344 foreach ($compacted as $version => $pl_total) {
345 $versionCounts[] = ['version' => $version, 'total' => $pl_total];
348 return $versionCounts;
352 * Clean up relay version numbers
354 * @param array $versionCounts list of version numbers
355 * @return array with cleaned version numbers
357 private static function reformatRelayVersions(array $versionCounts)
360 foreach ($versionCounts as $key => $value) {
361 $version = $versionCounts[$key]['version'];
363 $parts = explode(' ', trim($version));
364 $version = array_shift($parts);
366 if (empty($compacted[$version])) {
367 $compacted[$version] = $versionCounts[$key]['total'];
369 $compacted[$version] += $versionCounts[$key]['total'];
374 foreach ($compacted as $version => $pl_total) {
375 $versionCounts[] = ['version' => $version, 'total' => $pl_total];
378 return $versionCounts;
382 * Reformat, sort and compact version numbers
384 * @param array $versionCounts list of version numbers
385 * @return array with reformatted version numbers
387 private static function sortVersion(array $versionCounts)
390 // clean up version numbers
392 // some platforms do not provide version information, add a unkown there
393 // to the version string for the displayed list.
394 foreach ($versionCounts as $key => $value) {
395 if ($versionCounts[$key]['version'] == '') {
396 $versionCounts[$key] = ['total' => $versionCounts[$key]['total'], 'version' => DI::l10n()->t('unknown')];
400 // Assure that the versions are sorted correctly
403 foreach ($versionCounts as $vv) {
404 $version = trim(strip_tags($vv["version"]));
406 $versions[] = $version;
409 usort($versions, 'version_compare');
412 foreach ($versions as $version) {
413 $versionCounts[] = $v2[$version];
416 return $versionCounts;