/**
* abook_ldap_server.php
*
- * Copyright (c) 1999-2003 The SquirrelMail Project Team
+ * Copyright (c) 1999-2004 The SquirrelMail Project Team
* Licensed under the GNU GPL. For full terms see the file COPYING.
*
* Address book backend for LDAP server
* ? 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$
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage addressbook
*/
+/**
+ * Undocumented class - fixme
+ * @package squirrelmail
+ */
class abook_ldap_server extends addressbook_backend {
var $btype = 'remote';
var $bname = 'ldap_server';
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) */
+ var $binddn = ''; /* DN to bind to (non-anonymous bind) */
+ var $bindpw = ''; /* password to bind with (non-anonymous bind) */
+ var $protocol = ''; /* protocol used to connect to ldap server */
/* Constructor. Connects to database */
function abook_ldap_server($param) {
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');
/* Open the LDAP server. New connection if $new is true */
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;
}
}
}
-
+
/* ========================== Public ======================== */
/* Search the LDAP server */
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', 'telephonenumber'),
+ 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]);
}
} 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++) {
'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;
} // for($j ...)
} // isset($row['mail']['count'])
-
+
}
-
+
ldap_free_result($sret);
return $ret;
} /* end search() */
projects / squirrelmail.git / blobdiff