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