CRM/Admin/Page/MessageTemplates.php

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