3 * abook_ldap_server.php
5 * Copyright (c) 1999-2005 The SquirrelMail Project Team
6 * Licensed under the GNU GPL. For full terms see the file COPYING.
8 * Address book backend for LDAP server
11 * @package squirrelmail
12 * @subpackage addressbook
16 * Address book backend for LDAP server
18 * An array with the following elements must be passed to
19 * the class constructor (elements marked ? are optional):
21 * host => LDAP server hostname/IP-address
22 * base => LDAP server root (base dn). Empty string allowed.
23 * ? port => LDAP server TCP port number (default: 389)
24 * ? charset => LDAP server charset (default: utf-8)
25 * ? name => Name for LDAP server (default "LDAP: hostname")
26 * Used to tag the result data
27 * ? maxrows => Maximum # of rows in search result
28 * ? timeout => Timeout for LDAP operations (in seconds, default: 30)
29 * Might not work for all LDAP libraries or servers.
30 * ? binddn => LDAP Bind DN.
31 * ? bindpw => LDAP Bind Password.
32 * ? protocol => LDAP Bind protocol.
34 * NOTE. This class should not be used directly. Use the
35 * "AddressBook" class instead.
36 * @package squirrelmail
37 * @subpackage addressbook
39 class abook_ldap_server
extends addressbook_backend
{
41 * @var string backend type
43 var $btype = 'remote';
45 * @var string backend name
47 var $bname = 'ldap_server';
49 /* Parameters changed by class */
51 * @var string displayed name
53 var $sname = 'LDAP'; /* Service name */
55 * @var string LDAP server name or address or url
59 * @var integer LDAP server port
63 * @var string LDAP base DN
67 * @var string charset used for entries in LDAP server
69 var $charset = 'utf-8';
71 * @var object PHP LDAP link ID
75 * @var bool True if LDAP server is bound
79 * @var integer max rows in result
83 * @var integer timeout of LDAP operations (in seconds)
87 * @var string DN to bind to (non-anonymous bind)
88 * @since 1.5.0 and 1.4.3
92 * @var string password to bind with (non-anonymous bind)
93 * @since 1.5.0 and 1.4.3
97 * @var integer protocol used to connect to ldap server
98 * @since 1.5.0 and 1.4.3
103 * Constructor. Connects to database
104 * @param array connection options
106 function abook_ldap_server($param) {
107 if(!function_exists('ldap_connect')) {
108 $this->set_error('LDAP support missing from PHP');
111 if(is_array($param)) {
112 $this->server
= $param['host'];
113 $this->basedn
= $param['base'];
114 if(!empty($param['port'])) {
115 $this->port
= $param['port'];
117 if(!empty($param['charset'])) {
118 $this->charset
= strtolower($param['charset']);
120 if(isset($param['maxrows'])) {
121 $this->maxrows
= $param['maxrows'];
123 if(isset($param['timeout'])) {
124 $this->timeout
= $param['timeout'];
126 if(isset($param['binddn'])) {
127 $this->binddn
= $param['binddn'];
129 if(isset($param['bindpw'])) {
130 $this->bindpw
= $param['bindpw'];
132 if(isset($param['protocol'])) {
133 $this->protocol
= $param['protocol'];
135 if(empty($param['name'])) {
136 $this->sname
= 'LDAP: ' . $param['host'];
139 $this->sname
= $param['name'];
144 $this->set_error('Invalid argument to constructor');
150 * Open the LDAP server.
151 * @param bool $new is it a new connection
154 function open($new = false) {
157 /* Connection is already open */
158 if($this->linkid
!= false && !$new) {
162 $this->linkid
= @ldap_connect
($this->server
, $this->port
);
164 if(function_exists('ldap_error')) {
165 return $this->set_error(ldap_error($this->linkid
));
167 return $this->set_error('ldap_connect failed');
171 if(!empty($this->protocol
)) {
172 if(!@ldap_set_option
($this->linkid
, LDAP_OPT_PROTOCOL_VERSION
, $this->protocol
)) {
173 if(function_exists('ldap_error')) {
174 return $this->set_error(ldap_error($this->linkid
));
176 return $this->set_error('ldap_set_option failed');
181 if(!empty($this->binddn
)) {
182 if(!@ldap_bind
($this->linkid
, $this->binddn
, $this->bindpw
)) {
183 if(function_exists('ldap_error')) {
184 return $this->set_error(ldap_error($this->linkid
));
186 return $this->set_error('authenticated ldap_bind failed');
190 if(!@ldap_bind
($this->linkid
)) {
191 if(function_exists('ldap_error')) {
192 return $this->set_error(ldap_error($this->linkid
));
194 return $this->set_error('anonymous ldap_bind failed');
205 * Encode string to the charset used by this LDAP server
206 * @param string string that has to be encoded
207 * @return string encoded string
209 function charset_encode($str) {
210 global $default_charset;
211 if($this->charset
!= $default_charset) {
212 return charset_convert($default_charset,$str,$this->charset
,false);
219 * Decode from charset used by this LDAP server to charset used by translation
221 * Uses SquirrelMail charset_decode functions
222 * @param string string that has to be decoded
223 * @return string decoded string
225 function charset_decode($str) {
226 global $default_charset;
227 if ($this->charset
!= $default_charset) {
228 return charset_convert($this->charset
,$str,$default_charset,false);
235 * Sanitizes ldap search strings.
237 * @link http://www.faqs.org/rfcs/rfc2254.html
239 * @param string $string
240 * @return string sanitized string
242 function ldapspecialchars($string) {
243 $sanitized=array('\\' => '\5c',
249 return str_replace(array_keys($sanitized),array_values($sanitized),$string);
252 /* ========================== Public ======================== */
255 * Search the LDAP server
256 * @param string $expr search expression
257 * @return array search results
259 function search($expr) {
260 /* To be replaced by advanded search expression parsing */
261 if(is_array($expr)) return false;
263 /* Encode the expression */
264 $expr = $this->charset_encode($expr);
267 * allow use of one asterisk in search.
268 * Don't allow any ldap special chars if search is different
271 $expr = '*' . $this->ldapspecialchars($expr) . '*';
273 $expression = "cn=$expr";
275 /* Make sure connection is there */
280 $sret = @ldap_search
($this->linkid
, $this->basedn
, $expression,
281 array('dn', 'o', 'ou', 'sn', 'givenname', 'cn', 'mail'),
282 0, $this->maxrows
, $this->timeout
);
284 /* Should get error from server using the ldap_error() function,
285 * but it only exist in the PHP LDAP documentation. */
287 if(function_exists('ldap_error')) {
288 return $this->set_error(ldap_error($this->linkid
));
290 return $this->set_error('ldap_search failed');
294 if(@ldap_count_entries
($this->linkid
, $sret) <= 0) {
301 $res = @ldap_get_entries
($this->linkid
, $sret);
302 for($i = 0 ; $i < $res['count'] ; $i++
) {
305 /* Extract data common for all e-mail addresses
306 * of an object. Use only the first name */
307 $nickname = $this->charset_decode($row['dn']);
308 $fullname = $this->charset_decode($row['cn'][0]);
310 if(!empty($row['ou'][0])) {
311 $label = $this->charset_decode($row['ou'][0]);
313 else if(!empty($row['o'][0])) {
314 $label = $this->charset_decode($row['o'][0]);
319 if(empty($row['givenname'][0])) {
322 $firstname = $this->charset_decode($row['givenname'][0]);
325 if(empty($row['sn'][0])) {
328 $surname = $this->charset_decode($row['sn'][0]);
331 /* Add one row to result for each e-mail address */
332 if(isset($row['mail']['count'])) {
333 for($j = 0 ; $j < $row['mail']['count'] ; $j++
) {
334 array_push($ret, array('nickname' => $nickname,
336 'firstname' => $firstname,
337 'lastname' => $surname,
338 'email' => $row['mail'][$j],
340 'backend' => $this->bnum
,
341 'source' => &$this->sname
));
343 // Limit number of hits
345 if(($returned_rows >= $this->maxrows
) &&
346 ($this->maxrows
> 0) ) {
347 ldap_free_result($sret);
353 } // isset($row['mail']['count'])
357 ldap_free_result($sret);
363 * List all entries present in LDAP server
365 * If you run a tiny LDAP server and you want the "List All" button
366 * to show EVERYONE, disable first return call and enable the second one.
367 * Remember that maxrows setting might limit list of returned entries.
369 * Careful with this -- it could get quite large for big sites.
370 * @return array all entries in ldap server
372 function list_addr() {
374 // return $this->search('*');