-
-
Notifications
You must be signed in to change notification settings - Fork 1
/
sendMailCron.php
1781 lines (1700 loc) · 76.9 KB
/
sendMailCron.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
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* sendMailCron : allow to send token email by cron or sheduled task
* Need activate cron system in the server : php yourlimesurveydir/application/commands/console.php plugin cron --interval=X where X is interval in minutes.
*
* @author Denis Chenu <denis@sondages.pro>
* @copyright 2016-2023 Denis Chenu <https://www.sondages.pro>
* @copyright 2016 AXA Insurance (Gulf) B.S.C. <http://www.axa-gulf.com>
* @copyright 2016-2018 Extract Recherche Marketing <https://dialogs.ca>
* @license AGPL v3
*
* @version 4.4.1
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
class sendMailCron extends PluginBase
{
protected $storage = 'DbStorage';
protected static $description = 'Allow to send token email by cron or sheduled task';
protected static $name = 'sendMailCron';
/** @inheritdoc */
public $allowedPublicMethods = [
'actionSettings'
];
/**
* @var array[] the settings
*/
protected $settings = [
'information' => [
'type' => 'info',
'content' => '<div class="well">'
. '<p>You need activate cron system in the server : <code>php yourlimesurveydir/application/commands/console.php plugin index --target=sendMailCron</code>.</p>'
. '<p>You can check if plugin work like you want with : <code>php yourlimesurveydir/application/commands/console.php plugin index --target=sendMailCron sendMailCronDebug=3 sendMailCronSimulate=1</code>.</p>'
. '</div>',
],
'enableInCron' => [
'type' => 'checkbox',
'value' => 1,
'htmlOption' => [
'uncheckValue' => 0,
],
'label' => 'Enable in cron event.',
'help' => 'Enable sendMailCron in cron event, you can use direct event for sending email.',
'default' => 1,
],
'maxBatchSize' => [
'type' => 'int',
'htmlOptions' => [
'min' => 1,
],
'label' => 'Max email to send globally (max batch size).',
'help' => 'Leave empty to send all available email on each cron. Can be used if you need to limit the number of email sent by day for example.',
'default' => '',
],
'hostInfo' => [
'type' => 'string',
'label' => 'Host info for url',
],
'baseUrl' => [
'type' => 'string',
'label' => 'baseUrl',
],
'scriptUrl' => [
'type' => 'string',
'label' => 'scriptUrl',
],
'maxEmail' => [
'type' => 'int',
'htmlOptions' => [
'min' => 0,
],
'label' => 'Max email to send (invitation + remind), set it to 0 to deactivate sending of email.',
'default' => 2,
],
'delayInvitation' => [
'type' => 'int',
'htmlOptions' => [
'min' => 1,
],
'label' => 'Min delay between invitation and first reminder.',
'default' => 7,
],
'delayReminder' => [
'type' => 'int',
'htmlOptions' => [
'min' => 1,
],
'label' => 'Min delay between each reminders.',
'default' => 7,
],
'validateEmail' => [
'type' => 'checkbox',
'value' => 1,
'htmlOption' => [
'uncheckValue' => 0,
],
'label' => 'Validate email before try to send it.',
'default' => 0,
],
'maxEmailAttribute' => [
'type' => 'int',
'htmlOptions' => [
'min' => 1,
],
'label' => 'Default token attribute to use for max email to send (invitation + remind).',
'help' => 'If this attribute exist (number) : tested just before sending, compare with remindercount+1.',
'default' => '',
],
'delayInvitationAttribute' => [
'type' => 'int',
'htmlOptions' => [
'min' => 1,
],
'label' => 'Default token attribute to use for minimum delay between invitation and first reminder.',
'help' => 'If this attribute exist (number) : tested just before sending, then final delay is minimum between global and this attribute',
'default' => '',
],
'delayReminderAttribute' => [
'type' => 'int',
'htmlOptions' => [
'min' => 1,
],
'label' => 'Default token attribute to use for minimum delay between each reminders.',
'help' => 'If this attribute exist (number) : tested just before sending, then final delay is minimum between global and this attribute',
'default' => '',
],
'cronTypes' => [
'type' => 'text',
'label' => 'Cron moment type.',
'help' => 'One moment by line, use only alphanumeric caracter, you can use <code>,</code> or <code>;</code> as separator.',
'default' => '',
],
'cronTypeNone' => [
'type' => 'checkbox',
'value' => 1,
'htmlOption' => [
'uncheckValue' => 0,
],
'label' => 'Survey without moment use empty moment or moment not set only.',
'help' => "If a survey don't have type: you can choose if it sended for each cron or only if no moment is set",
'default' => 1,
],
];
/**
* @var int debug (for echoing on terminal) 0=>ERROR, 1=>WARNING+BASICINFORMATION, 2=>INFO, 3=>DEBUG/TRACE
*/
private $debug = 1;
/**
* @var bool simulate sending (for log)
*/
private $simulate = false;
/**
* @var bool disable plugin (via command line)
*/
private $disable = false;
/**
* @var string actual cron type
*/
private $cronType;
/**
* @var int currentBatchSize Count for this batch
*/
private $currentBatchSize = 0;
/**
* @var int SurveyBatchSize Count for this batch of actual survey
*/
private $currentSurveyBatchSize;
/**
* @var null|string final attributes to be used (for this survey)
*/
private $surveyMaxEmailAttributes;
private $surveyDelayInvitationAttribute;
private $surveyDelayReminderAttribute;
/**
* Add function to be used in cron event.
*
* @see parent::init()
*/
public function init()
{
// Action on cron
$this->subscribe('cron', 'sendMailByCron');
// Action on direct
$this->subscribe('direct', 'sendMailByCli');
// Needed config
$this->subscribe('beforeActivate');
// Add the link in menu
$this->subscribe('beforeToolsMenuRender');
// The survey seeting
$this->subscribe('beforeSurveySettings');
// Update Yii config
$this->subscribe('afterPluginLoad');
}
/**
* set actual url when activate.
*
* @see parent::saveSettings()
*
* @param mixed $settings
*/
public function saveSettings($settings)
{
if (!Permission::model()->hasGlobalPermission('settings', 'update')) {
throw new CHttpException(403);
}
if (isset($settings['cronTypes'])) {
$cronTypes = preg_split('/\r\n|\r|\n|,|;/', $settings['cronTypes']);
$cronTypes = array_map(
function ($cronType) {
return preg_replace('/[^0-9a-zA-Z]/i', '', $cronType);
},
$cronTypes
);
$cronTypes = array_filter($cronTypes);
$settings['cronTypes'] = implode('|', $cronTypes);
}
parent::saveSettings($settings);
}
/**
* set actual url when activate.
*
* @see parent::beforeActivate()
*/
public function beforeActivate()
{
if (!$this->getEvent()) {
throw new CHttpException(403);
}
$event = $this->getEvent();
if (is_null($this->getSetting('hostInfo'))) {
if (Yii::app() instanceof CConsoleApplication) {
$event->set('success', false);
$event->set('message', 'This plugin need to be configurated before activate.');
return;
}
$settings = [
'hostInfo' => Yii::app()->request->getHostInfo(),
'baseUrl' => Yii::app()->request->getBaseUrl(),
'scriptUrl' => Yii::app()->request->getScriptUrl(),
];
$this->saveSettings($settings);
$event->set('message', 'Default configuration for url is used.');
App()->setFlashMessage('Default configuration for url is used.');
}
}
/**
* @see parent::beforeSurveySettings()
*/
public function beforeSurveySettings()
{
if (!$this->getEvent()) {
throw new CHttpException(403);
}
$event = $this->event;
// Must control if token table exist
$iSurveyId = $event->get('survey');
if ($this->surveyHasTokens($iSurveyId)) {
$event->set("surveysettings.{$this->id}", [
'name' => get_class($this),
'settings' => [
'gotosettings' => [
'type' => 'link',
'label' => $this->translate('Mail by cron settings'),
'htmlOptions' => [
'title' => $this->translate('This open another page'),
],
'help' => $this->translate('This open a new page remind to save your settings.'),
'text' => $this->translate('Edit email by cron settings'),
'class' => 'btn btn-link',
'link' => Yii::app()->createUrl(
'admin/pluginhelper',
[
'sa' => 'sidebody',
'plugin' => get_class($this),
'method' => 'actionSettings',
'surveyId' => $iSurveyId,
]
),
],
],
]);
}
}
/**
* The action in direct event.
*/
public function sendMailByCli()
{
if (!Yii::app() instanceof CConsoleApplication) {
throw new CHttpException(403);
}
if ($this->event->get('target') != get_class()) {
return;
}
$this->fixLsCommand();
if (intval(Yii::app()->getConfig('versionnumber') < 4)) {
$this->setConfigsApi3();
}
$this->setArgs();
// @todo replace by option (in json array ?)
$this->sendTokenMessages();
}
/**
* The action in cron event.
*/
public function sendMailByCron()
{
if (!Yii::app() instanceof CConsoleApplication) {
throw new CHttpException(403);
}
if ($this->get('enableInCron', null, null, 1)) {
$this->fixLsCommand();
if (intval(Yii::app()->getConfig('versionnumber') < 4)) {
$this->setConfigsApi3();
}
$this->setArgs();
if (!$this->disable) {
$this->sendTokenMessages();
}
}
}
/**
* @see parent:getPluginSettings
*
* @param mixed $getValues
*/
public function getPluginSettings($getValues = true)
{
if (!Permission::model()->hasGlobalPermission('settings', 'read')) {
throw new CHttpException(403);
}
if (!Yii::app() instanceof CConsoleApplication) {
$this->settings['hostInfo']['default'] = Yii::app()->request->getHostInfo();
$this->settings['baseUrl']['default'] = Yii::app()->request->getBaseUrl();
}
$pluginSettings = parent::getPluginSettings($getValues);
if (intval(Yii::app()->getConfig('versionnumber') >= 4)) {
unset($pluginSettings['scriptUrl']);
$pluginSettings['baseUrl']['help'] = 'Only dirname are used, script url are automatically checked with showScriptName setting for urlManager in your config.php file';
}
if ($getValues) {
if ($pluginSettings['cronTypes']) {
$pluginSettings['cronTypes']['current'] = implode("\n", explode('|', $pluginSettings['cronTypes']['current']));
}
}
return $pluginSettings;
}
/** Menu and settings part */
/**
* see beforeToolsMenuRender event.
*/
public function beforeToolsMenuRender()
{
$event = $this->getEvent();
$surveyId = $event->get('surveyId');
$aMenuItem = [
'label' => $this->translate('Mail cron'),
'iconClass' => 'fa fa-envelope-square',
'href' => Yii::app()->createUrl(
'admin/pluginhelper',
[
'sa' => 'sidebody',
'plugin' => get_class($this),
'method' => 'actionSettings',
'surveyId' => $surveyId,
]
),
];
if (class_exists('\\LimeSurvey\\Menu\\MenuItem')) {
$menuItem = new \LimeSurvey\Menu\MenuItem($aMenuItem);
} else {
$menuItem = new \ls\menu\MenuItem($aMenuItem);
}
$event->append('menuItems', [$menuItem]);
}
/**
* Main function.
*
* @param int $surveyId Survey id
*
* @return string
*/
public function actionSettings($surveyId)
{
$oSurvey = Survey::model()->findByPk($surveyId);
if (!$oSurvey) {
throw new CHttpException(404, $this->translate('This survey does not seem to exist.'));
}
if (!Permission::model()->hasSurveyPermission($surveyId, 'surveysettings', 'update')) {
throw new CHttpException(403);
}
if (App()->getRequest()->getPost('save' . get_class($this))) {
$this->set('maxEmail', App()->getRequest()->getPost('maxEmail'), 'Survey', $surveyId);
$this->set('delayInvitation', App()->getRequest()->getPost('delayInvitation'), 'Survey', $surveyId);
$this->set('delayReminder', App()->getRequest()->getPost('delayReminder'), 'Survey', $surveyId);
$this->set('maxSurveyBatchSize', App()->getRequest()->getPost('maxSurveyBatchSize'), 'Survey', $surveyId);
$this->set('maxSurveyBatchSize_invite', App()->getRequest()->getPost('maxSurveyBatchSize_invite'), 'Survey', $surveyId);
$this->set('maxSurveyBatchSize_remind', App()->getRequest()->getPost('maxSurveyBatchSize_remind'), 'Survey', $surveyId);
$this->set('dayOfWeekToSend', App()->getRequest()->getPost('dayOfWeekToSend'), 'Survey', $surveyId);
$this->set('cronTypes', App()->getRequest()->getPost('cronTypes'), 'Survey', $surveyId);
$this->set('maxEmailAttribute', App()->getRequest()->getPost('maxEmailAttribute'), 'Survey', $surveyId);
$this->set('delayInvitationAttribute', App()->getRequest()->getPost('delayInvitationAttribute'), 'Survey', $surveyId);
$this->set('delayReminderAttribute', App()->getRequest()->getPost('delayReminderAttribute'), 'Survey', $surveyId);
if ('redirect' == App()->getRequest()->getPost('save' . get_class($this))) {
if (floatval(App()->getConfig('versionnumber')) < 4) {
App()->getController()->redirect(
App()->getController()->createUrl(
'admin/survey',
['sa' => 'view', 'surveyid' => $surveyId]
)
);
}
App()->getController()->redirect(
App()->getController()->createUrl(
'surveyAdministration/view',
['surveyid' => $surveyId]
)
);
}
}
// get the default settings
$defaultMaxEmail = $this->get('maxEmail', null, null, $this->settings['maxEmail']['default']);
if (!$defaultMaxEmail) {
$defaultMaxEmail = $this->translate('disabled');
}
$defaultDelayInvitation = $this->get('delayInvitation', null, null, $this->settings['delayInvitation']['default']);
$defaultDelayReminder = $this->get('delayReminder', null, null, $this->settings['delayReminder']['default']);
$defaultDelayInvitationAttribute = $this->get('delayInvitationAttribute', null, null, $this->settings['delayInvitationAttribute']['default']);
$defaultDelayReminderAttribute = $this->get('delayReminderAttribute', null, null, $this->settings['delayReminderAttribute']['default']);
$maxBatchSize = $this->get('maxBatchSize', null, null, $this->settings['maxBatchSize']['default']);
if (!$maxBatchSize) {
$maxBatchHelp = $this->translate('Leave empty to send all available emails.');
} else {
$maxBatchHelp = sprintf($this->translate('Leave empty to send all available emails,only limited by global batch size (%s) for all surveys.'), $maxBatchSize);
}
$aData = [];
// An alert if survey don't have token
$aData['warningString'] = !$this->surveyHasTokens($surveyId) ? $this->translate("This survey didn't have token currently, this settings are not used until participant are not activated.") : null;
$aSettings = [];
$aSettings[$this->translate('Basic settings')] = [
'maxEmail' => [
'type' => 'int',
'htmlOptions' => [
'min' => 0,
'placeholder' => $defaultMaxEmail,
],
'label' => $this->translate('Max email to send (invitation + remind) to each participant.'),
'help' => sprintf($this->translate('0 to deactivate sending of email, empty to use default (%s)'), $defaultMaxEmail),
'current' => $this->get('maxEmail', 'Survey', $surveyId, ''),
],
'delayInvitation' => [
'type' => 'int',
'htmlOptions' => [
'min' => 1,
'placeholder' => $defaultDelayInvitation,
],
'label' => $this->translate('Min delay between invitation and first reminder.'),
'help' => sprintf($this->translate('In days, empty for default (%s)'), $defaultDelayInvitation),
'current' => $this->get('delayInvitation', 'Survey', $surveyId, ''),
],
'delayReminder' => [
'type' => 'int',
'htmlOptions' => [
'min' => 1,
'placeholder' => $defaultDelayReminder,
],
'label' => $this->translate('Min delay between reminders.'),
'help' => sprintf($this->translate('In days, empty for default (%s)'), $defaultDelayReminder),
'current' => $this->get('delayReminder', 'Survey', $surveyId, ''),
],
];
$aSettings[$this->translate('Batch size')] = [
'maxSurveyBatchSize' => [
'type' => 'int',
'htmlOptions' => [
'min' => 1,
],
'label' => $this->translate('Max email to send (invitation + remind) in one batch for this survey.'),
'help' => $maxBatchHelp,
'current' => $this->get('maxSurveyBatchSize', 'Survey', $surveyId, ''),
],
'maxSurveyBatchSize_invite' => [
'type' => 'int',
'htmlOptions' => [
'min' => 0,
],
'label' => $this->translate('Max email to send for invitation in one batch for this survey.'),
'help' => $this->translate('The max email setting can not be exceeded.'),
'current' => $this->get('maxSurveyBatchSize_invite', 'Survey', $surveyId, ''),
],
'maxSurveyBatchSize_remind' => [
'type' => 'int',
'htmlOptions' => [
'min' => 0,
],
'label' => $this->translate('Max email to send for reminder in one batch for this survey.'),
'help' => $this->translate('The max email setting can not be exceeded. Reminders are sent after invitation.'),
'current' => $this->get('maxSurveyBatchSize_remind', 'Survey', $surveyId, ''),
],
];
$whenSettings = [
'dayOfWeekToSend' => [
'type' => 'select',
'htmlOptions' => [
'multiple' => 'multiple',
'empty' => $this->translate('All week days'),
],
'selectOptions' => [
'placeholder' => $this->translate('All week days'),
'allowClear' => true,
'width' => '100%',
],
'controlOptions' => [
'class' => 'search-100',
],
'label' => $this->translate('Day of week for sending email'),
'options' => [
1 => $this->translate('Monday'),
2 => $this->translate('Tuesday'),
3 => $this->translate('Wednesday'),
4 => $this->translate('Thursday'),
5 => $this->translate('Friday'),
6 => $this->translate('Saturday'),
7 => $this->translate('Sunday'),
],
'current' => $this->get('dayOfWeekToSend', 'Survey', $surveyId, []),
],
];
if ($this->get('cronTypes', null, null)) {
$availCronTypes = $this->get('cronTypes', null, null, $this->settings['cronTypes']['default']);
$availCronTypes = explode('|', $availCronTypes);
$cronTypesOtions = [];
foreach ($availCronTypes as $cronType) {
$cronTypesOtions[$cronType] = $cronType;
}
if (!empty($cronTypesOtions)) {
$emptyLabel = $this->get('cronTypeNone', null, null, $this->settings['cronTypeNone']['default']) ? $this->translate('Only if no moment is set') : $this->translate('At all moment');
$whenSettings['cronTypes'] = [
'type' => 'select',
'htmlOptions' => [
'multiple' => 'multiple',
'empty' => $emptyLabel,
],
'selectOptions' => [
'placeholder' => $emptyLabel,
'allowClear' => true,
'width' => '100%',
],
'controlOptions' => [
'class' => 'search-100',
],
'label' => $this->translate('Moment for emailing'),
'options' => $cronTypesOtions,
'current' => $this->get('cronTypes', 'Survey', $surveyId, []),
];
}
}
$aSettings[$this->translate('When email must be sent')] = $whenSettings;
// Get available attributes for options
$aAvailableAttribute = $this->getAttributesList($surveyId);
$aAvailableAttribute['none'] = $this->translate('None');
$defaultMax = $this->translate('None');
if (!empty($this->get('maxEmailAttribute'))) {
if (array_key_exists('attribute_' . $this->get('maxEmailAttribute'), $aAvailableAttribute)) {
$defaultMax = $aAvailableAttribute['attribute_' . $this->get('maxEmailAttribute')];
} else {
$defaultMax = sprintf($this->translate('None - %s'), 'attribute_' . $this->get('maxEmailAttribute'));
}
}
$defaultInvitation = $this->translate('None');
if (!empty($this->get('delayInvitationAttribute'))) {
if (array_key_exists('attribute_' . $this->get('delayInvitationAttribute'), $aAvailableAttribute)) {
$defaultInvitation = $aAvailableAttribute['attribute_' . $this->get('delayInvitationAttribute')];
} else {
$defaultInvitation = sprintf($this->translate('None - %s'), 'attribute_' . $this->get('delayInvitationAttribute'));
}
}
$defaultReminder = $this->translate('None');
if (!empty($this->get('delayReminderAttribute'))) {
if (array_key_exists('attribute_' . $this->get('delayReminderAttribute'), $aAvailableAttribute)) {
$defaultReminder = $aAvailableAttribute['attribute_' . $this->get('delayReminderAttribute')];
} else {
$defaultReminder = sprintf($this->translate('None - %s'), 'attribute_' . $this->get('delayReminderAttribute'));
}
}
$tokenAttributeSettings = [
'maxEmailAttribute' => [
'type' => 'select',
'htmlOptions' => [
'empty' => sprintf($this->translate('Leave default (%s)'), $defaultMax),
],
'label' => $this->translate('Attribute used for maximum number of emails.'),
'options' => $aAvailableAttribute,
'current' => $this->get('maxEmailAttribute', 'Survey', $surveyId, null),
],
'delayInvitationAttribute' => [
'type' => 'select',
'htmlOptions' => [
'empty' => sprintf($this->translate('Leave default (%s)'), $defaultInvitation),
],
'label' => $this->translate('Attribute used for min delay between inviation and 1st reminder.'),
'options' => $aAvailableAttribute,
'current' => $this->get('delayInvitationAttribute', 'Survey', $surveyId, null),
],
'delayReminderAttribute' => [
'type' => 'select',
'htmlOptions' => [
'empty' => sprintf($this->translate('Leave default (%s)'), $defaultReminder),
],
'label' => $this->translate('Attribute used for min delay between each reminders.'),
'options' => $aAvailableAttribute,
'current' => $this->get('delayReminderAttribute', 'Survey', $surveyId, null),
],
];
$aSettings[$this->translate('Token attribute usage')] = $tokenAttributeSettings;
$aData['pluginClass'] = get_class($this);
$aData['surveyId'] = $surveyId;
$aData['title'] = $this->translate('Send email by cron settings');
$aData['aSettings'] = $aSettings;
$aData['assetUrl'] = Yii::app()->assetManager->publish(dirname(__FILE__) . '/assets/');
return $this->renderPartial('settings', $aData, true);
}
/**
* Add this translation just after loaded all plugins.
*
* @see event afterPluginLoad
*/
public function afterPluginLoad()
{
// messageSource for this plugin:
$messageSource = [
'class' => 'CGettextMessageSource',
'cacheID' => get_class($this) . 'Lang',
'cachingDuration' => 3600,
'forceTranslation' => true,
'useMoFile' => true,
'basePath' => __DIR__ . DIRECTORY_SEPARATOR . 'locale',
'catalog' => 'messages', // default from Yii
];
Yii::app()->setComponent(get_class($this), $messageSource);
}
/**
* The action of sending token emails for all survey.
*/
private function sendTokenMessages()
{
$maxBatchSize = $this->getSetting('maxBatchSize', null, null, '');
$oSurveys = Survey::model()->findAll(array(
'select' => array('sid', 'active', 'startdate', 'expires'),
'condition' => "active = 'Y' AND (startdate <= :now1 OR startdate IS NULL) AND (expires >= :now2 OR expires IS NULL)",
'params' => array(
':now1' => self::dateShifted(date('Y-m-d H:i:s')),
':now2' => self::dateShifted(date('Y-m-d H:i:s')),
)
));
// Unsure we need whole ... to be fixed
Yii::import('application.helpers.common_helper', true);
Yii::import('application.helpers.surveytranslator_helper', true);
Yii::import('application.helpers.replacements_helper', true);
Yii::import('application.helpers.expressions.em_manager_helper', true);
// Fix the url @todo parse url and validate
App()->request->hostInfo = $this->getSetting('hostInfo');
// Issue with url manager and script … @todo : fix LimeSurvey core
$baseUrl = trim($this->getSetting('baseUrl'));
if (Yii::app()->getUrlManager()->showScriptName) {
$baseUrl = $baseUrl . '/index.php';
}
Yii::app()->getUrlManager()->setBaseUrl($baseUrl);
if ($oSurveys) {
foreach ($oSurveys as $oSurvey) {
$iSurvey = $oSurvey->sid;
if ($this->surveyHasTokens($iSurvey)) {
// By maxEmail
$maxEmail = $this->getSetting('maxEmail', 'survey', $iSurvey, '');
if ('' === $maxEmail) {
$maxEmail = $this->getSetting('maxEmail', null, null, $this->settings['maxEmail']['default']);
}
if ($maxEmail < 1) {
$this->sendMailCronLog("sendMailByCron for {$iSurvey} deactivated", 2, 'survey');
continue;
}
// By day of week
$aDayOfWeekToSend = [];
$dayOfWeekToSend = $this->getSetting('dayOfWeekToSend', 'Survey', $iSurvey);
if (!empty($dayOfWeekToSend) && !empty(json_decode($dayOfWeekToSend))) {
$aDayOfWeekToSend = array_filter(json_decode($dayOfWeekToSend));
}
$todayNum = (string) self::dateShifted(date('Y-m-d H:i:s'), 'N');
if (!empty($aDayOfWeekToSend) && !in_array($todayNum, $aDayOfWeekToSend)) {
$this->sendMailCronLog("sendMailByCron deactivated for {$iSurvey} for today", 2, 'survey');
continue;
}
// By cron type
$availCronTypes = $this->getSetting('cronTypes', null, null, '');
$availCronTypes = explode('|', $availCronTypes);
if (!empty($availCronTypes)) {
$surveyCronTypes = $this->getSetting('cronTypes', 'Survey', $iSurvey, '');
if (!empty($surveyCronTypes) && !empty(json_decode($surveyCronTypes))) {
$surveyCronTypes = json_decode($surveyCronTypes);
} else {
$surveyCronTypes = [];
if (!$this->getSetting('cronTypeNone', null, null, $this->settings['cronTypeNone']['default']) && $this->cronType) {
$surveyCronTypes = [$this->cronType];
} else {
$surveyCronTypes = [];
}
}
$surveyCronTypes = array_intersect($surveyCronTypes, $availCronTypes);
if ($this->cronType) {
if (!in_array($this->cronType, $surveyCronTypes)) {
$this->sendMailCronLog("sendMailByCron deactivated for {$iSurvey} for this cron type ({$this->cronType})", 2, 'survey');
continue;
}
} else {
if (!empty($surveyCronTypes)) {
$this->sendMailCronLog("sendMailByCron deactivated for {$iSurvey} for no cron type", 2, 'survey');
continue;
}
}
}
$this->sendMailCronLog("Start sendMailByCron for {$iSurvey}", 1, 'survey');
if ($maxBatchSize && $maxBatchSize <= $this->currentBatchSize) {
$this->sendMailCronLog("sendMailByCron deactivated for {$iSurvey} due to batch size", 1, 'survey');
continue;
}
Yii::app()->setConfig('surveyID', $iSurvey);
// Fill some information for this
$this->currentSurveyBatchSize = 0;
$this->setAttributeValue($iSurvey);
$this->sendEmails($iSurvey, 'invite');
if ($maxEmail < 2) {
$this->sendMailCronLog("sendMailByCron reminder for {$iSurvey} deactivated", 2);
} elseif (!$maxBatchSize || $maxBatchSize >= $this->currentBatchSize) {
if (
!$this->getSetting('maxSurveyBatchSize', 'Survey', $iSurvey)
|| $this->getSetting('maxSurveyBatchSize', 'Survey', $iSurvey) >= $this->currentBatchSize
) {
$this->sendEmails($iSurvey, 'remind');
} else {
$this->sendMailCronLog("sendMailByCron reminder deactivated for {$iSurvey} due to survey batch size", 1, 'survey');
}
} else {
$this->sendMailCronLog("sendMailByCron reminder deactivated for {$iSurvey} due to batch size", 1, 'survey');
}
$event = new PluginEvent('finishSendEmailForSurveyCron');
$event->set('survey_id', $iSurvey);
App()->getPluginManager()->dispatchEvent($event);
}
}
}
}
/**
* Return the date fixed by config (SQL format).
*
* @param string $date in SQL format
* @param string $dformat in token opr SQL format
*
* @return string
*/
private static function dateShifted($date, $dformat = 'Y-m-d H:i')
{
if (empty(Yii::app()->getConfig('timeadjust'))) {
return date($dformat, strtotime($date));
}
return date($dformat, strtotime(Yii::app()->getConfig('timeadjust'), strtotime($date)));
}
/**
* Set whole LimeSurvey config (not needed in new LS version).
*/
private function setConfigsApi3()
{
$aDefaultConfigs = require Yii::app()->basePath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'config-defaults.php';
foreach ($aDefaultConfigs as $sConfig => $defaultConfig) {
Yii::app()->setConfig($sConfig, $defaultConfig);
}
// ~ $ls_config = require(Yii::app()->basePath. DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'config-defaults.php');
// ~ $this->config = array_merge($this->config, $ls_config);
// Fix rootdir .....
if (!is_dir(Yii::app()->getConfig('usertemplaterootdir'))) {
$sRootDir = realpath(Yii::app()->basePath . DIRECTORY_SEPARATOR . '..');
Yii::app()->setConfig('rootdir', $sRootDir);
Yii::app()->setConfig('publicdir', $sRootDir);
Yii::app()->setConfig('homedir', $sRootDir);
Yii::app()->setConfig('tempdir', $sRootDir . DIRECTORY_SEPARATOR . 'tmp');
Yii::app()->setConfig('imagedir', $sRootDir . DIRECTORY_SEPARATOR . 'images');
Yii::app()->setConfig('uploaddir', $sRootDir . DIRECTORY_SEPARATOR . 'upload');
Yii::app()->setConfig('standardtemplaterootdir', $sRootDir . DIRECTORY_SEPARATOR . 'templates');
Yii::app()->setConfig('usertemplaterootdir', $sRootDir . DIRECTORY_SEPARATOR . 'upload' . DIRECTORY_SEPARATOR . 'templates');
Yii::app()->setConfig('styledir', $sRootDir . DIRECTORY_SEPARATOR . 'styledir');
}
if (file_exists(Yii::app()->basePath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'config.php')) {
$config = require Yii::app()->basePath . DIRECTORY_SEPARATOR . 'config' . DIRECTORY_SEPARATOR . 'config.php';
if (is_array($config['config']) && !empty($config['config'])) {
foreach ($config['config'] as $key => $value) {
Yii::app()->setConfig($key, $value);
}
}
}
$oSettings = SettingGlobal::model()->findAll();
if (count($oSettings) > 0) {
foreach ($oSettings as $oSetting) {
Yii::app()->setConfig($oSetting->getAttribute('stg_name'), $oSetting->getAttribute('stg_value'));
}
}
}
/**
* Dispatch event after email sent and final log.
*
* @param int[] $aCountMail array for email count
* @param int $iSurvey
* @param string $sType
*/
private function afterSendEmail($aCountMail, $iSurvey, $sType)
{
$event = new PluginEvent('finishSendEmailsForSurveyTypeCron');
$event->set('info', $aCountMail);
$event->set('type', $sType);
$event->set('survey_id', $iSurvey);
App()->getPluginManager()->dispatchEvent($event);
$this->sendMailCronFinalLog($aCountMail);
}
/**
* Send emails for a survey and a type.
*
* @param int $iSurvey
* @param string $sType
*/
private function sendEmails($iSurvey, $sType = 'invite')
{
if (intval(Yii::app()->getConfig('versionnumber') < 4)) {
return $this->sendEmailsApi3($iSurvey, $sType);
}
$aCountMail = [
'total' => 0,
'sent' => 0,
'invalid' => 0,
'error' => 0,
'started' => 0,
'notstarted' => 0,
'attributedisabled' => 0,
];
App()->setConfig('emailsmtpdebug', 0);
$oSurvey = Survey::model()->findByPk($iSurvey);
$aSurveyLangs = $oSurvey->getAllLanguages();
foreach ($aSurveyLangs as $sSurveyLanguage) {
$aSurveys[$sSurveyLanguage] = getSurveyInfo($iSurvey, $sSurveyLanguage);
}
$baseCriteria = $this->getSendCriteria($iSurvey, $sType);
if (empty($baseCriteria)) {
return;
}
$aCountMail['total'] = Token::model($iSurvey)->count($baseCriteria);;
$controlResponse = null;
$isNotAnonymous = 'Y' != $oSurvey->anonymized;
$reminderOnlyTo = $this->getSetting('reminderOnlyTo', 'Survey', $iSurvey, '');
if ($reminderOnlyTo && $isNotAnonymous) {
$controlResponse = $reminderOnlyTo;
}
$this->sendMailCronLog("Start sending {$sType}", 2, 'survey');
$mail = \LimeMailer::getInstance(\LimeMailer::ResetComplete);
$mail->setSurvey($iSurvey);
$mail->emailType = $sType;
$mail->replaceTokenAttributes = true;
$mail->addUrlsPlaceholders(['OPTOUT', 'OPTIN', 'SURVEY']);
$oCriteria = clone $baseCriteria;
$oToken = Token::model($iSurvey)->find($oCriteria);
while (!empty($oToken)) {
$oToken = $oToken->decrypt();
// Test actual sended
if ($this->stopSendMailAction($aCountMail, $iSurvey, $sType)) {
$this->afterSendEmail($aCountMail, $iSurvey, $sType);
return;
}
// Find if need to already started or not
if ($controlResponse) {
$oResponse = SurveyDynamic::model($iSurvey)->find('token=:token', [':token' => $oToken->token]);
if (!$oResponse && 'notstarted' == $controlResponse) {
$this->sendMailCronLog("Not started survey : {$oToken->email} ({$oToken->tid}) for {$iSurvey}", 3, 'token');
++$aCountMail['notstarted'];
continue;
}
if ($oResponse && 'started' == $controlResponse) {
$this->sendMailCronLog("Already started survey : {$oToken->email} ({$oToken->tid}) for {$iSurvey}", 3, 'token');
++$aCountMail['started'];
continue;
}
}
if (
$this->getSetting('validateEmail', null, null, $this->settings['validateEmail']['default'])
&& !filter_var(trim($oToken->email), FILTER_VALIDATE_EMAIL)
) {
$this->sendMailCronLog("invalid email : '{$oToken->email}' ({$oToken->tid}) for {$iSurvey}", 2, 'token');
++$aCountMail['invalid'];
$oCommand = Yii::app()->db->createCommand();
$oCommand->update(
"{{tokens_{$iSurvey}}}",
[
'emailstatus' => 'invalid',
],
'tid=:tid',
[
':tid' => $oToken->tid,
]
);
$oCriteria = clone $baseCriteria;
$oCriteria->compare('tid', ">{$oToken->tid}");
$oToken = Token::model($iSurvey)->find($oCriteria);
continue;
}
$mail = \LimeMailer::getInstance();
$mail->setToken($oToken->token);
$mail->setTypeWithRaw($sType);
if ($this->simulate) {
$this->sendMailCronLog("Simulate send : {$oToken->email} ({$oToken->tid}) for {$iSurvey}", 3, 'token');
$success = true;
} else {
$this->sendMailCronLog("Send : {$oToken->email} ({$oToken->tid}) for {$iSurvey}", 3, 'token');
$success = $mail->sendMessage();
}
// action if email is sent
if ($success) {
++$aCountMail['sent'];
++$this->currentBatchSize;
++$this->currentSurveyBatchSize;
if ('invite' == $sType) {
if (!$this->simulate) {
Token::model($iSurvey)->updateByPk(
$oToken->tid,
[
'sent' => self::dateShifted(date('Y-m-d H:i:s')),
]
);
}
$oToken->sent = self::dateShifted(date('Y-m-d H:i:s'));
$txtLog = 'sent set to ' . $oToken->sent;
}
if ('remind' == $sType) {
$oToken->remindersent = self::dateShifted(date('Y-m-d H:i:s'));
++$oToken->remindercount;
if (!$this->simulate) {
$oToken->save(false, [
'remindersent',
'remindercount'
]);
}
$txtLog = "remindersent set to {$oToken->remindersent} count: {$oToken->remindercount}";
}