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: */ outputHtml($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: */ outputHtml(__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()) && (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_run')) {
 123                 // Count in dummy variable
 124                 setStatsEntry('db_hits_run', 1);
 125         } else {
 126                 // Count to config array
 127                 incrementStatsEntry('db_hits_run');
 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         // Move stats
 256         incrementStatsEntry('db_hits', getStatsEntry('db_hits_run'));
 257
 258         // Return the result
 259         return $close;
 260 }
 261
 262 // SQL free result
 263 function SQL_FREERESULT ($result) {
 264         if ((!is_resource($result)) || (!SQL_IS_LINK_UP())) {
 265                 // Abort here
 266                 return false;
 267         } // END - if
 268
 269         $res = mysql_free_result($result);
 270         return $res;
 271 }
 272
 273 // SQL string escaping
 274 function SQL_QUERY_ESC ($qstring, $data, $F, $L, $run=true, $strip=true, $secure=true) {
 275         // Link is there?
 276         if ((!SQL_IS_LINK_UP()) || (!is_array($data))) return false;
 277
 278         /* Other way */
 279         // Escape all data
 280         $dataSecured['__sql_string'] = $qstring;
 281         foreach ($data as $key => $value) {
 282                 $dataSecured[$key] = SQL_ESCAPE($value, $secure, $strip);
 283         } // END - foreach
 284
 285         // Generate query
 286         $query = call_user_func_array('sprintf', $dataSecured);
 287         /*
 288         /* Old eval() way... *
 289         // Init variable
 290         $query = 'failed';
 291
 292         if ($strip === true) {
 293                 $strip = 'true';
 294         } else {
 295                 $strip = 'false';
 296         }
 297
 298         if ($secure === true) {
 299                 $secure = 'true';
 300         } else {
 301                 $secure = 'false';
 302         }
 303
 304         $eval = "\$query = sprintf(\"" . $qstring . "\"";
 305         foreach ($data as $var) {
 306                 if ((!empty($var)) || ($var === 0)) {
 307                         $eval .= ", SQL_ESCAPE('" . $var . "', " . $secure . ', ' . $strip . ')';
 308                 } else {
 309                         $eval .= ", ''";
 310                 }
 311         } // END - foreach
 312         $eval .= ');';
 313         **/
 314
 315         // Debugging
 316         //
 317         //* DEBUG: */ $fp = fopen(getConfig('CACHE_PATH') . 'escape_debug.log', 'a') or app_die(__FILE__, __LINE__, "Cannot write debug.log!");
 318         //* DEBUG: */ fwrite($fp, $F.'('.$L."): ".str_replace("\r", '', str_replace("\n", " ", $eval))."\n");
 319         //* DEBUG: */ fclose($fp);
 320
 321         // Run the code
 322         /**
 323         eval($eval);
 324
 325         // Was the eval() command fine?
 326         if ($query == 'failed') {
 327                 // Something went wrong?
 328                 debug_report_bug('eval=' . $eval);
 329         } // END - if
 330         **/
 331
 332         if ($run === true) {
 333                 // Run SQL query (default)
 334                 return SQL_QUERY($query, $F, $L);
 335         } else {
 336                 // Return secured string
 337                 return $query;
 338         }
 339 }
 340
 341 // Get ID from last INSERT command
 342 function SQL_INSERTID () {
 343         if (!SQL_IS_LINK_UP()) return false;
 344         return mysql_insert_id();
 345 }
 346
 347 // Escape a string for the database
 348 function SQL_ESCAPE ($str, $secureString=true, $strip=true) {
 349         // Do we have cache?
 350         if (isset($GLOBALS['sql_escapes'][$str])) {
 351                 // Then use it instead
 352                 return $GLOBALS['sql_escapes'][$str];
 353         } // END - if
 354
 355         // Secure string first? (which is the default behaviour!)
 356         if ($secureString === true) {
 357                 // Then do it here
 358                 $str = secureString($str, $strip);
 359         } // END - if
 360
 361         if (!SQL_IS_LINK_UP()) {
 362                 // Fall-back to smartAddSlashes() when there is no link
 363                 $ret = smartAddSlashes($str);
 364         } elseif (function_exists('mysql_real_escape_string')) {
 365                 // The new and improved version
 366                 //* DEBUG: */ outputHtml(__FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):str={$str}<br />");
 367                 $ret = mysql_real_escape_string($str, SQL_GET_LINK());
 368         } elseif (function_exists('mysql_escape_string')) {
 369                 // The obsolete function
 370                 $ret = mysql_escape_string($str, SQL_GET_LINK());
 371         } else {
 372                 // If nothing else works, fall back to smartAddSlashes() again
 373                 $ret = smartAddSlashes($str);
 374         }
 375
 376         // Cache result
 377         $GLOBALS['sql_escapes'][$str] = $ret;
 378
 379         // Return it
 380         return $ret;
 381 }
 382
 383 // SELECT query string from table, columns and so on... ;-)
 384 function SQL_RESULT_FROM_ARRAY ($table, $columns, $idRow, $id, $F, $L) {
 385         // Is columns an array?
 386         if (!is_array($columns)) {
 387                 // No array
 388                 debug_report_bug(sprintf("columns is not an array. %s != array, file=%s, line=%s",
 389                         gettype($columns),
 390                         basename($F),
 391                         $L
 392                 ));
 393
 394                 // Abort here with 'false'
 395                 return false;
 396         } // END  - if
 397
 398         // Prepare the SQL statement
 399         $sql = "SELECT `".implode("`,`", $columns)."` FROM `{?_MYSQL_PREFIX?}_%s` WHERE `%s`='%s' LIMIT 1";
 400
 401         // Return the result
 402         return SQL_QUERY_ESC($sql,
 403                 array(
 404                         $table,
 405                         $idRow,
 406                         bigintval($id),
 407                 ), $F, $L
 408         );
 409 }
 410
 411 // ALTER TABLE wrapper function
 412 function SQL_ALTER_TABLE ($sql, $F, $L) {
 413         // Abort if link is down
 414         if (!SQL_IS_LINK_UP()) return false;
 415
 416         // This is the default result...
 417         $result = false;
 418
 419         // Determine index/fulltext/unique word
 420         $noIndex = (
 421         (
 422                 strpos($sql, 'INDEX') === false
 423         ) && (
 424                 strpos($sql, 'FULLTEXT') === false
 425         ) && (
 426                 strpos($sql, 'UNIQUE') === false
 427         )
 428         );
 429
 430         // Extract table name
 431         $tableArray = explode(" ", $sql);
 432         $tableName = str_replace('`', '', $tableArray[2]);
 433
 434         // Shall we add/drop?
 435         if (((strpos($sql, 'ADD') !== false) || (strpos($sql, 'DROP') !== false)) && ($noIndex === true)) {
 436                 // And column name as well
 437                 $columnName = str_replace('`', '', $tableArray[4]);
 438
 439                 // Get column information
 440                 $result = SQL_QUERY_ESC("SHOW COLUMNS FROM `%s` LIKE '%s'",
 441                         array($tableName, $columnName), __FILE__, __LINE__);
 442
 443                 // Do we have no entry on ADD or an entry on DROP?
 444                 // 123           4       4     3    3      4           4          32    23           4       4     3    3      4            4          321
 445                 if (((SQL_NUMROWS($result) == 0) && (strpos($sql, 'ADD') !== false)) || ((SQL_NUMROWS($result) == 1) && (strpos($sql, 'DROP') !== false))) {
 446                         // Do the query
 447                         //* DEBUG: */ outputHtml(__LINE__.':'.$sql."<br />");
 448                         $result = SQL_QUERY($sql, $F, $L, false);
 449                 } // END - if
 450         } elseif ((getConfig('_TABLE_TYPE') == 'InnoDB') && (strpos($sql, 'FULLTEXT') !== false)) {
 451                 // Skip this query silently
 452                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, sprintf("Skipped FULLTEXT: sql=%s,file=%s,line=%s", $sql, $F, $L));
 453         } elseif ($noIndex === false) {
 454                 // And column name as well
 455                 $columnName = str_replace('`', '', $tableArray[4]);
 456
 457                 // Is this "UNIQUE" or so? FULLTEXT has been handled the elseif() block above
 458                 if (in_array(strtoupper($columnName), array('INDEX', 'UNIQUE', 'KEY', 'FULLTEXT'))) {
 459                         // Init loop
 460                         $begin = 1; $columnName = ',';
 461                         while (strpos($columnName, ',') !== false) {
 462                                 // Use last
 463                                 $columnName = str_replace('`', '', $tableArray[count($tableArray) - $begin]);
 464                                 //* DEBUG: */ outputHtml(__LINE__.':'.$columnName."----------------".$begin."<br />");
 465
 466                                 // Remove brackes
 467                                 $columnName = str_replace('(', '', str_replace(')', '', $columnName));
 468                                 //* DEBUG: */ outputHtml(__LINE__.':'.$columnName."----------------".$begin."<br />");
 469
 470                                 // Continue
 471                                 $begin++;
 472                         } // END while
 473                 } // END - if
 474
 475                 // Show indexes
 476                 $result = SQL_QUERY_ESC("SHOW INDEX FROM `%s`",
 477                         array($tableName), __FILE__, __LINE__);
 478
 479                 // Walk through all
 480                 $skip = false;
 481                 while ($content = SQL_FETCHARRAY($result)) {
 482                         // Is it found?
 483                         //* DEBUG: */ outputHtml("<pre>".print_r($content, true)."</pre>");
 484                         if (($content['Column_name'] == $columnName) || ($content['Key_name'] == $columnName)) {
 485                                 // Skip this query!
 486                                 //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, sprintf("Skiped: %s", $sql));
 487                                 $skip = true;
 488                                 break;
 489                         } // END - if
 490                 } // END - while
 491
 492                 // Free result
 493                 SQL_FREERESULT($result);
 494
 495                 // Shall we run it?
 496                 if ($skip === false) {
 497                         // Send it to the SQL_QUERY() function
 498                         //* DEBUG: */ outputHtml(__LINE__.':'.$sql."<br />");
 499                         $result = SQL_QUERY($sql, $F, $L, false);
 500                 } // END - if
 501         } else {
 502                 // Other ALTER TABLE query
 503                 //* DEBUG: */ outputHtml(__LINE__.':'.$sql."<br />");
 504                 $result = SQL_QUERY($sql, $F, $L, false);
 505         }
 506
 507         // Return result
 508         return $result;
 509 }
 510
 511 // Getter for SQL link
 512 function SQL_GET_LINK () {
 513         // Init link
 514         $link = null;
 515
 516         // Is it in the globals?
 517         if (isset($GLOBALS['sql_link'])) {
 518                 // Then take it
 519                 $link = $GLOBALS['sql_link'];
 520         } // END - if
 521
 522         // Return it
 523         return $link;
 524 }
 525
 526 // Setter for link
 527 function SQL_SET_LINK ($link) {
 528         // Is this a resource or null?
 529         if ((!is_resource($link)) && (!is_null($link))) {
 530                 // This should never happen!
 531                 debug_report_bug(sprintf("link is not resource or null. Type: %s", gettype($link)));
 532         } // END - if
 533
 534         // Set it
 535         $GLOBALS['sql_link'] = $link;
 536 }
 537
 538 // Checks if the link is up
 539 function SQL_IS_LINK_UP () {
 540         // Default is not up
 541         $linkUp = false;
 542
 543         // Do we have cached this?
 544         if (isset($GLOBALS['sql_link_res'])) {
 545                 // Then use this
 546                 $linkUp = $GLOBALS['sql_link_res'];
 547         } else {
 548                 // Get it
 549                 $linkUp = is_resource(SQL_GET_LINK());
 550
 551                 // And cache it
 552                 $GLOBALS['sql_link_res'] = $linkUp;
 553         }
 554
 555         // Return the result
 556         return $linkUp;
 557 }
 558
 559 // [EOF]
 560 ?>