]> git.mxchange.org Git - mailer.git/blobdiff - inc/db/lib-mysql3.php
Fixes for #226, renamed function:
[mailer.git] / inc / db / lib-mysql3.php
index 2d25cdea884311a5e9502aeec0868c1380437160..17caef397c5f9ee472bf9242c8ddf84df30fb0da 100644 (file)
@@ -16,8 +16,8 @@
  * $Author::                                                          $ *
  * -------------------------------------------------------------------- *
  * Copyright (c) 2003 - 2009 by Roland Haeder                           *
- * Copyright (c) 2009 - 2011 by Mailer Developer Team                   *
- * For more information visit: http://www.mxchange.org                  *
+ * Copyright (c) 2009 - 2012 by Mailer Developer Team                   *
+ * For more information visit: http://mxchange.org                      *
  *                                                                      *
  * This program is free software; you can redistribute it and/or modify *
  * it under the terms of the GNU General Public License as published by *
@@ -52,13 +52,13 @@ function SQL_QUERY ($sqlString, $F, $L, $enableCodes = true) {
                // Empty query string or link is not up?
                if (empty($sqlStringModified)) {
                        // Empty SQL string!
-                       debug_report_bug(__FUNCTION__, __LINE__, sprintf("SQL string is empty. Please fix this. file=%s, line=%s",
+                       reportBug(__FUNCTION__, __LINE__, sprintf("SQL string is empty, please fix this: file=%s, line=%s",
                                basename($F),
                                $L
                        ));
                } elseif (!SQL_IS_LINK_UP()) {
                        // We should not quietly ignore this
-                       debug_report_bug(__FUNCTION__, __LINE__, sprintf("Cannot query database: sqlString=%s,file=%s,line=%s",
+                       reportBug(__FUNCTION__, __LINE__, sprintf("Cannot query database: sqlString=%s,file=%s,line=%s",
                                $sqlStringModified,
                                basename($F),
                                $L
@@ -66,7 +66,7 @@ function SQL_QUERY ($sqlString, $F, $L, $enableCodes = true) {
                }
 
                // Remove \t, \n and \r from queries they may confuse some MySQL versions
-               $sqlStringModified = str_replace("\t", ' ', str_replace("\n", ' ', str_replace("\r", ' ', $sqlStringModified)));
+               $sqlStringModified = str_replace(array(chr(9), chr(10), chr(13)), array(' ', ' ', ' '), $sqlStringModified);
 
                // Compile config entries out
                $sqlStringModified = SQL_PREPARE_SQL_STRING($sqlStringModified, $enableCodes);
@@ -90,8 +90,7 @@ function SQL_QUERY ($sqlString, $F, $L, $enableCodes = true) {
        // Run SQL command
        //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'F=' . basename($F) . ',L=' . $L . ',sql=' . $GLOBALS['last_sql']);
        $result = mysql_query($GLOBALS['last_sql'], SQL_GET_LINK())
-               or debug_report_bug($F, $L, 'file='. basename($F) . ',line=' . $L . ':mysql_error()=' . mysql_error() . "\n".
-'Query string:' . $GLOBALS['last_sql']);
+               or SQL_ERROR($F, $L, 'file='. basename($F) . ',line=' . $L . ':mysql_error()=' . mysql_error() . ',last_query=' . $GLOBALS['last_sql']);
        //* DEBUG: */ logDebugMessage($F, $L, 'sql=' . $GLOBALS['last_sql'] . ',affected=' . SQL_AFFECTEDROWS() . ',numRows='.(is_resource($result) ? SQL_NUMROWS($result) : gettype($result)));
 
        // Calculate query time
@@ -110,7 +109,7 @@ function SQL_QUERY ($sqlString, $F, $L, $enableCodes = true) {
        incrementConfigEntry('sql_count');
 
        // Debug output
-       if ((!isCssOutputMode()) && (isDebugModeEnabled()) && (isSqlDebuggingEnabled())) {
+       if (SQL_DEBUG_ENABLED()) {
                // Is this the first call?
                if (!isset($GLOBALS['sql_first_entry'])) {
                        // Write first entry
@@ -119,17 +118,11 @@ function SQL_QUERY ($sqlString, $F, $L, $enableCodes = true) {
                } // END - if
 
                // Append debug line
-               appendLineToFile(getCachePath() . 'mysql.log', basename($F) . '|LINE=' . $L . '|NUM=' . (is_resource($result) ? SQL_NUMROWS($result) : 'false') . '|AFFECTED=' . SQL_AFFECTEDROWS() . '|QUERYTIME:' . $queryTime . '): ' . str_replace("\r", '', str_replace("\n", ' ', $GLOBALS['last_sql'])));
+               appendLineToFile(getCachePath() . 'mysql.log', basename($F) . '|LINE=' . $L . '|NUM=' . (is_resource($result) ? SQL_NUMROWS($result) : 'false') . '|AFFECTED=' . SQL_AFFECTEDROWS() . '|QUERYTIME:' . $queryTime . '): ' . str_replace(array(chr(13), chr(10)), array('', ' '), $GLOBALS['last_sql']));
        } // END - if
 
-       // Count DB hits
-       if (!isStatsEntrySet('db_hits')) {
-               // Count in dummy variable
-               setStatsEntry('db_hits', 1);
-       } else {
-               // Count to config array
-               incrementStatsEntry('db_hits');
-       }
+       // Increment stats entry
+       incrementStatsEntry('db_hits');
 
        // Return the result
        return $result;
@@ -144,7 +137,7 @@ function SQL_NUMROWS ($resource) {
        $lines = false;
 
        // Is the result a valid resource?
-       if (isset($GLOBALS['sql_numrows'][$resource])) {
+       if (isset($GLOBALS['sql_numrows'][intval($resource)])) {
                // Use cache
                $lines = $GLOBALS['sql_numrows'][intval($resource)];
        } elseif (is_resource($resource)) {
@@ -155,7 +148,7 @@ function SQL_NUMROWS ($resource) {
                $GLOBALS['sql_numrows'][intval($resource)] = $lines;
        } else {
                // No resource given, please fix this
-               debug_report_bug(__FUNCTION__, __LINE__, 'No resource given! result[]=' . gettype($resource) . ',last_sql=' .  $GLOBALS['last_sql']);
+               reportBug(__FUNCTION__, __LINE__, 'No resource given! result[]=' . gettype($resource) . ',last_sql=' .  $GLOBALS['last_sql']);
        }
 
        // Return lines
@@ -216,10 +209,21 @@ function SQL_RESULT ($resource, $row, $field = '0') {
 // SQL connect
 function SQL_CONNECT ($host, $login, $password, $F, $L) {
        // Try to connect
-       $linkResource = mysql_connect($host, $login, $password) or debug_report_bug(__FUNCTION__, __LINE__, $F . ' (' . $L . '):' . mysql_error());
+       $linkResource = mysql_connect($host, $login, $password) or SQL_ERROR($F, $L,  mysql_error());
 
        // Set the link resource
-       SQL_SET_LINK($linkResource);
+       if (is_resource($linkResource)) {
+               /*
+                * A non-resource (boolean) may happen on installation phase which
+                * shall not be set here. Only valid link resources shall be set so
+                * SQL_IS_LINK_UP() will only return 'true' if there is really a
+                * working database link.
+                */
+               SQL_SET_LINK($linkResource);
+       } // END - if
+
+       // Return the resource
+       return $linkResource;
 }
 
 // SQL select database
@@ -228,7 +232,7 @@ function SQL_SELECT_DB ($dbName, $F, $L) {
        if (!SQL_IS_LINK_UP()) return false;
 
        // Return the result
-       return mysql_select_db($dbName, SQL_GET_LINK()) or debug_report_bug(__FUNCTION__, __LINE__, $F . ' (' . $L . '):' . mysql_error());
+       return mysql_select_db($dbName, SQL_GET_LINK()) or SQL_ERROR($F, $L,  mysql_error());
 }
 
 // SQL close link
@@ -239,10 +243,10 @@ function SQL_CLOSE ($F, $L) {
        } // END - if
 
        // Close database link and forget the link
-       $close = mysql_close(SQL_GET_LINK()) or debug_report_bug(__FUNCTION__, __LINE__, $F . ' (' . $L . '):'.mysql_error());
+       $close = mysql_close(SQL_GET_LINK()) or SQL_ERROR($F, $L, mysql_error());
 
        // Close link
-       SQL_SET_LINK(null);
+       SQL_SET_LINK(NULL);
 
        // Return the result
        return $close;
@@ -295,6 +299,9 @@ function SQL_INSERTID () {
 function SQL_ESCAPE ($str, $secureString = true, $strip = true) {
        // Do we have cache?
        if (!isset($GLOBALS['sql_escapes'][''.$str.''])) {
+               // Prepare the string here
+               $str = SQL_PREPARE_SQL_STRING($str);
+
                // Secure string first? (which is the default behaviour!)
                if ($secureString === true) {
                        // Then do it here
@@ -328,7 +335,7 @@ function SQL_RESULT_FROM_ARRAY ($table, $columns, $idRow, $id, $F, $L) {
        // Is columns an array?
        if (!is_array($columns)) {
                // No array
-               debug_report_bug(__FUNCTION__, __LINE__, sprintf("columns is not an array. %s != array, file=%s, line=%s",
+               reportBug(__FUNCTION__, __LINE__, sprintf("columns is not an array. %s != array, file=%s, line=%s",
                        gettype($columns),
                        basename($F),
                        $L
@@ -338,8 +345,20 @@ function SQL_RESULT_FROM_ARRAY ($table, $columns, $idRow, $id, $F, $L) {
                return false;
        } // END  - if
 
-       // Prepare the SQL statement
-       $sql = "SELECT `".implode("`, `", $columns)."` FROM `{?_MYSQL_PREFIX?}_%s` WHERE `%s`='%s' LIMIT 1";
+       // Is this is a simple array?
+       if ((is_array($columns[0])) && (isset($columns[0]['column']))) {
+               // Begin with SQL query
+               $sql = 'SELECT ';
+
+               // No, it comes from XML, so get it back from it
+               $sql .= getSqlPartFromXmlArray($columns);
+
+               // Finalize it
+               $sql .= " FROM `{?_MYSQL_PREFIX?}_%s` WHERE `%s`='%s' LIMIT 1";
+       } else {
+               // Yes, prepare the SQL statement
+               $sql = 'SELECT `' . implode('`,`', $columns) . "` FROM `{?_MYSQL_PREFIX?}_%s` WHERE `%s`='%s' LIMIT 1";
+       }
 
        // Return the result
        return SQL_QUERY_ESC($sql,
@@ -360,16 +379,16 @@ function SQL_ALTER_TABLE ($sql, $F, $L, $enableCodes = true) {
        $result = false;
 
        // Determine index/fulltext/unique word
-       $noIndex = (
-       (
-               strpos($sql, 'INDEX') === false
-       ) && (
-               strpos($sql, 'KEY') === false
-       ) && (
-               strpos($sql, 'FULLTEXT') === false
-       ) && (
-               strpos($sql, 'UNIQUE') === false
-       )
+       $isAlterIndex = (
+               (
+                       isInString('INDEX', $sql)
+               ) || (
+                       isInString('KEY', $sql)
+               ) || (
+                       isInString('FULLTEXT', $sql)
+               ) || (
+                       isInString('UNIQUE', $sql)
+               )
        );
 
        // Extract table name
@@ -377,10 +396,10 @@ function SQL_ALTER_TABLE ($sql, $F, $L, $enableCodes = true) {
        $tableName = str_replace('`', '', $tableArray[2]);
 
        // Debug log
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'sql=' . $sql . ',tableName=' . $tableName . ',tableArray=<pre>' . print_r($tableArray, true) . '</pre>');
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'sql=' . $sql . ',tableName=' . $tableName . ',tableArray=<pre>' . print_r($tableArray, true) . '</pre>,isAlterIndex=' . intval($isAlterIndex));
 
        // Shall we add/drop?
-       if (((strpos($sql, 'ADD') !== false) || (strpos($sql, 'DROP') !== false) || (strpos($sql, 'CHANGE') !== false)) && ($noIndex === true)) {
+       if (((isInString('ADD', $sql)) || (isInString('DROP', $sql)) || (isInString('CHANGE', $sql))) && ($isAlterIndex === false)) {
                // Try two columns, one should fix
                foreach (array(4,5) as $idx) {
                        // If an entry is not set, abort here
@@ -397,20 +416,18 @@ function SQL_ALTER_TABLE ($sql, $F, $L, $enableCodes = true) {
                        //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'columnName=' . $columnName . ',idx=' . $idx . ',sql=' . $sql . ',hasZeroNums=' . intval(isSqlTableColumnFound($tableName, $columnName)));
 
                        // Do we have no entry on ADD or an entry on DROP/CHANGE?
-                       // 123                      4                       43    3      4           4          32    23                     4                       43    34      5            5          4    45      6              6          5    5         5    56                      7                          76    6                             654321
-                       if (((!isSqlTableColumnFound($tableName, $columnName)) && (strpos($sql, 'ADD') !== false)) || ((isSqlTableColumnFound($tableName, $columnName)) && ((strpos($sql, 'DROP') !== false) || ((strpos($sql, 'CHANGE') !== false) && ($idx == 4) && ((!isSqlTableColumnFound($tableName, $tableArray[5])) || ($columnName == $tableArray[5])))))) {
+                       if (((!isSqlTableColumnFound($tableName, $columnName)) && (isInString('ADD', $sql))) || ((isSqlTableColumnFound($tableName, $columnName)) && ((isInString('DROP', $sql)) || ((isInString('CHANGE', $sql)) && ($idx == 4) && ((!isSqlTableColumnFound($tableName, $tableArray[5])) || ($columnName == $tableArray[5])))))) {
                                // Do the query
                                //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Executing: ' . $sql);
                                $result = SQL_QUERY($sql, $F, $L, false);
 
                                // Skip further attempt(s)
                                break;
-                       //       1234                     5                       54    4      5           5          43    34                      5                       54    45      6            6          54    4      5              5          432    2                    21
-                       } elseif ((((isSqlTableColumnFound($tableName, $columnName)) && (strpos($sql, 'ADD') !== false)) || ((!isSqlTableColumnFound($tableName, $columnName)) && ((strpos($sql, 'DROP') !== false)) || (strpos($sql, 'CHANGE') !== false))) && ($columnName != 'KEY')) {
+                       } elseif ((((isSqlTableColumnFound($tableName, $columnName)) && (isInString('ADD', $sql))) || ((!isSqlTableColumnFound($tableName, $columnName)) && ((isInString('DROP', $sql))) || (isInString('CHANGE', $sql)))) && ($columnName != 'KEY')) {
                                // Abort here because it is alreay there
                                //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'Skipped: sql=' . $sql . ',columnName=' . $columnName . ',idx=' . $idx);
                                break;
-                       } elseif ((!isSqlTableColumnFound($tableName, $columnName)) && (strpos($sql, 'DROP') !== false)) {
+                       } elseif ((!isSqlTableColumnFound($tableName, $columnName)) && (isInString('DROP', $sql))) {
                                // Abort here because we tried to drop a column which is not there (never created maybe)
                                //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'No drop: ' . $sql);
                                break;
@@ -419,10 +436,10 @@ function SQL_ALTER_TABLE ($sql, $F, $L, $enableCodes = true) {
                                logDebugMessage(__FUNCTION__, __LINE__, 'Possible problem: ' . $sql . ',hasZeroNums=' . intval(isSqlTableColumnFound($tableName, $columnName)) . '');
                        }
                } // END - foreach
-       } elseif ((getTableType() == 'InnoDB') && (strpos($sql, 'FULLTEXT') !== false)) {
+       } elseif ((getTableType() == 'InnoDB') && (isInString('FULLTEXT', $sql))) {
                // Skip this query silently because InnoDB does not understand fulltext indexes
                //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, sprintf("Skipped FULLTEXT: sql=%s,tableName=%s,hasZeroNums=%d,file=%s,line=%s", $sql, $tableName, intval((is_bool($result)) ? 0 : isSqlTableColumnFound($columnName)), $F, $L));
-       } elseif ($noIndex === false) {
+       } elseif ($isAlterIndex === true) {
                // And column name as well without backticks
                $keyName = str_replace('`', '', $tableArray[5]);
                //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'keyName=' . $keyName . ',tableArray=<pre>' . print_r($tableArray, true) . '</pre>');
@@ -432,14 +449,14 @@ function SQL_ALTER_TABLE ($sql, $F, $L, $enableCodes = true) {
                        // Init loop
                        $begin = 1;
                        $keyName = ',';
-                       while (strpos($keyName, ',') !== false) {
+                       while (isInString(',', $keyName)) {
                                // Use last
                                //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'keyName=' . $keyName . 'begin=' . $begin . ' - BEFORE');
                                $keyName = str_replace('`', '', $tableArray[count($tableArray) - $begin]);
                                //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'keyName=' . $keyName . 'begin=' . $begin . ' - BETWEEN');
 
                                // Remove brackes
-                               $keyName = str_replace('(', '', str_replace(')', '', $keyName));
+                               $keyName = str_replace(array('(', ')'), array('', ''), $keyName);
                                //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'keyName=' . $keyName . 'begin=' . $begin . ' - AFTER');
 
                                // Continue
@@ -474,7 +491,7 @@ function SQL_ALTER_TABLE ($sql, $F, $L, $enableCodes = true) {
 // Getter for SQL link
 function SQL_GET_LINK () {
        // Init link
-       $link = null;
+       $link = NULL;
 
        // Is it in the globals?
        if (isset($GLOBALS['sql_link'])) {
@@ -494,7 +511,7 @@ function SQL_SET_LINK ($link) {
                return;
        } elseif ((!is_resource($link)) && (!is_null($link))) {
                // This should never happen!
-               debug_report_bug(__FUNCTION__, __LINE__, sprintf("Type of link is not resource or null, type=%s", gettype($link)));
+               reportBug(__FUNCTION__, __LINE__, sprintf("Type of link is not resource or null, type=%s", gettype($link)));
        } // END - if
 
        // Set it
@@ -506,23 +523,14 @@ function SQL_SET_LINK ($link) {
 
 // Checks if the link is up
 function SQL_IS_LINK_UP () {
-       // Default is not up
-       $linkUp = false;
-
        // Do we have cached this?
-       if (isset($GLOBALS['is_sql_link_up'])) {
-               // Then use this
-               $linkUp = $GLOBALS['is_sql_link_up'];
-       } else {
-               // Get it
-               $linkUp = is_resource(SQL_GET_LINK());
-
-               // And cache it
-               $GLOBALS['is_sql_link_up'] = $linkUp;
-       }
+       if (!isset($GLOBALS['is_sql_link_up'])) {
+               // Determine it
+               $GLOBALS['is_sql_link_up'] = is_resource(SQL_GET_LINK());
+       } // END - if
 
        // Return the result
-       return $linkUp;
+       return $GLOBALS['is_sql_link_up'];
 }
 
 // Wrapper function to make code more readable
@@ -541,12 +549,11 @@ function SQL_HASZEROAFFECTED () {
 function SQL_PREPARE_SQL_STRING ($sqlString, $enableCodes = true) {
        // Is it already cached?
        if (!isset($GLOBALS['sql_strings'][$sqlString])) {
-               // Compile config+expression code
-               $sqlString2 = FILTER_COMPILE_EXPRESSION_CODE(FILTER_COMPILE_CONFIG($sqlString));
+               // Compile URI codes+config+expression code
+               $sqlString2 = FILTER_COMPILE_EXPRESSION_CODE(FILTER_COMPILE_CONFIG(compileUriCode($sqlString)));
 
                // Do final compilation
                $GLOBALS['sql_strings'][$sqlString] = doFinalCompilation($sqlString2, false, $enableCodes);
-               //die($sqlString.'<br />'.$sqlString2.'<br />'.$GLOBALS['sql_strings'][$sqlString]);
        } // END - if
 
        // Return it
@@ -558,8 +565,26 @@ function SQL_EPOCHE_TO_TIMESTAMP ($timestamp) {
        return generateDateTime($timestamp, 7);
 }
 
+// Log SQL errors to debug.log in installation phase or call reportBug()
+function SQL_ERROR ($file, $line, $message) {
+       // Remember plain error in last_sql_error
+       $GLOBALS['last_sql_error'] = mysql_error();
+
+       // Do we have installation phase?
+       if (isInstallationPhase()) {
+               /*
+                * In installation phase, we don't want SQL errors abort e.g. connection
+                * tests, so just log it away.
+                */
+               logDebugMessage($file, $line, $message);
+       } else {
+               // Regular mode, then call reportBug()
+               reportBug($file, $line, $message);
+       }
+}
+
 // Check if there is a SQL table created
-function isSqlTableCreated ($tableName) {
+function ifSqlTableExists ($tableName) {
        //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'tableName=' . $tableName . ' - ENTERED!');
        // Do we have cache?
        if (!isset($GLOBALS[__FUNCTION__][$tableName])) {
@@ -579,7 +604,7 @@ function isSqlTableCreated ($tableName) {
 
 // Is a table column there?
 function isSqlTableColumnFound ($tableName, $columnName) {
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'tableName=' . $tableName . ',columnName=' . $columName . ' - ENTERED!');
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'tableName=' . $tableName . ',columnName=' . $columnName . ' - ENTERED!');
        // Do we have cache?
        if (!isset($GLOBALS[__FUNCTION__][$tableName][$columnName])) {
                // And column name as well
@@ -598,7 +623,7 @@ function isSqlTableColumnFound ($tableName, $columnName) {
        } // END - if
 
        // Return cache
-       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'tableName=' . $tableName . ',columnName=' . $columName . ',result=' . intval($GLOBALS[__FUNCTION__][$tableName][$columnName]) . ' - EXIT!');
+       //* DEBUG: */ logDebugMessage(__FUNCTION__, __LINE__, 'tableName=' . $tableName . ',columnName=' . $columnName . ',result=' . intval($GLOBALS[__FUNCTION__][$tableName][$columnName]) . ' - EXIT!');
        return $GLOBALS[__FUNCTION__][$tableName][$columnName];
 }
 
@@ -631,5 +656,49 @@ function isSqlTableIndexFound ($tableName, $keyName) {
        return $GLOBALS[__FUNCTION__][$tableName][$keyName];
 }
 
+// Init database layer
+function initDatabaseLayer () {
+       // Set all required variables:
+       $GLOBALS['last_sql_error'] = '';
+}
+
+// Get last SQL error
+function getLastSqlError () {
+       return $GLOBALS['last_sql_error'];
+}
+
+// Gets an array (or false if none is found) from all supported engines
+function getArrayFromSupportedSqlEngines ($support = 'YES') {
+       // Init array
+       $engines = array();
+
+       // This also worked, now we need to check if the selected database type is supported
+       $result = SQL_QUERY('SHOW ENGINES', __FUNCTION__, __LINE__);
+
+       // Do we have entries? (Bad if not)
+       if (SQL_NUMROWS($result) > 0) {
+               // Load all and check for active entries
+               while ($content = SQL_FETCHARRAY($result)) {
+                       // Is this supported?
+                       if (($support == 'ALL') || ($content['Support'] == $support)) {
+                               // Add it
+                               array_push($engines, $content);
+                       } elseif (isDebugModeEnabled()) {
+                               // Log it away in debug mode
+                               logDebugMessage(__FUNCTION__, __LINE__, 'Engine ' . $content['Engine'] . ' is not supported (' . $content['Supported'] . ')');
+                       }
+               } // END - if
+       } else {
+               // No engines! :(
+               $engines = false;
+       }
+
+       // Free result
+       SQL_FREERESULT($result);
+
+       // Return result
+       return $engines;
+}
+
 // [EOF]
 ?>