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