CRM/Admin/Form/WordReplacements.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   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 class CRM_Admin_Form_WordReplacements extends CRM_Core_Form {
  36   protected $_numStrings = 10;
  37
  38   protected $_stringName = NULL;
  39
  40   protected $_defaults = NULL;
  41
  42   function preProcess() {
  43     // This controller was originally written to CRUD $config->locale_custom_strings,
  44     // but that's no longer the canonical store. Re-sync from canonical store to ensure
  45     // that we display that latest data. This is inefficient - at some point, we
  46     // should rewrite this UI.
  47     CRM_Core_BAO_WordReplacement::rebuild();
  48
  49     $this->_soInstance = CRM_Utils_Array::value('instance', $_GET);
  50     $this->assign('soInstance', $this->_soInstance);
  51     $breadCrumbUrl = CRM_Utils_System::url('civicrm/admin/options/wordreplacements',
  52       "reset=1"
  53     );
  54     $breadCrumb = array(array('title' => ts('Word Replacements'),
  55         'url' => $breadCrumbUrl,
  56       ));
  57     CRM_Utils_System::appendBreadCrumb($breadCrumb);
  58   }
  59
  60   public function setDefaultValues() {
  61     if ($this->_defaults !== NULL) {
  62       return $this->_defaults;
  63     }
  64
  65     $this->_defaults = array();
  66
  67     $config = CRM_Core_Config::singleton();
  68
  69     $values = $config->localeCustomStrings[$config->lcMessages];
  70     $i = 1;
  71
  72     $enableDisable = array(
  73       1 => 'enabled',
  74       0 => 'disabled',
  75     );
  76
  77     $cardMatch = array('wildcardMatch', 'exactMatch');
  78
  79     foreach ($enableDisable as $key => $val) {
  80       foreach ($cardMatch as $kc => $vc) {
  81         if (!empty($values[$val][$vc])) {
  82           foreach ($values[$val][$vc] as $k => $v) {
  83             $this->_defaults["enabled"][$i] = $key;
  84             $this->_defaults["cb"][$i] = $kc;
  85             $this->_defaults["old"][$i] = $k;
  86             $this->_defaults["new"][$i] = $v;
  87             $i++;
  88           }
  89         }
  90       }
  91     }
  92
  93     $name = $this->_stringName = "custom_string_override_{$config->lcMessages}";
  94     if (isset($config->$name) &&
  95       is_array($config->$name)
  96     ) {
  97       $this->_numStrings = 1;
  98       foreach ($config->$name as $old => $newValues) {
  99         $this->_numStrings++;
 100         $this->_numStrings += 9;
 101       }
 102     }
 103     else {
 104       $this->_numStrings = 10;
 105     }
 106
 107     return $this->_defaults;
 108   }
 109
 110   /**
 111    * Function to actually build the form
 112    *
 113    * @return None
 114    * @access public
 115    */
 116   public function buildQuickForm() {
 117     $config    = CRM_Core_Config::singleton();
 118     $values    = $config->localeCustomStrings[$config->lcMessages];
 119     $instances = (count($values, COUNT_RECURSIVE) - 6);
 120     if ($instances > 10) {
 121       $this->_numStrings = $instances;
 122     }
 123
 124     $soInstances = range(1, $this->_numStrings, 1);
 125     $stringOverrideInstances = array();
 126     if ($this->_soInstance) {
 127       $soInstances = array($this->_soInstance);
 128     }
 129     elseif (CRM_Utils_Array::value('old', $_POST)) {
 130       $soInstances = $stringOverrideInstances = array_keys($_POST['old']);
 131     }
 132     elseif (!empty($this->_defaults) && is_array($this->_defaults)) {
 133       $stringOverrideInstances = array_keys($this->_defaults['new']);
 134       if (count($this->_defaults['old']) > count($this->_defaults['new'])) {
 135         $stringOverrideInstances = array_keys($this->_defaults['old']);
 136       }
 137     }
 138     foreach ($soInstances as $instance) {
 139       $this->addElement('checkbox', "enabled[$instance]");
 140       $this->add('textarea', "old[$instance]", NULL, array('rows' => 1, 'cols' => 40));
 141       $this->add('textarea', "new[$instance]", NULL, array('rows' => 1, 'cols' => 40));
 142       $this->addElement('checkbox', "cb[$instance]");
 143     }
 144     $this->assign('numStrings', $this->_numStrings);
 145     if ($this->_soInstance) {
 146       return;
 147     }
 148
 149     $this->assign('stringOverrideInstances', empty($stringOverrideInstances) ? FALSE : $stringOverrideInstances);
 150
 151     $this->addButtons(array(
 152         array(
 153           'type' => 'next',
 154           'name' => ts('Save'),
 155           'isDefault' => TRUE,
 156         ),
 157         array(
 158           'type' => 'cancel',
 159           'name' => ts('Cancel'),
 160         ),
 161       )
 162     );
 163     $this->addFormRule(array('CRM_Admin_Form_WordReplacements', 'formRule'), $this);
 164   }
 165
 166   /**
 167    * global validation rules for the form
 168    *
 169    * @param array $values posted values of the form
 170    *
 171    * @return array list of errors to be posted back to the form
 172    * @static
 173    * @access public
 174    */
 175   static function formRule($values) {
 176     $errors = array();
 177
 178     $oldValues  = CRM_Utils_Array::value('old', $values);
 179     $newValues  = CRM_Utils_Array::value('new', $values);
 180     $enabled    = CRM_Utils_Array::value('enabled', $values);
 181     $exactMatch = CRM_Utils_Array::value('cb', $values);
 182
 183     foreach ($oldValues as $k => $v) {
 184       if ($v && !$newValues[$k]) {
 185         $errors['new[' . $k . ']'] = ts('Please Enter the value for Replacement Word');
 186       }
 187       elseif (!$v && $newValues[$k]) {
 188         $errors['old[' . $k . ']'] = ts('Please Enter the value for Original Word');
 189       }
 190       elseif ((!CRM_Utils_Array::value($k, $newValues) && !CRM_Utils_Array::value($k, $oldValues))
 191         && (CRM_Utils_Array::value($k, $enabled) || CRM_Utils_Array::value($k, $exactMatch))
 192       ) {
 193         $errors['old[' . $k . ']'] = ts('Please Enter the value for Original Word');
 194         $errors['new[' . $k . ']'] = ts('Please Enter the value for Replacement Word');
 195       }
 196     }
 197
 198     return $errors;
 199   }
 200
 201   /**
 202    * Function to process the form
 203    *
 204    * @access public
 205    *
 206    * @return None
 207    */
 208   public function postProcess() {
 209     $params = $this->controller->exportValues($this->_name);
 210     $this->_numStrings = sizeof($params['old']);
 211
 212     $enabled['exactMatch'] = $enabled['wildcardMatch'] = $disabled['exactMatch'] = $disabled['wildcardMatch'] = array();
 213     for ($i = 1; $i <= $this->_numStrings; $i++) {
 214       if (CRM_Utils_Array::value($i, $params['new']) &&
 215         CRM_Utils_Array::value($i, $params['old'])
 216       ) {
 217         if (isset($params['enabled']) && CRM_Utils_Array::value($i, $params['enabled'])) {
 218           if (CRM_Utils_Array::value('cb', $params) &&
 219             CRM_Utils_Array::value($i, $params['cb'])
 220           ) {
 221             $enabled['exactMatch'] += array($params['old'][$i] => $params['new'][$i]);
 222           }
 223           else {
 224             $enabled['wildcardMatch'] += array($params['old'][$i] => $params['new'][$i]);
 225           }
 226         }
 227         else {
 228           if (isset($params['cb']) && is_array($params['cb']) && array_key_exists($i, $params['cb'])) {
 229             $disabled['exactMatch'] += array($params['old'][$i] => $params['new'][$i]);
 230           }
 231           else {
 232             $disabled['wildcardMatch'] += array($params['old'][$i] => $params['new'][$i]);
 233           }
 234         }
 235       }
 236     }
 237
 238     $overrides = array(
 239       'enabled' => $enabled,
 240       'disabled' => $disabled,
 241     );
 242
 243     $config = CRM_Core_Config::singleton();
 244
 245     $domain = new CRM_Core_DAO_Domain();
 246     $domain->find(TRUE);
 247
 248     if ($domain->locales && $config->localeCustomStrings) {
 249       // for multilingual
 250       $addReplacements = $config->localeCustomStrings;
 251       $addReplacements[$config->lcMessages] = $overrides;
 252       $stringOverride = serialize($addReplacements);
 253     }
 254     else {
 255       // for single language
 256       $stringOverride = serialize(array($config->lcMessages => $overrides));
 257     }
 258
 259     $params = array('locale_custom_strings' => $stringOverride);
 260     $id = CRM_Core_Config::domainID();
 261
 262     $wordReplacementSettings = CRM_Core_BAO_Domain::edit($params, $id);
 263
 264     if ($wordReplacementSettings) {
 265       // This controller was originally written to CRUD $config->locale_custom_strings,
 266       // but that's no longer the canonical store. Sync changes to canonical store.
 267       // This is inefficient - at some point, we should rewrite this UI.
 268       CRM_Core_BAO_WordReplacement::rebuildWordReplacementTable();
 269
 270       CRM_Core_Session::setStatus("", ts("Settings Saved"), "success");
 271       CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin/options/wordreplacements',
 272           "reset=1"
 273         ));
 274     }
 275   }
 276 }
 277