DynamicSegments
1 month ago
RestApi
1 month ago
SegmentDependencyValidator.php
3 years ago
SegmentListingRepository.php
1 month ago
SegmentSaveController.php
2 weeks ago
SegmentSubscribersRepository.php
2 weeks ago
SegmentsFinder.php
3 years ago
SegmentsRepository.php
2 weeks ago
SegmentsSimpleListRepository.php
2 months ago
SubscribersFinder.php
1 month ago
WP.php
2 weeks ago
WooCommerce.php
2 weeks ago
index.php
3 years ago
SubscribersFinder.php
224 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\Segments; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use MailPoet\Entities\ScheduledTaskEntity; |
| 9 | use MailPoet\Entities\ScheduledTaskSubscriberEntity; |
| 10 | use MailPoet\Entities\SegmentEntity; |
| 11 | use MailPoet\Entities\SubscriberEntity; |
| 12 | use MailPoet\Entities\SubscriberSegmentEntity; |
| 13 | use MailPoet\InvalidStateException; |
| 14 | use MailPoet\Newsletter\Sending\ScheduledTaskSubscribersRepository; |
| 15 | use MailPoetVendor\Doctrine\DBAL\ArrayParameterType; |
| 16 | use MailPoetVendor\Doctrine\DBAL\ParameterType; |
| 17 | use MailPoetVendor\Doctrine\ORM\EntityManager; |
| 18 | |
| 19 | class SubscribersFinder { |
| 20 | |
| 21 | /** @var SegmentSubscribersRepository */ |
| 22 | private $segmentSubscriberRepository; |
| 23 | |
| 24 | /** @var SegmentsRepository */ |
| 25 | private $segmentsRepository; |
| 26 | |
| 27 | /** @var EntityManager */ |
| 28 | private $entityManager; |
| 29 | |
| 30 | /** @var ScheduledTaskSubscribersRepository */ |
| 31 | private $scheduledTaskSubscribersRepository; |
| 32 | |
| 33 | public function __construct( |
| 34 | SegmentSubscribersRepository $segmentSubscriberRepository, |
| 35 | SegmentsRepository $segmentsRepository, |
| 36 | EntityManager $entityManager, |
| 37 | ScheduledTaskSubscribersRepository $scheduledTaskSubscribersRepository |
| 38 | ) { |
| 39 | $this->segmentSubscriberRepository = $segmentSubscriberRepository; |
| 40 | $this->segmentsRepository = $segmentsRepository; |
| 41 | $this->entityManager = $entityManager; |
| 42 | $this->scheduledTaskSubscribersRepository = $scheduledTaskSubscribersRepository; |
| 43 | } |
| 44 | |
| 45 | /** |
| 46 | * @return array |
| 47 | * @throws InvalidStateException |
| 48 | */ |
| 49 | public function findSubscribersInSegments($subscribersToProcessIds, $newsletterSegmentsIds, ?int $filterSegmentId = null) { |
| 50 | $result = []; |
| 51 | foreach ($newsletterSegmentsIds as $segmentId) { |
| 52 | $segment = $this->segmentsRepository->findOneById($segmentId); |
| 53 | if (!$segment instanceof SegmentEntity) { |
| 54 | continue; // skip deleted segments |
| 55 | } |
| 56 | $result = array_merge($result, $this->findSubscribersInSegment($segment, $subscribersToProcessIds)); |
| 57 | } |
| 58 | |
| 59 | if (is_int($filterSegmentId)) { |
| 60 | $filterSegment = $this->segmentsRepository->verifyDynamicSegmentExists($filterSegmentId); |
| 61 | $idsInFilterSegment = $this->findSubscribersInSegment($filterSegment, $subscribersToProcessIds); |
| 62 | $result = array_intersect($result, $idsInFilterSegment); |
| 63 | } |
| 64 | |
| 65 | return $this->unique($result); |
| 66 | } |
| 67 | |
| 68 | /** |
| 69 | * @param int[] $newsletterSegmentsIds |
| 70 | * @return int[] |
| 71 | * @throws InvalidStateException |
| 72 | */ |
| 73 | public function getSubscriberIdsFromSegments(array $newsletterSegmentsIds, ?int $filterSegmentId = null): array { |
| 74 | $result = []; |
| 75 | foreach ($newsletterSegmentsIds as $segmentId) { |
| 76 | $segment = $this->segmentsRepository->findOneById($segmentId); |
| 77 | if (!$segment instanceof SegmentEntity) { |
| 78 | continue; |
| 79 | } |
| 80 | try { |
| 81 | $result = array_merge($result, $this->segmentSubscriberRepository->getSubscriberIdsInSegment((int)$segment->getId())); |
| 82 | } catch (InvalidStateException $exception) { |
| 83 | continue; |
| 84 | } |
| 85 | } |
| 86 | |
| 87 | if (is_int($filterSegmentId)) { |
| 88 | $filterSegment = $this->segmentsRepository->verifyDynamicSegmentExists($filterSegmentId); |
| 89 | $filterSubscriberIds = $this->segmentSubscriberRepository->getSubscriberIdsInSegment((int)$filterSegment->getId()); |
| 90 | $result = array_intersect($result, $filterSubscriberIds); |
| 91 | } |
| 92 | |
| 93 | return array_values($this->unique($result)); |
| 94 | } |
| 95 | |
| 96 | private function findSubscribersInSegment(SegmentEntity $segment, $subscribersToProcessIds): array { |
| 97 | try { |
| 98 | return $this->segmentSubscriberRepository->findSubscribersIdsInSegment((int)$segment->getId(), $subscribersToProcessIds); |
| 99 | } catch (InvalidStateException $e) { |
| 100 | return []; |
| 101 | } |
| 102 | } |
| 103 | |
| 104 | /** |
| 105 | * @param ScheduledTaskEntity $task |
| 106 | * @param array<int> $segmentIds |
| 107 | * |
| 108 | * @return void |
| 109 | */ |
| 110 | public function addSubscribersToTaskFromSegments(ScheduledTaskEntity $task, array $segmentIds, ?int $filterSegmentId = null): void { |
| 111 | // Prepare subscribers on the DB side for performance reasons |
| 112 | if (is_int($filterSegmentId)) { |
| 113 | try { |
| 114 | $this->segmentsRepository->verifyDynamicSegmentExists($filterSegmentId); |
| 115 | } catch (InvalidStateException $exception) { |
| 116 | return; |
| 117 | } |
| 118 | } |
| 119 | $staticSegmentIds = []; |
| 120 | $dynamicSegmentIds = []; |
| 121 | foreach ($segmentIds as $segment) { |
| 122 | $segment = $this->segmentsRepository->findOneById($segment); |
| 123 | if ($segment instanceof SegmentEntity) { |
| 124 | if ($segment->isStatic()) { |
| 125 | $staticSegmentIds[] = (int)$segment->getId(); |
| 126 | } elseif ($segment->getType() === SegmentEntity::TYPE_DYNAMIC) { |
| 127 | $dynamicSegmentIds[] = (int)$segment->getId(); |
| 128 | } |
| 129 | } |
| 130 | } |
| 131 | $count = 0; |
| 132 | if (!empty($staticSegmentIds)) { |
| 133 | $count += $this->addSubscribersToTaskFromStaticSegments($task, $staticSegmentIds, $filterSegmentId); |
| 134 | } |
| 135 | if (!empty($dynamicSegmentIds)) { |
| 136 | $count += $this->addSubscribersToTaskFromDynamicSegments($task, $dynamicSegmentIds, $filterSegmentId); |
| 137 | } |
| 138 | if ($count > 0) { |
| 139 | $this->entityManager->refresh($task); |
| 140 | } |
| 141 | } |
| 142 | |
| 143 | /** |
| 144 | * @param ScheduledTaskEntity $task |
| 145 | * @param array<int> $segmentIds |
| 146 | * |
| 147 | * @return int |
| 148 | */ |
| 149 | private function addSubscribersToTaskFromStaticSegments(ScheduledTaskEntity $task, array $segmentIds, ?int $filterSegmentId = null) { |
| 150 | $scheduledTaskSubscriberTable = $this->entityManager->getClassMetadata(ScheduledTaskSubscriberEntity::class)->getTableName(); |
| 151 | $subscriberSegmentTable = $this->entityManager->getClassMetadata(SubscriberSegmentEntity::class)->getTableName(); |
| 152 | $subscriberTable = $this->entityManager->getClassMetadata(SubscriberEntity::class)->getTableName(); |
| 153 | |
| 154 | $connection = $this->entityManager->getConnection(); |
| 155 | $selectQueryBuilder = $connection->createQueryBuilder(); |
| 156 | $selectQueryBuilder |
| 157 | // No DISTINCT needed: the INSERT IGNORE relies on the (task_id, subscriber_id) |
| 158 | // primary key of scheduled_task_subscribers to drop duplicates, and DISTINCT |
| 159 | // forces an expensive temporary table on large segments. |
| 160 | ->select(':task_id as task_id', 'subscribers.id as subscriber_id', ':processed as processed') |
| 161 | ->from($subscriberSegmentTable, 'relation') |
| 162 | ->join('relation', $subscriberTable, 'subscribers', 'subscribers.id = relation.subscriber_id') |
| 163 | ->where('subscribers.deleted_at IS NULL') |
| 164 | ->andWhere('subscribers.status = :subscribers_status') |
| 165 | ->andWhere('relation.status = :relation_status') |
| 166 | ->andWhere($selectQueryBuilder->expr()->in('relation.segment_id', ':segment_ids')) |
| 167 | ->setParameter('task_id', $task->getId(), ParameterType::INTEGER) |
| 168 | ->setParameter('processed', ScheduledTaskSubscriberEntity::STATUS_UNPROCESSED, ParameterType::INTEGER) |
| 169 | ->setParameter('subscribers_status', SubscriberEntity::STATUS_SUBSCRIBED, ParameterType::STRING) |
| 170 | ->setParameter('relation_status', SubscriberEntity::STATUS_SUBSCRIBED, ParameterType::STRING) |
| 171 | ->setParameter('segment_ids', $segmentIds, ArrayParameterType::INTEGER); |
| 172 | |
| 173 | if ($filterSegmentId) { |
| 174 | $filterSegmentSubscriberIds = $this->segmentSubscriberRepository->findSubscribersIdsInSegment($filterSegmentId); |
| 175 | $selectQueryBuilder |
| 176 | ->andWhere($selectQueryBuilder->expr()->in('subscribers.id', ':filterSegmentSubscriberIds')) |
| 177 | ->setParameter('filterSegmentSubscriberIds', $filterSegmentSubscriberIds, ArrayParameterType::INTEGER); |
| 178 | } |
| 179 | |
| 180 | // queryBuilder doesn't support INSERT IGNORE directly |
| 181 | $sql = "INSERT IGNORE INTO $scheduledTaskSubscriberTable (task_id, subscriber_id, processed) " . $selectQueryBuilder->getSQL(); |
| 182 | $result = $connection->executeQuery($sql, $selectQueryBuilder->getParameters(), $selectQueryBuilder->getParameterTypes()); |
| 183 | |
| 184 | return (int)$result->rowCount(); |
| 185 | } |
| 186 | |
| 187 | /** |
| 188 | * @param ScheduledTaskEntity $task |
| 189 | * @param array<int> $segmentIds |
| 190 | * |
| 191 | * @return int |
| 192 | */ |
| 193 | private function addSubscribersToTaskFromDynamicSegments(ScheduledTaskEntity $task, array $segmentIds, ?int $filterSegmentId = null) { |
| 194 | $count = 0; |
| 195 | foreach ($segmentIds as $segmentId) { |
| 196 | $count += $this->addSubscribersToTaskFromDynamicSegment($task, (int)$segmentId, $filterSegmentId); |
| 197 | } |
| 198 | return $count; |
| 199 | } |
| 200 | |
| 201 | private function addSubscribersToTaskFromDynamicSegment(ScheduledTaskEntity $task, int $segmentId, ?int $filterSegmentId) { |
| 202 | $count = 0; |
| 203 | $subscriberIds = $this->segmentSubscriberRepository->getSubscriberIdsInSegment($segmentId); |
| 204 | |
| 205 | if ($filterSegmentId) { |
| 206 | $filterSegmentSubscriberIds = $this->segmentSubscriberRepository->getSubscriberIdsInSegment($filterSegmentId); |
| 207 | $subscriberIds = array_intersect($subscriberIds, $filterSegmentSubscriberIds); |
| 208 | } |
| 209 | |
| 210 | if ($subscriberIds) { |
| 211 | $count += $this->scheduledTaskSubscribersRepository->addSubscribersByIds($task, $subscriberIds); |
| 212 | } |
| 213 | return $count; |
| 214 | } |
| 215 | |
| 216 | private function unique(array $subscriberIds) { |
| 217 | $result = []; |
| 218 | foreach ($subscriberIds as $id) { |
| 219 | $result[$id] = $id; |
| 220 | } |
| 221 | return $result; |
| 222 | } |
| 223 | } |
| 224 |