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