3 * @copyright Copyright (C) 2020, Friendica
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;
24 use Friendica\Core\Renderer;
25 use Friendica\Database\DBA;
27 use Friendica\Module\BaseAdmin;
29 class Federation extends BaseAdmin
31 public static function content(array $parameters = [])
33 parent::content($parameters);
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"
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 'nextcloud' => ['name' => 'Nextcloud', 'color' => '#1cafff'], // Logo color
46 'peertube' => ['name' => 'Peertube', 'color' => '#ffad5c'], // One of the logo colors
47 'pixelfed' => ['name' => 'Pixelfed', 'color' => '#11da47'], // One of the logo colors
48 'pleroma' => ['name' => 'Pleroma', 'color' => '#E46F0F'], // Orange from the text that is used on Pleroma instances
49 'plume' => ['name' => 'Plume', 'color' => '#7765e3'], // From the homepage
50 'socialhome' => ['name' => 'SocialHome', 'color' => '#52056b'], // lilac from the Django Image used at the Socialhome homepage
51 'wordpress' => ['name' => 'WordPress', 'color' => '#016087'], // Background color of the homepage
52 'writefreely' => ['name' => 'WriteFreely', 'color' => '#292929'], // Font color of the homepage
53 'other' => ['name' => DI::l10n()->t('Other'), 'color' => '#F1007E'], // ActivityPub main color
56 $platforms = array_keys($systems);
59 foreach ($platforms as $platform) {
60 $counts[$platform] = [];
66 $gservers = DBA::p("SELECT COUNT(*) AS `total`, SUM(`registered-users`) AS `users`, `platform`,
67 ANY_VALUE(`network`) AS `network`, MAX(`version`) AS `version`
68 FROM `gserver` WHERE NOT `failed` GROUP BY `platform`");
69 while ($gserver = DBA::fetch($gservers)) {
70 $total += $gserver['total'];
71 $users += $gserver['users'];
74 $versions = DBA::p("SELECT COUNT(*) AS `total`, `version` FROM `gserver`
75 WHERE NOT `failed` AND `platform` = ?
76 GROUP BY `version` ORDER BY `version`", $gserver['platform']);
77 while ($version = DBA::fetch($versions)) {
78 $version['version'] = str_replace(["\n", "\r", "\t"], " ", $version['version']);
80 if (in_array($gserver['platform'], ['Red Matrix', 'redmatrix', 'red'])) {
81 $version['version'] = 'Red ' . $version['version'];
84 $versionCounts[] = $version;
86 DBA::close($versions);
88 $platform = $gserver['platform'] = strtolower($gserver['platform']);
90 if ($platform == 'friendika') {
91 $platform = 'friendica';
92 } elseif (in_array($platform, ['red matrix', 'redmatrix', 'red'])) {
93 $platform = 'hubzilla';
94 } elseif(stristr($platform, 'pleroma')) {
95 $platform = 'pleroma';
96 } elseif(stristr($platform, 'statusnet')) {
97 $platform = 'gnusocial';
98 } elseif(stristr($platform, 'wordpress')) {
99 $platform = 'wordpress';
100 } elseif (!in_array($platform, $platforms)) {
104 if ($platform != $gserver['platform']) {
105 if ($platform == 'other') {
106 $versionCounts = $counts[$platform][1] ?? [];
107 $versionCounts[] = ['version' => $gserver['platform'] ?: DI::l10n()->t('unknown'), 'total' => $gserver['total']];
108 $gserver['version'] = '';
110 $versionCounts = array_merge($versionCounts, $counts[$platform][1] ?? []);
113 $gserver['platform'] = $platform;
114 $gserver['total'] += $counts[$platform][0]['total'] ?? 0;
115 $gserver['users'] += $counts[$platform][0]['users'] ?? 0;
118 if ($platform == 'friendica') {
119 $versionCounts = self::reformaFriendicaVersions($versionCounts);
120 } elseif ($platform == 'pleroma') {
121 $versionCounts = self::reformaPleromaVersions($versionCounts);
122 } elseif ($platform == 'diaspora') {
123 $versionCounts = self::reformaDiasporaVersions($versionCounts);
126 $versionCounts = self::sortVersion($versionCounts);
128 $gserver['platform'] = $systems[$platform]['name'];
130 $counts[$platform] = [$gserver, $versionCounts, str_replace([' ', '%'], '', $platform), $systems[$platform]['color']];
132 DBA::close($gserver);
135 $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.');
137 // load the template, replace the macros and return the page content
138 $t = Renderer::getMarkupTemplate('admin/federation.tpl');
139 return Renderer::replaceMacros($t, [
140 '$title' => DI::l10n()->t('Administration'),
141 '$page' => DI::l10n()->t('Federation Statistics'),
143 '$counts' => $counts,
144 '$version' => FRIENDICA_VERSION,
145 '$legendtext' => DI::l10n()->t('Currently this node is aware of %d nodes with %d registered users from the following platforms:', $total, $users),
150 * early friendica versions have the format x.x.xxxx where xxxx is the
151 * DB version stamp; those should be operated out and versions be combined
153 * @param array $versionCounts list of version numbers
154 * @return array with cleaned version numbers
156 private static function reformaFriendicaVersions(array $versionCounts)
160 foreach ($versionCounts as $vv) {
161 $newVC = $vv['total'];
162 $newVV = $vv['version'];
163 $lastDot = strrpos($newVV, '.');
164 $len = strlen($newVV) - 1;
165 if (($lastDot == $len - 4) && (!strrpos($newVV, '-rc') == $len - 3)) {
166 $newVV = substr($newVV, 0, $lastDot);
168 if (isset($newV[$newVV])) {
169 $newV[$newVV] += $newVC;
171 $newV[$newVV] = $newVC;
174 foreach ($newV as $key => $value) {
175 array_push($newVv, ['total' => $value, 'version' => $key]);
177 $versionCounts = $newVv;
179 return $versionCounts;
183 * in the DB the Diaspora versions have the format x.x.x.x-xx the last
184 * part (-xx) should be removed to clean up the versions from the "head
185 * commit" information and combined into a single entry for x.x.x.x
187 * @param array $versionCounts list of version numbers
188 * @return array with cleaned version numbers
190 private static function reformaDiasporaVersions(array $versionCounts)
194 foreach ($versionCounts as $vv) {
195 $newVC = $vv['total'];
196 $newVV = $vv['version'];
197 $posDash = strpos($newVV, '-');
199 $newVV = substr($newVV, 0, $posDash);
201 if (isset($newV[$newVV])) {
202 $newV[$newVV] += $newVC;
204 $newV[$newVV] = $newVC;
207 foreach ($newV as $key => $value) {
208 array_push($newVv, ['total' => $value, 'version' => $key]);
210 $versionCounts = $newVv;
212 return $versionCounts;
216 * Clean up Pleroma version numbers
218 * @param array $versionCounts list of version numbers
219 * @return array with cleaned version numbers
221 private static function reformaPleromaVersions(array $versionCounts)
224 foreach ($versionCounts as $key => $value) {
225 $version = $versionCounts[$key]['version'];
226 $parts = explode(' ', trim($version));
228 $part = array_pop($parts);
229 } while (!empty($parts) && ((strlen($part) >= 40) || (strlen($part) <= 3)));
230 // only take the x.x.x part of the version, not the "release" after the dash
231 if (!empty($part) && strpos($part, '-')) {
232 $part = explode('-', $part)[0];
235 if (empty($compacted[$part])) {
236 $compacted[$part] = $versionCounts[$key]['total'];
238 $compacted[$part] += $versionCounts[$key]['total'];
244 foreach ($compacted as $version => $pl_total) {
245 $versionCounts[] = ['version' => $version, 'total' => $pl_total];
248 return $versionCounts;
252 * Reformat, sort and compact version numbers
254 * @param array $versionCounts list of version numbers
255 * @return array with reformatted version numbers
257 private static function sortVersion(array $versionCounts)
260 // clean up version numbers
262 // some platforms do not provide version information, add a unkown there
263 // to the version string for the displayed list.
264 foreach ($versionCounts as $key => $value) {
265 if ($versionCounts[$key]['version'] == '') {
266 $versionCounts[$key] = ['total' => $versionCounts[$key]['total'], 'version' => DI::l10n()->t('unknown')];
270 // Assure that the versions are sorted correctly
273 foreach ($versionCounts as $vv) {
274 $version = trim(strip_tags($vv["version"]));
276 $versions[] = $version;
279 usort($versions, 'version_compare');
282 foreach ($versions as $version) {
283 $versionCounts[] = $v2[$version];
286 return $versionCounts;