3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
17 class CRM_Upgrade_Incremental_MessageTemplates
{
20 * Version we are upgrading to.
24 protected $upgradeVersion;
29 public function getUpgradeVersion() {
30 return $this->upgradeVersion
;
34 * @param string $upgradeVersion
36 public function setUpgradeVersion($upgradeVersion) {
37 $this->upgradeVersion
= $upgradeVersion;
41 * CRM_Upgrade_Incremental_MessageTemplates constructor.
43 * @param string $upgradeVersion
45 public function __construct($upgradeVersion) {
46 $this->setUpgradeVersion($upgradeVersion);
50 * Get any templates that have been updated.
54 protected function getTemplateUpdates() {
57 'version' => '5.4.alpha1',
58 'upgrade_descriptor' => ts('Use email greeting at top where available'),
60 ['name' => 'membership_online_receipt', 'type' => 'text'],
61 ['name' => 'membership_online_receipt', 'type' => 'html'],
62 ['name' => 'contribution_online_receipt', 'type' => 'text'],
63 ['name' => 'contribution_online_receipt', 'type' => 'html'],
64 ['name' => 'event_online_receipt', 'type' => 'text'],
65 ['name' => 'event_online_receipt', 'type' => 'html'],
66 ['name' => 'event_online_receipt', 'type' => 'subject'],
70 'version' => '5.7.alpha1',
71 'upgrade_descriptor' => ts('Fix invoice number (human readable) instead of id (reference)'),
72 'label' => ts('Contributions - Invoice'),
74 ['name' => 'contribution_invoice_receipt', 'type' => 'html'],
78 'version' => '5.10.alpha1',
79 'upgrade_descriptor' => ts('Show recurring cancel/update URLs in receipt based on payment processor capabilities'),
80 'label' => ts('Receipts - cancel/update subscription URLs'),
82 ['name' => 'contribution_online_receipt', 'type' => 'text'],
83 ['name' => 'contribution_online_receipt', 'type' => 'html'],
84 ['name' => 'contribution_recurring_notify', 'type' => 'text'],
85 ['name' => 'contribution_recurring_notify', 'type' => 'html'],
86 ['name' => 'membership_online_receipt', 'type' => 'text'],
87 ['name' => 'membership_online_receipt', 'type' => 'html'],
91 'version' => '5.12.alpha1',
92 'upgrade_descriptor' => ts('Update payment notification to remove print text, use email greeting'),
93 'label' => ts('Payment notification'),
95 ['name' => 'payment_or_refund_notification', 'type' => 'text'],
96 ['name' => 'payment_or_refund_notification', 'type' => 'html'],
100 'version' => '5.15.alpha1',
101 'upgrade_descriptor' => ts('Use email greeting and fix capitalization'),
102 'label' => ts('Pledge acknowledgement'),
104 ['name' => 'pledge_acknowledge', 'type' => 'text'],
105 ['name' => 'pledge_acknowledge', 'type' => 'html'],
109 'version' => '5.20.alpha1',
110 'upgrade_descriptor' => ts('Fix missing Email greetings'),
112 ['name' => 'contribution_dupalert', 'type' => 'subject'],
113 ['name' => 'contribution_invoice_receipt', 'type' => 'subject'],
114 ['name' => 'contribution_offline_receipt', 'type' => 'html'],
115 ['name' => 'contribution_offline_receipt', 'type' => 'subject'],
116 ['name' => 'contribution_offline_receipt', 'type' => 'text'],
117 ['name' => 'contribution_online_receipt', 'type' => 'subject'],
118 ['name' => 'contribution_online_receipt', 'type' => 'html'],
119 ['name' => 'contribution_recurring_billing', 'type' => 'html'],
120 ['name' => 'contribution_recurring_billing', 'type' => 'subject'],
121 ['name' => 'contribution_recurring_billing', 'type' => 'text'],
122 ['name' => 'contribution_recurring_cancelled', 'type' => 'html'],
123 ['name' => 'contribution_recurring_cancelled', 'type' => 'subject'],
124 ['name' => 'contribution_recurring_cancelled', 'type' => 'text'],
125 ['name' => 'contribution_recurring_edit', 'type' => 'html'],
126 ['name' => 'contribution_recurring_edit', 'type' => 'subject'],
127 ['name' => 'contribution_recurring_edit', 'type' => 'text'],
128 ['name' => 'contribution_recurring_notify', 'type' => 'html'],
129 ['name' => 'contribution_recurring_notify', 'type' => 'subject'],
130 ['name' => 'contribution_recurring_notify', 'type' => 'text'],
131 ['name' => 'event_offline_receipt', 'type' => 'html'],
132 ['name' => 'event_offline_receipt', 'type' => 'subject'],
133 ['name' => 'event_offline_receipt', 'type' => 'text'],
134 ['name' => 'event_online_receipt', 'type' => 'html'],
135 ['name' => 'event_online_receipt', 'type' => 'subject'],
136 ['name' => 'event_online_receipt', 'type' => 'text'],
137 ['name' => 'event_registration_receipt', 'type' => 'html'],
138 ['name' => 'event_registration_receipt', 'type' => 'subject'],
139 ['name' => 'event_registration_receipt', 'type' => 'text'],
140 ['name' => 'membership_autorenew_billing', 'type' => 'html'],
141 ['name' => 'membership_autorenew_billing', 'type' => 'subject'],
142 ['name' => 'membership_autorenew_billing', 'type' => 'text'],
143 ['name' => 'membership_autorenew_cancelled', 'type' => 'html'],
144 ['name' => 'membership_autorenew_cancelled', 'type' => 'subject'],
145 ['name' => 'membership_autorenew_cancelled', 'type' => 'text'],
146 ['name' => 'membership_offline_receipt', 'type' => 'html'],
147 ['name' => 'membership_offline_receipt', 'type' => 'subject'],
148 ['name' => 'membership_offline_receipt', 'type' => 'text'],
149 ['name' => 'membership_online_receipt', 'type' => 'subject'],
150 ['name' => 'membership_online_receipt', 'type' => 'html'],
151 ['name' => 'participant_cancelled', 'type' => 'html'],
152 ['name' => 'participant_cancelled', 'type' => 'subject'],
153 ['name' => 'participant_cancelled', 'type' => 'text'],
154 ['name' => 'participant_confirm', 'type' => 'html'],
155 ['name' => 'participant_confirm', 'type' => 'subject'],
156 ['name' => 'participant_confirm', 'type' => 'text'],
157 ['name' => 'participant_expired', 'type' => 'html'],
158 ['name' => 'participant_expired', 'type' => 'subject'],
159 ['name' => 'participant_expired', 'type' => 'text'],
160 ['name' => 'participant_transferred', 'type' => 'html'],
161 ['name' => 'participant_transferred', 'type' => 'subject'],
162 ['name' => 'participant_transferred', 'type' => 'text'],
163 ['name' => 'payment_or_refund_notification', 'type' => 'html'],
164 ['name' => 'payment_or_refund_notification', 'type' => 'subject'],
165 ['name' => 'payment_or_refund_notification', 'type' => 'text'],
166 ['name' => 'pcp_notify', 'type' => 'subject'],
167 ['name' => 'pcp_owner_notify', 'type' => 'html'],
168 ['name' => 'pcp_owner_notify', 'type' => 'subject'],
169 ['name' => 'pcp_owner_notify', 'type' => 'text'],
170 ['name' => 'pcp_status_change', 'type' => 'subject'],
171 ['name' => 'pcp_status_change', 'type' => 'html'],
172 ['name' => 'pcp_supporter_notify', 'type' => 'html'],
173 ['name' => 'pcp_supporter_notify', 'type' => 'subject'],
174 ['name' => 'pcp_supporter_notify', 'type' => 'text'],
175 ['name' => 'petition_confirmation_needed', 'type' => 'html'],
176 ['name' => 'petition_confirmation_needed', 'type' => 'subject'],
177 ['name' => 'petition_confirmation_needed', 'type' => 'text'],
178 ['name' => 'petition_sign', 'type' => 'html'],
179 ['name' => 'petition_sign', 'type' => 'subject'],
180 ['name' => 'petition_sign', 'type' => 'text'],
181 ['name' => 'pledge_acknowledge', 'type' => 'subject'],
182 ['name' => 'pledge_acknowledge', 'type' => 'html'],
183 ['name' => 'pledge_acknowledge', 'type' => 'text'],
184 ['name' => 'pledge_reminder', 'type' => 'html'],
185 ['name' => 'pledge_reminder', 'type' => 'subject'],
186 ['name' => 'pledge_reminder', 'type' => 'text'],
187 ['name' => 'uf_notify', 'type' => 'subject'],
188 ['name' => 'uf_notify', 'type' => 'html'],
189 ['name' => 'case_activity', 'type' => 'html'],
190 ['name' => 'contribution_dupalert', 'type' => 'html'],
191 ['name' => 'friend', 'type' => 'html'],
192 ['name' => 'test_preview', 'type' => 'html'],
196 'version' => '5.21.beta1',
197 'upgrade_descriptor' => ts('Fix Membership Receipt'),
199 ['name' => 'membership_online_receipt', 'type' => 'html'],
203 'version' => '5.23.alpha1',
204 'upgrade_descriptor' => ts('Add Contributor Name to Offline Contribution receipts; fix bad event self-service URL'),
206 ['name' => 'contribution_offline_receipt', 'type' => 'text'],
207 ['name' => 'contribution_offline_receipt', 'type' => 'html'],
208 ['name' => 'participant_confirm', 'type' => 'html'],
212 'version' => '5.24.alpha1',
213 'upgrade_descriptor' => ts('Layout fixes for the Contribution templates'),
215 ['name' => 'contribution_invoice_receipt', 'type' => 'html'],
219 'version' => '5.30.alpha1',
220 'upgrade_descriptor' => ts('Support negative hours for cancellation/transfer'),
222 ['name' => 'participant_confirm', 'type' => 'html'],
223 ['name' => 'participant_confirm', 'type' => 'text'],
224 ['name' => 'event_online_receipt', 'type' => 'html'],
225 ['name' => 'event_online_receipt', 'type' => 'text'],
229 'version' => '5.30.beta1',
230 'upgrade_descriptor' => ts('Ensure that amount paid is shown even when fully paid'),
232 ['name' => 'contribution_invoice_receipt', 'type' => 'html'],
236 'version' => '5.38.alpha1',
237 'upgrade_descriptor' => ts('Fix Petition Confirmation email having a blank space at the end of url'),
239 ['name' => 'petition_confirmation_needed', 'type' => 'html'],
243 'version' => '5.38.alpha1',
244 'upgrade_descriptor' => ts('Fix Pledge and PCP urls to go to the front end site rather than backend site'),
246 ['name' => 'pcp_notify', 'type' => 'html'],
247 ['name' => 'pcp_notify', 'type' => 'text'],
248 ['name' => 'pledge_reminder', 'type' => 'html'],
249 ['name' => 'pledge_reminder', 'type' => 'text'],
253 'version' => '5.43.alpha1',
254 'upgrade_descriptor' => ts('Missed templates from earlier versions'),
256 ['name' => 'contribution_online_receipt', 'type' => 'text'],
257 ['name' => 'case_activity', 'type' => 'html'],
258 ['name' => 'case_activity', 'type' => 'text'],
259 ['name' => 'case_activity', 'type' => 'subject'],
263 'version' => '5.44.alpha1',
264 'upgrade_descriptor' => ts('Use domain tokens instead of smarty values'),
265 'label' => ts('Pledge acknowledgement'),
267 ['name' => 'pledge_acknowledge', 'type' => 'text'],
268 ['name' => 'pledge_acknowledge', 'type' => 'html'],
272 'version' => '5.44.alpha1',
273 'upgrade_descriptor' => ts('Use domain and contact tokens instead of smarty values'),
274 'label' => ts('Pledge reminder'),
276 ['name' => 'pledge_reminder', 'type' => 'text'],
277 ['name' => 'pledge_reminder', 'type' => 'html'],
281 'version' => '5.44.alpha1',
282 'upgrade_descriptor' => ts('Use domain and contact tokens instead of smarty values'),
283 'label' => ts('Participant Transferred'),
285 ['name' => 'participant_transferred', 'type' => 'text'],
286 ['name' => 'participant_transferred', 'type' => 'html'],
290 'version' => '5.44.alpha1',
291 'upgrade_descriptor' => ts('Use domain and contact tokens instead of smarty values'),
292 'label' => ts('Participant Cancelled'),
294 ['name' => 'participant_cancelled', 'type' => 'text'],
295 ['name' => 'participant_cancelled', 'type' => 'html'],
300 'version' => '5.44.alpha1',
301 'upgrade_descriptor' => ts('Use domain and contact tokens instead of smarty values'),
302 'label' => ts('Participant Expired'),
304 ['name' => 'participant_expired', 'type' => 'text'],
305 ['name' => 'participant_expired', 'type' => 'html'],
309 'version' => '5.44.alpha1',
310 'upgrade_descriptor' => ts('Use domain and contact tokens instead of smarty values'),
311 'label' => ts('Participant Confirmed'),
313 ['name' => 'participant_confirm', 'type' => 'text'],
314 ['name' => 'participant_confirm', 'type' => 'html'],
321 * Get any required template updates.
325 public function getTemplatesToUpdate() {
326 $templates = $this->getTemplateUpdates();
328 foreach ($templates as $templateArray) {
329 if ($templateArray['version'] === $this->getUpgradeVersion()) {
330 foreach ($templateArray['templates'] as $template) {
331 $return[$template['name'] . '_' . $template['type']] = array_merge($template, $templateArray);
339 * Replace a token with the new preferred option.
341 * @param string $workflowName
345 public function replaceTokenInTemplate(string $workflowName, string $old, string $new): void
{
346 $oldToken = '{' . $old . '}';
347 $newToken = '{' . $new . '}';
348 CRM_Core_DAO
::executeQuery("UPDATE civicrm_msg_template
350 msg_text = REPLACE(msg_text, '$oldToken', '$newToken'),
351 msg_subject = REPLACE(msg_subject, '$oldToken', '$newToken'),
352 msg_html = REPLACE(msg_html, '$oldToken', '$newToken')
353 WHERE workflow_name = '$workflowName'
358 * Replace a token with the new preferred option in non-workflow templates.
363 public function replaceTokenInMessageTemplates(string $old, string $new): void
{
364 $oldToken = '{' . $old . '}';
365 $newToken = '{' . $new . '}';
366 CRM_Core_DAO
::executeQuery("UPDATE civicrm_msg_template
368 msg_text = REPLACE(msg_text, '$oldToken', '$newToken'),
369 msg_subject = REPLACE(msg_subject, '$oldToken', '$newToken'),
370 msg_html = REPLACE(msg_html, '$oldToken', '$newToken')
371 WHERE workflow_name IS NULL
376 * Replace a token with the new preferred option.
381 public function replaceTokenInActionSchedule(string $old, string $new): void
{
382 $oldToken = '{' . $old . '}';
383 $newToken = '{' . $new . '}';
384 CRM_Core_DAO
::executeQuery("UPDATE civicrm_action_schedule
386 body_text = REPLACE(body_text, '$oldToken', '$newToken'),
387 subject = REPLACE(subject, '$oldToken', '$newToken'),
388 body_html = REPLACE(body_html, '$oldToken', '$newToken')
393 * Replace a token with the new preferred option in a print label.
398 public function replaceTokenInPrintLabel(string $old, string $new): void
{
399 $oldToken = '{' . $old . '}';
400 $newToken = '{' . $new . '}';
401 CRM_Core_DAO
::executeQuery("UPDATE civicrm_print_label
403 data = REPLACE(data, '$oldToken', '$newToken')
408 * Replace a token with the new preferred option in a print label.
413 * @throws \API_Exception
415 public function replaceTokenInGreetingOptions(string $old, string $new): void
{
416 $oldToken = '{' . $old . '}';
417 $newToken = '{' . $new . '}';
418 $options = (array) Civi\Api4\OptionValue
::get(FALSE)
419 ->addWhere('option_group_id:name', 'IN', ['email_greeting', 'postal_greeting', 'addressee'])
420 ->setSelect(['id'])->execute()->indexBy('id');
421 CRM_Core_DAO
::executeQuery("UPDATE civicrm_option_value
423 label = REPLACE(label, '$oldToken', '$newToken'),
424 name = REPLACE(name, '$oldToken', '$newToken')
425 WHERE id IN (" . implode(',', array_keys($options)) . ')'
430 * Get the upgrade messages.
432 public function getUpgradeMessages() {
433 $updates = $this->getTemplatesToUpdate();
436 foreach ($updates as $key => $value) {
438 $templateLabel = civicrm_api3('OptionValue', 'getvalue', [
440 'name' => $value['name'],
441 'options' => ['limit' => 1],
444 catch (Exception
$e) {
445 if (!empty($value['label'])) {
446 $templateLabel = $value['label'];
449 $messages[$templateLabel] = $value['upgrade_descriptor'];
455 * Update message templates.
457 public function updateTemplates() {
458 $templates = $this->getTemplatesToUpdate();
459 foreach ($templates as $template) {
460 $workFlowID = CRM_Core_DAO
::singleValueQuery("SELECT MAX(id) as id FROM civicrm_option_value WHERE name = %1", [
461 1 => [$template['name'], 'String'],
463 $content = file_get_contents(\Civi
::paths()->getPath('[civicrm.root]/xml/templates/message_templates/' . $template['name'] . '_' . $template['type'] . '.tpl'));
464 $templatesToUpdate = [];
465 if (!empty($workFlowID)) {
466 // This could be empty if the template was deleted. It should not happen,
467 // but has been seen in the wild (ex: marketing/civicrm-website#163).
468 $id = CRM_Core_DAO
::singleValueQuery("SELECT id FROM civicrm_msg_template WHERE workflow_id = $workFlowID AND is_reserved = 1");
470 $templatesToUpdate[] = $id;
472 $defaultTemplateID = CRM_Core_DAO
::singleValueQuery("
473 SELECT default_template.id FROM civicrm_msg_template reserved
474 LEFT JOIN civicrm_msg_template default_template
475 ON reserved.workflow_id = default_template.workflow_id
476 WHERE reserved.workflow_id = $workFlowID
477 AND reserved.is_reserved = 1 AND default_template.is_default = 1 AND reserved.id <> default_template.id
478 AND reserved.msg_{$template['type']} = default_template.msg_{$template['type']}
480 if ($defaultTemplateID) {
481 $templatesToUpdate[] = $defaultTemplateID;
484 if (!empty($templatesToUpdate)) {
485 CRM_Core_DAO
::executeQuery("
486 UPDATE civicrm_msg_template SET msg_{$template['type']} = %1 WHERE id IN (" . implode(',', $templatesToUpdate) . ")", [
487 1 => [$content, 'String'],