CRM/Admin/Form/Setting/Miscellaneous.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2016                                |
   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-2016
  32  */
  33
  34 /**
  35  * This class generates form components for Miscellaneous.
  36  */
  37 class CRM_Admin_Form_Setting_Miscellaneous extends CRM_Admin_Form_Setting {
  38
  39   protected $_settings = array(
  40     'max_attachments' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  41     'contact_undelete' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  42     'dashboardCacheTimeout' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  43     'empoweredBy' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  44     'logging' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  45     'maxFileSize' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  46     'doNotAttachPDFReceipt' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  47     'secondDegRelPermissions' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  48     'checksum_timeout' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  49     'recaptchaOptions' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  50     'recaptchaPublicKey' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  51     'recaptchaPrivateKey' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  52     'wkhtmltopdfPath' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  53     'recentItemsMaxCount' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  54     'recentItemsProviders' => CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME,
  55   );
  56
  57   public $_uploadMaxSize;
  58
  59   /**
  60    * Basic setup.
  61    */
  62   public function preProcess() {
  63     $config = CRM_Core_Config::singleton();
  64     $this->_uploadMaxSize = (int) ini_get('upload_max_filesize');
  65     // check for post max size
  66     CRM_Utils_Number::formatUnitSize(ini_get('post_max_size'), TRUE);
  67   }
  68
  69   /**
  70    * Build the form object.
  71    */
  72   public function buildQuickForm() {
  73     CRM_Utils_System::setTitle(ts('Misc (Undelete, PDFs, Limits, Logging, Captcha, etc.)'));
  74
  75     $this->assign('validTriggerPermission', CRM_Core_DAO::checkTriggerViewPermission(FALSE));
  76
  77     $this->addFormRule(array('CRM_Admin_Form_Setting_Miscellaneous', 'formRule'), $this);
  78
  79     parent::buildQuickForm();
  80     $this->addRule('checksum_timeout', ts('Value should be a positive number'), 'positiveInteger');
  81     $this->addRule('dashboardCacheTimeout', ts('Value should be a positive number'), 'positiveInteger');
  82   }
  83
  84   /**
  85    * Global form rule.
  86    *
  87    * @param array $fields
  88    *   The input form values.
  89    * @param array $files
  90    *   The uploaded files if any.
  91    * @param array $options
  92    *   Additional user data.
  93    *
  94    * @return bool|array
  95    *   true if no errors, else array of errors
  96    */
  97   public static function formRule($fields, $files, $options) {
  98     $errors = array();
  99
 100     // validate max file size
 101     if ($fields['maxFileSize'] > $options->_uploadMaxSize) {
 102       $errors['maxFileSize'] = ts("Maximum file size cannot exceed Upload max size ('upload_max_filesize') as defined in PHP.ini.");
 103     }
 104
 105     // validate recent items stack size
 106     if ($fields['recentItemsMaxCount'] && ($fields['recentItemsMaxCount'] < 1 || $fields['recentItemsMaxCount'] > CRM_Utils_Recent::MAX_ITEMS)) {
 107       $errors['recentItemsMaxCount'] = ts("Illegal stack size. Use values between 1 and %1.", array(1 => CRM_Utils_Recent::MAX_ITEMS));
 108     }
 109
 110     if (!empty($fields['wkhtmltopdfPath'])) {
 111       // check and ensure that thi leads to the wkhtmltopdf binary
 112       // and it is a valid executable binary
 113       // Only check the first space separated piece to allow for a value
 114       // such as /usr/bin/xvfb-run -- wkhtmltopdf (CRM-13292)
 115       $pieces = explode(' ', $fields['wkhtmltopdfPath']);
 116       $path = $pieces[0];
 117       if (
 118         !file_exists($path) ||
 119         !is_executable($path)
 120       ) {
 121         $errors['wkhtmltopdfPath'] = ts('The wkhtmltodfPath does not exist or is not valid');
 122       }
 123     }
 124     return $errors;
 125   }
 126
 127 }