gian/phpmyadmin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refactor server_status_processes to static methods

Browse Source 
Signed-off-by: Maurício Meneghini Fauth <mauriciofauth@gmail.com>
This commit is contained in:
Maurício Meneghini Fauth 2017-09-07 21:52:57 -03:00
parent 8d46a94dae
commit ef17be91c1
4 changed files with 331 additions and 322 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

311
libraries/classes/Server/Status/Processes.php Normal file
View File

@ -0,0 +1,311 @@
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* functions for displaying processes list
*
* @usedby server_status_processes.php
*
* @package PhpMyAdmin
*/
namespace PhpMyAdmin\Server\Status;
use PhpMyAdmin\Message;
use PhpMyAdmin\Server\Status\Data;
use PhpMyAdmin\Util;
use PhpMyAdmin\Url;
/**
* PhpMyAdmin\Server\Status\Processes class
*
* @package PhpMyAdmin
*/
class Processes
{
/**
* Prints html for auto refreshing processes list
*
* @return string
*/
public static function getHtmlForProcessListAutoRefresh()
{
$notice = Message::notice(
__(
'Note: Enabling the auto refresh here might cause '
. 'heavy traffic between the web server and the MySQL server.'
)
)->getDisplay();
$retval = $notice . '<div class="tabLinks">';
$retval .= '<label>' . __('Refresh rate') . ': ';
$retval .= Data::getHtmlForRefreshList(
'refreshRate',
5,
Array(2, 3, 4, 5, 10, 20, 40, 60, 120, 300, 600, 1200)
);
$retval .= '</label>';
$retval .= '<a id="toggleRefresh" href="#">';
$retval .= Util::getImage('play.png') . __('Start auto refresh');
$retval .= '</a>';
$retval .= '</div>';
return $retval;
}
/**
* Prints Server Process list
*
* @return string
*/
public static function getHtmlForServerProcesslist()
{
$url_params = array();
$show_full_sql = ! empty($_REQUEST['full']);
if ($show_full_sql) {
$url_params['full'] = 1;
$full_text_link = 'server_status_processes.php' . Url::getCommon(
array(), '?'
);
} else {
$full_text_link = 'server_status_processes.php' . Url::getCommon(
array('full' => 1)
);
}
// This array contains display name and real column name of each
// sortable column in the table
$sortable_columns = array(
array(
'column_name' => __('ID'),
'order_by_field' => 'Id'
),
array(
'column_name' => __('User'),
'order_by_field' => 'User'
),
array(
'column_name' => __('Host'),
'order_by_field' => 'Host'
),
array(
'column_name' => __('Database'),
'order_by_field' => 'db'
),
array(
'column_name' => __('Command'),
'order_by_field' => 'Command'
),
array(
'column_name' => __('Time'),
'order_by_field' => 'Time'
),
array(
'column_name' => __('Status'),
'order_by_field' => 'State'
),
array(
'column_name' => __('Progress'),
'order_by_field' => 'Progress'
),
array(
'column_name' => __('SQL query'),
'order_by_field' => 'Info'
)
);
$sortableColCount = count($sortable_columns);
$sql_query = $show_full_sql
? 'SHOW FULL PROCESSLIST'
: 'SHOW PROCESSLIST';
if ((! empty($_REQUEST['order_by_field'])
&& ! empty($_REQUEST['sort_order']))
|| (! empty($_REQUEST['showExecuting']))
) {
$sql_query = 'SELECT * FROM `INFORMATION_SCHEMA`.`PROCESSLIST` ';
}
if (! empty($_REQUEST['showExecuting'])) {
$sql_query .= ' WHERE state != "" ';
}
if (!empty($_REQUEST['order_by_field']) && !empty($_REQUEST['sort_order'])) {
$sql_query .= ' ORDER BY '
. Util::backquote($_REQUEST['order_by_field'])
. ' ' . $_REQUEST['sort_order'];
}
$result = $GLOBALS['dbi']->query($sql_query);
$retval = '<div class="responsivetable">';
$retval .= '<table id="tableprocesslist" '
. 'class="data clearfloat noclick sortable">';
$retval .= '<thead>';
$retval .= '<tr>';
$retval .= '<th>' . __('Processes') . '</th>';
foreach ($sortable_columns as $column) {
$is_sorted = ! empty($_REQUEST['order_by_field'])
&& ! empty($_REQUEST['sort_order'])
&& ($_REQUEST['order_by_field'] == $column['order_by_field']);
$column['sort_order'] = 'ASC';
if ($is_sorted && $_REQUEST['sort_order'] === 'ASC') {
$column['sort_order'] = 'DESC';
}
if (isset($_REQUEST['showExecuting'])) {
$column['showExecuting'] = 'on';
}
$retval .= '<th>';
$columnUrl = Url::getCommon($column);
$retval .= '<a href="server_status_processes.php' . $columnUrl . '" class="sortlink">';
$retval .= $column['column_name'];
if ($is_sorted) {
$asc_display_style = 'inline';
$desc_display_style = 'none';
if ($_REQUEST['sort_order'] === 'DESC') {
$desc_display_style = 'inline';
$asc_display_style = 'none';
}
$retval .= '<img class="icon ic_s_desc soimg" alt="'
. __('Descending') . '" title="" src="themes/dot.gif" '
. 'style="display: ' . $desc_display_style . '" />';
$retval .= '<img class="icon ic_s_asc soimg hide" alt="'
. __('Ascending') . '" title="" src="themes/dot.gif" '
. 'style="display: ' . $asc_display_style . '" />';
}
$retval .= '</a>';
if (0 === --$sortableColCount) {
$retval .= '<a href="' . $full_text_link . '">';
if ($show_full_sql) {
$retval .= Util::getImage(
's_partialtext.png',
__('Truncate Shown Queries')
);
} else {
$retval .= Util::getImage(
's_fulltext.png',
__('Show Full Queries')
);
}
$retval .= '</a>';
}
$retval .= '</th>';
}
$retval .= '</tr>';
$retval .= '</thead>';
$retval .= '<tbody>';
while ($process = $GLOBALS['dbi']->fetchAssoc($result)) {
$retval .= self::getHtmlForServerProcessItem(
$process,
$show_full_sql
);
}
$retval .= '</tbody>';
$retval .= '</table>';
$retval .= '</div>';
return $retval;
}
/**
* Returns the html for the list filter
*
* @return string
*/
public static function getHtmlForProcessListFilter()
{
$showExecuting = '';
if (! empty($_REQUEST['showExecuting'])) {
$showExecuting = ' checked="checked"';
}
$url_params = array(
'ajax_request' => true,
'full' => (isset($_REQUEST['full']) ? $_REQUEST['full'] : ''),
'column_name' => (isset($_REQUEST['column_name']) ? $_REQUEST['column_name'] : ''),
'order_by_field'
=> (isset($_REQUEST['order_by_field']) ? $_REQUEST['order_by_field'] : ''),
'sort_order' => (isset($_REQUEST['sort_order']) ? $_REQUEST['sort_order'] : ''),
);
$retval = '';
$retval .= '<fieldset id="tableFilter">';
$retval .= '<legend>' . __('Filters') . '</legend>';
$retval .= '<form action="server_status_processes.php">';
$retval .= Url::getHiddenInputs($url_params);
$retval .= '<input type="submit" value="' . __('Refresh') . '" />';
$retval .= '<div class="formelement">';
$retval .= '<input' . $showExecuting . ' type="checkbox" name="showExecuting"'
. ' id="showExecuting" class="autosubmit"/>';
$retval .= '<label for="showExecuting">';
$retval .= __('Show only active');
$retval .= '</label>';
$retval .= '</div>';
$retval .= '</form>';
$retval .= '</fieldset>';
return $retval;
}
/**
* Prints Every Item of Server Process
*
* @param array $process data of Every Item of Server Process
* @param bool $show_full_sql show full sql or not
*
* @return string
*/
public static function getHtmlForServerProcessItem($process, $show_full_sql)
{
// Array keys need to modify due to the way it has used
// to display column values
if ((! empty($_REQUEST['order_by_field']) && ! empty($_REQUEST['sort_order']))
|| (! empty($_REQUEST['showExecuting']))
) {
foreach (array_keys($process) as $key) {
$new_key = ucfirst(mb_strtolower($key));
if ($new_key !== $key) {
$process[$new_key] = $process[$key];
unset($process[$key]);
}
}
}
$url_params = array(
'kill' => $process['Id'],
'ajax_request' => true
);
$kill_process = 'server_status_processes.php' . Url::getCommon($url_params);
$retval = '<tr>';
$retval .= '<td><a class="ajax kill_process" href="' . $kill_process . '">'
. __('Kill') . '</a></td>';
$retval .= '<td class="value">' . $process['Id'] . '</td>';
$retval .= '<td>' . htmlspecialchars($process['User']) . '</td>';
$retval .= '<td>' . htmlspecialchars($process['Host']) . '</td>';
$retval .= '<td>' . ((! isset($process['db'])
|| strlen($process['db']) === 0)
? '<i>' . __('None') . '</i>'
: htmlspecialchars($process['db'])) . '</td>';
$retval .= '<td>' . htmlspecialchars($process['Command']) . '</td>';
$retval .= '<td class="value">' . $process['Time'] . '</td>';
$processStatusStr = empty($process['State']) ? '---' : $process['State'];
$retval .= '<td>' . $processStatusStr . '</td>';
$processProgress = empty($process['Progress']) ? '---' : $process['Progress'];
$retval .= '<td>' . $processProgress . '</td>';
$retval .= '<td>';
if (empty($process['Info'])) {
$retval .= '---';
} else {
$retval .= Util::formatSql($process['Info'], ! $show_full_sql);
}
$retval .= '</td>';
$retval .= '</tr>';
return $retval;
}
}

