Server : LiteSpeed System : Linux premium84.web-hosting.com 4.18.0-553.44.1.lve.el8.x86_64 #1 SMP Thu Mar 13 14:29:12 UTC 2025 x86_64 User : claqxcrl ( 523) PHP Version : 8.1.32 Disable Function : NONE Directory : /home/claqxcrl/anfangola.com/wp-content/plugins/matomo/app/plugins/SegmentEditor/ |
<?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\Plugins\SegmentEditor;
use Piwik\Access;
use Piwik\API\Request;
use Piwik\ArchiveProcessor\PluginsArchiver;
use Piwik\ArchiveProcessor\Rules;
use Piwik\Cache;
use Piwik\CacheId;
use Piwik\Common;
use Piwik\Config;
use Piwik\Container\StaticContainer;
use Piwik\CronArchive\SegmentArchiving;
use Piwik\DataAccess\ArchiveSelector;
use Piwik\Date;
use Piwik\Notification;
use Piwik\Period;
use Piwik\Piwik;
use Piwik\Plugins\CoreHome\SystemSummary;
use Piwik\Plugins\Diagnostics\Diagnostics;
use Piwik\Plugins\UsersManager\API as UsersManagerApi;
use Piwik\Segment;
use Piwik\SettingsServer;
use Piwik\Site;
use Piwik\Url;
use Piwik\View;
/**
*/
class SegmentEditor extends \Piwik\Plugin
{
const NO_DATA_UNPROCESSED_SEGMENT_ID = 'nodata_segment_not_processed';
/**
* @see \Piwik\Plugin::registerEvents
*/
public function registerEvents()
{
return array('Segments.getKnownSegmentsToArchiveForSite' => 'getKnownSegmentsToArchiveForSite', 'Segments.getKnownSegmentsToArchiveAllSites' => 'getKnownSegmentsToArchiveAllSites', 'AssetManager.getJavaScriptFiles' => 'getJsFiles', 'AssetManager.getStylesheetFiles' => 'getStylesheetFiles', 'Template.nextToCalendar' => 'getSegmentEditorHtml', 'System.addSystemSummaryItems' => 'addSystemSummaryItems', 'Translate.getClientSideTranslationKeys' => 'getClientSideTranslationKeys', 'Visualization.onNoData' => 'onNoData', 'Archive.noArchivedData' => 'onNoArchiveData', 'Db.getTablesInstalled' => 'getTablesInstalled', 'SitesManager.deleteSite.end' => 'onDeleteSite', 'UsersManager.deleteUser' => 'onDeleteUser');
}
public function onDeleteSite($idSite)
{
$model = new \Piwik\Plugins\SegmentEditor\Model();
foreach ($model->getAllSegmentsForAllUsers($idSite) as $segment) {
if (!empty($segment['enable_only_idsite'])) {
// don't delete segments for all sites
$model->deleteSegment($segment['idsegment']);
}
}
}
/**
* Register the new tables, so Matomo knows about them.
*
* @param array $allTablesInstalled
*/
public function getTablesInstalled(&$allTablesInstalled)
{
$allTablesInstalled[] = Common::prefixTable('segment');
}
public function addSystemSummaryItems(&$systemSummary)
{
$storedSegments = StaticContainer::get('Piwik\\Plugins\\SegmentEditor\\Services\\StoredSegmentService');
$segments = $storedSegments->getAllSegmentsAndIgnoreVisibility();
$numSegments = count($segments);
if (Rules::isBrowserArchivingAvailableForSegments()) {
$numAutoArchiveSegments = 0;
$numRealTimeSegments = 0;
foreach ($segments as $segment) {
$autoArchive = (int) $segment['auto_archive'];
if (!empty($autoArchive)) {
++$numAutoArchiveSegments;
} else {
++$numRealTimeSegments;
}
}
$message = Piwik::translate('CoreHome_SystemSummaryNSegmentsWithBreakdown', [$numSegments, $numAutoArchiveSegments, $numRealTimeSegments]);
} else {
$message = Piwik::translate('CoreHome_SystemSummaryNSegments', [$numSegments]);
}
$systemSummary[] = new SystemSummary\Item($key = 'segments', $message, $value = null, $url = null, $icon = 'icon-segment', $order = 6);
}
function getSegmentEditorHtml(&$out)
{
$selector = new \Piwik\Plugins\SegmentEditor\SegmentSelectorControl();
$out .= $selector->render();
}
public function getKnownSegmentsToArchiveAllSites(&$segments)
{
$this->getKnownSegmentsToArchiveForSite($segments, $idSite = false);
}
/**
* Adds the pre-processed segments to the list of Segments.
* Used by CronArchive, ArchiveProcessor\Rules, etc.
*
* @param $segments
* @param $idSite
*/
public function getKnownSegmentsToArchiveForSite(&$segments, $idSite)
{
$model = new \Piwik\Plugins\SegmentEditor\Model();
$segmentToAutoArchive = $model->getAllSegmentsAndIgnoreVisibility();
$forceAutoArchive = SegmentArchiving::getShouldForceArchiveAllSegments();
foreach ($segmentToAutoArchive as $index => $segmentInfo) {
if (!SegmentArchiving::isSegmentForSite($segmentInfo, $idSite)) {
unset($segmentToAutoArchive[$index]);
}
if (!$forceAutoArchive && empty($segmentInfo['auto_archive'])) {
unset($segmentToAutoArchive[$index]);
}
}
foreach ($segmentToAutoArchive as $segmentInfo) {
$segments[] = $segmentInfo['definition'];
}
$segments = array_unique($segments);
}
public function onNoArchiveData()
{
// don't perform this check if the request was triggered by the UI
if (Common::isXmlHttpRequest()) {
return null;
}
// when browser archiving is enabled, the archiving process can be triggered for an API request.
// for non-day periods, this means the Archive class will be used for smaller periods to build the
// non-day period (eg, requesting a week period can result in archiving of day periods). in this case
// Archive can report there is no data for a day, triggering this event, but there may be data for other
// days in the week. in this case, we don't want to throw an exception.
if (PluginsArchiver::isArchivingProcessActive()) {
return null;
}
// don't do check unless this is the root API request and it is an HTTP API request
if (!Request::isCurrentApiRequestTheRootApiRequest() || !Request::isRootRequestApiRequest()) {
return null;
}
// don't do check during cron archiving
if (SettingsServer::isArchivePhpTriggered() || Common::isPhpCliMode()) {
return null;
}
$segmentInfo = $this->getSegmentIfIsUnprocessed();
if (empty($segmentInfo)) {
return;
}
[$segment, $storedSegment, $isSegmentToPreprocess] = $segmentInfo;
throw new \Piwik\Plugins\SegmentEditor\UnprocessedSegmentException($segment, $isSegmentToPreprocess, $storedSegment);
}
public function onNoData(View $dataTableView)
{
// if the archiving hasn't run in a while notification is up, don't display this one
if (isset($dataTableView->notifications[Diagnostics::NO_DATA_ARCHIVING_NOT_RUN_NOTIFICATION_ID])) {
return;
}
$segmentInfo = $this->getSegmentIfIsUnprocessed();
if (empty($segmentInfo)) {
return;
}
[$segment, $storedSegment, $isSegmentToPreprocess, $canBeArchived] = $segmentInfo;
if (!$isSegmentToPreprocess) {
return;
// do not display the notification for custom segments
}
$segmentDisplayName = !empty($storedSegment['name']) ? $storedSegment['name'] : $segment;
$view = new View('@SegmentEditor/_unprocessedSegmentMessage.twig');
$view->isSegmentToPreprocess = $isSegmentToPreprocess;
$view->segmentName = $segmentDisplayName;
$view->canBeArchived = $canBeArchived;
$view->visitorLogLink = '#' . Url::getCurrentQueryStringWithParametersModified(['category' => 'General_Visitors', 'subcategory' => 'Live_VisitorLog']);
$notification = new Notification($view->render());
$notification->priority = Notification::PRIORITY_HIGH;
$notification->context = Notification::CONTEXT_INFO;
$notification->flags = Notification::FLAG_NO_CLEAR;
$notification->type = Notification::TYPE_TRANSIENT;
$notification->raw = true;
$dataTableView->notifications[self::NO_DATA_UNPROCESSED_SEGMENT_ID] = $notification;
}
private function getSegmentIfIsUnprocessed()
{
// get idSites
$idSite = Common::getRequestVar('idSite', false);
if (empty($idSite) || !is_numeric($idSite)) {
return null;
}
// get segment
$segment = Request::getRawSegmentFromRequest();
if (empty($segment)) {
return null;
}
// get period
$date = Common::getRequestVar('date', false);
$periodStr = Common::getRequestVar('period', false);
$period = Period\Factory::build($periodStr, $date);
$site = new Site($idSite);
$segment = new Segment($segment, [$idSite], $period->getDateTimeStart()->setTimezone($site->getTimezone()), $period->getDateTimeEnd()->setTimezone($site->getTimezone()));
// check if archiving is enabled. if so, the segment should have been processed.
$isArchivingDisabled = Rules::isArchivingDisabledFor([$idSite], $segment, $period);
if (!$isArchivingDisabled) {
return null;
}
// check if segment archive does not exist
$processorParams = new \Piwik\ArchiveProcessor\Parameters($site, $period, $segment);
$archiveIdAndStats = ArchiveSelector::getArchiveIdAndVisits($processorParams, null);
if (!empty($archiveIdAndStats['idArchives']) || !empty($archiveIdAndStats['visits'])) {
return null;
}
$idSites = Site::getIdSitesFromIdSitesString($idSite);
if (strpos($date, ',') !== false) {
// if getting multiple periods, check the whole range for visits
$periodStr = 'range';
}
// if no visits recorded, data will not appear, so don't show the message
$liveModel = new \Piwik\Plugins\Live\Model();
$visits = $liveModel->queryLogVisits($idSites, $periodStr, $date, $segment->getString(), $offset = 0, $limit = 1, null, null, 'ASC');
if (empty($visits)) {
return null;
}
// check if requested segment is segment to preprocess
$isSegmentToPreprocess = Rules::isSegmentPreProcessed([$idSite], $segment);
// this archive has no data, the report is for a segment that gets preprocessed, and the archive for this
// data does not exist. this means the data will be processed later. we let the user know so they will not
// be confused.
$model = new \Piwik\Plugins\SegmentEditor\Model();
$storedSegment = $model->getSegmentByDefinition($segment->getString());
if (empty($storedSegment)) {
$storedSegment = $model->getSegmentByDefinition(urldecode($segment->getString()));
}
if (empty($storedSegment)) {
$storedSegment = null;
}
// get the earliest date to rearchive
$earliestDateToRearchive = Piwik::getEarliestDateToRearchive();
//get the request end period
$endDate = $period->getDateEnd();
$canBeArchived = true;
if (!empty($earliestDateToRearchive) && !empty($endDate)) {
//if the rearchive won't trigger
if ($earliestDateToRearchive->isLater($endDate)) {
$canBeArchived = false;
}
}
return [$segment, $storedSegment, $isSegmentToPreprocess, $canBeArchived];
}
public function install()
{
\Piwik\Plugins\SegmentEditor\Model::install();
}
public function getJsFiles(&$jsFiles)
{
$jsFiles[] = "plugins/SegmentEditor/javascripts/Segmentation.js";
}
public function getStylesheetFiles(&$stylesheets)
{
$stylesheets[] = "plugins/SegmentEditor/stylesheets/segmentation.less";
$stylesheets[] = "plugins/SegmentEditor/vue/src/SegmentGenerator/SegmentGenerator.less";
}
/**
* Returns whether adding segments for all websites is enabled or not.
*
* @return bool
*/
public static function isAddingSegmentsForAllWebsitesEnabled()
{
return Config::getInstance()->General['allow_adding_segments_for_all_websites'] == 1;
}
/**
* Returns whether create realtime segments is enabled or not.
*
* @return bool
*/
public static function isCreateRealtimeSegmentsEnabled() : bool
{
return Config::getInstance()->General['enable_create_realtime_segments'] == 1;
}
public function getClientSideTranslationKeys(&$translationKeys)
{
$translationKeys[] = 'SegmentEditor_CustomSegment';
$translationKeys[] = 'SegmentEditor_VisibleToSuperUser';
$translationKeys[] = 'SegmentEditor_SharedWithYou';
$translationKeys[] = 'SegmentEditor_ChooseASegment';
$translationKeys[] = 'SegmentEditor_CurrentlySelectedSegment';
$translationKeys[] = 'SegmentEditor_OperatorAND';
$translationKeys[] = 'SegmentEditor_OperatorOR';
$translationKeys[] = 'SegmentEditor_AddANDorORCondition';
$translationKeys[] = 'SegmentEditor_DefaultAllVisits';
$translationKeys[] = 'General_OperationEquals';
$translationKeys[] = 'General_OperationNotEquals';
$translationKeys[] = 'General_OperationAtMost';
$translationKeys[] = 'General_OperationAtLeast';
$translationKeys[] = 'General_OperationLessThan';
$translationKeys[] = 'General_OperationGreaterThan';
$translationKeys[] = 'General_OperationIs';
$translationKeys[] = 'General_OperationIsNot';
$translationKeys[] = 'General_OperationContains';
$translationKeys[] = 'General_OperationDoesNotContain';
$translationKeys[] = 'General_OperationStartsWith';
$translationKeys[] = 'General_OperationEndsWith';
$translationKeys[] = 'General_Unknown';
$translationKeys[] = 'SegmentEditor_ThisSegmentIsCompared';
$translationKeys[] = 'SegmentEditor_ThisSegmentIsSelectedAndCannotBeCompared';
$translationKeys[] = 'SegmentEditor_CompareThisSegment';
$translationKeys[] = 'Live_VisitsLog';
}
public static function getAllSegmentsForSite($idSite)
{
$cache = Cache::getTransientCache();
$cacheKey = CacheId::siteAware('SegmentEditor_getAll', [$idSite]);
$segments = $cache->fetch($cacheKey);
if (!is_array($segments)) {
$segments = Request::processRequest('SegmentEditor.getAll', ['idSite' => $idSite], $default = []);
$cache->save($cacheKey, $segments);
}
return $segments;
}
public function onDeleteUser($userLogin)
{
$this->transferAllUserSegmentsToSuperUser($userLogin);
}
public function transferAllUserSegmentsToSuperUser($userLogin)
{
// We need to do that as super user, as the event triggering this method might be initiated without a session
Access::doAsSuperUser(function () use($userLogin) {
$model = new \Piwik\Plugins\SegmentEditor\Model();
$updatedAt = Date::factory('now')->toString('Y-m-d H:i:s');
$superUsers = UsersManagerApi::getInstance()->getUsersHavingSuperUserAccess();
$superUserLogin = false;
foreach ($superUsers as $superUser) {
if ($superUser['login'] !== $userLogin) {
$superUserLogin = $superUser['login'];
break;
}
}
if (!$superUserLogin) {
return;
}
foreach ($model->getAllSegments($userLogin) as $segment) {
if ($segment['login'] === $userLogin) {
$model->updateSegment($segment['idsegment'], array('login' => $superUserLogin, 'ts_last_edit' => $updatedAt));
}
}
});
}
}