Fixes for db/cache counter
[mailer.git] / 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  *                                                                      *
14  * -------------------------------------------------------------------- *
15  * Copyright (c) 2003 - 2008 by Roland Haeder                           *
16  * For more information visit: http://www.mxchange.org                  *
17  *                                                                      *
18  * This program is free software; you can redistribute it and/or modify *
19  * it under the terms of the GNU General Public License as published by *
20  * the Free Software Foundation; either version 2 of the License, or    *
21  * (at your option) any later version.                                  *
22  *                                                                      *
23  * This program is distributed in the hope that it will be useful,      *
24  * but WITHOUT ANY WARRANTY; without even the implied warranty of       *
25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
26  * GNU General Public License for more details.                         *
27  *                                                                      *
28  * You should have received a copy of the GNU General Public License    *
29  * along with this program; if not, write to the Free Software          *
30  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               *
31  * MA  02110-1301  USA                                                  *
32  ************************************************************************/
33
34 // Some security stuff...
35 if (ereg(basename(__FILE__), $_SERVER['PHP_SELF'])) {
36         $INC = substr(dirname(__FILE__), 0, strpos(dirname(__FILE__), "/inc") + 4) . "/security.php";
37         require($INC);
38 }
39
40 // SQL queries
41 function SQL_QUERY($sql_string, $F, $L) {
42         global $link, $CSS, $_CONFIG, $OK;
43
44         // Remove \t, \n and \r from queries they may confuse some MySQL version I have heard
45         $sql_string = str_replace("\t", " ", str_replace("\n", " ", str_replace("\r", " ", $sql_string)));
46
47         // Starting time
48         $querytimeBefore = array_sum(explode(' ', microtime()));
49
50         // Run SQL command
51         //* DEBUG: */ echo $sql_string."<br />\n";
52         $result = @mysql_query($sql_string, $link)
53          or ADD_FATAL($F." (".$L."):".mysql_error()."<br />
54 ".MYSQL_QUERY_STRING."<br />
55 ".$sql_string);
56
57         // Save last successfull query
58         $_CONFIG['db_last_query'] = $sql_string;
59
60         // Ending time
61         $querytimeAfter = array_sum(explode(' ', microtime()));
62
63         // Calculate query time
64         $queryTime = $querytimeAfter - $querytimeBefore;
65
66         // Count this query
67         if (!isset($_CONFIG['sql_count'])) $_CONFIG['sql_count'] = 0;
68         $_CONFIG['sql_count']++;
69
70         // Debug output
71         //* DEBUG: */ print "Query=<pre>".$sql_string."</pre>, affected=<b>".SQL_AFFECTEDROWS()."</b>, numrows=<b>".SQL_NUMROWS($result)."</b><br />\n";
72
73         if (($CSS != "1") && ($CSS != "-1") && (isBooleanConstantAndTrue('DEBUG_MODE')) && (isBooleanConstantAndTrue('DEBUG_SQL'))) {
74                 //
75                 // Debugging stuff...
76                 //
77                 $fp = @fopen(PATH."inc/cache/mysql.log", 'a') or mxchange_die("Cannot write mysql.log!");
78                 if (!isset($OK)) {
79                         // Write first entry
80                         fwrite($fp, "Module=".$GLOBALS['module']."\n");
81                         $OK = true;
82                 } // END - if
83                 fwrite($fp, $F."(LINE=".$L."|NUM=".SQL_NUMROWS($result)."|AFFECTED=".SQL_AFFECTEDROWS()."|QUERYTIME:".$queryTime."): ".str_replace('\r', "", str_replace('\n', " ", $sql_string))."\n");
84                 fclose($fp);
85         } // END - if
86
87         // Count DB hits
88         if (!isset($_CONFIG['db_hits_run'])) {
89                 // Count in dummy variable
90                 $_CONFIG['db_hits_run'] = 1;
91         } else {
92                 // Count to config array
93                 $_CONFIG['db_hits_run']++;
94         }
95
96         // Return the result
97         return $result;
98 }
99
100 // SQL num rows
101 function SQL_NUMROWS($result) {
102         // Is the result a valid resource?
103         if (is_resource($result)) {
104                 // Get the count of rows from database
105                 $lines = @mysql_num_rows($result);
106
107                 // Is the result empty? Then we have an error!
108                 if (empty($lines)) $lines = "0";
109         } else {
110                 // No resource given, no lines found!
111                 $lines = "0";
112         }
113         return $lines;
114 }
115
116 // SQL affected rows
117 function SQL_AFFECTEDROWS($lnk="x", $F="dummy", $L="dummy") {
118         global $link;
119         // $lnk will be ignored for now!
120         $lines = @mysql_affected_rows($link);
121         return $lines;
122 }
123
124 // SQL fetch row
125 function SQL_FETCHROW($result) {
126         $DATA = array();
127         $DATA = @mysql_fetch_row($result);
128         return $DATA;
129 }
130
131 // SQL fetch array
132 function SQL_FETCHARRAY($res=false, $nr=0, $remove_numerical=true) {
133         // Is a result resource set?
134         if (!$res) return false;
135
136         // Initialize array
137         $row = array();
138
139         // Load row from database
140         $row = @mysql_fetch_array($res);
141
142         // Return only arrays here
143         if (is_array($row)) {
144                 // Shall we remove numerical data here automatically?
145                 if ($remove_numerical) {
146                                  // So let's remove all numerical elements to save memory!
147                         $max = count($row);
148                         for ($idx = 0; $idx < ($max / 2); $idx++) {
149                                 // Remove entry
150                                 unset($row[$idx]);
151                         }
152                 }
153
154                 // Return row
155                 return $row;
156         } else {
157                 // Return a false here...
158                 return false;
159         }
160 }
161
162 // SQL result
163 function SQL_RESULT($res, $row, $field) {
164         $result = @mysql_result($res, $row, $field);
165         return $result;
166 }
167 // SQL connect
168 function SQL_CONNECT($host, $login, $password, $F, $L) {
169         $connect = @mysql_connect($host, $login, $password) or ADD_FATAL($F." (".$L."):".mysql_error());
170         return $connect;
171 }
172 // SQL select database
173 function SQL_SELECT_DB($dbName, $link, $F, $L) {
174         $select = false;
175         if (is_resource($link)) {
176                 $select = @mysql_select_db($dbName, $link) or ADD_FATAL($F." (".$L."):".mysql_error());
177         }
178         return $select;
179 }
180 // SQL close link
181 function SQL_CLOSE(&$link, $F, $L) {
182         global $_CONFIG, $cacheInstance, $cacheArray;
183
184         // Is there still a valid link?
185         if (!is_resource($link)) {
186                 // Skip double close
187                 return false;
188         } // END - if
189
190         // Add new hits
191         $_CONFIG['db_hits'] += $_CONFIG['db_hits_run'];
192         //* DEBUG: */ echo "DB=".$_CONFIG['db_hits'].",CACHE=".$_CONFIG['cache_hits']."<br />\n";
193         if ((GET_EXT_VERSION("cache") >= "0.0.7") && (isset($_CONFIG['db_hits'])) && (isset($_CONFIG['cache_hits'])) && (is_object($cacheInstance))) {
194                 // Update counter for db/cache
195                 UPDATE_CONFIG(array("db_hits", "cache_hits"), array(bigintval($_CONFIG['db_hits']), bigintval($_CONFIG['cache_hits'])));
196         } // END - if
197
198         // Close database link and forget the link
199         $close = @mysql_close($link) or ADD_FATAL($F." (".$L."):".mysql_error());
200         $link = null;
201         return $close;
202 }
203 // SQL free result
204 function SQL_FREERESULT($result) {
205         $res = @mysql_free_result($result);
206         return $res;
207 }
208 // SQL string escaping
209 function SQL_QUERY_ESC($qstring, $data, $file, $line, $run=true, $strip=true) {
210         global $link;
211         $query = "";
212         $eval = "\$query = sprintf(\"".$qstring."\"";
213         foreach ($data as $var) {
214                 if ((!empty($var)) || ($var === 0)) {
215                         if ($strip) {
216                                 $eval .= ", SQL_ESCAPE(\"".strip_tags($var)."\")";
217                         } else {
218                                 $eval .= ", SQL_ESCAPE(\"".$var."\")";
219                         }
220                 } else {
221                         $eval .= ", ''";
222                 }
223         }
224         $eval .= ");";
225         //
226         // Debugging
227         //
228         //$fp = fopen(PATH."inc/cache/escape_debug.log", 'a') or mxchange_die("Cannot write debug.log!");
229         //fwrite($fp, $file."(".$line."): ".str_replace("\r", "", str_replace("\n", " ", $eval))."\n");
230         //fclose($fp);
231         @eval($eval);
232         if (empty($query)) {
233                 print "eval=".htmlentities($eval)."<pre>";
234                 debug_print_backtrace();
235                 die("</pre>");
236         }
237         if ($run) {
238                 // Run SQL query (default)
239                 return SQL_QUERY($query, $file, $line);
240         } else {
241                 // Return secured string
242                 return $query;
243         }
244 }
245 // Get ID from last INSERT command
246 function SQL_INSERTID() {
247         return @mysql_insert_id();
248 }
249 // Escape a string for the database
250 function SQL_ESCAPE($str, $secureString = true) {
251         global $link;
252
253         // Secure string first? (which is the default behaviour!)
254         if ($secureString) {
255                 // Then do it here
256                 $str = secureString($str);
257         } // END - if
258
259         if (!is_resource($link)) {
260                 // Fall-back to addslashes() when there is no link
261                 return addslashes($str);
262         } // END - if
263
264         if (function_exists('mysql_real_escape_string')) {
265                 // The new and improved version
266                 return mysql_real_escape_string($str, $link);
267         } elseif (function_exists('mysql_escape_string')) {
268                 // The obsulete function
269                 return mysql_escape_string($str, $link);
270         } else {
271                 // If nothing else works
272                 return addslashes($str);
273         }
274 }
275 // SELECT query string from table, columns and so on... ;-)
276 function SQL_RESULT_FROM_ARRAY ($table, $columns, $idRow, $id) {
277         // Prepare the SQL statement
278         $SQL = "SELECT ".implode(", ", $columns)." FROM "._MYSQL_PREFIX."_".$table." WHERE ".$idRow."=%s LIMIT 1";
279
280         // Return the result
281         return SQL_QUERY_ESC($SQL, array(bigintval($id)), __FILE__, __LINE__);
282 }
283 // ALTER TABLE wrapper function
284 function SQL_ALTER_TABLE($sql, $F, $L) {
285         // Shall we add?
286         if (eregi("ADD", $sql) > 0) {
287                 // Extract table name
288                 $tableArray = explode(" ", $sql);
289                 $tableName = str_replace("`", "", $tableArray[2]);
290
291                 // And column name as well
292                 $columnName = str_replace("`", "", $tableArray[4]);
293
294                 // Get column information
295                 $result = SQL_QUERY_ESC("SHOW COLUMNS FROM %s LIKE '%s'",
296                         array($tableName, $columnName), __FILE__, __LINE__);
297
298                 // Do we have no entry?
299                 if (SQL_NUMROWS($result) == 0) {
300                         // Do the query
301                         return SQL_QUERY($sql, $F, $L, false);
302                 } // END - if
303         } else {
304                 // Send it to the SQL_QUERY() function
305                 return SQL_QUERY($sql, $F, $L, false);
306         }
307 }
308 //
309 ?>