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