CRM/Mailing/Event/BAO/Opened.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_Opened extends CRM_Mailing_Event_DAO_Opened {
  36
  37   /**
  38    * Class constructor
  39    */
  40   public function __construct() {
  41     parent::__construct();
  42   }
  43
  44   /**
  45    * Register an open event
  46    *
  47    * @param int $queue_id
  48    *   The Queue Event ID of the recipient.
  49    *
  50    * @return void
  51    * @static
  52    */
  53   public static function open($queue_id) {
  54     /* First make sure there's a matching queue event */
  55
  56     $success = FALSE;
  57
  58     $q = new CRM_Mailing_Event_BAO_Queue();
  59     $q->id = $queue_id;
  60     if ($q->find(TRUE)) {
  61       $oe                 = new CRM_Mailing_Event_BAO_Opened();
  62       $oe->event_queue_id = $queue_id;
  63       $oe->time_stamp     = date('YmdHis');
  64       $oe->save();
  65       $success = TRUE;
  66     }
  67
  68     return $success;
  69   }
  70
  71   /**
  72    * Get row count for the event selector
  73    *
  74    * @param int $mailing_id
  75    *   ID of the mailing.
  76    * @param int $job_id
  77    *   Optional ID of a job to filter on.
  78    * @param bool $is_distinct
  79    *   Group by queue ID?.
  80    *
  81    * @return int                  Number of rows in result set
  82    * @static
  83    */
  84   public static function getTotalCount($mailing_id,
  85     $job_id = NULL,
  86     $is_distinct = FALSE,
  87     $toDate = NULL
  88   ) {
  89     $dao = new CRM_Core_DAO();
  90
  91     $open    = self::getTableName();
  92     $queue   = CRM_Mailing_Event_BAO_Queue::getTableName();
  93     $mailing = CRM_Mailing_BAO_Mailing::getTableName();
  94     $job     = CRM_Mailing_BAO_MailingJob::getTableName();
  95
  96     $query = "
  97             SELECT      COUNT($open.id) as opened
  98             FROM        $open
  99             INNER JOIN  $queue
 100                     ON  $open.event_queue_id = $queue.id
 101             INNER JOIN  $job
 102                     ON  $queue.job_id = $job.id
 103             INNER JOIN  $mailing
 104                     ON  $job.mailing_id = $mailing.id
 105                     AND $job.is_test = 0
 106             WHERE       $mailing.id = " . CRM_Utils_Type::escape($mailing_id, 'Integer');
 107
 108     if (!empty($toDate)) {
 109       $query .= " AND $open.time_stamp <= $toDate";
 110     }
 111
 112     if (!empty($job_id)) {
 113       $query .= " AND $job.id = " . CRM_Utils_Type::escape($job_id, 'Integer');
 114     }
 115
 116     if ($is_distinct) {
 117       $query .= " GROUP BY $queue.id ";
 118     }
 119
 120     $dao->query($query);
 121     $dao->fetch();
 122     if ($is_distinct) {
 123       return $dao->N;
 124     }
 125     else {
 126       return $dao->opened ? $dao->opened : 0;
 127     }
 128   }
 129
 130   /**
 131    * CRM-12814
 132    * Get opened count for each mailing for a given set of mailing IDs
 133    *
 134    * @param $mailingIDs
 135    *
 136    * @return array          Opened count per mailing ID
 137    * @static
 138    */
 139   public static function getMailingTotalCount($mailingIDs) {
 140     $dao = new CRM_Core_DAO();
 141     $openedCount = array();
 142
 143     $open    = self::getTableName();
 144     $queue   = CRM_Mailing_Event_BAO_Queue::getTableName();
 145     $job     = CRM_Mailing_BAO_MailingJob::getTableName();
 146     $mailingIDs = implode(',', $mailingIDs);
 147
 148     $query = "
 149       SELECT $job.mailing_id as mailingID, COUNT($open.id) as opened
 150       FROM $open
 151       INNER JOIN $queue
 152         ON  $open.event_queue_id = $queue.id
 153       INNER JOIN $job
 154         ON  $queue.job_id = $job.id
 155         AND $job.is_test = 0
 156       WHERE $job.mailing_id IN ({$mailingIDs})
 157       GROUP BY civicrm_mailing_job.mailing_id
 158     ";
 159
 160     $dao->query($query);
 161
 162     while ( $dao->fetch() ) {
 163       $openedCount[$dao->mailingID] = $dao->opened;
 164     }
 165     return $openedCount;
 166   }
 167
 168   /**
 169    * Get opened count for each mailing for a given set of mailing IDs and a specific contact
 170    *
 171    * @param int $mailingIDs
 172    *   IDs of the mailing (comma separated).
 173    * @param int $contactID
 174    *   ID of the contact.
 175    *
 176    * @return array            Count per mailing ID
 177    * @static
 178    */
 179   public static function getMailingContactCount($mailingIDs, $contactID) {
 180     $dao = new CRM_Core_DAO();
 181     $openedCount = array();
 182
 183     $open = self::getTableName();
 184     $queue = CRM_Mailing_Event_BAO_Queue::getTableName();
 185     $job = CRM_Mailing_BAO_MailingJob::getTableName();
 186     $mailingIDs = implode(',', $mailingIDs);
 187
 188     $query = "
 189       SELECT $job.mailing_id as mailingID, COUNT($open.id) as opened
 190       FROM $open
 191       INNER JOIN $queue
 192         ON  $open.event_queue_id = $queue.id
 193         AND $queue.contact_id = $contactID
 194       INNER JOIN $job
 195         ON  $queue.job_id = $job.id
 196         AND $job.is_test = 0
 197       WHERE $job.mailing_id IN ({$mailingIDs})
 198       GROUP BY civicrm_mailing_job.mailing_id
 199     ";
 200
 201     $dao->query($query);
 202
 203     while ( $dao->fetch() ) {
 204       $openedCount[$dao->mailingID] = $dao->opened;
 205     }
 206
 207     return $openedCount;
 208   }
 209
 210   /**
 211    * Get rows for the event browser
 212    *
 213    * @param int $mailing_id
 214    *   ID of the mailing.
 215    * @param int $job_id
 216    *   Optional ID of the job.
 217    * @param bool $is_distinct
 218    *   Group by queue id?.
 219    * @param int $offset
 220    *   Offset.
 221    * @param int $rowCount
 222    *   Number of rows.
 223    * @param array $sort
 224    *   Sort array.
 225    *
 226    * @param int $contact_id
 227    *
 228    * @return array                Result set
 229    * @static
 230    */
 231   public static function &getRows($mailing_id, $job_id = NULL,
 232     $is_distinct = FALSE, $offset = NULL, $rowCount = NULL, $sort = NULL, $contact_id= NULL
 233   ) {
 234     $dao = new CRM_Core_Dao();
 235
 236     $open    = self::getTableName();
 237     $queue   = CRM_Mailing_Event_BAO_Queue::getTableName();
 238     $mailing = CRM_Mailing_BAO_Mailing::getTableName();
 239     $job     = CRM_Mailing_BAO_MailingJob::getTableName();
 240     $contact = CRM_Contact_BAO_Contact::getTableName();
 241     $email   = CRM_Core_BAO_Email::getTableName();
 242
 243     $query = "
 244             SELECT      $contact.display_name as display_name,
 245                         $contact.id as contact_id,
 246                         $email.email as email,
 247                         $open.time_stamp as date
 248             FROM        $contact
 249             INNER JOIN  $queue
 250                     ON  $queue.contact_id = $contact.id
 251             INNER JOIN  $email
 252                     ON  $queue.email_id = $email.id
 253             INNER JOIN  $open
 254                     ON  $open.event_queue_id = $queue.id
 255             INNER JOIN  $job
 256                     ON  $queue.job_id = $job.id
 257             INNER JOIN  $mailing
 258                     ON  $job.mailing_id = $mailing.id
 259                     AND $job.is_test = 0
 260             WHERE       $mailing.id = " . CRM_Utils_Type::escape($mailing_id, 'Integer');
 261
 262     if (!empty($job_id)) {
 263       $query .= " AND $job.id = " . CRM_Utils_Type::escape($job_id, 'Integer');
 264     }
 265
 266     if (!empty($contact_id)) {
 267       $query .= " AND $contact.id = " . CRM_Utils_Type::escape($contact_id, 'Integer');
 268     }
 269
 270     if ($is_distinct) {
 271       $query .= " GROUP BY $queue.id ";
 272     }
 273
 274     $orderBy = "sort_name ASC, {$open}.time_stamp DESC";
 275     if ($sort) {
 276       if (is_string($sort)) {
 277         $sort = CRM_Utils_Type::escape($sort, 'String');
 278         $orderBy = $sort;
 279       }
 280       else {
 281         $orderBy = trim($sort->orderBy());
 282       }
 283     }
 284
 285     $query .= " ORDER BY {$orderBy} ";
 286
 287     if ($offset || $rowCount) {
 288       //Added "||$rowCount" to avoid displaying all records on first page
 289       $query .= ' LIMIT ' . CRM_Utils_Type::escape($offset, 'Integer') . ', ' . CRM_Utils_Type::escape($rowCount, 'Integer');
 290     }
 291     $dao->query($query);
 292
 293     $results = array();
 294
 295     while ($dao->fetch()) {
 296       $url = CRM_Utils_System::url('civicrm/contact/view',
 297         "reset=1&cid={$dao->contact_id}"
 298       );
 299       $results[] = array(
 300         'name' => "<a href=\"$url\">{$dao->display_name}</a>",
 301         'email' => $dao->email,
 302         'date' => CRM_Utils_Date::customFormat($dao->date),
 303       );
 304     }
 305     return $results;
 306   }
 307 }