Refactor server pages common code

Extracts server_common.inc.php code to the Common::server() method and removes the include file. Signed-off-by: Maurício Meneghini Fauth <mauricio@fauth.dev>
phpmyadmin · Jan 8, 2020 · a1bcb9f · a1bcb9f
1 parent 59ce2db
commit a1bcb9f
Show file tree

Hide file tree

Showing 21 changed files with 97 additions and 71 deletions.
diff --git a/libraries/classes/Common.php b/libraries/classes/Common.php
@@ -0,0 +1,52 @@
+<?php
+/**
+ * @package PhpMyAdmin
+ */
+declare(strict_types=1);
+
+namespace PhpMyAdmin;
+
+/**
+ * Shared code for server pages.
+ *
+ * @package PhpMyAdmin
+ */
+final class Common
+{
+    /**
+     * @return void
+     */
+    public static function server(): void
+    {
+        global $db, $table, $url_query, $viewing_mode, $err_url, $is_grantuser, $is_createuser, $dbi;
+
+        /**
+         * Handles some variables that may have been sent by the calling script
+         * Note: this can be called also from the db panel to get the privileges of
+         *       a db, in which case we want to keep displaying the tabs of
+         *       the Database panel
+         */
+        if (empty($viewing_mode)) {
+            $db = '';
+            $table = '';
+        }
+
+        /**
+         * Set parameters for links
+         */
+        $url_query = Url::getCommon();
+
+        /**
+         * Defines the urls to return to in case of error in a sql statement
+         */
+        $err_url = Url::getFromRoute('/');
+
+        $is_grantuser = $dbi->isUserType('grant');
+        $is_createuser = $dbi->isUserType('create');
+
+        // now, select the mysql db
+        if ($dbi->isSuperuser()) {
+            $dbi->selectDb('mysql');
+        }
+    }
+}
diff --git a/libraries/classes/Controllers/HomeController.php b/libraries/classes/Controllers/HomeController.php
@@ -12,6 +12,7 @@
 use PhpMyAdmin\Charsets\Charset;
 use PhpMyAdmin\Charsets\Collation;
 use PhpMyAdmin\CheckUserPrivileges;
+use PhpMyAdmin\Common;
 use PhpMyAdmin\Config;
 use PhpMyAdmin\DatabaseInterface;
 use PhpMyAdmin\Display\GitRevision;
@@ -76,7 +77,7 @@ public function index(array $params): string
         $show_query = '1';
 
         if ($server > 0) {
-            include ROOT_PATH . 'libraries/server_common.inc.php';
+            Common::server();
         }
 
         $languageManager = LanguageManager::getInstance();

diff --git a/libraries/classes/Controllers/Server/BinlogController.php b/libraries/classes/Controllers/Server/BinlogController.php
@@ -8,6 +8,7 @@
 
 namespace PhpMyAdmin\Controllers\Server;
 
+use PhpMyAdmin\Common;
 use PhpMyAdmin\Controllers\AbstractController;
 use PhpMyAdmin\DatabaseInterface;
 use PhpMyAdmin\Html\Generator;
