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         protected $hook_map = array();
  84         protected $hookscan = array();
  85
  86         public function getHooksMap()
  87         {
  88             return $this->hook_map;
  89         }
  90
  91         public function getHooksList()
  92         {
  93             return $this->hookscan;
  94         }
  95
  96     public function scanHooksDir($extpath)
  97     {
  98                 if(is_dir($extpath)){
  99                     $dir = dir($extpath);
 100                         while($entry = $dir->read()){
 101                                 if($entry != '.' && $entry != '..' && strtolower(substr($entry, -4)) == ".php" && is_file($extpath.'/'.$entry)) {
 102                                     unset($hook_array);
 103                     include($extpath.'/'.$entry);
 104                     if(!empty($hook_array)) {
 105                         foreach($hook_array as $type => $hookg) {
 106                             foreach($hookg as $index => $hook) {
 107                                 $this->hookscan[$type][] = $hook;
 108                                 $idx = count($this->hookscan[$type])-1;
 109                                 $this->hook_map[$type][$idx] = array("file" => $extpath.'/'.$entry, "index" => $index);
 110                             }
 111                         }
 112                     }
 113                                 }
 114                         }
 115                 }
 116     }
 117
 118         protected static $hooks = array();
 119
 120         static public function refreshHooks() {
 121             self::$hooks = array();
 122         }
 123
 124         public function loadHooks($module_dir)
 125         {
 126                 $hook_array = null;
 127             if(!empty($module_dir)) {
 128                 $custom = "custom/modules/$module_dir";
 129             } else {
 130                 $custom = "custom/modules";
 131             }
 132                 if(file_exists("$custom/logic_hooks.php")){
 133             if(isset($GLOBALS['log'])){
 134                     $GLOBALS['log']->debug('Including module specific hook file for '.$custom);
 135             }
 136                     include("$custom/logic_hooks.php");
 137                 }
 138                 if(empty($module_dir)) {
 139                     $custom = "custom/application";
 140                 }
 141                 if(file_exists("$custom/Ext/LogicHooks/logichooks.ext.php")) {
 142             if(isset($GLOBALS['log'])){
 143                             $GLOBALS['log']->debug('Including Ext hook file for '.$custom);
 144             }
 145                         include("$custom/Ext/LogicHooks/logichooks.ext.php");
 146                 }
 147                 return $hook_array;
 148         }
 149
 150         public function getHooks($module_dir, $refresh = false)
 151         {
 152             if($refresh || !isset(self::$hooks[$module_dir])) {
 153                 self::$hooks[$module_dir] = $this->loadHooks($module_dir);
 154             }
 155             return self::$hooks[$module_dir];
 156         }
 157
 158         /**
 159          * Provide a means for developers to create upgrade safe business logic hooks.
 160          * If the bean is null, then we assume this call was not made from a SugarBean Object and
 161          * therefore we do not pass it to the method call.
 162          *
 163          * @param string $module_dir
 164          * @param string $event
 165          * @param array $arguments
 166          * @param SugarBean $bean
 167          */
 168         function call_custom_logic($module_dir, $event, $arguments = null){
 169                 // declare the hook array variable, it will be defined in the included file.
 170                 $hook_array = null;
 171         if(isset($GLOBALS['log'])){
 172             $GLOBALS['log']->debug("Hook called: $module_dir::$event");
 173         }
 174                 if(!empty($module_dir)){
 175                         // This will load an array of the hooks to process
 176                         $hooks = $this->getHooks($module_dir);
 177                         if(!empty($hooks)) {
 178                             $this->process_hooks($hooks, $event, $arguments);
 179                         }
 180                 }
 181                 $hooks = $this->getHooks('');
 182                 if(!empty($hooks)) {
 183                     $this->process_hooks($hooks, $event, $arguments);
 184                 }
 185         }
 186
 187         /**
 188          * This is called from call_custom_logic and actually performs the action as defined in the
 189          * logic hook. If the bean is null, then we assume this call was not made from a SugarBean Object and
 190          * therefore we do not pass it to the method call.
 191          *
 192          * @param array $hook_array
 193          * @param string $event
 194          * @param array $arguments
 195          * @param SugarBean $bean
 196          */
 197         function process_hooks($hook_array, $event, $arguments){
 198                 // Now iterate through the array for the appropriate hook
 199                 if(!empty($hook_array[$event])){
 200
 201                         // Apply sorting to the hooks using the sort index.
 202                         // Hooks with matching sort indexes will be processed in no particular order.
 203                         $sorted_indexes = array();
 204                         foreach($hook_array[$event] as $idx => $hook_details)
 205                         {
 206                                 $order_idx = $hook_details[0];
 207                                 $sorted_indexes[$idx] = $order_idx;
 208                         }
 209                         asort($sorted_indexes);
 210
 211                         $process_order = array_keys($sorted_indexes);
 212
 213                         foreach($process_order as $hook_index){
 214                                 $hook_details = $hook_array[$event][$hook_index];
 215                                 if(!file_exists($hook_details[2])){
 216                     if(isset($GLOBALS['log'])){
 217                                             $GLOBALS['log']->error('Unable to load custom logic file: '.$hook_details[2]);
 218                     }
 219                                         continue;
 220                                 }
 221                                 include_once($hook_details[2]);
 222                                 $hook_class = $hook_details[3];
 223                                 $hook_function = $hook_details[4];
 224
 225                                 // Make a static call to the function of the specified class
 226                                 //TODO Make a factory for these classes.  Cache instances accross uses
 227                                 if($hook_class == $hook_function){
 228                     if(isset($GLOBALS['log'])){
 229                                             $GLOBALS['log']->debug('Creating new instance of hook class '.$hook_class.' with parameters');
 230                     }
 231                                         if(!is_null($this->bean))
 232                                                 $class = new $hook_class($this->bean, $event, $arguments);
 233                                         else
 234                                                 $class = new $hook_class($event, $arguments);
 235                                 }else{
 236                     if(isset($GLOBALS['log'])){
 237                                             $GLOBALS['log']->debug('Creating new instance of hook class '.$hook_class.' without parameters');
 238                     }
 239                                         $class = new $hook_class();
 240                                         if(!is_null($this->bean))
 241                                                 $class->$hook_function($this->bean, $event, $arguments);
 242                                         else
 243                                                 $class->$hook_function($event, $arguments);
 244                                 }
 245                         }
 246                 }
 247         }
 248 }
 249 ?>