3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.4 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
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-2013
35 require_once 'Mail/mime.php';
36 class CRM_Mailing_BAO_Mailing
extends CRM_Mailing_DAO_Mailing
{
39 * An array that holds the complete templates
40 * including any headers or footers that need to be prepended
41 * or appended to the body
43 private $preparedTemplates = NULL;
46 * An array that holds the complete templates
47 * including any headers or footers that need to be prepended
48 * or appended to the body
50 private $templates = NULL;
53 * An array that holds the tokens that are specifically found in our text and html bodies
55 private $tokens = NULL;
58 * An array that holds the tokens that are specifically found in our text and html bodies
60 private $flattenedTokens = NULL;
63 * The header associated with this mailing
65 private $header = NULL;
68 * The footer associated with this mailing
70 private $footer = NULL;
73 * The HTML content of the message
78 * The text content of the message
83 * Cached BAO for the domain
85 private $_domain = NULL;
90 function __construct() {
91 parent
::__construct();
94 static function &getRecipientsCount($job_id, $mailing_id = NULL, $mode = NULL) {
95 // need this for backward compatibility, so we can get count for old mailings
96 // please do not use this function if possible
97 $eq = self
::getRecipients($job_id, $mailing_id);
101 // note that $job_id is used only as a variable in the temp table construction
102 // and does not play a role in the queries generated
103 static function &getRecipients(
108 $storeRecipients = FALSE,
109 $dedupeEmail = FALSE,
111 $mailingGroup = new CRM_Mailing_DAO_MailingGroup();
113 $mailing = CRM_Mailing_BAO_Mailing
::getTableName();
114 $job = CRM_Mailing_BAO_MailingJob
::getTableName();
115 $mg = CRM_Mailing_DAO_MailingGroup
::getTableName();
116 $eq = CRM_Mailing_Event_DAO_Queue
::getTableName();
117 $ed = CRM_Mailing_Event_DAO_Delivered
::getTableName();
118 $eb = CRM_Mailing_Event_DAO_Bounce
::getTableName();
120 $email = CRM_Core_DAO_Email
::getTableName();
121 if ($mode == 'sms') {
122 $phone = CRM_Core_DAO_Phone
::getTableName();
124 $contact = CRM_Contact_DAO_Contact
::getTableName();
126 $group = CRM_Contact_DAO_Group
::getTableName();
127 $g2contact = CRM_Contact_DAO_GroupContact
::getTableName();
129 /* Create a temp table for contact exclusion */
130 $mailingGroup->query(
131 "CREATE TEMPORARY TABLE X_$job_id
132 (contact_id int primary key)
136 /* Add all the members of groups excluded from this mailing to the temp
139 $excludeSubGroup = "INSERT INTO X_$job_id (contact_id)
140 SELECT DISTINCT $g2contact.contact_id
143 ON $g2contact.group_id = $mg.entity_id AND $mg.entity_table = '$group'
145 $mg.mailing_id = {$mailing_id}
146 AND $g2contact.status = 'Added'
147 AND $mg.group_type = 'Exclude'";
148 $mailingGroup->query($excludeSubGroup);
150 /* Add all unsubscribe members of base group from this mailing to the temp
153 $unSubscribeBaseGroup = "INSERT INTO X_$job_id (contact_id)
154 SELECT DISTINCT $g2contact.contact_id
157 ON $g2contact.group_id = $mg.entity_id AND $mg.entity_table = '$group'
159 $mg.mailing_id = {$mailing_id}
160 AND $g2contact.status = 'Removed'
161 AND $mg.group_type = 'Base'";
162 $mailingGroup->query($unSubscribeBaseGroup);
164 /* Add all the (intended) recipients of an excluded prior mailing to
167 $excludeSubMailing = "INSERT IGNORE INTO X_$job_id (contact_id)
168 SELECT DISTINCT $eq.contact_id
171 ON $eq.job_id = $job.id
173 ON $job.mailing_id = $mg.entity_id AND $mg.entity_table = '$mailing'
175 $mg.mailing_id = {$mailing_id}
176 AND $mg.group_type = 'Exclude'";
177 $mailingGroup->query($excludeSubMailing);
179 // get all the saved searches AND hierarchical groups
180 // and load them in the cache
182 SELECT $group.id, $group.cache_date, $group.saved_search_id, $group.children
184 INNER JOIN $mg ON $mg.entity_id = $group.id
185 WHERE $mg.entity_table = '$group'
186 AND $mg.group_type = 'Exclude'
187 AND $mg.mailing_id = {$mailing_id}
188 AND ( saved_search_id != 0
189 OR saved_search_id IS NOT NULL
190 OR children IS NOT NULL )
193 $groupDAO = CRM_Core_DAO
::executeQuery($sql);
194 while ($groupDAO->fetch()) {
195 if ($groupDAO->cache_date
== NULL) {
196 CRM_Contact_BAO_GroupContactCache
::load($groupDAO);
199 $smartGroupExclude = "
200 INSERT IGNORE INTO X_$job_id (contact_id)
202 FROM civicrm_group_contact_cache c
203 WHERE c.group_id = {$groupDAO->id}
205 $mailingGroup->query($smartGroupExclude);
208 $tempColumn = 'email_id';
209 if ($mode == 'sms') {
210 $tempColumn = 'phone_id';
213 /* Get all the group contacts we want to include */
215 $mailingGroup->query(
216 "CREATE TEMPORARY TABLE I_$job_id
217 ($tempColumn int, contact_id int primary key)
221 /* Get the group contacts, but only those which are not in the
222 * exclusion temp table */
224 $query = "REPLACE INTO I_$job_id (email_id, contact_id)
226 SELECT DISTINCT $email.id as email_id,
227 $contact.id as contact_id
230 ON $email.contact_id = $contact.id
231 INNER JOIN $g2contact
232 ON $contact.id = $g2contact.contact_id
234 ON $g2contact.group_id = $mg.entity_id
235 AND $mg.entity_table = '$group'
237 ON $contact.id = X_$job_id.contact_id
239 ($mg.group_type = 'Include')
240 AND $mg.search_id IS NULL
241 AND $g2contact.status = 'Added'
242 AND $contact.do_not_email = 0
243 AND $contact.is_opt_out = 0
244 AND $contact.is_deceased = 0
245 AND ($email.is_bulkmail = 1 OR $email.is_primary = 1)
246 AND $email.email IS NOT NULL
247 AND $email.email != ''
248 AND $email.on_hold = 0
249 AND $mg.mailing_id = {$mailing_id}
250 AND X_$job_id.contact_id IS null
251 ORDER BY $email.is_bulkmail";
253 if ($mode == 'sms') {
254 $phoneTypes = CRM_Core_OptionGroup
::values('phone_type', TRUE, FALSE, FALSE, NULL, 'name');
255 $query = "REPLACE INTO I_$job_id (phone_id, contact_id)
257 SELECT DISTINCT $phone.id as phone_id,
258 $contact.id as contact_id
261 ON $phone.contact_id = $contact.id
262 INNER JOIN $g2contact
263 ON $contact.id = $g2contact.contact_id
265 ON $g2contact.group_id = $mg.entity_id
266 AND $mg.entity_table = '$group'
268 ON $contact.id = X_$job_id.contact_id
270 ($mg.group_type = 'Include')
271 AND $mg.search_id IS NULL
272 AND $g2contact.status = 'Added'
273 AND $contact.do_not_sms = 0
274 AND $contact.is_opt_out = 0
275 AND $contact.is_deceased = 0
276 AND $phone.phone_type_id = {$phoneTypes['Mobile']}
277 AND $phone.phone IS NOT NULL
278 AND $phone.phone != ''
279 AND $mg.mailing_id = {$mailing_id}
280 AND X_$job_id.contact_id IS null";
282 $mailingGroup->query($query);
284 /* Query prior mailings */
286 $query = "REPLACE INTO I_$job_id (email_id, contact_id)
287 SELECT DISTINCT $email.id as email_id,
288 $contact.id as contact_id
291 ON $email.contact_id = $contact.id
293 ON $eq.contact_id = $contact.id
295 ON $eq.job_id = $job.id
297 ON $job.mailing_id = $mg.entity_id AND $mg.entity_table = '$mailing'
299 ON $contact.id = X_$job_id.contact_id
301 ($mg.group_type = 'Include')
302 AND $contact.do_not_email = 0
303 AND $contact.is_opt_out = 0
304 AND $contact.is_deceased = 0
305 AND ($email.is_bulkmail = 1 OR $email.is_primary = 1)
306 AND $email.on_hold = 0
307 AND $mg.mailing_id = {$mailing_id}
308 AND X_$job_id.contact_id IS null
309 ORDER BY $email.is_bulkmail";
311 if ($mode == 'sms') {
312 $query = "REPLACE INTO I_$job_id (phone_id, contact_id)
313 SELECT DISTINCT $phone.id as phone_id,
314 $contact.id as contact_id
317 ON $phone.contact_id = $contact.id
319 ON $eq.contact_id = $contact.id
321 ON $eq.job_id = $job.id
323 ON $job.mailing_id = $mg.entity_id AND $mg.entity_table = '$mailing'
325 ON $contact.id = X_$job_id.contact_id
327 ($mg.group_type = 'Include')
328 AND $contact.do_not_sms = 0
329 AND $contact.is_opt_out = 0
330 AND $contact.is_deceased = 0
331 AND $phone.phone_type_id = {$phoneTypes['Mobile']}
332 AND $mg.mailing_id = {$mailing_id}
333 AND X_$job_id.contact_id IS null";
335 $mailingGroup->query($query);
338 SELECT $group.id, $group.cache_date, $group.saved_search_id, $group.children
340 INNER JOIN $mg ON $mg.entity_id = $group.id
341 WHERE $mg.entity_table = '$group'
342 AND $mg.group_type = 'Include'
343 AND $mg.search_id IS NULL
344 AND $mg.mailing_id = {$mailing_id}
345 AND ( saved_search_id != 0
346 OR saved_search_id IS NOT NULL
347 OR children IS NOT NULL )
350 $groupDAO = CRM_Core_DAO
::executeQuery($sql);
351 while ($groupDAO->fetch()) {
352 if ($groupDAO->cache_date
== NULL) {
353 CRM_Contact_BAO_GroupContactCache
::load($groupDAO);
356 $smartGroupInclude = "
357 INSERT IGNORE INTO I_$job_id (email_id, contact_id)
358 SELECT e.id as email_id, c.id as contact_id
359 FROM civicrm_contact c
360 INNER JOIN civicrm_email e ON e.contact_id = c.id
361 INNER JOIN civicrm_group_contact_cache gc ON gc.contact_id = c.id
362 LEFT JOIN X_$job_id ON X_$job_id.contact_id = c.id
363 WHERE gc.group_id = {$groupDAO->id}
364 AND c.do_not_email = 0
366 AND c.is_deceased = 0
367 AND (e.is_bulkmail = 1 OR e.is_primary = 1)
369 AND X_$job_id.contact_id IS null
370 ORDER BY e.is_bulkmail
372 if ($mode == 'sms') {
373 $smartGroupInclude = "
374 INSERT IGNORE INTO I_$job_id (phone_id, contact_id)
375 SELECT p.id as phone_id, c.id as contact_id
376 FROM civicrm_contact c
377 INNER JOIN civicrm_phone p ON p.contact_id = c.id
378 INNER JOIN civicrm_group_contact_cache gc ON gc.contact_id = c.id
379 LEFT JOIN X_$job_id ON X_$job_id.contact_id = c.id
380 WHERE gc.group_id = {$groupDAO->id}
383 AND c.is_deceased = 0
384 AND p.phone_type_id = {$phoneTypes['Mobile']}
385 AND X_$job_id.contact_id IS null";
387 $mailingGroup->query($smartGroupInclude);
391 * Construct the filtered search queries
394 SELECT search_id, search_args, entity_id
396 WHERE $mg.search_id IS NOT NULL
397 AND $mg.mailing_id = {$mailing_id}
399 $dao = CRM_Core_DAO
::executeQuery($query);
400 while ($dao->fetch()) {
401 $customSQL = CRM_Contact_BAO_SearchCustom
::civiMailSQL($dao->search_id
,
405 $query = "REPLACE INTO I_$job_id ({$tempColumn}, contact_id)
407 $mailingGroup->query($query);
410 /* Get the emails with only location override */
412 $query = "REPLACE INTO I_$job_id (email_id, contact_id)
413 SELECT DISTINCT $email.id as local_email_id,
414 $contact.id as contact_id
417 ON $email.contact_id = $contact.id
418 INNER JOIN $g2contact
419 ON $contact.id = $g2contact.contact_id
421 ON $g2contact.group_id = $mg.entity_id
423 ON $contact.id = X_$job_id.contact_id
425 $mg.entity_table = '$group'
426 AND $mg.group_type = 'Include'
427 AND $g2contact.status = 'Added'
428 AND $contact.do_not_email = 0
429 AND $contact.is_opt_out = 0
430 AND $contact.is_deceased = 0
431 AND ($email.is_bulkmail = 1 OR $email.is_primary = 1)
432 AND $email.on_hold = 0
433 AND $mg.mailing_id = {$mailing_id}
434 AND X_$job_id.contact_id IS null
435 ORDER BY $email.is_bulkmail";
436 if ($mode == "sms") {
437 $query = "REPLACE INTO I_$job_id (phone_id, contact_id)
438 SELECT DISTINCT $phone.id as phone_id,
439 $contact.id as contact_id
442 ON $phone.contact_id = $contact.id
443 INNER JOIN $g2contact
444 ON $contact.id = $g2contact.contact_id
446 ON $g2contact.group_id = $mg.entity_id
448 ON $contact.id = X_$job_id.contact_id
450 $mg.entity_table = '$group'
451 AND $mg.group_type = 'Include'
452 AND $g2contact.status = 'Added'
453 AND $contact.do_not_sms = 0
454 AND $contact.is_opt_out = 0
455 AND $contact.is_deceased = 0
456 AND $phone.phone_type_id = {$phoneTypes['Mobile']}
457 AND $mg.mailing_id = {$mailing_id}
458 AND X_$job_id.contact_id IS null";
460 $mailingGroup->query($query);
464 $eq = new CRM_Mailing_Event_BAO_Queue();
466 list($aclFrom, $aclWhere) = CRM_Contact_BAO_Contact_Permission
::cacheClause();
467 $aclWhere = $aclWhere ?
"WHERE {$aclWhere}" : '';
469 if ($limit && $offset !== NULL) {
470 $offset = CRM_Utils_Type
::escape($offset, 'Int');
471 $limit = CRM_Utils_Type
::escape($limit, 'Int');
473 $limitString = "LIMIT $offset, $limit";
476 if ($storeRecipients && $mailing_id) {
479 FROM civicrm_mailing_recipients
480 WHERE mailing_id = %1
482 $params = array(1 => array($mailing_id, 'Integer'));
483 CRM_Core_DAO
::executeQuery($sql, $params);
486 $groupBy = $groupJoin = '';
488 $groupJoin = " INNER JOIN civicrm_email e ON e.id = i.email_id";
489 $groupBy = " GROUP BY e.email ";
493 INSERT INTO civicrm_mailing_recipients ( mailing_id, contact_id, {$tempColumn} )
494 SELECT %1, i.contact_id, i.{$tempColumn}
495 FROM civicrm_contact contact_a
496 INNER JOIN I_$job_id i ON contact_a.id = i.contact_id
501 ORDER BY i.contact_id, i.{$tempColumn}
504 CRM_Core_DAO
::executeQuery($sql, $params);
506 // if we need to add all emails marked bulk, do it as a post filter
507 // on the mailing recipients table
508 if (CRM_Core_BAO_Email
::isMultipleBulkMail()) {
509 self
::addMultipleEmails($mailing_id);
513 /* Delete the temp table */
515 $mailingGroup->reset();
516 $mailingGroup->query("DROP TEMPORARY TABLE X_$job_id");
517 $mailingGroup->query("DROP TEMPORARY TABLE I_$job_id");
522 private function _getMailingGroupIds($type = 'Include') {
523 $mailingGroup = new CRM_Mailing_DAO_MailingGroup();
524 $group = CRM_Contact_DAO_Group
::getTableName();
525 if (!isset($this->id
)) {
526 // we're just testing tokens, so return any group
527 $query = "SELECT id AS entity_id
533 $query = "SELECT entity_id
535 WHERE mailing_id = {$this->id}
536 AND group_type = '$type'
537 AND entity_table = '$group'";
539 $mailingGroup->query($query);
542 while ($mailingGroup->fetch()) {
543 $groupIds[] = $mailingGroup->entity_id
;
551 * Returns the regex patterns that are used for preparing the text and html templates
556 private function &getPatterns($onlyHrefs = FALSE) {
560 $protos = '(https?|ftp)';
562 $gunk = '\{\}/#~:.?+=&;%@!\,\-';
564 $any = "{$letters}{$gunk}{$punc}";
566 $pattern = "\\bhref[ ]*=[ ]*([\"'])?(($protos:[$any]+?(?=[$punc]*[^$any]|$)))([\"'])?";
569 $pattern = "\\b($protos:[$any]+?(?=[$punc]*[^$any]|$))";
572 $patterns[] = $pattern;
573 $patterns[] = '\\\\\{\w+\.\w+\\\\\}|\{\{\w+\.\w+\}\}';
574 $patterns[] = '\{\w+\.\w+\}';
576 $patterns = '{' . join('|', $patterns) . '}im';
582 * returns an array that denotes the type of token that we are dealing with
583 * we use the type later on when we are doing a token replcement lookup
585 * @param string $token The token for which we will be doing adata lookup
587 * @return array $funcStruct An array that holds the token itself and the type.
588 * the type will tell us which function to use for the data lookup
589 * if we need to do a lookup at all
591 function &getDataFunc($token) {
592 static $_categories = NULL;
593 static $_categoryString = NULL;
595 $_categories = array(
602 CRM_Utils_Hook
::tokens($_categories);
603 $_categoryString = implode('|', array_keys($_categories));
606 $funcStruct = array('type' => NULL, 'token' => $token);
608 if ((preg_match('/^href/i', $token) ||
preg_match('/^http/i', $token))) {
609 // it is a url so we need to check to see if there are any tokens embedded
610 // if so then call this function again to get the token dataFunc
611 // and assign the type 'embedded' so that the data retrieving function
612 // will know what how to handle this token.
613 if (preg_match_all('/(\{\w+\.\w+\})/', $token, $matches)) {
614 $funcStruct['type'] = 'embedded_url';
615 $funcStruct['embed_parts'] = $funcStruct['token'] = array();
616 foreach ($matches[1] as $match) {
617 $preg_token = '/' . preg_quote($match, '/') . '/';
618 $list = preg_split($preg_token, $token, 2);
619 $funcStruct['embed_parts'][] = $list[0];
621 $funcStruct['token'][] = $this->getDataFunc($match);
623 // fixed truncated url, CRM-7113
625 $funcStruct['embed_parts'][] = $token;
629 $funcStruct['type'] = 'url';
632 elseif (preg_match('/^\{(' . $_categoryString . ')\.(\w+)\}$/', $token, $matches)) {
633 $funcStruct['type'] = $matches[1];
634 $funcStruct['token'] = $matches[2];
636 elseif (preg_match('/\\\\\{(\w+\.\w+)\\\\\}|\{\{(\w+\.\w+)\}\}/', $token, $matches)) {
637 // we are an escaped token
638 // so remove the escape chars
639 $unescaped_token = preg_replace('/\{\{|\}\}|\\\\\{|\\\\\}/', '', $matches[0]);
640 $funcStruct['token'] = '{' . $unescaped_token . '}';
647 * Prepares the text and html templates
648 * for generating the emails and returns a copy of the
654 private function getPreparedTemplates() {
655 if (!$this->preparedTemplates
) {
656 $patterns['html'] = $this->getPatterns(TRUE);
657 $patterns['subject'] = $patterns['text'] = $this->getPatterns();
658 $templates = $this->getTemplates();
660 $this->preparedTemplates
= array();
663 'html', 'text', 'subject') as $key) {
664 if (!isset($templates[$key])) {
670 $split_template = array();
672 $email = $templates[$key];
673 preg_match_all($patterns[$key], $email, $matches, PREG_PATTERN_ORDER
);
674 foreach ($matches[0] as $idx => $token) {
675 $preg_token = '/' . preg_quote($token, '/') . '/im';
676 list($split_template[], $email) = preg_split($preg_token, $email, 2);
677 array_push($tokens, $this->getDataFunc($token));
680 $split_template[] = $email;
682 $this->preparedTemplates
[$key]['template'] = $split_template;
683 $this->preparedTemplates
[$key]['tokens'] = $tokens;
686 return ($this->preparedTemplates
);
691 * Retrieve a ref to an array that holds the email and text templates for this email
692 * assembles the complete template including the header and footer
693 * that the user has uploaded or declared (if they have dome that)
696 * @return array reference to an assoc array
700 private function &getTemplates() {
701 if (!$this->templates
) {
702 $this->getHeaderFooter();
703 $this->templates
= array();
705 if ($this->body_text
) {
708 $template[] = $this->header
->body_text
;
711 $template[] = $this->body_text
;
714 $template[] = $this->footer
->body_text
;
717 $this->templates
['text'] = join("\n", $template);
720 if ($this->body_html
) {
724 $template[] = $this->header
->body_html
;
727 $template[] = $this->body_html
;
730 $template[] = $this->footer
->body_html
;
733 $this->templates
['html'] = join("\n", $template);
735 // this is where we create a text template from the html template if the text template did not exist
736 // this way we ensure that every recipient will receive an email even if the pref is set to text and the
737 // user uploads an html email only
738 if (!$this->body_text
) {
739 $this->templates
['text'] = CRM_Utils_String
::htmlToText($this->templates
['html']);
743 if ($this->subject
) {
745 $template[] = $this->subject
;
746 $this->templates
['subject'] = join("\n", $template);
749 return $this->templates
;
754 * Retrieve a ref to an array that holds all of the tokens in the email body
755 * where the keys are the type of token and the values are ordinal arrays
756 * that hold the token names (even repeated tokens) in the order in which
757 * they appear in the body of the email.
759 * note: the real work is done in the _getTokens() function
761 * this function needs to have some sort of a body assigned
762 * either text or html for this to have any meaningful impact
764 * @return array reference to an assoc array
768 public function &getTokens() {
769 if (!$this->tokens
) {
771 $this->tokens
= array('html' => array(), 'text' => array(), 'subject' => array());
773 if ($this->body_html
) {
774 $this->_getTokens('html');
775 if (!$this->body_text
) {
776 // Since the text template was created from html, use the html tokens.
777 // @see CRM_Mailing_BAO_Mailing::getTemplates()
778 $this->tokens
['text'] = $this->tokens
['html'];
782 if ($this->body_text
) {
783 $this->_getTokens('text');
786 if ($this->subject
) {
787 $this->_getTokens('subject');
791 return $this->tokens
;
795 * Returns the token set for all 3 parts as one set. This allows it to be sent to the
796 * hook in one call and standardizes it across other token workflows
798 * @return array reference to an assoc array
802 public function &getFlattenedTokens() {
803 if (!$this->flattenedTokens
) {
804 $tokens = $this->getTokens();
806 $this->flattenedTokens
= CRM_Utils_Token
::flattenTokens($tokens);
809 return $this->flattenedTokens
;
814 * _getTokens parses out all of the tokens that have been
815 * included in the html and text bodies of the email
816 * we get the tokens and then separate them into an
817 * internal structure named tokens that has the same
818 * form as the static tokens property(?) of the CRM_Utils_Token class.
819 * The difference is that there might be repeated token names as we want the
820 * structures to represent the order in which tokens were found from left to right, top to bottom.
823 * @param str $prop name of the property that holds the text that we want to scan for tokens (html, text)
828 private function _getTokens($prop) {
829 $templates = $this->getTemplates();
831 $newTokens = CRM_Utils_Token
::getTokens($templates[$prop]);
833 foreach ($newTokens as $type => $names) {
834 if (!isset($this->tokens
[$prop][$type])) {
835 $this->tokens
[$prop][$type] = array();
837 foreach ($names as $key => $name) {
838 $this->tokens
[$prop][$type][] = $name;
844 * Generate an event queue for a test job
846 * @params array $params contains form values
851 public function getTestRecipients($testParams) {
852 if (array_key_exists($testParams['test_group'], CRM_Core_PseudoConstant
::group())) {
853 $contacts = civicrm_api('contact','get', array(
855 'group' => $testParams['test_group'],
857 'options' => array('limit' => 100000000000,
861 foreach (array_keys($contacts['values']) as $groupContact) {
863 SELECT civicrm_email.id AS email_id,
864 civicrm_email.is_primary as is_primary,
865 civicrm_email.is_bulkmail as is_bulkmail
867 INNER JOIN civicrm_contact ON civicrm_email.contact_id = civicrm_contact.id
868 WHERE (civicrm_email.is_bulkmail = 1 OR civicrm_email.is_primary = 1)
869 AND civicrm_contact.id = {$groupContact}
870 AND civicrm_contact.do_not_email = 0
871 AND civicrm_contact.is_deceased = 0
872 AND civicrm_email.on_hold = 0
873 AND civicrm_contact.is_opt_out = 0
874 GROUP BY civicrm_email.id
875 ORDER BY civicrm_email.is_bulkmail DESC
877 $dao = CRM_Core_DAO
::executeQuery($query);
880 'job_id' => $testParams['job_id'],
881 'email_id' => $dao->email_id
,
882 'contact_id' => $groupContact,
884 $queue = CRM_Mailing_Event_BAO_Queue
::create($params);
891 * Retrieve the header and footer for this mailing
898 private function getHeaderFooter() {
899 if (!$this->header
and $this->header_id
) {
900 $this->header
= new CRM_Mailing_BAO_Component();
901 $this->header
->id
= $this->header_id
;
902 $this->header
->find(TRUE);
903 $this->header
->free();
906 if (!$this->footer
and $this->footer_id
) {
907 $this->footer
= new CRM_Mailing_BAO_Component();
908 $this->footer
->id
= $this->footer_id
;
909 $this->footer
->find(TRUE);
910 $this->footer
->free();
915 * Given and array of headers and a prefix, job ID, event queue ID, and hash,
916 * add a Message-ID header if needed.
918 * i.e. if the global includeMessageId is set and there isn't already a
919 * Message-ID in the array.
920 * The message ID is structured the same way as a verp. However no interpretation
921 * is placed on the values received, so they do not need to follow the verp
924 * @param array $headers Array of message headers to update, in-out
925 * @param string $prefix Prefix for the message ID, use same prefixes as verp
927 * @param string $job_id Job ID component of the generated message ID
928 * @param string $event_queue_id Event Queue ID component of the generated message ID
929 * @param string $hash Hash component of the generated message ID.
933 static function addMessageIdHeader(&$headers, $prefix, $job_id, $event_queue_id, $hash) {
934 $config = CRM_Core_Config
::singleton();
935 $localpart = CRM_Core_BAO_MailSettings
::defaultLocalpart();
936 $emailDomain = CRM_Core_BAO_MailSettings
::defaultDomain();
937 $includeMessageId = CRM_Core_BAO_MailSettings
::includeMessageId();
939 if ($includeMessageId && (!array_key_exists('Message-ID', $headers))) {
940 $headers['Message-ID'] = '<' . implode($config->verpSeparator
,
942 $localpart . $prefix,
947 ) . "@{$emailDomain}>";
952 * static wrapper for getting verp and urls
954 * @param int $job_id ID of the Job associated with this message
955 * @param int $event_queue_id ID of the EventQueue
956 * @param string $hash Hash of the EventQueue
957 * @param string $email Destination address
959 * @return (reference) array array ref that hold array refs to the verp info and urls
961 static function getVerpAndUrls($job_id, $event_queue_id, $hash, $email) {
962 // create a skeleton object and set its properties that are required by getVerpAndUrlsAndHeaders()
963 $config = CRM_Core_Config
::singleton();
964 $bao = new CRM_Mailing_BAO_Mailing();
965 $bao->_domain
= CRM_Core_BAO_Domain
::getDomain();
966 $bao->from_name
= $bao->from_email
= $bao->subject
= '';
968 // use $bao's instance method to get verp and urls
969 list($verp, $urls, $_) = $bao->getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email);
970 return array($verp, $urls);
974 * get verp, urls and headers
976 * @param int $job_id ID of the Job associated with this message
977 * @param int $event_queue_id ID of the EventQueue
978 * @param string $hash Hash of the EventQueue
979 * @param string $email Destination address
981 * @return (reference) array array ref that hold array refs to the verp info, urls, and headers
984 private function getVerpAndUrlsAndHeaders($job_id, $event_queue_id, $hash, $email, $isForward = FALSE) {
985 $config = CRM_Core_Config
::singleton();
989 * reply: user replied to mailing
990 * bounce: email address bounced
991 * unsubscribe: contact opts out of all target lists for the mailing
992 * resubscribe: contact opts back into all target lists for the mailing
993 * optOut: contact unsubscribes from the domain
999 'unsubscribe' => 'u',
1000 'resubscribe' => 'e',
1004 $localpart = CRM_Core_BAO_MailSettings
::defaultLocalpart();
1005 $emailDomain = CRM_Core_BAO_MailSettings
::defaultDomain();
1007 foreach ($verpTokens as $key => $value) {
1008 $verp[$key] = implode($config->verpSeparator
,
1010 $localpart . $value,
1015 ) . "@$emailDomain";
1018 //handle should override VERP address.
1019 $skipEncode = FALSE;
1022 self
::overrideVerp($job_id)
1024 $verp['reply'] = "\"{$this->from_name}\" <{$this->from_email}>";
1028 'forward' => CRM_Utils_System
::url('civicrm/mailing/forward',
1029 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
1030 TRUE, NULL, TRUE, TRUE
1032 'unsubscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/unsubscribe',
1033 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
1034 TRUE, NULL, TRUE, TRUE
1036 'resubscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/resubscribe',
1037 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
1038 TRUE, NULL, TRUE, TRUE
1040 'optOutUrl' => CRM_Utils_System
::url('civicrm/mailing/optout',
1041 "reset=1&jid={$job_id}&qid={$event_queue_id}&h={$hash}",
1042 TRUE, NULL, TRUE, TRUE
1044 'subscribeUrl' => CRM_Utils_System
::url('civicrm/mailing/subscribe',
1046 TRUE, NULL, TRUE, TRUE
1051 'Reply-To' => $verp['reply'],
1052 'Return-Path' => $verp['bounce'],
1053 'From' => "\"{$this->from_name}\" <{$this->from_email}>",
1054 'Subject' => $this->subject
,
1055 'List-Unsubscribe' => "<mailto:{$verp['unsubscribe']}>",
1057 self
::addMessageIdHeader($headers, 'm', $job_id, $event_queue_id, $hash);
1059 $headers['Subject'] = "[Fwd:{$this->subject}]";
1061 return array(&$verp, &$urls, &$headers);
1067 * @param int $job_id ID of the Job associated with this message
1068 * @param int $event_queue_id ID of the EventQueue
1069 * @param string $hash Hash of the EventQueue
1070 * @param string $contactId ID of the Contact
1071 * @param string $email Destination address
1072 * @param string $recipient To: of the recipient
1073 * @param boolean $test Is this mailing a test?
1074 * @param boolean $isForward Is this mailing compose for forward?
1075 * @param string $fromEmail email address of who is forwardinf it.
1077 * @return object The mail object
1080 public function &compose($job_id, $event_queue_id, $hash, $contactId,
1081 $email, &$recipient, $test,
1082 $contactDetails, &$attachments, $isForward = FALSE,
1083 $fromEmail = NULL, $replyToEmail = NULL
1085 $config = CRM_Core_Config
::singleton();
1086 $knownTokens = $this->getTokens();
1088 if ($this->_domain
== NULL) {
1089 $this->_domain
= CRM_Core_BAO_Domain
::getDomain();
1092 list($verp, $urls, $headers) = $this->getVerpAndUrlsAndHeaders(
1100 //set from email who is forwarding it and not original one.
1102 unset($headers['From']);
1103 $headers['From'] = "<{$fromEmail}>";
1106 if ($replyToEmail && ($fromEmail != $replyToEmail)) {
1107 $headers['Reply-To'] = "{$replyToEmail}";
1110 if ($contactDetails) {
1111 $contact = $contactDetails;
1114 $params = array(array('contact_id', '=', $contactId, 0, 0));
1115 list($contact, $_) = CRM_Contact_BAO_Query
::apiQuery($params);
1118 $contact = reset($contact);
1120 if (!$contact ||
is_a($contact, 'CRM_Core_Error')) {
1121 CRM_Core_Error
::debug_log_message(ts('CiviMail will not send email to a non-existent contact: %1',
1122 array(1 => $contactId)
1124 // setting this because function is called by reference
1125 //@todo test not calling function by reference
1130 // also call the hook to get contact details
1131 CRM_Utils_Hook
::tokenValues($contact, $contactId, $job_id);
1134 $pTemplates = $this->getPreparedTemplates();
1137 foreach ($pTemplates as $type => $pTemplate) {
1138 $html = ($type == 'html') ?
TRUE : FALSE;
1139 $pEmails[$type] = array();
1140 $pEmail = &$pEmails[$type];
1141 $template = &$pTemplates[$type]['template'];
1142 $tokens = &$pTemplates[$type]['tokens'];
1144 if (!empty($tokens)) {
1145 foreach ($tokens as $idx => $token) {
1146 $token_data = $this->getTokenData($token, $html, $contact, $verp, $urls, $event_queue_id);
1147 array_push($pEmail, $template[$idx]);
1148 array_push($pEmail, $token_data);
1152 array_push($pEmail, $template[$idx]);
1155 if (isset($template[($idx +
1)])) {
1156 array_push($pEmail, $template[($idx +
1)]);
1161 if (isset($pEmails['html']) && is_array($pEmails['html']) && count($pEmails['html'])) {
1162 $html = &$pEmails['html'];
1166 if (isset($pEmails['text']) && is_array($pEmails['text']) && count($pEmails['text'])) {
1167 $text = &$pEmails['text'];
1170 // push the tracking url on to the html email if necessary
1171 if ($this->open_tracking
&& $html) {
1172 array_push($html, "\n" . '<img src="' . $config->userFrameworkResourceURL
.
1173 "extern/open.php?q=$event_queue_id\" width='1' height='1' alt='' border='0'>"
1177 $message = new Mail_mime("\n");
1179 $useSmarty = defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY ?
TRUE : FALSE;
1181 $smarty = CRM_Core_Smarty
::singleton();
1182 // also add the contact tokens to the template
1183 $smarty->assign_by_ref('contact', $contact);
1186 $mailParams = $headers;
1187 if ($text && ($test ||
$contact['preferred_mail_format'] == 'Text' ||
1188 $contact['preferred_mail_format'] == 'Both' ||
1189 ($contact['preferred_mail_format'] == 'HTML' && !array_key_exists('html', $pEmails))
1191 $textBody = join('', $text);
1193 $textBody = $smarty->fetch("string:$textBody");
1195 $mailParams['text'] = $textBody;
1198 if ($html && ($test ||
($contact['preferred_mail_format'] == 'HTML' ||
1199 $contact['preferred_mail_format'] == 'Both'
1201 $htmlBody = join('', $html);
1203 $htmlBody = $smarty->fetch("string:$htmlBody");
1205 $mailParams['html'] = $htmlBody;
1208 if (empty($mailParams['text']) && empty($mailParams['html'])) {
1210 // something went wrong, lets log it and return null (by reference)
1211 CRM_Core_Error
::debug_log_message(ts('CiviMail will not send an empty mail body, Skipping: %1',
1218 $mailParams['attachments'] = $attachments;
1220 $mailingSubject = CRM_Utils_Array
::value('subject', $pEmails);
1221 if (is_array($mailingSubject)) {
1222 $mailingSubject = join('', $mailingSubject);
1224 $mailParams['Subject'] = $mailingSubject;
1226 $mailParams['toName'] = CRM_Utils_Array
::value('display_name',
1229 $mailParams['toEmail'] = $email;
1231 CRM_Utils_Hook
::alterMailParams($mailParams, 'civimail');
1233 // CRM-10699 support custom email headers
1234 if (CRM_Utils_Array
::value('headers', $mailParams)) {
1235 $headers = array_merge($headers, $mailParams['headers']);
1237 //cycle through mailParams and set headers array
1238 foreach ($mailParams as $paramKey => $paramValue) {
1239 //exclude values not intended for the header
1240 if (!in_array($paramKey, array(
1241 'text', 'html', 'attachments', 'toName', 'toEmail'))) {
1242 $headers[$paramKey] = $paramValue;
1246 if (!empty($mailParams['text'])) {
1247 $message->setTxtBody($mailParams['text']);
1250 if (!empty($mailParams['html'])) {
1251 $message->setHTMLBody($mailParams['html']);
1254 if (!empty($mailParams['attachments'])) {
1255 foreach ($mailParams['attachments'] as $fileID => $attach) {
1256 $message->addAttachment($attach['fullPath'],
1257 $attach['mime_type'],
1258 $attach['cleanName']
1263 //pickup both params from mail params.
1264 $toName = trim($mailParams['toName']);
1265 $toEmail = trim($mailParams['toEmail']);
1266 if ($toName == $toEmail ||
1267 strpos($toName, '@') !== FALSE
1272 $toName = CRM_Utils_Mail
::formatRFC2822Name($toName);
1275 $headers['To'] = "$toName <$toEmail>";
1277 $headers['Precedence'] = 'bulk';
1278 // Will test in the mail processor if the X-VERP is set in the bounced email.
1279 // (As an option to replace real VERP for those that can't set it up)
1280 $headers['X-CiviMail-Bounce'] = $verp['bounce'];
1283 //token replacement of subject
1284 $headers['Subject'] = $mailingSubject;
1286 CRM_Utils_Mail
::setMimeParams($message);
1287 $headers = $message->headers($headers);
1289 //get formatted recipient
1290 $recipient = $headers['To'];
1292 // make sure we unset a lot of stuff
1304 * get mailing object and replaces subscribeInvite,
1305 * domain and mailing tokens
1308 public static function tokenReplace(&$mailing) {
1309 $domain = CRM_Core_BAO_Domain
::getDomain();
1311 foreach (array('text', 'html') as $type) {
1312 $tokens = $mailing->getTokens();
1313 if (isset($mailing->templates
[$type])) {
1314 $mailing->templates
[$type] = CRM_Utils_Token
::replaceSubscribeInviteTokens($mailing->templates
[$type]);
1315 $mailing->templates
[$type] = CRM_Utils_Token
::replaceDomainTokens(
1316 $mailing->templates
[$type],
1318 $type == 'html' ?
TRUE : FALSE,
1321 $mailing->templates
[$type] = CRM_Utils_Token
::replaceMailingTokens($mailing->templates
[$type], $mailing, NULL, $tokens[$type]);
1328 * getTokenData receives a token from an email
1329 * and returns the appropriate data for the token
1332 private function getTokenData(&$token_a, $html = FALSE, &$contact, &$verp, &$urls, $event_queue_id) {
1333 $type = $token_a['type'];
1334 $token = $token_a['token'];
1337 $useSmarty = defined('CIVICRM_MAIL_SMARTY') && CIVICRM_MAIL_SMARTY ?
TRUE : FALSE;
1339 if ($type == 'embedded_url') {
1340 $embed_data = array();
1341 foreach ($token as $t) {
1342 $embed_data[] = $this->getTokenData($t, $html = FALSE, $contact, $verp, $urls, $event_queue_id);
1344 $numSlices = count($embed_data);
1346 for ($i = 0; $i < $numSlices; $i++
) {
1347 $url .= "{$token_a['embed_parts'][$i]}{$embed_data[$i]}";
1349 if (isset($token_a['embed_parts'][$numSlices])) {
1350 $url .= $token_a['embed_parts'][$numSlices];
1352 // add trailing quote since we've gobbled it up in a previous regex
1353 // function getPatterns, line 431
1354 if (preg_match('/^href[ ]*=[ ]*\'/', $url)) {
1357 elseif (preg_match('/^href[ ]*=[ ]*\"/', $url)) {
1362 elseif ($type == 'url') {
1363 if ($this->url_tracking
) {
1364 $data = CRM_Mailing_BAO_TrackableURL
::getTrackerURL($token, $this->id
, $event_queue_id);
1370 elseif ($type == 'contact') {
1371 $data = CRM_Utils_Token
::getContactTokenReplacement($token, $contact, FALSE, FALSE, $useSmarty);
1373 elseif ($type == 'action') {
1374 $data = CRM_Utils_Token
::getActionTokenReplacement($token, $verp, $urls, $html);
1376 elseif ($type == 'domain') {
1377 $domain = CRM_Core_BAO_Domain
::getDomain();
1378 $data = CRM_Utils_Token
::getDomainTokenReplacement($token, $domain, $html);
1380 elseif ($type == 'mailing') {
1381 if ($token == 'name') {
1382 $data = $this->name
;
1384 elseif ($token == 'group') {
1385 $groups = $this->getGroupNames();
1386 $data = implode(', ', $groups);
1390 $data = CRM_Utils_Array
::value("{$type}.{$token}", $contact);
1396 * Return a list of group names for this mailing. Does not work with
1397 * prior-mailing targets.
1399 * @return array Names of groups receiving this mailing
1402 public function &getGroupNames() {
1403 if (!isset($this->id
)) {
1406 $mg = new CRM_Mailing_DAO_MailingGroup();
1407 $mgtable = CRM_Mailing_DAO_MailingGroup
::getTableName();
1408 $group = CRM_Contact_BAO_Group
::getTableName();
1410 $mg->query("SELECT $group.title as name FROM $mgtable
1411 INNER JOIN $group ON $mgtable.entity_id = $group.id
1412 WHERE $mgtable.mailing_id = {$this->id}
1413 AND $mgtable.entity_table = '$group'
1414 AND $mgtable.group_type = 'Include'
1415 ORDER BY $group.name");
1418 while ($mg->fetch()) {
1419 $groups[] = $mg->name
;
1426 * function to add the mailings
1428 * @param array $params reference array contains the values submitted by the form
1429 * @param array $ids reference array contains the id
1436 static function add(&$params, $ids = array()) {
1437 $id = CRM_Utils_Array
::value('mailing_id', $ids, CRM_Utils_Array
::value('id', $params));
1440 CRM_Utils_Hook
::pre('edit', 'Mailing', $id, $params);
1443 CRM_Utils_Hook
::pre('create', 'Mailing', NULL, $params);
1446 $mailing = new CRM_Mailing_DAO_Mailing();
1448 $mailing->domain_id
= CRM_Utils_Array
::value('domain_id', $params, CRM_Core_Config
::domainID());
1450 if (!isset($params['replyto_email']) &&
1451 isset($params['from_email'])
1453 $params['replyto_email'] = $params['from_email'];
1456 $mailing->copyValues($params);
1458 $result = $mailing->save();
1460 if (CRM_Utils_Array
::value('mailing', $ids)) {
1461 CRM_Utils_Hook
::post('edit', 'Mailing', $mailing->id
, $mailing);
1464 CRM_Utils_Hook
::post('create', 'Mailing', $mailing->id
, $mailing);
1471 * Construct a new mailing object, along with job and mailing_group
1472 * objects, from the form values of the create mailing wizard.
1474 * @params array $params Form values
1476 * @return object $mailing The new mailing object
1480 public static function create(&$params, $ids = array()) {
1483 // Do the below only for an insert
1484 // for an update, we should not set the defaults
1485 if (!isset($ids['id']) && !isset($ids['mailing_id'])) {
1486 // Retrieve domain email and name for default sender
1487 $domain = civicrm_api(
1492 'current_domain' => 1,
1496 if (isset($domain['from_email'])) {
1497 $domain_email = $domain['from_email'];
1498 $domain_name = $domain['from_name'];
1501 $domain_email = 'info@EXAMPLE.ORG';
1502 $domain_name = 'EXAMPLE.ORG';
1504 if (!isset($params['created_id'])) {
1505 $session =& CRM_Core_Session
::singleton();
1506 $params['created_id'] = $session->get('userID');
1509 // load the default config settings for each
1510 // eg reply_id, unsubscribe_id need to use
1511 // correct template IDs here
1512 'override_verp' => TRUE,
1513 'forward_replies' => FALSE,
1514 'open_tracking' => TRUE,
1515 'url_tracking' => TRUE,
1516 'visibility' => 'User and User Admin Only',
1517 'replyto_email' => $domain_email,
1518 'header_id' => CRM_Mailing_PseudoConstant
::defaultComponent('header_id', ''),
1519 'footer_id' => CRM_Mailing_PseudoConstant
::defaultComponent('footer_id', ''),
1520 'from_email' => $domain_email,
1521 'from_name' => $domain_name,
1522 'msg_template_id' => NULL,
1523 'contact_id' => $params['created_id'],
1524 'created_id' => $params['created_id'],
1525 'approver_id' => $params['created_id'],
1526 'auto_responder' => 0,
1527 'created_date' => date('YmdHis'),
1528 'scheduled_date' => date('YmdHis'),
1529 'approval_date' => date('YmdHis'),
1532 // Get the default from email address, if not provided.
1533 if (empty($defaults['from_email'])) {
1534 $defaultAddress = CRM_Core_OptionGroup
::values('from_email_address', NULL, NULL, NULL, ' AND is_default = 1');
1535 foreach ($defaultAddress as $id => $value) {
1536 if (preg_match('/"(.*)" <(.*)>/', $value, $match)) {
1537 $defaults['from_email'] = $match[2];
1538 $defaults['from_name'] = $match[1];
1543 $params = array_merge($defaults, $params);
1547 * Could check and warn for the following cases:
1549 * - groups OR mailings should be populated.
1550 * - body html OR body text should be populated.
1553 $transaction = new CRM_Core_Transaction();
1555 $mailing = self
::add($params, $ids);
1557 if (is_a($mailing, 'CRM_Core_Error')) {
1558 $transaction->rollback();
1562 $groupTableName = CRM_Contact_BAO_Group
::getTableName();
1563 $mailingTableName = CRM_Mailing_BAO_Mailing
::getTableName();
1565 /* Create the mailing group record */
1566 $mg = new CRM_Mailing_DAO_MailingGroup();
1567 foreach (array('groups', 'mailings') as $entity) {
1568 foreach (array('include', 'exclude', 'base') as $type) {
1569 if (isset($params[$entity]) &&
1570 CRM_Utils_Array
::value($type, $params[$entity]) &&
1571 is_array($params[$entity][$type])) {
1572 foreach ($params[$entity][$type] as $entityId) {
1574 $mg->mailing_id
= $mailing->id
;
1575 $mg->entity_table
= ($entity == 'groups') ?
$groupTableName : $mailingTableName;
1576 $mg->entity_id
= $entityId;
1577 $mg->group_type
= $type;
1584 if (!empty($params['search_id']) && !empty($params['group_id'])) {
1586 $mg->mailing_id
= $mailing->id
;
1587 $mg->entity_table
= $groupTableName;
1588 $mg->entity_id
= $params['group_id'];
1589 $mg->search_id
= $params['search_id'];
1590 $mg->search_args
= $params['search_args'];
1591 $mg->group_type
= 'Include';
1595 // check and attach and files as needed
1596 CRM_Core_BAO_File
::processAttachment($params, 'civicrm_mailing', $mailing->id
);
1598 $transaction->commit();
1601 * 'approval_status_id' set in
1602 * CRM_Mailing_Form_Schedule::postProcess() or via API.
1604 if (isset($params['approval_status_id']) && $params['approval_status_id']) {
1605 $job = new CRM_Mailing_BAO_MailingJob();
1606 $job->mailing_id
= $mailing->id
;
1607 $job->status
= 'Scheduled';
1609 $job->scheduled_date
= $params['scheduled_date'];
1611 // Populate the recipients.
1612 $mailing->getRecipients($job->id
, $mailing->id
, NULL, NULL, TRUE, FALSE);
1619 * Generate a report. Fetch event count information, mailing data, and job
1622 * @param int $id The mailing id to report
1623 * @param boolean $skipDetails whether return all detailed report
1625 * @return array Associative array of reporting data
1629 public static function &report($id, $skipDetails = FALSE, $isSMS = FALSE) {
1630 $mailing_id = CRM_Utils_Type
::escape($id, 'Integer');
1632 $mailing = new CRM_Mailing_BAO_Mailing();
1635 'mailing' => self
::getTableName(),
1636 'mailing_group' => CRM_Mailing_DAO_MailingGroup
::getTableName(),
1637 'group' => CRM_Contact_BAO_Group
::getTableName(),
1638 'job' => CRM_Mailing_BAO_MailingJob
::getTableName(),
1639 'queue' => CRM_Mailing_Event_BAO_Queue
::getTableName(),
1640 'delivered' => CRM_Mailing_Event_BAO_Delivered
::getTableName(),
1641 'opened' => CRM_Mailing_Event_BAO_Opened
::getTableName(),
1642 'reply' => CRM_Mailing_Event_BAO_Reply
::getTableName(),
1644 CRM_Mailing_Event_BAO_Unsubscribe
::getTableName(),
1645 'bounce' => CRM_Mailing_Event_BAO_Bounce
::getTableName(),
1646 'forward' => CRM_Mailing_Event_BAO_Forward
::getTableName(),
1647 'url' => CRM_Mailing_BAO_TrackableURL
::getTableName(),
1649 CRM_Mailing_Event_BAO_TrackableURLOpen
::getTableName(),
1650 'component' => CRM_Mailing_BAO_Component
::getTableName(),
1651 'spool' => CRM_Mailing_BAO_Spool
::getTableName(),
1656 $additionalWhereClause = " AND ";
1658 $additionalWhereClause .= " {$t['mailing']}.sms_provider_id IS NULL ";
1661 $additionalWhereClause .= " {$t['mailing']}.sms_provider_id IS NOT NULL ";
1664 /* Get the mailing info */
1667 SELECT {$t['mailing']}.*
1668 FROM {$t['mailing']}
1669 WHERE {$t['mailing']}.id = $mailing_id {$additionalWhereClause}");
1673 $report['mailing'] = array();
1674 foreach (array_keys(self
::fields()) as $field) {
1675 $report['mailing'][$field] = $mailing->$field;
1679 if ($campaignId = CRM_Utils_Array
::value('campaign_id', $report['mailing'])) {
1680 $campaigns = CRM_Campaign_BAO_Campaign
::getCampaigns($campaignId);
1681 $report['mailing']['campaign'] = $campaigns[$campaignId];
1684 //mailing report is called by activity
1685 //we dont need all detail report
1690 /* Get the component info */
1694 $components = array(
1695 'header' => ts('Header'),
1696 'footer' => ts('Footer'),
1697 'reply' => ts('Reply'),
1698 'unsubscribe' => ts('Unsubscribe'),
1699 'optout' => ts('Opt-Out'),
1701 foreach (array_keys($components) as $type) {
1702 $query[] = "SELECT {$t['component']}.name as name,
1704 {$t['component']}.id as id
1705 FROM {$t['component']}
1706 INNER JOIN {$t['mailing']}
1707 ON {$t['mailing']}.{$type}_id =
1708 {$t['component']}.id
1709 WHERE {$t['mailing']}.id = $mailing_id";
1711 $q = '(' . implode(') UNION (', $query) . ')';
1712 $mailing->query($q);
1714 $report['component'] = array();
1715 while ($mailing->fetch()) {
1716 $report['component'][] = array(
1717 'type' => $components[$mailing->type
],
1718 'name' => $mailing->name
,
1720 CRM_Utils_System
::url('civicrm/mailing/component',
1721 "reset=1&action=update&id={$mailing->id}"
1726 /* Get the recipient group info */
1729 SELECT {$t['mailing_group']}.group_type as group_type,
1730 {$t['group']}.id as group_id,
1731 {$t['group']}.title as group_title,
1732 {$t['group']}.is_hidden as group_hidden,
1733 {$t['mailing']}.id as mailing_id,
1734 {$t['mailing']}.name as mailing_name
1735 FROM {$t['mailing_group']}
1736 LEFT JOIN {$t['group']}
1737 ON {$t['mailing_group']}.entity_id = {$t['group']}.id
1738 AND {$t['mailing_group']}.entity_table =
1740 LEFT JOIN {$t['mailing']}
1741 ON {$t['mailing_group']}.entity_id =
1743 AND {$t['mailing_group']}.entity_table =
1746 WHERE {$t['mailing_group']}.mailing_id = $mailing_id
1749 $report['group'] = array('include' => array(), 'exclude' => array(), 'base' => array());
1750 while ($mailing->fetch()) {
1752 if (isset($mailing->group_id
)) {
1753 $row['id'] = $mailing->group_id
;
1754 $row['name'] = $mailing->group_title
;
1755 $row['link'] = CRM_Utils_System
::url('civicrm/group/search',
1756 "reset=1&force=1&context=smog&gid={$row['id']}"
1760 $row['id'] = $mailing->mailing_id
;
1761 $row['name'] = $mailing->mailing_name
;
1762 $row['mailing'] = TRUE;
1763 $row['link'] = CRM_Utils_System
::url('civicrm/mailing/report',
1768 /* Rename hidden groups */
1770 if ($mailing->group_hidden
== 1) {
1771 $row['name'] = "Search Results";
1774 if ($mailing->group_type
== 'Include') {
1775 $report['group']['include'][] = $row;
1777 elseif ($mailing->group_type
== 'Base') {
1778 $report['group']['base'][] = $row;
1781 $report['group']['exclude'][] = $row;
1785 /* Get the event totals, grouped by job (retries) */
1788 SELECT {$t['job']}.*,
1789 COUNT(DISTINCT {$t['queue']}.id) as queue,
1790 COUNT(DISTINCT {$t['delivered']}.id) as delivered,
1791 COUNT(DISTINCT {$t['reply']}.id) as reply,
1792 COUNT(DISTINCT {$t['forward']}.id) as forward,
1793 COUNT(DISTINCT {$t['bounce']}.id) as bounce,
1794 COUNT(DISTINCT {$t['urlopen']}.id) as url,
1795 COUNT(DISTINCT {$t['spool']}.id) as spool
1797 LEFT JOIN {$t['queue']}
1798 ON {$t['queue']}.job_id = {$t['job']}.id
1799 LEFT JOIN {$t['reply']}
1800 ON {$t['reply']}.event_queue_id = {$t['queue']}.id
1801 LEFT JOIN {$t['forward']}
1802 ON {$t['forward']}.event_queue_id = {$t['queue']}.id
1803 LEFT JOIN {$t['bounce']}
1804 ON {$t['bounce']}.event_queue_id = {$t['queue']}.id
1805 LEFT JOIN {$t['delivered']}
1806 ON {$t['delivered']}.event_queue_id = {$t['queue']}.id
1807 AND {$t['bounce']}.id IS null
1808 LEFT JOIN {$t['urlopen']}
1809 ON {$t['urlopen']}.event_queue_id = {$t['queue']}.id
1810 LEFT JOIN {$t['spool']}
1811 ON {$t['spool']}.job_id = {$t['job']}.id
1812 WHERE {$t['job']}.mailing_id = $mailing_id
1813 AND {$t['job']}.is_test = 0
1814 GROUP BY {$t['job']}.id");
1816 $report['jobs'] = array();
1817 $report['event_totals'] = array();
1819 'queue', 'delivered', 'url', 'forward',
1820 'reply', 'unsubscribe', 'optout', 'opened', 'bounce', 'spool',
1823 // initialize various counters
1824 foreach ($elements as $field) {
1825 $report['event_totals'][$field] = 0;
1828 while ($mailing->fetch()) {
1830 foreach ($elements as $field) {
1831 if (isset($mailing->$field)) {
1832 $row[$field] = $mailing->$field;
1833 $report['event_totals'][$field] +
= $mailing->$field;
1837 // compute open total separately to discount duplicates
1839 $row['opened'] = CRM_Mailing_Event_BAO_Opened
::getTotalCount($mailing_id, $mailing->id
, TRUE);
1840 $report['event_totals']['opened'] +
= $row['opened'];
1842 // compute unsub total separately to discount duplicates
1844 $row['unsubscribe'] = CRM_Mailing_Event_BAO_Unsubscribe
::getTotalCount($mailing_id, $mailing->id
, TRUE, TRUE);
1845 $report['event_totals']['unsubscribe'] +
= $row['unsubscribe'];
1847 $row['optout'] = CRM_Mailing_Event_BAO_Unsubscribe
::getTotalCount($mailing_id, $mailing->id
, TRUE, FALSE);
1848 $report['event_totals']['optout'] +
= $row['optout'];
1850 foreach (array_keys(CRM_Mailing_BAO_MailingJob
::fields()) as $field) {
1851 $row[$field] = $mailing->$field;
1854 if ($mailing->queue
) {
1855 $row['delivered_rate'] = (100.0 * $mailing->delivered
) / $mailing->queue
;
1856 $row['bounce_rate'] = (100.0 * $mailing->bounce
) / $mailing->queue
;
1857 $row['unsubscribe_rate'] = (100.0 * $row['unsubscribe']) / $mailing->queue
;
1858 $row['optout_rate'] = (100.0 * $row['optout']) / $mailing->queue
;
1861 $row['delivered_rate'] = 0;
1862 $row['bounce_rate'] = 0;
1863 $row['unsubscribe_rate'] = 0;
1864 $row['optout_rate'] = 0;
1867 $row['links'] = array(
1868 'clicks' => CRM_Utils_System
::url(
1869 'civicrm/mailing/report/event',
1870 "reset=1&event=click&mid=$mailing_id&jid={$mailing->id}"
1872 'queue' => CRM_Utils_System
::url(
1873 'civicrm/mailing/report/event',
1874 "reset=1&event=queue&mid=$mailing_id&jid={$mailing->id}"
1876 'delivered' => CRM_Utils_System
::url(
1877 'civicrm/mailing/report/event',
1878 "reset=1&event=delivered&mid=$mailing_id&jid={$mailing->id}"
1880 'bounce' => CRM_Utils_System
::url(
1881 'civicrm/mailing/report/event',
1882 "reset=1&event=bounce&mid=$mailing_id&jid={$mailing->id}"
1884 'unsubscribe' => CRM_Utils_System
::url(
1885 'civicrm/mailing/report/event',
1886 "reset=1&event=unsubscribe&mid=$mailing_id&jid={$mailing->id}"
1888 'forward' => CRM_Utils_System
::url(
1889 'civicrm/mailing/report/event',
1890 "reset=1&event=forward&mid=$mailing_id&jid={$mailing->id}"
1892 'reply' => CRM_Utils_System
::url(
1893 'civicrm/mailing/report/event',
1894 "reset=1&event=reply&mid=$mailing_id&jid={$mailing->id}"
1896 'opened' => CRM_Utils_System
::url(
1897 'civicrm/mailing/report/event',
1898 "reset=1&event=opened&mid=$mailing_id&jid={$mailing->id}"
1903 'scheduled_date', 'start_date', 'end_date') as $key) {
1904 $row[$key] = CRM_Utils_Date
::customFormat($row[$key]);
1906 $report['jobs'][] = $row;
1909 $newTableSize = CRM_Mailing_BAO_Recipients
::mailingSize($mailing_id);
1911 // we need to do this for backward compatibility, since old mailings did not
1912 // use the mailing_recipients table
1913 if ($newTableSize > 0) {
1914 $report['event_totals']['queue'] = $newTableSize;
1917 $report['event_totals']['queue'] = self
::getRecipientsCount($mailing_id, $mailing_id);
1920 if (CRM_Utils_Array
::value('queue', $report['event_totals'])) {
1921 $report['event_totals']['delivered_rate'] = (100.0 * $report['event_totals']['delivered']) / $report['event_totals']['queue'];
1922 $report['event_totals']['bounce_rate'] = (100.0 * $report['event_totals']['bounce']) / $report['event_totals']['queue'];
1923 $report['event_totals']['unsubscribe_rate'] = (100.0 * $report['event_totals']['unsubscribe']) / $report['event_totals']['queue'];
1924 $report['event_totals']['optout_rate'] = (100.0 * $report['event_totals']['optout']) / $report['event_totals']['queue'];
1927 $report['event_totals']['delivered_rate'] = 0;
1928 $report['event_totals']['bounce_rate'] = 0;
1929 $report['event_totals']['unsubscribe_rate'] = 0;
1930 $report['event_totals']['optout_rate'] = 0;
1933 /* Get the click-through totals, grouped by URL */
1936 SELECT {$t['url']}.url,
1938 COUNT({$t['urlopen']}.id) as clicks,
1939 COUNT(DISTINCT {$t['queue']}.id) as unique_clicks
1941 LEFT JOIN {$t['urlopen']}
1942 ON {$t['urlopen']}.trackable_url_id = {$t['url']}.id
1943 LEFT JOIN {$t['queue']}
1944 ON {$t['urlopen']}.event_queue_id = {$t['queue']}.id
1945 LEFT JOIN {$t['job']}
1946 ON {$t['queue']}.job_id = {$t['job']}.id
1947 WHERE {$t['url']}.mailing_id = $mailing_id
1948 AND {$t['job']}.is_test = 0
1949 GROUP BY {$t['url']}.id");
1951 $report['click_through'] = array();
1953 while ($mailing->fetch()) {
1954 $report['click_through'][] = array(
1955 'url' => $mailing->url
,
1957 CRM_Utils_System
::url(
1958 'civicrm/mailing/report/event',
1959 "reset=1&event=click&mid=$mailing_id&uid={$mailing->id}"
1962 CRM_Utils_System
::url(
1963 'civicrm/mailing/report/event',
1964 "reset=1&event=click&mid=$mailing_id&uid={$mailing->id}&distinct=1"
1966 'clicks' => $mailing->clicks
,
1967 'unique' => $mailing->unique_clicks
,
1968 'rate' => CRM_Utils_Array
::value('delivered', $report['event_totals']) ?
(100.0 * $mailing->unique_clicks
) / $report['event_totals']['delivered'] : 0,
1972 $report['event_totals']['links'] = array(
1973 'clicks' => CRM_Utils_System
::url(
1974 'civicrm/mailing/report/event',
1975 "reset=1&event=click&mid=$mailing_id"
1977 'clicks_unique' => CRM_Utils_System
::url(
1978 'civicrm/mailing/report/event',
1979 "reset=1&event=click&mid=$mailing_id&distinct=1"
1981 'queue' => CRM_Utils_System
::url(
1982 'civicrm/mailing/report/event',
1983 "reset=1&event=queue&mid=$mailing_id"
1985 'delivered' => CRM_Utils_System
::url(
1986 'civicrm/mailing/report/event',
1987 "reset=1&event=delivered&mid=$mailing_id"
1989 'bounce' => CRM_Utils_System
::url(
1990 'civicrm/mailing/report/event',
1991 "reset=1&event=bounce&mid=$mailing_id"
1993 'unsubscribe' => CRM_Utils_System
::url(
1994 'civicrm/mailing/report/event',
1995 "reset=1&event=unsubscribe&mid=$mailing_id"
1997 'optout' => CRM_Utils_System
::url(
1998 'civicrm/mailing/report/event',
1999 "reset=1&event=optout&mid=$mailing_id"
2001 'forward' => CRM_Utils_System
::url(
2002 'civicrm/mailing/report/event',
2003 "reset=1&event=forward&mid=$mailing_id"
2005 'reply' => CRM_Utils_System
::url(
2006 'civicrm/mailing/report/event',
2007 "reset=1&event=reply&mid=$mailing_id"
2009 'opened' => CRM_Utils_System
::url(
2010 'civicrm/mailing/report/event',
2011 "reset=1&event=opened&mid=$mailing_id"
2016 $actionLinks = array(CRM_Core_Action
::VIEW
=> array('name' => ts('Report')));
2017 if (CRM_Core_Permission
::check('view all contacts')) {
2018 $actionLinks[CRM_Core_Action
::ADVANCED
] =
2020 'name' => ts('Advanced Search'),
2021 'url' => 'civicrm/contact/search/advanced',
2024 $action = array_sum(array_keys($actionLinks));
2026 $report['event_totals']['actionlinks'] = array();
2028 'clicks', 'clicks_unique', 'queue', 'delivered', 'bounce', 'unsubscribe',
2029 'forward', 'reply', 'opened', 'optout',
2031 $url = 'mailing/detail';
2032 $reportFilter = "reset=1&mailing_id_value={$mailing_id}";
2033 $searchFilter = "force=1&mailing_id={$mailing_id}";
2036 $reportFilter .= "&delivery_status_value=successful";
2037 $searchFilter .= "&mailing_delivery_status=Y";
2041 $url = "mailing/bounce";
2042 $searchFilter .= "&mailing_delivery_status=N";
2046 $reportFilter .= "&is_forwarded_value=1";
2047 $searchFilter .= "&mailing_forward=1";
2051 $reportFilter .= "&is_replied_value=1";
2052 $searchFilter .= "&mailing_reply_status=Y";
2056 $reportFilter .= "&is_unsubscribed_value=1";
2057 $searchFilter .= "&mailing_unsubscribe=1";
2061 $reportFilter .= "&is_optout_value=1";
2062 $searchFilter .= "&mailing_optout=1";
2066 $url = "mailing/opened";
2067 $searchFilter .= "&mailing_open_status=Y";
2071 case 'clicks_unique':
2072 $url = "mailing/clicks";
2073 $searchFilter .= "&mailing_click_status=Y";
2076 $actionLinks[CRM_Core_Action
::VIEW
]['url'] = CRM_Report_Utils_Report
::getNextUrl($url, $reportFilter, FALSE, TRUE);
2077 if (array_key_exists(CRM_Core_Action
::ADVANCED
, $actionLinks)) {
2078 $actionLinks[CRM_Core_Action
::ADVANCED
]['qs'] = $searchFilter;
2080 $report['event_totals']['actionlinks'][$key] = CRM_Core_Action
::formLink($actionLinks, $action, array());
2087 * Get the count of mailings
2094 public function getCount() {
2096 $this->selectAdd('COUNT(id) as count');
2098 $session = CRM_Core_Session
::singleton();
2101 return $this->count
;
2104 static function checkPermission($id) {
2109 $mailingIDs = self
::mailingACLIDs();
2110 if ($mailingIDs === TRUE) {
2114 if (!in_array($id, $mailingIDs)) {
2115 CRM_Core_Error
::fatal(ts('You do not have permission to access this mailing report'));
2120 static function mailingACL($alias = NULL) {
2121 $mailingACL = " ( 0 ) ";
2123 $mailingIDs = self
::mailingACLIDs();
2124 if ($mailingIDs === TRUE) {
2128 if (!empty($mailingIDs)) {
2129 $mailingIDs = implode(',', $mailingIDs);
2130 $tableName = !$alias ? self
::getTableName() : $alias;
2131 $mailingACL = " $tableName.id IN ( $mailingIDs ) ";
2137 * returns all the mailings that this user can access. This is dependent on
2138 * all the groups that the user has access to.
2139 * However since most civi installs dont use ACL's we special case the condition
2140 * where the user has access to ALL groups, and hence ALL mailings and return a
2141 * value of TRUE (to avoid the downstream where clause with a list of mailing list IDs
2143 * @return boolean | array - TRUE if the user has access to all mailings, else array of mailing IDs (possibly empty)
2146 static function mailingACLIDs() {
2148 // optimize common case where admin has access
2151 CRM_Core_Permission
::check('view all contacts') ||
2152 CRM_Core_Permission
::check('edit all contacts')
2157 $mailingIDs = array();
2159 // get all the groups that this user can access
2160 // if they dont have universal access
2161 $groups = CRM_Core_PseudoConstant
::group(NULL, FALSE);
2162 if (!empty($groups)) {
2163 $groupIDs = implode(',', array_keys($groups));
2165 // get all the mailings that are in this subset of groups
2167 SELECT DISTINCT( m.id ) as id
2168 FROM civicrm_mailing m
2169 LEFT JOIN civicrm_mailing_group g ON g.mailing_id = m.id
2170 WHERE ( ( g.entity_table like 'civicrm_group%' AND g.entity_id IN ( $groupIDs ) )
2171 OR ( g.entity_table IS NULL AND g.entity_id IS NULL ) )
2173 $dao = CRM_Core_DAO
::executeQuery($query);
2175 $mailingIDs = array();
2176 while ($dao->fetch()) {
2177 $mailingIDs[] = $dao->id
;
2185 * Get the rows for a browse operation
2187 * @param int $offset The row number to start from
2188 * @param int $rowCount The nmber of rows to return
2189 * @param string $sort The sql string that describes the sort order
2191 * @return array The rows
2194 public function &getRows($offset, $rowCount, $sort, $additionalClause = NULL, $additionalParams = NULL) {
2195 $mailing = self
::getTableName();
2196 $job = CRM_Mailing_BAO_MailingJob
::getTableName();
2197 $group = CRM_Mailing_DAO_MailingGroup
::getTableName();
2198 $session = CRM_Core_Session
::singleton();
2200 $mailingACL = self
::mailingACL();
2202 //get all campaigns.
2203 $allCampaigns = CRM_Campaign_BAO_Campaign
::getCampaigns(NULL, NULL, FALSE, FALSE, FALSE, TRUE);
2205 // we only care about parent jobs, since that holds all the info on
2211 $mailing.approval_status_id,
2212 MIN($job.scheduled_date) as scheduled_date,
2213 MIN($job.start_date) as start_date,
2214 MAX($job.end_date) as end_date,
2215 createdContact.sort_name as created_by,
2216 scheduledContact.sort_name as scheduled_by,
2217 $mailing.created_id as created_id,
2218 $mailing.scheduled_id as scheduled_id,
2219 $mailing.is_archived as archived,
2220 $mailing.created_date as created_date,
2222 $mailing.sms_provider_id as sms_provider_id
2224 LEFT JOIN $job ON ( $job.mailing_id = $mailing.id AND $job.is_test = 0 AND $job.parent_id IS NULL )
2225 LEFT JOIN civicrm_contact createdContact ON ( civicrm_mailing.created_id = createdContact.id )
2226 LEFT JOIN civicrm_contact scheduledContact ON ( civicrm_mailing.scheduled_id = scheduledContact.id )
2227 WHERE $mailingACL $additionalClause
2228 GROUP BY $mailing.id ";
2231 $orderBy = trim($sort->orderBy());
2232 if (!empty($orderBy)) {
2233 $query .= " ORDER BY $orderBy";
2238 $offset = CRM_Utils_Type
::escape($offset, 'Int');
2239 $rowCount = CRM_Utils_Type
::escape($rowCount, 'Int');
2241 $query .= " LIMIT $offset, $rowCount ";
2244 if (!$additionalParams) {
2245 $additionalParams = array();
2248 $dao = CRM_Core_DAO
::executeQuery($query, $additionalParams);
2251 while ($dao->fetch()) {
2254 'name' => $dao->name
,
2255 'status' => $dao->status ?
$dao->status
: 'Not scheduled',
2256 'created_date' => CRM_Utils_Date
::customFormat($dao->created_date
),
2257 'scheduled' => CRM_Utils_Date
::customFormat($dao->scheduled_date
),
2258 'scheduled_iso' => $dao->scheduled_date
,
2259 'start' => CRM_Utils_Date
::customFormat($dao->start_date
),
2260 'end' => CRM_Utils_Date
::customFormat($dao->end_date
),
2261 'created_by' => $dao->created_by
,
2262 'scheduled_by' => $dao->scheduled_by
,
2263 'created_id' => $dao->created_id
,
2264 'scheduled_id' => $dao->scheduled_id
,
2265 'archived' => $dao->archived
,
2266 'approval_status_id' => $dao->approval_status_id
,
2267 'campaign_id' => $dao->campaign_id
,
2268 'campaign' => empty($dao->campaign_id
) ?
NULL : $allCampaigns[$dao->campaign_id
],
2269 'sms_provider_id' => $dao->sms_provider_id
,
2276 * Function to show detail Mailing report
2283 static function showEmailDetails($id) {
2284 return CRM_Utils_System
::url('civicrm/mailing/report', "mid=$id");
2288 * Delete Mails and all its associated records
2290 * @param int $id id of the mail to delete
2296 public static function del($id) {
2298 CRM_Core_Error
::fatal();
2301 CRM_Utils_Hook
::pre('delete', 'Mailing', $id, CRM_Core_DAO
::$_nullArray);
2303 // delete all file attachments
2304 CRM_Core_BAO_File
::deleteEntityFile('civicrm_mailing',
2308 $dao = new CRM_Mailing_DAO_Mailing();
2312 CRM_Core_Session
::setStatus(ts('Selected mailing has been deleted.'), ts('Deleted'), 'success');
2314 CRM_Utils_Hook
::post('delete', 'Mailing', $id, $dao);
2318 * Delete Jobss and all its associated records
2319 * related to test Mailings
2321 * @param int $id id of the Job to delete
2327 public static function delJob($id) {
2329 CRM_Core_Error
::fatal();
2332 $dao = new CRM_Mailing_BAO_MailingJob();
2337 function getReturnProperties() {
2338 $tokens = &$this->getTokens();
2340 $properties = array();
2341 if (isset($tokens['html']) &&
2342 isset($tokens['html']['contact'])
2344 $properties = array_merge($properties, $tokens['html']['contact']);
2347 if (isset($tokens['text']) &&
2348 isset($tokens['text']['contact'])
2350 $properties = array_merge($properties, $tokens['text']['contact']);
2353 if (isset($tokens['subject']) &&
2354 isset($tokens['subject']['contact'])
2356 $properties = array_merge($properties, $tokens['subject']['contact']);
2359 $returnProperties = array();
2360 $returnProperties['display_name'] = $returnProperties['contact_id'] = $returnProperties['preferred_mail_format'] = $returnProperties['hash'] = 1;
2362 foreach ($properties as $p) {
2363 $returnProperties[$p] = 1;
2366 return $returnProperties;
2370 * Function to build the compose mail form
2377 public static function commonCompose(&$form) {
2379 $tokens = CRM_Core_SelectValues
::contactTokens();
2381 //token selector for subject
2383 $form->add('select', 'token3', ts('Insert Token'),
2388 'onclick' => "return tokenReplText(this);",
2391 $className = CRM_Utils_System
::getClassName($form);
2392 if ($className == 'CRM_Mailing_Form_Upload') {
2393 $tokens = array_merge(CRM_Core_SelectValues
::mailingTokens(), $tokens);
2395 elseif ($className == 'CRM_Admin_Form_ScheduleReminders') {
2396 $tokens = array_merge(CRM_Core_SelectValues
::activityTokens(), $tokens);
2397 $tokens = array_merge(CRM_Core_SelectValues
::eventTokens(), $tokens);
2398 $tokens = array_merge(CRM_Core_SelectValues
::membershipTokens(), $tokens);
2400 elseif ($className == 'CRM_Event_Form_ManageEvent_ScheduleReminders') {
2401 $tokens = array_merge(CRM_Core_SelectValues
::eventTokens(), $tokens);
2404 //sorted in ascending order tokens by ignoring word case
2405 natcasesort($tokens);
2406 $form->assign('tokens', json_encode($tokens));
2408 $form->add('select', 'token1', ts('Insert Tokens'),
2413 'onclick' => "return tokenReplText(this);",
2417 $form->add('select', 'token2', ts('Insert Tokens'),
2422 'onclick' => "return tokenReplHtml(this);",
2427 $form->_templates
= CRM_Core_BAO_MessageTemplate
::getMessageTemplates(FALSE);
2428 if (!empty($form->_templates
)) {
2429 $form->assign('templates', TRUE);
2430 $form->add('select', 'template', ts('Use Template'),
2432 '' => ts('- select -')) +
$form->_templates
, FALSE,
2433 array('onChange' => "selectValue( this.value );")
2435 $form->add('checkbox', 'updateTemplate', ts('Update Template'), NULL);
2438 $form->add('checkbox', 'saveTemplate', ts('Save As New Template'), NULL, FALSE,
2439 array('onclick' => "showSaveDetails(this);")
2441 $form->add('text', 'saveTemplateName', ts('Template Title'));
2444 //insert message Text by selecting "Select Template option"
2445 $form->add('textarea',
2447 ts('Plain-text format'),
2449 'cols' => '80', 'rows' => '8',
2450 'onkeyup' => "return verify(this)",
2454 if ($className != 'CRM_SMS_Form_Upload' && $className != 'CRM_Contact_Form_Task_SMS' &&
2455 $className != 'CRM_Contact_Form_Task_SMS'
2457 $form->addWysiwyg('html_message',
2460 'cols' => '80', 'rows' => '8',
2461 'onkeyup' => "return verify(this)",
2468 * Function to build the compose PDF letter form
2475 public static function commonLetterCompose(&$form) {
2477 $tokens = CRM_Core_SelectValues
::contactTokens();
2478 if (CRM_Utils_System
::getClassName($form) == 'CRM_Mailing_Form_Upload') {
2479 $tokens = array_merge(CRM_Core_SelectValues
::mailingTokens(), $tokens);
2481 //@todo move this fn onto the form
2482 if (CRM_Utils_System
::getClassName($form) == 'CRM_Contribute_Form_Task_PDFLetter') {
2483 $tokens = array_merge(CRM_Core_SelectValues
::contributionTokens(), $tokens);
2486 if(method_exists($form, 'listTokens')) {
2487 $tokens = array_merge($form->listTokens(), $tokens);
2490 //sorted in ascending order tokens by ignoring word case
2491 natcasesort($tokens);
2493 $form->assign('tokens', json_encode($tokens));
2495 $form->add('select', 'token1', ts('Insert Tokens'),
2500 'onchange' => "return tokenReplHtml(this);",
2504 $form->_templates
= CRM_Core_BAO_MessageTemplate
::getMessageTemplates(FALSE);
2505 if (!empty($form->_templates
)) {
2506 $form->assign('templates', TRUE);
2507 $form->add('select', 'template', ts('Select Template'),
2509 '' => ts('- select -')) +
$form->_templates
, FALSE,
2510 array('onChange' => "selectValue( this.value );")
2512 $form->add('checkbox', 'updateTemplate', ts('Update Template'), NULL);
2515 $form->add('checkbox', 'saveTemplate', ts('Save As New Template'), NULL, FALSE,
2516 array('onclick' => "showSaveDetails(this);")
2518 $form->add('text', 'saveTemplateName', ts('Template Title'));
2521 $form->addWysiwyg('html_message',
2524 'cols' => '80', 'rows' => '8',
2525 'onkeyup' => "return verify(this)",
2528 $action = CRM_Utils_Request
::retrieve('action', 'String', $form, FALSE);
2529 if ((CRM_Utils_System
::getClassName($form) == 'CRM_Contact_Form_Task_PDF') &&
2530 $action == CRM_Core_Action
::VIEW
2532 $form->freeze('html_message');
2537 * Get the search based mailing Ids
2539 * @return array $mailingIDs, searched base mailing ids.
2542 public function searchMailingIDs() {
2543 $group = CRM_Mailing_DAO_MailingGroup
::getTableName();
2544 $mailing = self
::getTableName();
2547 SELECT $mailing.id as mailing_id
2548 FROM $mailing, $group
2549 WHERE $group.mailing_id = $mailing.id
2550 AND $group.group_type = 'Base'";
2552 $searchDAO = CRM_Core_DAO
::executeQuery($query);
2553 $mailingIDs = array();
2554 while ($searchDAO->fetch()) {
2555 $mailingIDs[] = $searchDAO->mailing_id
;
2562 * Get the content/components of mailing based on mailing Id
2564 * @param $report array of mailing report
2566 * @param $form reference of this
2568 * @return $report array content/component.
2571 static function getMailingContent(&$report, &$form, $isSMS = FALSE) {
2572 $htmlHeader = $textHeader = NULL;
2573 $htmlFooter = $textFooter = NULL;
2576 if ($report['mailing']['header_id']) {
2577 $header = new CRM_Mailing_BAO_Component();
2578 $header->id
= $report['mailing']['header_id'];
2579 $header->find(TRUE);
2580 $htmlHeader = $header->body_html
;
2581 $textHeader = $header->body_text
;
2584 if ($report['mailing']['footer_id']) {
2585 $footer = new CRM_Mailing_BAO_Component();
2586 $footer->id
= $report['mailing']['footer_id'];
2587 $footer->find(TRUE);
2588 $htmlFooter = $footer->body_html
;
2589 $textFooter = $footer->body_text
;
2593 $text = CRM_Utils_Request
::retrieve('text', 'Boolean', $form);
2595 echo "<pre>{$textHeader}</br>{$report['mailing']['body_text']}</br>{$textFooter}</pre>";
2596 CRM_Utils_System
::civiExit();
2600 $html = CRM_Utils_Request
::retrieve('html', 'Boolean', $form);
2602 $output = $htmlHeader . $report['mailing']['body_html'] . $htmlFooter ;
2603 echo str_replace( "\n", '<br />', $output );
2604 CRM_Utils_System
::civiExit();
2608 if (!empty($report['mailing']['body_text'])) {
2609 $url = CRM_Utils_System
::url('civicrm/mailing/report', 'reset=1&text=1&mid=' . $form->_mailing_id
);
2610 $popup = "javascript:popUp(\"$url\");";
2611 $form->assign('textViewURL', $popup);
2615 if (!empty($report['mailing']['body_html'])) {
2616 $url = CRM_Utils_System
::url('civicrm/mailing/report', 'reset=1&html=1&mid=' . $form->_mailing_id
);
2617 $popup = "javascript:popUp(\"$url\");";
2618 $form->assign('htmlViewURL', $popup);
2623 $report['mailing']['attachment'] = CRM_Core_BAO_File
::attachmentInfo('civicrm_mailing', $form->_mailing_id
);
2628 static function overrideVerp($jobID) {
2629 static $_cache = array();
2631 if (!isset($_cache[$jobID])) {
2633 SELECT override_verp
2634 FROM civicrm_mailing
2635 INNER JOIN civicrm_mailing_job ON civicrm_mailing.id = civicrm_mailing_job.mailing_id
2636 WHERE civicrm_mailing_job.id = %1
2638 $params = array(1 => array($jobID, 'Integer'));
2639 $_cache[$jobID] = CRM_Core_DAO
::singleValueQuery($query, $params);
2641 return $_cache[$jobID];
2644 static function processQueue($mode = NULL) {
2645 $config = &CRM_Core_Config
::singleton();
2646 // CRM_Core_Error::debug_log_message("Beginning processQueue run: {$config->mailerJobsMax}, {$config->mailerJobSize}");
2648 if ($mode == NULL && CRM_Core_BAO_MailSettings
::defaultDomain() == "EXAMPLE.ORG") {
2649 CRM_Core_Error
::fatal(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(1 => CRM_Utils_System
::url('civicrm/admin/mailSettings', 'reset=1'), 2 => "http://book.civicrm.org/user/advanced-configuration/email-system-configuration/")));
2652 // check if we are enforcing number of parallel cron jobs
2654 $gotCronLock = FALSE;
2656 if (property_exists($config, 'mailerJobsMax') && $config->mailerJobsMax
&& $config->mailerJobsMax
> 1) {
2657 $lockArray = range(1, $config->mailerJobsMax
);
2658 shuffle($lockArray);
2660 // check if we are using global locks
2661 $serverWideLock = CRM_Core_BAO_Setting
::getItem(
2662 CRM_Core_BAO_Setting
::MAILING_PREFERENCES_NAME
,
2663 'civimail_server_wide_lock'
2665 foreach ($lockArray as $lockID) {
2666 $cronLock = new CRM_Core_Lock("civimail.cronjob.{$lockID}", NULL, $serverWideLock);
2667 if ($cronLock->isAcquired()) {
2668 $gotCronLock = TRUE;
2673 // exit here since we have enuf cronjobs running
2674 if (!$gotCronLock) {
2675 CRM_Core_Error
::debug_log_message('Returning early, since max number of cronjobs running');
2680 // load bootstrap to call hooks
2682 // Split up the parent jobs into multiple child jobs
2683 $mailerJobSize = (property_exists($config, 'mailerJobSize')) ?
$config->mailerJobSize
: NULL;
2684 CRM_Mailing_BAO_MailingJob
::runJobs_pre($mailerJobSize, $mode);
2685 CRM_Mailing_BAO_MailingJob
::runJobs(NULL, $mode);
2686 CRM_Mailing_BAO_MailingJob
::runJobs_post($mode);
2688 // lets release the global cron lock if we do have one
2690 $cronLock->release();
2693 // CRM_Core_Error::debug_log_message('Ending processQueue run');
2697 private static function addMultipleEmails($mailingID) {
2699 INSERT INTO civicrm_mailing_recipients
2700 (mailing_id, email_id, contact_id)
2701 SELECT %1, e.id, e.contact_id FROM civicrm_email e
2703 AND e.is_bulkmail = 1
2705 ( SELECT contact_id FROM civicrm_mailing_recipients mr WHERE mailing_id = %1 )
2706 AND e.id NOT IN ( SELECT email_id FROM civicrm_mailing_recipients mr WHERE mailing_id = %1 )
2708 $params = array(1 => array($mailingID, 'Integer'));
2710 $dao = CRM_Core_DAO
::executeQuery($sql, $params);
2713 static function getMailingsList($isSMS = FALSE) {
2714 static $list = array();
2717 $where .= " civicrm_mailing.sms_provider_id IS NULL ";
2720 $where .= " civicrm_mailing.sms_provider_id IS NOT NULL ";
2725 SELECT civicrm_mailing.id, civicrm_mailing.name, civicrm_mailing_job.end_date
2726 FROM civicrm_mailing
2727 INNER JOIN civicrm_mailing_job ON civicrm_mailing.id = civicrm_mailing_job.mailing_id {$where}
2728 ORDER BY civicrm_mailing.name";
2729 $mailing = CRM_Core_DAO
::executeQuery($query);
2731 while ($mailing->fetch()) {
2732 $list[$mailing->id
] = "{$mailing->name} :: {$mailing->end_date}";
2739 static function hiddenMailingGroup($mid) {
2742 FROM civicrm_mailing m
2743 INNER JOIN civicrm_mailing_group mg ON mg.mailing_id = m.id
2744 INNER JOIN civicrm_group g ON mg.entity_id = g.id AND mg.entity_table = 'civicrm_group'
2745 WHERE g.is_hidden = 1
2746 AND mg.group_type = 'Include'
2749 $params = array( 1 => array( $mid, 'Integer' ) );
2750 return CRM_Core_DAO
::singleValueQuery($sql, $params);
2754 * This function is a wrapper for ajax activity selector
2756 * @param array $params associated array for params record id.
2758 * @return array $contactActivities associated array of contact activities
2761 public static function getContactMailingSelector(&$params) {
2762 // format the params
2763 $params['offset'] = ($params['page'] - 1) * $params['rp'];
2764 $params['rowCount'] = $params['rp'];
2765 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
2766 $params['caseId'] = NULL;
2768 // get contact mailings
2769 $mailings = CRM_Mailing_BAO_Mailing
::getContactMailings($params);
2772 $params['total'] = CRM_Mailing_BAO_Mailing
::getContactMailingsCount($params);
2775 if (!empty($mailings)) {
2776 $openCounts = CRM_Mailing_Event_BAO_Opened
::getMailingTotalCount(array_keys($mailings));
2777 $clickCounts = CRM_Mailing_Event_BAO_TrackableURLOpen
::getMailingTotalCount(array_keys($mailings));
2780 // format params and add links
2781 $contactMailings = array();
2782 foreach ($mailings as $mailingId => $values) {
2783 $contactMailings[$mailingId]['subject'] = $values['subject'];
2784 $contactMailings[$mailingId]['start_date'] = CRM_Utils_Date
::customFormat($values['start_date']);
2785 $contactMailings[$mailingId]['recipients'] = CRM_Utils_System
::href(ts('(recipients)'), 'civicrm/mailing/report/event',
2786 "mid={$values['mailing_id']}&reset=1&cid={$params['contact_id']}&event=queue&context=mailing");
2788 $contactMailings[$mailingId]['mailing_creator'] = CRM_Utils_System
::href(
2789 $values['creator_name'],
2790 'civicrm/contact/view',
2791 "reset=1&cid={$values['creator_id']}");
2794 $contactMailings[$mailingId]['openstats'] = ts('Opens') . ': ' . $openCounts[$values['mailing_id']] .
2795 '<br />' . ts('Clicks') . ': ' . $clickCounts[$values['mailing_id']];
2797 $actionLinks = array(
2798 CRM_Core_Action
::VIEW
=> array(
2799 'name' => ts('View'),
2800 'url' => 'civicrm/mailing/view',
2801 'qs' => "reset=1&id={$values['mailing_id']}",
2802 'title' => ts('View Mailing'),
2803 'class' => 'crm-mailing-view',
2805 CRM_Core_Action
::BROWSE
=> array(
2806 'name' => ts('Mailing Report'),
2807 'url' => 'civicrm/mailing/report',
2808 'qs' => "mid={$values['mailing_id']}&reset=1&cid={$params['contact_id']}&context=mailing",
2809 'title' => ts('View Mailing Report'),
2813 $contactMailings[$mailingId]['links'] = CRM_Core_Action
::formLink($actionLinks);
2816 return $contactMailings;
2820 * Function to retrieve contact mailing
2822 * @param array $params associated array
2824 * @return array of mailings for a contact
2829 static public function getContactMailings(&$params) {
2830 $params['version'] = 3;
2831 $params['offset'] = ($params['page'] - 1) * $params['rp'];
2832 $params['limit'] = $params['rp'];
2833 $params['sort'] = CRM_Utils_Array
::value('sortBy', $params);
2835 $result = civicrm_api('MailingContact', 'get', $params);
2836 return $result['values'];
2840 * Function to retrieve contact mailing count
2842 * @param array $params associated array
2844 * @return int count of mailings for a contact
2849 static public function getContactMailingsCount(&$params) {
2850 $params['version'] = 3;
2851 return civicrm_api('MailingContact', 'getcount', $params);