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-2012 SugarCRM Inc.
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.
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
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
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.
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.
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 ********************************************************************************/
40 * Predefined logic hooks
71 * Static Function which returns and instance of LogicHook
75 function initialize(){
76 if(empty($GLOBALS['logic_hook']))
77 $GLOBALS['logic_hook'] = new LogicHook();
78 return $GLOBALS['logic_hook'];
81 function setBean($bean){
86 protected $hook_map = array();
87 protected $hookscan = array();
89 public function getHooksMap()
91 return $this->hook_map;
94 public function getHooksList()
96 return $this->hookscan;
99 public function scanHooksDir($extpath)
101 if(is_dir($extpath)){
102 $dir = dir($extpath);
103 while($entry = $dir->read()){
104 if($entry != '.' && $entry != '..' && strtolower(substr($entry, -4)) == ".php" && is_file($extpath.'/'.$entry)) {
106 include($extpath.'/'.$entry);
107 if(!empty($hook_array)) {
108 foreach($hook_array as $type => $hookg) {
109 foreach($hookg as $index => $hook) {
110 $this->hookscan[$type][] = $hook;
111 $idx = count($this->hookscan[$type])-1;
112 $this->hook_map[$type][$idx] = array("file" => $extpath.'/'.$entry, "index" => $index);
121 protected static $hooks = array();
123 static public function refreshHooks() {
124 self::$hooks = array();
127 public function loadHooks($module_dir)
130 if(!empty($module_dir)) {
131 $custom = "custom/modules/$module_dir";
133 $custom = "custom/modules";
135 if(file_exists("$custom/logic_hooks.php")){
136 if(isset($GLOBALS['log'])){
137 $GLOBALS['log']->debug('Including module specific hook file for '.$custom);
139 include("$custom/logic_hooks.php");
141 if(empty($module_dir)) {
142 $custom = "custom/application";
144 if(file_exists("$custom/Ext/LogicHooks/logichooks.ext.php")) {
145 if(isset($GLOBALS['log'])){
146 $GLOBALS['log']->debug('Including Ext hook file for '.$custom);
148 include("$custom/Ext/LogicHooks/logichooks.ext.php");
153 public function getHooks($module_dir, $refresh = false)
155 if($refresh || !isset(self::$hooks[$module_dir])) {
156 self::$hooks[$module_dir] = $this->loadHooks($module_dir);
158 return self::$hooks[$module_dir];
162 * Provide a means for developers to create upgrade safe business logic hooks.
163 * If the bean is null, then we assume this call was not made from a SugarBean Object and
164 * therefore we do not pass it to the method call.
166 * @param string $module_dir
167 * @param string $event
168 * @param array $arguments
169 * @param SugarBean $bean
171 function call_custom_logic($module_dir, $event, $arguments = null){
172 // declare the hook array variable, it will be defined in the included file.
174 if(isset($GLOBALS['log'])){
175 $GLOBALS['log']->debug("Hook called: $module_dir::$event");
177 if(!empty($module_dir)){
178 // This will load an array of the hooks to process
179 $hooks = $this->getHooks($module_dir);
181 $this->process_hooks($hooks, $event, $arguments);
184 $hooks = $this->getHooks('');
186 $this->process_hooks($hooks, $event, $arguments);
191 * This is called from call_custom_logic and actually performs the action as defined in the
192 * logic hook. If the bean is null, then we assume this call was not made from a SugarBean Object and
193 * therefore we do not pass it to the method call.
195 * @param array $hook_array
196 * @param string $event
197 * @param array $arguments
198 * @param SugarBean $bean
200 function process_hooks($hook_array, $event, $arguments){
201 // Now iterate through the array for the appropriate hook
202 if(!empty($hook_array[$event])){
204 // Apply sorting to the hooks using the sort index.
205 // Hooks with matching sort indexes will be processed in no particular order.
206 $sorted_indexes = array();
207 foreach($hook_array[$event] as $idx => $hook_details)
209 $order_idx = $hook_details[0];
210 $sorted_indexes[$idx] = $order_idx;
212 asort($sorted_indexes);
214 $process_order = array_keys($sorted_indexes);
216 foreach($process_order as $hook_index){
217 $hook_details = $hook_array[$event][$hook_index];
218 if(!file_exists($hook_details[2])){
219 if(isset($GLOBALS['log'])){
220 $GLOBALS['log']->error('Unable to load custom logic file: '.$hook_details[2]);
224 include_once($hook_details[2]);
225 $hook_class = $hook_details[3];
226 $hook_function = $hook_details[4];
228 // Make a static call to the function of the specified class
229 //TODO Make a factory for these classes. Cache instances accross uses
230 if($hook_class == $hook_function){
231 if(isset($GLOBALS['log'])){
232 $GLOBALS['log']->debug('Creating new instance of hook class '.$hook_class.' with parameters');
234 if(!is_null($this->bean))
235 $class = new $hook_class($this->bean, $event, $arguments);
237 $class = new $hook_class($event, $arguments);
239 if(isset($GLOBALS['log'])){
240 $GLOBALS['log']->debug('Creating new instance of hook class '.$hook_class.' without parameters');
242 $class = new $hook_class();
243 if(!is_null($this->bean))
244 $class->$hook_function($this->bean, $event, $arguments);
246 $class->$hook_function($event, $arguments);