Spaces:
No application file
No application file
File size: 12,138 Bytes
d2897cd |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 |
<?php
namespace Mautic\LeadBundle\Segment;
use Mautic\LeadBundle\Entity\LeadList;
use Mautic\LeadBundle\Segment\Query\ContactSegmentQueryBuilder;
use Mautic\LeadBundle\Segment\Query\LeadBatchLimiterTrait;
use Mautic\LeadBundle\Segment\Query\QueryBuilder;
class ContactSegmentService
{
use LeadBatchLimiterTrait;
public function __construct(
private ContactSegmentFilterFactory $contactSegmentFilterFactory,
private ContactSegmentQueryBuilder $contactSegmentQueryBuilder,
private \Psr\Log\LoggerInterface $logger
) {
}
/**
* @return array<int,mixed[]>
*
* @throws Exception\SegmentQueryException
* @throws \Doctrine\DBAL\Exception
*/
public function getNewLeadListLeadsCount(LeadList $segment, array $batchLimiters): array
{
$segmentFilters = $this->contactSegmentFilterFactory->getSegmentFilters($segment, $batchLimiters);
if (!count($segmentFilters)) {
$this->logger->debug('Segment QB: Segment has no filters', ['segmentId' => $segment->getId()]);
return [
$segment->getId() => [
'count' => '0',
'maxId' => '0',
],
];
}
$qb = $this->getNewSegmentContactsQuery($segment, $batchLimiters);
$this->addLeadAndMinMaxLimiters($qb, $batchLimiters, 'leads', 'id');
if (!empty($batchLimiters['excludeVisitors'])) {
$this->excludeVisitors($qb);
}
$qb = $this->contactSegmentQueryBuilder->wrapInCount($qb);
$this->logger->debug('Segment QB: Create SQL: '.$qb->getDebugOutput(), ['segmentId' => $segment->getId()]);
$result = $this->timedFetch($qb, $segment->getId());
return [$segment->getId() => $result];
}
/**
* @param array|null $batchLimiters for debug purpose only
*
* @throws \Exception
*/
public function getTotalLeadListLeadsCount(LeadList $segment, array $batchLimiters = null): array
{
$segmentFilters = $this->contactSegmentFilterFactory->getSegmentFilters($segment);
if (!count($segmentFilters)) {
$this->logger->debug('Segment QB: Segment has no filters', ['segmentId' => $segment->getId()]);
return [
$segment->getId() => [
'count' => '0',
'maxId' => '0',
],
];
}
$qb = $this->getTotalSegmentContactsQuery($segment);
if (!empty($batchLimiters['excludeVisitors'])) {
$this->excludeVisitors($qb);
}
$qb = $this->contactSegmentQueryBuilder->wrapInCount($qb);
$this->logger->debug('Segment QB: Create SQL: '.$qb->getDebugOutput(), ['segmentId' => $segment->getId()]);
$result = $this->timedFetch($qb, $segment->getId());
return [$segment->getId() => $result];
}
/**
* @param int $limit
*
* @return array<int,mixed[]>
*
* @throws \Doctrine\DBAL\Exception
* @throws Exception\SegmentQueryException
*/
public function getNewLeadListLeads(LeadList $segment, array $batchLimiters, $limit = 1000): array
{
$queryBuilder = $this->getNewLeadListLeadsQueryBuilder($segment, $batchLimiters);
$queryBuilder->setMaxResults($limit);
$result = $this->timedFetchAll($queryBuilder, $segment->getId());
return [$segment->getId() => $result];
}
/**
* @param mixed[] $batchLimiters
*/
public function getNewLeadListLeadsQueryBuilder(LeadList $segment, array $batchLimiters, bool $addNewContactsRestrictions = true): QueryBuilder
{
$queryBuilder = $this->getNewSegmentContactsQuery($segment, $batchLimiters, $addNewContactsRestrictions);
$leadsTableAlias = $queryBuilder->getTableAlias(MAUTIC_TABLE_PREFIX.'leads');
// Prepend the DISTINCT to the beginning of the select array
$select = $queryBuilder->getQueryPart('select');
// We are removing it because we will have to add it later
// to make sure it's the first column in the query
$key = array_search($leadsTableAlias.'.id', $select);
if (false !== $key) {
unset($select[$key]);
}
// We only need to use distinct if we join other tables to the leads table
$join = $queryBuilder->getQueryPart('join');
$distinct = is_array($join) && (0 < count($join)) ? 'DISTINCT ' : '';
// Make sure that leads.id is the first column
array_unshift($select, $distinct.$leadsTableAlias.'.id');
$queryBuilder->resetQueryPart('select');
$queryBuilder->select($select);
$this->logger->debug('Segment QB: Create Leads SQL: '.$queryBuilder->getDebugOutput(), ['segmentId' => $segment->getId()]);
$this->addLeadAndMinMaxLimiters($queryBuilder, $batchLimiters, 'leads', 'id');
if (!empty($batchLimiters['dateTime'])) {
// Only leads in the list at the time of count
$queryBuilder->andWhere(
$queryBuilder->expr()->or(
$queryBuilder->expr()->lte($leadsTableAlias.'.date_added', $queryBuilder->expr()->literal($batchLimiters['dateTime'])),
$queryBuilder->expr()->isNull($leadsTableAlias.'.date_added')
)
);
}
if (!empty($batchLimiters['excludeVisitors'])) {
$this->excludeVisitors($queryBuilder);
}
return $queryBuilder;
}
/**
* @throws Exception\SegmentQueryException
* @throws \Doctrine\DBAL\Exception
*/
public function getOrphanedLeadListLeadsCount(LeadList $segment, array $batchLimiters = []): array
{
$queryBuilder = $this->getOrphanedLeadListLeadsQueryBuilder($segment, $batchLimiters);
$queryBuilder = $this->contactSegmentQueryBuilder->wrapInCount($queryBuilder);
$this->logger->debug('Segment QB: Orphan Leads Count SQL: '.$queryBuilder->getDebugOutput(), ['segmentId' => $segment->getId()]);
$result = $this->timedFetch($queryBuilder, $segment->getId());
return [$segment->getId() => $result];
}
/**
* @param int|null $limit
*
* @throws Exception\SegmentQueryException
* @throws \Doctrine\DBAL\Exception
*/
public function getOrphanedLeadListLeads(LeadList $segment, array $batchLimiters = [], $limit = null): array
{
$queryBuilder = $this->getOrphanedLeadListLeadsQueryBuilder($segment, $batchLimiters, $limit);
$this->logger->debug('Segment QB: Orphan Leads SQL: '.$queryBuilder->getDebugOutput(), ['segmentId' => $segment->getId()]);
$result = $this->timedFetchAll($queryBuilder, $segment->getId());
return [$segment->getId() => $result];
}
/**
* @param array<string, mixed> $batchLimiters
*
* @throws Exception\SegmentQueryException
* @throws \Exception
*/
private function getNewSegmentContactsQuery(LeadList $segment, array $batchLimiters = [], bool $addNewContactsRestrictions = true): QueryBuilder
{
$queryBuilder = $this->contactSegmentQueryBuilder->assembleContactsSegmentQueryBuilder(
$segment->getId(),
$this->contactSegmentFilterFactory->getSegmentFilters($segment, $batchLimiters)
);
if ($addNewContactsRestrictions) {
$queryBuilder = $this->contactSegmentQueryBuilder->addNewContactsRestrictions($queryBuilder, (int) $segment->getId(), $batchLimiters);
}
$this->contactSegmentQueryBuilder->queryBuilderGenerated($segment, $queryBuilder);
return $queryBuilder;
}
/**
* @throws Exception\SegmentQueryException
* @throws \Exception
*/
private function getTotalSegmentContactsQuery(LeadList $segment): QueryBuilder
{
$segmentFilters = $this->contactSegmentFilterFactory->getSegmentFilters($segment);
$queryBuilder = $this->contactSegmentQueryBuilder->assembleContactsSegmentQueryBuilder($segment->getId(), $segmentFilters);
$queryBuilder = $this->contactSegmentQueryBuilder->addManuallySubscribedQuery($queryBuilder, $segment->getId());
return $this->contactSegmentQueryBuilder->addManuallyUnsubscribedQuery($queryBuilder, $segment->getId());
}
/**
* @param int|null $limit
*
* @return QueryBuilder
*
* @throws Exception\SegmentQueryException
* @throws \Doctrine\DBAL\Exception
*/
public function getOrphanedLeadListLeadsQueryBuilder(LeadList $segment, array $batchLimiters = [], $limit = null)
{
$segmentFilters = $this->contactSegmentFilterFactory->getSegmentFilters($segment, $batchLimiters);
$queryBuilder = $this->contactSegmentQueryBuilder->assembleContactsSegmentQueryBuilder($segment->getId(), $segmentFilters);
$this->addLeadAndMinMaxLimiters($queryBuilder, $batchLimiters, 'leads', 'id');
$this->contactSegmentQueryBuilder->queryBuilderGenerated($segment, $queryBuilder);
$expr = $queryBuilder->expr();
$qbO = $queryBuilder->createQueryBuilder();
$qbO->select('orp.lead_id as id, orp.leadlist_id');
$qbO->from(MAUTIC_TABLE_PREFIX.'lead_lists_leads', 'orp');
$qbO->setParameters($queryBuilder->getParameters(), $queryBuilder->getParameterTypes());
$qbO->andWhere($expr->eq('orp.leadlist_id', ':orpsegid'));
$qbO->andWhere($expr->eq('orp.manually_added', $expr->literal(0)));
$qbO->andWhere($expr->notIn('orp.lead_id', $queryBuilder->getSQL()));
$qbO->setParameter('orpsegid', $segment->getId());
$this->addLeadAndMinMaxLimiters($qbO, $batchLimiters, 'lead_lists_leads');
if ($limit) {
$qbO->setMaxResults((int) $limit);
}
return $qbO;
}
private function excludeVisitors(QueryBuilder $queryBuilder): void
{
$leadsTableAlias = $queryBuilder->getTableAlias(MAUTIC_TABLE_PREFIX.'leads');
$queryBuilder->andWhere($queryBuilder->expr()->isNotNull($leadsTableAlias.'.date_identified'));
}
/***** DEBUG *****/
/**
* Formatting helper.
*
* @return string
*/
private function formatPeriod($inputSeconds)
{
$now = \DateTime::createFromFormat('U.u', number_format($inputSeconds, 6, '.', ''));
return $now->format('H:i:s.u');
}
/**
* @param int $segmentId
*
* @return mixed
*
* @throws \Exception
*/
private function timedFetch(QueryBuilder $qb, $segmentId)
{
try {
$start = microtime(true);
$result = $qb->executeQuery()->fetchAssociative();
$end = microtime(true) - $start;
$this->logger->debug('Segment QB: Query took: '.$this->formatPeriod($end).', Result count: '.count($result), ['segmentId' => $segmentId]);
} catch (\Exception $e) {
$this->logger->error(
'Segment QB: Query Exception: '.$e->getMessage(),
[
'query' => $qb->getSQL(),
'parameters' => $qb->getParameters(),
]
);
throw $e;
}
return $result;
}
/**
* @param int $segmentId
*
* @return mixed
*
* @throws \Exception
*/
private function timedFetchAll(QueryBuilder $qb, $segmentId)
{
try {
$start = microtime(true);
$result = $qb->executeQuery()->fetchAllAssociative();
$end = microtime(true) - $start;
$this->logger->debug(
'Segment QB: Query took: '.$this->formatPeriod($end).'ms. Result count: '.count($result),
['segmentId' => $segmentId]
);
} catch (\Exception $e) {
$this->logger->error(
'Segment QB: Query Exception: '.$e->getMessage(),
[
'query' => $qb->getSQL(),
'parameters' => $qb->getParameters(),
]
);
throw $e;
}
return $result;
}
}
|