Codding standards

This commit is contained in:
Loïc Chapeaux
2002-07-07 08:31:56 +00:00
parent e6f155003c
commit 6c70d8fdfc

145
sql.php3
View File

@@ -1,12 +1,14 @@
<?php <?php
/* $Id$ */ /* $Id$ */
/** /**
* Gets some core libraries * Gets some core libraries
*/ */
require('./libraries/grab_globals.lib.php3'); require('./libraries/grab_globals.lib.php3');
require('./libraries/common.lib.php3'); require('./libraries/common.lib.php3');
/** /**
* Defines the url to return to in case of error in a sql statement * Defines the url to return to in case of error in a sql statement
*/ */
@@ -34,6 +36,49 @@ if (!isset($err_url)) {
} // end if } // end if
/**
* SK -- Patch
*
* Does some preliminary formatting of the $sql_query to avoid problems with
* eregi and split:
* 1) separates reserved words in $sql_str from the next backquoted or
* parenthesized expression with a space;
* 2) capitalizes reserved words
* 3) removes repeated spaces
*
* @param string original query
*
* @return string formatted query
*/
function PMA_sqlFormat($sql_str) {
// Defines reserved words to deal with
$res_words_arr = array('DROP', 'SELECT', 'DELETE', 'UPDATE', 'INSERT', 'LOAD', 'EXPLAIN', 'SHOW', 'FROM', 'INTO', 'OUTFILE', 'DATA', 'REPLACE', 'CHECK', 'ANALYZE', 'REPAIR', 'OPTIMIZE', 'TABLE', 'ORDER', 'HAVING', 'LIMIT', 'GROUP', 'DISTINCT');
while (list(, $w) = each($res_words_arr)) {
// Separates a backquoted expression with spaces
$pattern = '[[:space:]]' . $w . '`([^`]*)`(.*)';
$replace = ' ' . $w . ' `\\1` \\2';
$sql_str = substr(eregi_replace($pattern, $replace, ' ' . $sql_str), 1);
// Separates a parenthesized expression with spaces
$pattern = '[[:space:]]' . $w . '\(([^)]*)\)(.*)';
$replace = ' ' . $w . ' (\\1) \\2';
$sql_str = substr(eregi_replace($pattern, $replace, ' ' . $sql_str), 1);
// Converts reservered words to upper case if not yet done
$sql_str = substr(eregi_replace('[[:space:]]' . $w . '[[:space:]]', ' ' . $w . ' ', ' ' . $sql_str), 1);
} // end while
// Removes repeated spaces
$sql_str = ereg_replace('[[:space:]]+', ' ', $sql_str);
// GROUP or ORDER: "BY" to uppercase too
$sql_str = eregi_replace('(GROUP|ORDER) BY', '\\1 BY', $sql_str);
return $sql_str;
} // end of the "PMA_sqlFormat()" function
/** /**
* Check rights in case of DROP DATABASE * Check rights in case of DROP DATABASE
* *
@@ -77,10 +122,8 @@ if (isset($btnDrop) || isset($navig)) {
$sql_query = urldecode($sql_query); $sql_query = urldecode($sql_query);
} }
/** // SK -- Patch : Reformats query - adds spaces when omitted and removes extra
* SK -- Patch : Reformat query - add spaces when omitted and remove // spaces; converts reserved words to uppercase
* extra spaces; convert reserved words to uppercase
*/
$sql_query = PMA_sqlFormat($sql_query); $sql_query = PMA_sqlFormat($sql_query);
@@ -110,6 +153,7 @@ if ($is_select) {
} }
} // end if } // end if
/** /**
* Sets or modifies the $goto variable if required * Sets or modifies the $goto variable if required
*/ */
@@ -218,15 +262,15 @@ else {
$repeat_cells = $cfg['RepeatCells']; $repeat_cells = $cfg['RepeatCells'];
} }
/** // SK -- Patch: $is_group added for use in calculation of total number of
* SK -- Patch : $is_group added for use in calculation of TOTAL NUMBER OF ROWS // rows.
* $is_count is changed for more correct "LIMIT" clause appending // $is_count is changed for more correct "LIMIT" clause
* in queries like SELECT COUNT(...) FROM ... GROUP BY ... // appending in queries like
*/ // "SELECT COUNT(...) FROM ... GROUP BY ..."
$is_explain = $is_count = $is_export = $is_delete = $is_insert = $is_affected = $is_show = $is_maint = $is_analyse = $is_group = $is_func = FALSE; $is_explain = $is_count = $is_export = $is_delete = $is_insert = $is_affected = $is_show = $is_maint = $is_analyse = $is_group = $is_func = FALSE;
if ($is_select) { // see line 76 if ($is_select) { // see line 141
$is_func = !$is_group && (eregi("( SUM\s*\(| AVG\s*\(| STD\s*\(| STDDEV\s*\(| MIN\s*\(| MAX\s*\(| BIT_OR\s*\(| BIT_AND\s*\()", $sql_query)); $is_func = !$is_group && (eregi('[[:space:]]+(SUM|AVG|STD|STDDEV|MIN|MAX|BIT_OR|BIT_AND)\s*\(', $sql_query));
$is_group = eregi("( GROUP BY | HAVING | SELECT DISTINCT )", $sql_query); $is_group = eregi('[[:space:]]+(GROUP BY|HAVING|SELECT[[:space:]]+DISTINCT)[[:space:]]+', $sql_query);
$is_count = !$is_group && (eregi('^SELECT[[:space:]]+COUNT\((.*\.+)?.*\)', $sql_query)); $is_count = !$is_group && (eregi('^SELECT[[:space:]]+COUNT\((.*\.+)?.*\)', $sql_query));
$is_export = (eregi('[[:space:]]+INTO[[:space:]]+OUTFILE[[:space:]]+', $sql_query)); $is_export = (eregi('[[:space:]]+INTO[[:space:]]+OUTFILE[[:space:]]+', $sql_query));
$is_analyse = (eregi('[[:space:]]+PROCEDURE[[:space:]]+ANALYSE\(', $sql_query)); $is_analyse = (eregi('[[:space:]]+PROCEDURE[[:space:]]+ANALYSE\(', $sql_query));
@@ -264,7 +308,6 @@ else {
$full_sql_query = $sql_query; $full_sql_query = $sql_query;
} // end if...else } // end if...else
PMA_mysql_select_db($db); PMA_mysql_select_db($db);
// If the query is a DELETE query with no WHERE clause, get the number of // If the query is a DELETE query with no WHERE clause, get the number of
@@ -313,40 +356,39 @@ else {
$unlim_num_rows = $num_rows; $unlim_num_rows = $num_rows;
} }
else if ($is_select) { else if ($is_select) {
/** // SK -- Patch : correct calculations for GROUP BY, HAVING, DISTINCT
* SK -- Patch : correct calculations for GROUP BY, HAVING, DISTINCT
*/
// reads only the from-part of the query...
// NOTE: here the presence of LIMIT is impossible,
// HAVING and GROUP BY are necessary for correct
// calculation, and extra spaces and lowercase reserved
// words are removed, so we have a simple split pattern:
$array = split('( FROM | ORDER BY )', $sql_query); // Reads only the from-part of the query...
// NOTE: here the presence of LIMIT is impossible, HAVING and GROUP BY
// are necessary for correct calculation, and extra spaces and
// lowercase reserved words are removed, so we have a simple split
// pattern:
// if $array[1] is empty here, there is an error in $array = split('[[:space:]]+(FROM|ORDER BY)[[:space:]]+', $sql_query);
// the query: "... FROM [ORDER BY ...]", but the query
// is already executed with success so this check is redundant??? // if $array[1] is empty here, there is an error in the query:
// "... FROM [ORDER BY ...]", but the query is already executed with
// success so this check is redundant???
if (!empty($array[1])) { if (!empty($array[1])) {
// ... and makes a count(*) to count the entries // ... and makes a count(*) to count the entries
// Special case: SELECT DISTINCT ... FROM ... // Special case: SELECT DISTINCT ... FROM ...
// the count of resulting rows can be found as: // the count of resulting rows can be found as:
// SELECT COUNT(DISTINCT ...) FROM ... // SELECT COUNT(DISTINCT ...) FROM ...
if (eregi("SELECT DISTINCT(.*)", $array[0], $array_dist)) { if (eregi('^SELECT DISTINCT(.*)', $array[0], $array_dist)) {
$count_what = "DISTINCT $array_dist[1]"; $count_what = 'DISTINCT ' . $array_dist[1];
} else { } else {
$count_what = "*"; $count_what = '*';
} }
$count_query = "SELECT COUNT($count_what) AS count FROM " . $array[1]; $count_query = 'SELECT COUNT(' . $count_what . ') AS count FROM ' . $array[1];
if ($cnt_all_result = mysql_query($count_query)) { if ($cnt_all_result = mysql_query($count_query)) {
if ($is_group) { if ($is_group) {
$unlim_num_rows = @mysql_num_rows($cnt_all_result); $unlim_num_rows = @mysql_num_rows($cnt_all_result);
} else { } else {
$unlim_num_rows = mysql_result($cnt_all_result, 0, 'count'); $unlim_num_rows = mysql_result($cnt_all_result, 0, 'count');
} }
mysql_free_result($cnt_all_result);
} }
@mysql_free_result($cna_all_result);
} else { } else {
$unlim_num_rows = 0; $unlim_num_rows = 0;
} }
@@ -428,7 +470,7 @@ else {
} else { } else {
$js_to_run = 'functions.js'; $js_to_run = 'functions.js';
unset($message); unset($message);
if (isset($table) && !empty($table)) { if (!empty($table)) {
include('./tbl_properties_common.php3'); include('./tbl_properties_common.php3');
include('./tbl_properties_table_info.php3'); include('./tbl_properties_table_info.php3');
} }
@@ -579,46 +621,5 @@ echo "\n\n";
*/ */
require('./footer.inc.php3'); require('./footer.inc.php3');
/**
* SK -- Patch
*
* Do some preliminary formatting of the $sql_query
* to avoid problems with eregi and split:
* 1) separate reserved words in $sql_str from the next
* bacquoted or parenthesized expression with a space
* 2) CAPITALIZE reserved words
* 3) remove repeated spaces
*
* @param string original query
*
* @return string formatted query
*/
function PMA_sqlFormat($sql_str) {
// Define reserved words to deal with
$res_words_arr = array("DROP", "SELECT", "DELETE", "UPDATE", "INSERT", "LOAD", "EXPLAIN", "SHOW", "FROM", "INTO", "OUTFILE", "DATA", "REPLACE", "CHECK", "ANALYZE", "REPAIR", "OPTIMIZE", "TABLE", "ORDER", "HAVING", "LIMIT", "GROUP" , "DISTINCT");
foreach ($res_words_arr as $w) {
// separate a backquoted expression with spaces
$pattern = " $w`([^`]*)`(.*)";
$replace = " $w `\\1` \\2";
$sql_str = substr(eregi_replace($pattern, $replace, ' ' . $sql_str), 1);
// separate a parenthesized expression with spaces
$pattern = " $w\(([^)]*)\)(.*)";
$replace = " $w (\\1) \\2";
$sql_str = substr(eregi_replace($pattern, $replace, ' ' . $sql_str), 1);
// convert reservered words to upper case if not yet done
$sql_str = substr(eregi_replace(" $w ", " $w ", ' ' . $sql_str), 1);
}; // end foreach
// remove repeated spaces
$sql_str = ereg_replace("[[:space:]]+", " ", $sql_str);
// GROUP or ORDER: "BY" to uppercase too
$sql_str = eregi_replace("(GROUP|ORDER) BY", "\\1 BY", $sql_str);
return $sql_str;
}; // end of the 'PMA_sqlFormat' function
?> ?>