CRM/Mailing/BAO/MailingJob.php

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