2 /************************************************************************
3 * MXChange v0.2.1 Start: 08/29/2004 *
4 * =============== Last change: 08/29/2004 *
6 * -------------------------------------------------------------------- *
7 * File : lib-mysql3.php *
8 * -------------------------------------------------------------------- *
9 * Short description : Database layer for MySQL +3.x server *
10 * -------------------------------------------------------------------- *
11 * Kurzbeschreibung : Datenbankschicht fuer MySQL +3.x Server *
12 * -------------------------------------------------------------------- *
15 * $Tag:: 0.2.1-FINAL $ *
17 * Needs to be in all Files and every File needs "svn propset *
18 * svn:keywords Date Revision" (autoprobset!) at least!!!!!! *
19 * -------------------------------------------------------------------- *
20 * Copyright (c) 2003 - 2008 by Roland Haeder *
21 * For more information visit: http://www.mxchange.org *
23 * This program is free software; you can redistribute it and/or modify *
24 * it under the terms of the GNU General Public License as published by *
25 * the Free Software Foundation; either version 2 of the License, or *
26 * (at your option) any later version. *
28 * This program is distributed in the hope that it will be useful, *
29 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
30 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
31 * GNU General Public License for more details. *
33 * You should have received a copy of the GNU General Public License *
34 * along with this program; if not, write to the Free Software *
35 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, *
37 ************************************************************************/
39 // Some security stuff...
40 if (!defined('__SECURITY')) {
41 $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), '/inc') + 4) . '/security.php';
46 function SQL_QUERY ($sql_string, $F, $L) {
48 if (!SQL_IS_LINK_UP()) {
49 // We should not quietly ignore this!
50 trigger_error(sprintf("Cannot query database: sql_string=%s,file=%s,line=%s",
56 // Return 'false' because it has failed
60 // Remove \t, \n and \r from queries they may confuse some MySQL version I have heard
61 $sql_string = str_replace("\t", " ", str_replace("\n", " ", str_replace("\r", " ", $sql_string)));
63 // Replace {!_MYSQL_PREFIX!} with constant, closes #84. Thanks to profi-concept
64 $sql_string = str_replace("{!_MYSQL_PREFIX!}", getConfig('_MYSQL_PREFIX'), $sql_string);
66 // Replace {!_TABLE_TYPE!} with constant
67 $sql_string = str_replace("{!_TABLE_TYPE!}", getConfig('_TABLE_TYPE'), $sql_string);
70 $querytimeBefore = array_sum(explode(' ', microtime()));
73 //* DEBUG: */ echo $sql_string."<br />\n";
74 $result = mysql_query($sql_string, SQL_GET_LINK())
75 or addFatalMessage(__FUNCTION__, __LINE__, $F." (".$L."):".mysql_error()."<br />
80 $querytimeAfter = array_sum(explode(' ', microtime()));
82 // Calculate query time
83 $queryTime = $querytimeAfter - $querytimeBefore;
85 // Save last successfull query
86 setConfigEntry('db_last_query', $sql_string);
89 incrementConfigEntry('sql_count');
92 //* DEBUG: */ print "Query=<pre>".$sql_string."</pre>, affected=<strong>".SQL_AFFECTEDROWS()."</strong>, numrows=<strong>".SQL_NUMROWS($result)."</strong><br />\n";
93 if ((getOutputMode() != '1') && (getOutputMode() != '-1') && (isDebugModeEnabled()) && (getConfig('DEBUG_SQL') == 'Y')) {
97 $fp = fopen(constant('PATH') . 'inc/cache/mysql.log', 'a') or app_die(__FILE__, __LINE__, "Cannot write mysql.log!");
98 if (!isset($GLOBALS['sql_first_entry'])) {
100 fwrite($fp, 'Module=' . getModule() . "\n");
101 $GLOBALS['sql_first_entry'] = true;
103 fwrite($fp, $F."(LINE=".$L."|NUM=".SQL_NUMROWS($result)."|AFFECTED=".SQL_AFFECTEDROWS()."|QUERYTIME:".$queryTime."): ".str_replace("\r", '', str_replace("\n", " ", $sql_string))."\n");
108 if (!isConfigEntrySet('db_hits_run')) {
109 // Count in dummy variable
110 setConfigEntry('db_hits_run', 1);
112 // Count to config array
113 incrementConfigEntry('db_hits_run');
121 function SQL_NUMROWS ($result) {
122 // Is the result a valid resource?
123 if (is_resource($result)) {
124 // Get the count of rows from database
125 $lines = mysql_num_rows($result);
127 // Is the result empty? Then we have an error!
128 if (empty($lines)) $lines = 0;
130 // No resource given, no lines found!
137 function SQL_AFFECTEDROWS() {
138 // Valid link resource?
139 if (!SQL_IS_LINK_UP()) return false;
142 $lines = mysql_affected_rows(SQL_GET_LINK());
149 function SQL_FETCHROW ($result) {
150 // Is a result resource set?
151 if (!is_resource($result)) return false;
153 // Fetch the data and return it
154 return mysql_fetch_row($result);
158 function SQL_FETCHARRAY($res, $nr=0, $remove_numerical=true) {
159 // Is a result resource set?
160 if (!is_resource($res)) return false;
165 // Load row from database
166 $row = mysql_fetch_array($res);
168 // Return only arrays here
169 if (is_array($row)) {
170 // Shall we remove numerical data here automatically?
171 if ($remove_numerical) {
172 // So let's remove all numerical elements to save memory!
174 for ($idx = 0; $idx < ($max / 2); $idx++) {
183 // Return a false here...
189 function SQL_RESULT ($res, $row, $field = 0) {
191 if (!is_resource($res)) return false;
193 // Run the result command and return the result
194 $result = mysql_result($res, $row, $field);
199 function SQL_CONNECT ($host, $login, $password, $F, $L) {
201 $connect = mysql_connect($host, $login, $password) or addFatalMessage(__FUNCTION__, __LINE__, $F." (".$L."):".mysql_error());
203 // Set the link resource
204 SQL_SET_LINK($connect);
207 // SQL select database
208 function SQL_SELECT_DB ($dbName, $F, $L) {
209 // Is there still a valid link? If not, skip it.
210 if (!SQL_IS_LINK_UP()) return false;
213 return mysql_select_db($dbName, SQL_GET_LINK()) or addFatalMessage(__FUNCTION__, __LINE__, $F." (".$L."):".mysql_error());
217 function SQL_CLOSE ($F, $L) {
218 if (!SQL_IS_LINK_UP()) {
223 // Do we need to update cache/db counter?
224 //* DEBUG: */ echo "DB=".getConfig('db_hits').",CACHE=".getConfig('cache_hits')."<br />\n";
225 if ((GET_EXT_VERSION('cache') >= '0.0.7') && (getConfig('db_hits') > 0) && (getConfig('cache_hits') > 0) && (isCacheInstanceValid())) {
227 incrementConfigEntry('db_hits', getConfig('db_hits_run'));
229 // Update counter for db/cache
230 updateConfiguration(array('db_hits', 'cache_hits'), array(getConfig(('db_hits')), getConfig(('cache_hits'))));
233 // Close database link and forget the link
234 $close = mysql_close(SQL_GET_LINK()) or addFatalMessage(__FUNCTION__, __LINE__, $F." (".$L."):".mysql_error());
244 function SQL_FREERESULT ($result) {
245 if (!is_resource($result)) {
250 $res = mysql_free_result($result);
254 // SQL string escaping
255 function SQL_QUERY_ESC ($qstring, $data, $F, $L, $run=true, $strip=true, $secure=true) {
257 if (!SQL_IS_LINK_UP()) return false;
262 if ($strip === true) {
268 if ($secure === true) {
274 $eval = "\$query = sprintf(\"".$qstring."\"";
275 foreach ($data as $var) {
276 if ((!empty($var)) || ($var === 0)) {
277 $eval .= ", SQL_ESCAPE(\"".$var."\", ".$secure.", ".$strip.")";
286 //* DEBUG: */ $fp = fopen(constant('PATH')."inc/cache/escape_debug.log", 'a') or app_die(__FILE__, __LINE__, "Cannot write debug.log!");
287 //* DEBUG: */ fwrite($fp, $F.'('.$L."): ".str_replace("\r", '', str_replace("\n", " ", $eval))."\n");
288 //* DEBUG: */ fclose($fp);
293 // Was the eval() command fine?
294 if ($query == 'failed') {
295 // Something went wrong?
296 debug_report_bug("eval={$eval}");
300 // Run SQL query (default)
301 return SQL_QUERY($query, $F, $L);
303 // Return secured string
308 // Get ID from last INSERT command
309 function SQL_INSERTID () {
310 if (!SQL_IS_LINK_UP()) return false;
311 return mysql_insert_id();
314 // Escape a string for the database
315 function SQL_ESCAPE ($str, $secureString=true, $strip=true) {
316 // Secure string first? (which is the default behaviour!)
319 $str = secureString($str, $strip);
322 if (!SQL_IS_LINK_UP()) {
323 // Fall-back to smartAddSlashes() when there is no link
324 return smartAddSlashes($str);
325 } elseif (function_exists('mysql_real_escape_string')) {
326 // The new and improved version
327 //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):str={$str}<br />\n";
328 return mysql_real_escape_string($str, SQL_GET_LINK());
329 } elseif (function_exists('mysql_escape_string')) {
330 // The obsolete function
331 return mysql_escape_string($str, SQL_GET_LINK());
333 // If nothing else works, fall back to smartAddSlashes()
334 return smartAddSlashes($str);
338 // SELECT query string from table, columns and so on... ;-)
339 function SQL_RESULT_FROM_ARRAY ($table, $columns, $idRow, $id, $F, $L) {
340 // Is columns an array?
341 if (!is_array($columns)) {
343 trigger_error(sprintf("columns is not array. %s!=array", gettype($columns)));
346 // Prepare the SQL statement
347 $sql = "SELECT `".implode("`,`", $columns)."` FROM `{!_MYSQL_PREFIX!}_%s` WHERE `%s`='%s' LIMIT 1";
350 return SQL_QUERY_ESC($sql,
359 // ALTER TABLE wrapper function
360 function SQL_ALTER_TABLE ($sql, $F, $L) {
361 // This is the default result...
364 // Determine index/fulltext/unique word
367 strpos($sql, 'INDEX') === false
369 strpos($sql, 'FULLTEXT') === false
371 strpos($sql, 'UNIQUE') === false
375 // Extract table name
376 $tableArray = explode(" ", $sql);
377 $tableName = str_replace('`', '', $tableArray[2]);
379 // Shall we add/drop?
380 if (((strpos($sql, 'ADD') !== false) || (strpos($sql, 'DROP') !== false)) && ($noIndex === true)) {
381 // And column name as well
382 $columnName = str_replace('`', '', $tableArray[4]);
384 // Get column information
385 $result = SQL_QUERY_ESC("SHOW COLUMNS FROM %s LIKE '%s'",
386 array($tableName, $columnName), __FILE__, __LINE__);
388 // Do we have no entry on ADD or an entry on DROP?
389 // 123 4 4 3 3 4 4 32 23 4 4 3 3 4 4 321
390 if (((SQL_NUMROWS($result) == 0) && (strpos($sql, 'ADD') !== false)) || ((SQL_NUMROWS($result) == 1) && (strpos($sql, 'DROP') !== false))) {
392 //* DEBUG: */ print __LINE__.':'.$sql."<br />\n";
393 $result = SQL_QUERY($sql, $F, $L, false);
395 } elseif ((getConfig('_TABLE_TYPE') == 'InnoDB') && (strpos($sql, 'FULLTEXT') !== false)) {
396 // Skip this query silently
397 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Skipped FULLTEXT: sql=%s,file=%s,line=%s", $sql, $F, $L));
398 } elseif (!$noIndex) {
399 // And column name as well
400 $columnName = str_replace('`', '', $tableArray[4]);
402 // Is this "UNIQUE" or so? FULLTEXT has been handled the elseif() block above
403 if (in_array(strtoupper($columnName), array('INDEX', 'UNIQUE', 'KEY', 'FULLTEXT'))) {
405 $begin = 1; $columnName = ',';
406 while (strpos($columnName, ',') !== false) {
408 $columnName = str_replace('`', '', $tableArray[count($tableArray) - $begin]);
409 //* DEBUG: */ print __LINE__.':'.$columnName."----------------".$begin."<br />\n";
412 $columnName = str_replace('(', '', str_replace(')', '', $columnName));
413 //* DEBUG: */ print __LINE__.':'.$columnName."----------------".$begin."<br />\n";
421 $result = SQL_QUERY_ESC("SHOW INDEX FROM `%s`",
422 array($tableName), __FILE__, __LINE__);
426 while ($content = SQL_FETCHARRAY($result)) {
428 //* DEBUG: */ print "<pre>".print_r($content, true)."</pre>";
429 if (($content['Column_name'] == $columnName) || ($content['Key_name'] == $columnName)) {
431 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Skiped: %s", $sql));
438 SQL_FREERESULT($result);
442 // Send it to the SQL_QUERY() function
443 //* DEBUG: */ print __LINE__.':'.$sql."<br />\n";
444 $result = SQL_QUERY($sql, $F, $L, false);
447 // Other ALTER TABLE query
448 //* DEBUG: */ print __LINE__.':'.$sql."<br />\n";
449 $result = SQL_QUERY($sql, $F, $L, false);
456 // Getter for SQL link
457 function SQL_GET_LINK () {
461 // Is it in the globals?
462 if (isset($GLOBALS['sql_link'])) {
464 $link = $GLOBALS['sql_link'];
472 function SQL_SET_LINK ($link) {
473 // Is this a resource or null?
474 if ((!is_resource($link)) && (!is_null($link))) {
475 // This should never happen!
476 trigger_error(sprintf("link is not resource or null. Type: %s", gettype($link)));
480 $GLOBALS['sql_link'] = $link;
483 // Checks if the link is up
484 function SQL_IS_LINK_UP () {
486 $link = SQL_GET_LINK();
489 return (is_resource($link));