git-svn-id: https://svn.typo3.org/TYPO3v4/Core/trunk@4899 709f56b5-9817-0410-a4d7...
[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 * Counts the number of rows in a table.
335 *
336 * @param string $field: Name of the field to use in the COUNT() expression (e.g. '*')
337 * @param string $table: Name of the table to count rows for
338 * @param string $where: (optional) WHERE statement of the query
339 * @return mixed Number of rows counter (integer) or false if something went wrong (boolean)
340 */
341 public function exec_SELECTcountRows($field, $table, $where = '') {
342 $count = false;
343 $resultSet = $this->exec_SELECTquery('COUNT(' . $field . ')', $table, $where);
344 if ($resultSet !== false) {
345 list($count) = $this->sql_fetch_row($resultSet);
346 $this->sql_free_result($resultSet);
347 }
348 return $count;
349 }
350
351
352
353
354
355
356
357
358
359
360
361 /**************************************
362 *
363 * Query building
364 *
365 **************************************/
366
367 /**
368 * Creates an INSERT SQL-statement for $table from the array with field/value pairs $fields_values.
369 * Usage count/core: 4
370 *
371 * @param string See exec_INSERTquery()
372 * @param array See exec_INSERTquery()
373 * @param string/array See fullQuoteArray()
374 * @return string Full SQL query for INSERT (unless $fields_values does not contain any elements in which case it will be false)
375 */
376 function INSERTquery($table,$fields_values,$no_quote_fields=FALSE) {
377
378 // Table and fieldnames should be "SQL-injection-safe" when supplied to this function (contrary to values in the arrays which may be insecure).
379 if (is_array($fields_values) && count($fields_values)) {
380
381 // quote and escape values
382 $fields_values = $this->fullQuoteArray($fields_values,$table,$no_quote_fields);
383
384 // Build query:
385 $query = 'INSERT INTO '.$table.'
386 (
387 '.implode(',
388 ',array_keys($fields_values)).'
389 ) VALUES (
390 '.implode(',
391 ',$fields_values).'
392 )';
393
394 // Return query:
395 if ($this->debugOutput || $this->store_lastBuiltQuery) $this->debug_lastBuiltQuery = $query;
396 return $query;
397 }
398 }
399
400 /**
401 * Creates an UPDATE SQL-statement for $table where $where-clause (typ. 'uid=...') from the array with field/value pairs $fields_values.
402 * Usage count/core: 6
403 *
404 * @param string See exec_UPDATEquery()
405 * @param string See exec_UPDATEquery()
406 * @param array See exec_UPDATEquery()
407 * @param array See fullQuoteArray()
408 * @return string Full SQL query for UPDATE (unless $fields_values does not contain any elements in which case it will be false)
409 */
410 function UPDATEquery($table,$where,$fields_values,$no_quote_fields=FALSE) {
411
412 // Table and fieldnames should be "SQL-injection-safe" when supplied to this function (contrary to values in the arrays which may be insecure).
413 if (is_string($where)) {
414 if (is_array($fields_values) && count($fields_values)) {
415
416 // quote and escape values
417 $nArr = $this->fullQuoteArray($fields_values,$table,$no_quote_fields);
418
419 $fields = array();
420 foreach ($nArr as $k => $v) {
421 $fields[] = $k.'='.$v;
422 }
423
424 // Build query:
425 $query = 'UPDATE '.$table.'
426 SET
427 '.implode(',
428 ',$fields).
429 (strlen($where)>0 ? '
430 WHERE
431 '.$where : '');
432
433 // Return query:
434 if ($this->debugOutput || $this->store_lastBuiltQuery) $this->debug_lastBuiltQuery = $query;
435 return $query;
436 }
437 } else {
438 die('<strong>TYPO3 Fatal Error:</strong> "Where" clause argument for UPDATE query was not a string in $this->UPDATEquery() !');
439 }
440 }
441
442 /**
443 * Creates a DELETE SQL-statement for $table where $where-clause
444 * Usage count/core: 3
445 *
446 * @param string See exec_DELETEquery()
447 * @param string See exec_DELETEquery()
448 * @return string Full SQL query for DELETE
449 */
450 function DELETEquery($table,$where) {
451 if (is_string($where)) {
452
453 // Table and fieldnames should be "SQL-injection-safe" when supplied to this function
454 $query = 'DELETE FROM '.$table.
455 (strlen($where)>0 ? '
456 WHERE
457 '.$where : '');
458
459 if ($this->debugOutput || $this->store_lastBuiltQuery) $this->debug_lastBuiltQuery = $query;
460 return $query;
461 } else {
462 die('<strong>TYPO3 Fatal Error:</strong> "Where" clause argument for DELETE query was not a string in $this->DELETEquery() !');
463 }
464 }
465
466 /**
467 * Creates a SELECT SQL-statement
468 * Usage count/core: 11
469 *
470 * @param string See exec_SELECTquery()
471 * @param string See exec_SELECTquery()
472 * @param string See exec_SELECTquery()
473 * @param string See exec_SELECTquery()
474 * @param string See exec_SELECTquery()
475 * @param string See exec_SELECTquery()
476 * @return string Full SQL query for SELECT
477 */
478 function SELECTquery($select_fields,$from_table,$where_clause,$groupBy='',$orderBy='',$limit='') {
479
480 // Table and fieldnames should be "SQL-injection-safe" when supplied to this function
481 // Build basic query:
482 $query = 'SELECT '.$select_fields.'
483 FROM '.$from_table.
484 (strlen($where_clause)>0 ? '
485 WHERE
486 '.$where_clause : '');
487
488 // Group by:
489 if (strlen($groupBy)>0) {
490 $query.= '
491 GROUP BY '.$groupBy;
492 }
493 // Order by:
494 if (strlen($orderBy)>0) {
495 $query.= '
496 ORDER BY '.$orderBy;
497 }
498 // Group by:
499 if (strlen($limit)>0) {
500 $query.= '
501 LIMIT '.$limit;
502 }
503
504 // Return query:
505 if ($this->debugOutput || $this->store_lastBuiltQuery) $this->debug_lastBuiltQuery = $query;
506 return $query;
507 }
508
509 /**
510 * Returns a WHERE clause that can find a value ($value) in a list field ($field)
511 * 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).
512 * Is nice to look up list-relations to records or files in TYPO3 database tables.
513 *
514 * @param string Field name
515 * @param string Value to find in list
516 * @param string Table in which we are searching (for DBAL detection of quoteStr() method)
517 * @return string WHERE clause for a query
518 */
519 function listQuery($field, $value, $table) {
520 $pattern = $this->quoteStr($value, $table);
521 $patternForLike = $this->escapeStrForLike($pattern, $table);
522 $where = '('.$field.' LIKE \'%,'.$patternForLike.',%\' OR '.$field.' LIKE \''.$patternForLike.',%\' OR '.$field.' LIKE \'%,'.$patternForLike.'\' OR '.$field.'=\''.$pattern.'\')';
523 return $where;
524 }
525
526 /**
527 * 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.
528 *
529 * @param array Array of search words
530 * @param array Array of fields
531 * @param string Table in which we are searching (for DBAL detection of quoteStr() method)
532 * @return string WHERE clause for search
533 */
534 function searchQuery($searchWords,$fields,$table) {
535 $queryParts = array();
536
537 foreach($searchWords as $sw) {
538 $like=' LIKE \'%'.$this->quoteStr($sw, $table).'%\'';
539 $queryParts[] = $table.'.'.implode($like.' OR '.$table.'.',$fields).$like;
540 }
541 $query = '('.implode(') AND (',$queryParts).')';
542 return $query ;
543 }
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560 /**************************************
561 *
562 * Various helper functions
563 *
564 * Functions recommended to be used for
565 * - escaping values,
566 * - cleaning lists of values,
567 * - stripping of excess ORDER BY/GROUP BY keywords
568 *
569 **************************************/
570
571 /**
572 * Escaping and quoting values for SQL statements.
573 * Usage count/core: 100
574 *
575 * @param string Input string
576 * @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!).
577 * @return string Output string; Wrapped in single quotes and quotes in the string (" / ') and \ will be backslashed (or otherwise based on DBAL handler)
578 * @see quoteStr()
579 */
580 function fullQuoteStr($str, $table) {
581 return '\''.mysql_real_escape_string($str, $this->link).'\'';
582 }
583
584 /**
585 * Will fullquote all values in the one-dimensional array so they are ready to "implode" for an sql query.
586 *
587 * @param array Array with values (either associative or non-associative array)
588 * @param string Table name for which to quote
589 * @param string/array List/array of keys NOT to quote (eg. SQL functions) - ONLY for associative arrays
590 * @return array The input array with the values quoted
591 * @see cleanIntArray()
592 */
593 function fullQuoteArray($arr, $table, $noQuote=FALSE) {
594 if (is_string($noQuote)) {
595 $noQuote = explode(',',$noQuote);
596 } elseif (!is_array($noQuote)) { // sanity check
597 $noQuote = FALSE;
598 }
599
600 foreach($arr as $k => $v) {
601 if ($noQuote===FALSE || !in_array($k,$noQuote)) {
602 $arr[$k] = $this->fullQuoteStr($v, $table);
603 }
604 }
605 return $arr;
606 }
607
608 /**
609 * Substitution for PHP function "addslashes()"
610 * Use this function instead of the PHP addslashes() function when you build queries - this will prepare your code for DBAL.
611 * 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()!
612 *
613 * Usage count/core: 20
614 *
615 * @param string Input string
616 * @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!).
617 * @return string Output string; Quotes (" / ') and \ will be backslashed (or otherwise based on DBAL handler)
618 * @see quoteStr()
619 */
620 function quoteStr($str, $table) {
621 return mysql_real_escape_string($str, $this->link);
622 }
623
624 /**
625 * Escaping values for SQL LIKE statements.
626 *
627 * @param string Input string
628 * @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!).
629 * @return string Output string; % and _ will be escaped with \ (or otherwise based on DBAL handler)
630 * @see quoteStr()
631 */
632 function escapeStrForLike($str, $table) {
633 return preg_replace('/[_%]/','\\\$0',$str);
634 }
635
636 /**
637 * Will convert all values in the one-dimensional array to integers.
638 * Useful when you want to make sure an array contains only integers before imploding them in a select-list.
639 * Usage count/core: 7
640 *
641 * @param array Array with values
642 * @return array The input array with all values passed through intval()
643 * @see cleanIntList()
644 */
645 function cleanIntArray($arr) {
646 foreach($arr as $k => $v) {
647 $arr[$k] = intval($arr[$k]);
648 }
649 return $arr;
650 }
651
652 /**
653 * Will force all entries in the input comma list to integers
654 * 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.
655 * Usage count/core: 6
656 *
657 * @param string List of comma-separated values which should be integers
658 * @return string The input list but with every value passed through intval()
659 * @see cleanIntArray()
660 */
661 function cleanIntList($list) {
662 return implode(',',t3lib_div::intExplode(',',$list));
663 }
664
665 /**
666 * Removes the prefix "ORDER BY" from the input string.
667 * 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.
668 * Generally; This function provides a work-around to the situation where you cannot pass only the fields by which to order the result.
669 * Usage count/core: 11
670 *
671 * @param string eg. "ORDER BY title, uid"
672 * @return string eg. "title, uid"
673 * @see exec_SELECTquery(), stripGroupBy()
674 */
675 function stripOrderBy($str) {
676 return preg_replace('/^ORDER[[:space:]]+BY[[:space:]]+/i','',trim($str));
677 }
678
679 /**
680 * Removes the prefix "GROUP BY" from the input string.
681 * 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.
682 * Generally; This function provides a work-around to the situation where you cannot pass only the fields by which to order the result.
683 * Usage count/core: 1
684 *
685 * @param string eg. "GROUP BY title, uid"
686 * @return string eg. "title, uid"
687 * @see exec_SELECTquery(), stripOrderBy()
688 */
689 function stripGroupBy($str) {
690 return preg_replace('/^GROUP[[:space:]]+BY[[:space:]]+/i','',trim($str));
691 }
692
693 /**
694 * 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)
695 * Work-around function for use where you know some userdefined end to an SQL clause is supplied and you need to separate these factors.
696 * Usage count/core: 13
697 *
698 * @param string Input string
699 * @return array
700 */
701 function splitGroupOrderLimit($str) {
702 $str = ' '.$str; // Prepending a space to make sure "[[:space:]]+" will find a space there for the first element.
703 // Init output array:
704 $wgolParts = array(
705 'WHERE' => '',
706 'GROUPBY' => '',
707 'ORDERBY' => '',
708 'LIMIT' => ''
709 );
710
711 // Find LIMIT:
712 $reg = array();
713 if (preg_match('/^(.*)[[:space:]]+LIMIT[[:space:]]+([[:alnum:][:space:],._]+)$/i',$str,$reg)) {
714 $wgolParts['LIMIT'] = trim($reg[2]);
715 $str = $reg[1];
716 }
717
718 // Find ORDER BY:
719 $reg = array();
720 if (preg_match('/^(.*)[[:space:]]+ORDER[[:space:]]+BY[[:space:]]+([[:alnum:][:space:],._]+)$/i',$str,$reg)) {
721 $wgolParts['ORDERBY'] = trim($reg[2]);
722 $str = $reg[1];
723 }
724
725 // Find GROUP BY:
726 $reg = array();
727 if (preg_match('/^(.*)[[:space:]]+GROUP[[:space:]]+BY[[:space:]]+([[:alnum:][:space:],._]+)$/i',$str,$reg)) {
728 $wgolParts['GROUPBY'] = trim($reg[2]);
729 $str = $reg[1];
730 }
731
732 // Rest is assumed to be "WHERE" clause:
733 $wgolParts['WHERE'] = $str;
734
735 return $wgolParts;
736 }
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752 /**************************************
753 *
754 * MySQL wrapper functions
755 * (For use in your applications)
756 *
757 **************************************/
758
759 /**
760 * Executes query
761 * mysql() wrapper function
762 * Usage count/core: 0
763 *
764 * @param string Database name
765 * @param string Query to execute
766 * @return pointer Result pointer / DBAL object
767 * @deprecated since TYPO3 3.6
768 * @see sql_query()
769 */
770 function sql($db,$query) {
771 $res = mysql_query($query, $this->link);
772 if ($this->debugOutput) $this->debug('sql',$query);
773 return $res;
774 }
775
776 /**
777 * Executes query
778 * mysql_query() wrapper function
779 * Usage count/core: 1
780 *
781 * @param string Query to execute
782 * @return pointer Result pointer / DBAL object
783 */
784 function sql_query($query) {
785 $res = mysql_query($query, $this->link);
786 if ($this->debugOutput) $this->debug('sql_query',$query);
787 return $res;
788 }
789
790 /**
791 * Returns the error status on the last sql() execution
792 * mysql_error() wrapper function
793 * Usage count/core: 32
794 *
795 * @return string MySQL error string.
796 */
797 function sql_error() {
798 return mysql_error($this->link);
799 }
800
801 /**
802 * Returns the error number on the last sql() execution
803 * mysql_errno() wrapper function
804 *
805 * @return int MySQL error number.
806 */
807 function sql_errno() {
808 return mysql_errno($this->link);
809 }
810
811 /**
812 * Returns the number of selected rows.
813 * mysql_num_rows() wrapper function
814 * Usage count/core: 85
815 *
816 * @param pointer MySQL result pointer (of SELECT query) / DBAL object
817 * @return integer Number of resulting rows
818 */
819 function sql_num_rows($res) {
820 $this->debug_check_recordset($res);
821 return mysql_num_rows($res);
822 }
823
824 /**
825 * Returns an associative array that corresponds to the fetched row, or FALSE if there are no more rows.
826 * mysql_fetch_assoc() wrapper function
827 * Usage count/core: 307
828 *
829 * @param pointer MySQL result pointer (of SELECT query) / DBAL object
830 * @return array Associative array of result row.
831 */
832 function sql_fetch_assoc($res) {
833 $this->debug_check_recordset($res);
834 return mysql_fetch_assoc($res);
835 }
836
837 /**
838 * Returns an array that corresponds to the fetched row, or FALSE if there are no more rows.
839 * The array contains the values in numerical indices.
840 * mysql_fetch_row() wrapper function
841 * Usage count/core: 56
842 *
843 * @param pointer MySQL result pointer (of SELECT query) / DBAL object
844 * @return array Array with result rows.
845 */
846 function sql_fetch_row($res) {
847 $this->debug_check_recordset($res);
848 return mysql_fetch_row($res);
849 }
850
851 /**
852 * Free result memory
853 * mysql_free_result() wrapper function
854 * Usage count/core: 3
855 *
856 * @param pointer MySQL result pointer to free / DBAL object
857 * @return boolean Returns TRUE on success or FALSE on failure.
858 */
859 function sql_free_result($res) {
860 $this->debug_check_recordset($res);
861 return mysql_free_result($res);
862 }
863
864 /**
865 * Get the ID generated from the previous INSERT operation
866 * mysql_insert_id() wrapper function
867 * Usage count/core: 13
868 *
869 * @return integer The uid of the last inserted record.
870 */
871 function sql_insert_id() {
872 return mysql_insert_id($this->link);
873 }
874
875 /**
876 * Returns the number of rows affected by the last INSERT, UPDATE or DELETE query
877 * mysql_affected_rows() wrapper function
878 * Usage count/core: 1
879 *
880 * @return integer Number of rows affected by last query
881 */
882 function sql_affected_rows() {
883 return mysql_affected_rows($this->link);
884 }
885
886 /**
887 * Move internal result pointer
888 * mysql_data_seek() wrapper function
889 * Usage count/core: 3
890 *
891 * @param pointer MySQL result pointer (of SELECT query) / DBAL object
892 * @param integer Seek result number.
893 * @return boolean Returns TRUE on success or FALSE on failure.
894 */
895 function sql_data_seek($res,$seek) {
896 $this->debug_check_recordset($res);
897 return mysql_data_seek($res,$seek);
898 }
899
900 /**
901 * Get the type of the specified field in a result
902 * mysql_field_type() wrapper function
903 * Usage count/core: 2
904 *
905 * @param pointer MySQL result pointer (of SELECT query) / DBAL object
906 * @param integer Field index.
907 * @return string Returns the name of the specified field index
908 */
909 function sql_field_type($res,$pointer) {
910 $this->debug_check_recordset($res);
911 return mysql_field_type($res,$pointer);
912 }
913
914 /**
915 * Open a (persistent) connection to a MySQL server
916 * mysql_pconnect() wrapper function
917 * Usage count/core: 12
918 *
919 * @param string Database host IP/domain
920 * @param string Username to connect with.
921 * @param string Password to connect with.
922 * @return pointer Returns a positive MySQL persistent link identifier on success, or FALSE on error.
923 */
924 function sql_pconnect($TYPO3_db_host, $TYPO3_db_username, $TYPO3_db_password) {
925 // mysql_error() is tied to an established connection
926 // if the connection fails we need a different method to get the error message
927 @ini_set('track_errors', 1);
928 @ini_set('html_errors', 0);
929
930 // Check for client compression
931 $isLocalhost = ($TYPO3_db_host == 'localhost' || $TYPO3_db_host == '127.0.0.1');
932 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['no_pconnect']) {
933 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['dbClientCompress'] && !$isLocalhost) {
934 // We use PHP's default value for 4th parameter (new_link), which is false.
935 // See PHP sources, for example: file php-5.2.5/ext/mysql/php_mysql.c, function php_mysql_do_connect(), near line 525
936 $this->link = @mysql_connect($TYPO3_db_host, $TYPO3_db_username, $TYPO3_db_password, false, MYSQL_CLIENT_COMPRESS);
937 } else {
938 $this->link = @mysql_connect($TYPO3_db_host, $TYPO3_db_username, $TYPO3_db_password);
939 }
940 } else {
941 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['dbClientCompress'] && !$isLocalhost) {
942 // See comment about 4th parameter in block above
943 $this->link = @mysql_pconnect($TYPO3_db_host, $TYPO3_db_username, $TYPO3_db_password, false, MYSQL_CLIENT_COMPRESS);
944 } else {
945 $this->link = @mysql_pconnect($TYPO3_db_host, $TYPO3_db_username, $TYPO3_db_password);
946 }
947 }
948
949 $error_msg = $php_errormsg;
950 @ini_restore('track_errors');
951 @ini_restore('html_errors');
952
953 if (!$this->link) {
954 t3lib_div::sysLog('Could not connect to MySQL server '.$TYPO3_db_host.' with user '.$TYPO3_db_username.': '.$error_msg,'Core',4);
955 } else {
956 $setDBinit = t3lib_div::trimExplode(chr(10), $GLOBALS['TYPO3_CONF_VARS']['SYS']['setDBinit'],TRUE);
957 foreach ($setDBinit as $v) {
958 if (mysql_query($v, $this->link) === FALSE) {
959 t3lib_div::sysLog('Could not initialize DB connection with query "'.$v.'": '.mysql_error($this->link),'Core',3);
960 }
961 }
962 }
963
964 return $this->link;
965 }
966
967 /**
968 * Select a MySQL database
969 * mysql_select_db() wrapper function
970 * Usage count/core: 8
971 *
972 * @param string Database to connect to.
973 * @return boolean Returns TRUE on success or FALSE on failure.
974 */
975 function sql_select_db($TYPO3_db) {
976 $ret = @mysql_select_db($TYPO3_db, $this->link);
977 if (!$ret) {
978 t3lib_div::sysLog('Could not select MySQL database '.$TYPO3_db.': '.mysql_error(),'Core',4);
979 }
980 return $ret;
981 }
982
983
984
985
986
987
988
989
990
991
992 /**************************************
993 *
994 * SQL admin functions
995 * (For use in the Install Tool and Extension Manager)
996 *
997 **************************************/
998
999 /**
1000 * Listing databases from current MySQL connection. NOTICE: It WILL try to select those databases and thus break selection of current database.
1001 * 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.
1002 * Use in Install Tool only!
1003 * Usage count/core: 1
1004 *
1005 * @return array Each entry represents a database name
1006 */
1007 function admin_get_dbs() {
1008 $dbArr = array();
1009 $db_list = mysql_list_dbs($this->link);
1010 while ($row = mysql_fetch_object($db_list)) {
1011 if ($this->sql_select_db($row->Database)) {
1012 $dbArr[] = $row->Database;
1013 }
1014 }
1015 return $dbArr;
1016 }
1017
1018 /**
1019 * Returns the list of tables from the default database, TYPO3_db (quering the DBMS)
1020 * 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
1021 * Usage count/core: 2
1022 *
1023 * @return array Array with tablenames as key and arrays with status information as value
1024 */
1025 function admin_get_tables() {
1026 $whichTables = array();
1027
1028 $tables_result = mysql_query('SHOW TABLE STATUS FROM `'.TYPO3_db.'`', $this->link);
1029 if (!mysql_error()) {
1030 while ($theTable = mysql_fetch_assoc($tables_result)) {
1031 $whichTables[$theTable['Name']] = $theTable;
1032 }
1033 }
1034
1035 return $whichTables;
1036 }
1037
1038 /**
1039 * Returns information about each field in the $table (quering the DBMS)
1040 * In a DBAL this should look up the right handler for the table and return compatible information
1041 * 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.
1042 *
1043 * @param string Table name
1044 * @return array Field information in an associative array with fieldname => field row
1045 */
1046 function admin_get_fields($tableName) {
1047 $output = array();
1048
1049 $columns_res = mysql_query('SHOW COLUMNS FROM `'.$tableName.'`', $this->link);
1050 while($fieldRow = mysql_fetch_assoc($columns_res)) {
1051 $output[$fieldRow['Field']] = $fieldRow;
1052 }
1053
1054 return $output;
1055 }
1056
1057 /**
1058 * Returns information about each index key in the $table (quering the DBMS)
1059 * In a DBAL this should look up the right handler for the table and return compatible information
1060 *
1061 * @param string Table name
1062 * @return array Key information in a numeric array
1063 */
1064 function admin_get_keys($tableName) {
1065 $output = array();
1066
1067 $keyRes = mysql_query('SHOW KEYS FROM `'.$tableName.'`', $this->link);
1068 while($keyRow = mysql_fetch_assoc($keyRes)) {
1069 $output[] = $keyRow;
1070 }
1071
1072 return $output;
1073 }
1074
1075 /**
1076 * Returns information about the character sets supported by the current DBM
1077 * 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.
1078 *
1079 * This is used by the Install Tool to convert tables tables with non-UTF8 charsets
1080 * Use in Install Tool only!
1081 *
1082 * @return array Array with Charset as key and an array of "Charset", "Description", "Default collation", "Maxlen" as values
1083 */
1084 function admin_get_charsets() {
1085 $output = array();
1086
1087 $columns_res = mysql_query('SHOW CHARACTER SET', $this->link);
1088 if ($columns_res) {
1089 while (($row = mysql_fetch_assoc($columns_res))) {
1090 $output[$row['Charset']] = $row;
1091 }
1092 }
1093
1094 return $output;
1095 }
1096
1097 /**
1098 * mysql() wrapper function, used by the Install Tool and EM for all queries regarding management of the database!
1099 * Usage count/core: 10
1100 *
1101 * @param string Query to execute
1102 * @return pointer Result pointer
1103 */
1104 function admin_query($query) {
1105 $res = mysql_query($query, $this->link);
1106 if ($this->debugOutput) $this->debug('admin_query',$query);
1107 return $res;
1108 }
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121 /******************************
1122 *
1123 * Connecting service
1124 *
1125 ******************************/
1126
1127 /**
1128 * Connects to database for TYPO3 sites:
1129 *
1130 * @return void
1131 */
1132 function connectDB() {
1133 if ($this->sql_pconnect(TYPO3_db_host, TYPO3_db_username, TYPO3_db_password)) {
1134 if (!TYPO3_db) {
1135 die('No database selected');
1136 exit;
1137 } elseif (!$this->sql_select_db(TYPO3_db)) {
1138 die('Cannot connect to the current database, "'.TYPO3_db.'"');
1139 exit;
1140 }
1141 } else {
1142 die('The current username, password or host was not accepted when the connection to the database was attempted to be established!');
1143 exit;
1144 }
1145 }
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158 /******************************
1159 *
1160 * Debugging
1161 *
1162 ******************************/
1163
1164 /**
1165 * Debug function: Outputs error if any
1166 *
1167 * @param string Function calling debug()
1168 * @param string Last query if not last built query
1169 * @return void
1170 */
1171 function debug($func, $query='') {
1172
1173 $error = $this->sql_error();
1174 if ($error) {
1175 debug(array(
1176 'caller' => 't3lib_DB::'.$func,
1177 'ERROR' => $error,
1178 'lastBuiltQuery' => ($query ? $query : $this->debug_lastBuiltQuery),
1179 'debug_backtrace' => t3lib_div::debug_trail()
1180 ), 'SQL debug');
1181 }
1182 }
1183
1184 /**
1185 * Checks if recordset is valid and writes debugging inormation into devLog if not.
1186 *
1187 * @param resource $res Recordset
1188 * @return boolean <code>false</code> if recordset is not valid
1189 */
1190 function debug_check_recordset($res) {
1191 if (!$res) {
1192 $trace = FALSE;
1193 $msg = 'Invalid database result resource detected';
1194 $trace = debug_backtrace();
1195 array_shift($trace);
1196 $cnt = count($trace);
1197 for ($i=0; $i<$cnt; $i++) {
1198 // complete objects are too large for the log
1199 if (isset($trace['object'])) unset($trace['object']);
1200 }
1201 $msg .= ': function t3lib_DB->' . $trace[0]['function'] . ' called from file ' . substr($trace[0]['file'],strlen(PATH_site)+2) . ' in line ' . $trace[0]['line'];
1202 t3lib_div::sysLog($msg.'. Use a devLog extension to get more details.', 'Core/t3lib_db', 3);
1203 // Send to devLog if enabled
1204 if (TYPO3_DLOG) {
1205 $debugLogData = array(
1206 'SQL Error' => $this->sql_error(),
1207 'Backtrace' => $trace,
1208 );
1209 if ($this->debug_lastBuiltQuery) {
1210 $debugLogData = array('SQL Query' => $this->debug_lastBuiltQuery) + $debugLogData;
1211 }
1212 t3lib_div::devLog($msg . '.', 'Core/t3lib_db', 3, $debugLogData);
1213 }
1214
1215 return FALSE;
1216 }
1217 return TRUE;
1218 }
1219
1220 /**
1221 * Explain select queries
1222 * If $this->explainOutput is set, SELECT queries will be explained here. Only queries with more than one possible result row will be displayed.
1223 * The output is either printed as raw HTML output or embedded into the TS admin panel (checkbox must be enabled!)
1224 *
1225 * TODO: Feature is not DBAL-compliant
1226 *
1227 * @param string SQL query
1228 * @param string Table(s) from which to select. This is what comes right after "FROM ...". Required value.
1229 * @param integer Number of resulting rows
1230 * @return boolean True if explain was run, false otherwise
1231 */
1232 protected function explain($query,$from_table,$row_count) {
1233
1234 if ((int)$this->explainOutput==1 || ((int)$this->explainOutput==2 && t3lib_div::cmpIP(t3lib_div::getIndpEnv('REMOTE_ADDR'), $GLOBALS['TYPO3_CONF_VARS']['SYS']['devIPmask']))) {
1235 $explainMode = 1; // raw HTML output
1236 } elseif ((int)$this->explainOutput==3 && is_object($GLOBALS['TT'])) {
1237 $explainMode = 2; // embed the output into the TS admin panel
1238 } else {
1239 return false;
1240 }
1241
1242 $error = $GLOBALS['TYPO3_DB']->sql_error();
1243 $trail = t3lib_div::debug_trail();
1244
1245 $explain_tables = array();
1246 $explain_output = array();
1247 $res = $this->sql_query('EXPLAIN '.$query, $this->link);
1248 if (is_resource($res)) {
1249 while ($tempRow = $this->sql_fetch_assoc($res)) {
1250 $explain_output[] = $tempRow;
1251 $explain_tables[] = $tempRow['table'];
1252 }
1253 $this->sql_free_result($res);
1254 }
1255
1256 $indices_output = array();
1257 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
1258 $debug = true; // only enable output if it's really useful
1259
1260 foreach ($explain_tables as $table) {
1261 $res = $this->sql_query('SHOW INDEX FROM '.$table, $this->link);
1262 if (is_resource($res)) {
1263 while ($tempRow = $this->sql_fetch_assoc($res)) {
1264 $indices_output[] = $tempRow;
1265 }
1266 $this->sql_free_result($res);
1267 }
1268 }
1269 } else {
1270 $debug = false;
1271 }
1272
1273 if ($debug) {
1274 if ($explainMode==1) {
1275 t3lib_div::debug('QUERY: '.$query);
1276 t3lib_div::debug(array('Debug trail:'=>$trail), 'Row count: '.$row_count);
1277
1278 if ($error) {
1279 t3lib_div::debug($error);
1280 }
1281 if (count($explain_output)) {
1282 t3lib_div::debug($explain_output);
1283 }
1284 if (count($indices_output)) {
1285 t3lib_div::debugRows($indices_output);
1286 }
1287
1288 } elseif ($explainMode==2) {
1289 $data = array();
1290 $data['query'] = $query;
1291 $data['trail'] = $trail;
1292 $data['row_count'] = $row_count;
1293
1294 if ($error) {
1295 $data['error'] = $error;
1296 }
1297 if (count($explain_output)) {
1298 $data['explain'] = $explain_output;
1299 }
1300 if (count($indices_output)) {
1301 $data['indices'] = $indices_output;
1302 }
1303 $GLOBALS['TT']->setTSselectQuery($data);
1304 }
1305 return true;
1306 }
1307
1308 return false;
1309 }
1310
1311 }
1312
1313
1314 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_db.php']) {
1315 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_db.php']);
1316 }
1317
1318 ?>