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
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\Actions\Tracker;
use Piwik\Tracker\Action;
use Piwik\Tracker\Request;
use Piwik\Tracker\RequestProcessor;
use Piwik\Tracker\Visit\VisitProperties;
use Piwik\Tracker\Visitor;
/**
* Handles actions detection and recording during tracker requests.
*
* ## Request Metadata
*
* This RequestProcessor exposes the following metadata for the **Actions** plugin:
*
* **action**: Contains the `Action` instance that represents the action being tracked for
* the current tracking request.
*
* Set in `processRequestParams()`.
*
* Other RequestProcessors can unset this value to skip actions recording or
* change the value to change how they are recorded.
*
* **idReferrerActionUrl**: The idaction of the URL action that is the referrer for the action
* being tracked.
*
* Set in `processRequestParams()`.
*
* Can be changed/unset to change the current action's referrer action.
*
* **idReferrerActionName**: The idaction of the name action that is the referrer for the action
* being tracked.
*
* Set in `processRequestParams()`.
*
* Can be changed/unset to change the current action's referrer action.
*/
class ActionsRequestProcessor extends RequestProcessor
{
public function processRequestParams(VisitProperties $visitProperties, Request $request)
{
// normal page view, potentially triggering a URL matching goal
$action = Action::factory($request);
$action->writeDebugInfo();
$request->setMetadata('Actions', 'action', $action);
// save the exit actions of the last action in this visit as the referrer actions for the action being tracked.
// when the visit is updated, these columns will be changed, so we have to do this before recordLogs
$request->setMetadata(
'Actions',
'idReferrerActionUrl',
$visitProperties->getProperty('visit_exit_idaction_url')
);
$request->setMetadata(
'Actions',
'idReferrerActionName',
$visitProperties->getProperty('visit_exit_idaction_name')
);
return false;
}
public function afterRequestProcessed(VisitProperties $visitProperties, Request $request)
{
/** @var Action $action */
$action = $request->getMetadata('Actions', 'action');
if (!empty($action)) { // other plugins can unset the action if they want
$action->loadIdsFromLogActionTable();
}
return false;
}
public function recordLogs(VisitProperties $visitProperties, Request $request)
{
/** @var Action $action */
$action = $request->getMetadata('Actions', 'action');
if (
$action !== null
&& !$request->getMetadata('CoreHome', 'visitorNotFoundInDb')
) {
$idReferrerActionUrl = 0;
$idReferrerActionName = 0;
if (!$request->getMetadata('CoreHome', 'isNewVisit')) {
$idReferrerActionUrl = $request->getMetadata('Actions', 'idReferrerActionUrl');
$idReferrerActionName = $request->getMetadata('Actions', 'idReferrerActionName');
}
$visitor = Visitor::makeFromVisitProperties($visitProperties, $request);
$action->record($visitor, $idReferrerActionUrl, $idReferrerActionName);
}
}
}
|
