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
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik\DataAccess\LogQueryBuilder;
use Exception;
use Piwik\Common;
use Piwik\Tracker\LogTable;
class JoinGenerator
{
/**
* @var JoinTables
*/
protected $tables;
/**
* @var bool
*/
private $joinWithSubSelect = false;
/**
* @var string
*/
private $joinString = '';
/**
* @var array
*/
private $nonVisitJoins = array();
public function __construct(JoinTables $tables)
{
$this->tables = $tables;
$this->addMissingTablesNeededForJoins();
}
private function addMissingTablesNeededForJoins()
{
foreach ($this->tables as $index => $table) {
if (is_array($table)) {
continue;
}
$logTable = $this->tables->getLogTable($table);
if (!$logTable->getColumnToJoinOnIdVisit()) {
$tableNameToJoin = $logTable->getLinkTableToBeAbleToJoinOnVisit();
if ($index > 0 && !$this->tables->hasJoinedTable($tableNameToJoin)) {
$this->tables->addTableToJoin($tableNameToJoin);
}
if ($this->tables->hasJoinedTable($tableNameToJoin)) {
$this->generateNonVisitJoins($table, $tableNameToJoin, $index);
}
}
}
foreach ($this->tables as $index => $table) {
if (is_array($table)) {
if (!isset($table['tableAlias'])) {
$tableName = $table['table'];
$numTables = count($this->tables);
for ($j = $index + 1; $j < $numTables; $j++) {
if (!isset($this->tables[$j])) {
continue;
}
$tableOther = $this->tables[$j];
if (is_string($tableOther) && $tableOther === $tableName) {
unset($this->tables[$j]);
}
}
}
} elseif (is_string($table)) {
$numTables = count($this->tables);
for ($j = $index + 1; $j < $numTables; $j++) {
if (isset($this->tables[$j]) && is_array($this->tables[$j]) && !isset($this->tables[$j]['tableAlias'])) {
$tableOther = $this->tables[$j];
if ($table === $tableOther['table']) {
$message = sprintf('Please reorganize the joined tables as the table %s in %s cannot be joined correctly. We recommend to join tables with arrays first. %s', $table, json_encode($this->tables), json_encode(debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 10)));
throw new Exception($message);
}
}
}
}
}
}
/**
* Generate the join sql based on the needed tables
* @throws Exception if tables can't be joined
* @return array
*/
public function generate()
{
/** @var LogTable[] $availableLogTables */
$availableLogTables = array();
$this->tables->sort(array($this, 'sortTablesForJoin'));
foreach ($this->tables as $i => $table) {
if (is_array($table)) {
// join condition provided
$alias = isset($table['tableAlias']) ? $table['tableAlias'] : $table['table'];
if (isset($table['join'])) {
$this->joinString .= ' ' . $table['join'];
} else {
$this->joinString .= ' LEFT JOIN';
}
if (!isset($table['joinOn']) && $this->tables->getLogTable($table['table']) && !empty($availableLogTables)) {
$logTable = $this->tables->getLogTable($table['table']);
$table['joinOn'] = $this->findJoinCriteriasForTables($logTable, $availableLogTables);
}
$this->joinString .= ' ' . Common::prefixTable($table['table']) . " AS " . $alias
. " ON " . $table['joinOn'];
continue;
}
$tableSql = Common::prefixTable($table) . " AS $table";
$logTable = $this->tables->getLogTable($table);
if ($i == 0) {
// first table
$this->joinString .= $tableSql;
} else {
$join = $this->findJoinCriteriasForTables($logTable, $availableLogTables);
if ($join === null) {
$availableLogTables[$table] = $logTable;
continue;
}
// the join sql the default way
$this->joinString .= " LEFT JOIN $tableSql ON " . $join;
}
$availableLogTables[$table] = $logTable;
}
}
public function getJoinString()
{
return $this->joinString;
}
public function shouldJoinWithSelect()
{
return $this->joinWithSubSelect;
}
/**
* @param LogTable $logTable
* @param LogTable[] $availableLogTables
* @return string|null returns null in case the table is already joined, or the join string if the table needs
* to be joined
* @throws Exception if table cannot be joined for segmentation
*/
public function findJoinCriteriasForTables(LogTable $logTable, $availableLogTables)
{
$join = null;
$alternativeJoin = null;
$table = $logTable->getName();
foreach ($availableLogTables as $availableLogTable) {
if ($logTable->getColumnToJoinOnIdVisit() && $availableLogTable->getColumnToJoinOnIdVisit()) {
$join = sprintf("%s.%s = %s.%s", $table, $logTable->getColumnToJoinOnIdVisit(),
$availableLogTable->getName(), $availableLogTable->getColumnToJoinOnIdVisit());
$alternativeJoin = sprintf("%s.%s = %s.%s", $availableLogTable->getName(), $availableLogTable->getColumnToJoinOnIdVisit(),
$table, $logTable->getColumnToJoinOnIdVisit());
if ($availableLogTable->shouldJoinWithSubSelect()) {
$this->joinWithSubSelect = true;
}
break;
}
if ($logTable->getColumnToJoinOnIdAction() && $availableLogTable->getColumnToJoinOnIdAction()) {
if (isset($this->nonVisitJoins[$logTable->getName()][$availableLogTable->getName()])) {
$join = $this->nonVisitJoins[$logTable->getName()][$availableLogTable->getName()];
}
break;
}
}
if (!isset($join)) {
throw new Exception("Table '$table' can't be joined for segmentation");
}
if ($this->tables->hasJoinedTableManually($table, $join)
|| $this->tables->hasJoinedTableManually($table, $alternativeJoin)) {
// already joined, no need to join it again
return null;
}
return $join;
}
/**
* This code is a bit tricky. We have to execute this right at the beginning before actually iterating over all the
* tables and generating the join string as we may have to delete a table from the tables. If we did not delete
* this table upfront, we would have maybe already added a joinString for that table, even though it will be later
* removed by another table. This means if we wouldn't delete/unset that table upfront, we would need to alter
* an already generated join string which would not be really nice code as well.
*
* Next problem is, because we are deleting a table, we have to remember the "joinOn" string for that table in a
* property "nonVisitJoins". Otherwise we would not be able to generate the correct "joinOn" string when actually
* iterating over all the tables to generate that string.
*
* @param $tableName
* @param $tableNameToJoin
* @param $index
*/
protected function generateNonVisitJoins($tableName, $tableNameToJoin, $index)
{
$logTable = $this->tables->getLogTable($tableName);
$logTableToJoin = $this->tables->getLogTable($tableNameToJoin);
$nonVisitJoin = sprintf("%s.%s = %s.%s", $logTableToJoin->getName(), $logTableToJoin->getColumnToJoinOnIdAction(),
$tableName, $logTable->getColumnToJoinOnIdAction());
$altNonVisitJoin = sprintf("%s.%s = %s.%s", $tableName, $logTable->getColumnToJoinOnIdAction(),
$logTableToJoin->getName(), $logTableToJoin->getColumnToJoinOnIdAction());
if ($index > 0
&& $this->tables->hasAddedTableManually($tableName)
&& !$this->tables->hasJoinedTableManually($tableName, $nonVisitJoin)
&& !$this->tables->hasJoinedTableManually($tableName, $altNonVisitJoin)) {
$tableIndex = $this->tables->findIndexOfManuallyAddedTable($tableName);
$nonVisitJoin = '(' . $this->tables[$tableIndex]['joinOn'] . ' AND ' . $nonVisitJoin . ')';
unset($this->tables[$tableIndex]);
}
if (!isset($this->nonVisitJoins[$tableName])) {
$this->nonVisitJoins[$tableName] = array();
}
if (!isset($this->nonVisitJoins[$tableNameToJoin])) {
$this->nonVisitJoins[$tableNameToJoin] = array();
}
$this->nonVisitJoins[$tableName][$tableNameToJoin] = $nonVisitJoin;
$this->nonVisitJoins[$tableNameToJoin][$tableName] = $nonVisitJoin;
}
public function sortTablesForJoin($tA, $tB)
{
$coreSort = array(
'log_link_visit_action' => 0,
'log_action' => 1,
'log_visit' => 2,
'log_conversion' => 3,
'log_conversion_item' => 4
);
if (is_array($tA) && is_array($tB)) {
if (isset($tB['tableAlias']) && isset($tA['joinOn']) && strpos($tA['joinOn'], $tB['tableAlias']) !== false) {
return 1;
}
if (isset($tA['tableAlias']) && isset($tB['joinOn']) && strpos($tB['joinOn'], $tA['tableAlias']) !== false) {
return -1;
}
return 0;
}
if (is_array($tA)) {
if (isset($tA['joinOn']) && is_string($tA['joinOn']) && strpos($tA['joinOn'] . '.', $tB) === 0) {
return 1; // tA requires tB so needs to be listed before
}
return -1;
}
if (is_array($tB)) {
if (isset($tB['joinOn']) && is_string($tB['joinOn']) && strpos($tB['joinOn'] . '.', $tA) === 0) {
return -1; // tB requires tA so needs to be listed before
}
return 1;
}
if (isset($coreSort[$tA])) {
$weightA = $coreSort[$tA];
} else {
$weightA = 999;
}
if (isset($coreSort[$tB])) {
$weightB = $coreSort[$tB];
} else {
$weightB = 999;
}
if ($weightA === $weightB) {
return 0;
}
if ($weightA > $weightB) {
return 1;
}
return -1;
}
}
|