Symfony Profiler

<?php
declare(strict_types=1);
/**
* Pimcore
*
* This source file is available under two different licenses:
* - GNU General Public License version 3 (GPLv3)
* - Pimcore Commercial License (PCL)
* Full copyright and license information is available in
* LICENSE.md which is distributed with this source code.
*
* @copyright Copyright (c) Pimcore GmbH (http://www.pimcore.org)
* @license http://www.pimcore.org/license GPLv3 and PCL
*/
namespace Pimcore\Targeting;
use Doctrine\DBAL\Connection;
use Pimcore\Debug\Traits\StopwatchTrait;
use Pimcore\Event\Targeting\TargetingEvent;
use Pimcore\Event\Targeting\TargetingResolveVisitorInfoEvent;
use Pimcore\Event\Targeting\TargetingRuleEvent;
use Pimcore\Event\TargetingEvents;
use Pimcore\Model\Tool\Targeting\Rule;
use Pimcore\Targeting\ActionHandler\ActionHandlerInterface;
use Pimcore\Targeting\ActionHandler\DelegatingActionHandler;
use Pimcore\Targeting\Model\VisitorInfo;
use Pimcore\Targeting\Storage\TargetingStorageInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
class VisitorInfoResolver
{
use StopwatchTrait;
const ATTRIBUTE_VISITOR_INFO = '_visitor_info';
const STORAGE_KEY_RULE_CONDITION_VARIABLES = 'vi:var';
const STORAGE_KEY_MATCHED_SESSION_RULES = 'vi:sru'; // visitorInfo:sessionRules
const STORAGE_KEY_MATCHED_VISITOR_RULES = 'vi:vru'; // visitorInfo:visitorRules
/**
* @var TargetingStorageInterface
*/
private $targetingStorage;
/**
* @var VisitorInfoStorageInterface
*/
private $visitorInfoStorage;
/**
* @var ConditionMatcherInterface
*/
private $conditionMatcher;
/**
* @var DelegatingActionHandler|ActionHandlerInterface
*/
private $actionHandler;
/**
* @var Connection
*/
private $db;
/**
* @var EventDispatcherInterface
*/
private $eventDispatcher;
/**
* @var Rule[]
*/
private $targetingRules;
/**
* @var bool
*/
private $targetingConfigured;
public function __construct(
TargetingStorageInterface $targetingStorage,
VisitorInfoStorageInterface $visitorInfoStorage,
ConditionMatcherInterface $conditionMatcher,
ActionHandlerInterface $actionHandler,
Connection $db,
EventDispatcherInterface $eventDispatcher
) {
$this->targetingStorage = $targetingStorage;
$this->visitorInfoStorage = $visitorInfoStorage;
$this->conditionMatcher = $conditionMatcher;
$this->actionHandler = $actionHandler;
$this->eventDispatcher = $eventDispatcher;
$this->db = $db;
}
public function resolve(Request $request): VisitorInfo
{
if ($this->visitorInfoStorage->hasVisitorInfo()) {
return $this->visitorInfoStorage->getVisitorInfo();
}
$visitorInfo = VisitorInfo::fromRequest($request);
if (!$this->isTargetingConfigured()) {
return $visitorInfo;
}
$event = new TargetingResolveVisitorInfoEvent($visitorInfo);
$this->eventDispatcher->dispatch($event, TargetingEvents::PRE_RESOLVE);
$visitorInfo = $event->getVisitorInfo();
$this->matchTargetingRuleConditions($visitorInfo);
$this->eventDispatcher->dispatch(new TargetingEvent($visitorInfo), TargetingEvents::POST_RESOLVE);
$this->visitorInfoStorage->setVisitorInfo($visitorInfo);
return $visitorInfo;
}
public function isTargetingConfigured(): bool
{
if (null !== $this->targetingConfigured) {
return $this->targetingConfigured;
}
$configuredRules = $this->db->fetchOne(
'SELECT id FROM targeting_target_groups UNION SELECT id FROM targeting_rules LIMIT 1'
);
$this->targetingConfigured = $configuredRules && (int)$configuredRules > 0;
return $this->targetingConfigured;
}
private function matchTargetingRuleConditions(VisitorInfo $visitorInfo)
{
$rules = $this->getTargetingRules();
foreach ($rules as $rule) {
if (Rule::SCOPE_SESSION === $rule->getScope()) {
if ($this->ruleWasMatchedInSession($visitorInfo, $rule)) {
continue;
}
} elseif (Rule::SCOPE_VISITOR === $rule->getScope()) {
if ($this->ruleWasMatchedForVisitor($visitorInfo, $rule)) {
continue;
}
}
$this->matchTargetingRuleCondition($visitorInfo, $rule);
}
}
private function matchTargetingRuleCondition(VisitorInfo $visitorInfo, Rule $rule)
{
$scopeWithVariables = Rule::SCOPE_SESSION_WITH_VARIABLES === $rule->getScope();
$this->startStopwatch('Targeting:match:' . $rule->getName(), 'targeting');
$match = $this->conditionMatcher->match(
$visitorInfo,
$rule->getConditions(),
$scopeWithVariables
);
$this->stopStopwatch('Targeting:match:' . $rule->getName());
if (!$match) {
return;
}
if ($scopeWithVariables) {
$collectedVariables = $this->conditionMatcher->getCollectedVariables();
// match only once with the same variables
if ($this->ruleWasMatchedInSessionWithVariables($visitorInfo, $rule, $collectedVariables)) {
return;
}
}
if (Rule::SCOPE_SESSION === $rule->getScope()) {
// record the rule as matched for the current session
$this->markRuleAsMatchedInSession($visitorInfo, $rule);
} elseif (Rule::SCOPE_VISITOR === $rule->getScope()) {
// record the rule as matched for the visitor
$this->markRuleAsMatchedForVisitor($visitorInfo, $rule);
}
// store info about matched rule
$visitorInfo->addMatchingTargetingRule($rule);
$this->eventDispatcher->dispatch(new TargetingRuleEvent($visitorInfo, $rule), TargetingEvents::PRE_RULE_ACTIONS);
// execute rule actions
$this->handleTargetingRuleActions($visitorInfo, $rule);
$this->eventDispatcher->dispatch(new TargetingRuleEvent($visitorInfo, $rule), TargetingEvents::POST_RULE_ACTIONS);
}
private function handleTargetingRuleActions(VisitorInfo $visitorInfo, Rule $rule)
{
$actions = $rule->getActions();
if (!$actions || !is_array($actions)) {
return;
}
foreach ($actions as $action) {
if (!is_array($action)) {
continue;
}
$this->actionHandler->apply($visitorInfo, $action, $rule);
}
}
/**
* @return Rule[]
*/
private function getTargetingRules(): array
{
if (null !== $this->targetingRules) {
return $this->targetingRules;
}
/** @var Rule\Listing|Rule\Listing\Dao $list */
$list = new Rule\Listing();
$list->setCondition('active = 1');
$list->setOrderKey('prio');
$list->setOrder('ASC');
$this->targetingRules = $list->load();
return $this->targetingRules;
}
private function ruleWasMatchedInSession(VisitorInfo $visitorInfo, Rule $rule): bool
{
return $this->ruleWasMatched(
$visitorInfo, $rule,
TargetingStorageInterface::SCOPE_SESSION, self::STORAGE_KEY_MATCHED_SESSION_RULES
);
}
private function markRuleAsMatchedInSession(VisitorInfo $visitorInfo, Rule $rule)
{
$this->markRuleAsMatched(
$visitorInfo, $rule,
TargetingStorageInterface::SCOPE_SESSION, self::STORAGE_KEY_MATCHED_SESSION_RULES
);
}
private function ruleWasMatchedForVisitor(VisitorInfo $visitorInfo, Rule $rule): bool
{
return $this->ruleWasMatched(
$visitorInfo, $rule,
TargetingStorageInterface::SCOPE_VISITOR, self::STORAGE_KEY_MATCHED_VISITOR_RULES
);
}
private function markRuleAsMatchedForVisitor(VisitorInfo $visitorInfo, Rule $rule)
{
$this->markRuleAsMatched(
$visitorInfo, $rule,
TargetingStorageInterface::SCOPE_VISITOR, self::STORAGE_KEY_MATCHED_VISITOR_RULES
);
}
private function ruleWasMatched(VisitorInfo $visitorInfo, Rule $rule, string $scope, string $storageKey): bool
{
$matchedRules = $this->targetingStorage->get($visitorInfo, $scope, $storageKey, []);
return in_array($rule->getId(), $matchedRules);
}
private function markRuleAsMatched(VisitorInfo $visitorInfo, Rule $rule, string $scope, string $storageKey)
{
$matchedRules = $this->targetingStorage->get($visitorInfo, $scope, $storageKey, []);
if (!in_array($rule->getId(), $matchedRules)) {
$matchedRules[] = $rule->getId();
}
$this->targetingStorage->set($visitorInfo, $scope, $storageKey, $matchedRules);
}
private function ruleWasMatchedInSessionWithVariables(VisitorInfo $visitorInfo, Rule $rule, array $variables): bool
{
$hash = sha1(serialize($variables));
$storedVariables = $this->targetingStorage->get(
$visitorInfo,
TargetingStorageInterface::SCOPE_SESSION,
self::STORAGE_KEY_RULE_CONDITION_VARIABLES,
[]
);
// hash was already matched
if (isset($storedVariables[$rule->getId()]) && $storedVariables[$rule->getId()] === $hash) {
return true;
}
// store hash to storage
$storedVariables[$rule->getId()] = $hash;
$this->targetingStorage->set(
$visitorInfo,
TargetingStorageInterface::SCOPE_SESSION,
self::STORAGE_KEY_RULE_CONDITION_VARIABLES,
$storedVariables
);
return false;
}
}

vendor/pimcore/pimcore/lib/Targeting/VisitorInfoResolver.php line 116