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