3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2016 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2016
34 require_once 'HTML/QuickForm/Rule/Email.php';
37 * Class CRM_Utils_Rule
39 class CRM_Utils_Rule
{
43 * @param int $maxLength
47 public static function title($str, $maxLength = 127) {
50 if (empty($str) ||
strlen($str) > $maxLength) {
54 // Make sure it include valid characters, alpha numeric and underscores
55 if (!preg_match('/^\w[\w\s\'\&\,\$\#\-\.\"\?\!]+$/i', $str)) {
67 public static function longTitle($str) {
68 return self
::title($str, 255);
76 public static function variable($str) {
78 if (empty($str) ||
strlen($str) > 31) {
82 // make sure it includes valid characters, alpha numeric and underscores
83 if (!preg_match('/^[\w]+$/i', $str)) {
91 * Validate an acceptable column name for sorting results.
97 public static function mysqlColumnName($str) {
103 // Ensure it only contains valid characters (alphanumeric and underscores).
105 // MySQL permits column names that don't match this (eg containing spaces),
106 // but CiviCRM won't create those ...
107 if (!preg_match('/^\w{1,64}(\.\w{1,64})?$/i', $str)) {
115 * Validate that a string is ASC or DESC.
117 * Empty string should be treated as invalid and ignored => default = ASC.
122 public static function mysqlOrderByDirection($str) {
123 if (!preg_match('/^(asc|desc)$/i', $str)) {
131 * Validate that a string is valid order by clause.
136 public static function mysqlOrderBy($str) {
137 // Making a regex for a comma separated list is quite hard and not readable
138 // at all, so we split and loop over.
139 $parts = explode(',', $str);
140 foreach ($parts as $part) {
141 if (!preg_match('/^((\w{1,64})((\.)(\w{1,64}))?( (asc|desc))?)$/i', trim($part))) {
154 public static function qfVariable($str) {
156 //if ( empty( $str ) || strlen( $str ) > 31 ) {
157 if (strlen(trim($str)) == 0 ||
strlen($str) > 31) {
161 // make sure it includes valid characters, alpha numeric and underscores
162 // added (. and ,) option (CRM-1336)
163 if (!preg_match('/^[\w\s\.\,]+$/i', $str)) {
175 public static function phone($phone) {
177 if (empty($phone) ||
strlen($phone) > 16) {
181 // make sure it includes valid characters, (, \s and numeric
182 if (preg_match('/^[\d\(\)\-\.\s]+$/', $phone)) {
193 public static function query($query) {
195 if (empty($query) ||
strlen($query) < 3 ||
strlen($query) > 127) {
199 // make sure it includes valid characters, alpha numeric and underscores
200 if (!preg_match('/^[\w\s\%\'\&\,\$\#]+$/i', $query)) {
212 public static function url($url) {
213 if (preg_match('/^\//', $url)) {
214 // allow relative URL's (CRM-15598)
215 $url = 'http://' . $_SERVER['HTTP_HOST'] . $url;
217 return (bool) filter_var($url, FILTER_VALIDATE_URL
);
225 public static function urlish($url) {
229 $url = Civi
::paths()->getUrl($url, 'absolute');
230 return (bool) filter_var($url, FILTER_VALIDATE_URL
);
238 public static function wikiURL($string) {
239 $items = explode(' ', trim($string), 2);
240 return self
::url($items[0]);
248 public static function domain($domain) {
249 // not perfect, but better than the previous one; see CRM-1502
250 if (!preg_match('/^[A-Za-z0-9]([A-Za-z0-9\.\-]*[A-Za-z0-9])?$/', $domain)) {
258 * @param null $default
262 public static function date($value, $default = NULL) {
263 if (is_string($value) &&
264 preg_match('/^\d\d\d\d-?\d\d-?\d\d$/', $value)
273 * @param null $default
275 * @return null|string
277 public static function dateTime($value, $default = NULL) {
279 if (is_string($value) &&
280 preg_match('/^\d\d\d\d-?\d\d-?\d\d(\s\d\d:\d\d(:\d\d)?|\d\d\d\d(\d\d)?)?$/', $value)
289 * Check the validity of the date (in qf format)
290 * note that only a year is valid, or a mon-year is
291 * also valid in addition to day-mon-year. The date
292 * specified has to be beyond today. (i.e today or later)
295 * @param bool $monthRequired
296 * Check whether month is mandatory.
301 public static function currentDate($date, $monthRequired = TRUE) {
302 $config = CRM_Core_Config
::singleton();
304 $d = CRM_Utils_Array
::value('d', $date);
305 $m = CRM_Utils_Array
::value('M', $date);
306 $y = CRM_Utils_Array
::value('Y', $date);
308 if (!$d && !$m && !$y) {
312 // CRM-9017 CiviContribute/CiviMember form with expiration date format 'm Y'
313 if (!$m && !empty($date['m'])) {
314 $m = CRM_Utils_Array
::value('m', $date);
329 // if we have day we need mon, and if we have mon we need year
338 if (!empty($day) ||
!empty($mon) ||
!empty($year)) {
339 $result = checkdate($mon, $day, $year);
346 // ensure we have month if required
347 if ($monthRequired && !$m) {
351 // now make sure this date is greater that today
352 $currentDate = getdate();
353 if ($year > $currentDate['year']) {
356 elseif ($year < $currentDate['year']) {
361 if ($mon > $currentDate['mon']) {
364 elseif ($mon < $currentDate['mon']) {
370 if ($day > $currentDate['mday']) {
373 elseif ($day < $currentDate['mday']) {
382 * Check the validity of a date or datetime (timestamp)
383 * value which is in YYYYMMDD or YYYYMMDDHHMMSS format
385 * Uses PHP checkdate() - params are ( int $month, int $day, int $year )
387 * @param string $date
392 public static function mysqlDate($date) {
393 // allow date to be null
398 if (checkdate(substr($date, 4, 2), substr($date, 6, 2), substr($date, 0, 4))) {
410 public static function integer($value) {
411 if (is_int($value)) {
416 // ensure number passed is always a string numeral
417 if (!is_numeric($value)) {
421 // note that is_int matches only integer type
422 // and not strings which are only integers
423 // hence we do this here
424 if (preg_match('/^\d+$/', $value)) {
429 $negValue = -1 * $value;
430 if (is_int($negValue)) {
443 public static function positiveInteger($value) {
444 if (is_int($value)) {
445 return ($value < 0) ?
FALSE : TRUE;
449 // ensure number passed is always a string numeral
450 if (!is_numeric($value)) {
454 if (preg_match('/^\d+$/', $value)) {
466 public static function numeric($value) {
467 // lets use a php gatekeeper to ensure this is numeric
468 if (!is_numeric($value)) {
472 return preg_match('/(^-?\d\d*\.\d*$)|(^-?\d\d*$)|(^-?\.\d\d*$)/', $value) ?
TRUE : FALSE;
481 public static function numberOfDigit($value, $noOfDigit) {
482 return preg_match('/^\d{' . $noOfDigit . '}$/', $value) ?
TRUE : FALSE;
490 public static function cleanMoney($value) {
491 // first remove all white space
492 $value = str_replace(array(' ', "\t", "\n"), '', $value);
494 $config = CRM_Core_Config
::singleton();
497 $currencySymbols = CRM_Core_PseudoConstant
::get(
498 'CRM_Contribute_DAO_Contribution',
500 'keyColumn' => 'name',
501 'labelColumn' => 'symbol',
504 $value = str_replace($currencySymbols, '', $value);
506 if ($config->monetaryThousandSeparator
) {
507 $mon_thousands_sep = $config->monetaryThousandSeparator
;
510 $mon_thousands_sep = ',';
513 // ugly fix for CRM-6391: do not drop the thousand separator if
514 // it looks like it’s separating decimal part (because a given
515 // value undergoes a second cleanMoney() call, for example)
516 // CRM-15835 - in case the amount/value contains 0 after decimal
517 // eg 150.5 the following if condition will pass
518 if ($mon_thousands_sep != '.' or (substr($value, -3, 1) != '.' && substr($value, -2, 1) != '.')) {
519 $value = str_replace($mon_thousands_sep, '', $value);
522 if ($config->monetaryDecimalPoint
) {
523 $mon_decimal_point = $config->monetaryDecimalPoint
;
526 $mon_decimal_point = '.';
528 $value = str_replace($mon_decimal_point, '.', $value);
538 public static function money($value) {
539 $config = CRM_Core_Config
::singleton();
541 // only edge case when we have a decimal point in the input money
542 // field and not defined in the decimal Point in config settings
543 if ($config->monetaryDecimalPoint
&&
544 $config->monetaryDecimalPoint
!= '.' &&
545 // CRM-7122 also check for Thousands Separator in config settings
546 $config->monetaryThousandSeparator
!= '.' &&
547 substr_count($value, '.')
552 $value = self
::cleanMoney($value);
554 if (self
::integer($value)) {
558 return preg_match('/(^-?\d+\.\d?\d?$)|(^-?\.\d\d?$)/', $value) ?
TRUE : FALSE;
563 * @param int $maxLength
567 public static function string($value, $maxLength = 0) {
568 if (is_string($value) &&
569 ($maxLength === 0 ||
strlen($value) <= $maxLength)
581 public static function boolean($value) {
583 '/(^(1|0)$)|(^(Y(es)?|N(o)?)$)|(^(T(rue)?|F(alse)?)$)/i', $value
592 public static function email($value) {
593 return (bool) filter_var($value, FILTER_VALIDATE_EMAIL
);
601 public static function emailList($list) {
602 $emails = explode(',', $list);
603 foreach ($emails as $email) {
604 $email = trim($email);
605 if (!self
::email($email)) {
613 * allow between 4-6 digits as postal code since india needs 6 and US needs 5 (or
614 * if u disregard the first 0, 4 (thanx excel!)
615 * FIXME: we need to figure out how to localize such rules
620 public static function postalCode($value) {
621 if (preg_match('/^\d{4,6}(-\d{4})?$/', $value)) {
628 * See how file rules are written in HTML/QuickForm/file.php
629 * Checks to make sure the uploaded file is ascii
631 * @param string $elementValue
634 * True if file has been uploaded, false otherwise
636 public static function asciiFile($elementValue) {
637 if ((isset($elementValue['error']) && $elementValue['error'] == 0) ||
638 (!empty($elementValue['tmp_name']) && $elementValue['tmp_name'] != 'none')
640 return CRM_Utils_File
::isAscii($elementValue['tmp_name']);
646 * Checks to make sure the uploaded file is in UTF-8, recodes if it's not
648 * @param array $elementValue
651 * Whether file has been uploaded properly and is now in UTF-8.
653 public static function utf8File($elementValue) {
656 if ((isset($elementValue['error']) && $elementValue['error'] == 0) ||
657 (!empty($elementValue['tmp_name']) && $elementValue['tmp_name'] != 'none')
660 $success = CRM_Utils_File
::isAscii($elementValue['tmp_name']);
662 // if it's a file, but not UTF-8, let's try and recode it
663 // and then make sure it's an UTF-8 file in the end
665 $success = CRM_Utils_File
::toUtf8($elementValue['tmp_name']);
667 $success = CRM_Utils_File
::isAscii($elementValue['tmp_name']);
675 * See how file rules are written in HTML/QuickForm/file.php
676 * Checks to make sure the uploaded file is html
678 * @param array $elementValue
681 * True if file has been uploaded, false otherwise
683 public static function htmlFile($elementValue) {
684 if ((isset($elementValue['error']) && $elementValue['error'] == 0) ||
685 (!empty($elementValue['tmp_name']) && $elementValue['tmp_name'] != 'none')
687 return CRM_Utils_File
::isHtmlFile($elementValue['tmp_name']);
693 * Check if there is a record with the same name in the db.
695 * @param string $value
696 * The value of the field we are checking.
697 * @param array $options
698 * The daoName and fieldName (optional ).
701 * true if object exists
703 public static function objectExists($value, $options) {
705 if (isset($options[2])) {
709 return CRM_Core_DAO
::objectExists($value, CRM_Utils_Array
::value(0, $options), CRM_Utils_Array
::value(1, $options), CRM_Utils_Array
::value(2, $options, $name));
718 public static function optionExists($value, $options) {
719 return CRM_Core_OptionValue
::optionExists($value, $options[0], $options[1], $options[2], CRM_Utils_Array
::value(3, $options, 'name'));
728 public static function creditCardNumber($value, $type) {
729 require_once 'Validate/Finance/CreditCard.php';
730 return Validate_Finance_CreditCard
::number($value, $type);
739 public static function cvv($value, $type) {
740 require_once 'Validate/Finance/CreditCard.php';
742 return Validate_Finance_CreditCard
::cvv($value, $type);
750 public static function currencyCode($value) {
751 static $currencyCodes = NULL;
752 if (!$currencyCodes) {
753 $currencyCodes = CRM_Core_PseudoConstant
::currencyCode();
755 if (in_array($value, $currencyCodes)) {
766 public static function xssString($value) {
767 if (is_string($value)) {
768 return preg_match('!<(vb)?script[^>]*>.*</(vb)?script.*>!ims',
782 public static function fileExists($path) {
783 return file_exists($path);
787 * Determine whether the value contains a valid reference to a directory.
789 * Paths stored in the setting system may be absolute -- or may be
790 * relative to the default data directory.
792 * @param string $path
795 public static function settingPath($path) {
796 return is_dir(Civi
::paths()->getPath($path));
801 * @param null $actualElementValue
805 public static function validContact($value, $actualElementValue = NULL) {
806 if ($actualElementValue) {
807 $value = $actualElementValue;
810 return CRM_Utils_Rule
::positiveInteger($value);
814 * Check the validity of the date (in qf format)
815 * note that only a year is valid, or a mon-year is
816 * also valid in addition to day-mon-year
823 public static function qfDate($date) {
824 $config = CRM_Core_Config
::singleton();
826 $d = CRM_Utils_Array
::value('d', $date);
827 $m = CRM_Utils_Array
::value('M', $date);
828 $y = CRM_Utils_Array
::value('Y', $date);
829 if (isset($date['h']) ||
832 $m = CRM_Utils_Array
::value('M', $date);
835 if (!$d && !$m && !$y) {
851 // if we have day we need mon, and if we have mon we need year
859 if (!empty($day) ||
!empty($mon) ||
!empty($year)) {
860 return checkdate($mon, $day, $year);
870 public static function qfKey($key) {
871 return ($key) ? CRM_Core_Key
::valid($key) : FALSE;
875 * Check if the values in the date range are in correct chronological order.
877 * @param array $fields
878 * Fields of the form.
880 * Name of date range field.
884 * Title of the date range to be displayed in the error message.
886 public static function validDateRange($fields, $fieldName, &$errors, $title) {
887 $lowDate = strtotime($fields[$fieldName . '_low']);
888 $highDate = strtotime($fields[$fieldName . '_high']);
890 if ($lowDate > $highDate) {
891 $errors[$fieldName . '_range_error'] = ts('%1: Please check that your date range is in correct chronological order.', array(1 => $title));