CRM/Admin/Form/Setting/Miscellaneous.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * This class generates form components for Miscellaneous
  38  *
  39  */
  40 class CRM_Admin_Form_Setting_Miscellaneous extends CRM_Admin_Form_Setting {
  41
  42   protected $_settings = array(
  43     'max_attachments' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  44     'contact_undelete' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  45     'versionAlert' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  46     'securityUpdateAlert' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  47     'versionCheck' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  48     'versionCheckIgnoreDate' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  49     'empoweredBy' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  50     'maxFileSize' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  51     'doNotAttachPDFReceipt' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  52     'secondDegRelPermissions' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  53     'checksumTimeout' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  54   );
  55
  56   public $_uploadMaxSize;
  57
  58   /**
  59    * Basic setup.
  60    */
  61   public function preProcess() {
  62     $config = CRM_Core_Config::singleton();
  63     $this->_uploadMaxSize = (int) ini_get('upload_max_filesize');
  64     // check for post max size
  65     CRM_Core_Config_Defaults::formatUnitSize(ini_get('post_max_size'), TRUE);
  66   }
  67
  68   /**
  69    * Build the form object.
  70    *
  71    * @return void
  72    */
  73   public function buildQuickForm() {
  74     CRM_Utils_System::setTitle(ts('Misc (Undelete, PDFs, Limits, Logging, Captcha, etc.)'));
  75
  76     // also check if we can enable triggers
  77     $validTriggerPermission = CRM_Core_DAO::checkTriggerViewPermission(FALSE);
  78
  79     // FIXME: for now, disable logging for multilingual sites OR if triggers are not permittted
  80     $domain = new CRM_Core_DAO_Domain();
  81     $domain->find(TRUE);
  82     $attribs = $domain->locales || !$validTriggerPermission ? array('disabled' => 'disabled') : array();
  83
  84     $this->assign('validTriggerPermission', $validTriggerPermission);
  85     $this->addYesNo('logging', ts('Logging'), NULL, NULL, $attribs);
  86
  87     $this->addElement(
  88       'text',
  89       'wkhtmltopdfPath', ts('Path to wkhtmltopdf executable'),
  90       array('size' => 64, 'maxlength' => 256)
  91     );
  92
  93     $this->addElement(
  94       'text', 'recaptchaPublicKey', ts('Public Key'),
  95       array('size' => 64, 'maxlength' => 64)
  96     );
  97     $this->addElement(
  98       'text', 'recaptchaPrivateKey', ts('Private Key'),
  99       array('size' => 64, 'maxlength' => 64)
 100     );
 101
 102     $this->addElement(
 103       'text', 'dashboardCacheTimeout', ts('Dashboard cache timeout'),
 104       array('size' => 3, 'maxlength' => 5)
 105     );
 106
 107     $this->addElement(
 108       'text', 'recaptchaOptions', ts('Recaptcha Options'),
 109       array('size' => 64, 'maxlength' => 64)
 110     );
 111
 112     $this->addFormRule(array('CRM_Admin_Form_Setting_Miscellaneous', 'formRule'), $this);
 113
 114     parent::buildQuickForm();
 115     $this->addRule('checksumTimeout', ts('Value should be a positive number'), 'positiveInteger');
 116   }
 117
 118   /**
 119    * Global form rule.
 120    *
 121    * @param array $fields
 122    *   The input form values.
 123    * @param array $files
 124    *   The uploaded files if any.
 125    * @param array $options
 126    *   Additional user data.
 127    *
 128    * @return bool|array
 129    *   true if no errors, else array of errors
 130    */
 131   public static function formRule($fields, $files, $options) {
 132     $errors = array();
 133
 134     // validate max file size
 135     if ($fields['maxFileSize'] > $options->_uploadMaxSize) {
 136       $errors['maxFileSize'] = ts("Maximum file size cannot exceed Upload max size ('upload_max_filesize') as defined in PHP.ini.");
 137     }
 138
 139     if (!empty($fields['wkhtmltopdfPath'])) {
 140       // check and ensure that thi leads to the wkhtmltopdf binary
 141       // and it is a valid executable binary
 142       // Only check the first space separated piece to allow for a value
 143       // such as /usr/bin/xvfb-run -- wkhtmltopdf (CRM-13292)
 144       $pieces = explode(' ', $fields['wkhtmltopdfPath']);
 145       $path = $pieces[0];
 146       if (
 147         !file_exists($path) ||
 148         !is_executable($path)
 149       ) {
 150         $errors['wkhtmltopdfPath'] = ts('The wkhtmltodfPath does not exist or is not valid');
 151       }
 152     }
 153     return $errors;
 154   }
 155
 156
 157   public function postProcess() {
 158     // store the submitted values in an array
 159     $config = CRM_Core_Config::singleton();
 160     $params = $this->controller->exportValues($this->_name);
 161
 162     // get current logging status
 163     $values = $this->exportValues();
 164
 165     parent::postProcess();
 166
 167     if ($config->logging != $values['logging']) {
 168       $logging = new CRM_Logging_Schema();
 169       if ($values['logging']) {
 170         $logging->enableLogging();
 171       }
 172       else {
 173         $logging->disableLogging();
 174       }
 175     }
 176   }
 177
 178 }