Cleanup: #12351: Clean-up SQL parser (thanks to Xavier Perseguers)
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_sqlparser.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2004-2009 Kasper Skaarhoj (kasperYYYY@typo3.com)
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27 /**
28 * TYPO3 SQL parser
29 *
30 * $Id$
31 *
32 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
33 */
34 /**
35 * [CLASS/FUNCTION INDEX of SCRIPT]
36 *
37 *
38 *
39 * 107: class t3lib_sqlparser
40 *
41 * SECTION: SQL Parsing, full queries
42 * 129: function parseSQL($parseString)
43 * 192: function parseSELECT($parseString)
44 * 261: function parseUPDATE($parseString)
45 * 315: function parseINSERT($parseString)
46 * 375: function parseDELETE($parseString)
47 * 413: function parseEXPLAIN($parseString)
48 * 435: function parseCREATETABLE($parseString)
49 * 514: function parseALTERTABLE($parseString)
50 * 583: function parseDROPTABLE($parseString)
51 * 616: function parseCREATEDATABASE($parseString)
52 *
53 * SECTION: SQL Parsing, helper functions for parts of queries
54 * 670: function parseFieldList(&$parseString, $stopRegex='')
55 * 791: function parseFromTables(&$parseString, $stopRegex='')
56 * 882: function parseWhereClause(&$parseString, $stopRegex='')
57 * 990: function parseFieldDef(&$parseString, $stopRegex='')
58 *
59 * SECTION: Parsing: Helper functions
60 * 1053: function nextPart(&$parseString,$regex,$trimAll=FALSE)
61 * 1068: function getValue(&$parseString,$comparator='')
62 * 1127: function getValueInQuotes(&$parseString,$quote)
63 * 1153: function parseStripslashes($str)
64 * 1167: function compileAddslashes($str)
65 * 1182: function parseError($msg,$restQuery)
66 * 1196: function trimSQL($str)
67 *
68 * SECTION: Compiling queries
69 * 1225: function compileSQL($components)
70 * 1263: function compileSELECT($components)
71 * 1294: function compileUPDATE($components)
72 * 1322: function compileINSERT($components)
73 * 1362: function compileDELETE($components)
74 * 1382: function compileCREATETABLE($components)
75 * 1415: function compileALTERTABLE($components)
76 *
77 * SECTION: Compiling queries, helper functions for parts of queries
78 * 1468: function compileFieldList($selectFields)
79 * 1510: function compileFromTables($tablesArray)
80 * 1551: function compileWhereClause($clauseArray)
81 * 1605: function compileFieldCfg($fieldCfg)
82 *
83 * SECTION: Debugging
84 * 1654: function debug_parseSQLpart($part,$str)
85 * 1679: function debug_parseSQLpartCompare($str,$newStr,$caseInsensitive=FALSE)
86 * 1712: function debug_testSQL($SQLquery)
87 *
88 * TOTAL FUNCTIONS: 35
89 * (This index is automatically created/updated by the extension "extdeveval")
90 *
91 */
92
93
94
95
96
97
98
99
100 /**
101 * TYPO3 SQL parser class.
102 *
103 * @author Kasper Skaarhoj <kasperYYYY@typo3.com>
104 * @package TYPO3
105 * @subpackage t3lib
106 */
107 class t3lib_sqlparser {
108
109 // Parser:
110 var $parse_error = ''; // Parsing error string
111 var $lastStopKeyWord = ''; // Last stop keyword used.
112
113
114
115
116 /*************************************
117 *
118 * SQL Parsing, full queries
119 *
120 **************************************/
121
122 /**
123 * Parses any single SQL query
124 *
125 * @param string SQL query
126 * @return array Result array with all the parts in - or error message string
127 * @see compileSQL(), debug_testSQL()
128 */
129 public function parseSQL($parseString) {
130 // Prepare variables:
131 $parseString = $this->trimSQL($parseString);
132 $this->parse_error = '';
133 $result = array();
134
135 // Finding starting keyword of string:
136 $_parseString = $parseString; // Protecting original string...
137 $keyword = $this->nextPart($_parseString, '^(SELECT|UPDATE|INSERT[[:space:]]+INTO|DELETE[[:space:]]+FROM|EXPLAIN|DROP[[:space:]]+TABLE|CREATE[[:space:]]+TABLE|CREATE[[:space:]]+DATABASE|ALTER[[:space:]]+TABLE)[[:space:]]+');
138 $keyword = strtoupper(str_replace(array(' ',"\t","\r","\n"),'',$keyword));
139
140 switch($keyword) {
141 case 'SELECT':
142 // Parsing SELECT query:
143 $result = $this->parseSELECT($parseString);
144 break;
145 case 'UPDATE':
146 // Parsing UPDATE query:
147 $result = $this->parseUPDATE($parseString);
148 break;
149 case 'INSERTINTO':
150 // Parsing INSERT query:
151 $result = $this->parseINSERT($parseString);
152 break;
153 case 'DELETEFROM':
154 // Parsing DELETE query:
155 $result = $this->parseDELETE($parseString);
156 break;
157 case 'EXPLAIN':
158 // Parsing EXPLAIN SELECT query:
159 $result = $this->parseEXPLAIN($parseString);
160 break;
161 case 'DROPTABLE':
162 // Parsing DROP TABLE query:
163 $result = $this->parseDROPTABLE($parseString);
164 break;
165 case 'ALTERTABLE':
166 // Parsing ALTER TABLE query:
167 $result = $this->parseALTERTABLE($parseString);
168 break;
169 case 'CREATETABLE':
170 // Parsing CREATE TABLE query:
171 $result = $this->parseCREATETABLE($parseString);
172 break;
173 case 'CREATEDATABASE':
174 // Parsing CREATE DATABASE query:
175 $result = $this->parseCREATEDATABASE($parseString);
176 break;
177 default:
178 $result = $this->parseError('"'.$keyword.'" is not a keyword',$parseString);
179 break;
180 }
181
182 return $result;
183 }
184
185 /**
186 * Parsing SELECT query
187 *
188 * @param string SQL string with SELECT query to parse
189 * @return mixed Returns array with components of SELECT query on success, otherwise an error message string.
190 * @see compileSELECT()
191 */
192 protected function parseSELECT($parseString) {
193
194 // Removing SELECT:
195 $parseString = $this->trimSQL($parseString);
196 $parseString = ltrim(substr($parseString,6));
197
198 // Init output variable:
199 $result = array();
200 $result['type'] = 'SELECT';
201
202 // Looking for STRAIGHT_JOIN keyword:
203 $result['STRAIGHT_JOIN'] = $this->nextPart($parseString, '^(STRAIGHT_JOIN)[[:space:]]+');
204
205 // Select fields:
206 $result['SELECT'] = $this->parseFieldList($parseString, '^(FROM)[[:space:]]+');
207 if ($this->parse_error) { return $this->parse_error; }
208
209 // Continue if string is not ended:
210 if ($parseString) {
211
212 // Get table list:
213 $result['FROM'] = $this->parseFromTables($parseString, '^(WHERE)[[:space:]]+');
214 if ($this->parse_error) { return $this->parse_error; }
215
216 // If there are more than just the tables (a WHERE clause that would be...)
217 if ($parseString) {
218
219 // Get WHERE clause:
220 $result['WHERE'] = $this->parseWhereClause($parseString, '^(GROUP[[:space:]]+BY|ORDER[[:space:]]+BY|LIMIT)[[:space:]]+');
221 if ($this->parse_error) { return $this->parse_error; }
222
223 // If the WHERE clause parsing was stopped by GROUP BY, ORDER BY or LIMIT, then proceed with parsing:
224 if ($this->lastStopKeyWord) {
225
226 // GROUP BY parsing:
227 if ($this->lastStopKeyWord == 'GROUPBY') {
228 $result['GROUPBY'] = $this->parseFieldList($parseString, '^(ORDER[[:space:]]+BY|LIMIT)[[:space:]]+');
229 if ($this->parse_error) { return $this->parse_error; }
230 }
231
232 // ORDER BY parsing:
233 if ($this->lastStopKeyWord == 'ORDERBY') {
234 $result['ORDERBY'] = $this->parseFieldList($parseString, '^(LIMIT)[[:space:]]+');
235 if ($this->parse_error) { return $this->parse_error; }
236 }
237
238 // LIMIT parsing:
239 if ($this->lastStopKeyWord == 'LIMIT') {
240 if (preg_match('/^([0-9]+|[0-9]+[[:space:]]*,[[:space:]]*[0-9]+)$/',trim($parseString))) {
241 $result['LIMIT'] = $parseString;
242 } else {
243 return $this->parseError('No value for limit!',$parseString);
244 }
245 }
246 }
247 }
248 } else return $this->parseError('No table to select from!',$parseString);
249
250 // Return result:
251 return $result;
252 }
253
254 /**
255 * Parsing UPDATE query
256 *
257 * @param string SQL string with UPDATE query to parse
258 * @return mixed Returns array with components of UPDATE query on success, otherwise an error message string.
259 * @see compileUPDATE()
260 */
261 protected function parseUPDATE($parseString) {
262
263 // Removing UPDATE
264 $parseString = $this->trimSQL($parseString);
265 $parseString = ltrim(substr($parseString,6));
266
267 // Init output variable:
268 $result = array();
269 $result['type'] = 'UPDATE';
270
271 // Get table:
272 $result['TABLE'] = $this->nextPart($parseString, '^([[:alnum:]_]+)[[:space:]]+');
273
274 // Continue if string is not ended:
275 if ($result['TABLE']) {
276 if ($parseString && $this->nextPart($parseString, '^(SET)[[:space:]]+')) {
277
278 $comma = TRUE;
279
280 // Get field/value pairs:
281 while($comma) {
282 if ($fieldName = $this->nextPart($parseString,'^([[:alnum:]_]+)[[:space:]]*=')) {
283 $this->nextPart($parseString,'^(=)'); // Strip of "=" sign.
284 $value = $this->getValue($parseString);
285 $result['FIELDS'][$fieldName] = $value;
286 } else return $this->parseError('No fieldname found',$parseString);
287
288 $comma = $this->nextPart($parseString,'^(,)');
289 }
290
291 // WHERE
292 if ($this->nextPart($parseString,'^(WHERE)')) {
293 $result['WHERE'] = $this->parseWhereClause($parseString);
294 if ($this->parse_error) { return $this->parse_error; }
295 }
296 } else return $this->parseError('Query missing SET...',$parseString);
297 } else return $this->parseError('No table found!',$parseString);
298
299 // Should be no more content now:
300 if ($parseString) {
301 return $this->parseError('Still content in clause after parsing!',$parseString);
302 }
303
304 // Return result:
305 return $result;
306 }
307
308 /**
309 * Parsing INSERT query
310 *
311 * @param string SQL string with INSERT query to parse
312 * @return mixed Returns array with components of INSERT query on success, otherwise an error message string.
313 * @see compileINSERT()
314 */
315 protected function parseINSERT($parseString) {
316
317 // Removing INSERT
318 $parseString = $this->trimSQL($parseString);
319 $parseString = ltrim(substr(ltrim(substr($parseString,6)),4));
320
321 // Init output variable:
322 $result = array();
323 $result['type'] = 'INSERT';
324
325 // Get table:
326 $result['TABLE'] = $this->nextPart($parseString, '^([[:alnum:]_]+)([[:space:]]+|\()');
327
328 if ($result['TABLE']) {
329
330 if ($this->nextPart($parseString,'^(VALUES)[[:space:]]+')) { // In this case there are no field names mentioned in the SQL!
331 // Get values/fieldnames (depending...)
332 $result['VALUES_ONLY'] = $this->getValue($parseString,'IN');
333 if ($this->parse_error) { return $this->parse_error; }
334 } else { // There are apparently fieldnames listed:
335 $fieldNames = $this->getValue($parseString,'_LIST');
336 if ($this->parse_error) { return $this->parse_error; }
337
338 if ($this->nextPart($parseString,'^(VALUES)[[:space:]]+')) { // "VALUES" keyword binds the fieldnames to values:
339
340 $values = $this->getValue($parseString,'IN'); // Using the "getValue" function to get the field list...
341 if ($this->parse_error) { return $this->parse_error; }
342
343 foreach($fieldNames as $k => $fN) {
344 if (preg_match('/^[[:alnum:]_]+$/',$fN)) {
345 if (isset($values[$k])) {
346 if (!isset($result['FIELDS'][$fN])) {
347 $result['FIELDS'][$fN] = $values[$k];
348 } else return $this->parseError('Fieldname ("'.$fN.'") already found in list!',$parseString);
349 } else return $this->parseError('No value set!',$parseString);
350 } else return $this->parseError('Invalid fieldname ("'.$fN.'")',$parseString);
351 }
352 if (isset($values[$k+1])) {
353 return $this->parseError('Too many values in list!',$parseString);
354 }
355 } else return $this->parseError('VALUES keyword expected',$parseString);
356 }
357 } else return $this->parseError('No table found!',$parseString);
358
359 // Should be no more content now:
360 if ($parseString) {
361 return $this->parseError('Still content after parsing!',$parseString);
362 }
363
364 // Return result
365 return $result;
366 }
367
368 /**
369 * Parsing DELETE query
370 *
371 * @param string SQL string with DELETE query to parse
372 * @return mixed Returns array with components of DELETE query on success, otherwise an error message string.
373 * @see compileDELETE()
374 */
375 protected function parseDELETE($parseString) {
376
377 // Removing DELETE
378 $parseString = $this->trimSQL($parseString);
379 $parseString = ltrim(substr(ltrim(substr($parseString,6)),4));
380
381 // Init output variable:
382 $result = array();
383 $result['type'] = 'DELETE';
384
385 // Get table:
386 $result['TABLE'] = $this->nextPart($parseString, '^([[:alnum:]_]+)[[:space:]]+');
387
388 if ($result['TABLE']) {
389
390 // WHERE
391 if ($this->nextPart($parseString,'^(WHERE)')) {
392 $result['WHERE'] = $this->parseWhereClause($parseString);
393 if ($this->parse_error) { return $this->parse_error; }
394 }
395 } else return $this->parseError('No table found!',$parseString);
396
397 // Should be no more content now:
398 if ($parseString) {
399 return $this->parseError('Still content in clause after parsing!',$parseString);
400 }
401
402 // Return result:
403 return $result;
404 }
405
406 /**
407 * Parsing EXPLAIN query
408 *
409 * @param string SQL string with EXPLAIN query to parse
410 * @return mixed Returns array with components of EXPLAIN query on success, otherwise an error message string.
411 * @see parseSELECT()
412 */
413 protected function parseEXPLAIN($parseString) {
414
415 // Removing EXPLAIN
416 $parseString = $this->trimSQL($parseString);
417 $parseString = ltrim(substr($parseString,6));
418
419 // Init output variable:
420 $result = $this->parseSELECT($parseString);
421 if (is_array($result)) {
422 $result['type'] = 'EXPLAIN';
423 }
424
425 return $result;
426 }
427
428 /**
429 * Parsing CREATE TABLE query
430 *
431 * @param string SQL string starting with CREATE TABLE
432 * @return mixed Returns array with components of CREATE TABLE query on success, otherwise an error message string.
433 * @see compileCREATETABLE()
434 */
435 protected function parseCREATETABLE($parseString) {
436
437 // Removing CREATE TABLE
438 $parseString = $this->trimSQL($parseString);
439 $parseString = ltrim(substr(ltrim(substr($parseString,6)),5));
440
441 // Init output variable:
442 $result = array();
443 $result['type'] = 'CREATETABLE';
444
445 // Get table:
446 $result['TABLE'] = $this->nextPart($parseString, '^([[:alnum:]_]+)[[:space:]]*\(',TRUE);
447
448 if ($result['TABLE']) {
449
450 // While the parseString is not yet empty:
451 while(strlen($parseString)>0) {
452 if ($key = $this->nextPart($parseString, '^(KEY|PRIMARY KEY|UNIQUE KEY|UNIQUE)([[:space:]]+|\()')) { // Getting key
453 $key = strtoupper(str_replace(array(' ',"\t","\r","\n"),'',$key));
454
455 switch($key) {
456 case 'PRIMARYKEY':
457 $result['KEYS']['PRIMARYKEY'] = $this->getValue($parseString,'_LIST');
458 if ($this->parse_error) { return $this->parse_error; }
459 break;
460 case 'UNIQUE':
461 case 'UNIQUEKEY':
462 if ($keyName = $this->nextPart($parseString, '^([[:alnum:]_]+)([[:space:]]+|\()')) {
463 $result['KEYS']['UNIQUE'] = array($keyName => $this->getValue($parseString,'_LIST'));
464 if ($this->parse_error) { return $this->parse_error; }
465 } else return $this->parseError('No keyname found',$parseString);
466 break;
467 case 'KEY':
468 if ($keyName = $this->nextPart($parseString, '^([[:alnum:]_]+)([[:space:]]+|\()')) {
469 $result['KEYS'][$keyName] = $this->getValue($parseString,'_LIST');
470 if ($this->parse_error) { return $this->parse_error; }
471 } else return $this->parseError('No keyname found',$parseString);
472 break;
473 }
474 } elseif ($fieldName = $this->nextPart($parseString, '^([[:alnum:]_]+)[[:space:]]+')) { // Getting field:
475 $result['FIELDS'][$fieldName]['definition'] = $this->parseFieldDef($parseString);
476 if ($this->parse_error) { return $this->parse_error; }
477 }
478
479 // Finding delimiter:
480 $delim = $this->nextPart($parseString, '^(,|\))');
481 if (!$delim) {
482 return $this->parseError('No delimiter found',$parseString);
483 } elseif ($delim==')') {
484 break;
485 }
486 }
487
488 // Finding what is after the table definition - table type in MySQL
489 if ($delim==')') {
490 if ($this->nextPart($parseString, '^((ENGINE|TYPE)[[:space:]]*=)')) {
491 $result['tableType'] = $parseString;
492 $parseString = '';
493 }
494 } else return $this->parseError('No fieldname found!',$parseString);
495
496 // Getting table type
497 } else return $this->parseError('No table found!',$parseString);
498
499 // Should be no more content now:
500 if ($parseString) {
501 return $this->parseError('Still content in clause after parsing!',$parseString);
502 }
503
504 return $result;
505 }
506
507 /**
508 * Parsing ALTER TABLE query
509 *
510 * @param string SQL string starting with ALTER TABLE
511 * @return mixed Returns array with components of ALTER TABLE query on success, otherwise an error message string.
512 * @see compileALTERTABLE()
513 */
514 protected function parseALTERTABLE($parseString) {
515
516 // Removing ALTER TABLE
517 $parseString = $this->trimSQL($parseString);
518 $parseString = ltrim(substr(ltrim(substr($parseString,5)),5));
519
520 // Init output variable:
521 $result = array();
522 $result['type'] = 'ALTERTABLE';
523
524 // Get table:
525 $result['TABLE'] = $this->nextPart($parseString, '^([[:alnum:]_]+)[[:space:]]+');
526
527 if ($result['TABLE']) {
528 if ($result['action'] = $this->nextPart($parseString, '^(CHANGE|DROP[[:space:]]+KEY|DROP[[:space:]]+PRIMARY[[:space:]]+KEY|ADD[[:space:]]+KEY|ADD[[:space:]]+PRIMARY[[:space:]]+KEY|DROP|ADD|RENAME)([[:space:]]+|\()')) {
529 $actionKey = strtoupper(str_replace(array(' ',"\t","\r","\n"),'',$result['action']));
530
531 // Getting field:
532 if (t3lib_div::inList('ADDPRIMARYKEY,DROPPRIMARYKEY',$actionKey) || $fieldKey = $this->nextPart($parseString, '^([[:alnum:]_]+)[[:space:]]+')) {
533
534 switch($actionKey) {
535 case 'ADD':
536 $result['FIELD'] = $fieldKey;
537 $result['definition'] = $this->parseFieldDef($parseString);
538 if ($this->parse_error) { return $this->parse_error; }
539 break;
540 case 'DROP':
541 case 'RENAME':
542 $result['FIELD'] = $fieldKey;
543 break;
544 case 'CHANGE':
545 $result['FIELD'] = $fieldKey;
546 if ($result['newField'] = $this->nextPart($parseString, '^([[:alnum:]_]+)[[:space:]]+')) {
547 $result['definition'] = $this->parseFieldDef($parseString);
548 if ($this->parse_error) { return $this->parse_error; }
549 } else return $this->parseError('No NEW field name found',$parseString);
550 break;
551
552 case 'ADDKEY':
553 case 'ADDPRIMARYKEY':
554 $result['KEY'] = $fieldKey;
555 $result['fields'] = $this->getValue($parseString,'_LIST');
556 if ($this->parse_error) { return $this->parse_error; }
557 break;
558 case 'DROPKEY':
559 $result['KEY'] = $fieldKey;
560 break;
561 case 'DROPPRIMARYKEY':
562 // ??? todo!
563 break;
564 }
565 } else return $this->parseError('No field name found',$parseString);
566 } else return $this->parseError('No action CHANGE, DROP or ADD found!',$parseString);
567 } else return $this->parseError('No table found!',$parseString);
568
569 // Should be no more content now:
570 if ($parseString) {
571 return $this->parseError('Still content in clause after parsing!',$parseString);
572 }
573
574 return $result;
575 }
576
577 /**
578 * Parsing DROP TABLE query
579 *
580 * @param string SQL string starting with DROP TABLE
581 * @return mixed Returns array with components of DROP TABLE query on success, otherwise an error message string.
582 */
583 protected function parseDROPTABLE($parseString) {
584
585 // Removing DROP TABLE
586 $parseString = $this->trimSQL($parseString);
587 $parseString = ltrim(substr(ltrim(substr($parseString,4)),5));
588
589 // Init output variable:
590 $result = array();
591 $result['type'] = 'DROPTABLE';
592
593 // IF EXISTS
594 $result['ifExists'] = $this->nextPart($parseString, '^(IF[[:space:]]+EXISTS[[:space:]]+)');
595
596 // Get table:
597 $result['TABLE'] = $this->nextPart($parseString, '^([[:alnum:]_]+)[[:space:]]+');
598
599 if ($result['TABLE']) {
600
601 // Should be no more content now:
602 if ($parseString) {
603 return $this->parseError('Still content in clause after parsing!',$parseString);
604 }
605
606 return $result;
607 } else return $this->parseError('No table found!',$parseString);
608 }
609
610 /**
611 * Parsing CREATE DATABASE query
612 *
613 * @param string SQL string starting with CREATE DATABASE
614 * @return mixed Returns array with components of CREATE DATABASE query on success, otherwise an error message string.
615 */
616 protected function parseCREATEDATABASE($parseString) {
617
618 // Removing CREATE DATABASE
619 $parseString = $this->trimSQL($parseString);
620 $parseString = ltrim(substr(ltrim(substr($parseString,6)),8));
621
622 // Init output variable:
623 $result = array();
624 $result['type'] = 'CREATEDATABASE';
625
626 // Get table:
627 $result['DATABASE'] = $this->nextPart($parseString, '^([[:alnum:]_]+)[[:space:]]+');
628
629 if ($result['DATABASE']) {
630
631 // Should be no more content now:
632 if ($parseString) {
633 return $this->parseError('Still content in clause after parsing!',$parseString);
634 }
635
636 return $result;
637 } else return $this->parseError('No database found!',$parseString);
638 }
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654 /**************************************
655 *
656 * SQL Parsing, helper functions for parts of queries
657 *
658 **************************************/
659
660 /**
661 * Parsing the fields in the "SELECT [$selectFields] FROM" part of a query into an array.
662 * The output from this function can be compiled back into a field list with ->compileFieldList()
663 * Will detect the keywords "DESC" and "ASC" after the table name; thus is can be used for parsing the more simply ORDER BY and GROUP BY field lists as well!
664 *
665 * @param string The string with fieldnames, eg. "title, uid AS myUid, max(tstamp), count(*)" etc. NOTICE: passed by reference!
666 * @param string Regular expressing to STOP parsing, eg. '^(FROM)([[:space:]]*)'
667 * @return array If successful parsing, returns an array, otherwise an error string.
668 * @see compileFieldList()
669 */
670 public function parseFieldList(&$parseString, $stopRegex = '') {
671
672 $stack = array(); // Contains the parsed content
673
674 if(strlen($parseString)==0) return $stack; // FIXME - should never happen, why does it?
675
676 $pnt = 0; // Pointer to positions in $stack
677 $level = 0; // Indicates the parenthesis level we are at.
678 $loopExit = 0; // Recursivity brake.
679
680 // Prepare variables:
681 $parseString = $this->trimSQL($parseString);
682 $this->lastStopKeyWord = '';
683 $this->parse_error = '';
684
685 // $parseString is continously shortend by the process and we keep parsing it till it is zero:
686 while (strlen($parseString)) {
687
688 // Checking if we are inside / outside parenthesis (in case of a function like count(), max(), min() etc...):
689 if ($level>0) { // Inside parenthesis here (does NOT detect if values in quotes are used, the only token is ")" or "("):
690
691 // Accumulate function content until next () parenthesis:
692 $funcContent = $this->nextPart($parseString,'^([^()]*.)');
693 $stack[$pnt]['func_content.'][] = array(
694 'level' => $level,
695 'func_content' => substr($funcContent,0,-1)
696 );
697 $stack[$pnt]['func_content'].= $funcContent;
698
699 // Detecting ( or )
700 switch(substr($stack[$pnt]['func_content'],-1)) {
701 case '(':
702 $level++;
703 break;
704 case ')':
705 $level--;
706 if (!$level) { // If this was the last parenthesis:
707 $stack[$pnt]['func_content'] = substr($stack[$pnt]['func_content'],0,-1);
708 $parseString = ltrim($parseString); // Remove any whitespace after the parenthesis.
709 }
710 break;
711 }
712 } else { // Outside parenthesis, looking for next field:
713
714 // Looking for a known function (only known functions supported)
715 $func = $this->nextPart($parseString,'^(count|max|min|floor|sum|avg)[[:space:]]*\(');
716 if ($func) {
717 $parseString = trim(substr($parseString,1)); // Strip of "("
718 $stack[$pnt]['type'] = 'function';
719 $stack[$pnt]['function'] = $func;
720 $level++; // increse parenthesis level counter.
721 } else {
722 $stack[$pnt]['distinct'] = $this->nextPart($parseString,'^(distinct[[:space:]]+)');
723 // Otherwise, look for regular fieldname:
724 if ($fieldName = $this->nextPart($parseString,'^([[:alnum:]\*._]+)(,|[[:space:]]+)')) {
725 $stack[$pnt]['type'] = 'field';
726
727 // Explode fieldname into field and table:
728 $tableField = explode('.',$fieldName,2);
729 if (count($tableField)==2) {
730 $stack[$pnt]['table'] = $tableField[0];
731 $stack[$pnt]['field'] = $tableField[1];
732 } else {
733 $stack[$pnt]['table'] = '';
734 $stack[$pnt]['field'] = $tableField[0];
735 }
736 } else {
737 return $this->parseError('No field name found as expected in parseFieldList()',$parseString);
738 }
739 }
740 }
741
742 // After a function or field we look for "AS" alias and a comma to separate to the next field in the list:
743 if (!$level) {
744
745 // Looking for "AS" alias:
746 if ($as = $this->nextPart($parseString,'^(AS)[[:space:]]+')) {
747 $stack[$pnt]['as'] = $this->nextPart($parseString,'^([[:alnum:]_]+)(,|[[:space:]]+)');
748 $stack[$pnt]['as_keyword'] = $as;
749 }
750
751 // Looking for "ASC" or "DESC" keywords (for ORDER BY)
752 if ($sDir = $this->nextPart($parseString,'^(ASC|DESC)([[:space:]]+|,)')) {
753 $stack[$pnt]['sortDir'] = $sDir;
754 }
755
756 // Looking for stop-keywords:
757 if ($stopRegex && $this->lastStopKeyWord = $this->nextPart($parseString, $stopRegex)) {
758 $this->lastStopKeyWord = strtoupper(str_replace(array(' ',"\t","\r","\n"),'',$this->lastStopKeyWord));
759 return $stack;
760 }
761
762 // Looking for comma (since the stop-keyword did not trigger a return...)
763 if (strlen($parseString) && !$this->nextPart($parseString,'^(,)')) {
764 return $this->parseError('No comma found as expected in parseFieldList()',$parseString);
765 }
766
767 // Increasing pointer:
768 $pnt++;
769 }
770
771 // Check recursivity brake:
772 $loopExit++;
773 if ($loopExit>500) {
774 return $this->parseError('More than 500 loops, exiting prematurely in parseFieldList()...',$parseString);
775 }
776 }
777
778 // Return result array:
779 return $stack;
780 }
781
782 /**
783 * Parsing the tablenames in the "FROM [$parseString] WHERE" part of a query into an array.
784 * The success of this parsing determines if that part of the query is supported by TYPO3.
785 *
786 * @param string list of tables, eg. "pages, tt_content" or "pages A, pages B". NOTICE: passed by reference!
787 * @param string Regular expressing to STOP parsing, eg. '^(WHERE)([[:space:]]*)'
788 * @return array If successful parsing, returns an array, otherwise an error string.
789 * @see compileFromTables()
790 */
791 public function parseFromTables(&$parseString, $stopRegex = '') {
792
793 // Prepare variables:
794 $parseString = $this->trimSQL($parseString);
795 $this->lastStopKeyWord = '';
796 $this->parse_error = '';
797
798 $stack = array(); // Contains the parsed content
799 $pnt = 0; // Pointer to positions in $stack
800 $loopExit = 0; // Recursivity brake.
801
802 // $parseString is continously shortend by the process and we keep parsing it till it is zero:
803 while (strlen($parseString)) {
804 // Looking for the table:
805 if ($stack[$pnt]['table'] = $this->nextPart($parseString,'^([[:alnum:]_]+)(,|[[:space:]]+)')) {
806 // Looking for stop-keywords before fetching potential table alias:
807 if ($stopRegex && ($this->lastStopKeyWord = $this->nextPart($parseString, $stopRegex))) {
808 $this->lastStopKeyWord = strtoupper(str_replace(array(' ',"\t","\r","\n"),'',$this->lastStopKeyWord));
809 return $stack;
810 }
811 if(!preg_match('/^(LEFT|JOIN)[[:space:]]+/i',$parseString)) {
812 $stack[$pnt]['as_keyword'] = $this->nextPart($parseString,'^(AS[[:space:]]+)');
813 $stack[$pnt]['as'] = $this->nextPart($parseString,'^([[:alnum:]_]+)[[:space:]]*');
814 }
815 } else return $this->parseError('No table name found as expected in parseFromTables()!',$parseString);
816
817 // Looking for JOIN
818 if ($join = $this->nextPart($parseString,'^(LEFT[[:space:]]+JOIN|LEFT[[:space:]]+OUTER[[:space:]]+JOIN|JOIN)[[:space:]]+')) {
819 $stack[$pnt]['JOIN']['type'] = $join;
820 if ($stack[$pnt]['JOIN']['withTable'] = $this->nextPart($parseString, '^([[:alnum:]_]+)[[:space:]]+', 1)) {
821 if (!preg_match('/^ON[[:space:]]+/i', $parseString)) {
822 $stack[$pnt]['JOIN']['as_keyword'] = $this->nextPart($parseString, '^(AS[[:space:]]+)');
823 $stack[$pnt]['JOIN']['as'] = $this->nextPart($parseString, '^([[:alnum:]_]+)[[:space:]]+');
824 }
825 if (!$this->nextPart($parseString, '^(ON[[:space:]]+)')) {
826 return $this->parseError('No join condition found in parseFromTables()!', $parseString);
827 }
828 $field1 = $this->nextPart($parseString,'^([[:alnum:]_.]+)[[:space:]]*=[[:space:]]*',1);
829 $field2 = $this->nextPart($parseString,'^([[:alnum:]_.]+)[[:space:]]+');
830 if ($field1 && $field2) {
831
832 // Explode fields into field and table:
833 $tableField = explode('.',$field1,2);
834 $field1 = array();
835 if (count($tableField)!=2) {
836 $field1['table'] = '';
837 $field1['field'] = $tableField[0];
838 } else {
839 $field1['table'] = $tableField[0];
840 $field1['field'] = $tableField[1];
841 }
842 $tableField = explode('.',$field2,2);
843 $field2 = array();
844 if (count($tableField)!=2) {
845 $field2['table'] = '';
846 $field2['field'] = $tableField[0];
847 } else {
848 $field2['table'] = $tableField[0];
849 $field2['field'] = $tableField[1];
850 }
851 $stack[$pnt]['JOIN']['ON'] = array($field1,$field2);
852 } else return $this->parseError('No join fields found in parseFromTables()!',$parseString);
853 } else return $this->parseError('No join table found in parseFromTables()!',$parseString);
854 }
855
856 // Looking for stop-keywords:
857 if ($stopRegex && $this->lastStopKeyWord = $this->nextPart($parseString, $stopRegex)) {
858 $this->lastStopKeyWord = strtoupper(str_replace(array(' ',"\t","\r","\n"),'',$this->lastStopKeyWord));
859 return $stack;
860 }
861
862 // Looking for comma:
863 if (strlen($parseString) && !$this->nextPart($parseString,'^(,)')) {
864 return $this->parseError('No comma found as expected in parseFromTables()',$parseString);
865 }
866
867 // Increasing pointer:
868 $pnt++;
869
870 // Check recursivity brake:
871 $loopExit++;
872 if ($loopExit>500) {
873 return $this->parseError('More than 500 loops, exiting prematurely in parseFromTables()...',$parseString);
874 }
875 }
876
877 // Return result array:
878 return $stack;
879 }
880
881 /**
882 * Parsing the WHERE clause fields in the "WHERE [$parseString] ..." part of a query into a multidimensional array.
883 * The success of this parsing determines if that part of the query is supported by TYPO3.
884 *
885 * @param string WHERE clause to parse. NOTICE: passed by reference!
886 * @param string Regular expressing to STOP parsing, eg. '^(GROUP BY|ORDER BY|LIMIT)([[:space:]]*)'
887 * @return mixed If successful parsing, returns an array, otherwise an error string.
888 */
889 public function parseWhereClause(&$parseString, $stopRegex = '') {
890
891 // Prepare variables:
892 $parseString = $this->trimSQL($parseString);
893 $this->lastStopKeyWord = '';
894 $this->parse_error = '';
895
896 $stack = array(0 => array()); // Contains the parsed content
897 $pnt = array(0 => 0); // Pointer to positions in $stack
898 $level = 0; // Determines parenthesis level
899 $loopExit = 0; // Recursivity brake.
900
901 // $parseString is continously shortend by the process and we keep parsing it till it is zero:
902 while (strlen($parseString)) {
903
904 // Look for next parenthesis level:
905 $newLevel = $this->nextPart($parseString,'^([(])');
906 if ($newLevel=='(') { // If new level is started, manage stack/pointers:
907 $level++; // Increase level
908 $pnt[$level] = 0; // Reset pointer for this level
909 $stack[$level] = array(); // Reset stack for this level
910 } else { // If no new level is started, just parse the current level:
911
912 // Find "modifyer", eg. "NOT or !"
913 $stack[$level][$pnt[$level]]['modifier'] = trim($this->nextPart($parseString,'^(!|NOT[[:space:]]+)'));
914
915 // Support calculated value only for:
916 // - "&" (boolean AND)
917 // - "+" (addition)
918 // - "-" (substraction)
919 // - "*" (multiplication)
920 // - "/" (division)
921 // - "%" (modulo)
922 $calcOperators = '&|\+|-|\*|\/|%';
923
924 // Fieldname:
925 if ($fieldName = $this->nextPart($parseString, '^([[:alnum:]._]+)([[:space:]]+|' . $calcOperators . '|<=|>=|<|>|=|!=|IS)')) {
926
927 // Parse field name into field and table:
928 $tableField = explode('.',$fieldName,2);
929 if (count($tableField)==2) {
930 $stack[$level][$pnt[$level]]['table'] = $tableField[0];
931 $stack[$level][$pnt[$level]]['field'] = $tableField[1];
932 } else {
933 $stack[$level][$pnt[$level]]['table'] = '';
934 $stack[$level][$pnt[$level]]['field'] = $tableField[0];
935 }
936 } else {
937 return $this->parseError('No field name found as expected in parseWhereClause()',$parseString);
938 }
939
940 // See if the value is calculated:
941 $stack[$level][$pnt[$level]]['calc'] = $this->nextPart($parseString, '^(' . $calcOperators . ')');
942 if (strlen($stack[$level][$pnt[$level]]['calc'])) {
943 // Finding value for calculation:
944 $stack[$level][$pnt[$level]]['calc_value'] = $this->getValue($parseString);
945 }
946
947 // Find "comparator":
948 $stack[$level][$pnt[$level]]['comparator'] = $this->nextPart($parseString,'^(<=|>=|<|>|=|!=|NOT[[:space:]]+IN|IN|NOT[[:space:]]+LIKE|LIKE|IS[[:space:]]+NOT|IS)');
949 if (strlen($stack[$level][$pnt[$level]]['comparator'])) {
950 // Finding value for comparator:
951 $stack[$level][$pnt[$level]]['value'] = $this->getValue($parseString,$stack[$level][$pnt[$level]]['comparator']);
952 if ($this->parse_error) { return $this->parse_error; }
953 }
954
955 // Finished, increase pointer:
956 $pnt[$level]++;
957
958 // Checking if the current level is ended, in that case do stack management:
959 while ($this->nextPart($parseString,'^([)])')) {
960 $level--; // Decrease level:
961 $stack[$level][$pnt[$level]]['sub'] = $stack[$level+1]; // Copy stack
962 $pnt[$level]++; // Increase pointer of the new level
963
964 // Make recursivity check:
965 $loopExit++;
966 if ($loopExit>500) {
967 return $this->parseError('More than 500 loops (in search for exit parenthesis), exiting prematurely in parseWhereClause()...',$parseString);
968 }
969 }
970
971 // Detecting the operator for the next level:
972 $op = $this->nextPart($parseString, '^(AND[[:space:]]+NOT|&&[[:space:]]+NOT|OR[[:space:]]+NOT|OR[[:space:]]+NOT|\|\|[[:space:]]+NOT|AND|&&|OR|\|\|)(\(|[[:space:]]+)');
973 if ($op) {
974 // Normalize boolean operator
975 $op = str_replace(array('&&', '||'), array('AND', 'OR'), $op);
976 $stack[$level][$pnt[$level]]['operator'] = $op;
977 } elseif (strlen($parseString)) {
978
979 // Looking for stop-keywords:
980 if ($stopRegex && $this->lastStopKeyWord = $this->nextPart($parseString, $stopRegex)) {
981 $this->lastStopKeyWord = strtoupper(str_replace(array(' ',"\t","\r","\n"),'',$this->lastStopKeyWord));
982 return $stack[0];
983 } else {
984 return $this->parseError('No operator, but parsing not finished in parseWhereClause().',$parseString);
985 }
986 }
987 }
988
989 // Make recursivity check:
990 $loopExit++;
991 if ($loopExit>500) {
992 return $this->parseError('More than 500 loops, exiting prematurely in parseWhereClause()...',$parseString);
993 }
994 }
995
996 // Return the stacks lowest level:
997 return $stack[0];
998 }
999
1000 /**
1001 * Parsing the WHERE clause fields in the "WHERE [$parseString] ..." part of a query into a multidimensional array.
1002 * The success of this parsing determines if that part of the query is supported by TYPO3.
1003 *
1004 * @param string WHERE clause to parse. NOTICE: passed by reference!
1005 * @param string Regular expressing to STOP parsing, eg. '^(GROUP BY|ORDER BY|LIMIT)([[:space:]]*)'
1006 * @return mixed If successful parsing, returns an array, otherwise an error string.
1007 */
1008 public function parseFieldDef(&$parseString, $stopRegex = '') {
1009 // Prepare variables:
1010 $parseString = $this->trimSQL($parseString);
1011 $this->lastStopKeyWord = '';
1012 $this->parse_error = '';
1013
1014 $result = array();
1015
1016 // Field type:
1017 if ($result['fieldType'] = $this->nextPart($parseString,'^(int|smallint|tinyint|mediumint|bigint|double|numeric|decimal|float|varchar|char|text|tinytext|mediumtext|longtext|blob|tinyblob|mediumblob|longblob)([[:space:],]+|\()')) {
1018
1019 // Looking for value:
1020 if (substr($parseString,0,1)=='(') {
1021 $parseString = substr($parseString,1);
1022 if ($result['value'] = $this->nextPart($parseString,'^([^)]*)')) {
1023 $parseString = ltrim(substr($parseString,1));
1024 } else return $this->parseError('No end-parenthesis for value found in parseFieldDef()!',$parseString);
1025 }
1026
1027 // Looking for keywords
1028 while($keyword = $this->nextPart($parseString,'^(DEFAULT|NOT[[:space:]]+NULL|AUTO_INCREMENT|UNSIGNED)([[:space:]]+|,|\))')) {
1029 $keywordCmp = strtoupper(str_replace(array(' ',"\t","\r","\n"),'',$keyword));
1030
1031 $result['featureIndex'][$keywordCmp]['keyword'] = $keyword;
1032
1033 switch($keywordCmp) {
1034 case 'DEFAULT':
1035 $result['featureIndex'][$keywordCmp]['value'] = $this->getValue($parseString);
1036 break;
1037 }
1038 }
1039 } else {
1040 return $this->parseError('Field type unknown in parseFieldDef()!',$parseString);
1041 }
1042
1043 return $result;
1044 }
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056 /************************************
1057 *
1058 * Parsing: Helper functions
1059 *
1060 ************************************/
1061
1062 /**
1063 * Strips off a part of the parseString and returns the matching part.
1064 * Helper function for the parsing methods.
1065 *
1066 * @param string Parse string; if $regex finds anything the value of the first () level will be stripped of the string in the beginning. Further $parseString is left-trimmed (on success). Notice; parsestring is passed by reference.
1067 * @param string Regex to find a matching part in the beginning of the string. Rules: You MUST start the regex with "^" (finding stuff in the beginning of string) and the result of the first parenthesis is what will be returned to you (and stripped of the string). Eg. '^(AND|OR|&&)[[:space:]]+' will return AND, OR or && if found and having one of more whitespaces after it, plus shorten $parseString with that match and any space after (by ltrim())
1068 * @param boolean If set the full match of the regex is stripped of the beginning of the string!
1069 * @return string The value of the first parenthesis level of the REGEX.
1070 */
1071 protected function nextPart(&$parseString, $regex, $trimAll = FALSE) {
1072 $reg = array();
1073 if (preg_match('/'.$regex.'/i',$parseString.' ', $reg)) { // Adding space char because [[:space:]]+ is often a requirement in regex's
1074 $parseString = ltrim(substr($parseString,strlen($reg[$trimAll?0:1])));
1075 return $reg[1];
1076 }
1077 }
1078
1079 /**
1080 * Finds value in beginning of $parseString, returns result and strips it of parseString
1081 *
1082 * @param string The parseString, eg. "(0,1,2,3) ..." or "('asdf','qwer') ..." or "1234 ..." or "'My string value here' ..."
1083 * @param string The comparator used before. If "NOT IN" or "IN" then the value is expected to be a list of values. Otherwise just an integer (un-quoted) or string (quoted)
1084 * @return mixed The value (string/integer). Otherwise an array with error message in first key (0)
1085 */
1086 protected function getValue(&$parseString, $comparator = '') {
1087 $value = '';
1088
1089 if (t3lib_div::inList('NOTIN,IN,_LIST',strtoupper(str_replace(array(' ',"\n","\r","\t"),'',$comparator)))) { // List of values:
1090 if ($this->nextPart($parseString,'^([(])')) {
1091 $listValues = array();
1092 $comma=',';
1093
1094 while($comma==',') {
1095 $listValues[] = $this->getValue($parseString);
1096 $comma = $this->nextPart($parseString,'^([,])');
1097 }
1098
1099 $out = $this->nextPart($parseString,'^([)])');
1100 if ($out) {
1101 if ($comparator=='_LIST') {
1102 $kVals = array();
1103 foreach ($listValues as $vArr) {
1104 $kVals[] = $vArr[0];
1105 }
1106 return $kVals;
1107 } else {
1108 return $listValues;
1109 }
1110 } else return array($this->parseError('No ) parenthesis in list',$parseString));
1111 } else return array($this->parseError('No ( parenthesis starting the list',$parseString));
1112
1113 } else { // Just plain string value, in quotes or not:
1114
1115 // Quote?
1116 $firstChar = substr($parseString,0,1);
1117 switch($firstChar) {
1118 case '"':
1119 $value = array($this->getValueInQuotes($parseString,'"'),'"');
1120 break;
1121 case "'":
1122 $value = array($this->getValueInQuotes($parseString,"'"),"'");
1123 break;
1124 default:
1125 $reg = array();
1126 if (preg_match('/^([[:alnum:]._-]+)/i',$parseString, $reg)) {
1127 $parseString = ltrim(substr($parseString,strlen($reg[0])));
1128 $value = array($reg[1]);
1129 }
1130 break;
1131 }
1132 }
1133 return $value;
1134 }
1135
1136 /**
1137 * Get value in quotes from $parseString.
1138 * NOTICE: If a query being parsed was prepared for another database than MySQL this function should probably be changed
1139 *
1140 * @param string String from which to find value in quotes. Notice that $parseString is passed by reference and is shortend by the output of this function.
1141 * @param string The quote used; input either " or '
1142 * @return string The value, passed through stripslashes() !
1143 */
1144 protected function getValueInQuotes(&$parseString, $quote) {
1145
1146 $parts = explode($quote,substr($parseString,1));
1147 $buffer = '';
1148 foreach($parts as $k => $v) {
1149 $buffer.=$v;
1150
1151 $reg = array();
1152 preg_match('/\\*$/',$v,$reg);
1153 if ($reg AND strlen($reg[0])%2) {
1154 $buffer.=$quote;
1155 } else {
1156 $parseString = ltrim(substr($parseString,strlen($buffer)+2));
1157 return $this->parseStripslashes($buffer);
1158 }
1159 }
1160 }
1161
1162 /**
1163 * Strip slashes function used for parsing
1164 * NOTICE: If a query being parsed was prepared for another database than MySQL this function should probably be changed
1165 *
1166 * @param string Input string
1167 * @return string Output string
1168 */
1169 protected function parseStripslashes($str) {
1170 $search = array('\\\\', '\\\'', '\\"', '\0', '\n', '\r', '\Z');
1171 $replace = array('\\', '\'', '"', "\x00", "\x0a", "\x0d", "\x1a");
1172
1173 return str_replace($search, $replace, $str);
1174 }
1175
1176 /**
1177 * Add slashes function used for compiling queries
1178 * NOTICE: If a query being parsed was prepared for another database than MySQL this function should probably be changed
1179 *
1180 * @param string Input string
1181 * @return string Output string
1182 */
1183 protected function compileAddslashes($str) {
1184 return $str;
1185 $search = array('\\', '\'', '"', "\x00", "\x0a", "\x0d", "\x1a");
1186 $replace = array('\\\\', '\\\'', '\\"', '\0', '\n', '\r', '\Z');
1187
1188 return str_replace($search, $replace, $str);
1189 }
1190
1191 /**
1192 * Setting the internal error message value, $this->parse_error and returns that value.
1193 *
1194 * @param string Input error message
1195 * @param string Remaining query to parse.
1196 * @return string Error message.
1197 */
1198 protected function parseError($msg, $restQuery) {
1199 $this->parse_error = 'SQL engine parse ERROR: '.$msg.': near "'.substr($restQuery,0,50).'"';
1200 return $this->parse_error;
1201 }
1202
1203 /**
1204 * Trimming SQL as preparation for parsing.
1205 * ";" in the end is stripped of.
1206 * White space is trimmed away around the value
1207 * A single space-char is added in the end
1208 *
1209 * @param string Input string
1210 * @return string Output string
1211 */
1212 protected function trimSQL($str) {
1213 return trim(rtrim($str, "; \r\n\t")).' ';
1214 }
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227 /*************************
1228 *
1229 * Compiling queries
1230 *
1231 *************************/
1232
1233 /**
1234 * Compiles an SQL query from components
1235 *
1236 * @param array Array of SQL query components
1237 * @return string SQL query
1238 * @see parseSQL()
1239 */
1240 public function compileSQL($components) {
1241 switch($components['type']) {
1242 case 'SELECT':
1243 $query = $this->compileSELECT($components);
1244 break;
1245 case 'UPDATE':
1246 $query = $this->compileUPDATE($components);
1247 break;
1248 case 'INSERT':
1249 $query = $this->compileINSERT($components);
1250 break;
1251 case 'DELETE':
1252 $query = $this->compileDELETE($components);
1253 break;
1254 case 'EXPLAIN':
1255 $query = 'EXPLAIN '.$this->compileSELECT($components);
1256 break;
1257 case 'DROPTABLE':
1258 $query = 'DROP TABLE'.($components['ifExists']?' IF EXISTS':'').' '.$components['TABLE'];
1259 break;
1260 case 'CREATETABLE':
1261 $query = $this->compileCREATETABLE($components);
1262 break;
1263 case 'ALTERTABLE':
1264 $query = $this->compileALTERTABLE($components);
1265 break;
1266 }
1267
1268 return $query;
1269 }
1270
1271 /**
1272 * Compiles a SELECT statement from components array
1273 *
1274 * @param array Array of SQL query components
1275 * @return string SQL SELECT query
1276 * @see parseSELECT()
1277 */
1278 protected function compileSELECT($components) {
1279
1280 // Initialize:
1281 $where = $this->compileWhereClause($components['WHERE']);
1282 $groupBy = $this->compileFieldList($components['GROUPBY']);
1283 $orderBy = $this->compileFieldList($components['ORDERBY']);
1284 $limit = $components['LIMIT'];
1285
1286 // Make query:
1287 $query = 'SELECT '.($components['STRAIGHT_JOIN'] ? $components['STRAIGHT_JOIN'].'' : '').'
1288 '.$this->compileFieldList($components['SELECT']).'
1289 FROM '.$this->compileFromTables($components['FROM']).
1290 (strlen($where)?'
1291 WHERE '.$where : '').
1292 (strlen($groupBy)?'
1293 GROUP BY '.$groupBy : '').
1294 (strlen($orderBy)?'
1295 ORDER BY '.$orderBy : '').
1296 (strlen($limit)?'
1297 LIMIT '.$limit : '');
1298
1299 return $query;
1300 }
1301
1302 /**
1303 * Compiles an UPDATE statement from components array
1304 *
1305 * @param array Array of SQL query components
1306 * @return string SQL UPDATE query
1307 * @see parseUPDATE()
1308 */
1309 protected function compileUPDATE($components) {
1310
1311 // Where clause:
1312 $where = $this->compileWhereClause($components['WHERE']);
1313
1314 // Fields
1315 $fields = array();
1316 foreach($components['FIELDS'] as $fN => $fV) {
1317 $fields[]=$fN.'='.$fV[1].$this->compileAddslashes($fV[0]).$fV[1];
1318 }
1319
1320 // Make query:
1321 $query = 'UPDATE '.$components['TABLE'].' SET
1322 '.implode(',
1323 ',$fields).'
1324 '.(strlen($where)?'
1325 WHERE '.$where : '');
1326
1327 return $query;
1328 }
1329
1330 /**
1331 * Compiles an INSERT statement from components array
1332 *
1333 * @param array Array of SQL query components
1334 * @return string SQL INSERT query
1335 * @see parseINSERT()
1336 */
1337 protected function compileINSERT($components) {
1338
1339 if ($components['VALUES_ONLY']) {
1340 // Initialize:
1341 $fields = array();
1342 foreach($components['VALUES_ONLY'] as $fV) {
1343 $fields[]=$fV[1].$this->compileAddslashes($fV[0]).$fV[1];
1344 }
1345
1346 // Make query:
1347 $query = 'INSERT INTO '.$components['TABLE'].'
1348 VALUES
1349 ('.implode(',
1350 ',$fields).')';
1351 } else {
1352 // Initialize:
1353 $fields = array();
1354 foreach($components['FIELDS'] as $fN => $fV) {
1355 $fields[$fN]=$fV[1].$this->compileAddslashes($fV[0]).$fV[1];
1356 }
1357
1358 // Make query:
1359 $query = 'INSERT INTO '.$components['TABLE'].'
1360 ('.implode(',
1361 ',array_keys($fields)).')
1362 VALUES
1363 ('.implode(',
1364 ',$fields).')';
1365 }
1366
1367 return $query;
1368 }
1369
1370 /**
1371 * Compiles an DELETE statement from components array
1372 *
1373 * @param array Array of SQL query components
1374 * @return string SQL DELETE query
1375 * @see parseDELETE()
1376 */
1377 protected function compileDELETE($components) {
1378
1379 // Where clause:
1380 $where = $this->compileWhereClause($components['WHERE']);
1381
1382 // Make query:
1383 $query = 'DELETE FROM '.$components['TABLE'].
1384 (strlen($where)?'
1385 WHERE '.$where : '');
1386
1387 return $query;
1388 }
1389
1390 /**
1391 * Compiles a CREATE TABLE statement from components array
1392 *
1393 * @param array Array of SQL query components
1394 * @return string SQL CREATE TABLE query
1395 * @see parseCREATETABLE()
1396 */
1397 protected function compileCREATETABLE($components) {
1398
1399 // Create fields and keys:
1400 $fieldsKeys = array();
1401 foreach($components['FIELDS'] as $fN => $fCfg) {
1402 $fieldsKeys[]=$fN.' '.$this->compileFieldCfg($fCfg['definition']);
1403 }
1404 foreach($components['KEYS'] as $kN => $kCfg) {
1405 if ($kN == 'PRIMARYKEY') {
1406 $fieldsKeys[]='PRIMARY KEY ('.implode(',', $kCfg).')';
1407 } elseif ($kN == 'UNIQUE') {
1408 $fieldsKeys[]='UNIQUE '.$kN.' ('.implode(',', $kCfg).')';
1409 } else {
1410 $fieldsKeys[]='KEY '.$kN.' ('.implode(',', $kCfg).')';
1411 }
1412 }
1413
1414 // Make query:
1415 $query = 'CREATE TABLE '.$components['TABLE'].' (
1416 '.implode(',
1417 ', $fieldsKeys).'
1418 )'.($components['tableType'] ? ' TYPE='.$components['tableType'] : '');
1419
1420 return $query;
1421 }
1422
1423 /**
1424 * Compiles an ALTER TABLE statement from components array
1425 *
1426 * @param array Array of SQL query components
1427 * @return string SQL ALTER TABLE query
1428 * @see parseALTERTABLE()
1429 */
1430 protected function compileALTERTABLE($components) {
1431
1432 // Make query:
1433 $query = 'ALTER TABLE '.$components['TABLE'].' '.$components['action'].' '.($components['FIELD']?$components['FIELD']:$components['KEY']);
1434
1435 // Based on action, add the final part:
1436 switch(strtoupper(str_replace(array(' ',"\t","\r","\n"),'',$components['action']))) {
1437 case 'ADD':
1438 $query.=' '.$this->compileFieldCfg($components['definition']);
1439 break;
1440 case 'CHANGE':
1441 $query.=' '.$components['newField'].' '.$this->compileFieldCfg($components['definition']);
1442 break;
1443 case 'DROP':
1444 case 'DROPKEY':
1445 break;
1446 case 'ADDKEY':
1447 case 'ADDPRIMARYKEY':
1448 $query.=' ('.implode(',',$components['fields']).')';
1449 break;
1450 }
1451
1452 // Return query
1453 return $query;
1454 }
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469 /**************************************
1470 *
1471 * Compiling queries, helper functions for parts of queries
1472 *
1473 **************************************/
1474
1475 /**
1476 * Compiles a "SELECT [output] FROM..:" field list based on input array (made with ->parseFieldList())
1477 * Can also compile field lists for ORDER BY and GROUP BY.
1478 *
1479 * @param array Array of select fields, (made with ->parseFieldList())
1480 * @return string Select field string
1481 * @see parseFieldList()
1482 */
1483 public function compileFieldList($selectFields) {
1484
1485 // Prepare buffer variable:
1486 $outputParts = array();
1487
1488 // Traverse the selectFields if any:
1489 if (is_array($selectFields)) {
1490 foreach($selectFields as $k => $v) {
1491
1492 // Detecting type:
1493 switch($v['type']) {
1494 case 'function':
1495 $outputParts[$k] = $v['function'].'('.$v['func_content'].')';
1496 break;
1497 case 'field':
1498 $outputParts[$k] = ($v['distinct']?$v['distinct']:'').($v['table']?$v['table'].'.':'').$v['field'];
1499 break;
1500 }
1501
1502 // Alias:
1503 if ($v['as']) {
1504 $outputParts[$k].= ' '.$v['as_keyword'].' '.$v['as'];
1505 }
1506
1507 // Specifically for ORDER BY and GROUP BY field lists:
1508 if ($v['sortDir']) {
1509 $outputParts[$k].= ' '.$v['sortDir'];
1510 }
1511 }
1512 }
1513
1514 // Return imploded buffer:
1515 return implode(', ',$outputParts);
1516 }
1517
1518 /**
1519 * Compiles a "FROM [output] WHERE..:" table list based on input array (made with ->parseFromTables())
1520 *
1521 * @param array Array of table names, (made with ->parseFromTables())
1522 * @return string Table name string
1523 * @see parseFromTables()
1524 */
1525 public function compileFromTables($tablesArray) {
1526
1527 // Prepare buffer variable:
1528 $outputParts = array();
1529
1530 // Traverse the table names:
1531 if (is_array($tablesArray)) {
1532 foreach($tablesArray as $k => $v) {
1533
1534 // Set table name:
1535 $outputParts[$k] = $v['table'];
1536
1537 // Add alias AS if there:
1538 if ($v['as']) {
1539 $outputParts[$k].= ' '.$v['as_keyword'].' '.$v['as'];
1540 }
1541
1542 if (is_array($v['JOIN'])) {
1543 $outputParts[$k] .= ' ' . $v['JOIN']['type'] . ' ' . $v['JOIN']['withTable'];
1544 // Add alias AS if there:
1545 if (isset($v['JOIN']['as']) && $v['JOIN']['as']) {
1546 $outputParts[$k] .= ' ' . $v['JOIN']['as_keyword'] . ' ' . $v['JOIN']['as'];
1547 }
1548 $outputParts[$k] .= ' ON ';
1549 $outputParts[$k] .= ($v['JOIN']['ON'][0]['table']) ? $v['JOIN']['ON'][0]['table'].'.' : '';
1550 $outputParts[$k] .= $v['JOIN']['ON'][0]['field'];
1551 $outputParts[$k] .= '=';
1552 $outputParts[$k] .= ($v['JOIN']['ON'][1]['table']) ? $v['JOIN']['ON'][1]['table'].'.' : '';
1553 $outputParts[$k] .= $v['JOIN']['ON'][1]['field'];
1554 }
1555 }
1556 }
1557
1558 // Return imploded buffer:
1559 return implode(', ',$outputParts);
1560 }
1561
1562 /**
1563 * Implodes an array of WHERE clause configuration into a WHERE clause.
1564 * NOTICE: MIGHT BY A TEMPORARY FUNCTION. Use for debugging only!
1565 * BUT IT IS NEEDED FOR DBAL - MAKE IT PERMANENT?!?!
1566 *
1567 * @param array WHERE clause configuration
1568 * @return string WHERE clause as string.
1569 * @see explodeWhereClause()
1570 */
1571 public function compileWhereClause($clauseArray) {
1572
1573 // Prepare buffer variable:
1574 $output='';
1575
1576 // Traverse clause array:
1577 if (is_array($clauseArray)) {
1578 foreach($clauseArray as $k => $v) {
1579
1580 // Set operator:
1581 $output.=$v['operator'] ? ' '.$v['operator'] : '';
1582
1583 // Look for sublevel:
1584 if (is_array($v['sub'])) {
1585 $output.=' ('.trim($this->compileWhereClause($v['sub'])).')';
1586 } else {
1587
1588 // Set field/table with modifying prefix if any:
1589 $output.=' '.trim($v['modifier'].' '.($v['table']?$v['table'].'.':'').$v['field']);
1590
1591 // Set calculation, if any:
1592 if ($v['calc']) {
1593 $output.=$v['calc'].$v['calc_value'][1].$this->compileAddslashes($v['calc_value'][0]).$v['calc_value'][1];
1594 }
1595
1596 // Set comparator:
1597 if ($v['comparator']) {
1598 $output.=' '.$v['comparator'];
1599
1600 // Detecting value type; list or plain:
1601 if (t3lib_div::inList('NOTIN,IN',strtoupper(str_replace(array(' ',"\t","\r","\n"),'',$v['comparator'])))) {
1602 $valueBuffer = array();
1603 foreach($v['value'] as $realValue) {
1604 $valueBuffer[]=$realValue[1].$this->compileAddslashes($realValue[0]).$realValue[1];
1605 }
1606 $output.=' ('.trim(implode(',',$valueBuffer)).')';
1607 } else {
1608 $output.=' '.$v['value'][1].$this->compileAddslashes($v['value'][0]).$v['value'][1];
1609 }
1610 }
1611 }
1612 }
1613 }
1614
1615 // Return output buffer:
1616 return $output;
1617 }
1618
1619 /**
1620 * Compile field definition
1621 *
1622 * @param array Field definition parts
1623 * @return string Field definition string
1624 */
1625 protected function compileFieldCfg($fieldCfg) {
1626
1627 // Set type:
1628 $cfg = $fieldCfg['fieldType'];
1629
1630 // Add value, if any:
1631 if (strlen($fieldCfg['value'])) {
1632 $cfg.='('.$fieldCfg['value'].')';
1633 }
1634
1635 // Add additional features:
1636 if (is_array($fieldCfg['featureIndex'])) {
1637 foreach($fieldCfg['featureIndex'] as $featureDef) {
1638 $cfg.=' '.$featureDef['keyword'];
1639
1640 // Add value if found:
1641 if (is_array($featureDef['value'])) {
1642 $cfg.=' '.$featureDef['value'][1].$this->compileAddslashes($featureDef['value'][0]).$featureDef['value'][1];
1643 }
1644 }
1645 }
1646
1647 // Return field definition string:
1648 return $cfg;
1649 }
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661 /*************************
1662 *
1663 * Debugging
1664 *
1665 *************************/
1666
1667 /**
1668 * Check parsability of input SQL part string; Will parse and re-compile after which it is compared
1669 *
1670 * @param string Part definition of string; "SELECT" = fieldlist (also ORDER BY and GROUP BY), "FROM" = table list, "WHERE" = Where clause.
1671 * @param string SQL string to verify parsability of
1672 * @return mixed Returns array with string 1 and 2 if error, otherwise false
1673 */
1674 public function debug_parseSQLpart($part, $str) {
1675 $retVal = false;
1676
1677 switch($part) {
1678 case 'SELECT':
1679 $retVal = $this->debug_parseSQLpartCompare($str,$this->compileFieldList($this->parseFieldList($str)));
1680 break;
1681 case 'FROM':
1682 $retVal = $this->debug_parseSQLpartCompare($str,$this->compileFromTables($this->parseFromTables($str)));
1683 break;
1684 case 'WHERE':
1685 $retVal = $this->debug_parseSQLpartCompare($str,$this->compileWhereClause($this->parseWhereClause($str)));
1686 break;
1687 }
1688 return $retVal;
1689 }
1690
1691 /**
1692 * Compare two query strins by stripping away whitespace.
1693 *
1694 * @param string SQL String 1
1695 * @param string SQL string 2
1696 * @param boolean If true, the strings are compared insensitive to case
1697 * @return mixed Returns array with string 1 and 2 if error, otherwise false
1698 */
1699 public function debug_parseSQLpartCompare($str, $newStr, $caseInsensitive = FALSE) {
1700 if ($caseInsensitive) {
1701 $str1 = strtoupper($str);
1702 $str2 = strtoupper($newStr);
1703 } else {
1704 $str1 = $str;
1705 $str2 = $newStr;
1706 }
1707
1708 // Fixing escaped chars:
1709 $search = array('\0', '\n', '\r', '\Z');
1710 $replace = array("\x00", "\x0a", "\x0d", "\x1a");
1711 $str1 = str_replace($search, $replace, $str1);
1712 $str2 = str_replace($search, $replace, $str2);
1713
1714 # Normally, commented out since they are needed only in tricky cases...
1715 # $str1 = stripslashes($str1);
1716 # $str2 = stripslashes($str2);
1717
1718 if (strcmp(str_replace(array(' ',"\t","\r","\n"),'',$this->trimSQL($str1)),str_replace(array(' ',"\t","\r","\n"),'',$this->trimSQL($str2)))) {
1719 return array(
1720 str_replace(array(' ',"\t","\r","\n"),' ',$str),
1721 str_replace(array(' ',"\t","\r","\n"),' ',$newStr),
1722 );
1723 }
1724 }
1725
1726 /**
1727 * Performs the ultimate test of the parser: Direct a SQL query in; You will get it back (through the parsed and re-compiled) if no problems, otherwise the script will print the error and exit
1728 *
1729 * @param string SQL query
1730 * @return string Query if all is well, otherwise exit.
1731 */
1732 public function debug_testSQL($SQLquery) {
1733
1734 // Getting result array:
1735 $parseResult = $this->parseSQL($SQLquery);
1736
1737 // If result array was returned, proceed. Otherwise show error and exit.
1738 if (is_array($parseResult)) {
1739
1740 // Re-compile query:
1741 $newQuery = $this->compileSQL($parseResult);
1742
1743 // TEST the new query:
1744 $testResult = $this->debug_parseSQLpartCompare($SQLquery, $newQuery);
1745
1746 // Return new query if OK, otherwise show error and exit:
1747 if (!is_array($testResult)) {
1748 return $newQuery;
1749 } else {
1750 debug(array('ERROR MESSAGE'=>'Input query did not match the parsed and recompiled query exactly (not observing whitespace)', 'TEST result' => $testResult),'SQL parsing failed:');
1751 exit;
1752 }
1753 } else {
1754 debug(array('query' => $SQLquery, 'ERROR MESSAGE'=>$parseResult),'SQL parsing failed:');
1755 exit;
1756 }
1757 }
1758 }
1759
1760
1761 if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_sqlparser.php']) {
1762 include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['t3lib/class.t3lib_sqlparser.php']);
1763 }
1764
1765 ?>