3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2016
35 class CRM_Report_Form_Mailing_Summary
extends CRM_Report_Form
{
37 protected $_summary = NULL;
39 protected $_customGroupExtends = array();
41 protected $_add2groupSupported = FALSE;
43 public $_drilldownReport = array('mailing/detail' => 'Link to Detail Report');
45 protected $_charts = array(
47 'bar_3dChart' => 'Bar Chart',
50 public $campaignEnabled = FALSE;
56 public function __construct() {
57 $this->_columns
= array();
59 $this->_columns
['civicrm_mailing'] = array(
60 'dao' => 'CRM_Mailing_DAO_Mailing',
64 'title' => ts('Mailing ID'),
69 'title' => ts('Mailing Name'),
72 'created_date' => array(
73 'title' => ts('Date Created'),
76 'title' => ts('Subject'),
80 'is_completed' => array(
81 'title' => ts('Mailing Status'),
82 'operatorType' => CRM_Report_Form
::OP_SELECT
,
83 'type' => CRM_Utils_Type
::T_INT
,
88 //'operator' => 'like',
91 'mailing_name' => array(
93 'title' => ts('Mailing'),
94 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
95 'type' => CRM_Utils_Type
::T_STRING
,
96 'options' => self
::mailing_select(),
102 $this->_columns
['civicrm_mailing_job'] = array(
103 'dao' => 'CRM_Mailing_DAO_MailingJob',
105 'start_date' => array(
106 'title' => ts('Start Date'),
109 'title' => ts('End Date'),
114 'type' => CRM_Utils_Type
::T_STRING
,
115 'default' => 'Complete',
116 'no_display' => TRUE,
119 'type' => CRM_Utils_Type
::T_INT
,
121 'no_display' => TRUE,
123 'start_date' => array(
124 'title' => ts('Start Date'),
125 'default' => 'this.year',
126 'operatorType' => CRM_Report_Form
::OP_DATE
,
127 'type' => CRM_Utils_Type
::T_DATE
,
130 'title' => ts('End Date'),
131 'default' => 'this.year',
132 'operatorType' => CRM_Report_Form
::OP_DATE
,
133 'type' => CRM_Utils_Type
::T_DATE
,
138 $this->_columns
['civicrm_mailing_event_queue'] = array(
139 'dao' => 'CRM_Mailing_DAO_Mailing',
141 'queue_count' => array(
143 'title' => ts('Intended Recipients'),
148 $this->_columns
['civicrm_mailing_event_delivered'] = array(
149 'dao' => 'CRM_Mailing_DAO_Mailing',
151 'delivered_count' => array(
152 'name' => 'event_queue_id',
153 'title' => ts('Delivered'),
155 'accepted_rate' => array(
156 'title' => 'Accepted Rate',
157 'statistics' => array(
158 'calc' => 'PERCENTAGE',
159 'top' => 'civicrm_mailing_event_delivered.delivered_count',
160 'base' => 'civicrm_mailing_event_queue.queue_count',
166 $this->_columns
['civicrm_mailing_event_bounce'] = array(
167 'dao' => 'CRM_Mailing_DAO_Mailing',
169 'bounce_count' => array(
170 'name' => 'event_queue_id',
171 'title' => ts('Bounce'),
173 'bounce_rate' => array(
174 'title' => 'Bounce Rate',
175 'statistics' => array(
176 'calc' => 'PERCENTAGE',
177 'top' => 'civicrm_mailing_event_bounce.bounce_count',
178 'base' => 'civicrm_mailing_event_queue.queue_count',
184 $this->_columns
['civicrm_mailing_event_opened'] = array(
185 'dao' => 'CRM_Mailing_DAO_Mailing',
187 'unique_open_count' => array(
189 'alias' => 'mailing_event_opened_civireport',
190 'dbAlias' => 'mailing_event_opened_civireport.event_queue_id',
191 'title' => ts('Unique Opens'),
193 'unique_open_rate' => array(
194 'title' => 'Unique Open Rate',
195 'statistics' => array(
196 'calc' => 'PERCENTAGE',
197 'top' => 'civicrm_mailing_event_opened.unique_open_count',
198 'base' => 'civicrm_mailing_event_delivered.delivered_count',
201 'open_count' => array(
202 'name' => 'event_queue_id',
203 'title' => ts('Total Opens'),
205 'open_rate' => array(
206 'title' => 'Total Open Rate',
207 'statistics' => array(
208 'calc' => 'PERCENTAGE',
209 'top' => 'civicrm_mailing_event_opened.open_count',
210 'base' => 'civicrm_mailing_event_delivered.delivered_count',
216 $this->_columns
['civicrm_mailing_event_trackable_url_open'] = array(
217 'dao' => 'CRM_Mailing_DAO_Mailing',
219 'click_count' => array(
220 'name' => 'event_queue_id',
221 'title' => ts('Clicks'),
224 'title' => 'Click through Rate',
226 'statistics' => array(
227 'calc' => 'PERCENTAGE',
228 'top' => 'civicrm_mailing_event_trackable_url_open.click_count',
229 'base' => 'civicrm_mailing_event_delivered.delivered_count',
233 'title' => 'Click to Open Rate',
235 'statistics' => array(
236 'calc' => 'PERCENTAGE',
237 'top' => 'civicrm_mailing_event_trackable_url_open.click_count',
238 'base' => 'civicrm_mailing_event_opened.open_count',
244 $this->_columns
['civicrm_mailing_event_unsubscribe'] = array(
245 'dao' => 'CRM_Mailing_DAO_Mailing',
247 'unsubscribe_count' => array(
249 'title' => ts('Unsubscribe'),
250 'alias' => 'mailing_event_unsubscribe_civireport',
251 'dbAlias' => 'mailing_event_unsubscribe_civireport.event_queue_id',
253 'optout_count' => array(
255 'title' => ts('Opt-outs'),
256 'alias' => 'mailing_event_optout_civireport',
257 'dbAlias' => 'mailing_event_optout_civireport.event_queue_id',
261 $this->_columns
['civicrm_mailing_group'] = array(
262 'dao' => 'CRM_Mailing_DAO_MailingGroup',
264 'entity_id' => array(
265 'title' => ts('Groups Included in Mailing'),
266 'operatorType' => CRM_Report_Form
::OP_MULTISELECT
,
267 'type' => CRM_Utils_Type
::T_INT
,
268 'options' => CRM_Core_PseudoConstant
::group(),
272 $config = CRM_Core_Config
::singleton();
273 $this->campaignEnabled
= in_array("CiviCampaign", $config->enableComponents
);
274 if ($this->campaignEnabled
) {
275 $this->_columns
['civicrm_campaign'] = array(
276 'dao' => 'CRM_Campaign_DAO_Campaign',
279 'title' => ts('Campaign Name'),
284 'type' => CRM_Utils_Type
::T_STRING
,
289 parent
::__construct();
295 public function mailing_select() {
299 $mailing = new CRM_Mailing_BAO_Mailing();
300 $query = "SELECT name FROM civicrm_mailing WHERE sms_provider_id IS NULL";
301 $mailing->query($query);
303 while ($mailing->fetch()) {
304 $data[mysql_real_escape_string($mailing->name
)] = $mailing->name
;
310 public function preProcess() {
311 $this->assign('chartSupported', TRUE);
312 parent
::preProcess();
316 * manipulate the select function to query count functions.
318 public function select() {
320 $count_tables = array(
321 'civicrm_mailing_event_queue',
322 'civicrm_mailing_event_delivered',
323 'civicrm_mailing_event_opened',
324 'civicrm_mailing_event_bounce',
325 'civicrm_mailing_event_trackable_url_open',
326 'civicrm_mailing_event_unsubscribe',
330 $this->_columnHeaders
= array();
331 foreach ($this->_columns
as $tableName => $table) {
332 if (array_key_exists('fields', $table)) {
333 foreach ($table['fields'] as $fieldName => $field) {
334 if (!empty($field['required']) ||
!empty($this->_params
['fields'][$fieldName])) {
337 if (!empty($field['statistics'])) {
338 switch ($field['statistics']['calc']) {
340 $base_table_column = explode('.', $field['statistics']['base']);
341 $top_table_column = explode('.', $field['statistics']['top']);
343 $select[] = "CONCAT(round(
344 count(DISTINCT {$this->_columns[$top_table_column[0]]['fields'][$top_table_column[1]]['dbAlias']}) /
345 count(DISTINCT {$this->_columns[$base_table_column[0]]['fields'][$base_table_column[1]]['dbAlias']}) * 100, 2
346 ), '%') as {$tableName}_{$fieldName}";
351 if (in_array($tableName, $count_tables)) {
352 $select[] = "count(DISTINCT {$field['dbAlias']}) as {$tableName}_{$fieldName}";
355 $select[] = "{$field['dbAlias']} as {$tableName}_{$fieldName}";
358 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['type'] = CRM_Utils_Array
::value('type', $field);
359 $this->_columnHeaders
["{$tableName}_{$fieldName}"]['title'] = $field['title'];
365 $this->_select
= "SELECT " . implode(', ', $select) . " ";
366 //print_r($this->_select);
369 public function from() {
372 FROM civicrm_mailing {$this->_aliases['civicrm_mailing']}
373 LEFT JOIN civicrm_mailing_job {$this->_aliases['civicrm_mailing_job']}
374 ON {$this->_aliases['civicrm_mailing']}.id = {$this->_aliases['civicrm_mailing_job']}.mailing_id
375 LEFT JOIN civicrm_mailing_event_queue {$this->_aliases['civicrm_mailing_event_queue']}
376 ON {$this->_aliases['civicrm_mailing_event_queue']}.job_id = {$this->_aliases['civicrm_mailing_job']}.id
377 LEFT JOIN civicrm_mailing_event_bounce {$this->_aliases['civicrm_mailing_event_bounce']}
378 ON {$this->_aliases['civicrm_mailing_event_bounce']}.event_queue_id = {$this->_aliases['civicrm_mailing_event_queue']}.id
379 LEFT JOIN civicrm_mailing_event_delivered {$this->_aliases['civicrm_mailing_event_delivered']}
380 ON {$this->_aliases['civicrm_mailing_event_delivered']}.event_queue_id = {$this->_aliases['civicrm_mailing_event_queue']}.id
381 AND {$this->_aliases['civicrm_mailing_event_bounce']}.id IS null
382 LEFT JOIN civicrm_mailing_event_opened {$this->_aliases['civicrm_mailing_event_opened']}
383 ON {$this->_aliases['civicrm_mailing_event_opened']}.event_queue_id = {$this->_aliases['civicrm_mailing_event_queue']}.id
384 LEFT JOIN civicrm_mailing_event_trackable_url_open {$this->_aliases['civicrm_mailing_event_trackable_url_open']}
385 ON {$this->_aliases['civicrm_mailing_event_trackable_url_open']}.event_queue_id = {$this->_aliases['civicrm_mailing_event_queue']}.id
386 LEFT JOIN civicrm_mailing_event_unsubscribe {$this->_aliases['civicrm_mailing_event_unsubscribe']}
387 ON {$this->_aliases['civicrm_mailing_event_unsubscribe']}.event_queue_id = {$this->_aliases['civicrm_mailing_event_queue']}.id AND {$this->_aliases['civicrm_mailing_event_unsubscribe']}.org_unsubscribe = 0
388 LEFT JOIN civicrm_mailing_event_unsubscribe mailing_event_optout_civireport
389 ON mailing_event_optout_civireport.event_queue_id = {$this->_aliases['civicrm_mailing_event_queue']}.id AND mailing_event_optout_civireport.org_unsubscribe = 1";
391 if ($this->isTableSelected('civicrm_mailing_group')) {
393 LEFT JOIN civicrm_mailing_group {$this->_aliases['civicrm_mailing_group']}
394 ON {$this->_aliases['civicrm_mailing_group']}.mailing_id = {$this->_aliases['civicrm_mailing']}.id";
396 if ($this->campaignEnabled
) {
398 LEFT JOIN civicrm_campaign {$this->_aliases['civicrm_campaign']}
399 ON {$this->_aliases['civicrm_campaign']}.id = {$this->_aliases['civicrm_mailing']}.campaign_id";
402 // need group by and order by
404 //print_r($this->_from);
407 public function where() {
409 //to avoid the sms listings
410 $clauses[] = "{$this->_aliases['civicrm_mailing']}.sms_provider_id IS NULL";
412 foreach ($this->_columns
as $tableName => $table) {
413 if (array_key_exists('filters', $table)) {
414 foreach ($table['filters'] as $fieldName => $field) {
416 if (CRM_Utils_Array
::value('type', $field) & CRM_Utils_Type
::T_DATE
) {
417 $relative = CRM_Utils_Array
::value("{$fieldName}_relative", $this->_params
);
418 $from = CRM_Utils_Array
::value("{$fieldName}_from", $this->_params
);
419 $to = CRM_Utils_Array
::value("{$fieldName}_to", $this->_params
);
421 $clause = $this->dateClause($this->_aliases
[$tableName] . '.' . $field['name'], $relative, $from, $to, $field['type']);
424 $op = CRM_Utils_Array
::value("{$fieldName}_op", $this->_params
);
427 if ($fieldName == 'relationship_type_id') {
428 $clause = "{$this->_aliases['civicrm_relationship']}.relationship_type_id=" . $this->relationshipId
;
431 $clause = $this->whereClause($field,
433 CRM_Utils_Array
::value("{$fieldName}_value", $this->_params
),
434 CRM_Utils_Array
::value("{$fieldName}_min", $this->_params
),
435 CRM_Utils_Array
::value("{$fieldName}_max", $this->_params
)
441 if (!empty($clause)) {
442 $clauses[] = $clause;
448 if (empty($clauses)) {
449 $this->_where
= "WHERE ( 1 )";
452 $this->_where
= "WHERE " . implode(' AND ', $clauses);
455 // if ( $this->_aclWhere ) {
456 // $this->_where .= " AND {$this->_aclWhere} ";
460 public function groupBy() {
461 $this->_groupBy
= "GROUP BY {$this->_aliases['civicrm_mailing']}.id";
464 public function orderBy() {
465 $this->_orderBy
= " ORDER BY {$this->_aliases['civicrm_mailing_job']}.end_date DESC ";
468 public function postProcess() {
470 $this->beginPostProcess();
472 // get the acl clauses built before we assemble the query
473 $this->buildACLClause(CRM_Utils_Array
::value('civicrm_contact', $this->_aliases
));
475 $sql = $this->buildQuery(TRUE);
479 $rows = $graphRows = array();
480 $this->buildRows($sql, $rows);
482 $this->formatDisplay($rows);
483 $this->doTemplateAssignment($rows);
484 $this->endPostProcess($rows);
490 public static function getChartCriteria() {
493 'civicrm_mailing_event_delivered_delivered_count' => ts('Delivered'),
494 'civicrm_mailing_event_bounce_bounce_count' => ts('Bounce'),
495 'civicrm_mailing_event_opened_open_count' => ts('Total Opens'),
496 'civicrm_mailing_event_opened_unique_open_count' => ts('Unique Opens'),
497 'civicrm_mailing_event_trackable_url_open_click_count' => ts('Clicks'),
498 'civicrm_mailing_event_unsubscribe_unsubscribe_count' => ts('Unsubscribe'),
501 'civicrm_mailing_event_delivered_accepted_rate' => ts('Accepted Rate'),
502 'civicrm_mailing_event_bounce_bounce_rate' => ts('Bounce Rate'),
503 'civicrm_mailing_event_opened_open_rate' => ts('Total Open Rate'),
504 'civicrm_mailing_event_opened_unique_open_rate' => ts('Unique Open Rate'),
505 'civicrm_mailing_event_trackable_url_open_CTR' => ts('Click through Rate'),
506 'civicrm_mailing_event_trackable_url_open_CTO' => ts('Click to Open Rate'),
518 public static function formRule($fields, $files, $self) {
521 if (empty($fields['charts'])) {
525 $criteria = self
::getChartCriteria();
527 foreach ($fields['fields'] as $fld => $isActive) {
528 if (in_array($fld, array(
547 $errors['_qf_default'] = ts('For Chart view, please select at least one field from %1 OR %2.', array(
548 1 => implode(', ', $criteria['count']),
549 2 => implode(', ', $criteria['rate']),
559 public function buildChart(&$rows) {
564 $criteria = self
::getChartCriteria();
567 'legend' => ts('Mail Summary'),
568 'xname' => ts('Mailing'),
569 'yname' => ts('Statistics'),
574 $plotRate = $plotCount = TRUE;
575 foreach ($rows as $row) {
576 $chartInfo['values'][$row['civicrm_mailing_name']] = array();
578 foreach ($criteria['count'] as $criteria => $label) {
579 if (isset($row[$criteria])) {
580 $chartInfo['values'][$row['civicrm_mailing_name']][$label] = $row[$criteria];
581 $chartInfo['tip'][$label] = "{$label} #val#";
584 elseif (isset($criteria['count'][$criteria])) {
585 unset($criteria['count'][$criteria]);
590 foreach ($criteria['rate'] as $criteria => $label) {
591 if (isset($row[$criteria])) {
592 $chartInfo['values'][$row['civicrm_mailing_name']][$label] = $row[$criteria];
593 $chartInfo['tip'][$label] = "{$label} #val#";
596 elseif (isset($criteria['rate'][$criteria])) {
597 unset($criteria['rate'][$criteria]);
604 $criteria = $criteria['count'];
607 $criteria = $criteria['rate'];
610 $chartInfo['criteria'] = array_values($criteria);
612 // dynamically set the graph size
613 $chartInfo['xSize'] = ((count($rows) * 125) +
(count($rows) * count($criteria) * 40));
616 CRM_Utils_OpenFlashChart
::buildChart($chartInfo, $this->_params
['charts']);
617 $this->assign('chartType', $this->_params
['charts']);
621 * Alter display of rows.
623 * Iterate through the rows retrieved via SQL and make changes for display purposes,
624 * such as rendering contacts as links.
627 * Rows generated by SQL, with an array for each row.
629 public function alterDisplay(&$rows) {
631 foreach ($rows as $rowNum => $row) {
633 if (array_key_exists('civicrm_mailing_name', $row) &&
634 array_key_exists('civicrm_mailing_id', $row)
636 $rows[$rowNum]['civicrm_mailing_name_link'] = CRM_Report_Utils_Report
::getNextUrl('mailing/detail',
637 'reset=1&force=1&mailing_id_op=eq&mailing_id_value=' . $row['civicrm_mailing_id'],
638 $this->_absoluteUrl
, $this->_id
, $this->_drilldownReport
640 $rows[$rowNum]['civicrm_mailing_name_hover'] = ts('View Mailing details for this mailing');
643 // skip looking further in rows, if first row itself doesn't
644 // have the column we need