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    * @param $value
 506    *
 507    * @return mixed
 508    */
 509   public static function cleanMoney($value) {
 510     // first remove all white space
 511     $value = str_replace(array(' ', "\t", "\n"), '', $value);
 512
 513     $config = CRM_Core_Config::singleton();
 514
 515     //CRM-14868
 516     $currencySymbols = CRM_Core_PseudoConstant::get(
 517       'CRM_Contribute_DAO_Contribution',
 518       'currency', array(
 519         'keyColumn' => 'name',
 520         'labelColumn' => 'symbol',
 521       )
 522     );
 523     $value = str_replace($currencySymbols, '', $value);
 524
 525     if ($config->monetaryThousandSeparator) {
 526       $mon_thousands_sep = $config->monetaryThousandSeparator;
 527     }
 528     else {
 529       $mon_thousands_sep = ',';
 530     }
 531
 532     // ugly fix for CRM-6391: do not drop the thousand separator if
 533     // it looks like it’s separating decimal part (because a given
 534     // value undergoes a second cleanMoney() call, for example)
 535     // CRM-15835 - in case the amount/value contains 0 after decimal
 536     // eg 150.5 the following if condition will pass
 537     if ($mon_thousands_sep != '.' or (substr($value, -3, 1) != '.' && substr($value, -2, 1) != '.')) {
 538       $value = str_replace($mon_thousands_sep, '', $value);
 539     }
 540
 541     if ($config->monetaryDecimalPoint) {
 542       $mon_decimal_point = $config->monetaryDecimalPoint;
 543     }
 544     else {
 545       $mon_decimal_point = '.';
 546     }
 547     $value = str_replace($mon_decimal_point, '.', $value);
 548
 549     return $value;
 550   }
 551
 552   /**
 553    * @param $value
 554    *
 555    * @return bool
 556    */
 557   public static function money($value) {
 558     $config = CRM_Core_Config::singleton();
 559
 560     // only edge case when we have a decimal point in the input money
 561     // field and not defined in the decimal Point in config settings
 562     if ($config->monetaryDecimalPoint &&
 563       $config->monetaryDecimalPoint != '.' &&
 564       // CRM-7122 also check for Thousands Separator in config settings
 565       $config->monetaryThousandSeparator != '.' &&
 566       substr_count($value, '.')
 567     ) {
 568       return FALSE;
 569     }
 570
 571     $value = self::cleanMoney($value);
 572
 573     if (self::integer($value)) {
 574       return TRUE;
 575     }
 576
 577     // Allow values such as -0, 1.024555, -.1
 578     // We need to support multiple decimal places here, not just the number allowed by locale
 579     //  otherwise tax calculations break when you want the inclusive amount to be a round number (eg. £10 inc. VAT requires 8.333333333 here).
 580     return preg_match('/(^-?\d+\.?\d*$)|(^-?\.\d+$)/', $value) ? TRUE : FALSE;
 581   }
 582
 583   /**
 584    * @param $value
 585    * @param int $maxLength
 586    *
 587    * @return bool
 588    */
 589   public static function string($value, $maxLength = 0) {
 590     if (is_string($value) &&
 591       ($maxLength === 0 || strlen($value) <= $maxLength)
 592     ) {
 593       return TRUE;
 594     }
 595     return FALSE;
 596   }
 597
 598   /**
 599    * @param $value
 600    *
 601    * @return bool
 602    */
 603   public static function boolean($value) {
 604     return preg_match(
 605       '/(^(1|0)$)|(^(Y(es)?|N(o)?)$)|(^(T(rue)?|F(alse)?)$)/i', $value
 606     ) ? TRUE : FALSE;
 607   }
 608
 609   /**
 610    * @param $value
 611    *
 612    * @return bool
 613    */
 614   public static function email($value) {
 615     return (bool) filter_var($value, FILTER_VALIDATE_EMAIL);
 616   }
 617
 618   /**
 619    * @param $list
 620    *
 621    * @return bool
 622    */
 623   public static function emailList($list) {
 624     $emails = explode(',', $list);
 625     foreach ($emails as $email) {
 626       $email = trim($email);
 627       if (!self::email($email)) {
 628         return FALSE;
 629       }
 630     }
 631     return TRUE;
 632   }
 633
 634   /**
 635    * allow between 4-6 digits as postal code since india needs 6 and US needs 5 (or
 636    * if u disregard the first 0, 4 (thanx excel!)
 637    * FIXME: we need to figure out how to localize such rules
 638    * @param $value
 639    *
 640    * @return bool
 641    */
 642   public static function postalCode($value) {
 643     if (preg_match('/^\d{4,6}(-\d{4})?$/', $value)) {
 644       return TRUE;
 645     }
 646     return FALSE;
 647   }
 648
 649   /**
 650    * See how file rules are written in HTML/QuickForm/file.php
 651    * Checks to make sure the uploaded file is ascii
 652    *
 653    * @param string $elementValue
 654    *
 655    * @return bool
 656    *   True if file has been uploaded, false otherwise
 657    */
 658   public static function asciiFile($elementValue) {
 659     if ((isset($elementValue['error']) && $elementValue['error'] == 0) ||
 660       (!empty($elementValue['tmp_name']) && $elementValue['tmp_name'] != 'none')
 661     ) {
 662       return CRM_Utils_File::isAscii($elementValue['tmp_name']);
 663     }
 664     return FALSE;
 665   }
 666
 667   /**
 668    * Checks to make sure the uploaded file is in UTF-8, recodes if it's not
 669    *
 670    * @param array $elementValue
 671    *
 672    * @return bool
 673    *   Whether file has been uploaded properly and is now in UTF-8.
 674    */
 675   public static function utf8File($elementValue) {
 676     $success = FALSE;
 677
 678     if ((isset($elementValue['error']) && $elementValue['error'] == 0) ||
 679       (!empty($elementValue['tmp_name']) && $elementValue['tmp_name'] != 'none')
 680     ) {
 681
 682       $success = CRM_Utils_File::isAscii($elementValue['tmp_name']);
 683
 684       // if it's a file, but not UTF-8, let's try and recode it
 685       // and then make sure it's an UTF-8 file in the end
 686       if (!$success) {
 687         $success = CRM_Utils_File::toUtf8($elementValue['tmp_name']);
 688         if ($success) {
 689           $success = CRM_Utils_File::isAscii($elementValue['tmp_name']);
 690         }
 691       }
 692     }
 693     return $success;
 694   }
 695
 696   /**
 697    * See how file rules are written in HTML/QuickForm/file.php
 698    * Checks to make sure the uploaded file is html
 699    *
 700    * @param array $elementValue
 701    *
 702    * @return bool
 703    *   True if file has been uploaded, false otherwise
 704    */
 705   public static function htmlFile($elementValue) {
 706     if ((isset($elementValue['error']) && $elementValue['error'] == 0) ||
 707       (!empty($elementValue['tmp_name']) && $elementValue['tmp_name'] != 'none')
 708     ) {
 709       return CRM_Utils_File::isHtmlFile($elementValue['tmp_name']);
 710     }
 711     return FALSE;
 712   }
 713
 714   /**
 715    * Check if there is a record with the same name in the db.
 716    *
 717    * @param string $value
 718    *   The value of the field we are checking.
 719    * @param array $options
 720    *   The daoName, fieldName (optional) and DomainID (optional).
 721    *
 722    * @return bool
 723    *   true if object exists
 724    */
 725   public static function objectExists($value, $options) {
 726     $name = 'name';
 727     if (isset($options[2])) {
 728       $name = $options[2];
 729     }
 730
 731     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));
 732   }
 733
 734   /**
 735    * @param $value
 736    * @param $options
 737    *
 738    * @return bool
 739    */
 740   public static function optionExists($value, $options) {
 741     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));
 742   }
 743
 744   /**
 745    * @param $value
 746    * @param $type
 747    *
 748    * @return bool
 749    */
 750   public static function creditCardNumber($value, $type) {
 751     return Validate_Finance_CreditCard::number($value, $type);
 752   }
 753
 754   /**
 755    * @param $value
 756    * @param $type
 757    *
 758    * @return bool
 759    */
 760   public static function cvv($value, $type) {
 761     return Validate_Finance_CreditCard::cvv($value, $type);
 762   }
 763
 764   /**
 765    * @param $value
 766    *
 767    * @return bool
 768    */
 769   public static function currencyCode($value) {
 770     static $currencyCodes = NULL;
 771     if (!$currencyCodes) {
 772       $currencyCodes = CRM_Core_PseudoConstant::currencyCode();
 773     }
 774     if (in_array($value, $currencyCodes)) {
 775       return TRUE;
 776     }
 777     return FALSE;
 778   }
 779
 780   /**
 781    * @param $value
 782    *
 783    * @return bool
 784    */
 785   public static function xssString($value) {
 786     if (is_string($value)) {
 787       return preg_match('!<(vb)?script[^>]*>.*</(vb)?script.*>!ims',
 788         $value
 789       ) ? FALSE : TRUE;
 790     }
 791     else {
 792       return TRUE;
 793     }
 794   }
 795
 796   /**
 797    * @param $path
 798    *
 799    * @return bool
 800    */
 801   public static function fileExists($path) {
 802     return file_exists($path);
 803   }
 804
 805   /**
 806    * Determine whether the value contains a valid reference to a directory.
 807    *
 808    * Paths stored in the setting system may be absolute -- or may be
 809    * relative to the default data directory.
 810    *
 811    * @param string $path
 812    * @return bool
 813    */
 814   public static function settingPath($path) {
 815     return is_dir(Civi::paths()->getPath($path));
 816   }
 817
 818   /**
 819    * @param $value
 820    * @param null $actualElementValue
 821    *
 822    * @return bool
 823    */
 824   public static function validContact($value, $actualElementValue = NULL) {
 825     if ($actualElementValue) {
 826       $value = $actualElementValue;
 827     }
 828
 829     return CRM_Utils_Rule::positiveInteger($value);
 830   }
 831
 832   /**
 833    * Check the validity of the date (in qf format)
 834    * note that only a year is valid, or a mon-year is
 835    * also valid in addition to day-mon-year
 836    *
 837    * @param array $date
 838    *
 839    * @return bool
 840    *   true if valid date
 841    */
 842   public static function qfDate($date) {
 843     $config = CRM_Core_Config::singleton();
 844
 845     $d = CRM_Utils_Array::value('d', $date);
 846     $m = CRM_Utils_Array::value('M', $date);
 847     $y = CRM_Utils_Array::value('Y', $date);
 848     if (isset($date['h']) ||
 849       isset($date['g'])
 850     ) {
 851       $m = CRM_Utils_Array::value('M', $date);
 852     }
 853
 854     if (!$d && !$m && !$y) {
 855       return TRUE;
 856     }
 857
 858     $day = $mon = 1;
 859     $year = 0;
 860     if ($d) {
 861       $day = $d;
 862     }
 863     if ($m) {
 864       $mon = $m;
 865     }
 866     if ($y) {
 867       $year = $y;
 868     }
 869
 870     // if we have day we need mon, and if we have mon we need year
 871     if (($d && !$m) ||
 872       ($d && !$y) ||
 873       ($m && !$y)
 874     ) {
 875       return FALSE;
 876     }
 877
 878     if (!empty($day) || !empty($mon) || !empty($year)) {
 879       return checkdate($mon, $day, $year);
 880     }
 881     return FALSE;
 882   }
 883
 884   /**
 885    * @param $key
 886    *
 887    * @return bool
 888    */
 889   public static function qfKey($key) {
 890     return ($key) ? CRM_Core_Key::valid($key) : FALSE;
 891   }
 892
 893   /**
 894    * Check if the values in the date range are in correct chronological order.
 895    *
 896    * @param array $fields
 897    *  Fields of the form.
 898    * @param $fieldName
 899    *  Name of date range field.
 900    * @param $errors
 901    *  The error array.
 902    * @param $title
 903    *  Title of the date range to be displayed in the error message.
 904    */
 905   public static function validDateRange($fields, $fieldName, &$errors, $title) {
 906     $lowDate = strtotime($fields[$fieldName . '_low']);
 907     $highDate = strtotime($fields[$fieldName . '_high']);
 908
 909     if ($lowDate > $highDate) {
 910       $errors[$fieldName . '_range_error'] = ts('%1: Please check that your date range is in correct chronological order.', array(1 => $title));
 911     }
 912   }
 913
 914   /**
 915    * @param string $key Extension Key to check
 916    * @return bool
 917    */
 918   public static function checkExtesnionKeyIsValid($key = NULL) {
 919     if (!empty($key) && !preg_match('/^[0-9a-zA-Z._-]+$/', $key)) {
 920       return FALSE;
 921     }
 922     return TRUE;
 923   }
 924
 925 }