@@ -58,7 +59,7 @@ public function index(array $params): string
     {
         global $cfg, $pmaThemeImage;
 
-        include_once ROOT_PATH . 'libraries/server_common.inc.php';
+        Common::server();
 
         $position = ! empty($params['pos']) ? (int) $params['pos'] : 0;
 

diff --git a/libraries/classes/Controllers/Server/CollationsController.php b/libraries/classes/Controllers/Server/CollationsController.php
@@ -11,6 +11,7 @@
 use PhpMyAdmin\Charsets;
 use PhpMyAdmin\Charsets\Charset;
 use PhpMyAdmin\Charsets\Collation;
+use PhpMyAdmin\Common;
 use PhpMyAdmin\Controllers\AbstractController;
 use PhpMyAdmin\DatabaseInterface;
 use PhpMyAdmin\Response;
@@ -68,7 +69,7 @@ public function __construct(
      */
     public function index(): string
     {
-        include_once ROOT_PATH . 'libraries/server_common.inc.php';
+        Common::server();
 
         $charsets = [];
         /** @var Charset $charset */

diff --git a/libraries/classes/Controllers/Server/DatabasesController.php b/libraries/classes/Controllers/Server/DatabasesController.php
@@ -12,6 +12,7 @@
 use PhpMyAdmin\Charsets\Charset;
 use PhpMyAdmin\Charsets\Collation;
 use PhpMyAdmin\CheckUserPrivileges;
+use PhpMyAdmin\Common;
 use PhpMyAdmin\Controllers\AbstractController;
 use PhpMyAdmin\DatabaseInterface;
 use PhpMyAdmin\Html\Generator;
@@ -88,7 +89,7 @@ public function index(array $params): string
         $scripts = $header->getScripts();
         $scripts->addFile('server/databases.js');
 
-        include_once ROOT_PATH . 'libraries/server_common.inc.php';
+        Common::server();
         ReplicationInfo::load();
 
         $this->setSortDetails($params['sort_by'], $params['sort_order']);

diff --git a/libraries/classes/Controllers/Server/EnginesController.php b/libraries/classes/Controllers/Server/EnginesController.php
@@ -8,6 +8,7 @@
 
 namespace PhpMyAdmin\Controllers\Server;
 
+use PhpMyAdmin\Common;
 use PhpMyAdmin\Controllers\AbstractController;
 use PhpMyAdmin\StorageEngine;
 
@@ -25,7 +26,7 @@ class EnginesController extends AbstractController
      */
     public function index(): string
     {
-        require ROOT_PATH . 'libraries/server_common.inc.php';
+        Common::server();
 
         return $this->template->render('server/engines/index', [
             'engines' => StorageEngine::getStorageEngines(),
@@ -41,7 +42,7 @@ public function index(): string
      */
     public function show(array $params): string
     {
-        require ROOT_PATH . 'libraries/server_common.inc.php';
+        Common::server();
 
         $page = $params['page'] ?? '';
 

diff --git a/libraries/classes/Controllers/Server/ExportController.php b/libraries/classes/Controllers/Server/ExportController.php
@@ -6,6 +6,7 @@
 
 namespace PhpMyAdmin\Controllers\Server;
 
+use PhpMyAdmin\Common;
 use PhpMyAdmin\Config\PageSettings;
 use PhpMyAdmin\Controllers\AbstractController;
 use PhpMyAdmin\DatabaseInterface;
@@ -41,7 +42,7 @@ public function index(): void
         global $db, $table, $sql_query, $num_tables, $unlim_num_rows;
         global $tmp_select, $select_item, $multi_values, $export_page_title;
 
-        require_once ROOT_PATH . 'libraries/server_common.inc.php';
+        Common::server();
 
         PageSettings::showGroup('Export');
 

diff --git a/libraries/classes/Controllers/Server/ImportController.php b/libraries/classes/Controllers/Server/ImportController.php
@@ -6,6 +6,7 @@
 
 namespace PhpMyAdmin\Controllers\Server;
 
+use PhpMyAdmin\Common;
 use PhpMyAdmin\Config\PageSettings;
 use PhpMyAdmin\Controllers\AbstractController;
 use PhpMyAdmin\Display\Import;
@@ -28,7 +29,7 @@ public function index(): void
         $scripts = $header->getScripts();
         $scripts->addFile('import.js');
 
-        require ROOT_PATH . 'libraries/server_common.inc.php';
+        Common::server();
 
         $this->response->addHTML(Import::get(
             'server',

diff --git a/libraries/classes/Controllers/Server/PluginsController.php b/libraries/classes/Controllers/Server/PluginsController.php
@@ -9,6 +9,7 @@
 
 namespace PhpMyAdmin\Controllers\Server;
 
+use PhpMyAdmin\Common;
 use PhpMyAdmin\Controllers\AbstractController;
 use PhpMyAdmin\DatabaseInterface;
 use PhpMyAdmin\Response;
@@ -46,7 +47,7 @@ public function __construct($response, $dbi, Template $template, Plugins $plugin
      */
     public function index(): string
     {
-        include ROOT_PATH . 'libraries/server_common.inc.php';
+        Common::server();
 
         $header = $this->response->getHeader();
         $scripts = $header->getScripts();

diff --git a/libraries/classes/Controllers/Server/PrivilegesController.php b/libraries/classes/Controllers/Server/PrivilegesController.php
@@ -7,6 +7,7 @@
 namespace PhpMyAdmin\Controllers\Server;
 
 use PhpMyAdmin\CheckUserPrivileges;
+use PhpMyAdmin\Common;
 use PhpMyAdmin\Controllers\AbstractController;
 use PhpMyAdmin\Controllers\Database\PrivilegesController as DatabaseController;
 use PhpMyAdmin\Controllers\Table\PrivilegesController as TableController;
@@ -116,7 +117,7 @@ public function index(): void
 
         Core::setPostAsGlobal($post_patterns);
 
-        require ROOT_PATH . 'libraries/server_common.inc.php';
+        Common::server();
 
         /**
          * Messages are built using the message name

diff --git a/libraries/classes/Controllers/Server/ReplicationController.php b/libraries/classes/Controllers/Server/ReplicationController.php
@@ -8,6 +8,7 @@
 
 namespace PhpMyAdmin\Controllers\Server;
 
+use PhpMyAdmin\Common;
 use PhpMyAdmin\Controllers\AbstractController;
 use PhpMyAdmin\DatabaseInterface;
 use PhpMyAdmin\ReplicationGui;
@@ -46,7 +47,7 @@ public function index(array $params): string
     {
         global $replication_info, $server_slave_replication, $url_params;
 
-        require_once ROOT_PATH . 'libraries/server_common.inc.php';
+        Common::server();
         ReplicationInfo::load();
 
         $header = $this->response->getHeader();

diff --git a/libraries/classes/Controllers/Server/SqlController.php b/libraries/classes/Controllers/Server/SqlController.php
@@ -8,6 +8,7 @@
 
 namespace PhpMyAdmin\Controllers\Server;
 
+use PhpMyAdmin\Common;
 use PhpMyAdmin\Config\PageSettings;
 use PhpMyAdmin\Controllers\AbstractController;
 use PhpMyAdmin\DatabaseInterface;
@@ -50,7 +51,7 @@ public function index(): string
 
         PageSettings::showGroup('Sql');
 
-        require_once ROOT_PATH . 'libraries/server_common.inc.php';
+        Common::server();
 
         return $this->sqlQueryForm->getHtml();
     }

diff --git a/libraries/classes/Controllers/Server/Status/MonitorController.php b/libraries/classes/Controllers/Server/Status/MonitorController.php
@@ -8,6 +8,7 @@
 
 namespace PhpMyAdmin\Controllers\Server\Status;
 
+use PhpMyAdmin\Common;
 use PhpMyAdmin\DatabaseInterface;
 use PhpMyAdmin\Response;
 use PhpMyAdmin\Server\Status\Data;
@@ -43,7 +44,7 @@ public function __construct($response, $dbi, Template $template, $data, $monitor
      */
     public function index(): string
     {
-        require_once ROOT_PATH . 'libraries/server_common.inc.php';
+        Common::server();
 
         $header = $this->response->getHeader();
         $scripts = $header->getScripts();
@@ -89,7 +90,7 @@ public function index(): string
      */
     public function chartingData(array $params): array
     {
-        require_once ROOT_PATH . 'libraries/server_common.inc.php';
+        Common::server();
 
         if (! $this->response->isAjax()) {
             return [];
@@ -110,7 +111,7 @@ public function chartingData(array $params): array
      */
     public function logDataTypeSlow(array $params): array
     {
-        require_once ROOT_PATH . 'libraries/server_common.inc.php';
+        Common::server();
 
         if (! $this->response->isAjax()) {
             return [];
@@ -132,7 +133,7 @@ public function logDataTypeSlow(array $params): array
      */
     public function logDataTypeGeneral(array $params): array
     {
-        require_once ROOT_PATH . 'libraries/server_common.inc.php';
+        Common::server();
 
         if (! $this->response->isAjax()) {
             return [];
@@ -156,7 +157,7 @@ public function logDataTypeGeneral(array $params): array
      */
     public function loggingVars(array $params): array
     {
-        require_once ROOT_PATH . 'libraries/server_common.inc.php';
+        Common::server();
 
         if (! $this->response->isAjax()) {
             return [];
@@ -178,7 +179,7 @@ public function loggingVars(array $params): array
      */
     public function queryAnalyzer(array $params): array
     {
-        require_once ROOT_PATH . 'libraries/server_common.inc.php';
+        Common::server();
 
         if (! $this->response->isAjax()) {
             return [];

diff --git a/libraries/classes/Controllers/Server/Status/ProcessesController.php b/libraries/classes/Controllers/Server/Status/ProcessesController.php
@@ -8,6 +8,7 @@
 
 namespace PhpMyAdmin\Controllers\Server\Status;
 
+use PhpMyAdmin\Common;
 use PhpMyAdmin\Html\Generator;
 use PhpMyAdmin\Message;
 use PhpMyAdmin\Util;
@@ -24,7 +25,7 @@ class ProcessesController extends AbstractController
      */
     public function index(array $params): string
     {
-        require_once ROOT_PATH . 'libraries/server_common.inc.php';
+        Common::server();
 
         $header = $this->response->getHeader();
         $scripts = $header->getScripts();

diff --git a/libraries/classes/Controllers/Server/Status/QueriesController.php b/libraries/classes/Controllers/Server/Status/QueriesController.php
@@ -8,6 +8,8 @@
 
 namespace PhpMyAdmin\Controllers\Server\Status;
 
+use PhpMyAdmin\Common;
+
 /**
  * @package PhpMyAdmin\Controllers\Server\Status
  */
@@ -18,7 +20,7 @@ class QueriesController extends AbstractController
      */
     public function index(): string
     {
-        require_once ROOT_PATH . 'libraries/server_common.inc.php';
+        Common::server();
 
         $header = $this->response->getHeader();
         $scripts = $header->getScripts();

diff --git a/libraries/classes/Controllers/Server/Status/StatusController.php b/libraries/classes/Controllers/Server/Status/StatusController.php
@@ -8,6 +8,7 @@
 
 namespace PhpMyAdmin\Controllers\Server\Status;
 
+use PhpMyAdmin\Common;
 use PhpMyAdmin\DatabaseInterface;
 use PhpMyAdmin\ReplicationGui;
 use PhpMyAdmin\Response;
@@ -45,7 +46,7 @@ public function index(): string
     {
         global $replication_info;
 
-        require_once ROOT_PATH . 'libraries/server_common.inc.php';
+        Common::server();
 
         $traffic = [];
         $connections = [];

diff --git a/libraries/classes/Controllers/Server/Status/VariablesController.php b/libraries/classes/Controllers/Server/Status/VariablesController.php
@@ -8,6 +8,7 @@
 
 namespace PhpMyAdmin\Controllers\Server\Status;
 
+use PhpMyAdmin\Common;
 use PhpMyAdmin\Html\Generator;
 
 /**
@@ -22,7 +23,7 @@ class VariablesController extends AbstractController
      */
     public function index(array $params): string
     {
-        require_once ROOT_PATH . 'libraries/server_common.inc.php';
+        Common::server();
 
         $header = $this->response->getHeader();
         $scripts = $header->getScripts();

diff --git a/libraries/classes/Controllers/Server/VariablesController.php b/libraries/classes/Controllers/Server/VariablesController.php
@@ -8,6 +8,7 @@
 
 namespace PhpMyAdmin\Controllers\Server;
 
+use PhpMyAdmin\Common;
 use PhpMyAdmin\Controllers\AbstractController;
 use PhpMyAdmin\Html\Generator;
 use PhpMyAdmin\Util;
@@ -30,7 +31,7 @@ class VariablesController extends AbstractController
      */
     public function index(array $params): string
     {
-        include ROOT_PATH . 'libraries/server_common.inc.php';
+        Common::server();
 
         $filterValue = ! empty($params['filter']) ? $params['filter'] : '';