inc/db/lib-mysql3.php

   1 <?php
   2 /************************************************************************
   3  * MXChange v0.2.1                                    Start: 08/29/2004 *
   4  * ===============                              Last change: 08/29/2004 *
   5  *                                                                      *
   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  * -------------------------------------------------------------------- *
  13  * $Revision::                                                        $ *
  14  * $Date::                                                            $ *
  15  * $Tag:: 0.2.1-FINAL                                                 $ *
  16  * $Author::                                                          $ *
  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 - 2009 by Roland Haeder                           *
  21  * For more information visit: http://www.mxchange.org                  *
  22  *                                                                      *
  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.                                  *
  27  *                                                                      *
  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.                         *
  32  *                                                                      *
  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,               *
  36  * MA  02110-1301  USA                                                  *
  37  ************************************************************************/
  38
  39 // Some security stuff...
  40 if (!defined('__SECURITY')) {
  41         die();
  42 } // END - if
  43
  44 // SQL queries
  45 function SQL_QUERY ($sqlString, $F, $L) {
  46         // Trim SQL string
  47         $sqlString = trim($sqlString);
  48
  49         // Link is up?
  50         if (!SQL_IS_LINK_UP()) {
  51                 // We should not quietly ignore this!
  52                 debug_report_bug(sprintf("Cannot query database: sqlString=%s,file=%s,line=%s",
  53                         $sqlString,
  54                         basename($F),
  55                         $L
  56                 ));
  57
  58                 // Return 'false' because it has failed
  59                 return false;
  60         } elseif (empty($sqlString)) {
  61                 // Empty SQL string!
  62                 debug_report_bug(sprintf("SQL string is empty. Please fix this. file=%s, line=%s",
  63                         basename($F),
  64                         $L
  65                 ));
  66
  67                 // This is invalid, of course
  68                 return false;
  69         }
  70
  71         // Remove \t, \n and \r from queries they may confuse some MySQL version I have heard
  72         $sqlString = str_replace("\t", ' ', str_replace("\n", ' ', str_replace("\r", ' ', $sqlString)));
  73
  74         // Compile config out
  75         $sqlString = FILTER_COMPILE_CONFIG($sqlString);
  76
  77         // Starting time
  78         $querytimeBefore = array_sum(explode(' ', microtime()));
  79
  80         // Run SQL command
  81         //* DEBUG: */ print($sqlString . '<br />');
  82         $result = mysql_query($sqlString, SQL_GET_LINK())
  83                 or addFatalMessage(__FUNCTION__, __LINE__, $F . ' (' . $L . '):' . mysql_error() . '<br />
  84 Query string:<br />
  85 ' . $sqlString);
  86         //* DEBUG: */ print(__LINE__ . ': numRows=' . SQL_NUMROWS($result) . ',affected=' . SQL_AFFECTEDROWS() . "<br />");
  87
  88         // Ending time
  89         $querytimeAfter = array_sum(explode(' ', microtime()));
  90
  91         // Calculate query time
  92         $queryTime = $querytimeAfter - $querytimeBefore;
  93
  94         // Add this query to array including timing
  95         addSqlToDebug($result, $sqlString, $queryTime, $F, $L);
  96
  97         // Save last successfull query
  98         setConfigEntry('db_last_query', $sqlString);
  99
 100         // Count all query times
 101         incrementConfigEntry('sql_time', $queryTime);
 102
 103         // Count this query
 104         incrementConfigEntry('sql_count');
 105
 106         // Debug output
 107         if ((getOutputMode() != 1) && (isDebugModeEnabled()) && (isConfigEntrySet('DEBUG_SQL')) && (getConfig('DEBUG_SQL') == 'Y')) {
 108                 //
 109                 // Debugging stuff...
 110                 //
 111                 $fp = fopen(getConfig('CACHE_PATH') . 'mysql.log', 'a') or app_die(__FILE__, __LINE__, "Cannot write mysql.log!");
 112                 if (!isset($GLOBALS['sql_first_entry'])) {
 113                         // Write first entry
 114                         fwrite($fp, 'Module=' . getModule() . "\n");
 115                         $GLOBALS['sql_first_entry'] = true;
 116                 } // END - if
 117                 fwrite($fp, $F . '(LINE=' . $L . '|NUM=' . SQL_NUMROWS($result) . '|AFFECTED=' . SQL_AFFECTEDROWS() . '|QUERYTIME:' . $queryTime . '): ' . str_replace("\r", '', str_replace("\n", ' ', $sqlString)) . "\n");
 118                 fclose($fp);
 119         } // END - if
 120
 121         // Count DB hits
 122         if (!isStatsEntrySet('db_hits')) {
 123                 // Count in dummy variable
 124                 setStatsEntry('db_hits', 1);
 125         } else {
 126                 // Count to config array
 127                 incrementStatsEntry('db_hits');
 128         }
 129
 130         // Return the result
 131         return $result;
 132 }
 133
 134 // SQL num rows
 135 function SQL_NUMROWS ($result) {
 136         // Link is not up, no rows by default
 137         $lines = false;
 138
 139         // Is the result a valid resource?
 140         if (is_resource($result)) {
 141                 // Get the count of rows from database
 142                 $lines = mysql_num_rows($result);
 143
 144                 // Is the result empty? Then we have an error!
 145                 if (empty($lines)) $lines = 0;
 146         } elseif (SQL_IS_LINK_UP()) {
 147                 // No resource given, no lines found!
 148                 $lines = 0;
 149         }
 150
 151         // Return lines
 152         return $lines;
 153 }
 154
 155 // SQL affected rows
 156 function SQL_AFFECTEDROWS() {
 157         // Valid link resource?
 158         if (!SQL_IS_LINK_UP()) return false;
 159
 160         // Get affected rows
 161         $lines = mysql_affected_rows(SQL_GET_LINK());
 162
 163         // Return it
 164         return $lines;
 165 }
 166
 167 // SQL fetch row
 168 function SQL_FETCHROW ($result) {
 169         // Is a result resource set?
 170         if ((!is_resource($result)) || (!SQL_IS_LINK_UP())) return false;
 171
 172         // Fetch the data and return it
 173         return mysql_fetch_row($result);
 174 }
 175
 176 // SQL fetch array
 177 function SQL_FETCHARRAY ($res, $nr=0, $remove_numerical=true) {
 178         // Is a result resource set?
 179         if ((!is_resource($res)) || (!SQL_IS_LINK_UP())) return false;
 180
 181         // Initialize array
 182         $row = array();
 183
 184         // Load row from database
 185         $row = mysql_fetch_array($res);
 186
 187         // Return only arrays here
 188         if (is_array($row)) {
 189                 // Shall we remove numerical data here automatically?
 190                 if ($remove_numerical) {
 191                         // So let's remove all numerical elements to save memory!
 192                         $max = count($row);
 193                         for ($idx = 0; $idx < ($max / 2); $idx++) {
 194                                 // Remove entry
 195                                 unset($row[$idx]);
 196                         } // END - for
 197                 } // END - if
 198
 199                 // Return row
 200                 return $row;
 201         } else {
 202                 // Return a false here...
 203                 return false;
 204         }
 205 }
 206
 207 // SQL result
 208 function SQL_RESULT ($res, $row, $field = 0) {
 209         // Is $res valid?
 210         if ((!is_resource($res)) || (!SQL_IS_LINK_UP())) return false;
 211
 212         // Run the result command and return the result
 213         $result = mysql_result($res, $row, $field);
 214         return $result;
 215 }
 216
 217 // SQL connect
 218 function SQL_CONNECT ($host, $login, $password, $F, $L) {
 219         // Try to connect
 220         $connect = mysql_connect($host, $login, $password) or addFatalMessage(__FUNCTION__, __LINE__, $F." (".$L."):".mysql_error());
 221
 222         // Set the link resource
 223         SQL_SET_LINK($connect);
 224
 225         // Destroy cache
 226         unset($GLOBALS['sql_link_res']);
 227 }
 228
 229 // SQL select database
 230 function SQL_SELECT_DB ($dbName, $F, $L) {
 231         // Is there still a valid link? If not, skip it.
 232         if (!SQL_IS_LINK_UP()) return false;
 233
 234         // Return the result
 235         return mysql_select_db($dbName, SQL_GET_LINK()) or addFatalMessage(__FUNCTION__, __LINE__, $F." (".$L."):".mysql_error());
 236 }
 237
 238 // SQL close link
 239 function SQL_CLOSE ($F, $L) {
 240         if (!SQL_IS_LINK_UP()) {
 241                 // Skip double close
 242                 return false;
 243         } // END - if
 244
 245         // Close database link and forget the link
 246         $close = mysql_close(SQL_GET_LINK())
 247                 or addFatalMessage(__FUNCTION__, __LINE__, $F . ' (' . $L . '):'.mysql_error());
 248
 249         // Close link
 250         SQL_SET_LINK(null);
 251
 252         // Destroy cache
 253         unset($GLOBALS['sql_link_res']);
 254
 255         // Return the result
 256         return $close;
 257 }
 258
 259 // SQL free result
 260 function SQL_FREERESULT ($result) {
 261         if ((!is_resource($result)) || (!SQL_IS_LINK_UP())) {
 262                 // Abort here
 263                 return false;
 264         } // END - if
 265
 266         $res = mysql_free_result($result);
 267         return $res;
 268 }
 269
 270 // SQL string escaping
 271 function SQL_QUERY_ESC ($qstring, $data, $F, $L, $run=true, $strip=true, $secure=true) {
 272         // Link is there?
 273         if ((!SQL_IS_LINK_UP()) || (!is_array($data))) return false;
 274
 275         /* Other way */
 276         // Escape all data
 277         $dataSecured['__sql_string'] = $qstring;
 278         foreach ($data as $key => $value) {
 279                 $dataSecured[$key] = SQL_ESCAPE($value, $secure, $strip);
 280         } // END - foreach
 281
 282         // Generate query
 283         $query = call_user_func_array('sprintf', $dataSecured);
 284         /*
 285         /* Old eval() way... *
 286         // Init variable
 287         $query = 'failed';
 288
 289         if ($strip === true) {
 290                 $strip = 'true';
 291         } else {
 292                 $strip = 'false';
 293         }
 294
 295         if ($secure === true) {
 296                 $secure = 'true';
 297         } else {
 298                 $secure = 'false';
 299         }
 300
 301         $eval = "\$query = sprintf(\"" . $qstring . "\"";
 302         foreach ($data as $var) {
 303                 if ((!empty($var)) || ($var === 0)) {
 304                         $eval .= ", SQL_ESCAPE('" . $var . "', " . $secure . ', ' . $strip . ')';
 305                 } else {
 306                         $eval .= ", ''";
 307                 }
 308         } // END - foreach
 309         $eval .= ');';
 310         **/
 311
 312         // Debugging
 313         //
 314         //* DEBUG: */ $fp = fopen(getConfig('CACHE_PATH') . 'escape_debug.log', 'a') or app_die(__FILE__, __LINE__, "Cannot write debug.log!");
 315         //* DEBUG: */ fwrite($fp, $F.'('.$L."): ".str_replace("\r", '', str_replace("\n", " ", $eval))."\n");
 316         //* DEBUG: */ fclose($fp);
 317
 318         // Run the code
 319         /**
 320         eval($eval);
 321
 322         // Was the eval() command fine?
 323         if ($query == 'failed') {
 324                 // Something went wrong?
 325                 debug_report_bug('eval=' . $eval);
 326         } // END - if
 327         **/
 328
 329         if ($run === true) {
 330                 // Run SQL query (default)
 331                 return SQL_QUERY($query, $F, $L);
 332         } else {
 333                 // Return secured string
 334                 return $query;
 335         }
 336 }
 337
 338 // Get ID from last INSERT command
 339 function SQL_INSERTID () {
 340         if (!SQL_IS_LINK_UP()) return false;
 341         return mysql_insert_id();
 342 }
 343
 344 // Escape a string for the database
 345 function SQL_ESCAPE ($str, $secureString=true, $strip=true) {
 346         // Do we have cache?
 347         if (!isset($GLOBALS['sql_escapes'][''.$str.''])) {
 348                 // Secure string first? (which is the default behaviour!)
 349                 if ($secureString === true) {
 350                         // Then do it here
 351                         $str = secureString($str, $strip);
 352                 } // END - if
 353
 354                 if (!SQL_IS_LINK_UP()) {
 355                         // Fall-back to smartAddSlashes() when there is no link
 356                         $ret = smartAddSlashes($str);
 357                 } elseif (function_exists('mysql_real_escape_string')) {
 358                         // The new and improved version
 359                         //* DEBUG: */ print(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):str={$str}<br />");
 360                         $ret = mysql_real_escape_string($str, SQL_GET_LINK());
 361                 } elseif (function_exists('mysql_escape_string')) {
 362                         // The obsolete function
 363                         $ret = mysql_escape_string($str, SQL_GET_LINK());
 364                 } else {
 365                         // If nothing else works, fall back to smartAddSlashes() again
 366                         $ret = smartAddSlashes($str);
 367                 }
 368
 369                 // Cache result
 370                 $GLOBALS['sql_escapes'][''.$str.''] = $ret;
 371         } // END - if
 372
 373         // Return it
 374         return $GLOBALS['sql_escapes'][''.$str.''];
 375 }
 376
 377 // SELECT query string from table, columns and so on... ;-)
 378 function SQL_RESULT_FROM_ARRAY ($table, $columns, $idRow, $id, $F, $L) {
 379         // Is columns an array?
 380         if (!is_array($columns)) {
 381                 // No array
 382                 debug_report_bug(sprintf("columns is not an array. %s != array, file=%s, line=%s",
 383                         gettype($columns),
 384                         basename($F),
 385                         $L
 386                 ));
 387
 388                 // Abort here with 'false'
 389                 return false;
 390         } // END  - if
 391
 392         // Prepare the SQL statement
 393         $sql = "SELECT `".implode("`,`", $columns)."` FROM `{?_MYSQL_PREFIX?}_%s` WHERE `%s`='%s' LIMIT 1";
 394
 395         // Return the result
 396         return SQL_QUERY_ESC($sql,
 397                 array(
 398                         $table,
 399                         $idRow,
 400                         bigintval($id),
 401                 ), $F, $L
 402         );
 403 }
 404
 405 // ALTER TABLE wrapper function
 406 function SQL_ALTER_TABLE ($sql, $F, $L) {
 407         // Abort if link is down
 408         if (!SQL_IS_LINK_UP()) return false;
 409
 410         // This is the default result...
 411         $result = false;
 412
 413         // Determine index/fulltext/unique word
 414         $noIndex = (
 415         (
 416                 strpos($sql, 'INDEX') === false
 417         ) && (
 418                 strpos($sql, 'FULLTEXT') === false
 419         ) && (
 420                 strpos($sql, 'UNIQUE') === false
 421         )
 422         );
 423
 424         // Extract table name
 425         $tableArray = explode(" ", $sql);
 426         $tableName = str_replace('`', '', $tableArray[2]);
 427
 428         // Shall we add/drop?
 429         if (((strpos($sql, 'ADD') !== false) || (strpos($sql, 'DROP') !== false)) && ($noIndex === true)) {
 430                 // And column name as well
 431                 $columnName = str_replace('`', '', $tableArray[4]);
 432
 433                 // Get column information
 434                 $result = SQL_QUERY_ESC("SHOW COLUMNS FROM `%s` LIKE '%s'",
 435                         array($tableName, $columnName), __FILE__, __LINE__);
 436
 437                 // Do we have no entry on ADD or an entry on DROP?
 438                 // 123           4       4     3    3      4           4          32    23           4       4     3    3      4            4          321
 439                 if (((SQL_NUMROWS($result) == 0) && (strpos($sql, 'ADD') !== false)) || ((SQL_NUMROWS($result) == 1) && (strpos($sql, 'DROP') !== false))) {
 440                         // Do the query
 441                         //* DEBUG: */ print(__LINE__.':'.$sql."<br />");
 442                         $result = SQL_QUERY($sql, $F, $L, false);
 443                 } // END - if
 444         } elseif ((getConfig('_TABLE_TYPE') == 'InnoDB') && (strpos($sql, 'FULLTEXT') !== false)) {
 445                 // Skip this query silently
 446                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, sprintf("Skipped FULLTEXT: sql=%s,file=%s,line=%s", $sql, $F, $L));
 447         } elseif ($noIndex === false) {
 448                 // And column name as well
 449                 $columnName = str_replace('`', '', $tableArray[4]);
 450
 451                 // Is this "UNIQUE" or so? FULLTEXT has been handled the elseif() block above
 452                 if (in_array(strtoupper($columnName), array('INDEX', 'UNIQUE', 'KEY', 'FULLTEXT'))) {
 453                         // Init loop
 454                         $begin = 1; $columnName = ',';
 455                         while (strpos($columnName, ',') !== false) {
 456                                 // Use last
 457                                 $columnName = str_replace('`', '', $tableArray[count($tableArray) - $begin]);
 458                                 //* DEBUG: */ print(__LINE__.':'.$columnName."----------------".$begin."<br />");
 459
 460                                 // Remove brackes
 461                                 $columnName = str_replace('(', '', str_replace(')', '', $columnName));
 462                                 //* DEBUG: */ print(__LINE__.':'.$columnName."----------------".$begin."<br />");
 463
 464                                 // Continue
 465                                 $begin++;
 466                         } // END while
 467                 } // END - if
 468
 469                 // Show indexes
 470                 $result = SQL_QUERY_ESC("SHOW INDEX FROM `%s`",
 471                         array($tableName), __FILE__, __LINE__);
 472
 473                 // Walk through all
 474                 $skip = false;
 475                 while ($content = SQL_FETCHARRAY($result)) {
 476                         // Is it found?
 477                         //* DEBUG: */ print("<pre>".print_r($content, true)."</pre>");
 478                         if (($content['Column_name'] == $columnName) || ($content['Key_name'] == $columnName)) {
 479                                 // Skip this query!
 480                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, sprintf("Skiped: %s", $sql));
 481                                 $skip = true;
 482                                 break;
 483                         } // END - if
 484                 } // END - while
 485
 486                 // Free result
 487                 SQL_FREERESULT($result);
 488
 489                 // Shall we run it?
 490                 if ($skip === false) {
 491                         // Send it to the SQL_QUERY() function
 492                         //* DEBUG: */ print(__LINE__.':'.$sql."<br />");
 493                         $result = SQL_QUERY($sql, $F, $L, false);
 494                 } // END - if
 495         } else {
 496                 // Other ALTER TABLE query
 497                 //* DEBUG: */ print(__LINE__.':'.$sql."<br />");
 498                 $result = SQL_QUERY($sql, $F, $L, false);
 499         }
 500
 501         // Return result
 502         return $result;
 503 }
 504
 505 // Getter for SQL link
 506 function SQL_GET_LINK () {
 507         // Init link
 508         $link = null;
 509
 510         // Is it in the globals?
 511         if (isset($GLOBALS['sql_link'])) {
 512                 // Then take it
 513                 $link = $GLOBALS['sql_link'];
 514         } // END - if
 515
 516         // Return it
 517         return $link;
 518 }
 519
 520 // Setter for link
 521 function SQL_SET_LINK ($link) {
 522         // Is this a resource or null?
 523         if ((!is_resource($link)) && (!is_null($link))) {
 524                 // This should never happen!
 525                 debug_report_bug(sprintf("link is not resource or null. Type: %s", gettype($link)));
 526         } // END - if
 527
 528         // Set it
 529         $GLOBALS['sql_link'] = $link;
 530 }
 531
 532 // Checks if the link is up
 533 function SQL_IS_LINK_UP () {
 534         // Default is not up
 535         $linkUp = false;
 536
 537         // Do we have cached this?
 538         if (isset($GLOBALS['sql_link_res'])) {
 539                 // Then use this
 540                 $linkUp = $GLOBALS['sql_link_res'];
 541         } else {
 542                 // Get it
 543                 $linkUp = is_resource(SQL_GET_LINK());
 544
 545                 // And cache it
 546                 $GLOBALS['sql_link_res'] = $linkUp;
 547         }
 548
 549         // Return the result
 550         return $linkUp;
 551 }
 552
 553 // [EOF]
 554 ?>