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

Merge pull request #663 from scnakandala/refac_tbl_indexes

Browse Source 
Refactoring tbl_indexes.php
This commit is contained in:
Marc Delisle 2013-09-01 15:42:25 -07:00
commit 930a024d02
3 changed files with 424 additions and 336 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

219
libraries/display_indexes.lib.php
View File

@ -1,219 +0,0 @@
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* Display the form to edit/create an index
*
* @package PhpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;
}
if (isset($_REQUEST['index']) && is_array($_REQUEST['index'])) {
// coming already from form
$add_fields
= count($_REQUEST['index']['columns']['names']) - $index->getColumnCount();
if (isset($_REQUEST['add_fields'])) {
$add_fields += $_REQUEST['added_fields'];
}
} elseif (isset($_REQUEST['create_index'])) {
$add_fields = $_REQUEST['added_fields'];
} else {
$add_fields = 1;
}// end preparing form values
$html = "";
$html .= '<form action="tbl_indexes.php" method="post" name="index_frm" id="index_frm" class="ajax"'
. 'onsubmit="if (typeof(this.elements[\'index[Key_name]\'].disabled) != \'undefined\') {'
. 'this.elements[\'index[Key_name]\'].disabled = false}">';
$form_params = array(
'db' => $db,
'table' => $table,
);
if (isset($_REQUEST['create_index'])) {
$form_params['create_index'] = 1;
} elseif (isset($_REQUEST['old_index'])) {
$form_params['old_index'] = $_REQUEST['old_index'];
} elseif (isset($_REQUEST['index'])) {
$form_params['old_index'] = $_REQUEST['index'];
}
$html .= PMA_URL_getHiddenInputs($form_params);
$html .= '<fieldset id="index_edit_fields">';
if ($GLOBALS['is_ajax_request'] != true) {
$html .= '<legend>';
if (isset($_REQUEST['create_index'])) {
$html .= __('Add index');
} else {
$html .= __('Edit index');
}
$html .= '</legend>';
}
$html .= '<div class="index_info">';
$html .= '<div>'
. '<div class="label">'
. '<strong>'
. '<label for="input_index_name">'
. __('Index name:')
. PMA_Util::showHint(
PMA_Message::notice(
__('"PRIMARY" <b>must</b> be the name of'
. ' and <b>only of</b> a primary key!'
)
)
)
. '</label>'
. '</strong>'
. '</div>'
. '<input type="text" name="index[Key_name]" id="input_index_name" size="25"'
. 'value="' . htmlspecialchars($index->getName()) . '"'
. 'onfocus="this.select()" />'
. '</div>';
if (PMA_MYSQL_INT_VERSION > 50500) {
$html .= '<div>'
. '<div class="label">'
. '<strong>'
. '<label for="input_index_comment">'
. __('Comment:')
. '</label>'
. '</strong>'
. '</div>'
. '<input type="text" name="index[Index_comment]" id="input_index_comment" size="30"'
. 'value="' . htmlspecialchars($index->getComment()) . '"'
. 'onfocus="this.select()" />'
. '</div>';
}
$html .= '<div>'
. '<div class="label">'
. '<strong>'
. '<label for="select_index_type">'
. __('Index type:')
. PMA_Util::showMySQLDocu('ALTER_TABLE')
. '</label>'
. '</strong>'
. '</div>'
. '<select name="index[Index_type]" id="select_index_type" >'
. $index->generateIndexSelector()
. '</select>'
. '</div>';
$html .= '<div class="clearfloat"></div>';
$html .= '</div>';
$html .= '<table id="index_columns">';
$html .= '<thead>'
. '<tr>'
. '<th>' . __('Column') . '</th>'
. '<th>' . __('Size') . '</th>'
. '</tr>'
. '</thead>';
$odd_row = true;
$spatial_types = array(
'geometry', 'point', 'linestring', 'polygon', 'multipoint',
'multilinestring', 'multipolygon', 'geomtrycollection'
);
$html .= '<tbody>';
foreach ($index->getColumns() as $column) {
$html .= '<tr class="';
$html .= $odd_row ? 'odd' : 'even';
$html .= 'noclick">';
$html .= '<td>';
$html .= '<select name="index[columns][names][]">';
$html .= '<option value="">-- ' . __('Ignore') . ' --</option>';
foreach ($fields as $field_name => $field_type) {
if (($index->getType() != 'FULLTEXT'
|| preg_match('/(char|text)/i', $field_type))
&& ($index->getType() != 'SPATIAL'
|| in_array($field_type, $spatial_types))
) {
$html .= '<option value="' . htmlspecialchars($field_name) . '"'
. (($field_name == $column->getName())
? ' selected="selected"'
: '') . '>'
. htmlspecialchars($field_name) . ' ['
. htmlspecialchars($field_type) . ']'
. '</option>' . "\n";
}
} // end foreach $fields
$html .= '</select>';
$html .= '</td>';
$html .= '<td>';
$html .= '<input type="text" size="5" onfocus="this.select()"'
. 'name="index[columns][sub_parts][]" value="';
if ($index->getType() != 'SPATIAL') {
$html .= $column->getSubPart();
}
$html .= '"/>';
$html .= '</td>';
$html .= '</tr>';
$odd_row = !$odd_row;
} // end foreach $edited_index_info['Sequences']
for ($i = 0; $i < $add_fields; $i++) {
$html .= '<tr class="';
$html .= $odd_row ? 'odd' : 'even';
$html .= 'noclick">';
$html .= '<td>';
$html .= '<select name="index[columns][names][]">';
$html .= '<option value="">-- ' . __('Ignore') . ' --</option>';
foreach ($fields as $field_name => $field_type) {
$html .= '<option value="' . htmlspecialchars($field_name) . '">'
. htmlspecialchars($field_name) . ' ['
. htmlspecialchars($field_type) . ']'
. '</option>' . "\n";
} // end foreach $fields
$html .= '</select>';
$html .= '</td>';
$html .= '<td>'
. '<input type="text" size="5" onfocus="this.select()"'
. 'name="index[columns][sub_parts][]" value="" />'
. '</td>';
$html .= '</tr>';
$odd_row = !$odd_row;
} // end foreach $edited_index_info['Sequences']
$html .= '</tbody>';
$html .= '</table>';
$html .= '</fieldset>';
$html .= '<fieldset class="tblFooters">';
if ($GLOBALS['is_ajax_request'] != true || ! empty($_REQUEST['ajax_page_request'])) {
$html .= '<input type="submit" name="do_save_data" value="' . __('Save') . '" />';
$html .= '<span id="addMoreColumns">';
$html .= __('Or') . ' ';
$html .= printf(
__('Add %s column(s) to index') . "\n",
'<input type="text" name="added_fields" size="2" value="1" />'
);
$html .= '<input type="submit" name="add_fields" value="' . __('Go') . '" />' . "\n";
$html .= '</span>';
} else {
$btn_value = sprintf(__('Add %s column(s) to index'), 1);
$html .= '<div class="slider"></div>';
$html .= '<div class="add_fields">';
$html .= '<input type="submit" value="' . $btn_value . '" />';
$html .= '</div>';
}
$html .= '</fieldset>';
$html .= '</form>';
$response = PMA_Response::getInstance();
$response->addHTML($html);
$header = $response->getHeader();
$scripts = $header->getScripts();
$scripts->addFile('indexes.js');
?>

