2009-06-30 08:07:14 +00:00
< ? php
2009-06-30 10:46:00 +00:00
// $Header: /cvsroot/phpldapadmin/phpldapadmin/lib/functions.php,v 1.303 2007/12/15 07:50:32 wurley Exp $
2009-06-30 09:22:30 +00:00
/**
2009-06-30 08:07:14 +00:00
* A collection of functions used throughout phpLDAPadmin .
2009-06-30 09:22:30 +00:00
* @ author The phpLDAPadmin development team
* @ package phpLDAPadmin
*/
2009-06-30 09:40:37 +00:00
define ( 'HTDOCDIR' , sprintf ( '%s/' , realpath ( LIBDIR . '../htdocs/' )));
2009-06-30 10:26:08 +00:00
define ( 'LANGDIR' , sprintf ( '%s/' , realpath ( LIBDIR . '../locale/' )));
2009-06-30 09:40:37 +00:00
define ( 'CONFDIR' , sprintf ( '%s/' , realpath ( LIBDIR . '../config' )));
define ( 'TMPLDIR' , sprintf ( '%s/' , realpath ( LIBDIR . '../templates/' )));
define ( 'DOCDIR' , sprintf ( '%s/' , realpath ( LIBDIR . '../doc/' )));
2009-06-30 10:26:45 +00:00
define ( 'HOOKSDIR' , sprintf ( '%s/' , realpath ( LIBDIR . '../hooks/' )));
2009-06-30 09:40:37 +00:00
define ( 'CSSDIR' , 'css/' );
define ( 'JSDIR' , 'js/' );
2009-06-30 09:29:51 +00:00
/* Supplimental functions
* This list is a list of supplimental functions that are used throughout PLA . The
* order here IS important - so that files that refer to functions defined in other files
* need to be listed after those files .*/
$pla_function_files = array (
# Functions for talking to LDAP servers.
LIBDIR . 'server_functions.php' ,
# Functions for sending syslog messages
LIBDIR . 'syslog.php' ,
# Functions for managing the session (pla_session_start(), etc.)
LIBDIR . 'session_functions.php' ,
2009-06-30 09:40:37 +00:00
# Functions for reading the server schema
2009-06-30 09:29:51 +00:00
LIBDIR . 'schema_functions.php' ,
# Functions for template manipulation.
LIBDIR . 'template_functions.php' ,
# Functions for hashing passwords with OpenSSL binary (only if mhash not present)
LIBDIR . 'emuhash_functions.php' ,
# Functions for running various hooks
LIBDIR . 'hooks.php' ,
2009-06-30 09:40:37 +00:00
# Functions for creating Samba passwords
LIBDIR . 'createlm.php' ,
2009-06-30 09:29:51 +00:00
# Functions for timeout and automatic logout feature
2009-06-30 10:46:00 +00:00
LIBDIR . 'timeout_functions.php' ,
# Functions for rendering the page
LIBDIR . 'page.php'
2009-06-30 09:29:51 +00:00
);
2009-06-30 10:46:00 +00:00
/**
* Loads class definition
*/
function __autoload ( $className ) {
if ( defined ( 'DEBUG_ENABLED' ) && DEBUG_ENABLED )
debug_log ( '__autoload(%s)' , 1 , __FILE__ , __LINE__ , __METHOD__ , $className );
if ( file_exists ( HOOKSDIR . " classes/ $className .php " ))
require_once ( HOOKSDIR . " classes/ $className .php " );
else
require_once ( LIBDIR . " $className .php " );
}
2009-06-30 09:22:30 +00:00
/**
2009-06-30 09:29:51 +00:00
* Fetches whether the user has configured phpLDAPadmin to obfuscate passwords
* with " ********* " when displaying them .
2009-06-30 09:22:30 +00:00
*
* This is configured in config . php thus :
* < code >
* $obfuscate_password_display = true ;
* </ code >
*
2009-06-30 09:29:51 +00:00
* @ param string $enc Password encoding type
2009-06-30 09:22:30 +00:00
* @ return bool
*/
2009-06-30 09:29:51 +00:00
function obfuscate_password_display ( $enc = null ) {
2009-06-30 10:46:00 +00:00
if ( $_SESSION [ 'plaConfig' ] -> GetValue ( 'appearance' , 'obfuscate_password_display' ))
2009-06-30 09:29:51 +00:00
$return = true ;
2009-06-30 10:46:00 +00:00
elseif ( ! $_SESSION [ 'plaConfig' ] -> GetValue ( 'appearance' , 'show_clear_password' ) && ( is_null ( $enc ) || $enc == 'clear' ))
2009-06-30 09:29:51 +00:00
$return = true ;
2009-06-30 08:10:17 +00:00
2009-06-30 09:22:30 +00:00
else
2009-06-30 09:29:51 +00:00
$return = false ;
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:46:00 +00:00
debug_log ( 'Entered with (%s), Returning (%s)' , 1 , __FILE__ , __LINE__ , __METHOD__ ,
$enc , $return );
2009-06-30 09:40:37 +00:00
2009-06-30 09:29:51 +00:00
return $return ;
2009-06-30 09:22:30 +00:00
}
2009-06-30 09:29:51 +00:00
/**
2009-06-30 08:10:17 +00:00
* Returns an HTML - beautified version of a DN .
2009-06-30 09:29:51 +00:00
* Internally , this function makes use of pla_explode_dn () to break the
2009-06-30 09:22:30 +00:00
* the DN into its components . It then glues them back together with
2009-06-30 09:29:51 +00:00
* " pretty " HTML . The returned HTML is NOT to be used as a real DN , but
2009-06-30 09:22:30 +00:00
* simply displayed .
2009-06-30 09:29:51 +00:00
*
2009-06-30 09:22:30 +00:00
* @ param string $dn The DN to pretty - print .
* @ return string
2009-06-30 08:10:17 +00:00
*/
2009-06-30 10:46:00 +00:00
function pretty_print_dn ( $dn ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:46:00 +00:00
debug_log ( 'Entered with (%s)' , 1 , __FILE__ , __LINE__ , __METHOD__ , $dn );
# @todo: Disabled, as it is affecting the special chars being displayed.
# if (! is_dn_string($dn))
# return $dn;
$dn_save = $dn ;
$dn = pla_explode_dn ( $dn );
2009-06-30 09:29:51 +00:00
2009-06-30 10:46:00 +00:00
if ( ! $dn )
return $dn_save ;
2009-06-30 10:40:33 +00:00
2009-06-30 10:46:00 +00:00
foreach ( $dn as $i => $element ) {
2009-06-30 09:40:37 +00:00
$element = htmlspecialchars ( $element );
$element = explode ( '=' , $element , 2 );
$element = implode ( '<span style="color: blue; font-family: courier; font-weight: bold">=</span>' , $element );
2009-06-30 08:10:17 +00:00
$dn [ $i ] = $element ;
}
2009-06-30 10:46:00 +00:00
2009-06-30 09:40:37 +00:00
$dn = implode ( '<span style="color:red; font-family:courier; font-weight: bold;">,</span>' , $dn );
2009-06-30 08:10:17 +00:00
return $dn ;
}
2009-06-30 09:22:30 +00:00
/**
* Given a string , this function returns true if the string has the format
* of a DN ( ie , looks like " cn=Foo,dc=example,dc=com " ) . Returns false otherwise .
* The purpose of this function is so that developers can examine a string and
* know if it looks like a DN , and draw a hyperlink as needed .
*
* ( See unit_test . php for test cases )
*
* @ param string $attr The attribute to examine for " DNness "
* @ see unit_test . php
* @ return bool
2009-06-30 08:10:17 +00:00
*/
2009-06-30 09:40:37 +00:00
function is_dn_string ( $str ) {
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'is_dn_string(): Entered with (%s)' , 1 , $str );
2009-06-30 09:40:37 +00:00
/* Try to break the string into its component parts if it can be done
ie , " uid=Manager " " dc=example " and " dc=com " */
$parts = pla_explode_dn ( $str );
if ( ! is_array ( $parts ) || ! count ( $parts ))
return false ;
/* Foreach of the " parts " , look for an " = " character ,
and make sure neither the left nor the right is empty */
foreach ( $parts as $part ) {
if ( ! strpos ( $part , " = " ))
return false ;
2009-06-30 10:46:00 +00:00
$sub_parts = explode ( '=' , $part , 2 );
2009-06-30 09:40:37 +00:00
$left = $sub_parts [ 0 ];
$right = $sub_parts [ 1 ];
if ( ! strlen ( trim ( $left )) || ! strlen ( trim ( $right )))
return false ;
2009-06-30 09:22:30 +00:00
2009-06-30 09:40:37 +00:00
if ( strpos ( $left , '#' ) !== false )
return false ;
}
# We survived the above rigor. This is a bonified DN string.
return true ;
2009-06-30 08:09:20 +00:00
}
2009-06-30 09:29:51 +00:00
/**
2009-06-30 09:22:30 +00:00
* Get whether a string looks like an email address ( user @ example . com ) .
2009-06-30 09:29:51 +00:00
*
2009-06-30 09:22:30 +00:00
* @ param string $str The string to analyze .
2009-06-30 09:29:51 +00:00
* @ return bool Returns true if the specified string looks like
2009-06-30 09:22:30 +00:00
* an email address or false otherwise .
*/
2009-06-30 09:40:37 +00:00
function is_mail_string ( $str ) {
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'is_mail_string(): Entered with (%s)' , 1 , $str );
2009-06-30 09:40:37 +00:00
$mail_regex = " /^[_A-Za-z0-9-]+( \\ .[_A-Za-z0-9-]+)*@[A-Za-z0-9-]+( \\ .[A-Za-z0-9-]+)* $ / " ;
if ( preg_match ( $mail_regex , $str ))
return true ;
else
return false ;
2009-06-30 09:22:30 +00:00
}
2009-06-30 09:29:51 +00:00
/**
2009-06-30 09:22:30 +00:00
* Get whether a string looks like a web URL ( http :// www . example . com / )
2009-06-30 09:29:51 +00:00
*
2009-06-30 09:22:30 +00:00
* @ param string $str The string to analyze .
2009-06-30 09:29:51 +00:00
* @ return bool Returns true if the specified string looks like
2009-06-30 09:22:30 +00:00
* a web URL or false otherwise .
*/
2009-06-30 09:40:37 +00:00
function is_url_string ( $str ) {
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'is_url_string(): Entered with (%s)' , 1 , $str );
2009-06-30 09:40:37 +00:00
$url_regex = '/(ftp|https?):\/\/+[\w\.\-\/\?\=\&]*\w+/' ;
if ( preg_match ( $url_regex , $str ))
return true ;
else
return false ;
2009-06-30 09:22:30 +00:00
}
/**
* Utility wrapper for setting cookies , which takes into consideration
2009-06-30 09:29:51 +00:00
* phpLDAPadmin configuration values . On success , true is returned . On
2009-06-30 09:22:30 +00:00
* failure , false is returned .
*
* @ param string $name The name of the cookie to set .
* @ param string $val The value of the cookie to set .
2009-06-30 09:29:51 +00:00
* @ param int $expire ( optional ) The duration in seconds of this cookie . If unspecified , $cookie_time
2009-06-30 09:22:30 +00:00
* is used from config . php
* @ param string $dir ( optional ) The directory value of this cookie ( see php . net / setcookie )
*
* @ see setcookie
* @ return bool
2009-06-30 08:10:17 +00:00
*/
2009-06-30 09:29:51 +00:00
function pla_set_cookie ( $name , $val , $expire = null , $dir = null ) {
# Set default return
$return = false ;
if ( $expire == null ) {
2009-06-30 10:46:00 +00:00
$cookie_time = $_SESSION [ 'plaConfig' ] -> GetValue ( 'session' , 'cookie_time' );
2009-06-30 08:09:20 +00:00
$expire = $cookie_time == 0 ? null : time () + $cookie_time ;
}
2009-06-30 09:29:51 +00:00
if ( $dir == null )
2009-06-30 08:09:20 +00:00
$dir = dirname ( $_SERVER [ 'PHP_SELF' ] );
2009-06-30 09:29:51 +00:00
if ( @ setcookie ( $name , $val , $expire , $dir )) {
$_COOKIE [ $name ] = $val ;
$return = true ;
2009-06-30 08:09:20 +00:00
}
2009-06-30 09:29:51 +00:00
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
debug_log ( 'pla_set_cookie(): Entered with (%s,%s,%s,%s), Returning (%s)' , 1 , $name , $val , $expire , $dir , $return );
2009-06-30 09:29:51 +00:00
return $return ;
2009-06-30 08:09:20 +00:00
}
2009-06-30 09:22:30 +00:00
/**
* Get a customized file for a server
* We don 't need any caching, because it' s done by PHP
*
* @ param int $server_id The ID of the server
* @ param string $filename The requested filename
*
* @ return string The customized filename , if exists , or the standard one
*/
2009-06-30 09:29:51 +00:00
function get_custom_file ( $server_id , $filename , $path ) {
# Set default return
$return = $path . $filename ;
2009-06-30 09:22:30 +00:00
2009-06-30 10:46:00 +00:00
$custom = $_SESSION [ 'plaConfig' ] -> ldapservers -> GetValue ( $server_id , 'custom' , 'pages_prefix' );
2009-06-30 09:29:51 +00:00
if ( ! is_null ( $custom ) && is_file ( realpath ( $path . $custom . $filename )))
$return = $path . $custom . $filename ;
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
debug_log ( 'get_custom_file(): Entered with (%s,%s,%s), Returning (%s)' , 1 , $server_id , $filename , $path , $return );
2009-06-30 09:29:51 +00:00
return $return ;
2009-06-30 09:22:30 +00:00
}
/**
* Call a customized function
*
* @ param int $server_id The ID of the server
* @ param string $filename The requested function
*
* @ return any The result of the called function
*/
2009-06-30 09:29:51 +00:00
function call_custom_function ( $server_id , $function ) {
# Set default return
$return = $function ;
2009-06-30 10:46:00 +00:00
$custom = $_SESSION [ 'plaConfig' ] -> ldapservers -> GetValue ( $server_id , 'custom' , 'pages_prefix' );
2009-06-30 09:29:51 +00:00
if ( ! is_null ( $custom ) && function_exists ( $custom . $function ))
$return = $custom . $filename ;
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
debug_log ( 'get_custom_file(): Entered with (%s,%s), Returning (%s)' , 1 , $server_id , $function , $return );
2009-06-30 09:29:51 +00:00
return call_user_func ( $return );
2009-06-30 09:22:30 +00:00
}
/**
2009-06-30 08:09:20 +00:00
* Compares 2 DNs . If they are equivelant , returns 0 , otherwise ,
2009-06-30 09:22:30 +00:00
* returns their sorting order ( similar to strcmp ()) :
* Returns < 0 if dn1 is less than dn2 .
* Returns > 0 if dn1 is greater than dn2 .
*
2009-06-30 09:29:51 +00:00
* The comparison is performed starting with the top - most element
2009-06-30 09:22:30 +00:00
* of the DN . Thus , the following list :
* < code >
* ou = people , dc = example , dc = com
* cn = Admin , ou = People , dc = example , dc = com
* cn = Joe , ou = people , dc = example , dc = com
* dc = example , dc = com
* cn = Fred , ou = people , dc = example , dc = org
* cn = Dave , ou = people , dc = example , dc = org
* </ code >
* Will be sorted thus using usort ( $list , " pla_compare_dns " ) :
* < code >
* dc = com
* dc = example , dc = com
* ou = people , dc = example , dc = com
* cn = Admin , ou = People , dc = example , dc = com
* cn = Joe , ou = people , dc = example , dc = com
* cn = Dave , ou = people , dc = example , dc = org
* cn = Fred , ou = people , dc = example , dc = org
* </ code >
*
* @ param string $dn1 The first of two DNs to compare
* @ param string $dn2 The second of two DNs to compare
* @ return int
2009-06-30 08:09:20 +00:00
*/
2009-06-30 09:40:37 +00:00
function pla_compare_dns ( $dn1 , $dn2 ) {
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'pla_compare_dns(): Entered with (%s,%s)' , 1 , $dn1 , $dn2 );
# If pla_compare_dns is passed via a tree, then we'll just get the DN part.
if ( is_array ( $dn1 ))
$dn1 = $dn1 [ 'dn' ];
if ( is_array ( $dn2 ))
$dn2 = $dn2 [ 'dn' ];
2009-06-30 09:29:51 +00:00
2009-06-30 09:40:37 +00:00
# If they are obviously the same, return immediately
if ( ! strcasecmp ( $dn1 , $dn2 ))
2009-06-30 08:09:20 +00:00
return 0 ;
2009-06-30 09:29:51 +00:00
2009-06-30 09:40:37 +00:00
$dn1_parts = pla_explode_dn ( pla_reverse_dn ( $dn1 ));
$dn2_parts = pla_explode_dn ( pla_reverse_dn ( $dn2 ));
assert ( is_array ( $dn1_parts ));
assert ( is_array ( $dn2_parts ));
2009-06-30 09:29:51 +00:00
2009-06-30 09:40:37 +00:00
# Foreach of the "parts" of the smaller DN
for ( $i = 0 ; $i < count ( $dn1_parts ) && $i < count ( $dn2_parts ); $i ++ ) {
/* dnX_part is of the form : " cn=joe " or " cn = joe " or " dc=example "
ie , one part of a multi - part DN . */
2009-06-30 08:09:20 +00:00
$dn1_part = $dn1_parts [ $i ];
$dn2_part = $dn2_parts [ $i ];
2009-06-30 09:29:51 +00:00
2009-06-30 09:40:37 +00:00
/* Each " part " consists of two sub - parts :
1. the attribute ( ie , " cn " or " o " )
2. the value ( ie , " joe " or " example " ) */
$dn1_sub_parts = explode ( '=' , $dn1_part , 2 );
$dn2_sub_parts = explode ( '=' , $dn2_part , 2 );
$dn1_sub_part_attr = trim ( $dn1_sub_parts [ 0 ]);
$dn2_sub_part_attr = trim ( $dn2_sub_parts [ 0 ]);
2009-06-30 08:09:20 +00:00
2009-06-30 09:40:37 +00:00
if ( 0 != ( $cmp = strcasecmp ( $dn1_sub_part_attr , $dn2_sub_part_attr )))
2009-06-30 08:09:20 +00:00
return $cmp ;
2009-06-30 09:40:37 +00:00
$dn1_sub_part_val = trim ( $dn1_sub_parts [ 1 ]);
$dn2_sub_part_val = trim ( $dn2_sub_parts [ 1 ]);
if ( 0 != ( $cmp = strcasecmp ( $dn1_sub_part_val , $dn2_sub_part_val )))
2009-06-30 08:09:20 +00:00
return $cmp ;
}
2009-06-30 09:40:37 +00:00
/* If we iterated through all entries in the smaller of the two DNs
( ie , the one with fewer parts ), and the entries are different sized ,
then , the smaller of the two must be " less than " than the larger . */
if ( count ( $dn1_parts ) > count ( $dn2_parts )) {
return 1 ;
} elseif ( count ( $dn2_parts ) > count ( $dn1_parts )) {
return - 1 ;
} else {
return 0 ;
}
2009-06-30 08:09:20 +00:00
}
2009-06-30 09:29:51 +00:00
/**
2009-06-30 09:22:30 +00:00
* Prunes off anything after the " ; " in an attr name . This is useful for
2009-06-30 09:29:51 +00:00
* attributes that may have " ;binary " appended to their names . With
2009-06-30 09:22:30 +00:00
* real_attr_name (), you can more easily fetch these attributes ' schema
* with their " real " attribute name .
*
* @ param string $attr_name The name of the attribute to examine .
* @ return string
2009-06-30 08:09:20 +00:00
*/
2009-06-30 09:40:37 +00:00
function real_attr_name ( $attr_name ) {
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'real_attr_name(): Entered with (%s)' , 1 , $attr_name );
2009-06-30 09:29:51 +00:00
2009-06-30 09:40:37 +00:00
$attr_name = preg_replace ( '/;.*$/U' , '' , $attr_name );
2009-06-30 08:09:20 +00:00
return $attr_name ;
}
2009-06-30 09:22:30 +00:00
/**
2009-06-30 08:09:20 +00:00
* For hosts who have 'enable_auto_uid_numbers' set to true , this function will
2009-06-30 09:22:30 +00:00
* get the next available uidNumber using the host ' s preferred mechanism
2009-06-30 08:09:20 +00:00
* ( uidpool or search ) . The uidpool mechanism uses a user - configured entry in
* the LDAP server to store the last used uidNumber . This mechanism simply fetches
* and increments and returns that value . The search mechanism is more complicated
* and slow . It searches all entries that have uidNumber set , finds the smalles and
* " fills in the gaps " by incrementing the smallest uidNumber until an unused value
* is found . Both mechanisms do NOT prevent race conditions or toe - stomping , so
* care must be taken when actually creating the entry to check that the uidNumber
* returned here has not been used in the mean time . Note that the two different
* mechanisms may ( will ! ) return different values as they use different algorithms
* to arrive at their result . Do not be alarmed if ( when ! ) this is the case .
2009-06-30 09:29:51 +00:00
*
2009-06-30 09:22:30 +00:00
* Also note that both algorithms are susceptible to a race condition . If two admins
* are adding users simultaneously , the users may get identical uidNumbers with this
* function .
*
* See config . php . example for more notes on the two auto uidNumber mechanisms .
*
2009-06-30 09:29:51 +00:00
* @ param object $ldapserver The LDAP Server Object of interest .
2009-06-30 09:22:30 +00:00
* @ return int
*
2009-06-30 09:29:51 +00:00
* @ todo Must turn off auto_uid | gid in template if config is disabled .
2009-06-30 08:09:20 +00:00
*/
2009-06-30 10:41:18 +00:00
function get_next_number ( & $ldapserver , $startbase = '' , $type = 'uid' , $increment = false , $filter = false ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:41:18 +00:00
debug_log ( 'get_next_number(): Entered with (%s,%s,%s,%s)' , 1 ,
$ldapserver -> server_id , $startbase , $type , $filter );
2009-06-30 09:29:51 +00:00
2009-06-30 10:46:00 +00:00
if ( ! $_SESSION [ 'plaConfig' ] -> ldapservers -> GetValue ( $ldapserver -> server_id , 'auto_number' , 'enable' ))
2009-06-30 08:09:20 +00:00
return false ;
2009-06-30 09:22:30 +00:00
2009-06-30 09:29:51 +00:00
# Based on the configured mechanism, go get the next available uidNumber!
2009-06-30 10:46:00 +00:00
$mechanism = $_SESSION [ 'plaConfig' ] -> ldapservers -> GetValue ( $ldapserver -> server_id , 'auto_number' , 'mechanism' );
2009-06-30 09:22:30 +00:00
2009-06-30 09:29:51 +00:00
switch ( $mechanism ) {
2009-06-30 09:22:30 +00:00
2009-06-30 09:29:51 +00:00
case 'search' :
if ( ! $startbase ) {
2009-06-30 10:46:00 +00:00
$base_dn = $_SESSION [ 'plaConfig' ] -> ldapservers -> GetValue ( $ldapserver -> server_id , 'auto_number' , 'search_base' );
2009-06-30 10:26:08 +00:00
2009-06-30 09:29:51 +00:00
if ( is_null ( $base_dn ))
2009-06-30 10:26:08 +00:00
pla_error ( sprintf ( _ ( ' You specified the " auto_uid_number_mechanism " as " search " in your
2009-06-30 10:41:18 +00:00
configuration for server < b >% s </ b > , but you did not specify the
" auto_uid_number_search_base " . Please specify it before proceeding . ' ), $ldapserver -> name ));
2009-06-30 09:29:51 +00:00
} else {
$base_dn = $startbase ;
2009-06-30 09:22:30 +00:00
}
2009-06-30 10:26:08 +00:00
if ( ! $ldapserver -> dnExists ( $base_dn ))
2009-06-30 10:41:18 +00:00
pla_error ( sprintf ( _ ( 'Your phpLDAPadmin configuration specifies an invalid auto_uid_search_base for server %s' ),
$ldapserver -> name ));
2009-06-30 10:26:08 +00:00
$filter = '(|(uidNumber=*)(gidNumber=*))' ;
2009-06-30 09:29:51 +00:00
$results = array ();
2009-06-30 09:22:30 +00:00
2009-06-30 09:29:51 +00:00
# Check see and use our alternate uid_dn and password if we have it.
2009-06-30 10:46:00 +00:00
$con = $ldapserver -> connect ( false , 'auto_search' , false , true ,
$_SESSION [ 'plaConfig' ] -> ldapservers -> GetValue ( $ldapserver -> server_id , 'auto_number' , 'dn' ),
$_SESSION [ 'plaConfig' ] -> ldapservers -> GetValue ( $ldapserver -> server_id , 'auto_number' , 'pass' ));
2009-06-30 09:29:51 +00:00
2009-06-30 10:26:08 +00:00
if ( ! $con )
pla_error ( sprintf ( _ ( 'Unable to bind to <b>%s</b> with your with auto_uid credentials. Please check your configuration file.' ), $ldapserver -> name ));
2009-06-30 10:46:00 +00:00
$search = $ldapserver -> search ( $con , $base_dn , $filter , array ( 'uidNumber' , 'gidNumber' ), 'sub' , false , $_SESSION [ 'plaConfig' ] -> GetValue ( 'deref' , 'search' ));
2009-06-30 10:26:08 +00:00
if ( ! is_array ( $search ))
pla_error ( 'Untrapped error.' );
foreach ( $search as $dn => $attrs ) {
$attrs = array_change_key_case ( $attrs );
$entry = array ();
switch ( $type ) {
case 'uid' :
if ( isset ( $attrs [ 'uidnumber' ])) {
$entry [ 'dn' ] = $attrs [ 'dn' ];
$entry [ 'uniqnumber' ] = $attrs [ 'uidnumber' ];
$results [] = $entry ;
}
break ;
case 'gid' :
if ( isset ( $attrs [ 'gidnumber' ])) {
$entry [ 'dn' ] = $attrs [ 'dn' ];
$entry [ 'uniqnumber' ] = $attrs [ 'gidnumber' ];
$results [] = $entry ;
}
break ;
default :
pla_error ( sprintf ( 'Unknown type [%s] in search' , $type ));
2009-06-30 09:29:51 +00:00
}
2009-06-30 08:09:20 +00:00
}
2009-06-30 09:29:51 +00:00
# construct a list of used numbers
$autonum = array ();
foreach ( $results as $result )
2009-06-30 10:26:08 +00:00
if ( isset ( $result [ 'uniqnumber' ]))
$autonum [] = $result [ 'uniqnumber' ];
2009-06-30 09:29:51 +00:00
$autonum = array_unique ( $autonum );
sort ( $autonum );
2009-06-30 10:26:08 +00:00
foreach ( $autonum as $uid )
2009-06-30 09:29:51 +00:00
$uid_hash [ $uid ] = 1 ;
# start with the least existing autoNumber and add 1
2009-06-30 10:46:00 +00:00
if ( $_SESSION [ 'plaConfig' ] -> ldapservers -> GetValue ( $ldapserver -> server_id , 'auto_number' , 'min' ))
$minNumber = $_SESSION [ 'plaConfig' ] -> ldapservers -> GetValue ( $ldapserver -> server_id , 'auto_number' , 'min' );
2009-06-30 09:29:51 +00:00
else
$minNumber = intval ( $autonum [ 0 ]) + 1 ;
# this loop terminates as soon as we encounter the next available minNumber
while ( isset ( $uid_hash [ $minNumber ]))
$minNumber ++ ;
return $minNumber ;
break ;
2009-06-30 10:41:18 +00:00
case 'uidpool' :
2009-06-30 10:46:00 +00:00
$con = $ldapserver -> connect ( false , 'auto_search' , false , true ,
$_SESSION [ 'plaConfig' ] -> ldapservers -> GetValue ( $ldapserver -> server_id , 'auto_number' , 'dn' ),
$_SESSION [ 'plaConfig' ] -> ldapservers -> GetValue ( $ldapserver -> server_id , 'auto_number' , 'pass' ));
2009-06-30 10:41:18 +00:00
if ( ! $con )
pla_error ( sprintf ( _ ( 'Unable to bind to <b>%s</b> with your with auto_uid credentials. Please check your configuration file.' ), $ldapserver -> name ));
# assume that uidpool dn is set in config file if no filter given
if ( empty ( $filter ))
2009-06-30 10:46:00 +00:00
$uidpool_dn = $_SESSION [ 'plaConfig' ] -> ldapservers -> GetValue ( $ldapserver -> server_id , 'auto_number' , 'uidpool_dn' );
2009-06-30 10:41:18 +00:00
else {
$filter = str_replace ( array ( '&' , ':::' ), array ( '&' , ',' ), $filter );
$dns = $ldapserver -> search ( $con , $startbase , $filter , array ( 'dn' ), 'sub' );
switch ( count ( $dns )) {
case '1' :
break ;
case '0' :
pla_error ( _ ( 'Uidpool dn not found, please change filter parameter' ));
default :
pla_error ( _ ( 'There is more than one dn for uidpool,please change filter parameter' ));
}
list ( $key , $attrs ) = each ( $dns );
$attrs = array_change_key_case ( $attrs );
$uidpool_dn = $attrs [ 'dn' ];
}
if ( empty ( $uidpool_dn ))
pla_error ( _ ( 'uidpool_dn not found. Please check filter (arg 3) or set up uidpool_dn in config file' ));
2009-06-30 10:46:00 +00:00
$attrs = array ( $type );
$key = strtolower ( $type );
$realkey = $type ;
2009-06-30 10:41:18 +00:00
$number = $ldapserver -> search ( $con , $uidpool_dn , $filter , $attrs , 'base' );
list ( $rkey , $number ) = each ( $number );
$number = array_change_key_case ( $number );
$number = $number [ $key ];
if ( isset ( $increment ) && ( $increment == 'true' )) {
$updatedattr = array ( $key => $number + 1 );
$ldapserver -> modify ( $uidpool_dn , $updatedattr );
}
return $number ;
break ;
2009-06-30 09:29:51 +00:00
# No other cases allowed. The user has an error in the configuration
default :
2009-06-30 10:26:08 +00:00
pla_error ( sprintf ( _ ( ' You specified an invalid value for auto_uid_number_mechanism ( " %s " )
2009-06-30 10:41:18 +00:00
in your configration . Only " uidpool " and " search " are valid .
Please correct this problem . ' ) , $mechanism ) );
2009-06-30 08:09:20 +00:00
}
}
2009-06-30 09:22:30 +00:00
/**
2009-06-30 10:26:08 +00:00
* Given a DN and server ID , this function reads the DN ' s objectClasses and
* determines which icon best represents the entry . The results of this query
* are cached in a session variable so it is not run every time the tree
* browser changes , just when exposing new DNs that were not displayed
* previously . That means we can afford a little bit of inefficiency here
* in favor of coolness . : )
2009-06-30 09:22:30 +00:00
*
2009-06-30 10:26:08 +00:00
* This function returns a string like " country.png " . All icon files are assumed
* to be contained in the / images / directory of phpLDAPadmin .
*
* Developers are encouraged to add new icons to the images directory and modify
* this function as needed to suit their types of LDAP entries . If the modifications
* are general to an LDAP audience , the phpLDAPadmin team will gladly accept them
* as a patch .
*
* @ param int $server_id The ID of the LDAP server housing the DN of interest .
* @ param string $dn The DN of the entry whose icon you wish to fetch .
*
* @ return string
2009-06-30 08:07:14 +00:00
*/
2009-06-30 10:26:08 +00:00
function get_icon ( $ldapserver , $dn ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'get_icon(): Entered with (%s,%s)' , 1 , $ldapserver -> server_id , $dn );
2009-06-30 09:40:37 +00:00
2009-06-30 10:26:08 +00:00
// fetch and lowercase all the objectClasses in an array
$object_classes = $ldapserver -> getDNAttr ( $dn , 'objectClass' , true );
if ( ! is_array ( $object_classes ))
$object_classes = array ( $object_classes );
2009-06-30 08:07:14 +00:00
2009-06-30 10:26:08 +00:00
if ( $object_classes === null || $object_classes === false || ! is_array ( $object_classes ) )
$object_classes = array ();
2009-06-30 08:07:14 +00:00
2009-06-30 10:26:08 +00:00
foreach ( $object_classes as $i => $class )
$object_classes [ $i ] = strtolower ( $class );
2009-06-30 08:07:14 +00:00
2009-06-30 10:26:08 +00:00
$rdn = get_rdn ( $dn );
$rdn_parts = explode ( '=' , $rdn , 2 );
$rdn_value = isset ( $rdn_parts [ 0 ] ) ? $rdn_parts [ 0 ] : null ;
$rdn_attr = isset ( $rdn_parts [ 1 ] ) ? $rdn_parts [ 1 ] : null ;
unset ( $rdn_parts );
2009-06-30 08:07:14 +00:00
2009-06-30 10:26:08 +00:00
// return icon filename based upon objectClass value
if ( in_array ( 'sambaaccount' , $object_classes ) &&
'$' == $rdn { strlen ( $rdn ) - 1 } )
return 'nt_machine.png' ;
2009-06-30 09:29:51 +00:00
2009-06-30 10:26:08 +00:00
if ( in_array ( 'sambaaccount' , $object_classes ) )
return 'nt_user.png' ;
2009-06-30 09:29:51 +00:00
2009-06-30 10:26:08 +00:00
elseif ( in_array ( 'person' , $object_classes ) ||
in_array ( 'organizationalperson' , $object_classes ) ||
in_array ( 'inetorgperson' , $object_classes ) ||
in_array ( 'account' , $object_classes ) ||
in_array ( 'posixaccount' , $object_classes ) )
2009-06-30 09:29:51 +00:00
2009-06-30 10:26:08 +00:00
return 'user.png' ;
2009-06-30 08:07:14 +00:00
2009-06-30 10:26:08 +00:00
elseif ( in_array ( 'organization' , $object_classes ) )
return 'o.png' ;
2009-06-30 09:22:30 +00:00
2009-06-30 10:26:08 +00:00
elseif ( in_array ( 'organizationalunit' , $object_classes ) )
return 'ou.png' ;
2009-06-30 09:29:51 +00:00
2009-06-30 10:26:08 +00:00
elseif ( in_array ( 'organizationalrole' , $object_classes ) )
return 'uid.png' ;
2009-06-30 09:29:51 +00:00
2009-06-30 10:26:08 +00:00
elseif ( in_array ( 'dcobject' , $object_classes ) ||
in_array ( 'domainrelatedobject' , $object_classes ) ||
in_array ( 'domain' , $object_classes ) ||
in_array ( 'builtindomain' , $object_classes ))
2009-06-30 09:29:51 +00:00
2009-06-30 10:26:08 +00:00
return 'dc.png' ;
2009-06-30 08:09:20 +00:00
2009-06-30 10:26:08 +00:00
elseif ( in_array ( 'alias' , $object_classes ) )
return 'go.png' ;
2009-06-30 09:29:51 +00:00
2009-06-30 10:26:08 +00:00
elseif ( in_array ( 'room' , $object_classes ) )
return 'door.png' ;
2009-06-30 09:29:51 +00:00
2009-06-30 10:26:08 +00:00
elseif ( in_array ( 'device' , $object_classes ) )
return 'device.png' ;
2009-06-30 09:22:30 +00:00
2009-06-30 10:26:08 +00:00
elseif ( in_array ( 'document' , $object_classes ) )
return 'document.png' ;
2009-06-30 09:29:51 +00:00
2009-06-30 09:22:30 +00:00
elseif ( in_array ( 'country' , $object_classes ) ) {
2009-06-30 09:29:51 +00:00
$tmp = pla_explode_dn ( $dn );
$cval = explode ( '=' , $tmp [ 0 ], 2 );
$cval = isset ( $cval [ 1 ] ) ? $cval [ 1 ] : false ;
if ( $cval && false === strpos ( $cval , " .. " ) &&
file_exists ( realpath ( sprintf ( " ./images/countries/%s.png " , strtolower ( $cval )) ) ) )
return sprintf ( " countries/%s.png " , strtolower ( $cval ));
else
return 'country.png' ;
}
2009-06-30 08:05:37 +00:00
elseif ( in_array ( 'jammvirtualdomain' , $object_classes ) )
return 'mail.png' ;
2009-06-30 09:29:51 +00:00
2009-06-30 08:05:37 +00:00
elseif ( in_array ( 'locality' , $object_classes ) )
return 'locality.png' ;
2009-06-30 09:29:51 +00:00
2009-06-30 08:09:20 +00:00
elseif ( in_array ( 'posixgroup' , $object_classes ) ||
2009-06-30 09:22:30 +00:00
in_array ( 'groupofnames' , $object_classes ) ||
in_array ( 'group' , $object_classes ) )
2009-06-30 09:29:51 +00:00
2009-06-30 08:07:14 +00:00
return 'ou.png' ;
2009-06-30 09:29:51 +00:00
2009-06-30 08:09:20 +00:00
elseif ( in_array ( 'applicationprocess' , $object_classes ) )
return 'process.png' ;
2009-06-30 09:29:51 +00:00
2009-06-30 08:09:20 +00:00
elseif ( in_array ( 'groupofuniquenames' , $object_classes ) )
return 'uniquegroup.png' ;
2009-06-30 09:29:51 +00:00
2009-06-30 08:09:20 +00:00
elseif ( in_array ( 'iphost' , $object_classes ) )
return 'host.png' ;
2009-06-30 09:29:51 +00:00
2009-06-30 09:22:30 +00:00
elseif ( in_array ( 'nlsproductcontainer' , $object_classes ) )
2009-06-30 09:29:51 +00:00
return 'n.png' ;
2009-06-30 09:22:30 +00:00
elseif ( in_array ( 'ndspkikeymaterial' , $object_classes ) )
2009-06-30 09:29:51 +00:00
return 'lock.png' ;
2009-06-30 09:22:30 +00:00
elseif ( in_array ( 'server' , $object_classes ) )
2009-06-30 09:29:51 +00:00
return 'server-small.png' ;
2009-06-30 09:22:30 +00:00
elseif ( in_array ( 'volume' , $object_classes ) )
2009-06-30 09:29:51 +00:00
return 'hard-drive.png' ;
2009-06-30 09:22:30 +00:00
elseif ( in_array ( 'ndscatcatalog' , $object_classes ) )
2009-06-30 09:29:51 +00:00
return 'catalog.png' ;
2009-06-30 09:22:30 +00:00
elseif ( in_array ( 'resource' , $object_classes ) )
2009-06-30 09:29:51 +00:00
return 'n.png' ;
2009-06-30 09:22:30 +00:00
elseif ( in_array ( 'ldapgroup' , $object_classes ) )
2009-06-30 09:29:51 +00:00
return 'ldap-server.png' ;
2009-06-30 09:22:30 +00:00
elseif ( in_array ( 'ldapserver' , $object_classes ) )
2009-06-30 09:29:51 +00:00
return 'ldap-server.png' ;
2009-06-30 09:22:30 +00:00
elseif ( in_array ( 'nisserver' , $object_classes ) )
2009-06-30 09:29:51 +00:00
return 'ldap-server.png' ;
2009-06-30 09:22:30 +00:00
elseif ( in_array ( 'rbscollection' , $object_classes ) )
2009-06-30 09:29:51 +00:00
return 'ou.png' ;
2009-06-30 09:22:30 +00:00
elseif ( in_array ( 'dfsconfiguration' , $object_classes ) )
2009-06-30 09:29:51 +00:00
return 'nt_machine.png' ;
2009-06-30 09:22:30 +00:00
elseif ( in_array ( 'applicationsettings' , $object_classes ) )
2009-06-30 09:29:51 +00:00
return 'server-settings.png' ;
2009-06-30 09:22:30 +00:00
elseif ( in_array ( 'aspenalias' , $object_classes ) )
2009-06-30 09:29:51 +00:00
return 'mail.png' ;
2009-06-30 09:22:30 +00:00
elseif ( in_array ( 'container' , $object_classes ) )
2009-06-30 09:29:51 +00:00
return 'folder.png' ;
2009-06-30 09:22:30 +00:00
elseif ( in_array ( 'ipnetwork' , $object_classes ) )
2009-06-30 09:29:51 +00:00
return 'network.png' ;
2009-06-30 09:22:30 +00:00
elseif ( in_array ( 'samserver' , $object_classes ) )
2009-06-30 09:29:51 +00:00
return 'server-small.png' ;
2009-06-30 09:22:30 +00:00
elseif ( in_array ( 'lostandfound' , $object_classes ) )
2009-06-30 09:29:51 +00:00
return 'find.png' ;
2009-06-30 09:22:30 +00:00
elseif ( in_array ( 'infrastructureupdate' , $object_classes ) )
2009-06-30 09:29:51 +00:00
return 'server-small.png' ;
2009-06-30 09:22:30 +00:00
elseif ( in_array ( 'filelinktracking' , $object_classes ) )
2009-06-30 09:29:51 +00:00
return 'files.png' ;
2009-06-30 09:22:30 +00:00
elseif ( in_array ( 'automountmap' , $object_classes ) ||
2009-06-30 09:29:51 +00:00
in_array ( 'automount' , $object_classes ) )
return 'hard-drive.png' ;
elseif ( 0 === strpos ( $rdn_value , " ipsec " ) ||
0 == strcasecmp ( $rdn_value , " IP Security " ) ||
0 == strcasecmp ( $rdn_value , " MSRADIUSPRIVKEY Secret " ) ||
0 === strpos ( $rdn_value , " BCKUPKEY_ " ) )
return 'lock.png' ;
2009-06-30 09:22:30 +00:00
elseif ( 0 == strcasecmp ( $rdn_value , " MicrosoftDNS " ) )
2009-06-30 09:29:51 +00:00
return 'dc.png' ;
2009-06-30 08:05:37 +00:00
// Oh well, I don't know what it is. Use a generic icon.
else
return 'object.png' ;
}
2009-06-30 09:22:30 +00:00
/**
* Appends a servers base to a " sub " dn or returns the base .
2009-06-30 09:29:51 +00:00
*
2009-06-30 09:40:37 +00:00
* @ param string $base The baseDN to be added if the DN is relative
* @ param string $sub_dn The DN to be made absolute
* @ return string | null Returns null if both base is null and sub_dn is null or empty
2009-06-30 08:05:37 +00:00
*/
2009-06-30 09:40:37 +00:00
function expand_dn_with_base ( $base , $sub_dn ) {
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'expand_dn_with_base(): Entered with (%s,%s)' , 1 , $base , $sub_dn );
2009-06-30 08:05:37 +00:00
2009-06-30 09:22:30 +00:00
$empty_str = ( is_null ( $sub_dn ) || ( ( $len = strlen ( trim ( $sub_dn ) ) ) == 0 ) );
2009-06-30 08:05:37 +00:00
2009-06-30 09:22:30 +00:00
if ( $empty_str ) {
2009-06-30 09:40:37 +00:00
return $base ;
2009-06-30 09:29:51 +00:00
2009-06-30 09:40:37 +00:00
} elseif ( $sub_dn [ $len - 1 ] != ',' ) {
2009-06-30 09:29:51 +00:00
// If we have a string which doesn't need a base
2009-06-30 09:22:30 +00:00
return $sub_dn ;
2009-06-30 09:40:37 +00:00
} else {
return $sub_dn . $base ;
2009-06-30 09:22:30 +00:00
}
}
/**
2009-06-30 08:09:20 +00:00
* Builds the initial tree that is stored in the session variable 'tree' .
2009-06-30 08:05:37 +00:00
* Simply returns an array with an entry for each active server in
2009-06-30 09:22:30 +00:00
* config . php . The structure of the returned array is simple , and looks like
* this :
* < code >
2009-06-30 09:29:51 +00:00
* Array (
2009-06-30 09:22:30 +00:00
* 0 => Array ( )
* 1 => Array ( )
* )
* </ code >
* This function is not meant as a user callable function , but rather a convenient ,
* automated method for setting up the initial structure for the tree viewer .
2009-06-30 08:05:37 +00:00
*/
2009-06-30 09:29:51 +00:00
function build_initial_tree () {
$return = array ();
2009-06-30 10:46:00 +00:00
foreach ( $_SESSION [ 'plaConfig' ] -> ldapservers -> GetServerList () as $id ) {
if ( ! trim ( $_SESSION [ 'plaConfig' ] -> ldapservers -> GetValue ( $id , 'server' , 'host' )))
2009-06-30 08:05:37 +00:00
continue ;
2009-06-30 09:29:51 +00:00
$return [ $id ] = array ();
2009-06-30 08:05:37 +00:00
}
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'build_initial_tree(): Entered with (), Returning (%s)' , 1 , $return );
2009-06-30 09:40:37 +00:00
2009-06-30 09:29:51 +00:00
return $return ;
2009-06-30 08:05:37 +00:00
}
2009-06-30 09:22:30 +00:00
/**
2009-06-30 08:09:20 +00:00
* Returns true if the passed string $temp contains all printable
2009-06-30 08:05:37 +00:00
* ASCII characters . Otherwise ( like if it contains binary data ),
* returns false .
*/
function is_printable_str ( $temp ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'is_printable_str(): Entered with (%s)' , 1 , $temp );
2009-06-30 09:29:51 +00:00
2009-06-30 08:05:37 +00:00
$len = strlen ( $temp );
2009-06-30 09:29:51 +00:00
2009-06-30 08:05:37 +00:00
for ( $i = 0 ; $i < $len ; $i ++ ) {
$ascii_val = ord ( substr ( $temp , $i , 1 ) );
if ( $ascii_val < 32 || $ascii_val > 126 )
return false ;
}
return true ;
}
2009-06-30 09:22:30 +00:00
/**
* Reads the query , checks all values and sets defaults .
*
* @ param int $query_id The ID of the predefined query .
* @ return array The fixed query or null on error
*/
2009-06-30 10:26:08 +00:00
function get_cleaned_up_predefined_search ( $query_id ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'get_cleaned_up_predefined_search(): Entered with (%s)' , 1 , $query_id );
2009-06-30 09:29:51 +00:00
2009-06-30 10:46:00 +00:00
if ( ! isset ( $_SESSION [ 'plaConfig' ] -> queries [ $query_id ]))
2009-06-30 09:22:30 +00:00
return null ;
2009-06-30 10:46:00 +00:00
$query = $_SESSION [ 'plaConfig' ] -> queries [ $query_id ];
2009-06-30 09:22:30 +00:00
2009-06-30 10:26:08 +00:00
$base = ( isset ( $query [ 'base' ])) ? $query [ 'base' ] : null ;
2009-06-30 09:22:30 +00:00
2009-06-30 10:26:08 +00:00
if ( isset ( $query [ 'filter' ]) && trim ( $query [ 'filter' ]))
2009-06-30 09:22:30 +00:00
$filter = $query [ 'filter' ];
else
2009-06-30 09:29:51 +00:00
$filter = 'objectclass=*' ;
2009-06-30 09:22:30 +00:00
2009-06-30 10:26:08 +00:00
$scope = isset ( $query [ 'scope' ]) && ( in_array ( $query [ 'scope' ], array ( 'base' , 'sub' , 'one' ))) ?
$query [ 'scope' ] : 'sub' ;
if ( isset ( $query [ 'attributes' ]) && trim ( $query [ 'filter' ]))
$attrib = $query [ 'attributes' ];
2009-06-30 08:05:37 +00:00
else
2009-06-30 10:26:08 +00:00
$attrib = 'dn, cn, sn, objectClass' ;
return array ( 'base' => $base , 'filter' => $filter , 'scope' => $scope , 'attributes' => $attrib );
2009-06-30 08:05:37 +00:00
}
2009-06-30 09:22:30 +00:00
/**
2009-06-30 09:29:51 +00:00
* Used to generate a random salt for crypt - style passwords . Salt strings are used
* to make pre - built hash cracking dictionaries difficult to use as the hash algorithm uses
* not only the user ' s password but also a randomly generated string . The string is
2009-06-30 09:22:30 +00:00
* stored as the first N characters of the hash for reference of hashing algorithms later .
*
2009-06-30 08:09:20 +00:00
* --- added 20021125 by bayu irawan < bayuir @ divnet . telkom . co . id > ---
2009-06-30 08:05:37 +00:00
* --- ammended 20030625 by S C Rigler < srigler @ houston . rr . com > ---
2009-06-30 09:22:30 +00:00
*
* @ param int $length The length of the salt string to generate .
* @ return string The generated salt string .
2009-06-30 08:05:37 +00:00
*/
2009-06-30 09:29:51 +00:00
function random_salt ( $length ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'random_salt(): Entered with (%s)' , 1 , $length );
2009-06-30 09:29:51 +00:00
$possible = '0123456789' .
'abcdefghijklmnopqrstuvwxyz' .
'ABCDEFGHIJKLMNOPQRSTUVWXYZ' .
'./' ;
$str = " " ;
mt_srand (( double ) microtime () * 1000000 );
2009-06-30 09:40:37 +00:00
while ( strlen ( $str ) < $length )
$str .= substr ( $possible , ( rand () % strlen ( $possible ) ), 1 );
2009-06-30 09:29:51 +00:00
2009-06-30 09:22:30 +00:00
/**
2009-06-30 08:05:37 +00:00
* Commented out following line because of problem
* with crypt function in update . php
* --- 20030625 by S C Rigler < srigler @ houston . rr . com > ---
*/
2009-06-30 09:29:51 +00:00
//$str = "\$1\$".$str."\$";
return $str ;
2009-06-30 08:05:37 +00:00
}
2009-06-30 09:22:30 +00:00
/**
2009-06-30 08:09:20 +00:00
* Given a DN string , this returns the 'RDN' portion of the string .
2009-06-30 08:05:37 +00:00
* For example . given 'cn=Manager,dc=example,dc=com' , this function returns
* 'cn=Manager' ( it is really the exact opposite of get_container ()) .
2009-06-30 09:22:30 +00:00
*
* @ param string $dn The DN whose RDN to return .
2009-06-30 09:29:51 +00:00
* @ param bool $include_attrs If true , include attributes in the RDN string .
2009-06-30 09:22:30 +00:00
* See http :// php . net / ldap_explode_dn for details
*
* @ return string The RDN
* @ see get_container
2009-06-30 08:05:37 +00:00
*/
2009-06-30 10:46:00 +00:00
function get_rdn ( $dn , $include_attrs = 0 , $decode = false ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:46:00 +00:00
debug_log ( 'Entered with (%s,%s,%s)' , 1 , __FILE__ , __LINE__ , __METHOD__ , $dn , $include_attrs , $decode );
2009-06-30 09:29:51 +00:00
2009-06-30 10:46:00 +00:00
if ( is_null ( $dn ))
2009-06-30 08:07:14 +00:00
return null ;
2009-06-30 10:26:08 +00:00
$rdn = pla_explode_dn ( $dn , $include_attrs );
if ( ! count ( $rdn ) || ! isset ( $rdn [ 0 ]))
2009-06-30 09:22:30 +00:00
return $dn ;
2009-06-30 10:26:08 +00:00
2009-06-30 10:46:00 +00:00
if ( $decode )
$rdn = dn_unescape ( $rdn [ 0 ]);
else
$rdn = $rdn [ 0 ];
2009-06-30 10:26:08 +00:00
2009-06-30 08:05:37 +00:00
return $rdn ;
}
2009-06-30 09:22:30 +00:00
/**
* Given a DN string , this returns the parent container portion of the string .
2009-06-30 08:05:37 +00:00
* For example . given 'cn=Manager,dc=example,dc=com' , this function returns
* 'dc=example,dc=com' .
2009-06-30 09:29:51 +00:00
*
2009-06-30 09:22:30 +00:00
* @ param string $dn The DN whose container string to return .
2009-06-30 10:46:00 +00:00
* @ param boolean $lower The DN returned will be in lower case .
2009-06-30 09:22:30 +00:00
*
* @ return string The container
* @ see get_rdn
2009-06-30 08:05:37 +00:00
*/
2009-06-30 10:46:00 +00:00
function get_container ( $dn , $lower = true ) {
2009-06-30 10:26:08 +00:00
$parts = pla_explode_dn ( $dn );
2009-06-30 09:29:51 +00:00
2009-06-30 10:26:08 +00:00
if ( count ( $parts ) <= 1 )
$container = null ;
2009-06-30 08:05:37 +00:00
2009-06-30 10:26:08 +00:00
else {
$container = $parts [ 1 ];
for ( $i = 2 ; $i < count ( $parts ); $i ++ )
$container .= ',' . $parts [ $i ];
2009-06-30 09:40:37 +00:00
}
2009-06-30 09:29:51 +00:00
2009-06-30 10:46:00 +00:00
if ( $lower )
$container = strtolower ( $container );
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'get_container(): Entered with (%s), Returning (%s)' , 1 , $dn , $container );
2009-06-30 09:29:51 +00:00
2009-06-30 10:26:08 +00:00
return $container ;
2009-06-30 09:29:51 +00:00
}
2009-06-30 09:22:30 +00:00
/**
* Given an LDAP error number , returns a verbose description of the error .
2009-06-30 08:05:37 +00:00
* This function parses ldap_error_codes . txt and looks up the specified
* ldap error number , and returns the verbose message defined in that file .
2009-06-30 09:22:30 +00:00
*
* @ param string $err_no The hex error number ( ie , " 0x42 " ) of the LDAP error of interest .
* @ return array An associative array contianing the error title and description like so :
* < code >
2009-06-30 09:29:51 +00:00
* Array
2009-06-30 09:22:30 +00:00
* (
* [ title ] => " Invalid Credentials "
* [ description ] => " An invalid username and/or password was supplied to the LDAP server. "
* )
* </ code >
2009-06-30 08:05:37 +00:00
*/
2009-06-30 09:29:51 +00:00
function pla_verbose_error ( $err_no ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'pla_verbose_error(): Entered with (%s)' , 1 , $err_no );
2009-06-30 09:29:51 +00:00
2009-06-30 08:05:37 +00:00
static $err_codes ;
2009-06-30 09:40:37 +00:00
if ( count ( $err_codes ) <= 0 ) {
$err_codes_file = LIBDIR . 'ldap_error_codes.txt' ;
2009-06-30 08:05:37 +00:00
2009-06-30 09:40:37 +00:00
if ( ! file_exists ( $err_codes_file ) || ! is_readable ( $err_codes_file ) || ! ( $f = fopen ( $err_codes_file , 'r' )))
return false ;
2009-06-30 08:05:37 +00:00
2009-06-30 09:40:37 +00:00
$contents = fread ( $f , filesize ( $err_codes_file ) );
fclose ( $f );
$entries = array ();
preg_match_all ( " /0x[A-Fa-f0-9][A-Za-z0-9] \ s+[0-9A-Za-z_]+ \ s+ \" [^ \" ]* \" \n / " ,
$contents , $entries );
$err_codes = array ();
foreach ( $entries [ 0 ] as $e ) {
$entry = array ();
preg_match ( " /(0x[A-Za-z0-9][A-Za-z0-9]) \ s+([0-9A-Za-z_]+) \ s+ \" ([^ \" ]*) \" / " , $e , $entry );
$hex_code = isset ( $entry [ 1 ] ) ? $entry [ 1 ] : null ;
$title = isset ( $entry [ 2 ] ) ? $entry [ 2 ] : null ;
$desc = isset ( $entry [ 3 ] ) ? $entry [ 3 ] : null ;
$desc = preg_replace ( " / \ s+/ " , " " , $desc );
$err_codes [ " $hex_code " ] = array ( 'title' => $title , 'desc' => $desc );
}
2009-06-30 08:05:37 +00:00
}
2009-06-30 09:40:37 +00:00
if ( isset ( $err_codes [ $err_no ] ) )
return $err_codes [ $err_no ];
else
return array ( 'title' => null , 'desc' => null );
2009-06-30 08:05:37 +00:00
}
2009-06-30 09:29:51 +00:00
// @todo: describe this function
function support_oid_to_text ( $oid_id ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'support_oid_to_text(): Entered with (%s)' , 1 , $oid_id );
2009-06-30 09:29:51 +00:00
static $oid ;
2009-06-30 09:40:37 +00:00
if ( count ( $oid ) <= 0 ) {
$oid_codes_file = LIBDIR . 'ldap_supported_oids.txt' ;
2009-06-30 09:29:51 +00:00
2009-06-30 09:40:37 +00:00
if ( ! file_exists ( $oid_codes_file ) || ! is_readable ( $oid_codes_file ) || ! ( $f = fopen ( $oid_codes_file , 'r' )))
return false ;
2009-06-30 09:29:51 +00:00
2009-06-30 09:40:37 +00:00
$contents = fread ( $f , filesize ( $oid_codes_file ) );
fclose ( $f );
$entries = array ();
preg_match_all ( " /[0-9] \ ..+ \ s+ \" [^ \" ]* \" \n / " , $contents , $entries );
$err_codes = array ();
foreach ( $entries [ 0 ] as $e ) {
$entry = array ();
preg_match ( " /([0-9] \ .([0-9]+ \ .)*[0-9]+)( \ s+ \" ([^ \" ]*) \" )?( \ s+ \" ([^ \" ]*) \" )?( \ s+ \" ([^ \" ]*) \" )?/ " , $e , $entry );
$oid_id_a = isset ( $entry [ 1 ] ) ? $entry [ 1 ] : null ;
if ( $oid_id_a ) {
$oid [ $oid_id_a ][ 'title' ] = isset ( $entry [ 4 ] ) ? $entry [ 4 ] : null ;
$oid [ $oid_id_a ][ 'ref' ] = isset ( $entry [ 6 ] ) ? $entry [ 6 ] : null ;
$desc = isset ( $entry [ 8 ] ) ? $entry [ 8 ] : null ;
$oid [ $oid_id_a ][ 'desc' ] = preg_replace ( " / \ s+/ " , " " , $desc );
}
2009-06-30 09:29:51 +00:00
}
}
if ( isset ( $oid [ $oid_id ] ) )
return $oid [ $oid_id ];
else
return null ;
}
2009-06-30 10:46:00 +00:00
function error ( $msg , $type = 'note' , $fatal = false , $backtrace = false ) {
global $www ;
# if the error is fatal, we'll need to stop here.
if ( ! isset ( $www ) && $fatal )
$www = new page ( null );
# Just a check to see that we are called right.
if ( ! isset ( $www ) && ! $fatal )
pla_error ( 'Function error called incorrectly' , null , - 1 , true , true );
$www -> setsysmsg ( array ( 'title' => _ ( 'Error' ), 'body' => $msg , 'type' => $type ));
if ( $fatal )
$www -> display ( array ( 'tree' => false ));
}
2009-06-30 09:22:30 +00:00
/**
* Prints an HTML - formatted error string . If you specify the optional
2009-06-30 09:29:51 +00:00
* parameters $ldap_err_msg and $ldap_err_no , this function will
* lookup the error number and display a verbose message in addition
2009-06-30 09:22:30 +00:00
* to the message you pass it .
2009-06-30 09:29:51 +00:00
*
2009-06-30 09:22:30 +00:00
* @ param string $msg The error message to display .
2009-06-30 09:29:51 +00:00
* @ param string $ldap_err_msg ( optional ) The error message supplied by the LDAP server
* @ param string $ldap_err_no ( optional ) The hexadecimal error number string supplied by the LDAP server
2009-06-30 09:22:30 +00:00
* @ param bool $fatal ( optional ) If true , phpLDAPadmin will terminate execution with the PHP die () function .
*
* @ see die
* @ see ldap_errno
* @ see pla_verbose_error
2009-06-30 08:05:37 +00:00
*/
2009-06-30 10:41:18 +00:00
function pla_error ( $msg , $ldap_err_msg = null , $ldap_err_no =- 1 , $fatal = true , $backtrace = null ) {
2009-06-30 09:40:37 +00:00
if ( defined ( 'DEBUG_ENABLED' ) && ( DEBUG_ENABLED ))
2009-06-30 10:26:08 +00:00
debug_log ( 'pla_error(): Entered with (%s,%s,%s,%s)' , 1 , $msg , $ldap_err_msg , $ldap_err_no , $fatal );
2009-06-30 09:29:51 +00:00
2009-06-30 10:41:18 +00:00
$server = isset ( $_SERVER [ 'SERVER_SOFTWARE' ]) ? $_SERVER [ 'SERVER_SOFTWARE' ] : 'undefined' ;
2009-06-30 10:46:00 +00:00
if ( $fatal ) {
include_once HTDOCDIR . 'header.php' ;
echo '<body>' ;
}
2009-06-30 08:05:37 +00:00
2009-06-30 10:41:18 +00:00
echo '<center>' ;
echo '<table class="error">' ;
printf ( '<tr><th colspan="4">%s</th></tr>' , _ ( 'Error' ));
echo '<tr>' ;
2009-06-30 10:46:00 +00:00
echo '<td rowspan="99" width="10%"><img src="../htdocs/images/warning.png" alt="Warning" /></td>' ;
2009-06-30 10:41:18 +00:00
printf ( '<td colspan="3"><b>%s</b></td>' , $msg );
echo '</tr>' ;
echo '<tr><td colspan="3"> </td></tr>' ;
2009-06-30 08:05:37 +00:00
2009-06-30 09:40:37 +00:00
if ( function_exists ( 'syslog_err' ))
syslog_err ( $msg );
2009-06-30 09:29:51 +00:00
2009-06-30 10:41:18 +00:00
if ( $ldap_err_msg )
printf ( '<tr><td colspan="3"><b>%s</b>: %s</td></tr>' , _ ( 'LDAP said' ), htmlspecialchars ( $ldap_err_msg ));
2009-06-30 08:05:37 +00:00
2009-06-30 10:41:18 +00:00
if ( $ldap_err_no != - 1 ) {
$ldap_err_no = ( '0x' . str_pad ( dechex ( $ldap_err_no ), 2 , 0 , STR_PAD_LEFT ));
$verbose_error = pla_verbose_error ( $ldap_err_no );
2009-06-30 08:05:37 +00:00
2009-06-30 10:41:18 +00:00
if ( $verbose_error ) {
printf ( '<tr><td colspan="2"><b>%s</b>: %s (%s)</td></tr>' , _ ( 'Error number' ), $ldap_err_no , $verbose_error [ 'title' ]);
printf ( '<tr><td colspan="2"><b>%s</b>: %s</td></tr>' , _ ( 'Description' ), $verbose_error [ 'desc' ]);
2009-06-30 08:05:37 +00:00
} else {
2009-06-30 10:41:18 +00:00
printf ( '<tr><td colspan="2"><b>%s</b>: %s</td></tr>' , _ ( 'Error number' ), $ldap_err_no );
printf ( '<tr><td colspan="2"><b>%s</b>: (%s)</td></tr>' , _ ( 'Description' ), _ ( 'no description available' ));
2009-06-30 08:05:37 +00:00
}
2009-06-30 09:29:51 +00:00
2009-06-30 10:41:18 +00:00
echo '<tr><td colspan="3"> </td></tr>' ;
2009-06-30 09:40:37 +00:00
if ( function_exists ( 'syslog_err' ))
2009-06-30 10:41:18 +00:00
syslog_err ( sprintf ( '%s %s' , _ ( 'Error number' ), $ldap_err_no ));
} elseif (( defined ( 'DEBUG_ENABLED' ) && DEBUG_ENABLED && function_exists ( 'debug_backtrace' )) || $backtrace ) {
printf ( '<tr><td colspan="3"><b>%s</b></td></tr>' , _ ( 'Backtrace' ));
if ( is_null ( $backtrace ))
$backtrace = debug_backtrace ();
printf ( '<tr><td> </td><td><b><small><span style="white-space: nowrap;">%s</span></small></b></td><td>%s</td></tr>' ,
'PHP Version' , phpversion ());
printf ( '<tr><td> </td><td><b><small><span style="white-space: nowrap;">%s</span></small></b></td><td>%s</td></tr>' ,
'PLA Version' , pla_version ());
printf ( '<tr><td> </td><td><b><small><span style="white-space: nowrap;">%s</span></small></b></td><td>%s</td></tr>' ,
'PHP SAPI' , php_sapi_name ());
printf ( '<tr><td> </td><td><b><small><span style="white-space: nowrap;">%s</span></small></b></td><td>%s</td></tr>' ,
'Web Server' , $server );
echo '<tr><td colspan="3"> </td></tr>' ;
foreach ( $backtrace as $error => $line ) {
2009-06-30 10:46:00 +00:00
printf ( '<tr><td rowspan="2"> </td><td><b><small>%s</small></b></td><td>%s (%s)</td></tr>' ,
_ ( 'File' ), isset ( $line [ 'file' ]) ? $line [ 'file' ] : '' , isset ( $line [ 'line' ]) ? $line [ 'line' ] : '' );
2009-06-30 10:41:18 +00:00
printf ( '<tr><td><b><small>%s</small></b></td><td><small>%s<br /><pre>' , _ ( 'Function' ), $line [ 'function' ]);
2009-06-30 10:46:00 +00:00
if ( isset ( $line [ 'args' ])) print_r ( $line [ 'args' ]);
2009-06-30 10:41:18 +00:00
echo '</pre></small></td></tr>' ;
}
/*
< br />
<!-- Commented out due to too many false bug reports . : )
< br />
< center >
< small >
< ? php printf ( _ ( 'Is this a phpLDAPadmin bug? If so, please <a href=\'%s\'>report it</a>.' ), get_href ( 'add_bug' )); ?>
</ small >
</ center >
-->
*/
2009-06-30 08:05:37 +00:00
}
2009-06-30 10:41:18 +00:00
echo '</table>' ;
echo '</center>' ;
if ( $fatal ) {
echo '</body>' ;
echo '</html>' ;
2009-06-30 08:09:20 +00:00
die ();
2009-06-30 09:29:51 +00:00
}
2009-06-30 08:09:20 +00:00
}
2009-06-30 09:22:30 +00:00
/**
* phpLDAPadmin ' s custom error handling function . When a PHP error occurs ,
2009-06-30 09:29:51 +00:00
* PHP will call this function rather than printing the typical PHP error string .
2009-06-30 09:22:30 +00:00
* This provides phpLDAPadmin the ability to format an error message more " pretty "
* and provide a link for users to submit a bug report . This function is not to
* be called by users . It is exclusively for the use of PHP internally . If this
* function is called by PHP from within a context where error handling has been
* disabled ( ie , from within a function called with " @ " prepended ), then this
* function does nothing .
*
* @ param int $errno The PHP error number that occurred ( ie , E_ERROR , E_WARNING , E_PARSE , etc ) .
* @ param string $errstr The PHP error string provided ( ie , " Warning index " foo " is undefined)
* @ param string $file The file in which the PHP error ocurred .
* @ param int $lineno The line number on which the PHP error ocurred
*
* @ see set_error_handler
2009-06-30 08:09:20 +00:00
*/
2009-06-30 10:41:18 +00:00
function pla_error_handler ( $errno , $errstr , $file , $lineno ) {
2009-06-30 10:46:00 +00:00
if ( defined ( 'DEBUG_ENABLED' ) && DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'pla_error_handler(): Entered with (%s,%s,%s,%s)' , 1 , $errno , $errstr , $file , $lineno );
2009-06-30 08:09:20 +00:00
2009-06-30 10:41:18 +00:00
/* error_reporting will be 0 if the error context occurred
* within a function call with '@' preprended ( ie , @ ldap_bind () );
* So , don ' t report errors if the caller has specifically
* disabled them with '@'
*/
if ( ini_get ( 'error_reporting' ) == 0 || error_reporting () == 0 )
2009-06-30 09:29:51 +00:00
return ;
2009-06-30 08:09:20 +00:00
2009-06-30 10:41:18 +00:00
$file = basename ( $file );
$caller = basename ( $_SERVER [ 'PHP_SELF' ]);
$errtype = '' ;
switch ( $errno ) {
case E_STRICT : $errtype = 'E_STRICT' ; break ;
case E_ERROR : $errtype = 'E_ERROR' ; break ;
case E_WARNING : $errtype = 'E_WARNING' ; break ;
case E_PARSE : $errtype = 'E_PARSE' ; break ;
case E_NOTICE : $errtype = 'E_NOTICE' ; break ;
case E_CORE_ERROR : $errtype = 'E_CORE_ERROR' ; break ;
case E_CORE_WARNING : $errtype = 'E_CORE_WARNING' ; break ;
case E_COMPILE_ERROR : $errtype = 'E_COMPILE_ERROR' ; break ;
case E_COMPILE_WARNING : $errtype = 'E_COMPILE_WARNING' ; break ;
case E_USER_ERROR : $errtype = 'E_USER_ERROR' ; break ;
case E_USER_WARNING : $errtype = 'E_USER_WARNING' ; break ;
case E_USER_NOTICE : $errtype = 'E_USER_NOTICE' ; break ;
case E_ALL : $errtype = 'E_ALL' ; break ;
default : $errtype = sprintf ( '%s: %s' , _ ( 'Unrecognized error number' ), $errno );
2009-06-30 08:09:20 +00:00
}
2009-06-30 10:41:18 +00:00
$errstr = preg_replace ( '/\s+/' , ' ' , $errstr );
if ( $errno == E_NOTICE ) {
2009-06-30 10:46:00 +00:00
$body = '<table class="notice">' ;
$body .= sprintf ( '<tr><td>%s:</td><td><b>%s</b> (<b>%s</b>)</td></tr>' , _ ( 'Error' ), $errstr , $errtype );
$body .= sprintf ( '<tr><td>%s:</td><td><b>%s</b> %s <b>%s</b>, %s <b>%s</b></td></tr>' ,
_ ( 'File' ), $file , _ ( 'line' ), $lineno , _ ( 'caller' ), $caller );
$body .= sprintf ( '<tr><td>Versions:</td><td>PLA: <b>%s</b>, PHP: <b>%s</b>, SAPI: <b>%s</b></td></tr>' ,
2009-06-30 10:41:18 +00:00
pla_version (), phpversion (), php_sapi_name ());
2009-06-30 10:46:00 +00:00
$body .= sprintf ( '<tr><td>Web server:</td><td><b>%s</b></td></tr>' , $_SERVER [ 'SERVER_SOFTWARE' ]);
2009-06-30 10:41:18 +00:00
2009-06-30 10:46:00 +00:00
$body .= sprintf ( '<tr><td colspan="2"><a target="new" href="%s"><center>%s.</center></a></td></tr>' ,
2009-06-30 10:41:18 +00:00
get_href ( 'search_bug' , " &summary_keyword= " . htmlspecialchars ( $errstr )),
_ ( 'Please check and see if this bug has been reported' ));
2009-06-30 10:46:00 +00:00
$body .= '</table>' ;
2009-06-30 10:41:18 +00:00
2009-06-30 10:46:00 +00:00
system_message ( array (
'title' => _ ( 'You found a non-fatal phpLDAPadmin bug!' ),
'body' => $body ,
'type' => 'error' ));
2009-06-30 10:41:18 +00:00
2009-06-30 08:09:20 +00:00
return ;
}
2009-06-30 10:41:18 +00:00
pla_error ( sprintf ( '%s: %s' , $errtype , $errstr ), null , - 1 , true , debug_backtrace ());
2009-06-30 08:05:37 +00:00
}
2009-06-30 09:22:30 +00:00
/**
2009-06-30 08:05:37 +00:00
* Reads the friendly_attrs array as defined in config . php and lower - cases all
* the keys . Will return an empty array if the friendly_attrs array is not defined
2009-06-30 09:22:30 +00:00
* in config . php . This is simply used so we can more easily lookup user - friendly
* attributes configured by the admin .
2009-06-30 08:05:37 +00:00
*/
2009-06-30 10:26:08 +00:00
function process_friendly_attr_table () {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'process_friendly_attr_table(): Entered with ()' , 1 );
2009-06-30 09:29:51 +00:00
2009-06-30 08:05:37 +00:00
$attrs_table = array ();
2009-06-30 10:46:00 +00:00
if ( isset ( $_SESSION [ 'plaConfig' ] -> friendly_attrs ) && is_array ( $_SESSION [ 'plaConfig' ] -> friendly_attrs ) )
foreach ( $_SESSION [ 'plaConfig' ] -> friendly_attrs as $old_name => $new_name )
2009-06-30 08:05:37 +00:00
$attrs_table [ strtolower ( $old_name ) ] = $new_name ;
else
return array ();
return $attrs_table ;
}
2009-06-30 09:22:30 +00:00
/**
2009-06-30 09:29:51 +00:00
* Draw the jpegPhoto image ( s ) for an entry wrapped in HTML . Many options are available to
2009-06-30 09:22:30 +00:00
* specify how the images are to be displayed .
*
* Usage Examples :
* < code >
* draw_jpeg_photos ( 0 , " cn=Bob,ou=People,dc=example,dc=com " , " jpegPhoto " true , false , " border: 1px; width: 150px " );
* draw_jpeg_photos ( 1 , " cn=Fred,ou=People,dc=example,dc=com " );
* </ code >
*
* @ param int $server_id The ID of the server of interest .
* @ param string $dn The DN of the entry that contains the jpeg attribute you want to draw .
* @ param string $attr_name The name of the attribute containing the jpeg data ( usually 'jpegPhoto' ) .
* @ param bool $draw_delete_buttons If true , draws a button beneath the image titled 'Delete' allowing the user
* to delete the jpeg attribute by calling JavaScript function deleteAttribute () provided
* in the default modification template .
* @ param bool $draw_bytes_and_size If true , draw text below the image indicating the byte size and dimensions .
* @ param string $table_html_attrs Specifies optional CSS style attributes for the table tag .
*
* @ return void
2009-06-30 08:05:37 +00:00
*/
2009-06-30 10:26:08 +00:00
function draw_jpeg_photos ( $ldapserver , $dn , $attr_name = 'jpegPhoto' , $draw_delete_buttons = false ,
$draw_bytes_and_size = true , $table_html_attrs = 'align="left"' , $img_html_attrs = '' ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'draw_jpeg_photos(): Entered with (%s,%s,%s,%s,%s,%s,%s)' , 1 ,
2009-06-30 09:40:37 +00:00
$ldapserver -> server_id , $dn , $attr_name , $draw_delete_buttons ,
$draw_bytes_and_size , $table_html_attrs , $img_html_attrs );
2009-06-30 08:05:37 +00:00
2009-06-30 09:29:51 +00:00
$fixed_width = false ;
$fixed_height = false ;
2009-06-30 10:26:08 +00:00
if ( eregi ( ' width' , $img_html_attrs ) || eregi ( '^width' , $img_html_attrs ))
2009-06-30 09:29:51 +00:00
$fixed_width = true ;
2009-06-30 10:26:08 +00:00
if ( eregi ( ' height=' , $img_html_attrs ) || eregi ( '^height=' , $img_html_attrs ))
2009-06-30 09:29:51 +00:00
$fixed_height = true ;
2009-06-30 10:26:08 +00:00
if ( isset ( $table_html_attrs ) && trim ( $table_html_attrs ) )
printf ( '<table %s><tr><td><center>' , $table_html_attrs );
2009-06-30 08:05:37 +00:00
2009-06-30 10:41:18 +00:00
$jpeg_data = $ldapserver -> search ( null , $dn , 'objectClass=*' , array ( $attr_name ), 'base' );
$jpeg_data = array_pop ( $jpeg_data );
2009-06-30 10:26:08 +00:00
if ( ! $jpeg_data ) {
printf ( _ ( 'Could not fetch jpeg data from LDAP server for attribute %s.' ), htmlspecialchars ( $attr_name ));
2009-06-30 09:29:51 +00:00
return ;
}
2009-06-30 10:46:00 +00:00
$jpeg_temp_dir = realpath ( $_SESSION [ 'plaConfig' ] -> GetValue ( 'jpeg' , 'tmpdir' ) . '/' );
2009-06-30 10:26:08 +00:00
if ( ! is_writable ( $jpeg_temp_dir ))
pla_error ( _ ( 'Please set $jpeg_temp_dir to a writable directory in the phpLDAPadmin config.php' ) );
if ( ! is_array ( $jpeg_data [ $attr_name ]))
$jpeg_data [ $attr_name ] = array ( $jpeg_data [ $attr_name ]);
foreach ( $jpeg_data [ $attr_name ] as $jpeg ) {
$jpeg_filename = tempnam ( $jpeg_temp_dir . '/' , 'pla' );
$outjpeg = @ fopen ( $jpeg_filename , 'wb' );
if ( ! $outjpeg )
pla_error ( sprintf ( _ ( 'Could not write to the $jpeg_temp_dir directory %s. Please verify that your web server can write files there.' ), $jpeg_temp_dir ));
fwrite ( $outjpeg , $jpeg );
2009-06-30 08:05:37 +00:00
fclose ( $outjpeg );
2009-06-30 09:29:51 +00:00
2009-06-30 10:26:08 +00:00
$jpeg_data_size = filesize ( $jpeg_filename );
if ( $jpeg_data_size < 6 && $draw_delete_buttons ) {
echo _ ( 'jpegPhoto contains errors<br />' );
2009-06-30 10:46:00 +00:00
printf ( '<a href="javascript:deleteAttribute(\'%s\');" style="color:red; font-size: 75%%">%s</a>' , $attr_name , _ ( 'Delete Photo' ));
2009-06-30 08:05:37 +00:00
continue ;
}
2009-06-30 10:26:08 +00:00
if ( function_exists ( 'getimagesize' )) {
$jpeg_dimensions = @ getimagesize ( $jpeg_filename );
2009-06-30 09:29:51 +00:00
$width = $jpeg_dimensions [ 0 ];
$height = $jpeg_dimensions [ 1 ];
} else {
$width = 0 ;
$height = 0 ;
}
2009-06-30 10:26:08 +00:00
if ( $width > 300 ) {
2009-06-30 08:05:37 +00:00
$scale_factor = 300 / $width ;
$img_width = 300 ;
2009-06-30 10:26:45 +00:00
$img_height = intval ( $height * $scale_factor );
2009-06-30 09:29:51 +00:00
2009-06-30 08:05:37 +00:00
} else {
$img_width = $width ;
$img_height = $height ;
}
2009-06-30 09:29:51 +00:00
2009-06-30 10:40:33 +00:00
printf ( '<img %s%s%s src="view_jpeg_photo.php?file=%s" alt="Photo" /><br />' ,
2009-06-30 10:26:08 +00:00
( $fixed_width ? '' : 'width="' . $img_width . '" ' ),
( $fixed_height ? '' : 'height="' . $img_height . '"' ),
( $img_html_attrs ? $img_html_attrs : '' ), basename ( $jpeg_filename ));
2009-06-30 09:29:51 +00:00
2009-06-30 10:26:08 +00:00
if ( $draw_bytes_and_size )
2009-06-30 10:46:00 +00:00
printf ( '<small>%s %s. %s x %s pixels.<br /></small>' , number_format ( $jpeg_data_size ), _ ( 'bytes' ), $width , $height );
2009-06-30 08:05:37 +00:00
2009-06-30 10:26:08 +00:00
if ( $draw_delete_buttons )
# <!-- JavaScript function deleteJpegPhoto() to be defined later by calling script -->
printf ( '<a href="javascript:deleteAttribute(\'%s\');" style="color:red; font-size: 75%%">%s</a>' ,
$attr_name , _ ( 'Delete photo' ));
2009-06-30 08:05:37 +00:00
}
2009-06-30 10:26:08 +00:00
if ( isset ( $table_html_attrs ) && trim ( $table_html_attrs ))
echo '</center></td></tr></table>' ;
2009-06-30 08:05:37 +00:00
2009-06-30 10:26:08 +00:00
# Delete old jpeg files.
2009-06-30 09:22:30 +00:00
$jpegtmp_wildcard = " /^pla/ " ;
2009-06-30 10:46:00 +00:00
$handle = @ opendir ( $jpeg_temp_dir );
if ( $handle !== false ) {
while (( $file = readdir ( $handle )) != false ) {
if ( preg_match ( $jpegtmp_wildcard , $file )) {
$file = " $jpeg_temp_dir / $file " ;
if (( time () - filemtime ( $file )) > $_SESSION [ 'plaConfig' ] -> GetValue ( 'jpeg' , 'tmp_keep_time' ))
@ unlink ( $file );
}
2009-06-30 08:05:37 +00:00
}
2009-06-30 10:46:00 +00:00
closedir ( $handle );
} else {
pla_error ( sprintf ( 'failed to open dir %s : permission denied' , $jpeg_temp_dir ), null , - 1 , false , false );
2009-06-30 09:22:30 +00:00
}
2009-06-30 08:05:37 +00:00
}
2009-06-30 09:22:30 +00:00
/**
2009-06-30 09:29:51 +00:00
* Hashes a password and returns the hash based on the specified enc_type .
2009-06-30 09:22:30 +00:00
*
2009-06-30 09:29:51 +00:00
* @ param string $password_clear The password to hash in clear text .
* @ param string $enc_type Standard LDAP encryption type which must be one of
* crypt , ext_des , md5crypt , blowfish , md5 , sha , smd5 , ssha , or clear .
* @ return string The hashed password .
2009-06-30 08:05:37 +00:00
*/
2009-06-30 09:29:51 +00:00
function password_hash ( $password_clear , $enc_type ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'password_hash(): Entered with (%s,%s)' , 1 , $password_clear , $enc_type );
2009-06-30 09:22:30 +00:00
2009-06-30 09:29:51 +00:00
$enc_type = strtolower ( $enc_type );
2009-06-30 09:22:30 +00:00
2009-06-30 09:29:51 +00:00
switch ( $enc_type ) {
case 'crypt' :
2009-06-30 10:46:00 +00:00
if ( $_SESSION [ 'plaConfig' ] -> GetValue ( 'password' , 'no_random_crypt_salt' ))
2009-06-30 10:41:18 +00:00
$new_value = '{CRYPT}' . crypt ( $password_clear , substr ( $password_clear , 0 , 2 ));
else
$new_value = '{CRYPT}' . crypt ( $password_clear , random_salt ( 2 ));
2009-06-30 09:29:51 +00:00
break ;
2009-06-30 08:09:20 +00:00
2009-06-30 09:29:51 +00:00
case 'ext_des' :
// extended des crypt. see OpenBSD crypt man page.
if ( ! defined ( 'CRYPT_EXT_DES' ) || CRYPT_EXT_DES == 0 )
2009-06-30 10:26:08 +00:00
pla_error ( _ ( 'Your system crypt library does not support extended DES encryption.' ) );
2009-06-30 08:05:37 +00:00
2009-06-30 09:29:51 +00:00
$new_value = '{CRYPT}' . crypt ( $password_clear , '_' . random_salt ( 8 ) );
break ;
2009-06-30 08:05:37 +00:00
2009-06-30 09:29:51 +00:00
case 'md5crypt' :
if ( ! defined ( 'CRYPT_MD5' ) || CRYPT_MD5 == 0 )
2009-06-30 10:26:08 +00:00
pla_error ( _ ( 'Your system crypt library does not support md5crypt encryption.' ) );
2009-06-30 09:29:51 +00:00
$new_value = '{CRYPT}' . crypt ( $password_clear , '$1$' . random_salt ( 9 ) );
break ;
case 'blowfish' :
if ( ! defined ( 'CRYPT_BLOWFISH' ) || CRYPT_BLOWFISH == 0 )
2009-06-30 10:26:08 +00:00
pla_error ( _ ( 'Your system crypt library does not support blowfish encryption.' ) );
2009-06-30 09:29:51 +00:00
// hardcoded to second blowfish version and set number of rounds
$new_value = '{CRYPT}' . crypt ( $password_clear , '$2a$12$' . random_salt ( 13 ) );
break ;
case 'md5' :
$new_value = '{MD5}' . base64_encode ( pack ( 'H*' , md5 ( $password_clear ) ) );
break ;
case 'sha' :
if ( function_exists ( 'sha1' ) ) {
// use php 4.3.0+ sha1 function, if it is available.
$new_value = '{SHA}' . base64_encode ( pack ( 'H*' , sha1 ( $password_clear ) ) );
} elseif ( function_exists ( 'mhash' ) ) {
$new_value = '{SHA}' . base64_encode ( mhash ( MHASH_SHA1 , $password_clear ) );
} else {
2009-06-30 10:26:08 +00:00
pla_error ( _ ( 'Your PHP install does not have the mhash() function. Cannot do SHA hashes.' ) );
2009-06-30 09:29:51 +00:00
}
break ;
case 'ssha' :
if ( function_exists ( 'mhash' ) && function_exists ( 'mhash_keygen_s2k' ) ) {
mt_srand ( ( double ) microtime () * 1000000 );
$salt = mhash_keygen_s2k ( MHASH_SHA1 , $password_clear , substr ( pack ( " h* " , md5 ( mt_rand () ) ), 0 , 8 ), 4 );
$new_value = " { SSHA} " . base64_encode ( mhash ( MHASH_SHA1 , $password_clear . $salt ) . $salt );
} else {
2009-06-30 10:26:08 +00:00
pla_error ( _ ( 'Your PHP install does not have the mhash() function. Cannot do SHA hashes.' ) );
2009-06-30 09:29:51 +00:00
}
break ;
case 'smd5' :
if ( function_exists ( 'mhash' ) && function_exists ( 'mhash_keygen_s2k' ) ) {
mt_srand ( ( double ) microtime () * 1000000 );
$salt = mhash_keygen_s2k ( MHASH_MD5 , $password_clear , substr ( pack ( " h* " , md5 ( mt_rand () ) ), 0 , 8 ), 4 );
$new_value = " { SMD5} " . base64_encode ( mhash ( MHASH_MD5 , $password_clear . $salt ) . $salt );
} else {
2009-06-30 10:26:08 +00:00
pla_error ( _ ( 'Your PHP install does not have the mhash() function. Cannot do SHA hashes.' ) );
2009-06-30 09:29:51 +00:00
}
break ;
case 'clear' :
default :
$new_value = $password_clear ;
2009-06-30 08:05:37 +00:00
}
2009-06-30 09:29:51 +00:00
2009-06-30 08:05:37 +00:00
return $new_value ;
}
2009-06-30 09:22:30 +00:00
/**
* Given a clear - text password and a hash , this function determines if the clear - text password
* is the password that was used to generate the hash . This is handy to verify a user ' s password
* when all that is given is the hash and a " guess " .
* @ param String $hash The hash .
* @ param String $clear The password in clear text to test .
* @ return Boolean True if the clear password matches the hash , and false otherwise .
*/
2009-06-30 09:29:51 +00:00
function password_check ( $cryptedpassword , $plainpassword ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'password_check(): Entered with (%s,%s)' , 1 , $cryptedpassword , $plainpassword );
2009-06-30 09:29:51 +00:00
if ( preg_match ( " / { ([^}]+)}(.*)/ " , $cryptedpassword , $cypher ) ) {
$cryptedpassword = $cypher [ 2 ];
$_cypher = strtolower ( $cypher [ 1 ]);
2009-06-30 09:40:37 +00:00
} else {
2009-06-30 09:29:51 +00:00
$_cypher = NULL ;
}
switch ( $_cypher ) {
// SSHA crypted passwords
case 'ssha' :
// check php mhash support before using it
if ( function_exists ( 'mhash' ) ) {
$hash = base64_decode ( $cryptedpassword );
$salt = substr ( $hash , - 4 );
$new_hash = base64_encode ( mhash ( MHASH_SHA1 , $plainpassword . $salt ) . $salt );
if ( strcmp ( $cryptedpassword , $new_hash ) == 0 )
return true ;
else
return false ;
} else {
2009-06-30 10:26:08 +00:00
pla_error ( _ ( 'Your PHP install does not have the mhash() function. Cannot do SHA hashes.' ) );
2009-06-30 09:29:51 +00:00
}
break ;
// Salted MD5
case 'smd5' :
// check php mhash support before using it
if ( function_exists ( 'mhash' ) ) {
$hash = base64_decode ( $cryptedpassword );
$salt = substr ( $hash , - 4 );
$new_hash = base64_encode ( mhash ( MHASH_MD5 , $plainpassword . $salt ) . $salt );
if ( strcmp ( $cryptedpassword , $new_hash ) == 0 )
return true ;
else
return false ;
} else {
2009-06-30 10:26:08 +00:00
pla_error ( _ ( 'Your PHP install does not have the mhash() function. Cannot do SHA hashes.' ) );
2009-06-30 09:29:51 +00:00
}
break ;
// SHA crypted passwords
case 'sha' :
if ( strcasecmp ( password_hash ( $plainpassword , 'sha' ), " { SHA} " . $cryptedpassword ) == 0 )
return true ;
else
return false ;
break ;
// MD5 crypted passwords
case 'md5' :
if ( strcasecmp ( password_hash ( $plainpassword , 'md5' ), " { MD5} " . $cryptedpassword ) == 0 )
return true ;
else
return false ;
break ;
// Crypt passwords
case 'crypt' :
// Check if it's blowfish crypt
if ( preg_match ( " /^ \\ $ 2+/ " , $cryptedpassword ) ) {
// make sure that web server supports blowfish crypt
if ( ! defined ( 'CRYPT_BLOWFISH' ) || CRYPT_BLOWFISH == 0 )
2009-06-30 10:26:08 +00:00
pla_error ( _ ( 'Your system crypt library does not support blowfish encryption.' ) );
2009-06-30 09:29:51 +00:00
list (, $version , $rounds , $salt_hash ) = explode ( '$' , $cryptedpassword );
if ( crypt ( $plainpassword , '$' . $version . '$' . $rounds . '$' . $salt_hash ) == $cryptedpassword )
return true ;
else
return false ;
}
// Check if it's an crypted md5
elseif ( strstr ( $cryptedpassword , '$1$' ) ) {
// make sure that web server supports md5 crypt
if ( ! defined ( 'CRYPT_MD5' ) || CRYPT_MD5 == 0 )
2009-06-30 10:26:08 +00:00
pla_error ( _ ( 'Your system crypt library does not support md5crypt encryption.' ) );
2009-06-30 09:29:51 +00:00
list (, $type , $salt , $hash ) = explode ( '$' , $cryptedpassword );
if ( crypt ( $plainpassword , '$1$' . $salt ) == $cryptedpassword )
return true ;
else
return false ;
}
// Check if it's extended des crypt
elseif ( strstr ( $cryptedpassword , '_' ) ) {
// make sure that web server supports ext_des
if ( ! defined ( 'CRYPT_EXT_DES' ) || CRYPT_EXT_DES == 0 )
2009-06-30 10:26:08 +00:00
pla_error ( _ ( 'Your system crypt library does not support extended DES encryption.' ) );
2009-06-30 09:29:51 +00:00
if ( crypt ( $plainpassword , $cryptedpassword ) == $cryptedpassword )
return true ;
else
return false ;
}
// Password is plain crypt
else {
if ( crypt ( $plainpassword , $cryptedpassword ) == $cryptedpassword )
return true ;
else
return false ;
}
break ;
// No crypt is given assume plaintext passwords are used
default :
if ( $plainpassword == $cryptedpassword )
return true ;
else
return false ;
break ;
}
2009-06-30 09:22:30 +00:00
}
2009-06-30 09:29:51 +00:00
/**
* Detects password encryption type
*
* Returns crypto string listed in braces . If it is 'crypt' password ,
* returns crypto detected in password hash . Function should detect
* md5crypt , blowfish and extended DES crypt . If function fails to detect
* encryption type , it returns NULL .
* @ param string hashed password
* @ return string
*/
function get_enc_type ( $user_password ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'get_enc_type(): Entered with (%s)' , 1 , $user_password );
2009-06-30 09:22:30 +00:00
2009-06-30 09:29:51 +00:00
/* Capture the stuff in the { } to determine if this is crypt, md5, etc. */
$enc_type = null ;
if ( preg_match ( " / { ([^}]+)}/ " , $user_password , $enc_type ) )
$enc_type = strtolower ( $enc_type [ 1 ] );
else
return null ;
/* handle crypt types */
if ( strcasecmp ( $enc_type , 'crypt' ) == 0 ) {
if ( preg_match ( " / { [^}]+} \\ $ 1 \\ $ +/ " , $user_password ) ) {
$enc_type = " md5crypt " ;
} elseif ( preg_match ( " / { [^}]+} \\ $ 2+/ " , $user_password ) ) {
$enc_type = " blowfish " ;
} elseif ( preg_match ( " / { [^}]+}_+/ " , $user_password ) ) {
$enc_type = " ext_des " ;
}
/*
* No need to check for standard crypt ,
* because enc_type is already equal to 'crypt' .
*/
}
return $enc_type ;
2009-06-30 09:22:30 +00:00
}
/**
* Gets the default enc_type configured in config . php for the server indicated by $server_id ;
* @ param int $server_id The ID of the server of interest .
* @ return String The enc_type , like 'sha' , 'md5' , 'ssha' , 'md5crypt' , for example .
*/
2009-06-30 09:29:51 +00:00
function get_default_hash ( $server_id ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'get_default_hash(): Entered with (%s)' , 1 , $server_id );
2009-06-30 09:29:51 +00:00
2009-06-30 10:46:00 +00:00
return $_SESSION [ 'plaConfig' ] -> ldapservers -> GetValue ( $server_id , 'appearance' , 'password_hash' );
2009-06-30 09:22:30 +00:00
}
/**
* Returns the phpLDAPadmin version currently running . The version
* is read from the file named VERSION .
*
* @ return string The current version as read from the VERSION file .
2009-06-30 08:05:37 +00:00
*/
2009-06-30 09:29:51 +00:00
function pla_version () {
2009-06-30 10:46:00 +00:00
$version_file = realpath ( LIBDIR . '../VERSION' );
2009-06-30 09:29:51 +00:00
if ( ! file_exists ( $version_file ))
2009-06-30 09:41:11 +00:00
$return = 'UNKNOWN' ;
else {
$f = fopen ( $version_file , 'r' );
$version = trim ( fread ( $f , filesize ( $version_file )));
fclose ( $f );
# We use cvs_prefix, because CVS will translate this on checkout otherwise.
$cvs_prefix = '\$Name:' ;
$return = preg_replace ( '/^' . $cvs_prefix . ' RELEASE-([0-9_]+)\s*\$$/' , '$1' , $version );
$return = preg_replace ( '/_/' , '.' , $return );
2009-06-30 08:05:37 +00:00
2009-06-30 09:41:11 +00:00
# Check if we are a CVS copy.
if ( preg_match ( '/^' . $cvs_prefix . '?\s*\$$/' , $return ))
$return = 'CVS' ;
2009-06-30 10:46:00 +00:00
# Check if we are special CVS branch
elseif ( preg_match ( '/^' . $cvs_prefix . '?\s*([a-zA-Z]+)?\s*\$$/' , $return , $match ))
$return = $match [ 1 ];
2009-06-30 09:41:11 +00:00
# If return is still the same as version, then the tag is not one we expect.
elseif ( $return == $version )
$return = 'UNKNOWN' ;
}
2009-06-30 10:26:08 +00:00
if ( defined ( 'DEBUG_ENABLED' ) && DEBUG_ENABLED )
debug_log ( 'pla_version(): Entered with (), Returning (%s)' , 1 , $return );
2009-06-30 09:41:11 +00:00
return $return ;
2009-06-30 08:05:37 +00:00
}
2009-06-30 09:29:51 +00:00
/**
2009-06-30 09:22:30 +00:00
* Draws an HTML browse button which , when clicked , pops up a DN chooser dialog .
* @ param string $form_element The name of the form element to which this chooser
* dialog will publish the user ' s choice . The form element must be a member
* of a form with the " name " or " id " attribute set in the form tag , and the element
* must also define " name " or " id " for JavaScript to uniquely identify it .
2009-06-30 09:29:51 +00:00
* Example $form_element values may include " creation_form.container " or
2009-06-30 09:22:30 +00:00
* " edit_form.member_uid " . See / templates / modification / default . php for example usage .
* @ param bool $include_choose_text ( optional ) If true , the function draws the localized text " choose " to the right of the button .
*/
2009-06-30 09:29:51 +00:00
function draw_chooser_link ( $form_element , $include_choose_text = true , $rdn = " none " ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'draw_chooser_link(): Entered with (%s,%s,%s)' , 1 , $form_element , $include_choose_text , $rdn );
2009-06-30 09:29:51 +00:00
2009-06-30 10:26:08 +00:00
if ( $rdn == 'none' ) {
$href = " javascript:dnChooserPopup(' $form_element ',''); " ;
2009-06-30 09:29:51 +00:00
} else {
2009-06-30 10:26:08 +00:00
$href = " javascript:dnChooserPopup(' $form_element ',' $rdn '); " ;
2009-06-30 09:29:51 +00:00
}
2009-06-30 10:26:08 +00:00
$title = _ ( 'Click to popup a dialog to select an entry (DN) graphically' );
2009-06-30 09:29:51 +00:00
2009-06-30 10:40:33 +00:00
printf ( '<a href="%s" title="%s"><img class="chooser" src="images/find.png" alt="Find" /></a>' , $href , $title );
2009-06-30 09:29:51 +00:00
if ( $include_choose_text )
2009-06-30 10:26:08 +00:00
printf ( '<span class="x-small"><a href="%s" title="%s">%s</a></span>' , $href , $title , _ ( 'browse' ));
2009-06-30 08:07:14 +00:00
}
2009-06-30 09:22:30 +00:00
/**
2009-06-30 10:26:08 +00:00
* Explode a DN into an array of its RDN parts .
2009-06-30 09:22:30 +00:00
* @ param string $dn The DN to explode .
* @ param int $with_attriutes ( optional ) Whether to include attribute names ( see http :// php . net / ldap_explode_dn for details )
*
* @ return array An array of RDN parts of this format :
* < code >
2009-06-30 09:40:37 +00:00
* Array
2009-06-30 09:22:30 +00:00
* (
* [ 0 ] => uid = ppratt
* [ 1 ] => ou = People
* [ 2 ] => dc = example
* [ 3 ] => dc = com
* )
* </ code >
2009-06-30 10:46:00 +00:00
*
* NOTE : When a multivalue RDN is passed to ldap_explode_dn , the results returns with 'value + value' ;
2009-06-30 09:22:30 +00:00
*/
2009-06-30 10:26:08 +00:00
function pla_explode_dn ( $dn , $with_attributes = 0 ) {
2009-06-30 10:46:00 +00:00
global $CACHE ;
2009-06-30 10:40:33 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:46:00 +00:00
debug_log ( 'Entered with (%s,%s)' , 1 , __FILE__ , __LINE__ , __METHOD__ , $dn , $with_attributes );
if ( isset ( $CACHE [ 'explode' ][ $dn ][ $with_attributes ])) {
if ( DEBUG_ENABLED )
debug_log ( 'Return CACHED result (%s) for (%s)' , 1 , __FILE__ , __LINE__ , __METHOD__ ,
$CACHE [ 'explode' ][ $dn ][ $with_attributes ], $dn );
return $CACHE [ 'explode' ][ $dn ][ $with_attributes ];
}
$dn = addcslashes ( $dn , '<>+";' );
2009-06-30 09:29:51 +00:00
2009-06-30 09:40:37 +00:00
# split the dn
2009-06-30 10:46:00 +00:00
$result [ 0 ] = ldap_explode_dn ( dn_escape ( $dn ), 0 );
$result [ 1 ] = ldap_explode_dn ( dn_escape ( $dn ), 1 );
if ( ! $result [ $with_attributes ]) {
if ( DEBUG_ENABLED )
debug_log ( 'Returning NULL - NO result.' , 1 , __FILE__ , __LINE__ , __METHOD__ );
2009-06-30 10:26:08 +00:00
return null ;
2009-06-30 10:46:00 +00:00
}
2009-06-30 10:26:08 +00:00
# Remove our count value that ldap_explode_dn returns us.
2009-06-30 10:46:00 +00:00
unset ( $result [ 0 ][ 'count' ]);
unset ( $result [ 1 ][ 'count' ]);
2009-06-30 09:22:30 +00:00
2009-06-30 10:46:00 +00:00
# Record the forward and reverse entries in the cache.
foreach ( $result as $key => $value ) {
# translate hex code into ascii for display
$result [ $key ] = dn_unescape ( $value );
$CACHE [ 'explode' ][ join ( ',' , $result [ 0 ])][ $key ] = $result [ $key ];
$CACHE [ 'explode' ][ join ( ',' , array_reverse ( $result [ 0 ]))][ $key ] = array_reverse ( $result [ $key ]);
}
2009-06-30 09:29:51 +00:00
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:46:00 +00:00
debug_log ( 'Entered with (%s,%s), Returning (%s)' , 1 , __FILE__ , __LINE__ , __METHOD__ ,
$dn , $with_attributes , $result [ $with_attributes ]);
2009-06-30 09:29:51 +00:00
2009-06-30 10:46:00 +00:00
return $result [ $with_attributes ];
2009-06-30 09:22:30 +00:00
}
2009-06-30 10:26:08 +00:00
/**
2009-06-30 10:40:03 +00:00
* Parse a DN and escape any special characters
2009-06-30 10:26:08 +00:00
*/
function dn_escape ( $dn ) {
2009-06-30 10:40:33 +00:00
$olddn = $dn ;
2009-06-30 10:40:03 +00:00
# Check if the RDN has a comma and escape it.
while ( preg_match ( '/([^\\\\]),(\s*[^=]*\s*),/' , $dn ))
$dn = preg_replace ( '/([^\\\\]),(\s*[^=]*\s*),/' , '$1\\\\2C$2,' , $dn );
2009-06-30 10:27:56 +00:00
2009-06-30 10:40:03 +00:00
$dn = preg_replace ( '/([^\\\\]),(\s*[^=]*\s*)([^,])$/' , '$1\\\\2C$2$3' , $dn );
2009-06-30 10:26:08 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:40:33 +00:00
debug_log ( 'dn_escape(): Entered with (%s), Returning (%s)' , 1 , $olddn , $dn );
2009-06-30 10:26:08 +00:00
return $dn ;
}
/**
* Parse a DN and unescape any special characters
*/
function dn_unescape ( $dn ) {
2009-06-30 10:46:00 +00:00
if ( is_array ( $dn )) {
$a = array ();
foreach ( $dn as $key => $rdn ) {
$a [ $key ] = preg_replace ( '/\\\([0-9A-Fa-f]{2})/e' , " ''.chr(hexdec(' \\ 1')).'' " , $rdn );
}
return $a ;
} else {
return preg_replace ( '/\\\([0-9A-Fa-f]{2})/e' , " ''.chr(hexdec(' \\ 1')).'' " , $dn );
}
2009-06-30 10:26:08 +00:00
}
2009-06-30 09:22:30 +00:00
/**
2009-06-30 09:29:51 +00:00
* Fetches the URL for the specified item . This is a convenience function for
2009-06-30 09:22:30 +00:00
* fetching project HREFs ( like bugs )
*
* @ param string $type One of " open_bugs " , " add_bug " , " donate " , or " add_rfe "
* ( rfe = request for enhancement )
* @ return string The URL to the requested item .
*/
2009-06-30 10:26:08 +00:00
function get_href ( $type , $extra_info = '' ) {
$sf = 'https://sourceforge.net' ;
2009-06-30 10:41:18 +00:00
$pla = 'http://wiki.phpldapadmin.info' ;
2009-06-30 10:26:08 +00:00
$group_id = '61828' ;
$bug_atid = '498546' ;
$rfe_atid = '498549' ;
$forum_id = '34809' ;
switch ( $type ) {
case 'add_bug' :
return sprintf ( '%s/tracker/?func=add&group_id=%s&atid=%s' , $sf , $group_id , $bug_atid );
case 'add_rfe' :
return sprintf ( '%s/tracker/?func=add&group_id=%s&atid=%s' , $sf , $group_id , $rfe_atid );
case 'credits' :
return sprintf ( '%s/Credits' , $pla );
case 'documentation' :
return sprintf ( '%s/Documentation' , $pla );
case 'forum' :
return sprintf ( '%s/mailarchive/forum.php?forum_id=%s' , $sf , $forum_id );
case 'open_bugs' :
return sprintf ( '%s/tracker/?group_id=%s&atid=%s' , $sf , $group_id , $bug_atid );
case 'search_bug' :
return sprintf ( '%s/tracker/?func=search&group_id=%s&atid=%s&set=custom&_status=100&_group=100&order=summary%s' , $sf , $group_id , $bug_atid , $extra_info );
case 'donate' :
return sprintf ( '%s/donate/index.php?group_id=%s' , $sf , $group_id );
case 'help' :
return sprintf ( 'help.php' );
default :
return null ;
2009-06-30 08:07:14 +00:00
}
}
2009-06-30 08:09:20 +00:00
2009-06-30 09:22:30 +00:00
/**
* Returns the current time as a double ( including micro - seconds ) .
*
* @ return double The current time in seconds since the beginning of the UNIX epoch ( Midnight Jan . 1 , 1970 )
*/
2009-06-30 09:29:51 +00:00
function utime () {
2009-06-30 09:40:37 +00:00
$time = explode ( ' ' , microtime ());
2009-06-30 09:22:30 +00:00
$usec = ( double ) $time [ 0 ];
$sec = ( double ) $time [ 1 ];
return $sec + $usec ;
2009-06-30 08:07:14 +00:00
}
2009-06-30 09:22:30 +00:00
/**
2009-06-30 09:29:51 +00:00
* Converts an array to a query - string with the option to exclude certain variables
2009-06-30 09:22:30 +00:00
* from the returned query string . This is convenient if callers want to convert the
2009-06-30 09:29:51 +00:00
* current GET query string or POST array into a string and replace certain
2009-06-30 09:22:30 +00:00
* variables with their own .
2009-06-30 09:29:51 +00:00
*
* @ param array $array The associate array to convert whose form is such that the keys are the
2009-06-30 09:22:30 +00:00
* names of the variables and the values are said variables ' values like this :
* < code >
* Array
* (
* [ server_id ] = 0 ,
* [ dn ] = " dc=example,dc=com " ,
* [ attr ] = " sn "
* )
* </ code >
* This will produce a string like this : " server_id=0&dn=dc=example,dc=com&attr=sn "
* @ param array $exclude_vars ( optional ) An array of variables to exclude in the resulting string
* @ param bool $url_encode_ampersands ( optional ) By default , this function encodes all ampersand - separators
* as & amp ; but callers may dislabe this by specifying false here . For example , URLs on HTML
* pages should encode the ampersands but URLs in header ( " Location: http://example.com " ) should
* not be encoded .
* @ return string The string created from the array .
*/
2009-06-30 09:29:51 +00:00
function array_to_query_string ( $array , $exclude_vars = array (), $url_encode_ampersands = true ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'array_to_query_string(): Entered with (%s,%s,%s)' , 1 ,
2009-06-30 09:40:37 +00:00
count ( $array ), count ( $exclude_vars ), $url_encode_ampersands );
2009-06-30 09:29:51 +00:00
2009-06-30 10:46:00 +00:00
if ( ! is_array ( $array ))
2009-06-30 09:22:30 +00:00
return '' ;
2009-06-30 10:46:00 +00:00
if ( ! $array )
2009-06-30 09:22:30 +00:00
return '' ;
2009-06-30 10:46:00 +00:00
2009-06-30 09:22:30 +00:00
$str = '' ;
2009-06-30 10:46:00 +00:00
$i = 0 ;
foreach ( $array as $name => $val ) {
if ( ! in_array ( $name , $exclude_vars )) {
if ( is_array ( $val )) {
foreach ( $val as $v ) {
if ( $i > 0 )
if ( $url_encode_ampersands ) $str .= '&' ;
else $str .= '&' ;
$str .= rawurlencode ( $name ) . '[]=' . rawurlencode ( $v );
$i ++ ;
}
} else {
if ( $i > 0 )
if ( $url_encode_ampersands ) $str .= '&' ;
else $str .= '&' ;
$str .= rawurlencode ( $name ) . '=' . rawurlencode ( $val );
$i ++ ;
}
2009-06-30 09:22:30 +00:00
}
}
return $str ;
2009-06-30 08:07:14 +00:00
}
/**
2009-06-30 09:22:30 +00:00
* Reverses a DN such that the top - level RDN is first and the bottom - level RDN is last
* For example :
* < code >
* cn = Brigham , ou = People , dc = example , dc = com
* </ code >
2009-06-30 09:29:51 +00:00
* Becomes :
2009-06-30 09:22:30 +00:00
* < code >
* dc = com , dc = example , ou = People , cn = Brigham
* </ code >
* This makes it possible to sort lists of DNs such that they are grouped by container .
*
* @ param string $dn The DN to reverse
* @ return string The reversed DN
*
* @ see pla_compare_dns
2009-06-30 10:46:00 +00:00
* @ see pla_explode_dns
2009-06-30 08:07:14 +00:00
*/
2009-06-30 09:29:51 +00:00
function pla_reverse_dn ( $dn ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'pla_reverse_dn(): Entered with (%s)' , 1 , $dn );
2009-06-30 09:29:51 +00:00
2009-06-30 10:46:00 +00:00
return ( join ( ',' , array_reverse ( pla_explode_dn ( $dn ))));
2009-06-30 09:22:30 +00:00
}
2009-06-30 09:29:51 +00:00
/**
*
*/
2009-06-30 09:22:30 +00:00
function sortAttrs ( $a , $b ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'sortAttrs(): Entered with (%s,%s)' , 1 , $a , $b );
2009-06-30 08:10:17 +00:00
2009-06-30 10:46:00 +00:00
$attrs_display_order = isset ( $_SESSION [ 'plaConfig' ] -> attrs_display_order ) ? $_SESSION [ 'plaConfig' ] -> attrs_display_order : array ();
2009-06-30 08:10:17 +00:00
2009-06-30 10:26:08 +00:00
if ( $a == $b )
return 0 ;
2009-06-30 09:29:51 +00:00
2009-06-30 10:26:08 +00:00
# Check if $a is in $attrs_display_order, get its key
$a_key = array_search ( $a , $attrs_display_order );
# If not, check if its friendly name is $attrs_display_order, get its key
# If not, assign one greater than number of elements.
if ( $a_key === false ) {
2009-06-30 10:46:00 +00:00
if ( isset ( $_SESSION [ 'plaConfig' ] -> friendly_attrs [ strtolower ( $a )])) {
$a_key = array_search ( $_SESSION [ 'plaConfig' ] -> friendly_attrs [ strtolower ( $a )], $attrs_display_order );
2009-06-30 10:26:08 +00:00
if ( $a_key == '' )
$a_key = count ( $attrs_display_order ) + 1 ;
} else {
2009-06-30 09:29:51 +00:00
$a_key = count ( $attrs_display_order ) + 1 ;
}
2009-06-30 09:22:30 +00:00
}
2009-06-30 10:26:08 +00:00
$b_key = array_search ( $b , $attrs_display_order );
if ( $b_key === false ) {
2009-06-30 10:46:00 +00:00
if ( isset ( $_SESSION [ 'plaConfig' ] -> friendly_attrs [ strtolower ( $b )])) {
$b_key = array_search ( $_SESSION [ 'plaConfig' ] -> friendly_attrs [ strtolower ( $b )], $attrs_display_order );
2009-06-30 10:26:08 +00:00
if ( $b_key == '' )
$b_key = count ( $attrs_display_order ) + 1 ;
} else {
2009-06-30 09:29:51 +00:00
$b_key = count ( $attrs_display_order ) + 1 ;
}
}
2009-06-30 09:22:30 +00:00
2009-06-30 10:26:08 +00:00
# Case where neither $a, nor $b are in $attrs_display_order, $a_key = $b_key = one greater than num elements.
# So we sort them alphabetically
if ( $a_key === $b_key ) {
2009-06-30 10:46:00 +00:00
$a = strtolower (( isset ( $_SESSION [ 'plaConfig' ] -> friendly_attrs [ strtolower ( $a )]) ? $_SESSION [ 'plaConfig' ] -> friendly_attrs [ strtolower ( $a )] : $a ));
$b = strtolower (( isset ( $_SESSION [ 'plaConfig' ] -> friendly_attrs [ strtolower ( $b )]) ? $_SESSION [ 'plaConfig' ] -> friendly_attrs [ strtolower ( $b )] : $b ));
2009-06-30 10:26:08 +00:00
return strcmp ( $a , $b );
2009-06-30 09:29:51 +00:00
}
2009-06-30 10:26:08 +00:00
# Case where at least one attribute or its friendly name is in $attrs_display_order
# return -1 if $a before $b in $attrs_display_order
return ( $a_key < $b_key ) ? - 1 : 1 ;
2009-06-30 09:29:51 +00:00
}
2009-06-30 10:46:00 +00:00
/**
* Compare the names of two Atrribute objects
*/
function attrcmp ( $a1 , $a2 ) {
return strcmp ( strtolower ( $a1 -> getFriendlyName ()), strtolower ( $a2 -> getFriendlyName ()));
}
2009-06-30 09:29:51 +00:00
/**
* Reads an array and returns the array values back in lower case
* @ param array $array The array to convert the values to lowercase .
* @ returns array Array with values converted to lowercase .
*/
function arrayLower ( $array ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'arrayLower(): Entered with (%s)' , 1 , $array );
2009-06-30 09:29:51 +00:00
if ( ! is_array ( $array ))
return $array ;
$newarray = array ();
foreach ( $array as $key => $value ) {
$newarray [ $key ] = strtolower ( $value );
}
return $newarray ;
}
/**
* Strips all slashes from the specified array in place ( pass by ref ) .
* @ param Array $array The array to strip slashes from , typically one of
* $_GET , $_POST , or $_COOKIE .
*/
function array_stripslashes ( & $array ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'array_stripslashes(): Entered with (%s)' , 1 , $array );
2009-06-30 09:29:51 +00:00
if ( is_array ( $array ))
while ( list ( $key ) = each ( $array ))
if ( is_array ( $array [ $key ]) && $key != $array )
array_stripslashes ( $array [ $key ]);
else
$array [ $key ] = stripslashes ( $array [ $key ]);
}
/**
* Gets the USER_AGENT string from the $_SERVER array , all in lower case in
* an E_NOTICE safe manner .
* @ return string | false The user agent string as reported by the browser .
*/
function get_user_agent_string () {
2009-06-30 09:40:37 +00:00
if ( isset ( $_SERVER [ 'HTTP_USER_AGENT' ] ) )
$return = strtolower ( $_SERVER [ 'HTTP_USER_AGENT' ] );
else
$return = false ;
2009-06-30 09:29:51 +00:00
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
debug_log ( 'get_user_agent_string(): Entered with (), Returning (%s)' , 1 , $return );
2009-06-30 09:29:51 +00:00
return $return ;
}
/**
* Determines whether the browser ' s operating system is UNIX ( or something like UNIX ) .
* @ return boolean True if the brower ' s OS is UNIX , false otherwise .
*/
function is_browser_os_unix () {
$agent_strs = array (
'sunos' , 'sunos 4' , 'sunos 5' ,
'i86' ,
'irix' , 'irix 5' , 'irix 6' , 'irix6' ,
'hp-ux' , '09.' , '10.' ,
'aix' , 'aix 1' , 'aix 2' , 'aix 3' , 'aix 4' ,
'inux' ,
'sco' ,
'unix_sv' , 'unix_system_v' , 'ncr' , 'reliant' , 'dec' , 'osf1' ,
'dec_alpha' , 'alphaserver' , 'ultrix' , 'alphastation' ,
'sinix' ,
'freebsd' , 'bsd' ,
'x11' , 'vax' , 'openvms'
);
$return = string_in_array_value ( get_user_agent_string (), $agent_strs );
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
debug_log ( 'is_browser_os_unix(): Entered with (), Returning (%s)' , 1 , $return );
2009-06-30 09:29:51 +00:00
return $return ;
2009-06-30 09:22:30 +00:00
}
/**
* Determines whether the browser ' s operating system is Windows .
* @ return boolean True if the brower ' s OS is Windows , false otherwise .
*/
2009-06-30 09:29:51 +00:00
function is_browser_os_windows () {
$agent_strs = array (
'win' , 'win95' , 'windows 95' ,
'win16' , 'windows 3.1' , 'windows 16-bit' , 'windows' , 'win31' , 'win16' , 'winme' ,
2009-06-30 09:40:37 +00:00
'win2k' , 'winxp' ,
2009-06-30 09:29:51 +00:00
'win98' , 'windows 98' , 'win9x' ,
'winnt' , 'windows nt' , 'win32' ,
'32bit'
);
$return = string_in_array_value ( get_user_agent_string (), $agent_strs );
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
debug_log ( 'is_browser_os_windows(): Entered with (), Returning (%s)' , 1 , $return );
2009-06-30 09:29:51 +00:00
return $return ;
2009-06-30 09:22:30 +00:00
}
/**
* Determines whether the browser ' s operating system is Macintosh .
* @ return boolean True if the brower ' s OS is mac , false otherwise .
*/
2009-06-30 09:29:51 +00:00
function is_browser_os_mac () {
$agent_strs = array (
'mac' , '68000' , 'ppc' , 'powerpc'
2009-06-30 09:40:37 +00:00
);
2009-06-30 09:29:51 +00:00
$return = string_in_array_value ( get_user_agent_string (), $agent_strs );
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
debug_log ( 'is_browser_os_windows(): Entered with (), Returning (%s)' , 1 , $return );
2009-06-30 09:29:51 +00:00
return $return ;
2009-06-30 09:22:30 +00:00
}
2009-06-30 09:29:51 +00:00
/**
* Return the default format for search results .
*
* @ return string The format to use .
*/
function get_default_search_display () {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'get_default_search_display(): Entered with ()' , 1 );
2009-06-30 09:29:51 +00:00
2009-06-30 10:26:08 +00:00
global $default_search_display ;
2009-06-30 09:29:51 +00:00
if ( ! isset ( $default_search_display ) || is_null ( $default_search_display ) )
return 'list' ;
elseif ( 0 == strcasecmp ( $default_search_display , 'list' ) )
return 'list' ;
elseif ( 0 == strcasecmp ( $default_search_display , 'table' ) )
return 'table' ;
else
2009-06-30 10:26:08 +00:00
pla_error ( sprintf ( _ ( 'Your config.php specifies an invalid value for $default_search_display: %s. Please fix it' ), htmlspecialchars ( $default_search_display ) ) );
2009-06-30 09:29:51 +00:00
}
2009-06-30 09:22:30 +00:00
/**
* Checks if a string exists in an array , ignoring case .
2009-06-30 09:29:51 +00:00
*
* @ param string $needle What you are looking for
* @ param array $haystack The array that you think it is in .
* @ return bool True if its there , false if its not .
2009-06-30 09:22:30 +00:00
*/
2009-06-30 10:46:00 +00:00
function in_array_ignore_case ( $needle , $haystack ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:46:00 +00:00
debug_log ( 'Entered with (%s,%s)' , 1 , __FILE__ , __LINE__ , __METHOD__ , $needle , $haystack );
2009-06-30 09:29:51 +00:00
2009-06-30 10:46:00 +00:00
if ( ! is_array ( $haystack ))
2009-06-30 09:29:51 +00:00
return false ;
2009-06-30 10:46:00 +00:00
if ( ! is_string ( $needle ))
2009-06-30 09:29:51 +00:00
return false ;
2009-06-30 10:46:00 +00:00
$return = false ;
foreach ( $haystack as $element ) {
if ( DEBUG_ENABLED )
debug_log ( 'Comparing (%s) with (%s)' , 64 , __FILE__ , __LINE__ , __METHOD__ , $needle , $element );
if ( is_string ( $element ) && 0 == strcasecmp ( $needle , $element ))
$return = true ;
}
2009-06-30 09:29:51 +00:00
2009-06-30 10:46:00 +00:00
if ( DEBUG_ENABLED )
debug_log ( 'Entered with (%s,%s), Returning (%s)' , 1 , __FILE__ , __LINE__ , __METHOD__ , $needle , $haystack , $return );
return $return ;
2009-06-30 09:22:30 +00:00
}
/**
2009-06-30 09:29:51 +00:00
* Checks if a string exists in part in an array value , ignoring case .
2009-06-30 09:22:30 +00:00
*
2009-06-30 09:29:51 +00:00
* @ param string $needle What you are looking for
* @ param array $haystack The array that you think it is in .
* @ return bool True if its there , false if its not .
*/
function string_in_array_value ( $needle , $haystack ) {
# Set default return
$return = false ;
if ( ! is_string ( $needle )) return $return ;
if ( ! is_array ( $haystack )) return $return ;
foreach ( $haystack as $element )
if ( is_string ( $element ) && ( strpos ( $needle , $element ) !== false )) {
$return = true ;
break ;
}
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'string_in_array_value(): Entered with (%s,%s), Returning (%s)' , 1 , $needle , $haystack , $return );
2009-06-30 09:40:37 +00:00
2009-06-30 09:29:51 +00:00
return $return ;
}
/**
* String padding
2009-06-30 09:22:30 +00:00
*
2009-06-30 09:29:51 +00:00
* @ param string input string
* @ param integer length of the result
* @ param string the filling string
* @ param integer padding mode
2009-06-30 09:22:30 +00:00
*
2009-06-30 09:29:51 +00:00
* @ return string the padded string
2009-06-30 09:22:30 +00:00
*/
function full_str_pad ( $input , $pad_length , $pad_string = '' , $pad_type = 0 ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'full_str_pad(): Entered with (%s,%s,%s,%s)' , 1 , $input , $pad_length , $pad_string , $pad_type );
2009-06-30 09:29:51 +00:00
2009-06-30 09:40:37 +00:00
$str = '' ;
$length = $pad_length - strlen ( $input );
if ( $length > 0 ) { // str_repeat doesn't like negatives
if ( $pad_type == STR_PAD_RIGHT ) { // STR_PAD_RIGHT == 1
$str = $input . str_repeat ( $pad_string , $length );
} elseif ( $pad_type == STR_PAD_BOTH ) { // STR_PAD_BOTH == 2
$str = str_repeat ( $pad_string , floor ( $length / 2 ));
$str .= $input ;
$str .= str_repeat ( $pad_string , ceil ( $length / 2 ));
} else { // defaults to STR_PAD_LEFT == 0
$str = str_repeat ( $pad_string , $length ) . $input ;
}
2009-06-30 09:29:51 +00:00
2009-06-30 09:40:37 +00:00
} else { // if $length is negative or zero we don't need to do anything
$str = $input ;
}
return $str ;
2009-06-30 09:22:30 +00:00
}
/**
* Encryption using blowfish algorithm
*
* @ param string original data
* @ param string the secret
*
* @ return string the encrypted result
*
* @ access public
*
* @ author lem9 ( taken from the phpMyAdmin source )
*/
2009-06-30 09:29:51 +00:00
function pla_blowfish_encrypt ( $data , $secret = null ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'pla_blowfish_encrypt(): Entered with (%s,%s)' , 1 , $data , $secret );
2009-06-30 09:40:37 +00:00
2009-06-30 09:29:51 +00:00
# If our secret is null or blank, get the default.
if ( $secret === null || ! trim ( $secret ))
2009-06-30 10:46:00 +00:00
$secret = $_SESSION [ 'plaConfig' ] -> GetValue ( 'session' , 'blowfish' );
2009-06-30 09:40:37 +00:00
# If the secret isnt set, then just return the data.
if ( ! trim ( $secret ))
return $data ;
2009-06-30 09:29:51 +00:00
require_once LIBDIR . 'blowfish.php' ;
$pma_cipher = new Horde_Cipher_blowfish ;
$encrypt = '' ;
for ( $i = 0 ; $i < strlen ( $data ); $i += 8 ) {
$block = substr ( $data , $i , 8 );
if ( strlen ( $block ) < 8 )
$block = full_str_pad ( $block , 8 , " \0 " , 1 );
$encrypt .= $pma_cipher -> encryptBlock ( $block , $secret );
}
return base64_encode ( $encrypt );
2009-06-30 09:22:30 +00:00
}
/**
* Decryption using blowfish algorithm
*
* @ param string encrypted data
* @ param string the secret
*
* @ return string original data
*
* @ access public
*
* @ author lem9 ( taken from the phpMyAdmin source )
*/
2009-06-30 09:29:51 +00:00
function pla_blowfish_decrypt ( $encdata , $secret = null ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'pla_blowfish_decrypt(): Entered with (%s,%s)' , 1 , $encdata , $secret );
2009-06-30 09:40:37 +00:00
2009-06-30 09:29:51 +00:00
// This cache gives major speed up for stupid callers :)
static $cache = array ();
if ( isset ( $cache [ $encdata ] ) )
return $cache [ $encdata ];
# If our secret is null or blank, get the default.
if ( $secret === null || ! trim ( $secret ))
2009-06-30 10:46:00 +00:00
$secret = $_SESSION [ 'plaConfig' ] -> GetValue ( 'session' , 'blowfish' );
2009-06-30 09:40:37 +00:00
# If the secret isnt set, then just return the data.
if ( ! trim ( $secret ))
return $encdata ;
2009-06-30 09:29:51 +00:00
require_once LIBDIR . 'blowfish.php' ;
$pma_cipher = new Horde_Cipher_blowfish ;
$decrypt = '' ;
$data = base64_decode ( $encdata );
for ( $i = 0 ; $i < strlen ( $data ); $i += 8 ) {
$decrypt .= $pma_cipher -> decryptBlock ( substr ( $data , $i , 8 ), $secret );
}
$return = trim ( $decrypt );
$cache [ $encdata ] = $return ;
return $return ;
2009-06-30 09:22:30 +00:00
}
/**
* Gets a DN string using the user - configured tree_display_format string to format it .
*/
2009-06-30 10:46:00 +00:00
function draw_formatted_dn ( $ldapserver , $entry ) {
$dn = $entry -> getDn ();
2009-06-30 09:29:51 +00:00
2009-06-30 10:46:00 +00:00
if ( DEBUG_ENABLED )
debug_log ( 'Entered with (%s,%s)' , 1 , $ldapserver -> server_id , $dn );
2009-06-30 09:29:51 +00:00
2009-06-30 10:46:00 +00:00
$format = $_SESSION [ 'plaConfig' ] -> GetValue ( 'appearance' , 'tree_display_format' );
preg_match_all ( '/%[a-zA-Z_0-9]+/' , $format , $tokens );
2009-06-30 09:40:37 +00:00
$tokens = $tokens [ 0 ];
2009-06-30 10:46:00 +00:00
if ( DEBUG_ENABLED )
debug_log ( 'The tokens are (%s)' , 1 , $tokens );
foreach ( $tokens as $token ) {
if ( strcasecmp ( $token , '%dn' ) == 0 )
$format = str_replace ( $token , pretty_print_dn ( $dn ), $format );
2009-06-30 09:40:37 +00:00
2009-06-30 10:46:00 +00:00
elseif ( strcasecmp ( $token , '%rdn' ) == 0 )
$format = str_replace ( $token , pretty_print_dn ( $entry -> getRdn ()), $format );
elseif ( strcasecmp ( $token , '%rdnvalue' ) == 0 ) {
$rdn = get_rdn ( $dn , 0 , true );
$rdn_value = explode ( '=' , $rdn , 2 );
2009-06-30 09:40:37 +00:00
$rdn_value = $rdn_value [ 1 ];
2009-06-30 10:46:00 +00:00
$format = str_replace ( $token , $rdn_value , $format );
2009-06-30 09:40:37 +00:00
} else {
2009-06-30 10:46:00 +00:00
$attr_name = str_replace ( '%' , '' , $token );
2009-06-30 10:26:08 +00:00
$attr_values = $ldapserver -> getDNAttr ( $dn , $attr_name );
2009-06-30 09:40:37 +00:00
2009-06-30 10:46:00 +00:00
if ( is_null ( $attr_values ) || ( count ( $attr_values ) <= 0 ))
$display = '<' . _ ( 'none' ) . '>' ;
2009-06-30 09:40:37 +00:00
2009-06-30 10:46:00 +00:00
elseif ( is_array ( $attr_values ))
$display = htmlspecialchars ( implode ( ', ' , $attr_values ));
2009-06-30 09:40:37 +00:00
else
2009-06-30 10:46:00 +00:00
$display = htmlspecialchars ( $attr_values );
2009-06-30 09:40:37 +00:00
2009-06-30 10:46:00 +00:00
$format = str_replace ( $token , $display , $format );
2009-06-30 09:40:37 +00:00
}
}
2009-06-30 10:46:00 +00:00
2009-06-30 10:26:08 +00:00
return $format ;
2009-06-30 09:29:51 +00:00
}
/**
* Takes a shadow * attribute and returns the date as an integer .
2009-06-30 10:46:00 +00:00
* @ param $attrs array of Attribute objects
* @ param $attr a shadow attribute name
2009-06-30 09:29:51 +00:00
*/
function shadow_date ( $attrs , $attr ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'shadow_date(): Entered with (%s,%s)' , 1 , $attrs , $attr );
2009-06-30 09:29:51 +00:00
2009-06-30 10:46:00 +00:00
$shadowlastchange_attribute = null ;
$shadowmax_attribute = null ;
$shadowdate_attribute = null ;
foreach ( $attrs as $attribute ) {
if ( $attribute -> getName () == 'shadowLastChange' || $attribute -> getName () == 'shadowlastchange' ) {
$shadowlastchange_attribute = $attribute ;
} elseif ( $attribute -> getName () == 'shadowMax' || $attribute -> getName () == 'shadowmax' ) {
$shadowmax_attribute = $attribute ;
} elseif ( $attribute -> getName () == $attr || $attribute -> getName () == $attr ) {
$shadowdate_attribute = $attribute ;
}
if ( $shadowlastchange_attribute && $shadowmax_attribute && $shadowdate_attribute ) {
break ;
}
}
$shadowLastChange = $shadowlastchange_attribute ? $shadowlastchange_attribute -> getValue ( 0 ) : null ;
$shadowMax = $shadowmax_attribute ? $shadowmax_attribute -> getValue ( 0 ) : null ;
2009-06-30 09:29:51 +00:00
if ( 0 == strcasecmp ( $attr , 'shadowLastChange' ) && $shadowLastChange )
2009-06-30 09:40:37 +00:00
$shadow_date = $shadowLastChange ;
2009-06-30 09:29:51 +00:00
elseif ( 0 == strcasecmp ( $attr , 'shadowMax' ) && ( $shadowMax > 0 ) && $shadowLastChange )
$shadow_date = $shadowLastChange + $shadowMax ;
2009-06-30 10:46:00 +00:00
elseif ( 0 == strcasecmp ( $attr , 'shadowWarning' ) && ( $shadowdate_attribute -> getValue ( 0 ) > 0 )
&& $shadowLastChange && $shadowMax && $shadowMax > 0 )
$shadow_date = $shadowLastChange + $shadowMax - $shadowdate_attribute -> getValue ( 0 );
2009-06-30 09:29:51 +00:00
2009-06-30 10:46:00 +00:00
elseif ( 0 == strcasecmp ( $attr , 'shadowInactive' ) && ( $shadowdate_attribute -> getValue ( 0 ) > 0 )
&& $shadowLastChange && $shadowMax && $shadowMax > 0 )
$shadow_date = $shadowLastChange + $shadowMax + $shadowdate_attribute -> getValue ( 0 );
2009-06-30 09:29:51 +00:00
2009-06-30 10:46:00 +00:00
elseif ( 0 == strcasecmp ( $attr , 'shadowMin' ) && ( $shadowdate_attribute -> getValue ( 0 ) > 0 )
&& $shadowLastChange )
$shadow_date = $shadowLastChange + $shadowdate_attribute -> getValue ( 0 );
2009-06-30 09:29:51 +00:00
2009-06-30 10:46:00 +00:00
elseif ( 0 == strcasecmp ( $attr , 'shadowExpire' ) && ( $shadowdate_attribute -> getValue ( 0 ) > 0 ))
$shadow_date = $shadowdate_attribute -> getValue ( 0 );
2009-06-30 09:29:51 +00:00
else // Couldn't interpret the shadow date (could be 0 or -1 or something)
return false ;
return $shadow_date * 24 * 3600 ;
}
/**
* This function will clean up the values use during a search - namely , values that have brackets
* as that messes up the search filter .
* @ param string $val String that will be used in the search filter .
* @ return string $result String that is ready for the search filter .
*/
function clean_search_vals ( $val ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'clean_search_vals(): Entered with (%s)' , 1 , $val );
2009-06-30 09:29:51 +00:00
# Remove any escaped brackets already.
2009-06-30 10:26:08 +00:00
$val = preg_replace ( '/\\\\([\(\)])/' , '$1' , $val );
2009-06-30 09:29:51 +00:00
# The string might be a proper search filter
2009-06-30 10:26:08 +00:00
if ( preg_match ( '/^\([&\|!]\(/' , $val ) || ( preg_match ( '/\(([^\(|\)])*\)/' , $val )))
2009-06-30 09:29:51 +00:00
return $val ;
else
2009-06-30 10:26:08 +00:00
return preg_replace ( '/([\(\)])/' , '\\\\$1' , $val );
2009-06-30 09:29:51 +00:00
}
/**
* Server html select list
*/
function server_select_list ( $select_id = null , $only_logged_on = true , $select_name = 'server_id' , $js_script = null ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'server_select_list(): Entered with (%s,%s,%s,%s)' , 1 , $select_id , $only_logged_on , $select_name , $js_script );
2009-06-30 09:29:51 +00:00
$count = 0 ;
2009-06-30 10:46:00 +00:00
$server_menu_html = sprintf ( '<select name="%s" id="%s" %s>' , $select_name , $select_name , $js_script );
2009-06-30 09:29:51 +00:00
2009-06-30 10:46:00 +00:00
foreach ( $_SESSION [ 'plaConfig' ] -> ldapservers -> GetServerList () as $id ) {
2009-06-30 09:29:51 +00:00
2009-06-30 10:46:00 +00:00
$ldapserver = $_SESSION [ 'plaConfig' ] -> ldapservers -> Instance ( $id );
2009-06-30 09:29:51 +00:00
if ( $ldapserver -> isVisible ()) {
if ( $only_logged_on && ! $ldapserver -> haveAuthInfo ())
continue ;
$count ++ ;
$server = $ldapserver ;
$server_menu_html .= sprintf ( '<option value="%s" %s>%s</option>' ,
2009-06-30 10:46:00 +00:00
$ldapserver -> server_id ,( $ldapserver -> server_id == $select_id ? 'selected' : '' ), $ldapserver -> name );
2009-06-30 09:29:51 +00:00
}
}
$server_menu_html .= '</select>' ;
if ( $count > 1 )
return $server_menu_html ;
elseif ( $count )
2009-06-30 10:26:08 +00:00
return sprintf ( '%s <input type="hidden" name="%s" value="%s" />' ,
2009-06-30 09:29:51 +00:00
$server -> name , $select_name , $server -> server_id );
else
return null ;
}
2009-06-30 10:46:00 +00:00
function server_info_list ( $visible = false ) {
2009-06-30 09:29:51 +00:00
$server_info_list = array ();
2009-06-30 10:46:00 +00:00
if ( isset ( $_SESSION [ 'plaConfig' ])) {
foreach ( $_SESSION [ 'plaConfig' ] -> ldapservers -> GetServerList () as $id ) {
$ldapserver = $_SESSION [ 'plaConfig' ] -> ldapservers -> Instance ( $id );
2009-06-30 09:29:51 +00:00
2009-06-30 10:46:00 +00:00
if ( ! $ldapserver -> isValidServer ( $id ))
continue ;
if ( $visible && ! $ldapserver -> visible )
continue ;
2009-06-30 09:29:51 +00:00
2009-06-30 10:46:00 +00:00
$server_info_list [ $id ][ 'id' ] = $id ;
$server_info_list [ $id ][ 'name' ] = $ldapserver -> name ;
$server_info_list [ $id ][ 'base_dns' ] = $ldapserver -> getBaseDN ();
}
2009-06-30 09:29:51 +00:00
}
2009-06-30 10:46:00 +00:00
if ( defined ( 'DEBUG_ENABLED' ) && DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'server_info_list(): Entered with (), Returning (%s)' , 1 , $server_info_list );
2009-06-30 09:40:37 +00:00
2009-06-30 09:29:51 +00:00
return $server_info_list ;
}
/**
* Debug Logging to Syslog
*
2009-06-30 10:26:08 +00:00
* The global debug level is turned on in your configuration file by setting :
* < code >
* $config -> custom -> debug [ 'level' ] = 255 ;
* </ code >
* together with atleast one output direction ( currently file and syslog are supported ) .
* < code >
* $config -> custom -> debug [ 'file' ] = '/tmp/pla_debug.log' ;
* $config -> custom -> debug [ 'syslog' ] = true ;
* </ code >
2009-06-30 09:40:37 +00:00
*
2009-06-30 10:26:08 +00:00
* The debug level is turned into binary , then if the message levels bit is on
* the message will be sent to the debug log . ( Thus setting your debug level to 255 ,
* all bits on , will results in all messages being printed . )
*
* The message level bits are defined here .
* 0 ( 1 ) = Entry / Return results from function calls .
* 1 ( 2 ) = Configuration Processing
* 2 ( 4 ) = Template Processing
* 3 ( 8 ) = Schema Processing
* 4 ( 16 ) = LDAP Server Communication
* 5 ( 32 ) = Tree Processing
* 7 ( 64 ) = Other non generic messages
2009-06-30 10:46:00 +00:00
* 8 ( 128 ) = Page Processing
2009-06-30 09:29:51 +00:00
* @ param string $msg Message to send to syslog
2009-06-30 10:26:08 +00:00
* @ param int $level Log bit number for this message .
2009-06-30 09:29:51 +00:00
* @ see syslog . php
*/
function debug_log ( $msg , $level = 0 ) {
2009-06-30 10:46:00 +00:00
global $debug_file , $timer ;
# Temporary, to catch when these are not set in the function arguments.
$file = __FILE__ ;
$line = __LINE__ ;
$method = __METHOD__ ;
2009-06-30 09:29:51 +00:00
2009-06-30 09:40:37 +00:00
# In case we are called before we are fully initialised or if debugging is not set.
2009-06-30 10:46:00 +00:00
if ( ! isset ( $_SESSION [ 'plaConfig' ]) || ! ( $_SESSION [ 'plaConfig' ] -> GetValue ( 'debug' , 'file' )
|| $_SESSION [ 'plaConfig' ] -> GetValue ( 'debug' , 'syslog' )))
2009-06-30 09:29:51 +00:00
return false ;
2009-06-30 10:46:00 +00:00
$debug_level = $_SESSION [ 'plaConfig' ] -> GetValue ( 'debug' , 'level' );
2009-06-30 10:26:08 +00:00
if ( ! $debug_level || ( ! ( $level & $debug_level )))
return ;
2009-06-30 10:46:00 +00:00
$debugaddr = false ;
if ( $_SESSION [ 'plaConfig' ] -> GetValue ( 'debug' , 'addr' )) {
if ( isset ( $_SERVER [ 'HTTP_X_FORWARDED_FOR' ]) && $_SERVER [ 'HTTP_X_FORWARDED_FOR' ] == $_SESSION [ 'plaConfig' ] -> GetValue ( 'debug' , 'addr' ))
$debugaddr = true ;
elseif ( $_SERVER [ 'REMOTE_ADDR' ] == $_SESSION [ 'plaConfig' ] -> GetValue ( 'debug' , 'addr' ))
$debugaddr = true ;
} else $debugaddr = true ;
if ( ! $debugaddr )
return ;
# If we are limiting debug to a browser, then check that
2009-06-30 09:40:37 +00:00
$caller = basename ( $_SERVER [ 'PHP_SELF' ] );
if ( func_num_args () > 2 ) {
$args = func_get_args ();
2009-06-30 10:26:08 +00:00
array_shift ( $args );
array_shift ( $args );
2009-06-30 10:46:00 +00:00
# This is temporary, until we change all the debug_log statements.
if ( is_string ( $args [ 0 ]) && preg_match ( '/.php$/' , $args [ 0 ])) {
$file = array_shift ( $args );
# if (is_numeric($args[0]))
$line = array_shift ( $args );
# if (is_string($args[0]))
$method = array_shift ( $args );
}
2009-06-30 10:26:08 +00:00
$fargs = array ();
foreach ( $args as $key ) {
if ( is_array ( $key ) || is_object ( $key ))
array_push ( $fargs , serialize ( $key ));
else
array_push ( $fargs , $key );
}
$msg = vsprintf ( $msg , array_values ( $fargs ));
2009-06-30 09:40:37 +00:00
}
2009-06-30 10:26:08 +00:00
if ( function_exists ( 'stopwatch' ))
$timer = stopwatch ();
else
$timer = null ;
2009-06-30 09:40:37 +00:00
2009-06-30 10:46:00 +00:00
$debug_message = sprintf ( '[%2.3f] %3s-%s(%04s): %s: %s' , $timer , $level , basename ( $file ), $line , $method , substr ( $msg , 0 , 200 ));
2009-06-30 09:40:37 +00:00
2009-06-30 10:46:00 +00:00
if ( $debug_file || $_SESSION [ 'plaConfig' ] -> GetValue ( 'debug' , 'file' )) {
2009-06-30 10:26:08 +00:00
if ( ! $debug_file )
2009-06-30 10:46:00 +00:00
$debug_file = fopen ( $_SESSION [ 'plaConfig' ] -> GetValue ( 'debug' , 'file' ),
$_SESSION [ 'plaConfig' ] -> GetValue ( 'debug' , 'append' ) ? 'a' : 'w' );
2009-06-30 09:29:51 +00:00
2009-06-30 10:26:08 +00:00
fwrite ( $debug_file , $debug_message . " \n " );
2009-06-30 09:40:37 +00:00
}
2009-06-30 10:26:08 +00:00
2009-06-30 10:46:00 +00:00
if ( $_SESSION [ 'plaConfig' ] -> GetValue ( 'debug' , 'syslog' ))
2009-06-30 10:26:08 +00:00
syslog_notice ( $debug_message );
2009-06-30 09:40:37 +00:00
return syslog_notice ( sprintf ( '%s(%s): %s' , $caller , $level , $msg ) );
2009-06-30 09:29:51 +00:00
}
2009-06-30 10:26:08 +00:00
function enc_type_select_list ( $enc_type ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'enc_type_select_list(): Entered with (%s)' , 1 , $enc_type );
2009-06-30 09:29:51 +00:00
2009-06-30 10:26:08 +00:00
$html = '<select name="enc_type[]">' ;
2009-06-30 09:29:51 +00:00
$html .= '<option>clear</option>' ;
foreach ( array ( 'crypt' , 'ext_des' , 'md5crypt' , 'blowfish' , 'md5' , 'smd5' , 'sha' , 'ssha' ) as $option )
$html .= sprintf ( '<option%s>%s</option>' ,( $enc_type == $option ? ' selected="true"' : '' ), $option );
$html .= " </select> " ;
return $html ;
}
2009-06-30 09:40:37 +00:00
// Converts a little-endian hex-number to one, that 'hexdec' can convert
2009-06-30 09:29:51 +00:00
function littleEndian ( $hex ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'littleEndian(): Entered with (%s)' , 1 , $hex );
2009-06-30 09:29:51 +00:00
$result = '' ;
for ( $x = strlen ( $hex ) - 2 ; $x >= 0 ; $x = $x - 2 )
$result .= substr ( $hex , $x , 2 );
return $result ;
}
function binSIDtoText ( $binsid ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'binSIDtoText(): Entered with (%s)' , 1 , $binsid );
2009-06-30 09:29:51 +00:00
$hex_sid = bin2hex ( $binsid );
$rev = hexdec ( substr ( $hex_sid , 0 , 2 )); // Get revision-part of SID
$subcount = hexdec ( substr ( $hex_sid , 2 , 2 )); // Get count of sub-auth entries
$auth = hexdec ( substr ( $hex_sid , 4 , 12 )); // SECURITY_NT_AUTHORITY
$result = " $rev - $auth " ;
for ( $x = 0 ; $x < $subcount ; $x ++ ) {
$subauth [ $x ] =
hexdec ( littleEndian ( substr ( $hex_sid , 16 + ( $x * 8 ), 8 ))); // get all SECURITY_NT_AUTHORITY
$result .= " - " . $subauth [ $x ];
}
return $result ;
}
/**
* Sort a multi dimensional array .
* @ param array $data Multi demension array passed by reference
* @ param string $sortby Comma delimited string of sort keys .
* @ param bool $rev Whether to reverse sort .
* @ returnn array $data Sorted multi demension array .
*/
2009-06-30 10:26:08 +00:00
function masort ( & $data , $sortby , $rev = 0 ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:46:00 +00:00
debug_log ( 'Entered with (%s,%s,%s)' , 1 , __FILE__ , __LINE__ , __METHOD__ ,
$data , $sortby , $rev );
2009-06-30 09:29:51 +00:00
2009-06-30 10:46:00 +00:00
# if the array to sort is null or empty
if ( ! $data ) return ;
2009-06-30 09:29:51 +00:00
static $sort_funcs = array ();
if ( empty ( $sort_funcs [ $sortby ])) {
$code = " \$ c=0; \n " ;
2009-06-30 10:26:08 +00:00
foreach ( split ( ',' , $sortby ) as $key ) {
$code .= " if (is_object( \$ a) || is_object( \$ b)) { \n " ;
$code .= " if ( \$ a-> $key != \$ b-> $key ) \n " ;
if ( $rev )
$code .= " return ( \$ a-> $key < \$ b-> $key ? -1 : 1); \n " ;
else
$code .= " return ( \$ a-> $key > \$ b-> $key ? -1 : 1); \n " ;
$code .= " } else { \n " ;
2009-06-30 09:29:51 +00:00
$code .= " if ((! isset( \$ a[' $key '])) && (! isset( \$ b[' $key ']))) return 0; \n " ;
$code .= " if ((! isset( \$ a[' $key '])) && isset( \$ b[' $key '])) return -1; \n " ;
$code .= " if (isset( \$ a[' $key ']) && (! isset( \$ b[' $key ']))) return 1; \n " ;
2009-06-30 10:26:08 +00:00
2009-06-30 09:29:51 +00:00
$code .= " if (is_numeric( \$ a[' $key ']) && is_numeric( \$ b[' $key '])) { \n " ;
$code .= " if ( \$ a[' $key '] != \$ b[' $key ']) \n " ;
if ( $rev )
$code .= " return ( \$ a[' $key '] < \$ b[' $key '] ? -1 : 1); \n " ;
else
$code .= " return ( \$ a[' $key '] > \$ b[' $key '] ? -1 : 1); \n " ;
$code .= " } else { \n " ;
if ( $rev )
$code .= " if ( ( \$ c = strcasecmp( \$ b[' $key '], \$ a[' $key '])) != 0 ) return \$ c; \n " ;
else
$code .= " if ( ( \$ c = strcasecmp( \$ a[' $key '], \$ b[' $key '])) != 0 ) return \$ c; \n " ;
2009-06-30 10:26:08 +00:00
$code .= " }} \n " ;
2009-06-30 09:29:51 +00:00
}
$code .= 'return $c;' ;
2009-06-30 10:26:08 +00:00
$sort_func = $sort_funcs [ $sortby ] = create_function ( '$a, $b' , $code );
2009-06-30 09:29:51 +00:00
} else {
$sort_func = $sort_funcs [ $sortby ];
}
2009-06-30 10:26:08 +00:00
2009-06-30 09:29:51 +00:00
$sort_func = $sort_funcs [ $sortby ];
2009-06-30 10:26:08 +00:00
uasort ( $data , $sort_func );
2009-06-30 09:29:51 +00:00
}
/**
* Query LDAP and return a hash .
* @ param object $ldapserver The LDAPServer object of the server which the user hsa logged in .
* @ param string $base_dn The base DN to use .
* @ param string $filter LDAP Query filter .
* @ param string $key LDAP attribute to use as key .
* @ param array $attrs LDAP attributes to use as values .
2009-06-30 10:46:00 +00:00
* @ param bool $sort Specify false to not sort results by DN
* or true to have the returned array sorted by DN ( uses ksort )
* or an array of attribute names to sort by attribute values
2009-06-30 09:29:51 +00:00
* @ return array $results Array of values keyed by $key .
*/
2009-06-30 10:46:00 +00:00
function return_ldap_hash ( $ldapserver , $base_dn , $filter , $key , $attrs , $sort = true ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'return_ldap_hash(): Entered with (%s,%s,%s,%s,%s)' , 0 ,
2009-06-30 09:40:37 +00:00
$ldapserver -> server_id , $base_dn , $filter , $key , count ( $attrs ));
2009-06-30 09:29:51 +00:00
2009-06-30 10:46:00 +00:00
$ldapquery = $ldapserver -> search ( null , $base_dn , $filter , $attrs , 'sub' , $sort , LDAP_DEREF_NEVER , 0 );
2009-06-30 09:29:51 +00:00
2009-06-30 10:26:08 +00:00
$results = array ();
2009-06-30 09:29:51 +00:00
foreach ( $ldapquery as $dn => $dnattrs ) {
2009-06-30 10:46:00 +00:00
if ( isset ( $dnattrs [ $key ])) {
if ( is_array ( $dnattrs [ $key ])) {
foreach ( $dnattrs [ $key ] as $i => $k ) {
foreach ( $attrs as $attr ) {
if ( isset ( $dnattrs [ $attr ])) {
$v = '' ;
if ( is_array ( $dnattrs [ $attr ]) && isset ( $dnattrs [ $attr ][ $i ]))
$v = $dnattrs [ $attr ][ $i ];
if ( is_string ( $v ) && ( strlen ( $v ) > 0 ))
$results [ $k ][ $attr ] = $v ;
}
}
}
} else {
foreach ( $attrs as $attr ) {
if ( isset ( $dnattrs [ $attr ]))
$results [ $dnattrs [ $key ]][ $attr ] = $dnattrs [ $attr ];
}
}
2009-06-30 09:29:51 +00:00
}
}
return $results ;
}
2009-06-30 10:46:00 +00:00
/**
* This function dumps the $variable for debugging purposes
* @ param string | array Variable to dump
* @ param boolean Whether to stop execution or not .
*/
function debug_dump ( $variable , $die = false , $onlydebugaddr = false ) {
if ( $onlydebugaddr &&
$_SESSION [ 'plaConfig' ] -> GetValue ( 'debug' , 'addr' ) &&
$_SERVER [ 'HTTP_X_FORWARDED_FOR' ] != $_SESSION [ 'plaConfig' ] -> GetValue ( 'debug' , 'addr' ) &&
$_SERVER [ 'REMOTE_ADDR' ] != $_SESSION [ 'plaConfig' ] -> GetValue ( 'debug' , 'addr' ))
return ;
print '<PRE>' ;
2009-06-30 09:29:51 +00:00
print_r ( $variable );
2009-06-30 10:46:00 +00:00
print '</PRE>' ;
2009-06-30 09:29:51 +00:00
if ( $die )
die ();
}
/**
2009-06-30 10:26:08 +00:00
* This function returns a string automatically generated
2009-06-30 09:29:51 +00:00
* based on the criteria defined in the array $criteria in config . php
*/
function password_generate () {
2009-06-30 10:46:00 +00:00
$no_use_similiar = ! $_SESSION [ 'plaConfig' ] -> GetValue ( 'password' , 'use_similar' );
$lowercase = $_SESSION [ 'plaConfig' ] -> GetValue ( 'password' , 'lowercase' );
$uppercase = $_SESSION [ 'plaConfig' ] -> GetValue ( 'password' , 'uppercase' );
$digits = $_SESSION [ 'plaConfig' ] -> GetValue ( 'password' , 'numbers' );
$punctuation = $_SESSION [ 'plaConfig' ] -> GetValue ( 'password' , 'punctuation' );
$length = $_SESSION [ 'plaConfig' ] -> GetValue ( 'password' , 'length' );
2009-06-30 09:29:51 +00:00
$outarray = array ();
if ( $no_use_similiar ) {
$raw_lower = " a b c d e f g h k m n p q r s t u v w x y z " ;
$raw_numbers = " 2 3 4 5 6 7 8 9 " ;
$raw_punc = " # $ % ^ & * ( ) _ - + = . , [ ] { } : " ;
} else {
$raw_lower = " a b c d e f g h i j k l m n o p q r s t u v w x y z " ;
$raw_numbers = " 1 2 3 4 5 6 7 8 9 0 " ;
$raw_punc = " # $ % ^ & * ( ) _ - + = . , [ ] { } : | " ;
}
$llower = explode ( " " , $raw_lower );
shuffle ( $llower );
$lupper = explode ( " " , strtoupper ( $raw_lower ));
shuffle ( $lupper );
$numbers = explode ( " " , $raw_numbers );
shuffle ( $numbers );
$punc = explode ( " " , $raw_punc );
shuffle ( $punc );
if ( $lowercase > 0 )
$outarray = array_merge ( $outarray , a_array_rand ( $llower , $lowercase ));
if ( $uppercase > 0 )
$outarray = array_merge ( $outarray , a_array_rand ( $lupper , $uppercase ));
if ( $digits > 0 )
$outarray = array_merge ( $outarray , a_array_rand ( $numbers , $digits ));
if ( $punctuation > 0 )
$outarray = array_merge ( $outarray , a_array_rand ( $punc , $punctuation ));
$num_spec = $lowercase + $uppercase + $digits + $punctuation ;
if ( $num_spec < $length ) {
$leftover = array ();
if ( $lowercase > 0 )
$leftover = array_merge ( $leftover , $llower );
if ( $uppercase > 0 )
$leftover = array_merge ( $leftover , $lupper );
if ( $digits > 0 )
$leftover = array_merge ( $leftover , $numbers );
if ( $punctuation > 0 )
$leftover = array_merge ( $leftover , $punc );
if ( count ( $leftover ) == 0 )
$leftover = array_merge ( $leftover , $llower , $lupper , $numbers , $punc );
shuffle ( $leftover );
2009-06-30 10:41:18 +00:00
$outarray = array_merge ( $outarray , a_array_rand ( $leftover , $length - $num_spec ));
2009-06-30 09:29:51 +00:00
}
shuffle ( $outarray );
$return = implode ( '' , $outarray );
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
debug_log ( 'password_generate(): Entered with (), Returning (%s)' , 1 , $return );
2009-06-30 09:29:51 +00:00
return $return ;
}
/**
* This function returns an array of $num_req values
* randomly picked from the $input array
*
2009-06-30 10:26:08 +00:00
* @ param array of values
2009-06-30 09:29:51 +00:00
* @ param integer , number of values in returned array
* @ return string the padded string
*/
function a_array_rand ( $input , $num_req ) {
if ( count ( $input ) == 0 )
return array ();
if ( $num_req < 1 )
return array ();
$return = array ();
if ( $num_req > count ( $input )) {
for ( $i = 0 ; $i < $num_req ; $i ++ ) {
$idx = array_rand ( $input , 1 );
$return [] = $input [ $idx ];
}
} else {
$idxlist = array_rand ( $input , $num_req );
if ( $num_req == 1 )
$idxlist = array ( $idxlist );
for ( $i = 0 ; $i < count ( $idxlist ); $i ++ )
$return [] = $input [ $idxlist [ $i ]];
}
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'a_array_rand(): Entered with (%s,%s), Returning (%s)' , 1 , $input , $num_req , $return );
2009-06-30 09:40:37 +00:00
2009-06-30 09:29:51 +00:00
return $return ;
}
/**
* Returns the cached array of LDAP resources .
*
2009-06-30 10:26:08 +00:00
* Note that internally , this function utilizes a two - layer cache ,
2009-06-30 09:29:51 +00:00
* one in memory using a static variable for multiple calls within
* the same page load , and one in a session for multiple calls within
* the same user session ( spanning multiple page loads ) .
*
2009-06-30 10:26:08 +00:00
* @ return Returns the cached attributed requested ,
2009-06-30 09:29:51 +00:00
* or null if there is nothing cached ..
*/
function get_cached_item ( $server_id , $item , $subitem = 'null' ) {
# Set default return
$return = null ;
# Check config to make sure session-based caching is enabled.
2009-06-30 10:46:00 +00:00
if ( $_SESSION [ 'plaConfig' ] -> GetValue ( 'cache' , $item )) {
2009-06-30 09:29:51 +00:00
2009-06-30 10:26:08 +00:00
global $cache ;
2009-06-30 09:29:51 +00:00
if ( isset ( $cache [ $server_id ][ $item ][ $subitem ])) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'get_cached_item(): Returning MEMORY cached [%s] (%s)' , 1 , $item , $subitem );
2009-06-30 09:40:37 +00:00
2009-06-30 09:29:51 +00:00
$return = $cache [ $server_id ][ $item ][ $subitem ];
} elseif ( isset ( $_SESSION [ 'cache' ][ $server_id ][ $item ][ $subitem ])) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'get_cached_item(): Returning SESSION cached [%s] (%s)' , 1 , $item , $subitem );
2009-06-30 09:29:51 +00:00
2009-06-30 09:40:37 +00:00
$return = $_SESSION [ 'cache' ][ $server_id ][ $item ][ $subitem ];
$cache [ $server_id ][ $item ][ $subitem ] = $return ;
2009-06-30 10:26:08 +00:00
}
2009-06-30 09:40:37 +00:00
}
if ( DEBUG_ENABLED )
debug_log ( 'get_cached_item(): Entered with (%s,%s,%s), Returning (%s)' , 1 ,
2009-06-30 10:26:08 +00:00
$server_id , $item , $subitem , count ( $return ));
2009-06-30 09:29:51 +00:00
return $return ;
}
/**
* Caches the specified $item for the specified $server_id .
*
* Returns true on success of false on failure .
*/
function set_cached_item ( $server_id , $item , $subitem = 'null' , $data ) {
2009-06-30 09:40:37 +00:00
if ( DEBUG_ENABLED )
2009-06-30 10:26:08 +00:00
debug_log ( 'set_cached_item(): Entered with (%s,%s,%s,%s)' , 1 , $server_id , $item , $subitem , $data );
2009-06-30 09:29:51 +00:00
# Check config to make sure session-based caching is enabled.
2009-06-30 10:46:00 +00:00
if ( $_SESSION [ 'plaConfig' ] -> GetValue ( 'cache' , $item )) {
2009-06-30 10:26:08 +00:00
global $cache ;
2009-06-30 09:29:51 +00:00
$cache [ $server_id ][ $item ][ $subitem ] = $data ;
2009-06-30 09:40:37 +00:00
$_SESSION [ 'cache' ][ $server_id ][ $item ][ $subitem ] = $data ;
2009-06-30 09:29:51 +00:00
return true ;
} else
return false ;
}
2009-06-30 10:46:00 +00:00
/**
* Deletes the cache for a specified $item for the specified $server_id
*
* @ return : void
*/
function del_cached_item ( $server_id , $item , $subitem = 'null' ) {
if ( DEBUG_ENABLED )
debug_log ( 'del_cached_item(): Entered with (%s,%s,%s)' , 1 , $server_id , $item , $subitem );
# Check config to make sure session-based caching is enabled.
if ( isset ( $_SESSION [ 'cache' ][ $server_id ][ $item ][ $subitem ]))
unset ( $_SESSION [ 'cache' ][ $server_id ][ $item ][ $subitem ]);
}
2009-06-30 09:40:37 +00:00
/**
* Draws an HTML date selector button which , when clicked , pops up a date selector dialog .
* @ param string $attr The name of the date type attribute
*/
function draw_date_selector_link ( $attr ) {
2009-06-30 10:26:08 +00:00
debug_log ( 'draw_date_selector_link(): Entered with (%s)' , 1 , $attr );
2009-06-30 09:40:37 +00:00
$href = " javascript:dateSelector(' $attr '); " ;
2009-06-30 10:26:08 +00:00
$title = _ ( 'Click to popup a dialog to select a date graphically' );
2009-06-30 10:40:33 +00:00
printf ( '<a href="%s" title="%s"><img class="chooser" src="images/calendar.png" id="f_trigger_%s" style="cursor: pointer;" alt="Calendar" /></a>' , $href , $title , $attr );
2009-06-30 09:40:37 +00:00
}
2009-06-30 10:26:08 +00:00
function no_expire_header () {
header ( 'Expires: Mon, 26 Jul 1997 05:00:00 GMT' );
header ( 'Last-Modified: ' . gmdate ( 'D, d M Y H:i:s' ) . ' GMT' );
header ( 'Cache-Control: no-store, no-cache, must-revalidate' );
header ( 'Cache-Control: post-check=0, pre-check=0' , false );
header ( 'Pragma: no-cache' );
2009-06-30 09:40:37 +00:00
}
2009-06-30 10:41:18 +00:00
/**
* This is for Opera . By putting " random junk " in the query string , it thinks
* that it does not have a cached version of the page , and will thus
* fetch the page rather than display the cached version
*/
function random_junk () {
$time = gettimeofday ();
return md5 ( strtotime ( 'now' ) . $time [ 'usec' ]);
}
2009-06-30 10:46:00 +00:00
/**
* This function will convert the browser two character language into the
* default 5 character language , where the country portion should NOT be
* assumed to be upper case characters of the first two characters .
*/
function auto_lang ( $lang ) {
switch ( $lang ) {
case 'ja' : return 'ja_JP' ;
case 'cs' : return 'cs_CZ' ;
default : return sprintf ( '%s_%s' , $lang , strtoupper ( $lang ));
}
}
function get_request ( $attr , $type = 'POST' , $die = false , $default = null ) {
switch ( $type ) {
case 'GET' :
$value = isset ( $_GET [ $attr ]) ? $_GET [ $attr ] : $default ;
break ;
case 'REQUEST' :
$value = isset ( $_REQUEST [ $attr ]) ? $_REQUEST [ $attr ] : $default ;
break ;
case 'SESSION' :
$value = isset ( $_SESSION [ $attr ]) ? $_SESSION [ $attr ] : $default ;
break ;
case 'POST' :
default :
$value = isset ( $_POST [ $attr ]) ? $_POST [ $attr ] : $default ;
break ;
}
if ( ! is_array ( $value ) && trim ( $value ) == " " )
$value = $default ;
if ( $die && is_null ( $value ))
system_message ( array (
'title' => _ ( 'Generic Error' ),
'body' => sprintf ( '%s: Called "%s" without "%s" using "%s"' , basename ( $_SERVER [ 'PHP_SELF' ]), get_request ( 'cmd' , 'REQUEST' ), $attr , $type ),
'type' => 'error' ), 'index.php' );
return $value ;
}
function system_message ( $msg , $redirect = null , $noserverid = false ) {
global $ldapserver ;
if ( ! is_array ( $msg ))
return null ;
$_SESSION [ 'sysmsg' ][] = $msg ;
if ( $redirect ) {
if ( $noserverid || ! $ldapserver ) {
header ( " Location: $redirect " );
} else {
if ( preg_match ( '/\?/' , $redirect ))
header ( sprintf ( 'Location: %s&server_id=%s' , $redirect , $ldapserver -> server_id ));
else
header ( sprintf ( 'Location: %s?server_id=%s' , $redirect , $ldapserver -> server_id ));
}
exit ;
}
}
/**
* Returns a HTML id that can be used in the URL after the #.
*
* @ param string $dn The DN to pretty - print .
* @ return string
*/
function htmlid ( $sid , $dn ) {
return sprintf ( 'SID%s:%s' , $sid , preg_replace ( '/[\ =,]/' , '_' , $dn ));
}
/*
* Makes sure that the config file is properly setup and
* that your install of PHP can handle LDAP stuff .
*/
function check_config ( $config_file ) {
global $config , $ldapservers ;
global $friendly_attrs , $queries , $attrs_display_order ;
global $hidden_attrs , $hidden_except_dn , $hidden_attrs_ro ;
global $read_only_attrs , $read_only_except_dn , $unique_attrs ;
# Read in config_default.php
require_once LIBDIR . 'config_default.php' ;
# Make sure their PHP version is current enough
if ( strcmp ( phpversion (), REQUIRED_PHP_VERSION ) < 0 )
pla_error ( sprintf ( 'phpLDAPadmin requires PHP version %s or greater.<br /><small>(You are using %s)</small>' ,
REQUIRED_PHP_VERSION , phpversion ()));
# Make sure this PHP install has all our required extensions
if ( ! extension_loaded ( 'ldap' ))
system_message ( array (
'title' => _ ( 'Missing required extension' ),
'body' => 'Your install of PHP appears to be missing LDAP support.<br /><br />Please install LDAP support before using phpLDAPadmin.<br /><small>(Dont forget to restart your web server afterwards)</small>' ,
'type' => 'error' ));
# Make sure that we have php-xml loaded.
if ( ! function_exists ( 'xml_parser_create' ))
system_message ( array (
'title' => _ ( 'Missing required extension' ),
'body' => 'Your install of PHP appears to be missing XML support.<br /><br />Please install XML support before using phpLDAPadmin.<br /><small>(Dont forget to restart your web server afterwards)</small>' ,
'type' => 'error' ));
# Make sure their session save path is writable, if they are using a file system session module, that is.
if ( ! strcasecmp ( 'Files' , session_module_name () && ! is_writable ( realpath ( session_save_path ()))))
system_message ( array (
'title' => _ ( 'Missing required extension' ),
'body' => 'Your PHP session configuration is incorrect. Please check the value of session.save_path in your php.ini to ensure that the directory specified there exists and is writable. The current setting of "' . session_save_path () . '" is un-writable by the web server.' ,
'type' => 'error' ));
$config = new Config ;
/* Check for syntax errors in config . php
As of php 4.3 . 5 , this NO longer catches fatal errors : ( */
ob_start ();
require_once $config_file ;
$str = '' ;
if ( ob_get_level ()) {
$str = ob_get_contents ();
ob_end_clean ();
}
if ( $str ) {
$str = strip_tags ( $str );
$matches = array ();
preg_match ( '/(.*):\s+(.*):.*\s+on line (\d+)/' , $str , $matches );
if ( isset ( $matches [ 1 ]) && isset ( $matches [ 2 ]) && isset ( $matches [ 3 ])) {
$error_type = $matches [ 1 ];
$error = $matches [ 2 ];
$line_num = $matches [ 3 ];
$file = file ( $config_file );
echo '<?xml version="1.0" encoding="utf-8"?>' . " \n " ;
echo '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML Basic 1.0//EN"' . " \n " ;
echo ' "http://www.w3.org/TR/xhtml-basic/xhtml-basic10.dtd">' . " \n " ;
echo " \n " ;
echo '<html>' ;
echo '<head>' ;
echo '<title>phpLDAPadmin Config File Error</title>' ;
echo '<link type="text/css" rel="stylesheet" href="css/style.css" />' ;
echo '</head>' ;
echo '<body>' ;
echo '<h3 class="title">Config File ERROR</h3>' ;
printf ( '<h3 class="subtitle">%s (%s) on line %s</h3>' , $error_type , $error , $line_num );
echo '<center>' ;
printf ( 'Looks like your config file has an ERROR on line %s.<br />' , $line_num );
echo 'Here is a snippet around that line <br />' ;
echo '<br />' . " \n " ;
echo '<div style="text-align: left; font-family: monospace; margin-left: 80px; margin-right: 80px; border: 1px solid black; padding: 10px;">' ;
for ( $i = $line_num - 9 ; $i < $line_num + 5 ; $i ++ ) {
if ( $i + 1 == $line_num )
echo '<div style="color:red;background:#fdd">' ;
if ( $i < 0 )
continue ;
printf ( '<b>%s</b>: %s<br />' , $i + 1 , htmlspecialchars ( $file [ $i ]));
if ( $i + 1 == $line_num )
echo '</div>' ;
}
echo '</div>' ;
echo '<br />' ;
echo 'Hint: Sometimes these errors are caused by lines <b>preceding</b> the line reported.' ;
echo '</center>' ;
echo '</body>' ;
echo '</html>' ;
return false ;
}
}
# Check for server definitions.
if ( ! isset ( $ldapservers ) || count ( $ldapservers -> GetServerList ()) == 0 )
system_message ( array (
'title' => _ ( 'Missing required extension' ),
'body' => 'Your config.php is missing Server Definitions. Please see the sample file config/config.php.example.' ,
'type' => 'error' ));
$config -> ldapservers = $ldapservers ;
if ( isset ( $friendly_attrs )) $config -> friendly_attrs = $friendly_attrs ;
if ( isset ( $queries )) $config -> queries = $queries ;
if ( isset ( $attrs_display_order )) $config -> attrs_display_order = $attrs_display_order ;
if ( isset ( $hidden_attrs )) $config -> hidden_attrs = $hidden_attrs ;
if ( isset ( $hidden_except_dn )) $config -> hidden_except_dn = $hidden_except_dn ;
if ( isset ( $hidden_attrs_ro )) $config -> hidden_attrs_ro = $hidden_attrs_ro ;
if ( isset ( $read_only_attrs )) $config -> read_only_attrs = $read_only_attrs ;
if ( isset ( $read_only_except_dn )) $config -> read_only_except_dn = $read_only_except_dn ;
if ( isset ( $unique_attrs )) $config -> unique_attrs = $unique_attrs ;
# Check the memory limit parameter.
if ( ini_get ( 'memory_limit' ) < $config -> GetValue ( 'session' , 'memorylimit' ))
system_message ( array (
'title' => _ ( 'Memory Limit low.' ),
'body' => sprintf ( 'Your php memory limit is low - currently %s' , ini_get ( 'memory_limit' ), false ),
'type' => 'error' ));
# if $_SESSION['sysmsg'] is set, then there were problems.
if ( isset ( $_SESSION [ 'sysmsg' ]))
return false ;
return true ;
}
2009-06-30 08:05:37 +00:00
?>