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
SegmentsRepository.php
461 lines
| 1 | <?php // phpcs:ignore SlevomatCodingStandard.TypeHints.DeclareStrictTypes.DeclareStrictTypesMissing |
| 2 | |
| 3 | namespace MailPoet\Segments; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use DateTime; |
| 9 | use MailPoet\ConflictException; |
| 10 | use MailPoet\Doctrine\Repository; |
| 11 | use MailPoet\Entities\DynamicSegmentFilterData; |
| 12 | use MailPoet\Entities\DynamicSegmentFilterEntity; |
| 13 | use MailPoet\Entities\NewsletterSegmentEntity; |
| 14 | use MailPoet\Entities\SegmentEntity; |
| 15 | use MailPoet\Entities\SubscriberEntity; |
| 16 | use MailPoet\Entities\SubscriberSegmentEntity; |
| 17 | use MailPoet\Form\FormsRepository; |
| 18 | use MailPoet\InvalidStateException; |
| 19 | use MailPoet\Logging\LoggerFactory; |
| 20 | use MailPoet\Newsletter\Segment\NewsletterSegmentRepository; |
| 21 | use MailPoet\NotFoundException; |
| 22 | use MailPoet\Subscribers\SegmentsCountRecalculator; |
| 23 | use MailPoet\WP\Functions as WPFunctions; |
| 24 | use MailPoetVendor\Carbon\Carbon; |
| 25 | use MailPoetVendor\Doctrine\DBAL\ArrayParameterType; |
| 26 | use MailPoetVendor\Doctrine\DBAL\ParameterType; |
| 27 | use MailPoetVendor\Doctrine\ORM\EntityManager; |
| 28 | use MailPoetVendor\Doctrine\ORM\ORMException; |
| 29 | |
| 30 | /** |
| 31 | * @extends Repository<SegmentEntity> |
| 32 | */ |
| 33 | class SegmentsRepository extends Repository { |
| 34 | |
| 35 | /** @var NewsletterSegmentRepository */ |
| 36 | private $newsletterSegmentRepository; |
| 37 | |
| 38 | /** @var FormsRepository */ |
| 39 | private $formsRepository; |
| 40 | |
| 41 | /** @var WPFunctions */ |
| 42 | private $wp; |
| 43 | |
| 44 | /** @var LoggerFactory */ |
| 45 | private $loggerFactory; |
| 46 | |
| 47 | /** @var SegmentsCountRecalculator */ |
| 48 | private $segmentsCountRecalculator; |
| 49 | |
| 50 | public function __construct( |
| 51 | EntityManager $entityManager, |
| 52 | NewsletterSegmentRepository $newsletterSegmentRepository, |
| 53 | FormsRepository $formsRepository, |
| 54 | WPFunctions $wp, |
| 55 | LoggerFactory $loggerFactory, |
| 56 | SegmentsCountRecalculator $segmentsCountRecalculator |
| 57 | ) { |
| 58 | parent::__construct($entityManager); |
| 59 | $this->newsletterSegmentRepository = $newsletterSegmentRepository; |
| 60 | $this->formsRepository = $formsRepository; |
| 61 | $this->wp = $wp; |
| 62 | $this->loggerFactory = $loggerFactory; |
| 63 | $this->segmentsCountRecalculator = $segmentsCountRecalculator; |
| 64 | } |
| 65 | |
| 66 | protected function getEntityClassName() { |
| 67 | return SegmentEntity::class; |
| 68 | } |
| 69 | |
| 70 | /** |
| 71 | * @param string[] $types |
| 72 | * @return SegmentEntity[] |
| 73 | */ |
| 74 | public function findByTypeNotIn(array $types): array { |
| 75 | return $this->doctrineRepository->createQueryBuilder('s') |
| 76 | ->select('s') |
| 77 | ->where('s.type NOT IN (:types)') |
| 78 | ->setParameter('types', $types) |
| 79 | ->getQuery() |
| 80 | ->getResult(); |
| 81 | } |
| 82 | |
| 83 | public function getWPUsersSegment(): SegmentEntity { |
| 84 | $cached = current( |
| 85 | array_filter( |
| 86 | $this->getAllFromIdentityMap(), |
| 87 | fn(SegmentEntity $segment) => $segment->getType() === SegmentEntity::TYPE_WP_USERS |
| 88 | ) |
| 89 | ); |
| 90 | |
| 91 | if ($cached) { |
| 92 | return $cached; |
| 93 | } |
| 94 | |
| 95 | $segment = $this->findOneBy(['type' => SegmentEntity::TYPE_WP_USERS]); |
| 96 | if (!$segment) { |
| 97 | // create the wp users segment |
| 98 | $segment = new SegmentEntity( |
| 99 | __('WordPress Users', 'mailpoet'), |
| 100 | SegmentEntity::TYPE_WP_USERS, |
| 101 | __('This list contains all of your WordPress users.', 'mailpoet') |
| 102 | ); |
| 103 | $this->entityManager->persist($segment); |
| 104 | $this->entityManager->flush(); |
| 105 | } |
| 106 | return $segment; |
| 107 | } |
| 108 | |
| 109 | public function getWooCommerceSegment(): SegmentEntity { |
| 110 | $cached = current( |
| 111 | array_filter( |
| 112 | $this->getAllFromIdentityMap(), |
| 113 | fn(SegmentEntity $segment) => $segment->getType() === SegmentEntity::TYPE_WC_USERS |
| 114 | ) |
| 115 | ); |
| 116 | |
| 117 | if ($cached) { |
| 118 | return $cached; |
| 119 | } |
| 120 | |
| 121 | $segment = $this->findOneBy(['type' => SegmentEntity::TYPE_WC_USERS]); |
| 122 | if (!$segment) { |
| 123 | // create the WooCommerce customers segment |
| 124 | $segment = new SegmentEntity( |
| 125 | __('WooCommerce Customers', 'mailpoet'), |
| 126 | SegmentEntity::TYPE_WC_USERS, |
| 127 | __('This list contains all of your WooCommerce customers.', 'mailpoet') |
| 128 | ); |
| 129 | $this->entityManager->persist($segment); |
| 130 | $this->entityManager->flush(); |
| 131 | } |
| 132 | return $segment; |
| 133 | } |
| 134 | |
| 135 | public function getCountsPerType(): array { |
| 136 | $results = $this->doctrineRepository->createQueryBuilder('s') |
| 137 | ->select('s.type, COUNT(s) as cnt') |
| 138 | ->where('s.deletedAt IS NULL') |
| 139 | ->groupBy('s.type') |
| 140 | ->getQuery() |
| 141 | ->getResult(); |
| 142 | |
| 143 | $countMap = []; |
| 144 | foreach ($results as $result) { |
| 145 | $countMap[$result['type']] = (int)$result['cnt']; |
| 146 | } |
| 147 | return $countMap; |
| 148 | } |
| 149 | |
| 150 | public function isNameUnique(string $name, ?int $id): bool { |
| 151 | $qb = $this->doctrineRepository->createQueryBuilder('s') |
| 152 | ->select('s') |
| 153 | ->where('s.name = :name') |
| 154 | ->setParameter('name', $name); |
| 155 | |
| 156 | if ($id !== null) { |
| 157 | $qb->andWhere('s.id != :id') |
| 158 | ->setParameter('id', $id); |
| 159 | } |
| 160 | |
| 161 | $results = $qb->getQuery() |
| 162 | ->getResult(); |
| 163 | |
| 164 | return count($results) === 0; |
| 165 | } |
| 166 | |
| 167 | /** |
| 168 | * @throws ConflictException |
| 169 | */ |
| 170 | public function verifyNameIsUnique(string $name, ?int $id): void { |
| 171 | if (!$this->isNameUnique($name, $id)) { |
| 172 | throw new ConflictException("Could not create new segment with name [{$name}] because a segment with that name already exists."); |
| 173 | } |
| 174 | } |
| 175 | |
| 176 | /** |
| 177 | * @param int $id |
| 178 | * |
| 179 | * @return SegmentEntity |
| 180 | * @throws InvalidStateException |
| 181 | */ |
| 182 | public function verifyDynamicSegmentExists(int $id): SegmentEntity { |
| 183 | try { |
| 184 | $dynamicSegment = $this->findOneById($id); |
| 185 | if (!$dynamicSegment instanceof SegmentEntity) { |
| 186 | throw InvalidStateException::create()->withMessage(sprintf("Could not find segment with ID '%s'.", $id)); |
| 187 | } |
| 188 | if ($dynamicSegment->getType() !== SegmentEntity::TYPE_DYNAMIC) { |
| 189 | throw InvalidStateException::create()->withMessage(sprintf("Segment with ID '%s' is not a dynamic segment. Its type is %s.", $id, $dynamicSegment->getType())); |
| 190 | } |
| 191 | } catch (InvalidStateException $exception) { |
| 192 | $this->loggerFactory->getLogger(LoggerFactory::TOPIC_SEGMENTS)->error(sprintf("Could not verify existence of dynamic segment: %s", $exception->getMessage())); |
| 193 | throw $exception; |
| 194 | } |
| 195 | return $dynamicSegment; |
| 196 | } |
| 197 | |
| 198 | /** |
| 199 | * @param DynamicSegmentFilterData[] $filtersData |
| 200 | * @throws ConflictException |
| 201 | * @throws NotFoundException |
| 202 | * @throws ORMException |
| 203 | */ |
| 204 | public function createOrUpdate( |
| 205 | string $name, |
| 206 | string $description = '', |
| 207 | string $type = SegmentEntity::TYPE_DEFAULT, |
| 208 | array $filtersData = [], |
| 209 | ?int $id = null, |
| 210 | bool $displayInManageSubscriptionPage = true, |
| 211 | ?int $confirmationEmailId = null, |
| 212 | ?int $confirmationPageId = null, |
| 213 | ?string $publicDescription = null |
| 214 | ): SegmentEntity { |
| 215 | if ($confirmationEmailId !== null && $confirmationEmailId <= 0) { |
| 216 | $confirmationEmailId = null; |
| 217 | } |
| 218 | if ($confirmationPageId !== null && $confirmationPageId <= 0) { |
| 219 | $confirmationPageId = null; |
| 220 | } |
| 221 | $displayInManageSubPage = $type === SegmentEntity::TYPE_DEFAULT ? $displayInManageSubscriptionPage : false; |
| 222 | |
| 223 | if ($id) { |
| 224 | $segment = $this->findOneById($id); |
| 225 | if (!$segment instanceof SegmentEntity) { |
| 226 | throw new NotFoundException("Segment with ID [{$id}] was not found."); |
| 227 | } |
| 228 | if ($name !== $segment->getName()) { |
| 229 | $this->verifyNameIsUnique($name, $id); |
| 230 | $segment->setName($name); |
| 231 | } |
| 232 | $segment->setDescription($description); |
| 233 | $segment->setDisplayInManageSubscriptionPage($displayInManageSubPage); |
| 234 | $segment->setConfirmationEmailId($confirmationEmailId); |
| 235 | $segment->setConfirmationPageId($confirmationPageId); |
| 236 | if ($publicDescription !== null) { |
| 237 | $segment->setPublicDescription($publicDescription); |
| 238 | } |
| 239 | } else { |
| 240 | $this->verifyNameIsUnique($name, $id); |
| 241 | $segment = new SegmentEntity($name, $type, $description); |
| 242 | $segment->setDisplayInManageSubscriptionPage($displayInManageSubPage); |
| 243 | $segment->setConfirmationEmailId($confirmationEmailId); |
| 244 | $segment->setConfirmationPageId($confirmationPageId); |
| 245 | $segment->setPublicDescription($publicDescription ?? ''); |
| 246 | $this->persist($segment); |
| 247 | } |
| 248 | |
| 249 | // We want to remove redundant filters before update |
| 250 | while ($segment->getDynamicFilters()->count() > count($filtersData)) { |
| 251 | $filterEntity = $segment->getDynamicFilters()->last(); |
| 252 | if ($filterEntity) { |
| 253 | $segment->getDynamicFilters()->removeElement($filterEntity); |
| 254 | $this->entityManager->remove($filterEntity); |
| 255 | } |
| 256 | } |
| 257 | |
| 258 | $createOrUpdateFilter = function ($filterData, $key) use ($segment) { |
| 259 | if ($filterData instanceof DynamicSegmentFilterData) { |
| 260 | $filterEntity = $segment->getDynamicFilters()->get($key); |
| 261 | if (!$filterEntity instanceof DynamicSegmentFilterEntity) { |
| 262 | $filterEntity = new DynamicSegmentFilterEntity($segment, $filterData); |
| 263 | $segment->getDynamicFilters()->add($filterEntity); |
| 264 | $this->entityManager->persist($filterEntity); |
| 265 | } else { |
| 266 | $filterEntity->setFilterData($filterData); |
| 267 | } |
| 268 | } |
| 269 | }; |
| 270 | |
| 271 | $wpActionName = 'mailpoet_dynamic_segments_filters_save'; |
| 272 | if ($this->wp->hasAction($wpActionName)) { |
| 273 | $this->wp->doAction($wpActionName, $createOrUpdateFilter, $filtersData); |
| 274 | } else { |
| 275 | $filterData = reset($filtersData); |
| 276 | $key = key($filtersData); |
| 277 | $createOrUpdateFilter($filterData, $key); |
| 278 | } |
| 279 | |
| 280 | $this->flush(); |
| 281 | return $segment; |
| 282 | } |
| 283 | |
| 284 | public function bulkDelete(array $ids, string $type = SegmentEntity::TYPE_DEFAULT): int { |
| 285 | if (empty($ids)) { |
| 286 | return 0; |
| 287 | } |
| 288 | |
| 289 | // Dynamic segments never materialize memberships in subscriber_segment, so |
| 290 | // deleting them cannot change any subscriber's segments_count. Skip the |
| 291 | // capture (and the recalc below) for them. |
| 292 | $isDynamic = $type === SegmentEntity::TYPE_DYNAMIC; |
| 293 | |
| 294 | // Capture the affected subscribers before the cascade removes their |
| 295 | // memberships, so segments_count can be refreshed for them afterwards. When |
| 296 | // there are too many to recompute inline, skip the (potentially huge) |
| 297 | // capture and let the background sweep reconcile their counts instead. |
| 298 | $deferRecalculation = false; |
| 299 | $affectedSubscriberIds = []; |
| 300 | if (!$isDynamic) { |
| 301 | $deferRecalculation = $this->segmentsCountRecalculator->countSegmentMembers($ids, true, $type) >= $this->segmentsCountRecalculator->getDeferThreshold(); |
| 302 | if (!$deferRecalculation) { |
| 303 | $affectedSubscriberIds = $this->getSubscriberIdsForSegments($ids, $type); |
| 304 | } |
| 305 | } |
| 306 | |
| 307 | $count = 0; |
| 308 | $this->entityManager->transactional(function (EntityManager $entityManager) use ($ids, $type, &$count) { |
| 309 | $subscriberSegmentTable = $entityManager->getClassMetadata(SubscriberSegmentEntity::class)->getTableName(); |
| 310 | $segmentTable = $entityManager->getClassMetadata(SegmentEntity::class)->getTableName(); |
| 311 | $segmentFiltersTable = $entityManager->getClassMetadata(DynamicSegmentFilterEntity::class)->getTableName(); |
| 312 | |
| 313 | $entityManager->getConnection()->executeStatement(" |
| 314 | DELETE ss FROM $subscriberSegmentTable ss |
| 315 | JOIN $segmentTable s ON ss.`segment_id` = s.`id` |
| 316 | WHERE ss.`segment_id` IN (:ids) |
| 317 | AND s.`type` = :type |
| 318 | ", [ |
| 319 | 'ids' => $ids, |
| 320 | 'type' => $type, |
| 321 | ], ['ids' => ArrayParameterType::INTEGER]); |
| 322 | |
| 323 | $entityManager->getConnection()->executeStatement(" |
| 324 | DELETE df FROM $segmentFiltersTable df |
| 325 | WHERE df.`segment_id` IN (:ids) |
| 326 | ", [ |
| 327 | 'ids' => $ids, |
| 328 | ], ['ids' => ArrayParameterType::INTEGER]); |
| 329 | |
| 330 | $queryBuilder = $entityManager->createQueryBuilder(); |
| 331 | $count = $queryBuilder->delete(SegmentEntity::class, 's') |
| 332 | ->where('s.id IN (:ids)') |
| 333 | ->andWhere('s.type = :type') |
| 334 | ->setParameter('ids', $ids, ArrayParameterType::INTEGER) |
| 335 | ->setParameter('type', $type, ParameterType::STRING) |
| 336 | ->getQuery()->execute(); |
| 337 | |
| 338 | $queryBuilder = $entityManager->createQueryBuilder(); |
| 339 | $queryBuilder->delete(NewsletterSegmentEntity::class, 'ns') |
| 340 | ->where('ns.segment IN (:ids)') |
| 341 | ->setParameter('ids', $ids, ArrayParameterType::INTEGER) |
| 342 | ->getQuery()->execute(); |
| 343 | }); |
| 344 | |
| 345 | if (!$isDynamic) { |
| 346 | if ($deferRecalculation) { |
| 347 | $this->segmentsCountRecalculator->scheduleBackgroundRecalculation(); |
| 348 | } else { |
| 349 | $this->segmentsCountRecalculator->recalculateForSubscribers($affectedSubscriberIds); |
| 350 | } |
| 351 | } |
| 352 | |
| 353 | return $count; |
| 354 | } |
| 355 | |
| 356 | /** |
| 357 | * @param int[] $segmentIds |
| 358 | * @return int[] |
| 359 | */ |
| 360 | private function getSubscriberIdsForSegments(array $segmentIds, string $type): array { |
| 361 | if (empty($segmentIds)) { |
| 362 | return []; |
| 363 | } |
| 364 | |
| 365 | $subscriberSegmentTable = $this->entityManager->getClassMetadata(SubscriberSegmentEntity::class)->getTableName(); |
| 366 | $segmentTable = $this->entityManager->getClassMetadata(SegmentEntity::class)->getTableName(); |
| 367 | |
| 368 | $subscribedStatus = SubscriberEntity::STATUS_SUBSCRIBED; |
| 369 | $ids = $this->entityManager->getConnection()->executeQuery(" |
| 370 | SELECT DISTINCT ss.`subscriber_id` FROM $subscriberSegmentTable ss |
| 371 | JOIN $segmentTable s ON ss.`segment_id` = s.`id` |
| 372 | WHERE ss.`segment_id` IN (:ids) |
| 373 | AND s.`type` = :type |
| 374 | AND ss.`status` = :subscribedStatus |
| 375 | ", [ |
| 376 | 'ids' => $segmentIds, |
| 377 | 'type' => $type, |
| 378 | 'subscribedStatus' => $subscribedStatus, |
| 379 | ], ['ids' => ArrayParameterType::INTEGER])->fetchFirstColumn(); |
| 380 | |
| 381 | return array_map(function ($id): int { |
| 382 | return is_numeric($id) ? (int)$id : 0; |
| 383 | }, $ids); |
| 384 | } |
| 385 | |
| 386 | public function bulkTrash(array $ids, string $type = SegmentEntity::TYPE_DEFAULT): int { |
| 387 | $activelyUsedInNewsletters = $this->newsletterSegmentRepository->getSubjectsOfActivelyUsedEmailsForSegments($ids); |
| 388 | $activelyUsedInForms = $this->formsRepository->getNamesOfFormsForSegments(); |
| 389 | $activelyUsed = array_unique(array_merge(array_keys($activelyUsedInNewsletters), array_keys($activelyUsedInForms))); |
| 390 | $ids = array_diff($ids, $activelyUsed); |
| 391 | return $this->updateDeletedAt($ids, new Carbon(), $type); |
| 392 | } |
| 393 | |
| 394 | public function doTrash(array $ids, string $type = SegmentEntity::TYPE_DEFAULT): int { |
| 395 | return $this->updateDeletedAt($ids, new Carbon(), $type); |
| 396 | } |
| 397 | |
| 398 | public function bulkRestore(array $ids, string $type = SegmentEntity::TYPE_DEFAULT): int { |
| 399 | return $this->updateDeletedAt($ids, null, $type); |
| 400 | } |
| 401 | |
| 402 | private function updateDeletedAt(array $ids, ?DateTime $deletedAt, string $type): int { |
| 403 | if (empty($ids)) { |
| 404 | return 0; |
| 405 | } |
| 406 | |
| 407 | $rows = $this->entityManager->createQueryBuilder()->update(SegmentEntity::class, 's') |
| 408 | ->set('s.deletedAt', ':deletedAt') |
| 409 | ->where('s.id IN (:ids)') |
| 410 | ->andWhere('s.type IN (:type)') |
| 411 | ->setParameter('deletedAt', $deletedAt) |
| 412 | ->setParameter('ids', $ids) |
| 413 | ->setParameter('type', $type) |
| 414 | ->getQuery()->execute(); |
| 415 | |
| 416 | // Trashing or restoring a segment changes whether its memberships count |
| 417 | // towards segments_count, so refresh every affected subscriber. The |
| 418 | // memberships still exist here (only deleted_at changed), so walk them in |
| 419 | // keyset-paginated batches instead of materializing every member id at once. |
| 420 | // Dynamic segments have no materialized memberships, so there is nothing to |
| 421 | // recalculate for them. |
| 422 | if ($type !== SegmentEntity::TYPE_DYNAMIC) { |
| 423 | $this->segmentsCountRecalculator->recalculateForSegments($ids); |
| 424 | } |
| 425 | |
| 426 | return $rows; |
| 427 | } |
| 428 | |
| 429 | public function findByUpdatedScoreNotInLastDay(int $limit): array { |
| 430 | $dateTime = (new Carbon())->subDay(); |
| 431 | return $this->entityManager->createQueryBuilder() |
| 432 | ->select('s') |
| 433 | ->from(SegmentEntity::class, 's') |
| 434 | ->where('s.averageEngagementScoreUpdatedAt IS NULL') |
| 435 | ->orWhere('s.averageEngagementScoreUpdatedAt < :dateTime') |
| 436 | ->setParameter('dateTime', $dateTime) |
| 437 | ->getQuery() |
| 438 | ->setMaxResults($limit) |
| 439 | ->getResult(); |
| 440 | } |
| 441 | |
| 442 | /** |
| 443 | * Returns count of segments that have more than one dynamic filter |
| 444 | */ |
| 445 | public function getSegmentCountWithMultipleFilters(): int { |
| 446 | $segmentFiltersTable = $this->entityManager->getClassMetadata(DynamicSegmentFilterEntity::class)->getTableName(); |
| 447 | $qbInner = $this->entityManager->getConnection()->createQueryBuilder() |
| 448 | ->select('COUNT(DISTINCT sf.id) AS segmentCount') |
| 449 | ->from($segmentFiltersTable, 'sf') |
| 450 | ->groupBy('sf.segment_id') |
| 451 | ->having('COUNT(sf.id) > 1'); |
| 452 | /** @var null|int $result */ |
| 453 | $result = $this->entityManager->getConnection()->createQueryBuilder() |
| 454 | ->select('count(*)') |
| 455 | ->from(sprintf('(%s) as subCounts', $qbInner->getSQL())) |
| 456 | ->execute() |
| 457 | ->fetchOne(); |
| 458 | return (int)$result; |
| 459 | } |
| 460 | } |
| 461 |