From 0fe3b9a7d7c06e8c5ef0488419dd94c9ebce6b46 Mon Sep 17 00:00:00 2001
From: alecpl <alec@alec.pl>
Date: Mon, 19 Sep 2011 09:25:22 -0400
Subject: [PATCH] - Hide PHP warning on ldap_search()
---
program/include/rcube_ldap.php | 708 ++++++++++++++++++++++++++++++++++++++++++----------------
1 files changed, 510 insertions(+), 198 deletions(-)
diff --git a/program/include/rcube_ldap.php b/program/include/rcube_ldap.php
index c825371..b5f9f46 100644
--- a/program/include/rcube_ldap.php
+++ b/program/include/rcube_ldap.php
@@ -5,6 +5,7 @@
| |
| This file is part of the Roundcube Webmail client |
| Copyright (C) 2006-2011, The Roundcube Dev Team |
+ | Copyright (C) 2011, Kolab Systems AG |
| Licensed under the GNU GPL |
| |
| PURPOSE: |
@@ -13,6 +14,7 @@
+-----------------------------------------------------------------------+
| Author: Thomas Bruederli <roundcube@gmail.com> |
| Andreas Dick <andudi (at) gmx (dot) ch> |
+ | Aleksander Machniak <machniak@kolabsys.com> |
+-----------------------------------------------------------------------+
$Id$
@@ -49,8 +51,13 @@
protected $mail_domain = '';
protected $debug = false;
+ private $base_dn = '';
+ private $groups_base_dn = '';
private $group_cache = array();
private $group_members = array();
+
+ private $vlv_active = false;
+ private $vlv_count = 0;
/**
@@ -66,7 +73,7 @@
$this->prop = $p;
// check if groups are configured
- if (is_array($p['groups']))
+ if (is_array($p['groups']) and count($p['groups']))
$this->groups = true;
// fieldmap property is given
@@ -108,7 +115,7 @@
foreach ($this->prop['required_fields'] as $key => $val)
$this->prop['required_fields'][$key] = $this->_attr_name(strtolower($val));
- $this->sort_col = $p['sort'];
+ $this->sort_col = is_array($p['sort']) ? $p['sort'][0] : $p['sort'];
$this->debug = $debug;
$this->mail_domain = $mail_domain;
@@ -125,8 +132,9 @@
if (!function_exists('ldap_connect'))
raise_error(array('code' => 100, 'type' => 'ldap',
- 'file' => __FILE__, 'line' => __LINE__,
- 'message' => "No ldap support in this installation of PHP"), true);
+ 'file' => __FILE__, 'line' => __LINE__,
+ 'message' => "No ldap support in this installation of PHP"),
+ true, true);
if (is_resource($this->conn))
return true;
@@ -165,7 +173,7 @@
$bind_pass = $this->prop['bind_pass'];
$bind_user = $this->prop['bind_user'];
$bind_dn = $this->prop['bind_dn'];
- $base_dn = $this->prop['base_dn'];
+ $this->base_dn = $this->prop['base_dn'];
// User specific access, generate the proper values to use.
if ($this->prop['user_specific']) {
@@ -175,8 +183,11 @@
}
// Get the pieces needed for variable replacement.
- $fu = $RCMAIL->user->get_username();
- list($u, $d) = explode('@', $fu);
+ if ($fu = $RCMAIL->user->get_username())
+ list($u, $d) = explode('@', $fu);
+ else
+ $d = $this->mail_domain;
+
$dc = 'dc='.strtr($d, array('.' => ',dc=')); // hierarchal domain string
$replaces = array('%dc' => $dc, '%d' => $d, '%fu' => $fu, '%u' => $u);
@@ -202,7 +213,7 @@
}
// Replace the bind_dn and base_dn variables.
$bind_dn = strtr($bind_dn, $replaces);
- $base_dn = strtr($base_dn, $replaces);
+ $this->base_dn = strtr($this->base_dn, $replaces);
if (empty($bind_user)) {
$bind_user = $u;
@@ -211,13 +222,13 @@
if (!empty($bind_pass)) {
if (!empty($bind_dn)) {
- $this->ready = $this->_bind($bind_dn, $bind_pass);
+ $this->ready = $this->bind($bind_dn, $bind_pass);
}
else if (!empty($this->prop['auth_cid'])) {
- $this->ready = $this->_sasl_bind($this->prop['auth_cid'], $bind_pass, $bind_user);
+ $this->ready = $this->sasl_bind($this->prop['auth_cid'], $bind_pass, $bind_user);
}
else {
- $this->ready = $this->_sasl_bind($bind_user, $bind_pass);
+ $this->ready = $this->sasl_bind($bind_user, $bind_pass);
}
}
}
@@ -242,18 +253,17 @@
*
* @return boolean True on success, False on error
*/
- private function _sasl_bind($authc, $pass, $authz=null)
+ public function sasl_bind($authc, $pass, $authz=null)
{
if (!$this->conn) {
return false;
}
if (!function_exists('ldap_sasl_bind')) {
- raise_error(array(
- 'code' => 100, 'type' => 'ldap',
+ raise_error(array('code' => 100, 'type' => 'ldap',
'file' => __FILE__, 'line' => __LINE__,
'message' => "Unable to bind: ldap_sasl_bind() not exists"),
- true, true);
+ true, true);
}
if (!empty($authz)) {
@@ -287,13 +297,14 @@
/**
- * Bind connection with DN and password
- *
- * @param string Bind DN
- * @param string Bind password
- * @return boolean True on success, False on error
- */
- private function _bind($dn, $pass)
+ * Bind connection with DN and password
+ *
+ * @param string Bind DN
+ * @param string Bind password
+ *
+ * @return boolean True on success, False on error
+ */
+ public function bind($dn, $pass)
{
if (!$this->conn) {
return false;
@@ -308,19 +319,19 @@
$this->_debug("S: ".ldap_error($this->conn));
- $error = array(
- 'code' => ldap_errno($this->conn), 'type' => 'ldap',
- 'file' => __FILE__, 'line' => __LINE__,
- 'message' => "Bind failed for dn=$dn: ".ldap_error($this->conn));
- raise_error($error,true);
+ raise_error(array(
+ 'code' => ldap_errno($this->conn), 'type' => 'ldap',
+ 'file' => __FILE__, 'line' => __LINE__,
+ 'message' => "Bind failed for dn=$dn: ".ldap_error($this->conn)),
+ true);
return false;
}
/**
- * Close connection to LDAP server
- */
+ * Close connection to LDAP server
+ */
function close()
{
if ($this->conn)
@@ -333,11 +344,21 @@
/**
- * Set internal list page
- *
- * @param number Page number to list
- * @access public
- */
+ * Returns address book name
+ *
+ * @return string Address book name
+ */
+ function get_name()
+ {
+ return $this->prop['name'];
+ }
+
+
+ /**
+ * Set internal list page
+ *
+ * @param number $page Page number to list
+ */
function set_page($page)
{
$this->list_page = (int)$page;
@@ -345,11 +366,10 @@
/**
- * Set internal page size
- *
- * @param number Number of messages to display on one page
- * @access public
- */
+ * Set internal page size
+ *
+ * @param number $size Number of messages to display on one page
+ */
function set_pagesize($size)
{
$this->page_size = (int)$size;
@@ -357,10 +377,10 @@
/**
- * Save a search string for future listings
- *
- * @param string Filter string
- */
+ * Save a search string for future listings
+ *
+ * @param string $filter Filter string
+ */
function set_search_set($filter)
{
$this->filter = $filter;
@@ -368,10 +388,10 @@
/**
- * Getter for saved search properties
- *
- * @return mixed Search properties used by this class
- */
+ * Getter for saved search properties
+ *
+ * @return mixed Search properties used by this class
+ */
function get_search_set()
{
return $this->filter;
@@ -379,8 +399,8 @@
/**
- * Reset all saved results and search parameters
- */
+ * Reset all saved results and search parameters
+ */
function reset()
{
$this->result = null;
@@ -390,12 +410,13 @@
/**
- * List the current set of contact records
- *
- * @param array List of cols to show
- * @param int Only return this number of records
- * @return array Indexed list of contact records, each a hash array
- */
+ * List the current set of contact records
+ *
+ * @param array List of cols to show
+ * @param int Only return this number of records
+ *
+ * @return array Indexed list of contact records, each a hash array
+ */
function list_records($cols=null, $subset=0)
{
// add general filter to query
@@ -415,54 +436,63 @@
// we have a search result resource
if ($this->ldap_result && $this->result->count > 0)
{
- if ($this->sort_col && $this->prop['scope'] !== 'base')
+ // sorting still on the ldap server
+ if ($this->sort_col && $this->prop['scope'] !== 'base' && !$this->vlv_active)
ldap_sort($this->conn, $this->ldap_result, $this->sort_col);
- $start_row = $subset < 0 ? $this->result->first + $this->page_size + $subset : $this->result->first;
+ // start and end of the page
+ $start_row = $this->vlv_active ? 0 : $this->result->first;
+ $start_row = $subset < 0 ? $start_row + $this->page_size + $subset : $start_row;
$last_row = $this->result->first + $this->page_size;
$last_row = $subset != 0 ? $start_row + abs($subset) : $last_row;
+ // get all entries from the ldap server
$entries = ldap_get_entries($this->conn, $this->ldap_result);
+
+ // filtering for group members
+ if ($this->groups and $this->group_id)
+ {
+ $count = 0;
+ $members = array();
+ foreach ($entries as $entry)
+ {
+ if ($this->group_members[self::dn_encode($entry['dn'])])
+ {
+ $members[] = $entry;
+ $count++;
+ }
+ }
+ $entries = $members;
+ $entries['count'] = $count;
+ $this->result->count = $count;
+ }
+
+ // filter entries for this page
for ($i = $start_row; $i < min($entries['count'], $last_row); $i++)
$this->result->add($this->_ldap2result($entries[$i]));
}
-
- // temp hack for filtering group members
- if ($this->groups and $this->group_id)
- {
- $result = new rcube_result_set();
- while ($record = $this->result->iterate())
- {
- if ($this->group_members[$record['ID']])
- {
- $result->add($record);
- $result->count++;
- }
- }
- $this->result = $result;
- }
-
return $this->result;
}
/**
- * Search contacts
- *
- * @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
- * @param boolean (Not used)
- * @param array List of fields that cannot be empty
- * @return array Indexed list of contact records and 'count' value
- */
+ * Search contacts
+ *
+ * @param mixed $fields The field name of array of field names to search in
+ * @param mixed $value Search value (or array of values when $fields is array)
+ * @param boolean $strict True for strict, False for partial (fuzzy) matching
+ * @param boolean $select True if results are requested, False if count only
+ * @param boolean $nocount (Not used)
+ * @param array $required List of fields that cannot be empty
+ *
+ * @return array Indexed list of contact records and 'count' value
+ */
function search($fields, $value, $strict=false, $select=true, $nocount=false, $required=array())
{
// special treatment for ID-based search
if ($fields == 'ID' || $fields == $this->primary_key)
{
- $ids = explode(',', $value);
+ $ids = !is_array($value) ? explode(',', $value) : $value;
$result = new rcube_result_set();
foreach ($ids as $id)
{
@@ -475,29 +505,34 @@
return $result;
}
- $filter = '(|';
- $wc = !$strict && $this->prop['fuzzy_search'] ? '*' : '';
- if ($fields != '*')
+ // use AND operator for advanced searches
+ $filter = is_array($value) ? '(&' : '(|';
+ $wc = !$strict && $this->prop['fuzzy_search'] ? '*' : '';
+
+ if ($fields == '*')
{
// search_fields are required for fulltext search
- if (!$this->prop['search_fields'])
+ if (empty($this->prop['search_fields']))
{
$this->set_error(self::ERROR_SEARCH, 'nofulltextsearch');
$this->result = new rcube_result_set();
return $this->result;
}
- }
-
- if (is_array($this->prop['search_fields']))
- {
- foreach ($this->prop['search_fields'] as $k => $field)
- $filter .= "($field=$wc" . $this->_quote_string($value) . "$wc)";
+ if (is_array($this->prop['search_fields']))
+ {
+ foreach ($this->prop['search_fields'] as $field) {
+ $filter .= "($field=$wc" . $this->_quote_string($value) . "$wc)";
+ }
+ }
}
else
{
- foreach ((array)$fields as $field)
- if ($f = $this->_map_field($field))
- $filter .= "($f=$wc" . $this->_quote_string($value) . "$wc)";
+ foreach ((array)$fields as $idx => $field) {
+ $val = is_array($value) ? $value[$idx] : $value;
+ if ($f = $this->_map_field($field)) {
+ $filter .= "($f=$wc" . $this->_quote_string($val) . "$wc)";
+ }
+ }
}
$filter .= ')';
@@ -531,15 +566,15 @@
/**
- * Count number of available contacts in database
- *
- * @return object rcube_result_set Resultset with values for 'count' and 'first'
- */
+ * Count number of available contacts in database
+ *
+ * @return object rcube_result_set Resultset with values for 'count' and 'first'
+ */
function count()
{
$count = 0;
if ($this->conn && $this->ldap_result) {
- $count = ldap_count_entries($this->conn, $this->ldap_result);
+ $count = $this->vlv_active ? $this->vlv_count : ldap_count_entries($this->conn, $this->ldap_result);
} // end if
elseif ($this->conn) {
// We have a connection but no result set, attempt to get one.
@@ -547,7 +582,7 @@
// The filter is not set, set it.
$this->filter = $this->prop['filter'];
} // end if
- $this->_exec_search();
+ $this->_exec_search(true);
if ($this->ldap_result) {
$count = ldap_count_entries($this->conn, $this->ldap_result);
} // end if
@@ -558,10 +593,10 @@
/**
- * Return the last result set
- *
- * @return object rcube_result_set Current resultset or NULL if nothing selected yet
- */
+ * Return the last result set
+ *
+ * @return object rcube_result_set Current resultset or NULL if nothing selected yet
+ */
function get_result()
{
return $this->result;
@@ -569,18 +604,19 @@
/**
- * Get a specific contact record
- *
- * @param mixed Record identifier
- * @param boolean Return as associative array
- * @return mixed Hash array or rcube_result_set with all record fields
- */
+ * Get a specific contact record
+ *
+ * @param mixed Record identifier
+ * @param boolean Return as associative array
+ *
+ * @return mixed Hash array or rcube_result_set with all record fields
+ */
function get_record($dn, $assoc=false)
{
$res = null;
if ($this->conn && $dn)
{
- $dn = base64_decode($dn);
+ $dn = self::dn_decode($dn);
$this->_debug("C: Read [dn: $dn] [(objectclass=*)]");
@@ -608,11 +644,33 @@
/**
- * Create a new contact record
- *
- * @param array Hash array with save data
- * @return encoded record ID on success, False on error
- */
+ * Check the given data before saving.
+ * If input not valid, the message to display can be fetched using get_error()
+ *
+ * @param array Assoziative array with data to save
+ *
+ * @return boolean True if input is valid, False if not.
+ */
+ public function validate($save_data)
+ {
+ // check for name input
+ if (empty($save_data['name'])) {
+ $this->set_error('warning', 'nonamewarning');
+ return false;
+ }
+
+ // validate e-mail addresses
+ return parent::validate($save_data);
+ }
+
+
+ /**
+ * Create a new contact record
+ *
+ * @param array Hash array with save data
+ *
+ * @return encoded record ID on success, False on error
+ */
function insert($save_cols)
{
// Map out the column names to their LDAP ones to build the new entry.
@@ -629,8 +687,8 @@
} // end foreach
// Verify that the required fields are set.
+ $missing = null;
foreach ($this->prop['required_fields'] as $fld) {
- $missing = null;
if (!isset($newentry[$fld])) {
$missing[] = $fld;
}
@@ -644,7 +702,7 @@
}
// Build the new entries DN.
- $dn = $this->prop['LDAP_rdn'].'='.$this->_quote_string($newentry[$this->prop['LDAP_rdn']], true).','.$this->prop['base_dn'];
+ $dn = $this->prop['LDAP_rdn'].'='.$this->_quote_string($newentry[$this->prop['LDAP_rdn']], true).','.$this->base_dn;
$this->_debug("C: Add [dn: $dn]: ".print_r($newentry, true));
@@ -657,21 +715,24 @@
$this->_debug("S: OK");
+ $dn = self::dn_encode($dn);
+
// add new contact to the selected group
if ($this->groups)
- $this->add_to_group($this->group_id, base64_encode($dn));
+ $this->add_to_group($this->group_id, $dn);
- return base64_encode($dn);
+ return $dn;
}
/**
- * Update a specific contact record
- *
- * @param mixed Record identifier
- * @param array Hash array with save data
- * @return boolean True on success, False on error
- */
+ * Update a specific contact record
+ *
+ * @param mixed Record identifier
+ * @param array Hash array with save data
+ *
+ * @return boolean True on success, False on error
+ */
function update($id, $save_cols)
{
$record = $this->get_record($id, true);
@@ -681,6 +742,16 @@
$newdata = array();
$replacedata = array();
$deletedata = array();
+
+ // flatten composite fields in $record
+ if (is_array($record['address'])) {
+ foreach ($record['address'] as $i => $struct) {
+ foreach ($struct as $col => $val) {
+ $record[$col][$i] = $val;
+ }
+ }
+ }
+
foreach ($this->fieldmap as $col => $fld) {
$val = $save_cols[$col];
if ($fld) {
@@ -709,7 +780,7 @@
} // end if
} // end foreach
- $dn = base64_decode($id);
+ $dn = self::dn_decode($id);
// Update the entry as required.
if (!empty($deletedata)) {
@@ -728,7 +799,7 @@
if ($replacedata[$this->prop['LDAP_rdn']]) {
$newdn = $this->prop['LDAP_rdn'].'='
.$this->_quote_string($replacedata[$this->prop['LDAP_rdn']], true)
- .','.$this->prop['base_dn'];
+ .','.$this->base_dn;
if ($dn != $newdn) {
$newrdn = $this->prop['LDAP_rdn'].'='
.$this->_quote_string($replacedata[$this->prop['LDAP_rdn']], true);
@@ -766,17 +837,21 @@
}
$this->_debug("S: OK");
+ $dn = self::dn_encode($dn);
+ $newdn = self::dn_encode($newdn);
+
// change the group membership of the contact
if ($this->groups)
{
- $group_ids = $this->get_record_groups(base64_encode($dn));
+ $group_ids = $this->get_record_groups($dn);
foreach ($group_ids as $group_id)
{
- $this->remove_from_group($group_id, base64_encode($dn));
- $this->add_to_group($group_id, base64_encode($newdn));
+ $this->remove_from_group($group_id, $dn);
+ $this->add_to_group($group_id, $newdn);
}
}
- return base64_encode($newdn);
+
+ return $newdn;
}
return true;
@@ -784,20 +859,22 @@
/**
- * Mark one or more contact records as deleted
- *
- * @param array Record identifiers
- * @return boolean True on success, False on error
- */
- function delete($ids)
+ * Mark one or more contact records as deleted
+ *
+ * @param array Record identifiers
+ * @param boolean Remove record(s) irreversible (unsupported)
+ *
+ * @return boolean True on success, False on error
+ */
+ function delete($ids, $force=true)
{
if (!is_array($ids)) {
// Not an array, break apart the encoded DNs.
- $dns = explode(',', $ids);
+ $ids = explode(',', $ids);
} // end if
- foreach ($dns as $id) {
- $dn = base64_decode($id);
+ foreach ($ids as $id) {
+ $dn = self::dn_decode($id);
$this->_debug("C: Delete [dn: $dn]");
// Delete the record.
$res = ldap_delete($this->conn, $dn);
@@ -809,38 +886,54 @@
$this->_debug("S: OK");
// remove contact from all groups where he was member
- if ($this->groups)
- {
- $group_ids = $this->get_record_groups(base64_encode($dn));
- foreach ($group_ids as $group_id)
- {
- $this->remove_from_group($group_id, base64_encode($dn));
+ if ($this->groups) {
+ $dn = self::dn_encode($dn);
+ $group_ids = $this->get_record_groups($dn);
+ foreach ($group_ids as $group_id) {
+ $this->remove_from_group($group_id, $dn);
}
}
} // end foreach
- return count($dns);
+ return count($ids);
}
/**
- * Execute the LDAP search based on the stored credentials
- *
- * @access private
- */
- private function _exec_search()
+ * Execute the LDAP search based on the stored credentials
+ */
+ private function _exec_search($count = false)
{
if ($this->ready)
{
$filter = $this->filter ? $this->filter : '(objectclass=*)';
$function = $this->prop['scope'] == 'sub' ? 'ldap_search' : ($this->prop['scope'] == 'base' ? 'ldap_read' : 'ldap_list');
- $this->_debug("C: Search [".$filter."]");
+ $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']))
+ // when using VLV, we get the total count by...
+ if (!$count && $function != 'ldap_read' && $this->prop['vlv']) {
+ // ...either reading numSubOrdinates attribute
+ if ($this->prop['numsub_filter'] && ($result_count = @$function($this->conn, $this->base_dn, $this->prop['numsub_filter'], array('numSubOrdinates'), 0, 0, 0))) {
+ $counts = ldap_get_entries($this->conn, $result_count);
+ for ($this->vlv_count = $j = 0; $j < $counts['count']; $j++)
+ $this->vlv_count += $counts[$j]['numsubordinates'][0];
+ $this->_debug("D: total numsubordinates = " . $this->vlv_count);
+ }
+ else // ...or by fetching all records dn and count them
+ $this->vlv_count = $this->_exec_search(true);
+
+ $this->vlv_active = $this->_vlv_set_controls();
+ }
+
+ // only fetch dn for count (should keep the payload low)
+ $attrs = $count ? array('dn') : array_values($this->fieldmap);
+ if ($this->ldap_result = @$function($this->conn, $this->base_dn, $filter,
+ $attrs, 0, (int)$this->prop['sizelimit'], (int)$this->prop['timelimit']))
{
$this->_debug("S: ".ldap_count_entries($this->conn, $this->ldap_result)." record(s)");
+ if ($err = ldap_errno($this->conn))
+ $this->_debug("S: Error: " .ldap_err2str($err));
return true;
}
else
@@ -852,16 +945,36 @@
return false;
}
+ /**
+ * Set server controls for Virtual List View (paginated listing)
+ */
+ private function _vlv_set_controls()
+ {
+ $sort_ctrl = array('oid' => "1.2.840.113556.1.4.473", 'value' => $this->_sort_ber_encode((array)$this->prop['sort']));
+ $vlv_ctrl = array('oid' => "2.16.840.1.113730.3.4.9", 'value' => $this->_vlv_ber_encode(($offset = ($this->list_page-1) * $this->page_size + 1), $this->page_size), 'iscritical' => true);
+
+ $this->_debug("C: set controls sort=" . join(' ', unpack('H'.(strlen($sort_ctrl['value'])*2), $sort_ctrl['value'])) . " ({$this->sort_col});"
+ . " vlv=" . join(' ', (unpack('H'.(strlen($vlv_ctrl['value'])*2), $vlv_ctrl['value']))) . " ($offset)");
+
+ if (!ldap_set_option($this->conn, LDAP_OPT_SERVER_CONTROLS, array($sort_ctrl, $vlv_ctrl))) {
+ $this->_debug("S: ".ldap_error($this->conn));
+ $this->set_error(self::ERROR_SEARCH, 'vlvnotsupported');
+ return false;
+ }
+
+ return true;
+ }
+
/**
- * @access private
- */
+ * Converts LDAP entry into an array
+ */
private function _ldap2result($rec)
{
$out = array();
if ($rec['dn'])
- $out[$this->primary_key] = base64_encode($rec['dn']);
+ $out[$this->primary_key] = self::dn_encode($rec['dn']);
foreach ($this->fieldmap as $rf => $lf)
{
@@ -884,8 +997,8 @@
/**
- * @access private
- */
+ * Return real field name (from fields map)
+ */
private function _map_field($field)
{
return $this->fieldmap[$field];
@@ -893,9 +1006,9 @@
/**
- * @access private
- */
- private function _attr_name($name)
+ * Returns unified attribute name (resolving aliases)
+ */
+ private static function _attr_name($name)
{
// list of known attribute aliases
$aliases = array(
@@ -910,8 +1023,8 @@
/**
- * @access private
- */
+ * Prints debug info to the log
+ */
private function _debug($str)
{
if ($this->debug)
@@ -920,9 +1033,14 @@
/**
- * @static
- */
- private function _quote_string($str, $dn=false)
+ * Quotes attribute value string
+ *
+ * @param string $str Attribute value
+ * @param bool $dn True if the attribute is a DN
+ *
+ * @return string Quoted string
+ */
+ private static function _quote_string($str, $dn=false)
{
// take firt entry if array given
if (is_array($str))
@@ -953,9 +1071,10 @@
$cache_members = $this->group_cache[$group_id]['members'];
$members = array();
- for ($i=1; $i<$cache_members["count"]; $i++)
+ for ($i=0; $i<$cache_members["count"]; $i++)
{
- $members[base64_encode($cache_members[$i])] = 1;
+ if (!empty($cache_members[$i]))
+ $members[self::dn_encode($cache_members[$i])] = 1;
}
$this->group_members = $members;
$this->group_id = $group_id;
@@ -972,11 +1091,29 @@
*/
function list_groups($search = null)
{
+ global $RCMAIL;
+
if (!$this->groups)
return array();
- $base_dn = $this->prop['groups']['base_dn'];
- $filter = '(objectClass=groupOfNames)';
+ $this->groups_base_dn = ($this->prop['groups']['base_dn']) ?
+ $this->prop['groups']['base_dn'] : $this->base_dn;
+
+ // replace user specific dn
+ if ($this->prop['user_specific'])
+ {
+ $fu = $RCMAIL->user->get_username();
+ list($u, $d) = explode('@', $fu);
+ $dc = 'dc='.strtr($d, array('.' => ',dc='));
+ $replaces = array('%dc' => $dc, '%d' => $d, '%fu' => $fu, '%u' => $u);
+
+ $this->groups_base_dn = strtr($this->groups_base_dn, $replaces);
+ }
+
+ $base_dn = $this->groups_base_dn;
+ $filter = $this->prop['groups']['filter'];
+
+ $this->_debug("C: Search [$filter][dn: $base_dn]");
$res = ldap_search($this->conn, $base_dn, $filter, array('cn','member'));
if ($res === false)
@@ -985,18 +1122,23 @@
$this->set_error(self::ERROR_SAVING, 'errorsaving');
return array();
}
+
$ldap_data = ldap_get_entries($this->conn, $res);
+ $this->_debug("S: ".ldap_count_entries($this->conn, $res)." record(s)");
$groups = array();
$group_sortnames = array();
for ($i=0; $i<$ldap_data["count"]; $i++)
{
$group_name = $ldap_data[$i]['cn'][0];
- $group_id = base64_encode($group_name);
- $groups[$group_id]['ID'] = $group_id;
- $groups[$group_id]['name'] = $group_name;
- $groups[$group_id]['members'] = $ldap_data[$i]['member'];
- $group_sortnames[] = strtolower($group_name);
+ if (!$search || strstr(strtolower($group_name), strtolower($search)))
+ {
+ $group_id = self::dn_encode($group_name);
+ $groups[$group_id]['ID'] = $group_id;
+ $groups[$group_id]['name'] = $group_name;
+ $groups[$group_id]['members'] = $ldap_data[$i]['member'];
+ $group_sortnames[] = strtolower($group_name);
+ }
}
array_multisort($group_sortnames, SORT_ASC, SORT_STRING, $groups);
$this->group_cache = $groups;
@@ -1015,15 +1157,17 @@
if (!$this->group_cache)
$this->list_groups();
- $base_dn = $this->prop['groups']['base_dn'];
+ $base_dn = $this->groups_base_dn;
$new_dn = "cn=$group_name,$base_dn";
- $new_gid = base64_encode($group_name);
+ $new_gid = self::dn_encode($group_name);
$new_entry = array(
- 'objectClass' => array('top', 'groupOfNames'),
+ 'objectClass' => $this->prop['groups']['object_classes'],
'cn' => $group_name,
'member' => '',
);
+
+ $this->_debug("C: Add [dn: $new_dn]: ".print_r($new_entry, true));
$res = ldap_add($this->conn, $new_dn, $new_entry);
if ($res === false)
@@ -1032,6 +1176,9 @@
$this->set_error(self::ERROR_SAVING, 'errorsaving');
return false;
}
+
+ $this->_debug("S: OK");
+
return array('id' => $new_gid, 'name' => $group_name);
}
@@ -1046,10 +1193,12 @@
if (!$this->group_cache)
$this->list_groups();
- $base_dn = $this->prop['groups']['base_dn'];
+ $base_dn = $this->groups_base_dn;
$group_name = $this->group_cache[$group_id]['name'];
-
$del_dn = "cn=$group_name,$base_dn";
+
+ $this->_debug("C: Delete [dn: $del_dn]");
+
$res = ldap_delete($this->conn, $del_dn);
if ($res === false)
{
@@ -1057,6 +1206,9 @@
$this->set_error(self::ERROR_SAVING, 'errorsaving');
return false;
}
+
+ $this->_debug("S: OK");
+
return true;
}
@@ -1068,16 +1220,18 @@
* @param string New group identifier (if changed, otherwise don't set)
* @return boolean New name on success, false if no data was changed
*/
- function rename_group($group_id, $new_name, &$new_id)
+ function rename_group($group_id, $new_name, &$new_gid)
{
if (!$this->group_cache)
$this->list_groups();
- $base_dn = $this->prop['groups']['base_dn'];
+ $base_dn = $this->groups_base_dn;
$group_name = $this->group_cache[$group_id]['name'];
$old_dn = "cn=$group_name,$base_dn";
$new_rdn = "cn=$new_name";
- $new_id = base64_encode($new_rdn . ",$base_dn");
+ $new_gid = self::dn_encode($new_name);
+
+ $this->_debug("C: Rename [dn: $old_dn] [dn: $new_rdn]");
$res = ldap_rename($this->conn, $old_dn, $new_rdn, NULL, TRUE);
if ($res === false)
@@ -1086,6 +1240,9 @@
$this->set_error(self::ERROR_SAVING, 'errorsaving');
return false;
}
+
+ $this->_debug("S: OK");
+
return $new_name;
}
@@ -1101,13 +1258,15 @@
if (!$this->group_cache)
$this->list_groups();
- $base_dn = $this->prop['groups']['base_dn'];
+ $base_dn = $this->groups_base_dn;
$group_name = $this->group_cache[$group_id]['name'];
$group_dn = "cn=$group_name,$base_dn";
$new_attrs = array();
foreach (explode(",", $contact_ids) as $id)
- $new_attrs['member'][] = base64_decode($id);
+ $new_attrs['member'][] = self::dn_decode($id);
+
+ $this->_debug("C: Add [dn: $group_dn]: ".print_r($new_attrs, true));
$res = ldap_mod_add($this->conn, $group_dn, $new_attrs);
if ($res === false)
@@ -1116,6 +1275,9 @@
$this->set_error(self::ERROR_SAVING, 'errorsaving');
return 0;
}
+
+ $this->_debug("S: OK");
+
return count($new_attrs['member']);
}
@@ -1131,13 +1293,15 @@
if (!$this->group_cache)
$this->list_groups();
- $base_dn = $this->prop['groups']['base_dn'];
+ $base_dn = $this->groups_base_dn;
$group_name = $this->group_cache[$group_id]['name'];
$group_dn = "cn=$group_name,$base_dn";
$del_attrs = array();
foreach (explode(",", $contact_ids) as $id)
- $del_attrs['member'][] = base64_decode($id);
+ $del_attrs['member'][] = self::dn_decode($id);
+
+ $this->_debug("C: Delete [dn: $group_dn]: ".print_r($del_attrs, true));
$res = ldap_mod_del($this->conn, $group_dn, $del_attrs);
if ($res === false)
@@ -1146,6 +1310,9 @@
$this->set_error(self::ERROR_SAVING, 'errorsaving');
return 0;
}
+
+ $this->_debug("S: OK");
+
return count($del_attrs['member']);
}
@@ -1162,11 +1329,13 @@
if (!$this->groups)
return array();
- $base_dn = $this->prop['groups']['base_dn'];
- $contact_dn = base64_decode($contact_id);
- $filter = "(member=$contact_dn)";
+ $base_dn = $this->groups_base_dn;
+ $contact_dn = self::dn_decode($contact_id);
+ $filter = strtr("(member=$contact_dn)", array('\\' => '\\\\'));
- $res = ldap_search($this->conn, $base_dn, $filter, array('cn'));
+ $this->_debug("C: Search [$filter][dn: $base_dn]");
+
+ $res = @ldap_search($this->conn, $base_dn, $filter, array('cn'));
if ($res === false)
{
$this->_debug("S: ".ldap_error($this->conn));
@@ -1174,14 +1343,157 @@
return array();
}
$ldap_data = ldap_get_entries($this->conn, $res);
+ $this->_debug("S: ".ldap_count_entries($this->conn, $res)." record(s)");
$groups = array();
for ($i=0; $i<$ldap_data["count"]; $i++)
{
$group_name = $ldap_data[$i]['cn'][0];
- $group_id = base64_encode($group_name);
+ $group_id = self::dn_encode($group_name);
$groups[$group_id] = $group_id;
}
return $groups;
}
+
+
+ /**
+ * Generate BER encoded string for Virtual List View option
+ *
+ * @param integer List offset (first record)
+ * @param integer Records per page
+ * @return string BER encoded option value
+ */
+ private function _vlv_ber_encode($offset, $rpp)
+ {
+ # this string is ber-encoded, php will prefix this value with:
+ # 04 (octet string) and 10 (length of 16 bytes)
+ # the code behind this string is broken down as follows:
+ # 30 = ber sequence with a length of 0e (14) bytes following
+ # 20 = type integer (in two's complement form) with 2 bytes following (beforeCount): 01 00 (ie 0)
+ # 20 = type integer (in two's complement form) with 2 bytes following (afterCount): 01 18 (ie 25-1=24)
+ # a0 = type context-specific/constructed with a length of 06 (6) bytes following
+ # 20 = type integer with 2 bytes following (offset): 01 01 (ie 1)
+ # 20 = type integer with 2 bytes following (contentCount): 01 00
+ # the following info was taken from the ISO/IEC 8825-1:2003 x.690 standard re: the
+ # encoding of integer values (note: these values are in
+ # two-complement form so since offset will never be negative bit 8 of the
+ # leftmost octet should never by set to 1):
+ # 8.3.2: If the contents octets of an integer value encoding consist
+ # of more than one octet, then the bits of the first octet (rightmost) and bit 8
+ # of the second (to the left of first octet) octet:
+ # a) shall not all be ones; and
+ # b) shall not all be zero
+
+ # construct the string from right to left
+ $str = "020100"; # contentCount
+
+ $ber_val = self::_ber_encode_int($offset); // returns encoded integer value in hex format
+
+ // calculate octet length of $ber_val
+ $str = self::_ber_addseq($ber_val, '02') . $str;
+
+ // now compute length over $str
+ $str = self::_ber_addseq($str, 'a0');
+
+ // now tack on records per page
+ $str = sprintf("0201000201%02x", min(255, $rpp)-1) . $str;
+
+ // now tack on sequence identifier and length
+ $str = self::_ber_addseq($str, '30');
+
+ return pack('H'.strlen($str), $str);
+ }
+
+
+ /**
+ * create ber encoding for sort control
+ *
+ * @param array List of cols to sort by
+ * @return string BER encoded option value
+ */
+ private function _sort_ber_encode($sortcols)
+ {
+ $str = '';
+ foreach (array_reverse((array)$sortcols) as $col) {
+ $ber_val = self::_string2hex($col);
+
+ # 30 = ber sequence with a length of octet value
+ # 04 = octet string with a length of the ascii value
+ $oct = self::_ber_addseq($ber_val, '04');
+ $str = self::_ber_addseq($oct, '30') . $str;
+ }
+
+ // now tack on sequence identifier and length
+ $str = self::_ber_addseq($str, '30');
+
+ return pack('H'.strlen($str), $str);
+ }
+
+ /**
+ * Add BER sequence with correct length and the given identifier
+ */
+ private static function _ber_addseq($str, $identifier)
+ {
+ $len = dechex(strlen($str)/2);
+ if (strlen($len) % 2 != 0)
+ $len = '0'.$len;
+
+ return $identifier . $len . $str;
+ }
+
+ /**
+ * Returns BER encoded integer value in hex format
+ */
+ private static function _ber_encode_int($offset)
+ {
+ $val = dechex($offset);
+ $prefix = '';
+
+ // check if bit 8 of high byte is 1
+ if (preg_match('/^[89abcdef]/', $val))
+ $prefix = '00';
+
+ if (strlen($val)%2 != 0)
+ $prefix .= '0';
+
+ return $prefix . $val;
+ }
+
+ /**
+ * Returns ascii string encoded in hex
+ */
+ private static function _string2hex($str)
+ {
+ $hex = '';
+ for ($i=0; $i < strlen($str); $i++)
+ $hex .= dechex(ord($str[$i]));
+ return $hex;
+ }
+
+ /**
+ * HTML-safe DN string encoding
+ *
+ * @param string $str DN string
+ *
+ * @return string Encoded HTML identifier string
+ */
+ static function dn_encode($str)
+ {
+ // @TODO: to make output string shorter we could probably
+ // remove dc=* items from it
+ return rtrim(strtr(base64_encode($str), '+/', '-_'), '=');
+ }
+
+ /**
+ * Decodes DN string encoded with _dn_encode()
+ *
+ * @param string $str Encoded HTML identifier string
+ *
+ * @return string DN string
+ */
+ static function dn_decode($str)
+ {
+ $str = str_pad(strtr($str, '-_', '+/'), strlen($str) % 4, '=', STR_PAD_RIGHT);
+ return base64_decode($str);
+ }
}
--
Gitblit v1.9.1