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()) return false;
50 // Remove \t, \n and \r from queries they may confuse some MySQL version I have heard
51 $sql_string = str_replace("\t", " ", str_replace("\n", " ", str_replace("\r", " ", $sql_string)));
53 // Replace {!_MYSQL_PREFIX!} with constant, closes #84. Thanks to profi-concept
54 $sql_string = str_replace("{!_MYSQL_PREFIX!}", constant('_MYSQL_PREFIX'), $sql_string);
56 // Replace {!_TABLE_TYPE!} with constant
57 $sql_string = str_replace("{!_TABLE_TYPE!}", constant('_TABLE_TYPE'), $sql_string);
60 $querytimeBefore = array_sum(explode(' ', microtime()));
63 //* DEBUG: */ echo $sql_string."<br />\n";
64 $result = mysql_query($sql_string, SQL_GET_LINK())
65 or addFatalMessage(__FUNCTION__, __LINE__, $F." (".$L."):".mysql_error()."<br />
70 $querytimeAfter = array_sum(explode(' ', microtime()));
72 // Calculate query time
73 $queryTime = $querytimeAfter - $querytimeBefore;
75 // Save last successfull query
76 setConfigEntry('db_last_query', $sql_string);
79 incrementConfigEntry('sql_count');
82 //* DEBUG: */ print "Query=<pre>".$sql_string."</pre>, affected=<strong>".SQL_AFFECTEDROWS()."</strong>, numrows=<strong>".SQL_NUMROWS($result)."</strong><br />\n";
83 if (($GLOBALS['output_mode'] != "1") && ($GLOBALS['output_mode'] != "-1") && (isDebugModeEnabled()) && (isBooleanConstantAndTrue('DEBUG_SQL'))) {
87 $fp = fopen(constant('PATH')."inc/cache/mysql.log", 'a') or app_die(__FILE__, __LINE__, "Cannot write mysql.log!");
88 if (!isset($GLOBALS['sql_first_entry'])) {
90 fwrite($fp, "Module=".$GLOBALS['module']."\n");
91 $GLOBALS['sql_first_entry'] = true;
93 fwrite($fp, $F."(LINE=".$L."|NUM=".SQL_NUMROWS($result)."|AFFECTED=".SQL_AFFECTEDROWS()."|QUERYTIME:".$queryTime."): ".str_replace('\r', '', str_replace('\n', " ", $sql_string))."\n");
98 if (!isConfigEntrySet('db_hits_run')) {
99 // Count in dummy variable
100 setConfigEntry('db_hits_run', 1);
102 // Count to config array
103 incrementConfigEntry('db_hits_run');
111 function SQL_NUMROWS ($result) {
112 // Is the result a valid resource?
113 if (is_resource($result)) {
114 // Get the count of rows from database
115 $lines = mysql_num_rows($result);
117 // Is the result empty? Then we have an error!
118 if (empty($lines)) $lines = 0;
120 // No resource given, no lines found!
127 function SQL_AFFECTEDROWS() {
128 // Valid link resource?
129 if (!SQL_IS_LINK_UP()) return false;
132 $lines = mysql_affected_rows(SQL_GET_LINK());
139 function SQL_FETCHROW ($result) {
140 // Is a result resource set?
141 if (!is_resource($result)) return false;
143 // Fetch the data and return it
144 return mysql_fetch_row($result);
148 function SQL_FETCHARRAY($res, $nr=0, $remove_numerical=true) {
149 // Is a result resource set?
150 if (!is_resource($res)) return false;
155 // Load row from database
156 $row = mysql_fetch_array($res);
158 // Return only arrays here
159 if (is_array($row)) {
160 // Shall we remove numerical data here automatically?
161 if ($remove_numerical) {
162 // So let's remove all numerical elements to save memory!
164 for ($idx = 0; $idx < ($max / 2); $idx++) {
173 // Return a false here...
179 function SQL_RESULT ($res, $row, $field = 0) {
181 if (!is_resource($res)) return false;
183 // Run the result command and return the result
184 $result = mysql_result($res, $row, $field);
189 function SQL_CONNECT ($host, $login, $password, $F, $L) {
191 $connect = mysql_connect($host, $login, $password) or addFatalMessage(__FUNCTION__, __LINE__, $F." (".$L."):".mysql_error());
193 // Set the link resource
194 SQL_SET_LINK($connect);
197 // SQL select database
198 function SQL_SELECT_DB ($dbName, $F, $L) {
199 // Is there still a valid link? If not, skip it.
200 if (!SQL_IS_LINK_UP()) return false;
203 return mysql_select_db($dbName, SQL_GET_LINK()) or addFatalMessage(__FUNCTION__, __LINE__, $F." (".$L."):".mysql_error());
207 function SQL_CLOSE ($F, $L) {
208 if (!SQL_IS_LINK_UP()) {
213 // Do we need to update cache/db counter?
214 //* DEBUG: */ echo "DB=".getConfig('db_hits').",CACHE=".getConfig('cache_hits')."<br />\n";
215 if ((GET_EXT_VERSION('cache') >= '0.0.7') && (getConfig('db_hits') > 0) && (getConfig('cache_hits') > 0) && (isCacheInstanceValid())) {
217 incrementConfigEntry('db_hits', getConfig('db_hits_run'));
219 // Update counter for db/cache
220 UPDATE_CONFIG(array('db_hits', 'cache_hits'), array(getConfig(('db_hits')), getConfig(('cache_hits'))));
223 // Close database link and forget the link
224 $close = mysql_close(SQL_GET_LINK()) or addFatalMessage(__FUNCTION__, __LINE__, $F." (".$L."):".mysql_error());
234 function SQL_FREERESULT ($result) {
235 if (!is_resource($result)) {
240 $res = mysql_free_result($result);
244 // SQL string escaping
245 function SQL_QUERY_ESC ($qstring, $data, $F, $L, $run=true, $strip=true, $secure=true) {
247 if (!SQL_IS_LINK_UP()) return false;
252 if ($strip === true) {
258 if ($secure === true) {
264 $eval = "\$query = sprintf(\"".$qstring."\"";
265 foreach ($data as $var) {
266 if ((!empty($var)) || ($var === 0)) {
267 $eval .= ", SQL_ESCAPE(\"".$var."\", ".$secure.", ".$strip.")";
276 //* DEBUG: */ $fp = fopen(constant('PATH')."inc/cache/escape_debug.log", 'a') or app_die(__FILE__, __LINE__, "Cannot write debug.log!");
277 //* DEBUG: */ fwrite($fp, $F."(".$L."): ".str_replace("\r", '', str_replace("\n", " ", $eval))."\n");
278 //* DEBUG: */ fclose($fp);
283 // Was the eval() command fine?
284 if ($query == "failed") {
285 // Something went wrong?
286 debug_report_bug("eval={$eval}");
290 // Run SQL query (default)
291 return SQL_QUERY($query, $F, $L);
293 // Return secured string
298 // Get ID from last INSERT command
299 function SQL_INSERTID () {
300 if (!SQL_IS_LINK_UP()) return false;
301 return mysql_insert_id();
304 // Escape a string for the database
305 function SQL_ESCAPE ($str, $secureString=true, $strip=true) {
306 // Secure string first? (which is the default behaviour!)
309 $str = secureString($str, $strip);
312 if (!SQL_IS_LINK_UP()) {
313 // Fall-back to smartAddSlashes() when there is no link
314 return smartAddSlashes($str);
315 } elseif (function_exists('mysql_real_escape_string')) {
316 // The new and improved version
317 //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):str={$str}<br />\n";
318 return mysql_real_escape_string($str, SQL_GET_LINK());
319 } elseif (function_exists('mysql_escape_string')) {
320 // The obsolete function
321 return mysql_escape_string($str, SQL_GET_LINK());
323 // If nothing else works, fall back to smartAddSlashes()
324 return smartAddSlashes($str);
328 // SELECT query string from table, columns and so on... ;-)
329 function SQL_RESULT_FROM_ARRAY ($table, $columns, $idRow, $id, $F, $L) {
330 // Is columns an array?
331 if (!is_array($columns)) {
333 trigger_error(sprintf("columns is not array. %s!=array", gettype($columns)));
336 // Prepare the SQL statement
337 $sql = "SELECT `".implode("`,`", $columns)."` FROM `{!_MYSQL_PREFIX!}_%s` WHERE ``='%s' LIMIT 1";
340 return SQL_QUERY_ESC($sql,
348 // ALTER TABLE wrapper function
349 function SQL_ALTER_TABLE ($sql, $F, $L) {
350 // This is the default result...
353 // Determine index/fulltext/unique word
354 // 12 3 3 2 2 3 3 2 2 3 3 21
355 $noIndex = ((ereg("INDEX", $sql) == false) && (ereg("FULLTEXT", $sql) == false) && (ereg("UNIQUE", $sql) == false));
357 // Extract table name
358 $tableArray = explode(" ", $sql);
359 $tableName = str_replace("`", '', $tableArray[2]);
361 // Shall we add/drop?
362 if (((ereg("ADD", $sql)) || (ereg("DROP", $sql))) && ($noIndex)) {
363 // And column name as well
364 $columnName = str_replace("`", '', $tableArray[4]);
366 // Get column information
367 $result = SQL_QUERY_ESC("SHOW COLUMNS FROM %s LIKE '%s'",
368 array($tableName, $columnName), __FILE__, __LINE__);
370 // Do we have no entry on ADD or an entry on DROP?
371 // 123 4 4 3 3 4 432 23 4 4 3 3 4 4321
372 if (((SQL_NUMROWS($result) == 0) && (ereg("ADD", $sql))) || ((SQL_NUMROWS($result) == 1) && (ereg("DROP", $sql)))) {
374 //* DEBUG: */ print __LINE__.":".$sql."<br />\n";
375 $result = SQL_QUERY($sql, $F, $L, false);
377 } elseif ((constant('_TABLE_TYPE') == "InnoDB") && (ereg("FULLTEXT", $sql))) {
378 // Skip this query silently
379 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Skipped FULLTEXT: sql=%s,file=%s,line=%s", $sql, $F, $L));
380 } elseif (!$noIndex) {
381 // And column name as well
382 $columnName = str_replace("`", '', $tableArray[4]);
384 // Is this "UNIQUE" or so? FULLTEXT has been handled the elseif() block above
385 if (in_array(strtoupper($columnName), array("INDEX", "UNIQUE", "KEY", "FULLTEXT"))) {
387 $begin = 1; $columnName = ",";
388 while (strpos($columnName, ",") !== false) {
390 $columnName = str_replace("`", '', $tableArray[count($tableArray) - $begin]);
391 //* DEBUG: */ print __LINE__.":".$columnName."----------------".$begin."<br />\n";
394 $columnName = str_replace("(", '', str_replace(")", '', $columnName));
395 //* DEBUG: */ print __LINE__.":".$columnName."----------------".$begin."<br />\n";
403 $result = SQL_QUERY_ESC("SHOW INDEX FROM %s",
404 array($tableName), __FILE__, __LINE__);
408 while ($content = SQL_FETCHARRAY($result)) {
410 //* DEBUG: */ print "<pre>".print_r($content, true)."</pre>";
411 if (($content['Column_name'] == $columnName) || ($content['Key_name'] == $columnName)) {
413 //* DEBUG: */ DEBUG_LOG(__FUNCTION__, __LINE__, sprintf("Skiped: %s", $sql));
420 SQL_FREERESULT($result);
424 // Send it to the SQL_QUERY() function
425 //* DEBUG: */ print __LINE__.":".$sql."<br />\n";
426 $result = SQL_QUERY($sql, $F, $L, false);
429 // Other ALTER TABLE query
430 //* DEBUG: */ print __LINE__.":".$sql."<br />\n";
431 $result = SQL_QUERY($sql, $F, $L, false);
438 // Getter for SQL link
439 function SQL_GET_LINK () {
443 // Is it in the globals?
444 if (isset($GLOBALS['sql_link'])) {
446 $link = $GLOBALS['sql_link'];
454 function SQL_SET_LINK ($link) {
455 // Is this a resource or null?
456 if ((!is_resource($link)) && (!is_null($link))) {
457 // This should never happen!
458 trigger_error(sprintf("link is not resource or null. Type: %s", gettype($link)));
462 $GLOBALS['sql_link'] = $link;
465 // Checks if the link is up
466 function SQL_IS_LINK_UP () {
468 $link = SQL_GET_LINK();
471 return (is_resource($link));