Ubuntu

isEmpty() && ($periodLabel != 'range' || SettingsServer::isArchivePhpTriggered())) { return true; } if ($periodLabel === 'range' && !SettingsServer::isArchivePhpTriggered()) { return false; } return self::isSegmentPreProcessed($idSites, $segment); } /** * @param $idSites * @return array */ public static function getSegmentsToProcess($idSites) { $knownSegmentsToArchiveAllSites = SettingsPiwik::getKnownSegmentsToArchive(); $segmentsToProcess = $knownSegmentsToArchiveAllSites; foreach ($idSites as $idSite) { $segmentForThisWebsite = SettingsPiwik::getKnownSegmentsToArchiveForSite($idSite); $segmentsToProcess = array_merge($segmentsToProcess, $segmentForThisWebsite); } $segmentsToProcess = array_unique($segmentsToProcess); return $segmentsToProcess; } public static function getDoneFlagArchiveContainsOnePlugin(Segment $segment, $plugin) { return 'done' . $segment->getHash() . '.' . $plugin; } public static function getDoneFlagArchiveContainsAllPlugins(Segment $segment) { return 'done' . $segment->getHash(); } /** * Return done flags used to tell how the archiving process for a specific archive was completed, * * @param array $plugins * @param $segment * @return array */ public static function getDoneFlags(array $plugins, Segment $segment) { $doneFlags = array(); $doneAllPlugins = self::getDoneFlagArchiveContainsAllPlugins($segment); $doneFlags[$doneAllPlugins] = $doneAllPlugins; $plugins = array_unique($plugins); foreach ($plugins as $plugin) { $doneOnePlugin = self::getDoneFlagArchiveContainsOnePlugin($segment, $plugin); $doneFlags[$plugin] = $doneOnePlugin; } return $doneFlags; } public static function getMinTimeProcessedForInProgressArchive( Date $dateStart, \Piwik\Period $period, Segment $segment, Site $site ) { $todayArchiveTimeToLive = self::getPeriodArchiveTimeToLiveDefault($period->getLabel()); $now = time(); $minimumArchiveTime = $now - $todayArchiveTimeToLive; $idSites = array($site->getId()); $isArchivingDisabled = Rules::isArchivingDisabledFor($idSites, $segment, $period->getLabel()); if ($isArchivingDisabled) { if ($period->getNumberOfSubperiods() == 0 && $dateStart->getTimestamp() <= $now ) { // Today: accept any recent enough archive $minimumArchiveTime = false; } else { // This week, this month, this year: // accept any archive that was processed today after 00:00:01 this morning $timezone = $site->getTimezone(); $minimumArchiveTime = Date::factory(Date::factory('now', $timezone)->getDateStartUTC())->setTimezone($timezone)->getTimestamp(); } } return $minimumArchiveTime; } public static function setTodayArchiveTimeToLive($timeToLiveSeconds) { $timeToLiveSeconds = (int)$timeToLiveSeconds; if ($timeToLiveSeconds <= 0) { throw new Exception(Piwik::translate('General_ExceptionInvalidArchiveTimeToLive')); } Option::set(self::OPTION_TODAY_ARCHIVE_TTL, $timeToLiveSeconds, $autoLoad = true); } public static function getTodayArchiveTimeToLive() { $uiSettingIsEnabled = Controller::isGeneralSettingsAdminEnabled(); if ($uiSettingIsEnabled) { $timeToLive = Option::get(self::OPTION_TODAY_ARCHIVE_TTL); if ($timeToLive !== false) { return $timeToLive; } } return self::getTodayArchiveTimeToLiveDefault(); } public static function getPeriodArchiveTimeToLiveDefault($periodLabel) { if (empty($periodLabel) || strtolower($periodLabel) === 'day') { return self::getTodayArchiveTimeToLive(); } $config = Config::getInstance(); $general = $config->General; $key = sprintf('time_before_%s_archive_considered_outdated', $periodLabel); if (isset($general[$key]) && is_numeric($general[$key]) && $general[$key] > 0) { return $general[$key]; } return self::getTodayArchiveTimeToLive(); } public static function getTodayArchiveTimeToLiveDefault() { return Config::getInstance()->General['time_before_today_archive_considered_outdated']; } public static function isBrowserArchivingAvailableForSegments() { $generalConfig = Config::getInstance()->General; return !$generalConfig['browser_archiving_disabled_enforce']; } public static function isArchivingEnabledFor(array $idSites, Segment $segment, $periodLabel) { $isArchivingEnabled = self::isRequestAuthorizedToArchive() && !self::$archivingDisabledByTests; $generalConfig = Config::getInstance()->General; if ($periodLabel === 'range') { if (isset($generalConfig['archiving_range_force_on_browser_request']) && $generalConfig['archiving_range_force_on_browser_request'] == false ) { Log::debug("Not forcing archiving for range period."); return $isArchivingEnabled; } return true; } if ($segment->isEmpty()) { // viewing "All Visits" return $isArchivingEnabled; } if (!$isArchivingEnabled && (!self::isBrowserArchivingAvailableForSegments() || self::isSegmentPreProcessed($idSites, $segment)) && !SettingsServer::isArchivePhpTriggered() // Only applies when we are not running core:archive command ) { Log::debug("Archiving is disabled because of config setting browser_archiving_disabled_enforce=1 or because the segment is selected to be pre-processed."); return false; } return true; } public static function isArchivingDisabledFor(array $idSites, Segment $segment, $periodLabel) { return !self::isArchivingEnabledFor($idSites, $segment, $periodLabel); } public static function isRequestAuthorizedToArchive(Parameters $params = null) { $isRequestAuthorizedToArchive = Rules::isBrowserTriggerEnabled() || SettingsServer::isArchivePhpTriggered(); if (!empty($params)) { /** * @ignore * * @params bool &$isRequestAuthorizedToArchive * @params Parameters $params */ Piwik::postEvent('Archiving.isRequestAuthorizedToArchive', [&$isRequestAuthorizedToArchive, $params]); } return $isRequestAuthorizedToArchive; } public static function isBrowserTriggerEnabled() { $uiSettingIsEnabled = Controller::isGeneralSettingsAdminEnabled(); if ($uiSettingIsEnabled) { $browserArchivingEnabled = Option::get(self::OPTION_BROWSER_TRIGGER_ARCHIVING); if ($browserArchivingEnabled !== false) { return (bool)$browserArchivingEnabled; } } return (bool)Config::getInstance()->General['enable_browser_archiving_triggering']; } public static function setBrowserTriggerArchiving($enabled) { if (!is_bool($enabled)) { throw new Exception('Browser trigger archiving must be set to true or false.'); } Option::set(self::OPTION_BROWSER_TRIGGER_ARCHIVING, (int)$enabled, $autoLoad = true); Cache::clearCacheGeneral(); } /** * Returns true if the archiving process should skip the calculation of unique visitors * across several sites. The `[General] enable_processing_unique_visitors_multiple_sites` * INI config option controls the value of this variable. * * @return bool */ public static function shouldSkipUniqueVisitorsCalculationForMultipleSites() { return Config::getInstance()->General['enable_processing_unique_visitors_multiple_sites'] != 1; } /** * @param array $idSites * @param Segment $segment * @return bool */ public static function isSegmentPreProcessed(array $idSites, Segment $segment) { $segmentsToProcess = self::getSegmentsToProcess($idSites); if (empty($segmentsToProcess)) { return false; } // If the requested segment is one of the segments to pre-process // we ensure that any call to the API will trigger archiving of all reports for this segment $segment = $segment->getString(); // Turns out the getString() above returns the URL decoded segment string $segmentsToProcessUrlDecoded = array_map('urldecode', $segmentsToProcess); return in_array($segment, $segmentsToProcess) || in_array($segment, $segmentsToProcessUrlDecoded); } /** * Returns done flag values allowed to be selected * * @return string[] */ public static function getSelectableDoneFlagValues( $includeInvalidated = true, Parameters $params = null, $checkAuthorizedToArchive = true ) { $possibleValues = array(ArchiveWriter::DONE_OK, ArchiveWriter::DONE_OK_TEMPORARY); if ($includeInvalidated) { if (!$checkAuthorizedToArchive || !Rules::isRequestAuthorizedToArchive($params)) { //If request is not authorized to archive then fetch also invalidated archives $possibleValues[] = ArchiveWriter::DONE_INVALIDATED; $possibleValues[] = ArchiveWriter::DONE_PARTIAL; } } return $possibleValues; } public static function isRequestingToAndAbleToForceArchiveSinglePlugin() { if (!SettingsServer::isArchivePhpTriggered()) { return false; } return !empty($_GET['pluginOnly']) || !empty($_POST['pluginOnly']); } public static function isActuallyForceArchivingSinglePlugin() { return Loader::getArchivingDepth() <= 1 && self::isRequestingToAndAbleToForceArchiveSinglePlugin(); } public static function shouldProcessSegmentsWhenReArchivingReports() { return Config::getInstance()->General['rearchive_reports_in_past_exclude_segments'] != 1; } public static function isSegmentPluginArchivingDisabled($pluginName, $siteId = null) { $pluginArchivingSetting = GeneralConfig::getConfigValue('disable_archiving_segment_for_plugins', $siteId); if (empty($pluginArchivingSetting)) { return false; } if (is_string($pluginArchivingSetting)) { $pluginArchivingSetting = explode(",", $pluginArchivingSetting); $pluginArchivingSetting = array_filter($pluginArchivingSetting, function($plugin){ return Manager::getInstance()->isValidPluginName($plugin); }); } $pluginArchivingSetting = array_map('strtolower', $pluginArchivingSetting); return in_array(strtolower($pluginName), $pluginArchivingSetting); } }