Commit | Line | Data |
---|---|---|
fe83c251 | 1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
4 | | CiviCRM version 5 | | |
5 | +--------------------------------------------------------------------+ | |
6b83d5bd | 6 | | Copyright CiviCRM LLC (c) 2004-2019 | |
fe83c251 | 7 | +--------------------------------------------------------------------+ |
8 | | This file is a part of CiviCRM. | | |
9 | | | | |
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. | | |
13 | | | | |
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. | | |
18 | | | | |
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 | +--------------------------------------------------------------------+ | |
26 | */ | |
27 | ||
28 | /** | |
29 | * | |
30 | * @package CRM | |
6b83d5bd | 31 | * @copyright CiviCRM LLC (c) 2004-2019 |
fe83c251 | 32 | */ |
33 | class CRM_Upgrade_Incremental_MessageTemplates { | |
34 | ||
35 | /** | |
36 | * Version we are upgrading to. | |
37 | * | |
38 | * @var string | |
39 | */ | |
40 | protected $upgradeVersion; | |
41 | ||
42 | /** | |
43 | * @return string | |
44 | */ | |
45 | public function getUpgradeVersion() { | |
46 | return $this->upgradeVersion; | |
47 | } | |
48 | ||
49 | /** | |
50 | * @param string $upgradeVersion | |
51 | */ | |
52 | public function setUpgradeVersion($upgradeVersion) { | |
53 | $this->upgradeVersion = $upgradeVersion; | |
54 | } | |
55 | ||
56 | /** | |
57 | * CRM_Upgrade_Incremental_MessageTemplates constructor. | |
58 | * | |
59 | * @param string $upgradeVersion | |
60 | */ | |
61 | public function __construct($upgradeVersion) { | |
62 | $this->setUpgradeVersion($upgradeVersion); | |
63 | } | |
64 | ||
65 | /** | |
66 | * Get any templates that have been updated. | |
67 | * | |
68 | * @return array | |
69 | */ | |
70 | protected function getTemplateUpdates() { | |
71 | return [ | |
72 | [ | |
73 | 'version' => '5.4.alpha1', | |
74 | 'upgrade_descriptor' => ts('Use email greeting at top where available'), | |
75 | 'templates' => [ | |
76 | ['name' => 'membership_online_receipt', 'type' => 'text'], | |
77 | ['name' => 'membership_online_receipt', 'type' => 'html'], | |
e74e138c | 78 | ['name' => 'contribution_online_receipt', 'type' => 'text'], |
79 | ['name' => 'contribution_online_receipt', 'type' => 'html'], | |
80 | ['name' => 'event_online_receipt', 'type' => 'text'], | |
81 | ['name' => 'event_online_receipt', 'type' => 'html'], | |
2db5cabf | 82 | ['name' => 'event_online_receipt', 'type' => 'subject'], |
3655bea4 | 83 | ], |
fe83c251 | 84 | ], |
9d404148 | 85 | [ |
86 | 'version' => '5.7.alpha1', | |
87 | 'upgrade_descriptor' => ts('Fix invoice number (human readable) instead of id (reference)'), | |
88 | 'label' => ts('Contributions - Invoice'), | |
89 | 'templates' => [ | |
90 | ['name' => 'contribution_invoice_receipt', 'type' => 'html'], | |
3655bea4 | 91 | ], |
f926d56f MWMC |
92 | ], |
93 | [ | |
94 | 'version' => '5.10.alpha1', | |
95 | 'upgrade_descriptor' => ts('Show recurring cancel/update URLs in receipt based on payment processor capabilities'), | |
96 | 'label' => ts('Receipts - cancel/update subscription URLs'), | |
97 | 'templates' => [ | |
98 | ['name' => 'contribution_online_receipt', 'type' => 'text'], | |
99 | ['name' => 'contribution_online_receipt', 'type' => 'html'], | |
100 | ['name' => 'contribution_recurring_notify', 'type' => 'text'], | |
101 | ['name' => 'contribution_recurring_notify', 'type' => 'html'], | |
102 | ['name' => 'membership_online_receipt', 'type' => 'text'], | |
103 | ['name' => 'membership_online_receipt', 'type' => 'html'], | |
3655bea4 | 104 | ], |
1e477c5b | 105 | ], |
106 | [ | |
107 | 'version' => '5.12.alpha1', | |
108 | 'upgrade_descriptor' => ts('Update payment notification to remove print text, use email greeting'), | |
109 | 'label' => ts('Payment notification'), | |
110 | 'templates' => [ | |
111 | ['name' => 'payment_or_refund_notification', 'type' => 'text'], | |
112 | ['name' => 'payment_or_refund_notification', 'type' => 'html'], | |
3655bea4 | 113 | ], |
1e477c5b | 114 | ], |
fe83c251 | 115 | ]; |
116 | } | |
117 | ||
118 | /** | |
119 | * Get any required template updates. | |
120 | * | |
121 | * @return array | |
122 | */ | |
123 | public function getTemplatesToUpdate() { | |
124 | $templates = $this->getTemplateUpdates(); | |
125 | $return = []; | |
126 | foreach ($templates as $templateArray) { | |
127 | if ($templateArray['version'] === $this->getUpgradeVersion()) { | |
128 | foreach ($templateArray['templates'] as $template) { | |
129 | $return[$template['name'] . '_' . $template['type']] = array_merge($template, $templateArray); | |
130 | } | |
131 | } | |
132 | } | |
133 | return $return; | |
134 | } | |
135 | ||
136 | /** | |
137 | * Get the upgrade messages. | |
138 | */ | |
139 | public function getUpgradeMessages() { | |
140 | $updates = $this->getTemplatesToUpdate(); | |
141 | $messages = []; | |
9d404148 | 142 | $templateLabel = ''; |
fe83c251 | 143 | foreach ($updates as $key => $value) { |
9d404148 | 144 | try { |
145 | $templateLabel = civicrm_api3('OptionValue', 'getvalue', [ | |
146 | 'return' => 'label', | |
147 | 'name' => $value['name'], | |
148 | 'options' => ['limit' => 1], | |
149 | ]); | |
150 | } | |
151 | catch (Exception $e) { | |
152 | if (!empty($value['label'])) { | |
153 | $templateLabel = $value['label']; | |
154 | } | |
155 | } | |
fe83c251 | 156 | $messages[$templateLabel] = $value['upgrade_descriptor']; |
157 | } | |
158 | return $messages; | |
159 | } | |
160 | ||
161 | /** | |
162 | * Update message templates. | |
163 | */ | |
164 | public function updateTemplates() { | |
165 | $templates = $this->getTemplatesToUpdate(); | |
166 | foreach ($templates as $template) { | |
167 | $workFlowID = CRM_Core_DAO::singleValueQuery("SELECT MAX(id) as id FROM civicrm_option_value WHERE name = %1", [ | |
168 | 1 => [$template['name'], 'String'], | |
169 | ]); | |
170 | $content = file_get_contents(\Civi::paths()->getPath('[civicrm.root]/xml/templates/message_templates/' . $template['name'] . '_' . $template['type'] . '.tpl')); | |
171 | $templatesToUpdate = []; | |
9d404148 | 172 | if (!empty($workFlowID)) { |
173 | $templatesToUpdate[] = CRM_Core_DAO::singleValueQuery("SELECT id FROM civicrm_msg_template WHERE workflow_id = $workFlowID AND is_reserved = 1"); | |
174 | $defaultTemplateID = CRM_Core_DAO::singleValueQuery(" | |
175 | SELECT default_template.id FROM civicrm_msg_template reserved | |
176 | LEFT JOIN civicrm_msg_template default_template | |
177 | ON reserved.workflow_id = default_template.workflow_id | |
178 | WHERE reserved.workflow_id = $workFlowID | |
179 | AND reserved.is_reserved = 1 AND default_template.is_default = 1 AND reserved.id <> default_template.id | |
180 | AND reserved.msg_{$template['type']} = default_template.msg_{$template['type']} | |
181 | "); | |
182 | if ($defaultTemplateID) { | |
183 | $templatesToUpdate[] = $defaultTemplateID; | |
184 | } | |
fe83c251 | 185 | |
9d404148 | 186 | CRM_Core_DAO::executeQuery(" |
187 | UPDATE civicrm_msg_template SET msg_{$template['type']} = %1 WHERE id IN (" . implode(',', $templatesToUpdate) . ")", [ | |
3655bea4 SL |
188 | 1 => [$content, 'String'], |
189 | ] | |
9d404148 | 190 | ); |
191 | } | |
fe83c251 | 192 | } |
193 | } | |
194 | ||
195 | } |