/
Interval.php
403 lines (344 loc) · 14.1 KB
/
Interval.php
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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
<?php
/*
* @copyright 2017 Mautic Contributors. All rights reserved
* @author Mautic, Inc.
*
* @link https://mautic.org
*
* @license GNU/GPLv3 http://www.gnu.org/licenses/gpl-3.0.html
*/
namespace Mautic\CampaignBundle\Executioner\Scheduler\Mode;
use Doctrine\Common\Collections\ArrayCollection;
use Mautic\CampaignBundle\Entity\Event;
use Mautic\CampaignBundle\Entity\LeadEventLog;
use Mautic\CampaignBundle\Executioner\Scheduler\Exception\NotSchedulableException;
use Mautic\CampaignBundle\Executioner\Scheduler\Mode\DAO\GroupExecutionDateDAO;
use Mautic\CoreBundle\Helper\CoreParametersHelper;
use Mautic\CoreBundle\Helper\DateTimeHelper;
use Mautic\LeadBundle\Entity\Lead;
use Psr\Log\LoggerInterface;
class Interval implements ScheduleModeInterface
{
/**
* @var LoggerInterface
*/
private $logger;
/**
* @var CoreParametersHelper
*/
private $coreParametersHelper;
/**
* @var \DateTimeZone
*/
private $defaultTimezone;
/**
* Interval constructor.
*
* @param LoggerInterface $logger
* @param CoreParametersHelper $coreParametersHelper
*/
public function __construct(LoggerInterface $logger, CoreParametersHelper $coreParametersHelper)
{
$this->logger = $logger;
$this->coreParametersHelper = $coreParametersHelper;
}
/**
* @param Event $event
* @param \DateTime $compareFromDateTime
* @param \DateTime $comparedToDateTime
*
* @return \DateTime
*
* @throws NotSchedulableException
*/
public function getExecutionDateTime(Event $event, \DateTime $compareFromDateTime, \DateTime $comparedToDateTime)
{
$interval = $event->getTriggerInterval();
$unit = $event->getTriggerIntervalUnit();
try {
$this->logger->debug(
'CAMPAIGN: ('.$event->getId().') Adding interval of '.$interval.$unit.' to '.$comparedToDateTime->format('Y-m-d H:i:s T')
);
$comparedToDateTime->add((new DateTimeHelper())->buildInterval($interval, $unit));
} catch (\Exception $exception) {
$this->logger->error('CAMPAIGN: Determining interval scheduled failed with "'.$exception->getMessage().'"');
throw new NotSchedulableException();
}
if ($comparedToDateTime > $compareFromDateTime) {
$this->logger->debug(
'CAMPAIGN: ('.$event->getId().') '.$comparedToDateTime->format('Y-m-d H:i:s T').' is later than '
.$compareFromDateTime->format('Y-m-d H:i:s T').' and thus returning '.$comparedToDateTime->format('Y-m-d H:i:s T')
);
//the event is to be scheduled based on the time interval
return $comparedToDateTime;
}
$this->logger->debug(
'CAMPAIGN: ('.$event->getId().') '.$comparedToDateTime->format('Y-m-d H:i:s T').' is earlier than '
.$compareFromDateTime->format('Y-m-d H:i:s T').' and thus returning '.$compareFromDateTime->format('Y-m-d H:i:s T')
);
return $compareFromDateTime;
}
/**
* @param LeadEventLog $log
* @param \DateTime $compareFromDateTime
*
* @return \DateTime
*
* @throws NotSchedulableException
*/
public function validateExecutionDateTime(LeadEventLog $log, \DateTime $compareFromDateTime)
{
$event = $log->getEvent();
$dateTriggered = clone $log->getDateTriggered();
if (!$this->isContactSpecificExecutionDateRequired($event)) {
return $this->getExecutionDateTime($event, $compareFromDateTime, $dateTriggered);
}
$hour = $event->getTriggerHour();
$startTime = $event->getTriggerRestrictedStartHour();
$endTime = $event->getTriggerRestrictedStopHour();
$dow = $event->getTriggerRestrictedDaysOfWeek();
$diff = $dateTriggered->diff($compareFromDateTime);
return $this->getGroupExecutionDateTime($event->getId(), $log->getLead(), $diff, $dateTriggered, $hour, $startTime, $endTime, $dow);
}
/**
* @param Event $event
* @param ArrayCollection $contacts
* @param \DateTime $executionDate
* @param null|\DateTime $compareFromDateTime
*
* @return GroupExecutionDateDAO[]
*/
public function groupContactsByDate(Event $event, ArrayCollection $contacts, \DateTime $executionDate, \DateTime $compareFromDateTime = null)
{
$groupedExecutionDates = [];
$hour = $event->getTriggerHour();
$startTime = $event->getTriggerRestrictedStartHour();
$endTime = $event->getTriggerRestrictedStopHour();
$daysOfWeek = $event->getTriggerRestrictedDaysOfWeek();
// Get the difference between now and the date we're supposed to be executing
$compareFromDateTime = $compareFromDateTime ? clone $compareFromDateTime : new \DateTime('now');
$diff = $compareFromDateTime->diff($executionDate);
$diff->f = 0; // we don't care about microseconds
/** @var Lead $contact */
foreach ($contacts as $contact) {
$groupExecutionDate = $this->getGroupExecutionDateTime(
$event->getId(),
$contact,
$diff,
$compareFromDateTime,
$hour,
$startTime,
$endTime,
$daysOfWeek
);
if (!isset($groupedExecutionDates[$groupExecutionDate->getTimestamp()])) {
$groupedExecutionDates[$groupExecutionDate->getTimestamp()] = new GroupExecutionDateDAO($groupExecutionDate);
}
$groupedExecutionDates[$groupExecutionDate->getTimestamp()]->addContact($contact);
}
return $groupedExecutionDates;
}
/**
* Checks if an event has a relative time configured.
*
* @param Event $event
*
* @return bool
*/
public function isContactSpecificExecutionDateRequired(Event $event)
{
if (Event::TRIGGER_MODE_INTERVAL !== $event->getTriggerMode()) {
return false;
}
if (
null === $event->getTriggerHour() &&
(null === $event->getTriggerRestrictedStartHour() || null === $event->getTriggerRestrictedStopHour()) &&
empty($event->getTriggerRestrictedDaysOfWeek())
) {
return false;
}
return true;
}
/**
* @param $eventId
* @param Lead $contact
* @param \DateInterval $diff
* @param \DateTime $compareFromDateTime
* @param \DateTime|null $hour
* @param \DateTime|null $startTime
* @param \DateTime|null $endTime
* @param array $daysOfWeek
*
* @return \DateTime
*/
private function getGroupExecutionDateTime(
$eventId,
Lead $contact,
\DateInterval $diff,
\DateTime $compareFromDateTime,
\DateTime $hour = null,
\DateTime $startTime = null,
\DateTime $endTime = null,
array $daysOfWeek = []
) {
$this->logger->debug(
sprintf('CAMPAIGN: Comparing calculated executed time for event ID %s and contact ID %s with %s', $eventId, $contact->getId(), $compareFromDateTime->format('Y-m-d H:i:s e'))
);
if ($hour) {
$this->logger->debug(
sprintf('CAMPAIGN: Scheduling event ID %s for contact ID %s based on hour of %s', $eventId, $contact->getId(), $hour->format('H:i e'))
);
$groupDateTime = $this->getExecutionDateTimeFromHour($contact, $hour, $diff, $eventId, $compareFromDateTime);
} elseif ($startTime && $endTime) {
$this->logger->debug(
sprintf(
'CAMPAIGN: Scheduling event ID %s for contact ID %s based on hour range of %s to %s',
$eventId,
$contact->getId(),
$startTime->format('H:i e'),
$endTime->format('H:i e')
)
);
$groupDateTime = $this->getExecutionDateTimeBetweenHours($contact, $startTime, $endTime, $diff, $eventId, $compareFromDateTime);
} else {
$this->logger->debug(
sprintf('CAMPAIGN: Scheduling event ID %s for contact ID %s without hour restrictions.', $eventId, $contact->getId())
);
$groupDateTime = clone $compareFromDateTime;
$groupDateTime->add($diff);
}
if ($daysOfWeek) {
$this->logger->debug(
sprintf(
'CAMPAIGN: Scheduling event ID %s for contact ID %s based on DOW restrictions of %s',
$eventId,
$contact->getId(),
implode(',', $daysOfWeek)
)
);
// Schedule for the next day of the week if applicable
while (!in_array((int) $groupDateTime->format('w'), $daysOfWeek)) {
$groupDateTime->modify('+1 day');
}
}
return $groupDateTime;
}
/**
* @param Lead $contact
* @param \DateTime $hour
* @param \DateInterval $diff
* @param $eventId
* @param \DateTime $compareFromDateTime
*
* @return \DateTime
*/
private function getExecutionDateTimeFromHour(Lead $contact, \DateTime $hour, \DateInterval $diff, $eventId, \DateTime $compareFromDateTime)
{
$groupHour = clone $hour;
// Set execution to UTC
if ($timezone = $contact->getTimezone()) {
try {
// Set the group's timezone to the contact's
$contactTimezone = new \DateTimeZone($timezone);
$this->logger->debug(
'CAMPAIGN: ('.$eventId.') Setting '.$timezone.' for contact '.$contact->getId()
);
// Get now in the contacts timezone then add the number of days from now and the original execution date
$groupExecutionDate = clone $compareFromDateTime;
$groupExecutionDate->setTimezone($contactTimezone);
$groupExecutionDate->add($diff);
$groupExecutionDate->setTime($groupHour->format('H'), $groupHour->format('i'));
return $groupExecutionDate;
} catch (\Exception $exception) {
// Timezone is not recognized so use the default
$this->logger->debug(
'CAMPAIGN: ('.$eventId.') '.$timezone.' for contact '.$contact->getId().' is not recognized'
);
}
}
$groupExecutionDate = clone $compareFromDateTime;
$groupExecutionDate->setTimezone($this->getDefaultTimezone());
$groupExecutionDate->add($diff);
$groupExecutionDate->setTime($groupHour->format('H'), $groupHour->format('i'));
return $groupExecutionDate;
}
/**
* @param Lead $contact
* @param \DateTime $startTime
* @param \DateTime $endTime
* @param \DateInterval $diff
* @param $eventId
* @param \DateTime $compareFromDateTime
*
* @return \DateTime
*/
private function getExecutionDateTimeBetweenHours(
Lead $contact,
\DateTime $startTime,
\DateTime $endTime,
\DateInterval $diff,
$eventId,
\DateTime $compareFromDateTime
) {
$startTime = clone $startTime;
$endTime = clone $endTime;
if ($endTime < $startTime) {
// End time is after start time so switch them
$tempStartTime = clone $startTime;
$startTime = clone $endTime;
$endTime = clone $tempStartTime;
unset($tempStartTime);
}
// Set execution to UTC
if ($timezone = $contact->getTimezone()) {
try {
// Set the group's timezone to the contact's
$contactTimezone = new \DateTimeZone($timezone);
$this->logger->debug(
'CAMPAIGN: ('.$eventId.') Setting '.$timezone.' for contact '.$contact->getId()
);
// Get now in the contacts timezone then add the number of days from now and the original execution date
$groupExecutionDate = clone $compareFromDateTime;
$groupExecutionDate->setTimezone($contactTimezone);
$groupExecutionDate->add($diff);
} catch (\Exception $exception) {
// Timezone is not recognized so use the default
$this->logger->debug(
'CAMPAIGN: ('.$eventId.') '.$timezone.' for contact '.$contact->getId().' is not recognized'
);
}
}
if (!isset($groupExecutionDate)) {
$groupExecutionDate = clone $compareFromDateTime;
$groupExecutionDate->setTimezone($this->getDefaultTimezone());
$groupExecutionDate->add($diff);
}
// Is the time between the start and end hours?
$testStartDateTime = clone $groupExecutionDate;
$testStartDateTime->setTime($startTime->format('H'), $startTime->format('i'));
$testStopDateTime = clone $groupExecutionDate;
$testStopDateTime->setTime($endTime->format('H'), $endTime->format('i'));
if ($groupExecutionDate < $testStartDateTime) {
// Too early so set it to the start date
return $testStartDateTime;
}
if ($groupExecutionDate > $testStopDateTime) {
// Too late so try again tomorrow
$groupExecutionDate->modify('+1 day')->setTime($startTime->format('H'), $startTime->format('i'));
}
return $groupExecutionDate;
}
/**
* @return \DateTimeZone
*/
private function getDefaultTimezone()
{
if ($this->defaultTimezone) {
return $this->defaultTimezone;
}
$this->defaultTimezone = new \DateTimeZone(
$this->coreParametersHelper->getParameter('default_timezone', 'UTC')
);
return $this->defaultTimezone;
}
}