CRM/Mailing/Event/BAO/Queue.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35 class CRM_Mailing_Event_BAO_Queue extends CRM_Mailing_Event_DAO_Queue {
  36
  37   /**
  38    * Class constructor.
  39    */
  40   public function __construct() {
  41     parent::__construct();
  42   }
  43
  44   /**
  45    * Queue a new recipient.
  46    *
  47    * @param array $params
  48    *   Values of the new EventQueue.
  49    *
  50    * @return CRM_Mailing_Event_BAO_Queue
  51    *   The new EventQueue
  52    */
  53   public static function create($params) {
  54     $eq = new CRM_Mailing_Event_BAO_Queue();
  55     $eq->copyValues($params);
  56     if (empty($params['id']) && empty($params['hash'])) {
  57       $eq->hash = self::hash($params);
  58     }
  59     $eq->save();
  60     return $eq;
  61   }
  62
  63   /**
  64    * Create a security hash from the job, email and contact ids
  65    *
  66    * @return int
  67    *   The hash
  68    */
  69   public static function hash($params) {
  70     $jobId = $params['job_id'];
  71     $emailId = CRM_Utils_Array::value('email_id', $params, '');
  72     $contactId = $params['contact_id'];
  73
  74     return substr(sha1("{$jobId}:{$emailId}:{$contactId}:" . time()),
  75       0, 16
  76     );
  77   }
  78
  79   /**
  80    * Verify that a queue event exists with the specified id/job id/hash
  81    *
  82    * @param int $job_id
  83    *   The job ID of the event to find.
  84    * @param int $queue_id
  85    *   The Queue Event ID to find.
  86    * @param string $hash
  87    *   The hash to validate against.
  88    *
  89    * @return object|null
  90    *   The queue event if verified, or null
  91    */
  92   public static function &verify($job_id, $queue_id, $hash) {
  93     $success = NULL;
  94     $q = new CRM_Mailing_Event_BAO_Queue();
  95     if (!empty($job_id) && !empty($queue_id) && !empty($hash)) {
  96       $q->id = $queue_id;
  97       $q->job_id = $job_id;
  98       $q->hash = $hash;
  99       if ($q->find(TRUE)) {
 100         $success = $q;
 101       }
 102     }
 103     return $success;
 104   }
 105
 106   /**
 107    * Given a queue event ID, find the corresponding email address.
 108    *
 109    * @param int $queue_id
 110    *   The queue event ID.
 111    *
 112    * @return string
 113    *   The email address
 114    */
 115   public static function getEmailAddress($queue_id) {
 116     $email = CRM_Core_BAO_Email::getTableName();
 117     $eq = self::getTableName();
 118     $query = "  SELECT      $email.email as email
 119                     FROM        $email
 120                     INNER JOIN  $eq
 121                     ON          $eq.email_id = $email.id
 122                     WHERE       $eq.id = " . CRM_Utils_Type::rule($queue_id, 'Integer');
 123
 124     $q = new CRM_Mailing_Event_BAO_Queue();
 125     $q->query($query);
 126     if (!$q->fetch()) {
 127       return NULL;
 128     }
 129
 130     return $q->email;
 131   }
 132
 133   /**
 134    * Count up events given a mailing id and optional job id.
 135    *
 136    * @param int $mailing_id
 137    *   ID of the mailing to count.
 138    * @param int $job_id
 139    *   Optional ID of a job to limit results.
 140    *
 141    * @return int
 142    *   Number of matching events
 143    */
 144   public static function getTotalCount($mailing_id, $job_id = NULL) {
 145     $dao = new CRM_Core_DAO();
 146
 147     $queue = self::getTableName();
 148     $mailing = CRM_Mailing_BAO_Mailing::getTableName();
 149     $job = CRM_Mailing_BAO_MailingJob::getTableName();
 150
 151     $dao->query("
 152             SELECT      COUNT(*) as queued
 153             FROM        $queue
 154             INNER JOIN  $job
 155                     ON  $queue.job_id = $job.id
 156             INNER JOIN  $mailing
 157                     ON  $job.mailing_id = $mailing.id
 158                     AND $job.is_test = 0
 159             WHERE       $mailing.id = " . CRM_Utils_Type::escape($mailing_id, 'Integer') . ($job_id ? " AND $job.id = " . CRM_Utils_Type::escape($job_id,
 160           'Integer'
 161         ) : '')
 162     );
 163
 164     $dao->fetch();
 165     return $dao->queued;
 166   }
 167
 168   /**
 169    * Get rows for the event browser.
 170    *
 171    * @param int $mailing_id
 172    *   ID of the mailing.
 173    * @param int $job_id
 174    *   Optional ID of the job.
 175    * @param int $offset
 176    *   Offset.
 177    * @param int $rowCount
 178    *   Number of rows.
 179    * @param array $sort
 180    *   Sort array.
 181    *
 182    * @return array
 183    *   Result set
 184    */
 185   public static function &getRows(
 186     $mailing_id, $job_id = NULL, $offset = NULL,
 187     $rowCount = NULL, $sort = NULL
 188   ) {
 189     $dao = new CRM_Core_Dao();
 190
 191     $queue = self::getTableName();
 192     $mailing = CRM_Mailing_BAO_Mailing::getTableName();
 193     $job = CRM_Mailing_BAO_MailingJob::getTableName();
 194     $contact = CRM_Contact_BAO_Contact::getTableName();
 195     $email = CRM_Core_BAO_Email::getTableName();
 196
 197     $orderBy = "sort_name ASC, {$job}.start_date DESC";
 198     if ($sort) {
 199       if (is_string($sort)) {
 200         $sort = CRM_Utils_Type::escape($sort, 'String');
 201         $orderBy = $sort;
 202       }
 203       else {
 204         $orderBy = trim($sort->orderBy());
 205       }
 206     }
 207
 208     $query = "
 209             SELECT      $contact.display_name as display_name,
 210                         $contact.id as contact_id,
 211                         $email.email as email,
 212                         $job.start_date as date
 213             FROM        $contact
 214             INNER JOIN  $queue
 215                     ON  $queue.contact_id = $contact.id
 216             INNER JOIN  $email
 217                     ON  $queue.email_id = $email.id
 218             INNER JOIN  $job
 219                     ON  $queue.job_id = $job.id
 220             INNER JOIN  $mailing
 221                     ON  $job.mailing_id = $mailing.id
 222                     AND $job.is_test = 0
 223             WHERE       $mailing.id = " . CRM_Utils_Type::escape($mailing_id, 'Integer');
 224
 225     if (!empty($job_id)) {
 226       $query .= " AND $job.id = " . CRM_Utils_Type::escape($job_id, 'Integer');
 227     }
 228
 229     $query .= " ORDER BY {$orderBy} ";
 230
 231     if ($offset || $rowCount) {
 232       //Added "||$rowCount" to avoid displaying all records on first page
 233       $query .= ' LIMIT ' . CRM_Utils_Type::escape($offset, 'Integer') . ', ' . CRM_Utils_Type::escape($rowCount, 'Integer');
 234     }
 235
 236     $dao->query($query);
 237
 238     $results = array();
 239
 240     while ($dao->fetch()) {
 241       $url = CRM_Utils_System::url('civicrm/contact/view',
 242         "reset=1&cid={$dao->contact_id}"
 243       );
 244       $results[] = array(
 245         'name' => "<a href=\"$url\">{$dao->display_name}</a>",
 246         'email' => $dao->email,
 247         'date' => CRM_Utils_Date::customFormat($dao->date),
 248       );
 249     }
 250     return $results;
 251   }
 252
 253   /**
 254    * Get the mailing object for this queue event instance.
 255    *
 256    * @param
 257    *
 258    * @return object
 259    *   Mailing BAO
 260    */
 261   public function &getMailing() {
 262     $mailing = new CRM_Mailing_BAO_Mailing();
 263     $jobs = CRM_Mailing_BAO_MailingJob::getTableName();
 264     $mailings = CRM_Mailing_BAO_Mailing::getTableName();
 265     $queue = self::getTableName();
 266
 267     $mailing->query("
 268                 SELECT      $mailings.*
 269                 FROM        $mailings
 270                 INNER JOIN  $jobs
 271                         ON  $jobs.mailing_id = $mailings.id
 272                 INNER JOIN  $queue
 273                         ON  $queue.job_id = $jobs.id
 274                 WHERE       $queue.id = {$this->id}");
 275     $mailing->fetch();
 276     return $mailing;
 277   }
 278
 279   /**
 280    * @param int $queueID
 281    *
 282    * @return array
 283    */
 284   public static function getContactInfo($queueID) {
 285     $query = "
 286 SELECT DISTINCT(civicrm_mailing_event_queue.contact_id) as contact_id,
 287        civicrm_contact.display_name as display_name,
 288        civicrm_email.email as email
 289   FROM civicrm_mailing_event_queue,
 290        civicrm_contact,
 291        civicrm_email
 292  WHERE civicrm_mailing_event_queue.contact_id = civicrm_contact.id
 293    AND civicrm_mailing_event_queue.email_id = civicrm_email.id
 294    AND civicrm_mailing_event_queue.id = " . CRM_Utils_Type::escape($queueID, 'Integer');
 295
 296     $dao = CRM_Core_DAO::executeQuery($query, CRM_Core_DAO::$_nullArray);
 297
 298     $displayName = 'Unknown';
 299     $email = 'Unknown';
 300     if ($dao->fetch()) {
 301       $displayName = $dao->display_name;
 302       $email = $dao->email;
 303     }
 304
 305     return array($displayName, $email);
 306   }
 307
 308   /**
 309    * @param array $params
 310    * @param null $now
 311    */
 312   public static function bulkCreate($params, $now = NULL) {
 313     if (!$now) {
 314       $now = time();
 315     }
 316
 317     // construct a bulk insert statement
 318     $values = array();
 319     foreach ($params as $param) {
 320       $values[] = "( {$param[0]}, {$param[1]}, {$param[2]}, {$param[3]}, '" . substr(sha1("{$param[0]}:{$param[1]}:{$param[2]}:{$param[3]}:{$now}"),
 321           0, 16
 322         ) . "' )";
 323     }
 324
 325     while (!empty($values)) {
 326       $input = array_splice($values, 0, CRM_Core_DAO::BULK_INSERT_COUNT);
 327       $str = implode(',', $input);
 328       $sql = "INSERT INTO civicrm_mailing_event_queue ( job_id, email_id, contact_id, phone_id, hash ) VALUES $str;";
 329       CRM_Core_DAO::executeQuery($sql);
 330     }
 331   }
 332
 333 }