CRM/Mailing/BAO/MailingJob.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2018                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  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.   |
  13  |                                                                    |
  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.        |
  18  |                                                                    |
  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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2018
  32  */
  33
  34 require_once 'Mail.php';
  35
  36 /**
  37  * Class CRM_Mailing_BAO_MailingJob
  38  */
  39 class CRM_Mailing_BAO_MailingJob extends CRM_Mailing_DAO_MailingJob {
  40   const MAX_CONTACTS_TO_PROCESS = 1000;
  41
  42   /**
  43    * (Dear God Why) Keep a global count of mails processed within the current
  44    * request.
  45    *
  46    * @var int
  47    */
  48   static $mailsProcessed = 0;
  49
  50   /**
  51    * Class constructor.
  52    */
  53   public function __construct() {
  54     parent::__construct();
  55   }
  56
  57   /**
  58    * Create mailing job.
  59    *
  60    * @param array $params
  61    *
  62    * @return \CRM_Mailing_BAO_MailingJob
  63    * @throws \CRM_Core_Exception
  64    */
  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'];
  71     $job->save();
  72     if ($params['mailing_id']) {
  73       CRM_Mailing_BAO_Mailing::getRecipients($params['mailing_id']);
  74       return $job;
  75     }
  76     else {
  77       throw new CRM_Core_Exception("Failed to create job: Unknown mailing ID");
  78     }
  79   }
  80
  81   /**
  82    * Initiate all pending/ready jobs.
  83    *
  84    * @param array $testParams
  85    * @param string $mode
  86    *
  87    * @return bool|null
  88    */
  89   public static function runJobs($testParams = NULL, $mode = NULL) {
  90     $job = new CRM_Mailing_BAO_MailingJob();
  91
  92     $config = CRM_Core_Config::singleton();
  93     $jobTable = CRM_Mailing_DAO_MailingJob::getTableName();
  94     $mailingTable = CRM_Mailing_DAO_Mailing::getTableName();
  95     $mailerBatchLimit = Civi::settings()->get('mailerBatchLimit');
  96
  97     if (!empty($testParams)) {
  98       $query = "
  99       SELECT *
 100         FROM $jobTable
 101        WHERE id = {$testParams['job_id']}";
 102       $job->query($query);
 103     }
 104     else {
 105       $currentTime = date('YmdHis');
 106       $mailingACL = CRM_Mailing_BAO_Mailing::mailingACL('m');
 107       $domainID = CRM_Core_Config::domainID();
 108
 109       $modeClause = 'AND m.sms_provider_id IS NULL';
 110       if ($mode == 'sms') {
 111         $modeClause = 'AND m.sms_provider_id IS NOT NULL';
 112       }
 113
 114       // Select the first child job that is scheduled
 115       // CRM-6835
 116       $query = "
 117       SELECT   j.*
 118         FROM   $jobTable     j,
 119            $mailingTable m
 120        WHERE   m.id = j.mailing_id AND m.domain_id = {$domainID}
 121                      {$modeClause}
 122          AND   j.is_test = 0
 123          AND   ( ( j.start_date IS null
 124          AND       j.scheduled_date <= $currentTime
 125          AND       j.status = 'Scheduled' )
 126                 OR     ( j.status = 'Running'
 127          AND       j.end_date IS null ) )
 128          AND (j.job_type = 'child')
 129          AND   {$mailingACL}
 130       ORDER BY j.scheduled_date ASC,
 131         j.id
 132       ";
 133
 134       $job->query($query);
 135     }
 136
 137     while ($job->fetch()) {
 138       // still use job level lock for each child job
 139       $lock = Civi::lockManager()->acquire("data.mailing.job.{$job->id}");
 140       if (!$lock->isAcquired()) {
 141         continue;
 142       }
 143
 144       // for test jobs we do not change anything, since its on a short-circuit path
 145       if (empty($testParams)) {
 146         // we've got the lock, but while we were waiting and processing
 147         // other emails, this job might have changed under us
 148         // lets get the job status again and check
 149         $job->status = CRM_Core_DAO::getFieldValue(
 150           'CRM_Mailing_DAO_MailingJob',
 151           $job->id,
 152           'status',
 153           'id',
 154           TRUE
 155         );
 156
 157         if (
 158           $job->status != 'Running' &&
 159           $job->status != 'Scheduled'
 160         ) {
 161           // this includes Cancelled and other statuses, CRM-4246
 162           $lock->release();
 163           continue;
 164         }
 165       }
 166
 167       /* Queue up recipients for the child job being launched */
 168
 169       if ($job->status != 'Running') {
 170         $transaction = new CRM_Core_Transaction();
 171
 172         // have to queue it up based on the offset and limits
 173         // get the parent ID, and limit and offset
 174         $job->queue($testParams);
 175
 176         // Mark up the starting time
 177         $saveJob = new CRM_Mailing_DAO_MailingJob();
 178         $saveJob->id = $job->id;
 179         $saveJob->start_date = date('YmdHis');
 180         $saveJob->status = 'Running';
 181         $saveJob->save();
 182
 183         $transaction->commit();
 184       }
 185
 186       // Get the mailer
 187       if ($mode === NULL) {
 188         $mailer = \Civi::service('pear_mail');
 189       }
 190       elseif ($mode == 'sms') {
 191         $mailer = CRM_SMS_Provider::singleton(array('mailing_id' => $job->mailing_id));
 192       }
 193
 194       // Compose and deliver each child job
 195       if (\CRM_Utils_Constant::value('CIVICRM_FLEXMAILER_HACK_DELIVER')) {
 196         $isComplete = Civi\Core\Resolver::singleton()->call(CIVICRM_FLEXMAILER_HACK_DELIVER, array($job, $mailer, $testParams));
 197       }
 198       else {
 199         $isComplete = $job->deliver($mailer, $testParams);
 200       }
 201
 202       CRM_Utils_Hook::post('create', 'CRM_Mailing_DAO_Spool', $job->id, $isComplete);
 203
 204       // Mark the child complete
 205       if ($isComplete) {
 206         // Finish the job.
 207
 208         $transaction = new CRM_Core_Transaction();
 209
 210         $saveJob = new CRM_Mailing_DAO_MailingJob();
 211         $saveJob->id = $job->id;
 212         $saveJob->end_date = date('YmdHis');
 213         $saveJob->status = 'Complete';
 214         $saveJob->save();
 215
 216         $transaction->commit();
 217
 218         // don't mark the mailing as complete
 219       }
 220
 221       // Release the child joblock
 222       $lock->release();
 223
 224       if ($testParams) {
 225         return $isComplete;
 226       }
 227
 228       // CRM-17629: Stop processing jobs if mailer batch limit reached
 229       if ($mailerBatchLimit > 0 && self::$mailsProcessed >= $mailerBatchLimit) {
 230         break;
 231       }
 232
 233     }
 234   }
 235
 236   /**
 237    * Post process to determine if the parent job
 238    * as well as the mailing is complete after the run.
 239    * @param null $mode
 240    */
 241   public static function runJobs_post($mode = NULL) {
 242
 243     $job = new CRM_Mailing_BAO_MailingJob();
 244
 245     $mailing = new CRM_Mailing_BAO_Mailing();
 246
 247     $config = CRM_Core_Config::singleton();
 248     $jobTable = CRM_Mailing_DAO_MailingJob::getTableName();
 249     $mailingTable = CRM_Mailing_DAO_Mailing::getTableName();
 250
 251     $currentTime = date('YmdHis');
 252     $mailingACL = CRM_Mailing_BAO_Mailing::mailingACL('m');
 253     $domainID = CRM_Core_Config::domainID();
 254
 255     $query = "
 256                 SELECT   j.*
 257                   FROM   $jobTable     j,
 258                                  $mailingTable m
 259                  WHERE   m.id = j.mailing_id AND m.domain_id = {$domainID}
 260                    AND   j.is_test = 0
 261                    AND       j.scheduled_date <= $currentTime
 262                    AND       j.status = 'Running'
 263                    AND       j.end_date IS null
 264                    AND       (j.job_type != 'child' OR j.job_type is NULL)
 265                 ORDER BY j.scheduled_date,
 266                                  j.start_date";
 267
 268     $job->query($query);
 269
 270     // For each parent job that is running, let's look at their child jobs
 271     while ($job->fetch()) {
 272
 273       $child_job = new CRM_Mailing_BAO_MailingJob();
 274
 275       $child_job_sql = "
 276             SELECT count(j.id)
 277                         FROM civicrm_mailing_job j, civicrm_mailing m
 278                         WHERE m.id = j.mailing_id
 279                         AND j.job_type = 'child'
 280                         AND j.parent_id = %1
 281             AND j.status <> 'Complete'";
 282       $params = array(1 => array($job->id, 'Integer'));
 283
 284       $anyChildLeft = CRM_Core_DAO::singleValueQuery($child_job_sql, $params);
 285
 286       // all of the child jobs are complete, update
 287       // the parent job as well as the mailing status
 288       if (!$anyChildLeft) {
 289
 290         $transaction = new CRM_Core_Transaction();
 291
 292         $saveJob = new CRM_Mailing_DAO_MailingJob();
 293         $saveJob->id = $job->id;
 294         $saveJob->end_date = date('YmdHis');
 295         $saveJob->status = 'Complete';
 296         $saveJob->save();
 297
 298         $mailing->reset();
 299         $mailing->id = $job->mailing_id;
 300         $mailing->is_completed = TRUE;
 301         $mailing->save();
 302         $transaction->commit();
 303
 304         // CRM-17763
 305         CRM_Utils_Hook::postMailing($job->mailing_id);
 306       }
 307     }
 308   }
 309
 310
 311   /**
 312    * before we run jobs, we need to split the jobs
 313    * @param int $offset
 314    * @param null $mode
 315    */
 316   public static function runJobs_pre($offset = 200, $mode = NULL) {
 317     $job = new CRM_Mailing_BAO_MailingJob();
 318
 319     $jobTable = CRM_Mailing_DAO_MailingJob::getTableName();
 320     $mailingTable = CRM_Mailing_DAO_Mailing::getTableName();
 321
 322     $currentTime = date('YmdHis');
 323     $mailingACL = CRM_Mailing_BAO_Mailing::mailingACL('m');
 324
 325     $workflowClause = CRM_Mailing_BAO_MailingJob::workflowClause();
 326
 327     $domainID = CRM_Core_Config::domainID();
 328
 329     $modeClause = 'AND m.sms_provider_id IS NULL';
 330     if ($mode == 'sms') {
 331       $modeClause = 'AND m.sms_provider_id IS NOT NULL';
 332     }
 333
 334     // Select all the mailing jobs that are created from
 335     // when the mailing is submitted or scheduled.
 336     $query = "
 337     SELECT   j.*
 338       FROM   $jobTable     j,
 339          $mailingTable m
 340      WHERE   m.id = j.mailing_id AND m.domain_id = {$domainID}
 341                  $workflowClause
 342                  $modeClause
 343        AND   j.is_test = 0
 344        AND   ( ( j.start_date IS null
 345        AND       j.scheduled_date <= $currentTime
 346        AND       j.status = 'Scheduled'
 347        AND       j.end_date IS null ) )
 348        AND ((j.job_type is NULL) OR (j.job_type <> 'child'))
 349     ORDER BY j.scheduled_date,
 350          j.start_date";
 351
 352     $job->query($query);
 353
 354     // For each of the "Parent Jobs" we find, we split them into
 355     // X Number of child jobs
 356     while ($job->fetch()) {
 357       // still use job level lock for each child job
 358       $lock = Civi::lockManager()->acquire("data.mailing.job.{$job->id}");
 359       if (!$lock->isAcquired()) {
 360         continue;
 361       }
 362
 363       // Re-fetch the job status in case things
 364       // changed between the first query and now
 365       // to avoid race conditions
 366       $job->status = CRM_Core_DAO::getFieldValue(
 367         'CRM_Mailing_DAO_MailingJob',
 368         $job->id,
 369         'status',
 370         'id',
 371         TRUE
 372       );
 373       if ($job->status != 'Scheduled') {
 374         $lock->release();
 375         continue;
 376       }
 377
 378       $transaction = new CRM_Core_Transaction();
 379
 380       $job->split_job($offset);
 381
 382       // update the status of the parent job
 383       $saveJob = new CRM_Mailing_DAO_MailingJob();
 384       $saveJob->id = $job->id;
 385       $saveJob->start_date = date('YmdHis');
 386       $saveJob->status = 'Running';
 387       $saveJob->save();
 388
 389       $transaction->commit();
 390
 391       // Release the job lock
 392       $lock->release();
 393     }
 394   }
 395
 396   /**
 397    * Split the parent job into n number of child job based on an offset.
 398    * If null or 0 , we create only one child job
 399    * @param int $offset
 400    */
 401   public function split_job($offset = 200) {
 402     $recipient_count = CRM_Mailing_BAO_Recipients::mailingSize($this->mailing_id);
 403
 404     $jobTable = CRM_Mailing_DAO_MailingJob::getTableName();
 405
 406     $dao = new CRM_Core_DAO();
 407
 408     $sql = "
 409 INSERT INTO civicrm_mailing_job
 410 (`mailing_id`, `scheduled_date`, `status`, `job_type`, `parent_id`, `job_offset`, `job_limit`)
 411 VALUES (%1, %2, %3, %4, %5, %6, %7)
 412 ";
 413     $params = array(
 414       1 => array($this->mailing_id, 'Integer'),
 415       2 => array($this->scheduled_date, 'String'),
 416       3 => array('Scheduled', 'String'),
 417       4 => array('child', 'String'),
 418       5 => array($this->id, 'Integer'),
 419       6 => array(0, 'Integer'),
 420       7 => array($recipient_count, 'Integer'),
 421     );
 422
 423     // create one child job if the mailing size is less than the offset
 424     // probably use a CRM_Mailing_DAO_MailingJob( );
 425     if (empty($offset) ||
 426       $recipient_count <= $offset
 427     ) {
 428       CRM_Core_DAO::executeQuery($sql, $params);
 429     }
 430     else {
 431       // Creating 'child jobs'
 432       $scheduled_unixtime = strtotime($this->scheduled_date);
 433       for ($i = 0, $s = 0; $i < $recipient_count; $i = $i + $offset, $s++) {
 434         $params[2][0] = date('Y-m-d H:i:s', $scheduled_unixtime + $s);
 435         $params[6][0] = $i;
 436         $params[7][0] = $offset;
 437         CRM_Core_DAO::executeQuery($sql, $params);
 438       }
 439     }
 440
 441   }
 442
 443   /**
 444    * @param array $testParams
 445    */
 446   public function queue($testParams = NULL) {
 447     $mailing = new CRM_Mailing_BAO_Mailing();
 448     $mailing->id = $this->mailing_id;
 449     if (!empty($testParams)) {
 450       $mailing->getTestRecipients($testParams);
 451     }
 452     else {
 453       // We are still getting all the recipients from the parent job
 454       // so we don't mess with the include/exclude logic.
 455       $recipients = CRM_Mailing_BAO_Recipients::mailingQuery($this->mailing_id, $this->job_offset, $this->job_limit);
 456
 457       // FIXME: this is not very smart, we should move this to one DB call
 458       // INSERT INTO ... SELECT FROM ..
 459       // the thing we need to figure out is how to generate the hash automatically
 460       $now = time();
 461       $params = array();
 462       $count = 0;
 463       while ($recipients->fetch()) {
 464         // CRM-18543: there are situations when both the email and phone are null.
 465         // Skip the recipient in this case.
 466         if (empty($recipients->email_id) && empty($recipients->phone_id)) {
 467           continue;
 468         }
 469
 470         if ($recipients->phone_id) {
 471           $recipients->email_id = "null";
 472         }
 473         else {
 474           $recipients->phone_id = "null";
 475         }
 476
 477         $params[] = array(
 478           $this->id,
 479           $recipients->email_id,
 480           $recipients->contact_id,
 481           $recipients->phone_id,
 482         );
 483         $count++;
 484         if ($count % CRM_Mailing_Config::BULK_MAIL_INSERT_COUNT == 0) {
 485           CRM_Mailing_Event_BAO_Queue::bulkCreate($params, $now);
 486           $count = 0;
 487           $params = array();
 488         }
 489       }
 490
 491       if (!empty($params)) {
 492         CRM_Mailing_Event_BAO_Queue::bulkCreate($params, $now);
 493       }
 494     }
 495   }
 496
 497   /**
 498    * Send the mailing.
 499    *
 500    * @deprecated
 501    *   This is used by CiviMail but will be made redundant by FlexMailer.
 502    * @param object $mailer
 503    *   A Mail object to send the messages.
 504    *
 505    * @param array $testParams
 506    * @return bool
 507    */
 508   public function deliver(&$mailer, $testParams = NULL) {
 509     if (\Civi::settings()->get('experimentalFlexMailerEngine')) {
 510       throw new \RuntimeException("Cannot use legacy deliver() when experimentalFlexMailerEngine is enabled");
 511     }
 512
 513     $mailing = new CRM_Mailing_BAO_Mailing();
 514     $mailing->id = $this->mailing_id;
 515     $mailing->find(TRUE);
 516     $mailing->free();
 517
 518     $config = NULL;
 519
 520     if ($config == NULL) {
 521       $config = CRM_Core_Config::singleton();
 522     }
 523
 524     if (property_exists($mailing, 'language') && $mailing->language && $mailing->language != 'en_US') {
 525       $swapLang = CRM_Utils_AutoClean::swap('global://dbLocale?getter', 'call://i18n/setLocale', $mailing->language);
 526     }
 527
 528     $job_date = CRM_Utils_Date::isoToMysql($this->scheduled_date);
 529     $fields = array();
 530
 531     if (!empty($testParams)) {
 532       $mailing->subject = ts('[CiviMail Draft]') . ' ' . $mailing->subject;
 533     }
 534
 535     CRM_Mailing_BAO_Mailing::tokenReplace($mailing);
 536
 537     // get and format attachments
 538     $attachments = CRM_Core_BAO_File::getEntityFile('civicrm_mailing', $mailing->id);
 539
 540     if (defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY) {
 541       CRM_Core_Smarty::registerStringResource();
 542     }
 543
 544     // CRM-12376
 545     // This handles the edge case scenario where all the mails
 546     // have been delivered in prior jobs.
 547     $isDelivered = TRUE;
 548
 549     // make sure that there's no more than $mailerBatchLimit mails processed in a run
 550     $mailerBatchLimit = Civi::settings()->get('mailerBatchLimit');
 551     $eq = self::findPendingTasks($this->id, $mailing->sms_provider_id ? 'sms' : 'email');
 552     while ($eq->fetch()) {
 553       if ($mailerBatchLimit > 0 && self::$mailsProcessed >= $mailerBatchLimit) {
 554         if (!empty($fields)) {
 555           $this->deliverGroup($fields, $mailing, $mailer, $job_date, $attachments);
 556         }
 557         $eq->free();
 558         return FALSE;
 559       }
 560       self::$mailsProcessed++;
 561
 562       $fields[] = array(
 563         'id' => $eq->id,
 564         'hash' => $eq->hash,
 565         'contact_id' => $eq->contact_id,
 566         'email' => $eq->email,
 567         'phone' => $eq->phone,
 568       );
 569       if (count($fields) == self::MAX_CONTACTS_TO_PROCESS) {
 570         $isDelivered = $this->deliverGroup($fields, $mailing, $mailer, $job_date, $attachments);
 571         if (!$isDelivered) {
 572           $eq->free();
 573           return $isDelivered;
 574         }
 575         $fields = array();
 576       }
 577     }
 578
 579     $eq->free();
 580
 581     if (!empty($fields)) {
 582       $isDelivered = $this->deliverGroup($fields, $mailing, $mailer, $job_date, $attachments);
 583     }
 584     return $isDelivered;
 585   }
 586
 587   /**
 588    * @deprecated
 589    *   This is used by CiviMail but will be made redundant by FlexMailer.
 590    * @param array $fields
 591    *   List of intended recipients.
 592    *   Each recipient is an array with keys 'hash', 'contact_id', 'email', etc.
 593    * @param $mailing
 594    * @param $mailer
 595    * @param $job_date
 596    * @param $attachments
 597    *
 598    * @return bool|null
 599    * @throws Exception
 600    */
 601   public function deliverGroup(&$fields, &$mailing, &$mailer, &$job_date, &$attachments) {
 602     static $smtpConnectionErrors = 0;
 603
 604     if (!is_object($mailer) || empty($fields)) {
 605       CRM_Core_Error::fatal();
 606     }
 607
 608     // get the return properties
 609     $returnProperties = $mailing->getReturnProperties();
 610     $params = $targetParams = $deliveredParams = array();
 611     $count = 0;
 612
 613     // CRM-15702: Sending bulk sms to contacts without e-mail address fails.
 614     // Solution is to skip checking for on hold
 615     $skipOnHold = TRUE;    //do include a statement to check wether e-mail address is on hold
 616     if ($mailing->sms_provider_id) {
 617       $skipOnHold = FALSE; //do not include a statement to check wether e-mail address is on hold
 618     }
 619
 620     foreach ($fields as $key => $field) {
 621       $params[] = $field['contact_id'];
 622     }
 623
 624     $details = CRM_Utils_Token::getTokenDetails(
 625       $params,
 626       $returnProperties,
 627       $skipOnHold, TRUE, NULL,
 628       $mailing->getFlattenedTokens(),
 629       get_class($this),
 630       $this->id
 631     );
 632
 633     $config = CRM_Core_Config::singleton();
 634     foreach ($fields as $key => $field) {
 635       $contactID = $field['contact_id'];
 636       if (!array_key_exists($contactID, $details[0])) {
 637         $details[0][$contactID] = array();
 638       }
 639
 640       // Compose the mailing.
 641       $recipient = $replyToEmail = NULL;
 642       $replyValue = strcmp($mailing->replyto_email, $mailing->from_email);
 643       if ($replyValue) {
 644         $replyToEmail = $mailing->replyto_email;
 645       }
 646
 647       $message = $mailing->compose(
 648         $this->id, $field['id'], $field['hash'],
 649         $field['contact_id'], $field['email'],
 650         $recipient, FALSE, $details[0][$contactID], $attachments,
 651         FALSE, NULL, $replyToEmail
 652       );
 653       if (empty($message)) {
 654         // lets keep the message in the queue
 655         // most likely a permissions related issue with smarty templates
 656         // or a bad contact id? CRM-9833
 657         continue;
 658       }
 659
 660       // Send the mailing.
 661
 662       $body = &$message->get();
 663       $headers = &$message->headers();
 664
 665       if ($mailing->sms_provider_id) {
 666         $provider = CRM_SMS_Provider::singleton(array('mailing_id' => $mailing->id));
 667         $body = $provider->getMessage($message, $field['contact_id'], $details[0][$contactID]);
 668         $headers = $provider->getRecipientDetails($field, $details[0][$contactID]);
 669       }
 670
 671       // make $recipient actually be the *encoded* header, so as not to baffle Mail_RFC822, CRM-5743
 672       $recipient = $headers['To'];
 673       $result = NULL;
 674
 675       // disable error reporting on real mailings (but leave error reporting for tests), CRM-5744
 676       if ($job_date) {
 677         $errorScope = CRM_Core_TemporaryErrorScope::ignoreException();
 678       }
 679
 680       $result = $mailer->send($recipient, $headers, $body, $this->id);
 681
 682       if ($job_date) {
 683         unset($errorScope);
 684       }
 685
 686       if (is_a($result, 'PEAR_Error') && !$mailing->sms_provider_id) {
 687         // CRM-9191
 688         $message = $result->getMessage();
 689         if (
 690           strpos($message, 'Failed to write to socket') !== FALSE ||
 691           strpos($message, 'Failed to set sender') !== FALSE
 692         ) {
 693           // lets log this message and code
 694           $code = $result->getCode();
 695           CRM_Core_Error::debug_log_message("SMTP Socket Error or failed to set sender error. Message: $message, Code: $code");
 696
 697           // these are socket write errors which most likely means smtp connection errors
 698           // lets skip them
 699           $smtpConnectionErrors++;
 700           if ($smtpConnectionErrors <= 5) {
 701             continue;
 702           }
 703
 704           // seems like we have too many of them in a row, we should
 705           // write stuff to disk and abort the cron job
 706           $this->writeToDB(
 707             $deliveredParams,
 708             $targetParams,
 709             $mailing,
 710             $job_date
 711           );
 712
 713           CRM_Core_Error::debug_log_message("Too many SMTP Socket Errors. Exiting");
 714           CRM_Utils_System::civiExit();
 715         }
 716
 717         // Register the bounce event.
 718
 719         $params = array(
 720           'event_queue_id' => $field['id'],
 721           'job_id' => $this->id,
 722           'hash' => $field['hash'],
 723         );
 724         $params = array_merge($params,
 725           CRM_Mailing_BAO_BouncePattern::match($result->getMessage())
 726         );
 727         CRM_Mailing_Event_BAO_Bounce::create($params);
 728       }
 729       elseif (is_a($result, 'PEAR_Error') && $mailing->sms_provider_id) {
 730         // Handle SMS errors: CRM-15426
 731         $job_id = intval($this->id);
 732         $mailing_id = intval($mailing->id);
 733         CRM_Core_Error::debug_log_message("Failed to send SMS message. Vars: mailing_id: ${mailing_id}, job_id: ${job_id}. Error message follows.");
 734         CRM_Core_Error::debug_log_message($result->getMessage());
 735       }
 736       else {
 737         // Register the delivery event.
 738         $deliveredParams[] = $field['id'];
 739         $targetParams[] = $field['contact_id'];
 740
 741         $count++;
 742         if ($count % CRM_Mailing_Config::BULK_MAIL_INSERT_COUNT == 0) {
 743           $this->writeToDB(
 744             $deliveredParams,
 745             $targetParams,
 746             $mailing,
 747             $job_date
 748           );
 749           $count = 0;
 750
 751           // hack to stop mailing job at run time, CRM-4246.
 752           // to avoid making too many DB calls for this rare case
 753           // lets do it when we snapshot
 754           $status = CRM_Core_DAO::getFieldValue(
 755             'CRM_Mailing_DAO_MailingJob',
 756             $this->id,
 757             'status',
 758             'id',
 759             TRUE
 760           );
 761
 762           if ($status != 'Running') {
 763             return FALSE;
 764           }
 765         }
 766       }
 767
 768       unset($result);
 769
 770       // seems like a successful delivery or bounce, lets decrement error count
 771       // only if we have smtp connection errors
 772       if ($smtpConnectionErrors > 0) {
 773         $smtpConnectionErrors--;
 774       }
 775
 776       // If we have enabled the Throttle option, this is the time to enforce it.
 777       $mailThrottleTime = Civi::settings()->get('mailThrottleTime');
 778       if (!empty($mailThrottleTime)) {
 779         usleep((int ) $mailThrottleTime);
 780       }
 781     }
 782
 783     $result = $this->writeToDB(
 784       $deliveredParams,
 785       $targetParams,
 786       $mailing,
 787       $job_date
 788     );
 789
 790     return $result;
 791   }
 792
 793   /**
 794    * Cancel a mailing.
 795    *
 796    * @param int $mailingId
 797    *   The id of the mailing to be canceled.
 798    */
 799   public static function cancel($mailingId) {
 800     $sql = "
 801 SELECT *
 802 FROM   civicrm_mailing_job
 803 WHERE  mailing_id = %1
 804 AND    is_test = 0
 805 AND    ( ( job_type IS NULL ) OR
 806            job_type <> 'child' )
 807 ";
 808     $params = array(1 => array($mailingId, 'Integer'));
 809     $job = CRM_Core_DAO::executeQuery($sql, $params);
 810     if ($job->fetch() &&
 811       in_array($job->status, array('Scheduled', 'Running', 'Paused'))
 812     ) {
 813
 814       $newJob = new CRM_Mailing_BAO_MailingJob();
 815       $newJob->id = $job->id;
 816       $newJob->end_date = date('YmdHis');
 817       $newJob->status = 'Canceled';
 818       $newJob->save();
 819
 820       // also cancel all child jobs
 821       $sql = "
 822 UPDATE civicrm_mailing_job
 823 SET    status = 'Canceled',
 824        end_date = %2
 825 WHERE  parent_id = %1
 826 AND    is_test = 0
 827 AND    job_type = 'child'
 828 AND    status IN ( 'Scheduled', 'Running', 'Paused' )
 829 ";
 830       $params = array(
 831         1 => array($job->id, 'Integer'),
 832         2 => array(date('YmdHis'), 'Timestamp'),
 833       );
 834       CRM_Core_DAO::executeQuery($sql, $params);
 835
 836       CRM_Core_Session::setStatus(ts('The mailing has been canceled.'), ts('Canceled'), 'success');
 837     }
 838   }
 839
 840   /**
 841    * Return a translated status enum string.
 842    *
 843    * @param string $status
 844    *   The status enum.
 845    *
 846    * @return string
 847    *   The translated version
 848    */
 849   public static function status($status) {
 850     static $translation = NULL;
 851
 852     if (empty($translation)) {
 853       $translation = array(
 854         'Scheduled' => ts('Scheduled'),
 855         'Running' => ts('Running'),
 856         'Complete' => ts('Complete'),
 857         'Paused' => ts('Paused'),
 858         'Canceled' => ts('Canceled'),
 859       );
 860     }
 861     return CRM_Utils_Array::value($status, $translation, ts('Not scheduled'));
 862   }
 863
 864   /**
 865    * Return a workflow clause for use in SQL queries,
 866    * to only process jobs that are approved.
 867    *
 868    * @return string
 869    *   For use in a WHERE clause
 870    */
 871   public static function workflowClause() {
 872     // add an additional check and only process
 873     // jobs that are approved
 874     if (CRM_Mailing_Info::workflowEnabled()) {
 875       $approveOptionID = CRM_Core_OptionGroup::getValue('mail_approval_status',
 876         'Approved',
 877         'name'
 878       );
 879       if ($approveOptionID) {
 880         return " AND m.approval_status_id = $approveOptionID ";
 881       }
 882     }
 883     return '';
 884   }
 885
 886   /**
 887    * @param array $deliveredParams
 888    * @param array $targetParams
 889    * @param $mailing
 890    * @param $job_date
 891    *
 892    * @return bool
 893    * @throws CRM_Core_Exception
 894    * @throws Exception
 895    */
 896   public function writeToDB(
 897     &$deliveredParams,
 898     &$targetParams,
 899     &$mailing,
 900     $job_date
 901   ) {
 902     static $activityTypeID = NULL;
 903     static $writeActivity = NULL;
 904
 905     if (!empty($deliveredParams)) {
 906       CRM_Mailing_Event_BAO_Delivered::bulkCreate($deliveredParams);
 907       $deliveredParams = array();
 908     }
 909
 910     if ($writeActivity === NULL) {
 911       $writeActivity = Civi::settings()->get('write_activity_record');
 912     }
 913
 914     if (!$writeActivity) {
 915       return TRUE;
 916     }
 917
 918     $result = TRUE;
 919     if (!empty($targetParams) && !empty($mailing->scheduled_id)) {
 920       if (!$activityTypeID) {
 921         if ($mailing->sms_provider_id) {
 922           $mailing->subject = $mailing->name;
 923           $activityTypeID = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Mass SMS'
 924           );
 925         }
 926         else {
 927           $activityTypeID = CRM_Core_PseudoConstant::getKey('CRM_Activity_BAO_Activity', 'activity_type_id', 'Bulk Email');
 928         }
 929         if (!$activityTypeID) {
 930           CRM_Core_Error::fatal();
 931         }
 932       }
 933
 934       $activity = array(
 935         'source_contact_id' => $mailing->scheduled_id,
 936         // CRM-9519
 937         'target_contact_id' => array_unique($targetParams),
 938         'activity_type_id' => $activityTypeID,
 939         'source_record_id' => $this->mailing_id,
 940         'activity_date_time' => $job_date,
 941         'subject' => $mailing->subject,
 942         'status_id' => 2,
 943         'deleteActivityTarget' => FALSE,
 944         'campaign_id' => $mailing->campaign_id,
 945       );
 946
 947       //check whether activity is already created for this mailing.
 948       //if yes then create only target contact record.
 949       $query = "
 950 SELECT id
 951 FROM   civicrm_activity
 952 WHERE  civicrm_activity.activity_type_id = %1
 953 AND    civicrm_activity.source_record_id = %2
 954 ";
 955
 956       $queryParams = array(
 957         1 => array($activityTypeID, 'Integer'),
 958         2 => array($this->mailing_id, 'Integer'),
 959       );
 960       $activityID = CRM_Core_DAO::singleValueQuery($query, $queryParams);
 961
 962       if ($activityID) {
 963         $activity['id'] = $activityID;
 964
 965         // CRM-9519
 966         if (CRM_Core_BAO_Email::isMultipleBulkMail()) {
 967           static $targetRecordID = NULL;
 968           if (!$targetRecordID) {
 969             $activityContacts = CRM_Activity_BAO_ActivityContact::buildOptions('record_type_id', 'validate');
 970             $targetRecordID = CRM_Utils_Array::key('Activity Targets', $activityContacts);
 971           }
 972
 973           // make sure we don't attempt to duplicate the target activity
 974           foreach ($activity['target_contact_id'] as $key => $targetID) {
 975             $sql = "
 976 SELECT id
 977 FROM   civicrm_activity_contact
 978 WHERE  activity_id = $activityID
 979 AND    contact_id = $targetID
 980 AND    record_type_id = $targetRecordID
 981 ";
 982             if (CRM_Core_DAO::singleValueQuery($sql)) {
 983               unset($activity['target_contact_id'][$key]);
 984             }
 985           }
 986         }
 987       }
 988
 989       if (is_a(CRM_Activity_BAO_Activity::create($activity), 'CRM_Core_Error')) {
 990         $result = FALSE;
 991       }
 992
 993       $targetParams = array();
 994     }
 995
 996     return $result;
 997   }
 998
 999   /**
1000    * Search the mailing-event queue for a list of pending delivery tasks.
1001    *
1002    * @param int $jobId
1003    * @param string $medium
1004    *   Ex: 'email' or 'sms'.
1005    *
1006    * @return \CRM_Mailing_Event_BAO_Queue
1007    *   A query object whose rows provide ('id', 'contact_id', 'hash') and ('email' or 'phone').
1008    */
1009   public static function findPendingTasks($jobId, $medium) {
1010     $eq = new CRM_Mailing_Event_BAO_Queue();
1011     $queueTable = CRM_Mailing_Event_BAO_Queue::getTableName();
1012     $emailTable = CRM_Core_BAO_Email::getTableName();
1013     $phoneTable = CRM_Core_BAO_Phone::getTableName();
1014     $contactTable = CRM_Contact_BAO_Contact::getTableName();
1015     $deliveredTable = CRM_Mailing_Event_BAO_Delivered::getTableName();
1016     $bounceTable = CRM_Mailing_Event_BAO_Bounce::getTableName();
1017
1018     $query = "  SELECT      $queueTable.id,
1019                                 $emailTable.email as email,
1020                                 $queueTable.contact_id,
1021                                 $queueTable.hash,
1022                                 NULL as phone
1023                     FROM        $queueTable
1024                     INNER JOIN  $emailTable
1025                             ON  $queueTable.email_id = $emailTable.id
1026                     INNER JOIN  $contactTable
1027                             ON  $contactTable.id = $emailTable.contact_id
1028                     LEFT JOIN   $deliveredTable
1029                             ON  $queueTable.id = $deliveredTable.event_queue_id
1030                     LEFT JOIN   $bounceTable
1031                             ON  $queueTable.id = $bounceTable.event_queue_id
1032                     WHERE       $queueTable.job_id = " . $jobId . "
1033                         AND     $deliveredTable.id IS null
1034                         AND     $bounceTable.id IS null
1035                         AND    $contactTable.is_opt_out = 0";
1036
1037     if ($medium === 'sms') {
1038       $query = "
1039                     SELECT      $queueTable.id,
1040                                 $phoneTable.phone as phone,
1041                                 $queueTable.contact_id,
1042                                 $queueTable.hash,
1043                                 NULL as email
1044                     FROM        $queueTable
1045                     INNER JOIN  $phoneTable
1046                             ON  $queueTable.phone_id = $phoneTable.id
1047                     INNER JOIN  $contactTable
1048                             ON  $contactTable.id = $phoneTable.contact_id
1049                     LEFT JOIN   $deliveredTable
1050                             ON  $queueTable.id = $deliveredTable.event_queue_id
1051                     LEFT JOIN   $bounceTable
1052                             ON  $queueTable.id = $bounceTable.event_queue_id
1053                     WHERE       $queueTable.job_id = " . $jobId . "
1054                         AND     $deliveredTable.id IS null
1055                         AND     $bounceTable.id IS null
1056                         AND    ( $contactTable.is_opt_out = 0
1057                         OR       $contactTable.do_not_sms = 0 )";
1058     }
1059     $eq->query($query);
1060     return $eq;
1061   }
1062
1063 }