crm.fsf.org/20131203/files/sites/all/modules-old/civicrm/CRM/Core/Invoke.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2015                                |
   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  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * Given an argument list, invoke the appropriate CRM function
  31  * Serves as a wrapper between the UserFrameWork and Core CRM
  32  *
  33  * @package CRM
  34  * @copyright CiviCRM LLC (c) 2004-2015
  35  * $Id$
  36  *
  37  */
  38 class CRM_Core_Invoke {
  39
  40   /**
  41    * This is the main front-controller that integrates with the CMS. Any
  42    * page-request that is sent to the CMS and intended for CiviCRM should
  43    * be processed by invoke().
  44    *
  45    * @param array $args
  46    *   The parts of the URL which identify the intended CiviCRM page
  47    *   (e.g. array('civicrm', 'event', 'register')).
  48    * @return string
  49    *   HTML. For non-HTML content, invoke() may call print() and exit().
  50    *
  51    */
  52   public static function invoke($args) {
  53     try {
  54       return self::_invoke($args);
  55     }
  56     catch (Exception $e) {
  57       CRM_Core_Error::handleUnhandledException($e);
  58     }
  59   }
  60
  61   /**
  62    * This is the same as invoke(), but it does *not* include exception
  63    * handling.
  64    *
  65    * @param array $args
  66    *   The parts of the URL which identify the intended CiviCRM page
  67    *   (e.g. array('civicrm', 'event', 'register')).
  68    * @return string
  69    *   HTML. For non-HTML content, invoke() may call print() and exit().
  70    */
  71   public static function _invoke($args) {
  72     if ($args[0] !== 'civicrm') {
  73       return NULL;
  74     }
  75     // CRM-15901: Turn off PHP errors display for all ajax calls
  76     if (CRM_Utils_Array::value(1, $args) == 'ajax' || CRM_Utils_Array::value('snippet', $_REQUEST)) {
  77       ini_set('display_errors', 0);
  78     }
  79
  80     if (!defined('CIVICRM_SYMFONY_PATH')) {
  81       // Traditional Civi invocation path
  82       self::hackMenuRebuild($args); // may exit
  83       self::init($args);
  84       self::hackStandalone($args);
  85       $item = self::getItem($args);
  86       return self::runItem($item);
  87     }
  88     else {
  89       // Symfony-based invocation path
  90       require_once CIVICRM_SYMFONY_PATH . '/app/bootstrap.php.cache';
  91       require_once CIVICRM_SYMFONY_PATH . '/app/AppKernel.php';
  92       $kernel = new AppKernel('dev', TRUE);
  93       $kernel->loadClassCache();
  94       $response = $kernel->handle(Symfony\Component\HttpFoundation\Request::createFromGlobals());
  95       if (preg_match(':^text/html:', $response->headers->get('Content-Type'))) {
  96         // let the CMS handle the trappings
  97         return $response->getContent();
  98       }
  99       else {
 100         $response->send();
 101         exit();
 102       }
 103     }
 104   }
 105
 106   /**
 107    * Hackish support /civicrm/menu/rebuild
 108    *
 109    * @param array $args
 110    *   List of path parts.
 111    * @void
 112    */
 113   static public function hackMenuRebuild($args) {
 114     if (array('civicrm', 'menu', 'rebuild') == $args || array('civicrm', 'clearcache') == $args) {
 115       // ensure that the user has a good privilege level
 116       if (CRM_Core_Permission::check('administer CiviCRM')) {
 117         self::rebuildMenuAndCaches();
 118         CRM_Core_Session::setStatus(ts('Cleared all CiviCRM caches (database, menu, templates)'), ts('Complete'), 'success');
 119         return CRM_Utils_System::redirect(); // exits
 120       }
 121       else {
 122         CRM_Core_Error::fatal('You do not have permission to execute this url');
 123       }
 124     }
 125   }
 126
 127   /**
 128    * Perform general setup.
 129    *
 130    * @param array $args
 131    *   List of path parts.
 132    * @void
 133    */
 134   static public function init($args) {
 135     // first fire up IDS and check for bad stuff
 136     $config = CRM_Core_Config::singleton();
 137     if (!CRM_Core_Permission::check('skip IDS check')) {
 138       $ids = new CRM_Core_IDS();
 139       $ids->check($args);
 140     }
 141
 142     // also initialize the i18n framework
 143     require_once 'CRM/Core/I18n.php';
 144     $i18n = CRM_Core_I18n::singleton();
 145   }
 146
 147   /**
 148    * Hackish support for /standalone/*
 149    *
 150    * @param array $args
 151    *   List of path parts.
 152    * @void
 153    */
 154   static public function hackStandalone($args) {
 155     $config = CRM_Core_Config::singleton();
 156     if ($config->userFramework == 'Standalone') {
 157       $session = CRM_Core_Session::singleton();
 158       if ($session->get('new_install') !== TRUE) {
 159         CRM_Core_Standalone::sidebarLeft();
 160       }
 161       elseif ($args[1] == 'standalone' && $args[2] == 'register') {
 162         CRM_Core_Menu::store();
 163       }
 164     }
 165   }
 166
 167   /**
 168    * Determine which menu $item corresponds to $args
 169    *
 170    * @param array $args
 171    *   List of path parts.
 172    * @return array; see CRM_Core_Menu
 173    */
 174   static public function getItem($args) {
 175     if (is_array($args)) {
 176       // get the menu items
 177       $path = implode('/', $args);
 178     }
 179     else {
 180       $path = $args;
 181     }
 182     $item = CRM_Core_Menu::get($path);
 183
 184     // we should try to compute menus, if item is empty and stay on the same page,
 185     // rather than compute and redirect to dashboard.
 186     if (!$item) {
 187       CRM_Core_Menu::store(FALSE);
 188       $item = CRM_Core_Menu::get($path);
 189     }
 190
 191     return $item;
 192   }
 193
 194   /**
 195    * Given a menu item, call the appropriate controller and return the response
 196    *
 197    * @param array $item
 198    *   See CRM_Core_Menu.
 199    * @return string, HTML
 200    */
 201   static public function runItem($item) {
 202     $config = CRM_Core_Config::singleton();
 203     if ($config->userFramework == 'Joomla' && $item) {
 204       $config->userFrameworkURLVar = 'task';
 205
 206       // joomla 1.5RC1 seems to push this in the POST variable, which messes
 207       // QF and checkboxes
 208       unset($_POST['option']);
 209       CRM_Core_Joomla::sidebarLeft();
 210     }
 211
 212     // set active Component
 213     $template = CRM_Core_Smarty::singleton();
 214     $template->assign('activeComponent', 'CiviCRM');
 215     $template->assign('formTpl', 'default');
 216
 217     if ($item) {
 218       // CRM-7656 - make sure we send a clean sanitized path to create printer friendly url
 219       $printerFriendly = CRM_Utils_System::makeURL(
 220           'snippet', FALSE, FALSE,
 221           CRM_Utils_Array::value('path', $item)
 222         ) . '2';
 223       $template->assign('printerFriendly', $printerFriendly);
 224
 225       if (!array_key_exists('page_callback', $item)) {
 226         CRM_Core_Error::debug('Bad item', $item);
 227         CRM_Core_Error::fatal(ts('Bad menu record in database'));
 228       }
 229
 230       // check that we are permissioned to access this page
 231       if (!CRM_Core_Permission::checkMenuItem($item)) {
 232         CRM_Utils_System::permissionDenied();
 233         return NULL;
 234       }
 235
 236       // check if ssl is set
 237       if (!empty($item['is_ssl'])) {
 238         CRM_Utils_System::redirectToSSL();
 239       }
 240
 241       if (isset($item['title'])) {
 242         CRM_Utils_System::setTitle($item['title']);
 243       }
 244
 245       if (isset($item['breadcrumb']) && !isset($item['is_public'])) {
 246         CRM_Utils_System::appendBreadCrumb($item['breadcrumb']);
 247       }
 248
 249       $pageArgs = NULL;
 250       if (!empty($item['page_arguments'])) {
 251         $pageArgs = CRM_Core_Menu::getArrayForPathArgs($item['page_arguments']);
 252       }
 253
 254       $template = CRM_Core_Smarty::singleton();
 255       if (!empty($item['is_public'])) {
 256         $template->assign('urlIsPublic', TRUE);
 257       }
 258       else {
 259         $template->assign('urlIsPublic', FALSE);
 260         self::versionCheck($template);
 261       }
 262
 263       if (isset($item['return_url'])) {
 264         $session = CRM_Core_Session::singleton();
 265         $args = CRM_Utils_Array::value(
 266           'return_url_args',
 267           $item,
 268           'reset=1'
 269         );
 270         $session->pushUserContext(CRM_Utils_System::url($item['return_url'], $args));
 271       }
 272
 273       $result = NULL;
 274       // WISHLIST: Refactor this. Instead of pattern-matching on page_callback, lookup
 275       // page_callback via Civi\Core\Resolver and check the implemented interfaces. This
 276       // would require rethinking the default constructor.
 277       if (is_array($item['page_callback']) || strpos($item['page_callback'], ':')) {
 278         $result = call_user_func(Civi\Core\Resolver::singleton()->get($item['page_callback']));
 279       }
 280       elseif (strstr($item['page_callback'], '_Form')) {
 281         $wrapper = new CRM_Utils_Wrapper();
 282         $result = $wrapper->run(
 283           CRM_Utils_Array::value('page_callback', $item),
 284           CRM_Utils_Array::value('title', $item),
 285           isset($pageArgs) ? $pageArgs : NULL
 286         );
 287       }
 288       else {
 289         $newArgs = explode('/', $_GET[$config->userFrameworkURLVar]);
 290         $mode = 'null';
 291         if (isset($pageArgs['mode'])) {
 292           $mode = $pageArgs['mode'];
 293           unset($pageArgs['mode']);
 294         }
 295         $title = CRM_Utils_Array::value('title', $item);
 296         if (strstr($item['page_callback'], '_Page') || strstr($item['page_callback'], '\\Page\\')) {
 297           $object = new $item['page_callback']($title, $mode);
 298           $object->urlPath = explode('/', $_GET[$config->userFrameworkURLVar]);
 299         }
 300         elseif (strstr($item['page_callback'], '_Controller') || strstr($item['page_callback'], '\\Controller\\')) {
 301           $addSequence = 'false';
 302           if (isset($pageArgs['addSequence'])) {
 303             $addSequence = $pageArgs['addSequence'];
 304             $addSequence = $addSequence ? 'true' : 'false';
 305             unset($pageArgs['addSequence']);
 306           }
 307           $object = new $item['page_callback']($title, TRUE, $mode, NULL, $addSequence);
 308         }
 309         else {
 310           CRM_Core_Error::fatal();
 311         }
 312         $result = $object->run($newArgs, $pageArgs);
 313       }
 314
 315       CRM_Core_Session::storeSessionObjects();
 316       return $result;
 317     }
 318
 319     CRM_Core_Menu::store();
 320     CRM_Core_Session::setStatus(ts('Menu has been rebuilt'), ts('Complete'), 'success');
 321     return CRM_Utils_System::redirect();
 322   }
 323
 324   /**
 325    * This function contains the default action.
 326    *
 327    * @param $action
 328    *
 329    * @param $contact_type
 330    * @param $contact_sub_type
 331    *
 332    */
 333   public static function form($action, $contact_type, $contact_sub_type) {
 334     CRM_Utils_System::setUserContext(array('civicrm/contact/search/basic', 'civicrm/contact/view'));
 335     $wrapper = new CRM_Utils_Wrapper();
 336
 337     $properties = CRM_Core_Component::contactSubTypeProperties($contact_sub_type, 'Edit');
 338     if ($properties) {
 339       $wrapper->run($properties['class'], ts('New %1', array(1 => $contact_sub_type)), $action, TRUE);
 340     }
 341     else {
 342       $wrapper->run('CRM_Contact_Form_Contact', ts('New Contact'), $action, TRUE);
 343     }
 344   }
 345
 346   /**
 347    * Show the message about CiviCRM versions.
 348    *
 349    * @param CRM_Core_Smarty $template
 350    */
 351   public static function versionCheck($template) {
 352     if (CRM_Core_Config::isUpgradeMode()) {
 353       return;
 354     }
 355     $newerVersion = $securityUpdate = NULL;
 356     if (CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'versionAlert', NULL, 1) & 1) {
 357       $newerVersion = CRM_Utils_VersionCheck::singleton()->isNewerVersionAvailable();
 358     }
 359     if (CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'securityUpdateAlert', NULL, 3) & 1) {
 360       $securityUpdate = CRM_Utils_VersionCheck::singleton()->isSecurityUpdateAvailable();
 361     }
 362     $template->assign('newer_civicrm_version', $newerVersion);
 363     $template->assign('security_update', $securityUpdate);
 364   }
 365
 366   /**
 367    * @param bool $triggerRebuild
 368    * @param bool $sessionReset
 369    *
 370    * @throws Exception
 371    */
 372   public static function rebuildMenuAndCaches($triggerRebuild = FALSE, $sessionReset = FALSE) {
 373     $config = CRM_Core_Config::singleton();
 374     $config->clearModuleList();
 375
 376     // also cleanup all caches
 377     $config->cleanupCaches($sessionReset || CRM_Utils_Request::retrieve('sessionReset', 'Boolean', CRM_Core_DAO::$_nullObject, FALSE, 0, 'GET'));
 378
 379     CRM_Core_Menu::store();
 380
 381     // also reset navigation
 382     CRM_Core_BAO_Navigation::resetNavigation();
 383
 384     // also cleanup module permissions
 385     $config->cleanupPermissions();
 386
 387     // rebuild word replacement cache - pass false to prevent operations redundant with this fn
 388     CRM_Core_BAO_WordReplacement::rebuild(FALSE);
 389
 390     CRM_Core_BAO_Setting::updateSettingsFromMetaData();
 391     // Clear js caches
 392     CRM_Core_Resources::singleton()->flushStrings()->resetCacheCode();
 393     CRM_Case_XMLRepository::singleton(TRUE);
 394
 395     // also rebuild triggers if requested explicitly
 396     if (
 397       $triggerRebuild ||
 398       CRM_Utils_Request::retrieve('triggerRebuild', 'Boolean', CRM_Core_DAO::$_nullObject, FALSE, 0, 'GET')
 399     ) {
 400       CRM_Core_DAO::triggerRebuild();
 401     }
 402     CRM_Core_DAO_AllCoreTables::reinitializeCache(TRUE);
 403     CRM_Core_ManagedEntities::singleton(TRUE)->reconcile();
 404
 405     //CRM-16257 update Config.IDS.ini might be an old copy
 406     CRM_Core_IDS::createConfigFile(TRUE);
 407   }
 408
 409 }