3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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-2017
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 that a string is a valid MySQL column name or alias.
97 public static function mysqlColumnNameOrAlias($str) {
103 // Ensure $str conforms to expected format. Not a complete expression of
104 // what MySQL permits; this should permit the formats CiviCRM generates.
106 // * Table name prefix is optional.
107 // * Table & column names & aliases:
108 // * Composed of alphanumeric chars, underscore and hyphens.
109 // * Maximum length of 64 chars.
110 // * Optionally surrounded by backticks, in which case spaces also OK.
111 if (!preg_match('/^((`[\w- ]{1,64}`|[\w-]{1,64})\.)?(`[\w- ]{1,64}`|[\w-]{1,64})$/i', $str)) {
119 * Validate that a string is ASC or DESC.
121 * Empty string should be treated as invalid and ignored => default = ASC.
126 public static function mysqlOrderByDirection($str) {
127 if (!preg_match('/^(asc|desc)$/i', $str)) {
135 * Validate that a string is valid order by clause.
140 public static function mysqlOrderBy($str) {
141 // Making a regex for a comma separated list is quite hard and not readable
142 // at all, so we split and loop over.
143 $parts = explode(',', $str);
144 foreach ($parts as $part) {
145 if (!preg_match('/^((`[\w-]{1,64}`|[\w-]{1,64})\.)?(`[\w-]{1,64}`|[\w-]{1,64})( (asc|desc))?$/i', trim($part))) {
158 public static function qfVariable($str) {
160 //if ( empty( $str ) || strlen( $str ) > 31 ) {
161 if (strlen(trim($str)) == 0 ||
strlen($str) > 31) {
165 // make sure it includes valid characters, alpha numeric and underscores
166 // added (. and ,) option (CRM-1336)
167 if (!preg_match('/^[\w\s\.\,]+$/i', $str)) {
179 public static function phone($phone) {
181 if (empty($phone) ||
strlen($phone) > 16) {
185 // make sure it includes valid characters, (, \s and numeric
186 if (preg_match('/^[\d\(\)\-\.\s]+$/', $phone)) {
197 public static function query($query) {
199 if (empty($query) ||
strlen($query) < 3 ||
strlen($query) > 127) {
203 // make sure it includes valid characters, alpha numeric and underscores
204 if (!preg_match('/^[\w\s\%\'\&\,\$\#]+$/i', $query)) {
216 public static function url($url) {
217 if (preg_match('/^\//', $url)) {
218 // allow relative URL's (CRM-15598)
219 $url = 'http://' . $_SERVER['HTTP_HOST'] . $url;
221 return (bool) filter_var($url, FILTER_VALIDATE_URL
);
229 public static function urlish($url) {
233 $url = Civi
::paths()->getUrl($url, 'absolute');
234 return (bool) filter_var($url, FILTER_VALIDATE_URL
);
242 public static function wikiURL($string) {
243 $items = explode(' ', trim($string), 2);
244 return self
::url($items[0]);
252 public static function domain($domain) {
253 // not perfect, but better than the previous one; see CRM-1502
254 if (!preg_match('/^[A-Za-z0-9]([A-Za-z0-9\.\-]*[A-Za-z0-9])?$/', $domain)) {
262 * @param null $default
266 public static function date($value, $default = NULL) {
267 if (is_string($value) &&
268 preg_match('/^\d\d\d\d-?\d\d-?\d\d$/', $value)
277 * @param null $default
279 * @return null|string
281 public static function dateTime($value, $default = NULL) {
283 if (is_string($value) &&
284 preg_match('/^\d\d\d\d-?\d\d-?\d\d(\s\d\d:\d\d(:\d\d)?|\d\d\d\d(\d\d)?)?$/', $value)
293 * Check the validity of the date (in qf format)
294 * note that only a year is valid, or a mon-year is
295 * also valid in addition to day-mon-year. The date
296 * specified has to be beyond today. (i.e today or later)
299 * @param bool $monthRequired
300 * Check whether month is mandatory.
305 public static function currentDate($date, $monthRequired = TRUE) {
306 $config = CRM_Core_Config
::singleton();
308 $d = CRM_Utils_Array
::value('d', $date);
309 $m = CRM_Utils_Array
::value('M', $date);
310 $y = CRM_Utils_Array
::value('Y', $date);
312 if (!$d && !$m && !$y) {
316 // CRM-9017 CiviContribute/CiviMember form with expiration date format 'm Y'
317 if (!$m && !empty($date['m'])) {
318 $m = CRM_Utils_Array
::value('m', $date);
333 // if we have day we need mon, and if we have mon we need year
342 if (!empty($day) ||
!empty($mon) ||
!empty($year)) {
343 $result = checkdate($mon, $day, $year);
350 // ensure we have month if required
351 if ($monthRequired && !$m) {
355 // now make sure this date is greater that today
356 $currentDate = getdate();
357 if ($year > $currentDate['year']) {
360 elseif ($year < $currentDate['year']) {
365 if ($mon > $currentDate['mon']) {
368 elseif ($mon < $currentDate['mon']) {
374 if ($day > $currentDate['mday']) {
377 elseif ($day < $currentDate['mday']) {
386 * Check the validity of a date or datetime (timestamp)
387 * value which is in YYYYMMDD or YYYYMMDDHHMMSS format
389 * Uses PHP checkdate() - params are ( int $month, int $day, int $year )
391 * @param string $date
396 public static function mysqlDate($date) {
397 // allow date to be null
402 if (checkdate(substr($date, 4, 2), substr($date, 6, 2), substr($date, 0, 4))) {
414 public static function integer($value) {
415 if (is_int($value)) {
420 // ensure number passed is always a string numeral
421 if (!is_numeric($value)) {
425 // note that is_int matches only integer type
426 // and not strings which are only integers
427 // hence we do this here
428 if (preg_match('/^\d+$/', $value)) {
433 $negValue = -1 * $value;
434 if (is_int($negValue)) {
447 public static function positiveInteger($value) {
448 if (is_int($value)) {
449 return ($value < 0) ?
FALSE : TRUE;
453 // ensure number passed is always a string numeral
454 if (!is_numeric($value)) {
458 if (preg_match('/^\d+$/', $value)) {
470 public static function numeric($value) {
471 // lets use a php gatekeeper to ensure this is numeric
472 if (!is_numeric($value)) {
476 return preg_match('/(^-?\d\d*\.\d*$)|(^-?\d\d*$)|(^-?\.\d\d*$)/', $value) ?
TRUE : FALSE;
485 public static function numberOfDigit($value, $noOfDigit) {
486 return preg_match('/^\d{' . $noOfDigit . '}$/', $value) ?
TRUE : FALSE;
494 public static function cleanMoney($value) {
495 // first remove all white space
496 $value = str_replace(array(' ', "\t", "\n"), '', $value);
498 $config = CRM_Core_Config
::singleton();
501 $currencySymbols = CRM_Core_PseudoConstant
::get(
502 'CRM_Contribute_DAO_Contribution',
504 'keyColumn' => 'name',
505 'labelColumn' => 'symbol',
508 $value = str_replace($currencySymbols, '', $value);
510 if ($config->monetaryThousandSeparator
) {
511 $mon_thousands_sep = $config->monetaryThousandSeparator
;
514 $mon_thousands_sep = ',';
517 // ugly fix for CRM-6391: do not drop the thousand separator if
518 // it looks like it’s separating decimal part (because a given
519 // value undergoes a second cleanMoney() call, for example)
520 // CRM-15835 - in case the amount/value contains 0 after decimal
521 // eg 150.5 the following if condition will pass
522 if ($mon_thousands_sep != '.' or (substr($value, -3, 1) != '.' && substr($value, -2, 1) != '.')) {
523 $value = str_replace($mon_thousands_sep, '', $value);
526 if ($config->monetaryDecimalPoint
) {
527 $mon_decimal_point = $config->monetaryDecimalPoint
;
530 $mon_decimal_point = '.';
532 $value = str_replace($mon_decimal_point, '.', $value);
542 public static function money($value) {
543 $config = CRM_Core_Config
::singleton();
545 // only edge case when we have a decimal point in the input money
546 // field and not defined in the decimal Point in config settings
547 if ($config->monetaryDecimalPoint
&&
548 $config->monetaryDecimalPoint
!= '.' &&
549 // CRM-7122 also check for Thousands Separator in config settings
550 $config->monetaryThousandSeparator
!= '.' &&
551 substr_count($value, '.')
556 $value = self
::cleanMoney($value);
558 if (self
::integer($value)) {
562 return preg_match('/(^-?\d+\.\d?\d?$)|(^-?\.\d\d?$)/', $value) ?
TRUE : FALSE;
567 * @param int $maxLength
571 public static function string($value, $maxLength = 0) {
572 if (is_string($value) &&
573 ($maxLength === 0 ||
strlen($value) <= $maxLength)
585 public static function boolean($value) {
587 '/(^(1|0)$)|(^(Y(es)?|N(o)?)$)|(^(T(rue)?|F(alse)?)$)/i', $value
596 public static function email($value) {
597 return (bool) filter_var($value, FILTER_VALIDATE_EMAIL
);
605 public static function emailList($list) {
606 $emails = explode(',', $list);
607 foreach ($emails as $email) {
608 $email = trim($email);
609 if (!self
::email($email)) {
617 * allow between 4-6 digits as postal code since india needs 6 and US needs 5 (or
618 * if u disregard the first 0, 4 (thanx excel!)
619 * FIXME: we need to figure out how to localize such rules
624 public static function postalCode($value) {
625 if (preg_match('/^\d{4,6}(-\d{4})?$/', $value)) {
632 * See how file rules are written in HTML/QuickForm/file.php
633 * Checks to make sure the uploaded file is ascii
635 * @param string $elementValue
638 * True if file has been uploaded, false otherwise
640 public static function asciiFile($elementValue) {
641 if ((isset($elementValue['error']) && $elementValue['error'] == 0) ||
642 (!empty($elementValue['tmp_name']) && $elementValue['tmp_name'] != 'none')
644 return CRM_Utils_File
::isAscii($elementValue['tmp_name']);
650 * Checks to make sure the uploaded file is in UTF-8, recodes if it's not
652 * @param array $elementValue
655 * Whether file has been uploaded properly and is now in UTF-8.
657 public static function utf8File($elementValue) {
660 if ((isset($elementValue['error']) && $elementValue['error'] == 0) ||
661 (!empty($elementValue['tmp_name']) && $elementValue['tmp_name'] != 'none')
664 $success = CRM_Utils_File
::isAscii($elementValue['tmp_name']);
666 // if it's a file, but not UTF-8, let's try and recode it
667 // and then make sure it's an UTF-8 file in the end
669 $success = CRM_Utils_File
::toUtf8($elementValue['tmp_name']);
671 $success = CRM_Utils_File
::isAscii($elementValue['tmp_name']);
679 * See how file rules are written in HTML/QuickForm/file.php
680 * Checks to make sure the uploaded file is html
682 * @param array $elementValue
685 * True if file has been uploaded, false otherwise
687 public static function htmlFile($elementValue) {
688 if ((isset($elementValue['error']) && $elementValue['error'] == 0) ||
689 (!empty($elementValue['tmp_name']) && $elementValue['tmp_name'] != 'none')
691 return CRM_Utils_File
::isHtmlFile($elementValue['tmp_name']);
697 * Check if there is a record with the same name in the db.
699 * @param string $value
700 * The value of the field we are checking.
701 * @param array $options
702 * The daoName, fieldName (optional) and DomainID (optional).
705 * true if object exists
707 public static function objectExists($value, $options) {
709 if (isset($options[2])) {
713 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), CRM_Utils_Array
::value(3, $options));
722 public static function optionExists($value, $options) {
723 return CRM_Core_OptionValue
::optionExists($value, $options[0], $options[1], $options[2], CRM_Utils_Array
::value(3, $options, 'name'), CRM_Utils_Array
::value(4, $options, FALSE));
732 public static function creditCardNumber($value, $type) {
733 return Validate_Finance_CreditCard
::number($value, $type);
742 public static function cvv($value, $type) {
743 return Validate_Finance_CreditCard
::cvv($value, $type);
751 public static function currencyCode($value) {
752 static $currencyCodes = NULL;
753 if (!$currencyCodes) {
754 $currencyCodes = CRM_Core_PseudoConstant
::currencyCode();
756 if (in_array($value, $currencyCodes)) {
767 public static function xssString($value) {
768 if (is_string($value)) {
769 return preg_match('!<(vb)?script[^>]*>.*</(vb)?script.*>!ims',
783 public static function fileExists($path) {
784 return file_exists($path);
788 * Determine whether the value contains a valid reference to a directory.
790 * Paths stored in the setting system may be absolute -- or may be
791 * relative to the default data directory.
793 * @param string $path
796 public static function settingPath($path) {
797 return is_dir(Civi
::paths()->getPath($path));
802 * @param null $actualElementValue
806 public static function validContact($value, $actualElementValue = NULL) {
807 if ($actualElementValue) {
808 $value = $actualElementValue;
811 return CRM_Utils_Rule
::positiveInteger($value);
815 * Check the validity of the date (in qf format)
816 * note that only a year is valid, or a mon-year is
817 * also valid in addition to day-mon-year
824 public static function qfDate($date) {
825 $config = CRM_Core_Config
::singleton();
827 $d = CRM_Utils_Array
::value('d', $date);
828 $m = CRM_Utils_Array
::value('M', $date);
829 $y = CRM_Utils_Array
::value('Y', $date);
830 if (isset($date['h']) ||
833 $m = CRM_Utils_Array
::value('M', $date);
836 if (!$d && !$m && !$y) {
852 // if we have day we need mon, and if we have mon we need year
860 if (!empty($day) ||
!empty($mon) ||
!empty($year)) {
861 return checkdate($mon, $day, $year);
871 public static function qfKey($key) {
872 return ($key) ? CRM_Core_Key
::valid($key) : FALSE;
876 * Check if the values in the date range are in correct chronological order.
878 * @param array $fields
879 * Fields of the form.
881 * Name of date range field.
885 * Title of the date range to be displayed in the error message.
887 public static function validDateRange($fields, $fieldName, &$errors, $title) {
888 $lowDate = strtotime($fields[$fieldName . '_low']);
889 $highDate = strtotime($fields[$fieldName . '_high']);
891 if ($lowDate > $highDate) {
892 $errors[$fieldName . '_range_error'] = ts('%1: Please check that your date range is in correct chronological order.', array(1 => $title));