CRM/Admin/Form/Setting/UpdateConfigBackend.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class generates form components for Error Handling and Debugging
  38  *
  39  */
  40 class CRM_Admin_Form_Setting_UpdateConfigBackend extends CRM_Admin_Form_Setting {
  41   protected $_oldBaseDir;
  42   protected $_oldBaseURL;
  43   protected $_oldSiteName;
  44
  45   /**
  46    * Build the form object
  47    *
  48    * @return void
  49    */
  50   public function buildQuickForm() {
  51     CRM_Utils_System::setTitle(ts('Settings - Cleanup Caches and Update Paths'));
  52
  53     list(
  54       $this->_oldBaseURL,
  55       $this->_oldBaseDir,
  56       $this->_oldSiteName
  57     ) = CRM_Core_BAO_ConfigSetting::getConfigSettings();
  58
  59     $this->assign('oldBaseURL', $this->_oldBaseURL);
  60     $this->assign('oldBaseDir', $this->_oldBaseDir);
  61     $this->assign('oldSiteName', $this->_oldSiteName);
  62
  63     $this->addElement(
  64       'submit', $this->getButtonName('next', 'cleanup'), 'Cleanup Caches',
  65       array('class' => 'crm-form-submit', 'id' => 'cleanup-cache')
  66     );
  67
  68     $this->add('text', 'newBaseURL', ts('New Base URL'), NULL, TRUE);
  69     $this->add('text', 'newBaseDir', ts('New Base Directory'), NULL, TRUE);
  70     if ($this->_oldSiteName) {
  71       $this->add('text', 'newSiteName', ts('New Site Name'), NULL, TRUE);
  72     }
  73     $this->addFormRule(array('CRM_Admin_Form_Setting_UpdateConfigBackend', 'formRule'));
  74
  75     parent::buildQuickForm();
  76   }
  77
  78   public function setDefaultValues() {
  79     if (!$this->_defaults) {
  80       parent::setDefaultValues();
  81
  82       $config = CRM_Core_Config::singleton();
  83       list(
  84         $this->_defaults['newBaseURL'],
  85         $this->_defaults['newBaseDir'],
  86         $this->_defaults['newSiteName']
  87       ) = CRM_Core_BAO_ConfigSetting::getBestGuessSettings();
  88     }
  89
  90     return $this->_defaults;
  91   }
  92
  93   /**
  94    * @param $fields
  95    *
  96    * @return array
  97    */
  98   public static function formRule($fields) {
  99     $tmpDir = trim($fields['newBaseDir']);
 100
 101     $errors = array();
 102     if (!is_writeable($tmpDir)) {
 103       $errors['newBaseDir'] = ts('%1 directory does not exist or cannot be written by webserver',
 104         array(1 => $tmpDir)
 105       );
 106     }
 107     return $errors;
 108   }
 109
 110   public function postProcess() {
 111     if (!empty($_POST['_qf_UpdateConfigBackend_next_cleanup'])) {
 112
 113       $config = CRM_Core_Config::singleton();
 114
 115       // cleanup templates_c directory
 116       $config->cleanup(1, FALSE);
 117
 118       // clear db caching
 119       CRM_Core_Config::clearDBCache();
 120       parent::rebuildMenu();
 121
 122       CRM_Core_BAO_WordReplacement::rebuild();
 123
 124       CRM_Core_Session::setStatus(ts('Cache has been cleared and menu has been rebuilt successfully.'), ts("Success"), "success");
 125       return CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin/setting/updateConfigBackend', 'reset=1'));
 126     }
 127
 128     // redirect to admin page after saving
 129     $session = CRM_Core_Session::singleton();
 130     $session->pushUserContext(CRM_Utils_System::url('civicrm/admin'));
 131
 132     $params = $this->controller->exportValues($this->_name);
 133
 134     //CRM-5679
 135     foreach ($params as $name => & $val) {
 136       if ($val && in_array($name, array('newBaseDir', 'newSiteName'))) {
 137         $val = CRM_Utils_File::addTrailingSlash($val);
 138       }
 139     }
 140
 141     //CRM-15365 - Fix BaseURL to avoid wrong trailing slash on Windows installs
 142     foreach ($params as $name => & $val) {
 143       if ($val && in_array($name, array('newBaseURL'))) {
 144         $val = CRM_Utils_File::addTrailingSlash($val,"/");
 145       }
 146     }
 147
 148     $from = array($this->_oldBaseURL, $this->_oldBaseDir);
 149     $to = array(trim($params['newBaseURL']),
 150       trim($params['newBaseDir']),
 151     );
 152     if ($this->_oldSiteName &&
 153       $params['newSiteName']
 154     ) {
 155       $from[] = $this->_oldSiteName;
 156       $to[] = $params['newSiteName'];
 157     }
 158
 159     $newValues = str_replace($from,
 160       $to,
 161       $this->_defaults
 162     );
 163
 164     parent::commonProcess($newValues);
 165
 166     parent::rebuildMenu();
 167   }
 168 }