dolibarr  18.0.0-alpha
hookmanager.class.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2010-2016 Laurent Destailleur <eldy@users.sourceforge.net>
3  * Copyright (C) 2010-2014 Regis Houssin <regis.houssin@inodbox.com>
4  * Copyright (C) 2010-2011 Juanjo Menent <jmenent@2byte.es>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program. If not, see <https://www.gnu.org/licenses/>.
18  */
19 
31 {
35  public $db;
36 
40  public $error = '';
41 
45  public $errors = array();
46 
47  // Context hookmanager was created for ('thirdpartycard', 'thirdpartydao', ...)
48  public $contextarray = array();
49 
50  // Array with instantiated classes
51  public $hooks = array();
52 
53  // Array result
54  public $resArray = array();
55  // Printable result
56  public $resPrint = '';
57  // Nb of qualified hook ran
58  public $resNbOfHooks = 0;
59 
65  public function __construct($db)
66  {
67  $this->db = $db;
68  }
69 
70 
82  public function initHooks($arraycontext)
83  {
84  global $conf;
85 
86  // Test if there is hooks to manage
87  if (!is_array($conf->modules_parts['hooks']) || empty($conf->modules_parts['hooks'])) {
88  return;
89  }
90 
91  // For backward compatibility
92  if (!is_array($arraycontext)) {
93  $arraycontext = array($arraycontext);
94  }
95 
96  $this->contextarray = array_unique(array_merge($arraycontext, $this->contextarray)); // All contexts are concatenated
97 
98  $arraytolog = array();
99  foreach ($conf->modules_parts['hooks'] as $module => $hooks) { // Loop on each module that brings hooks
100  if (empty($conf->$module->enabled)) {
101  continue;
102  }
103 
104  //dol_syslog(get_class($this).'::initHooks module='.$module.' arraycontext='.join(',',$arraycontext));
105  foreach ($arraycontext as $context) {
106  if (is_array($hooks)) {
107  $arrayhooks = $hooks; // New system
108  } else {
109  $arrayhooks = explode(':', $hooks); // Old system (for backward compatibility)
110  }
111 
112  if (in_array($context, $arrayhooks) || in_array('all', $arrayhooks)) { // We instantiate action class only if initialized hook is handled by module
113  // Include actions class overwriting hooks
114  if (empty($this->hooks[$context][$module]) || !is_object($this->hooks[$context][$module])) { // If set to an object value, class was already loaded so we do nothing.
115  $path = '/'.$module.'/class/';
116  $actionfile = 'actions_'.$module.'.class.php';
117 
118  $arraytolog[] = 'context='.$context.'-path='.$path.$actionfile;
119  $resaction = dol_include_once($path.$actionfile);
120  if ($resaction) {
121  $controlclassname = 'Actions'.ucfirst($module);
122  $actionInstance = new $controlclassname($this->db);
123  $priority = empty($actionInstance->priority) ? 50 : $actionInstance->priority;
124  $this->hooks[$context][$priority.':'.$module] = $actionInstance;
125  }
126  }
127  }
128  }
129  }
130  // Log the init of hook but only for hooks thare are declared to be managed
131  if (count($arraytolog) > 0) {
132  dol_syslog(get_class($this)."::initHooks Loading hooks: ".join(', ', $arraytolog), LOG_DEBUG);
133  }
134 
135  foreach ($arraycontext as $context) {
136  if (!empty($this->hooks[$context])) {
137  ksort($this->hooks[$context], SORT_NATURAL);
138  }
139  }
140 
141  return 1;
142  }
143 
156  public function executeHooks($method, $parameters = array(), &$object = '', &$action = '')
157  {
158  if (!is_array($this->hooks) || empty($this->hooks)) {
159  return 0; // No hook available, do nothing.
160  }
161 
162  $parameters['context'] = join(':', $this->contextarray);
163  //dol_syslog(get_class($this).'::executeHooks method='.$method." action=".$action." context=".$parameters['context']);
164 
165  // Define type of hook ('output' or 'addreplace').
166  $hooktype = 'addreplace';
167  // TODO Remove hooks with type 'output' (exemple createFrom). All hooks must be converted into 'addreplace' hooks.
168  if (in_array($method, array(
169  'createFrom',
170  'dashboardAccountancy',
171  'dashboardActivities',
172  'dashboardCommercials',
173  'dashboardContracts',
174  'dashboardDonation',
175  'dashboardEmailings',
176  'dashboardExpenseReport',
177  'dashboardHRM',
178  'dashboardInterventions',
179  'dashboardMRP',
180  'dashboardMembers',
181  'dashboardOpensurvey',
182  'dashboardOrders',
183  'dashboardOrdersSuppliers',
184  'dashboardProductServices',
185  'dashboardProjects',
186  'dashboardPropals',
187  'dashboardSpecialBills',
188  'dashboardSupplierProposal',
189  'dashboardThirdparties',
190  'dashboardTickets',
191  'dashboardUsersGroups',
192  'dashboardWarehouse',
193  'dashboardWarehouseReceptions',
194  'dashboardWarehouseSendings',
195  'insertExtraHeader',
196  'insertExtraFooter',
197  'printLeftBlock',
198  'formAddObjectLine',
199  'formBuilddocOption',
200  'showSocinfoOnPrint'
201  ))) {
202  $hooktype = 'output';
203  }
204 
205  // Init return properties
206  $this->resPrint = '';
207  $this->resArray = array();
208  $this->resNbOfHooks = 0;
209 
210  // Here, the value for $method and $hooktype are given.
211  // Loop on each hook to qualify modules that have declared context
212  $modulealreadyexecuted = array();
213  $resaction = 0;
214  $error = 0;
215  foreach ($this->hooks as $context => $modules) { // $this->hooks is an array with context as key and value is an array of modules that handle this context
216  if (!empty($modules)) {
217  // Loop on each active hooks of module for this context
218  foreach ($modules as $module => $actionclassinstance) {
219  $module = preg_replace('/^\d+:/', '', $module);
220  //print "Before hook ".get_class($actionclassinstance)." method=".$method." module=".$module." hooktype=".$hooktype." results=".count($actionclassinstance->results)." resprints=".count($actionclassinstance->resprints)." resaction=".$resaction."<br>\n";
221 
222  // test to avoid running twice a hook, when a module implements several active contexts
223  if (in_array($module, $modulealreadyexecuted)) {
224  continue;
225  }
226 
227  // jump to next module/class if method does not exist
228  if (!method_exists($actionclassinstance, $method)) {
229  continue;
230  }
231 
232  $this->resNbOfHooks++;
233 
234  $modulealreadyexecuted[$module] = $module;
235 
236  // Clean class (an error may have been set from a previous call of another method for same module/hook)
237  $actionclassinstance->error = 0;
238  $actionclassinstance->errors = array();
239 
240  if (getDolGlobalInt('MAIN_DEBUG_SHOW_EACH_QUALIFIED_HOOK_CALL') >= 2) {
241  // This his too much verbose, enabled in develop only
242  dol_syslog(get_class($this)."::executeHooks Qualified hook found (hooktype=".$hooktype."). We call method ".get_class($actionclassinstance).'->'.$method.", context=".$context.", module=".$module.", action=".$action.((is_object($object) && property_exists($object, 'id')) ? ', object id='.$object->id : '').((is_object($object) && property_exists($object, 'element')) ? ', object element='.$object->element : ''), LOG_DEBUG);
243  }
244 
245  // Add current context to avoid method execution in bad context, you can add this test in your method : eg if($currentcontext != 'formfile') return;
246  // Note: The hook can use the $currentcontext in its code to avoid to be ran twice or be ran for one given context only
247  $parameters['currentcontext'] = $context;
248  // Hooks that must return int (hooks with type 'addreplace')
249  if ($hooktype == 'addreplace') {
250  $resactiontmp = $actionclassinstance->$method($parameters, $object, $action, $this); // $object and $action can be changed by method ($object->id during creation for example or $action to go back to other action for example)
251  $resaction += $resactiontmp;
252 
253  if ($resactiontmp < 0 || !empty($actionclassinstance->error) || (!empty($actionclassinstance->errors) && count($actionclassinstance->errors) > 0)) {
254  $error++;
255  $this->error = $actionclassinstance->error;
256  $this->errors = array_merge($this->errors, (array) $actionclassinstance->errors);
257  dol_syslog("Error on hook module=".$module.", method ".$method.", class ".get_class($actionclassinstance).", hooktype=".$hooktype.(empty($this->error) ? '' : " ".$this->error).(empty($this->errors) ? '' : " ".join(",", $this->errors)), LOG_ERR);
258  }
259 
260  if (isset($actionclassinstance->results) && is_array($actionclassinstance->results)) {
261  if ($resactiontmp > 0) {
262  $this->resArray = $actionclassinstance->results;
263  } else {
264  $this->resArray = array_merge($this->resArray, $actionclassinstance->results);
265  }
266  }
267  if (!empty($actionclassinstance->resprints)) {
268  if ($resactiontmp > 0) {
269  $this->resPrint = $actionclassinstance->resprints;
270  } else {
271  $this->resPrint .= $actionclassinstance->resprints;
272  }
273  }
274  } else {
275  // Generic hooks that return a string or array (printLeftBlock, formAddObjectLine, formBuilddocOptions, ...)
276 
277  // TODO. this test should be done into the method of hook by returning nothing
278  if (is_array($parameters) && !empty($parameters['special_code']) && $parameters['special_code'] > 3 && $parameters['special_code'] != $actionclassinstance->module_number) {
279  continue;
280  }
281 
282  //dol_syslog("Call method ".$method." of class ".get_class($actionclassinstance).", module=".$module.", hooktype=".$hooktype, LOG_DEBUG);
283  $resactiontmp = $actionclassinstance->$method($parameters, $object, $action, $this); // $object and $action can be changed by method ($object->id during creation for example or $action to go back to other action for example)
284  $resaction += $resactiontmp;
285 
286  if (!empty($actionclassinstance->results) && is_array($actionclassinstance->results)) {
287  $this->resArray = array_merge($this->resArray, $actionclassinstance->results);
288  }
289  if (!empty($actionclassinstance->resprints)) {
290  $this->resPrint .= $actionclassinstance->resprints;
291  }
292  if (is_numeric($resactiontmp) && $resactiontmp < 0) {
293  $error++;
294  $this->error = $actionclassinstance->error;
295  $this->errors = array_merge($this->errors, (array) $actionclassinstance->errors);
296  dol_syslog("Error on hook module=".$module.", method ".$method.", class ".get_class($actionclassinstance).", hooktype=".$hooktype.(empty($this->error) ? '' : " ".$this->error).(empty($this->errors) ? '' : " ".join(",", $this->errors)), LOG_ERR);
297  }
298 
299  // TODO dead code to remove (do not disable this, but fix your hook instead): result must not be a string but an int. you must use $actionclassinstance->resprints to return a string
300  if (!is_array($resactiontmp) && !is_numeric($resactiontmp)) {
301  dol_syslog('Error: Bug into hook '.$method.' of module class '.get_class($actionclassinstance).'. Method must not return a string but an int (0=OK, 1=Replace, -1=KO) and set string into ->resprints', LOG_ERR);
302  if (empty($actionclassinstance->resprints)) {
303  $this->resPrint .= $resactiontmp;
304  }
305  }
306  }
307 
308  //print "After hook context=".$context." ".get_class($actionclassinstance)." method=".$method." hooktype=".$hooktype." results=".count($actionclassinstance->results)." resprints=".count($actionclassinstance->resprints)." resaction=".$resaction."<br>\n";
309 
310  unset($actionclassinstance->results);
311  unset($actionclassinstance->resprints);
312  }
313  }
314  }
315 
316  return ($error ? -1 : $resaction);
317  }
318 }
db
$conf db
API class for accounts.
Definition: inc.php:41
HookManager\__construct
__construct($db)
Constructor.
Definition: hookmanager.class.php:65
dol_include_once
if(!function_exists('dol_getprefix')) dol_include_once($relpath, $classname='')
Make an include_once using default root and alternate root if it fails.
Definition: functions.lib.php:1043
HookManager\initHooks
initHooks($arraycontext)
Init array $this->hooks with instantiated action controlers.
Definition: hookmanager.class.php:82
dol_syslog
dol_syslog($message, $level=LOG_INFO, $ident=0, $suffixinfilename='', $restricttologhandler='', $logcontext=null)
Write log message into outputs.
Definition: functions.lib.php:1639
HookManager\executeHooks
executeHooks($method, $parameters=array(), &$object='', &$action='')
Execute hooks (if they were initialized) for the given method.
Definition: hookmanager.class.php:156
getDolGlobalInt
getDolGlobalInt($key, $default=0)
Return dolibarr global constant int value.
Definition: functions.lib.php:96
HookManager
Class to manage hooks.
Definition: hookmanager.class.php:30