3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2017
34 require_once 'Mail.php';
37 * Class CRM_Mailing_BAO_MailingJob
39 class CRM_Mailing_BAO_MailingJob
extends CRM_Mailing_DAO_MailingJob
{
40 const MAX_CONTACTS_TO_PROCESS
= 1000;
43 * (Dear God Why) Keep a global count of mails processed within the current
48 static $mailsProcessed = 0;
53 public function __construct() {
54 parent
::__construct();
60 * @param array $params
62 * @return \CRM_Mailing_BAO_MailingJob
63 * @throws \CRM_Core_Exception
65 static public function create($params) {
66 $job = new CRM_Mailing_BAO_MailingJob();
67 $job->mailing_id
= $params['mailing_id'];
68 $job->status
= $params['status'];
69 $job->scheduled_date
= $params['scheduled_date'];
70 $job->is_test
= $params['is_test'];
72 $mailing = new CRM_Mailing_BAO_Mailing();
73 $mailing->id
= $params['mailing_id'];
74 if ($mailing->id
&& $mailing->find(TRUE)) {
75 $mailing->getRecipients($job->id
, $params['mailing_id'], TRUE, $mailing->dedupe_email
);
79 throw new CRM_Core_Exception("Failed to create job: Unknown mailing ID");
84 * Initiate all pending/ready jobs.
86 * @param array $testParams
91 public static function runJobs($testParams = NULL, $mode = NULL) {
92 $job = new CRM_Mailing_BAO_MailingJob();
94 $config = CRM_Core_Config
::singleton();
95 $jobTable = CRM_Mailing_DAO_MailingJob
::getTableName();
96 $mailingTable = CRM_Mailing_DAO_Mailing
::getTableName();
97 $mailerBatchLimit = Civi
::settings()->get('mailerBatchLimit');
99 if (!empty($testParams)) {
103 WHERE id = {$testParams['job_id']}";
107 $currentTime = date('YmdHis');
108 $mailingACL = CRM_Mailing_BAO_Mailing
::mailingACL('m');
109 $domainID = CRM_Core_Config
::domainID();
111 $modeClause = 'AND m.sms_provider_id IS NULL';
112 if ($mode == 'sms') {
113 $modeClause = 'AND m.sms_provider_id IS NOT NULL';
116 // Select the first child job that is scheduled
122 WHERE m.id = j.mailing_id AND m.domain_id = {$domainID}
125 AND ( ( j.start_date IS null
126 AND j.scheduled_date <= $currentTime
127 AND j.status = 'Scheduled' )
128 OR ( j.status = 'Running'
129 AND j.end_date IS null ) )
130 AND (j.job_type = 'child')
132 ORDER BY j.scheduled_date ASC,
139 while ($job->fetch()) {
140 // still use job level lock for each child job
141 $lock = Civi
::lockManager()->acquire("data.mailing.job.{$job->id}");
142 if (!$lock->isAcquired()) {
146 // for test jobs we do not change anything, since its on a short-circuit path
147 if (empty($testParams)) {
148 // we've got the lock, but while we were waiting and processing
149 // other emails, this job might have changed under us
150 // lets get the job status again and check
151 $job->status
= CRM_Core_DAO
::getFieldValue(
152 'CRM_Mailing_DAO_MailingJob',
160 $job->status
!= 'Running' &&
161 $job->status
!= 'Scheduled'
163 // this includes Cancelled and other statuses, CRM-4246
169 /* Queue up recipients for the child job being launched */
171 if ($job->status
!= 'Running') {
172 $transaction = new CRM_Core_Transaction();
174 // have to queue it up based on the offset and limits
175 // get the parent ID, and limit and offset
176 $job->queue($testParams);
178 // Mark up the starting time
179 $saveJob = new CRM_Mailing_DAO_MailingJob();
180 $saveJob->id
= $job->id
;
181 $saveJob->start_date
= date('YmdHis');
182 $saveJob->status
= 'Running';
185 $transaction->commit();
189 if ($mode === NULL) {
190 $mailer = \Civi
::service('pear_mail');
192 elseif ($mode == 'sms') {
193 $mailer = CRM_SMS_Provider
::singleton(array('mailing_id' => $job->mailing_id
));
196 // Compose and deliver each child job
197 if (\CRM_Utils_Constant
::value('CIVICRM_FLEXMAILER_HACK_DELIVER')) {
198 $isComplete = Civi\Core\Resolver
::singleton()->call(CIVICRM_FLEXMAILER_HACK_DELIVER
, array($job, $mailer, $testParams));
201 $isComplete = $job->deliver($mailer, $testParams);
204 CRM_Utils_Hook
::post('create', 'CRM_Mailing_DAO_Spool', $job->id
, $isComplete);
206 // Mark the child complete
210 $transaction = new CRM_Core_Transaction();
212 $saveJob = new CRM_Mailing_DAO_MailingJob();
213 $saveJob->id
= $job->id
;
214 $saveJob->end_date
= date('YmdHis');
215 $saveJob->status
= 'Complete';
218 $transaction->commit();
220 // don't mark the mailing as complete
223 // Release the child joblock
230 // CRM-17629: Stop processing jobs if mailer batch limit reached
231 if ($mailerBatchLimit > 0 && self
::$mailsProcessed >= $mailerBatchLimit) {
239 * Post process to determine if the parent job
240 * as well as the mailing is complete after the run.
243 public static function runJobs_post($mode = NULL) {
245 $job = new CRM_Mailing_BAO_MailingJob();
247 $mailing = new CRM_Mailing_BAO_Mailing();
249 $config = CRM_Core_Config
::singleton();
250 $jobTable = CRM_Mailing_DAO_MailingJob
::getTableName();
251 $mailingTable = CRM_Mailing_DAO_Mailing
::getTableName();
253 $currentTime = date('YmdHis');
254 $mailingACL = CRM_Mailing_BAO_Mailing
::mailingACL('m');
255 $domainID = CRM_Core_Config
::domainID();
261 WHERE m.id = j.mailing_id AND m.domain_id = {$domainID}
263 AND j.scheduled_date <= $currentTime
264 AND j.status = 'Running'
265 AND j.end_date IS null
266 AND (j.job_type != 'child' OR j.job_type is NULL)
267 ORDER BY j.scheduled_date,
272 // For each parent job that is running, let's look at their child jobs
273 while ($job->fetch()) {
275 $child_job = new CRM_Mailing_BAO_MailingJob();
279 FROM civicrm_mailing_job j, civicrm_mailing m
280 WHERE m.id = j.mailing_id
281 AND j.job_type = 'child'
283 AND j.status <> 'Complete'";
284 $params = array(1 => array($job->id
, 'Integer'));
286 $anyChildLeft = CRM_Core_DAO
::singleValueQuery($child_job_sql, $params);
288 // all of the child jobs are complete, update
289 // the parent job as well as the mailing status
290 if (!$anyChildLeft) {
292 $transaction = new CRM_Core_Transaction();
294 $saveJob = new CRM_Mailing_DAO_MailingJob();
295 $saveJob->id
= $job->id
;
296 $saveJob->end_date
= date('YmdHis');
297 $saveJob->status
= 'Complete';
301 $mailing->id
= $job->mailing_id
;
302 $mailing->is_completed
= TRUE;
304 $transaction->commit();
307 CRM_Utils_Hook
::postMailing($job->mailing_id
);
314 * before we run jobs, we need to split the jobs
318 public static function runJobs_pre($offset = 200, $mode = NULL) {
319 $job = new CRM_Mailing_BAO_MailingJob();
321 $jobTable = CRM_Mailing_DAO_MailingJob
::getTableName();
322 $mailingTable = CRM_Mailing_DAO_Mailing
::getTableName();
324 $currentTime = date('YmdHis');
325 $mailingACL = CRM_Mailing_BAO_Mailing
::mailingACL('m');
327 $workflowClause = CRM_Mailing_BAO_MailingJob
::workflowClause();
329 $domainID = CRM_Core_Config
::domainID();
331 $modeClause = 'AND m.sms_provider_id IS NULL';
332 if ($mode == 'sms') {
333 $modeClause = 'AND m.sms_provider_id IS NOT NULL';
336 // Select all the mailing jobs that are created from
337 // when the mailing is submitted or scheduled.
342 WHERE m.id = j.mailing_id AND m.domain_id = {$domainID}
346 AND ( ( j.start_date IS null
347 AND j.scheduled_date <= $currentTime
348 AND j.status = 'Scheduled'
349 AND j.end_date IS null ) )
350 AND ((j.job_type is NULL) OR (j.job_type <> 'child'))
351 ORDER BY j.scheduled_date,
356 // For each of the "Parent Jobs" we find, we split them into
357 // X Number of child jobs
358 while ($job->fetch()) {
359 // still use job level lock for each child job
360 $lock = Civi
::lockManager()->acquire("data.mailing.job.{$job->id}");
361 if (!$lock->isAcquired()) {
365 // Re-fetch the job status in case things
366 // changed between the first query and now
367 // to avoid race conditions
368 $job->status
= CRM_Core_DAO
::getFieldValue(
369 'CRM_Mailing_DAO_MailingJob',
375 if ($job->status
!= 'Scheduled') {
380 $job->split_job($offset);
382 // update the status of the parent job
383 $transaction = new CRM_Core_Transaction();
385 $saveJob = new CRM_Mailing_DAO_MailingJob();
386 $saveJob->id
= $job->id
;
387 $saveJob->start_date
= date('YmdHis');
388 $saveJob->status
= 'Running';
391 $transaction->commit();
393 // Release the job lock
399 * Split the parent job into n number of child job based on an offset.
400 * If null or 0 , we create only one child job
403 public function split_job($offset = 200) {
404 $recipient_count = CRM_Mailing_BAO_Recipients
::mailingSize($this->mailing_id
);
406 $jobTable = CRM_Mailing_DAO_MailingJob
::getTableName();
408 $dao = new CRM_Core_DAO();
411 INSERT INTO civicrm_mailing_job
412 (`mailing_id`, `scheduled_date`, `status`, `job_type`, `parent_id`, `job_offset`, `job_limit`)
413 VALUES (%1, %2, %3, %4, %5, %6, %7)
416 1 => array($this->mailing_id
, 'Integer'),
417 2 => array($this->scheduled_date
, 'String'),
418 3 => array('Scheduled', 'String'),
419 4 => array('child', 'String'),
420 5 => array($this->id
, 'Integer'),
421 6 => array(0, 'Integer'),
422 7 => array($recipient_count, 'Integer'),
425 // create one child job if the mailing size is less than the offset
426 // probably use a CRM_Mailing_DAO_MailingJob( );
427 if (empty($offset) ||
428 $recipient_count <= $offset
430 CRM_Core_DAO
::executeQuery($sql, $params);
433 // Creating 'child jobs'
434 $scheduled_unixtime = strtotime($this->scheduled_date
);
435 for ($i = 0, $s = 0; $i < $recipient_count; $i = $i +
$offset, $s++
) {
436 $params[2][0] = date('Y-m-d H:i:s', $scheduled_unixtime +
$s);
438 $params[7][0] = $offset;
439 CRM_Core_DAO
::executeQuery($sql, $params);
445 * @param array $testParams
447 public function queue($testParams = NULL) {
448 $mailing = new CRM_Mailing_BAO_Mailing();
449 $mailing->id
= $this->mailing_id
;
450 if (!empty($testParams)) {
451 $mailing->getTestRecipients($testParams);
454 // We are still getting all the recipients from the parent job
455 // so we don't mess with the include/exclude logic.
456 $recipients = CRM_Mailing_BAO_Recipients
::mailingQuery($this->mailing_id
, $this->job_offset
, $this->job_limit
);
458 // FIXME: this is not very smart, we should move this to one DB call
459 // INSERT INTO ... SELECT FROM ..
460 // the thing we need to figure out is how to generate the hash automatically
464 while ($recipients->fetch()) {
465 // CRM-18543: there are situations when both the email and phone are null.
466 // Skip the recipient in this case.
467 if (empty($recipients->email_id
) && empty($recipients->phone_id
)) {
471 if ($recipients->phone_id
) {
472 $recipients->email_id
= "null";
475 $recipients->phone_id
= "null";
480 $recipients->email_id
,
481 $recipients->contact_id
,
482 $recipients->phone_id
,
485 if ($count % CRM_Mailing_Config
::BULK_MAIL_INSERT_COUNT
== 0) {
486 CRM_Mailing_Event_BAO_Queue
::bulkCreate($params, $now);
492 if (!empty($params)) {
493 CRM_Mailing_Event_BAO_Queue
::bulkCreate($params, $now);
502 * This is used by CiviMail but will be made redundant by FlexMailer.
503 * @param object $mailer
504 * A Mail object to send the messages.
506 * @param array $testParams
509 public function deliver(&$mailer, $testParams = NULL) {
510 if (\Civi
::settings()->get('experimentalFlexMailerEngine')) {
511 throw new \
RuntimeException("Cannot use legacy deliver() when experimentalFlexMailerEngine is enabled");
514 $mailing = new CRM_Mailing_BAO_Mailing();
515 $mailing->id
= $this->mailing_id
;
516 $mailing->find(TRUE);
521 if ($config == NULL) {
522 $config = CRM_Core_Config
::singleton();
525 if (property_exists($mailing, 'language') && $mailing->language
&& $mailing->language
!= 'en_US') {
526 $swapLang = CRM_Utils_AutoClean
::swap('global://dbLocale?getter', 'call://i18n/setLocale', $mailing->language
);
529 $job_date = CRM_Utils_Date
::isoToMysql($this->scheduled_date
);
532 if (!empty($testParams)) {
533 $mailing->subject
= ts('[CiviMail Draft]') . ' ' . $mailing->subject
;
536 CRM_Mailing_BAO_Mailing
::tokenReplace($mailing);
538 // get and format attachments
539 $attachments = CRM_Core_BAO_File
::getEntityFile('civicrm_mailing', $mailing->id
);
541 if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY
) {
542 CRM_Core_Smarty
::registerStringResource();
546 // This handles the edge case scenario where all the mails
547 // have been delivered in prior jobs.
550 // make sure that there's no more than $mailerBatchLimit mails processed in a run
551 $mailerBatchLimit = Civi
::settings()->get('mailerBatchLimit');
552 $eq = self
::findPendingTasks($this->id
, $mailing->sms_provider_id ?
'sms' : 'email');
553 while ($eq->fetch()) {
554 if ($mailerBatchLimit > 0 && self
::$mailsProcessed >= $mailerBatchLimit) {
555 if (!empty($fields)) {
556 $this->deliverGroup($fields, $mailing, $mailer, $job_date, $attachments);
561 self
::$mailsProcessed++
;
566 'contact_id' => $eq->contact_id
,
567 'email' => $eq->email
,
568 'phone' => $eq->phone
,
570 if (count($fields) == self
::MAX_CONTACTS_TO_PROCESS
) {
571 $isDelivered = $this->deliverGroup($fields, $mailing, $mailer, $job_date, $attachments);
582 if (!empty($fields)) {
583 $isDelivered = $this->deliverGroup($fields, $mailing, $mailer, $job_date, $attachments);
590 * This is used by CiviMail but will be made redundant by FlexMailer.
591 * @param array $fields
592 * List of intended recipients.
593 * Each recipient is an array with keys 'hash', 'contact_id', 'email', etc.
597 * @param $attachments
602 public function deliverGroup(&$fields, &$mailing, &$mailer, &$job_date, &$attachments) {
603 static $smtpConnectionErrors = 0;
605 if (!is_object($mailer) ||
empty($fields)) {
606 CRM_Core_Error
::fatal();
609 // get the return properties
610 $returnProperties = $mailing->getReturnProperties();
611 $params = $targetParams = $deliveredParams = array();
614 // CRM-15702: Sending bulk sms to contacts without e-mail address fails.
615 // Solution is to skip checking for on hold
616 $skipOnHold = TRUE; //do include a statement to check wether e-mail address is on hold
617 if ($mailing->sms_provider_id
) {
618 $skipOnHold = FALSE; //do not include a statement to check wether e-mail address is on hold
621 foreach ($fields as $key => $field) {
622 $params[] = $field['contact_id'];
625 $details = CRM_Utils_Token
::getTokenDetails(
628 $skipOnHold, TRUE, NULL,
629 $mailing->getFlattenedTokens(),
634 $config = CRM_Core_Config
::singleton();
635 foreach ($fields as $key => $field) {
636 $contactID = $field['contact_id'];
637 if (!array_key_exists($contactID, $details[0])) {
638 $details[0][$contactID] = array();
641 // Compose the mailing.
642 $recipient = $replyToEmail = NULL;
643 $replyValue = strcmp($mailing->replyto_email
, $mailing->from_email
);
645 $replyToEmail = $mailing->replyto_email
;
648 $message = $mailing->compose(
649 $this->id
, $field['id'], $field['hash'],
650 $field['contact_id'], $field['email'],
651 $recipient, FALSE, $details[0][$contactID], $attachments,
652 FALSE, NULL, $replyToEmail
654 if (empty($message)) {
655 // lets keep the message in the queue
656 // most likely a permissions related issue with smarty templates
657 // or a bad contact id? CRM-9833
663 $body = &$message->get();
664 $headers = &$message->headers();
666 if ($mailing->sms_provider_id
) {
667 $provider = CRM_SMS_Provider
::singleton(array('mailing_id' => $mailing->id
));
668 $body = $provider->getMessage($message, $field['contact_id'], $details[0][$contactID]);
669 $headers = $provider->getRecipientDetails($field, $details[0][$contactID]);
672 // make $recipient actually be the *encoded* header, so as not to baffle Mail_RFC822, CRM-5743
673 $recipient = $headers['To'];
676 // disable error reporting on real mailings (but leave error reporting for tests), CRM-5744
678 $errorScope = CRM_Core_TemporaryErrorScope
::ignoreException();
681 $result = $mailer->send($recipient, $headers, $body, $this->id
);
687 if (is_a($result, 'PEAR_Error') && !$mailing->sms_provider_id
) {
689 $message = $result->getMessage();
691 strpos($message, 'Failed to write to socket') !== FALSE ||
692 strpos($message, 'Failed to set sender') !== FALSE
694 // lets log this message and code
695 $code = $result->getCode();
696 CRM_Core_Error
::debug_log_message("SMTP Socket Error or failed to set sender error. Message: $message, Code: $code");
698 // these are socket write errors which most likely means smtp connection errors
700 $smtpConnectionErrors++
;
701 if ($smtpConnectionErrors <= 5) {
705 // seems like we have too many of them in a row, we should
706 // write stuff to disk and abort the cron job
714 CRM_Core_Error
::debug_log_message("Too many SMTP Socket Errors. Exiting");
715 CRM_Utils_System
::civiExit();
718 // Register the bounce event.
721 'event_queue_id' => $field['id'],
722 'job_id' => $this->id
,
723 'hash' => $field['hash'],
725 $params = array_merge($params,
726 CRM_Mailing_BAO_BouncePattern
::match($result->getMessage())
728 CRM_Mailing_Event_BAO_Bounce
::create($params);
730 elseif (is_a($result, 'PEAR_Error') && $mailing->sms_provider_id
) {
731 // Handle SMS errors: CRM-15426
732 $job_id = intval($this->id
);
733 $mailing_id = intval($mailing->id
);
734 CRM_Core_Error
::debug_log_message("Failed to send SMS message. Vars: mailing_id: ${mailing_id}, job_id: ${job_id}. Error message follows.");
735 CRM_Core_Error
::debug_log_message($result->getMessage());
738 // Register the delivery event.
739 $deliveredParams[] = $field['id'];
740 $targetParams[] = $field['contact_id'];
743 if ($count % CRM_Mailing_Config
::BULK_MAIL_INSERT_COUNT
== 0) {
752 // hack to stop mailing job at run time, CRM-4246.
753 // to avoid making too many DB calls for this rare case
754 // lets do it when we snapshot
755 $status = CRM_Core_DAO
::getFieldValue(
756 'CRM_Mailing_DAO_MailingJob',
763 if ($status != 'Running') {
771 // seems like a successful delivery or bounce, lets decrement error count
772 // only if we have smtp connection errors
773 if ($smtpConnectionErrors > 0) {
774 $smtpConnectionErrors--;
777 // If we have enabled the Throttle option, this is the time to enforce it.
778 $mailThrottleTime = Civi
::settings()->get('mailThrottleTime');
779 if (!empty($mailThrottleTime)) {
780 usleep((int ) $mailThrottleTime);
784 $result = $this->writeToDB(
797 * @param int $mailingId
798 * The id of the mailing to be canceled.
800 public static function cancel($mailingId) {
803 FROM civicrm_mailing_job
804 WHERE mailing_id = %1
806 AND ( ( job_type IS NULL ) OR
807 job_type <> 'child' )
809 $params = array(1 => array($mailingId, 'Integer'));
810 $job = CRM_Core_DAO
::executeQuery($sql, $params);
812 in_array($job->status
, array('Scheduled', 'Running', 'Paused'))
815 $newJob = new CRM_Mailing_BAO_MailingJob();
816 $newJob->id
= $job->id
;
817 $newJob->end_date
= date('YmdHis');
818 $newJob->status
= 'Canceled';
821 // also cancel all child jobs
823 UPDATE civicrm_mailing_job
824 SET status = 'Canceled',
828 AND job_type = 'child'
829 AND status IN ( 'Scheduled', 'Running', 'Paused' )
832 1 => array($job->id
, 'Integer'),
833 2 => array(date('YmdHis'), 'Timestamp'),
835 CRM_Core_DAO
::executeQuery($sql, $params);
837 CRM_Core_Session
::setStatus(ts('The mailing has been canceled.'), ts('Canceled'), 'success');
842 * Return a translated status enum string.
844 * @param string $status
848 * The translated version
850 public static function status($status) {
851 static $translation = NULL;
853 if (empty($translation)) {
854 $translation = array(
855 'Scheduled' => ts('Scheduled'),
856 'Running' => ts('Running'),
857 'Complete' => ts('Complete'),
858 'Paused' => ts('Paused'),
859 'Canceled' => ts('Canceled'),
862 return CRM_Utils_Array
::value($status, $translation, ts('Not scheduled'));
866 * Return a workflow clause for use in SQL queries,
867 * to only process jobs that are approved.
870 * For use in a WHERE clause
872 public static function workflowClause() {
873 // add an additional check and only process
874 // jobs that are approved
875 if (CRM_Mailing_Info
::workflowEnabled()) {
876 $approveOptionID = CRM_Core_OptionGroup
::getValue('mail_approval_status',
880 if ($approveOptionID) {
881 return " AND m.approval_status_id = $approveOptionID ";
888 * @param array $deliveredParams
889 * @param array $targetParams
894 * @throws CRM_Core_Exception
897 public function writeToDB(
903 static $activityTypeID = NULL;
904 static $writeActivity = NULL;
906 if (!empty($deliveredParams)) {
907 CRM_Mailing_Event_BAO_Delivered
::bulkCreate($deliveredParams);
908 $deliveredParams = array();
911 if ($writeActivity === NULL) {
912 $writeActivity = Civi
::settings()->get('write_activity_record');
915 if (!$writeActivity) {
920 if (!empty($targetParams) && !empty($mailing->scheduled_id
)) {
921 if (!$activityTypeID) {
922 if ($mailing->sms_provider_id
) {
923 $mailing->subject
= $mailing->name
;
924 $activityTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Mass SMS'
928 $activityTypeID = CRM_Core_PseudoConstant
::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Bulk Email');
930 if (!$activityTypeID) {
931 CRM_Core_Error
::fatal();
936 'source_contact_id' => $mailing->scheduled_id
,
938 'target_contact_id' => array_unique($targetParams),
939 'activity_type_id' => $activityTypeID,
940 'source_record_id' => $this->mailing_id
,
941 'activity_date_time' => $job_date,
942 'subject' => $mailing->subject
,
944 'deleteActivityTarget' => FALSE,
945 'campaign_id' => $mailing->campaign_id
,
948 //check whether activity is already created for this mailing.
949 //if yes then create only target contact record.
952 FROM civicrm_activity
953 WHERE civicrm_activity.activity_type_id = %1
954 AND civicrm_activity.source_record_id = %2
957 $queryParams = array(
958 1 => array($activityTypeID, 'Integer'),
959 2 => array($this->mailing_id
, 'Integer'),
961 $activityID = CRM_Core_DAO
::singleValueQuery($query, $queryParams);
964 $activity['id'] = $activityID;
967 if (CRM_Core_BAO_Email
::isMultipleBulkMail()) {
968 static $targetRecordID = NULL;
969 if (!$targetRecordID) {
970 $activityContacts = CRM_Activity_BAO_ActivityContact
::buildOptions('record_type_id', 'validate');
971 $targetRecordID = CRM_Utils_Array
::key('Activity Targets', $activityContacts);
974 // make sure we don't attempt to duplicate the target activity
975 foreach ($activity['target_contact_id'] as $key => $targetID) {
978 FROM civicrm_activity_contact
979 WHERE activity_id = $activityID
980 AND contact_id = $targetID
981 AND record_type_id = $targetRecordID
983 if (CRM_Core_DAO
::singleValueQuery($sql)) {
984 unset($activity['target_contact_id'][$key]);
990 if (is_a(CRM_Activity_BAO_Activity
::create($activity), 'CRM_Core_Error')) {
994 $targetParams = array();
1001 * Search the mailing-event queue for a list of pending delivery tasks.
1004 * @param string $medium
1005 * Ex: 'email' or 'sms'.
1007 * @return \CRM_Mailing_Event_BAO_Queue
1008 * A query object whose rows provide ('id', 'contact_id', 'hash') and ('email' or 'phone').
1010 public static function findPendingTasks($jobId, $medium) {
1011 $eq = new CRM_Mailing_Event_BAO_Queue();
1012 $queueTable = CRM_Mailing_Event_BAO_Queue
::getTableName();
1013 $emailTable = CRM_Core_BAO_Email
::getTableName();
1014 $phoneTable = CRM_Core_BAO_Phone
::getTableName();
1015 $contactTable = CRM_Contact_BAO_Contact
::getTableName();
1016 $deliveredTable = CRM_Mailing_Event_BAO_Delivered
::getTableName();
1017 $bounceTable = CRM_Mailing_Event_BAO_Bounce
::getTableName();
1019 $query = " SELECT $queueTable.id,
1020 $emailTable.email as email,
1021 $queueTable.contact_id,
1025 INNER JOIN $emailTable
1026 ON $queueTable.email_id = $emailTable.id
1027 INNER JOIN $contactTable
1028 ON $contactTable.id = $emailTable.contact_id
1029 LEFT JOIN $deliveredTable
1030 ON $queueTable.id = $deliveredTable.event_queue_id
1031 LEFT JOIN $bounceTable
1032 ON $queueTable.id = $bounceTable.event_queue_id
1033 WHERE $queueTable.job_id = " . $jobId . "
1034 AND $deliveredTable.id IS null
1035 AND $bounceTable.id IS null
1036 AND $contactTable.is_opt_out = 0";
1038 if ($medium === 'sms') {
1040 SELECT $queueTable.id,
1041 $phoneTable.phone as phone,
1042 $queueTable.contact_id,
1046 INNER JOIN $phoneTable
1047 ON $queueTable.phone_id = $phoneTable.id
1048 INNER JOIN $contactTable
1049 ON $contactTable.id = $phoneTable.contact_id
1050 LEFT JOIN $deliveredTable
1051 ON $queueTable.id = $deliveredTable.event_queue_id
1052 LEFT JOIN $bounceTable
1053 ON $queueTable.id = $bounceTable.event_queue_id
1054 WHERE $queueTable.job_id = " . $jobId . "
1055 AND $deliveredTable.id IS null
1056 AND $bounceTable.id IS null
1057 AND ( $contactTable.is_opt_out = 0
1058 OR $contactTable.do_not_sms = 0 )";