X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fabook_ldap_server.php;h=fe0fff455326899151f5bd4a13a079e3d22263f5;hb=0f610dca6fd52a148e290f79cdfcfc572998b475;hp=93097956fe01906bddbd0d110d0a488303c91829;hpb=06b4facd9478c9f1b4464a0f6ef3895ec8d92bf9;p=squirrelmail.git diff --git a/functions/abook_ldap_server.php b/functions/abook_ldap_server.php index 93097956..fe0fff45 100644 --- a/functions/abook_ldap_server.php +++ b/functions/abook_ldap_server.php @@ -1,16 +1,23 @@ * host => LDAP server hostname/IP-address * base => LDAP server root (base dn). Empty string allowed. * ? port => LDAP server TCP port number (default: 389) @@ -20,29 +27,82 @@ * ? maxrows => Maximum # of rows in search result * ? timeout => Timeout for LDAP operations (in seconds, default: 30) * Might not work for all LDAP libraries or servers. - * + * ? binddn => LDAP Bind DN. + * ? bindpw => LDAP Bind Password. + * ? protocol => LDAP Bind protocol. + * * NOTE. This class should not be used directly. Use the * "AddressBook" class instead. - * - * $Id$ + * @package squirrelmail + * @subpackage addressbook */ - class abook_ldap_server extends addressbook_backend { + /** + * @var string backend type + */ var $btype = 'remote'; + /** + * @var string backend name + */ var $bname = 'ldap_server'; /* Parameters changed by class */ + /** + * @var string displayed name + */ var $sname = 'LDAP'; /* Service name */ - var $server = ''; /* LDAP server name */ - var $port = 389; /* LDAP server port */ - var $basedn = ''; /* LDAP base DN */ - var $charset = 'utf-8'; /* LDAP server charset */ - var $linkid = false; /* PHP LDAP link ID */ - var $bound = false; /* True if LDAP server is bound */ - var $maxrows = 250; /* Max rows in result */ - var $timeout = 30; /* Timeout for LDAP operations (in seconds) */ - - /* Constructor. Connects to database */ + /** + * @var string LDAP server name or address or url + */ + var $server = ''; + /** + * @var integer LDAP server port + */ + var $port = 389; + /** + * @var string LDAP base DN + */ + var $basedn = ''; + /** + * @var string charset used for entries in LDAP server + */ + var $charset = 'utf-8'; + /** + * @var object PHP LDAP link ID + */ + var $linkid = false; + /** + * @var bool True if LDAP server is bound + */ + var $bound = false; + /** + * @var integer max rows in result + */ + var $maxrows = 250; + /** + * @var integer timeout of LDAP operations (in seconds) + */ + var $timeout = 30; + /** + * @var string DN to bind to (non-anonymous bind) + * @since 1.5.0 and 1.4.3 + */ + var $binddn = ''; + /** + * @var string password to bind with (non-anonymous bind) + * @since 1.5.0 and 1.4.3 + */ + var $bindpw = ''; + /** + * @var integer protocol used to connect to ldap server + * @since 1.5.0 and 1.4.3 + */ + var $protocol = ''; + + /** + * Constructor. Connects to database + * @param array connection options + */ function abook_ldap_server($param) { if(!function_exists('ldap_connect')) { $this->set_error('LDAP support missing from PHP'); @@ -63,13 +123,22 @@ class abook_ldap_server extends addressbook_backend { if(isset($param['timeout'])) { $this->timeout = $param['timeout']; } + if(isset($param['binddn'])) { + $this->binddn = $param['binddn']; + } + if(isset($param['bindpw'])) { + $this->bindpw = $param['bindpw']; + } + if(isset($param['protocol'])) { + $this->protocol = $param['protocol']; + } if(empty($param['name'])) { $this->sname = 'LDAP: ' . $param['host']; } else { $this->sname = $param['name']; } - + $this->open(true); } else { $this->set_error('Invalid argument to constructor'); @@ -77,39 +146,66 @@ class abook_ldap_server extends addressbook_backend { } - /* Open the LDAP server. New connection if $new is true */ + /** + * Open the LDAP server. + * @param bool $new is it a new connection + * @return bool + */ function open($new = false) { $this->error = ''; - + /* Connection is already open */ if($this->linkid != false && !$new) { return true; } - + $this->linkid = @ldap_connect($this->server, $this->port); if(!$this->linkid) { if(function_exists('ldap_error')) { - return $this->set_error(ldap_error($this->linkid)); + return $this->set_error(ldap_error($this->linkid)); } else { return $this->set_error('ldap_connect failed'); } } - - if(!@ldap_bind($this->linkid)) { - if(function_exists('ldap_error')) { - return $this->set_error(ldap_error($this->linkid)); - } else { - return $this->set_error('ldap_bind failed'); + + if(!empty($this->protocol)) { + if(!@ldap_set_option($this->linkid, LDAP_OPT_PROTOCOL_VERSION, $this->protocol)) { + if(function_exists('ldap_error')) { + return $this->set_error(ldap_error($this->linkid)); + } else { + return $this->set_error('ldap_set_option failed'); + } } } - + + if(!empty($this->binddn)) { + if(!@ldap_bind($this->linkid, $this->binddn, $this->bindpw)) { + if(function_exists('ldap_error')) { + return $this->set_error(ldap_error($this->linkid)); + } else { + return $this->set_error('authenticated ldap_bind failed'); + } + } + } else { + if(!@ldap_bind($this->linkid)) { + if(function_exists('ldap_error')) { + return $this->set_error(ldap_error($this->linkid)); + } else { + return $this->set_error('anonymous ldap_bind failed'); + } + } + } + $this->bound = true; - + return true; } - - /* Encode iso8859-1 string to the charset used by this LDAP server */ + /** + * Encode string to the charset used by this LDAP server + * @param string string that has to be encoded + * @return string encoded string + */ function charset_encode($str) { if($this->charset == 'utf-8') { if(function_exists('utf8_encode')) { @@ -122,86 +218,77 @@ class abook_ldap_server extends addressbook_backend { } } - - /* Decode from charset used by this LDAP server to iso8859-1 */ + /** + * Decode from charset used by this LDAP server to html entities + * + * Uses squirrelmail charset_decode functions + * @param string string that has to be decoded + * @return string decoded string + */ function charset_decode($str) { - if($this->charset == 'utf-8') { - if(function_exists('utf8_decode')) { - return utf8_decode($str); - } else - return $str; - } + global $default_charset; + if ($this->charset != $default_charset) { + return charset_decode($this->charset,$str); } else { return $str; } } - + /* ========================== Public ======================== */ - /* Search the LDAP server */ + /** + * Search the LDAP server + * @param string $expr search expression + * @return array search results + */ function search($expr) { - + /* To be replaced by advanded search expression parsing */ if(is_array($expr)) return false; - + /* Encode the expression */ $expr = $this->charset_encode($expr); if(strstr($expr, '*') === false) { $expr = "*$expr*"; } $expression = "cn=$expr"; - + /* Make sure connection is there */ if(!$this->open()) { return false; } - - /* Do the search. Use improved ldap_search() if PHP version is - * 4.0.2 or newer. */ - if(sqCheckPHPVersion(4, 0, 2)) { - $sret = @ldap_search($this->linkid, $this->basedn, $expression, - array('dn', 'o', 'ou', 'sn', 'givenname', - 'cn', 'mail', 'telephonenumber'), - 0, $this->maxrows, $this->timeout); - } else { - $sret = @ldap_search($this->linkid, $this->basedn, $expression, - array('dn', 'o', 'ou', 'sn', 'givenname', - 'cn', 'mail', 'telephonenumber')); - } - + + $sret = @ldap_search($this->linkid, $this->basedn, $expression, + array('dn', 'o', 'ou', 'sn', 'givenname', 'cn', 'mail'), + 0, $this->maxrows, $this->timeout); + /* Should get error from server using the ldap_error() function, * but it only exist in the PHP LDAP documentation. */ if(!$sret) { if(function_exists('ldap_error')) { - return $this->set_error(ldap_error($this->linkid)); + return $this->set_error(ldap_error($this->linkid)); } else { - return $this->set_error('ldap_search failed'); + return $this->set_error('ldap_search failed'); } } - + if(@ldap_count_entries($this->linkid, $sret) <= 0) { return array(); } - + /* Get results */ $ret = array(); $returned_rows = 0; $res = @ldap_get_entries($this->linkid, $sret); for($i = 0 ; $i < $res['count'] ; $i++) { $row = $res[$i]; - + /* Extract data common for all e-mail addresses * of an object. Use only the first name */ $nickname = $this->charset_decode($row['dn']); $fullname = $this->charset_decode($row['cn'][0]); - - if(empty($row['telephonenumber'][0])) { - $phone = ''; - } else { - $phone = $this->charset_decode($row['telephonenumber'][0]); - } - + if(!empty($row['ou'][0])) { $label = $this->charset_decode($row['ou'][0]); } @@ -210,19 +297,19 @@ class abook_ldap_server extends addressbook_backend { } else { $label = ''; } - + if(empty($row['givenname'][0])) { $firstname = ''; } else { $firstname = $this->charset_decode($row['givenname'][0]); } - + if(empty($row['sn'][0])) { $surname = ''; } else { $surname = $this->charset_decode($row['sn'][0]); } - + /* Add one row to result for each e-mail address */ if(isset($row['mail']['count'])) { for($j = 0 ; $j < $row['mail']['count'] ; $j++) { @@ -232,13 +319,12 @@ class abook_ldap_server extends addressbook_backend { 'lastname' => $surname, 'email' => $row['mail'][$j], 'label' => $label, - 'phone' => $phone, 'backend' => $this->bnum, 'source' => &$this->sname)); - + // Limit number of hits $returned_rows++; - if(($returned_rows >= $this->maxrows) && + if(($returned_rows >= $this->maxrows) && ($this->maxrows > 0) ) { ldap_free_result($sret); return $ret; @@ -247,21 +333,27 @@ class abook_ldap_server extends addressbook_backend { } // for($j ...) } // isset($row['mail']['count']) - + } - + ldap_free_result($sret); return $ret; } /* end search() */ - /* If you run a tiny LDAP server and you want the "List All" button - * to show EVERYONE, then uncomment this tiny block of code: + /** + * List all entries present in LDAP server * - * function list_addr() { - * return $this->search('*'); - * } + * If you run a tiny LDAP server and you want the "List All" button + * to show EVERYONE, disable first return call and enable the second one. + * Remember that maxrows setting might limit list of returned entries. * - * Careful with this -- it could get quite large for big sites. */ + * Careful with this -- it could get quite large for big sites. + * @return array all entries in ldap server + */ + function list_addr() { + return array(); + // return $this->search('*'); + } } ?> \ No newline at end of file