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
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik\Segment;
use Exception;
/**
*
*/
class SegmentExpression
{
const AND_DELIMITER = ';';
const OR_DELIMITER = ',';
const MATCH_EQUAL = '==';
const MATCH_NOT_EQUAL = '!=';
const MATCH_GREATER_OR_EQUAL = '>=';
const MATCH_LESS_OR_EQUAL = '<=';
const MATCH_GREATER = '>';
const MATCH_LESS = '<';
const MATCH_CONTAINS = '=@';
const MATCH_DOES_NOT_CONTAIN = '!@';
const MATCH_STARTS_WITH = '=^';
const MATCH_ENDS_WITH = '=$';
const BOOL_OPERATOR_OR = 'OR';
const BOOL_OPERATOR_AND = 'AND';
const BOOL_OPERATOR_END = '';
// Note: you can't write this in the API, but access this feature
// via field!= <- IS NOT NULL
// or via field== <- IS NULL / empty
const MATCH_IS_NOT_NULL_NOR_EMPTY = '::NOT_NULL';
const MATCH_IS_NULL_OR_EMPTY = '::NULL';
// Special case, since we look up Page URLs/Page titles in a sub SQL query
const MATCH_ACTIONS_CONTAINS = 'IN';
const INDEX_BOOL_OPERATOR = 0;
const INDEX_OPERAND = 1;
const INDEX_OPERAND_NAME = 0;
const INDEX_OPERAND_OPERATOR = 1;
const INDEX_OPERAND_VALUE = 2;
const SQL_WHERE_DO_NOT_MATCH_ANY_ROW = "(1 = 0)";
const SQL_WHERE_MATCHES_ALL_ROWS = "(1 = 1)";
public function __construct($string)
{
$this->string = $string;
$this->tree = $this->parseTree();
}
public function getSegmentDefinition()
{
return $this->string;
}
public function isEmpty()
{
return count($this->tree) == 0;
}
protected $joins = array();
protected $valuesBind = array();
protected $tree = array();
protected $parsedSubExpressions = array();
public function getSubExpressionCount()
{
$cleaned = array_filter($this->parsedSubExpressions, function ($part) {
$isExpressionColumnPresent = !empty($part[1][0]);
return $isExpressionColumnPresent;
});
return count($cleaned);
}
/**
* Given the array of parsed filters containing, for each filter,
* the boolean operator (AND/OR) and the operand,
* Will return the array where the filters are in SQL representation
*
* @throws Exception
* @return array
*/
public function parseSubExpressions()
{
$parsedSubExpressions = array();
foreach ($this->tree as $leaf) {
$operand = $leaf[self::INDEX_OPERAND];
$operand = urldecode($operand);
$operator = $leaf[self::INDEX_BOOL_OPERATOR];
$pattern = '/^(.+?)(' . self::MATCH_EQUAL . '|'
. self::MATCH_NOT_EQUAL . '|'
. self::MATCH_GREATER_OR_EQUAL . '|'
. self::MATCH_GREATER . '|'
. self::MATCH_LESS_OR_EQUAL . '|'
. self::MATCH_LESS . '|'
. self::MATCH_CONTAINS . '|'
. self::MATCH_DOES_NOT_CONTAIN . '|'
. preg_quote(self::MATCH_STARTS_WITH) . '|'
. preg_quote(self::MATCH_ENDS_WITH)
. '){1}(.*)/';
$match = preg_match($pattern, $operand, $matches);
if ($match == 0) {
throw new Exception('The segment condition \'' . $operand . '\' is not valid.');
}
$leftMember = $matches[1];
$operation = $matches[2];
$valueRightMember = urldecode($matches[3]);
// is null / is not null
if ($valueRightMember === '') {
if ($operation == self::MATCH_NOT_EQUAL) {
$operation = self::MATCH_IS_NOT_NULL_NOR_EMPTY;
} elseif ($operation == self::MATCH_EQUAL) {
$operation = self::MATCH_IS_NULL_OR_EMPTY;
} else {
throw new Exception('The segment \'' . $operand . '\' has no value specified. You can leave this value empty ' .
'only when you use the operators: ' . self::MATCH_NOT_EQUAL . ' (is not) or ' . self::MATCH_EQUAL . ' (is)');
}
}
$parsedSubExpressions[] = array(
self::INDEX_BOOL_OPERATOR => $operator,
self::INDEX_OPERAND => array(
self::INDEX_OPERAND_NAME => $leftMember,
self::INDEX_OPERAND_OPERATOR => $operation,
self::INDEX_OPERAND_VALUE => $valueRightMember,
));
}
$this->parsedSubExpressions = $parsedSubExpressions;
return $parsedSubExpressions;
}
/**
* Set the given expression
* @param $parsedSubExpressions
*/
public function setSubExpressionsAfterCleanup($parsedSubExpressions)
{
$this->parsedSubExpressions = $parsedSubExpressions;
}
/**
* @param array $availableTables
*/
public function parseSubExpressionsIntoSqlExpressions(&$availableTables = array())
{
$sqlSubExpressions = array();
$this->valuesBind = array();
$this->joins = array();
foreach ($this->parsedSubExpressions as $leaf) {
$operator = $leaf[self::INDEX_BOOL_OPERATOR];
$operandDefinition = $leaf[self::INDEX_OPERAND];
$operand = $this->getSqlMatchFromDefinition($operandDefinition, $availableTables);
if ($operand[self::INDEX_OPERAND_OPERATOR] !== null) {
if (is_array($operand[self::INDEX_OPERAND_OPERATOR])) {
$this->valuesBind = array_merge($this->valuesBind, $operand[self::INDEX_OPERAND_OPERATOR]);
} else {
$this->valuesBind[] = $operand[self::INDEX_OPERAND_OPERATOR];
}
}
$operand = $operand[self::INDEX_OPERAND_NAME];
$sqlSubExpressions[] = array(
self::INDEX_BOOL_OPERATOR => $operator,
self::INDEX_OPERAND => $operand,
);
}
$this->tree = $sqlSubExpressions;
}
/**
* Given an array representing one filter operand ( left member , operation , right member)
* Will return an array containing
* - the SQL substring,
* - the values to bind to this substring
*
* @param array $def
* @param array $availableTables
* @throws Exception
* @return array
*/
protected function getSqlMatchFromDefinition($def, &$availableTables)
{
$field = $def[0];
$matchType = $def[1];
$value = $def[2];
// Segment::getCleanedExpression() may return array(null, $matchType, null)
$operandWillNotMatchAnyRow = empty($field) && is_null($value);
if($operandWillNotMatchAnyRow) {
if($matchType == self::MATCH_EQUAL) {
// eg. pageUrl==DoesNotExist
// Equal to NULL means it will match none
$sqlExpression = self::SQL_WHERE_DO_NOT_MATCH_ANY_ROW;
} elseif($matchType == self::MATCH_NOT_EQUAL) {
// eg. pageUrl!=DoesNotExist
// Not equal to NULL means it matches all rows
$sqlExpression = self::SQL_WHERE_MATCHES_ALL_ROWS;
} elseif($matchType == self::MATCH_CONTAINS
|| $matchType == self::MATCH_DOES_NOT_CONTAIN
|| $matchType == self::MATCH_STARTS_WITH
|| $matchType == self::MATCH_ENDS_WITH) {
// no action was found for CONTAINS / DOES NOT CONTAIN
// eg. pageUrl=@DoesNotExist -> matches no row
// eg. pageUrl!@DoesNotExist -> matches no rows
$sqlExpression = self::SQL_WHERE_DO_NOT_MATCH_ANY_ROW;
} else {
// it is not expected to reach this code path
throw new Exception("Unexpected match type $matchType for your segment. " .
"Please report this issue to the Matomo team with the segment you are using.");
}
return array($sqlExpression, $value = null);
}
$alsoMatchNULLValues = false;
switch ($matchType) {
case self::MATCH_EQUAL:
$sqlMatch = '%s =';
break;
case self::MATCH_NOT_EQUAL:
$sqlMatch = '%s <>';
$alsoMatchNULLValues = true;
break;
case self::MATCH_GREATER:
$sqlMatch = '%s >';
break;
case self::MATCH_LESS:
$sqlMatch = '%s <';
break;
case self::MATCH_GREATER_OR_EQUAL:
$sqlMatch = '%s >=';
break;
case self::MATCH_LESS_OR_EQUAL:
$sqlMatch = '%s <=';
break;
case self::MATCH_CONTAINS:
$sqlMatch = '%s LIKE';
$value = '%' . $this->escapeLikeString($value) . '%';
break;
case self::MATCH_DOES_NOT_CONTAIN:
$sqlMatch = '%s NOT LIKE';
$value = '%' . $this->escapeLikeString($value) . '%';
$alsoMatchNULLValues = true;
break;
case self::MATCH_STARTS_WITH:
$sqlMatch = '%s LIKE';
$value = $this->escapeLikeString($value) . '%';
break;
case self::MATCH_ENDS_WITH:
$sqlMatch = '%s LIKE';
$value = '%' . $this->escapeLikeString($value);
break;
case self::MATCH_IS_NOT_NULL_NOR_EMPTY:
$sqlMatch = '%s IS NOT NULL AND %s <> \'\' AND %s <> \'0\'';
$value = null;
break;
case self::MATCH_IS_NULL_OR_EMPTY:
$sqlMatch = '%s IS NULL OR %s = \'\' OR %s = \'0\'';
$value = null;
break;
case self::MATCH_ACTIONS_CONTAINS:
// this match type is not accessible from the outside
// (it won't be matched in self::parseSubExpressions())
// it can be used internally to inject sub-expressions into the query.
// see Segment::getCleanedExpression()
$sqlMatch = '%s IN (' . $value['SQL'] . ')';
$value = $value['bind'];
break;
default:
throw new Exception("Filter contains the match type '" . $matchType . "' which is not supported");
break;
}
// We match NULL values when rows are excluded only when we are not doing a
$alsoMatchNULLValues = $alsoMatchNULLValues && !empty($value);
$sqlMatch = str_replace('%s', $field, $sqlMatch);
if ($matchType === self::MATCH_ACTIONS_CONTAINS
|| is_null($value)
) {
$sqlExpression = "( $sqlMatch )";
} else {
if ($alsoMatchNULLValues) {
$sqlExpression = "( $field IS NULL OR $sqlMatch ? )";
} else {
$sqlExpression = "$sqlMatch ?";
}
}
$columns = self::parseColumnsFromSqlExpr($field);
foreach ($columns as $column) {
$this->checkFieldIsAvailable($column, $availableTables);
}
return array($sqlExpression, $value);
}
/**
* @param string $field
* @return string[]
*/
public static function parseColumnsFromSqlExpr($field)
{
preg_match_all('/[^@a-zA-Z0-9_]?`?([@a-zA-Z_][@a-zA-Z0-9_]*`?\.`?[a-zA-Z0-9_`]+)`?\b/', $field, $matches);
$result = isset($matches[1]) ? $matches[1] : [];
$result = array_filter($result, function ($value) { // remove uses of session vars
return strpos($value, '@') === false;
});
$result = array_map(function ($item) {
return str_replace('`', '', $item);
}, $result);
$result = array_unique($result);
$result = array_values($result);
return $result;
}
/**
* Check whether the field is available
* If not, add it to the available tables
*
* @param string $field
* @param array $availableTables
*/
private function checkFieldIsAvailable($field, &$availableTables)
{
$fieldParts = explode('.', $field);
$table = count($fieldParts) == 2 ? $fieldParts[0] : false;
// remove sql functions from field name
// example: `HOUR(log_visit.visit_last_action_time)` gets `HOUR(log_visit` => remove `HOUR(`
$table = preg_replace('/^[A-Z_]+\(/', '', $table);
$tableExists = !$table || in_array($table, $availableTables);
if ($tableExists) {
return;
}
if (is_array($availableTables)) {
foreach ($availableTables as $availableTable) {
if (is_array($availableTable)) {
if (!isset($availableTable['tableAlias']) && $availableTable['table'] === $table) {
return;
} elseif (isset($availableTable['tableAlias']) && $availableTable['tableAlias'] === $table) {
return;
}
}
}
}
$availableTables[] = $table;
}
/**
* Escape the characters % and _ in the given string
* @param string $str
* @return string
*/
private function escapeLikeString($str)
{
if (false !== strpos($str, '%')) {
$str = str_replace("%", "\%", $str);
}
if (false !== strpos($str, '_')) {
$str = str_replace("_", "\_", $str);
}
return $str;
}
/**
* Given a filter string,
* will parse it into an array where each row contains the boolean operator applied to it,
* and the operand
*
* @return array
*/
protected function parseTree()
{
$string = $this->string;
if (empty($string)) {
return array();
}
$tree = array();
$i = 0;
$length = strlen($string);
$isBackslash = false;
$operand = '';
while ($i <= $length) {
$char = $string[$i];
$isAND = ($char == self::AND_DELIMITER);
$isOR = ($char == self::OR_DELIMITER);
$isEnd = ($length == $i + 1);
if ($isEnd) {
if ($isBackslash && ($isAND || $isOR)) {
$operand = substr($operand, 0, -1);
}
$operand .= $char;
$tree[] = array(self::INDEX_BOOL_OPERATOR => self::BOOL_OPERATOR_END, self::INDEX_OPERAND => $operand);
break;
}
if ($isAND && !$isBackslash) {
$tree[] = array(self::INDEX_BOOL_OPERATOR => self::BOOL_OPERATOR_AND, self::INDEX_OPERAND => $operand);
$operand = '';
} elseif ($isOR && !$isBackslash) {
$tree[] = array(self::INDEX_BOOL_OPERATOR => self::BOOL_OPERATOR_OR, self::INDEX_OPERAND => $operand);
$operand = '';
} else {
if ($isBackslash && ($isAND || $isOR)) {
$operand = substr($operand, 0, -1);
}
$operand .= $char;
}
$isBackslash = ($char == "\\");
$i++;
}
return $tree;
}
/**
* Given the array of parsed boolean logic, will return
* an array containing the full SQL string representing the filter,
* the needed joins and the values to bind to the query
*
* @throws Exception
* @return array SQL Query, Joins and Bind parameters
*/
public function getSql()
{
if ($this->isEmpty()) {
throw new Exception("Invalid segment, please specify a valid segment.");
}
$sql = '';
$subExpression = false;
foreach ($this->tree as $expression) {
$operator = $expression[self::INDEX_BOOL_OPERATOR];
$operand = $expression[self::INDEX_OPERAND];
if ($operator == self::BOOL_OPERATOR_OR
&& !$subExpression
) {
$sql .= ' (';
$subExpression = true;
} else {
$sql .= ' ';
}
$sql .= $operand;
if ($operator == self::BOOL_OPERATOR_AND
&& $subExpression
) {
$sql .= ')';
$subExpression = false;
}
$sql .= " $operator";
}
if ($subExpression) {
$sql .= ')';
}
return array(
'where' => $sql,
'bind' => $this->valuesBind,
'join' => implode(' ', $this->joins)
);
}
}
|