From d8afd9254898ea9065712a8f57b3aeec3c5e1270 Mon Sep 17 00:00:00 2001
From: xmujay <xmujay@gmail.com>
Date: Mon, 24 Jun 2013 22:38:42 +0800
Subject: [PATCH 1/2] refactor server_engines.php

---
 libraries/server_engines.lib.php | 152 +++++++++++++++++++++++++++++
 server_engines.php               | 158 +++----------------------------
 2 files changed, 163 insertions(+), 147 deletions(-)
 create mode 100644 libraries/server_engines.lib.php

diff --git a/libraries/server_engines.lib.php b/libraries/server_engines.lib.php
new file mode 100644
index 0000000000..9d0d112a35
--- /dev/null
+++ b/libraries/server_engines.lib.php
@@ -0,0 +1,152 @@
+<?php
+/* vim: set expandtab sw=4 ts=4 sts=4: */
+
+/**
+ * functions for displaying server engines
+ *
+ * @usedby  server_engines.php
+ *  
+ * @package PhpMyAdmin
+ */
+if (! defined('PHPMYADMIN')) {
+    exit;
+}
+
+/**
+ * setup HTML for server Engines information
+ *
+ * @param null
+ *
+ * @return string
+ */
+function PMA_getHtmlForServerEngines()
+{
+    /**
+     * Did the user request information about a certain storage engine?
+     */
+    $html = '';
+    if (empty($_REQUEST['engine'])
+        || ! PMA_StorageEngine::isValid($_REQUEST['engine'])
+    ) {
+        $html .= PMA_getHtmlForAllServerEngines();    
+    } else {
+        $html .= PMA_getHtmlForSpecifiedServerEngines();
+    }
+    
+    return $html;
+}
+
+/**
+ * setup HTML for server all Engines information
+ *
+ * @param null
+ *
+ * @return string
+ */
+function PMA_getHtmlForAllServerEngines()
+{
+    /**
+     * Displays the table header
+     */
+    $html = '<table class="noclick">' . "\n"
+        . '<thead>' . "\n"
+        . '<tr><th>' . __('Storage Engine') . '</th>' . "\n"
+        . '    <th>' . __('Description') . '</th>' . "\n"
+        . '</tr>' . "\n"
+        . '</thead>' . "\n"
+        . '<tbody>' . "\n";
+
+
+    /**
+     * Listing the storage engines
+     */
+    $odd_row = true;
+    foreach (PMA_StorageEngine::getStorageEngines() as $engine => $details) {
+        $html .= '<tr class="'
+            . ($odd_row ? 'odd' : 'even')
+            . ($details['Support'] == 'NO' || $details['Support'] == 'DISABLED'
+                ? ' disabled' : '')
+            . '">' . "\n"
+            . '    <td><a rel="newpage" href="server_engines.php'
+            . PMA_generate_common_url(array('engine' => $engine)) . '">' . "\n"
+            . '            ' . htmlspecialchars($details['Engine']) . "\n"
+            . '        </a></td>' . "\n"
+            . '    <td>' . htmlspecialchars($details['Comment']) . '</td>' . "\n"
+            . '</tr>' . "\n";
+        $odd_row = !$odd_row;
+    }
+
+    unset($odd_row, $engine, $details);
+    $html .= '</tbody>' . "\n"
+        . '</table>' . "\n";
+    
+    return $html;
+}
+
+/**
+ * setup HTML for a given Storage Engine
+ *
+ * @param null
+ *
+ * @return string
+ */
+function PMA_getHtmlForSpecifiedServerEngines()
+{
+    /**
+     * Displays details about a given Storage Engine
+     */
+    $html = ''; 
+    $engine_plugin = PMA_StorageEngine::getEngine($_REQUEST['engine']);
+    $html .= '<h2>' . "\n"
+        . PMA_Util::getImage('b_engine.png')
+        . '    ' . htmlspecialchars($engine_plugin->getTitle()) . "\n"
+        . '    ' . PMA_Util::showMySQLDocu('', $engine_plugin->getMysqlHelpPage())
+        . "\n" . '</h2>' . "\n\n";
+    $html .= '<p>' . "\n"
+        . '    <em>' . "\n"
+        . '        ' . htmlspecialchars($engine_plugin->getComment()) . "\n"
+        . '    </em>' . "\n"
+        . '</p>' . "\n\n";
+    $infoPages = $engine_plugin->getInfoPages();
+    if (! empty($infoPages) && is_array($infoPages)) {
+        $html .= '<p>' . "\n"
+            . '    <strong>[</strong>' . "\n";
+        if (empty($_REQUEST['page'])) {
+            $html .= '    <strong>' . __('Variables') . '</strong>' . "\n";
+        } else {
+            $html .= '    <a href="server_engines.php'
+                . PMA_generate_common_url(array('engine' => $_REQUEST['engine']))
+                . '">' . __('Variables') . '</a>' . "\n";
+        }
+        foreach ($infoPages as $current => $label) {
+            $html .= '    <strong>|</strong>' . "\n";
+            if (isset($_REQUEST['page']) && $_REQUEST['page'] == $current) {
+                $html .= '    <strong>' . $label . '</strong>' . "\n";
+            } else {
+                $html .= '    <a href="server_engines.php'
+                    . PMA_generate_common_url(
+                        array('engine' => $_REQUEST['engine'], 'page' => $current)
+                    )
+                    . '">' . htmlspecialchars($label) . '</a>' . "\n";
+            }
+        }
+        unset($current, $label);
+        $html .= '    <strong>]</strong>' . "\n"
+            . '</p>' . "\n\n";
+    }
+    unset($infoPages, $page_output);
+    if (! empty($_REQUEST['page'])) {
+        $page_output = $engine_plugin->getPage($_REQUEST['page']);
+    }
+    if (! empty($page_output)) {
+        $html .= $page_output;
+    } else {
+        $html .= '<p> ' . $engine_plugin->getSupportInformationMessage() . "\n"
+           . '</p>' . "\n"
+           . $engine_plugin->getHtmlVariables();
+    }
+    
+    return $html;
+}
+
+?>
diff --git a/server_engines.php b/server_engines.php
index fca316e42f..fe26cbb7d1 100644
--- a/server_engines.php
+++ b/server_engines.php
@@ -16,159 +16,23 @@ require_once 'libraries/common.inc.php';
  */
 require 'libraries/server_common.inc.php';
 require 'libraries/StorageEngine.class.php';
