3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.5 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2014 |
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-2014
38 class CRM_Core_Invoke
{
41 * This is the main function that is called on every click action and based on the argument
42 * respective functions are called
44 * @param $args array this array contains the arguments of the url
45 * @return string, HTML
50 static function invoke($args) {
52 return self
::_invoke($args);
55 catch (Exception
$e) {
56 return CRM_Core_Error
::handleUnhandledException($e);
60 protected static function _invoke($args) {
61 if ($args[0] !== 'civicrm') {
65 if (!defined('CIVICRM_SYMFONY_PATH')) {
67 // Traditional Civi invocation path
68 self
::hackMenuRebuild($args); // may exit
70 self
::hackStandalone($args);
71 $item = self
::getItem($args);
72 return self
::runItem($item);
74 catch (CRM_Core_EXCEPTION
$e) {
75 $params = $e->getErrorData();
76 $message = $e->getMessage();
77 if (isset($params['legacy_status_bounce'])) {
78 //@todo remove this- see comments on
79 //https://github.com/eileenmcnaughton/civicrm-core/commit/ae686b09e2c987091612bb25ba0a58e520a203e7
80 CRM_Core_Error
::statusBounce($params['message']);
83 $session = CRM_Core_Session
::singleton();
86 CRM_Utils_Array
::value('message_title', $params),
87 CRM_Utils_Array
::value('message_type', $params, 'error')
90 // @todo remove this code - legacy redirect path is an interim measure for moving redirects out of BAO
91 // to somewhere slightly more acceptable. they should not be part of the exception class & should
92 // be managed @ the form level - if you find a form that is triggering this piece of code
93 // you should log a ticket for it to be removed with details about the form you were on.
94 if(!empty($params['legacy_redirect_path'])) {
95 if(CRM_Utils_System
::isDevelopment()) {
96 // here we could set a message telling devs to log it per above
98 CRM_Utils_System
::redirect($params['legacy_redirect_path'], $params['legacy_redirect_query']);
102 catch (Exception
$e) {
103 // Recall: CRM_Core_Config is initialized before calling CRM_Core_Invoke
104 $config = CRM_Core_Config
::singleton();
105 return CRM_Core_Error
::handleUnhandledException($e);
107 if ($config->backtrace) {
108 return CRM_Core_Error::formatHtmlException($e);
114 // Symfony-based invocation path
115 require_once CIVICRM_SYMFONY_PATH
. '/app/bootstrap.php.cache';
116 require_once CIVICRM_SYMFONY_PATH
. '/app/AppKernel.php';
117 $kernel = new AppKernel('dev', true);
118 $kernel->loadClassCache();
119 $response = $kernel->handle(Symfony\Component\HttpFoundation\Request
::createFromGlobals());
120 if (preg_match(':^text/html:', $response->headers
->get('Content-Type'))) {
121 // let the CMS handle the trappings
122 return $response->getContent();
130 * Hackish support /civicrm/menu/rebuild
132 * @param array $args list of path parts
135 static public function hackMenuRebuild($args) {
136 if (array('civicrm','menu','rebuild') == $args ||
array('civicrm', 'clearcache') == $args) {
137 // ensure that the user has a good privilege level
138 if (CRM_Core_Permission
::check('administer CiviCRM')) {
139 self
::rebuildMenuAndCaches();
140 CRM_Core_Session
::setStatus(ts('Cleared all CiviCRM caches (database, menu, templates)'), ts('Complete'), 'success');
141 return CRM_Utils_System
::redirect(); // exits
144 CRM_Core_Error
::fatal('You do not have permission to execute this url');
150 * Perform general setup
152 * @param array $args list of path parts
155 static public function init($args) {
156 // first fire up IDS and check for bad stuff
157 $config = CRM_Core_Config
::singleton();
158 if (!CRM_Core_Permission
::check('skip IDS check')) {
159 $ids = new CRM_Core_IDS();
163 // also initialize the i18n framework
164 require_once 'CRM/Core/I18n.php';
165 $i18n = CRM_Core_I18n
::singleton();
169 * Hackish support for /standalone/*
171 * @param array $args list of path parts
174 static public function hackStandalone($args) {
175 $config = CRM_Core_Config
::singleton();
176 if ($config->userFramework
== 'Standalone') {
177 $session = CRM_Core_Session
::singleton();
178 if ($session->get('new_install') !== TRUE) {
179 CRM_Core_Standalone
::sidebarLeft();
181 elseif ($args[1] == 'standalone' && $args[2] == 'register') {
182 CRM_Core_Menu
::store();
188 * Determine which menu $item corresponds to $args
190 * @param array $args list of path parts
191 * @return array; see CRM_Core_Menu
193 static public function getItem($args) {
194 if (is_array($args)) {
195 // get the menu items
196 $path = implode('/', $args);
200 $item = CRM_Core_Menu
::get($path);
202 // we should try to compute menus, if item is empty and stay on the same page,
203 // rather than compute and redirect to dashboard.
205 CRM_Core_Menu
::store(FALSE);
206 $item = CRM_Core_Menu
::get($path);
213 * Given a menu item, call the appropriate controller and return the response
215 * @param array $item see CRM_Core_Menu
216 * @return string, HTML
218 static public function runItem($item) {
219 $config = CRM_Core_Config
::singleton();
220 if ($config->userFramework
== 'Joomla' && $item) {
221 $config->userFrameworkURLVar
= 'task';
223 // joomla 1.5RC1 seems to push this in the POST variable, which messes
225 unset($_POST['option']);
226 CRM_Core_Joomla
::sidebarLeft();
229 // set active Component
230 $template = CRM_Core_Smarty
::singleton();
231 $template->assign('activeComponent', 'CiviCRM');
232 $template->assign('formTpl', 'default');
235 // CRM-7656 - make sure we send a clean sanitized path to create printer friendly url
236 $printerFriendly = CRM_Utils_System
::makeURL(
237 'snippet', FALSE, FALSE,
238 CRM_Utils_Array
::value('path', $item)
240 $template->assign('printerFriendly', $printerFriendly);
242 if (!array_key_exists('page_callback', $item)) {
243 CRM_Core_Error
::debug('Bad item', $item);
244 CRM_Core_Error
::fatal(ts('Bad menu record in database'));
247 // check that we are permissioned to access this page
248 if (!CRM_Core_Permission
::checkMenuItem($item)) {
249 CRM_Utils_System
::permissionDenied();
253 // check if ssl is set
254 if (!empty($item['is_ssl'])) {
255 CRM_Utils_System
::redirectToSSL();
258 if (isset($item['title'])) {
259 CRM_Utils_System
::setTitle($item['title']);
262 if (isset($item['breadcrumb']) && !isset($item['is_public'])) {
263 foreach ($item['breadcrumb'] as &$breadcrumb) {
264 $breadcrumb['url'] = CRM_Utils_System
::url($breadcrumb['url']);
266 CRM_Utils_System
::appendBreadCrumb($item['breadcrumb']);
270 if (!empty($item['page_arguments'])) {
271 $pageArgs = CRM_Core_Menu
::getArrayForPathArgs($item['page_arguments']);
274 $template = CRM_Core_Smarty
::singleton();
275 if (!empty($item['is_public'])) {
276 $template->assign('urlIsPublic', TRUE);
279 $template->assign('urlIsPublic', FALSE);
280 self
::versionCheck($template);
283 if (isset($item['return_url'])) {
284 $session = CRM_Core_Session
::singleton();
285 $args = CRM_Utils_Array
::value(
290 $session->pushUserContext(CRM_Utils_System
::url($item['return_url'], $args));
294 if (is_array($item['page_callback'])) {
295 require_once (str_replace('_', DIRECTORY_SEPARATOR
, $item['page_callback'][0]) . '.php');
296 $result = call_user_func($item['page_callback']);
298 elseif (strstr($item['page_callback'], '_Form')) {
299 $wrapper = new CRM_Utils_Wrapper();
300 $result = $wrapper->run(
301 CRM_Utils_Array
::value('page_callback', $item),
302 CRM_Utils_Array
::value('title', $item),
303 isset($pageArgs) ?
$pageArgs : NULL
307 $newArgs = explode('/', $_GET[$config->userFrameworkURLVar
]);
308 require_once (str_replace('_', DIRECTORY_SEPARATOR
, $item['page_callback']) . '.php');
310 if (isset($pageArgs['mode'])) {
311 $mode = $pageArgs['mode'];
312 unset($pageArgs['mode']);
314 $title = CRM_Utils_Array
::value('title', $item);
315 if (strstr($item['page_callback'], '_Page')) {
316 $object = new $item['page_callback'] ($title, $mode );
317 $object->urlPath
= explode('/', $_GET[$config->userFrameworkURLVar
]);
319 elseif (strstr($item['page_callback'], '_Controller')) {
320 $addSequence = 'false';
321 if (isset($pageArgs['addSequence'])) {
322 $addSequence = $pageArgs['addSequence'];
323 $addSequence = $addSequence ?
'true' : 'false';
324 unset($pageArgs['addSequence']);
326 $object = new $item['page_callback'] ($title, true, $mode, null, $addSequence );
329 CRM_Core_Error
::fatal();
331 $result = $object->run($newArgs, $pageArgs);
334 CRM_Core_Session
::storeSessionObjects();
338 CRM_Core_Menu
::store();
339 CRM_Core_Session
::setStatus(ts('Menu has been rebuilt'), ts('Complete'), 'success');
340 return CRM_Utils_System
::redirect();
344 * This function contains the default action
351 static function form($action, $contact_type, $contact_sub_type) {
352 CRM_Utils_System
::setUserContext(array('civicrm/contact/search/basic', 'civicrm/contact/view'));
353 $wrapper = new CRM_Utils_Wrapper();
355 $properties = CRM_Core_Component
::contactSubTypeProperties($contact_sub_type, 'Edit');
357 $wrapper->run($properties['class'], ts('New %1', array(1 => $contact_sub_type)), $action, TRUE);
360 $wrapper->run('CRM_Contact_Form_Contact', ts('New Contact'), $action, TRUE);
365 * Show the message about CiviCRM versions
367 * @param obj: $template (reference)
369 static function versionCheck($template) {
370 if (CRM_Core_Config
::isUpgradeMode()) {
373 $versionCheck = CRM_Utils_VersionCheck
::singleton();
374 $newerVersion = $versionCheck->newerVersion();
375 $template->assign('newer_civicrm_version', $newerVersion);
378 static function rebuildMenuAndCaches($triggerRebuild = FALSE, $sessionReset = FALSE) {
379 $config = CRM_Core_Config
::singleton();
380 $config->clearModuleList();
382 // also cleanup all caches
383 $config->cleanupCaches($sessionReset || CRM_Utils_Request
::retrieve('sessionReset', 'Boolean', CRM_Core_DAO
::$_nullObject, FALSE, 0, 'GET'));
385 CRM_Core_Menu
::store();
387 // also reset navigation
388 CRM_Core_BAO_Navigation
::resetNavigation();
390 // also cleanup module permissions
391 $config->cleanupPermissions();
393 // also rebuild word replacement cache
394 CRM_Core_BAO_WordReplacement
::rebuild();
396 CRM_Core_BAO_Setting
::updateSettingsFromMetaData();
397 CRM_Core_Resources
::singleton()->resetCacheCode();
399 // also rebuild triggers if requested explicitly
402 CRM_Utils_Request
::retrieve('triggerRebuild', 'Boolean', CRM_Core_DAO
::$_nullObject, FALSE, 0, 'GET')
404 CRM_Core_DAO
::triggerRebuild();
406 CRM_Core_DAO_AllCoreTables
::reinitializeCache(TRUE);
407 CRM_Core_ManagedEntities
::singleton(TRUE)->reconcile();