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