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
|
<?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\SegmentEditor;
use Piwik\API\Request;
use Piwik\ArchiveProcessor\Rules;
use Piwik\Config;
use Piwik\Container\StaticContainer;
use Piwik\Piwik;
use Piwik\Plugin\Manager;
use Piwik\Plugins\API\API as APIMetadata;
use Piwik\Plugins\Live\Live;
use Piwik\Plugins\UsersManager\API as UsersManagerAPI;
use Piwik\View\UIControl;
use Piwik\Plugins\SegmentEditor\API as SegmentEditorAPI;
/**
* Generates the HTML for the segment selector control (which includes the segment editor).
*/
class SegmentSelectorControl extends UIControl
{
public const TEMPLATE = "@SegmentEditor/_segmentSelector";
/**
* Constructor.
*/
public function __construct()
{
parent::__construct();
$this->jsClass = "SegmentSelectorControl";
$this->cssIdentifier = "segmentEditorPanel";
$this->cssClass = "piwikTopControl borderedControl piwikSelector";
$idSiteFromRequest = \Piwik\Request::fromRequest()->getIntegerParameter('idSite', -1);
$this->idSite = $idSiteFromRequest !== -1 ? $idSiteFromRequest : null;
$formatter = StaticContainer::get('Piwik\Plugins\SegmentEditor\SegmentFormatter');
$this->segmentDescription = $formatter->getHumanReadable(Request::getRawSegmentFromRequest(), $this->idSite);
$this->isAddingSegmentsForAllWebsitesEnabled = SegmentEditor::isAddingSegmentsForAllWebsitesEnabled();
$this->isCreateRealtimeSegmentsEnabled = SegmentEditor::isCreateRealtimeSegmentsEnabled();
$segments = APIMetadata::getInstance()->getSegmentsMetadata($this->idSite);
$visitTitle = Piwik::translate('General_Visit');
foreach ($segments as $segment) {
if (
$segment['category'] == $visitTitle
&& ($segment['type'] == 'metric' && $segment['segment'] != 'visitIp')
) {
$metricsLabel = mb_strtolower(Piwik::translate('General_Metrics'));
$segment['category'] .= ' (' . $metricsLabel . ')';
}
}
$this->createRealTimeSegmentsIsEnabled = $this->isCreatingRealTimeSegmentsEnabled();
$this->nameOfCurrentSegment = '';
$this->isSegmentNotAppliedBecauseBrowserArchivingIsDisabled = 0;
$this->selectedSegment = \Piwik\Request::fromRequest()->getStringParameter('segment', '');
$this->availableSegments = SegmentEditor::getAllSegmentsForSite($this->idSite);
foreach ($this->availableSegments as &$savedSegment) {
if (!empty($this->selectedSegment) && $this->selectedSegment == $savedSegment['definition']) {
$this->nameOfCurrentSegment = $savedSegment['name'];
$this->isSegmentNotAppliedBecauseBrowserArchivingIsDisabled =
$this->wouldApplySegment($savedSegment) ? 0 : 1;
}
}
$this->authorizedToCreateSegments = SegmentEditorAPI::getInstance()->isUserCanAddNewSegment($this->idSite);
$this->isUserAnonymous = Piwik::isUserIsAnonymous();
$this->segmentTranslations = $this->getTranslations();
$this->segmentProcessedOnRequest = Rules::isBrowserArchivingAvailableForSegments();
$this->hideSegmentDefinitionChangeMessage = UsersManagerAPI::getInstance()->getUserPreference(
'hideSegmentDefinitionChangeMessage',
Piwik::getCurrentUserLogin()
);
$this->isBrowserArchivingEnabled = Rules::isBrowserTriggerEnabled();
$this->isVisitorLogEnabled = Manager::getInstance()->isPluginActivated('Live') && Live::isVisitorLogEnabled($this->idSite);
}
public function getClientSideProperties()
{
return array('availableSegments',
'segmentTranslations',
'isSegmentNotAppliedBecauseBrowserArchivingIsDisabled',
'selectedSegment',
'authorizedToCreateSegments');
}
private function wouldApplySegment($savedSegment)
{
if (Rules::isBrowserArchivingAvailableForSegments()) {
return true;
}
return (bool) $savedSegment['auto_archive'];
}
private function getTranslations()
{
$translationKeys = array(
'General_OperationEquals',
'General_OperationNotEquals',
'General_OperationAtMost',
'General_OperationAtLeast',
'General_OperationLessThan',
'General_OperationGreaterThan',
'General_OperationContains',
'General_OperationDoesNotContain',
'General_OperationStartsWith',
'General_OperationEndsWith',
'General_OperationIs',
'General_OperationIsNot',
'General_OperationContains',
'General_OperationDoesNotContain',
'SegmentEditor_DefaultAllVisits',
'General_DefaultAppended',
'SegmentEditor_AddNewSegment',
'General_Edit',
'General_Search',
'General_SearchNoResults',
);
$translations = array();
foreach ($translationKeys as $key) {
$translations[$key] = Piwik::translate($key);
}
return $translations;
}
protected function isCreatingRealTimeSegmentsEnabled()
{
// when browser archiving is disabled for segments, we force new segments to be created as pre-processed
if (!Rules::isBrowserArchivingAvailableForSegments()) {
return false;
}
return (bool) Config::getInstance()->General['enable_create_realtime_segments'];
}
}
|
