| | |
| | | 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; |
| | | |
| | | |
| | | /** |
| | |
| | | $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 |
| | |
| | | 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; |
| | | |
| | |
| | | |
| | | 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; |
| | |
| | | { |
| | | $this->ready = true; |
| | | |
| | | $bind_pass = $this->prop['bind_pass']; |
| | | $bind_user = $this->prop['bind_user']; |
| | | $bind_dn = $this->prop['bind_dn']; |
| | | $this->base_dn = $this->prop['base_dn']; |
| | | |
| | | // User specific access, generate the proper values to use. |
| | | if ($this->prop['user_specific']) { |
| | | // No password set, use the session password |
| | | if (empty($this->prop['bind_pass'])) { |
| | | $this->prop['bind_pass'] = $RCMAIL->decrypt($_SESSION['password']); |
| | | if (empty($bind_pass)) { |
| | | $bind_pass = $RCMAIL->decrypt($_SESSION['password']); |
| | | } |
| | | |
| | | // Get the pieces needed for variable replacement. |
| | |
| | | $this->_debug("S: search returned dn: $bind_dn"); |
| | | |
| | | if ($bind_dn) { |
| | | $this->prop['bind_dn'] = $bind_dn; |
| | | $dn = ldap_explode_dn($bind_dn, 1); |
| | | $replaces['%dn'] = $dn[0]; |
| | | } |
| | | } |
| | | } |
| | | // Replace the bind_dn and base_dn variables. |
| | | $this->prop['bind_dn'] = strtr($this->prop['bind_dn'], $replaces); |
| | | $this->prop['base_dn'] = strtr($this->prop['base_dn'], $replaces); |
| | | $bind_dn = strtr($bind_dn, $replaces); |
| | | $this->base_dn = strtr($this->base_dn, $replaces); |
| | | |
| | | if (empty($bind_user)) { |
| | | $bind_user = $u; |
| | | } |
| | | } |
| | | |
| | | if (!empty($this->prop['bind_dn']) && !empty($this->prop['bind_pass'])) |
| | | $this->ready = $this->_bind($this->prop['bind_dn'], $this->prop['bind_pass']); |
| | | if (!empty($bind_pass)) { |
| | | if (!empty($bind_dn)) { |
| | | $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); |
| | | } |
| | | else { |
| | | $this->ready = $this->_sasl_bind($bind_user, $bind_pass); |
| | | } |
| | | } |
| | | } |
| | | else |
| | | raise_error(array('code' => 100, 'type' => 'ldap', |
| | |
| | | |
| | | |
| | | /** |
| | | * Bind connection with DN and password |
| | | * |
| | | * @param string Bind DN |
| | | * @param string Bind password |
| | | * @return boolean True on success, False on error |
| | | */ |
| | | * Bind connection with (SASL-) user and password |
| | | * |
| | | * @param string $authc Authentication user |
| | | * @param string $pass Bind password |
| | | * @param string $authz Autorization user |
| | | * |
| | | * @return boolean True on success, False on error |
| | | */ |
| | | private 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', |
| | | 'file' => __FILE__, 'line' => __LINE__, |
| | | 'message' => "Unable to bind: ldap_sasl_bind() not exists"), |
| | | true, true); |
| | | } |
| | | |
| | | if (!empty($authz)) { |
| | | $authz = 'u:' . $authz; |
| | | } |
| | | |
| | | if (!empty($this->prop['auth_method'])) { |
| | | $method = $this->prop['auth_method']; |
| | | } |
| | | else { |
| | | $method = 'DIGEST-MD5'; |
| | | } |
| | | |
| | | $this->_debug("C: Bind [mech: $method, authc: $authc, authz: $authz] [pass: $pass]"); |
| | | |
| | | if (ldap_sasl_bind($this->conn, NULL, $pass, $method, NULL, $authc, $authz)) { |
| | | $this->_debug("S: OK"); |
| | | return true; |
| | | } |
| | | |
| | | $this->_debug("S: ".ldap_error($this->conn)); |
| | | |
| | | raise_error(array( |
| | | 'code' => ldap_errno($this->conn), 'type' => 'ldap', |
| | | 'file' => __FILE__, 'line' => __LINE__, |
| | | 'message' => "Bind failed for authcid=$authc ".ldap_error($this->conn)), |
| | | true); |
| | | |
| | | return false; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * 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) |
| | | { |
| | | if (!$this->conn) { |
| | |
| | | |
| | | $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) |
| | |
| | | |
| | | |
| | | /** |
| | | * 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; |
| | |
| | | |
| | | |
| | | /** |
| | | * 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; |
| | |
| | | |
| | | |
| | | /** |
| | | * 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; |
| | |
| | | |
| | | |
| | | /** |
| | | * 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; |
| | |
| | | |
| | | |
| | | /** |
| | | * Reset all saved results and search parameters |
| | | */ |
| | | * Reset all saved results and search parameters |
| | | */ |
| | | function reset() |
| | | { |
| | | $this->result = null; |
| | |
| | | |
| | | |
| | | /** |
| | | * 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 |
| | |
| | | // we have a search result resource |
| | | if ($this->ldap_result && $this->result->count > 0) |
| | | { |
| | | if ($this->sort_col && $this->prop['scope'] !== 'base') |
| | | 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_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; |
| | | |
| | |
| | | |
| | | |
| | | /** |
| | | * 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) |
| | | { |
| | |
| | | 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 .= ')'; |
| | | |
| | |
| | | |
| | | |
| | | /** |
| | | * 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. |
| | |
| | | // 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 |
| | |
| | | |
| | | |
| | | /** |
| | | * 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; |
| | |
| | | |
| | | |
| | | /** |
| | | * 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; |
| | |
| | | |
| | | |
| | | /** |
| | | * 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. |
| | |
| | | } |
| | | |
| | | // 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)); |
| | | |
| | |
| | | |
| | | |
| | | /** |
| | | * 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); |
| | |
| | | $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) { |
| | |
| | | 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); |
| | |
| | | |
| | | |
| | | /** |
| | | * 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) { |
| | | foreach ($ids as $id) { |
| | | $dn = base64_decode($id); |
| | | $this->_debug("C: Delete [dn: $dn]"); |
| | | // Delete the record. |
| | |
| | | } |
| | | } // 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) |
| | | { |
| | |
| | | |
| | | $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 |
| | |
| | | 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(); |
| | |
| | | |
| | | |
| | | /** |
| | | * @access private |
| | | */ |
| | | * Return real field name (from fields map) |
| | | */ |
| | | private function _map_field($field) |
| | | { |
| | | return $this->fieldmap[$field]; |
| | |
| | | |
| | | |
| | | /** |
| | | * @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( |
| | |
| | | |
| | | |
| | | /** |
| | | * @access private |
| | | */ |
| | | * Prints debug info to the log |
| | | */ |
| | | private function _debug($str) |
| | | { |
| | | if ($this->debug) |
| | |
| | | |
| | | |
| | | /** |
| | | * @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)) |
| | |
| | | $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[base64_encode($cache_members[$i])] = 1; |
| | | } |
| | | $this->group_members = $members; |
| | | $this->group_id = $group_id; |
| | |
| | | */ |
| | | 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']; |
| | | |
| | | $res = ldap_search($this->conn, $base_dn, $filter, array('cn','member')); |
| | | if ($res === false) |
| | |
| | | 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 = 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); |
| | | } |
| | | } |
| | | array_multisort($group_sortnames, SORT_ASC, SORT_STRING, $groups); |
| | | $this->group_cache = $groups; |
| | |
| | | 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_entry = array( |
| | | 'objectClass' => array('top', 'groupOfNames'), |
| | | 'objectClass' => $this->prop['groups']['object_classes'], |
| | | 'cn' => $group_name, |
| | | 'member' => '', |
| | | ); |
| | |
| | | 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"; |
| | |
| | | * @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 = base64_encode($new_name); |
| | | |
| | | $res = ldap_rename($this->conn, $old_dn, $new_rdn, NULL, TRUE); |
| | | if ($res === false) |
| | |
| | | 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"; |
| | | |
| | |
| | | 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"; |
| | | |
| | |
| | | if (!$this->groups) |
| | | return array(); |
| | | |
| | | $base_dn = $this->prop['groups']['base_dn']; |
| | | $base_dn = $this->groups_base_dn; |
| | | $contact_dn = base64_decode($contact_id); |
| | | $filter = "(member=$contact_dn)"; |
| | | |
| | |
| | | } |
| | | 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 |
| | | * |
| | | * @pararm 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; |
| | | } |
| | | |
| | | } |