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
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik\DataAccess\LogQueryBuilder;
use Exception;
use Piwik\DataAccess\LogAggregator;
use Piwik\Plugin\LogTablesProvider;
class JoinTables extends \ArrayObject
{
/**
* @var LogTablesProvider
*/
private $logTableProvider;
// NOTE: joins can be specified explicitly as arrays w/ 'joinOn' keys or implicitly as table names. when
// table names are used, the joins dependencies are assumed based on how we want to order those joins.
// the below table list the possible dependencies of each table, and is specifically designed to enforce
// the following order:
// log_link_visit_action, log_action, log_visit, log_conversion, log_conversion_item
// which means if an array is supplied where log_visit comes before log_link_visitAction, it will
// be moved to after it.
private $implicitTableDependencies = [
'log_link_visit_action' => [
// empty
],
'log_action' => [
'log_link_visit_action',
'log_conversion',
'log_conversion_item',
'log_visit',
],
'log_visit' => [
'log_link_visit_action',
'log_action',
],
'log_conversion' => [
'log_link_visit_action',
'log_action',
'log_visit',
],
'log_conversion_item' => [
'log_link_visit_action',
'log_action',
'log_visit',
'log_conversion',
],
];
/**
* Tables constructor.
* @param LogTablesProvider $logTablesProvider
* @param array $tables
*/
public function __construct(LogTablesProvider $logTablesProvider, $tables)
{
$this->logTableProvider = $logTablesProvider;
foreach ($tables as $table) {
$this->checkTableCanBeUsedForSegmentation($table);
}
$this->exchangeArray(array_values($tables));
}
public function getTables()
{
return $this->getArrayCopy();
}
public function addTableToJoin($tableName)
{
$this->checkTableCanBeUsedForSegmentation($tableName);
$this->append($tableName);
}
public function hasJoinedTable($tableName)
{
$tables = in_array($tableName, $this->getTables());
if ($tables) {
return true;
}
foreach ($this as $table) {
if (is_array($table)) {
if (!isset($table['tableAlias']) && $table['table'] === $table) {
return true;
} elseif (isset($table['tableAlias']) && $table['tableAlias'] === $table) {
return true;
}
}
}
return false;
}
public function hasJoinedTableManually($tableToFind, $joinToFind)
{
foreach ($this as $table) {
if (is_array($table)
&& !empty($table['table'])
&& $table['table'] === $tableToFind
&& (!isset($table['tableAlias']) || $table['tableAlias'] === $tableToFind)
&& (!isset($table['join']) || strtolower($table['join']) === 'left join')
&& isset($table['joinOn']) && $table['joinOn'] === $joinToFind) {
return true;
}
}
return false;
}
public function getLogTable($tableName)
{
return $this->logTableProvider->getLogTable($tableName);
}
public function findIndexOfManuallyAddedTable($tableNameToFind)
{
foreach ($this as $index => $table) {
if (is_array($table)
&& !empty($table['table'])
&& $table['table'] === $tableNameToFind
&& (!isset($table['join']) || strtolower($table['join']) === 'left join')
&& (!isset($table['tableAlias']) || $table['tableAlias'] === $tableNameToFind)) {
return $index;
}
}
}
public function hasAddedTableManually($tableToFind)
{
$table = $this->findIndexOfManuallyAddedTable($tableToFind);
return isset($table);
}
public function sort()
{
// we do not use $this->uasort as we do not want to maintain keys
$tables = $this->getTables();
// the first entry is always the FROM table
$firstTable = array_shift($tables);
$sorted = [$firstTable];
if (strpos($firstTable, LogAggregator::LOG_TABLE_SEGMENT_TEMPORARY_PREFIX) === 0) {
// the first table might be a temporary segment table in which case we need to keep the next one as well
$sorted[] = array_shift($tables);
}
$dependencies = $this->parseDependencies($tables);
$this->visitTableListDfs($tables, $dependencies, function ($tableInfo) use (&$sorted) {
$sorted[] = $tableInfo;
});
$this->exchangeArray($sorted);
}
public function isTableJoinableOnVisit($tableToCheck)
{
$table = $this->getLogTable($tableToCheck);
if (empty($table)) {
return false;
}
if ($table->getColumnToJoinOnIdVisit()) {
return true;
}
if ($table->getLinkTableToBeAbleToJoinOnVisit()) {
return true;
}
$otherWays = $table->getWaysToJoinToOtherLogTables();
if (empty($otherWays)) {
return false;
}
foreach ($otherWays as $logTable => $column) {
if ($logTable == 'log_visit' || $this->isTableJoinableOnVisit($logTable)) {
return true;
}
}
return false;
}
public function isTableJoinableOnAction($tableToCheck)
{
$table = $this->getLogTable($tableToCheck);
if (empty($table)) {
return false;
}
if ($table->getColumnToJoinOnIdAction()) {
return true;
}
$otherWays = $table->getWaysToJoinToOtherLogTables();
if (empty($otherWays)) {
return false;
}
foreach ($otherWays as $logTable => $column) {
if ($logTable == 'log_action' || $this->isTableJoinableOnAction($logTable)) {
return true;
}
}
return false;
}
public function addTableDependency($table, $dependentTable)
{
if (!empty($this->implicitTableDependencies[$table])) {
return;
}
$this->implicitTableDependencies[$table] = [$dependentTable];
}
private function checkTableCanBeUsedForSegmentation($tableName)
{
if (!is_array($tableName) && !$this->getLogTable($tableName)) {
throw new Exception("Table '$tableName' can't be used for segmentation");
}
}
private function parseDependencies(array $tables)
{
$dependencies = [];
foreach ($tables as $key => &$fromInfo) {
if (is_string($fromInfo)) {
$dependencies[$key] = $this->assumeImplicitJoinDependencies($tables, $fromInfo);
continue;
}
if (empty($fromInfo['joinOn'])) {
continue;
}
$table = isset($fromInfo['tableAlias']) ? $fromInfo['tableAlias'] : $fromInfo['table'];
$tablesInExpr = $this->parseSqlTables($fromInfo['joinOn'], $table);
$dependencies[$key] = $tablesInExpr;
}
return $dependencies;
}
private function assumeImplicitJoinDependencies($allTablesToQuery, $table)
{
$implicitTableDependencies = $this->implicitTableDependencies;
$result = [];
if (isset($implicitTableDependencies[$table])) {
$result = $implicitTableDependencies[$table];
// only include dependencies that are in the list of requested tables (ie, if we want to
// query from log_conversion joining on log_link_visit_action, we don't want to add log_visit
// to the sql statement)
$result = array_filter($result, function ($table) use ($allTablesToQuery) {
return $this->isInTableArray($allTablesToQuery, $table);
});
}
return $result;
}
private function isInTableArray($tables, $table)
{
foreach ($tables as $entry) {
if (is_string($entry)
&& $entry == $table
) {
return true;
}
if (is_array($entry)
&& $entry['table'] == $table
) {
return true;
}
}
return false;
}
private function parseSqlTables($joinOn, $self)
{
preg_match_all('/\b([a-zA-Z0-9_`]+)\.[a-zA-Z0-9_`]+\b/', $joinOn, $matches);
$tables = [];
foreach ($matches[1] as $table) {
if ($table === $self) {
continue;
}
$tables[] = $table;
}
return $tables;
}
private function visitTableListDfs($tables, $dependencies, $visitor)
{
$visited = [];
foreach ($tables as $index => $tableInfo) {
if (empty($visited[$index])) {
$this->visitTableListDfsSingle($tables, $dependencies, $visitor, $index, $visited);
}
}
}
private function visitTableListDfsSingle($tables, $dependencies, $visitor, $tableToVisitIndex, &$visited)
{
$visited[$tableToVisitIndex] = true;
$tableToVisit = $tables[$tableToVisitIndex];
if (!empty($dependencies[$tableToVisitIndex])) {
foreach ($dependencies[$tableToVisitIndex] as $dependencyTableName) {
$dependentTableToVisit = $this->findTableIndex($tables, $dependencyTableName);
if ($dependentTableToVisit === null) { // sanity check, in case the dependent table is not in the list of tables to query
continue;
}
if (!empty($visited[$dependentTableToVisit])) { // skip if already visited
continue;
}
// visit dependent table...
$this->visitTableListDfsSingle($tables, $dependencies, $visitor, $dependentTableToVisit, $visited);
}
}
// ...then visit current table
$visitor($tableToVisit);
}
private function findTableIndex($tables, $tableToSearchFor)
{
foreach ($tables as $key => $info) {
$tableName = null;
if (is_string($info)) {
$tableName = $info;
} else if (is_array($info)) {
$tableName = isset($info['tableAlias']) ? $info['tableAlias'] : $info['table'];
}
if ($tableName == $tableToSearchFor) {
return $key;
}
}
return null;
}
}
|