CRM/Utils/Rule.php

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