From a201391d1138351153b1e604a21ca7049f3721c2 Mon Sep 17 00:00:00 2001 From: Hypolite Petovan Date: Thu, 25 Apr 2019 23:47:10 -0400 Subject: [PATCH] Move admin/dbsync to src/Module --- mod/admin.php | 101 ---------------- src/App/Router.php | 4 + src/Module/Admin/DBSync.php | 108 ++++++++++++++++++ src/Module/BaseAdminModule.php | 1 + .../{ => admin/dbsync}/failed_updates.tpl | 0 .../{ => admin/dbsync}/structure_check.tpl | 0 6 files changed, 113 insertions(+), 101 deletions(-) create mode 100644 src/Module/Admin/DBSync.php rename view/templates/{ => admin/dbsync}/failed_updates.tpl (100%) rename view/templates/{ => admin/dbsync}/structure_check.tpl (100%) diff --git a/mod/admin.php b/mod/admin.php index 71089cc39a..1632f7c0aa 100644 --- a/mod/admin.php +++ b/mod/admin.php @@ -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) . "
"; - 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) . "
"; - } - 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) . "
"; - 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 diff --git a/src/App/Router.php b/src/App/Router.php index 47f71c988e..6352a18130 100644 --- a/src/App/Router.php +++ b/src/App/Router.php @@ -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); diff --git a/src/Module/Admin/DBSync.php b/src/Module/Admin/DBSync.php new file mode 100644 index 0000000000..c62fefe4c1 --- /dev/null +++ b/src/Module/Admin/DBSync.php @@ -0,0 +1,108 @@ +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) . "
"; + 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) . "
"; + } + 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) . "
"; + 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; + } +} \ No newline at end of file diff --git a/src/Module/BaseAdminModule.php b/src/Module/BaseAdminModule.php index dc94473812..7ad36e8cc3 100644 --- a/src/Module/BaseAdminModule.php +++ b/src/Module/BaseAdminModule.php @@ -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'], ]], diff --git a/view/templates/failed_updates.tpl b/view/templates/admin/dbsync/failed_updates.tpl similarity index 100% rename from view/templates/failed_updates.tpl rename to view/templates/admin/dbsync/failed_updates.tpl diff --git a/view/templates/structure_check.tpl b/view/templates/admin/dbsync/structure_check.tpl similarity index 100% rename from view/templates/structure_check.tpl rename to view/templates/admin/dbsync/structure_check.tpl