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
|
<?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\CustomJsTracker;
use Piwik\Common;
use Piwik\Container\StaticContainer;
use Piwik\Plugins\CustomJsTracker\TrackingCode\PiwikJsManipulator;
use Piwik\Plugins\CustomJsTracker\TrackingCode\PluginTrackerFiles;
use Piwik\Piwik;
/**
* Updates the Piwik JavaScript Tracker "piwik.js" in case plugins extend the tracker.
*
* Usage:
* StaticContainer::get('Piwik\Plugins\CustomJsTracker\TrackerUpdater')->update();
*/
class TrackerUpdater
{
public const DEVELOPMENT_PIWIK_JS = '/js/piwik.js';
public const ORIGINAL_PIWIK_JS = '/js/piwik.min.js';
public const TARGET_MATOMO_JS = '/matomo.js';
/**
* @var File
*/
private $fromFile;
/**
* @var File
*/
private $toFile;
private $trackerFiles = array();
/**
* @param string|null $fromFile If null then the minified JS tracker file in /js fill be used
* @param string|null $toFile If null then the minified JS tracker will be updated.
*/
public function __construct($fromFile = null, $toFile = null)
{
if (!isset($fromFile)) {
$fromFile = PIWIK_DOCUMENT_ROOT . self::ORIGINAL_PIWIK_JS;
}
if (!isset($toFile)) {
$toFile = PIWIK_DOCUMENT_ROOT . self::TARGET_MATOMO_JS;
}
$this->setFromFile($fromFile);
$this->setToFile($toFile);
$this->trackerFiles = StaticContainer::get('Piwik\Plugins\CustomJsTracker\TrackingCode\PluginTrackerFiles');
}
public function setFromFile($fromFile)
{
if (is_string($fromFile)) {
$fromFile = new File($fromFile);
}
$this->fromFile = $fromFile;
}
public function getFromFile()
{
return $this->fromFile;
}
public function setToFile($toFile)
{
if (is_string($toFile)) {
$toFile = new File($toFile);
}
$this->toFile = $toFile;
}
public function getToFile()
{
return $this->toFile;
}
public function setTrackerFiles(PluginTrackerFiles $trackerFiles)
{
$this->trackerFiles = $trackerFiles;
}
/**
* Checks whether the Piwik JavaScript tracker file "piwik.js" is writable.
* @throws \Exception In case the piwik.js file is not writable.
*
* @api
*/
public function checkWillSucceed()
{
$this->fromFile->checkReadable();
$this->toFile->checkWritable();
}
public function getCurrentTrackerFileContent()
{
return $this->toFile->getContent();
}
public function getUpdatedTrackerFileContent()
{
$trackingCode = new PiwikJsManipulator($this->fromFile->getContent(), $this->trackerFiles);
$newContent = $trackingCode->manipulateContent();
return $newContent;
}
/**
* Updates / re-generates the Piwik JavaScript tracker "piwik.js".
*
* It may not be possible to update the "piwik.js" tracker file if the file is not writable. It won't throw
* an exception in such a case and instead just to nothing. To check if the update would succeed, call
* {@link checkWillSucceed()}.
*
* @api
*/
public function update()
{
if (!$this->toFile->hasWriteAccess() || !$this->fromFile->hasReadAccess()) {
return;
}
$newContent = $this->getUpdatedTrackerFileContent();
if (!$this->toFile->isFileContentSame($newContent)) {
$savedFiles = $this->toFile->save($newContent);
foreach ($savedFiles as $savedFile) {
/**
* Triggered after the tracker JavaScript content (the content of the piwik.js file) is changed.
*
* @param string $absolutePath The path to the new piwik.js file.
*/
Piwik::postEvent('CustomJsTracker.trackerJsChanged', [$savedFile]);
}
}
// we need to make sure to sync matomo.js / piwik.js
$this->updateAlternative('piwik.js', 'matomo.js', $newContent);
$this->updateAlternative('matomo.js', 'piwik.js', $newContent);
}
private function updateAlternative($fromFile, $toFile, $newContent)
{
if (Common::stringEndsWith($this->toFile->getName(), $fromFile)) {
$alternativeFilename = dirname($this->toFile->getPath()) . DIRECTORY_SEPARATOR . $toFile;
$file = $this->toFile->setFile($alternativeFilename);
if ($file->hasWriteAccess() && !$file->isFileContentSame($newContent)) {
$savedFiles = $file->save($newContent);
foreach ($savedFiles as $savedFile) {
Piwik::postEvent('CustomJsTracker.trackerJsChanged', [$savedFile]);
}
}
}
}
}
|
