include/MVC/Controller/SugarController.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it under
   7  * the terms of the GNU Affero General Public License version 3 as published by the
   8  * Free Software Foundation with the addition of the following permission added
   9  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  10  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  11  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU Affero General Public License along with
  19  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  20  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21  * 02110-1301 USA.
  22  *
  23  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  24  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  25  *
  26  * The interactive user interfaces in modified source and object code versions
  27  * of this program must display Appropriate Legal Notices, as required under
  28  * Section 5 of the GNU Affero General Public License version 3.
  29  *
  30  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  31  * these Appropriate Legal Notices must retain the display of the "Powered by
  32  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  33  * technical reasons, the Appropriate Legal Notices must display the words
  34  * "Powered by SugarCRM".
  35  ********************************************************************************/
  36
  37 require_once('include/MVC/View/SugarView.php');
  38
  39
  40 class SugarController{
  41         /**
  42          * remap actions in here
  43          * e.g. make all detail views go to edit views
  44          * $action_remap = array('detailview'=>'editview');
  45          */
  46         protected $action_remap = array('index'=>'listview');
  47         /**
  48          * The name of the current module.
  49          */
  50         public $module = 'Home';
  51         /**
  52          * The name of the target module.
  53          */
  54         public $target_module = null;
  55         /**
  56          * The name of the current action.
  57          */
  58         public $action = 'index';
  59         /**
  60          * The id of the current record.
  61          */
  62         public $record = '';
  63         /**
  64          * The name of the return module.
  65          */
  66         public $return_module = null;
  67         /**
  68          * The name of the return action.
  69          */
  70         public $return_action = null;
  71         /**
  72          * The id of the return record.
  73          */
  74         public $return_id = null;
  75         /**
  76          * If the action was remapped it will be set to do_action and then we will just
  77          * use do_action for the actual action to perform.
  78          */
  79         protected $do_action = 'index';
  80         /**
  81          * If a bean is present that set it.
  82          */
  83         public $bean = null;
  84         /**
  85          * url to redirect to
  86          */
  87         public $redirect_url = '';
  88         /**
  89          * any subcontroller can modify this to change the view
  90          */
  91         public $view = 'classic';
  92         /**
  93          * this array will hold the mappings between a key and an object for use within the view.
  94          */
  95         public $view_object_map = array();
  96
  97         /**
  98          * This array holds the methods that handleAction() will invoke, in sequence.
  99          */
 100         protected $tasks = array(
 101                                            'pre_action',
 102                                            'do_action',
 103                                            'post_action'
 104                                            );
 105         /**
 106          * List of options to run through within the process() method.
 107          * This list is meant to easily allow additions for new functionality as well as
 108          * the ability to add a controller's own handling.
 109          */
 110         public $process_tasks = array(
 111                                                 'blockFileAccess',
 112                                                 'handleEntryPoint',
 113                                                 'callLegacyCode',
 114                                                 'remapAction',
 115                                                 'handle_action',
 116                                                 'handleActionMaps',
 117                                         );
 118         /**
 119          * Whether or not the action has been handled by $process_tasks
 120          *
 121          * @var bool
 122          */
 123         protected $_processed = false;
 124         /**
 125          * Map an action directly to a file
 126          */
 127         /**
 128          * Map an action directly to a file. This will be loaded from action_file_map.php
 129          */
 130         protected $action_file_map = array();
 131         /**
 132          * Map an action directly to a view
 133          */
 134         /**
 135          * Map an action directly to a view. This will be loaded from action_view_map.php
 136          */
 137         protected $action_view_map = array();
 138
 139         /**
 140          * This can be set from the application to tell us whether we have authorization to
 141          * process the action. If this is set we will default to the noaccess view.
 142          */
 143         public $hasAccess = true;
 144
 145         /**
 146          * Map case sensitive filenames to action.  This is used for linux/unix systems
 147          * where filenames are case sensitive
 148          */
 149         public static $action_case_file = array(
 150                                                                                 'editview'=>'EditView',
 151                                                                                 'detailview'=>'DetailView',
 152                                                                                 'listview'=>'ListView'
 153                                                                           );
 154
 155         /**
 156          * Constructor. This ie meant tot load up the module, action, record as well
 157          * as the mapping arrays.
 158          */
 159         function SugarController(){
 160         }
 161
 162         /**
 163          * Called from SugarApplication and is meant to perform the setup operations
 164          * on the controller.
 165          *
 166          */
 167         public function setup($module = ''){
 168                 if(empty($module) && !empty($_REQUEST['module']))
 169                         $module = $_REQUEST['module'];
 170                 //set the module
 171                 if(!empty($module))
 172                         $this->setModule($module);
 173
 174                 if(!empty($_REQUEST['target_module']) && $_REQUEST['target_module'] != 'undefined') {
 175                         $this->target_module = $_REQUEST['target_module'];
 176                 }
 177                 //set properties on the controller from the $_REQUEST
 178                 $this->loadPropertiesFromRequest();
 179                 //load the mapping files
 180                 $this->loadMappings();
 181         }
 182         /**
 183          * Set the module on the Controller
 184          *
 185          * @param object $module
 186          */
 187         public function setModule($module){
 188                 $this->module = $module;
 189         }
 190
 191         /**
 192          * Set properties on the Controller from the $_REQUEST
 193          *
 194          */
 195         private function loadPropertiesFromRequest(){
 196                 if(!empty($_REQUEST['action']))
 197                         $this->action = $_REQUEST['action'];
 198                 if(!empty($_REQUEST['record']))
 199                         $this->record = $_REQUEST['record'];
 200                 if(!empty($_REQUEST['view']))
 201                         $this->view = $_REQUEST['view'];
 202                 if(!empty($_REQUEST['return_module']))
 203                         $this->return_module = $_REQUEST['return_module'];
 204                 if(!empty($_REQUEST['return_action']))
 205                         $this->return_action = $_REQUEST['return_action'];
 206                 if(!empty($_REQUEST['return_id']))
 207                         $this->return_id = $_REQUEST['return_id'];
 208         }
 209
 210         /**
 211          * Load map files for use within the Controller
 212          *
 213          */
 214         private function loadMappings(){
 215                 $this->loadMapping('action_view_map');
 216                 $this->loadMapping('action_file_map');
 217                 $this->loadMapping('action_remap', true);
 218         }
 219
 220         /**
 221          * Given a record id load the bean. This bean is accessible from any sub controllers.
 222          */
 223         public function loadBean()
 224         {
 225                 if(!empty($GLOBALS['beanList'][$this->module])){
 226                         $class = $GLOBALS['beanList'][$this->module];
 227                         if(!empty($GLOBALS['beanFiles'][$class])){
 228                                 require_once($GLOBALS['beanFiles'][$class]);
 229                                 $this->bean = new $class();
 230                                 if(!empty($this->record)){
 231                                         $this->bean->retrieve($this->record);
 232                                         if($this->bean)
 233                                                 $GLOBALS['FOCUS'] = $this->bean;
 234                                 }
 235                         }
 236                 }
 237         }
 238
 239         /**
 240          * Generic load method to load mapping arrays.
 241          */
 242         private function loadMapping($var, $merge = false){
 243                 $$var = sugar_cache_retrieve("CONTROLLER_". $var . "_".$this->module);
 244                 if(!$$var){
 245                         if($merge && !empty($this->$var)){
 246                                 $$var = $this->$var;
 247                         }else{
 248                                 $$var = array();
 249                         }
 250                         if(file_exists('include/MVC/Controller/'. $var . '.php')){
 251                                 require('include/MVC/Controller/'. $var . '.php');
 252                         }
 253                         if(file_exists('modules/'.$this->module.'/'. $var . '.php')){
 254                                 require('modules/'.$this->module.'/'. $var . '.php');
 255                         }
 256                         if(file_exists('custom/modules/'.$this->module.'/'. $var . '.php')){
 257                                 require('custom/modules/'.$this->module.'/'. $var . '.php');
 258                         }
 259                         if(file_exists('custom/include/MVC/Controller/'. $var . '.php')){
 260                                 require('custom/include/MVC/Controller/'. $var . '.php');
 261                         }
 262
 263                         sugar_cache_put("CONTROLLER_". $var . "_".$this->module, $$var);
 264                 }
 265                 $this->$var = $$var;
 266         }
 267
 268         /**
 269          * This method is called from SugarApplication->execute and it will bootstrap the entire controller process
 270          */
 271         final public function execute(){
 272                 $this->process();
 273                 if(!empty($this->view)){
 274                         $this->processView();
 275                 }elseif(!empty($this->redirect_url)){
 276                         $this->redirect();
 277                 }
 278         }
 279
 280         /**
 281          * Display the appropriate view.
 282          */
 283         private function processView(){
 284                 $view = ViewFactory::loadView($this->view, $this->module, $this->bean, $this->view_object_map, $this->target_module);
 285                 $GLOBALS['current_view'] = $view;
 286                 if(!empty($this->bean) && !$this->bean->ACLAccess($view->type) && $view->type != 'list'){
 287                         ACLController::displayNoAccess(true);
 288                         sugar_cleanup(true);
 289                 }
 290                 if(isset($this->errors)){
 291                   $view->errors = $this->errors;
 292                 }
 293                 $view->process();
 294         }
 295
 296         /**
 297          * Meant to be overridden by a subclass and allows for specific functionality to be
 298          * injected prior to the process() method being called.
 299          */
 300         public function preProcess()
 301         {}
 302
 303         /**
 304          * if we have a function to support the action use it otherwise use the default action
 305          *
 306          * 1) check for file
 307          * 2) check for action
 308          */
 309         public function process(){
 310                 $GLOBALS['action'] = $this->action;
 311                 $GLOBALS['module'] = $this->module;
 312
 313                 //check to ensure we have access to the module.
 314                 if($this->hasAccess){
 315                         $this->do_action = $this->action;
 316
 317                         $file = self::getActionFilename($this->do_action);
 318
 319                         $this->loadBean();
 320
 321                         $processed = false;
 322                         foreach($this->process_tasks as $process){
 323                                 $this->$process();
 324                                 if($this->_processed)
 325                                         break;
 326                         }
 327
 328                         $this->redirect();
 329                 }else{
 330                         $this->no_access();
 331                 }
 332         }
 333
 334         /**
 335          * This method is called from the process method. I could also be called within an action_* method.
 336          * It allows a developer to override any one of these methods contained within,
 337          * or if the developer so chooses they can override the entire action_* method.
 338          *
 339          * @return true if any one of the pre_, do_, or post_ methods have been defined,
 340          * false otherwise.  This is important b/c if none of these methods exists, then we will run the
 341          * action_default() method.
 342          */
 343         protected function handle_action(){
 344                 $processed = false;
 345                 foreach($this->tasks as $task){
 346                         $processed = ($this->$task() || $processed);
 347                 }
 348                 $this->_processed = $processed;
 349         }
 350
 351         /**
 352          * Perform an action prior to the specified action.
 353          * This can be overridde in a sub-class
 354          */
 355         private function pre_action(){
 356                 $function = 'pre_' . $this->action;
 357                 if($this->hasFunction($function)){
 358                         $GLOBALS['log']->debug('Performing pre_action');
 359                         $this->$function();
 360                         return true;
 361                 }
 362                 return false;
 363         }
 364
 365         /**
 366          * Perform the specified action.
 367          * This can be overridde in a sub-class
 368          */
 369         private function do_action(){
 370                 $function =  'action_'. strtolower($this->do_action);
 371                 if($this->hasFunction($function)){
 372                         $GLOBALS['log']->debug('Performing action: '.$function.' MODULE: '.$this->module);
 373                         $this->$function();
 374                         return true;
 375                 }
 376                 return false;
 377         }
 378
 379         /**
 380          * Perform an action after to the specified action has occurred.
 381          * This can be overridde in a sub-class
 382          */
 383         private function post_action(){
 384                 $function = 'post_' . $this->action;
 385                 if($this->hasFunction($function)){
 386                         $GLOBALS['log']->debug('Performing post_action');
 387                         $this->$function();
 388                         return true;
 389                 }
 390                 return false;
 391         }
 392
 393         /**
 394          * If there is no action found then display an error to the user.
 395          */
 396         protected function no_action(){
 397                 sugar_die($GLOBALS['app_strings']['LBL_NO_ACTION']);
 398         }
 399
 400         /**
 401          * The default action handler for instances where we do not have access to process.
 402          */
 403         protected function no_access(){
 404                 $this->view = 'noaccess';
 405         }
 406
 407         ///////////////////////////////////////////////
 408         /////// HELPER FUNCTIONS
 409         ///////////////////////////////////////////////
 410
 411         /**
 412          * Determine if a given function exists on the objects
 413          * @param function - the function to check
 414          * @return true if the method exists on the object, false otherwise
 415          */
 416         protected function hasFunction($function){
 417                 return method_exists($this, $function);
 418         }
 419
 420
 421         /**
 422          * Set the url to which we will want to redirect
 423          *
 424          * @param string url - the url to which we will want to redirect
 425          */
 426         protected function set_redirect($url){
 427                 $this->redirect_url = $url;
 428         }
 429
 430         /**
 431          * Perform redirection based on the redirect_url
 432          *
 433          */
 434         protected function redirect(){
 435
 436                 if(!empty($this->redirect_url))
 437                         SugarApplication::redirect($this->redirect_url);
 438         }
 439
 440         ////////////////////////////////////////////////////////
 441         ////// DEFAULT ACTIONS
 442         ///////////////////////////////////////////////////////
 443
 444         /*
 445          * Save a bean
 446          */
 447
 448         /**
 449          * Do some processing before saving the bean to the database.
 450          */
 451         public function pre_save(){
 452                 if(!empty($_POST['assigned_user_id']) && $_POST['assigned_user_id'] != $this->bean->assigned_user_id && $_POST['assigned_user_id'] != $GLOBALS['current_user']->id && empty($GLOBALS['sugar_config']['exclude_notifications'][$this->bean->module_dir])){
 453                         $this->bean->notify_on_save = true;
 454                 }
 455                 $GLOBALS['log']->debug("SugarController:: performing pre_save.");
 456         require_once('include/SugarFields/SugarFieldHandler.php');
 457         $sfh = new SugarFieldHandler();
 458                 foreach($this->bean->field_defs as $field => $properties) {
 459                         $type = !empty($properties['custom_type']) ? $properties['custom_type'] : $properties['type'];
 460                     $sf = $sfh->getSugarField(ucfirst($type), true);
 461                         if(isset($_POST[$field])) {
 462                                 if(is_array($_POST[$field]) && !empty($properties['isMultiSelect'])) {
 463                                         if(empty($_POST[$field][0])) {
 464                                                 unset($_POST[$field][0]);
 465                                         }
 466                                         $_POST[$field] = encodeMultienumValue($_POST[$field]);
 467                                 }
 468                                 $this->bean->$field = $_POST[$field];
 469                         } else if(!empty($properties['isMultiSelect']) && !isset($_POST[$field]) && isset($_POST[$field . '_multiselect'])) {
 470                                 $this->bean->$field = '';
 471                         }
 472             if($sf != null){
 473                 $sf->save($this->bean, $_POST, $field, $properties);
 474             }
 475                 }
 476
 477                 foreach($this->bean->relationship_fields as $field=>$link){
 478                         if(!empty($_POST[$field])){
 479                                 $this->bean->$field = $_POST[$field];
 480                         }
 481                 }
 482                 if(!$this->bean->ACLAccess('save')){
 483                         ACLController::displayNoAccess(true);
 484                         sugar_cleanup(true);
 485                 }
 486                 $this->bean->unformat_all_fields();
 487         }
 488
 489         /**
 490          * Perform the actual save
 491          */
 492         public function action_save(){
 493                 $this->bean->save(!empty($this->bean->notify_on_save));
 494         }
 495
 496         /**
 497          * Specify what happens after the save has occurred.
 498          */
 499         protected function post_save(){
 500                 $module = (!empty($this->return_module) ? $this->return_module : $this->module);
 501                 $action = (!empty($this->return_action) ? $this->return_action : 'DetailView');
 502                 $id = (!empty($this->return_id) ? $this->return_id : $this->bean->id);
 503
 504                 $url = "index.php?module=".$module."&action=".$action."&record=".$id;
 505                 $this->set_redirect($url);
 506         }
 507
 508         /*
 509          * Delete a bean
 510          */
 511
 512         /**
 513          * Perform the actual deletion.
 514          */
 515         protected function action_delete(){
 516                 //do any pre delete processing
 517                 //if there is some custom logic for deletion.
 518                 if(!empty($_REQUEST['record'])){
 519                         if(!$this->bean->ACLAccess('Delete')){
 520                                 ACLController::displayNoAccess(true);
 521                                 sugar_cleanup(true);
 522                         }
 523                         $this->bean->mark_deleted($_REQUEST['record']);
 524                 }else{
 525                         sugar_die("A record number must be specified to delete");
 526                 }
 527         }
 528
 529         /**
 530          * Specify what happens after the deletion has occurred.
 531          */
 532         protected function post_delete(){
 533                 $return_module = isset($_REQUEST['return_module']) ?
 534                         $_REQUEST['return_module'] :
 535                         $GLOBALS['sugar_config']['default_module'];
 536                 $return_action = isset($_REQUEST['return_action']) ?
 537                         $_REQUEST['return_action'] :
 538                         $GLOBALS['sugar_config']['default_action'];
 539                 $return_id = isset($_REQUEST['return_id']) ?
 540                         $_REQUEST['return_id'] :
 541                         '';
 542                 $url = "index.php?module=".$return_module."&action=".$return_action."&record=".$return_id;
 543                 $this->set_redirect($url);
 544         }
 545         /**
 546          * Perform the actual massupdate.
 547          */
 548         protected function action_massupdate(){
 549                 if(!empty($_REQUEST['massupdate']) && $_REQUEST['massupdate'] == 'true' && (!empty($_REQUEST['uid']) || !empty($_REQUEST['entire']))){
 550                         if(!empty($_REQUEST['Delete']) && $_REQUEST['Delete']=='true' && !$this->bean->ACLAccess('delete')
 551                 || (empty($_REQUEST['Delete']) || $_REQUEST['Delete']!='true') && !$this->bean->ACLAccess('save')){
 552                                 ACLController::displayNoAccess(true);
 553                                 sugar_cleanup(true);
 554                         }
 555
 556             set_time_limit(0);//I'm wondering if we will set it never goes timeout here.
 557             // until we have more efficient way of handling MU, we have to disable the limit
 558             $GLOBALS['db']->setQueryLimit(0);
 559             require_once("include/MassUpdate.php");
 560             require_once('modules/MySettings/StoreQuery.php');
 561             $seed = loadBean($_REQUEST['module']);
 562             $mass = new MassUpdate();
 563             $mass->setSugarBean($seed);
 564             if(isset($_REQUEST['entire']) && empty($_POST['mass'])) {
 565                 $mass->generateSearchWhere($_REQUEST['module'], $_REQUEST['current_query_by_page']);
 566             }
 567             $mass->handleMassUpdate();
 568             $storeQuery = new StoreQuery();//restore the current search. to solve bug 24722 for multi tabs massupdate.
 569             $temp_req = array('current_query_by_page' => $_REQUEST['current_query_by_page'], 'return_module' => $_REQUEST['return_module'], 'return_action' => $_REQUEST['return_action']);
 570             if($_REQUEST['return_module'] == 'Emails') {
 571                 if(!empty($_REQUEST['type']) && !empty($_REQUEST['ie_assigned_user_id'])) {
 572                     $this->req_for_email = array('type' => $_REQUEST['type'], 'ie_assigned_user_id' => $_REQUEST['ie_assigned_user_id']); //specificly for My Achieves
 573                 }
 574             }
 575             $_REQUEST = array();
 576             $_REQUEST = unserialize(base64_decode($temp_req['current_query_by_page']));
 577             unset($_REQUEST[$seed->module_dir.'2_'.strtoupper($seed->object_name).'_offset']);//after massupdate, the page should redirect to no offset page
 578             $storeQuery->saveFromRequest($_REQUEST['module']);
 579             $_REQUEST = array('return_module' => $temp_req['return_module'], 'return_action' => $temp_req['return_action']);//for post_massupdate, to go back to original page.
 580                 }else{
 581                         sugar_die("You must massupdate at least one record");
 582                 }
 583         }
 584         /**
 585          * Specify what happens after the massupdate has occurred.
 586          */
 587         protected function post_massupdate(){
 588                 $return_module = isset($_REQUEST['return_module']) ?
 589                         $_REQUEST['return_module'] :
 590                         $GLOBALS['sugar_config']['default_module'];
 591                 $return_action = isset($_REQUEST['return_action']) ?
 592                         $_REQUEST['return_action'] :
 593                         $GLOBALS['sugar_config']['default_action'];
 594                 $url = "index.php?module=".$return_module."&action=".$return_action;
 595                 if($return_module == 'Emails'){//specificly for My Achieves
 596                         if(!empty($this->req_for_email['type']) && !empty($this->req_for_email['ie_assigned_user_id'])) {
 597                                 $url = $url . "&type=".$this->req_for_email['type']."&assigned_user_id=".$this->req_for_email['ie_assigned_user_id'];
 598                         }
 599                 }
 600                 $this->set_redirect($url);
 601         }
 602         /**
 603          * Perform the listview action
 604          */
 605         protected function action_listview(){
 606                 $this->view_object_map['bean'] = $this->bean;
 607                 $this->view = 'list';
 608         }
 609
 610 /*
 611
 612         //THIS IS HANDLED IN ACTION_REMAP WHERE INDEX IS SET TO LISTVIEW
 613         function action_index(){
 614         }
 615 */
 616
 617         /**
 618          * Action to handle when using a file as was done in previous versions of Sugar.
 619          */
 620         protected function action_default(){
 621                 $this->view = 'classic';
 622         }
 623
 624         /**
 625          * this method id used within a Dashlet when performing an ajax call
 626          */
 627         protected function action_callmethoddashlet(){
 628                 if(!empty($_REQUEST['id'])) {
 629                     $id = $_REQUEST['id'];
 630                     $requestedMethod = $_REQUEST['method'];
 631                     $dashletDefs = $GLOBALS['current_user']->getPreference('dashlets', 'Home'); // load user's dashlets config
 632                     if(!empty($dashletDefs[$id])) {
 633                         require_once($dashletDefs[$id]['fileLocation']);
 634
 635                         $dashlet = new $dashletDefs[$id]['className']($id, (isset($dashletDefs[$id]['options']) ? $dashletDefs[$id]['options'] : array()));
 636
 637                         if(method_exists($dashlet, $requestedMethod) || method_exists($dashlet, '__call')) {
 638                             echo $dashlet->$requestedMethod();
 639                         }
 640                         else {
 641                             echo 'no method';
 642                         }
 643                     }
 644                 }
 645         }
 646
 647         /**
 648          * this method is used within a Dashlet when the options configuration is posted
 649          */
 650         protected function action_configuredashlet(){
 651                 global $current_user, $mod_strings;
 652
 653                 if(!empty($_REQUEST['id'])) {
 654                     $id = $_REQUEST['id'];
 655                     $dashletDefs = $current_user->getPreference('dashlets', $_REQUEST['module']); // load user's dashlets config
 656                     require_once($dashletDefs[$id]['fileLocation']);
 657
 658                     $dashlet = new $dashletDefs[$id]['className']($id, (isset($dashletDefs[$id]['options']) ? $dashletDefs[$id]['options'] : array()));
 659                     if(!empty($_REQUEST['configure']) && $_REQUEST['configure']) { // save settings
 660                         $dashletDefs[$id]['options'] = $dashlet->saveOptions($_REQUEST);
 661                         $current_user->setPreference('dashlets', $dashletDefs, 0, $_REQUEST['module']);
 662                     }
 663                     else { // display options
 664                         $json = getJSONobj();
 665                         return 'result = ' . $json->encode((array('header' => $dashlet->title . ' : ' . $mod_strings['LBL_OPTIONS'],
 666                                                                  'body'  => $dashlet->displayOptions())));
 667
 668                     }
 669                 }
 670                 else {
 671                     return '0';
 672                 }
 673         }
 674
 675         /**
 676          * getActionFilename
 677          */
 678         public static function getActionFilename($action) {
 679            if(isset(self::$action_case_file[$action])) {
 680                   return self::$action_case_file[$action];
 681            }
 682            return $action;
 683         }
 684
 685         /********************************************************************/
 686         //                              PROCESS TASKS
 687         /********************************************************************/
 688
 689         /**
 690          * Given the module and action, determine whether the super/admin has prevented access
 691          * to this url. In addition if any links specified for this module, load the links into
 692          * GLOBALS
 693          *
 694          * @return true if we want to stop processing, false if processing should continue
 695          */
 696         private function blockFileAccess(){
 697                 //check if the we have enabled file_access_control and if so then check the mappings on the request;
 698                 if(!empty($GLOBALS['sugar_config']['admin_access_control']) && $GLOBALS['sugar_config']['admin_access_control']){
 699                         $this->loadMapping('file_access_control_map');
 700                         //since we have this turned on, check the mapping file
 701                         $module = strtolower($this->module);
 702                         $action = strtolower($this->do_action);
 703                         if(!empty($this->file_access_control_map['modules'][$module]['links'])){
 704                                 $GLOBALS['admin_access_control_links'] = $this->file_access_control_map['modules'][$module]['links'];
 705                         }
 706
 707                         if(!empty($this->file_access_control_map['modules'][$module]['actions']) && (in_array($action, $this->file_access_control_map['modules'][$module]['actions']) || !empty($this->file_access_control_map['modules'][$module]['actions'][$action]))){
 708                                 //check params
 709                                 if(!empty($this->file_access_control_map['modules'][$module]['actions'][$action]['params'])){
 710                                         $block = true;
 711                                         $params = $this->file_access_control_map['modules'][$module]['actions'][$action]['params'];
 712                                         foreach($params as $param => $paramVals){
 713                                                 if(!empty($_REQUEST[$param])){
 714                                                         if(!in_array($_REQUEST[$param], $paramVals)){
 715                                                                 $block = false;
 716                                                                 break;
 717                                                         }
 718                                                 }
 719                                         }
 720                                         if($block){
 721                                                 $this->_processed = true;
 722                                                 $this->no_access();
 723                                         }
 724                                 }else{
 725                                         $this->_processed = true;
 726                                         $this->no_access();
 727                                 }
 728                         }
 729                 }else
 730                         $this->_processed = false;
 731         }
 732
 733         /**
 734          * This code is part of the entry points reworking. We have consolidated all
 735          * entry points to go through index.php. Now in order to bring up an entry point
 736          * it will follow the format:
 737          * 'index.php?entryPoint=download'
 738          * the download entry point is mapped in the following file: entry_point_registry.php
 739          *
 740          */
 741         private function handleEntryPoint(){
 742                 if(!empty($_REQUEST['entryPoint'])){
 743                         $this->loadMapping('entry_point_registry');
 744                         $entryPoint = $_REQUEST['entryPoint'];
 745
 746                         if(!empty($this->entry_point_registry[$entryPoint])){
 747                                 require_once($this->entry_point_registry[$entryPoint]['file']);
 748                                 $this->_processed = true;
 749                                 $this->view = '';
 750                         }
 751                 }
 752         }
 753
 754     /**
 755      * Checks to see if the requested entry point requires auth
 756      *
 757      * @param  $entrypoint string name of the entrypoint
 758      * @return bool true if auth is required, false if not
 759      */
 760     public function checkEntryPointRequiresAuth($entryPoint)
 761     {
 762         $this->loadMapping('entry_point_registry');
 763
 764         if ( isset($this->entry_point_registry[$entryPoint]['auth'])
 765                 && !$this->entry_point_registry[$entryPoint]['auth'] )
 766             return false;
 767         return true;
 768     }
 769
 770         /**
 771          * Meant to handle old views e.g. DetailView.php.
 772          *
 773          */
 774         protected function callLegacyCode()
 775         {
 776                 $file = self::getActionFilename($this->do_action);
 777                 if ( isset($this->action_view_map[strtolower($this->do_action)]) ) {
 778                 $action = $this->action_view_map[strtolower($this->do_action)];
 779             }
 780             else {
 781                 $action = $this->do_action;
 782             }
 783             // index actions actually maps to the view.list.php view
 784             if ( $action == 'index' ) {
 785                 $action = 'list';
 786             }
 787
 788                 if ((file_exists('modules/' . $this->module . '/'. $file . '.php')
 789                 && !file_exists('modules/' . $this->module . '/views/view.'. $action . '.php'))
 790             || (file_exists('custom/modules/' . $this->module . '/'. $file . '.php')
 791                 && !file_exists('custom/modules/' . $this->module . '/views/view.'. $action . '.php'))
 792             ) {
 793                         // A 'classic' module, using the old pre-MVC display files
 794                         // We should now discard the bean we just obtained for tracking as the pre-MVC module will instantiate its own
 795                         unset($GLOBALS['FOCUS']);
 796                         $GLOBALS['log']->debug('Module:' . $this->module . ' using file: '. $file);
 797                         $this->action_default();
 798                         $this->_processed = true;
 799                 }
 800         }
 801
 802         /**
 803          * If the action has been remapped to a different action as defined in
 804          * action_file_map.php or action_view_map.php load those maps here.
 805          *
 806          */
 807         private function handleActionMaps(){
 808                 if(!empty($this->action_file_map[strtolower($this->do_action)])){
 809                         $this->view = '';
 810                         $GLOBALS['log']->debug('Using Action File Map:' . $this->action_file_map[strtolower($this->do_action)]);
 811                         require_once($this->action_file_map[strtolower($this->do_action)]);
 812                         $this->_processed = true;
 813                 }elseif(!empty($this->action_view_map[strtolower($this->do_action)])){
 814                         $GLOBALS['log']->debug('Using Action View Map:' . $this->action_view_map[strtolower($this->do_action)]);
 815                         $this->view = $this->action_view_map[strtolower($this->do_action)];
 816                         $this->_processed = true;
 817                 }else
 818                         $this->no_action();
 819         }
 820
 821         /**
 822          * Actually remap the action if required.
 823          *
 824          */
 825         protected function remapAction(){
 826                 if(!empty($this->action_remap[$this->do_action])){
 827                         $this->action = $this->action_remap[$this->do_action];
 828                         $this->do_action = $this->action;
 829                 }
 830         }
 831
 832 }
 833 ?>