+require 'libraries/server_engines.lib.php';
 
+/**
+ * Displays the sub-page heading
+ */
+$html = '<h2>' . "\n"
+    . PMA_Util::getImage('b_engine.png')
+    . "\n" . __('Storage Engines') . "\n"
+    . '</h2>' . "\n";
+        
 /**
  * start output
  */
 $response = PMA_Response::getInstance();
-$response->addHTML(PMA_getServerEnginesHtml());
+$response->addHTML($html);
+$response->addHTML(PMA_getHtmlForServerEngines());
 
 exit;
 
-
-/**
- * setup HTML for server Engines information
- *
- * @param null
- *
- * @return string
- */
-function PMA_getServerEnginesHtml()
-{
-    /**
-     * Did the user request information about a certain storage engine?
-     */
-    $html = '';
-    if (empty($_REQUEST['engine'])
-        || ! PMA_StorageEngine::isValid($_REQUEST['engine'])
-    ) {
-        $html .= PMA_getAllServerEnginesHtml();    
-    } else {
-        $html .= PMA_getSpecifiedServerEnginesHtml();
-    }
-    
-    return $html;
-}
-
-/**
- * setup HTML for server all Engines information
- *
- * @param null
- *
- * @return string
- */
-function PMA_getAllServerEnginesHtml()
-{
-    /**
-     * Displays the sub-page heading
-     */
-    $html = '<h2>' . "\n"
-        . PMA_Util::getImage('b_engine.png')
-        . "\n" . __('Storage Engines') . "\n"
-        . '</h2>' . "\n";
-
-    /**
-     * Displays the table header
-     */
-    $html .= '<table class="noclick">' . "\n"
-        . '<thead>' . "\n"
-        . '<tr><th>' . __('Storage Engine') . '</th>' . "\n"
-        . '    <th>' . __('Description') . '</th>' . "\n"
-        . '</tr>' . "\n"
-        . '</thead>' . "\n"
-        . '<tbody>' . "\n";
-
-
-    /**
-     * Listing the storage engines
-     */
-    $odd_row = true;
-    foreach (PMA_StorageEngine::getStorageEngines() as $engine => $details) {
-        $html .= '<tr class="'
-            . ($odd_row ? 'odd' : 'even')
-            . ($details['Support'] == 'NO' || $details['Support'] == 'DISABLED'
-                ? ' disabled' : '')
-            . '">' . "\n"
-            . '    <td><a rel="newpage" href="server_engines.php'
-            . PMA_generate_common_url(array('engine' => $engine)) . '">' . "\n"
-            . '            ' . htmlspecialchars($details['Engine']) . "\n"
-            . '        </a></td>' . "\n"
-            . '    <td>' . htmlspecialchars($details['Comment']) . '</td>' . "\n"
-            . '</tr>' . "\n";
-        $odd_row = !$odd_row;
-    }
-
-    unset($odd_row, $engine, $details);
-    $html .= '</tbody>' . "\n"
-        . '</table>' . "\n";
-    
-    return $html;
-}
-
-/**
- * setup HTML for a given Storage Engine
- *
- * @param null
- *
- * @return string
- */
-function PMA_getSpecifiedServerEnginesHtml()
-{
-    /**
-     * Displays details about a given Storage Engine
-     */
-    $html = ''; 
-    $engine_plugin = PMA_StorageEngine::getEngine($_REQUEST['engine']);
-    $html .= '<h2>' . "\n"
-        . PMA_Util::getImage('b_engine.png')
-        . '    ' . htmlspecialchars($engine_plugin->getTitle()) . "\n"
-        . '    ' . PMA_Util::showMySQLDocu('', $engine_plugin->getMysqlHelpPage())
-        . "\n" . '</h2>' . "\n\n";
-    $html .= '<p>' . "\n"
-        . '    <em>' . "\n"
-        . '        ' . htmlspecialchars($engine_plugin->getComment()) . "\n"
-        . '    </em>' . "\n"
-        . '</p>' . "\n\n";
-    $infoPages = $engine_plugin->getInfoPages();
-    if (! empty($infoPages) && is_array($infoPages)) {
-        $html .= '<p>' . "\n"
-            . '    <strong>[</strong>' . "\n";
-        if (empty($_REQUEST['page'])) {
-            $html .= '    <strong>' . __('Variables') . '</strong>' . "\n";
-        } else {
-            $html .= '    <a href="server_engines.php'
-                . PMA_generate_common_url(array('engine' => $_REQUEST['engine']))
-                . '">' . __('Variables') . '</a>' . "\n";
-        }
-        foreach ($infoPages as $current => $label) {
-            $html .= '    <strong>|</strong>' . "\n";
-            if (isset($_REQUEST['page']) && $_REQUEST['page'] == $current) {
-                $html .= '    <strong>' . $label . '</strong>' . "\n";
-            } else {
-                $html .= '    <a href="server_engines.php'
-                    . PMA_generate_common_url(
-                        array('engine' => $_REQUEST['engine'], 'page' => $current)
-                    )
-                    . '">' . htmlspecialchars($label) . '</a>' . "\n";
-            }
-        }
-        unset($current, $label);
-        $html .= '    <strong>]</strong>' . "\n"
-            . '</p>' . "\n\n";
-    }
-    unset($infoPages, $page_output);
-    if (! empty($_REQUEST['page'])) {
-        $page_output = $engine_plugin->getPage($_REQUEST['page']);
-    }
-    if (! empty($page_output)) {
-        $html .= $page_output;
-    } else {
-        $html .= '<p> ' . $engine_plugin->getSupportInformationMessage() . "\n"
-           . '</p>' . "\n"
-           . $engine_plugin->getHtmlVariables();
-    }
-    
-    return $html;
-}
-
 ?>

