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