406
libraries/tbl_indexes.lib.php Normal file
View File

@ -0,0 +1,406 @@
<?php
/* vim: set expandtab sw=4 ts=4 sts=4: */
/**
* Set of functions related to table indexes
*
* @package PhpMyAdmin
*/
if (! defined('PHPMYADMIN')) {
exit;
}
/**
* Function to get the name and type of the columns of a table
*
* @param string $db current database
* @param string $table current table
*
* @return array
*/
function PMA_getNameAndTypeOfTheColumns($db, $table)
{
$columns = array();
foreach ($GLOBALS['dbi']->getColumnsFull($db, $table) as $row) {
if (preg_match('@^(set|enum)\((.+)\)$@i', $row['Type'], $tmp)) {
$tmp[2] = substr(
preg_replace('@([^,])\'\'@', '\\1\\\'', ',' . $tmp[2]), 1
);
$columns[$row['Field']] = $tmp[1] . '('
. str_replace(',', ', ', $tmp[2]) . ')';
} else {
$columns[$row['Field']] = $row['Type'];
}
} // end while
return $columns;
}
/**
* Function to handle the creation or edit of an index
*
* @param string $db current db
* @param string $table current table
* @param Object $index current index
*
* @return void
*/
function PMA_handleCreateOrEditIndex($db, $table, $index)
{
$error = false;
$sql_query = PMA_getSqlQueryForIndexCreateOrEdit($db, $table, $index, $error);
if (! $error) {
$GLOBALS['dbi']->query($sql_query);
$message = PMA_Message::success(
__('Table %1$s has been altered successfully')
);
$message->addParam($table);
if ($GLOBALS['is_ajax_request'] == true) {
$response = PMA_Response::getInstance();
$response->addJSON('message', $message);
$response->addJSON('index_table', PMA_Index::getView($table, $db));
$response->addJSON(
'sql_query',
PMA_Util::getMessage(null, $sql_query)
);
} else {
$active_page = 'tbl_structure.php';
include 'tbl_structure.php';
}
exit;
} else {
$response = PMA_Response::getInstance();
$response->isSuccess(false);
$response->addJSON('message', $error);
exit;
}
}
/**
* Function to get the sql query for index creation or edit
*
* @param string $db current db
* @param string $table current table
* @param Object $index current index
* @param bool &$error whether error occoured or not
*
* @return string
*/
function PMA_getSqlQueryForIndexCreateOrEdit($db, $table, $index, &$error)
{
// $sql_query is the one displayed in the query box
$sql_query = 'ALTER TABLE ' . PMA_Util::backquote($db)
. '.' . PMA_Util::backquote($table);
// Drops the old index
if (! empty($_REQUEST['old_index'])) {
if ($_REQUEST['old_index'] == 'PRIMARY') {
$sql_query .= ' DROP PRIMARY KEY,';
} else {
$sql_query .= ' DROP INDEX '
. PMA_Util::backquote($_REQUEST['old_index']) . ',';
}
} // end if
// Builds the new one
switch ($index->getType()) {
case 'PRIMARY':
if ($index->getName() == '') {
$index->setName('PRIMARY');
} elseif ($index->getName() != 'PRIMARY') {
$error = PMA_Message::error(
__('The name of the primary key must be "PRIMARY"!')
);
}
$sql_query .= ' ADD PRIMARY KEY';
break;
case 'FULLTEXT':
case 'UNIQUE':
case 'INDEX':
case 'SPATIAL':
if ($index->getName() == 'PRIMARY') {
$error = PMA_Message::error(__('Can\'t rename index to PRIMARY!'));
}
$sql_query .= ' ADD ' . $index->getType() . ' '
. ($index->getName() ? PMA_Util::backquote($index->getName()) : '');
break;
} // end switch
$index_fields = array();
foreach ($index->getColumns() as $key => $column) {
$index_fields[$key] = PMA_Util::backquote($column->getName());
if ($column->getSubPart()) {
$index_fields[$key] .= '(' . $column->getSubPart() . ')';
}
} // end while
if (empty($index_fields)) {
$error = PMA_Message::error(__('No index parts defined!'));
} else {
$sql_query .= ' (' . implode(', ', $index_fields) . ')';
}
if (PMA_MYSQL_INT_VERSION > 50500) {
$sql_query .= "COMMENT '"
. PMA_Util::sqlAddSlashes($index->getComment())
. "'";
}
$sql_query .= ';';
return $sql_query;
}
/**
* Function to prepare the form values for index
*
* @param string $db curent database
* @param string $table current table
*
* @return PMA_Index
*/
function PMA_prepareFormValues($db, $table)
{
if (isset($_REQUEST['index'])) {
if (is_array($_REQUEST['index'])) {
// coming already from form
$index = new PMA_Index($_REQUEST['index']);
} else {
$index = PMA_Index::singleton($db, $table, $_REQUEST['index']);
}
} else {
$index = new PMA_Index;
}
return $index;
}
/**
* Function to get the number of fields for the form
*
* @param Object $index index
*
* @return int
*/
function PMA_getNumberOfFieldsForForm($index)
{
if (isset($_REQUEST['index']) && is_array($_REQUEST['index'])) {
// coming already from form
$add_fields
= count($_REQUEST['index']['columns']['names'])
- $index->getColumnCount();
if (isset($_REQUEST['add_fields'])) {
$add_fields += $_REQUEST['added_fields'];
}
} elseif (isset($_REQUEST['create_index'])) {
$add_fields = $_REQUEST['added_fields'];
} else {
$add_fields = 1;
}// end preparing form values
return $add_fields;
}
/**
* Function to get form parameters
*
* @param string $db current db
* @param string $table current table
*
* @return array
*/
function PMA_getFormParameters($db, $table)
{
$form_params = array(
'db' => $db,
'table' => $table,
);
if (isset($_REQUEST['create_index'])) {
$form_params['create_index'] = 1;
} elseif (isset($_REQUEST['old_index'])) {
$form_params['old_index'] = $_REQUEST['old_index'];
} elseif (isset($_REQUEST['index'])) {
$form_params['old_index'] = $_REQUEST['index'];
}
return $form_params;
}
/**
* Function to get html for displaying the index form
*
* @param array $fields fields
* @param Object $index index
* @param array $form_params form parameters
* @param int $add_fields number of fields in the form
*
* @return string
*/
function PMA_getHtmlForIndexForm($fields, $index, $form_params,$add_fields)
{
$html = "";
$html .= '<form action="tbl_indexes.php" method="post" name="index_frm" id="'
. 'index_frm" class="ajax"'
. 'onsubmit="if (typeof(this.elements[\'index[Key_name]\'].disabled) !='
. ' \'undefined\') {'
. 'this.elements[\'index[Key_name]\'].disabled = false}">';
$html .= PMA_URL_getHiddenInputs($form_params);
$html .= '<fieldset id="index_edit_fields">';
$html .= '<div class="index_info">';
$html .= '<div>'
. '<div class="label">'
. '<strong>'
. '<label for="input_index_name">'
. __('Index name:')
. PMA_Util::showHint(
PMA_Message::notice(
__(
'"PRIMARY" <b>must</b> be the name of'
. ' and <b>only of</b> a primary key!'
)
)
)
. '</label>'
. '</strong>'
. '</div>'
. '<input type="text" name="index[Key_name]" id="input_index_name"'
. ' size="25"'
. 'value="' . htmlspecialchars($index->getName()) . '"'
. 'onfocus="this.select()" />'
. '</div>';
if (PMA_MYSQL_INT_VERSION > 50500) {
$html .= '<div>'
. '<div class="label">'
. '<strong>'
. '<label for="input_index_comment">'
. __('Comment:')
. '</label>'
. '</strong>'
. '</div>'
. '<input type="text" name="index[Index_comment]" '
. 'id="input_index_comment" size="30"'
. 'value="' . htmlspecialchars($index->getComment()) . '"'
. 'onfocus="this.select()" />'
. '</div>';
}
$html .= '<div>'
. '<div class="label">'
. '<strong>'
. '<label for="select_index_type">'
. __('Index type:')
. PMA_Util::showMySQLDocu('ALTER_TABLE')
. '</label>'
. '</strong>'
. '</div>'
. '<select name="index[Index_type]" id="select_index_type" >'
. $index->generateIndexSelector()
. '</select>'
. '</div>';
$html .= '<div class="clearfloat"></div>';
$html .= '</div>';
$html .= '<table id="index_columns">';
$html .= '<thead>'
. '<tr>'
. '<th>' . __('Column') . '</th>'
. '<th>' . __('Size') . '</th>'
. '</tr>'
. '</thead>';
$odd_row = true;
$spatial_types = array(
'geometry', 'point', 'linestring', 'polygon', 'multipoint',
'multilinestring', 'multipolygon', 'geomtrycollection'
);
$html .= '<tbody>';
foreach ($index->getColumns() as $column) {
$html .= '<tr class="';
$html .= $odd_row ? 'odd' : 'even';
$html .= 'noclick">';
$html .= '<td>';
$html .= '<select name="index[columns][names][]">';
$html .= '<option value="">-- ' . __('Ignore') . ' --</option>';
foreach ($fields as $field_name => $field_type) {
if (($index->getType() != 'FULLTEXT'
|| preg_match('/(char|text)/i', $field_type))
&& ($index->getType() != 'SPATIAL'
|| in_array($field_type, $spatial_types))
) {
$html .= '<option value="' . htmlspecialchars($field_name) . '"'
. (($field_name == $column->getName())
? ' selected="selected"'
: '') . '>'
. htmlspecialchars($field_name) . ' ['
. htmlspecialchars($field_type) . ']'
. '</option>' . "\n";
}
} // end foreach $fields
$html .= '</select>';
$html .= '</td>';
$html .= '<td>';
$html .= '<input type="text" size="5" onfocus="this.select()"'
. 'name="index[columns][sub_parts][]" value="';
if ($index->getType() != 'SPATIAL') {
$html .= $column->getSubPart();
}
$html .= '"/>';
$html .= '</td>';
$html .= '</tr>';
$odd_row = !$odd_row;
} // end foreach $edited_index_info['Sequences']
for ($i = 0; $i < $add_fields; $i++) {
$html .= '<tr class="';
$html .= $odd_row ? 'odd' : 'even';
$html .= 'noclick">';
$html .= '<td>';
$html .= '<select name="index[columns][names][]">';
$html .= '<option value="">-- ' . __('Ignore') . ' --</option>';
foreach ($fields as $field_name => $field_type) {
$html .= '<option value="' . htmlspecialchars($field_name) . '">'
. htmlspecialchars($field_name) . ' ['
. htmlspecialchars($field_type) . ']'
. '</option>' . "\n";
} // end foreach $fields
$html .= '</select>';
$html .= '</td>';
$html .= '<td>'
. '<input type="text" size="5" onfocus="this.select()"'
. 'name="index[columns][sub_parts][]" value="" />'
. '</td>';
$html .= '</tr>';
$odd_row = !$odd_row;
} // end foreach $edited_index_info['Sequences']
$html .= '</tbody>';
$html .= '</table>';
$html .= '</fieldset>';
$html .= '<fieldset class="tblFooters">';
$btn_value = sprintf(__('Add %s column(s) to index'), 1);
$html .= '<div class="slider"></div>';
$html .= '<div class="add_fields">';
$html .= '<input type="submit" value="' . $btn_value . '" />';
$html .= '</div>';
$html .= '</fieldset>';
$html .= '</form>';
return $html;
}
?>

