include/utils/LogicHook.php

   1 <?php
   2 if(!defined('sugarEntry') || !sugarEntry) die('Not A Valid Entry Point');
   3 /*********************************************************************************
   4  * SugarCRM Community Edition 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  * before_login
  56  * after_login
  57  * login_failed
  58  *
  59  */
  60 class LogicHook{
  61
  62         var $bean = null;
  63
  64         function LogicHook(){
  65         }
  66
  67         /**
  68          * Static Function which returns and instance of LogicHook
  69          *
  70          * @return unknown
  71          */
  72         function initialize(){
  73                 if(empty($GLOBALS['logic_hook']))
  74                         $GLOBALS['logic_hook'] = new LogicHook();
  75                 return $GLOBALS['logic_hook'];
  76         }
  77
  78         function setBean(&$bean){
  79                 $this->bean =& $bean;
  80                 return $this;
  81         }
  82
  83         /**
  84          * Provide a means for developers to create upgrade safe business logic hooks.
  85          * If the bean is null, then we assume this call was not made from a SugarBean Object and
  86          * therefore we do not pass it to the method call.
  87          *
  88          * @param string $module_dir
  89          * @param string $event
  90          * @param array $arguments
  91          * @param SugarBean $bean
  92          */
  93         function call_custom_logic($module_dir, $event, $arguments = null){
  94                 // declare the hook array variable, it will be defined in the included file.
  95                 $hook_array = null;
  96         if(isset($GLOBALS['log'])){
  97             $GLOBALS['log']->debug("Hook called: $module_dir::$event");
  98         }
  99                 if(!empty($module_dir)){
 100                         // This will load an array of the hooks to process
 101                         if(file_exists("custom/modules/$module_dir/logic_hooks.php")){
 102                 if(isset($GLOBALS['log'])){
 103                                     $GLOBALS['log']->debug('Including module specific hook file for '.$module_dir);
 104                 }
 105                                 include("custom/modules/$module_dir/logic_hooks.php");
 106                                 $this->process_hooks($hook_array, $event, $arguments);
 107                                 $hook_array = null;
 108                         }
 109                 }
 110                 // Now load the generic array if it exists.
 111                 if(file_exists('custom/modules/logic_hooks.php')){
 112             if(isset($GLOBALS['log'])){
 113                             $GLOBALS['log']->debug('Including generic hook file');
 114             }
 115                         include('custom/modules/logic_hooks.php');
 116                         $this->process_hooks($hook_array, $event, $arguments);
 117                 }
 118         }
 119
 120         /**
 121          * This is called from call_custom_logic and actually performs the action as defined in the
 122          * logic hook. If the bean is null, then we assume this call was not made from a SugarBean Object and
 123          * therefore we do not pass it to the method call.
 124          *
 125          * @param array $hook_array
 126          * @param string $event
 127          * @param array $arguments
 128          * @param SugarBean $bean
 129          */
 130         function process_hooks($hook_array, $event, $arguments){
 131                 // Now iterate through the array for the appropriate hook
 132                 if(!empty($hook_array[$event])){
 133                         foreach($hook_array[$event] as $hook_details){
 134                                 if(!file_exists($hook_details[2])){
 135                     if(isset($GLOBALS['log'])){
 136                                             $GLOBALS['log']->error('Unable to load custom logic file: '.$hook_details[2]);
 137                     }
 138                                         continue;
 139                                 }
 140                                 include_once($hook_details[2]);
 141                                 $hook_class = $hook_details[3];
 142                                 $hook_function = $hook_details[4];
 143
 144                                 // Make a static call to the function of the specified class
 145                                 //TODO Make a factory for these classes.  Cache instances accross uses
 146                                 if($hook_class == $hook_function){
 147                     if(isset($GLOBALS['log'])){
 148                                             $GLOBALS['log']->debug('Creating new instance of hook class '.$hook_class.' with parameters');
 149                     }
 150                                         if(!is_null($this->bean))
 151                                                 $class = new $hook_class($this->bean, $event, $arguments);
 152                                         else
 153                                                 $class = new $hook_class($event, $arguments);
 154                                 }else{
 155                     if(isset($GLOBALS['log'])){
 156                                             $GLOBALS['log']->debug('Creating new instance of hook class '.$hook_class.' without parameters');
 157                     }
 158                                         $class = new $hook_class();
 159                                         if(!is_null($this->bean))
 160                                                 $class->$hook_function($this->bean, $event, $arguments);
 161                                         else
 162                                                 $class->$hook_function($event, $arguments);
 163                                 }
 164                         }
 165                 }
 166         }
 167 }
 168 ?>