Exceptions
2 months ago
Filters
1 month ago
DynamicSegmentFilterRepository.php
4 years ago
DynamicSegmentsListingRepository.php
1 month ago
FilterDataMapper.php
1 month ago
FilterFactory.php
2 months ago
FilterHandler.php
2 months ago
SegmentSaveController.php
2 years ago
index.php
3 years ago
FilterHandler.php
188 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Segments\DynamicSegments; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Entities\DynamicSegmentFilterData; |
| 9 | use MailPoet\Entities\SegmentEntity; |
| 10 | use MailPoet\Entities\SubscriberEntity; |
| 11 | use MailPoet\Segments\SegmentDependencyValidator; |
| 12 | use MailPoetVendor\Doctrine\DBAL\Query\QueryBuilder; |
| 13 | use MailPoetVendor\Doctrine\ORM\EntityManager; |
| 14 | |
| 15 | class FilterHandler { |
| 16 | /** @var EntityManager */ |
| 17 | private $entityManager; |
| 18 | |
| 19 | /** @var SegmentDependencyValidator */ |
| 20 | private $segmentDependencyValidator; |
| 21 | |
| 22 | /** @var FilterFactory */ |
| 23 | private $filterFactory; |
| 24 | |
| 25 | public function __construct( |
| 26 | EntityManager $entityManager, |
| 27 | SegmentDependencyValidator $segmentDependencyValidator, |
| 28 | FilterFactory $filterFactory |
| 29 | ) { |
| 30 | |
| 31 | $this->entityManager = $entityManager; |
| 32 | $this->segmentDependencyValidator = $segmentDependencyValidator; |
| 33 | $this->filterFactory = $filterFactory; |
| 34 | } |
| 35 | |
| 36 | public function apply(QueryBuilder $queryBuilder, SegmentEntity $segment): QueryBuilder { |
| 37 | $allFilters = $segment->getDynamicFilters(); |
| 38 | $subscribersTable = $this->entityManager->getClassMetadata(SubscriberEntity::class)->getTableName(); |
| 39 | $pluginsForAllFiltersMissing = $this->segmentDependencyValidator->getMissingPluginsByAllFilters($allFilters); |
| 40 | if ($pluginsForAllFiltersMissing) { |
| 41 | return $queryBuilder->andWhere('1 = 0'); |
| 42 | } |
| 43 | |
| 44 | $groups = $segment->getFilterGroups(); |
| 45 | $builtGroups = []; |
| 46 | foreach ($groups as $group) { |
| 47 | $groupOperator = $group['operator']; |
| 48 | $filterSelects = []; |
| 49 | foreach ($group['filters'] as $filter) { |
| 50 | $subscribersIdsQuery = $this->entityManager |
| 51 | ->getConnection() |
| 52 | ->createQueryBuilder() |
| 53 | ->select("DISTINCT $subscribersTable.id as inner_subscriber_id") |
| 54 | ->from($subscribersTable); |
| 55 | // When a required plugin is missing inside a NONE group, we cannot evaluate the |
| 56 | // negation reliably — fail closed and return empty. |
| 57 | $missingPlugins = $this->segmentDependencyValidator->getMissingPluginsByFilter($filter); |
| 58 | if ($missingPlugins && $groupOperator === DynamicSegmentFilterData::CONNECT_TYPE_NONE) { |
| 59 | return $queryBuilder->andWhere('1 = 0'); |
| 60 | } |
| 61 | if ($missingPlugins) { |
| 62 | $subscribersIdsQuery->andWhere('1 = 0'); |
| 63 | } else { |
| 64 | $this->filterFactory->getFilterForFilterEntity($filter)->apply($subscribersIdsQuery, $filter); |
| 65 | } |
| 66 | $filterSelects[] = $subscribersIdsQuery->getSQL(); |
| 67 | $queryBuilder->setParameters( |
| 68 | array_merge( |
| 69 | $subscribersIdsQuery->getParameters(), |
| 70 | $queryBuilder->getParameters() |
| 71 | ), |
| 72 | array_merge( |
| 73 | $subscribersIdsQuery->getParameterTypes(), |
| 74 | $queryBuilder->getParameterTypes() |
| 75 | ) |
| 76 | ); |
| 77 | } |
| 78 | if ($filterSelects) { |
| 79 | $builtGroups[] = ['operator' => $groupOperator, 'selects' => $filterSelects]; |
| 80 | } |
| 81 | } |
| 82 | |
| 83 | // Fast path: a single group — emit its filter subqueries directly via joinSubqueries |
| 84 | // with the group's own operator. Covers every legacy segment (which always collapses |
| 85 | // to one group) and avoids wrapping the filter selects in an extra derived table. |
| 86 | // Preserves the SQL shape MySQL was previously optimizing against. |
| 87 | if (count($builtGroups) === 1) { |
| 88 | $only = $builtGroups[0]; |
| 89 | $this->joinSubqueries($queryBuilder, $only['operator'], $only['selects']); |
| 90 | return $queryBuilder; |
| 91 | } |
| 92 | |
| 93 | $groupSelects = []; |
| 94 | foreach ($builtGroups as $built) { |
| 95 | $groupSelects[] = $this->combineGroupFilters($built['operator'], $built['selects'], $subscribersTable); |
| 96 | } |
| 97 | |
| 98 | $outerOperator = $segment->getFiltersConnectOperator(); |
| 99 | // Multi-group segments must use AND/OR as the outer connector — FilterDataMapper |
| 100 | // rejects NONE in that case. Coerce defensively in case unusual data slips through. |
| 101 | if ($outerOperator === DynamicSegmentFilterData::CONNECT_TYPE_NONE) { |
| 102 | $outerOperator = DynamicSegmentFilterData::CONNECT_TYPE_AND; |
| 103 | } |
| 104 | $this->joinSubqueries($queryBuilder, $outerOperator, $groupSelects); |
| 105 | return $queryBuilder; |
| 106 | } |
| 107 | |
| 108 | /** |
| 109 | * Combines filter subqueries within a single group into one derived-table SQL string |
| 110 | * that yields `inner_subscriber_id` rows. |
| 111 | * |
| 112 | * @param string[] $filterSelects |
| 113 | */ |
| 114 | private function combineGroupFilters(string $groupOperator, array $filterSelects, string $subscribersTable): string { |
| 115 | if ($groupOperator === DynamicSegmentFilterData::CONNECT_TYPE_NONE) { |
| 116 | $unionSql = join(' UNION ', $filterSelects); |
| 117 | return sprintf( |
| 118 | "SELECT %s.id AS inner_subscriber_id FROM %s LEFT JOIN (%s) excluded_subscribers ON excluded_subscribers.inner_subscriber_id = %s.id WHERE excluded_subscribers.inner_subscriber_id IS NULL", |
| 119 | $subscribersTable, |
| 120 | $subscribersTable, |
| 121 | $unionSql, |
| 122 | $subscribersTable |
| 123 | ); |
| 124 | } |
| 125 | |
| 126 | if (count($filterSelects) === 1) { |
| 127 | return $filterSelects[0]; |
| 128 | } |
| 129 | |
| 130 | if ($groupOperator === DynamicSegmentFilterData::CONNECT_TYPE_OR) { |
| 131 | return join(' UNION ', $filterSelects); |
| 132 | } |
| 133 | |
| 134 | // AND: chain INNER JOINs on inner_subscriber_id |
| 135 | $sql = sprintf('SELECT a0.inner_subscriber_id FROM (%s) a0', array_shift($filterSelects)); |
| 136 | $index = 1; |
| 137 | foreach ($filterSelects as $filterSelect) { |
| 138 | $sql .= sprintf( |
| 139 | ' INNER JOIN (%s) a%d ON a%d.inner_subscriber_id = a0.inner_subscriber_id', |
| 140 | $filterSelect, |
| 141 | $index, |
| 142 | $index |
| 143 | ); |
| 144 | $index++; |
| 145 | } |
| 146 | return $sql; |
| 147 | } |
| 148 | |
| 149 | private function joinSubqueries(QueryBuilder $queryBuilder, string $filtersConnectOperator, array $subQueries): QueryBuilder { |
| 150 | if (!$subQueries) return $queryBuilder; |
| 151 | $subscribersTable = $this->entityManager->getClassMetadata(SubscriberEntity::class)->getTableName(); |
| 152 | |
| 153 | if ($filtersConnectOperator === DynamicSegmentFilterData::CONNECT_TYPE_OR) { |
| 154 | // the final query: SELECT * FROM subscribers INNER JOIN (filter_select1 UNION filter_select2) filtered_subscribers ON filtered_subscribers.inner_subscriber_id = id |
| 155 | $queryBuilder->innerJoin( |
| 156 | $subscribersTable, |
| 157 | sprintf('(%s)', join(' UNION ', $subQueries)), |
| 158 | 'filtered_subscribers', |
| 159 | "filtered_subscribers.inner_subscriber_id = $subscribersTable.id" |
| 160 | ); |
| 161 | return $queryBuilder; |
| 162 | } |
| 163 | |
| 164 | if ($filtersConnectOperator === DynamicSegmentFilterData::CONNECT_TYPE_NONE) { |
| 165 | $queryBuilder->leftJoin( |
| 166 | $subscribersTable, |
| 167 | sprintf('(%s)', join(' UNION ', $subQueries)), |
| 168 | 'filtered_subscribers', |
| 169 | "filtered_subscribers.inner_subscriber_id = $subscribersTable.id" |
| 170 | ) |
| 171 | ->andWhere('filtered_subscribers.inner_subscriber_id IS NULL'); |
| 172 | return $queryBuilder; |
| 173 | } |
| 174 | |
| 175 | foreach ($subQueries as $key => $subQuery) { |
| 176 | // we need a unique name for each subquery so that we can join them together in the sql query - just make sure the identifier starts with a letter, not a number |
| 177 | $subqueryName = 'a' . $key; |
| 178 | $queryBuilder->innerJoin( |
| 179 | $subscribersTable, |
| 180 | "($subQuery)", |
| 181 | $subqueryName, |
| 182 | "$subqueryName.inner_subscriber_id = $subscribersTable.id" |
| 183 | ); |
| 184 | } |
| 185 | return $queryBuilder; |
| 186 | } |
| 187 | } |
| 188 |