/
SQLProcessor.php
516 lines (461 loc) · 17.3 KB
/
SQLProcessor.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
<?php
/**
* SQLProcessor.php
*
* This file implements the processor for the base SQL statements.
*
* PHP version 5
*
* LICENSE:
* Copyright (c) 2010-2014 Justin Swanhart and André Rothe
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. The name of the author may not be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* @author André Rothe <andre.rothe@phosco.info>
* @copyright 2010-2014 Justin Swanhart and André Rothe
* @license http://www.debian.org/misc/bsd.license BSD License (3 Clause)
* @version SVN: $Id$
*
*/
namespace PHPSQLParser\processors;
/**
* This class processes the base SQL statements.
*
* @author André Rothe <andre.rothe@phosco.info>
* @author Marco Th. <marco64th@gmail.com>
* @license http://www.debian.org/misc/bsd.license BSD License (3 Clause)
*
*/
class SQLProcessor extends SQLChunkProcessor {
/**
* This function breaks up the SQL statement into logical sections.
* Some sections are delegated to specialized processors.
*/
public function process($tokens) {
$prev_category = "";
$token_category = "";
$skip_next = 0;
$out = false;
// $tokens may come as a numeric indexed array starting with an index greater than 0 (or as a boolean)
$tokenCount = count($tokens);
if ( is_array($tokens) ){
$tokens = array_values($tokens);
}
for ($tokenNumber = 0; $tokenNumber < $tokenCount; ++$tokenNumber) {
// https://github.com/greenlion/PHP-SQL-Parser/issues/279
// https://github.com/sinri/PHP-SQL-Parser/commit/eac592a0e19f1df6f420af3777a6d5504837faa7
// as there is no pull request for 279 by the user. His solution works and tested.
if (!isset($tokens[$tokenNumber])) continue;// as a fix by Sinri 20180528
$token = $tokens[$tokenNumber];
$trim = trim($token); // this removes also \n and \t!
// if it starts with an "(", it should follow a SELECT
if ($trim !== "" && $trim[0] === "(" && $token_category === "") {
$token_category = 'BRACKET';
$prev_category = $token_category;
}
/*
* If it isn't obvious, when $skip_next is set, then we ignore the next real token, that is we ignore whitespace.
*/
if ($skip_next > 0) {
if ($trim === "") {
if ($token_category !== "") { // is this correct??
$out[$token_category][] = $token;
}
continue;
}
// to skip the token we replace it with whitespace
$trim = "";
$token = "";
$skip_next--;
if ($skip_next > 0) {
continue;
}
}
$upper = strtoupper($trim);
switch ($upper) {
/* Tokens that get their own sections. These keywords have subclauses. */
case 'SELECT':
case 'ORDER':
case 'VALUES':
case 'GROUP':
case 'HAVING':
case 'WHERE':
case 'CALL':
case 'PROCEDURE':
case 'FUNCTION':
case 'SERVER':
case 'LOGFILE':
case 'DEFINER':
case 'RETURNS':
case 'TABLESPACE':
case 'TRIGGER':
case 'DO':
case 'FLUSH':
case 'KILL':
case 'RESET':
case 'STOP':
case 'PURGE':
case 'EXECUTE':
case 'PREPARE':
$token_category = $upper;
break;
case 'DEALLOCATE':
if ($trim === 'DEALLOCATE') {
$skip_next = 1;
}
$token_category = $upper;
break;
case 'DUPLICATE':
if ($token_category !== 'VALUES') {
$token_category = $upper;
}
break;
case 'SET':
if ($token_category !== 'TABLE') {
$token_category = $upper;
}
break;
case 'LIMIT':
case 'PLUGIN':
// no separate section
if ($token_category === 'SHOW') {
continue;
}
$token_category = $upper;
break;
case 'FROM':
// this FROM is different from FROM in other DML (not join related)
if ($token_category === 'PREPARE') {
continue 2;
}
// no separate section
if ($token_category === 'SHOW') {
continue;
}
$token_category = $upper;
break;
case 'EXPLAIN':
case 'DESCRIBE':
case 'SHOW':
$token_category = $upper;
break;
case 'DESC':
if ($token_category === '') {
// short version of DESCRIBE
$token_category = $upper;
}
// else direction of ORDER-BY
break;
case 'RENAME':
$token_category = $upper;
break;
case 'DATABASE':
case 'SCHEMA':
if ($prev_category === 'DROP') {
continue;
}
if ($prev_category === 'SHOW') {
continue;
}
$token_category = $upper;
break;
case 'EVENT':
// issue 71
if ($prev_category === 'DROP' || $prev_category === 'ALTER' || $prev_category === 'CREATE') {
$token_category = $upper;
}
break;
case 'DATA':
// prevent wrong handling of DATA as keyword
if ($prev_category === 'LOAD') {
$token_category = $upper;
}
break;
case 'INTO':
// prevent wrong handling of CACHE within LOAD INDEX INTO CACHE...
if ($prev_category === 'LOAD') {
$out[$prev_category][] = $trim;
continue 2;
}
$token_category = $prev_category = $upper;
break;
case 'USER':
// prevent wrong processing as keyword
if ($prev_category === 'CREATE' || $prev_category === 'RENAME' || $prev_category === 'DROP') {
$token_category = $upper;
}
break;
case 'VIEW':
// prevent wrong processing as keyword
if ($prev_category === 'CREATE' || $prev_category === 'ALTER' || $prev_category === 'DROP') {
$token_category = $upper;
}
break;
/*
* These tokens get their own section, but have no subclauses. These tokens identify the statement but have no specific subclauses of their own.
*/
case 'DELETE':
case 'ALTER':
case 'INSERT':
case 'TRUNCATE':
case 'OPTIMIZE':
case 'GRANT':
case 'REVOKE':
case 'HANDLER':
case 'LOAD':
case 'ROLLBACK':
case 'SAVEPOINT':
case 'UNLOCK':
case 'INSTALL':
case 'UNINSTALL':
case 'ANALZYE':
case 'BACKUP':
case 'CHECKSUM':
case 'REPAIR':
case 'RESTORE':
case 'HELP':
$token_category = $upper;
// set the category in case these get subclauses in a future version of MySQL
$out[$upper][0] = $trim;
continue 2;
case 'REPLACE':
if ($prev_category === '') {
// set the category in case these get subclauses in a future version of MySQL
$token_category = $upper;
$out[$upper][0] = $trim;
continue 2;
}
// part of the CREATE TABLE statement or a function
$out[$prev_category][] = $trim;
continue 2;
case 'IGNORE':
if ($prev_category === 'TABLE') {
// part of the CREATE TABLE statement
$out[$prev_category][] = $trim;
continue 2;
}
if ($token_category === 'FROM') {
// part of the FROM statement (index hint)
$out[$token_category][] = $trim;
continue 2;
}
$out['OPTIONS'][] = $upper;
continue 2;
case 'CHECK':
if ($prev_category === 'TABLE') {
$out[$prev_category][] = $trim;
continue 2;
}
$token_category = $upper;
$out[$upper][0] = $trim;
continue 2;
case 'CREATE':
if ($prev_category === 'SHOW') {
continue;
}
$token_category = $upper;
break;
case 'INDEX':
if ( in_array( $prev_category, array( 'CREATE', 'DROP' ) ) ) {
$out[ $prev_category ][] = $trim;
$token_category = $upper;
}
break;
case 'TABLE':
if ($prev_category === 'CREATE') {
$out[$prev_category][] = $trim;
$token_category = $upper;
}
if ($prev_category === 'TRUNCATE') {
$out[$prev_category][] = $trim;
$token_category = $upper;
}
break;
case 'TEMPORARY':
if ($prev_category === 'CREATE') {
$out[$prev_category][] = $trim;
$token_category = $prev_category;
continue 2;
}
break;
case 'IF':
if ($prev_category === 'TABLE') {
$token_category = 'CREATE';
$out[$token_category] = array_merge($out[$token_category], $out[$prev_category]);
$out[$prev_category] = array();
$out[$token_category][] = $trim;
$prev_category = $token_category;
continue 2;
}
break;
case 'NOT':
if ($prev_category === 'CREATE') {
$token_category = $prev_category;
$out[$prev_category][] = $trim;
continue 2;
}
break;
case 'EXISTS':
if ($prev_category === 'CREATE') {
$out[$prev_category][] = $trim;
$prev_category = $token_category = 'TABLE';
continue 2;
}
break;
case 'CACHE':
if ($prev_category === "" || $prev_category === 'RESET' || $prev_category === 'FLUSH'
|| $prev_category === 'LOAD') {
$token_category = $upper;
continue 2;
}
break;
/* This is either LOCK TABLES or SELECT ... LOCK IN SHARE MODE */
case 'LOCK':
if ($token_category === "") {
$token_category = $upper;
$out[$upper][0] = $trim;
} elseif ($token_category === 'INDEX') {
break;
} else {
$trim = 'LOCK IN SHARE MODE';
$skip_next = 3;
$out['OPTIONS'][] = $trim;
}
continue 2;
case 'USING': /* USING in FROM clause is different from USING w/ prepared statement*/
if ($token_category === 'EXECUTE') {
$token_category = $upper;
continue 2;
}
if ($token_category === 'FROM' && !empty($out['DELETE'])) {
$token_category = $upper;
continue 2;
}
break;
/* DROP TABLE is different from ALTER TABLE DROP ... */
case 'DROP':
if ($token_category !== 'ALTER') {
$token_category = $upper;
continue 2;
}
break;
case 'FOR':
if ($prev_category === 'SHOW') {
continue;
}
$skip_next = 1;
$out['OPTIONS'][] = 'FOR UPDATE'; // TODO: this could be generate problems within the position calculator
continue 2;
case 'UPDATE':
if ($token_category === "") {
$token_category = $upper;
continue 2;
}
if ($token_category === 'DUPLICATE') {
continue 2;
}
break;
case 'START':
$trim = "BEGIN";
$out[$upper][0] = $upper; // TODO: this could be generate problems within the position calculator
$skip_next = 1;
break;
// This token is ignored, except within RENAME
case 'TO':
if ($token_category === 'RENAME') {
break;
}
continue 2;
// This token is ignored, except within CREATE TABLE
case 'BY':
if ($prev_category === 'TABLE') {
break;
}
continue 2;
// These tokens are ignored.
case 'ALL':
case 'SHARE':
case 'MODE':
case ';':
continue 2;
case 'KEY':
if ($token_category === 'DUPLICATE') {
continue 2;
}
break;
/* These tokens set particular options for the statement. */
case 'LOW_PRIORITY':
case 'DELAYED':
case 'QUICK':
case 'HIGH_PRIORITY':
$out['OPTIONS'][] = $trim;
continue 2;
case 'USE':
if ($token_category === 'FROM') {
// index hint within FROM clause
$out[$token_category][] = $trim;
continue 2;
}
// set the category in case these get subclauses in a future version of MySQL
$token_category = $upper;
$out[$upper][0] = $trim;
continue 2;
case 'FORCE':
if ($token_category === 'FROM') {
// index hint within FROM clause
$out[$token_category][] = $trim;
continue 2;
}
$out['OPTIONS'][] = $trim;
continue 2;
case 'WITH':
if ($token_category === 'GROUP') {
$skip_next = 1;
$out['OPTIONS'][] = 'WITH ROLLUP'; // TODO: this could be generate problems within the position calculator
continue 2;
}
if ($token_category === '') {
$token_category = $upper;
}
break;
case 'AS':
break;
case '':
case ',':
case ';':
break;
default:
break;
}
// remove obsolete category after union (empty category because of
// empty token before select)
if ($token_category !== "" && ($prev_category === $token_category)) {
$out[$token_category][] = $token;
}
$prev_category = $token_category;
}
return parent::process($out);
}
}
?>