CRM/Utils/Rule.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.7                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2017                                |
   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-2017
  32  */
  33
  34 require_once 'HTML/QuickForm/Rule/Email.php';
  35
  36 /**
  37  * Class CRM_Utils_Rule
  38  */
  39 class CRM_Utils_Rule {
  40
  41   /**
  42    * @param $str
  43    * @param int $maxLength
  44    *
  45    * @return bool
  46    */
  47   public static function title($str, $maxLength = 127) {
  48
  49     // check length etc
  50     if (empty($str) || strlen($str) > $maxLength) {
  51       return FALSE;
  52     }
  53
  54     // Make sure it include valid characters, alpha numeric and underscores
  55     if (!preg_match('/^\w[\w\s\'\&\,\$\#\-\.\"\?\!]+$/i', $str)) {
  56       return FALSE;
  57     }
  58
  59     return TRUE;
  60   }
  61
  62   /**
  63    * @param $str
  64    *
  65    * @return bool
  66    */
  67   public static function longTitle($str) {
  68     return self::title($str, 255);
  69   }
  70
  71   /**
  72    * @param $str
  73    *
  74    * @return bool
  75    */
  76   public static function variable($str) {
  77     // check length etc
  78     if (empty($str) || strlen($str) > 31) {
  79       return FALSE;
  80     }
  81
  82     // make sure it includes valid characters, alpha numeric and underscores
  83     if (!preg_match('/^[\w]+$/i', $str)) {
  84       return FALSE;
  85     }
  86
  87     return TRUE;
  88   }
  89
  90   /**
  91    * Validate that a string is a valid MySQL column name or alias.
  92    *
  93    * @param $str
  94    *
  95    * @return bool
  96    */
  97   public static function mysqlColumnNameOrAlias($str) {
  98     // Check not empty.
  99     if (empty($str)) {
 100       return FALSE;
 101     }
 102
 103     // Ensure $str conforms to expected format. Not a complete expression of
 104     // what MySQL permits; this should permit the formats CiviCRM generates.
 105     //
 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)) {
 112       return FALSE;
 113     }
 114
 115     return TRUE;
 116   }
 117
 118   /**
 119    * Validate that a string is ASC or DESC.
 120    *
 121    * Empty string should be treated as invalid and ignored => default = ASC.
 122    *
 123    * @param $str
 124    * @return bool
 125    */
 126   public static function mysqlOrderByDirection($str) {
 127     if (!preg_match('/^(asc|desc)$/i', $str)) {
 128       return FALSE;
 129     }
 130
 131     return TRUE;
 132   }
 133
 134   /**
 135    * Validate that a string is valid order by clause.
 136    *
 137    * @param $str
 138    * @return bool
 139    */
 140   public static function mysqlOrderBy($str) {
 141     $matches = array();
 142     // Using the field function in order by is valid.
 143     // Look for a string like field(contribution_status_id,3,4,6).
 144     // or field(civicrm_contribution.contribution_status_id,3,4,6)
 145     if (preg_match('/field\([a-z_.]+,[0-9,]+\)/', $str, $matches)) {
 146       // We have checked these. Remove them as they will fail the next lot.
 147       // Our check currently only permits numbers & no back ticks. If we get a
 148       // need for strings or backticks we can add.
 149       $str = str_replace($matches, '', $str);
 150     }
 151     $str = trim($str);
 152     if (!empty($matches) && empty($str)) {
 153       // nothing left to check after the field check.
 154       return TRUE;
 155     }
 156     // Making a regex for a comma separated list is quite hard and not readable
 157     // at all, so we split and loop over.
 158     $parts = explode(',', $str);
 159     foreach ($parts as $part) {
 160       if (!preg_match('/^((`[\w-]{1,64}`|[\w-]{1,64})\.)?(`[\w-]{1,64}`|[\w-]{1,64})( (asc|desc))?$/i', trim($part))) {
 161         return FALSE;
 162       }
 163     }
 164
 165     return TRUE;
 166   }
 167
 168   /**
 169    * @param $str
 170    *
 171    * @return bool
 172    */
 173   public static function qfVariable($str) {
 174     // check length etc
 175     //if ( empty( $str ) || strlen( $str ) > 31 ) {
 176     if (strlen(trim($str)) == 0 || strlen($str) > 31) {
 177       return FALSE;
 178     }
 179
 180     // make sure it includes valid characters, alpha numeric and underscores
 181     // added (. and ,) option (CRM-1336)
 182     if (!preg_match('/^[\w\s\.\,]+$/i', $str)) {
 183       return FALSE;
 184     }
 185
 186     return TRUE;
 187   }
 188
 189   /**
 190    * @param $phone
 191    *
 192    * @return bool
 193    */
 194   public static function phone($phone) {
 195     // check length etc
 196     if (empty($phone) || strlen($phone) > 16) {
 197       return FALSE;
 198     }
 199
 200     // make sure it includes valid characters, (, \s and numeric
 201     if (preg_match('/^[\d\(\)\-\.\s]+$/', $phone)) {
 202       return TRUE;
 203     }
 204     return FALSE;
 205   }
 206
 207   /**
 208    * @param $query
 209    *
 210    * @return bool
 211    */
 212   public static function query($query) {
 213     // check length etc
 214     if (empty($query) || strlen($query) < 3 || strlen($query) > 127) {
 215       return FALSE;
 216     }
 217
 218     // make sure it includes valid characters, alpha numeric and underscores
 219     if (!preg_match('/^[\w\s\%\'\&\,\$\#]+$/i', $query)) {
 220       return FALSE;
 221     }
 222
 223     return TRUE;
 224   }
 225
 226   /**
 227    * @param $url
 228    *
 229    * @return bool
 230    */
 231   public static function url($url) {
 232     if (preg_match('/^\//', $url)) {
 233       // allow relative URL's (CRM-15598)
 234       $url = 'http://' . $_SERVER['HTTP_HOST'] . $url;
 235     }
 236     return (bool) filter_var($url, FILTER_VALIDATE_URL);
 237   }
 238
 239   /**
 240    * @param $url
 241    *
 242    * @return bool
 243    */
 244   public static function urlish($url) {
 245     if (empty($url)) {
 246       return TRUE;
 247     }
 248     $url = Civi::paths()->getUrl($url, 'absolute');
 249     return (bool) filter_var($url, FILTER_VALIDATE_URL);
 250   }
 251
 252   /**
 253    * @param $string
 254    *
 255    * @return bool
 256    */
 257   public static function wikiURL($string) {
 258     $items = explode(' ', trim($string), 2);
 259     return self::url($items[0]);
 260   }
 261
 262   /**
 263    * @param $domain
 264    *
 265    * @return bool
 266    */
 267   public static function domain($domain) {
 268     // not perfect, but better than the previous one; see CRM-1502
 269     if (!preg_match('/^[A-Za-z0-9]([A-Za-z0-9\.\-]*[A-Za-z0-9])?$/', $domain)) {
 270       return FALSE;
 271     }
 272     return TRUE;
 273   }
 274
 275   /**
 276    * @param $value
 277    * @param null $default
 278    *
 279    * @return null
 280    */
 281   public static function date($value, $default = NULL) {
 282     if (is_string($value) &&
 283       preg_match('/^\d\d\d\d-?\d\d-?\d\d$/', $value)
 284     ) {
 285       return $value;
 286     }
 287     return $default;
 288   }
 289
 290   /**
 291    * @param $value
 292    * @param null $default
 293    *
 294    * @return null|string
 295    */
 296   public static function dateTime($value, $default = NULL) {
 297     $result = $default;
 298     if (is_string($value) &&
 299       preg_match('/^\d\d\d\d-?\d\d-?\d\d(\s\d\d:\d\d(:\d\d)?|\d\d\d\d(\d\d)?)?$/', $value)
 300     ) {
 301       $result = $value;
 302     }
 303
 304     return $result;
 305   }
 306
 307   /**
 308    * Check the validity of the date (in qf format)
 309    * note that only a year is valid, or a mon-year is
 310    * also valid in addition to day-mon-year. The date
 311    * specified has to be beyond today. (i.e today or later)
 312    *
 313    * @param array $date
 314    * @param bool $monthRequired
 315    *   Check whether month is mandatory.
 316    *
 317    * @return bool
 318    *   true if valid date
 319    */
 320   public static function currentDate($date, $monthRequired = TRUE) {
 321     $config = CRM_Core_Config::singleton();
 322
 323     $d = CRM_Utils_Array::value('d', $date);
 324     $m = CRM_Utils_Array::value('M', $date);
 325     $y = CRM_Utils_Array::value('Y', $date);
 326
 327     if (!$d && !$m && !$y) {
 328       return TRUE;
 329     }
 330
 331     // CRM-9017 CiviContribute/CiviMember form with expiration date format 'm Y'
 332     if (!$m && !empty($date['m'])) {
 333       $m = CRM_Utils_Array::value('m', $date);
 334     }
 335
 336     $day = $mon = 1;
 337     $year = 0;
 338     if ($d) {
 339       $day = $d;
 340     }
 341     if ($m) {
 342       $mon = $m;
 343     }
 344     if ($y) {
 345       $year = $y;
 346     }
 347
 348     // if we have day we need mon, and if we have mon we need year
 349     if (($d && !$m) ||
 350       ($d && !$y) ||
 351       ($m && !$y)
 352     ) {
 353       return FALSE;
 354     }
 355
 356     $result = FALSE;
 357     if (!empty($day) || !empty($mon) || !empty($year)) {
 358       $result = checkdate($mon, $day, $year);
 359     }
 360
 361     if (!$result) {
 362       return FALSE;
 363     }
 364
 365     // ensure we have month if required
 366     if ($monthRequired && !$m) {
 367       return FALSE;
 368     }
 369
 370     // now make sure this date is greater that today
 371     $currentDate = getdate();
 372     if ($year > $currentDate['year']) {
 373       return TRUE;
 374     }
 375     elseif ($year < $currentDate['year']) {
 376       return FALSE;
 377     }
 378
 379     if ($m) {
 380       if ($mon > $currentDate['mon']) {
 381         return TRUE;
 382       }
 383       elseif ($mon < $currentDate['mon']) {
 384         return FALSE;
 385       }
 386     }
 387
 388     if ($d) {
 389       if ($day > $currentDate['mday']) {
 390         return TRUE;
 391       }
 392       elseif ($day < $currentDate['mday']) {
 393         return FALSE;
 394       }
 395     }
 396
 397     return TRUE;
 398   }
 399
 400   /**
 401    * Check the validity of a date or datetime (timestamp)
 402    * value which is in YYYYMMDD or YYYYMMDDHHMMSS format
 403    *
 404    * Uses PHP checkdate() - params are ( int $month, int $day, int $year )
 405    *
 406    * @param string $date
 407    *
 408    * @return bool
 409    *   true if valid date
 410    */
 411   public static function mysqlDate($date) {
 412     // allow date to be null
 413     if ($date == NULL) {
 414       return TRUE;
 415     }
 416
 417     if (checkdate(substr($date, 4, 2), substr($date, 6, 2), substr($date, 0, 4))) {
 418       return TRUE;
 419     }
 420
 421     return FALSE;
 422   }
 423
 424   /**
 425    * @param $value
 426    *
 427    * @return bool
 428    */
 429   public static function integer($value) {
 430     if (is_int($value)) {
 431       return TRUE;
 432     }
 433
 434     // CRM-13460
 435     // ensure number passed is always a string numeral
 436     if (!is_numeric($value)) {
 437       return FALSE;
 438     }
 439
 440     // note that is_int matches only integer type
 441     // and not strings which are only integers
 442     // hence we do this here
 443     if (preg_match('/^\d+$/', $value)) {
 444       return TRUE;
 445     }
 446
 447     if ($value < 0) {
 448       $negValue = -1 * $value;
 449       if (is_int($negValue)) {
 450         return TRUE;
 451       }
 452     }
 453
 454     return FALSE;
 455   }
 456
 457   /**
 458    * @param $value
 459    *
 460    * @return bool
 461    */
 462   public static function positiveInteger($value) {
 463     if (is_int($value)) {
 464       return ($value < 0) ? FALSE : TRUE;
 465     }
 466
 467     // CRM-13460
 468     // ensure number passed is always a string numeral
 469     if (!is_numeric($value)) {
 470       return FALSE;
 471     }
 472
 473     if (preg_match('/^\d+$/', $value)) {
 474       return TRUE;
 475     }
 476
 477     return FALSE;
 478   }
 479
 480   /**
 481    * @param $value
 482    *
 483    * @return bool
 484    */
 485   public static function numeric($value) {
 486     // lets use a php gatekeeper to ensure this is numeric
 487     if (!is_numeric($value)) {
 488       return FALSE;
 489     }
 490
 491     return preg_match('/(^-?\d\d*\.\d*$)|(^-?\d\d*$)|(^-?\.\d\d*$)/', $value) ? TRUE : FALSE;
 492   }
 493
 494   /**
 495    * @param $value
 496    * @param $noOfDigit
 497    *
 498    * @return bool
 499    */
 500   public static function numberOfDigit($value, $noOfDigit) {
 501     return preg_match('/^\d{' . $noOfDigit . '}$/', $value) ? TRUE : FALSE;
 502   }
 503
 504   /**
 505    * Strip thousand separator from a money string.
 506    *
 507    * Note that this should be done at the form layer. Once we are processing
 508    * money at the BAO or processor layer we should be working with something that
 509    * is already in a normalised format.
 510    *
 511    * @param string $value
 512    *
 513    * @return string
 514    */
 515   public static function cleanMoney($value) {
 516     // first remove all white space
 517     $value = str_replace(array(' ', "\t", "\n"), '', $value);
 518
 519     $config = CRM_Core_Config::singleton();
 520
 521     //CRM-14868
 522     $currencySymbols = CRM_Core_PseudoConstant::get(
 523       'CRM_Contribute_DAO_Contribution',
 524       'currency', array(
 525         'keyColumn' => 'name',
 526         'labelColumn' => 'symbol',
 527       )
 528     );
 529     $value = str_replace($currencySymbols, '', $value);
 530
 531     if ($config->monetaryThousandSeparator) {
 532       $mon_thousands_sep = $config->monetaryThousandSeparator;
 533     }
 534     else {
 535       $mon_thousands_sep = ',';
 536     }
 537
 538     // ugly fix for CRM-6391: do not drop the thousand separator if
 539     // it looks like it’s separating decimal part (because a given
 540     // value undergoes a second cleanMoney() call, for example)
 541     // CRM-15835 - in case the amount/value contains 0 after decimal
 542     // eg 150.5 the following if condition will pass
 543     if ($mon_thousands_sep != '.' or (substr($value, -3, 1) != '.' && substr($value, -2, 1) != '.')) {
 544       $value = str_replace($mon_thousands_sep, '', $value);
 545     }
 546
 547     if ($config->monetaryDecimalPoint) {
 548       $mon_decimal_point = $config->monetaryDecimalPoint;
 549     }
 550     else {
 551       $mon_decimal_point = '.';
 552     }
 553     $value = str_replace($mon_decimal_point, '.', $value);
 554
 555     return $value;
 556   }
 557
 558   /**
 559    * @param $value
 560    *
 561    * @return bool
 562    */
 563   public static function money($value) {
 564     $config = CRM_Core_Config::singleton();
 565
 566     // only edge case when we have a decimal point in the input money
 567     // field and not defined in the decimal Point in config settings
 568     if ($config->monetaryDecimalPoint &&
 569       $config->monetaryDecimalPoint != '.' &&
 570       // CRM-7122 also check for Thousands Separator in config settings
 571       $config->monetaryThousandSeparator != '.' &&
 572       substr_count($value, '.')
 573     ) {
 574       return FALSE;
 575     }
 576
 577     $value = self::cleanMoney($value);
 578
 579     if (self::integer($value)) {
 580       return TRUE;
 581     }
 582
 583     // Allow values such as -0, 1.024555, -.1
 584     // We need to support multiple decimal places here, not just the number allowed by locale
 585     //  otherwise tax calculations break when you want the inclusive amount to be a round number (eg. £10 inc. VAT requires 8.333333333 here).
 586     return preg_match('/(^-?\d+\.?\d*$)|(^-?\.\d+$)/', $value) ? TRUE : FALSE;
 587   }
 588
 589   /**
 590    * @param $value
 591    * @param int $maxLength
 592    *
 593    * @return bool
 594    */
 595   public static function string($value, $maxLength = 0) {
 596     if (is_string($value) &&
 597       ($maxLength === 0 || strlen($value) <= $maxLength)
 598     ) {
 599       return TRUE;
 600     }
 601     return FALSE;
 602   }
 603
 604   /**
 605    * @param $value
 606    *
 607    * @return bool
 608    */
 609   public static function boolean($value) {
 610     return preg_match(
 611       '/(^(1|0)$)|(^(Y(es)?|N(o)?)$)|(^(T(rue)?|F(alse)?)$)/i', $value
 612     ) ? TRUE : FALSE;
 613   }
 614
 615   /**
 616    * @param $value
 617    *
 618    * @return bool
 619    */
 620   public static function email($value) {
 621     return (bool) filter_var($value, FILTER_VALIDATE_EMAIL);
 622   }
 623
 624   /**
 625    * @param $list
 626    *
 627    * @return bool
 628    */
 629   public static function emailList($list) {
 630     $emails = explode(',', $list);
 631     foreach ($emails as $email) {
 632       $email = trim($email);
 633       if (!self::email($email)) {
 634         return FALSE;
 635       }
 636     }
 637     return TRUE;
 638   }
 639
 640   /**
 641    * allow between 4-6 digits as postal code since india needs 6 and US needs 5 (or
 642    * if u disregard the first 0, 4 (thanx excel!)
 643    * FIXME: we need to figure out how to localize such rules
 644    * @param $value
 645    *
 646    * @return bool
 647    */
 648   public static function postalCode($value) {
 649     if (preg_match('/^\d{4,6}(-\d{4})?$/', $value)) {
 650       return TRUE;
 651     }
 652     return FALSE;
 653   }
 654
 655   /**
 656    * See how file rules are written in HTML/QuickForm/file.php
 657    * Checks to make sure the uploaded file is ascii
 658    *
 659    * @param string $elementValue
 660    *
 661    * @return bool
 662    *   True if file has been uploaded, false otherwise
 663    */
 664   public static function asciiFile($elementValue) {
 665     if ((isset($elementValue['error']) && $elementValue['error'] == 0) ||
 666       (!empty($elementValue['tmp_name']) && $elementValue['tmp_name'] != 'none')
 667     ) {
 668       return CRM_Utils_File::isAscii($elementValue['tmp_name']);
 669     }
 670     return FALSE;
 671   }
 672
 673   /**
 674    * Checks to make sure the uploaded file is in UTF-8, recodes if it's not
 675    *
 676    * @param array $elementValue
 677    *
 678    * @return bool
 679    *   Whether file has been uploaded properly and is now in UTF-8.
 680    */
 681   public static function utf8File($elementValue) {
 682     $success = FALSE;
 683
 684     if ((isset($elementValue['error']) && $elementValue['error'] == 0) ||
 685       (!empty($elementValue['tmp_name']) && $elementValue['tmp_name'] != 'none')
 686     ) {
 687
 688       $success = CRM_Utils_File::isAscii($elementValue['tmp_name']);
 689
 690       // if it's a file, but not UTF-8, let's try and recode it
 691       // and then make sure it's an UTF-8 file in the end
 692       if (!$success) {
 693         $success = CRM_Utils_File::toUtf8($elementValue['tmp_name']);
 694         if ($success) {
 695           $success = CRM_Utils_File::isAscii($elementValue['tmp_name']);
 696         }
 697       }
 698     }
 699     return $success;
 700   }
 701
 702   /**
 703    * See how file rules are written in HTML/QuickForm/file.php
 704    * Checks to make sure the uploaded file is html
 705    *
 706    * @param array $elementValue
 707    *
 708    * @return bool
 709    *   True if file has been uploaded, false otherwise
 710    */
 711   public static function htmlFile($elementValue) {
 712     if ((isset($elementValue['error']) && $elementValue['error'] == 0) ||
 713       (!empty($elementValue['tmp_name']) && $elementValue['tmp_name'] != 'none')
 714     ) {
 715       return CRM_Utils_File::isHtmlFile($elementValue['tmp_name']);
 716     }
 717     return FALSE;
 718   }
 719
 720   /**
 721    * Check if there is a record with the same name in the db.
 722    *
 723    * @param string $value
 724    *   The value of the field we are checking.
 725    * @param array $options
 726    *   The daoName, fieldName (optional) and DomainID (optional).
 727    *
 728    * @return bool
 729    *   true if object exists
 730    */
 731   public static function objectExists($value, $options) {
 732     $name = 'name';
 733     if (isset($options[2])) {
 734       $name = $options[2];
 735     }
 736
 737     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));
 738   }
 739
 740   /**
 741    * @param $value
 742    * @param $options
 743    *
 744    * @return bool
 745    */
 746   public static function optionExists($value, $options) {
 747     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));
 748   }
 749
 750   /**
 751    * @param $value
 752    * @param $type
 753    *
 754    * @return bool
 755    */
 756   public static function creditCardNumber($value, $type) {
 757     return Validate_Finance_CreditCard::number($value, $type);
 758   }
 759
 760   /**
 761    * @param $value
 762    * @param $type
 763    *
 764    * @return bool
 765    */
 766   public static function cvv($value, $type) {
 767     return Validate_Finance_CreditCard::cvv($value, $type);
 768   }
 769
 770   /**
 771    * @param $value
 772    *
 773    * @return bool
 774    */
 775   public static function currencyCode($value) {
 776     static $currencyCodes = NULL;
 777     if (!$currencyCodes) {
 778       $currencyCodes = CRM_Core_PseudoConstant::currencyCode();
 779     }
 780     if (in_array($value, $currencyCodes)) {
 781       return TRUE;
 782     }
 783     return FALSE;
 784   }
 785
 786   /**
 787    * @param $value
 788    *
 789    * @return bool
 790    */
 791   public static function xssString($value) {
 792     if (is_string($value)) {
 793       return preg_match('!<(vb)?script[^>]*>.*</(vb)?script.*>!ims',
 794         $value
 795       ) ? FALSE : TRUE;
 796     }
 797     else {
 798       return TRUE;
 799     }
 800   }
 801
 802   /**
 803    * @param $path
 804    *
 805    * @return bool
 806    */
 807   public static function fileExists($path) {
 808     return file_exists($path);
 809   }
 810
 811   /**
 812    * Determine whether the value contains a valid reference to a directory.
 813    *
 814    * Paths stored in the setting system may be absolute -- or may be
 815    * relative to the default data directory.
 816    *
 817    * @param string $path
 818    * @return bool
 819    */
 820   public static function settingPath($path) {
 821     return is_dir(Civi::paths()->getPath($path));
 822   }
 823
 824   /**
 825    * @param $value
 826    * @param null $actualElementValue
 827    *
 828    * @return bool
 829    */
 830   public static function validContact($value, $actualElementValue = NULL) {
 831     if ($actualElementValue) {
 832       $value = $actualElementValue;
 833     }
 834
 835     return CRM_Utils_Rule::positiveInteger($value);
 836   }
 837
 838   /**
 839    * Check the validity of the date (in qf format)
 840    * note that only a year is valid, or a mon-year is
 841    * also valid in addition to day-mon-year
 842    *
 843    * @param array $date
 844    *
 845    * @return bool
 846    *   true if valid date
 847    */
 848   public static function qfDate($date) {
 849     $config = CRM_Core_Config::singleton();
 850
 851     $d = CRM_Utils_Array::value('d', $date);
 852     $m = CRM_Utils_Array::value('M', $date);
 853     $y = CRM_Utils_Array::value('Y', $date);
 854     if (isset($date['h']) ||
 855       isset($date['g'])
 856     ) {
 857       $m = CRM_Utils_Array::value('M', $date);
 858     }
 859
 860     if (!$d && !$m && !$y) {
 861       return TRUE;
 862     }
 863
 864     $day = $mon = 1;
 865     $year = 0;
 866     if ($d) {
 867       $day = $d;
 868     }
 869     if ($m) {
 870       $mon = $m;
 871     }
 872     if ($y) {
 873       $year = $y;
 874     }
 875
 876     // if we have day we need mon, and if we have mon we need year
 877     if (($d && !$m) ||
 878       ($d && !$y) ||
 879       ($m && !$y)
 880     ) {
 881       return FALSE;
 882     }
 883
 884     if (!empty($day) || !empty($mon) || !empty($year)) {
 885       return checkdate($mon, $day, $year);
 886     }
 887     return FALSE;
 888   }
 889
 890   /**
 891    * @param $key
 892    *
 893    * @return bool
 894    */
 895   public static function qfKey($key) {
 896     return ($key) ? CRM_Core_Key::valid($key) : FALSE;
 897   }
 898
 899   /**
 900    * Check if the values in the date range are in correct chronological order.
 901    *
 902    * @param array $fields
 903    *  Fields of the form.
 904    * @param $fieldName
 905    *  Name of date range field.
 906    * @param $errors
 907    *  The error array.
 908    * @param $title
 909    *  Title of the date range to be displayed in the error message.
 910    */
 911   public static function validDateRange($fields, $fieldName, &$errors, $title) {
 912     $lowDate = strtotime($fields[$fieldName . '_low']);
 913     $highDate = strtotime($fields[$fieldName . '_high']);
 914
 915     if ($lowDate > $highDate) {
 916       $errors[$fieldName . '_range_error'] = ts('%1: Please check that your date range is in correct chronological order.', array(1 => $title));
 917     }
 918   }
 919
 920   /**
 921    * @param string $key Extension Key to check
 922    * @return bool
 923    */
 924   public static function checkExtesnionKeyIsValid($key = NULL) {
 925     if (!empty($key) && !preg_match('/^[0-9a-zA-Z._-]+$/', $key)) {
 926       return FALSE;
 927     }
 928     return TRUE;
 929   }
 930
 931 }