Move admin/dbsync to src/Module

This commit is contained in:
Hypolite Petovan 2019-04-25 23:47:10 -04:00
parent df947ba9db
commit a201391d11
6 changed files with 113 additions and 101 deletions

View file

@ -166,9 +166,6 @@ function admin_content(App $a)
// urls
if ($a->argc > 1) {
switch ($a->argv[1]) {
case 'dbsync':
$o = admin_page_dbsync($a);
break;
case 'deleteitem':
$o = admin_page_deleteitem($a);
break;
@ -246,104 +243,6 @@ function admin_page_deleteitem_post(App $a)
return; // NOTREACHED
}
/**
* @brief Generates admin panel subpage for DB syncronization
*
* This page checks if the database of friendica is in sync with the specs.
* Should this not be the case, it attemps to sync the structure and notifies
* the admin if the automatic process was failing.
*
* The returned string holds the HTML code of the page.
*
* @param App $a
* @return string
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
function admin_page_dbsync(App $a)
{
$o = '';
if ($a->argc > 3 && intval($a->argv[3]) && $a->argv[2] === 'mark') {
Config::set('database', 'update_' . intval($a->argv[3]), 'success');
$curr = Config::get('system', 'build');
if (intval($curr) == intval($a->argv[3])) {
Config::set('system', 'build', intval($curr) + 1);
}
info(L10n::t('Update has been marked successful') . EOL);
$a->internalRedirect('admin/dbsync');
}
if (($a->argc > 2) && (intval($a->argv[2]) || ($a->argv[2] === 'check'))) {
$retval = DBStructure::update($a->getBasePath(), false, true);
if ($retval === '') {
$o .= L10n::t("Database structure update %s was successfully applied.", DB_UPDATE_VERSION) . "<br />";
Config::set('database', 'last_successful_update', DB_UPDATE_VERSION);
Config::set('database', 'last_successful_update_time', time());
} else {
$o .= L10n::t("Executing of database structure update %s failed with error: %s", DB_UPDATE_VERSION, $retval) . "<br />";
}
if ($a->argv[2] === 'check') {
return $o;
}
}
if ($a->argc > 2 && intval($a->argv[2])) {
require_once 'update.php';
$func = 'update_' . intval($a->argv[2]);
if (function_exists($func)) {
$retval = $func();
if ($retval === Update::FAILED) {
$o .= L10n::t("Executing %s failed with error: %s", $func, $retval);
} elseif ($retval === Update::SUCCESS) {
$o .= L10n::t('Update %s was successfully applied.', $func);
Config::set('database', $func, 'success');
} else {
$o .= L10n::t('Update %s did not return a status. Unknown if it succeeded.', $func);
}
} else {
$o .= L10n::t('There was no additional update function %s that needed to be called.', $func) . "<br />";
Config::set('database', $func, 'success');
}
return $o;
}
$failed = [];
$r = q("SELECT `k`, `v` FROM `config` WHERE `cat` = 'database' ");
if (DBA::isResult($r)) {
foreach ($r as $rr) {
$upd = intval(substr($rr['k'], 7));
if ($upd < 1139 || $rr['v'] === 'success') {
continue;
}
$failed[] = $upd;
}
}
if (!count($failed)) {
$o = Renderer::replaceMacros(Renderer::getMarkupTemplate('structure_check.tpl'), [
'$base' => System::baseUrl(true),
'$banner' => L10n::t('No failed updates.'),
'$check' => L10n::t('Check database structure'),
]);
} else {
$o = Renderer::replaceMacros(Renderer::getMarkupTemplate('failed_updates.tpl'), [
'$base' => System::baseUrl(true),
'$banner' => L10n::t('Failed Updates'),
'$desc' => L10n::t('This does not include updates prior to 1139, which did not return a status.'),
'$mark' => L10n::t("Mark success \x28if update was manually applied\x29"),
'$apply' => L10n::t('Attempt to execute this update step automatically'),
'$failed' => $failed
]);
}
return $o;
}
function admin_page_server_vital()
{
// Fetch the host-meta to check if this really is a vital server

View file

@ -127,6 +127,10 @@ class Router
$collector->addRoute(['GET', 'POST'], '/blocklist/contact' , Module\Admin\Blocklist\Contact::class);
$collector->addRoute(['GET', 'POST'], '/blocklist/server' , Module\Admin\Blocklist\Server::class);
$collector->addRoute(['GET'] , '/dbsync[/check]' , Module\Admin\DBSync::class);
$collector->addRoute(['GET'] , '/dbsync/{update:\d+}' , Module\Admin\DBSync::class);
$collector->addRoute(['GET'] , '/dbsync/mark/{update:\d+}', Module\Admin\DBSync::class);
$collector->addRoute(['GET', 'POST'], '/features' , Module\Admin\Features::class);
$collector->addRoute(['GET'] , '/federation' , Module\Admin\Federation::class);

108
src/Module/Admin/DBSync.php Normal file
View file

@ -0,0 +1,108 @@
<?php
namespace Friendica\Module\Admin;
use Friendica\Core\Config;
use Friendica\Core\L10n;
use Friendica\Core\Renderer;
use Friendica\Core\System;
use Friendica\Core\Update;
use Friendica\Database\DBA;
use Friendica\Database\DBStructure;
use Friendica\Module\BaseAdminModule;
use Friendica\Util\Strings;
class DBSync extends BaseAdminModule
{
public static function content()
{
parent::content();
$a = self::getApp();
$o = '';
if ($a->argc > 3 && $a->argv[2] === 'mark') {
// @TODO: Replace with parameter from router
$update = intval($a->argv[3]);
if ($update) {
Config::set('database', 'update_' . $update, 'success');
$curr = Config::get('system', 'build');
if (intval($curr) == $update) {
Config::set('system', 'build', intval($curr) + 1);
}
info(L10n::t('Update has been marked successful') . EOL);
}
$a->internalRedirect('admin/dbsync');
}
if ($a->argc > 2) {
if ($a->argv[2] === 'check') {
$retval = DBStructure::update($a->getBasePath(), false, true);
if ($retval === '') {
$o .= L10n::t("Database structure update %s was successfully applied.", DB_UPDATE_VERSION) . "<br />";
Config::set('database', 'last_successful_update', DB_UPDATE_VERSION);
Config::set('database', 'last_successful_update_time', time());
} else {
$o .= L10n::t("Executing of database structure update %s failed with error: %s", DB_UPDATE_VERSION, $retval) . "<br />";
}
if ($a->argv[2] === 'check') {
return $o;
}
} elseif (intval($a->argv[2])) {
require_once 'update.php';
// @TODO: Replace with parameter from router
$update = intval($a->argv[2]);
$func = 'update_' . $update;
if (function_exists($func)) {
$retval = $func();
if ($retval === Update::FAILED) {
$o .= L10n::t("Executing %s failed with error: %s", $func, $retval);
} elseif ($retval === Update::SUCCESS) {
$o .= L10n::t('Update %s was successfully applied.', $func);
Config::set('database', $func, 'success');
} else {
$o .= L10n::t('Update %s did not return a status. Unknown if it succeeded.', $func);
}
} else {
$o .= L10n::t('There was no additional update function %s that needed to be called.', $func) . "<br />";
Config::set('database', $func, 'success');
}
return $o;
}
}
$failed = [];
$configStmt = DBA::select('config', ['k', 'v'], ['cat' => 'database']);
while ($config = DBA::fetch($configStmt)) {
$upd = intval(substr($config['k'], 7));
if ($upd >= 1139 && $config['v'] != 'success') {
$failed[] = $upd;
}
}
if (!count($failed)) {
$o = Renderer::replaceMacros(Renderer::getMarkupTemplate('admin/dbsync/structure_check.tpl'), [
'$base' => System::baseUrl(true),
'$banner' => L10n::t('No failed updates.'),
'$check' => L10n::t('Check database structure'),
]);
} else {
$o = Renderer::replaceMacros(Renderer::getMarkupTemplate('admin/dbsync/failed_updates.tpl'), [
'$base' => System::baseUrl(true),
'$banner' => L10n::t('Failed Updates'),
'$desc' => L10n::t('This does not include updates prior to 1139, which did not return a status.'),
'$mark' => L10n::t("Mark success \x28if update was manually applied\x29"),
'$apply' => L10n::t('Attempt to execute this update step automatically'),
'$failed' => $failed
]);
}
return $o;
}
}

View file

@ -61,6 +61,7 @@ abstract class BaseAdminModule extends BaseModule
'tos' => ['admin/tos' , L10n::t('Terms of Service') , 'tos'],
]],
'database' => [L10n::t('Database'), [
'dbsync' => ['admin/dbsync' , L10n::t('DB updates') , 'dbsync'],
'deferred' => ['admin/queue/deferred', L10n::t('Inspect Deferred Workers'), 'deferred'],
'workerqueue' => ['admin/queue' , L10n::t('Inspect worker Queue') , 'workerqueue'],
]],