CRM/Utils/System.php

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