CRM/Utils/System.php

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