include/utils/LogicHook.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM is a customer relationship management program developed by
   5  * SugarCRM, Inc. Copyright (C) 2004-2011 SugarCRM Inc.
   6  *
   7  * This program is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU Affero General Public License version 3 as published by the
   9  * Free Software Foundation with the addition of the following permission added
  10  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  11  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  12  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  13  *
  14  * This program is distributed in the hope that it will be useful, but WITHOUT
  15  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  16  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  17  * details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License along with
  20  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  21  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  22  * 02110-1301 USA.
  23  *
  24  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  25  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  26  *
  27  * The interactive user interfaces in modified source and object code versions
  28  * of this program must display Appropriate Legal Notices, as required under
  29  * Section 5 of the GNU Affero General Public License version 3.
  30  *
  31  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  32  * these Appropriate Legal Notices must retain the display of the "Powered by
  33  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  34  * technical reasons, the Appropriate Legal Notices must display the words
  35  * "Powered by SugarCRM".
  36  ********************************************************************************/
  37
  38
  39 /**
  40  * Predefined logic hooks
  41  * after_ui_frame
  42  * after_ui_footer
  43  * after_save
  44  * before_save
  45  * before_retrieve
  46  * after_retrieve
  47  * process_record
  48  * before_delete
  49  * after_delete
  50  * before_restore
  51  * after_restore
  52  * server_roundtrip
  53  * before_logout
  54  * after_logout
  55  * after_login
  56  * login_failed
  57  *
  58  */
  59 class LogicHook{
  60
  61         var $bean = null;
  62
  63         function LogicHook(){
  64         }
  65
  66         /**
  67          * Static Function which returns and instance of LogicHook
  68          *
  69          * @return unknown
  70          */
  71         function initialize(){
  72                 if(empty($GLOBALS['logic_hook']))
  73                         $GLOBALS['logic_hook'] = new LogicHook();
  74                 return $GLOBALS['logic_hook'];
  75         }
  76
  77         function setBean(&$bean){
  78                 $this->bean =& $bean;
  79                 return $this;
  80         }
  81
  82         /**
  83          * Provide a means for developers to create upgrade safe business logic hooks.
  84          * If the bean is null, then we assume this call was not made from a SugarBean Object and
  85          * therefore we do not pass it to the method call.
  86          *
  87          * @param string $module_dir
  88          * @param string $event
  89          * @param array $arguments
  90          * @param SugarBean $bean
  91          */
  92         function call_custom_logic($module_dir, $event, $arguments = null){
  93                 // declare the hook array variable, it will be defined in the included file.
  94                 $hook_array = null;
  95
  96                 if(!empty($module_dir)){
  97                         // This will load an array of the hooks to process
  98                         if(file_exists("custom/modules/$module_dir/logic_hooks.php")){
  99                                 $GLOBALS['log']->debug('Including module specific hook file for '.$module_dir);
 100                                 include("custom/modules/$module_dir/logic_hooks.php");
 101                                 $this->process_hooks($hook_array, $event, $arguments);
 102                                 $hook_array = null;
 103                         }
 104                 }
 105                 // Now load the generic array if it exists.
 106                 if(file_exists('custom/modules/logic_hooks.php')){
 107                         $GLOBALS['log']->debug('Including generic hook file');
 108                         include('custom/modules/logic_hooks.php');
 109                         $this->process_hooks($hook_array, $event, $arguments);
 110                 }
 111         }
 112
 113         /**
 114          * This is called from call_custom_logic and actually performs the action as defined in the
 115          * logic hook. If the bean is null, then we assume this call was not made from a SugarBean Object and
 116          * therefore we do not pass it to the method call.
 117          *
 118          * @param array $hook_array
 119          * @param string $event
 120          * @param array $arguments
 121          * @param SugarBean $bean
 122          */
 123         function process_hooks($hook_array, $event, $arguments){
 124                 // Now iterate through the array for the appropriate hook
 125                 if(!empty($hook_array[$event])){
 126                         foreach($hook_array[$event] as $hook_details){
 127                                 if(!file_exists($hook_details[2])){
 128                                         $GLOBALS['log']->error('Unable to load custom logic file: '.$hook_details[2]);
 129                                         continue;
 130                                 }
 131                                 include_once($hook_details[2]);
 132                                 $hook_class = $hook_details[3];
 133                                 $hook_function = $hook_details[4];
 134
 135                                 // Make a static call to the function of the specified class
 136                                 //TODO Make a factory for these classes.  Cache instances accross uses
 137                                 if($hook_class == $hook_function){
 138                                         $GLOBALS['log']->debug('Creating new instance of hook class '.$hook_class.' with parameters');
 139                                         if(!is_null($this->bean))
 140                                                 $class = new $hook_class($this->bean, $event, $arguments);
 141                                         else
 142                                                 $class = new $hook_class($event, $arguments);
 143                                 }else{
 144                                         $GLOBALS['log']->debug('Creating new instance of hook class '.$hook_class.' without parameters');
 145                                         $class = new $hook_class();
 146                                         if(!is_null($this->bean))
 147                                                 $class->$hook_function($this->bean, $event, $arguments);
 148                                         else
 149                                                 $class->$hook_function($event, $arguments);
 150                                 }
 151                         }
 152                 }
 153         }
 154 }
 155 ?>