3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
30 * Given an argument list, invoke the appropriate CRM function
31 * Serves as a wrapper between the UserFrameWork and Core CRM
34 * @copyright CiviCRM LLC (c) 2004-2017
36 class CRM_Core_Invoke
{
39 * This is the main front-controller that integrates with the CMS. Any
40 * page-request that is sent to the CMS and intended for CiviCRM should
41 * be processed by invoke().
44 * The parts of the URL which identify the intended CiviCRM page
45 * (e.g. array('civicrm', 'event', 'register')).
47 * HTML. For non-HTML content, invoke() may call print() and exit().
50 public static function invoke($args) {
52 return self
::_invoke($args);
54 catch (Exception
$e) {
55 CRM_Core_Error
::handleUnhandledException($e);
60 * This is the same as invoke(), but it does *not* include exception
64 * The parts of the URL which identify the intended CiviCRM page
65 * (e.g. array('civicrm', 'event', 'register')).
67 * HTML. For non-HTML content, invoke() may call print() and exit().
69 public static function _invoke($args) {
70 if ($args[0] !== 'civicrm') {
73 // CRM-15901: Turn off PHP errors display for all ajax calls
74 if (CRM_Utils_Array
::value(1, $args) == 'ajax' || CRM_Utils_Array
::value('snippet', $_REQUEST)) {
75 ini_set('display_errors', 0);
78 if (!defined('CIVICRM_SYMFONY_PATH')) {
79 // Traditional Civi invocation path
80 self
::hackMenuRebuild($args); // may exit
82 self
::hackStandalone($args);
83 $item = self
::getItem($args);
84 return self
::runItem($item);
87 // Symfony-based invocation path
88 require_once CIVICRM_SYMFONY_PATH
. '/app/bootstrap.php.cache';
89 require_once CIVICRM_SYMFONY_PATH
. '/app/AppKernel.php';
90 $kernel = new AppKernel('dev', TRUE);
91 $kernel->loadClassCache();
92 $response = $kernel->handle(Symfony\Component\HttpFoundation\Request
::createFromGlobals());
93 if (preg_match(':^text/html:', $response->headers
->get('Content-Type'))) {
94 // let the CMS handle the trappings
95 return $response->getContent();
105 * Hackish support /civicrm/menu/rebuild
108 * List of path parts.
111 static public function hackMenuRebuild($args) {
112 if (array('civicrm', 'menu', 'rebuild') == $args ||
array('civicrm', 'clearcache') == $args) {
113 // ensure that the user has a good privilege level
114 if (CRM_Core_Permission
::check('administer CiviCRM')) {
115 self
::rebuildMenuAndCaches();
116 CRM_Core_Session
::setStatus(ts('Cleared all CiviCRM caches (database, menu, templates)'), ts('Complete'), 'success');
117 return CRM_Utils_System
::redirect(); // exits
120 CRM_Core_Error
::fatal('You do not have permission to execute this url');
126 * Perform general setup.
129 * List of path parts.
132 static public function init($args) {
133 // first fire up IDS and check for bad stuff
134 $config = CRM_Core_Config
::singleton();
135 if (!CRM_Core_Permission
::check('skip IDS check')) {
136 $ids = new CRM_Core_IDS();
140 // also initialize the i18n framework
141 require_once 'CRM/Core/I18n.php';
142 $i18n = CRM_Core_I18n
::singleton();
146 * Hackish support for /standalone/*
149 * List of path parts.
152 static public function hackStandalone($args) {
153 $config = CRM_Core_Config
::singleton();
154 if ($config->userFramework
== 'Standalone') {
155 $session = CRM_Core_Session
::singleton();
156 if ($session->get('new_install') !== TRUE) {
157 CRM_Core_Standalone
::sidebarLeft();
159 elseif ($args[1] == 'standalone' && $args[2] == 'register') {
160 CRM_Core_Menu
::store();
166 * Determine which menu $item corresponds to $args
169 * List of path parts.
170 * @return array; see CRM_Core_Menu
172 static public function getItem($args) {
173 if (is_array($args)) {
174 // get the menu items
175 $path = implode('/', $args);
180 $item = CRM_Core_Menu
::get($path);
182 // we should try to compute menus, if item is empty and stay on the same page,
183 // rather than compute and redirect to dashboard.
185 CRM_Core_Menu
::store(FALSE);
186 $item = CRM_Core_Menu
::get($path);
193 * Given a menu item, call the appropriate controller and return the response
197 * @return string, HTML
199 static public function runItem($item) {
200 $config = CRM_Core_Config
::singleton();
201 if ($config->userFramework
== 'Joomla' && $item) {
202 $config->userFrameworkURLVar
= 'task';
204 // joomla 1.5RC1 seems to push this in the POST variable, which messes
206 unset($_POST['option']);
207 CRM_Core_Joomla
::sidebarLeft();
210 // set active Component
211 $template = CRM_Core_Smarty
::singleton();
212 $template->assign('activeComponent', 'CiviCRM');
213 $template->assign('formTpl', 'default');
216 // CRM-7656 - make sure we send a clean sanitized path to create printer friendly url
217 $printerFriendly = CRM_Utils_System
::makeURL(
218 'snippet', FALSE, FALSE,
219 CRM_Utils_Array
::value('path', $item)
221 $template->assign('printerFriendly', $printerFriendly);
223 if (!array_key_exists('page_callback', $item)) {
224 CRM_Core_Error
::debug('Bad item', $item);
225 CRM_Core_Error
::fatal(ts('Bad menu record in database'));
228 // check that we are permissioned to access this page
229 if (!CRM_Core_Permission
::checkMenuItem($item)) {
230 CRM_Utils_System
::permissionDenied();
234 // check if ssl is set
235 if (!empty($item['is_ssl'])) {
236 CRM_Utils_System
::redirectToSSL();
239 if (isset($item['title'])) {
240 CRM_Utils_System
::setTitle($item['title']);
243 if (isset($item['breadcrumb']) && !isset($item['is_public'])) {
244 CRM_Utils_System
::appendBreadCrumb($item['breadcrumb']);
248 if (!empty($item['page_arguments'])) {
249 $pageArgs = CRM_Core_Menu
::getArrayForPathArgs($item['page_arguments']);
252 $template = CRM_Core_Smarty
::singleton();
253 if (!empty($item['is_public'])) {
254 $template->assign('urlIsPublic', TRUE);
257 $template->assign('urlIsPublic', FALSE);
258 self
::statusCheck($template);
261 if (isset($item['return_url'])) {
262 $session = CRM_Core_Session
::singleton();
263 $args = CRM_Utils_Array
::value(
268 $session->pushUserContext(CRM_Utils_System
::url($item['return_url'], $args));
272 // WISHLIST: Refactor this. Instead of pattern-matching on page_callback, lookup
273 // page_callback via Civi\Core\Resolver and check the implemented interfaces. This
274 // would require rethinking the default constructor.
275 if (is_array($item['page_callback']) ||
strpos($item['page_callback'], ':')) {
276 $result = call_user_func(Civi\Core\Resolver
::singleton()->get($item['page_callback']));
278 elseif (strstr($item['page_callback'], '_Form')) {
279 $wrapper = new CRM_Utils_Wrapper();
280 $result = $wrapper->run(
281 CRM_Utils_Array
::value('page_callback', $item),
282 CRM_Utils_Array
::value('title', $item),
283 isset($pageArgs) ?
$pageArgs : NULL
287 $newArgs = explode('/', $_GET[$config->userFrameworkURLVar
]);
289 if (isset($pageArgs['mode'])) {
290 $mode = $pageArgs['mode'];
291 unset($pageArgs['mode']);
293 $title = CRM_Utils_Array
::value('title', $item);
294 if (strstr($item['page_callback'], '_Page') ||
strstr($item['page_callback'], '\\Page\\')) {
295 $object = new $item['page_callback']($title, $mode);
296 $object->urlPath
= explode('/', $_GET[$config->userFrameworkURLVar
]);
298 elseif (strstr($item['page_callback'], '_Controller') ||
strstr($item['page_callback'], '\\Controller\\')) {
299 $addSequence = 'false';
300 if (isset($pageArgs['addSequence'])) {
301 $addSequence = $pageArgs['addSequence'];
302 $addSequence = $addSequence ?
'true' : 'false';
303 unset($pageArgs['addSequence']);
305 $object = new $item['page_callback']($title, TRUE, $mode, NULL, $addSequence);
308 CRM_Core_Error
::fatal();
310 $result = $object->run($newArgs, $pageArgs);
313 CRM_Core_Session
::storeSessionObjects();
317 CRM_Core_Menu
::store();
318 CRM_Core_Session
::setStatus(ts('Menu has been rebuilt'), ts('Complete'), 'success');
319 return CRM_Utils_System
::redirect();
323 * This function contains the default action.
327 * @param $contact_type
328 * @param $contact_sub_type
331 public static function form($action, $contact_type, $contact_sub_type) {
332 CRM_Utils_System
::setUserContext(array('civicrm/contact/search/basic', 'civicrm/contact/view'));
333 $wrapper = new CRM_Utils_Wrapper();
335 $properties = CRM_Core_Component
::contactSubTypeProperties($contact_sub_type, 'Edit');
337 $wrapper->run($properties['class'], ts('New %1', array(1 => $contact_sub_type)), $action, TRUE);
340 $wrapper->run('CRM_Contact_Form_Contact', ts('New Contact'), $action, TRUE);
345 * Show status in the footer (admin only)
347 * @param CRM_Core_Smarty $template
349 public static function statusCheck($template) {
350 if (CRM_Core_Config
::isUpgradeMode() ||
!CRM_Core_Permission
::check('administer CiviCRM')) {
353 // always use cached results - they will be refreshed by the session timer
354 $status = Civi
::settings()->get('systemStatusCheckResult');
355 $template->assign('footer_status_severity', $status);
356 $template->assign('footer_status_message', CRM_Utils_Check
::toStatusLabel($status));
360 * @param bool $triggerRebuild
361 * @param bool $sessionReset
365 public static function rebuildMenuAndCaches($triggerRebuild = FALSE, $sessionReset = FALSE) {
366 $config = CRM_Core_Config
::singleton();
367 $config->clearModuleList();
369 // also cleanup all caches
370 $config->cleanupCaches($sessionReset || CRM_Utils_Request
::retrieve('sessionReset', 'Boolean', CRM_Core_DAO
::$_nullObject, FALSE, 0, 'GET'));
372 CRM_Core_Menu
::store();
374 // also reset navigation
375 CRM_Core_BAO_Navigation
::resetNavigation();
377 // also cleanup module permissions
378 $config->cleanupPermissions();
380 // rebuild word replacement cache - pass false to prevent operations redundant with this fn
381 CRM_Core_BAO_WordReplacement
::rebuild(FALSE);
383 Civi
::service('settings_manager')->flush();
385 CRM_Core_Resources
::singleton()->flushStrings()->resetCacheCode();
386 CRM_Case_XMLRepository
::singleton(TRUE);
388 // also rebuild triggers if requested explicitly
391 CRM_Utils_Request
::retrieve('triggerRebuild', 'Boolean', CRM_Core_DAO
::$_nullObject, FALSE, 0, 'GET')
393 CRM_Core_DAO
::triggerRebuild();
395 CRM_Core_DAO_AllCoreTables
::reinitializeCache(TRUE);
396 CRM_Core_ManagedEntities
::singleton(TRUE)->reconcile();
398 //CRM-16257 update Config.IDS.ini might be an old copy
399 CRM_Core_IDS
::createConfigFile(TRUE);