From e7ced6eb0fa56df71277aec56b3f5689daad80a8 Mon Sep 17 00:00:00 2001
From: xmujay <xmujay@gmail.com>
Date: Mon, 24 Jun 2013 23:35:08 +0800
Subject: [PATCH 2/2] using the common header function to render header

---
 libraries/server_common.lib.php | 3 +++
 server_engines.php              | 8 ++------
 2 files changed, 5 insertions(+), 6 deletions(-)

diff --git a/libraries/server_common.lib.php b/libraries/server_common.lib.php
index 3128a59893..56cf54e8f1 100644
--- a/libraries/server_common.lib.php
+++ b/libraries/server_common.lib.php
@@ -20,6 +20,9 @@ function PMA_getSubPageHeader($type)
 {
     $res = array();
 
+    $res['engines']['icon'] = 'b_engine.png';
+    $res['engines']['text'] = __('Storage Engines');
+
     $res['plugins']['icon'] = 'b_engine.png';
     $res['plugins']['text'] = __('Plugins');
     
diff --git a/server_engines.php b/server_engines.php
index fe26cbb7d1..a987f8d61e 100644
--- a/server_engines.php
+++ b/server_engines.php
@@ -21,16 +21,12 @@ require 'libraries/server_engines.lib.php';
 /**
  * Displays the sub-page heading
  */
-$html = '<h2>' . "\n"
-    . PMA_Util::getImage('b_engine.png')
-    . "\n" . __('Storage Engines') . "\n"
-    . '</h2>' . "\n";
+$response = PMA_Response::getInstance();
+$response->addHTML(PMA_getSubPageHeader('engines'));
         
 /**
  * start output
  */
-$response = PMA_Response::getInstance();
-$response->addHTML($html);
 $response->addHTML(PMA_getHtmlForServerEngines());
 
 exit;