Fixed bug #8028: Databases with an "-" in it can't be used (Thanks to Steffen Kamper)
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_db.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2004-2008 Kasper Skaarhoj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28 * Contains the class "t3lib_db" containing functions for building SQL queries and mysql wrappers, thus providing a foundational API to all database interaction.
29 * This class is instantiated globally as $TYPO3_DB in TYPO3 scripts.
30 *
31 * $Id$
32 *
33 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
34 */
35 /**
36 * [CLASS/FUNCTION INDEX of SCRIPT]
37 *
38 *
39 *
40 * 138: class t3lib_DB
41 *
42 * SECTION: Query execution
43 * 175: function exec_INSERTquery($table,$fields_values,$no_quote_fields=FALSE)
44 * 192: function exec_UPDATEquery($table,$where,$fields_values,$no_quote_fields=FALSE)
45 * 206: function exec_DELETEquery($table,$where)
46 * 225: function exec_SELECTquery($select_fields,$from_table,$where_clause,$groupBy='',$orderBy='',$limit='')
47 * 250: function exec_SELECT_mm_query($select,$local_table,$mm_table,$foreign_table,$whereClause='',$groupBy='',$orderBy='',$limit='')
48 * 278: function exec_SELECT_queryArray($queryParts)
49 * 301: function exec_SELECTgetRows($select_fields,$from_table,$where_clause,$groupBy='',$orderBy='',$limit='',$uidIndexField='')
50 *
51 * SECTION: Query building
52 * 346: function INSERTquery($table,$fields_values,$no_quote_fields=FALSE)
53 * 381: function UPDATEquery($table,$where,$fields_values,$no_quote_fields=FALSE)
54 * 422: function DELETEquery($table,$where)
55 * 451: function SELECTquery($select_fields,$from_table,$where_clause,$groupBy='',$orderBy='',$limit='')
56 * 492: function listQuery($field, $value, $table)
57 * 506: function searchQuery($searchWords,$fields,$table)
58 *
59 * SECTION: Various helper functions
60 * 552: function fullQuoteStr($str, $table)
61 * 569: function fullQuoteArray($arr, $table, $noQuote=FALSE)
62 * 596: function quoteStr($str, $table)
63 * 612: function escapeStrForLike($str, $table)
64 * 625: function cleanIntArray($arr)
65 * 641: function cleanIntList($list)
66 * 655: function stripOrderBy($str)
67 * 669: function stripGroupBy($str)
68 * 681: function splitGroupOrderLimit($str)
69 *
70 * SECTION: MySQL wrapper functions
71 * 749: function sql($db,$query)
72 * 763: function sql_query($query)
73 * 776: function sql_error()
74 * 788: function sql_num_rows($res)
75 * 800: function sql_fetch_assoc($res)
76 * 813: function sql_fetch_row($res)
77 * 825: function sql_free_result($res)
78 * 836: function sql_insert_id()
79 * 847: function sql_affected_rows()
80 * 860: function sql_data_seek($res,$seek)
81 * 873: function sql_field_type($res,$pointer)
82 * 887: function sql_pconnect($TYPO3_db_host, $TYPO3_db_username, $TYPO3_db_password)
83 * 915: function sql_select_db($TYPO3_db)
84 *
85 * SECTION: SQL admin functions
86 * 947: function admin_get_dbs()
87 * 965: function admin_get_tables()
88 * 984: function admin_get_fields($tableName)
89 * 1002: function admin_get_keys($tableName)
90 * 1020: function admin_query($query)
91 *
92 * SECTION: Connecting service
93 * 1048: function connectDB()
94 *
95 * SECTION: Debugging
96 * 1086: function debug($func)
97 *
98 * TOTAL FUNCTIONS: 42
99 * (This index is automatically created/updated by the extension "extdeveval")
100 *
101 */
102
103
104
105
106
107
108
109
110
111
112
113
114 /**
115 * TYPO3 "database wrapper" class (new in 3.6.0)
116 * This class contains
117 * - abstraction functions for executing INSERT/UPDATE/DELETE/SELECT queries ("Query execution"; These are REQUIRED for all future connectivity to the database, thus ensuring DBAL compliance!)
118 * - functions for building SQL queries (INSERT/UPDATE/DELETE/SELECT) ("Query building"); These are transitional functions for building SQL queries in a more automated way. Use these to build queries instead of doing it manually in your code!
119 * - mysql() wrapper functions; These are transitional functions. By a simple search/replace you should be able to substitute all mysql*() calls with $GLOBALS['TYPO3_DB']->sql*() and your application will work out of the box. YOU CANNOT (legally) use any mysql functions not found as wrapper functions in this class!
120 * See the Project Coding Guidelines (doc_core_cgl) for more instructions on best-practise
121 *
122 * This class is not in itself a complete database abstraction layer but can be extended to be a DBAL (by extensions, see "dbal" for example)
123 * ALL connectivity to the database in TYPO3 must be done through this class!
124 * The points of this class are:
125 * - To direct all database calls through this class so it becomes possible to implement DBAL with extensions.
126 * - To keep it very easy to use for developers used to MySQL in PHP - and preserve as much performance as possible when TYPO3 is used with MySQL directly...
127 * - To create an interface for DBAL implemented by extensions; (Eg. making possible escaping characters, clob/blob handling, reserved words handling)
128 * - Benchmarking the DB bottleneck queries will become much easier; Will make it easier to find optimization possibilities.
129 *
130 * USE:
131 * In all TYPO3 scripts the global variable $TYPO3_DB is an instance of this class. Use that.
132 * Eg. $GLOBALS['TYPO3_DB']->sql_fetch_assoc()
133 *
134 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
135 * @package TYPO3
136 * @subpackage t3lib
137 */
138 class t3lib_DB {
139
140
141 // Debug:
142 var $debugOutput = FALSE; // Set "TRUE" if you want database errors outputted.
143 var $debug_lastBuiltQuery = ''; // Internally: Set to last built query (not necessarily executed...)
144 var $store_lastBuiltQuery = FALSE; // Set "TRUE" if you want the last built query to be stored in $debug_lastBuiltQuery independent of $this->debugOutput
145 var $explainOutput = 0; // Set this to 1 to get queries explained (devIPmask must match). Set the value to 2 to the same but disregarding the devIPmask. There is an alternative option to enable explain output in the admin panel under "TypoScript", which will produce much nicer output, but only works in FE.
146
147 // Default link identifier:
148 var $link = FALSE;
149
150 // Default character set, applies unless character set or collation are explicitely set
151 var $default_charset = 'utf8';
152
153
154
155
156 /************************************
157 *
158 * Query execution
159 *
160 * These functions are the RECOMMENDED DBAL functions for use in your applications
161 * Using these functions will allow the DBAL to use alternative ways of accessing data (contrary to if a query is returned!)
162 * They compile a query AND execute it immediately and then return the result
163 * This principle heightens our ability to create various forms of DBAL of the functions.
164 * Generally: We want to return a result pointer/object, never queries.
165 * Also, having the table name together with the actual query execution allows us to direct the request to other databases.
166 *
167 **************************************/
168
169 /**
170 * Creates and executes an INSERT SQL-statement for $table from the array with field/value pairs $fields_values.
171 * Using this function specifically allows us to handle BLOB and CLOB fields depending on DB
172 * Usage count/core: 47
173 *
174 * @param string Table name
175 * @param array Field values as key=>value pairs. Values will be escaped internally. Typically you would fill an array like "$insertFields" with 'fieldname'=>'value' and pass it to this function as argument.
176 * @param string/array See fullQuoteArray()
177 * @return pointer MySQL result pointer / DBAL object
178 */
179 function exec_INSERTquery($table,$fields_values,$no_quote_fields=FALSE) {
180 $res = mysql_query($this->INSERTquery($table,$fields_values,$no_quote_fields), $this->link);
181 if ($this->debugOutput) $this->debug('exec_INSERTquery');
182 return $res;
183 }
184
185 /**
186 * Creates and executes an UPDATE SQL-statement for $table where $where-clause (typ. 'uid=...') from the array with field/value pairs $fields_values.
187 * Using this function specifically allow us to handle BLOB and CLOB fields depending on DB
188 * Usage count/core: 50
189 *
190 * @param string Database tablename
191 * @param string WHERE clause, eg. "uid=1". NOTICE: You must escape values in this argument with $this->fullQuoteStr() yourself!
192 * @param array Field values as key=>value pairs. Values will be escaped internally. Typically you would fill an array like "$updateFields" with 'fieldname'=>'value' and pass it to this function as argument.
193 * @param string/array See fullQuoteArray()
194 * @return pointer MySQL result pointer / DBAL object
195 */
196 function exec_UPDATEquery($table,$where,$fields_values,$no_quote_fields=FALSE) {
197 $res = mysql_query($this->UPDATEquery($table,$where,$fields_values,$no_quote_fields), $this->link);
198 if ($this->debugOutput) $this->debug('exec_UPDATEquery');
199 return $res;
200 }
201
202 /**
203 * Creates and executes a DELETE SQL-statement for $table where $where-clause
204 * Usage count/core: 40
205 *
206 * @param string Database tablename
207 * @param string WHERE clause, eg. "uid=1". NOTICE: You must escape values in this argument with $this->fullQuoteStr() yourself!
208 * @return pointer MySQL result pointer / DBAL object
209 */
210 function exec_DELETEquery($table,$where) {
211 $res = mysql_query($this->DELETEquery($table,$where), $this->link);
212 if ($this->debugOutput) $this->debug('exec_DELETEquery');
213 return $res;
214 }
215
216 /**
217 * Creates and executes a SELECT SQL-statement
218 * Using this function specifically allow us to handle the LIMIT feature independently of DB.
219 * Usage count/core: 340
220 *
221 * @param string List of fields to select from the table. This is what comes right after "SELECT ...". Required value.
222 * @param string Table(s) from which to select. This is what comes right after "FROM ...". Required value.
223 * @param string Optional additional WHERE clauses put in the end of the query. NOTICE: You must escape values in this argument with $this->fullQuoteStr() yourself! DO NOT PUT IN GROUP BY, ORDER BY or LIMIT!
224 * @param string Optional GROUP BY field(s), if none, supply blank string.
225 * @param string Optional ORDER BY field(s), if none, supply blank string.
226 * @param string Optional LIMIT value ([begin,]max), if none, supply blank string.
227 * @return pointer MySQL result pointer / DBAL object
228 */
229 function exec_SELECTquery($select_fields,$from_table,$where_clause,$groupBy='',$orderBy='',$limit='') {
230 $query = $this->SELECTquery($select_fields,$from_table,$where_clause,$groupBy,$orderBy,$limit);
231 $res = mysql_query($query, $this->link);
232
233 if ($this->debugOutput) {
234 $this->debug('exec_SELECTquery');
235 }
236 if ($this->explainOutput) {
237 $this->explain($query, $from_table, $this->sql_num_rows($res));
238 }
239
240 return $res;
241 }
242
243 /**
244 * Creates and executes a SELECT query, selecting fields ($select) from two/three tables joined
245 * Use $mm_table together with $local_table or $foreign_table to select over two tables. Or use all three tables to select the full MM-relation.
246 * The JOIN is done with [$local_table].uid <--> [$mm_table].uid_local / [$mm_table].uid_foreign <--> [$foreign_table].uid
247 * The function is very useful for selecting MM-relations between tables adhering to the MM-format used by TCE (TYPO3 Core Engine). See the section on $TCA in Inside TYPO3 for more details.
248 *
249 * Usage: 12 (spec. ext. sys_action, sys_messages, sys_todos)
250 *
251 * @param string Field list for SELECT
252 * @param string Tablename, local table
253 * @param string Tablename, relation table
254 * @param string Tablename, foreign table
255 * @param string Optional additional WHERE clauses put in the end of the query. NOTICE: You must escape values in this argument with $this->fullQuoteStr() yourself! DO NOT PUT IN GROUP BY, ORDER BY or LIMIT! You have to prepend 'AND ' to this parameter yourself!
256 * @param string Optional GROUP BY field(s), if none, supply blank string.
257 * @param string Optional ORDER BY field(s), if none, supply blank string.
258 * @param string Optional LIMIT value ([begin,]max), if none, supply blank string.
259 * @return pointer MySQL result pointer / DBAL object
260 * @see exec_SELECTquery()
261 */
262 function exec_SELECT_mm_query($select,$local_table,$mm_table,$foreign_table,$whereClause='',$groupBy='',$orderBy='',$limit='') {
263 if($foreign_table == $local_table) {
264 $foreign_table_as = $foreign_table.uniqid('_join');
265 }
266
267 $mmWhere = $local_table ? $local_table.'.uid='.$mm_table.'.uid_local' : '';
268 $mmWhere.= ($local_table AND $foreign_table) ? ' AND ' : '';
269 $mmWhere.= $foreign_table ? ($foreign_table_as ? $foreign_table_as : $foreign_table).'.uid='.$mm_table.'.uid_foreign' : '';
270
271 return $GLOBALS['TYPO3_DB']->exec_SELECTquery(
272 $select,
273 ($local_table ? $local_table.',' : '').$mm_table.($foreign_table ? ','. $foreign_table.($foreign_table_as ? ' AS '.$foreign_table_as : '') : ''),
274 $mmWhere.' '.$whereClause, // whereClauseMightContainGroupOrderBy
275 $groupBy,
276 $orderBy,
277 $limit
278 );
279 }
280
281 /**
282 * Executes a select based on input query parts array
283 *
284 * Usage: 9
285 *
286 * @param array Query parts array
287 * @return pointer MySQL select result pointer / DBAL object
288 * @see exec_SELECTquery()
289 */
290 function exec_SELECT_queryArray($queryParts) {
291 return $this->exec_SELECTquery(
292 $queryParts['SELECT'],
293 $queryParts['FROM'],
294 $queryParts['WHERE'],
295 $queryParts['GROUPBY'],
296 $queryParts['ORDERBY'],
297 $queryParts['LIMIT']
298 );
299 }
300
301 /**
302 * Creates and executes a SELECT SQL-statement AND traverse result set and returns array with records in.
303 *
304 * @param string See exec_SELECTquery()
305 * @param string See exec_SELECTquery()
306 * @param string See exec_SELECTquery()
307 * @param string See exec_SELECTquery()
308 * @param string See exec_SELECTquery()
309 * @param string See exec_SELECTquery()
310 * @param string If set, the result array will carry this field names value as index. Requires that field to be selected of course!
311 * @return array Array of rows.
312 */
313 function exec_SELECTgetRows($select_fields,$from_table,$where_clause,$groupBy='',$orderBy='',$limit='',$uidIndexField='') {
314 $res = $this->exec_SELECTquery($select_fields,$from_table,$where_clause,$groupBy,$orderBy,$limit);
315 if ($this->debugOutput) $this->debug('exec_SELECTquery');
316
317 if (!$this->sql_error()) {
318 $output = array();
319
320 if ($uidIndexField) {
321 while($tempRow = $this->sql_fetch_assoc($res)) {
322 $output[$tempRow[$uidIndexField]] = $tempRow;
323 }
324 } else {
325 while($output[] = $this->sql_fetch_assoc($res));
326 array_pop($output);
327 }
328 $this->sql_free_result($res);
329 }
330 return $output;
331 }
332
333
334
335
336
337
338
339
340
341
342
343 /**************************************
344 *
345 * Query building
346 *
347 **************************************/
348
349 /**
350 * Creates an INSERT SQL-statement for $table from the array with field/value pairs $fields_values.
351 * Usage count/core: 4
352 *
353 * @param string See exec_INSERTquery()
354 * @param array See exec_INSERTquery()
355 * @param string/array See fullQuoteArray()
356 * @return string Full SQL query for INSERT (unless $fields_values does not contain any elements in which case it will be false)
357 * @deprecated use exec_INSERTquery() instead if possible!
358 */
359 function INSERTquery($table,$fields_values,$no_quote_fields=FALSE) {
360
361 // Table and fieldnames should be "SQL-injection-safe" when supplied to this function (contrary to values in the arrays which may be insecure).
362 if (is_array($fields_values) && count($fields_values)) {
363
364 // quote and escape values
365 $fields_values = $this->fullQuoteArray($fields_values,$table,$no_quote_fields);
366
367 // Build query:
368 $query = 'INSERT INTO '.$table.'
369 (
370 '.implode(',
371 ',array_keys($fields_values)).'
372 ) VALUES (
373 '.implode(',
374 ',$fields_values).'
375 )';
376
377 // Return query:
378 if ($this->debugOutput || $this->store_lastBuiltQuery) $this->debug_lastBuiltQuery = $query;
379 return $query;
380 }
381 }
382
383 /**
384 * Creates an UPDATE SQL-statement for $table where $where-clause (typ. 'uid=...') from the array with field/value pairs $fields_values.
385 * Usage count/core: 6
386 *
387 * @param string See exec_UPDATEquery()
388 * @param string See exec_UPDATEquery()
389 * @param array See exec_UPDATEquery()
390 * @param array See fullQuoteArray()
391 * @return string Full SQL query for UPDATE (unless $fields_values does not contain any elements in which case it will be false)
392 * @deprecated use exec_UPDATEquery() instead if possible!
393 */
394 function UPDATEquery($table,$where,$fields_values,$no_quote_fields=FALSE) {
395
396 // Table and fieldnames should be "SQL-injection-safe" when supplied to this function (contrary to values in the arrays which may be insecure).
397 if (is_string($where)) {
398 if (is_array($fields_values) && count($fields_values)) {
399
400 // quote and escape values
401 $nArr = $this->fullQuoteArray($fields_values,$table,$no_quote_fields);
402
403 $fields = array();
404 foreach ($nArr as $k => $v) {
405 $fields[] = $k.'='.$v;
406 }
407
408 // Build query:
409 $query = 'UPDATE '.$table.'
410 SET
411 '.implode(',
412 ',$fields).
413 (strlen($where)>0 ? '
414 WHERE
415 '.$where : '');
416
417 // Return query:
418 if ($this->debugOutput || $this->store_lastBuiltQuery) $this->debug_lastBuiltQuery = $query;
419 return $query;
420 }
421 } else {
422 die('<strong>TYPO3 Fatal Error:</strong> "Where" clause argument for UPDATE query was not a string in $this->UPDATEquery() !');
423 }
424 }
425
426 /**
427 * Creates a DELETE SQL-statement for $table where $where-clause
428 * Usage count/core: 3
429 *
430 * @param string See exec_DELETEquery()
431 * @param string See exec_DELETEquery()
432 * @return string Full SQL query for DELETE
433 * @deprecated use exec_DELETEquery() instead if possible!
434 */
435 function DELETEquery($table,$where) {
436 if (is_string($where)) {
437
438 // Table and fieldnames should be "SQL-injection-safe" when supplied to this function
439 $query = 'DELETE FROM '.$table.
440 (strlen($where)>0 ? '
441 WHERE
442 '.$where : '');
443
444 if ($this->debugOutput || $this->store_lastBuiltQuery) $this->debug_lastBuiltQuery = $query;
445 return $query;
446 } else {
447 die('<strong>TYPO3 Fatal Error:</strong> "Where" clause argument for DELETE query was not a string in $this->DELETEquery() !');
448 }
449 }
450
451 /**
452 * Creates a SELECT SQL-statement
453 * Usage count/core: 11
454 *
455 * @param string See exec_SELECTquery()
456 * @param string See exec_SELECTquery()
457 * @param string See exec_SELECTquery()
458 * @param string See exec_SELECTquery()
459 * @param string See exec_SELECTquery()
460 * @param string See exec_SELECTquery()
461 * @return string Full SQL query for SELECT
462 * @deprecated use exec_SELECTquery() instead if possible!
463 */
464 function SELECTquery($select_fields,$from_table,$where_clause,$groupBy='',$orderBy='',$limit='') {
465
466 // Table and fieldnames should be "SQL-injection-safe" when supplied to this function
467 // Build basic query:
468 $query = 'SELECT '.$select_fields.'
469 FROM '.$from_table.
470 (strlen($where_clause)>0 ? '
471 WHERE
472 '.$where_clause : '');
473
474 // Group by:
475 if (strlen($groupBy)>0) {
476 $query.= '
477 GROUP BY '.$groupBy;
478 }
479 // Order by:
480 if (strlen($orderBy)>0) {
481 $query.= '
482 ORDER BY '.$orderBy;
483 }
484 // Group by:
485 if (strlen($limit)>0) {
486 $query.= '
487 LIMIT '.$limit;
488 }
489
490 // Return query:
491 if ($this->debugOutput || $this->store_lastBuiltQuery) $this->debug_lastBuiltQuery = $query;
492 return $query;
493 }
494
495 /**
496 * Returns a WHERE clause that can find a value ($value) in a list field ($field)
497 * For instance a record in the database might contain a list of numbers, "34,234,5" (with no spaces between). This query would be able to select that record based on the value "34", "234" or "5" regardless of their positioni in the list (left, middle or right).
498 * Is nice to look up list-relations to records or files in TYPO3 database tables.
499 *
500 * @param string Field name
501 * @param string Value to find in list
502 * @param string Table in which we are searching (for DBAL detection of quoteStr() method)
503 * @return string WHERE clause for a query
504 */
505 function listQuery($field, $value, $table) {
506 $command = $this->quoteStr($value, $table);
507 $where = '('.$field.' LIKE \'%,'.$command.',%\' OR '.$field.' LIKE \''.$command.',%\' OR '.$field.' LIKE \'%,'.$command.'\' OR '.$field.'=\''.$command.'\')';
508 return $where;
509 }
510
511 /**
512 * Returns a WHERE clause which will make an AND search for the words in the $searchWords array in any of the fields in array $fields.
513 *
514 * @param array Array of search words
515 * @param array Array of fields
516 * @param string Table in which we are searching (for DBAL detection of quoteStr() method)
517 * @return string WHERE clause for search
518 */
519 function searchQuery($searchWords,$fields,$table) {
520 $queryParts = array();
521
522 foreach($searchWords as $sw) {
523 $like=' LIKE \'%'.$this->quoteStr($sw, $table).'%\'';
524 $queryParts[] = $table.'.'.implode($like.' OR '.$table.'.',$fields).$like;
525 }
526 $query = '('.implode(') AND (',$queryParts).')';
527 return $query ;
528 }
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545 /**************************************
546 *
547 * Various helper functions
548 *
549 * Functions recommended to be used for
550 * - escaping values,
551 * - cleaning lists of values,
552 * - stripping of excess ORDER BY/GROUP BY keywords
553 *
554 **************************************/
555
556 /**
557 * Escaping and quoting values for SQL statements.
558 * Usage count/core: 100
559 *
560 * @param string Input string
561 * @param string Table name for which to quote string. Just enter the table that the field-value is selected from (and any DBAL will look up which handler to use and then how to quote the string!).
562 * @return string Output string; Wrapped in single quotes and quotes in the string (" / ') and \ will be backslashed (or otherwise based on DBAL handler)
563 * @see quoteStr()
564 */
565 function fullQuoteStr($str, $table) {
566 return '\''.mysql_real_escape_string($str, $this->link).'\'';
567 }
568
569 /**
570 * Will fullquote all values in the one-dimensional array so they are ready to "implode" for an sql query.
571 *
572 * @param array Array with values (either associative or non-associative array)
573 * @param string Table name for which to quote
574 * @param string/array List/array of keys NOT to quote (eg. SQL functions) - ONLY for associative arrays
575 * @return array The input array with the values quoted
576 * @see cleanIntArray()
577 */
578 function fullQuoteArray($arr, $table, $noQuote=FALSE) {
579 if (is_string($noQuote)) {
580 $noQuote = explode(',',$noQuote);
581 } elseif (!is_array($noQuote)) { // sanity check
582 $noQuote = FALSE;
583 }
584
585 foreach($arr as $k => $v) {
586 if ($noQuote===FALSE || !in_array($k,$noQuote)) {
587 $arr[$k] = $this->fullQuoteStr($v, $table);
588 }
589 }
590 return $arr;
591 }
592
593 /**
594 * Substitution for PHP function "addslashes()"
595 * Use this function instead of the PHP addslashes() function when you build queries - this will prepare your code for DBAL.
596 * NOTICE: You must wrap the output of this function in SINGLE QUOTES to be DBAL compatible. Unless you have to apply the single quotes yourself you should rather use ->fullQuoteStr()!
597 *
598 * Usage count/core: 20
599 *
600 * @param string Input string
601 * @param string Table name for which to quote string. Just enter the table that the field-value is selected from (and any DBAL will look up which handler to use and then how to quote the string!).
602 * @return string Output string; Quotes (" / ') and \ will be backslashed (or otherwise based on DBAL handler)
603 * @see quoteStr()
604 */
605 function quoteStr($str, $table) {
606 return mysql_real_escape_string($str, $this->link);
607 }
608
609 /**
610 * Escaping values for SQL LIKE statements.
611 *
612 * @param string Input string
613 * @param string Table name for which to escape string. Just enter the table that the field-value is selected from (and any DBAL will look up which handler to use and then how to quote the string!).
614 * @return string Output string; % and _ will be escaped with \ (or otherwise based on DBAL handler)
615 * @see quoteStr()
616 */
617 function escapeStrForLike($str, $table) {
618 return preg_replace('/[_%]/','\\\$0',$str);
619 }
620
621 /**
622 * Will convert all values in the one-dimensional array to integers.
623 * Useful when you want to make sure an array contains only integers before imploding them in a select-list.
624 * Usage count/core: 7
625 *
626 * @param array Array with values
627 * @return array The input array with all values passed through intval()
628 * @see cleanIntList()
629 */
630 function cleanIntArray($arr) {
631 foreach($arr as $k => $v) {
632 $arr[$k] = intval($arr[$k]);
633 }
634 return $arr;
635 }
636
637 /**
638 * Will force all entries in the input comma list to integers
639 * Useful when you want to make sure a commalist of supposed integers really contain only integers; You want to know that when you don't trust content that could go into an SQL statement.
640 * Usage count/core: 6
641 *
642 * @param string List of comma-separated values which should be integers
643 * @return string The input list but with every value passed through intval()
644 * @see cleanIntArray()
645 */
646 function cleanIntList($list) {
647 return implode(',',t3lib_div::intExplode(',',$list));
648 }
649
650 /**
651 * Removes the prefix "ORDER BY" from the input string.
652 * This function is used when you call the exec_SELECTquery() function and want to pass the ORDER BY parameter by can't guarantee that "ORDER BY" is not prefixed.
653 * Generally; This function provides a work-around to the situation where you cannot pass only the fields by which to order the result.
654 * Usage count/core: 11
655 *
656 * @param string eg. "ORDER BY title, uid"
657 * @return string eg. "title, uid"
658 * @see exec_SELECTquery(), stripGroupBy()
659 */
660 function stripOrderBy($str) {
661 return preg_replace('/^ORDER[[:space:]]+BY[[:space:]]+/i','',trim($str));
662 }
663
664 /**
665 * Removes the prefix "GROUP BY" from the input string.
666 * This function is used when you call the SELECTquery() function and want to pass the GROUP BY parameter by can't guarantee that "GROUP BY" is not prefixed.
667 * Generally; This function provides a work-around to the situation where you cannot pass only the fields by which to order the result.
668 * Usage count/core: 1
669 *
670 * @param string eg. "GROUP BY title, uid"
671 * @return string eg. "title, uid"
672 * @see exec_SELECTquery(), stripOrderBy()
673 */
674 function stripGroupBy($str) {
675 return preg_replace('/^GROUP[[:space:]]+BY[[:space:]]+/i','',trim($str));
676 }
677
678 /**
679 * Takes the last part of a query, eg. "... uid=123 GROUP BY title ORDER BY title LIMIT 5,2" and splits each part into a table (WHERE, GROUPBY, ORDERBY, LIMIT)
680 * Work-around function for use where you know some userdefined end to an SQL clause is supplied and you need to separate these factors.
681 * Usage count/core: 13
682 *
683 * @param string Input string
684 * @return array
685 */
686 function splitGroupOrderLimit($str) {
687 $str = ' '.$str; // Prepending a space to make sure "[[:space:]]+" will find a space there for the first element.
688 // Init output array:
689 $wgolParts = array(
690 'WHERE' => '',
691 'GROUPBY' => '',
692 'ORDERBY' => '',
693 'LIMIT' => ''
694 );
695
696 // Find LIMIT:
697 $reg = array();
698 if (preg_match('/^(.*)[[:space:]]+LIMIT[[:space:]]+([[:alnum:][:space:],._]+)$/i',$str,$reg)) {
699 $wgolParts['LIMIT'] = trim($reg[2]);
700 $str = $reg[1];
701 }
702
703 // Find ORDER BY:
704 $reg = array();
705 if (preg_match('/^(.*)[[:space:]]+ORDER[[:space:]]+BY[[:space:]]+([[:alnum:][:space:],._]+)$/i',$str,$reg)) {
706 $wgolParts['ORDERBY'] = trim($reg[2]);
707 $str = $reg[1];
708 }
709
710 // Find GROUP BY:
711 $reg = array();
712 if (preg_match('/^(.*)[[:space:]]+GROUP[[:space:]]+BY[[:space:]]+([[:alnum:][:space:],._]+)$/i',$str,$reg)) {
713 $wgolParts['GROUPBY'] = trim($reg[2]);
714 $str = $reg[1];
715 }
716
717 // Rest is assumed to be "WHERE" clause:
718 $wgolParts['WHERE'] = $str;
719
720 return $wgolParts;
721 }
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737 /**************************************
738 *
739 * MySQL wrapper functions
740 * (For use in your applications)
741 *
742 **************************************/
743
744 /**
745 * Executes query
746 * mysql() wrapper function
747 * DEPRECATED - use exec_* functions from this class instead!
748 * Usage count/core: 9
749 *
750 * @param string Database name
751 * @param string Query to execute
752 * @return pointer Result pointer / DBAL object
753 */
754 function sql($db,$query) {
755 $res = mysql_query($query, $this->link);
756 if ($this->debugOutput) $this->debug('sql',$query);
757 return $res;
758 }
759
760 /**
761 * Executes query
762 * mysql_query() wrapper function
763 * Usage count/core: 1
764 *
765 * @param string Query to execute
766 * @return pointer Result pointer / DBAL object
767 */
768 function sql_query($query) {
769 $res = mysql_query($query, $this->link);
770 if ($this->debugOutput) $this->debug('sql_query',$query);
771 return $res;
772 }
773
774 /**
775 * Returns the error status on the last sql() execution
776 * mysql_error() wrapper function
777 * Usage count/core: 32
778 *
779 * @return string MySQL error string.
780 */
781 function sql_error() {
782 return mysql_error($this->link);
783 }
784
785 /**
786 * Returns the number of selected rows.
787 * mysql_num_rows() wrapper function
788 * Usage count/core: 85
789 *
790 * @param pointer MySQL result pointer (of SELECT query) / DBAL object
791 * @return integer Number of resulting rows
792 */
793 function sql_num_rows($res) {
794 $this->debug_check_recordset($res);
795 return mysql_num_rows($res);
796 }
797
798 /**
799 * Returns an associative array that corresponds to the fetched row, or FALSE if there are no more rows.
800 * mysql_fetch_assoc() wrapper function
801 * Usage count/core: 307
802 *
803 * @param pointer MySQL result pointer (of SELECT query) / DBAL object
804 * @return array Associative array of result row.
805 */
806 function sql_fetch_assoc($res) {
807 $this->debug_check_recordset($res);
808 return mysql_fetch_assoc($res);
809 }
810
811 /**
812 * Returns an array that corresponds to the fetched row, or FALSE if there are no more rows.
813 * The array contains the values in numerical indices.
814 * mysql_fetch_row() wrapper function
815 * Usage count/core: 56
816 *
817 * @param pointer MySQL result pointer (of SELECT query) / DBAL object
818 * @return array Array with result rows.
819 */
820 function sql_fetch_row($res) {
821 $this->debug_check_recordset($res);
822 return mysql_fetch_row($res);
823 }
824
825 /**
826 * Free result memory
827 * mysql_free_result() wrapper function
828 * Usage count/core: 3
829 *
830 * @param pointer MySQL result pointer to free / DBAL object
831 * @return boolean Returns TRUE on success or FALSE on failure.
832 */
833 function sql_free_result($res) {
834 $this->debug_check_recordset($res);
835 return mysql_free_result($res);
836 }
837
838 /**
839 * Get the ID generated from the previous INSERT operation
840 * mysql_insert_id() wrapper function
841 * Usage count/core: 13
842 *
843 * @return integer The uid of the last inserted record.
844 */
845 function sql_insert_id() {
846 return mysql_insert_id($this->link);
847 }
848
849 /**
850 * Returns the number of rows affected by the last INSERT, UPDATE or DELETE query
851 * mysql_affected_rows() wrapper function
852 * Usage count/core: 1
853 *
854 * @return integer Number of rows affected by last query
855 */
856 function sql_affected_rows() {
857 return mysql_affected_rows($this->link);
858 }
859
860 /**
861 * Move internal result pointer
862 * mysql_data_seek() wrapper function
863 * Usage count/core: 3
864 *
865 * @param pointer MySQL result pointer (of SELECT query) / DBAL object
866 * @param integer Seek result number.
867 * @return boolean Returns TRUE on success or FALSE on failure.
868 */
869 function sql_data_seek($res,$seek) {
870 $this->debug_check_recordset($res);
871 return mysql_data_seek($res,$seek);
872 }
873
874 /**
875 * Get the type of the specified field in a result
876 * mysql_field_type() wrapper function
877 * Usage count/core: 2
878 *
879 * @param pointer MySQL result pointer (of SELECT query) / DBAL object
880 * @param integer Field index.
881 * @return string Returns the name of the specified field index
882 */
883 function sql_field_type($res,$pointer) {
884 $this->debug_check_recordset($res);
885 return mysql_field_type($res,$pointer);
886 }
887
888 /**
889 * Open a (persistent) connection to a MySQL server
890 * mysql_pconnect() wrapper function
891 * Usage count/core: 12
892 *
893 * @param string Database host IP/domain
894 * @param string Username to connect with.
895 * @param string Password to connect with.
896 * @return pointer Returns a positive MySQL persistent link identifier on success, or FALSE on error.
897 */
898 function sql_pconnect($TYPO3_db_host, $TYPO3_db_username, $TYPO3_db_password) {
899 // mysql_error() is tied to an established connection
900 // if the connection fails we need a different method to get the error message
901 ini_set('track_errors', 1);
902 ini_set('html_errors', 0);
903 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['no_pconnect']) {
904 $this->link = @mysql_connect($TYPO3_db_host, $TYPO3_db_username, $TYPO3_db_password);
905 } else {
906 $this->link = @mysql_pconnect($TYPO3_db_host, $TYPO3_db_username, $TYPO3_db_password);
907 }
908 $error_msg = $php_errormsg;
909 ini_restore('track_errors');
910 ini_restore('html_errors');
911
912 if (!$this->link) {
913 t3lib_div::sysLog('Could not connect to MySQL server '.$TYPO3_db_host.' with user '.$TYPO3_db_username.': '.$error_msg,'Core',4);
914 } else {
915 $setDBinit = t3lib_div::trimExplode(chr(10), $GLOBALS['TYPO3_CONF_VARS']['SYS']['setDBinit'],TRUE);
916 foreach ($setDBinit as $v) {
917 if (mysql_query($v, $this->link) === FALSE) {
918 t3lib_div::sysLog('Could not initialize DB connection with query "'.$v.'": '.mysql_error($this->link),'Core',3);
919 }
920 }
921 }
922
923 return $this->link;
924 }
925
926 /**
927 * Select a MySQL database
928 * mysql_select_db() wrapper function
929 * Usage count/core: 8
930 *
931 * @param string Database to connect to.
932 * @return boolean Returns TRUE on success or FALSE on failure.
933 */
934 function sql_select_db($TYPO3_db) {
935 $ret = @mysql_select_db($TYPO3_db, $this->link);
936 if (!$ret) {
937 t3lib_div::sysLog('Could not select MySQL database '.$TYPO3_db.': '.mysql_error(),'Core',4);
938 }
939 return $ret;
940 }
941
942
943
944
945
946
947
948
949
950
951 /**************************************
952 *
953 * SQL admin functions
954 * (For use in the Install Tool and Extension Manager)
955 *
956 **************************************/
957
958 /**
959 * Listing databases from current MySQL connection. NOTICE: It WILL try to select those databases and thus break selection of current database.
960 * This is only used as a service function in the (1-2-3 process) of the Install Tool. In any case a lookup should be done in the _DEFAULT handler DBMS then.
961 * Use in Install Tool only!
962 * Usage count/core: 1
963 *
964 * @return array Each entry represents a database name
965 */
966 function admin_get_dbs() {
967 $dbArr = array();
968 $db_list = mysql_list_dbs($this->link);
969 while ($row = mysql_fetch_object($db_list)) {
970 if ($this->sql_select_db($row->Database)) {
971 $dbArr[] = $row->Database;
972 }
973 }
974 return $dbArr;
975 }
976
977 /**
978 * Returns the list of tables from the default database, TYPO3_db (quering the DBMS)
979 * In a DBAL this method should 1) look up all tables from the DBMS of the _DEFAULT handler and then 2) add all tables *configured* to be managed by other handlers
980 * Usage count/core: 2
981 *
982 * @return array Array with tablenames as key and arrays with status information as value
983 */
984 function admin_get_tables() {
985 $whichTables = array();
986
987 $tables_result = mysql_query('SHOW TABLE STATUS FROM `'.TYPO3_db.'`', $this->link);
988 if (!mysql_error()) {
989 while ($theTable = mysql_fetch_assoc($tables_result)) {
990 $whichTables[$theTable['Name']] = $theTable;
991 }
992 }
993
994 return $whichTables;
995 }
996
997 /**
998 * Returns information about each field in the $table (quering the DBMS)
999 * In a DBAL this should look up the right handler for the table and return compatible information
1000 * This function is important not only for the Install Tool but probably for DBALs as well since they might need to look up table specific information in order to construct correct queries. In such cases this information should probably be cached for quick delivery.
1001 *
1002 * @param string Table name
1003 * @return array Field information in an associative array with fieldname => field row
1004 */
1005 function admin_get_fields($tableName) {
1006 $output = array();
1007
1008 $columns_res = mysql_query('SHOW COLUMNS FROM `'.$tableName.'`', $this->link);
1009 while($fieldRow = mysql_fetch_assoc($columns_res)) {
1010 $output[$fieldRow['Field']] = $fieldRow;
1011 }
1012
1013 return $output;
1014 }
1015
1016 /**
1017 * Returns information about each index key in the $table (quering the DBMS)
1018 * In a DBAL this should look up the right handler for the table and return compatible information
1019 *
1020 * @param string Table name
1021 * @return array Key information in a numeric array
1022 */
1023 function admin_get_keys($tableName) {
1024 $output = array();
1025
1026 $keyRes = mysql_query('SHOW KEYS FROM `'.$tableName.'`', $this->link);
1027 while($keyRow = mysql_fetch_assoc($keyRes)) {
1028 $output[] = $keyRow;
1029 }
1030
1031 return $output;
1032 }
1033
1034 /**
1035 * Returns information about the character sets supported by the current DBM
1036 * This function is important not only for the Install Tool but probably for DBALs as well since they might need to look up table specific information in order to construct correct queries. In such cases this information should probably be cached for quick delivery.
1037 *
1038 * This is used by the Install Tool to convert tables tables with non-UTF8 charsets
1039 * Use in Install Tool only!
1040 *
1041 * @return array Array with Charset as key and an array of "Charset", "Description", "Default collation", "Maxlen" as values
1042 */
1043 function admin_get_charsets() {
1044 $output = array();
1045
1046 $columns_res = mysql_query('SHOW CHARACTER SET', $this->link);
1047 while ($row = mysql_fetch_assoc($columns_res)) {
1048 $output[$row['Charset']] = $row;
1049 }
1050
1051 return $output;
1052 }
1053
1054 /**
1055 * mysql() wrapper function, used by the Install Tool and EM for all queries regarding management of the database!
1056 * Usage count/core: 10
1057 *
1058 * @param string Query to execute
1059 * @return pointer Result pointer
1060 */
1061 function admin_query($query) {
1062 $res = mysql_query($query, $this->link);
1063 if ($this->debugOutput) $this->debug('admin_query',$query);
1064 return $res;
1065 }
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078 /******************************
1079 *
1080 * Connecting service
1081 *
1082 ******************************/
1083
1084 /**
1085 * Connects to database for TYPO3 sites:
1086 *
1087 * @return void
1088 */
1089 function connectDB() {
1090 if ($this->sql_pconnect(TYPO3_db_host, TYPO3_db_username, TYPO3_db_password)) {
1091 if (!TYPO3_db) {
1092 die('No database selected');
1093 exit;
1094 } elseif (!$this->sql_select_db(TYPO3_db)) {
1095 die('Cannot connect to the current database, "'.TYPO3_db.'"');
1096 exit;
1097 }
1098 } else {
1099 die('The current username, password or host was not accepted when the connection to the database was attempted to be established!');
1100 exit;
1101 }
1102 }
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115 /******************************
1116 *
1117 * Debugging
1118 *
1119 ******************************/
1120
1121 /**
1122 * Debug function: Outputs error if any
1123 *
1124 * @param string Function calling debug()
1125 * @param string Last query if not last built query
1126 * @return void
1127 */
1128 function debug($func, $query='') {
1129
1130 $error = $this->sql_error();
1131 if ($error) {
1132 echo t3lib_div::view_array(array(
1133 'caller' => 't3lib_DB::'.$func,
1134 'ERROR' => $error,
1135 'lastBuiltQuery' => ($query ? $query : $this->debug_lastBuiltQuery),
1136 'debug_backtrace' => t3lib_div::debug_trail()
1137 ));
1138 }
1139 }
1140
1141 /**
1142 * Checks if recordset is valid and writes debugging inormation into devLog if not.
1143 *
1144 * @param resource $res Recordset
1145 * @return boolean <code>false</code> if recordset is not valid
1146 */
1147 function debug_check_recordset($res) {
1148 if (!$res) {
1149 $trace = FALSE;
1150 $msg = 'Invalid database result resource detected';
1151 $trace = debug_backtrace();
1152 array_shift($trace);
1153 $cnt = count($trace);
1154 for ($i=0; $i<$cnt; $i++) {
1155 // complete objects are too large for the log
1156 if (isset($trace['object'])) unset($trace['object']);
1157 }
1158 $msg .= ': function t3lib_DB->' . $trace[0]['function'] . ' called from file ' . substr($trace[0]['file'],strlen(PATH_site)+2) . ' in line ' . $trace[0]['line'];
1159 t3lib_div::sysLog($msg.'. Use a devLog extension to get more details.', 'Core/t3lib_db', 3);
1160 t3lib_div::devLog($msg.'.', 'Core/t3lib_db', 3, $trace);
1161
1162 return FALSE;
1163 }
1164 return TRUE;
1165 }
1166
1167 /**
1168 * Explain select queries
1169 * If $this->explainOutput is set, SELECT queries will be explained here. Only queries with more than one possible result row will be displayed.
1170 * The output is either printed as raw HTML output or embedded into the TS admin panel (checkbox must be enabled!)
1171 *
1172 * TODO: Feature is not DBAL-compliant
1173 *
1174 * @param string SQL query
1175 * @param string Table(s) from which to select. This is what comes right after "FROM ...". Required value.
1176 * @param integer Number of resulting rows
1177 * @return boolean True if explain was run, false otherwise
1178 */
1179 protected function explain($query,$from_table,$row_count) {
1180
1181 if ((int)$this->explainOutput==1 || ((int)$this->explainOutput==2 && t3lib_div::cmpIP(t3lib_div::getIndpEnv('REMOTE_ADDR'), $GLOBALS['TYPO3_CONF_VARS']['SYS']['devIPmask']))) {
1182 $explainMode = 1; // raw HTML output
1183 } elseif ((int)$this->explainOutput==3 && is_object($GLOBALS['TT'])) {
1184 $explainMode = 2; // embed the output into the TS admin panel
1185 } else {
1186 return false;
1187 }
1188
1189 $error = $GLOBALS['TYPO3_DB']->sql_error();
1190 $trail = t3lib_div::debug_trail();
1191
1192 $explain_tables = array();
1193 $explain_output = array();
1194 $res = $this->sql_query('EXPLAIN '.$query, $this->link);
1195 if (is_resource($res)) {
1196 while ($tempRow = $this->sql_fetch_assoc($res)) {
1197 $explain_output[] = $tempRow;
1198 $explain_tables[] = $tempRow['table'];
1199 }
1200 $this->sql_free_result($res);
1201 }
1202
1203 $indices_output = array();
1204 if ($explain_output[0]['rows']>1 || t3lib_div::inList('ALL',$explain_output[0]['type'])) { // Notice: Rows are skipped if there is only one result, or if no conditions are set
1205 $debug = true; // only enable output if it's really useful
1206
1207 foreach ($explain_tables as $table) {
1208 $res = $this->sql_query('SHOW INDEX FROM '.$table, $this->link);
1209 if (is_resource($res)) {
1210 while ($tempRow = $this->sql_fetch_assoc($res)) {
1211 $indices_output[] = $tempRow;
1212 }
1213 $this->sql_free_result($res);
1214 }
1215 }
1216 } else {
1217 $debug = false;
1218 }
1219
1220 if ($debug) {
1221 if ($explainMode==1) {
1222 t3lib_div::debug('QUERY: '.$query);
1223 t3lib_div::debug(array('Debug trail:'=>$trail), 'Row count: '.$row_count);
1224
1225 if ($error) {
1226 t3lib_div::debug($error);
1227 }
1228 if (count($explain_output)) {
1229 t3lib_div::debug($explain_output);
1230 }
1231 if (count($indices_output)) {
1232 t3lib_div::debugRows($indices_output);
1233 }
1234
1235 } elseif ($explainMode==2) {
1236 $data = array();
1237 $data['query'] = $query;
1238 $data['trail'] = $trail;
1239 $data['row_count'] = $row_count;
1240
1241 if ($error) {
1242 $data['error'] = $error;
1243 }
1244 if (count($explain_output)) {
1245 $data['explain'] = $explain_output;
1246 }
1247 if (count($indices_output)) {
1248 $data['indices'] = $indices_output;
1249 }
1250 $GLOBALS['TT']->setTSselectQuery($data);
1251 }
1252 return true;
1253 }
1254
1255 return false;
1256 }
1257
1258 }
1259
1260
1261 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_db.php']) {
1262 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_db.php']);
1263 }
1264 ?>