301
libraries/server_status_processes.lib.php
View File

@ -1,301 +0,0 @@
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* functions for displaying processes list
*
* @usedby server_status_processes.php
*
* @package PhpMyAdmin
*/
use PhpMyAdmin\Message;
use PhpMyAdmin\Server\Status\Data;
use PhpMyAdmin\Util;
use PhpMyAdmin\Url;
/**
* Prints html for auto refreshing processes list
*
* @return string
*/
function PMA_getHtmlForProcessListAutoRefresh()
{
$notice = Message::notice(
__(
'Note: Enabling the auto refresh here might cause '
. 'heavy traffic between the web server and the MySQL server.'
)
)->getDisplay();
$retval = $notice . '<div class="tabLinks">';
$retval .= '<label>' . __('Refresh rate') . ': ';
$retval .= Data::getHtmlForRefreshList(
'refreshRate',
5,
Array(2, 3, 4, 5, 10, 20, 40, 60, 120, 300, 600, 1200)
);
$retval .= '</label>';
$retval .= '<a id="toggleRefresh" href="#">';
$retval .= Util::getImage('play.png') . __('Start auto refresh');
$retval .= '</a>';
$retval .= '</div>';
return $retval;
}
/**
* Prints Server Process list
*
* @return string
*/
function PMA_getHtmlForServerProcesslist()
{
$url_params = array();
$show_full_sql = ! empty($_REQUEST['full']);
if ($show_full_sql) {
$url_params['full'] = 1;
$full_text_link = 'server_status_processes.php' . Url::getCommon(
array(), '?'
);
} else {
$full_text_link = 'server_status_processes.php' . Url::getCommon(
array('full' => 1)
);
}
// This array contains display name and real column name of each
// sortable column in the table
$sortable_columns = array(
array(
'column_name' => __('ID'),
'order_by_field' => 'Id'
),
array(
'column_name' => __('User'),
'order_by_field' => 'User'
),
array(
'column_name' => __('Host'),
'order_by_field' => 'Host'
),
array(
'column_name' => __('Database'),
'order_by_field' => 'db'
),
array(
'column_name' => __('Command'),
'order_by_field' => 'Command'
),
array(
'column_name' => __('Time'),
'order_by_field' => 'Time'
),
array(
'column_name' => __('Status'),
'order_by_field' => 'State'
),
array(
'column_name' => __('Progress'),
'order_by_field' => 'Progress'
),
array(
'column_name' => __('SQL query'),
'order_by_field' => 'Info'
)
);
$sortableColCount = count($sortable_columns);
$sql_query = $show_full_sql
? 'SHOW FULL PROCESSLIST'
: 'SHOW PROCESSLIST';
if ((! empty($_REQUEST['order_by_field'])
&& ! empty($_REQUEST['sort_order']))
|| (! empty($_REQUEST['showExecuting']))
) {
$sql_query = 'SELECT * FROM `INFORMATION_SCHEMA`.`PROCESSLIST` ';
}
if (! empty($_REQUEST['showExecuting'])) {
$sql_query .= ' WHERE state != "" ';
}
if (!empty($_REQUEST['order_by_field']) && !empty($_REQUEST['sort_order'])) {
$sql_query .= ' ORDER BY '
. Util::backquote($_REQUEST['order_by_field'])
. ' ' . $_REQUEST['sort_order'];
}
$result = $GLOBALS['dbi']->query($sql_query);
$retval = '<div class="responsivetable">';
$retval .= '<table id="tableprocesslist" '
. 'class="data clearfloat noclick sortable">';
$retval .= '<thead>';
$retval .= '<tr>';
$retval .= '<th>' . __('Processes') . '</th>';
foreach ($sortable_columns as $column) {
$is_sorted = ! empty($_REQUEST['order_by_field'])
&& ! empty($_REQUEST['sort_order'])
&& ($_REQUEST['order_by_field'] == $column['order_by_field']);
$column['sort_order'] = 'ASC';
if ($is_sorted && $_REQUEST['sort_order'] === 'ASC') {
$column['sort_order'] = 'DESC';
}
if (isset($_REQUEST['showExecuting'])) {
$column['showExecuting'] = 'on';
}
$retval .= '<th>';
$columnUrl = Url::getCommon($column);
$retval .= '<a href="server_status_processes.php' . $columnUrl . '" class="sortlink">';
$retval .= $column['column_name'];
if ($is_sorted) {
$asc_display_style = 'inline';
$desc_display_style = 'none';
if ($_REQUEST['sort_order'] === 'DESC') {
$desc_display_style = 'inline';
$asc_display_style = 'none';
}
$retval .= '<img class="icon ic_s_desc soimg" alt="'
. __('Descending') . '" title="" src="themes/dot.gif" '
. 'style="display: ' . $desc_display_style . '" />';
$retval .= '<img class="icon ic_s_asc soimg hide" alt="'
. __('Ascending') . '" title="" src="themes/dot.gif" '
. 'style="display: ' . $asc_display_style . '" />';
}
$retval .= '</a>';
if (0 === --$sortableColCount) {
$retval .= '<a href="' . $full_text_link . '">';
if ($show_full_sql) {
$retval .= Util::getImage(
's_partialtext.png',
__('Truncate Shown Queries')
);
} else {
$retval .= Util::getImage(
's_fulltext.png',
__('Show Full Queries')
);
}
$retval .= '</a>';
}
$retval .= '</th>';
}
$retval .= '</tr>';
$retval .= '</thead>';
$retval .= '<tbody>';
while ($process = $GLOBALS['dbi']->fetchAssoc($result)) {
$retval .= PMA_getHtmlForServerProcessItem(
$process,
$show_full_sql
);
}
$retval .= '</tbody>';
$retval .= '</table>';
$retval .= '</div>';
return $retval;
}
/**
* Returns the html for the list filter
*
* @return string
*/
function PMA_getHtmlForProcessListFilter()
{
$showExecuting = '';
if (! empty($_REQUEST['showExecuting'])) {
$showExecuting = ' checked="checked"';
}
$url_params = array(
'ajax_request' => true,
'full' => (isset($_REQUEST['full']) ? $_REQUEST['full'] : ''),
'column_name' => (isset($_REQUEST['column_name']) ? $_REQUEST['column_name'] : ''),
'order_by_field'
=> (isset($_REQUEST['order_by_field']) ? $_REQUEST['order_by_field'] : ''),
'sort_order' => (isset($_REQUEST['sort_order']) ? $_REQUEST['sort_order'] : ''),
);
$retval = '';
$retval .= '<fieldset id="tableFilter">';
$retval .= '<legend>' . __('Filters') . '</legend>';
$retval .= '<form action="server_status_processes.php">';
$retval .= Url::getHiddenInputs($url_params);
$retval .= '<input type="submit" value="' . __('Refresh') . '" />';
$retval .= '<div class="formelement">';
$retval .= '<input' . $showExecuting . ' type="checkbox" name="showExecuting"'
. ' id="showExecuting" class="autosubmit"/>';
$retval .= '<label for="showExecuting">';
$retval .= __('Show only active');
$retval .= '</label>';
$retval .= '</div>';
$retval .= '</form>';
$retval .= '</fieldset>';
return $retval;
}
/**
* Prints Every Item of Server Process
*
* @param array $process data of Every Item of Server Process
* @param bool $show_full_sql show full sql or not
*
* @return string
*/
function PMA_getHtmlForServerProcessItem($process, $show_full_sql)
{
// Array keys need to modify due to the way it has used
// to display column values
if ((! empty($_REQUEST['order_by_field']) && ! empty($_REQUEST['sort_order']))
|| (! empty($_REQUEST['showExecuting']))
) {
foreach (array_keys($process) as $key) {
$new_key = ucfirst(mb_strtolower($key));
if ($new_key !== $key) {
$process[$new_key] = $process[$key];
unset($process[$key]);
}
}
}
$url_params = array(
'kill' => $process['Id'],
'ajax_request' => true
);
$kill_process = 'server_status_processes.php' . Url::getCommon($url_params);
$retval = '<tr>';
$retval .= '<td><a class="ajax kill_process" href="' . $kill_process . '">'
. __('Kill') . '</a></td>';
$retval .= '<td class="value">' . $process['Id'] . '</td>';
$retval .= '<td>' . htmlspecialchars($process['User']) . '</td>';
$retval .= '<td>' . htmlspecialchars($process['Host']) . '</td>';
$retval .= '<td>' . ((! isset($process['db'])
|| strlen($process['db']) === 0)
? '<i>' . __('None') . '</i>'
: htmlspecialchars($process['db'])) . '</td>';
$retval .= '<td>' . htmlspecialchars($process['Command']) . '</td>';
$retval .= '<td class="value">' . $process['Time'] . '</td>';
$processStatusStr = empty($process['State']) ? '---' : $process['State'];
$retval .= '<td>' . $processStatusStr . '</td>';
$processProgress = empty($process['Progress']) ? '---' : $process['Progress'];
$retval .= '<td>' . $processProgress . '</td>';
$retval .= '<td>';
if (empty($process['Info'])) {
$retval .= '---';
} else {
$retval .= Util::formatSql($process['Info'], ! $show_full_sql);
}
$retval .= '</td>';
$retval .= '</tr>';
return $retval;
}

