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