Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
232624b1 | 4 | | CiviCRM version 4.4 | |
6a488035 TO |
5 | +--------------------------------------------------------------------+ |
6 | | Copyright CiviCRM LLC (c) 2004-2013 | | |
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 | |
31 | * @copyright CiviCRM LLC (c) 2004-2013 | |
32 | * $Id$ | |
33 | * | |
34 | */ | |
35 | ||
36 | /** | |
37 | * Page for displaying list of message templates | |
38 | */ | |
39 | class CRM_Admin_Page_MessageTemplates extends CRM_Core_Page_Basic { | |
40 | ||
41 | /** | |
42 | * The action links that we need to display for the browse screen | |
43 | * | |
44 | * @var array | |
45 | * @static | |
46 | */ | |
47 | static $_links = NULL; | |
48 | ||
49 | // ids of templates which diverted from the default ones and can be reverted | |
50 | protected $_revertible = array(); | |
51 | ||
52 | // set to the id that we’re reverting at the given moment (if we are) | |
430ae6dd TO |
53 | protected $_revertedId; |
54 | ||
55 | function __construct($title = NULL, $mode = NULL) { | |
6a488035 TO |
56 | parent::__construct($title, $mode); |
57 | ||
58 | // fetch the ids of templates which diverted from defaults and can be reverted – | |
59 | // these templates have the same workflow_id as the defaults; defaults are reserved | |
60 | $sql = ' | |
61 | SELECT diverted.id, orig.id orig_id | |
62 | FROM civicrm_msg_template diverted JOIN civicrm_msg_template orig ON ( | |
63 | diverted.workflow_id = orig.workflow_id AND | |
64 | orig.is_reserved = 1 AND ( | |
65 | diverted.msg_subject != orig.msg_subject OR | |
66 | diverted.msg_text != orig.msg_text OR | |
67 | diverted.msg_html != orig.msg_html | |
68 | ) | |
69 | ) | |
70 | '; | |
71 | $dao = CRM_Core_DAO::executeQuery($sql); | |
72 | while ($dao->fetch()) { | |
73 | $this->_revertible[$dao->id] = $dao->orig_id; | |
74 | } | |
75 | } | |
76 | ||
77 | /** | |
78 | * Get BAO Name | |
79 | * | |
80 | * @return string Classname of BAO. | |
81 | */ | |
82 | function getBAOName() { | |
c6327d7d | 83 | return 'CRM_Core_BAO_MessageTemplate'; |
6a488035 TO |
84 | } |
85 | ||
86 | /** | |
87 | * Get action Links | |
88 | * | |
89 | * @return array (reference) of action links | |
90 | */ | |
91 | function &links() { | |
92 | if (!(self::$_links)) { | |
93 | $confirm = ts('Are you sure you want to revert this template to the default for this workflow? You will lose any customizations you have made.', array('escape' => 'js')) . '\n\n' . ts('We recommend that you save a copy of the your customized Text and HTML message content to a text file before reverting so you can combine your changes with the system default messages as needed.', array('escape' => 'js')); | |
94 | self::$_links = array( | |
95 | CRM_Core_Action::UPDATE => array( | |
96 | 'name' => ts('Edit'), | |
97 | 'url' => 'civicrm/admin/messageTemplates/add', | |
98 | 'qs' => 'action=update&id=%%id%%&reset=1', | |
99 | 'title' => ts('Edit this message template'), | |
100 | ), | |
101 | CRM_Core_Action::DISABLE => array( | |
102 | 'name' => ts('Disable'), | |
c6327d7d | 103 | 'extra' => 'onclick = "enableDisable( %%id%%,\'' . 'CRM_Core_BAO_MessageTemplate' . '\',\'' . 'enable-disable' . '\' );"', |
6a488035 TO |
104 | 'ref' => 'disable-action', |
105 | 'title' => ts('Disable this message template'), | |
106 | ), | |
107 | CRM_Core_Action::ENABLE => array( | |
108 | 'name' => ts('Enable'), | |
c6327d7d | 109 | 'extra' => 'onclick = "enableDisable( %%id%%,\'' . 'CRM_Core_BAO_MessageTemplate' . '\',\'' . 'disable-enable' . '\' );"', |
6a488035 TO |
110 | 'ref' => 'enable-action', |
111 | 'title' => ts('Enable this message template'), | |
112 | ), | |
113 | CRM_Core_Action::DELETE => array( | |
114 | 'name' => ts('Delete'), | |
115 | 'url' => 'civicrm/admin/messageTemplates', | |
116 | 'qs' => 'action=delete&id=%%id%%', | |
117 | 'title' => ts('Delete this message template'), | |
118 | ), | |
119 | CRM_Core_Action::REVERT => array( | |
120 | 'name' => ts('Revert to Default'), | |
121 | 'extra' => "onclick = 'return confirm(\"$confirm\");'", | |
122 | 'url' => 'civicrm/admin/messageTemplates', | |
123 | 'qs' => 'action=revert&id=%%id%%&selectedChild=workflow', | |
124 | 'title' => ts('Revert this workflow message template to the system default'), | |
125 | ), | |
126 | CRM_Core_Action::VIEW => array( | |
127 | 'name' => ts('View Default'), | |
128 | 'url' => 'civicrm/admin/messageTemplates', | |
129 | 'qs' => 'action=view&id=%%orig_id%%&reset=1', | |
130 | 'title' => ts('View the system default for this workflow message template'), | |
131 | ), | |
132 | ); | |
133 | } | |
134 | return self::$_links; | |
135 | } | |
136 | ||
137 | function action(&$object, $action, &$values, &$links, $permission, $forceAction = FALSE) { | |
138 | if ($object->workflow_id) { | |
139 | // do not expose action link for reverting to default if the template did not diverge or we just reverted it now | |
140 | if (!in_array($object->id, array_keys($this->_revertible)) or | |
141 | ($this->_action & CRM_Core_Action::REVERT and $object->id == $this->_revertedId) | |
142 | ) { | |
143 | $action &= ~CRM_Core_Action::REVERT; | |
144 | $action &= ~CRM_Core_Action::VIEW; | |
145 | } | |
146 | ||
147 | // default workflow templates shouldn’t be deletable | |
148 | // workflow templates shouldn’t have disable/enable actions (at least for CiviCRM 3.1) | |
149 | if ($object->workflow_id) { | |
150 | $action &= ~CRM_Core_Action::DISABLE; | |
151 | $action &= ~CRM_Core_Action::DELETE; | |
152 | } | |
153 | ||
154 | // rebuild the action links HTML, as we need to handle %%orig_id%% for revertible templates | |
155 | $values['action'] = CRM_Core_Action::formLink($links, $action, array( | |
156 | 'id' => $object->id, | |
157 | 'orig_id' => CRM_Utils_Array::value($object->id, $this->_revertible), | |
158 | )); | |
159 | } | |
160 | else { | |
161 | $action &= ~CRM_Core_Action::REVERT; | |
162 | $action &= ~CRM_Core_Action::VIEW; | |
163 | parent::action($object, $action, $values, $links, $permission); | |
164 | } | |
165 | } | |
166 | ||
167 | function run($args = NULL, $pageArgs = NULL, $sort = NULL) { | |
168 | // handle the revert action and offload the rest to parent | |
169 | if (CRM_Utils_Request::retrieve('action', 'String', $this) & CRM_Core_Action::REVERT) { | |
170 | ||
171 | $id = CRM_Utils_Request::retrieve('id', 'Positive', $this); | |
172 | if (!$this->checkPermission($id, NULL)) { | |
173 | CRM_Core_Error::fatal(ts('You do not have permission to revert this template.')); | |
174 | } | |
175 | ||
176 | $this->_revertedId = $id; | |
177 | ||
c6327d7d | 178 | CRM_Core_BAO_MessageTemplate::revert($id); |
6a488035 TO |
179 | } |
180 | ||
181 | $this->assign('selectedChild', CRM_Utils_Request::retrieve('selectedChild', 'String', $this)); | |
182 | ||
183 | return parent::run($args, $pageArgs, $sort); | |
184 | } | |
185 | ||
186 | /** | |
187 | * Get name of edit form | |
188 | * | |
189 | * @return string Classname of edit form. | |
190 | */ | |
191 | function editForm() { | |
192 | return 'CRM_Admin_Form_MessageTemplates'; | |
193 | } | |
194 | ||
195 | /** | |
196 | * Get edit form name | |
197 | * | |
198 | * @return string name of this page. | |
199 | */ | |
200 | function editName() { | |
201 | return ts('Message Template'); | |
202 | } | |
203 | ||
204 | /** | |
205 | * Get user context. | |
206 | * | |
207 | * @return string user context. | |
208 | */ | |
209 | function userContext($mode = NULL) { | |
210 | return 'civicrm/admin/messageTemplates'; | |
211 | } | |
212 | ||
213 | /** | |
214 | * browse all entities. | |
215 | * | |
216 | * @param int $action | |
217 | * | |
218 | * @return void | |
219 | * @access public | |
220 | */ | |
221 | function browse() { | |
222 | $action = func_num_args() ? func_get_arg(0) : NULL; | |
223 | if ($this->_action & CRM_Core_Action::ADD) { | |
224 | return; | |
225 | } | |
226 | $links = $this->links(); | |
227 | if ($action == NULL) { | |
228 | if (!empty($links)) { | |
229 | $action = array_sum(array_keys($links)); | |
230 | } | |
231 | } | |
232 | ||
233 | if ($action & CRM_Core_Action::DISABLE) { | |
234 | $action -= CRM_Core_Action::DISABLE; | |
235 | } | |
236 | ||
237 | if ($action & CRM_Core_Action::ENABLE) { | |
238 | $action -= CRM_Core_Action::ENABLE; | |
239 | } | |
240 | ||
c6327d7d | 241 | $messageTemplate = new CRM_Core_BAO_MessageTemplate(); |
6a488035 TO |
242 | $messageTemplate->orderBy('msg_title' . ' asc'); |
243 | ||
244 | $userTemplates = array(); | |
245 | $workflowTemplates = array(); | |
246 | ||
247 | // find all objects | |
248 | $messageTemplate->find(); | |
249 | while ($messageTemplate->fetch()) { | |
250 | $values[$messageTemplate->id] = array(); | |
251 | CRM_Core_DAO::storeValues($messageTemplate, $values[$messageTemplate->id]); | |
252 | // populate action links | |
253 | $this->action($messageTemplate, $action, $values[$messageTemplate->id], $links, CRM_Core_Permission::EDIT); | |
254 | ||
255 | if (!$messageTemplate->workflow_id) { | |
256 | $userTemplates[$messageTemplate->id] = $values[$messageTemplate->id]; | |
257 | } | |
258 | elseif (!$messageTemplate->is_reserved) { | |
259 | $workflowTemplates[$messageTemplate->id] = $values[$messageTemplate->id]; | |
260 | } | |
261 | } | |
262 | ||
263 | $rows = array( | |
264 | 'userTemplates' => $userTemplates, | |
265 | 'workflowTemplates' => $workflowTemplates, | |
266 | ); | |
267 | ||
268 | $this->assign('rows', $rows); | |
269 | } | |
270 | } | |
271 |