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
|
<?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;
use Exception;
use Piwik\API\Request;
use Piwik\ArchiveProcessor\Rules;
use Piwik\Container\StaticContainer;
use Piwik\DataAccess\LogQueryBuilder;
use Piwik\Plugins\SegmentEditor\SegmentEditor;
use Piwik\Segment\SegmentExpression;
/**
* Limits the set of visits Piwik uses when aggregating analytics data.
*
* A segment is a condition used to filter visits. They can, for example,
* select visits that have a specific browser or come from a specific
* country, or both.
*
* Plugins that aggregate data stored in Piwik can support segments by
* using this class when generating aggregation SQL queries.
*
* ### Examples
*
* **Basic usage**
*
* $idSites = array(1,2,3);
* $segmentStr = "browserCode==ff;countryCode==CA";
* $segment = new Segment($segmentStr, $idSites);
*
* $query = $segment->getSelectQuery(
* $select = "table.col1, table2.col2",
* $from = array("table", "table2"),
* $where = "table.col3 = ?",
* $bind = array(5),
* $orderBy = "table.col1 DESC",
* $groupBy = "table2.col2"
* );
*
* Db::fetchAll($query['sql'], $query['bind']);
*
* **Creating a _null_ segment**
*
* $idSites = array(1,2,3);
* $segment = new Segment('', $idSites);
* // $segment->getSelectQuery will return a query that selects all visits
*
* @api
*/
class Segment
{
/**
* @var SegmentExpression
*/
protected $segmentExpression = null;
/**
* @var string
*/
protected $string = null;
/**
* @var string
*/
protected $originalString = null;
/**
* @var array
*/
protected $idSites = null;
/**
* @var LogQueryBuilder
*/
private $segmentQueryBuilder;
/**
* @var bool
*/
private $isSegmentEncoded;
/**
* Truncate the Segments to 8k
*/
const SEGMENT_TRUNCATE_LIMIT = 8192;
/**
* Constructor.
*
* @param string $segmentCondition The segment condition, eg, `'browserCode=ff;countryCode=CA'`.
* @param array $idSites The list of sites the segment will be used with. Some segments are
* dependent on the site, such as goal segments.
* @throws
*/
public function __construct($segmentCondition, $idSites)
{
$this->segmentQueryBuilder = StaticContainer::get('Piwik\DataAccess\LogQueryBuilder');
$segmentCondition = trim($segmentCondition);
if (!SettingsPiwik::isSegmentationEnabled()
&& !empty($segmentCondition)
) {
throw new Exception("The Super User has disabled the Segmentation feature.");
}
$this->originalString = $segmentCondition;
// The segment expression can be urlencoded. Unfortunately, both the encoded and decoded versions
// can usually be parsed successfully. To pick the right one, we try both and pick the one w/ more
// successfully parsed subexpressions.
$subexpressionsDecoded = 0;
try {
$this->initializeSegment(urldecode($segmentCondition), $idSites);
$subexpressionsDecoded = $this->segmentExpression->getSubExpressionCount();
} catch (Exception $e) {
// ignore
}
$subexpressionsRaw = 0;
try {
$this->initializeSegment($segmentCondition, $idSites);
$subexpressionsRaw = $this->segmentExpression->getSubExpressionCount();
} catch (Exception $e) {
// ignore
}
if ($subexpressionsRaw > $subexpressionsDecoded) {
$this->initializeSegment($segmentCondition, $idSites);
$this->isSegmentEncoded = false;
} else {
$this->initializeSegment(urldecode($segmentCondition), $idSites);
$this->isSegmentEncoded = true;
}
}
/**
* Returns the segment expression.
* @return SegmentExpression
* @api since Piwik 3.2.0
*/
public function getSegmentExpression()
{
return $this->segmentExpression;
}
private function getAvailableSegments()
{
// segment metadata
if (empty($this->availableSegments)) {
$this->availableSegments = Request::processRequest('API.getSegmentsMetadata', array(
'idSites' => $this->idSites,
'_hideImplementationData' => 0,
'filter_limit' => -1,
'filter_offset' => 0,
'_showAllSegments' => 1,
), []);
}
return $this->availableSegments;
}
private function getSegmentByName($name)
{
$segments = $this->getAvailableSegments();
foreach ($segments as $segment) {
if ($segment['segment'] == $name && !empty($name)) {
// check permission
if (isset($segment['permission']) && $segment['permission'] != 1) {
throw new NoAccessException("You do not have enough permission to access the segment " . $name);
}
return $segment;
}
}
throw new Exception("Segment '$name' is not a supported segment.");
}
/**
* @param $string
* @param $idSites
* @throws Exception
*/
protected function initializeSegment($string, $idSites)
{
// As a preventive measure, we restrict the filter size to a safe limit
$string = substr($string, 0, self::SEGMENT_TRUNCATE_LIMIT);
$this->string = $string;
$this->idSites = $idSites;
$segment = new SegmentExpression($string);
$this->segmentExpression = $segment;
// parse segments
$expressions = $segment->parseSubExpressions();
$expressions = $this->getExpressionsWithUnionsResolved($expressions);
// convert segments name to sql segment
// check that user is allowed to view this segment
// and apply a filter to the value to match if necessary (to map DB fields format)
$cleanedExpressions = array();
foreach ($expressions as $expression) {
$operand = $expression[SegmentExpression::INDEX_OPERAND];
$cleanedExpression = $this->getCleanedExpression($operand);
$expression[SegmentExpression::INDEX_OPERAND] = $cleanedExpression;
$cleanedExpressions[] = $expression;
}
$segment->setSubExpressionsAfterCleanup($cleanedExpressions);
}
private function getExpressionsWithUnionsResolved($expressions)
{
$expressionsWithUnions = array();
foreach ($expressions as $expression) {
$operand = $expression[SegmentExpression::INDEX_OPERAND];
$name = $operand[SegmentExpression::INDEX_OPERAND_NAME];
$availableSegment = $this->getSegmentByName($name);
if (!empty($availableSegment['unionOfSegments'])) {
$count = 0;
foreach ($availableSegment['unionOfSegments'] as $segmentNameOfUnion) {
$count++;
$operator = SegmentExpression::BOOL_OPERATOR_OR; // we connect all segments within that union via OR
if ($count === count($availableSegment['unionOfSegments'])) {
$operator = $expression[SegmentExpression::INDEX_BOOL_OPERATOR];
}
$operand[SegmentExpression::INDEX_OPERAND_NAME] = $segmentNameOfUnion;
$expressionsWithUnions[] = array(
SegmentExpression::INDEX_BOOL_OPERATOR => $operator,
SegmentExpression::INDEX_OPERAND => $operand
);
}
} else {
$expressionsWithUnions[] = array(
SegmentExpression::INDEX_BOOL_OPERATOR => $expression[SegmentExpression::INDEX_BOOL_OPERATOR],
SegmentExpression::INDEX_OPERAND => $operand
);
}
}
return $expressionsWithUnions;
}
/**
* Returns `true` if the segment is empty, `false` if otherwise.
*/
public function isEmpty()
{
return $this->segmentExpression->isEmpty();
}
/**
* Detects whether the Piwik instance is configured to be able to archive this segment. It checks whether the segment
* will be either archived via browser or cli archiving. It does not check if the segment has been archived. If you
* want to know whether the segment has been archived, the actual report data needs to be requested.
*
* This method does not take any date/period into consideration. Meaning a Piwik instance might be able to archive
* this segment in general, but not for a certain period if eg the archiving of range dates is disabled.
*
* @return bool
*/
public function willBeArchived()
{
if ($this->isEmpty()) {
return true;
}
$idSites = $this->idSites;
if (!is_array($idSites)) {
$idSites = array($this->idSites);
}
return Rules::isRequestAuthorizedToArchive()
|| Rules::isBrowserArchivingAvailableForSegments()
|| Rules::isSegmentPreProcessed($idSites, $this);
}
protected $availableSegments = array();
protected function getCleanedExpression($expression)
{
$name = $expression[SegmentExpression::INDEX_OPERAND_NAME];
$matchType = $expression[SegmentExpression::INDEX_OPERAND_OPERATOR];
$value = $expression[SegmentExpression::INDEX_OPERAND_VALUE];
$segment = $this->getSegmentByName($name);
$sqlName = $segment['sqlSegment'];
if ($matchType != SegmentExpression::MATCH_IS_NOT_NULL_NOR_EMPTY
&& $matchType != SegmentExpression::MATCH_IS_NULL_OR_EMPTY) {
if (isset($segment['sqlFilterValue'])) {
$value = call_user_func($segment['sqlFilterValue'], $value, $segment['sqlSegment']);
}
// apply presentation filter
if (isset($segment['sqlFilter'])) {
$value = call_user_func($segment['sqlFilter'], $value, $segment['sqlSegment'], $matchType, $name);
if(is_null($value)) { // null is returned in TableLogAction::getIdActionFromSegment()
return array(null, $matchType, null);
}
// sqlFilter-callbacks might return arrays for more complex cases
// e.g. see TableLogAction::getIdActionFromSegment()
if (is_array($value) && isset($value['SQL'])) {
// Special case: returned value is a sub sql expression!
$matchType = SegmentExpression::MATCH_ACTIONS_CONTAINS;
}
}
}
return array($sqlName, $matchType, $value);
}
/**
* Returns the segment condition.
*
* @return string
*/
public function getString()
{
return $this->string;
}
/**
* Returns a hash of the segment condition, or the empty string if the segment
* condition is empty.
*
* @return string
*/
public function getHash()
{
if (empty($this->string)) {
return '';
}
return self::getSegmentHash($this->string);
}
public static function getSegmentHash($definition)
{
// urldecode to normalize the string, as browsers may send slightly different payloads for the same archive
return md5(urldecode($definition));
}
/**
* Extend an SQL query that aggregates data over one of the 'log_' tables with segment expressions.
*
* @param string $select The select clause. Should NOT include the **SELECT** just the columns, eg,
* `'t1.col1 as col1, t2.col2 as col2'`.
* @param array|string $from Array of table names (without prefix), eg, `array('log_visit', 'log_conversion')`.
* @param false|string $where (optional) Where clause, eg, `'t1.col1 = ? AND t2.col2 = ?'`.
* @param array|string $bind (optional) Bind parameters, eg, `array($col1Value, $col2Value)`.
* @param false|string $orderBy (optional) Order by clause, eg, `"t1.col1 ASC"`.
* @param false|string $groupBy (optional) Group by clause, eg, `"t2.col2"`.
* @param int $limit Limit number of result to $limit
* @param int $offset Specified the offset of the first row to return
* @param bool $forceGroupBy Force the group by and not using a subquery. Note: This may make the query slower see https://github.com/matomo-org/matomo/issues/9200#issuecomment-183641293
* A $groupBy value needs to be set for this to work.
* @param int If set to value >= 1 then the Select query (and All inner queries) will be LIMIT'ed by this value.
* Use only when you're not aggregating or it will sample the data.
* @return string The entire select query.
*/
public function getSelectQuery($select, $from, $where = false, $bind = array(), $orderBy = false, $groupBy = false, $limit = 0, $offset = 0, $forceGroupBy = false)
{
$segmentExpression = $this->segmentExpression;
$limitAndOffset = null;
if($limit > 0) {
$limitAndOffset = (int) $offset . ', ' . (int) $limit;
}
try {
if ($forceGroupBy && $groupBy) {
$this->segmentQueryBuilder->forceInnerGroupBySubselect(LogQueryBuilder::FORCE_INNER_GROUP_BY_NO_SUBSELECT);
}
$result = $this->segmentQueryBuilder->getSelectQueryString($segmentExpression, $select, $from, $where, $bind,
$groupBy, $orderBy, $limitAndOffset);
} catch (Exception $e) {
if ($forceGroupBy && $groupBy) {
$this->segmentQueryBuilder->forceInnerGroupBySubselect('');
}
throw $e;
}
if ($forceGroupBy && $groupBy) {
$this->segmentQueryBuilder->forceInnerGroupBySubselect('');
}
return $result;
}
/**
* Returns the segment string.
*
* @return string
*/
public function __toString()
{
return (string) $this->getString();
}
/**
* Combines this segment with another segment condition, if the segment condition is not already
* in the segment.
*
* The combination is naive in that it does not take order of operations into account.
*
* @param string $segment
* @param string $operator The operator to use. Should be either SegmentExpression::AND_DELIMITER
* or SegmentExpression::OR_DELIMITER.
* @param string $segmentCondition The segment condition to add.
* @return string
* @throws Exception
*/
public static function combine($segment, $operator, $segmentCondition)
{
if (empty($segment)) {
return $segmentCondition;
}
if (empty($segmentCondition)
|| self::containsCondition($segment, $operator, $segmentCondition)
) {
return $segment;
}
return $segment . $operator . $segmentCondition;
}
private static function containsCondition($segment, $operator, $segmentCondition)
{
// check when segment/condition are of same encoding
return strpos($segment, $operator . $segmentCondition) !== false
|| strpos($segment, $segmentCondition . $operator) !== false
// check when both operator & condition are urlencoded in $segment
|| strpos($segment, urlencode($operator . $segmentCondition)) !== false
|| strpos($segment, urlencode($segmentCondition . $operator)) !== false
// check when operator is not urlencoded, but condition is in $segment
|| strpos($segment, $operator . urlencode($segmentCondition)) !== false
|| strpos($segment, urlencode($segmentCondition) . $operator) !== false
// check when segment condition is urlencoded & $segment isn't
|| strpos($segment, $operator . urldecode($segmentCondition)) !== false
|| strpos($segment, urldecode($segmentCondition) . $operator) !== false
|| $segment === $segmentCondition
|| $segment === urlencode($segmentCondition)
|| $segment === urldecode($segmentCondition);
}
public function getStoredSegmentName($idSite)
{
$segment = $this->getString();
if (empty($segment)) {
return Piwik::translate('SegmentEditor_DefaultAllVisits');
}
$availableSegments = SegmentEditor::getAllSegmentsForSite($idSite);
$foundStoredSegment = null;
foreach ($availableSegments as $storedSegment) {
if ($storedSegment['definition'] == $segment
|| $storedSegment['definition'] == urldecode($segment)
|| $storedSegment['definition'] == urlencode($segment)
|| $storedSegment['definition'] == $this->originalString
|| $storedSegment['definition'] == urldecode($this->originalString)
|| $storedSegment['definition'] == urlencode($this->originalString)
) {
$foundStoredSegment = $storedSegment;
}
}
if (isset($foundStoredSegment)) {
return $foundStoredSegment['name'];
}
return $this->isSegmentEncoded ? urldecode($segment) : $segment;
}
}
|