3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
36 require_once 'Mail/mime.php';
37 class CRM_Core_BAO_MessageTemplate
extends CRM_Core_DAO_MessageTemplate
{
40 * Takes a bunch of params that are needed to match certain criteria and
41 * retrieves the relevant objects. Typically the valid params are only
42 * contact_id. We'll tweak this function to be more full featured over a period
43 * of time. This is the inverse function of create. It also stores all the retrieved
44 * values in the default array
46 * @param array $params (reference ) an assoc array of name/value pairs
47 * @param array $defaults (reference ) an assoc array to hold the flattened values
49 * @return object CRM_Core_BAO_MessageTemplate object
53 static function retrieve(&$params, &$defaults) {
54 $messageTemplates = new CRM_Core_DAO_MessageTemplate();
55 $messageTemplates->copyValues($params);
56 if ($messageTemplates->find(TRUE)) {
57 CRM_Core_DAO
::storeValues($messageTemplates, $defaults);
58 return $messageTemplates;
64 * update the is_active flag in the db
66 * @param int $id id of the database record
67 * @param boolean $is_active value we want to set the is_active field
69 * @return Object DAO object on sucess, null otherwise
72 static function setIsActive($id, $is_active) {
73 return CRM_Core_DAO
::setFieldValue('CRM_Core_DAO_MessageTemplate', $id, 'is_active', $is_active);
77 * function to add the Message Templates
79 * @param array $params reference array contains the values submitted by the form
86 static function add(&$params) {
87 $hook = empty($params['id']) ?
'create' : 'edit';
88 CRM_Utils_Hook
::pre($hook, 'MessageTemplate', CRM_Utils_Array
::value('id', $params), $params);
90 $messageTemplates = new CRM_Core_DAO_MessageTemplate();
91 $messageTemplates->copyValues($params);
92 $messageTemplates->save();
94 CRM_Utils_Hook
::post($hook, 'MessageTemplate', $messageTemplates->id
, $messageTemplates);
95 return $messageTemplates;
99 * function to delete the Message Templates
104 * @param $messageTemplatesID
108 static function del($messageTemplatesID) {
109 // make sure messageTemplatesID is an integer
110 if (!CRM_Utils_Rule
::positiveInteger($messageTemplatesID)) {
111 CRM_Core_Error
::fatal(ts('Invalid Message template'));
114 // Set mailing msg template col to NULL
115 $query = "UPDATE civicrm_mailing
116 SET msg_template_id = NULL
117 WHERE msg_template_id = %1";
119 $params = array(1 => array($messageTemplatesID, 'Integer'));
120 CRM_Core_DAO
::executeQuery($query, $params);
122 $messageTemplates = new CRM_Core_DAO_MessageTemplate();
123 $messageTemplates->id
= $messageTemplatesID;
124 $messageTemplates->delete();
125 CRM_Core_Session
::setStatus(ts('Selected message template has been deleted.'), ts('Deleted'), 'success');
129 * function to get the Message Templates
138 static function getMessageTemplates($all = TRUE) {
141 $messageTemplates = new CRM_Core_DAO_MessageTemplate();
142 $messageTemplates->is_active
= 1;
145 $messageTemplates->workflow_id
= 'NULL';
147 $messageTemplates->find();
148 while ($messageTemplates->fetch()) {
149 $msgTpls[$messageTemplates->id
] = $messageTemplates->msg_title
;
155 static function sendReminder($contactId, $email, $messageTemplateID, $from) {
157 $messageTemplates = new CRM_Core_DAO_MessageTemplate();
158 $messageTemplates->id
= $messageTemplateID;
160 $domain = CRM_Core_BAO_Domain
::getDomain();
162 $hookTokens = array();
164 if ($messageTemplates->find(TRUE)) {
165 $body_text = $messageTemplates->msg_text
;
166 $body_html = $messageTemplates->msg_html
;
167 $body_subject = $messageTemplates->msg_subject
;
169 $body_text = CRM_Utils_String
::htmlToText($body_html);
172 $params = array(array('contact_id', '=', $contactId, 0, 0));
173 list($contact, $_) = CRM_Contact_BAO_Query
::apiQuery($params);
176 $contact = reset($contact);
178 if (!$contact ||
is_a($contact, 'CRM_Core_Error')) {
184 // get tokens to be replaced
185 $tokens = array_merge(CRM_Utils_Token
::getTokens($body_text),
186 CRM_Utils_Token
::getTokens($body_html),
187 CRM_Utils_Token
::getTokens($body_subject));
189 // get replacement text for these tokens
190 $returnProperties = array("preferred_mail_format" => 1);
191 if (isset($tokens['contact'])) {
192 foreach ($tokens['contact'] as $key => $value) {
193 $returnProperties[$value] = 1;
196 list($details) = CRM_Utils_Token
::getTokenDetails(array($contactId),
200 'CRM_Core_BAO_MessageTemplate');
201 $contact = reset( $details );
204 $hookTokens = array();
205 CRM_Utils_Hook
::tokens($hookTokens);
206 $categories = array_keys($hookTokens);
208 // do replacements in text and html body
209 $type = array('html', 'text');
210 foreach ($type as $key => $value) {
211 $bodyType = "body_{$value}";
213 CRM_Utils_Token
::replaceGreetingTokens($
$bodyType, NULL, $contact['contact_id']);
214 $
$bodyType = CRM_Utils_Token
::replaceDomainTokens($
$bodyType, $domain, true, $tokens, true);
215 $
$bodyType = CRM_Utils_Token
::replaceContactTokens($
$bodyType, $contact, false, $tokens, false, true);
216 $
$bodyType = CRM_Utils_Token
::replaceComponentTokens($
$bodyType, $contact, $tokens, true);
217 $
$bodyType = CRM_Utils_Token
::replaceHookTokens($
$bodyType, $contact , $categories, true);
223 $smarty = CRM_Core_Smarty
::singleton();
225 'text', 'html') as $elem) {
226 $
$elem = $smarty->fetch("string:{$$elem}");
229 // do replacements in message subject
230 $messageSubject = CRM_Utils_Token
::replaceContactTokens($body_subject, $contact, false, $tokens);
231 $messageSubject = CRM_Utils_Token
::replaceDomainTokens($messageSubject, $domain, true, $tokens);
232 $messageSubject = CRM_Utils_Token
::replaceComponentTokens($messageSubject, $contact, $tokens, true);
233 $messageSubject = CRM_Utils_Token
::replaceHookTokens($messageSubject, $contact, $categories, true);
235 $messageSubject = $smarty->fetch("string:{$messageSubject}");
237 // set up the parameters for CRM_Utils_Mail::send
239 'groupName' => 'Scheduled Reminder Sender',
241 'toName' => $contact['display_name'],
243 'subject' => $messageSubject,
245 if (!$html ||
$contact['preferred_mail_format'] == 'Text' ||
246 $contact['preferred_mail_format'] == 'Both'
248 // render the & entities in text mode, so that the links work
249 $mailParams['text'] = str_replace('&', '&', $text);
251 if ($html && ($contact['preferred_mail_format'] == 'HTML' ||
252 $contact['preferred_mail_format'] == 'Both'
254 $mailParams['html'] = $html;
257 $result = CRM_Utils_Mail
::send($mailParams);
260 $messageTemplates->free();
266 * Revert a message template to its default subject+text+HTML state
268 * @param integer id id of the template
272 static function revert($id) {
273 $diverted = new self
;
274 $diverted->id
= (int) $id;
277 if ($diverted->N
!= 1) {
278 CRM_Core_Error
::fatal(ts('Did not find a message template with id of %1.', array(1 => $id)));
282 $orig->workflow_id
= $diverted->workflow_id
;
283 $orig->is_reserved
= 1;
287 CRM_Core_Error
::fatal(ts('Message template with id of %1 does not have a default to revert to.', array(1 => $id)));
290 $diverted->msg_subject
= $orig->msg_subject
;
291 $diverted->msg_text
= $orig->msg_text
;
292 $diverted->msg_html
= $orig->msg_html
;
293 $diverted->pdf_format_id
= is_null($orig->pdf_format_id
) ?
'null' : $orig->pdf_format_id
;
298 * Send an email from the specified template based on an array of params
300 * @param array $params a string-keyed array of function params, see function body for details
302 * @return array of four parameters: a boolean whether the email was sent, and the subject, text and HTML templates
304 static function sendTemplate($params) {
306 // option group name of the template
308 // option value name of the template
310 // ID of the template
311 'messageTemplateID' => NULL,
312 // contact id if contact tokens are to be replaced
314 // additional template params (other than the ones already set in the template singleton)
315 'tplParams' => array(),
318 // the recipient’s name
320 // the recipient’s email - mail is sent only if set
326 // the Reply-To: header
329 'attachments' => NULL,
330 // whether this is a test email (and hence should include the test banner)
332 // filename of optional PDF version to add as attachment (do not include path)
333 'PDFFilename' => NULL,
335 $params = array_merge($defaults, $params);
337 if ((!$params['groupName'] ||
338 !$params['valueName']
340 !$params['messageTemplateID']
342 CRM_Core_Error
::fatal(ts("Message template's option group and/or option value or ID missing."));
345 if ($params['messageTemplateID']) {
346 // fetch the three elements from the db based on id
347 $query = 'SELECT msg_subject subject, msg_text text, msg_html html, pdf_format_id format
348 FROM civicrm_msg_template mt
349 WHERE mt.id = %1 AND mt.is_default = 1';
350 $sqlParams = array(1 => array($params['messageTemplateID'], 'String'));
353 // fetch the three elements from the db based on option_group and option_value names
354 $query = 'SELECT msg_subject subject, msg_text text, msg_html html, pdf_format_id format
355 FROM civicrm_msg_template mt
356 JOIN civicrm_option_value ov ON workflow_id = ov.id
357 JOIN civicrm_option_group og ON ov.option_group_id = og.id
358 WHERE og.name = %1 AND ov.name = %2 AND mt.is_default = 1';
359 $sqlParams = array(1 => array($params['groupName'], 'String'), 2 => array($params['valueName'], 'String'));
361 $dao = CRM_Core_DAO
::executeQuery($query, $sqlParams);
365 if ($params['messageTemplateID']) {
366 CRM_Core_Error
::fatal(ts('No such message template: id=%1.', array(1 => $params['messageTemplateID'])));
369 CRM_Core_Error
::fatal(ts('No such message template: option group %1, option value %2.', array(1 => $params['groupName'], 2 => $params['valueName'])));
373 $subject = $dao->subject
;
376 $format = $dao->format
;
379 // add the test banner (if requested)
380 if ($params['isTest']) {
381 $query = "SELECT msg_subject subject, msg_text text, msg_html html
382 FROM civicrm_msg_template mt
383 JOIN civicrm_option_value ov ON workflow_id = ov.id
384 JOIN civicrm_option_group og ON ov.option_group_id = og.id
385 WHERE og.name = 'msg_tpl_workflow_meta' AND ov.name = 'test_preview' AND mt.is_default = 1";
386 $testDao = CRM_Core_DAO
::executeQuery($query);
389 $subject = $testDao->subject
. $subject;
390 $text = $testDao->text
. $text;
391 $html = preg_replace('/<body(.*)$/im', "<body\\1\n{$testDao->html}", $html);
395 // replace tokens in the three elements (in subject as if it was the text body)
396 $domain = CRM_Core_BAO_Domain
::getDomain();
397 $hookTokens = array();
398 $mailing = new CRM_Mailing_BAO_Mailing
;
399 $mailing->body_text
= $text;
400 $mailing->body_html
= $html;
401 $tokens = $mailing->getTokens();
402 CRM_Utils_Hook
::tokens($hookTokens);
403 $categories = array_keys($hookTokens);
405 $contactID = CRM_Utils_Array
::value('contactId', $params);
408 $contactParams = array('contact_id' => $contactID);
409 $returnProperties = array();
411 if (isset($tokens['text']['contact'])) {
412 foreach ($tokens['text']['contact'] as $name) {
413 $returnProperties[$name] = 1;
417 if (isset($tokens['html']['contact'])) {
418 foreach ($tokens['html']['contact'] as $name) {
419 $returnProperties[$name] = 1;
422 list($contact) = CRM_Utils_Token
::getTokenDetails($contactParams,
425 CRM_Utils_Token
::flattenTokens($tokens),
426 // we should consider adding groupName and valueName here
427 'CRM_Core_BAO_MessageTemplate'
429 $contact = $contact[$contactID];
432 $subject = CRM_Utils_Token
::replaceDomainTokens($subject, $domain, FALSE, $tokens['text'], TRUE);
433 $text = CRM_Utils_Token
::replaceDomainTokens($text, $domain, FALSE, $tokens['text'], TRUE);
434 $html = CRM_Utils_Token
::replaceDomainTokens($html, $domain, TRUE, $tokens['html'], TRUE);
437 $subject = CRM_Utils_Token
::replaceContactTokens($subject, $contact, FALSE, $tokens['text'], FALSE, TRUE);
438 $text = CRM_Utils_Token
::replaceContactTokens($text, $contact, FALSE, $tokens['text'], FALSE, TRUE);
439 $html = CRM_Utils_Token
::replaceContactTokens($html, $contact, FALSE, $tokens['html'], FALSE, TRUE);
442 $contactArray = array($contactID => $contact);
443 CRM_Utils_Hook
::tokenValues($contactArray,
446 CRM_Utils_Token
::flattenTokens($tokens),
447 // we should consider adding groupName and valueName here
448 'CRM_Core_BAO_MessageTemplate'
450 $contact = $contactArray[$contactID];
452 $subject = CRM_Utils_Token
::replaceHookTokens($subject, $contact, $categories, TRUE);
453 $text = CRM_Utils_Token
::replaceHookTokens($text, $contact, $categories, TRUE);
454 $html = CRM_Utils_Token
::replaceHookTokens($html, $contact, $categories, TRUE);
457 // strip whitespace from ends and turn into a single line
458 $subject = "{strip}$subject{/strip}";
460 // parse the three elements with Smarty
463 $smarty = CRM_Core_Smarty
::singleton();
464 foreach ($params['tplParams'] as $name => $value) {
465 $smarty->assign($name, $value);
468 'subject', 'text', 'html') as $elem) {
469 $
$elem = $smarty->fetch("string:{$$elem}");
472 // send the template, honouring the target user’s preferences (if any)
475 // create the params array
476 $params['subject'] = $subject;
477 $params['text'] = $text;
478 $params['html'] = $html;
480 if ($params['toEmail']) {
481 $contactParams = array(array('email', 'LIKE', $params['toEmail'], 0, 1));
482 list($contact, $_) = CRM_Contact_BAO_Query
::apiQuery($contactParams);
484 $prefs = array_pop($contact);
486 if (isset($prefs['preferred_mail_format']) and $prefs['preferred_mail_format'] == 'HTML') {
487 $params['text'] = NULL;
490 if (isset($prefs['preferred_mail_format']) and $prefs['preferred_mail_format'] == 'Text') {
491 $params['html'] = NULL;
494 $config = CRM_Core_Config
::singleton();
496 if ($config->doNotAttachPDFReceipt
&&
497 $params['PDFFilename'] &&
500 if (empty($params['attachments'])) {
501 $params['attachments'] = array();
503 $params['attachments'][] = CRM_Utils_Mail
::appendPDF($params['PDFFilename'], $params['html'], $format);
506 $sent = CRM_Utils_Mail
::send($params);
509 unlink($pdf_filename);
513 return array($sent, $subject, $text, $html);