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