From 93c01888547210f54bd593d0774f9f63ec38f7a7 Mon Sep 17 00:00:00 2001
From: alecpl <alec@alec.pl>
Date: Wed, 21 Apr 2010 09:44:14 -0400
Subject: [PATCH] - Add sizelimit and timelimit variables in LDAP config (#1486544)
---
program/include/rcube_ldap.php | 138 +++++++++++++++++++++++++++++++++++++--------
1 files changed, 113 insertions(+), 25 deletions(-)
diff --git a/program/include/rcube_ldap.php b/program/include/rcube_ldap.php
index 016509c..04ccd6c 100644
--- a/program/include/rcube_ldap.php
+++ b/program/include/rcube_ldap.php
@@ -34,6 +34,8 @@
var $result = null;
var $ldap_result = null;
var $sort_col = '';
+ var $mail_domain = '';
+ var $debug = false;
/** public properties */
var $primary_key = 'ID';
@@ -46,10 +48,12 @@
/**
* Object constructor
*
- * @param array LDAP connection properties
+ * @param array LDAP connection properties
+ * @param boolean Enables debug mode
+ * @param string Current user mail domain name
* @param integer User-ID
*/
- function __construct($p)
+ function __construct($p, $debug=false, $mail_domain=NULL)
{
$this->prop = $p;
@@ -57,10 +61,16 @@
if (preg_match('/^(.+)_field$/', $prop, $matches))
$this->fieldmap[$matches[1]] = $this->_attr_name(strtolower($value));
+ // make sure 'required_fields' is an array
+ if (!is_array($this->prop['required_fields']))
+ $this->prop['required_fields'] = (array) $this->prop['required_fields'];
+
foreach ($this->prop['required_fields'] as $key => $val)
$this->prop['required_fields'][$key] = $this->_attr_name(strtolower($val));
$this->sort_col = $p['sort'];
+ $this->debug = $debug;
+ $this->mail_domain = $mail_domain;
$this->connect();
}
@@ -74,7 +84,9 @@
global $RCMAIL;
if (!function_exists('ldap_connect'))
- raise_error(array('code' => 100, 'type' => 'ldap', 'message' => "No ldap support in this installation of PHP"), true);
+ raise_error(array('code' => 100, 'type' => 'ldap',
+ 'file' => __FILE__, 'line' => __LINE__,
+ 'message' => "No ldap support in this installation of PHP"), true);
if (is_resource($this->conn))
return true;
@@ -87,17 +99,22 @@
foreach ($this->prop['hosts'] as $host)
{
+ $this->_debug("C: Connect [$host".($this->prop['port'] ? ':'.$this->prop['port'] : '')."]");
+
if ($lc = @ldap_connect($host, $this->prop['port']))
{
if ($this->prop['use_tls']===true)
if (!ldap_start_tls($lc))
continue;
+ $this->_debug("S: OK");
+
ldap_set_option($lc, LDAP_OPT_PROTOCOL_VERSION, $this->prop['ldap_version']);
$this->prop['host'] = $host;
$this->conn = $lc;
break;
}
+ $this->_debug("S: NOT OK");
}
if (is_resource($this->conn))
@@ -125,7 +142,9 @@
$this->ready = $this->bind($this->prop['bind_dn'], $this->prop['bind_pass']);
}
else
- raise_error(array('code' => 100, 'type' => 'ldap', 'message' => "Could not connect to any LDAP server, tried $host:{$this->prop[port]} last"), true);
+ raise_error(array('code' => 100, 'type' => 'ldap',
+ 'file' => __FILE__, 'line' => __LINE__,
+ 'message' => "Could not connect to any LDAP server, last tried $host:{$this->prop[port]}"), true);
// See if the directory is writeable.
if ($this->prop['writable']) {
@@ -148,13 +167,18 @@
return false;
}
+ $this->_debug("C: Bind [dn: $dn] [pass: $pass]");
+
if (@ldap_bind($this->conn, $dn, $pass)) {
+ $this->_debug("S: OK");
return true;
}
+ $this->_debug("S: ".ldap_error($this->conn));
+
raise_error(array(
- 'code' => ldap_errno($this->conn),
- 'type' => 'ldap',
+ 'code' => ldap_errno($this->conn), 'type' => 'ldap',
+ 'file' => __FILE__, 'line' => __LINE__,
'message' => "Bind failed for dn=$dn: ".ldap_error($this->conn)),
true);
@@ -169,6 +193,7 @@
{
if ($this->conn)
{
+ $this->_debug("C: Close");
ldap_unbind($this->conn);
$this->conn = null;
}
@@ -279,6 +304,7 @@
*
* @param array List of fields to search in
* @param string Search value
+ * @param boolean True for strict, False for partial (fuzzy) matching
* @param boolean True if results are requested, False if count only
* @return array Indexed list of contact records and 'count' value
*/
@@ -384,15 +410,23 @@
$res = null;
if ($this->conn && $dn)
{
- $this->ldap_result = ldap_read($this->conn, base64_decode($dn), '(objectclass=*)', array_values($this->fieldmap));
- $entry = @ldap_first_entry($this->conn, $this->ldap_result);
+ $dn = base64_decode($dn);
+
+ $this->_debug("C: Read [dn: $dn] [(objectclass=*)]");
+
+ if ($this->ldap_result = @ldap_read($this->conn, $dn, '(objectclass=*)', array_values($this->fieldmap)))
+ $entry = ldap_first_entry($this->conn, $this->ldap_result);
+ else
+ $this->_debug("S: ".ldap_error($this->conn));
if ($entry && ($rec = ldap_get_attributes($this->conn, $entry)))
{
+ $this->_debug("S: OK");
+
$rec = array_change_key_case($rec, CASE_LOWER);
// Add in the dn for the entry.
- $rec['dn'] = base64_decode($dn);
+ $rec['dn'] = $dn;
$res = $this->_ldap2result($rec);
$this->result = new rcube_result_set(1);
$this->result->add($res);
@@ -432,11 +466,18 @@
} // end foreach
// Build the new entries DN.
- $dn = $this->prop['LDAP_rdn'].'='.$newentry[$this->prop['LDAP_rdn']].','.$this->prop['base_dn'];
+ $dn = $this->prop['LDAP_rdn'].'='.rcube_ldap::quote_string($newentry[$this->prop['LDAP_rdn']], true)
+ .','.$this->prop['base_dn'];
+
+ $this->_debug("C: Add [dn: $dn]: ".print_r($newentry, true));
+
$res = ldap_add($this->conn, $dn, $newentry);
if ($res === FALSE) {
+ $this->_debug("S: ".ldap_error($this->conn));
return false;
} // end if
+
+ $this->_debug("S: OK");
return base64_encode($dn);
}
@@ -488,36 +529,55 @@
// Update the entry as required.
if (!empty($deletedata)) {
// Delete the fields.
- if (!ldap_mod_del($this->conn, $dn, $deletedata))
+ $this->_debug("C: Delete [dn: $dn]: ".print_r($deletedata, true));
+ if (!ldap_mod_del($this->conn, $dn, $deletedata)) {
+ $this->_debug("S: ".ldap_error($this->conn));
return false;
+ }
+ $this->_debug("S: OK");
} // end if
if (!empty($replacedata)) {
// Handle RDN change
if ($replacedata[$this->prop['LDAP_rdn']]) {
- $newdn = $this->prop['LDAP_rdn'].'='.$replacedata[$this->prop['LDAP_rdn']].','.$this->prop['base_dn'];
+ $newdn = $this->prop['LDAP_rdn'].'='
+ .rcube_ldap::quote_string($replacedata[$this->prop['LDAP_rdn']], true)
+ .','.$this->prop['base_dn'];
if ($dn != $newdn) {
- $newrdn = $this->prop['LDAP_rdn'].'='.$replacedata[$this->prop['LDAP_rdn']];
+ $newrdn = $this->prop['LDAP_rdn'].'='
+ .rcube_ldap::quote_string($replacedata[$this->prop['LDAP_rdn']], true);
unset($replacedata[$this->prop['LDAP_rdn']]);
}
}
// Replace the fields.
if (!empty($replacedata)) {
- if (!ldap_mod_replace($this->conn, $dn, $replacedata))
+ $this->_debug("C: Replace [dn: $dn]: ".print_r($replacedata, true));
+ if (!ldap_mod_replace($this->conn, $dn, $replacedata)) {
+ $this->_debug("S: ".ldap_error($this->conn));
return false;
+ }
+ $this->_debug("S: OK");
} // end if
} // end if
if (!empty($newdata)) {
// Add the fields.
- if (!ldap_mod_add($this->conn, $dn, $newdata))
+ $this->_debug("C: Add [dn: $dn]: ".print_r($newdata, true));
+ if (!ldap_mod_add($this->conn, $dn, $newdata)) {
+ $this->_debug("S: ".ldap_error($this->conn));
return false;
+ }
+ $this->_debug("S: OK");
} // end if
// Handle RDN change
if (!empty($newrdn)) {
- if (@ldap_rename($this->conn, $dn, $newrdn, NULL, TRUE))
+ $this->_debug("C: Rename [dn: $dn] [dn: $newrdn]");
+ if (@ldap_rename($this->conn, $dn, $newrdn, NULL, TRUE)) {
+ $this->_debug("S: ".ldap_error($this->conn));
return base64_encode($newdn);
+ }
+ $this->_debug("S: OK");
}
return true;
@@ -539,11 +599,14 @@
foreach ($dns as $id) {
$dn = base64_decode($id);
+ $this->_debug("C: Delete [dn: $dn]");
// Delete the record.
$res = ldap_delete($this->conn, $dn);
if ($res === FALSE) {
+ $this->_debug("S: ".ldap_error($this->conn));
return false;
} // end if
+ $this->_debug("S: OK");
} // end foreach
return count($dns);
@@ -561,11 +624,19 @@
{
$filter = $this->filter ? $this->filter : '(objectclass=*)';
$function = $this->prop['scope'] == 'sub' ? 'ldap_search' : ($this->prop['scope'] == 'base' ? 'ldap_read' : 'ldap_list');
- $this->ldap_result = $function($this->conn, $this->prop['base_dn'], $filter, array_values($this->fieldmap), 0, 0);
- return true;
+
+ $this->_debug("C: Search [".$filter."]");
+
+ if ($this->ldap_result = @$function($this->conn, $this->prop['base_dn'], $filter,
+ array_values($this->fieldmap), 0, (int) $this->prop['sizelimit'], (int) $this->prop['timelimit'])
+ ) {
+ $this->_debug("S: ".ldap_count_entries($this->conn, $this->ldap_result)." record(s)");
+ return true;
+ } else
+ $this->_debug("S: ".ldap_error($this->conn));
}
- else
- return false;
+
+ return false;
}
@@ -584,8 +655,8 @@
foreach ($this->fieldmap as $rf => $lf)
{
if ($rec[$lf]['count']) {
- if ($rf == 'email' && !strpos($rec[$lf][0], '@'))
- $out[$rf] = sprintf('%s@%s', $rec[$lf][0] , $RCMAIL->config->mail_domain($_SESSION['imap_host']));
+ if ($rf == 'email' && $this->mail_domain && !strpos($rec[$lf][0], '@'))
+ $out[$rf] = sprintf('%s@%s', $rec[$lf][0], $this->mail_domain);
else
$out[$rf] = $rec[$lf][0];
}
@@ -612,7 +683,7 @@
// list of known attribute aliases
$aliases = array(
'gn' => 'givenname',
- 'rfc822mailbox' => 'mail',
+ 'rfc822mailbox' => 'email',
'userid' => 'uid',
'emailaddress' => 'email',
'pkcs9email' => 'email',
@@ -622,11 +693,28 @@
/**
+ * @access private
+ */
+ private function _debug($str)
+ {
+ if ($this->debug)
+ write_log('ldap', $str);
+ }
+
+
+ /**
* @static
*/
- function quote_string($str)
+ function quote_string($str, $dn=false)
{
- return strtr($str, array('*'=>'\2a', '('=>'\28', ')'=>'\29', '\\'=>'\5c'));
+ if ($dn)
+ $replace = array(','=>'\2c', '='=>'\3d', '+'=>'\2b', '<'=>'\3c',
+ '>'=>'\3e', ';'=>'\3b', '\\'=>'\5c', '"'=>'\22', '#'=>'\23');
+ else
+ $replace = array('*'=>'\2a', '('=>'\28', ')'=>'\29', '\\'=>'\5c',
+ '/'=>'\2f');
+
+ return strtr($str, $replace);
}
}
--
Gitblit v1.9.1