61d9be17fa1305e720669059823f380a1851389e
[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 (!defined('__SECURITY')) {
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, $OK;
43
44         // Link is up?
45         if (!is_resource($link)) return false;
46
47         // Remove \t, \n and \r from queries they may confuse some MySQL version I have heard
48         $sql_string = str_replace("\t", " ", str_replace("\n", " ", str_replace("\r", " ", $sql_string)));
49
50         // Starting time
51         $querytimeBefore = array_sum(explode(' ', microtime()));
52
53         // Replace {!_MYSQL_PREFIX!} with constant, closes #84. Thanks to profi-concept
54         $sql_string = str_replace("{!_MYSQL_PREFIX!}", constant('_MYSQL_PREFIX'), $sql_string);
55
56         // Run SQL command
57         //* DEBUG: */ echo $sql_string."<br />\n";
58         $result = mysql_query($sql_string, $link)
59          or addFatalMessage($F." (".$L."):".mysql_error()."<br />
60 Query string:<br />
61 ".$sql_string);
62
63         // Ending time
64         $querytimeAfter = array_sum(explode(' ', microtime()));
65
66         // Calculate query time
67         $queryTime = $querytimeAfter - $querytimeBefore;
68
69         // Save last successfull query
70         setConfigEntry('db_last_query', $sql_string);
71
72         // Count this query
73         incrementConfigEntry('sql_count');
74
75         // Debug output
76         //* DEBUG: */ print "Query=<pre>".$sql_string."</pre>, affected=<strong>".SQL_AFFECTEDROWS()."</strong>, numrows=<strong>".SQL_NUMROWS($result)."</strong><br />\n";
77
78         if (($CSS != "1") && ($CSS != "-1") && (isBooleanConstantAndTrue('DEBUG_MODE')) && (isBooleanConstantAndTrue('DEBUG_SQL'))) {
79                 //
80                 // Debugging stuff...
81                 //
82                 $fp = @fopen(PATH."inc/cache/mysql.log", 'a') or mxchange_die("Cannot write mysql.log!");
83                 if (!isset($OK)) {
84                         // Write first entry
85                         fwrite($fp, "Module=".$GLOBALS['module']."\n");
86                         $OK = true;
87                 } // END - if
88                 fwrite($fp, $F."(LINE=".$L."|NUM=".SQL_NUMROWS($result)."|AFFECTED=".SQL_AFFECTEDROWS()."|QUERYTIME:".$queryTime."): ".str_replace('\r', "", str_replace('\n', " ", $sql_string))."\n");
89                 fclose($fp);
90         } // END - if
91
92         // Count DB hits
93         if (!isConfigEntrySet('db_hits_run')) {
94                 // Count in dummy variable
95                 setConfigEntry('db_hits_run', 1);
96         } else {
97                 // Count to config array
98                 incrementConfigEntry('db_hits_run');
99         }
100
101         // Return the result
102         return $result;
103 }
104
105 // SQL num rows
106 function SQL_NUMROWS ($result) {
107         // Is the result a valid resource?
108         if (is_resource($result)) {
109                 // Get the count of rows from database
110                 $lines = mysql_num_rows($result);
111
112                 // Is the result empty? Then we have an error!
113                 if (empty($lines)) $lines = 0;
114         } else {
115                 // No resource given, no lines found!
116                 $lines = 0;
117         }
118         return $lines;
119 }
120
121 // SQL affected rows
122 function SQL_AFFECTEDROWS() {
123         global $link;
124
125         // Valid link resource?
126         if (!is_resource($link)) return false;
127
128         // Get affected rows
129         $lines = mysql_affected_rows($link);
130
131         // Return it
132         return $lines;
133 }
134
135 // SQL fetch row
136 function SQL_FETCHROW($result) {
137         // Init data
138         $DATA = array();
139
140         // Is a result resource set?
141         if (!is_resource($result)) return false;
142
143         $DATA = mysql_fetch_row($result);
144         return $DATA;
145 }
146
147 // SQL fetch array
148 function SQL_FETCHARRAY($res, $nr=0, $remove_numerical=true) {
149         // Is a result resource set?
150         if (!is_resource($res)) return false;
151
152         // Initialize array
153         $row = array();
154
155         // Load row from database
156         $row = mysql_fetch_array($res);
157
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!
163                         $max = count($row);
164                         for ($idx = 0; $idx < ($max / 2); $idx++) {
165                                 // Remove entry
166                                 unset($row[$idx]);
167                         }
168                 }
169
170                 // Return row
171                 return $row;
172         } else {
173                 // Return a false here...
174                 return false;
175         }
176 }
177
178 // SQL result
179 function SQL_RESULT ($res, $row, $field) {
180         $result = mysql_result($res, $row, $field);
181         return $result;
182 }
183 // SQL connect
184 function SQL_CONNECT ($host, $login, $password, $F, $L) {
185         $connect = mysql_connect($host, $login, $password) or addFatalMessage($F." (".$L."):".mysql_error());
186         return $connect;
187 }
188 // SQL select database
189 function SQL_SELECT_DB ($dbName, $link, $F, $L) {
190         // Is there still a valid link? If not, skip it.
191         if (!is_resource($link)) return false;
192
193         return mysql_select_db($dbName, $link) or addFatalMessage($F." (".$L."):".mysql_error());
194 }
195 // SQL close link
196 function SQL_CLOSE (&$link, $F, $L) {
197         global $cacheInstance, $cacheArray;
198
199         if (!is_resource($link)) {
200                 // Skip double close
201                 return false;
202         } // END - if
203
204         // Do we need to update cache/db counter?
205         //* DEBUG: */ echo "DB=".getConfig('db_hits').",CACHE=".getConfig('cache_hits')."<br />\n";
206         if ((GET_EXT_VERSION("cache") >= "0.0.7") && (getConfig('db_hits') > 0) && (getConfig('cache_hits') > 0) && (is_object($cacheInstance))) {
207                 // Add new hits
208                 incrementConfigEntry('db_hits', getConfig('db_hits_run'));
209
210                 // Update counter for db/cache
211                 UPDATE_CONFIG(array("db_hits", "cache_hits"), array(bigintval(getConfig('db_hits')), bigintval(getConfig('cache_hits'))));
212         } // END - if
213
214         // Close database link and forget the link
215         $close = mysql_close($link) or addFatalMessage($F." (".$L."):".mysql_error());
216         $link = null;
217         return $close;
218 }
219
220 // SQL free result
221 function SQL_FREERESULT ($result) {
222         if (!is_resource($result)) {
223                 // Abort here
224                 return false;
225         } // END - if
226
227         $res = mysql_free_result($result);
228         return $res;
229 }
230
231 // SQL string escaping
232 function SQL_QUERY_ESC ($qstring, $data, $file, $line, $run=true, $strip=true) {
233         global $link;
234
235         // Link is there?
236         if (!is_resource($link)) return false;
237
238         // Init variable
239         $query = "failed";
240
241         if ($strip) {
242                 $strip = "true";
243         } else {
244                 $strip = "false";
245         }
246
247         $eval = "\$query = sprintf(\"".$qstring."\"";
248         foreach ($data as $var) {
249                 if ((!empty($var)) || ($var === 0)) {
250                         $eval .= ", SQL_ESCAPE(\"".$var."\",true,".$strip.")";
251                 } else {
252                         $eval .= ", ''";
253                 }
254         }
255         $eval .= ");";
256         //
257         // Debugging
258         //
259         //* DEBUG: */ $fp = fopen(PATH."inc/cache/escape_debug.log", 'a') or mxchange_die("Cannot write debug.log!");
260         //* DEBUG: */ fwrite($fp, $file."(".$line."): ".str_replace("\r", "", str_replace("\n", " ", $eval))."\n");
261         //* DEBUG: */ fclose($fp);
262
263         // Run the code
264         eval($eval);
265
266         // Was the eval() command fine?
267         if ($query == "failed") {
268                 // Something went wrong?
269                 printf("eval=%s\n<pre>%s</pre>",
270                         htmlentities($eval),
271                         debug_get_printable_backtrace()
272                 );
273
274                 // Abort further code executions
275                 exit;
276         } // END - if
277
278         if ($run) {
279                 // Run SQL query (default)
280                 return SQL_QUERY($query, $file, $line);
281         } else {
282                 // Return secured string
283                 return $query;
284         }
285 }
286
287 // Get ID from last INSERT command
288 function SQL_INSERTID () {
289         global $link;
290         if (!is_resource($link)) return false;
291         return mysql_insert_id();
292 }
293
294 // Escape a string for the database
295 function SQL_ESCAPE ($str, $secureString=true,$strip=true) {
296         global $link;
297
298         // Secure string first? (which is the default behaviour!)
299         if ($secureString) {
300                 // Then do it here
301                 $str = secureString($str, $strip);
302         } // END - if
303
304         if (!is_resource($link)) {
305                 // Fall-back to addslashes() when there is no link
306                 return addslashes($str);
307         } // END - if
308
309         if (function_exists('mysql_real_escape_string')) {
310                 // The new and improved version
311                 //* DEBUG: */ print __FUNCTION__."(<font color=\"#0000aa\">".__LINE__."</font>):str={$str}<br />\n";
312                 return mysql_real_escape_string($str, $link);
313         } elseif (function_exists('mysql_escape_string')) {
314                 // The obsolete function
315                 return mysql_escape_string($str, $link);
316         } else {
317                 // If nothing else works
318                 return addslashes($str);
319         }
320 }
321
322 // SELECT query string from table, columns and so on... ;-)
323 function SQL_RESULT_FROM_ARRAY ($table, $columns, $idRow, $id, $F, $L) {
324         // Is columns an array?
325         if (!is_array($columns) {
326                 // No array
327                 trigger_error(sprintf("columns is not array. %s!=array", gettype($columns)));
328         }
329
330         // Prepare the SQL statement
331         $SQL = "SELECT `".implode("`, `", $columns)."` FROM `{!_MYSQL_PREFIX!}_%s` WHERE ``='%s' LIMIT 1";
332
333         // Return the result
334         return SQL_QUERY_ESC($SQL,
335                 array(
336                         bigintval($id),
337                         $table,
338                         $idRow
339                 ), $F, $L);
340 }
341
342 // ALTER TABLE wrapper function
343 function SQL_ALTER_TABLE ($sql, $F, $L) {
344         // This is the default result...
345         $result = false;
346
347         // Determine index/fulltext/unique word
348         $noIndex = ((eregi("INDEX", $sql) == false) && (eregi("FULLTEXT", $sql) == false) && (eregi("UNIQUE", $sql) == false);
349
350         // Shall we add/drop?
351         if (((eregi("ADD", $sql) > 0) || (eregi("DROP", $sql) > 0)) && ($noIndex)) {
352                 // Extract table name
353                 $tableArray = explode(" ", $sql);
354                 $tableName = str_replace("`", "", $tableArray[2]);
355
356                 // And column name as well
357                 $columnName = str_replace("`", "", $tableArray[4]);
358
359                 // Get column information
360                 $result = SQL_QUERY_ESC("SHOW COLUMNS FROM %s LIKE '%s'",
361                         array($tableName, $columnName), $F, $L);
362
363                 // Do we have no entry on ADD or an entry on DROP?
364                 if (((SQL_NUMROWS($result) == 0) && (eregi("ADD", $sql) > 0)) || ((SQL_NUMROWS($result) == 1) && (eregi("DROP", $sql) > 0))) {
365                         // Do the query
366                         $result = SQL_QUERY($sql, $F, $L, false);
367                 } // END - if
368         } else {
369                 // Send it to the SQL_QUERY() function
370                 $result = SQL_QUERY($sql, $F, $L, false);
371         }
372
373         // Return result
374         return $result;
375 }
376 //
377 ?>