strk/friendica
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Move admin/federation to src/Module

Browse source 
- Add Module\Admin\Federation class
- Add missing abstract keyword in Module\BaseAdminModule
- Add route for admin/federation
- Remove admin_page_federation()  from mod/admin.php
This commit is contained in:
Hypolite Petovan 2019-04-14 11:20:44 -04:00
parent 6387a77b52
commit 35d222f95d
4 changed files with 203 additions and 194 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

193
mod/admin.php
View file

@ -280,9 +280,6 @@ function admin_content(App $a)
case 'workerqueue':
$o = admin_page_workerqueue($a, false);
break;
case 'federation':
$o = admin_page_federation($a);
break;
case 'contactblock':
$o = admin_page_contactblock($a);
break;
@ -594,196 +591,6 @@ function admin_page_deleteitem_post(App $a)
return; // NOTREACHED
}
/**
* @brief Subpage with some stats about "the federation" network
*
* This function generates the "Federation Statistics" subpage for the admin
* panel. The page lists some numbers to the part of "The Federation" known to
* the node. This data includes the different connected networks (e.g.
* Diaspora, Hubzilla, GNU Social) and the used versions in the different
* networks.
*
* The returned string contains the HTML code of the subpage for display.
*
* @param App $a
* @return string
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
function admin_page_federation(App $a)
{
// get counts on active friendica, diaspora, redmatrix, hubzilla, gnu
// social and statusnet nodes this node is knowing
//
// We are looking for the following platforms in the DB, "Red" should find
// all variants of that platform ID string as the q() function is stripping
// off one % two of them are needed in the query
// Add more platforms if you like, when one returns 0 known nodes it is not
// displayed on the stats page.
$platforms = ['Friendi%%a', 'Diaspora', '%%red%%', 'Hubzilla', 'BlaBlaNet', 'GNU Social', 'StatusNet', 'Mastodon', 'Pleroma', 'socialhome', 'ganggo'];
$colors = [
'Friendi%%a' => '#ffc018', // orange from the logo
'Diaspora' => '#a1a1a1', // logo is black and white, makes a gray
'%%red%%' => '#c50001', // fire red from the logo
'Hubzilla' => '#43488a', // blue from the logo
'BlaBlaNet' => '#3B5998', // blue from the navbar at blablanet-dot-com
'GNU Social' => '#a22430', // dark red from the logo
'StatusNet' => '#789240', // the green from the logo (red and blue have already others
'Mastodon' => '#1a9df9', // blue from the Mastodon logo
'Pleroma' => '#E46F0F', // Orange from the text that is used on Pleroma instances
'socialhome' => '#52056b' , // lilac from the Django Image used at the Socialhome homepage
'ganggo' => '#69d7e2' // from the favicon
];
$counts = [];
$total = 0;
$users = 0;
foreach ($platforms as $p) {
// get a total count for the platform, the name and version of the
// highest version and the protocol tpe
$c = q('SELECT COUNT(*) AS `total`, SUM(`registered-users`) AS `users`, ANY_VALUE(`platform`) AS `platform`,
ANY_VALUE(`network`) AS `network`, MAX(`version`) AS `version` FROM `gserver`
WHERE `platform` LIKE "%s" AND `last_contact` >= `last_failure`
ORDER BY `version` ASC;', $p);
$total += $c[0]['total'];
$users += $c[0]['users'];
// what versions for that platform do we know at all?
// again only the active nodes
$v = q('SELECT COUNT(*) AS `total`, `version` FROM `gserver`
WHERE `last_contact` >= `last_failure` AND `platform` LIKE "%s"
GROUP BY `version`
ORDER BY `version`;', $p);
//
// clean up version numbers
//
// some platforms do not provide version information, add a unkown there
// to the version string for the displayed list.
foreach ($v as $key => $value) {
if ($v[$key]['version'] == '') {
$v[$key] = ['total' => $v[$key]['total'], 'version' => L10n::t('unknown')];
}
}
// Reformat and compact version numbers
if ($p == 'Pleroma') {
$compacted = [];
foreach ($v as $key => $value) {
$version = $v[$key]['version'];
$parts = explode(' ', trim($version));
do {
$part = array_pop($parts);
} while (!empty($parts) && ((strlen($part) >= 40) || (strlen($part) <= 3)));
// only take the x.x.x part of the version, not the "release" after the dash
$part = array_shift(explode('-', $part));
if (!empty($part)) {
if (empty($compacted[$part])) {
$compacted[$part] = $v[$key]['total'];
} else {
$compacted[$part] += $v[$key]['total'];
}
}
}
$v = [];
foreach ($compacted as $version => $pl_total) {
$v[] = ['version' => $version, 'total' => $pl_total];
}
}
// in the DB the Diaspora versions have the format x.x.x.x-xx the last
// part (-xx) should be removed to clean up the versions from the "head
// commit" information and combined into a single entry for x.x.x.x
if ($p == 'Diaspora') {
$newV = [];
$newVv = [];
foreach ($v as $vv) {
$newVC = $vv['total'];
$newVV = $vv['version'];
$posDash = strpos($newVV, '-');
if ($posDash) {
$newVV = substr($newVV, 0, $posDash);
}
if (isset($newV[$newVV])) {
$newV[$newVV] += $newVC;
} else {
$newV[$newVV] = $newVC;
}
}
foreach ($newV as $key => $value) {
array_push($newVv, ['total' => $value, 'version' => $key]);
}
$v = $newVv;
}
// early friendica versions have the format x.x.xxxx where xxxx is the
// DB version stamp; those should be operated out and versions be
// conbined
if ($p == 'Friendi%%a') {
$newV = [];
$newVv = [];
foreach ($v as $vv) {
$newVC = $vv['total'];
$newVV = $vv['version'];
$lastDot = strrpos($newVV, '.');
$len = strlen($newVV) - 1;
if (($lastDot == $len - 4) && (!strrpos($newVV, '-rc') == $len - 3)) {
$newVV = substr($newVV, 0, $lastDot);
}
if (isset($newV[$newVV])) {
$newV[$newVV] += $newVC;
} else {
$newV[$newVV] = $newVC;
}
}
foreach ($newV as $key => $value) {
array_push($newVv, ['total' => $value, 'version' => $key]);
}
$v = $newVv;
}
// Assure that the versions are sorted correctly
$v2 = [];
$versions = [];
foreach ($v as $vv) {
$version = trim(strip_tags($vv["version"]));
$v2[$version] = $vv;
$versions[] = $version;
}
usort($versions, 'version_compare');
$v = [];
foreach ($versions as $version) {
$v[] = $v2[$version];
}
// the 3rd array item is needed for the JavaScript graphs as JS does
// not like some characters in the names of variables...
$counts[$p] = [$c[0], $v, str_replace([' ', '%'], '', $p), $colors[$p]];
}
// some helpful text
$intro = 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.');
$hint = L10n::t('The <em>Auto Discovered Contact Directory</em> feature is not enabled, it will improve the data displayed here.');
// load the template, replace the macros and return the page content
$t = Renderer::getMarkupTemplate('admin/federation.tpl');
return Renderer::replaceMacros($t, [
'$title' => L10n::t('Administration'),
'$page' => L10n::t('Federation Statistics'),
'$intro' => $intro,
'$hint' => $hint,
'$autoactive' => Config::get('system', 'poco_completion'),
'$counts' => $counts,
'$version' => FRIENDICA_VERSION,
'$legendtext' => L10n::t('Currently this node is aware of %d nodes with %d registered users from the following platforms:', $total, $users),
'$baseurl' => System::baseUrl(),
]);
}
/**
* @brief Admin Inspect Worker Queue Page
*

1
src/App/Router.php
View file

@ -120,6 +120,7 @@ class Router
$this->routeCollector->addGroup('/admin', function (RouteCollector $collector) {
$collector->addRoute(['GET'] , '[/]' , Module\Admin\Summary::class);
$collector->addRoute(['GET'] , '/federation' , Module\Admin\Federation::class);
});
}

200
src/Module/Admin/Federation.php Normal file
View file

@ -0,0 +1,200 @@
<?php
namespace Friendica\Module\Admin;
use Friendica\Core\Config;
use Friendica\Core\L10n;
use Friendica\Core\Renderer;
use Friendica\Core\System;
use Friendica\Database\DBA;
use Friendica\Module\BaseAdminModule;
class Federation extends BaseAdminModule
{
public static function content()
{
parent::content();
// get counts on active friendica, diaspora, redmatrix, hubzilla, gnu
// social and statusnet nodes this node is knowing
//
// We are looking for the following platforms in the DB, "Red" should find
// all variants of that platform ID string as the q() function is stripping
// off one % two of them are needed in the query
// Add more platforms if you like, when one returns 0 known nodes it is not
// displayed on the stats page.
$platforms = ['Friendi%%a', 'Diaspora', '%%red%%', 'Hubzilla', 'BlaBlaNet', 'GNU Social', 'StatusNet', 'Mastodon', 'Pleroma', 'socialhome', 'ganggo'];
$colors = [
'Friendi%%a' => '#ffc018', // orange from the logo
'Diaspora' => '#a1a1a1', // logo is black and white, makes a gray
'%%red%%' => '#c50001', // fire red from the logo
'Hubzilla' => '#43488a', // blue from the logo
'BlaBlaNet' => '#3B5998', // blue from the navbar at blablanet-dot-com
'GNU Social' => '#a22430', // dark red from the logo
'StatusNet' => '#789240', // the green from the logo (red and blue have already others
'Mastodon' => '#1a9df9', // blue from the Mastodon logo
'Pleroma' => '#E46F0F', // Orange from the text that is used on Pleroma instances
'socialhome' => '#52056b', // lilac from the Django Image used at the Socialhome homepage
'ganggo' => '#69d7e2', // from the favicon
];
$counts = [];
$total = 0;
$users = 0;
foreach ($platforms as $platform) {
// get a total count for the platform, the name and version of the
// highest version and the protocol tpe
$platformCountStmt = DBA::p('SELECT
COUNT(*) AS `total`,
SUM(`registered-users`) AS `users`,
ANY_VALUE(`platform`) AS `platform`,
ANY_VALUE(`network`) AS `network`,
MAX(`version`) AS `version` FROM `gserver`
WHERE `platform` LIKE ?
AND `last_contact` >= `last_failure`
ORDER BY `version` ASC', $platform);
$platformCount = DBA::fetch($platformCountStmt);
$total += $platformCount['total'];
$users += $platformCount['users'];
DBA::close($platformCountStmt);
// what versions for that platform do we know at all?
// again only the active nodes
$versionCountsStmt = DBA::p('SELECT
COUNT(*) AS `total`,
`version` FROM `gserver`
WHERE `last_contact` >= `last_failure`
AND `platform` LIKE ?
GROUP BY `version`
ORDER BY `version`;', $platform);
$versionCounts = DBA::toArray($versionCountsStmt);
//
// clean up version numbers
//
// some platforms do not provide version information, add a unkown there
// to the version string for the displayed list.
foreach ($versionCounts as $key => $value) {
if ($versionCounts[$key]['version'] == '') {
$versionCounts[$key] = ['total' => $versionCounts[$key]['total'], 'version' => L10n::t('unknown')];
}
}
// Reformat and compact version numbers
if ($platform == 'Pleroma') {
$compacted = [];
foreach ($versionCounts as $key => $value) {
$version = $versionCounts[$key]['version'];
$parts = explode(' ', trim($version));
do {
$part = array_pop($parts);
} while (!empty($parts) && ((strlen($part) >= 40) || (strlen($part) <= 3)));
if (!empty($part)) {
if (empty($compacted[$part])) {
$compacted[$part] = $versionCounts[$key]['total'];
} else {
$compacted[$part] += $versionCounts[$key]['total'];
}
}
}
$versionCounts = [];
foreach ($compacted as $version => $pl_total) {
$versionCounts[] = ['version' => $version, 'total' => $pl_total];
}
}
// in the DB the Diaspora versions have the format x.x.x.x-xx the last
// part (-xx) should be removed to clean up the versions from the "head
// commit" information and combined into a single entry for x.x.x.x
if ($platform == 'Diaspora') {
$newV = [];
$newVv = [];
foreach ($versionCounts as $vv) {
$newVC = $vv['total'];
$newVV = $vv['version'];
$posDash = strpos($newVV, '-');
if ($posDash) {
$newVV = substr($newVV, 0, $posDash);
}
if (isset($newV[$newVV])) {
$newV[$newVV] += $newVC;
} else {
$newV[$newVV] = $newVC;
}
}
foreach ($newV as $key => $value) {
array_push($newVv, ['total' => $value, 'version' => $key]);
}
$versionCounts = $newVv;
}
// early friendica versions have the format x.x.xxxx where xxxx is the
// DB version stamp; those should be operated out and versions be
// conbined
if ($platform == 'Friendi%%a') {
$newV = [];
$newVv = [];
foreach ($versionCounts as $vv) {
$newVC = $vv['total'];
$newVV = $vv['version'];
$lastDot = strrpos($newVV, '.');
$len = strlen($newVV) - 1;
if (($lastDot == $len - 4) && (!strrpos($newVV, '-rc') == $len - 3)) {
$newVV = substr($newVV, 0, $lastDot);
}
if (isset($newV[$newVV])) {
$newV[$newVV] += $newVC;
} else {
$newV[$newVV] = $newVC;
}
}
foreach ($newV as $key => $value) {
array_push($newVv, ['total' => $value, 'version' => $key]);
}
$versionCounts = $newVv;
}
// Assure that the versions are sorted correctly
$v2 = [];
$versions = [];
foreach ($versionCounts as $vv) {
$version = trim(strip_tags($vv["version"]));
$v2[$version] = $vv;
$versions[] = $version;
}
usort($versions, 'version_compare');
$versionCounts = [];
foreach ($versions as $version) {
$versionCounts[] = $v2[$version];
}
// the 3rd array item is needed for the JavaScript graphs as JS does
// not like some characters in the names of variables...
$counts[$platform] = [$platformCount, $versionCounts, str_replace([' ', '%'], '', $platform), $colors[$platform]];
}
// some helpful text
$intro = 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.');
$hint = L10n::t('The <em>Auto Discovered Contact Directory</em> feature is not enabled, it will improve the data displayed here.');
// load the template, replace the macros and return the page content
$t = Renderer::getMarkupTemplate('admin/federation.tpl');
return Renderer::replaceMacros($t, [
'$title' => L10n::t('Administration'),
'$page' => L10n::t('Federation Statistics'),
'$intro' => $intro,
'$hint' => $hint,
'$autoactive' => Config::get('system', 'poco_completion'),
'$counts' => $counts,
'$version' => FRIENDICA_VERSION,
'$legendtext' => L10n::t('Currently this node is aware of %d nodes with %d registered users from the following platforms:', $total, $users),
'$baseurl' => System::baseUrl(),
]);
}
}

3
src/Module/BaseAdminModule.php
View file

@ -7,7 +7,7 @@ use Friendica\Core\L10n;
use Friendica\Core\Renderer;
use Friendica\Database\DBA;
class BaseAdminModule extends BaseModule
abstract class BaseAdminModule extends BaseModule
{
public static function post()
{
@ -50,6 +50,7 @@ class BaseAdminModule extends BaseModule
$aside_sub = [
'information' => [L10n::t('Information'), [
'overview' => ['admin' , L10n::t('Overview') , 'overview'],
'federation' => ['admin/federation' , L10n::t('Federation Statistics') , 'federation']
]],
];