323 lines
12 KiB
PHP
323 lines
12 KiB
PHP
<?php declare(strict_types = 1);
|
|
|
|
namespace MailPoet\Subscribers;
|
|
|
|
use MailPoet\Entities\SegmentEntity;
|
|
use MailPoet\Entities\SubscriberEntity;
|
|
use MailPoet\Listing\ListingDefinition;
|
|
use MailPoet\Listing\ListingRepository;
|
|
use MailPoet\Segments\DynamicSegments\FilterHandler;
|
|
use MailPoet\Segments\SegmentSubscribersRepository;
|
|
use MailPoet\Util\Helpers;
|
|
use MailPoet\WP\Functions as WPFunctions;
|
|
use MailPoetVendor\Doctrine\DBAL\Driver\Statement;
|
|
use MailPoetVendor\Doctrine\ORM\EntityManager;
|
|
use MailPoetVendor\Doctrine\ORM\Query\Expr\Join;
|
|
use MailPoetVendor\Doctrine\ORM\QueryBuilder;
|
|
|
|
use function MailPoetVendor\array_column;
|
|
|
|
class SubscriberListingRepository extends ListingRepository {
|
|
const DEFAULT_SORT_BY = 'createdAt';
|
|
|
|
private static $supportedStatuses = [
|
|
SubscriberEntity::STATUS_SUBSCRIBED,
|
|
SubscriberEntity::STATUS_UNSUBSCRIBED,
|
|
SubscriberEntity::STATUS_INACTIVE,
|
|
SubscriberEntity::STATUS_BOUNCED,
|
|
SubscriberEntity::STATUS_UNCONFIRMED,
|
|
];
|
|
|
|
/** @var FilterHandler */
|
|
private $dynamicSegmentsFilter;
|
|
|
|
/** @var EntityManager */
|
|
private $entityManager;
|
|
|
|
/** @var SegmentSubscribersRepository */
|
|
private $segmentSubscribersRepository;
|
|
|
|
public function __construct(
|
|
EntityManager $entityManager,
|
|
FilterHandler $dynamicSegmentsFilter,
|
|
SegmentSubscribersRepository $segmentSubscribersRepository
|
|
) {
|
|
parent::__construct($entityManager);
|
|
$this->dynamicSegmentsFilter = $dynamicSegmentsFilter;
|
|
$this->entityManager = $entityManager;
|
|
$this->segmentSubscribersRepository = $segmentSubscribersRepository;
|
|
}
|
|
|
|
protected function applySelectClause(QueryBuilder $queryBuilder) {
|
|
$queryBuilder->select("PARTIAL s.{id,email,firstName,lastName,status,createdAt,countConfirmations,wpUserId,isWoocommerceUser}");
|
|
}
|
|
|
|
protected function applyFromClause(QueryBuilder $queryBuilder) {
|
|
$queryBuilder->from(SubscriberEntity::class, 's');
|
|
}
|
|
|
|
protected function applyGroup(QueryBuilder $queryBuilder, string $group) {
|
|
// include/exclude deleted
|
|
if ($group === 'trash') {
|
|
$queryBuilder->andWhere('s.deletedAt IS NOT NULL');
|
|
} else {
|
|
$queryBuilder->andWhere('s.deletedAt IS NULL');
|
|
}
|
|
|
|
if (!in_array($group, self::$supportedStatuses)) {
|
|
return;
|
|
}
|
|
|
|
$queryBuilder
|
|
->andWhere('s.status = :status')
|
|
->setParameter('status', $group);
|
|
}
|
|
|
|
protected function applySearch(QueryBuilder $queryBuilder, string $search) {
|
|
$search = $this->sanitizeSearch($search);
|
|
$queryBuilder
|
|
->andWhere('s.email LIKE :search or s.firstName LIKE :search or s.lastName LIKE :search')
|
|
->setParameter('search', "%$search%");
|
|
}
|
|
|
|
protected function applyFilters(QueryBuilder $queryBuilder, array $filters) {
|
|
// Filtering for subscribers is handled in self::applyDefinition
|
|
// because other parameters are needed for performance reasons
|
|
}
|
|
|
|
protected function applyListingDefinition(QueryBuilder $queryBuilder, ListingDefinition $definition) {
|
|
$filters = $definition->getFilters();
|
|
if (!$filters || !isset($filters['segment'])) {
|
|
return;
|
|
}
|
|
$segment = $this->entityManager->find(SegmentEntity::class, (int)$filters['segment']);
|
|
if (!$segment instanceof SegmentEntity) {
|
|
return;
|
|
}
|
|
if ($segment->isStatic()) {
|
|
$queryBuilder->join('s.subscriberSegments', 'ss', Join::WITH, 'ss.segment = :ssSegment')
|
|
->setParameter('ssSegment', $segment->getId());
|
|
return;
|
|
}
|
|
$this->applyDynamicSegmentsFilter($queryBuilder, $definition, $segment);
|
|
}
|
|
|
|
protected function applyParameters(QueryBuilder $queryBuilder, array $parameters) {
|
|
// nothing to do here
|
|
}
|
|
|
|
protected function applySorting(QueryBuilder $queryBuilder, string $sortBy, string $sortOrder) {
|
|
if (!$sortBy) {
|
|
$sortBy = self::DEFAULT_SORT_BY;
|
|
}
|
|
$queryBuilder->addOrderBy("s.$sortBy", $sortOrder);
|
|
}
|
|
|
|
public function getGroups(ListingDefinition $definition): array {
|
|
$queryBuilder = clone $this->queryBuilder;
|
|
$this->applyFromClause($queryBuilder);
|
|
|
|
// total count
|
|
$countQueryBuilder = clone $queryBuilder;
|
|
$countQueryBuilder->select('COUNT(s) AS subscribersCount');
|
|
$countQueryBuilder->andWhere('s.deletedAt IS NULL');
|
|
$totalCount = (int)$countQueryBuilder->getQuery()->getSingleScalarResult();
|
|
|
|
// trashed count
|
|
$trashedCountQueryBuilder = clone $queryBuilder;
|
|
$trashedCountQueryBuilder->select('COUNT(s) AS subscribersCount');
|
|
$trashedCountQueryBuilder->andWhere('s.deletedAt IS NOT NULL');
|
|
$trashedCount = (int)$trashedCountQueryBuilder->getQuery()->getSingleScalarResult();
|
|
|
|
// count-by-status query
|
|
$queryBuilder->select('s.status, COUNT(s) AS subscribersCount');
|
|
$queryBuilder->andWhere('s.deletedAt IS NULL');
|
|
$queryBuilder->groupBy('s.status');
|
|
|
|
$map = [];
|
|
foreach ($queryBuilder->getQuery()->getResult() as $item) {
|
|
$map[$item['status']] = (int)$item['subscribersCount'];
|
|
}
|
|
|
|
return [
|
|
[
|
|
'name' => 'all',
|
|
'label' => WPFunctions::get()->__('All', 'mailpoet'),
|
|
'count' => $totalCount,
|
|
],
|
|
[
|
|
'name' => SubscriberEntity::STATUS_SUBSCRIBED,
|
|
'label' => WPFunctions::get()->__('Subscribed', 'mailpoet'),
|
|
'count' => $map[SubscriberEntity::STATUS_SUBSCRIBED] ?? 0,
|
|
],
|
|
[
|
|
'name' => SubscriberEntity::STATUS_UNCONFIRMED,
|
|
'label' => WPFunctions::get()->__('Unconfirmed', 'mailpoet'),
|
|
'count' => $map[SubscriberEntity::STATUS_UNCONFIRMED] ?? 0,
|
|
],
|
|
[
|
|
'name' => SubscriberEntity::STATUS_UNSUBSCRIBED,
|
|
'label' => WPFunctions::get()->__('Unsubscribed', 'mailpoet'),
|
|
'count' => $map[SubscriberEntity::STATUS_UNSUBSCRIBED] ?? 0,
|
|
],
|
|
[
|
|
'name' => SubscriberEntity::STATUS_INACTIVE,
|
|
'label' => WPFunctions::get()->__('Inactive', 'mailpoet'),
|
|
'count' => $map[SubscriberEntity::STATUS_INACTIVE] ?? 0,
|
|
],
|
|
[
|
|
'name' => SubscriberEntity::STATUS_BOUNCED,
|
|
'label' => WPFunctions::get()->__('Bounced', 'mailpoet'),
|
|
'count' => $map[SubscriberEntity::STATUS_BOUNCED] ?? 0,
|
|
],
|
|
[
|
|
'name' => 'trash',
|
|
'label' => WPFunctions::get()->__('Trash', 'mailpoet'),
|
|
'count' => $trashedCount,
|
|
],
|
|
];
|
|
}
|
|
|
|
public function getFilters(ListingDefinition $definition): array {
|
|
$group = $definition->getGroup();
|
|
|
|
$queryBuilder = clone $this->queryBuilder;
|
|
$this->applyFromClause($queryBuilder);
|
|
|
|
if ($group) {
|
|
$this->applyGroup($queryBuilder, $group);
|
|
}
|
|
|
|
$queryBuilderNoSegment = clone $queryBuilder;
|
|
$subscribersWithoutSegment = $queryBuilderNoSegment
|
|
->select('COUNT(s) AS subscribersCount')
|
|
->leftJoin('s.subscriberSegments', 'ssg', Join::WITH, (string)$queryBuilderNoSegment->expr()->eq('ssg.status', ':statusSubscribed'))
|
|
->leftJoin('ssg.segment', 'sg', Join::WITH, (string)$queryBuilderNoSegment->expr()->isNull('sg.deletedAt'))
|
|
->andWhere('s.deletedAt IS NULL')
|
|
->andWhere('sg.id IS NULL')
|
|
->setParameter('statusSubscribed', SubscriberEntity::STATUS_SUBSCRIBED)
|
|
->getQuery()->getSingleScalarResult();
|
|
|
|
$subscribersWithoutSegmentLabel = sprintf(
|
|
WPFunctions::get()->__('Subscribers without a list (%s)', 'mailpoet'),
|
|
number_format((float)$subscribersWithoutSegment)
|
|
);
|
|
|
|
$queryBuilder
|
|
->select('sg.id, sg.name, COUNT(s) AS subscribersCount')
|
|
->leftJoin('s.subscriberSegments', 'ssg')
|
|
->join('ssg.segment', 'sg')
|
|
->groupBy('sg.id')
|
|
->andWhere('sg.deletedAt IS NULL')
|
|
->andWhere('s.deletedAt IS NULL')
|
|
->having('subscribersCount > 0');
|
|
|
|
// format segment list
|
|
$allSubscribersList = [
|
|
'label' => WPFunctions::get()->__('All Lists', 'mailpoet'),
|
|
'value' => '',
|
|
];
|
|
|
|
$withoutSegmentList = [
|
|
'label' => $subscribersWithoutSegmentLabel,
|
|
'value' => 'none',
|
|
];
|
|
|
|
$segmentList = [];
|
|
foreach ($queryBuilder->getQuery()->getResult() as $item) {
|
|
$segmentList[] = [
|
|
'label' => sprintf('%s (%s)', $item['name'], number_format((float)$item['subscribersCount'])),
|
|
'value' => $item['id'],
|
|
];
|
|
}
|
|
|
|
$queryBuilder = clone $this->queryBuilder;
|
|
// Load dynamic segments with some subscribers
|
|
$queryBuilder
|
|
->select('s')
|
|
->from(SegmentEntity::class, 's')
|
|
->andWhere('s.type = :dynamicType')
|
|
->andWhere('s.deletedAt IS NULL')
|
|
->setParameter('dynamicType', SegmentEntity::TYPE_DYNAMIC);
|
|
|
|
foreach ($queryBuilder->getQuery()->getResult() as $segment) {
|
|
$count = $this->segmentSubscribersRepository->getSubscribersCount($segment->getId());
|
|
if (!$count) {
|
|
continue;
|
|
}
|
|
$segmentList[] = [
|
|
'label' => sprintf('%s (%s)', $segment->getName(), number_format((float)$count)),
|
|
'value' => $segment->getId(),
|
|
];
|
|
}
|
|
usort($segmentList, function($a, $b) {
|
|
return strcasecmp($a['label'], $b['label']);
|
|
});
|
|
|
|
array_unshift($segmentList, $allSubscribersList, $withoutSegmentList);
|
|
return ['segment' => $segmentList];
|
|
}
|
|
|
|
private function sanitizeSearch(string $search): string {
|
|
return str_replace(['\\', '%', '_'], ['\\\\', '\\%', '\\_'], trim($search)); // escape for 'LIKE'
|
|
}
|
|
|
|
private function applyDynamicSegmentsFilter(
|
|
QueryBuilder $queryBuilder,
|
|
ListingDefinition $definition,
|
|
SegmentEntity $segment
|
|
) {
|
|
$subscribersTable = $this->entityManager->getClassMetadata(SubscriberEntity::class)->getTableName();
|
|
$subscribersIdsQuery = $this->entityManager
|
|
->getConnection()
|
|
->createQueryBuilder()
|
|
->select("DISTINCT $subscribersTable.id")
|
|
->from($subscribersTable);
|
|
|
|
// Apply dynamic segments filters
|
|
foreach ($segment->getDynamicFilters() as $filter) {
|
|
$subscribersIdsQuery = $this->dynamicSegmentsFilter->apply($subscribersIdsQuery, $filter);
|
|
}
|
|
|
|
// Apply group, search, order and paging to fetch only necessary ids
|
|
// This id done for performance reasons instead of fetching all IDs in dynamic segment
|
|
if ($definition->getSearch()) {
|
|
$search = $this->sanitizeSearch((string)$definition->getSearch());
|
|
$subscribersIdsQuery
|
|
->andWhere("$subscribersTable.email LIKE :search or $subscribersTable.first_name LIKE :search or $subscribersTable.last_name LIKE :search")
|
|
->setParameter('search', "%$search%");
|
|
}
|
|
if ($definition->getGroup()) {
|
|
if ($definition->getGroup() === 'trash') {
|
|
$subscribersIdsQuery->andWhere("$subscribersTable.deleted_at IS NOT NULL");
|
|
} else {
|
|
$subscribersIdsQuery->andWhere("$subscribersTable.deleted_at IS NULL");
|
|
}
|
|
if (in_array($definition->getGroup(), self::$supportedStatuses)) {
|
|
$subscribersIdsQuery
|
|
->andWhere("$subscribersTable.status = :status")
|
|
->setParameter('status', $definition->getGroup());
|
|
}
|
|
}
|
|
$sortBy = $definition->getSortBy() ?: self::DEFAULT_SORT_BY;
|
|
$subscribersIdsQuery->orderBy("$subscribersTable." . Helpers::camelCaseToUnderscore($sortBy), $definition->getSortOrder());
|
|
$subscribersIdsQuery->setFirstResult($definition->getOffset());
|
|
$subscribersIdsQuery->setMaxResults($definition->getLimit());
|
|
|
|
$idsStatement = $subscribersIdsQuery->execute();
|
|
// This shouldn't happen because execute on select SQL always returns Statement, but PHPStan doesn't know that
|
|
if (!$idsStatement instanceof Statement) {
|
|
$queryBuilder->andWhere('0 = 1');
|
|
return;
|
|
}
|
|
$result = $idsStatement->fetchAll();
|
|
$ids = array_column($result, 'id');
|
|
if (count($ids)) {
|
|
$queryBuilder->andWhere('s.id IN (:subscriberIds)')
|
|
->setParameter('subscriberIds', $ids);
|
|
} else {
|
|
$queryBuilder->andWhere('0 = 1'); // Don't return any subscribers if no ids found
|
|
}
|
|
}
|
|
}
|