135
tbl_indexes.php
View File

@ -12,130 +12,17 @@
require_once 'libraries/common.inc.php';
require_once 'libraries/Index.class.php';
require_once 'libraries/tbl_common.inc.php';
require_once 'libraries/tbl_indexes.lib.php';
// Get fields and stores their name/type
$fields = array();
foreach ($GLOBALS['dbi']->getColumnsFull($db, $table) as $row) {
if (preg_match('@^(set|enum)\((.+)\)$@i', $row['Type'], $tmp)) {
$tmp[2] = substr(
preg_replace('@([^,])\'\'@', '\\1\\\'', ',' . $tmp[2]), 1
);
$fields[$row['Field']] = $tmp[1] . '('
. str_replace(',', ', ', $tmp[2]) . ')';
} else {
$fields[$row['Field']] = $row['Type'];
}
} // end while
// Prepares the form values
if (isset($_REQUEST['index'])) {
if (is_array($_REQUEST['index'])) {
// coming already from form
$index = new PMA_Index($_REQUEST['index']);
} else {
$index = PMA_Index::singleton($db, $table, $_REQUEST['index']);
}
} else {
$index = new PMA_Index;
}
$index = PMA_prepareFormValues($db, $table);
/**
* Process the data from the edit/create index form,
* run the query to build the new index
* and moves back to "tbl_sql.php"
*/
if (isset($_REQUEST['do_save_data'])) {
$error = false;
// $sql_query is the one displayed in the query box
$sql_query = 'ALTER TABLE ' . PMA_Util::backquote($db)
. '.' . PMA_Util::backquote($table);
// Drops the old index
if (! empty($_REQUEST['old_index'])) {
if ($_REQUEST['old_index'] == 'PRIMARY') {
$sql_query .= ' DROP PRIMARY KEY,';
} else {
$sql_query .= ' DROP INDEX '
. PMA_Util::backquote($_REQUEST['old_index']) . ',';
}
} // end if
// Builds the new one
switch ($index->getType()) {
case 'PRIMARY':
if ($index->getName() == '') {
$index->setName('PRIMARY');
} elseif ($index->getName() != 'PRIMARY') {
$error = PMA_Message::error(
__('The name of the primary key must be "PRIMARY"!')
);
}
$sql_query .= ' ADD PRIMARY KEY';
break;
case 'FULLTEXT':
case 'UNIQUE':
case 'INDEX':
case 'SPATIAL':
if ($index->getName() == 'PRIMARY') {
$error = PMA_Message::error(__('Can\'t rename index to PRIMARY!'));
}
$sql_query .= ' ADD ' . $index->getType() . ' '
. ($index->getName() ? PMA_Util::backquote($index->getName()) : '');
break;
} // end switch
$index_fields = array();
foreach ($index->getColumns() as $key => $column) {
$index_fields[$key] = PMA_Util::backquote($column->getName());
if ($column->getSubPart()) {
$index_fields[$key] .= '(' . $column->getSubPart() . ')';
}
} // end while
if (empty($index_fields)) {
$error = PMA_Message::error(__('No index parts defined!'));
} else {
$sql_query .= ' (' . implode(', ', $index_fields) . ')';
}
if (PMA_MYSQL_INT_VERSION > 50500) {
$sql_query .= "COMMENT '"
. PMA_Util::sqlAddSlashes($index->getComment())
. "'";
}
$sql_query .= ';';
if (! $error) {
$GLOBALS['dbi']->query($sql_query);
$message = PMA_Message::success(
__('Table %1$s has been altered successfully')
);
$message->addParam($table);
if ($GLOBALS['is_ajax_request'] == true) {
$response = PMA_Response::getInstance();
$response->addJSON('message', $message);
$response->addJSON('index_table', PMA_Index::getView($table, $db));
$response->addJSON(
'sql_query',
PMA_Util::getMessage(null, $sql_query)
);
} else {
$active_page = 'tbl_structure.php';
include 'tbl_structure.php';
}
exit;
} else {
if ($GLOBALS['is_ajax_request'] == true) {
$response = PMA_Response::getInstance();
$response->isSuccess(false);
$response->addJSON('message', $error);
exit;
} else {
$error->display();
}
}
PMA_handleCreateOrEditIndex($db, $table, $index);
} // end builds the new index
@ -143,5 +30,19 @@ if (isset($_REQUEST['do_save_data'])) {
* Display the form to edit/create an index
*/
require_once 'libraries/tbl_info.inc.php';
require_once 'libraries/display_indexes.lib.php';
$add_fields = PMA_getNumberOfFieldsForForm($index);
$form_params = PMA_getFormParameters($db, $table);
// Get fields and stores their name/type
$fields = PMA_getNameAndTypeOfTheColumns($db, $table);
$html = PMA_getHtmlForIndexForm($fields, $index, $form_params, $add_fields);
$response = PMA_Response::getInstance();
$response->addHTML($html);
$header = $response->getHeader();
$scripts = $header->getScripts();
$scripts->addFile('indexes.js');
?>