CRM/Utils/System.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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-2015
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * System wide utilities.
  38  *
  39  */
  40 class CRM_Utils_System {
  41
  42   static $_callbacks = NULL;
  43
  44   /**
  45    * @var string Page title
  46    */
  47   static $title = '';
  48
  49   /**
  50    * Compose a new URL string from the current URL string.
  51    *
  52    * Used by all the framework components, specifically,
  53    * pager, sort and qfc
  54    *
  55    * @param string $urlVar
  56    *   The url variable being considered (i.e. crmPageID, crmSortID etc).
  57    * @param bool $includeReset
  58    *   (optional) Whether to include the reset GET string (if present).
  59    * @param bool $includeForce
  60    *   (optional) Whether to include the force GET string (if present).
  61    * @param string $path
  62    *   (optional) The path to use for the new url.
  63    * @param bool|string $absolute
  64    *   (optional) Whether to return an absolute URL.
  65    *
  66    * @return string
  67    *   The URL fragment.
  68    */
  69   public static function makeURL($urlVar, $includeReset = FALSE, $includeForce = TRUE, $path = NULL, $absolute = FALSE) {
  70     if (empty($path)) {
  71       $config = CRM_Core_Config::singleton();
  72       $path = CRM_Utils_Array::value($config->userFrameworkURLVar, $_GET);
  73       if (empty($path)) {
  74         return '';
  75       }
  76     }
  77
  78     return
  79       self::url(
  80         $path,
  81         CRM_Utils_System::getLinksUrl($urlVar, $includeReset, $includeForce),
  82         $absolute
  83       );
  84   }
  85
  86   /**
  87    * Get the query string and clean it up.
  88    *
  89    * Strips some variables that should not be propagated, specifically variables
  90    * like 'reset'. Also strips any side-affect actions (e.g. export).
  91    *
  92    * This function is copied mostly verbatim from Pager.php (_getLinksUrl)
  93    *
  94    * @param string $urlVar
  95    *   The URL variable being considered (e.g. crmPageID, crmSortID etc).
  96    * @param bool $includeReset
  97    *   (optional) By default this is FALSE, meaning that the reset parameter
  98    *   is skipped. Set to TRUE to leave the reset parameter as-is.
  99    * @param bool $includeForce
 100    *   (optional)
 101    * @param bool $skipUFVar
 102    *   (optional)
 103    *
 104    * @return string
 105    */
 106   public static function getLinksUrl($urlVar, $includeReset = FALSE, $includeForce = TRUE, $skipUFVar = TRUE) {
 107     // Sort out query string to prevent messy urls
 108     $querystring = array();
 109     $qs = array();
 110     $arrays = array();
 111
 112     if (!empty($_SERVER['QUERY_STRING'])) {
 113       $qs = explode('&', str_replace('&amp;', '&', $_SERVER['QUERY_STRING']));
 114       for ($i = 0, $cnt = count($qs); $i < $cnt; $i++) {
 115         // check first if exist a pair
 116         if (strstr($qs[$i], '=') !== FALSE) {
 117           list($name, $value) = explode('=', $qs[$i]);
 118           if ($name != $urlVar) {
 119             $name = rawurldecode($name);
 120             //check for arrays in parameters: site.php?foo[]=1&foo[]=2&foo[]=3
 121             if ((strpos($name, '[') !== FALSE) &&
 122               (strpos($name, ']') !== FALSE)
 123             ) {
 124               $arrays[] = $qs[$i];
 125             }
 126             else {
 127               $qs[$name] = $value;
 128             }
 129           }
 130         }
 131         else {
 132           $qs[$qs[$i]] = '';
 133         }
 134         unset($qs[$i]);
 135       }
 136     }
 137
 138     if ($includeForce) {
 139       $qs['force'] = 1;
 140     }
 141
 142     // Ok this is a big assumption but usually works
 143     // If we are in snippet mode, retain the 'section' param, if not, get rid
 144     // of it.
 145     if (!empty($qs['snippet'])) {
 146       unset($qs['snippet']);
 147     }
 148     else {
 149       unset($qs['section']);
 150     }
 151
 152     if ($skipUFVar) {
 153       $config = CRM_Core_Config::singleton();
 154       unset($qs[$config->userFrameworkURLVar]);
 155     }
 156
 157     foreach ($qs as $name => $value) {
 158       if ($name != 'reset' || $includeReset) {
 159         $querystring[] = $name . '=' . $value;
 160       }
 161     }
 162
 163     $querystring = array_merge($querystring, array_unique($arrays));
 164
 165     $url = implode('&', $querystring);
 166     if ($urlVar) {
 167       $url .= (!empty($querystring) ? '&' : '') . $urlVar . '=';
 168     }
 169
 170     return $url;
 171   }
 172
 173   /**
 174    * If we are using a theming system, invoke theme, else just print the
 175    * content.
 176    *
 177    * @param string $content
 178    *   The content that will be themed.
 179    * @param bool $print
 180    *   (optional) Are we displaying to the screen or bypassing theming?
 181    * @param bool $maintenance
 182    *   (optional) For maintenance mode.
 183    *
 184    * @return string
 185    */
 186   public static function theme(
 187     &$content,
 188     $print = FALSE,
 189     $maintenance = FALSE
 190   ) {
 191     $config = &CRM_Core_Config::singleton();
 192     return $config->userSystem->theme($content, $print, $maintenance);
 193   }
 194
 195   /**
 196    * Generate a query string if input is an array.
 197    *
 198    * @param array|string $query
 199    * @return string
 200    */
 201   public static function makeQueryString($query) {
 202     if (is_array($query)) {
 203       $buf = '';
 204       foreach ($query as $key => $value) {
 205         $buf .= ($buf ? '&' : '') . urlencode($key) . '=' . urlencode($value);
 206       }
 207       $query = $buf;
 208     }
 209     return $query;
 210   }
 211
 212   /**
 213    * Generate an internal CiviCRM URL.
 214    *
 215    * @param string $path
 216    *   The path being linked to, such as "civicrm/add".
 217    * @param array|string $query
 218    *   A query string to append to the link, or an array of key-value pairs.
 219    * @param bool $absolute
 220    *   Whether to force the output to be an absolute link (beginning with a
 221    *   URI-scheme such as 'http:'). Useful for links that will be displayed
 222    *   outside the site, such as in an RSS feed.
 223    * @param string $fragment
 224    *   A fragment identifier (named anchor) to append to the link.
 225    *
 226    * @param bool $htmlize
 227    * @param bool $frontend
 228    * @param bool $forceBackend
 229    * @return string
 230    *   An HTML string containing a link to the given path.
 231    */
 232   public static function url(
 233     $path = NULL,
 234     $query = NULL,
 235     $absolute = FALSE,
 236     $fragment = NULL,
 237     $htmlize = TRUE,
 238     $frontend = FALSE,
 239     $forceBackend = FALSE
 240   ) {
 241     $query = self::makeQueryString($query);
 242
 243     // we have a valid query and it has not yet been transformed
 244     if ($htmlize && !empty($query) && strpos($query, '&amp;') === FALSE) {
 245       $query = htmlentities($query);
 246     }
 247
 248     $config = CRM_Core_Config::singleton();
 249     return $config->userSystem->url($path, $query, $absolute, $fragment, $htmlize, $frontend, $forceBackend);
 250   }
 251
 252   /**
 253    * @param $text
 254    * @param null $path
 255    * @param null $query
 256    * @param bool $absolute
 257    * @param null $fragment
 258    * @param bool $htmlize
 259    * @param bool $frontend
 260    * @param bool $forceBackend
 261    *
 262    * @return string
 263    */
 264   public static function href(
 265     $text, $path = NULL, $query = NULL, $absolute = TRUE,
 266     $fragment = NULL, $htmlize = TRUE, $frontend = FALSE, $forceBackend = FALSE
 267   ) {
 268     $url = self::url($path, $query, $absolute, $fragment, $htmlize, $frontend, $forceBackend);
 269     return "<a href=\"$url\">$text</a>";
 270   }
 271
 272   /**
 273    * @return mixed
 274    */
 275   public static function permissionDenied() {
 276     $config = CRM_Core_Config::singleton();
 277     return $config->userSystem->permissionDenied();
 278   }
 279
 280   /**
 281    * @return mixed
 282    */
 283   public static function logout() {
 284     $config = CRM_Core_Config::singleton();
 285     return $config->userSystem->logout();
 286   }
 287
 288   /**
 289    * this is a very drupal specific function for now.
 290    */
 291   public static function updateCategories() {
 292     $config = CRM_Core_Config::singleton();
 293     if ($config->userSystem->is_drupal) {
 294       $config->userSystem->updateCategories();
 295     }
 296   }
 297
 298   /**
 299    * What menu path are we currently on. Called for the primary tpl
 300    *
 301    * @return string
 302    *   the current menu path
 303    */
 304   public static function currentPath() {
 305     $config = CRM_Core_Config::singleton();
 306     return trim(CRM_Utils_Array::value($config->userFrameworkURLVar, $_GET), '/');
 307   }
 308
 309   /**
 310    * called from a template to compose a url.
 311    *
 312    * @param array $params
 313    *   List of parameters.
 314    *
 315    * @return string
 316    *   url
 317    */
 318   public static function crmURL($params) {
 319     $p = CRM_Utils_Array::value('p', $params);
 320     if (!isset($p)) {
 321       $p = self::currentPath();
 322     }
 323
 324     return self::url(
 325       $p,
 326       CRM_Utils_Array::value('q', $params),
 327       CRM_Utils_Array::value('a', $params, FALSE),
 328       CRM_Utils_Array::value('f', $params),
 329       CRM_Utils_Array::value('h', $params, TRUE),
 330       CRM_Utils_Array::value('fe', $params, FALSE),
 331       CRM_Utils_Array::value('fb', $params, FALSE)
 332     );
 333   }
 334
 335   /**
 336    * Sets the title of the page.
 337    *
 338    * @param string $title
 339    * @param string $pageTitle
 340    */
 341   public static function setTitle($title, $pageTitle = NULL) {
 342     self::$title = $title;
 343     $config = CRM_Core_Config::singleton();
 344     return $config->userSystem->setTitle($title, $pageTitle);
 345   }
 346
 347   /**
 348    * Figures and sets the userContext.
 349    *
 350    * Uses the referer if valid else uses the default.
 351    *
 352    * @param array $names
 353    *   Refererer should match any str in this array.
 354    * @param string $default
 355    *   (optional) The default userContext if no match found.
 356    */
 357   public static function setUserContext($names, $default = NULL) {
 358     $url = $default;
 359
 360     $session = CRM_Core_Session::singleton();
 361     $referer = CRM_Utils_Array::value('HTTP_REFERER', $_SERVER);
 362
 363     if ($referer && !empty($names)) {
 364       foreach ($names as $name) {
 365         if (strstr($referer, $name)) {
 366           $url = $referer;
 367           break;
 368         }
 369       }
 370     }
 371
 372     if ($url) {
 373       $session->pushUserContext($url);
 374     }
 375   }
 376
 377   /**
 378    * Gets a class name for an object.
 379    *
 380    * @param object $object
 381    *   Object whose class name is needed.
 382    *
 383    * @return string
 384    *   The class name of the object.
 385    */
 386   public static function getClassName($object) {
 387     return get_class($object);
 388   }
 389
 390   /**
 391    * Redirect to another URL.
 392    *
 393    * @param string $url
 394    *   The URL to provide to the browser via the Location header.
 395    */
 396   public static function redirect($url = NULL) {
 397     if (!$url) {
 398       $url = self::url('civicrm/dashboard', 'reset=1');
 399     }
 400
 401     // replace the &amp; characters with &
 402     // this is kinda hackish but not sure how to do it right
 403     $url = str_replace('&amp;', '&', $url);
 404
 405     // If we are in a json context, respond appropriately
 406     if (CRM_Utils_Array::value('snippet', $_GET) === 'json') {
 407       CRM_Core_Page_AJAX::returnJsonResponse(array(
 408         'status' => 'redirect',
 409         'userContext' => $url,
 410       ));
 411     }
 412
 413     header('Location: ' . $url);
 414     self::civiExit();
 415   }
 416
 417   /**
 418    * Redirect to another URL using JavaScript.
 419    *
 420    * Use an html based file with javascript embedded to redirect to another url
 421    * This prevent the too many redirect errors emitted by various browsers
 422    *
 423    * @param string $url
 424    *   (optional) The destination URL.
 425    * @param string $title
 426    *   (optional) The page title to use for the redirect page.
 427    * @param string $message
 428    *   (optional) The message to provide in the body of the redirect page.
 429    */
 430   public static function jsRedirect(
 431     $url = NULL,
 432     $title = NULL,
 433     $message = NULL
 434   ) {
 435     if (!$url) {
 436       $url = self::url('civicrm/dashboard', 'reset=1');
 437     }
 438
 439     if (!$title) {
 440       $title = ts('CiviCRM task in progress');
 441     }
 442
 443     if (!$message) {
 444       $message = ts('A long running CiviCRM task is currently in progress. This message will be refreshed till the task is completed');
 445     }
 446
 447     // replace the &amp; characters with &
 448     // this is kinda hackish but not sure how to do it right
 449     $url = str_replace('&amp;', '&', $url);
 450
 451     $template = CRM_Core_Smarty::singleton();
 452     $template->assign('redirectURL', $url);
 453     $template->assign('title', $title);
 454     $template->assign('message', $message);
 455
 456     $html = $template->fetch('CRM/common/redirectJS.tpl');
 457
 458     echo $html;
 459
 460     self::civiExit();
 461   }
 462
 463   /**
 464    * Append an additional breadcrumb tag to the existing breadcrumbs.
 465    *
 466    * @param $breadCrumbs
 467    */
 468   public static function appendBreadCrumb($breadCrumbs) {
 469     $config = CRM_Core_Config::singleton();
 470     return $config->userSystem->appendBreadCrumb($breadCrumbs);
 471   }
 472
 473   /**
 474    * Reset an additional breadcrumb tag to the existing breadcrumb.
 475    */
 476   public static function resetBreadCrumb() {
 477     $config = CRM_Core_Config::singleton();
 478     return $config->userSystem->resetBreadCrumb();
 479   }
 480
 481   /**
 482    * Append a string to the head of the HTML file.
 483    *
 484    * @param string $bc
 485    */
 486   public static function addHTMLHead($bc) {
 487     $config = CRM_Core_Config::singleton();
 488     return $config->userSystem->addHTMLHead($bc);
 489   }
 490
 491   /**
 492    * Determine the post URL for a form.
 493    *
 494    * @param $action
 495    *   The default action if one is pre-specified.
 496    *
 497    * @return string
 498    *   The URL to post the form.
 499    */
 500   public static function postURL($action) {
 501     $config = CRM_Core_Config::singleton();
 502     return $config->userSystem->postURL($action);
 503   }
 504
 505   /**
 506    * Rewrite various system URLs to https.
 507    */
 508   public static function mapConfigToSSL() {
 509     $config = CRM_Core_Config::singleton();
 510     $config->userFrameworkResourceURL = str_replace('http://', 'https://', $config->userFrameworkResourceURL);
 511     $config->resourceBase = $config->userFrameworkResourceURL;
 512
 513     if (!empty($config->extensionsURL)) {
 514       $config->extensionsURL = str_replace('http://', 'https://', $config->extensionsURL);
 515     }
 516
 517     return $config->userSystem->mapConfigToSSL();
 518   }
 519
 520   /**
 521    * Get the base URL of the system.
 522    *
 523    * @return string
 524    */
 525   public static function baseURL() {
 526     $config = CRM_Core_Config::singleton();
 527     return $config->userFrameworkBaseURL;
 528   }
 529
 530   /**
 531    */
 532   public static function authenticateAbort($message, $abort) {
 533     if ($abort) {
 534       echo $message;
 535       self::civiExit(0);
 536     }
 537     else {
 538       return FALSE;
 539     }
 540   }
 541
 542   /**
 543    * @param bool $abort
 544    *   (optional) Whether to exit; defaults to true.
 545    *
 546    * @return bool
 547    */
 548   public static function authenticateKey($abort = TRUE) {
 549     // also make sure the key is sent and is valid
 550     $key = trim(CRM_Utils_Array::value('key', $_REQUEST));
 551
 552     $docAdd = "More info at:" . CRM_Utils_System::docURL2("Managing Scheduled Jobs", TRUE, NULL, NULL, NULL, "wiki");
 553
 554     if (!$key) {
 555       return self::authenticateAbort(
 556         "ERROR: You need to send a valid key to execute this file. " . $docAdd . "\n",
 557         $abort
 558       );
 559     }
 560
 561     $siteKey = defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY : NULL;
 562
 563     if (!$siteKey || empty($siteKey)) {
 564       return self::authenticateAbort(
 565         "ERROR: You need to set a valid site key in civicrm.settings.php. " . $docAdd . "\n",
 566         $abort
 567       );
 568     }
 569
 570     if (strlen($siteKey) < 8) {
 571       return self::authenticateAbort(
 572         "ERROR: Site key needs to be greater than 7 characters in civicrm.settings.php. " . $docAdd . "\n",
 573         $abort
 574       );
 575     }
 576
 577     if ($key !== $siteKey) {
 578       return self::authenticateAbort(
 579         "ERROR: Invalid key value sent. " . $docAdd . "\n",
 580         $abort
 581       );
 582     }
 583
 584     return TRUE;
 585   }
 586
 587   /**
 588    * @param bool $abort
 589    * @param null $name
 590    * @param null $pass
 591    * @param bool $storeInSession
 592    * @param bool $loadCMSBootstrap
 593    * @param bool $requireKey
 594    *
 595    * @return bool
 596    */
 597   public static function authenticateScript($abort = TRUE, $name = NULL, $pass = NULL, $storeInSession = TRUE, $loadCMSBootstrap = TRUE, $requireKey = TRUE) {
 598     // auth to make sure the user has a login/password to do a shell operation
 599     // later on we'll link this to acl's
 600     if (!$name) {
 601       $name = trim(CRM_Utils_Array::value('name', $_REQUEST));
 602       $pass = trim(CRM_Utils_Array::value('pass', $_REQUEST));
 603     }
 604
 605     // its ok to have an empty password
 606     if (!$name) {
 607       return self::authenticateAbort(
 608         "ERROR: You need to send a valid user name and password to execute this file\n",
 609         $abort
 610       );
 611     }
 612
 613     if ($requireKey && !self::authenticateKey($abort)) {
 614       return FALSE;
 615     }
 616
 617     $result = CRM_Utils_System::authenticate($name, $pass, $loadCMSBootstrap);
 618     if (!$result) {
 619       return self::authenticateAbort(
 620         "ERROR: Invalid username and/or password\n",
 621         $abort
 622       );
 623     }
 624     elseif ($storeInSession) {
 625       // lets store contact id and user id in session
 626       list($userID, $ufID, $randomNumber) = $result;
 627       if ($userID && $ufID) {
 628         $config = CRM_Core_Config::singleton();
 629         $config->userSystem->setUserSession(array($userID, $ufID));
 630       }
 631       else {
 632         return self::authenticateAbort(
 633           "ERROR: Unexpected error, could not match userID and contactID",
 634           $abort
 635         );
 636       }
 637     }
 638
 639     return $result;
 640   }
 641
 642   /**
 643    * Authenticate the user against the uf db.
 644    *
 645    * In case of successful authentication, returns an array consisting of
 646    * (contactID, ufID, unique string). Returns FALSE if authentication is
 647    * unsuccessful.
 648    *
 649    * @param string $name
 650    *   The username.
 651    * @param string $password
 652    *   The password.
 653    * @param bool $loadCMSBootstrap
 654    * @param $realPath
 655    *
 656    * @return false|array
 657    */
 658   public static function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) {
 659     $config = CRM_Core_Config::singleton();
 660
 661     /* Before we do any loading, let's start the session and write to it.
 662      * We typically call authenticate only when we need to bootstrap the CMS
 663      * directly via Civi and hence bypass the normal CMS auth and bootstrap
 664      * process typically done in CLI and cron scripts. See: CRM-12648
 665      *
 666      * Q: Can we move this to the userSystem class so that it can be tuned
 667      * per-CMS? For example, when dealing with UnitTests UF, there's no
 668      * userFrameworkDSN.
 669      */
 670     $session = CRM_Core_Session::singleton();
 671     $session->set('civicrmInitSession', TRUE);
 672
 673     if ($config->userFrameworkDSN) {
 674       $dbDrupal = DB::connect($config->userFrameworkDSN);
 675     }
 676     return $config->userSystem->authenticate($name, $password, $loadCMSBootstrap, $realPath);
 677   }
 678
 679   /**
 680    * Set a message in the UF to display to a user.
 681    *
 682    * @param string $message
 683    *   The message to set.
 684    */
 685   public static function setUFMessage($message) {
 686     $config = CRM_Core_Config::singleton();
 687     return $config->userSystem->setMessage($message);
 688   }
 689
 690
 691   /**
 692    * Determine whether a value is null-ish.
 693    *
 694    * @param $value
 695    *   The value to check for null.
 696    * @return bool
 697    */
 698   public static function isNull($value) {
 699     // FIXME: remove $value = 'null' string test when we upgrade our DAO code to handle passing null in a better way.
 700     if (!isset($value) || $value === NULL || $value === '' || $value === 'null') {
 701       return TRUE;
 702     }
 703     if (is_array($value)) {
 704       // @todo Reuse of the $value variable = asking for trouble.
 705       foreach ($value as $key => $value) {
 706         if (!self::isNull($value)) {
 707           return FALSE;
 708         }
 709       }
 710       return TRUE;
 711     }
 712     return FALSE;
 713   }
 714
 715   /**
 716    * Obscure all but the last few digits of a credit card number.
 717    *
 718    * @param string $number
 719    *   The credit card number to obscure.
 720    * @param int $keep
 721    *   (optional) The number of digits to preserve unmodified.
 722    * @return string
 723    *   The obscured credit card number.
 724    */
 725   public static function mungeCreditCard($number, $keep = 4) {
 726     $number = trim($number);
 727     if (empty($number)) {
 728       return NULL;
 729     }
 730     $replace = str_repeat('*', strlen($number) - $keep);
 731     return substr_replace($number, $replace, 0, -$keep);
 732   }
 733
 734   /**
 735    * Determine which PHP modules are loaded.
 736    *
 737    * @return array
 738    */
 739   public static function parsePHPModules() {
 740     ob_start();
 741     phpinfo(INFO_MODULES);
 742     $s = ob_get_contents();
 743     ob_end_clean();
 744
 745     $s = strip_tags($s, '<h2><th><td>');
 746     $s = preg_replace('/<th[^>]*>([^<]+)<\/th>/', "<info>\\1</info>", $s);
 747     $s = preg_replace('/<td[^>]*>([^<]+)<\/td>/', "<info>\\1</info>", $s);
 748     $vTmp = preg_split('/(<h2>[^<]+<\/h2>)/', $s, -1, PREG_SPLIT_DELIM_CAPTURE);
 749     $vModules = array();
 750     for ($i = 1; $i < count($vTmp); $i++) {
 751       if (preg_match('/<h2>([^<]+)<\/h2>/', $vTmp[$i], $vMat)) {
 752         $vName = trim($vMat[1]);
 753         $vTmp2 = explode("\n", $vTmp[$i + 1]);
 754         foreach ($vTmp2 as $vOne) {
 755           $vPat = '<info>([^<]+)<\/info>';
 756           $vPat3 = "/$vPat\s*$vPat\s*$vPat/";
 757           $vPat2 = "/$vPat\s*$vPat/";
 758           // 3cols
 759           if (preg_match($vPat3, $vOne, $vMat)) {
 760             $vModules[$vName][trim($vMat[1])] = array(trim($vMat[2]), trim($vMat[3]));
 761             // 2cols
 762           }
 763           elseif (preg_match($vPat2, $vOne, $vMat)) {
 764             $vModules[$vName][trim($vMat[1])] = trim($vMat[2]);
 765           }
 766         }
 767       }
 768     }
 769     return $vModules;
 770   }
 771
 772   /**
 773    * Get a setting from a loaded PHP module.
 774    */
 775   public static function getModuleSetting($pModuleName, $pSetting) {
 776     $vModules = self::parsePHPModules();
 777     return $vModules[$pModuleName][$pSetting];
 778   }
 779
 780   /**
 781    * @param $title
 782    *   (optional)
 783    *
 784    * @return mixed|string
 785    */
 786   public static function memory($title = NULL) {
 787     static $pid = NULL;
 788     if (!$pid) {
 789       $pid = posix_getpid();
 790     }
 791
 792     $memory = str_replace("\n", '', shell_exec("ps -p" . $pid . " -o rss="));
 793     $memory .= ", " . time();
 794     if ($title) {
 795       CRM_Core_Error::debug_var($title, $memory);
 796     }
 797     return $memory;
 798   }
 799
 800   /**
 801    * @param string $name
 802    * @param string $mimeType
 803    * @param $buffer
 804    * @param string $ext
 805    * @param bool $output
 806    * @param string $disposition
 807    */
 808   public static function download(
 809     $name, $mimeType, &$buffer,
 810     $ext = NULL,
 811     $output = TRUE,
 812     $disposition = 'attachment'
 813   ) {
 814     $now = gmdate('D, d M Y H:i:s') . ' GMT';
 815
 816     header('Content-Type: ' . $mimeType);
 817     header('Expires: ' . $now);
 818
 819     // lem9 & loic1: IE need specific headers
 820     $isIE = strstr($_SERVER['HTTP_USER_AGENT'], 'MSIE');
 821     if ($ext) {
 822       $fileString = "filename=\"{$name}.{$ext}\"";
 823     }
 824     else {
 825       $fileString = "filename=\"{$name}\"";
 826     }
 827     if ($isIE) {
 828       header("Content-Disposition: inline; $fileString");
 829       header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
 830       header('Pragma: public');
 831     }
 832     else {
 833       header("Content-Disposition: $disposition; $fileString");
 834       header('Pragma: no-cache');
 835     }
 836
 837     if ($output) {
 838       print $buffer;
 839       self::civiExit();
 840     }
 841   }
 842
 843   /**
 844    * Gather and print (and possibly log) amount of used memory.
 845    *
 846    * @param string $title
 847    * @param bool $log
 848    *   (optional) Whether to log the memory usage information.
 849    */
 850   public static function xMemory($title = NULL, $log = FALSE) {
 851     $mem = (float ) xdebug_memory_usage() / (float ) (1024);
 852     $mem = number_format($mem, 5) . ", " . time();
 853     if ($log) {
 854       echo "<p>$title: $mem<p>";
 855       flush();
 856       CRM_Core_Error::debug_var($title, $mem);
 857     }
 858     else {
 859       echo "<p>$title: $mem<p>";
 860       flush();
 861     }
 862   }
 863
 864   /**
 865    * Take a URL (or partial URL) and make it better.
 866    *
 867    * Currently, URLs pass straight through unchanged unless they are "seriously
 868    * malformed" (see http://us2.php.net/parse_url).
 869    *
 870    * @param string $url
 871    *   The URL to operate on.
 872    * @return string
 873    *   The fixed URL.
 874    */
 875   public static function fixURL($url) {
 876     $components = parse_url($url);
 877
 878     if (!$components) {
 879       return NULL;
 880     }
 881
 882     // at some point we'll add code here to make sure the url is not
 883     // something that will mess up up, so we need to clean it up here
 884     return $url;
 885   }
 886
 887   /**
 888    * Make sure a callback is valid in the current context.
 889    *
 890    * @param string $callback
 891    *   Name of the function to check.
 892    *
 893    * @return bool
 894    */
 895   public static function validCallback($callback) {
 896     if (self::$_callbacks === NULL) {
 897       self::$_callbacks = array();
 898     }
 899
 900     if (!array_key_exists($callback, self::$_callbacks)) {
 901       if (strpos($callback, '::') !== FALSE) {
 902         list($className, $methodName) = explode('::', $callback);
 903         $fileName = str_replace('_', DIRECTORY_SEPARATOR, $className) . '.php';
 904         // ignore errors if any
 905         @include_once $fileName;
 906         if (!class_exists($className)) {
 907           self::$_callbacks[$callback] = FALSE;
 908         }
 909         else {
 910           // instantiate the class
 911           $object = new $className();
 912           if (!method_exists($object, $methodName)) {
 913             self::$_callbacks[$callback] = FALSE;
 914           }
 915           else {
 916             self::$_callbacks[$callback] = TRUE;
 917           }
 918         }
 919       }
 920       else {
 921         self::$_callbacks[$callback] = function_exists($callback);
 922       }
 923     }
 924     return self::$_callbacks[$callback];
 925   }
 926
 927   /**
 928    * Like PHP's built-in explode(), but always return an array of $limit items.
 929    *
 930    * This serves as a wrapper to the PHP explode() function. In the event that
 931    * PHP's explode() returns an array with fewer than $limit elements, pad
 932    * the end of the array with NULLs.
 933    *
 934    * @param string $separator
 935    * @param string $string
 936    * @param int $limit
 937    * @return string[]
 938    */
 939   public static function explode($separator, $string, $limit) {
 940     $result = explode($separator, $string, $limit);
 941     for ($i = count($result); $i < $limit; $i++) {
 942       $result[$i] = NULL;
 943     }
 944     return $result;
 945   }
 946
 947   /**
 948    * @param string $url
 949    *   The URL to check.
 950    * @param bool $addCookie
 951    *   (optional)
 952    *
 953    * @return mixed
 954    */
 955   public static function checkURL($url, $addCookie = FALSE) {
 956     // make a GET request to $url
 957     $ch = curl_init($url);
 958     if ($addCookie) {
 959       curl_setopt($ch, CURLOPT_COOKIE, http_build_query($_COOKIE));
 960     }
 961     // it's quite alright to use a self-signed cert
 962     curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
 963
 964     // lets capture the return stuff rather than echo
 965     curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
 966
 967     // CRM-13227, CRM-14744: only return the SSL error status
 968     return (curl_exec($ch) !== FALSE);
 969   }
 970
 971   /**
 972    * Assert that we are running on a particular PHP version.
 973    *
 974    * @param int $ver
 975    *   The major version of PHP that is required.
 976    * @param bool $abort
 977    *   (optional) Whether to fatally abort if the version requirement is not
 978    *   met. Defaults to TRUE.
 979    * @return bool
 980    *   Returns TRUE if the requirement is met, FALSE if the requirement is not
 981    *   met and we're not aborting due to the failed requirement. If $abort is
 982    *   TRUE and the requirement fails, this function does not return.
 983    */
 984   public static function checkPHPVersion($ver = 5, $abort = TRUE) {
 985     $phpVersion = substr(PHP_VERSION, 0, 1);
 986     if ($phpVersion >= $ver) {
 987       return TRUE;
 988     }
 989
 990     if ($abort) {
 991       CRM_Core_Error::fatal(ts('This feature requires PHP Version %1 or greater',
 992         array(1 => $ver)
 993       ));
 994     }
 995     return FALSE;
 996   }
 997
 998   /**
 999    * @param $string
1000    * @param bool $encode
1001    *
1002    * @return string
1003    */
1004   public static function formatWikiURL($string, $encode = FALSE) {
1005     $items = explode(' ', trim($string), 2);
1006     if (count($items) == 2) {
1007       $title = $items[1];
1008     }
1009     else {
1010       $title = $items[0];
1011     }
1012
1013     // fix for CRM-4044
1014     $url = $encode ? self::urlEncode($items[0]) : $items[0];
1015     return "<a href=\"$url\">$title</a>";
1016   }
1017
1018   /**
1019    * @param string $url
1020    *
1021    * @return null|string
1022    */
1023   public static function urlEncode($url) {
1024     $items = parse_url($url);
1025     if ($items === FALSE) {
1026       return NULL;
1027     }
1028
1029     if (empty($items['query'])) {
1030       return $url;
1031     }
1032
1033     $items['query'] = urlencode($items['query']);
1034
1035     $url = $items['scheme'] . '://';
1036     if (!empty($items['user'])) {
1037       $url .= "{$items['user']}:{$items['pass']}@";
1038     }
1039
1040     $url .= $items['host'];
1041     if (!empty($items['port'])) {
1042       $url .= ":{$items['port']}";
1043     }
1044
1045     $url .= "{$items['path']}?{$items['query']}";
1046     if (!empty($items['fragment'])) {
1047       $url .= "#{$items['fragment']}";
1048     }
1049
1050     return $url;
1051   }
1052
1053   /**
1054    * Return the running civicrm version.
1055    *
1056    * @return string
1057    *   civicrm version
1058    */
1059   public static function version() {
1060     static $version;
1061
1062     if (!$version) {
1063       $verFile = implode(DIRECTORY_SEPARATOR,
1064         array(dirname(__FILE__), '..', '..', 'civicrm-version.php')
1065       );
1066       if (file_exists($verFile)) {
1067         require_once $verFile;
1068         if (function_exists('civicrmVersion')) {
1069           $info = civicrmVersion();
1070           $version = $info['version'];
1071         }
1072       }
1073       else {
1074         // svn installs don't have version.txt by default. In that case version.xml should help -
1075         $verFile = implode(DIRECTORY_SEPARATOR,
1076           array(dirname(__FILE__), '..', '..', 'xml', 'version.xml')
1077         );
1078         if (file_exists($verFile)) {
1079           $str = file_get_contents($verFile);
1080           $xmlObj = simplexml_load_string($str);
1081           $version = (string) $xmlObj->version_no;
1082         }
1083       }
1084
1085       // pattern check
1086       if (!CRM_Utils_System::isVersionFormatValid($version)) {
1087         CRM_Core_Error::fatal('Unknown codebase version.');
1088       }
1089     }
1090
1091     return $version;
1092   }
1093
1094   /**
1095    * Determines whether a string is a valid CiviCRM version string.
1096    *
1097    * @param string $version
1098    *   Version string to be checked.
1099    * @return bool
1100    */
1101   public static function isVersionFormatValid($version) {
1102     return preg_match("/^(\d{1,2}\.){2,3}(\d{1,2}|(alpha|beta)\d{1,2})(\.upgrade)?$/", $version);
1103   }
1104
1105   /**
1106    * Wraps or emulates PHP's getallheaders() function.
1107    */
1108   public static function getAllHeaders() {
1109     if (function_exists('getallheaders')) {
1110       return getallheaders();
1111     }
1112
1113     // emulate get all headers
1114     // http://www.php.net/manual/en/function.getallheaders.php#66335
1115     $headers = array();
1116     foreach ($_SERVER as $name => $value) {
1117       if (substr($name, 0, 5) == 'HTTP_') {
1118         $headers[str_replace(' ',
1119           '-',
1120           ucwords(strtolower(str_replace('_',
1121               ' ',
1122               substr($name, 5)
1123             )
1124           ))
1125         )] = $value;
1126       }
1127     }
1128     return $headers;
1129   }
1130
1131   /**
1132    */
1133   public static function getRequestHeaders() {
1134     if (function_exists('apache_request_headers')) {
1135       return apache_request_headers();
1136     }
1137     else {
1138       return $_SERVER;
1139     }
1140   }
1141
1142   /**
1143    * Determine whether this is an SSL request.
1144    *
1145    * Note that we inline this function in install/civicrm.php, so if you change
1146    * this function, please go and change the code in the install script as well.
1147    */
1148   public static function isSSL() {
1149     return
1150       (isset($_SERVER['HTTPS']) &&
1151         !empty($_SERVER['HTTPS']) &&
1152         strtolower($_SERVER['HTTPS']) != 'off') ? TRUE : FALSE;
1153   }
1154
1155   /**
1156    */
1157   public static function redirectToSSL($abort = FALSE) {
1158     $config = CRM_Core_Config::singleton();
1159     $req_headers = self::getRequestHeaders();
1160     if (CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'enableSSL') &&
1161       !self::isSSL() &&
1162       strtolower(CRM_Utils_Array::value('X_FORWARDED_PROTO', $req_headers)) != 'https'
1163     ) {
1164       // ensure that SSL is enabled on a civicrm url (for cookie reasons etc)
1165       $url = "https://{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}";
1166       if (!self::checkURL($url, TRUE)) {
1167         if ($abort) {
1168           CRM_Core_Error::fatal('HTTPS is not set up on this machine');
1169         }
1170         else {
1171           CRM_Core_Session::setStatus(ts('HTTPS is not set up on this machine'), ts('Warning'), 'alert');
1172           // admin should be the only one following this
1173           // since we dont want the user stuck in a bad place
1174           return;
1175         }
1176       }
1177       CRM_Utils_System::redirect($url);
1178     }
1179   }
1180
1181   /**
1182    * Get logged in user's IP address.
1183    *
1184    * Get IP address from HTTP REMOTE_ADDR header. If the CMS is Drupal then use
1185    * the Drupal function as this also handles reverse proxies (based on proper
1186    * configuration in settings.php)
1187    *
1188    * @param bool $strictIPV4
1189    *   (optional) Whether to return only IPv4 addresses.
1190    *
1191    * @return string
1192    *   IP address of logged in user.
1193    */
1194   public static function ipAddress($strictIPV4 = TRUE) {
1195     $address = CRM_Utils_Array::value('REMOTE_ADDR', $_SERVER);
1196
1197     $config = CRM_Core_Config::singleton();
1198     if ($config->userSystem->is_drupal && function_exists('ip_address')) {
1199       //drupal function handles the server being behind a proxy securely. We still have legacy ipn methods
1200       // that reach this point without bootstrapping hence the check that the fn exists
1201       $address = ip_address();
1202     }
1203
1204     // hack for safari
1205     if ($address == '::1') {
1206       $address = '127.0.0.1';
1207     }
1208
1209     // when we need to have strictly IPV4 ip address
1210     // convert ipV6 to ipV4
1211     if ($strictIPV4) {
1212       // this converts 'IPV4 mapped IPV6 address' to IPV4
1213       if (filter_var($address, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) && strstr($address, '::ffff:')) {
1214         $address = ltrim($address, '::ffff:');
1215       }
1216     }
1217
1218     return $address;
1219   }
1220
1221   /**
1222    * Get the referring / previous page URL.
1223    *
1224    * @return string
1225    *   The previous page URL
1226    */
1227   public static function refererPath() {
1228     return CRM_Utils_Array::value('HTTP_REFERER', $_SERVER);
1229   }
1230
1231   /**
1232    * Get the documentation base URL.
1233    *
1234    * @return string
1235    *   Base URL of the CRM documentation.
1236    */
1237   public static function getDocBaseURL() {
1238     // FIXME: move this to configuration at some stage
1239     return 'http://book.civicrm.org/';
1240   }
1241
1242   /**
1243    * Returns wiki (alternate) documentation URL base.
1244    *
1245    * @return string
1246    *   documentation url
1247    */
1248   public static function getWikiBaseURL() {
1249     // FIXME: move this to configuration at some stage
1250     return 'http://wiki.civicrm.org/confluence/display/CRMDOC/';
1251   }
1252
1253   /**
1254    * Returns URL or link to documentation page, based on provided parameters.
1255    *
1256    * For use in PHP code.
1257    * WARNING: Always returns URL, if ts function is not defined ($URLonly has
1258    * no effect).
1259    *
1260    * @param string $page
1261    *   Title of documentation wiki page.
1262    * @param bool $URLonly
1263    *   (optional) Whether to return URL only or full HTML link (default).
1264    * @param string $text
1265    *   (optional) Text of HTML link (no effect if $URLonly = false).
1266    * @param string $title
1267    *   (optional) Tooltip text for HTML link (no effect if $URLonly = false)
1268    * @param string $style
1269    *   (optional) Style attribute value for HTML link (no effect if $URLonly = false)
1270    *
1271    * @param null $resource
1272    *
1273    * @return string
1274    *   URL or link to documentation page, based on provided parameters.
1275    */
1276   public static function docURL2($page, $URLonly = FALSE, $text = NULL, $title = NULL, $style = NULL, $resource = NULL) {
1277     // if ts function doesn't exist, it means that CiviCRM hasn't been fully initialised yet -
1278     // return just the URL, no matter what other parameters are defined
1279     if (!function_exists('ts')) {
1280       if ($resource == 'wiki') {
1281         $docBaseURL = self::getWikiBaseURL();
1282       }
1283       else {
1284         $docBaseURL = self::getDocBaseURL();
1285       }
1286       return $docBaseURL . str_replace(' ', '+', $page);
1287     }
1288     else {
1289       $params = array(
1290         'page' => $page,
1291         'URLonly' => $URLonly,
1292         'text' => $text,
1293         'title' => $title,
1294         'style' => $style,
1295         'resource' => $resource,
1296       );
1297       return self::docURL($params);
1298     }
1299   }
1300
1301   /**
1302    * Returns URL or link to documentation page, based on provided parameters.
1303    *
1304    * For use in templates code.
1305    *
1306    * @param array $params
1307    *   An array of parameters (see CRM_Utils_System::docURL2 method for names)
1308    *
1309    * @return void|string
1310    *   URL or link to documentation page, based on provided parameters.
1311    */
1312   public static function docURL($params) {
1313
1314     if (!isset($params['page'])) {
1315       return NULL;
1316     }
1317
1318     if (CRM_Utils_Array::value('resource', $params) == 'wiki') {
1319       $docBaseURL = self::getWikiBaseURL();
1320     }
1321     else {
1322       $docBaseURL = self::getDocBaseURL();
1323     }
1324
1325     if (!isset($params['title']) or $params['title'] === NULL) {
1326       $params['title'] = ts('Opens documentation in a new window.');
1327     }
1328
1329     if (!isset($params['text']) or $params['text'] === NULL) {
1330       $params['text'] = ts('(learn more...)');
1331     }
1332
1333     if (!isset($params['style']) || $params['style'] === NULL) {
1334       $style = '';
1335     }
1336     else {
1337       $style = "style=\"{$params['style']}\"";
1338     }
1339
1340     $link = $docBaseURL . str_replace(' ', '+', $params['page']);
1341
1342     if (isset($params['URLonly']) && $params['URLonly'] == TRUE) {
1343       return $link;
1344     }
1345     else {
1346       return "<a href=\"{$link}\" $style target=\"_blank\" class=\"crm-doc-link no-popup\" title=\"{$params['title']}\">{$params['text']}</a>";
1347     }
1348   }
1349
1350   /**
1351    * Get the locale set in the hosting CMS.
1352    *
1353    * @return string
1354    *   The used locale or null for none.
1355    */
1356   public static function getUFLocale() {
1357     $config = CRM_Core_Config::singleton();
1358     return $config->userSystem->getUFLocale();
1359   }
1360
1361   /**
1362    * Execute external or internal URLs and return server response.
1363    *
1364    * @param string $url
1365    *   Request URL.
1366    * @param bool $addCookie
1367    *   Whether to provide a cookie. Should be true to access internal URLs.
1368    *
1369    * @return string
1370    *   Response from URL.
1371    */
1372   public static function getServerResponse($url, $addCookie = TRUE) {
1373     CRM_Core_TemporaryErrorScope::ignoreException();
1374     require_once 'HTTP/Request.php';
1375     $request = new HTTP_Request($url);
1376
1377     if ($addCookie) {
1378       foreach ($_COOKIE as $name => $value) {
1379         $request->addCookie($name, $value);
1380       }
1381     }
1382
1383     if (isset($_SERVER['AUTH_TYPE'])) {
1384       $request->setBasicAuth($_SERVER['PHP_AUTH_USER'], $_SERVER['PHP_AUTH_PW']);
1385     }
1386
1387     $config = CRM_Core_Config::singleton();
1388     if ($config->userFramework == 'WordPress') {
1389       session_write_close();
1390     }
1391
1392     $request->sendRequest();
1393     $response = $request->getResponseBody();
1394
1395     return $response;
1396   }
1397
1398   /**
1399    */
1400   public static function isDBVersionValid(&$errorMessage) {
1401     $dbVersion = CRM_Core_BAO_Domain::version();
1402
1403     if (!$dbVersion) {
1404       // if db.ver missing
1405       $errorMessage = ts('Version information found to be missing in database. You will need to determine the correct version corresponding to your current database state.');
1406       return FALSE;
1407     }
1408     elseif (!CRM_Utils_System::isVersionFormatValid($dbVersion)) {
1409       $errorMessage = ts('Database is marked with invalid version format. You may want to investigate this before you proceed further.');
1410       return FALSE;
1411     }
1412     elseif (stripos($dbVersion, 'upgrade')) {
1413       // if db.ver indicates a partially upgraded db
1414       $upgradeUrl = CRM_Utils_System::url("civicrm/upgrade", "reset=1");
1415       $errorMessage = ts('Database check failed - the database looks to have been partially upgraded. You may want to reload the database with the backup and try the <a href=\'%1\'>upgrade process</a> again.', array(1 => $upgradeUrl));
1416       return FALSE;
1417     }
1418     else {
1419       $codeVersion = CRM_Utils_System::version();
1420
1421       // if db.ver < code.ver, time to upgrade
1422       if (version_compare($dbVersion, $codeVersion) < 0) {
1423         $upgradeUrl = CRM_Utils_System::url("civicrm/upgrade", "reset=1");
1424         $errorMessage = ts('New codebase version detected. You might want to visit <a href=\'%1\'>upgrade screen</a> to upgrade the database.', array(1 => $upgradeUrl));
1425         return FALSE;
1426       }
1427
1428       // if db.ver > code.ver, sth really wrong
1429       if (version_compare($dbVersion, $codeVersion) > 0) {
1430         $errorMessage = '<p>' . ts('Your database is marked with an unexpected version number: %1. The v%2 codebase may not be compatible with your database state. You will need to determine the correct version corresponding to your current database state. You may want to revert to the codebase you were using until you resolve this problem.',
1431             array(1 => $dbVersion, 2 => $codeVersion)
1432           ) . '</p>';
1433         $errorMessage .= "<p>" . ts('OR if this is a manual install from git, you might want to fix civicrm-version.php file.') . "</p>";
1434         return FALSE;
1435       }
1436     }
1437     // FIXME: there should be another check to make sure version is in valid format - X.Y.alpha_num
1438
1439     return TRUE;
1440   }
1441
1442   /**
1443    * Exit with provided exit code.
1444    *
1445    * @param int $status
1446    *   (optional) Code with which to exit.
1447    */
1448   public static function civiExit($status = 0) {
1449     // move things to CiviCRM cache as needed
1450     CRM_Core_Session::storeSessionObjects();
1451
1452     exit($status);
1453   }
1454
1455   /**
1456    * Reset the various system caches and some important static variables.
1457    */
1458   public static function flushCache() {
1459     // flush out all cache entries so we can reload new data
1460     // a bit aggressive, but livable for now
1461     $cache = CRM_Utils_Cache::singleton();
1462     $cache->flush();
1463
1464     // also reset the various static memory caches
1465
1466     // reset the memory or array cache
1467     CRM_Core_BAO_Cache::deleteGroup('contact fields', NULL, FALSE);
1468
1469     // reset ACL cache
1470     CRM_ACL_BAO_Cache::resetCache();
1471
1472     // reset various static arrays used here
1473     CRM_Contact_BAO_Contact::$_importableFields = CRM_Contact_BAO_Contact::$_exportableFields
1474       = CRM_Contribute_BAO_Contribution::$_importableFields
1475         = CRM_Contribute_BAO_Contribution::$_exportableFields
1476           = CRM_Pledge_BAO_Pledge::$_exportableFields = CRM_Contribute_BAO_Query::$_contributionFields
1477             = CRM_Core_BAO_CustomField::$_importFields
1478               = CRM_Core_BAO_Cache::$_cache = CRM_Core_DAO::$_dbColumnValueCache = NULL;
1479
1480     CRM_Core_OptionGroup::flushAll();
1481     CRM_Utils_PseudoConstant::flushAll();
1482   }
1483
1484   /**
1485    * Load CMS bootstrap.
1486    *
1487    * @param array $params
1488    *   Array with uid name and pass
1489    * @param bool $loadUser
1490    *   Boolean load user or not.
1491    * @param bool $throwError
1492    * @param $realPath
1493    */
1494   public static function loadBootStrap($params = array(), $loadUser = TRUE, $throwError = TRUE, $realPath = NULL) {
1495     if (!is_array($params)) {
1496       $params = array();
1497     }
1498     $config = CRM_Core_Config::singleton();
1499     return $config->userSystem->loadBootStrap($params, $loadUser, $throwError, $realPath);
1500   }
1501
1502   /**
1503    * Check if user is logged in.
1504    *
1505    * @return bool
1506    */
1507   public static function isUserLoggedIn() {
1508     $config = CRM_Core_Config::singleton();
1509     return $config->userSystem->isUserLoggedIn();
1510   }
1511
1512   /**
1513    * Get current logged in user id.
1514    *
1515    * @return int
1516    *   ufId, currently logged in user uf id.
1517    */
1518   public static function getLoggedInUfID() {
1519     $config = CRM_Core_Config::singleton();
1520     return $config->userSystem->getLoggedInUfID();
1521   }
1522
1523   /**
1524    */
1525   public static function baseCMSURL() {
1526     static $_baseURL = NULL;
1527     if (!$_baseURL) {
1528       $config = CRM_Core_Config::singleton();
1529       $_baseURL = $userFrameworkBaseURL = $config->userFrameworkBaseURL;
1530
1531       if ($config->userFramework == 'Joomla') {
1532         // gross hack
1533         // we need to remove the administrator/ from the end
1534         $_baseURL = str_replace("/administrator/", "/", $userFrameworkBaseURL);
1535       }
1536       else {
1537         // Drupal setting
1538         global $civicrm_root;
1539         if (strpos($civicrm_root,
1540             DIRECTORY_SEPARATOR . 'sites' .
1541             DIRECTORY_SEPARATOR . 'all' .
1542             DIRECTORY_SEPARATOR . 'modules'
1543           ) === FALSE
1544         ) {
1545           $startPos = strpos($civicrm_root,
1546             DIRECTORY_SEPARATOR . 'sites' . DIRECTORY_SEPARATOR
1547           );
1548           $endPos = strpos($civicrm_root,
1549             DIRECTORY_SEPARATOR . 'modules' . DIRECTORY_SEPARATOR
1550           );
1551           if ($startPos && $endPos) {
1552             // if component is in sites/SITENAME/modules
1553             $siteName = substr($civicrm_root,
1554               $startPos + 7,
1555               $endPos - $startPos - 7
1556             );
1557
1558             $_baseURL = $userFrameworkBaseURL . "sites/$siteName/";
1559           }
1560         }
1561       }
1562     }
1563     return $_baseURL;
1564   }
1565
1566   /**
1567    * Given a URL, return a relative URL if possible.
1568    *
1569    * @param string $url
1570    * @return string
1571    */
1572   public static function relativeURL($url) {
1573     // check if url is relative, if so return immediately
1574     if (substr($url, 0, 4) != 'http') {
1575       return $url;
1576     }
1577
1578     // make everything relative from the baseFilePath
1579     $baseURL = self::baseCMSURL();
1580
1581     // check if baseURL is a substr of $url, if so
1582     // return rest of string
1583     if (substr($url, 0, strlen($baseURL)) == $baseURL) {
1584       return substr($url, strlen($baseURL));
1585     }
1586
1587     // return the original value
1588     return $url;
1589   }
1590
1591   /**
1592    * Produce an absolute URL from a possibly-relative URL.
1593    *
1594    * @param string $url
1595    * @param bool $removeLanguagePart
1596    *
1597    * @return string
1598    */
1599   public static function absoluteURL($url, $removeLanguagePart = FALSE) {
1600     // check if url is already absolute, if so return immediately
1601     if (substr($url, 0, 4) == 'http') {
1602       return $url;
1603     }
1604
1605     // make everything absolute from the baseFileURL
1606     $baseURL = self::baseCMSURL();
1607
1608     //CRM-7622: drop the language from the URL if requested (and it’s there)
1609     $config = CRM_Core_Config::singleton();
1610     if ($removeLanguagePart) {
1611       $baseURL = self::languageNegotiationURL($baseURL, FALSE, TRUE);
1612     }
1613
1614     return $baseURL . $url;
1615   }
1616
1617   /**
1618    * Clean url, replaces first '&' with '?'
1619    *
1620    * @param string $url
1621    *
1622    * @return string
1623    *   , clean url
1624    */
1625   public static function cleanUrl($url) {
1626     if (!$url) {
1627       return NULL;
1628     }
1629
1630     if ($pos = strpos($url, '&')) {
1631       $url = substr_replace($url, '?', $pos, 1);
1632     }
1633
1634     return $url;
1635   }
1636
1637   /**
1638    * Format the url as per language Negotiation.
1639    *
1640    * @param string $url
1641    *
1642    * @param bool $addLanguagePart
1643    * @param bool $removeLanguagePart
1644    *
1645    * @return string
1646    *   , formatted url.
1647    */
1648   public static function languageNegotiationURL(
1649     $url,
1650     $addLanguagePart = TRUE,
1651     $removeLanguagePart = FALSE
1652   ) {
1653     $config = &CRM_Core_Config::singleton();
1654     return $config->userSystem->languageNegotiationURL($url, $addLanguagePart, $removeLanguagePart);
1655   }
1656
1657   /**
1658    * Append the contents of an 'extra' smarty template file if it is present in
1659    * the custom template directory. This does not work if there are
1660    * multiple custom template directories
1661    *
1662    * @param string $fileName
1663    *   The name of the tpl file that we are processing.
1664    * @param string $content
1665    *   The current content string. May be modified by this function.
1666    * @param string $overideFileName
1667    *   (optional) Sent by contribution/event reg/profile pages which uses a id
1668    *   specific extra file name if present.
1669    */
1670   public static function appendTPLFile(
1671     $fileName,
1672     &$content,
1673     $overideFileName = NULL
1674   ) {
1675     $template = CRM_Core_Smarty::singleton();
1676     if ($overideFileName) {
1677       $additionalTPLFile = $overideFileName;
1678     }
1679     else {
1680       $additionalTPLFile = str_replace('.tpl', '.extra.tpl', $fileName);
1681     }
1682
1683     if ($template->template_exists($additionalTPLFile)) {
1684       $content .= $template->fetch($additionalTPLFile);
1685     }
1686   }
1687
1688   /**
1689    * Get a list of all files that are found within the directories
1690    * that are the result of appending the provided relative path to
1691    * each component of the PHP include path.
1692    *
1693    * @author Ken Zalewski
1694    *
1695    * @param string $relpath
1696    *   A relative path, typically pointing to a directory with multiple class
1697    *   files.
1698    *
1699    * @return array
1700    *   An array of files that exist in one or more of the directories that are
1701    *   referenced by the relative path when appended to each element of the PHP
1702    *   include path.
1703    */
1704   public static function listIncludeFiles($relpath) {
1705     $file_list = array();
1706     $inc_dirs = explode(PATH_SEPARATOR, get_include_path());
1707     foreach ($inc_dirs as $inc_dir) {
1708       $target_dir = $inc_dir . DIRECTORY_SEPARATOR . $relpath;
1709       if (is_dir($target_dir)) {
1710         $cur_list = scandir($target_dir);
1711         foreach ($cur_list as $fname) {
1712           if ($fname != '.' && $fname != '..') {
1713             $file_list[$fname] = $fname;
1714           }
1715         }
1716       }
1717     }
1718     return $file_list;
1719   }
1720   // listIncludeFiles()
1721
1722   /**
1723    * Get a list of all "plugins" (PHP classes that implement a piece of
1724    * functionality using a well-defined interface) that are found in a
1725    * particular CiviCRM directory (both custom and core are searched).
1726    *
1727    * @author Ken Zalewski
1728    *
1729    * @param string $relpath
1730    *   A relative path referencing a directory that contains one or more
1731    *   plugins.
1732    * @param string $fext
1733    *   (optional) Only files with this extension will be considered to be
1734    *   plugins.
1735    * @param array $skipList
1736    *   (optional) List of files to skip.
1737    *
1738    * @return array
1739    *   List of plugins, where the plugin name is both the key and the value of
1740    *   each element.
1741    */
1742   public static function getPluginList($relpath, $fext = '.php', $skipList = array()) {
1743     $fext_len = strlen($fext);
1744     $plugins = array();
1745     $inc_files = CRM_Utils_System::listIncludeFiles($relpath);
1746     foreach ($inc_files as $inc_file) {
1747       if (substr($inc_file, 0 - $fext_len) == $fext) {
1748         $plugin_name = substr($inc_file, 0, 0 - $fext_len);
1749         if (!in_array($plugin_name, $skipList)) {
1750           $plugins[$plugin_name] = $plugin_name;
1751         }
1752       }
1753     }
1754     return $plugins;
1755   }
1756   // getPluginList()
1757
1758   /**
1759    */
1760   public static function executeScheduledJobs() {
1761     $facility = new CRM_Core_JobManager();
1762     $facility->execute(FALSE);
1763
1764     $redirectUrl = self::url('civicrm/admin/job', 'reset=1');
1765
1766     CRM_Core_Session::setStatus(
1767       ts('Scheduled jobs have been executed according to individual timing settings. Please check log for messages.'),
1768       ts('Complete'), 'success');
1769
1770     CRM_Utils_System::redirect($redirectUrl);
1771   }
1772
1773   /**
1774    * Evaluate any tokens in a URL.
1775    *
1776    * @param string|FALSE $url
1777    * @return string|FALSE
1778    */
1779   public static function evalUrl($url) {
1780     if ($url === FALSE) {
1781       return FALSE;
1782     }
1783     else {
1784       $config = CRM_Core_Config::singleton();
1785       $vars = array(
1786         '{ver}' => CRM_Utils_System::version(),
1787         '{uf}' => $config->userFramework,
1788         '{php}' => phpversion(),
1789         '{sid}' => md5('sid_' . (defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY : '') . '_' . $config->userFrameworkBaseURL),
1790         '{baseUrl}' => $config->userFrameworkBaseURL,
1791         '{lang}' => $config->lcMessages,
1792         '{co}' => $config->defaultContactCountry,
1793       );
1794       foreach (array_keys($vars) as $k) {
1795         $vars[$k] = urlencode($vars[$k]);
1796       }
1797       return strtr($url, $vars);
1798     }
1799   }
1800
1801
1802   /**
1803    * Determine whether this is a developmental system.
1804    *
1805    * @return bool
1806    */
1807   public static function isDevelopment() {
1808     static $cache = NULL;
1809     if ($cache === NULL) {
1810       global $civicrm_root;
1811       $cache = file_exists("{$civicrm_root}/.svn") || file_exists("{$civicrm_root}/.git");
1812     }
1813     return $cache;
1814   }
1815
1816   /**
1817    * @return bool
1818    */
1819   public static function isInUpgradeMode() {
1820     $args = explode('/', $_GET['q']);
1821     $upgradeInProcess = CRM_Core_Session::singleton()->get('isUpgradePending');
1822     if ((isset($args[1]) && $args[1] == 'upgrade') || $upgradeInProcess) {
1823       return TRUE;
1824     }
1825     else {
1826       return FALSE;
1827     }
1828   }
1829
1830   /**
1831    * Determine the standard URL for viewing or editing the specified link.
1832    *
1833    * This function delegates the decision-making to (a) the hook system and
1834    * (b) the BAO system.
1835    *
1836    * @param array $crudLinkSpec
1837    *   With keys:.
1838    *   - action: int, CRM_Core_Action::UPDATE or CRM_Core_Action::VIEW [default: VIEW]
1839    *   - entity_table: string, eg "civicrm_contact"
1840    *   - entity_id: int
1841    * @return array|NULL
1842    *   NULL if unavailable, or an array. array has keys:
1843    *   - path: string
1844    *   - query: array
1845    *   - title: string
1846    *   - url: string
1847    */
1848   public static function createDefaultCrudLink($crudLinkSpec) {
1849     $crudLinkSpec['action'] = CRM_Utils_Array::value('action', $crudLinkSpec, CRM_Core_Action::VIEW);
1850     $daoClass = CRM_Core_DAO_AllCoreTables::getClassForTable($crudLinkSpec['entity_table']);
1851     if (!$daoClass) {
1852       return NULL;
1853     }
1854
1855     $baoClass = str_replace('_DAO_', '_BAO_', $daoClass);
1856     if (!class_exists($baoClass)) {
1857       return NULL;
1858     }
1859
1860     $bao = new $baoClass();
1861     $bao->id = $crudLinkSpec['entity_id'];
1862     if (!$bao->find(TRUE)) {
1863       return NULL;
1864     }
1865
1866     $link = array();
1867     CRM_Utils_Hook::crudLink($crudLinkSpec, $bao, $link);
1868     if (empty($link) && is_callable(array($bao, 'createDefaultCrudLink'))) {
1869       $link = $bao->createDefaultCrudLink($crudLinkSpec);
1870     }
1871
1872     if (!empty($link)) {
1873       if (!isset($link['url'])) {
1874         $link['url'] = self::url($link['path'], $link['query'], TRUE, NULL, FALSE);
1875       }
1876       return $link;
1877     }
1878
1879     return NULL;
1880   }
1881
1882 }