3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.6 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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-2015
35 require_once 'Mail/mime.php';
38 * Class CRM_Mailing_BAO_Mailing
40 class CRM_Mailing_BAO_Mailing
extends CRM_Mailing_DAO_Mailing
{
43 * An array that holds the complete templates
44 * including any headers or footers that need to be prepended
45 * or appended to the body
47 private $preparedTemplates = NULL;
50 * An array that holds the complete templates
51 * including any headers or footers that need to be prepended
52 * or appended to the body
54 private $templates = NULL;
57 * An array that holds the tokens that are specifically found in our text and html bodies
59 private $tokens = NULL;
62 * An array that holds the tokens that are specifically found in our text and html bodies
64 private $flattenedTokens = NULL;
67 * The header associated with this mailing
69 private $header = NULL;
72 * The footer associated with this mailing
74 private $footer = NULL;
77 * The HTML content of the message
82 * The text content of the message
87 * Cached BAO for the domain
89 private $_domain = NULL;
94 public function __construct() {
95 parent
::__construct();
102 * @param int $mailing_id
106 public static function getRecipientsCount($job_id, $mailing_id = NULL) {
107 // need this for backward compatibility, so we can get count for old mailings
108 // please do not use this function if possible
109 $eq = self
::getRecipients($job_id, $mailing_id);
114 * note that $job_id is used only as a variable in the temp table construction
115 * and does not play a role in the queries generated
117 * (misnomer) a nonce value used to name temporary tables.
118 * @param int $mailing_id
119 * @param bool $storeRecipients
120 * @param bool $dedupeEmail
123 * @return CRM_Mailing_Event_BAO_Queue|string
125 public static function getRecipients(
128 $storeRecipients = FALSE,
129 $dedupeEmail = FALSE,
131 $mailingGroup = new CRM_Mailing_DAO_MailingGroup();
133 $mailing = CRM_Mailing_BAO_Mailing
::getTableName();
134 $job = CRM_Mailing_BAO_MailingJob
::getTableName();
135 $mg = CRM_Mailing_DAO_MailingGroup
::getTableName();
136 $eq = CRM_Mailing_Event_DAO_Queue
::getTableName();
138 $email = CRM_Core_DAO_Email
::getTableName();
139 if ($mode == 'sms') {
140 $phone = CRM_Core_DAO_Phone
::getTableName();
142 $contact = CRM_Contact_DAO_Contact
::getTableName();
144 $group = CRM_Contact_DAO_Group
::getTableName();
145 $g2contact = CRM_Contact_DAO_GroupContact
::getTableName();
147 $m = new CRM_Mailing_DAO_Mailing();
148 $m->id
= $mailing_id;
151 $email_selection_method = $m->email_selection_method
;
152 $location_type_id = $m->location_type_id
;
154 // Note: When determining the ORDER that results are returned, it's
155 // the record that comes last that counts. That's because we are
156 // INSERT'ing INTO a table with a primary id so that last record
157 // over writes any previous record.
158 switch ($email_selection_method) {
159 case 'location-exclude':
160 $location_filter = "($email.location_type_id != $location_type_id)";
161 // If there is more than one email that doesn't match the location,
162 // prefer the one marked is_bulkmail, followed by is_primary.
163 $order_by = "ORDER BY $email.is_bulkmail, $email.is_primary";
166 case 'location-only':
167 $location_filter = "($email.location_type_id = $location_type_id)";
168 // If there is more than one email of the desired location, prefer
169 // the one marked is_bulkmail, followed by is_primary.
170 $order_by = "ORDER BY $email.is_bulkmail, $email.is_primary";
173 case 'location-prefer':
174 $location_filter = "($email.is_bulkmail = 1 OR $email.is_primary = 1 OR $email.location_type_id = $location_type_id)";
176 // ORDER BY is more complicated because we have to set an arbitrary
177 // order that prefers the location that we want. We do that using
178 // the FIELD function. For more info, see:
179 // https://dev.mysql.com/doc/refman/5.5/en/string-functions.html#function_field
180 // We assign the location type we want the value "1" by putting it
181 // in the first position after we name the field. All other location
182 // types are left out, so they will be assigned the value 0. That
183 // means, they will all be equally tied for first place, with our
184 // location being last.
185 $order_by = "ORDER BY FIELD($email.location_type_id, $location_type_id), $email.is_bulkmail, $email.is_primary";
189 // fall through to default
191 $location_filter = "($email.is_bulkmail = 1 OR $email.is_primary = 1)";
192 $order_by = "ORDER BY $email.is_bulkmail";
195 /* Create a temp table for contact exclusion */
196 $mailingGroup->query(
197 "CREATE TEMPORARY TABLE X_$job_id
198 (contact_id int primary key)
202 /* Add all the members of groups excluded from this mailing to the temp
205 $excludeSubGroup = "INSERT INTO X_$job_id (contact_id)
206 SELECT DISTINCT $g2contact.contact_id
209 ON $g2contact.group_id = $mg.entity_id AND $mg.entity_table = '$group'
211 $mg.mailing_id = {$mailing_id}
212 AND $g2contact.status = 'Added'
213 AND $mg.group_type = 'Exclude'";
214 $mailingGroup->query($excludeSubGroup);
216 /* Add all unsubscribe members of base group from this mailing to the temp
219 $unSubscribeBaseGroup = "INSERT INTO X_$job_id (contact_id)
220 SELECT DISTINCT $g2contact.contact_id
223 ON $g2contact.group_id = $mg.entity_id AND $mg.entity_table = '$group'
225 $mg.mailing_id = {$mailing_id}
226 AND $g2contact.status = 'Removed'
227 AND $mg.group_type = 'Base'";
228 $mailingGroup->query($unSubscribeBaseGroup);
230 /* Add all the (intended) recipients of an excluded prior mailing to
233 $excludeSubMailing = "INSERT IGNORE INTO X_$job_id (contact_id)
234 SELECT DISTINCT $eq.contact_id
237 ON $eq.job_id = $job.id
239 ON $job.mailing_id = $mg.entity_id AND $mg.entity_table = '$mailing'
241 $mg.mailing_id = {$mailing_id}
242 AND $mg.group_type = 'Exclude'";
243 $mailingGroup->query($excludeSubMailing);
245 // get all the saved searches AND hierarchical groups
246 // and load them in the cache
248 SELECT $group.id, $group.cache_date, $group.saved_search_id, $group.children
250 INNER JOIN $mg ON $mg.entity_id = $group.id
251 WHERE $mg.entity_table = '$group'
252 AND $mg.group_type = 'Exclude'
253 AND $mg.mailing_id = {$mailing_id}
254 AND ( saved_search_id != 0
255 OR saved_search_id IS NOT NULL
256 OR children IS NOT NULL )
259 $groupDAO = CRM_Core_DAO
::executeQuery($sql);
260 while ($groupDAO->fetch()) {
261 if ($groupDAO->cache_date
== NULL) {
262 CRM_Contact_BAO_GroupContactCache
::load($groupDAO);
265 $smartGroupExclude = "
266 INSERT IGNORE INTO X_$job_id (contact_id)
268 FROM civicrm_group_contact_cache c
269 WHERE c.group_id = {$groupDAO->id}
271 $mailingGroup->query($smartGroupExclude);
274 $tempColumn = 'email_id';
275 if ($mode == 'sms') {
276 $tempColumn = 'phone_id';
279 /* Get all the group contacts we want to include */
281 $mailingGroup->query(
282 "CREATE TEMPORARY TABLE I_$job_id
283 ($tempColumn int, contact_id int primary key)
287 /* Get the group contacts, but only those which are not in the
288 * exclusion temp table */
290 $query = "REPLACE INTO I_$job_id (email_id, contact_id)
292 SELECT DISTINCT $email.id as email_id,
293 $contact.id as contact_id
296 ON $email.contact_id = $contact.id
297 INNER JOIN $g2contact
298 ON $contact.id = $g2contact.contact_id
300 ON $g2contact.group_id = $mg.entity_id
301 AND $mg.entity_table = '$group'
303 ON $contact.id = X_$job_id.contact_id
305 ($mg.group_type = 'Include')
306 AND $mg.search_id IS NULL
307 AND $g2contact.status = 'Added'
308 AND $contact.do_not_email = 0
309 AND $contact.is_opt_out = 0
310 AND $contact.is_deceased <> 1
312 AND $email.email IS NOT NULL
313 AND $email.email != ''
314 AND $email.on_hold = 0
315 AND $mg.mailing_id = {$mailing_id}
316 AND X_$job_id.contact_id IS null
319 if ($mode == 'sms') {
320 $phoneTypes = CRM_Core_OptionGroup
::values('phone_type', TRUE, FALSE, FALSE, NULL, 'name');
321 $query = "REPLACE INTO I_$job_id (phone_id, contact_id)
323 SELECT DISTINCT $phone.id as phone_id,
324 $contact.id as contact_id
327 ON $phone.contact_id = $contact.id
328 INNER JOIN $g2contact
329 ON $contact.id = $g2contact.contact_id
331 ON $g2contact.group_id = $mg.entity_id
332 AND $mg.entity_table = '$group'
334 ON $contact.id = X_$job_id.contact_id
336 ($mg.group_type = 'Include')
337 AND $mg.search_id IS NULL
338 AND $g2contact.status = 'Added'
339 AND $contact.do_not_sms = 0
340 AND $contact.is_opt_out = 0
341 AND $contact.is_deceased <> 1
342 AND $phone.phone_type_id = {$phoneTypes['Mobile']}
343 AND $phone.phone IS NOT NULL
344 AND $phone.phone != ''
345 AND $mg.mailing_id = {$mailing_id}
346 AND X_$job_id.contact_id IS null";
348 $mailingGroup->query($query);
350 /* Query prior mailings */
352 $query = "REPLACE INTO I_$job_id (email_id, contact_id)
353 SELECT DISTINCT $email.id as email_id,
354 $contact.id as contact_id
357 ON $email.contact_id = $contact.id
359 ON $eq.contact_id = $contact.id
361 ON $eq.job_id = $job.id
363 ON $job.mailing_id = $mg.entity_id AND $mg.entity_table = '$mailing'
365 ON $contact.id = X_$job_id.contact_id
367 ($mg.group_type = 'Include')
368 AND $contact.do_not_email = 0
369 AND $contact.is_opt_out = 0
370 AND $contact.is_deceased <> 1
372 AND $email.on_hold = 0
373 AND $mg.mailing_id = {$mailing_id}
374 AND X_$job_id.contact_id IS null
377 if ($mode == 'sms') {
378 $query = "REPLACE INTO I_$job_id (phone_id, contact_id)
379 SELECT DISTINCT $phone.id as phone_id,
380 $contact.id as contact_id
383 ON $phone.contact_id = $contact.id
385 ON $eq.contact_id = $contact.id
387 ON $eq.job_id = $job.id
389 ON $job.mailing_id = $mg.entity_id AND $mg.entity_table = '$mailing'
391 ON $contact.id = X_$job_id.contact_id
393 ($mg.group_type = 'Include')
394 AND $contact.do_not_sms = 0
395 AND $contact.is_opt_out = 0
396 AND $contact.is_deceased <> 1
397 AND $phone.phone_type_id = {$phoneTypes['Mobile']}
398 AND $mg.mailing_id = {$mailing_id}
399 AND X_$job_id.contact_id IS null";
401 $mailingGroup->query($query);
404 SELECT $group.id, $group.cache_date, $group.saved_search_id, $group.children
406 INNER JOIN $mg ON $mg.entity_id = $group.id
407 WHERE $mg.entity_table = '$group'
408 AND $mg.group_type = 'Include'
409 AND $mg.search_id IS NULL
410 AND $mg.mailing_id = {$mailing_id}
411 AND ( saved_search_id != 0
412 OR saved_search_id IS NOT NULL
413 OR children IS NOT NULL )
416 $groupDAO = CRM_Core_DAO
::executeQuery($sql);
417 while ($groupDAO->fetch()) {
418 if ($groupDAO->cache_date
== NULL) {
419 CRM_Contact_BAO_GroupContactCache
::load($groupDAO);
422 $smartGroupInclude = "
423 REPLACE INTO I_$job_id (email_id, contact_id)
424 SELECT civicrm_email.id as email_id, c.id as contact_id
425 FROM civicrm_contact c
426 INNER JOIN civicrm_email ON civicrm_email.contact_id = c.id
427 INNER JOIN civicrm_group_contact_cache gc ON gc.contact_id = c.id
428 LEFT JOIN X_$job_id ON X_$job_id.contact_id = c.id
429 WHERE gc.group_id = {$groupDAO->id}
430 AND c.do_not_email = 0
432 AND c.is_deceased <> 1
434 AND civicrm_email.on_hold = 0
435 AND X_$job_id.contact_id IS null
438 if ($mode == 'sms') {
439 $smartGroupInclude = "
440 REPLACE INTO I_$job_id (phone_id, contact_id)
441 SELECT p.id as phone_id, c.id as contact_id
442 FROM civicrm_contact c
443 INNER JOIN civicrm_phone p ON p.contact_id = c.id
444 INNER JOIN civicrm_group_contact_cache gc ON gc.contact_id = c.id
445 LEFT JOIN X_$job_id ON X_$job_id.contact_id = c.id
446 WHERE gc.group_id = {$groupDAO->id}
449 AND c.is_deceased <> 1
450 AND p.phone_type_id = {$phoneTypes['Mobile']}
451 AND X_$job_id.contact_id IS null";
453 $mailingGroup->query($smartGroupInclude);
457 * Construct the filtered search queries
460 SELECT search_id, search_args, entity_id
462 WHERE $mg.search_id IS NOT NULL
463 AND $mg.mailing_id = {$mailing_id}
465 $dao = CRM_Core_DAO
::executeQuery($query);
466 while ($dao->fetch()) {
467 $customSQL = CRM_Contact_BAO_SearchCustom
::civiMailSQL($dao->search_id
,
471 $query = "REPLACE INTO I_$job_id ({$tempColumn}, contact_id)
473 $mailingGroup->query($query);
476 /* Get the emails with only location override */
478 $query = "REPLACE INTO I_$job_id (email_id, contact_id)
479 SELECT DISTINCT $email.id as local_email_id,
480 $contact.id as contact_id
483 ON $email.contact_id = $contact.id
484 INNER JOIN $g2contact
485 ON $contact.id = $g2contact.contact_id
487 ON $g2contact.group_id = $mg.entity_id
489 ON $contact.id = X_$job_id.contact_id
491 $mg.entity_table = '$group'
492 AND $mg.group_type = 'Include'
493 AND $g2contact.status = 'Added'
494 AND $contact.do_not_email = 0
495 AND $contact.is_opt_out = 0
496 AND $contact.is_deceased <> 1
498 AND $email.on_hold = 0
499 AND $mg.mailing_id = {$mailing_id}
500 AND X_$job_id.contact_id IS null
502 if ($mode == "sms") {
503 $query = "REPLACE INTO I_$job_id (phone_id, contact_id)
504 SELECT DISTINCT $phone.id as phone_id,
505 $contact.id as contact_id
508 ON $phone.contact_id = $contact.id
509 INNER JOIN $g2contact
510 ON $contact.id = $g2contact.contact_id
512 ON $g2contact.group_id = $mg.entity_id
514 ON $contact.id = X_$job_id.contact_id
516 $mg.entity_table = '$group'
517 AND $mg.group_type = 'Include'
518 AND $g2contact.status = 'Added'
519 AND $contact.do_not_sms = 0
520 AND $contact.is_opt_out = 0
521 AND $contact.is_deceased <> 1
522 AND $phone.phone_type_id = {$phoneTypes['Mobile']}
523 AND $mg.mailing_id = {$mailing_id}
524 AND X_$job_id.contact_id IS null";
526 $mailingGroup->query($query);
528 $eq = new CRM_Mailing_Event_BAO_Queue();
530 list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission
::cacheClause();
531 $aclWhere = $aclWhere ?
"WHERE {$aclWhere}" : '';
533 if ($storeRecipients && $mailing_id) {
536 FROM civicrm_mailing_recipients
537 WHERE mailing_id = %1
539 $params = array(1 => array($mailing_id, 'Integer'));
540 CRM_Core_DAO
::executeQuery($sql, $params);
543 $groupBy = $groupJoin = '';
545 $groupJoin = " INNER JOIN civicrm_email e ON e.id = i.email_id";
546 $groupBy = " GROUP BY e.email ";
550 INSERT INTO civicrm_mailing_recipients ( mailing_id, contact_id, {$tempColumn} )
551 SELECT %1, i.contact_id, i.{$tempColumn}
552 FROM civicrm_contact contact_a
553 INNER JOIN I_$job_id i ON contact_a.id = i.contact_id
558 ORDER BY i.contact_id, i.{$tempColumn}
561 CRM_Core_DAO
::executeQuery($sql, $params);
563 // if we need to add all emails marked bulk, do it as a post filter
564 // on the mailing recipients table
565 if (CRM_Core_BAO_Email
::isMultipleBulkMail()) {
566 self
::addMultipleEmails($mailing_id);
570 /* Delete the temp table */
572 $mailingGroup->reset();
573 $mailingGroup->query("DROP TEMPORARY TABLE X_$job_id");
574 $mailingGroup->query("DROP TEMPORARY TABLE I_$job_id");
580 * @param string $type
584 private function _getMailingGroupIds($type = 'Include') {
585 $mailingGroup = new CRM_Mailing_DAO_MailingGroup();
586 $group = CRM_Contact_DAO_Group
::getTableName();
587 if (!isset($this->id
)) {
588 // we're just testing tokens, so return any group
589 $query = "SELECT id AS entity_id
595 $query = "SELECT entity_id
597 WHERE mailing_id = {$this->id}
598 AND group_type = '$type'
599 AND entity_table = '$group'";
601 $mailingGroup->query($query);
604 while ($mailingGroup->fetch()) {
605 $groupIds[] = $mailingGroup->entity_id
;
612 * Returns the regex patterns that are used for preparing the text and html templates.
614 private function getPatterns($onlyHrefs = FALSE) {
618 $protos = '(https?|ftp)';
620 $gunk = '\{\}/#~:.?+=&;%@!\,\-\|\(\)\*';
622 $any = "{$letters}{$gunk}{$punc}";
624 $pattern = "\\bhref[ ]*=[ ]*([\"'])?(($protos:[$any]+?(?=[$punc]*[^$any]|$)))([\"'])?";
627 $pattern = "\\b($protos:[$any]+?(?=[$punc]*[^$any]|$))";
630 $patterns[] = $pattern;
631 $patterns[] = '\\\\\{\w+\.\w+\\\\\}|\{\{\w+\.\w+\}\}';
632 $patterns[] = '\{\w+\.\w+\}';
634 $patterns = '{' . implode('|', $patterns) . '}im';
640 * Returns an array that denotes the type of token that we are dealing with
641 * we use the type later on when we are doing a token replacement lookup
643 * @param string $token
644 * The token for which we will be doing adata lookup.
647 * An array that holds the token itself and the type.
648 * the type will tell us which function to use for the data lookup
649 * if we need to do a lookup at all
651 public function &getDataFunc($token) {
652 static $_categories = NULL;
653 static $_categoryString = NULL;
655 $_categories = array(
662 CRM_Utils_Hook
::tokens($_categories);
663 $_categoryString = implode('|', array_keys($_categories));
666 $funcStruct = array('type' => NULL, 'token' => $token);
668 if ((preg_match('/^href/i', $token) ||
preg_match('/^http/i', $token))) {
669 // it is a url so we need to check to see if there are any tokens embedded
670 // if so then call this function again to get the token dataFunc
671 // and assign the type 'embedded' so that the data retrieving function
672 // will know what how to handle this token.
673 if (preg_match_all('/(\{\w+\.\w+\})/', $token, $matches)) {
674 $funcStruct['type'] = 'embedded_url';
675 $funcStruct['embed_parts'] = $funcStruct['token'] = array();
676 foreach ($matches[1] as $match) {
677 $preg_token = '/' . preg_quote($match, '/') . '/';
678 $list = preg_split($preg_token, $token, 2);
679 $funcStruct['embed_parts'][] = $list[0];
681 $funcStruct['token'][] = $this->getDataFunc($match);
683 // fixed truncated url, CRM-7113
685 $funcStruct['embed_parts'][] = $token;
689 $funcStruct['type'] = 'url';
692 elseif (preg_match('/^\{(' . $_categoryString . ')\.(\w+)\}$/', $token, $matches)) {
693 $funcStruct['type'] = $matches[1];
694 $funcStruct['token'] = $matches[2];
696 elseif (preg_match('/\\\\\{(\w+\.\w+)\\\\\}|\{\{(\w+\.\w+)\}\}/', $token, $matches)) {
697 // we are an escaped token
698 // so remove the escape chars
699 $unescaped_token = preg_replace('/\{\{|\}\}|\\\\\{|\\\\\}/', '', $matches[0]);
700 $funcStruct['token'] = '{' . $unescaped_token . '}';
707 * Prepares the text and html templates
708 * for generating the emails and returns a copy of the
711 private function getPreparedTemplates() {
712 if (!$this->preparedTemplates
) {
713 $patterns['html'] = $this->getPatterns(TRUE);
714 $patterns['subject'] = $patterns['text'] = $this->getPatterns();
715 $templates = $this->getTemplates();
717 $this->preparedTemplates
= array();
724 if (!isset($templates[$key])) {
730 $split_template = array();
732 $email = $templates[$key];
733 preg_match_all($patterns[$key], $email, $matches, PREG_PATTERN_ORDER
);
734 foreach ($matches[0] as $idx => $token) {
735 $preg_token = '/' . preg_quote($token, '/') . '/im';
736 list($split_template[], $email) = preg_split($preg_token, $email, 2);
737 array_push($tokens, $this->getDataFunc($token));
740 $split_template[] = $email;
742 $this->preparedTemplates
[$key]['template'] = $split_template;
743 $this->preparedTemplates
[$key]['tokens'] = $tokens;
746 return ($this->preparedTemplates
);
750 * Retrieve a ref to an array that holds the email and text templates for this email
751 * assembles the complete template including the header and footer
752 * that the user has uploaded or declared (if they have dome that)
755 * reference to an assoc array
757 private function &getTemplates() {
758 if (!$this->templates
) {
759 $this->getHeaderFooter();
760 $this->templates
= array();
762 if ($this->body_text
) {
765 $template[] = $this->header
->body_text
;
768 $template[] = $this->body_text
;
771 $template[] = $this->footer
->body_text
;
774 $this->templates
['text'] = implode("\n", $template);
777 if ($this->body_html
) {
781 $template[] = $this->header
->body_html
;
784 $template[] = $this->body_html
;
787 $template[] = $this->footer
->body_html
;
790 $this->templates
['html'] = implode("\n", $template);
792 // this is where we create a text template from the html template if the text template did not exist
793 // this way we ensure that every recipient will receive an email even if the pref is set to text and the
794 // user uploads an html email only
795 if (!$this->body_text
) {
796 $this->templates
['text'] = CRM_Utils_String
::htmlToText($this->templates
['html']);
800 if ($this->subject
) {
802 $template[] = $this->subject
;
803 $this->templates
['subject'] = implode("\n", $template);
806 return $this->templates
;
811 * Retrieve a ref to an array that holds all of the tokens in the email body
812 * where the keys are the type of token and the values are ordinal arrays
813 * that hold the token names (even repeated tokens) in the order in which
814 * they appear in the body of the email.
816 * note: the real work is done in the _getTokens() function
818 * this function needs to have some sort of a body assigned
819 * either text or html for this to have any meaningful impact
822 * reference to an assoc array
824 public function &getTokens() {
825 if (!$this->tokens
) {
827 $this->tokens
= array('html' => array(), 'text' => array(), 'subject' => array());
829 if ($this->body_html
) {
830 $this->_getTokens('html');
831 if (!$this->body_text
) {
832 // Since the text template was created from html, use the html tokens.
833 // @see CRM_Mailing_BAO_Mailing::getTemplates()
834 $this->tokens
['text'] = $this->tokens
['html'];
838 if ($this->body_text
) {
839 $this->_getTokens('text');
842 if ($this->subject
) {
843 $this->_getTokens('subject');
847 return $this->tokens
;
851 * Returns the token set for all 3 parts as one set. This allows it to be sent to the
852 * hook in one call and standardizes it across other token workflows
855 * reference to an assoc array
857 public function &getFlattenedTokens() {
858 if (!$this->flattenedTokens
) {
859 $tokens = $this->getTokens();
861 $this->flattenedTokens
= CRM_Utils_Token
::flattenTokens($tokens);
864 return $this->flattenedTokens
;
869 * _getTokens parses out all of the tokens that have been
870 * included in the html and text bodies of the email
871 * we get the tokens and then separate them into an
872 * internal structure named tokens that has the same
873 * form as the static tokens property(?) of the CRM_Utils_Token class.
874 * The difference is that there might be repeated token names as we want the
875 * structures to represent the order in which tokens were found from left to right, top to bottom.
878 * @param string $prop name of the property that holds the text that we want to scan for tokens (html, text).
879 * Name of the property that holds the text that we want to scan for tokens (html, text).
883 private function _getTokens($prop) {
884 $templates = $this->getTemplates();
886 $newTokens = CRM_Utils_Token
::getTokens($templates[$prop]);
888 foreach ($newTokens as $type => $names) {
889 if (!isset($this->tokens
[$prop][$type])) {
890 $this->tokens
[$prop][$type] = array();
892 foreach ($names as $key => $name) {
893 $this->tokens
[$prop][$type][] = $name;
899 * Generate an event queue for a test job.
901 * @param array $testParams
902 * Contains form values.
906 public function getTestRecipients($testParams) {
907 if (array_key_exists($testParams['test_group'], CRM_Core_PseudoConstant
::group())) {
908 $contacts = civicrm_api('contact', 'get', array(
910 'group' => $testParams['test_group'],
913 'limit' => 100000000000,
918 foreach (array_keys($contacts['values']) as $groupContact) {
920 SELECT civicrm_email.id AS email_id,
921 civicrm_email.is_primary as is_primary,
922 civicrm_email.is_bulkmail as is_bulkmail
924 INNER JOIN civicrm_contact ON civicrm_email.contact_id = civicrm_contact.id
925 WHERE (civicrm_email.is_bulkmail = 1 OR civicrm_email.is_primary = 1)
926 AND civicrm_contact.id = {$groupContact}
927 AND civicrm_contact.do_not_email = 0
928 AND civicrm_contact.is_deceased <> 1
929 AND civicrm_email.on_hold = 0
930 AND civicrm_contact.is_opt_out = 0
931 GROUP BY civicrm_email.id
932 ORDER BY civicrm_email.is_bulkmail DESC
934 $dao = CRM_Core_DAO
::executeQuery($query);
937 'job_id' => $testParams['job_id'],
938 'email_id' => $dao->email_id
,
939 'contact_id' => $groupContact,
941 CRM_Mailing_Event_BAO_Queue
::create($params);
948 * Load this->header and this->footer.
950 private function getHeaderFooter() {
951 if (!$this->header
and $this->header_id
) {
952 $this->header
= new CRM_Mailing_BAO_Component();
953 $this->header
->id
= $this->header_id
;
954 $this->header
->find(TRUE);
955 $this->header
->free();
958 if (!$this->footer
and $this->footer_id
) {
959 $this->footer
= new CRM_Mailing_BAO_Component();
960 $this->footer
->id
= $this->footer_id
;
961 $this->footer
->find(TRUE);
962 $this->footer
->free();
967 * Given and array of headers and a prefix, job ID, event queue ID, and hash,
968 * add a Message-ID header if needed.
970 * i.e. if the global includeMessageId is set and there isn't already a
971 * Message-ID in the array.
972 * The message ID is structured the same way as a verp. However no interpretation
973 * is placed on the values received, so they do not need to follow the verp
976 * @param array $headers
977 * Array of message headers to update, in-out.
978 * @param string $prefix
979 * Prefix for the message ID, use same prefixes as verp.
981 * @param string $job_id
982 * Job ID component of the generated message ID.
983 * @param string $event_queue_id
984 * Event Queue ID component of the generated message ID.
985 * @param string $hash
986 * Hash component of the generated message ID.
990 public static function addMessageIdHeader(&$headers, $prefix, $job_id, $event_queue_id, $hash) {
991 $config = CRM_Core_Config
::singleton();
992 $localpart = CRM_Core_BAO_MailSettings
::defaultLocalpart();
993 $emailDomain = CRM_Core_BAO_MailSettings
::defaultDomain();
994 $includeMessageId = CRM_Core_BAO_MailSettings
::includeMessageId();
996 if ($includeMessageId && (!array_key_exists('Message-ID', $headers))) {
997 $headers['Message-ID'] = '<' . implode($config->verpSeparator
,
999 $localpart . $prefix,
1004 ) . "@{$emailDomain}>";
1009 * Static wrapper for getting verp and urls.
1011 * @param int $job_id
1012 * ID of the Job associated with this message.
1013 * @param int $event_queue_id
1014 * ID of the EventQueue.
1015 * @param string $hash
1016 * Hash of the EventQueue.
1017 * @param string $email
1018 * Destination address.
1021 * (reference) array array ref that hold array refs to the verp info and urls
1023 public static function getVerpAndUrls($job_id, $event_queue_id, $hash, $email) {
1024 // create a skeleton object and set its properties that are required by getVerpAndUrlsAndHeaders()
1025 $config = CRM_Core_Config
::singleton();
1026 $bao = new CRM_Mailing_BAO_Mailing();
1027 $bao->_domain
= CRM_Core_BAO_Domain
::getDomain();
1028 $bao->from_name
= $bao->from_email
= $bao->subject
= '';
1030 // use $bao's instance method to get verp and urls
1031 list($verp, $urls, $_) = $bao->getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email);
1032 return array($verp, $urls);
1036 * Get verp, urls and headers
1038 * @param int $job_id
1039 * ID of the Job associated with this message.
1040 * @param int $event_queue_id
1041 * ID of the EventQueue.
1042 * @param string $hash
1043 * Hash of the EventQueue.
1044 * @param string $email
1045 * Destination address.
1047 * @param bool $isForward
1050 * array ref that hold array refs to the verp info, urls, and headers
1052 private function getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email, $isForward = FALSE) {
1053 $config = CRM_Core_Config
::singleton();
1056 * Inbound VERP keys:
1057 * reply: user replied to mailing
1058 * bounce: email address bounced
1059 * unsubscribe: contact opts out of all target lists for the mailing
1060 * resubscribe: contact opts back into all target lists for the mailing
1061 * optOut: contact unsubscribes from the domain
1064 $verpTokens = array(
1067 'unsubscribe' => 'u',
1068 'resubscribe' => 'e',
1072 $localpart = CRM_Core_BAO_MailSettings
::defaultLocalpart();
1073 $emailDomain = CRM_Core_BAO_MailSettings
::defaultDomain();
1075 foreach ($verpTokens as $key => $value) {
1076 $verp[$key] = implode($config->verpSeparator
,
1078 $localpart . $value,
1083 ) . "@$emailDomain";
1086 //handle should override VERP address.
1087 $skipEncode = FALSE;
1090 self
::overrideVerp($job_id)
1092 $verp['reply'] = "\"{$this->from_name}\" <{$this->from_email}>";
1096 'forward' => CRM_Utils_System
::url('civicrm/mailing/forward',
1097 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
1098 TRUE, NULL, TRUE, TRUE
1100 'unsubscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/unsubscribe',
1101 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
1102 TRUE, NULL, TRUE, TRUE
1104 'resubscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/resubscribe',
1105 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
1106 TRUE, NULL, TRUE, TRUE
1108 'optOutUrl' => CRM_Utils_System
::url('civicrm/mailing/optout',
1109 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
1110 TRUE, NULL, TRUE, TRUE
1112 'subscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/subscribe',
1114 TRUE, NULL, TRUE, TRUE
1119 'Reply-To' => $verp['reply'],
1120 'Return-Path' => $verp['bounce'],
1121 'From' => "\"{$this->from_name}\" <{$this->from_email}>",
1122 'Subject' => $this->subject
,
1123 'List-Unsubscribe' => "<mailto:{$verp['unsubscribe']}>",
1125 self
::addMessageIdHeader($headers, 'm', $job_id, $event_queue_id, $hash);
1127 $headers['Subject'] = "[Fwd:{$this->subject}]";
1129 return array(&$verp, &$urls, &$headers);
1133 * Compose a message.
1135 * @param int $job_id
1136 * ID of the Job associated with this message.
1137 * @param int $event_queue_id
1138 * ID of the EventQueue.
1139 * @param string $hash
1140 * Hash of the EventQueue.
1141 * @param string $contactId
1142 * ID of the Contact.
1143 * @param string $email
1144 * Destination address.
1145 * @param string $recipient
1146 * To: of the recipient.
1148 * Is this mailing a test?.
1149 * @param $contactDetails
1150 * @param $attachments
1151 * @param bool $isForward
1152 * Is this mailing compose for forward?.
1153 * @param string $fromEmail
1154 * Email address of who is forwardinf it.
1156 * @param null $replyToEmail
1158 * @return Mail_mime The mail object
1160 public function compose(
1161 $job_id, $event_queue_id, $hash, $contactId,
1162 $email, &$recipient, $test,
1163 $contactDetails, &$attachments, $isForward = FALSE,
1164 $fromEmail = NULL, $replyToEmail = NULL
1166 $config = CRM_Core_Config
::singleton();
1169 if ($this->_domain
== NULL) {
1170 $this->_domain
= CRM_Core_BAO_Domain
::getDomain();
1173 list($verp, $urls, $headers) = $this->getVerpAndUrlsAndHeaders(
1181 //set from email who is forwarding it and not original one.
1183 unset($headers['From']);
1184 $headers['From'] = "<{$fromEmail}>";
1187 if ($replyToEmail && ($fromEmail != $replyToEmail)) {
1188 $headers['Reply-To'] = "{$replyToEmail}";
1191 if ($contactDetails) {
1192 $contact = $contactDetails;
1194 elseif ($contactId === 0) {
1197 CRM_Utils_Hook
::tokenValues($contact, $contactId, $job_id);
1200 $params = array(array('contact_id', '=', $contactId, 0, 0));
1201 list($contact) = CRM_Contact_BAO_Query
::apiQuery($params);
1204 $contact = reset($contact);
1206 if (!$contact ||
is_a($contact, 'CRM_Core_Error')) {
1207 CRM_Core_Error
::debug_log_message(ts('CiviMail will not send email to a non-existent contact: %1',
1208 array(1 => $contactId)
1210 // setting this because function is called by reference
1211 //@todo test not calling function by reference
1216 // also call the hook to get contact details
1217 CRM_Utils_Hook
::tokenValues($contact, $contactId, $job_id);
1220 $pTemplates = $this->getPreparedTemplates();
1223 foreach ($pTemplates as $type => $pTemplate) {
1224 $html = ($type == 'html') ?
TRUE : FALSE;
1225 $pEmails[$type] = array();
1226 $pEmail = &$pEmails[$type];
1227 $template = &$pTemplates[$type]['template'];
1228 $tokens = &$pTemplates[$type]['tokens'];
1230 if (!empty($tokens)) {
1231 foreach ($tokens as $idx => $token) {
1232 $token_data = $this->getTokenData($token, $html, $contact, $verp, $urls, $event_queue_id);
1233 array_push($pEmail, $template[$idx]);
1234 array_push($pEmail, $token_data);
1238 array_push($pEmail, $template[$idx]);
1241 if (isset($template[($idx +
1)])) {
1242 array_push($pEmail, $template[($idx +
1)]);
1247 if (isset($pEmails['html']) && is_array($pEmails['html']) && count($pEmails['html'])) {
1248 $html = &$pEmails['html'];
1252 if (isset($pEmails['text']) && is_array($pEmails['text']) && count($pEmails['text'])) {
1253 $text = &$pEmails['text'];
1256 // push the tracking url on to the html email if necessary
1257 if ($this->open_tracking
&& $html) {
1258 array_push($html, "\n" . '<img src="' . $config->userFrameworkResourceURL
.
1259 "extern/open.php?q=$event_queue_id\" width='1' height='1' alt='' border='0'>"
1263 $message = new Mail_mime("\n");
1265 $useSmarty = defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY ?
TRUE : FALSE;
1267 $smarty = CRM_Core_Smarty
::singleton();
1268 // also add the contact tokens to the template
1269 $smarty->assign_by_ref('contact', $contact);
1272 $mailParams = $headers;
1273 if ($text && ($test ||
$contact['preferred_mail_format'] == 'Text' ||
1274 $contact['preferred_mail_format'] == 'Both' ||
1275 ($contact['preferred_mail_format'] == 'HTML' && !array_key_exists('html', $pEmails))
1278 $textBody = implode('', $text);
1280 $textBody = $smarty->fetch("string:$textBody");
1282 $mailParams['text'] = $textBody;
1285 if ($html && ($test ||
($contact['preferred_mail_format'] == 'HTML' ||
1286 $contact['preferred_mail_format'] == 'Both'
1289 $htmlBody = implode('', $html);
1291 $htmlBody = $smarty->fetch("string:$htmlBody");
1293 $mailParams['html'] = $htmlBody;
1296 if (empty($mailParams['text']) && empty($mailParams['html'])) {
1298 // something went wrong, lets log it and return null (by reference)
1299 CRM_Core_Error
::debug_log_message(ts('CiviMail will not send an empty mail body, Skipping: %1',
1306 $mailParams['attachments'] = $attachments;
1308 $mailingSubject = CRM_Utils_Array
::value('subject', $pEmails);
1309 if (is_array($mailingSubject)) {
1310 $mailingSubject = implode('', $mailingSubject);
1312 $mailParams['Subject'] = $mailingSubject;
1314 $mailParams['toName'] = CRM_Utils_Array
::value('display_name',
1317 $mailParams['toEmail'] = $email;
1319 // Add job ID to mailParams for external email delivery service to utilise
1320 $mailParams['job_id'] = $job_id;
1322 CRM_Utils_Hook
::alterMailParams($mailParams, 'civimail');
1324 // CRM-10699 support custom email headers
1325 if (!empty($mailParams['headers'])) {
1326 $headers = array_merge($headers, $mailParams['headers']);
1328 //cycle through mailParams and set headers array
1329 foreach ($mailParams as $paramKey => $paramValue) {
1330 //exclude values not intended for the header
1331 if (!in_array($paramKey, array(
1339 $headers[$paramKey] = $paramValue;
1343 if (!empty($mailParams['text'])) {
1344 $message->setTxtBody($mailParams['text']);
1347 if (!empty($mailParams['html'])) {
1348 $message->setHTMLBody($mailParams['html']);
1351 if (!empty($mailParams['attachments'])) {
1352 foreach ($mailParams['attachments'] as $fileID => $attach) {
1353 $message->addAttachment($attach['fullPath'],
1354 $attach['mime_type'],
1355 $attach['cleanName']
1360 //pickup both params from mail params.
1361 $toName = trim($mailParams['toName']);
1362 $toEmail = trim($mailParams['toEmail']);
1363 if ($toName == $toEmail ||
1364 strpos($toName, '@') !== FALSE
1369 $toName = CRM_Utils_Mail
::formatRFC2822Name($toName);
1372 $headers['To'] = "$toName <$toEmail>";
1374 $headers['Precedence'] = 'bulk';
1375 // Will test in the mail processor if the X-VERP is set in the bounced email.
1376 // (As an option to replace real VERP for those that can't set it up)
1377 $headers['X-CiviMail-Bounce'] = $verp['bounce'];
1380 //token replacement of subject
1381 $headers['Subject'] = $mailingSubject;
1383 CRM_Utils_Mail
::setMimeParams($message);
1384 $headers = $message->headers($headers);
1386 //get formatted recipient
1387 $recipient = $headers['To'];
1389 // make sure we unset a lot of stuff
1401 * get mailing object and replaces subscribeInvite,
1402 * domain and mailing tokens
1404 public static function tokenReplace(&$mailing) {
1405 $domain = CRM_Core_BAO_Domain
::getDomain();
1407 foreach (array('text', 'html') as $type) {
1408 $tokens = $mailing->getTokens();
1409 if (isset($mailing->templates
[$type])) {
1410 $mailing->templates
[$type] = CRM_Utils_Token
::replaceSubscribeInviteTokens($mailing->templates
[$type]);
1411 $mailing->templates
[$type] = CRM_Utils_Token
::replaceDomainTokens(
1412 $mailing->templates
[$type],
1414 $type == 'html' ?
TRUE : FALSE,
1417 $mailing->templates
[$type] = CRM_Utils_Token
::replaceMailingTokens($mailing->templates
[$type], $mailing, NULL, $tokens[$type]);
1424 * getTokenData receives a token from an email
1425 * and returns the appropriate data for the token
1427 private function getTokenData(&$token_a, $html = FALSE, &$contact, &$verp, &$urls, $event_queue_id) {
1428 $type = $token_a['type'];
1429 $token = $token_a['token'];
1432 $useSmarty = defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY ?
TRUE : FALSE;
1434 if ($type == 'embedded_url') {
1435 $embed_data = array();
1436 foreach ($token as $t) {
1437 $embed_data[] = $this->getTokenData($t, $html = FALSE, $contact, $verp, $urls, $event_queue_id);
1439 $numSlices = count($embed_data);
1441 for ($i = 0; $i < $numSlices; $i++
) {
1442 $url .= "{$token_a['embed_parts'][$i]}{$embed_data[$i]}";
1444 if (isset($token_a['embed_parts'][$numSlices])) {
1445 $url .= $token_a['embed_parts'][$numSlices];
1447 // add trailing quote since we've gobbled it up in a previous regex
1448 // function getPatterns, line 431
1449 if (preg_match('/^href[ ]*=[ ]*\'/', $url)) {
1452 elseif (preg_match('/^href[ ]*=[ ]*\"/', $url)) {
1457 elseif ($type == 'url') {
1458 if ($this->url_tracking
) {
1459 $data = CRM_Mailing_BAO_TrackableURL
::getTrackerURL($token, $this->id
, $event_queue_id);
1460 if (!empty($html)) {
1461 $data = htmlentities($data, ENT_NOQUOTES
);
1468 elseif ($type == 'contact') {
1469 $data = CRM_Utils_Token
::getContactTokenReplacement($token, $contact, FALSE, FALSE, $useSmarty);
1471 elseif ($type == 'action') {
1472 $data = CRM_Utils_Token
::getActionTokenReplacement($token, $verp, $urls, $html);
1474 elseif ($type == 'domain') {
1475 $domain = CRM_Core_BAO_Domain
::getDomain();
1476 $data = CRM_Utils_Token
::getDomainTokenReplacement($token, $domain, $html);
1478 elseif ($type == 'mailing') {
1479 if ($token == 'name') {
1480 $data = $this->name
;
1482 elseif ($token == 'group') {
1483 $groups = $this->getGroupNames();
1484 $data = implode(', ', $groups);
1488 $data = CRM_Utils_Array
::value("{$type}.{$token}", $contact);
1494 * Return a list of group names for this mailing. Does not work with
1495 * prior-mailing targets.
1498 * Names of groups receiving this mailing
1500 public function &getGroupNames() {
1501 if (!isset($this->id
)) {
1504 $mg = new CRM_Mailing_DAO_MailingGroup();
1505 $mgtable = CRM_Mailing_DAO_MailingGroup
::getTableName();
1506 $group = CRM_Contact_BAO_Group
::getTableName();
1508 $mg->query("SELECT $group.title as name FROM $mgtable
1509 INNER JOIN $group ON $mgtable.entity_id = $group.id
1510 WHERE $mgtable.mailing_id = {$this->id}
1511 AND $mgtable.entity_table = '$group'
1512 AND $mgtable.group_type = 'Include'
1513 ORDER BY $group.name");
1516 while ($mg->fetch()) {
1517 $groups[] = $mg->name
;
1526 * @param array $params
1527 * Reference array contains the values submitted by the form.
1529 * Reference array contains the id.
1532 * @return CRM_Mailing_DAO_Mailing
1534 public static function add(&$params, $ids = array()) {
1535 $id = CRM_Utils_Array
::value('mailing_id', $ids, CRM_Utils_Array
::value('id', $params));
1538 CRM_Utils_Hook
::pre('edit', 'Mailing', $id, $params);
1541 CRM_Utils_Hook
::pre('create', 'Mailing', NULL, $params);
1544 $mailing = new static();
1547 $mailing->find(TRUE);
1549 $mailing->domain_id
= CRM_Utils_Array
::value('domain_id', $params, CRM_Core_Config
::domainID());
1551 if (!isset($params['replyto_email']) &&
1552 isset($params['from_email'])
1554 $params['replyto_email'] = $params['from_email'];
1557 $mailing->copyValues($params);
1559 $result = $mailing->save();
1561 if (!empty($ids['mailing'])) {
1562 CRM_Utils_Hook
::post('edit', 'Mailing', $mailing->id
, $mailing);
1565 CRM_Utils_Hook
::post('create', 'Mailing', $mailing->id
, $mailing);
1572 * Construct a new mailing object, along with job and mailing_group
1573 * objects, from the form values of the create mailing wizard.
1575 * This function is a bit evil. It not only merges $params and saves
1576 * the mailing -- it also schedules the mailing and chooses the recipients.
1577 * Since it merges $params, it's also the only place to correctly trigger
1578 * multi-field validation. It should be broken up.
1580 * In the mean time, use-cases which break under the weight of this
1581 * evil may find reprieve in these extra evil params:
1583 * - _skip_evil_bao_auto_recipients_: bool
1584 * - _skip_evil_bao_auto_schedule_: bool
1585 * - _evil_bao_validator_: string|callable
1587 * </twowrongsmakesaright>
1589 * @params array $params
1592 * @param array $params
1596 * $mailing The new mailing object
1597 * @throws \Exception
1599 public static function create(&$params, $ids = array()) {
1601 if (empty($ids) && isset($params['id'])) {
1602 $ids['mailing_id'] = $ids['id'] = $params['id'];
1606 // Do the below only for an insert
1607 // for an update, we should not set the defaults
1608 if (!isset($ids['id']) && !isset($ids['mailing_id'])) {
1609 // Retrieve domain email and name for default sender
1610 $domain = civicrm_api(
1615 'current_domain' => 1,
1619 if (isset($domain['from_email'])) {
1620 $domain_email = $domain['from_email'];
1621 $domain_name = $domain['from_name'];
1624 $domain_email = 'info@EXAMPLE.ORG';
1625 $domain_name = 'EXAMPLE.ORG';
1627 if (!isset($params['created_id'])) {
1628 $session =& CRM_Core_Session
::singleton();
1629 $params['created_id'] = $session->get('userID');
1632 // load the default config settings for each
1633 // eg reply_id, unsubscribe_id need to use
1634 // correct template IDs here
1635 'override_verp' => TRUE,
1636 'forward_replies' => FALSE,
1637 'open_tracking' => TRUE,
1638 'url_tracking' => TRUE,
1639 'visibility' => 'Public Pages',
1640 'replyto_email' => $domain_email,
1641 'header_id' => CRM_Mailing_PseudoConstant
::defaultComponent('header_id', ''),
1642 'footer_id' => CRM_Mailing_PseudoConstant
::defaultComponent('footer_id', ''),
1643 'from_email' => $domain_email,
1644 'from_name' => $domain_name,
1645 'msg_template_id' => NULL,
1646 'created_id' => $params['created_id'],
1647 'approver_id' => NULL,
1648 'auto_responder' => 0,
1649 'created_date' => date('YmdHis'),
1650 'scheduled_date' => NULL,
1651 'approval_date' => NULL,
1654 // Get the default from email address, if not provided.
1655 if (empty($defaults['from_email'])) {
1656 $defaultAddress = CRM_Core_OptionGroup
::values('from_email_address', NULL, NULL, NULL, ' AND is_default = 1');
1657 foreach ($defaultAddress as $id => $value) {
1658 if (preg_match('/"(.*)" <(.*)>/', $value, $match)) {
1659 $defaults['from_email'] = $match[2];
1660 $defaults['from_name'] = $match[1];
1665 $params = array_merge($defaults, $params);
1669 * Could check and warn for the following cases:
1671 * - groups OR mailings should be populated.
1672 * - body html OR body text should be populated.
1675 $transaction = new CRM_Core_Transaction();
1677 $mailing = self
::add($params, $ids);
1679 if (is_a($mailing, 'CRM_Core_Error')) {
1680 $transaction->rollback();
1683 // update mailings with hash values
1684 CRM_Contact_BAO_Contact_Utils
::generateChecksum($mailing->id
, NULL, NULL, NULL, 'mailing', 16);
1686 $groupTableName = CRM_Contact_BAO_Group
::getTableName();
1687 $mailingTableName = CRM_Mailing_BAO_Mailing
::getTableName();
1689 /* Create the mailing group record */
1690 $mg = new CRM_Mailing_DAO_MailingGroup();
1691 $groupTypes = array('include' => 'Include', 'exclude' => 'Exclude', 'base' => 'Base');
1692 foreach (array('groups', 'mailings') as $entity) {
1693 foreach (array('include', 'exclude', 'base') as $type) {
1694 if (isset($params[$entity][$type])) {
1695 self
::replaceGroups($mailing->id
, $groupTypes[$type], $entity, $params[$entity][$type]);
1700 if (!empty($params['search_id']) && !empty($params['group_id'])) {
1702 $mg->mailing_id
= $mailing->id
;
1703 $mg->entity_table
= $groupTableName;
1704 $mg->entity_id
= $params['group_id'];
1705 $mg->search_id
= $params['search_id'];
1706 $mg->search_args
= $params['search_args'];
1707 $mg->group_type
= 'Include';
1711 // check and attach and files as needed
1712 CRM_Core_BAO_File
::processAttachment($params, 'civicrm_mailing', $mailing->id
);
1714 // If we're going to autosend, then check validity before saving.
1715 if (!empty($params['scheduled_date']) && $params['scheduled_date'] != 'null' && !empty($params['_evil_bao_validator_'])) {
1716 $cb = Civi\Core\Resolver
::singleton()->get($params['_evil_bao_validator_']);
1717 $errors = call_user_func($cb, $mailing);
1718 if (!empty($errors)) {
1719 $fields = implode(',', array_keys($errors));
1720 throw new CRM_Core_Exception("Mailing cannot be sent. There are missing or invalid fields ($fields).", 'cannot-send', $errors);
1724 $transaction->commit();
1726 // Create parent job if not yet created.
1727 // Condition on the existence of a scheduled date.
1728 if (!empty($params['scheduled_date']) && $params['scheduled_date'] != 'null' && empty($params['_skip_evil_bao_auto_schedule_'])) {
1729 $job = new CRM_Mailing_BAO_MailingJob();
1730 $job->mailing_id
= $mailing->id
;
1731 $job->status
= 'Scheduled';
1734 if (!$job->find(TRUE)) {
1735 $job->scheduled_date
= $params['scheduled_date'];
1739 // Populate the recipients.
1740 if (empty($params['_skip_evil_bao_auto_recipients_'])) {
1741 self
::getRecipients($job->id
, $mailing->id
, TRUE, $mailing->dedupe_email
);
1749 * @param CRM_Mailing_DAO_Mailing $mailing
1750 * The mailing which may or may not be sendable.
1752 * List of error messages.
1754 public static function checkSendable($mailing) {
1756 foreach (array('subject', 'name', 'from_name', 'from_email') as $field) {
1757 if (empty($mailing->{$field})) {
1758 $errors[$field] = ts('Field "%1" is required.', array(
1763 if (empty($mailing->body_html
) && empty($mailing->body_text
)) {
1764 $errors['body'] = ts('Field "body_html" or "body_text" is required.');
1767 if (!CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
, 'disable_mandatory_tokens_check')) {
1768 $header = $mailing->header_id
&& $mailing->header_id
!= 'null' ? CRM_Mailing_BAO_Component
::findById($mailing->header_id
) : NULL;
1769 $footer = $mailing->footer_id
&& $mailing->footer_id
!= 'null' ? CRM_Mailing_BAO_Component
::findById($mailing->footer_id
) : NULL;
1770 foreach (array('body_html', 'body_text') as $field) {
1771 if (empty($mailing->{$field})) {
1774 $str = ($header ?
$header->{$field} : '') . $mailing->{$field} . ($footer ?
$footer->{$field} : '');
1775 $err = CRM_Utils_Token
::requiredTokens($str);
1776 if ($err !== TRUE) {
1777 foreach ($err as $token => $desc) {
1778 $errors["{$field}:{$token}"] = ts('This message is missing a required token - {%1}: %2',
1779 array(1 => $token, 2 => $desc)
1790 * Replace the list of recipients on a given mailing.
1792 * @param int $mailingId
1793 * @param string $type
1794 * 'include' or 'exclude'.
1795 * @param string $entity
1796 * 'groups' or 'mailings'.
1797 * @param array <int> $entityIds
1798 * @throws CiviCRM_API3_Exception
1800 public static function replaceGroups($mailingId, $type, $entity, $entityIds) {
1802 foreach ($entityIds as $entityId) {
1803 $values[] = array('entity_id' => $entityId);
1805 civicrm_api3('mailing_group', 'replace', array(
1806 'mailing_id' => $mailingId,
1807 'group_type' => $type,
1808 'entity_table' => ($entity == 'groups') ? CRM_Contact_BAO_Group
::getTableName() : CRM_Mailing_BAO_Mailing
::getTableName(),
1809 'values' => $values,
1814 * Get hash value of the mailing.
1818 * @return null|string
1820 public static function getMailingHash($id) {
1822 if (CRM_Core_BAO_Setting
::getItem(CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
, 'hash_mailing_url')) {
1823 $hash = CRM_Core_DAO
::getFieldValue('CRM_Mailing_BAO_Mailing', $id, 'hash', 'id');
1829 * Generate a report. Fetch event count information, mailing data, and job
1833 * The mailing id to report.
1834 * @param bool $skipDetails
1835 * Whether return all detailed report.
1837 * @param bool $isSMS
1840 * Associative array of reporting data
1842 public static function &report($id, $skipDetails = FALSE, $isSMS = FALSE) {
1843 $mailing_id = CRM_Utils_Type
::escape($id, 'Integer');
1845 $mailing = new CRM_Mailing_BAO_Mailing();
1848 'mailing' => self
::getTableName(),
1849 'mailing_group' => CRM_Mailing_DAO_MailingGroup
::getTableName(),
1850 'group' => CRM_Contact_BAO_Group
::getTableName(),
1851 'job' => CRM_Mailing_BAO_MailingJob
::getTableName(),
1852 'queue' => CRM_Mailing_Event_BAO_Queue
::getTableName(),
1853 'delivered' => CRM_Mailing_Event_BAO_Delivered
::getTableName(),
1854 'opened' => CRM_Mailing_Event_BAO_Opened
::getTableName(),
1855 'reply' => CRM_Mailing_Event_BAO_Reply
::getTableName(),
1856 'unsubscribe' => CRM_Mailing_Event_BAO_Unsubscribe
::getTableName(),
1857 'bounce' => CRM_Mailing_Event_BAO_Bounce
::getTableName(),
1858 'forward' => CRM_Mailing_Event_BAO_Forward
::getTableName(),
1859 'url' => CRM_Mailing_BAO_TrackableURL
::getTableName(),
1860 'urlopen' => CRM_Mailing_Event_BAO_TrackableURLOpen
::getTableName(),
1861 'component' => CRM_Mailing_BAO_Component
::getTableName(),
1862 'spool' => CRM_Mailing_BAO_Spool
::getTableName(),
1866 $additionalWhereClause = " AND ";
1868 $additionalWhereClause .= " {$t['mailing']}.sms_provider_id IS NULL ";
1871 $additionalWhereClause .= " {$t['mailing']}.sms_provider_id IS NOT NULL ";
1874 /* Get the mailing info */
1877 SELECT {$t['mailing']}.*
1878 FROM {$t['mailing']}
1879 WHERE {$t['mailing']}.id = $mailing_id {$additionalWhereClause}");
1883 $report['mailing'] = array();
1884 foreach (array_keys(self
::fields()) as $field) {
1885 $report['mailing'][$field] = $mailing->$field;
1889 if ($campaignId = CRM_Utils_Array
::value('campaign_id', $report['mailing'])) {
1890 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns($campaignId);
1891 $report['mailing']['campaign'] = $campaigns[$campaignId];
1894 //mailing report is called by activity
1895 //we dont need all detail report
1900 /* Get the component info */
1904 $components = array(
1905 'header' => ts('Header'),
1906 'footer' => ts('Footer'),
1907 'reply' => ts('Reply'),
1908 'unsubscribe' => ts('Unsubscribe'),
1909 'optout' => ts('Opt-Out'),
1911 foreach (array_keys($components) as $type) {
1912 $query[] = "SELECT {$t['component']}.name as name,
1914 {$t['component']}.id as id
1915 FROM {$t['component']}
1916 INNER JOIN {$t['mailing']}
1917 ON {$t['mailing']}.{$type}_id =
1918 {$t['component']}.id
1919 WHERE {$t['mailing']}.id = $mailing_id";
1921 $q = '(' . implode(') UNION (', $query) . ')';
1922 $mailing->query($q);
1924 $report['component'] = array();
1925 while ($mailing->fetch()) {
1926 $report['component'][] = array(
1927 'type' => $components[$mailing->type
],
1928 'name' => $mailing->name
,
1929 'link' => CRM_Utils_System
::url('civicrm/mailing/component',
1930 "reset=1&action=update&id={$mailing->id}"
1935 /* Get the recipient group info */
1938 SELECT {$t['mailing_group']}.group_type as group_type,
1939 {$t['group']}.id as group_id,
1940 {$t['group']}.title as group_title,
1941 {$t['group']}.is_hidden as group_hidden,
1942 {$t['mailing']}.id as mailing_id,
1943 {$t['mailing']}.name as mailing_name
1944 FROM {$t['mailing_group']}
1945 LEFT JOIN {$t['group']}
1946 ON {$t['mailing_group']}.entity_id = {$t['group']}.id
1947 AND {$t['mailing_group']}.entity_table =
1949 LEFT JOIN {$t['mailing']}
1950 ON {$t['mailing_group']}.entity_id =
1952 AND {$t['mailing_group']}.entity_table =
1955 WHERE {$t['mailing_group']}.mailing_id = $mailing_id
1958 $report['group'] = array('include' => array(), 'exclude' => array(), 'base' => array());
1959 while ($mailing->fetch()) {
1961 if (isset($mailing->group_id
)) {
1962 $row['id'] = $mailing->group_id
;
1963 $row['name'] = $mailing->group_title
;
1964 $row['link'] = CRM_Utils_System
::url('civicrm/group/search',
1965 "reset=1&force=1&context=smog&gid={$row['id']}"
1969 $row['id'] = $mailing->mailing_id
;
1970 $row['name'] = $mailing->mailing_name
;
1971 $row['mailing'] = TRUE;
1972 $row['link'] = CRM_Utils_System
::url('civicrm/mailing/report',
1977 /* Rename hidden groups */
1979 if ($mailing->group_hidden
== 1) {
1980 $row['name'] = "Search Results";
1983 if ($mailing->group_type
== 'Include') {
1984 $report['group']['include'][] = $row;
1986 elseif ($mailing->group_type
== 'Base') {
1987 $report['group']['base'][] = $row;
1990 $report['group']['exclude'][] = $row;
1994 /* Get the event totals, grouped by job (retries) */
1997 SELECT {$t['job']}.*,
1998 COUNT(DISTINCT {$t['queue']}.id) as queue,
1999 COUNT(DISTINCT {$t['delivered']}.id) as delivered,
2000 COUNT(DISTINCT {$t['reply']}.id) as reply,
2001 COUNT(DISTINCT {$t['forward']}.id) as forward,
2002 COUNT(DISTINCT {$t['bounce']}.id) as bounce,
2003 COUNT(DISTINCT {$t['urlopen']}.id) as url,
2004 COUNT(DISTINCT {$t['spool']}.id) as spool
2006 LEFT JOIN {$t['queue']}
2007 ON {$t['queue']}.job_id = {$t['job']}.id
2008 LEFT JOIN {$t['reply']}
2009 ON {$t['reply']}.event_queue_id = {$t['queue']}.id
2010 LEFT JOIN {$t['forward']}
2011 ON {$t['forward']}.event_queue_id = {$t['queue']}.id
2012 LEFT JOIN {$t['bounce']}
2013 ON {$t['bounce']}.event_queue_id = {$t['queue']}.id
2014 LEFT JOIN {$t['delivered']}
2015 ON {$t['delivered']}.event_queue_id = {$t['queue']}.id
2016 AND {$t['bounce']}.id IS null
2017 LEFT JOIN {$t['urlopen']}
2018 ON {$t['urlopen']}.event_queue_id = {$t['queue']}.id
2019 LEFT JOIN {$t['spool']}
2020 ON {$t['spool']}.job_id = {$t['job']}.id
2021 WHERE {$t['job']}.mailing_id = $mailing_id
2022 AND {$t['job']}.is_test = 0
2023 GROUP BY {$t['job']}.id");
2025 $report['jobs'] = array();
2026 $report['event_totals'] = array();
2040 // initialize various counters
2041 foreach ($elements as $field) {
2042 $report['event_totals'][$field] = 0;
2045 while ($mailing->fetch()) {
2047 foreach ($elements as $field) {
2048 if (isset($mailing->$field)) {
2049 $row[$field] = $mailing->$field;
2050 $report['event_totals'][$field] +
= $mailing->$field;
2054 // compute open total separately to discount duplicates
2056 $row['opened'] = CRM_Mailing_Event_BAO_Opened
::getTotalCount($mailing_id, $mailing->id
, TRUE);
2057 $report['event_totals']['opened'] +
= $row['opened'];
2059 // compute unsub total separately to discount duplicates
2061 $row['unsubscribe'] = CRM_Mailing_Event_BAO_Unsubscribe
::getTotalCount($mailing_id, $mailing->id
, TRUE, TRUE);
2062 $report['event_totals']['unsubscribe'] +
= $row['unsubscribe'];
2064 $row['optout'] = CRM_Mailing_Event_BAO_Unsubscribe
::getTotalCount($mailing_id, $mailing->id
, TRUE, FALSE);
2065 $report['event_totals']['optout'] +
= $row['optout'];
2067 foreach (array_keys(CRM_Mailing_BAO_MailingJob
::fields()) as $field) {
2068 $row[$field] = $mailing->$field;
2071 if ($mailing->queue
) {
2072 $row['delivered_rate'] = (100.0 * $mailing->delivered
) / $mailing->queue
;
2073 $row['bounce_rate'] = (100.0 * $mailing->bounce
) / $mailing->queue
;
2074 $row['unsubscribe_rate'] = (100.0 * $row['unsubscribe']) / $mailing->queue
;
2075 $row['optout_rate'] = (100.0 * $row['optout']) / $mailing->queue
;
2078 $row['delivered_rate'] = 0;
2079 $row['bounce_rate'] = 0;
2080 $row['unsubscribe_rate'] = 0;
2081 $row['optout_rate'] = 0;
2084 $row['links'] = array(
2085 'clicks' => CRM_Utils_System
::url(
2086 'civicrm/mailing/report/event',
2087 "reset=1&event=click&mid=$mailing_id&jid={$mailing->id}"
2089 'queue' => CRM_Utils_System
::url(
2090 'civicrm/mailing/report/event',
2091 "reset=1&event=queue&mid=$mailing_id&jid={$mailing->id}"
2093 'delivered' => CRM_Utils_System
::url(
2094 'civicrm/mailing/report/event',
2095 "reset=1&event=delivered&mid=$mailing_id&jid={$mailing->id}"
2097 'bounce' => CRM_Utils_System
::url(
2098 'civicrm/mailing/report/event',
2099 "reset=1&event=bounce&mid=$mailing_id&jid={$mailing->id}"
2101 'unsubscribe' => CRM_Utils_System
::url(
2102 'civicrm/mailing/report/event',
2103 "reset=1&event=unsubscribe&mid=$mailing_id&jid={$mailing->id}"
2105 'forward' => CRM_Utils_System
::url(
2106 'civicrm/mailing/report/event',
2107 "reset=1&event=forward&mid=$mailing_id&jid={$mailing->id}"
2109 'reply' => CRM_Utils_System
::url(
2110 'civicrm/mailing/report/event',
2111 "reset=1&event=reply&mid=$mailing_id&jid={$mailing->id}"
2113 'opened' => CRM_Utils_System
::url(
2114 'civicrm/mailing/report/event',
2115 "reset=1&event=opened&mid=$mailing_id&jid={$mailing->id}"
2124 $row[$key] = CRM_Utils_Date
::customFormat($row[$key]);
2126 $report['jobs'][] = $row;
2129 $newTableSize = CRM_Mailing_BAO_Recipients
::mailingSize($mailing_id);
2131 // we need to do this for backward compatibility, since old mailings did not
2132 // use the mailing_recipients table
2133 if ($newTableSize > 0) {
2134 $report['event_totals']['queue'] = $newTableSize;
2137 $report['event_totals']['queue'] = self
::getRecipientsCount($mailing_id, $mailing_id);
2140 if (!empty($report['event_totals']['queue'])) {
2141 $report['event_totals']['delivered_rate'] = (100.0 * $report['event_totals']['delivered']) / $report['event_totals']['queue'];
2142 $report['event_totals']['bounce_rate'] = (100.0 * $report['event_totals']['bounce']) / $report['event_totals']['queue'];
2143 $report['event_totals']['unsubscribe_rate'] = (100.0 * $report['event_totals']['unsubscribe']) / $report['event_totals']['queue'];
2144 $report['event_totals']['optout_rate'] = (100.0 * $report['event_totals']['optout']) / $report['event_totals']['queue'];
2147 $report['event_totals']['delivered_rate'] = 0;
2148 $report['event_totals']['bounce_rate'] = 0;
2149 $report['event_totals']['unsubscribe_rate'] = 0;
2150 $report['event_totals']['optout_rate'] = 0;
2153 /* Get the click-through totals, grouped by URL */
2156 SELECT {$t['url']}.url,
2158 COUNT({$t['urlopen']}.id) as clicks,
2159 COUNT(DISTINCT {$t['queue']}.id) as unique_clicks
2161 LEFT JOIN {$t['urlopen']}
2162 ON {$t['urlopen']}.trackable_url_id = {$t['url']}.id
2163 LEFT JOIN {$t['queue']}
2164 ON {$t['urlopen']}.event_queue_id = {$t['queue']}.id
2165 LEFT JOIN {$t['job']}
2166 ON {$t['queue']}.job_id = {$t['job']}.id
2167 WHERE {$t['url']}.mailing_id = $mailing_id
2168 AND {$t['job']}.is_test = 0
2169 GROUP BY {$t['url']}.id");
2171 $report['click_through'] = array();
2173 while ($mailing->fetch()) {
2174 $report['click_through'][] = array(
2175 'url' => $mailing->url
,
2176 'link' => CRM_Utils_System
::url(
2177 'civicrm/mailing/report/event',
2178 "reset=1&event=click&mid=$mailing_id&uid={$mailing->id}"
2180 'link_unique' => CRM_Utils_System
::url(
2181 'civicrm/mailing/report/event',
2182 "reset=1&event=click&mid=$mailing_id&uid={$mailing->id}&distinct=1"
2184 'clicks' => $mailing->clicks
,
2185 'unique' => $mailing->unique_clicks
,
2186 'rate' => CRM_Utils_Array
::value('delivered', $report['event_totals']) ?
(100.0 * $mailing->unique_clicks
) / $report['event_totals']['delivered'] : 0,
2190 $report['event_totals']['links'] = array(
2191 'clicks' => CRM_Utils_System
::url(
2192 'civicrm/mailing/report/event',
2193 "reset=1&event=click&mid=$mailing_id"
2195 'clicks_unique' => CRM_Utils_System
::url(
2196 'civicrm/mailing/report/event',
2197 "reset=1&event=click&mid=$mailing_id&distinct=1"
2199 'queue' => CRM_Utils_System
::url(
2200 'civicrm/mailing/report/event',
2201 "reset=1&event=queue&mid=$mailing_id"
2203 'delivered' => CRM_Utils_System
::url(
2204 'civicrm/mailing/report/event',
2205 "reset=1&event=delivered&mid=$mailing_id"
2207 'bounce' => CRM_Utils_System
::url(
2208 'civicrm/mailing/report/event',
2209 "reset=1&event=bounce&mid=$mailing_id"
2211 'unsubscribe' => CRM_Utils_System
::url(
2212 'civicrm/mailing/report/event',
2213 "reset=1&event=unsubscribe&mid=$mailing_id"
2215 'optout' => CRM_Utils_System
::url(
2216 'civicrm/mailing/report/event',
2217 "reset=1&event=optout&mid=$mailing_id"
2219 'forward' => CRM_Utils_System
::url(
2220 'civicrm/mailing/report/event',
2221 "reset=1&event=forward&mid=$mailing_id"
2223 'reply' => CRM_Utils_System
::url(
2224 'civicrm/mailing/report/event',
2225 "reset=1&event=reply&mid=$mailing_id"
2227 'opened' => CRM_Utils_System
::url(
2228 'civicrm/mailing/report/event',
2229 "reset=1&event=opened&mid=$mailing_id"
2233 $actionLinks = array(CRM_Core_Action
::VIEW
=> array('name' => ts('Report')));
2234 if (CRM_Core_Permission
::check('view all contacts')) {
2235 $actionLinks[CRM_Core_Action
::ADVANCED
] = array(
2236 'name' => ts('Advanced Search'),
2237 'url' => 'civicrm/contact/search/advanced',
2240 $action = array_sum(array_keys($actionLinks));
2242 $report['event_totals']['actionlinks'] = array();
2255 $url = 'mailing/detail';
2256 $reportFilter = "reset=1&mailing_id_value={$mailing_id}";
2257 $searchFilter = "force=1&mailing_id=%%mid%%";
2260 $reportFilter .= "&delivery_status_value=successful";
2261 $searchFilter .= "&mailing_delivery_status=Y";
2265 $url = "mailing/bounce";
2266 $searchFilter .= "&mailing_delivery_status=N";
2270 $reportFilter .= "&is_forwarded_value=1";
2271 $searchFilter .= "&mailing_forward=1";
2275 $reportFilter .= "&is_replied_value=1";
2276 $searchFilter .= "&mailing_reply_status=Y";
2280 $reportFilter .= "&is_unsubscribed_value=1";
2281 $searchFilter .= "&mailing_unsubscribe=1";
2285 $reportFilter .= "&is_optout_value=1";
2286 $searchFilter .= "&mailing_optout=1";
2290 $url = "mailing/opened";
2291 $searchFilter .= "&mailing_open_status=Y";
2295 case 'clicks_unique':
2296 $url = "mailing/clicks";
2297 $searchFilter .= "&mailing_click_status=Y";
2300 $actionLinks[CRM_Core_Action
::VIEW
]['url'] = CRM_Report_Utils_Report
::getNextUrl($url, $reportFilter, FALSE, TRUE);
2301 if (array_key_exists(CRM_Core_Action
::ADVANCED
, $actionLinks)) {
2302 $actionLinks[CRM_Core_Action
::ADVANCED
]['qs'] = $searchFilter;
2304 $report['event_totals']['actionlinks'][$key] = CRM_Core_Action
::formLink(
2307 array('mid' => $mailing_id),
2310 'mailing.report.action',
2320 * Get the count of mailings.
2327 public function getCount() {
2329 $this->selectAdd('COUNT(id) as count');
2331 $session = CRM_Core_Session
::singleton();
2334 return $this->count
;
2342 public static function checkPermission($id) {
2347 $mailingIDs = self
::mailingACLIDs();
2348 if ($mailingIDs === TRUE) {
2352 if (!in_array($id, $mailingIDs)) {
2353 CRM_Core_Error
::fatal(ts('You do not have permission to access this mailing report'));
2358 * @param null $alias
2362 public static function mailingACL($alias = NULL) {
2363 $mailingACL = " ( 0 ) ";
2365 $mailingIDs = self
::mailingACLIDs();
2366 if ($mailingIDs === TRUE) {
2370 if (!empty($mailingIDs)) {
2371 $mailingIDs = implode(',', $mailingIDs);
2372 $tableName = !$alias ? self
::getTableName() : $alias;
2373 $mailingACL = " $tableName.id IN ( $mailingIDs ) ";
2379 * Returns all the mailings that this user can access. This is dependent on
2380 * all the groups that the user has access to.
2381 * However since most civi installs dont use ACL's we special case the condition
2382 * where the user has access to ALL groups, and hence ALL mailings and return a
2383 * value of TRUE (to avoid the downstream where clause with a list of mailing list IDs
2385 * @return bool|array
2386 * TRUE if the user has access to all mailings, else array of mailing IDs (possibly empty).
2388 public static function mailingACLIDs() {
2390 // optimize common case where admin has access
2393 CRM_Core_Permission
::check('view all contacts') ||
2394 CRM_Core_Permission
::check('edit all contacts')
2399 $mailingIDs = array();
2401 // get all the groups that this user can access
2402 // if they dont have universal access
2403 $groups = CRM_Core_PseudoConstant
::group(NULL, FALSE);
2404 if (!empty($groups)) {
2405 $groupIDs = implode(',', array_keys($groups));
2407 // get all the mailings that are in this subset of groups
2409 SELECT DISTINCT( m.id ) as id
2410 FROM civicrm_mailing m
2411 LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id
2412 WHERE ( ( g.entity_table like 'civicrm_group%' AND g.entity_id IN ( $groupIDs ) )
2413 OR ( g.entity_table IS NULL AND g.entity_id IS NULL ) )
2415 $dao = CRM_Core_DAO
::executeQuery($query);
2417 $mailingIDs = array();
2418 while ($dao->fetch()) {
2419 $mailingIDs[] = $dao->id
;
2427 * Get the rows for a browse operation.
2429 * @param int $offset
2430 * The row number to start from.
2431 * @param int $rowCount
2432 * The nmber of rows to return.
2433 * @param string $sort
2434 * The sql string that describes the sort order.
2436 * @param null $additionalClause
2437 * @param array $additionalParams
2442 public function &getRows($offset, $rowCount, $sort, $additionalClause = NULL, $additionalParams = NULL) {
2443 $mailing = self
::getTableName();
2444 $job = CRM_Mailing_BAO_MailingJob
::getTableName();
2445 $group = CRM_Mailing_DAO_MailingGroup
::getTableName();
2446 $session = CRM_Core_Session
::singleton();
2448 $mailingACL = self
::mailingACL();
2450 //get all campaigns.
2451 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
2453 // we only care about parent jobs, since that holds all the info on
2459 $mailing.approval_status_id,
2460 MIN($job.scheduled_date) as scheduled_date,
2461 MIN($job.start_date) as start_date,
2462 MAX($job.end_date) as end_date,
2463 createdContact.sort_name as created_by,
2464 scheduledContact.sort_name as scheduled_by,
2465 $mailing.created_id as created_id,
2466 $mailing.scheduled_id as scheduled_id,
2467 $mailing.is_archived as archived,
2468 $mailing.created_date as created_date,
2470 $mailing.sms_provider_id as sms_provider_id
2472 LEFT JOIN $job ON ( $job.mailing_id = $mailing.id AND $job.is_test = 0 AND $job.parent_id IS NULL )
2473 LEFT JOIN civicrm_contact createdContact ON ( civicrm_mailing.created_id = createdContact.id )
2474 LEFT JOIN civicrm_contact scheduledContact ON ( civicrm_mailing.scheduled_id = scheduledContact.id )
2475 WHERE $mailingACL $additionalClause
2476 GROUP BY $mailing.id ";
2479 $orderBy = trim($sort->orderBy());
2480 if (!empty($orderBy)) {
2481 $query .= " ORDER BY $orderBy";
2486 $offset = CRM_Utils_Type
::escape($offset, 'Int');
2487 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
2489 $query .= " LIMIT $offset, $rowCount ";
2492 if (!$additionalParams) {
2493 $additionalParams = array();
2496 $dao = CRM_Core_DAO
::executeQuery($query, $additionalParams);
2499 while ($dao->fetch()) {
2502 'name' => $dao->name
,
2503 'status' => $dao->status ?
$dao->status
: 'Not scheduled',
2504 'created_date' => CRM_Utils_Date
::customFormat($dao->created_date
),
2505 'scheduled' => CRM_Utils_Date
::customFormat($dao->scheduled_date
),
2506 'scheduled_iso' => $dao->scheduled_date
,
2507 'start' => CRM_Utils_Date
::customFormat($dao->start_date
),
2508 'end' => CRM_Utils_Date
::customFormat($dao->end_date
),
2509 'created_by' => $dao->created_by
,
2510 'scheduled_by' => $dao->scheduled_by
,
2511 'created_id' => $dao->created_id
,
2512 'scheduled_id' => $dao->scheduled_id
,
2513 'archived' => $dao->archived
,
2514 'approval_status_id' => $dao->approval_status_id
,
2515 'campaign_id' => $dao->campaign_id
,
2516 'campaign' => empty($dao->campaign_id
) ?
NULL : $allCampaigns[$dao->campaign_id
],
2517 'sms_provider_id' => $dao->sms_provider_id
,
2524 * Show detail Mailing report.
2530 public static function showEmailDetails($id) {
2531 return CRM_Utils_System
::url('civicrm/mailing/report', "mid=$id");
2535 * Delete Mails and all its associated records.
2538 * Id of the mail to delete.
2542 public static function del($id) {
2544 CRM_Core_Error
::fatal();
2547 CRM_Utils_Hook
::pre('delete', 'Mailing', $id, CRM_Core_DAO
::$_nullArray);
2549 // delete all file attachments
2550 CRM_Core_BAO_File
::deleteEntityFile('civicrm_mailing',
2554 $dao = new CRM_Mailing_DAO_Mailing();
2558 CRM_Core_Session
::setStatus(ts('Selected mailing has been deleted.'), ts('Deleted'), 'success');
2560 CRM_Utils_Hook
::post('delete', 'Mailing', $id, $dao);
2564 * Delete Jobss and all its associated records
2565 * related to test Mailings
2568 * Id of the Job to delete.
2572 public static function delJob($id) {
2574 CRM_Core_Error
::fatal();
2577 $dao = new CRM_Mailing_BAO_MailingJob();
2585 public function getReturnProperties() {
2586 $tokens = &$this->getTokens();
2588 $properties = array();
2589 if (isset($tokens['html']) &&
2590 isset($tokens['html']['contact'])
2592 $properties = array_merge($properties, $tokens['html']['contact']);
2595 if (isset($tokens['text']) &&
2596 isset($tokens['text']['contact'])
2598 $properties = array_merge($properties, $tokens['text']['contact']);
2601 if (isset($tokens['subject']) &&
2602 isset($tokens['subject']['contact'])
2604 $properties = array_merge($properties, $tokens['subject']['contact']);
2607 $returnProperties = array();
2608 $returnProperties['display_name'] = $returnProperties['contact_id'] = $returnProperties['preferred_mail_format'] = $returnProperties['hash'] = 1;
2610 foreach ($properties as $p) {
2611 $returnProperties[$p] = 1;
2614 return $returnProperties;
2618 * Build the compose mail form.
2620 * @param CRM_Core_Form $form
2624 public static function commonCompose(&$form) {
2628 if (method_exists($form, 'listTokens')) {
2629 $tokens = array_merge($form->listTokens(), $tokens);
2632 //sorted in ascending order tokens by ignoring word case
2633 $form->assign('tokens', CRM_Utils_Token
::formatTokensForDisplay($tokens));
2635 $templates = array();
2637 $textFields = array('text_message' => ts('HTML Format'), 'sms_text_message' => ts('SMS Message'));
2638 $modePrefixes = array('Mail' => NULL, 'SMS' => 'SMS');
2640 $className = CRM_Utils_System
::getClassName($form);
2642 if ($className != 'CRM_SMS_Form_Upload' && $className != 'CRM_Contact_Form_Task_SMS' &&
2643 $className != 'CRM_Contact_Form_Task_SMS'
2645 $form->add('wysiwyg', 'html_message',
2650 'onkeyup' => "return verify(this)",
2654 if ($className != 'CRM_Admin_Form_ScheduleReminders') {
2655 unset($modePrefixes['SMS']);
2659 unset($textFields['text_message']);
2660 unset($modePrefixes['Mail']);
2663 //insert message Text by selecting "Select Template option"
2664 foreach ($textFields as $id => $label) {
2666 if ($id == 'sms_text_message') {
2668 $form->assign('max_sms_length', CRM_SMS_Provider
::MAX_SMS_CHAR
);
2670 $form->add('textarea', $id, $label,
2674 'onkeyup' => "return verify(this, '{$prefix}')",
2679 foreach ($modePrefixes as $prefix) {
2680 if ($prefix == 'SMS') {
2681 $templates[$prefix] = CRM_Core_BAO_MessageTemplate
::getMessageTemplates(FALSE, TRUE);
2684 $templates[$prefix] = CRM_Core_BAO_MessageTemplate
::getMessageTemplates(FALSE);
2686 if (!empty($templates[$prefix])) {
2687 $form->assign('templates', TRUE);
2689 $form->add('select', "{$prefix}template", ts('Use Template'),
2690 array('' => ts('- select -')) +
$templates[$prefix], FALSE,
2691 array('onChange' => "selectValue( this.value, '{$prefix}');")
2694 $form->add('checkbox', "{$prefix}updateTemplate", ts('Update Template'), NULL);
2696 $form->add('checkbox', "{$prefix}saveTemplate", ts('Save As New Template'), NULL, FALSE,
2697 array('onclick' => "showSaveDetails(this, '{$prefix}');")
2699 $form->add('text', "{$prefix}saveTemplateName", ts('Template Title'));
2702 // I'm not sure this is ever called.
2703 $action = CRM_Utils_Request
::retrieve('action', 'String', $form, FALSE);
2704 if ((CRM_Utils_System
::getClassName($form) == 'CRM_Contact_Form_Task_PDF') &&
2705 $action == CRM_Core_Action
::VIEW
2707 $form->freeze('html_message');
2712 * Get the search based mailing Ids.
2715 * , searched base mailing ids.
2717 public function searchMailingIDs() {
2718 $group = CRM_Mailing_DAO_MailingGroup
::getTableName();
2719 $mailing = self
::getTableName();
2722 SELECT $mailing.id as mailing_id
2723 FROM $mailing, $group
2724 WHERE $group.mailing_id = $mailing.id
2725 AND $group.group_type = 'Base'";
2727 $searchDAO = CRM_Core_DAO
::executeQuery($query);
2728 $mailingIDs = array();
2729 while ($searchDAO->fetch()) {
2730 $mailingIDs[] = $searchDAO->mailing_id
;
2737 * Get the content/components of mailing based on mailing Id
2739 * @param array $report
2740 * of mailing report.
2743 * Reference of this.
2745 * @param bool $isSMS
2748 * array content/component.
2750 public static function getMailingContent(&$report, &$form, $isSMS = FALSE) {
2751 $htmlHeader = $textHeader = NULL;
2752 $htmlFooter = $textFooter = NULL;
2755 if ($report['mailing']['header_id']) {
2756 $header = new CRM_Mailing_BAO_Component();
2757 $header->id
= $report['mailing']['header_id'];
2758 $header->find(TRUE);
2759 $htmlHeader = $header->body_html
;
2760 $textHeader = $header->body_text
;
2763 if ($report['mailing']['footer_id']) {
2764 $footer = new CRM_Mailing_BAO_Component();
2765 $footer->id
= $report['mailing']['footer_id'];
2766 $footer->find(TRUE);
2767 $htmlFooter = $footer->body_html
;
2768 $textFooter = $footer->body_text
;
2772 $mailingKey = $form->_mailing_id
;
2774 if ($hash = CRM_Mailing_BAO_Mailing
::getMailingHash($mailingKey)) {
2775 $mailingKey = $hash;
2779 if (!empty($report['mailing']['body_text'])) {
2780 $url = CRM_Utils_System
::url('civicrm/mailing/view', 'reset=1&text=1&id=' . $mailingKey);
2781 $form->assign('textViewURL', $url);
2785 if (!empty($report['mailing']['body_html'])) {
2786 $url = CRM_Utils_System
::url('civicrm/mailing/view', 'reset=1&id=' . $mailingKey);
2787 $form->assign('htmlViewURL', $url);
2792 $report['mailing']['attachment'] = CRM_Core_BAO_File
::attachmentInfo('civicrm_mailing', $form->_mailing_id
);
2802 public static function overrideVerp($jobID) {
2803 static $_cache = array();
2805 if (!isset($_cache[$jobID])) {
2807 SELECT override_verp
2808 FROM civicrm_mailing
2809 INNER JOIN civicrm_mailing_job ON civicrm_mailing.id = civicrm_mailing_job.mailing_id
2810 WHERE civicrm_mailing_job.id = %1
2812 $params = array(1 => array($jobID, 'Integer'));
2813 $_cache[$jobID] = CRM_Core_DAO
::singleValueQuery($query, $params);
2815 return $_cache[$jobID];
2824 public static function processQueue($mode = NULL) {
2825 $config = CRM_Core_Config
::singleton();
2827 if ($mode == NULL && CRM_Core_BAO_MailSettings
::defaultDomain() == "EXAMPLE.ORG") {
2828 throw new CRM_Core_Exception(ts('The <a href="%1">default mailbox</a> has not been configured. You will find <a href="%2">more info in the online user and administrator guide</a>', array(
2829 1 => CRM_Utils_System
::url('civicrm/admin/mailSettings', 'reset=1'),
2830 2 => "http://book.civicrm.org/user/advanced-configuration/email-system-configuration/",
2834 // check if we are enforcing number of parallel cron jobs
2836 $gotCronLock = FALSE;
2838 if (property_exists($config, 'mailerJobsMax') && $config->mailerJobsMax
&& $config->mailerJobsMax
> 0) {
2839 $lockArray = range(1, $config->mailerJobsMax
);
2840 shuffle($lockArray);
2842 // check if we are using global locks
2843 foreach ($lockArray as $lockID) {
2844 $cronLock = Civi\Core\Container
::singleton()->get('lockManager')->acquire("worker.mailing.send.{$lockID}");
2845 if ($cronLock->isAcquired()) {
2846 $gotCronLock = TRUE;
2851 // exit here since we have enuf cronjobs running
2852 if (!$gotCronLock) {
2853 CRM_Core_Error
::debug_log_message('Returning early, since max number of cronjobs running');
2857 if (getenv('CIVICRM_CRON_HOLD')) {
2858 // In testing, we may need to simulate some slow activities.
2859 sleep(getenv('CIVICRM_CRON_HOLD'));
2863 // load bootstrap to call hooks
2865 // Split up the parent jobs into multiple child jobs
2866 $mailerJobSize = (property_exists($config, 'mailerJobSize')) ?
$config->mailerJobSize
: NULL;
2867 CRM_Mailing_BAO_MailingJob
::runJobs_pre($mailerJobSize, $mode);
2868 CRM_Mailing_BAO_MailingJob
::runJobs(NULL, $mode);
2869 CRM_Mailing_BAO_MailingJob
::runJobs_post($mode);
2871 // lets release the global cron lock if we do have one
2873 $cronLock->release();
2880 * @param int $mailingID
2882 private static function addMultipleEmails($mailingID) {
2884 INSERT INTO civicrm_mailing_recipients
2885 (mailing_id, email_id, contact_id)
2886 SELECT %1, e.id, e.contact_id FROM civicrm_email e
2888 AND e.is_bulkmail = 1
2890 ( SELECT contact_id FROM civicrm_mailing_recipients mr WHERE mailing_id = %1 )
2891 AND e.id NOT IN ( SELECT email_id FROM civicrm_mailing_recipients mr WHERE mailing_id = %1 )
2893 $params = array(1 => array($mailingID, 'Integer'));
2895 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
2899 * @param bool $isSMS
2903 public static function getMailingsList($isSMS = FALSE) {
2904 static $list = array();
2907 $where .= " civicrm_mailing.sms_provider_id IS NULL ";
2910 $where .= " civicrm_mailing.sms_provider_id IS NOT NULL ";
2915 SELECT civicrm_mailing.id, civicrm_mailing.name, civicrm_mailing_job.end_date
2916 FROM civicrm_mailing
2917 INNER JOIN civicrm_mailing_job ON civicrm_mailing.id = civicrm_mailing_job.mailing_id {$where}
2918 ORDER BY civicrm_mailing.name";
2919 $mailing = CRM_Core_DAO
::executeQuery($query);
2921 while ($mailing->fetch()) {
2922 $list[$mailing->id
] = "{$mailing->name} :: {$mailing->end_date}";
2932 * @return null|string
2934 public static function hiddenMailingGroup($mid) {
2937 FROM civicrm_mailing m
2938 INNER JOIN civicrm_mailing_group mg ON mg.mailing_id = m.id
2939 INNER JOIN civicrm_group g ON mg.entity_id = g.id AND mg.entity_table = 'civicrm_group'
2940 WHERE g.is_hidden = 1
2941 AND mg.group_type = 'Include'
2944 $params = array(1 => array($mid, 'Integer'));
2945 return CRM_Core_DAO
::singleValueQuery($sql, $params);
2949 * wrapper for ajax activity selector.
2951 * @param array $params
2952 * Associated array for params record id.
2955 * associated array of contact activities
2957 public static function getContactMailingSelector(&$params) {
2958 // format the params
2959 $params['offset'] = ($params['page'] - 1) * $params['rp'];
2960 $params['rowCount'] = $params['rp'];
2961 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
2962 $params['caseId'] = NULL;
2964 // get contact mailings
2965 $mailings = CRM_Mailing_BAO_Mailing
::getContactMailings($params);
2968 $params['total'] = CRM_Mailing_BAO_Mailing
::getContactMailingsCount($params);
2971 if (!empty($mailings)) {
2972 $openCounts = CRM_Mailing_Event_BAO_Opened
::getMailingContactCount(array_keys($mailings), $params['contact_id']);
2973 $clickCounts = CRM_Mailing_Event_BAO_TrackableURLOpen
::getMailingContactCount(array_keys($mailings), $params['contact_id']);
2976 // format params and add links
2977 $contactMailings = array();
2978 foreach ($mailings as $mailingId => $values) {
2980 $mailing['subject'] = $values['subject'];
2981 $mailing['creator_name'] = CRM_Utils_System
::href(
2982 $values['creator_name'],
2983 'civicrm/contact/view',
2984 "reset=1&cid={$values['creator_id']}");
2985 $mailing['recipients'] = CRM_Utils_System
::href(ts('(recipients)'), 'civicrm/mailing/report/event',
2986 "mid={$values['mailing_id']}&reset=1&cid={$params['contact_id']}&event=queue&context=mailing");
2987 $mailing['start_date'] = CRM_Utils_Date
::customFormat($values['start_date']);
2989 $mailing['openstats'] = "Opens: " .
2990 CRM_Utils_Array
::value($values['mailing_id'], $openCounts, 0) .
2992 CRM_Utils_Array
::value($values['mailing_id'], $clickCounts, 0);
2994 $actionLinks = array(
2995 CRM_Core_Action
::VIEW
=> array(
2996 'name' => ts('View'),
2997 'url' => 'civicrm/mailing/view',
2998 'qs' => "reset=1&id=%%mkey%%",
2999 'title' => ts('View Mailing'),
3000 'class' => 'crm-popup',
3002 CRM_Core_Action
::BROWSE
=> array(
3003 'name' => ts('Mailing Report'),
3004 'url' => 'civicrm/mailing/report',
3005 'qs' => "mid=%%mid%%&reset=1&cid=%%cid%%&context=mailing",
3006 'title' => ts('View Mailing Report'),
3010 $mailingKey = $values['mailing_id'];
3011 if ($hash = CRM_Mailing_BAO_Mailing
::getMailingHash($mailingKey)) {
3012 $mailingKey = $hash;
3015 $mailing['links'] = CRM_Core_Action
::formLink(
3019 'mid' => $values['mailing_id'],
3020 'cid' => $params['contact_id'],
3021 'mkey' => $mailingKey,
3025 'mailing.contact.action',
3027 $values['mailing_id']
3030 array_push($contactMailings, $mailing);
3033 $contactMailingsDT = array();
3034 $contactMailingsDT['data'] = $contactMailings;
3035 $contactMailingsDT['recordsTotal'] = $params['total'];
3036 $contactMailingsDT['recordsFiltered'] = $params['total'];
3038 return $contactMailingsDT;
3042 * Retrieve contact mailing.
3044 * @param array $params
3047 * Array of mailings for a contact
3050 static public function getContactMailings(&$params) {
3051 $params['version'] = 3;
3052 $params['offset'] = ($params['page'] - 1) * $params['rp'];
3053 $params['limit'] = $params['rp'];
3054 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
3056 $result = civicrm_api('MailingContact', 'get', $params);
3057 return $result['values'];
3061 * Retrieve contact mailing count.
3063 * @param array $params
3066 * count of mailings for a contact
3069 static public function getContactMailingsCount(&$params) {
3070 $params['version'] = 3;
3071 return civicrm_api('MailingContact', 'getcount', $params);
3075 * Get a list of permissions required for CRUD'ing each field
3076 * (when workflow is enabled).
3079 * Array (string $fieldName => string $permName)
3081 public static function getWorkflowFieldPerms() {
3082 $fieldNames = array_keys(CRM_Mailing_DAO_Mailing
::fields());
3083 $fieldPerms = array();
3084 foreach ($fieldNames as $fieldName) {
3085 if ($fieldName == 'id') {
3086 $fieldPerms[$fieldName] = array(
3087 array('access CiviMail', 'schedule mailings', 'approve mailings', 'create mailings'), // OR
3090 elseif (in_array($fieldName, array('scheduled_date', 'scheduled_id'))) {
3091 $fieldPerms[$fieldName] = array(
3092 array('access CiviMail', 'schedule mailings'), // OR
3095 elseif (in_array($fieldName, array('approval_date', 'approver_id', 'approval_status_id', 'approval_note'))) {
3096 $fieldPerms[$fieldName] = array(
3097 array('access CiviMail', 'approve mailings'), // OR
3101 $fieldPerms[$fieldName] = array(
3102 array('access CiviMail', 'create mailings'), // OR