7c0591fb88a96007f58f989469bec3474104fbf6
[Packages/TYPO3.CMS.git] / typo3 / sysext / dbal / class.ux_t3lib_db.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2004-2009 Kasper Skaarhoj (kasperYYYY@typo3.com)
6 * (c) 2004-2009 Karsten Dambekalns <karsten@typo3.org>
7 * (c) 2009-2010 Xavier Perseguers <typo3@perseguers.ch>
8 * All rights reserved
9 *
10 * This script is part of the TYPO3 project. The TYPO3 project is
11 * free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * The GNU General Public License can be found at
17 * http://www.gnu.org/copyleft/gpl.html.
18 * A copy is found in the textfile GPL.txt and important notices to the license
19 * from the author is found in LICENSE.txt distributed with these scripts.
20 *
21 *
22 * This script is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
26 *
27 * This copyright notice MUST APPEAR in all copies of the script!
28 ***************************************************************/
29 /**
30 * Contains a database abstraction layer class for TYPO3
31 *
32 * $Id$
33 *
34 * @author Kasper Skaarhoj <kasper@typo3.com>
35 * @author Karsten Dambekalns <k.dambekalns@fishfarm.de>
36 * @author Xavier Perseguers <typo3@perseguers.ch>
37 */
38 /**
39 * [CLASS/FUNCTION INDEX of SCRIPT]
40 *
41 *
42 *
43 * 123: class ux_t3lib_DB extends t3lib_DB
44 * 169: function ux_t3lib_DB()
45 * 184: function initInternalVariables()
46 *
47 * SECTION: Query Building (Overriding parent methods)
48 * 217: function exec_INSERTquery($table,$fields_values)
49 * 275: function exec_UPDATEquery($table,$where,$fields_values)
50 * 334: function exec_DELETEquery($table,$where)
51 * 387: function exec_SELECTquery($select_fields,$from_table,$where_clause,$groupBy = '',$orderBy = '',$limit = '')
52 *
53 * SECTION: Creates an INSERT SQL-statement for $table from the array with field/value pairs $fields_values.
54 * 533: function SELECTquery($select_fields,$from_table,$where_clause,$groupBy = '',$orderBy = '',$limit = '')
55 * 556: function quoteSelectFields(&$select_fields)
56 * 573: function quoteFromTables(&$from_table)
57 * 595: function quoteWhereClause(&$where_clause)
58 * 620: function quoteGroupBy(&$groupBy)
59 * 637: function quoteOrderBy(&$orderBy)
60 *
61 * SECTION: Various helper functions
62 * 663: function quoteStr($str, $table)
63 *
64 * SECTION: SQL wrapper functions (Overriding parent methods)
65 * 707: function sql_error()
66 * 734: function sql_num_rows(&$res)
67 * 760: function sql_fetch_assoc(&$res)
68 * 808: function sql_fetch_row(&$res)
69 * 842: function sql_free_result(&$res)
70 * 868: function sql_insert_id()
71 * 893: function sql_affected_rows()
72 * 919: function sql_data_seek(&$res,$seek)
73 * 946: function sql_field_type(&$res,$pointer)
74 *
75 * SECTION: Legacy functions, bound to _DEFAULT handler. (Overriding parent methods)
76 * 987: function sql($db,$query)
77 * 999: function sql_query($query)
78 * 1035: function sql_pconnect($TYPO3_db_host, $TYPO3_db_username, $TYPO3_db_password)
79 * 1055: function sql_select_db($TYPO3_db)
80 *
81 * SECTION: SQL admin functions
82 * 1086: function admin_get_tables()
83 * 1149: function admin_get_fields($tableName)
84 * 1210: function admin_get_keys($tableName)
85 * 1270: function admin_query($query)
86 *
87 * SECTION: Handler management
88 * 1333: function handler_getFromTableList($tableList)
89 * 1379: function handler_init($handlerKey)
90 *
91 * SECTION: Table/Field mapping
92 * 1488: function map_needMapping($tableList,$fieldMappingOnly = FALSE)
93 * 1524: function map_assocArray($input,$tables,$rev = FALSE)
94 * 1573: function map_remapSELECTQueryParts(&$select_fields,&$from_table,&$where_clause,&$groupBy,&$orderBy)
95 * 1615: function map_sqlParts(&$sqlPartArray, $defaultTable)
96 * 1650: function map_genericQueryParsed(&$parsedQuery)
97 * 1717: function map_fieldNamesInArray($table,&$fieldArray)
98 *
99 * SECTION: Debugging
100 * 1758: function debugHandler($function,$execTime,$inData)
101 * 1823: function debug_log($query,$ms,$data,$join,$errorFlag)
102 * 1849: function debug_explain($query)
103 *
104 * TOTAL FUNCTIONS: 41
105 * (This index is automatically created/updated by the extension "extdeveval")
106 *
107 */
108 /**
109 * TYPO3 database abstraction layer
110 *
111 * @author Kasper Skaarhoj <kasper@typo3.com>
112 * @author Karsten Dambekalns <k.dambekalns@fishfarm.de>
113 * @package TYPO3
114 * @subpackage tx_dbal
115 */
116 class ux_t3lib_DB extends t3lib_DB {
117
118 // Internal, static:
119 var $printErrors = FALSE; // Enable output of SQL errors after query executions. Set through TYPO3_CONF_VARS, see init()
120 var $debug = FALSE; // Enable debug mode. Set through TYPO3_CONF_VARS, see init()
121 var $conf = array(); // Configuration array, copied from TYPO3_CONF_VARS in constructor.
122
123 var $mapping = array(); // See manual.
124 var $table2handlerKeys = array(); // See manual.
125 var $handlerCfg = array( // See manual.
126 '_DEFAULT' => array(
127 'type' => 'native',
128 'config' => array(
129 'username' => '', // Set by default (overridden)
130 'password' => '', // Set by default (overridden)
131 'host' => '', // Set by default (overridden)
132 'database' => '', // Set by default (overridden)
133 'driver' => '', // ONLY "adodb" type; eg. "mysql"
134 'sequenceStart' => 1, // ONLY "adodb", first number in sequences/serials/...
135 'useNameQuote' => 0 // ONLY "adodb", whether to use NameQuote() method from ADOdb to quote names
136 )
137 ),
138 );
139
140
141 // Internal, dynamic:
142 var $handlerInstance = array(); // Contains instance of the handler objects as they are created. Exception is the native mySQL calls which are registered as an array with keys "handlerType" = "native" and "link" pointing to the link resource for the connection.
143 var $lastHandlerKey = ''; // Storage of the handler key of last ( SELECT) query - used for subsequent fetch-row calls etc.
144 var $lastQuery = ''; // Storage of last SELECT query
145 var $lastParsedAndMappedQueryArray = array(); // Query array, the last one parsed
146
147 var $resourceIdToTableNameMap = array(); // Mapping of resource ids to table names.
148
149 // Internal, caching:
150 var $cache_handlerKeyFromTableList = array(); // Caching handlerKeys for table lists
151 var $cache_mappingFromTableList = array(); // Caching mapping information for table lists
152 var $cache_autoIncFields = array(); // parsed SQL from standard DB dump file
153 var $cache_fieldType = array(); // field types for tables/fields
154 var $cache_primaryKeys = array(); // primary keys
155
156 /**
157 * SQL parser
158 *
159 * @var tx_dbal_sqlengine
160 */
161 var $SQLparser;
162
163 /**
164 * Installer
165 *
166 * @var t3lib_install
167 */
168 var $Installer;
169
170
171 /**
172 * Constructor.
173 * Creates SQL parser object and imports configuration from $TYPO3_CONF_VARS['EXTCONF']['dbal']
174 */
175 public function __construct() {
176 // Set SQL parser object for internal use:
177 $this->SQLparser = t3lib_div::makeInstance('tx_dbal_sqlengine');
178 $this->Installer = t3lib_div::makeInstance('t3lib_install');
179
180 // Set internal variables with configuration:
181 $this->conf = $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['dbal'];
182 $this->initInternalVariables();
183 }
184
185 /**
186 * Setting internal variables from $this->conf.
187 *
188 * @return void
189 */
190 protected function initInternalVariables() {
191 // Set outside configuration:
192 if (isset($this->conf['mapping'])) {
193 $this->mapping = $this->conf['mapping'];
194 }
195 if (isset($this->conf['table2handlerKeys'])) {
196 $this->table2handlerKeys = $this->conf['table2handlerKeys'];
197 }
198 if (isset($this->conf['handlerCfg'])) {
199 $this->handlerCfg = $this->conf['handlerCfg'];
200 }
201
202 $this->cacheFieldInfo();
203 // Debugging settings:
204 $this->printErrors = $this->conf['debugOptions']['printErrors'] ? TRUE : FALSE;
205 $this->debug = $this->conf['debugOptions']['enabled'] ? TRUE : FALSE;
206 }
207
208 /**
209 * Clears the cached field information file.
210 *
211 * @return void
212 */
213 public function clearCachedFieldInfo() {
214 if (file_exists(PATH_typo3conf . 'temp_fieldInfo.php')) {
215 unlink(PATH_typo3conf . 'temp_fieldInfo.php');
216 }
217 }
218
219 /**
220 * Caches the field information.
221 *
222 * @return void
223 */
224 public function cacheFieldInfo() {
225 $extSQL = '';
226 $parsedExtSQL = array();
227
228 // try to fetch cached file first
229 // file is removed when admin_query() is called
230 if (file_exists(PATH_typo3conf . 'temp_fieldInfo.php')) {
231 $fdata = unserialize(t3lib_div::getUrl(PATH_typo3conf . 'temp_fieldInfo.php'));
232 $this->cache_autoIncFields = $fdata['incFields'];
233 $this->cache_fieldType = $fdata['fieldTypes'];
234 $this->cache_primaryKeys = $fdata['primaryKeys'];
235 } else {
236 // handle stddb.sql, parse and analyze
237 $extSQL = t3lib_div::getUrl(PATH_site . 't3lib/stddb/tables.sql');
238 $parsedExtSQL = $this->Installer->getFieldDefinitions_fileContent($extSQL);
239 $this->analyzeFields($parsedExtSQL);
240
241 // loop over all installed extensions
242 foreach ($GLOBALS['TYPO3_LOADED_EXT'] as $ext => $v) {
243 if (!is_array($v) || !isset($v['ext_tables.sql'])) {
244 continue;
245 }
246
247 // fetch db dump (if any) and parse it, then analyze
248 $extSQL = t3lib_div::getUrl($v['ext_tables.sql']);
249 $parsedExtSQL = $this->Installer->getFieldDefinitions_fileContent($extSQL);
250 $this->analyzeFields($parsedExtSQL);
251 }
252
253 $cachedFieldInfo = array('incFields' => $this->cache_autoIncFields, 'fieldTypes' => $this->cache_fieldType, 'primaryKeys' => $this->cache_primaryKeys);
254 $cachedFieldInfo = serialize($this->mapCachedFieldInfo($cachedFieldInfo));
255
256 // write serialized content to file
257 t3lib_div::writeFile(PATH_typo3conf . 'temp_fieldInfo.php', $cachedFieldInfo);
258
259 if (strcmp(t3lib_div::getUrl(PATH_typo3conf . 'temp_fieldInfo.php'), $cachedFieldInfo)) {
260 die('typo3temp/temp_incfields.php was NOT updated properly (written content didn\'t match file content) - maybe write access problem?');
261 }
262 }
263 }
264
265 /**
266 * Analyzes fields and adds the extracted information to the field type, auto increment and primary key info caches.
267 *
268 * @param array $parsedExtSQL The output produced by t3lib_install::getFieldDefinitions_fileContent()
269 * @return void
270 * @see t3lib_install::getFieldDefinitions_fileContent()
271 */
272 protected function analyzeFields($parsedExtSQL) {
273 foreach ($parsedExtSQL as $table => $tdef) {
274 if (is_array($tdef['fields'])) {
275 foreach ($tdef['fields'] as $field => $fdef) {
276 $fdef = $this->SQLparser->parseFieldDef($fdef);
277 $this->cache_fieldType[$table][$field]['type'] = $fdef['fieldType'];
278 $this->cache_fieldType[$table][$field]['metaType'] = $this->MySQLMetaType($fdef['fieldType']);
279 $this->cache_fieldType[$table][$field]['notnull'] = (isset($fdef['featureIndex']['NOTNULL']) && !$this->SQLparser->checkEmptyDefaultValue($fdef['featureIndex'])) ? 1 : 0;
280 if (isset($fdef['featureIndex']['DEFAULT'])) {
281 $default = $fdef['featureIndex']['DEFAULT']['value'][0];
282 if (isset($fdef['featureIndex']['DEFAULT']['value'][1])) {
283 $default = $fdef['featureIndex']['DEFAULT']['value'][1] . $default . $fdef['featureIndex']['DEFAULT']['value'][1];
284 }
285 $this->cache_fieldType[$table][$field]['default'] = $default;
286 }
287 if (isset($fdef['featureIndex']['AUTO_INCREMENT'])) {
288 $this->cache_autoIncFields[$table] = $field;
289 }
290 if (isset($tdef['keys']['PRIMARY'])) {
291 $this->cache_primaryKeys[$table] = substr($tdef['keys']['PRIMARY'], 13, -1);
292 }
293 }
294 }
295 }
296 }
297
298 /**
299 * This function builds all definitions for mapped tables and fields
300 * @see cacheFieldInfo()
301 */
302 protected function mapCachedFieldInfo($fieldInfo) {
303 if (is_array($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['dbal']['mapping'])) {
304 foreach ($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['dbal']['mapping'] as $mappedTable => $mappedConf) {
305 if (array_key_exists($mappedTable, $fieldInfo['incFields'])) {
306 $mappedTableAlias = $mappedConf['mapTableName'];
307 if (isset($mappedConf['mapFieldNames'][$fieldInfo['incFields'][$mappedTable]])) {
308 $fieldInfo['incFields'][$mappedTableAlias] = $mappedConf['mapFieldNames'][$fieldInfo['incFields'][$mappedTable]];
309 } else {
310 $fieldInfo['incFields'][$mappedTableAlias] = $fieldInfo['incFields'][$mappedTable];
311 }
312 }
313
314 if (array_key_exists($mappedTable, $fieldInfo['fieldTypes'])) {
315 foreach ($fieldInfo['fieldTypes'][$mappedTable] as $field => $fieldConf) {
316 $tempMappedFieldConf[$mappedConf['mapFieldNames'][$field]] = $fieldConf;
317 }
318
319 $fieldInfo['fieldTypes'][$mappedConf['mapTableName']] = $tempMappedFieldConf;
320 }
321
322 if (array_key_exists($mappedTable, $fieldInfo['primaryKeys'])) {
323 $mappedTableAlias = $mappedConf['mapTableName'];
324 if (isset($mappedConf['mapFieldNames'][$fieldInfo['primaryKeys'][$mappedTable]])) {
325 $fieldInfo['primaryKeys'][$mappedTableAlias] = $mappedConf['mapFieldNames'][$fieldInfo['primaryKeys'][$mappedTable]];
326 } else {
327 $fieldInfo['primaryKeys'][$mappedTableAlias] = $fieldInfo['primaryKeys'][$mappedTable];
328 }
329 }
330 }
331 }
332
333 return $fieldInfo;
334 }
335
336
337 /************************************
338 *
339 * Query Building (Overriding parent methods)
340 * These functions are extending counterparts in the parent class.
341 *
342 **************************************/
343
344 /* From the ADOdb documentation, this is what we do (_Execute for SELECT, _query for the other actions)
345
346 Execute() is the default way to run queries. You can use the low-level functions _Execute() and _query() to reduce query overhead.
347 Both these functions share the same parameters as Execute().
348
349 If you do not have any bind parameters or your database supports binding (without emulation), then you can call _Execute() directly.
350 Calling this function bypasses bind emulation. Debugging is still supported in _Execute().
351
352 If you do not require debugging facilities nor emulated binding, and do not require a recordset to be returned, then you can call _query.
353 This is great for inserts, updates and deletes. Calling this function bypasses emulated binding, debugging, and recordset handling. Either
354 the resultid, TRUE or FALSE are returned by _query().
355 */
356
357 /**
358 * Inserts a record for $table from the array with field/value pairs $fields_values.
359 *
360 * @param string Table name
361 * @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.
362 * @param mixed List/array of keys NOT to quote (eg. SQL functions)
363 * @return mixed Result from handler, usually TRUE when success and FALSE on failure
364 */
365 public function exec_INSERTquery($table, $fields_values, $no_quote_fields = '') {
366
367 if ($this->debug) {
368 $pt = t3lib_div::milliseconds();
369 }
370
371 // Do field mapping if needed:
372 $ORIG_tableName = $table;
373 if ($tableArray = $this->map_needMapping($table)) {
374
375 // Field mapping of array:
376 $fields_values = $this->map_assocArray($fields_values, $tableArray);
377
378 // Table name:
379 if ($this->mapping[$table]['mapTableName']) {
380 $table = $this->mapping[$table]['mapTableName'];
381 }
382 }
383 // Select API:
384 $this->lastHandlerKey = $this->handler_getFromTableList($ORIG_tableName);
385 switch ((string)$this->handlerCfg[$this->lastHandlerKey]['type']) {
386 case 'native':
387 $this->lastQuery = $this->INSERTquery($table,$fields_values,$no_quote_fields);
388 if (is_string($this->lastQuery)) {
389 $sqlResult = mysql_query($this->lastQuery, $this->handlerInstance[$this->lastHandlerKey]['link']);
390 } else {
391 $sqlResult = mysql_query($this->lastQuery[0], $this->handlerInstance[$this->lastHandlerKey]['link']);
392 foreach ($this->lastQuery[1] as $field => $content) {
393 mysql_query('UPDATE ' . $this->quoteFromTables($table) . ' SET ' . $this->quoteFromTables($field) . '=' . $this->fullQuoteStr($content, $table) . ' WHERE ' . $this->quoteWhereClause($where), $this->handlerInstance[$this->lastHandlerKey]['link']);
394 }
395 }
396 break;
397 case 'adodb':
398 // auto generate ID for auto_increment fields if not present (static import needs this!)
399 // should we check the table name here (static_*)?
400 if (isset($this->cache_autoIncFields[$table])) {
401 if (isset($fields_values[$this->cache_autoIncFields[$table]])) {
402 $new_id = $fields_values[$this->cache_autoIncFields[$table]];
403 if ($table != 'tx_dbal_debuglog') {
404 $this->handlerInstance[$this->lastHandlerKey]->last_insert_id = $new_id;
405 }
406 } else {
407 $new_id = $this->handlerInstance[$this->lastHandlerKey]->GenID($table.'_'.$this->cache_autoIncFields[$table], $this->handlerInstance[$this->lastHandlerKey]->sequenceStart);
408 $fields_values[$this->cache_autoIncFields[$table]] = $new_id;
409 if ($table != 'tx_dbal_debuglog') {
410 $this->handlerInstance[$this->lastHandlerKey]->last_insert_id = $new_id;
411 }
412 }
413 }
414
415 $this->lastQuery = $this->INSERTquery($table,$fields_values,$no_quote_fields);
416 if (is_string($this->lastQuery)) {
417 $sqlResult = $this->handlerInstance[$this->lastHandlerKey]->_query($this->lastQuery,FALSE);
418 } else {
419 $this->handlerInstance[$this->lastHandlerKey]->StartTrans();
420 if (strlen($this->lastQuery[0])) {
421 $sqlResult = $this->handlerInstance[$this->lastHandlerKey]->_query($this->lastQuery[0],FALSE);
422 }
423 if (is_array($this->lastQuery[1])) {
424 foreach ($this->lastQuery[1] as $field => $content) {
425 if (empty($content)) continue;
426
427 if (isset($this->cache_autoIncFields[$table]) && isset($new_id)) {
428 $this->handlerInstance[$this->lastHandlerKey]->UpdateBlob($this->quoteFromTables($table),$field,$content,$this->quoteWhereClause($this->cache_autoIncFields[$table].'='.$new_id));
429 } elseif (isset($this->cache_primaryKeys[$table])) {
430 $where = '';
431 $pks = explode(',', $this->cache_primaryKeys[$table]);
432 foreach ($pks as $pk) {
433 if (isset($fields_values[$pk]))
434 $where .= $pk.'='.$this->fullQuoteStr($fields_values[$pk], $table).' AND ';
435 }
436 $where = $this->quoteWhereClause($where.'1=1');
437 $this->handlerInstance[$this->lastHandlerKey]->UpdateBlob($this->quoteFromTables($table),$field,$content,$where);
438 } else {
439 $this->handlerInstance[$this->lastHandlerKey]->CompleteTrans(FALSE);
440 die('Could not update BLOB >>>> no WHERE clause found!'); // should never ever happen
441 }
442 }
443 }
444 if (is_array($this->lastQuery[2])) {
445 foreach ($this->lastQuery[2] as $field => $content) {
446 if (empty($content)) continue;
447
448 if (isset($this->cache_autoIncFields[$table]) && isset($new_id)) {
449 $this->handlerInstance[$this->lastHandlerKey]->UpdateClob($this->quoteFromTables($table),$field,$content,$this->quoteWhereClause($this->cache_autoIncFields[$table].'='.$new_id));
450 } elseif (isset($this->cache_primaryKeys[$table])) {
451 $where = '';
452 $pks = explode(',', $this->cache_primaryKeys[$table]);
453 foreach ($pks as $pk) {
454 if (isset($fields_values[$pk]))
455 $where .= $pk.'='.$this->fullQuoteStr($fields_values[$pk], $table).' AND ';
456 }
457 $where = $this->quoteWhereClause($where.'1=1');
458 $this->handlerInstance[$this->lastHandlerKey]->UpdateClob($this->quoteFromTables($table),$field,$content,$where);
459 } else {
460 $this->handlerInstance[$this->lastHandlerKey]->CompleteTrans(FALSE);
461 die('Could not update CLOB >>>> no WHERE clause found!'); // should never ever happen
462 }
463 }
464 }
465 $this->handlerInstance[$this->lastHandlerKey]->CompleteTrans();
466 }
467 break;
468 case 'userdefined':
469 $sqlResult = $this->handlerInstance[$this->lastHandlerKey]->exec_INSERTquery($table,$fields_values,$no_quote_fields);
470 break;
471 }
472
473 if ($this->printErrors && $this->sql_error()) {
474 debug(array($this->lastQuery, $this->sql_error()));
475 }
476
477 if ($this->debug) {
478 $this->debugHandler(
479 'exec_INSERTquery',
480 t3lib_div::milliseconds()-$pt,
481 array(
482 'handlerType' => $hType,
483 'args' => array($table,$fields_values),
484 'ORIG_tablename' => $ORIG_tableName
485 )
486 );
487 }
488 // Return output:
489 return $sqlResult;
490 }
491
492 /**
493 * Creates and executes an INSERT SQL-statement for $table with multiple rows.
494 * This method uses exec_INSERTquery() and is just a syntax wrapper to it.
495 *
496 * @param string Table name
497 * @param array Field names
498 * @param array Table rows. Each row should be an array with field values mapping to $fields
499 * @param string/array See fullQuoteArray()
500 * @return mixed Result from last handler, usually TRUE when success and FALSE on failure
501 */
502 public function exec_INSERTmultipleRows($table, array $fields, array $rows, $no_quote_fields = FALSE) {
503 if ((string)$this->handlerCfg[$this->lastHandlerKey]['type'] === 'native') {
504 return parent::exec_INSERTmultipleRows($table, $fields, $rows, $no_quote_fields);
505 }
506
507 foreach ($rows as $row) {
508 $fields_values = array();
509 foreach ($fields as $key => $value) {
510 $fields_values[$value] = $row[$key];
511 }
512 $res = $this->exec_INSERTquery($table, $fields_values, $no_quote_fields);
513 }
514
515 return $res;
516 }
517
518 /**
519 * Updates a record from $table
520 *
521 * @param string Database tablename
522 * @param string WHERE clause, eg. "uid=1". NOTICE: You must escape values in this argument with $this->fullQuoteStr() yourself!
523 * @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.
524 * @param mixed List/array of keys NOT to quote (eg. SQL functions)
525 * @return mixed Result from handler, usually TRUE when success and FALSE on failure
526 */
527 public function exec_UPDATEquery($table,$where,$fields_values,$no_quote_fields = '') {
528 if ($this->debug) {
529 $pt = t3lib_div::milliseconds();
530 }
531
532 // Do table/field mapping:
533 $ORIG_tableName = $table;
534 if ($tableArray = $this->map_needMapping($table)) {
535
536 // Field mapping of array:
537 $fields_values = $this->map_assocArray($fields_values,$tableArray);
538
539 // Where clause table and field mapping:
540 $whereParts = $this->SQLparser->parseWhereClause($where);
541 $this->map_sqlParts($whereParts,$tableArray[0]['table']);
542 $where = $this->SQLparser->compileWhereClause($whereParts, FALSE);
543
544 // Table name:
545 if ($this->mapping[$table]['mapTableName']) {
546 $table = $this->mapping[$table]['mapTableName'];
547 }
548 }
549
550 // Select API
551 $this->lastHandlerKey = $this->handler_getFromTableList($ORIG_tableName);
552 switch ((string)$this->handlerCfg[$this->lastHandlerKey]['type']) {
553 case 'native':
554 $this->lastQuery = $this->UPDATEquery($table,$where,$fields_values,$no_quote_fields);
555 if (is_string($this->lastQuery)) {
556 $sqlResult = mysql_query($this->lastQuery, $this->handlerInstance[$this->lastHandlerKey]['link']);
557 }
558 else {
559 $sqlResult = mysql_query($this->lastQuery[0], $this->handlerInstance[$this->lastHandlerKey]['link']);
560 foreach ($this->lastQuery[1] as $field => $content) {
561 mysql_query('UPDATE '.$this->quoteFromTables($table).' SET '.$this->quoteFromTables($field).'='.$this->fullQuoteStr($content,$table).' WHERE '.$this->quoteWhereClause($where), $this->handlerInstance[$this->lastHandlerKey]['link']);
562 }
563 }
564 break;
565 case 'adodb':
566 $this->lastQuery = $this->UPDATEquery($table,$where,$fields_values,$no_quote_fields);
567 if (is_string($this->lastQuery)) {
568 $sqlResult = $this->handlerInstance[$this->lastHandlerKey]->_query($this->lastQuery,FALSE);
569 } else {
570 $this->handlerInstance[$this->lastHandlerKey]->StartTrans();
571 if (strlen($this->lastQuery[0])) {
572 $sqlResult = $this->handlerInstance[$this->lastHandlerKey]->_query($this->lastQuery[0],FALSE);
573 }
574 if (is_array($this->lastQuery[1])) {
575 foreach ($this->lastQuery[1] as $field => $content) {
576 $this->handlerInstance[$this->lastHandlerKey]->UpdateBlob($this->quoteFromTables($table),$field,$content,$this->quoteWhereClause($where));
577 }
578 }
579 if (is_array($this->lastQuery[2])) {
580 foreach ($this->lastQuery[2] as $field => $content) {
581 $this->handlerInstance[$this->lastHandlerKey]->UpdateClob($this->quoteFromTables($table),$field,$content,$this->quoteWhereClause($where));
582 }
583 }
584 $this->handlerInstance[$this->lastHandlerKey]->CompleteTrans();
585 }
586 break;
587 case 'userdefined':
588 $sqlResult = $this->handlerInstance[$this->lastHandlerKey]->exec_UPDATEquery($table,$where,$fields_values,$no_quote_fields);
589 break;
590 }
591
592 if ($this->printErrors && $this->sql_error()) {
593 debug(array($this->lastQuery, $this->sql_error()));
594 }
595
596 if ($this->debug) {
597 $this->debugHandler(
598 'exec_UPDATEquery',
599 t3lib_div::milliseconds()-$pt,
600 array(
601 'handlerType' => $hType,
602 'args' => array($table,$where, $fields_values),
603 'ORIG_from_table' => $ORIG_tableName
604 )
605 );
606 }
607
608 // Return result:
609 return $sqlResult;
610 }
611
612 /**
613 * Deletes records from table
614 *
615 * @param string Database tablename
616 * @param string WHERE clause, eg. "uid=1". NOTICE: You must escape values in this argument with $this->fullQuoteStr() yourself!
617 * @return mixed Result from handler
618 */
619 public function exec_DELETEquery($table, $where) {
620 if ($this->debug) {
621 $pt = t3lib_div::milliseconds();
622 }
623
624 // Do table/field mapping:
625 $ORIG_tableName = $table;
626 if ($tableArray = $this->map_needMapping($table)) {
627
628 // Where clause:
629 $whereParts = $this->SQLparser->parseWhereClause($where);
630 $this->map_sqlParts($whereParts,$tableArray[0]['table']);
631 $where = $this->SQLparser->compileWhereClause($whereParts, FALSE);
632
633 // Table name:
634 if ($this->mapping[$table]['mapTableName']) {
635 $table = $this->mapping[$table]['mapTableName'];
636 }
637 }
638
639 // Select API
640 $this->lastHandlerKey = $this->handler_getFromTableList($ORIG_tableName);
641 switch ((string)$this->handlerCfg[$this->lastHandlerKey]['type']) {
642 case 'native':
643 $this->lastQuery = $this->DELETEquery($table,$where);
644 $sqlResult = mysql_query($this->lastQuery, $this->handlerInstance[$this->lastHandlerKey]['link']);
645 break;
646 case 'adodb':
647 $this->lastQuery = $this->DELETEquery($table,$where);
648 $sqlResult = $this->handlerInstance[$this->lastHandlerKey]->_query($this->lastQuery,FALSE);
649 break;
650 case 'userdefined':
651 $sqlResult = $this->handlerInstance[$this->lastHandlerKey]->exec_DELETEquery($table,$where);
652 break;
653 }
654
655 if ($this->printErrors && $this->sql_error()) {
656 debug(array($this->lastQuery, $this->sql_error()));
657 }
658
659 if ($this->debug) {
660 $this->debugHandler(
661 'exec_DELETEquery',
662 t3lib_div::milliseconds()-$pt,
663 array(
664 'handlerType' => $hType,
665 'args' => array($table,$where),
666 'ORIG_from_table' => $ORIG_tableName
667 )
668 );
669 }
670
671 // Return result:
672 return $sqlResult;
673 }
674
675 /**
676 * Selects records from Data Source
677 *
678 * @param string $select_fields List of fields to select from the table. This is what comes right after "SELECT ...". Required value.
679 * @param string $from_table Table(s) from which to select. This is what comes right after "FROM ...". Required value.
680 * @param string $where_clause Optional additional WHERE clauses put in the end of the query. NOTICE: You must escape values in this argument with $this->fullQquoteStr() yourself! DO NOT PUT IN GROUP BY, ORDER BY or LIMIT!
681 * @param string $groupBy Optional GROUP BY field(s), if none, supply blank string.
682 * @param string $orderBy Optional ORDER BY field(s), if none, supply blank string.
683 * @param string $limit Optional LIMIT value ([begin,]max), if none, supply blank string.
684 * @return mixed Result from handler. Typically object from DBAL layers.
685 */
686 public function exec_SELECTquery($select_fields, $from_table, $where_clause, $groupBy = '', $orderBy = '', $limit = '') {
687 if ($this->debug) {
688 $pt = t3lib_div::milliseconds();
689 }
690
691 // Map table / field names if needed:
692 $ORIG_tableName = $from_table; // Saving table names in $ORIG_from_table since $from_table is transformed beneath:
693 if ($tableArray = $this->map_needMapping($ORIG_tableName)) {
694 $this->map_remapSELECTQueryParts($select_fields,$from_table,$where_clause,$groupBy,$orderBy); // Variables passed by reference!
695 }
696
697 // Get handler key and select API:
698 $this->lastHandlerKey = $this->handler_getFromTableList($ORIG_tableName);
699 $hType = (string)$this->handlerCfg[$this->lastHandlerKey]['type'];
700 switch ($hType) {
701 case 'native':
702 $this->lastQuery = $this->SELECTquery($select_fields,$from_table,$where_clause,$groupBy,$orderBy,$limit);
703 $sqlResult = mysql_query($this->lastQuery, $this->handlerInstance[$this->lastHandlerKey]['link']);
704 $this->resourceIdToTableNameMap[(string)$sqlResult] = $ORIG_tableName;
705 break;
706 case 'adodb':
707 if ($limit != '') {
708 $splitLimit = t3lib_div::intExplode(',', $limit); // Splitting the limit values:
709 if ($splitLimit[1]) { // If there are two parameters, do mapping differently than otherwise:
710 $numrows = $splitLimit[1];
711 $offset = $splitLimit[0];
712 } else {
713 $numrows = $splitLimit[0];
714 $offset = 0;
715 }
716
717 $sqlResult = $this->handlerInstance[$this->lastHandlerKey]->SelectLimit($this->SELECTquery($select_fields,$from_table,$where_clause,$groupBy,$orderBy), $numrows, $offset);
718 $this->lastQuery = $sqlResult->sql;
719 } else {
720 $this->lastQuery = $this->SELECTquery($select_fields,$from_table,$where_clause,$groupBy,$orderBy);
721 $sqlResult = $this->handlerInstance[$this->lastHandlerKey]->_Execute($this->lastQuery);
722 }
723
724 $sqlResult->TYPO3_DBAL_handlerType = 'adodb'; // Setting handler type in result object (for later recognition!)
725 $sqlResult->TYPO3_DBAL_tableList = $ORIG_tableName;
726 break;
727 case 'userdefined':
728 $sqlResult = $this->handlerInstance[$this->lastHandlerKey]->exec_SELECTquery($select_fields,$from_table,$where_clause,$groupBy,$orderBy,$limit);
729 if (is_object($sqlResult)) {
730 $sqlResult->TYPO3_DBAL_handlerType = 'userdefined'; // Setting handler type in result object (for later recognition!)
731 $sqlResult->TYPO3_DBAL_tableList = $ORIG_tableName;
732 }
733 break;
734 }
735
736 if ($this->printErrors && $this->sql_error()) {
737 debug(array($this->lastQuery, $this->sql_error()));
738 }
739
740 if ($this->debug) {
741 $this->debugHandler(
742 'exec_SELECTquery',
743 t3lib_div::milliseconds()-$pt,
744 array(
745 'handlerType' => $hType,
746 'args' => array($from_table,$select_fields,$where_clause,$groupBy,$orderBy,$limit),
747 'ORIG_from_table' => $ORIG_tableName
748 )
749 );
750 }
751
752 // Return result handler.
753 return $sqlResult;
754 }
755
756 /**
757 * Truncates a table.
758 *
759 * @param string Database tablename
760 * @return mixed Result from handler
761 */
762 public function exec_TRUNCATEquery($table) {
763 if ($this->debug) {
764 $pt = t3lib_div::milliseconds();
765 }
766
767 // Do table/field mapping:
768 $ORIG_tableName = $table;
769 if ($tableArray = $this->map_needMapping($table)) {
770 // Table name:
771 if ($this->mapping[$table]['mapTableName']) {
772 $table = $this->mapping[$table]['mapTableName'];
773 }
774 }
775
776 // Select API
777 $this->lastHandlerKey = $this->handler_getFromTableList($ORIG_tableName);
778 switch ((string)$this->handlerCfg[$this->lastHandlerKey]['type']) {
779 case 'native':
780 $this->lastQuery = $this->TRUNCATEquery($table);
781 $sqlResult = mysql_query($this->lastQuery, $this->handlerInstance[$this->lastHandlerKey]['link']);
782 break;
783 case 'adodb':
784 $this->lastQuery = $this->TRUNCATEquery($table);
785 $sqlResult = $this->handlerInstance[$this->lastHandlerKey]->_query($this->lastQuery, FALSE);
786 break;
787 case 'userdefined':
788 $sqlResult = $this->handlerInstance[$this->lastHandlerKey]->exec_TRUNCATEquery($table,$where);
789 break;
790 }
791
792 if ($this->printErrors && $this->sql_error()) {
793 debug(array($this->lastQuery, $this->sql_error()));
794 }
795
796 if ($this->debug) {
797 $this->debugHandler(
798 'exec_TRUNCATEquery',
799 t3lib_div::milliseconds() - $pt,
800 array(
801 'handlerType' => $hType,
802 'args' => array($table),
803 'ORIG_from_table' => $ORIG_tableName
804 )
805 );
806 }
807
808 // Return result:
809 return $sqlResult;
810 }
811
812 /**
813 * Executes a query.
814 * EXPERIMENTAL since TYPO3 4.4.
815 *
816 * @param array $queryParts SQL parsed by method parseSQL() of t3lib_sqlparser
817 * @return pointer Result pointer / DBAL object
818 * @see ux_t3lib_db::sql_query()
819 */
820 protected function exec_query(array $queryParts) {
821 switch ($queryParts['type']) {
822 case 'SELECT':
823 $selectFields = $this->SQLparser->compileFieldList($queryParts['SELECT']);
824 $fromTables = $this->SQLparser->compileFromTables($queryParts['FROM']);
825 $whereClause = isset($queryParts['WHERE']) ? $this->SQLparser->compileWhereClause($queryParts['WHERE']) : '1=1';
826 $groupBy = isset($queryParts['GROUPBY']) ? $this->SQLparser->compileWhereClause($queryParts['GROUPBY']) : '';
827 $orderBy = isset($queryParts['GROUPBY']) ? $this->SQLparser->compileWhereClause($queryParts['ORDERBY']) : '';
828 $limit = isset($queryParts['LIMIT']) ? $this->SQLparser->compileWhereClause($queryParts['LIMIT']) : '';
829 return $this->exec_SELECTquery($selectFields, $fromTables, $whereClause, $groupBy, $orderBy, $limit);
830
831 case 'UPDATE':
832 $table = $queryParts['TABLE'];
833 $fields = array();
834 foreach ($components['FIELDS'] as $fN => $fV) {
835 $fields[$fN] = $fV[0];
836 }
837 $whereClause = isset($queryParts['WHERE']) ? $this->SQLparser->compileWhereClause($queryParts['WHERE']) : '1=1';
838 return $this->exec_UPDATEquery($table, $whereClause, $fields);
839
840 case 'INSERT':
841 $table = $queryParts['TABLE'];
842 $values = array();
843 if (isset($queryParts['VALUES_ONLY']) && is_array($queryParts['VALUES_ONLY'])) {
844 $fields = $GLOBALS['TYPO3_DB']->cache_fieldType[$table];
845 $fc = 0;
846 foreach ($fields as $fn => $fd) {
847 $values[$fn] = $queryParts['VALUES_ONLY'][$fc++][0];
848 }
849 } else {
850 foreach ($queryParts['FIELDS'] as $fN => $fV) {
851 $values[$fN] = $fV[0];
852 }
853 }
854 return $this->exec_INSERTquery($table, $values);
855
856 case 'DELETE':
857 $table = $queryParts['TABLE'];
858 $whereClause = isset($queryParts['WHERE']) ? $this->SQLparser->compileWhereClause($queryParts['WHERE']) : '1=1';
859 return $this->exec_DELETEquery($table, $whereClause);
860
861 case 'TRUNCATETABLE':
862 $table = $queryParts['TABLE'];
863 return $this->exec_TRUNCATEquery($table);
864 }
865 }
866
867
868
869 /**************************************
870 *
871 * Query building
872 *
873 **************************************/
874
875 /**
876 * Creates an INSERT SQL-statement for $table from the array with field/value pairs $fields_values.
877 * Usage count/core: 4
878 *
879 * @param string See exec_INSERTquery()
880 * @param array See exec_INSERTquery()
881 * @param mixed See exec_INSERTquery()
882 * @return mixed Full SQL query for INSERT as string or array (unless $fields_values does not contain any elements in which case it will be FALSE). If BLOB fields will be affected and one is not running the native type, an array will be returned, where 0 => plain SQL, 1 => fieldname/value pairs of BLOB fields
883 */
884 public function INSERTquery($table, $fields_values, $no_quote_fields = '') {
885 // Table and fieldnames should be "SQL-injection-safe" when supplied to this function (contrary to values in the arrays which may be insecure).
886 if (is_array($fields_values) && count($fields_values)) {
887
888 if (is_string($no_quote_fields)) {
889 $no_quote_fields = explode(',', $no_quote_fields);
890 } elseif (!is_array($no_quote_fields)) {
891 $no_quote_fields = array();
892 }
893
894 $blobfields = array();
895 $nArr = array();
896 foreach ($fields_values as $k => $v) {
897 if (!$this->runningNative() && $this->sql_field_metatype($table, $k) == 'B') {
898 // we skip the field in the regular INSERT statement, it is only in blobfields
899 $blobfields[$this->quoteFieldNames($k)] = $v;
900 } elseif (!$this->runningNative() && $this->sql_field_metatype($table, $k) == 'XL') {
901 // we skip the field in the regular INSERT statement, it is only in clobfields
902 $clobfields[$this->quoteFieldNames($k)] = $v;
903 } else {
904 // Add slashes old-school:
905 // cast numerical values
906 $mt = $this->sql_field_metatype($table, $k);
907 if ($mt{0} == 'I') {
908 $v = (int)$v;
909 } else if ($mt{0} == 'F') {
910 $v = (double)$v;
911 }
912
913 $nArr[$this->quoteFieldNames($k)] = (!in_array($k,$no_quote_fields)) ? $this->fullQuoteStr($v, $table) : $v;
914 }
915 }
916
917 if (count($blobfields) || count($clobfields)) {
918 if (count($nArr)) {
919 $query[0] = 'INSERT INTO ' . $this->quoteFromTables($table) . '
920 (
921 ' . implode(',
922 ', array_keys($nArr)) . '
923 ) VALUES (
924 ' . implode(',
925 ', $nArr) . '
926 )';
927 }
928 if (count($blobfields)) $query[1] = $blobfields;
929 if (count($clobfields)) $query[2] = $clobfields;
930 if ($this->debugOutput || $this->store_lastBuiltQuery) $this->debug_lastBuiltQuery = $query[0];
931 } else {
932 $query = 'INSERT INTO '.$this->quoteFromTables($table).'
933 (
934 ' . implode(',
935 ', array_keys($nArr)) . '
936 ) VALUES (
937 ' . implode(',
938 ', $nArr) . '
939 )';
940
941 if ($this->debugOutput || $this->store_lastBuiltQuery) $this->debug_lastBuiltQuery = $query;
942 }
943
944 return $query;
945 }
946 }
947
948 /**
949 * Creates an INSERT SQL-statement for $table with multiple rows.
950 * This method will create multiple INSERT queries concatenated with ';'
951 *
952 * @param string Table name
953 * @param array Field names
954 * @param array Table rows. Each row should be an array with field values mapping to $fields
955 * @param string/array See fullQuoteArray()
956 * @return array Full SQL query for INSERT as array of strings (unless $fields_values does not contain any elements in which case it will be FALSE). If BLOB fields will be affected and one is not running the native type, an array will be returned for each row, where 0 => plain SQL, 1 => fieldname/value pairs of BLOB fields.
957 */
958 public function INSERTmultipleRows($table, array $fields, array $rows, $no_quote_fields = FALSE) {
959 if ((string)$this->handlerCfg[$this->lastHandlerKey]['type'] === 'native') {
960 return parent::INSERTmultipleRows($table, $fields, $rows, $no_quote_fields);
961 }
962
963 $result = array();
964
965 foreach ($rows as $row) {
966 $fields_values = array();
967 foreach ($fields as $key => $value) {
968 $fields_values[$value] = $row[$key];
969 }
970 $rowQuery = $this->INSERTquery($table, $fields_values, $no_quote_fields);
971 if (is_array($rowQuery)) {
972 $result[] = $rowQuery;
973 } else {
974 $result[][0] = $rowQuery;
975 }
976 }
977
978 return $result;
979 }
980
981 /**
982 * Creates an UPDATE SQL-statement for $table where $where-clause (typ. 'uid=...') from the array with field/value pairs $fields_values.
983 * Usage count/core: 6
984 *
985 * @param string See exec_UPDATEquery()
986 * @param string See exec_UPDATEquery()
987 * @param array See exec_UPDATEquery()
988 * @param mixed See exec_UPDATEquery()
989 * @return mixed Full SQL query for UPDATE as string or array (unless $fields_values does not contain any elements in which case it will be FALSE). If BLOB fields will be affected and one is not running the native type, an array will be returned, where 0 => plain SQL, 1 => fieldname/value pairs of BLOB fields
990 */
991 public function UPDATEquery($table, $where, $fields_values, $no_quote_fields = '') {
992 // Table and fieldnames should be "SQL-injection-safe" when supplied to this function (contrary to values in the arrays which may be insecure).
993 if (is_string($where)) {
994 if (is_array($fields_values) && count($fields_values)) {
995
996 if (is_string($no_quote_fields)) {
997 $no_quote_fields = explode(',', $no_quote_fields);
998 } elseif (!is_array($no_quote_fields)) {
999 $no_quote_fields = array();
1000 }
1001
1002 $blobfields = array();
1003 $nArr = array();
1004 foreach ($fields_values as $k => $v) {
1005 if (!$this->runningNative() && $this->sql_field_metatype($table, $k) == 'B') {
1006 // we skip the field in the regular UPDATE statement, it is only in blobfields
1007 $blobfields[$this->quoteFieldNames($k)] = $v;
1008 } elseif (!$this->runningNative() && $this->sql_field_metatype($table, $k) == 'XL') {
1009 // we skip the field in the regular UPDATE statement, it is only in clobfields
1010 $clobfields[$this->quoteFieldNames($k)] = $v;
1011 } else {
1012 // Add slashes old-school:
1013 // cast numeric values
1014 $mt = $this->sql_field_metatype($table, $k);
1015 if ($mt{0} == 'I') {
1016 $v = (int)$v;
1017 } else if ($mt{0} == 'F') {
1018 $v = (double)$v;
1019 }
1020 $nArr[] = $this->quoteFieldNames($k) . '=' . ((!in_array($k, $no_quote_fields)) ? $this->fullQuoteStr($v, $table) : $v);
1021 }
1022 }
1023
1024 if (count($blobfields) || count($clobfields)) {
1025 if (count($nArr)) {
1026 $query[0] = 'UPDATE '.$this->quoteFromTables($table).'
1027 SET
1028 '.implode(',
1029 ',$nArr).
1030 (strlen($where)>0 ? '
1031 WHERE
1032 '.$this->quoteWhereClause($where) : '');
1033 }
1034 if (count($blobfields)) $query[1] = $blobfields;
1035 if (count($clobfields)) $query[2] = $clobfields;
1036 if ($this->debugOutput || $this->store_lastBuiltQuery) $this->debug_lastBuiltQuery = $query[0];
1037 } else {
1038 $query = 'UPDATE '.$this->quoteFromTables($table).'
1039 SET
1040 '.implode(',
1041 ',$nArr).
1042 (strlen($where)>0 ? '
1043 WHERE
1044 '.$this->quoteWhereClause($where) : '');
1045
1046 if ($this->debugOutput || $this->store_lastBuiltQuery) $this->debug_lastBuiltQuery = $query;
1047 }
1048
1049 return $query;
1050 }
1051 } else {
1052 die('<strong>TYPO3 Fatal Error:</strong> "Where" clause argument for UPDATE query was not a string in $this->UPDATEquery() !');
1053 }
1054 }
1055
1056 /**
1057 * Creates a DELETE SQL-statement for $table where $where-clause
1058 * Usage count/core: 3
1059 *
1060 * @param string See exec_DELETEquery()
1061 * @param string See exec_DELETEquery()
1062 * @return string Full SQL query for DELETE
1063 */
1064 public function DELETEquery($table, $where) {
1065 if (is_string($where)) {
1066 $table = $this->quoteFromTables($table);
1067 $where = $this->quoteWhereClause($where);
1068
1069 $query = parent::DELETEquery($table, $where);
1070
1071 if ($this->debugOutput || $this->store_lastBuiltQuery) $this->debug_lastBuiltQuery = $query;
1072 return $query;
1073 } else {
1074 die('<strong>TYPO3 Fatal Error:</strong> "Where" clause argument for DELETE query was not a string in $this->DELETEquery() !');
1075 }
1076 }
1077
1078 /**
1079 * Creates a SELECT SQL-statement
1080 * Usage count/core: 11
1081 *
1082 * @param string See exec_SELECTquery()
1083 * @param string See exec_SELECTquery()
1084 * @param string See exec_SELECTquery()
1085 * @param string See exec_SELECTquery()
1086 * @param string See exec_SELECTquery()
1087 * @param string See exec_SELECTquery()
1088 * @return string Full SQL query for SELECT
1089 */
1090 public function SELECTquery($select_fields, $from_table, $where_clause, $groupBy = '', $orderBy = '', $limit = '') {
1091 $this->lastHandlerKey = $this->handler_getFromTableList($from_table);
1092 $hType = (string)$this->handlerCfg[$this->lastHandlerKey]['type'];
1093 if ($hType === 'adodb' && $this->runningADOdbDriver('postgres')) {
1094 // Possibly rewrite the LIMIT to be PostgreSQL-compatible
1095 $splitLimit = t3lib_div::intExplode(',', $limit); // Splitting the limit values:
1096 if ($splitLimit[1]) { // If there are two parameters, do mapping differently than otherwise:
1097 $numrows = $splitLimit[1];
1098 $offset = $splitLimit[0];
1099 $limit = $numrows . ' OFFSET ' . $offset;
1100 }
1101 }
1102
1103 $select_fields = $this->quoteFieldNames($select_fields);
1104 $from_table = $this->quoteFromTables($from_table);
1105 $where_clause = $this->quoteWhereClause($where_clause);
1106 $groupBy = $this->quoteGroupBy($groupBy);
1107 $orderBy = $this->quoteOrderBy($orderBy);
1108
1109 // Call parent method to build actual query
1110 $query = parent::SELECTquery($select_fields,$from_table,$where_clause,$groupBy,$orderBy,$limit);
1111
1112 if ($this->debugOutput || $this->store_lastBuiltQuery) $this->debug_lastBuiltQuery = $query;
1113
1114 return $query;
1115 }
1116
1117 /**
1118 * Creates a TRUNCATE TABLE SQL-statement
1119 *
1120 * @param string See exec_TRUNCATEquery()
1121 * @return string Full SQL query for TRUNCATE TABLE
1122 */
1123 public function TRUNCATEquery($table) {
1124 $table = $this->quoteFromTables($table);
1125
1126 // Call parent method to build actual query
1127 $query = parent::TRUNCATEquery($table);
1128
1129 if ($this->debugOutput || $this->store_lastBuiltQuery) {
1130 $this->debug_lastBuiltQuery = $query;
1131 }
1132
1133 return $query;
1134 }
1135
1136
1137 /**************************************
1138 *
1139 * Functions for quoting table/field names
1140 *
1141 **************************************/
1142
1143 /**
1144 * Quotes components of a SELECT subquery.
1145 *
1146 * @param array $components Array of SQL query components
1147 * @return array
1148 */
1149 protected function quoteSELECTsubquery(array $components) {
1150 $components['SELECT'] = $this->_quoteFieldNames($components['SELECT']);
1151 $components['FROM'] = $this->_quoteFromTables($components['FROM']);
1152 $components['WHERE'] = $this->_quoteWhereClause($components['WHERE']);
1153 return $components;
1154 }
1155
1156 /**
1157 * Quotes field (and table) names with the quote character suitable for the DB being used
1158 * Use quoteFieldNames instead!
1159 *
1160 * @param string List of fields to be selected from DB
1161 * @return string Quoted list of fields to be selected from DB
1162 * @deprecated since TYPO3 4.0
1163 */
1164 public function quoteSelectFields($select_fields) {
1165 $this->quoteFieldNames($select_fields);
1166 }
1167
1168 /**
1169 * Quotes field (and table) names with the quote character suitable for the DB being used
1170 *
1171 * @param string List of fields to be used in query to DB
1172 * @return string Quoted list of fields to be in query to DB
1173 */
1174 public function quoteFieldNames($select_fields) {
1175 if ($select_fields == '') return '';
1176 if ($this->runningNative()) return $select_fields;
1177
1178 $select_fields = $this->SQLparser->parseFieldList($select_fields);
1179 if ($this->SQLparser->parse_error) {
1180 die($this->SQLparser->parse_error . ' in ' . __FILE__ . ' : ' . __LINE__);
1181 }
1182 $select_fields = $this->_quoteFieldNames($select_fields);
1183
1184 return $this->SQLparser->compileFieldList($select_fields);
1185 }
1186
1187 /**
1188 * Quotes field (and table) names in a SQL SELECT clause acccording to DB rules
1189 *
1190 * @param array $select_fields The parsed fields to quote
1191 * @return array
1192 * @see quoteFieldNames()
1193 */
1194 protected function _quoteFieldNames(array $select_fields) {
1195 foreach ($select_fields as $k => $v) {
1196 if ($select_fields[$k]['field'] != '' && $select_fields[$k]['field'] != '*' && !is_numeric($select_fields[$k]['field'])) {
1197 $select_fields[$k]['field'] = $this->quoteName($select_fields[$k]['field']);
1198 }
1199 if ($select_fields[$k]['table'] != '' && !is_numeric($select_fields[$k]['table'])) {
1200 $select_fields[$k]['table'] = $this->quoteName($select_fields[$k]['table']);
1201 }
1202 if ($select_fields[$k]['as'] != '') {
1203 $select_fields[$k]['as'] = $this->quoteName($select_fields[$k]['as']);
1204 }
1205 if (isset($select_fields[$k]['func_content.']) && $select_fields[$k]['func_content.'][0]['func_content'] != '*'){
1206 $select_fields[$k]['func_content.'][0]['func_content'] = $this->quoteFieldNames($select_fields[$k]['func_content.'][0]['func_content']);
1207 $select_fields[$k]['func_content'] = $this->quoteFieldNames($select_fields[$k]['func_content']);
1208 }
1209 if (isset($select_fields[$k]['flow-control'])) {
1210 // Quoting flow-control statements
1211 if ($select_fields[$k]['flow-control']['type'] === 'CASE') {
1212 if (isset($select_fields[$k]['flow-control']['case_field'])) {
1213 $select_fields[$k]['flow-control']['case_field'] = $this->quoteFieldNames($select_fields[$k]['flow-control']['case_field']);
1214 }
1215 foreach ($select_fields[$k]['flow-control']['when'] as $key => $when) {
1216 $select_fields[$k]['flow-control']['when'][$key]['when_value'] = $this->_quoteWhereClause($when['when_value']);
1217 }
1218 }
1219 }
1220 }
1221
1222 return $select_fields;
1223 }
1224
1225 /**
1226 * Quotes table names with the quote character suitable for the DB being used
1227 *
1228 * @param string List of tables to be selected from DB
1229 * @return string Quoted list of tables to be selected from DB
1230 */
1231 public function quoteFromTables($from_table) {
1232 if ($from_table == '') return '';
1233 if ($this->runningNative()) return $from_table;
1234
1235 $from_table = $this->SQLparser->parseFromTables($from_table);
1236 $from_table = $this->_quoteFromTables($from_table);
1237 return $this->SQLparser->compileFromTables($from_table);
1238 }
1239
1240 /**
1241 * Quotes table names in a SQL FROM clause acccording to DB rules
1242 *
1243 * @param array $from_table The parsed FROM clause to quote
1244 * @return array
1245 * @see quoteFromTables()
1246 */
1247 protected function _quoteFromTables(array $from_table) {
1248 foreach ($from_table as $k => $v) {
1249 $from_table[$k]['table'] = $this->quoteName($from_table[$k]['table']);
1250 if ($from_table[$k]['as'] != '') {
1251 $from_table[$k]['as'] = $this->quoteName($from_table[$k]['as']);
1252 }
1253 if (is_array($v['JOIN'])) {
1254 foreach ($v['JOIN'] as $joinCnt => $join) {
1255 $from_table[$k]['JOIN'][$joinCnt]['withTable'] = $this->quoteName($join['withTable']);
1256 $from_table[$k]['JOIN'][$joinCnt]['as'] = ($join['as']) ? $this->quoteName($join['as']) : '';
1257 $from_table[$k]['JOIN'][$joinCnt]['ON'][0]['table'] = ($join['ON'][0]['table']) ? $this->quoteName($join['ON'][0]['table']) : '';
1258 $from_table[$k]['JOIN'][$joinCnt]['ON'][0]['field'] = $this->quoteName($join['ON'][0]['field']);
1259 $from_table[$k]['JOIN'][$joinCnt]['ON'][1]['table'] = ($join['ON'][1]['table']) ? $this->quoteName($join['ON'][1]['table']) : '';
1260 $from_table[$k]['JOIN'][$joinCnt]['ON'][1]['field'] = $this->quoteName($join['ON'][1]['field']);
1261 }
1262 }
1263 }
1264
1265 return $from_table;
1266 }
1267
1268 /**
1269 * Quotes the field (and table) names within a where clause with the quote character suitable for the DB being used
1270 *
1271 * @param string A where clause that can e parsed by parseWhereClause
1272 * @return string Usable where clause with quoted field/table names
1273 */
1274 public function quoteWhereClause($where_clause) {
1275 if ($where_clause === '' || $this->runningNative()) return $where_clause;
1276
1277 $where_clause = $this->SQLparser->parseWhereClause($where_clause);
1278 if (is_array($where_clause)) {
1279 $where_clause = $this->_quoteWhereClause($where_clause);
1280 $where_clause = $this->SQLparser->compileWhereClause($where_clause);
1281 } else {
1282 die('Could not parse where clause in ' . __FILE__ . ' : ' . __LINE__);
1283 }
1284
1285 return $where_clause;
1286 }
1287
1288 /**
1289 * Quotes field names in a SQL WHERE clause acccording to DB rules
1290 *
1291 * @param array $where_clause The parsed WHERE clause to quote
1292 * @return array
1293 * @see quoteWhereClause()
1294 */
1295 protected function _quoteWhereClause(array $where_clause) {
1296 foreach ($where_clause as $k => $v) {
1297 // Look for sublevel:
1298 if (is_array($where_clause[$k]['sub'])) {
1299 $where_clause[$k]['sub'] = $this->_quoteWhereClause($where_clause[$k]['sub']);
1300 } elseif (isset($v['func'])) {
1301 switch ($where_clause[$k]['func']['type']) {
1302 case 'EXISTS':
1303 $where_clause[$k]['func']['subquery'] = $this->quoteSELECTsubquery($v['func']['subquery']);
1304 break;
1305 case 'IFNULL':
1306 case 'LOCATE':
1307 if ($where_clause[$k]['func']['table'] != '') {
1308 $where_clause[$k]['func']['table'] = $this->quoteName($v['func']['table']);
1309 }
1310 if ($where_clause[$k]['func']['field'] != '') {
1311 $where_clause[$k]['func']['field'] = $this->quoteName($v['func']['field']);
1312 }
1313 break;
1314 }
1315 } else {
1316 if ($where_clause[$k]['table'] != '') {
1317 $where_clause[$k]['table'] = $this->quoteName($where_clause[$k]['table']);
1318 }
1319 if (!is_numeric($where_clause[$k]['field'])) {
1320 $where_clause[$k]['field'] = $this->quoteName($where_clause[$k]['field']);
1321 }
1322 if (isset($where_clause[$k]['calc_table'])) {
1323 if ($where_clause[$k]['calc_table'] != '') {
1324 $where_clause[$k]['calc_table'] = $this->quoteName($where_clause[$k]['calc_table']);
1325 }
1326 if ($where_clause[$k]['calc_field'] != '') {
1327 $where_clause[$k]['calc_field'] = $this->quoteName($where_clause[$k]['calc_field']);
1328 }
1329 }
1330 }
1331 if ($where_clause[$k]['comparator']) {
1332 if (isset($v['value']['operator'])) {
1333 foreach ($where_clause[$k]['value']['args'] as $argK => $fieldDef) {
1334 $where_clause[$k]['value']['args'][$argK]['table'] = $this->quoteName($fieldDef['table']);
1335 $where_clause[$k]['value']['args'][$argK]['field'] = $this->quoteName($fieldDef['field']);
1336 }
1337 } else {
1338 // Detecting value type; list or plain:
1339 if (t3lib_div::inList('NOTIN,IN', strtoupper(str_replace(array(' ',"\n", "\r", "\t"), '', $where_clause[$k]['comparator'])))) {
1340 if (isset($v['subquery'])) {
1341 $where_clause[$k]['subquery'] = $this->quoteSELECTsubquery($v['subquery']);
1342 }
1343 } else {
1344 if ((!isset($where_clause[$k]['value'][1]) || $where_clause[$k]['value'][1] == '') && is_string($where_clause[$k]['value'][0]) && strstr($where_clause[$k]['value'][0], '.')) {
1345 $where_clause[$k]['value'][0] = $this->quoteFieldNames($where_clause[$k]['value'][0]);
1346 }
1347 }
1348 }
1349 }
1350 }
1351
1352 return $where_clause;
1353 }
1354
1355 /**
1356 * [Describe function...]
1357 *
1358 * @param [type] $$groupBy: ...
1359 * @return [type] ...
1360 */
1361 protected function quoteGroupBy($groupBy) {
1362 if ($groupBy === '') return '';
1363 if ($this->runningNative()) return $groupBy;
1364
1365 $groupBy = $this->SQLparser->parseFieldList($groupBy);
1366 foreach ($groupBy as $k => $v) {
1367 $groupBy[$k]['field'] = $this->quoteName($groupBy[$k]['field']);
1368 if ($groupBy[$k]['table'] != '') {
1369 $groupBy[$k]['table'] = $this->quoteName($groupBy[$k]['table']);
1370 }
1371 }
1372 return $this->SQLparser->compileFieldList($groupBy);
1373 }
1374
1375 /**
1376 * [Describe function...]
1377 *
1378 * @param [type] $$orderBy: ...
1379 * @return [type] ...
1380 */
1381 protected function quoteOrderBy($orderBy) {
1382 if ($orderBy === '') return '';
1383 if ($this->runningNative()) return $orderBy;
1384
1385 $orderBy = $this->SQLparser->parseFieldList($orderBy);
1386 foreach ($orderBy as $k => $v) {
1387 $orderBy[$k]['field'] = $this->quoteName($orderBy[$k]['field']);
1388 if ($orderBy[$k]['table'] != '') {
1389 $orderBy[$k]['table'] = $this->quoteName($orderBy[$k]['table']);
1390 }
1391 }
1392 return $this->SQLparser->compileFieldList($orderBy);
1393 }
1394
1395
1396
1397 /**************************************
1398 *
1399 * Various helper functions
1400 *
1401 **************************************/
1402
1403 /**
1404 * Escaping and quoting values for SQL statements.
1405 *
1406 * @param string Input string
1407 * @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!).
1408 * @return string Output string; Wrapped in single quotes and quotes in the string (" / ') and \ will be backslashed (or otherwise based on DBAL handler)
1409 * @see quoteStr()
1410 */
1411 public function fullQuoteStr($str, $table) {
1412 return '\'' . $this->quoteStr($str, $table) . '\'';
1413 }
1414
1415 /**
1416 * Substitution for PHP function "addslashes()"
1417 * 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()!
1418 *
1419 * @param string Input string
1420 * @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!).
1421 * @return string Output string; Quotes (" / ') and \ will be backslashed (or otherwise based on DBAL handler)
1422 * @see quoteStr()
1423 */
1424 public function quoteStr($str, $table) {
1425 $this->lastHandlerKey = $this->handler_getFromTableList($table);
1426 switch ((string)$this->handlerCfg[$this->lastHandlerKey]['type']) {
1427 case 'native':
1428 $str = mysql_real_escape_string($str, $this->handlerInstance[$this->lastHandlerKey]['link']);
1429 break;
1430 case 'adodb':
1431 $str = substr($this->handlerInstance[$this->lastHandlerKey]->qstr($str), 1, -1);
1432 break;
1433 case 'userdefined':
1434 $str = $this->handlerInstance[$this->lastHandlerKey]->quoteStr($str);
1435 break;
1436 default:
1437 die('No handler found!!!');
1438 break;
1439 }
1440
1441 return $str;
1442 }
1443
1444 /**
1445 * Quotes an object name (table name, field, ...)
1446 *
1447 * @param string Object's name
1448 * @param string Handler key
1449 * @param boolean If method NameQuote() is not used, whether to use backticks instead of driver-specific quotes
1450 * @return string Properly-quoted object's name
1451 */
1452 public function quoteName($name, $handlerKey = NULL, $useBackticks = FALSE) {
1453 $handlerKey = $handlerKey ? $handlerKey : $this->lastHandlerKey;
1454 $useNameQuote = isset($this->handlerCfg[$handlerKey]['config']['useNameQuote']) ? $this->handlerCfg[$handlerKey]['config']['useNameQuote'] : FALSE;
1455 if ($useNameQuote) {
1456 return $this->handlerInstance[$handlerKey]->DataDictionary->NameQuote($name);
1457 } else {
1458 $quote = $useBackticks ? '`' : $this->handlerInstance[$handlerKey]->nameQuote;
1459 return $quote . $name . $quote;
1460 }
1461 }
1462
1463 /**
1464 * Return MetaType for native field type (ADOdb only!)
1465 *
1466 * @param string native type as reported by admin_get_fields()
1467 * @param string Table name for which query type string. Important for detection of DBMS handler of the query!
1468 * @return string Meta type (currenly ADOdb syntax only, http://phplens.com/lens/adodb/docs-adodb.htm#metatype)
1469 */
1470 public function MetaType($type, $table, $max_length = -1) {
1471 $this->lastHandlerKey = $this->handler_getFromTableList($table);
1472 $str = '';
1473 switch ((string)$this->handlerCfg[$this->lastHandlerKey]['type']) {
1474 case 'native':
1475 $str = $type;
1476 break;
1477 case 'adodb':
1478 if (in_array($table, $this->cache_fieldType)) {
1479 $rs = $this->handlerInstance[$this->lastHandlerKey]->SelectLimit('SELECT * FROM ' . $this->quoteFromTables($table), 1);
1480 $str = $rs->MetaType($type, $max_length);
1481 }
1482 break;
1483 case 'userdefined':
1484 $str = $this->handlerInstance[$this->lastHandlerKey]->MetaType($str,$table,$max_length);
1485 break;
1486 default:
1487 die('No handler found!!!');
1488 break;
1489 }
1490
1491 return $str;
1492 }
1493
1494
1495 /**
1496 * Return MetaType for native MySQL field type
1497 *
1498 * @param string native type as reported as in mysqldump files
1499 * @return string Meta type (currenly ADOdb syntax only, http://phplens.com/lens/adodb/docs-adodb.htm#metatype)
1500 */
1501 public function MySQLMetaType($t) {
1502
1503 switch (strtoupper($t)) {
1504 case 'STRING':
1505 case 'CHAR':
1506 case 'VARCHAR':
1507 case 'TINYBLOB':
1508 case 'TINYTEXT':
1509 case 'ENUM':
1510 case 'SET': return 'C';
1511
1512 case 'TEXT':
1513 case 'LONGTEXT':
1514 case 'MEDIUMTEXT': return 'XL';
1515
1516 case 'IMAGE':
1517 case 'LONGBLOB':
1518 case 'BLOB':
1519 case 'MEDIUMBLOB': return 'B';
1520
1521 case 'YEAR':
1522 case 'DATE': return 'D';
1523
1524 case 'TIME':
1525 case 'DATETIME':
1526 case 'TIMESTAMP': return 'T';
1527
1528 case 'FLOAT':
1529 case 'DOUBLE': return 'F';
1530
1531 case 'INT':
1532 case 'INTEGER':
1533 case 'TINYINT':
1534 case 'SMALLINT':
1535 case 'MEDIUMINT':
1536 case 'BIGINT': return 'I8'; // we always return I8 to be on the safe side. Under some circumstances the fields are to small otherwise...
1537
1538 default: return 'N';
1539 }
1540 }
1541
1542 /**
1543 * Return actual MySQL type for meta field type
1544 *
1545 * @param string Meta type (currenly ADOdb syntax only, http://phplens.com/lens/adodb/docs-adodb.htm#metatype)
1546 * @return string native type as reported as in mysqldump files, uppercase
1547 */
1548 public function MySQLActualType($meta) {
1549 switch (strtoupper($meta)) {
1550 case 'C': return 'VARCHAR';
1551 case 'XL':
1552 case 'X': return 'LONGTEXT';
1553
1554 case 'C2': return 'VARCHAR';
1555 case 'X2': return 'LONGTEXT';
1556
1557 case 'B': return 'LONGBLOB';
1558
1559 case 'D': return 'DATE';
1560 case 'T': return 'DATETIME';
1561 case 'L': return 'TINYINT';
1562
1563 case 'I':
1564 case 'I1':
1565 case 'I2':
1566 case 'I4':
1567 case 'I8': return 'BIGINT'; // we only have I8 in DBAL, see MySQLMetaType()
1568
1569 case 'F': return 'DOUBLE';
1570 case 'N': return 'NUMERIC';
1571
1572 default: return $meta;
1573 }
1574 }
1575
1576
1577
1578
1579 /**************************************
1580 *
1581 * SQL wrapper functions (Overriding parent methods)
1582 * (For use in your applications)
1583 *
1584 **************************************/
1585
1586 /**
1587 * Returns the error status on the most recent sql() execution (based on $this->lastHandlerKey)
1588 *
1589 * @return string Handler error strings
1590 */
1591 public function sql_error() {
1592 switch ($this->handlerCfg[$this->lastHandlerKey]['type']) {
1593 case 'native':
1594 $output = mysql_error($this->handlerInstance[$this->lastHandlerKey]['link']);
1595 break;
1596 case 'adodb':
1597 $output = $this->handlerInstance[$this->lastHandlerKey]->ErrorMsg();
1598 break;
1599 case 'userdefined':
1600 $output = $this->handlerInstance[$this->lastHandlerKey]->sql_error();
1601 break;
1602 }
1603 return $output;
1604 }
1605
1606 /**
1607 * Returns the error number on the most recent sql() execution (based on $this->lastHandlerKey)
1608 *
1609 * @return int Handler error number
1610 */
1611 public function sql_errno() {
1612 switch ($this->handlerCfg[$this->lastHandlerKey]['type']) {
1613 case 'native':
1614 $output = mysql_errno($this->handlerInstance[$this->lastHandlerKey]['link']);
1615 break;
1616 case 'adodb':
1617 $output = $this->handlerInstance[$this->lastHandlerKey]->ErrorNo();
1618 break;
1619 case 'userdefined':
1620 $output = $this->handlerInstance[$this->lastHandlerKey]->sql_errno();
1621 break;
1622 }
1623 return $output;
1624 }
1625
1626 /**
1627 * Returns the number of selected rows.
1628 *
1629 * @param pointer Result pointer / DBAL object
1630 * @return integer Number of resulting rows.
1631 */
1632 public function sql_num_rows(&$res) {
1633 if ($res === FALSE) return 0;
1634
1635 $handlerType = is_object($res) ? $res->TYPO3_DBAL_handlerType : 'native';
1636 switch ($handlerType) {
1637 case 'native':
1638 $output = mysql_num_rows($res);
1639 break;
1640 case 'adodb':
1641 $output = method_exists($res, 'RecordCount') ? $res->RecordCount() : 0;
1642 break;
1643 case 'userdefined':
1644 $output = $res->sql_num_rows();
1645 break;
1646 }
1647 return $output;
1648 }
1649
1650 /**
1651 * Returns an associative array that corresponds to the fetched row, or FALSE if there are no more rows.
1652 *
1653 * @param pointer MySQL result pointer (of SELECT query) / DBAL object
1654 * @return array Associative array of result row.
1655 */
1656 public function sql_fetch_assoc(&$res) {
1657 $output = array();
1658
1659 $handlerType = is_object($res) ? $res->TYPO3_DBAL_handlerType : (is_resource($res) ? 'native' : FALSE);
1660 switch ($handlerType) {
1661 case 'native':
1662 $output = mysql_fetch_assoc($res);
1663 $tableList = $this->resourceIdToTableNameMap[(string)$res]; // Reading list of tables from SELECT query:
1664 break;
1665 case 'adodb':
1666 // Check if method exists for the current $res object.
1667 // If a table exists in TCA but not in the db, a error
1668 // occured because $res is not a valid object.
1669 if (method_exists($res, 'FetchRow')) {
1670 $output = $res->FetchRow();
1671 $tableList = $res->TYPO3_DBAL_tableList; // Reading list of tables from SELECT query:
1672
1673 // Removing all numeric/integer keys.
1674 // A workaround because in ADOdb we would need to know what we want before executing the query...
1675 if (is_array($output)) {
1676 foreach ($output as $key => $value) {
1677 if (is_integer($key)) {
1678 unset($output[$key]);
1679 }
1680 elseif ($value === ' ' && $this->runningADOdbDriver('mssql')) $output[$key] = ''; // MSSQL does not know such thing as an empty string. So it returns one space instead, which we must fix.
1681 }
1682 }
1683 }
1684 break;
1685 case 'userdefined':
1686 $output = $res->sql_fetch_assoc();
1687 $tableList = $res->TYPO3_DBAL_tableList; // Reading list of tables from SELECT query:
1688 break;
1689 }
1690
1691 // Table/Fieldname mapping:
1692 if (is_array($output)) {
1693 if ($tables = $this->map_needMapping($tableList,TRUE)) {
1694 $output = $this->map_assocArray($output,$tables,1);
1695 }
1696 }
1697
1698 // Return result:
1699 return $output;
1700 }
1701
1702 /**
1703 * Returns an array that corresponds to the fetched row, or FALSE if there are no more rows.
1704 * The array contains the values in numerical indices.
1705 *
1706 * @param pointer MySQL result pointer (of SELECT query) / DBAL object
1707 * @return array Array with result rows.
1708 */
1709 public function sql_fetch_row(&$res) {
1710 $handlerType = is_object($res) ? $res->TYPO3_DBAL_handlerType : 'native';
1711 switch ($handlerType) {
1712 case 'native':
1713 $output = mysql_fetch_row($res);
1714 break;
1715 case 'adodb':
1716 // Check if method exists for the current $res object.
1717 // If a table exists in TCA but not in the db, a error
1718 // occured because $res is not a valid object.
1719 if (method_exists($res, 'FetchRow')) {
1720 $output = $res->FetchRow();
1721
1722 // Removing all assoc. keys.
1723 // A workaround because in ADOdb we would need to know what we want before executing the query...
1724 if (is_array($output)) {
1725 foreach ($output as $key => $value) {
1726 if (!is_integer($key)) unset($output[$key]);
1727 elseif ($value === ' ' && $this->runningADOdbDriver('mssql')) $output[$key] = ''; // MSSQL does not know such thing as an empty string. So it returns one space instead, which we must fix.
1728 }
1729 }
1730 }
1731 break;
1732 case 'userdefined':
1733 $output = $res->sql_fetch_row();
1734 break;
1735 }
1736 return $output;
1737 }
1738
1739 /**
1740 * Free result memory / unset result object
1741 *
1742 * @param pointer MySQL result pointer to free / DBAL object
1743 * @return boolean Returns TRUE on success or FALSE on failure.
1744 */
1745 public function sql_free_result(&$res) {
1746 if ($res === FALSE) return FALSE;
1747
1748 $handlerType = is_object($res) ? $res->TYPO3_DBAL_handlerType : 'native';
1749 switch ($handlerType) {
1750 case 'native':
1751 $output = mysql_free_result($res);
1752 break;
1753 case 'adodb':
1754 if (method_exists($res, 'Close')) {
1755 $res->Close();
1756 unset($res);
1757 $output = TRUE;
1758 } else {
1759 $output = FALSE;
1760 }
1761 break;
1762 case 'userdefined':
1763 unset($res);
1764 break;
1765 }
1766 return $output;
1767 }
1768
1769 /**
1770 * Get the ID generated from the previous INSERT operation
1771 *
1772 * @return integer The uid of the last inserted record.
1773 */
1774 public function sql_insert_id() {
1775 switch ($this->handlerCfg[$this->lastHandlerKey]['type']) {
1776 case 'native':
1777 $output = mysql_insert_id($this->handlerInstance[$this->lastHandlerKey]['link']);
1778 break;
1779 case 'adodb':
1780 $output = $this->handlerInstance[$this->lastHandlerKey]->last_insert_id;
1781 break;
1782 case 'userdefined':
1783 $output = $this->handlerInstance[$this->lastHandlerKey]->sql_insert_id();
1784 break;
1785 }
1786 return $output;
1787 }
1788
1789 /**
1790 * Returns the number of rows affected by the last INSERT, UPDATE or DELETE query
1791 *
1792 * @return integer Number of rows affected by last query
1793 */
1794 public function sql_affected_rows() {
1795 switch ($this->handlerCfg[$this->lastHandlerKey]['type']) {
1796 case 'native':
1797 $output = mysql_affected_rows();
1798 break;
1799 case 'adodb':
1800 $output = $this->handlerInstance[$this->lastHandlerKey]->Affected_Rows();
1801 break;
1802 case 'userdefined':
1803 $output = $this->handlerInstance[$this->lastHandlerKey]->sql_affected_rows();
1804 break;
1805 }
1806 return $output;
1807 }
1808
1809 /**
1810 * Move internal result pointer
1811 *
1812 * @param pointer MySQL result pointer (of SELECT query) / DBAL object
1813 * @param integer Seek result number.
1814 * @return boolean Returns TRUE on success or FALSE on failure.
1815 */
1816 public function sql_data_seek(&$res, $seek) {
1817 $handlerType = is_object($res) ? $res->TYPO3_DBAL_handlerType : 'native';
1818 switch ($handlerType) {
1819 case 'native':
1820 $output = mysql_data_seek($res,$seek);
1821 break;
1822 case 'adodb':
1823 $output = $res->Move($seek);
1824 break;
1825 case 'userdefined':
1826 $output = $res->sql_data_seek($seek);
1827 break;
1828 }
1829 return $output;
1830 }
1831
1832 /**
1833 * Get the type of the specified field in a result
1834 *
1835 * If the first parameter is a string, it is used as table name for the lookup.
1836 *
1837 * @param pointer MySQL result pointer (of SELECT query) / DBAL object / table name
1838 * @param integer Field index. In case of ADOdb a string (field name!) FIXME
1839 * @return string Returns the type of the specified field index
1840 */
1841 public function sql_field_metatype($table, $field) {
1842 // If $table and/or $field are mapped, use the original names instead
1843 foreach ($this->mapping as $tableName => $tableMapInfo) {
1844 if (isset($tableMapInfo['mapTableName']) && $tableMapInfo['mapTableName'] === $table) {
1845 // Table name is mapped => use original name
1846 $table = $tableName;
1847 }
1848
1849 if (isset($tableMapInfo['mapFieldNames'])) {
1850 foreach ($tableMapInfo['mapFieldNames'] as $fieldName => $fieldMapInfo) {
1851 if ($fieldMapInfo === $field) {
1852 // Field name is mapped => use original name
1853 $field = $fieldName;
1854 }
1855 }
1856 }
1857 }
1858
1859 return $this->cache_fieldType[$table][$field]['metaType'];
1860 }
1861
1862 /**
1863 * Get the type of the specified field in a result
1864 *
1865 * If the first parameter is a string, it is used as table name for the lookup.
1866 *
1867 * @param pointer MySQL result pointer (of SELECT query) / DBAL object / table name
1868 * @param integer Field index. In case of ADOdb a string (field name!) FIXME
1869 * @return string Returns the type of the specified field index
1870 */
1871 public function sql_field_type(&$res,$pointer) {
1872 if ($res === null) {
1873 debug(array('no res in sql_field_type!'));
1874 return 'text';
1875 }
1876 elseif (is_string($res)){
1877 if ($res === 'tx_dbal_debuglog') return 'text';
1878 $handlerType = 'adodb';
1879 }
1880 else {
1881 $handlerType = is_object($res) ? $res->TYPO3_DBAL_handlerType : 'native';
1882 }
1883
1884 switch ($handlerType) {
1885 case 'native':
1886 $output = mysql_field_type($res,$pointer);
1887 break;
1888 case 'adodb':
1889 if (is_string($pointer)){
1890 $output = $this->cache_fieldType[$res][$pointer]['type'];
1891 }
1892
1893 break;
1894 case 'userdefined':
1895 $output = $res->sql_field_type($pointer);
1896 break;
1897 }
1898
1899 return $output;
1900 }
1901
1902
1903
1904
1905
1906
1907
1908
1909 /**********
1910 *
1911 * Legacy functions, bound to _DEFAULT handler. (Overriding parent methods)
1912 * Deprecated or still experimental.
1913 *
1914 **********/
1915
1916 /**
1917 * Executes query (on DEFAULT handler!)
1918 * DEPRECATED - use exec_* functions from this class instead!
1919 *
1920 * @param string Database name
1921 * @param string Query to execute
1922 * @return pointer Result pointer
1923 * @deprecated since TYPO3 4.1
1924 */
1925 public function sql($db,$query) {
1926 return $this->sql_query($query);
1927 }
1928
1929 /**
1930 * Executes a query
1931 * EXPERIMENTAL - This method will make its best to handle the query correctly
1932 * but if it cannot, it will simply pass the query to DEFAULT handler.
1933 *
1934 * You should use exec_* function from this class instead!
1935 * If you don't, anything that does not use the _DEFAULT handler will probably break!
1936 *
1937 * This method was deprecated in TYPO3 4.1 but is considered experimental since TYPO3 4.4
1938 * as it tries to handle the query correctly anyway.
1939 *
1940 * @param string Query to execute
1941 * @return pointer Result pointer / DBAL object
1942 */
1943 public function sql_query($query) {
1944 // This method is heavily used by Extbase, try to handle it with DBAL-native methods
1945 $queryParts = $this->SQLparser->parseSQL($query);
1946 if (is_array($queryParts) && t3lib_div::inList('SELECT,UPDATE,INSERT,DELETE', $queryParts['type'])) {
1947 return $this->exec_query($queryParts);
1948 }
1949
1950 switch ($this->handlerCfg['_DEFAULT']['type']) {
1951 case 'native':
1952 $sqlResult = mysql_query($query, $this->handlerInstance['_DEFAULT']['link']);
1953 break;
1954 case 'adodb':
1955 $sqlResult = $this->handlerInstance['_DEFAULT']->Execute($query);
1956 $sqlResult->TYPO3_DBAL_handlerType = 'adodb';
1957 break;
1958 case 'userdefined':
1959 $sqlResult = $this->handlerInstance['_DEFAULT']->sql_query($query);
1960 $sqlResult->TYPO3_DBAL_handlerType = 'userdefined';
1961 break;
1962 }
1963
1964 if ($this->printErrors && $this->sql_error()) {
1965 debug(array($this->lastQuery, $this->sql_error()));
1966 }
1967
1968 return $sqlResult;
1969 }
1970
1971 /**
1972 * Opening the _DEFAULT connection handler to the database.
1973 * This is typically done by the scripts "init.php" in the backend or "index_ts.php" in the frontend (tslib_fe->connectToMySQL())
1974 * You wouldn't need to use this at any time - let TYPO3 core handle this.
1975 *
1976 * @param string Database host IP/domain
1977 * @param string Username to connect with.
1978 * @param string Password to connect with.
1979 * @return mixed Returns handler connection value
1980 * @deprecated since TYPO3 4.1
1981 * @see handler_init()
1982 */
1983 public function sql_pconnect($TYPO3_db_host, $TYPO3_db_username, $TYPO3_db_password) {
1984 // Overriding the _DEFAULT handler configuration of username, password, localhost and database name:
1985 $this->handlerCfg['_DEFAULT']['config']['username'] = $TYPO3_db_username;
1986 $this->handlerCfg['_DEFAULT']['config']['password'] = $TYPO3_db_password;
1987 $this->handlerCfg['_DEFAULT']['config']['host'] = $TYPO3_db_host;
1988 $this->handlerCfg['_DEFAULT']['config']['database'] = TYPO3_db;
1989
1990 // Initializing and output value:
1991 $sqlResult = $this->handler_init('_DEFAULT');
1992 return $sqlResult;
1993 }
1994
1995 /**
1996 * Select database for _DEFAULT handler.
1997 *
1998 * @param string Database to connect to.
1999 * @return boolean Always returns TRUE; function is obsolete, database selection is made in handler_init() function!
2000 * @deprecated since TYPO3 4.1
2001 */
2002 public function sql_select_db($TYPO3_db) {
2003 return TRUE;
2004 }
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020 /**************************************
2021 *
2022 * SQL admin functions
2023 * (For use in the Install Tool and Extension Manager)
2024 *
2025 **************************************/
2026
2027 /**
2028 * Listing databases from current MySQL connection. NOTICE: It WILL try to select those databases and thus break selection of current database.
2029 * Use in Install Tool only!
2030 * Usage count/core: 1
2031 *
2032 * @return array Each entry represents a database name
2033 */
2034 public function admin_get_dbs() {
2035 $dbArr = array();
2036 switch ($this->handlerCfg['_DEFAULT']['type']) {
2037 case 'native':
2038 $db_list = mysql_list_dbs($this->link);
2039 while ($row = mysql_fetch_object($db_list)) {
2040 if ($this->sql_select_db($row->Database)) {
2041 $dbArr[] = $row->Database;
2042 }
2043 }
2044 break;
2045 case 'adodb':
2046 // check needed for install tool - otherwise it will just die because the call to
2047 // MetaDatabases is done on a stdClass instance
2048 if (method_exists($this->handlerInstance['_DEFAULT'],'MetaDatabases')) {
2049 $sqlDBs = $this->handlerInstance['_DEFAULT']->MetaDatabases();
2050 if (is_array($sqlDBs)) {
2051 foreach ($sqlDBs as $k => $theDB) {
2052 $dbArr[] = $theDB;
2053 }
2054 }
2055 }
2056 break;
2057 case 'userdefined':
2058 $dbArr = $this->handlerInstance['_DEFAULT']->admin_get_tables();
2059 break;
2060 }
2061
2062 return $dbArr;
2063 }
2064
2065 /**
2066 * Returns the list of tables from the system (quering the DBMSs)
2067 * It looks up all tables from the DBMS of the _DEFAULT handler and then add all tables *configured* to be managed by other handlers
2068 *
2069 * When fetching the tables, it skips tables whose names begin with BIN$, as this is taken as a table coming from the "Recycle Bin" on Oracle.
2070 *
2071 * @return array Tables in an array (tablename is in both key and value)
2072 * @todo Should the check for Oracle Recycle Bin stuff be moved elsewhere?
2073 * @todo Should return table details in value! see t3lib_db::admin_get_tables()
2074 */
2075 public function admin_get_tables() {
2076 $whichTables = array();
2077
2078 // Getting real list of tables:
2079 switch ($this->handlerCfg['_DEFAULT']['type']) {
2080 case 'native':
2081 $tables_result = mysql_query('SHOW TABLE STATUS FROM `' . TYPO3_db . '`', $this->handlerInstance['_DEFAULT']['link']);
2082 if (!$this->sql_error()) {
2083 while ($theTable = $this->sql_fetch_assoc($tables_result)) {
2084 $whichTables[current($theTable)] = current($theTable);
2085 }
2086 }
2087 break;
2088 case 'adodb':
2089 $sqlTables = $this->handlerInstance['_DEFAULT']->MetaTables('TABLES');
2090 while (list($k, $theTable) = each($sqlTables)) {
2091 if (preg_match('/BIN\$/', $theTable)) continue; // skip tables from the Oracle 10 Recycle Bin
2092 $whichTables[$theTable] = $theTable;
2093 }
2094 break;
2095 case 'userdefined':
2096 $whichTables = $this->handlerInstance['_DEFAULT']->admin_get_tables();
2097 break;
2098 }
2099
2100 // Check mapping:
2101 if (is_array($this->mapping) && count($this->mapping)) {
2102
2103 // Mapping table names in reverse, first getting list of real table names:
2104 $tMap = array();
2105 foreach ($this->mapping as $tN => $tMapInfo) {
2106 if (isset($tMapInfo['mapTableName'])) $tMap[$tMapInfo['mapTableName']]=$tN;
2107 }
2108
2109 // Do mapping:
2110 $newList=array();
2111 foreach ($whichTables as $tN) {
2112 if (isset($tMap[$tN])) $tN = $tMap[$tN];
2113 $newList[$tN] = $tN;
2114 }
2115
2116 $whichTables = $newList;
2117 }
2118
2119 // Adding tables configured to reside in other DBMS (handler by other handlers than the default):
2120 if (is_array($this->table2handlerKeys)) {
2121 foreach ($this->table2handlerKeys as $key => $handlerKey) {
2122 $whichTables[$key] = $key;
2123 }
2124 }
2125
2126 return $whichTables;
2127 }
2128
2129 /**
2130 * Returns information about each field in the $table (quering the DBMS)
2131 * In a DBAL this should look up the right handler for the table and return compatible information
2132 * 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
2133 *
2134 * @param string Table name
2135 * @return array Field information in an associative array with fieldname => field row
2136 */
2137 public function admin_get_fields($tableName) {
2138 $output = array();
2139
2140 // Do field mapping if needed:
2141 $ORIG_tableName = $tableName;
2142 if ($tableArray = $this->map_needMapping($tableName)) {
2143
2144 // Table name:
2145 if ($this->mapping[$tableName]['mapTableName']) {
2146 $tableName = $this->mapping[$tableName]['mapTableName'];
2147 }
2148 }
2149
2150 // Find columns
2151 $this->lastHandlerKey = $this->handler_getFromTableList($ORIG_tableName);
2152 switch ((string)$this->handlerCfg[$this->lastHandlerKey]['type']) {
2153 case 'native':
2154 $columns_res = mysql_query('SHOW columns FROM '.$tableName, $this->handlerInstance[$this->lastHandlerKey]['link']);
2155 while($fieldRow = mysql_fetch_assoc($columns_res)) {
2156 $output[$fieldRow['Field']] = $fieldRow;
2157 }
2158 break;
2159 case 'adodb':
2160 $fieldRows = $this->handlerInstance[$this->lastHandlerKey]->MetaColumns($tableName, FALSE);
2161 if (is_array($fieldRows)) {
2162 foreach ($fieldRows as $k => $fieldRow) {
2163 settype($fieldRow, 'array');
2164 $fieldRow['Field'] = $fieldRow['name'];
2165 $ntype = $this->MySQLActualType($this->MetaType($fieldRow['type'],$tableName));
2166 $ntype .= (($fieldRow['max_length'] != -1) ? (($ntype == 'INT') ? '(11)' :'('.$fieldRow['max_length'].')') : '');
2167 $fieldRow['Type'] = strtolower($ntype);
2168 $fieldRow['Null'] = '';
2169 $fieldRow['Key'] = '';
2170 $fieldRow['Default'] = $fieldRow['default_value'];
2171 $fieldRow['Extra'] = '';
2172 $output[$fieldRow['name']] = $fieldRow;
2173 }
2174 }
2175 break;
2176 case 'userdefined':
2177 $output = $this->handlerInstance[$this->lastHandlerKey]->admin_get_fields($tableName);
2178 break;
2179 }
2180
2181 // mapping should be done:
2182 if (is_array($tableArray) && is_array($this->mapping[$ORIG_tableName]['mapFieldNames'])) {
2183 $revFields = array_flip($this->mapping[$ORIG_tableName]['mapFieldNames']);
2184
2185 $newOutput = array();
2186 foreach ($output as $fN => $fInfo) {
2187 if (isset($revFields[$fN])) {
2188 $fN = $revFields[$fN];
2189 $fInfo['Field'] = $fN;
2190 }
2191 $newOutput[$fN] = $fInfo;
2192 }
2193 $output = $newOutput;
2194 }
2195
2196 return $output;
2197 }
2198
2199 /**
2200 * Returns information about each index key in the $table (quering the DBMS)
2201 * In a DBAL this should look up the right handler for the table and return compatible information
2202 *
2203 * @param string Table name
2204 * @return array Key information in a numeric array
2205 */
2206 public function admin_get_keys($tableName) {
2207 $output = array();
2208
2209 // Do field mapping if needed:
2210 $ORIG_tableName = $tableName;
2211 if ($tableArray = $this->map_needMapping($tableName)) {
2212
2213 // Table name:
2214 if ($this->mapping[$tableName]['mapTableName']) {
2215 $tableName = $this->mapping[$tableName]['mapTableName'];
2216 }
2217 }
2218
2219 // Find columns
2220 $this->lastHandlerKey = $this->handler_getFromTableList($ORIG_tableName);
2221 switch ((string)$this->handlerCfg[$this->lastHandlerKey]['type']) {
2222 case 'native':
2223 $keyRes = mysql_query('SHOW keys FROM '.$tableName, $this->handlerInstance[$this->lastHandlerKey]['link']);
2224 while($keyRow = mysql_fetch_assoc($keyRes)) {
2225 $output[] = $keyRow;
2226 }
2227 break;
2228 case 'adodb':
2229 $keyRows = $this->handlerInstance[$this->lastHandlerKey]->MetaIndexes($tableName);
2230 if ($keyRows !== FALSE) {
2231 while (list($k, $theKey) = each($keyRows)) {
2232 $theKey['Table'] = $tableName;
2233 $theKey['Non_unique'] = (int) !$theKey['unique'];
2234 $theKey['Key_name'] = str_replace($tableName.'_','',$k);
2235
2236 // the following are probably not needed anyway...
2237 $theKey['Collation'] = '';
2238 $theKey['Cardinality'] = '';
2239 $theKey['Sub_part'] = '';
2240 $theKey['Packed'] = '';
2241 $theKey['Null'] = '';
2242 $theKey['Index_type'] = '';
2243 $theKey['Comment'] = '';
2244
2245 // now map multiple fields into multiple rows (we mimic MySQL, remember...)
2246 $keycols = $theKey['columns'];
2247 while (list($c, $theCol) = each($keycols)) {
2248 $theKey['Seq_in_index'] = $c+1;
2249 $theKey['Column_name'] = $theCol;
2250 $output[] = $theKey;
2251 }
2252 }
2253 }
2254 $priKeyRow = $this->handlerInstance[$this->lastHandlerKey]->MetaPrimaryKeys($tableName);
2255 $theKey = array();
2256 $theKey['Table'] = $tableName;
2257 $theKey['Non_unique'] = 0;
2258 $theKey['Key_name'] = 'PRIMARY';
2259
2260 // the following are probably not needed anyway...
2261 $theKey['Collation'] = '';
2262 $theKey['Cardinality'] = '';
2263 $theKey['Sub_part'] = '';
2264 $theKey['Packed'] = '';
2265 $theKey['Null'] = '';
2266 $theKey['Index_type'] = '';
2267 $theKey['Comment'] = '';
2268
2269 // now map multiple fields into multiple rows (we mimic MySQL, remember...)
2270 if ($priKeyRow !== FALSE) {
2271 while (list($c, $theCol) = each($priKeyRow)) {
2272 $theKey['Seq_in_index'] = $c+1;
2273 $theKey['Column_name'] = $theCol;
2274 $output[] = $theKey;
2275 }
2276 }
2277 break;
2278 case 'userdefined':
2279 $output = $this->handlerInstance[$this->lastHandlerKey]->admin_get_keys($tableName);
2280 break;
2281 }
2282
2283 // mapping should be done:
2284 if (is_array($tableArray) && is_array($this->mapping[$ORIG_tableName]['mapFieldNames'])) {
2285 $revFields = array_flip($this->mapping[$ORIG_tableName]['mapFieldNames']);
2286
2287 $newOutput = array();
2288 foreach ($output as $kN => $kInfo) {
2289 // Table:
2290 $kInfo['Table'] = $ORIG_tableName;
2291
2292 // Column
2293 if (isset($revFields[$kInfo['Column_name']])) {
2294 $kInfo['Column_name'] = $revFields[$kInfo['Column_name']];
2295 }
2296
2297 // Write it back:
2298 $newOutput[$kN] = $kInfo;
2299 }
2300 $output = $newOutput;
2301 }
2302
2303 return $output;
2304 }
2305
2306 /**
2307 * mysql() wrapper function, used by the Install Tool.
2308 *
2309 * @return array
2310 */
2311 public function admin_get_charsets() {
2312 return array();
2313 }
2314
2315 /**
2316 * mysql() wrapper function, used by the Install Tool and EM for all queries regarding management of the database!
2317 *
2318 * @param string Query to execute
2319 * @return pointer Result pointer
2320 */
2321 public function admin_query($query) {
2322 $parsedQuery = $this->SQLparser->parseSQL($query);
2323 $ORIG_table = $parsedQuery['TABLE'];
2324
2325 if (is_array($parsedQuery)) {
2326
2327 // Process query based on type:
2328 switch ($parsedQuery['type']) {
2329 case 'CREATETABLE':
2330 case 'ALTERTABLE':
2331 case 'DROPTABLE':
2332 if (file_exists(PATH_typo3conf.'temp_fieldInfo.php')) unlink(PATH_typo3conf.'temp_fieldInfo.php');
2333 $this->map_genericQueryParsed($parsedQuery);
2334 break;
2335 case 'INSERT':
2336 case 'TRUNCATETABLE':
2337 $this->map_genericQueryParsed($parsedQuery);
2338 break;
2339 case 'CREATEDATABASE':
2340 die('Creating a database with DBAL is not supported. Did you really read the manual?');
2341 break;
2342 default:
2343 die('ERROR: Invalid Query type ('.$parsedQuery['type'].') for ->admin_query() function!: "'.htmlspecialchars($query).'"');
2344 break;
2345 }
2346
2347 // Setting query array (for other applications to access if needed)
2348 $this->lastParsedAndMappedQueryArray = $parsedQuery;
2349
2350 // Execute query (based on handler derived from the TABLE name which we actually know for once!)
2351 $this->lastHandlerKey = $this->handler_getFromTableList($ORIG_table);
2352 switch ((string)$this->handlerCfg[$this->lastHandlerKey]['type']) {
2353 case 'native':
2354 // Compiling query:
2355 $compiledQuery = $this->SQLparser->compileSQL($this->lastParsedAndMappedQueryArray);
2356
2357 if ($this->lastParsedAndMappedQueryArray['type']=='INSERT') {
2358 return mysql_query($compiledQuery, $this->link);
2359 }
2360 return mysql_query($compiledQuery[0], $this->link);
2361 break;
2362 case 'adodb':
2363 // Compiling query:
2364 $compiledQuery = $this->SQLparser->compileSQL($this->lastParsedAndMappedQueryArray);
2365 switch ($this->lastParsedAndMappedQueryArray['type']) {
2366 case 'INSERT':
2367 return $this->exec_INSERTquery($this->lastParsedAndMappedQueryArray['TABLE'], $compiledQuery);
2368 case 'TRUNCATETABLE':
2369 return $this->exec_TRUNCATEquery($this->lastParsedAndMappedQueryArray['TABLE']);
2370 }
2371 return $this->handlerInstance[$this->lastHandlerKey]->DataDictionary->ExecuteSQLArray($compiledQuery);
2372 break;
2373 case 'userdefined':
2374 // Compiling query:
2375 $compiledQuery = $this->SQLparser->compileSQL($this->lastParsedAndMappedQueryArray);
2376
2377 return $this->handlerInstance[$this->lastHandlerKey]->admin_query($compiledQuery);
2378 break;
2379 }
2380 } else die('ERROR: Query could not be parsed: "'.htmlspecialchars($parsedQuery).'". Query: "'.htmlspecialchars($query).'"');
2381 }
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392 /************************************
2393 *
2394 * Handler management
2395 *
2396 **************************************/
2397
2398 /**
2399 * Return the handler key pointing to an appropriate database handler as found in $this->handlerCfg array
2400 * Notice: TWO or more tables in the table list MUST use the SAME handler key - otherwise a fatal error is thrown! (Logically, no database can possibly join two tables from separate sources!)
2401 *
2402 * @param string Table list, eg. "pages" or "pages, tt_content" or "pages AS A, tt_content AS B"
2403 * @return string Handler key (see $this->handlerCfg array) for table
2404 */
2405 public function handler_getFromTableList($tableList) {
2406
2407 $key = $tableList;
2408
2409 if (!isset($this->cache_handlerKeyFromTableList[$key])) {
2410
2411 // Get tables separated:
2412 $_tableList = $tableList;
2413 $tableArray = $this->SQLparser->parseFromTables($_tableList);
2414
2415 // If success, traverse the tables:
2416 if (is_array($tableArray) && count($tableArray)) {
2417 $outputHandlerKey = '';
2418
2419 foreach ($tableArray as $vArray) {
2420 // Find handler key, select "_DEFAULT" if none is specifically configured:
2421 $handlerKey = $this->table2handlerKeys[$vArray['table']] ? $this->table2handlerKeys[$vArray['table']] : '_DEFAULT';
2422
2423 // In case of separate handler keys for joined tables:
2424 if ($outputHandlerKey && $handlerKey != $outputHandlerKey) {
2425 die('DBAL fatal error: Tables in this list "'.$tableList.'" didn\'t use the same DB handler!');
2426 }
2427
2428 $outputHandlerKey = $handlerKey;
2429 }
2430
2431 // Check initialized state; if handler is NOT initialized (connected) then we will connect it!
2432 if (!isset($this->handlerInstance[$outputHandlerKey])) {
2433 $this->handler_init($outputHandlerKey);
2434 }
2435
2436 // Return handler key:
2437 $this->cache_handlerKeyFromTableList[$key] = $outputHandlerKey;
2438 } else {
2439 die('DBAL fatal error: No handler found in handler_getFromTableList() for: "'.$tableList.'" ('.$tableArray.')');
2440 }
2441 }
2442
2443 return $this->cache_handlerKeyFromTableList[$key];
2444 }
2445
2446 /**
2447 * Initialize handler (connecting to database)
2448 *
2449 * @param string Handler key
2450 * @return boolean If connection went well, return TRUE
2451 * @see handler_getFromTableList()
2452 */
2453 public function handler_init($handlerKey) {
2454
2455 // Find handler configuration:
2456 $cfgArray = $this->handlerCfg[$handlerKey];
2457 $handlerType = (string)$cfgArray['type'];
2458 $output = FALSE;
2459
2460 if (is_array($cfgArray)) {
2461 switch ($handlerType) {
2462 case 'native':
2463 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['no_pconnect']) {
2464 $link = mysql_connect($cfgArray['config']['host'].(isset($cfgArray['config']['port']) ? ':'.$cfgArray['config']['port'] : ''), $cfgArray['config']['username'], $cfgArray['config']['password'], TRUE);
2465 } else {
2466 $link = mysql_pconnect($cfgArray['config']['host'].(isset($cfgArray['config']['port']) ? ':'.$cfgArray['config']['port'] : ''), $cfgArray['config']['username'], $cfgArray['config']['password']);
2467 }
2468
2469 // Set handler instance:
2470 $this->handlerInstance[$handlerKey] = array('handlerType' => 'native', 'link' => $link);
2471
2472 // If link succeeded:
2473 if ($link) {
2474 // For default, set ->link (see t3lib_DB)
2475 if ($handlerKey == '_DEFAULT') {
2476 $this->link = $link;
2477 }
2478
2479 // Select database as well:
2480 if (mysql_select_db($cfgArray['config']['database'], $link)) {
2481 $output = TRUE;
2482 }
2483 $setDBinit = t3lib_div::trimExplode(chr(10), $GLOBALS['TYPO3_CONF_VARS']['SYS']['setDBinit'], 1);
2484 foreach ($setDBinit as $v) {
2485 if (mysql_query($v, $this->link) === FALSE) {
2486 t3lib_div::sysLog('Could not initialize DB connection with query "'.$v.'".','Core',3);
2487 }
2488 }
2489 } else {
2490 t3lib_div::sysLog('Could not connect to MySQL server '.$cfgArray['config']['host'].' with user '.$cfgArray['config']['username'].'.','Core',4);
2491 }
2492 break;
2493 case 'adodb':
2494 $output = TRUE;
2495 require_once(t3lib_extMgm::extPath('adodb').'adodb/adodb.inc.php');
2496 if (!defined('ADODB_FORCE_NULLS')) define('ADODB_FORCE_NULLS', 1);
2497 $GLOBALS['ADODB_FORCE_TYPE'] = ADODB_FORCE_VALUE;
2498 $GLOBALS['ADODB_FETCH_MODE'] = ADODB_FETCH_BOTH;
2499
2500 $this->handlerInstance[$handlerKey] = &ADONewConnection($cfgArray['config']['driver']);
2501
2502 // Set driver-specific options
2503 if (isset($cfgArray['config']['driverOptions'])) {
2504 foreach ($cfgArray['config']['driverOptions'] as $optionName => $optionValue) {
2505 $optionSetterName = 'set' . ucfirst($optionName);
2506 if (method_exists($this->handlerInstance[$handlerKey], $optionSetterName)) {
2507 $this->handlerInstance[$handlerKey]->$optionSetterName($optionValue);
2508 } else {
2509 $this->handlerInstance[$handlerKey]->$optionName = $optionValue;
2510 }
2511 }
2512 }
2513
2514 if ($GLOBALS['TYPO3_CONF_VARS']['SYS']['no_pconnect']) {
2515 $this->handlerInstance[$handlerKey]->Connect($cfgArray['config']['host'].(isset($cfgArray['config']['port']) ? ':'.$cfgArray['config']['port'] : ''),$cfgArray['config']['username'],$cfgArray['config']['password'],$cfgArray['config']['database']);
2516 } else {
2517 $this->handlerInstance[$handlerKey]->PConnect($cfgArray['config']['host'].(isset($cfgArray['config']['port']) ? ':'.$cfgArray['config']['port'] : ''),$cfgArray['config']['username'],$cfgArray['config']['password'],$cfgArray['config']['database']);
2518 }
2519 if (!$this->handlerInstance[$handlerKey]->isConnected()) {
2520 $dsn = $cfgArray['config']['driver'].'://'.$cfgArray['config']['username'].
2521 (strlen($cfgArray['config']['password']) ? ':XXXX@' : '').
2522 $cfgArray['config']['host'].(isset($cfgArray['config']['port']) ? ':'.$cfgArray['config']['port'] : '').'/'.$cfgArray['config']['database'].
2523 ($GLOBALS['TYPO3_CONF_VARS']['SYS']['no_pconnect'] ? '' : '?persistent=1');
2524 t3lib_div::sysLog('Could not connect to DB server using ADOdb on '.$cfgArray['config']['host'].' with user '.$cfgArray['config']['username'].'.','Core',4);
2525 error_log('DBAL error: Connection to '.$dsn.' failed. Maybe PHP doesn\'t support the database?');
2526 $output = FALSE;
2527 } else {
2528 $this->handlerInstance[$handlerKey]->DataDictionary = NewDataDictionary($this->handlerInstance[$handlerKey]);
2529 $this->handlerInstance[$handlerKey]->last_insert_id = 0;
2530 if (isset($cfgArray['config']['sequenceStart'])) {
2531 $this->handlerInstance[$handlerKey]->sequenceStart = $cfgArray['config']['sequenceStart'];
2532 } else {
2533 $this->handlerInstance[$handlerKey]->sequenceStart = 1;
2534 }
2535 }
2536 break;
2537 case 'userdefined':
2538 // Find class file:
2539 $fileName = t3lib_div::getFileAbsFileName($cfgArray['config']['classFile']);
2540 if (@is_file($fileName)) {
2541 require_once($fileName);
2542 } else die('DBAL error: "'.$fileName.'" was not a file to include.');
2543
2544 // Initialize:
2545 $this->handlerInstance[$handlerKey] = t3lib_div::makeInstance($cfgArray['config']['class']);
2546 $this->handlerInstance[$handlerKey]->init($cfgArray,$this);
2547
2548 if (is_object($this->handlerInstance[$handlerKey])) {
2549 $output = TRUE;
2550 }
2551 break;
2552 default:
2553 die('ERROR: Invalid handler type: "'.$cfgArray['type'].'"');
2554 break;
2555 }
2556
2557 return $output;
2558 } else die('ERROR: No handler for key "'.$handlerKey.'"');
2559 }
2560
2561
2562 /**
2563 * Checks whether the DBAL is currently inside an operation running on the "native" DB handler (i.e. MySQL)
2564 *
2565 * @return boolean True if running on "native" DB handler (i.e. MySQL)
2566 */
2567 public function runningNative() {
2568 return ((string)$this->handlerCfg[$this->lastHandlerKey]['type']==='native');
2569 }
2570
2571
2572 /**
2573 * Checks whether the ADOdb handler is running with a driver that contains the argument
2574 *
2575 * @param string $driver Driver name, matched with strstr().
2576 * @return boolean True if running with the given driver
2577 */
2578 public function runningADOdbDriver($driver) {
2579 return strstr($this->handlerCfg[$this->lastHandlerKey]['config']['driver'], $driver);
2580 }
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591 /************************************
2592 *
2593 * Table/Field mapping
2594 *
2595 **************************************/
2596
2597 /**
2598 * Checks if mapping is needed for a table(list)
2599 *
2600 * @param string List of tables in query
2601 * @param boolean If TRUE, it will check only if FIELDs are configured and ignore the mapped table name if any.
2602 * @return mixed Returns an array of table names (parsed version of input table) if mapping is needed, otherwise just FALSE.
2603 */
2604 protected function map_needMapping($tableList, $fieldMappingOnly = FALSE) {
2605 $key = $tableList.'|'.$fieldMappingOnly;
2606 if (!isset($this->cache_mappingFromTableList[$key])) {
2607 $this->cache_mappingFromTableList[$key] = FALSE; // Default:
2608
2609 $tables = $this->SQLparser->parseFromTables($tableList);
2610 if (is_array($tables)) {
2611 foreach ($tables as $tableCfg) {
2612 if ($fieldMappingOnly) {
2613 if (is_array($this->mapping[$tableCfg['table']]['mapFieldNames'])) {
2614 $this->cache_mappingFromTableList[$key] = $tables;
2615 } elseif (is_array($tableCfg['JOIN'])) {
2616 foreach ($tableCfg['JOIN'] as $join) {
2617 if (is_array($this->mapping[$join['withTable']]['mapFieldNames'])) {
2618 $this->cache_mappingFromTableList[$key] = $tables;
2619 break;
2620 }
2621 }
2622 }
2623 } else {
2624 if (is_array($this->mapping[$tableCfg['table']])) {
2625 $this->cache_mappingFromTableList[$key] = $tables;
2626 } elseif (is_array($tableCfg['JOIN'])) {
2627 foreach ($tableCfg['JOIN'] as $join) {
2628 if (is_array($this->mapping[$join['withTable']])) {
2629 $this->cache_mappingFromTableList[$key] = $tables;
2630 break;
2631 }
2632 }
2633 }
2634 }
2635 }
2636 }
2637 }
2638
2639 return $this->cache_mappingFromTableList[$key];
2640 }
2641
2642 /**
2643 * Takes an associated array with field => value pairs and remaps the field names if configured for this table in $this->mapping array.
2644 * Be careful not to map a field name to another existing fields name (although you can use this to swap fieldnames of course...:-)
2645 * Observe mapping problems with join-results (more than one table): Joined queries should always prefix the table name to avoid problems with this.
2646 * Observe that alias fields are not mapped of course (should not be a problem though)
2647 *
2648 * @param array Input array, associative keys
2649 * @param array Array of tables from the query. Normally just one table; many tables in case of a join. NOTICE: for multiple tables (with joins) there MIGHT occur trouble with fields of the same name in the two tables: This function traverses the mapping information for BOTH tables and applies mapping without checking from which table the field really came!
2650 * @param boolean If TRUE, reverse direction. Default direction is to map an array going INTO the database (thus mapping TYPO3 fieldnames to PHYSICAL field names!)
2651 * @return array Output array, with mapped associative keys.
2652 */
2653 protected function map_assocArray($input, $tables, $rev = FALSE) {
2654 // Traverse tables from query (hopefully only one table):
2655 foreach ($tables as $tableCfg) {
2656 if (is_array($this->mapping[$tableCfg['table']]['mapFieldNames'])) {
2657
2658 // Get the map (reversed if needed):
2659 if ($rev) {
2660 $theMap = array_flip($this->mapping[$tableCfg['table']]['mapFieldNames']);
2661 } else {
2662 $theMap = $this->mapping[$tableCfg['table']]['mapFieldNames'];
2663 }
2664
2665 // Traverse selected record, map fieldnames:
2666 $output = array();
2667 foreach ($input as $fN => $value) {
2668
2669 // Set the field name, change it if found in mapping array:
2670 if ($theMap[$fN]) {
2671 $newKey = $theMap[$fN];
2672 } else {
2673 $newKey = $fN;
2674 }
2675
2676 // Set value to fieldname:
2677 $output[$newKey] = $value;
2678 }
2679
2680 // When done, override the $input array with the result:
2681 $input = $output;
2682 }
2683 }
2684
2685 // Return input array (which might have been altered in the mean time)
2686 return $input;
2687 }
2688
2689 /**
2690 * Remaps table/field names in a SELECT query's parts
2691 * Notice: All arguments are passed by reference!
2692 *
2693 * @param string List of fields to select from the table. This is what comes right after "SELECT ...". Required value.
2694 * @param string Table(s) from which to select. This is what comes right after "FROM ...". Require value.
2695 * @param string Where clause. This is what comes right after "WHERE ...". Can be blank.
2696 * @param string Group by field(s)
2697 * @param string Order by field(s)
2698 * @return void
2699 * @see exec_SELECTquery()
2700 */
2701 protected function map_remapSELECTQueryParts(&$select_fields, &$from_table, &$where_clause, &$groupBy, &$orderBy) {
2702 // Tables:
2703 $tables = $this->SQLparser->parseFromTables($from_table);
2704 $defaultTable = $tables[0]['table'];
2705 foreach ($tables as $k => $v) {
2706 if ($this->mapping[$v['table']]['mapTableName']) {
2707 $tables[$k]['table'] = $this->mapping[$v['table']]['mapTableName'];
2708 }
2709 // Mapping JOINS
2710 if (is_array($v['JOIN'])) {
2711 foreach($v['JOIN'] as $joinCnt => $join) {
2712 // Mapping withTable of the JOIN
2713 if ($this->mapping[$join['withTable']]['mapTableName']) {
2714 $tables[$k]['JOIN'][$joinCnt]['withTable'] = $this->mapping[$join['withTable']]['mapTableName'];
2715 }
2716 $onPartsArray = array();
2717 // Mapping ON parts of the JOIN
2718 if (is_array($join['ON'])) {
2719 foreach ($join['ON'] as $onParts) {
2720 if (isset($this->mapping[$onParts['table']]['mapFieldNames'][$onParts['field']])) {
2721 $onParts['field'] = $this->mapping[$onParts['table']]['mapFieldNames'][$onParts['field']];
2722 }
2723 if (isset($this->mapping[$onParts['table']]['mapTableName'])) {
2724 $onParts['table'] = $this->mapping[$onParts['table']]['mapTableName'];
2725 }
2726 $onPartsArray[] = $onParts;
2727 }
2728 $tables[$k]['JOIN'][$joinCnt]['ON'] = $onPartsArray;
2729 }
2730 }
2731 }
2732 }
2733 $from_table = $this->SQLparser->compileFromTables($tables);
2734
2735 // Where clause:
2736 $whereParts = $this->SQLparser->parseWhereClause($where_clause);
2737 $this->map_sqlParts($whereParts,$defaultTable);
2738 $where_clause = $this->SQLparser->compileWhereClause($whereParts, FALSE);
2739
2740 // Select fields:
2741 $expFields = $this->SQLparser->parseFieldList($select_fields);
2742 $this->map_sqlParts($expFields,$defaultTable);
2743 $select_fields = $this->SQLparser->compileFieldList($expFields, FALSE, FALSE);
2744
2745 // Group By fields
2746 $expFields = $this->SQLparser->parseFieldList($groupBy);
2747 $this->map_sqlParts($expFields,$defaultTable);
2748 $groupBy = $this->SQLparser->compileFieldList($expFields);
2749
2750 // Order By fields
2751 $expFields = $this->SQLparser->parseFieldList($orderBy);
2752 $this->map_sqlParts($expFields,$defaultTable);
2753 $orderBy = $this->SQLparser->compileFieldList($expFields);
2754 }
2755
2756 /**
2757 * Generic mapping of table/field names arrays (as parsed by tx_dbal_sqlengine)
2758 *
2759 * @param array Array with parsed SQL parts; Takes both fields, tables, where-parts, group and order-by. Passed by reference.
2760 * @param string Default table name to assume if no table is found in $sqlPartArray
2761 * @return void
2762 * @access private
2763 * @see map_remapSELECTQueryParts()
2764 */
2765 protected function map_sqlParts(&$sqlPartArray, $defaultTable) {
2766 // Traverse sql Part array:
2767 if (is_array($sqlPartArray)) {
2768 foreach ($sqlPartArray as $k => $v) {
2769
2770 if (isset($sqlPartArray[$k]['type'])) {
2771 switch ($sqlPartArray[$k]['type']) {
2772 case 'flow-control':
2773 $temp = array($sqlPartArray[$k]['flow-control']);
2774 $this->map_sqlParts($temp, $defaultTable); // Call recursively!
2775 $sqlPartArray[$k]['flow-control'] = $temp[0];
2776 break;
2777 case 'CASE':
2778 if (isset($sqlPartArray[$k]['case_field'])) {
2779 $fieldArray = explode('.', $sqlPartArray[$k]['case_field']);
2780 if (count($fieldArray) == 1 && is_array($this->mapping[$defaultTable]['mapFieldNames']) && isset($this->mapping[$defaultTable]['mapFieldNames'][$fieldArray[0]])) {
2781 $sqlPartArray[$k]['case_field'] = $this->mapping[$defaultTable]['mapFieldNames'][$fieldArray[0]];
2782 }
2783 elseif (count($fieldArray) == 2) {
2784 // Map the external table
2785 $table = $fieldArray[0];
2786 if (isset($this->mapping[$fieldArray[0]]['mapTableName'])) {
2787 $table = $this->mapping[$fieldArray[0]]['mapTableName'];
2788 }
2789 // Map the field itself
2790 $field = $fieldArray[1];
2791 if (is_array($this->mapping[$fieldArray[0]]['mapFieldNames']) && isset($this->mapping[$fieldArray[0]]['mapFieldNames'][$fieldArray[1]])) {
2792 $field = $this->mapping[$fieldArray[0]]['mapFieldNames'][$fieldArray[1]];
2793 }
2794 $sqlPartArray[$k]['case_field'] = $table . '.' . $field;
2795 }
2796 }
2797 foreach ($sqlPartArray[$k]['when'] as $key => $when) {
2798 $this->map_sqlParts($sqlPartArray[$k]['when'][$key]['when_value'], $defaultTable);
2799 }
2800 break;
2801 }
2802 }
2803
2804 // Look for sublevel (WHERE parts only)
2805 if (is_array($sqlPartArray[$k]['sub'])) {
2806 $this->map_sqlParts($sqlPartArray[$k]['sub'], $defaultTable); // Call recursively!
2807 } elseif (isset($sqlPartArray[$k]['func'])) {
2808 switch ($sqlPartArray[$k]['func']['type']) {
2809 case 'EXISTS':
2810 $subqueryDefaultTable = $sqlPartArray[$k]['func']['subquery']['FROM'][0]['table'];
2811 $this->map_sqlParts($sqlPartArray[$k]['func']['subquery']['SELECT'], $subqueryDefaultTable);
2812 $this->map_sqlParts($sqlPartArray[$k]['func']['subquery']['FROM'], $subqueryDefaultTable);
2813 $this->map_sqlParts($sqlPartArray[$k]['func']['subquery']['WHERE'], $subqueryDefaultTable);
2814 break;
2815 case 'IFNULL':
2816 case 'LOCATE':
2817 // For the field, look for table mapping (generic):
2818 $t = $sqlPartArray[$k]['func']['table'] ? $sqlPartArray[$k]['func']['table'] : $defaultTable;
2819 if (is_array($this->mapping[$t]['mapFieldNames']) && $this->mapping[$t]['mapFieldNames'][$sqlPartArray[$k]['func']['field']]) {
2820 $sqlPartArray[$k]['func']['field'] = $this->mapping[$t]['mapFieldNames'][$sqlPartArray[$k]['func']['field']];
2821 }
2822 if ($this->mapping[$t]['mapTableName']) {
2823 $sqlPartArray[$k]['func']['table'] = $this->mapping[$t]['mapTableName'];
2824 }
2825 break;
2826 }
2827 } else {
2828 // For the field, look for table mapping (generic):
2829 $t = $sqlPartArray[$k]['table'] ? $sqlPartArray[$k]['table'] : $defaultTable;
2830
2831 // Mapping field name, if set:
2832 if (is_array($this->mapping[$t]['mapFieldNames']) && isset($this->mapping[$t]['mapFieldNames'][$sqlPartArray[$k]['field']])) {
2833 $sqlPartArray[$k]['field'] = $this->mapping[$t]['mapFieldNames'][$sqlPartArray[$k]['field']];
2834 }
2835
2836 // Mapping field name in SQL-functions like MIN(), MAX() or SUM()
2837 if ($this->mapping[$t]['mapFieldNames']) {
2838 $fieldArray = explode('.', $sqlPartArray[$k]['func_content']);
2839 if (count($fieldArray) == 1 && is_array($this->mapping[$t]['mapFieldNames']) && isset($this->mapping[$t]['mapFieldNames'][$fieldArray[0]])) {
2840 $sqlPartArray[$k]['func_content.'][0]['func_content'] = $this->mapping[$t]['mapFieldNames'][