10
server_status_processes.php
View File

@ -8,10 +8,10 @@
use PhpMyAdmin\Response;
use PhpMyAdmin\Server\Status\Data;
use PhpMyAdmin\Server\Status\Processes;
require_once 'libraries/common.inc.php';
require_once 'libraries/server_common.inc.php';
require_once 'libraries/server_status_processes.lib.php';
/**
* Replication library
@ -47,7 +47,7 @@ if ($response->isAjax() && !empty($_REQUEST['kill'])) {
$response->addJSON('message', $message);
} elseif ($response->isAjax() && !empty($_REQUEST['refresh'])) {
// Only sends the process list table
$response->addHTML(PMA_getHtmlForServerProcessList());
$response->addHTML(Processes::getHtmlForServerProcesslist());
} else {
// Load the full page
$header = $response->getHeader();
@ -55,9 +55,9 @@ if ($response->isAjax() && !empty($_REQUEST['kill'])) {
$scripts->addFile('server_status_processes.js');
$response->addHTML('<div>');
$response->addHTML($serverStatusData->getMenuHtml());
$response->addHTML(PMA_getHtmlForProcessListFilter());
$response->addHTML(PMA_getHtmlForServerProcesslist());
$response->addHTML(PMA_getHtmlForProcessListAutoRefresh());
$response->addHTML(Processes::getHtmlForProcessListFilter());
$response->addHTML(Processes::getHtmlForServerProcesslist());
$response->addHTML(Processes::getHtmlForProcessListAutoRefresh());
$response->addHTML('</div>');
}
exit;

31
test/libraries/PMA_server_status_processes_test.php → test/classes/Server/Status/ProcessesTest.php
View File

@ -1,26 +1,25 @@
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* tests for server_status_processes.lib.php
* tests for PhpMyAdmin\Server\Status\Processes
*
* @package PhpMyAdmin-test
*/
namespace PhpMyAdmin\Tests\Server\Status;
use PhpMyAdmin\Core;
use PhpMyAdmin\Server\Status\Processes;
use PhpMyAdmin\Theme;
use PhpMyAdmin\Url;
require_once 'libraries/server_status_processes.lib.php';
/**
* class PMA_ServerStatusProcesses_Test
* PhpMyAdmin\Tests\Server\Status\ProcessesTest class
*
* this class is for testing server_status_processes.lib.php functions
* this class is for testing PhpMyAdmin\Server\Status\Processes methods
*
* @package PhpMyAdmin-test
*/
class PMA_ServerStatusProcesses_Test extends PHPUnit_Framework_TestCase
class ProcessesTest extends \PHPUnit_Framework_TestCase
{
/**
* Test for setUp
@ -48,14 +47,14 @@ class PMA_ServerStatusProcesses_Test extends PHPUnit_Framework_TestCase
}
/**
* Test for PMA_getHtmlForProcessListAutoRefresh
* Test for Processes::getHtmlForProcessListAutoRefresh
*
* @return void
* @group medium
*/
public function testPMAGetHtmlForProcessListAutoRefresh()
{
$html = PMA_getHtmlForProcessListAutoRefresh();
$html = Processes::getHtmlForProcessListAutoRefresh();
// Test Notice
$this->assertContains(
@ -91,7 +90,7 @@ class PMA_ServerStatusProcesses_Test extends PHPUnit_Framework_TestCase
}
/**
* Test for PMA_getHtmlForServerProcesslist
* Test for Processes::getHtmlForServerProcesslist
*
* @return void
* @group medium
@ -112,7 +111,7 @@ class PMA_ServerStatusProcesses_Test extends PHPUnit_Framework_TestCase
$GLOBALS['dbi']->expects($this->any())->method('fetchAssoc')
->will($this->onConsecutiveCalls($process));
$html = PMA_getHtmlForServerProcesslist();
$html = Processes::getHtmlForServerProcesslist();
// Test process table
$this->assertContains(
@ -137,7 +136,7 @@ class PMA_ServerStatusProcesses_Test extends PHPUnit_Framework_TestCase
$_REQUEST['sort_order'] = 'ASC';
$_REQUEST['order_by_field'] = 'db';
$_REQUEST['column_name'] = 'Database';
$html = PMA_getHtmlForServerProcesslist();
$html = Processes::getHtmlForServerProcesslist();
$this->assertContains(
'Truncate Shown Queries',
@ -155,7 +154,7 @@ class PMA_ServerStatusProcesses_Test extends PHPUnit_Framework_TestCase
$_REQUEST['sort_order'] = 'DESC';
$_REQUEST['order_by_field'] = 'Host';
$_REQUEST['column_name'] = 'Host';
$html = PMA_getHtmlForServerProcesslist();
$html = Processes::getHtmlForServerProcesslist();
$this->assertContains(
'Host',
@ -168,7 +167,7 @@ class PMA_ServerStatusProcesses_Test extends PHPUnit_Framework_TestCase
}
/**
* Test for PMA_getHtmlForServerProcessItem
* Test for Processes::getHtmlForServerProcessItem
*
* @return void
*/
@ -192,7 +191,7 @@ class PMA_ServerStatusProcesses_Test extends PHPUnit_Framework_TestCase
$GLOBALS['cfg']['MaxCharactersInDisplayedSQL'] = 12;
//Call the test function
$html = PMA_getHtmlForServerProcessItem($process, $show_full_sql);
$html = Processes::getHtmlForServerProcessItem($process, $show_full_sql);
//validate 1: $kill_process
$url_params = array(
@ -257,7 +256,7 @@ class PMA_ServerStatusProcesses_Test extends PHPUnit_Framework_TestCase
);
unset($process['info']);
$html = PMA_getHtmlForServerProcessItem($process, $show_full_sql);
$html = Processes::getHtmlForServerProcessItem($process, $show_full_sql);
$this->assertContains(
'---',