deon/phpldapadmin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

RELEASE 1.1.0

Browse Source
This commit is contained in:
Deon George
2009-06-30 20:46:00 +10:00
parent a08bc4e9e1
commit dd581eb5c8
191 changed files with 25012 additions and 10177 deletions
Download Patch File Download Diff File Expand all files Collapse all files

174
lib/hooks.php
View File

@@ -1,10 +1,10 @@
<?php
// $Header: /cvsroot/phpldapadmin/phpldapadmin/lib/hooks.php,v 1.8 2006/10/28 06:03:30 wurley Exp $
// $Header: /cvsroot/phpldapadmin/phpldapadmin/lib/hooks.php,v 1.10 2007/12/15 11:30:24 wurley Exp $
/**
* Functions related to hooks management.
*
* @author Benjamin Drieu <benjamin.drieu@fr.alcove.com> and Alcôve
* @author Benjamin Drieu <benjamin.drieu@fr.alcove.com> and Alc<EFBFBD>?ve
* @package phpLDAPadmin
*
* This program is free software; you can redistribute it and/or
@@ -14,7 +14,7 @@
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
@@ -23,23 +23,18 @@
* USA
*/
if ( ! isset($hooks) ) {
/** This variable contains all hooks that are defined. */
$hooks = array();
}
/**
* Compares two arrays by numerically comparing their 'prority'
* value. Standard `cmp-like' function.
* value. Standard `cmp-like' function.
*
* @param a First element to compare.
* @param b Second element to compare.
*
* @return -1 if priority of first element is smaller than second
* element priority. 1 otherwise.
* element priority. 1 otherwise.
*/
function sort_array_by_priority ( $a, $b ) {
return ( ( $a['priority'] < $b['priority'] ) ? -1 : 1 );
function sort_array_by_priority($a,$b) {
return (($a['priority'] < $b['priority']) ? -1 : 1 );
}
/**
@@ -47,114 +42,116 @@ function sort_array_by_priority ( $a, $b ) {
*
* @param hook_name Name of hook to run.
* @param args Array of optional arguments set by
* phpldapadmin. It is normally in a form known
* phpldapadmin. It is normally in a form known
* by call_user_func_array() :
* <pre>[ 'server_id' => 0,
* 'dn' => 'uid=epoussa,ou=tech,o=corp,o=fr' ]</pre>
* 'dn' => 'uid=epoussa,ou=tech,o=corp,o=fr' ]</pre>
*
* @return true if all procedures returned true, false otherwise.
*/
function run_hook ( $hook_name, $args ) {
global $hooks;
function run_hook($hook_name,$args) {
$hooks = isset($_SESSION['plaConfig']) ? $_SESSION['plaConfig']->hooks : array();
$debug = 0;
syslog_debug ( "Running hook $hook_name." );
$debug = 0;
syslog_debug("Running hook $hook_name.");
if ( ! array_key_exists ( $hook_name, $hooks ) ) {
syslog_notice ( "Hook '$hook_name' not defined !\n" );
return true;
}
if (! array_key_exists($hook_name,$hooks)) {
syslog_notice("Hook '$hook_name' not defined !\n");
return true;
}
unset ( $rollbacks );
$rollbacks = array ();
reset ( $hooks[$hook_name] );
unset($rollbacks);
$rollbacks = array ();
reset($hooks[$hook_name]);
/** Execution of procedures attached is done using a numeric order
* since all procedures have been attached to the hook with a
* numerical weight. */
while ( list ( $key, $hook ) = each ( $hooks[$hook_name] ) ) {
array_push ( $rollbacks, $hook['rollback_function'] );
syslog_debug ( "Calling " . $hook['hook_function'] . "\n" );
$result = call_user_func_array ( $hook['hook_function'], $args );
syslog_notice ( "Called " . $hook['hook_function'] . "\n" );
/* Execution of procedures attached is done using a numeric order
* since all procedures have been attached to the hook with a
* numerical weight. */
while (list($key,$hook) = each($hooks[$hook_name])) {
array_push($rollbacks,$hook['rollback_function']);
syslog_debug("Calling ".$hook['hook_function']."\n");
/** If a procedure fails, its optional rollback is executed with
* the same arguments. After that, all rollbacks from
* previously executed procedures are executed in the reverse
* order. */
if ( $result != true ) {
syslog_debug ( "Function " . $hook['hook_function'] . " returned $result\n" );
$result = call_user_func_array($hook['hook_function'],$args);
syslog_notice("Called ".$hook['hook_function']."\n");
while ( $rollbacks ) {
$rollback = array_pop ( $rollbacks );
/* If a procedure fails, its optional rollback is executed with
* the same arguments. After that, all rollbacks from
* previously executed procedures are executed in the reverse
* order. */
if ($result != true) {
syslog_debug("Function ".$hook['hook_function']." returned $result\n");
if ( $rollback != false ) {
syslog_debug ( "Executing rollback $rollback\n" );
call_user_func_array ( $rollback, $args );
while ($rollbacks) {
$rollback = array_pop($rollbacks);
if ($rollback != false) {
syslog_debug("Executing rollback $rollback\n");
call_user_func_array($rollback,$args);
}
}
return false;
}
}
}
return false;
}
}
return true;
return true;
}
/**
* Adds a procedure to a hook for later execution.
*
* @param hook_name Name of the hook.
* @param priority Numeric priority. Lowest means
* @param priority Numeric priority. Lowest means
* procedure will be executed before.
* @param hook_function Name of the php function called upon
* hook trigger.
* @param rollback_function Name of the php rollback function
* called upon failure.
*/
function add_hook ( $hook_name, $priority, $hook_function, $rollback_function ) {
global $hooks;
function add_hook($hook_name,$priority,$hook_function,$rollback_function) {
global $config;
if ( ! array_key_exists ( $hook_name, $hooks ) ) {
$hooks[$hook_name] = array();
}
if (! array_key_exists($hook_name,$config->hooks)) {
$config->hooks[$hook_name] = array();
}
array_push ( $hooks[$hook_name], array ( 'priority' => $priority, 'hook_function' => $hook_function,
'rollback_function' => $rollback_function ) );
remove_hook($hook_name,-1,$hook_function,'');
uasort ( $hooks[$hook_name], "sort_array_by_priority" );
array_push($config->hooks[$hook_name],array('priority' => $priority,'hook_function' => $hook_function,'rollback_function' => $rollback_function));
uasort($config->hooks[$hook_name],"sort_array_by_priority");
}
/**
* Removes a procedure from a hook, based on a filter.
*
* @param hook_name Name of the hook.
* @param priority Numeric priority. If set, all
* @param priority Numeric priority. If set, all
* procedures of that priority will be
* removed.
* @param hook_function Name of the procedure function. If
* @param hook_function Name of the procedure function. If
* set, all procedures that call this
* function will be removed.
* @param rollback_function Name of the php rollback function
* called upon failure. If set, all
* called upon failure. If set, all
* procedures that call this function
* as a rollback will be removed.
*/
function remove_hook ( $hook_name, $priority, $hook_function, $rollback_function ) {
global $hooks;
function remove_hook($hook_name,$priority,$hook_function,$rollback_function) {
global $config;
if ( array_key_exists ( $hook_name, $hooks ) ) {
reset ( $hooks[$hook_name] );
if (array_key_exists($hook_name,$config->hooks)) {
reset($config->hooks[$hook_name]);
while ( list ( $key, $hook ) = each ( $hooks[$hook_name] ) ) {
if ( ( $priority >= 0 && $priority == $hook['priority'] ) ||
( $hook_function && $hook_function == $hook['hook_function'] ) ||
( $rollback_function && $rollback_function == $hook['rollback_function'] ) ) {
unset ( $hooks[$hook_name][$key] );
}
while (list($key,$hook) = each($config->hooks[$hook_name])) {
if (($priority >= 0 && $priority == $hook['priority']) ||
($hook_function && $hook_function == $hook['hook_function']) ||
($rollback_function && $rollback_function == $hook['rollback_function'])) {
}
}
unset($config->hooks[$hook_name][$key]);
}
}
}
}
/**
@@ -162,25 +159,26 @@ function remove_hook ( $hook_name, $priority, $hook_function, $rollback_function
*
* @param hook_name Name of hook to clear.
*/
function clear_hooks ( $hook_name ) {
global $hooks;
function clear_hooks($hook_name) {
global $config;
if (!isset($config) && isset($_SESSION['plaConfig']))
$config = $_SESSION['plaConfig'];
if ( array_key_exists ( $hook_name, $hooks ) ) {
unset ( $hooks[$hook_name] );
}
if (array_key_exists($hook_name,$config->hooks))
unset($config->hooks[$hook_name]);
}
/* Evaluating user-made hooks */
if (is_dir(HOOKSDIR)) {
$dir = dir(HOOKSDIR);
# Evaluating user-made hooks
if (is_dir(HOOKSDIR.'functions')) {
$dir = dir(HOOKSDIR.'functions');
while (false !== ($entry = $dir->read())) {
$filename = sprintf('%s/%s/%s',HOOKSDIR,'functions',$entry);
while (false !== ($entry = $dir->read())) {
$filename = sprintf('%s/%s',HOOKSDIR,$entry);
if (is_file($filename) and eregi('php[0-9]?$',$entry))
require_once "hooks/$entry";
}
require_once "$filename";
}
$dir -> close();
$dir -> close();
}
?>