| | |
| | | <?php |
| | | |
| | | /* |
| | | +-----------------------------------------------------------------------+ |
| | | | program/include/rcube_ldap.php | |
| | | | | |
| | | | This file is part of the Roundcube Webmail client | |
| | | | Copyright (C) 2006-2012, The Roundcube Dev Team | |
| | | | Copyright (C) 2011, Kolab Systems AG | |
| | | | Copyright (C) 2011-2012, Kolab Systems AG | |
| | | | | |
| | | | Licensed under the GNU General Public License version 3 or | |
| | | | any later version with exceptions for skins & plugins. | |
| | |
| | | | Andreas Dick <andudi (at) gmx (dot) ch> | |
| | | | Aleksander Machniak <machniak@kolabsys.com> | |
| | | +-----------------------------------------------------------------------+ |
| | | |
| | | $Id$ |
| | | |
| | | */ |
| | | |
| | | |
| | | /** |
| | | * Model class to access an LDAP address directory |
| | | * |
| | | * @package Addressbook |
| | | * @package Framework |
| | | * @subpackage Addressbook |
| | | */ |
| | | class rcube_ldap extends rcube_addressbook |
| | | { |
| | |
| | | |
| | | if (!is_array($this->coltypes[$col])) { |
| | | $subtypes = $type ? array($type) : null; |
| | | $this->coltypes[$col] = array('limit' => $limit, 'subtypes' => $subtypes); |
| | | $this->coltypes[$col] = array('limit' => $limit, 'subtypes' => $subtypes, 'attributes' => array($lf)); |
| | | } |
| | | elseif ($type) { |
| | | $this->coltypes[$col]['subtypes'][] = $type; |
| | | $this->coltypes[$col]['attributes'][] = $lf; |
| | | $this->coltypes[$col]['limit'] += $limit; |
| | | } |
| | | |
| | | if ($delim) |
| | | $this->coltypes[$col]['serialized'][$type] = $delim; |
| | | |
| | | if ($type && !$this->fieldmap[$col]) |
| | | $this->fieldmap[$col] = $lf; |
| | | |
| | | $this->fieldmap[$colv] = $lf; |
| | | $this->fieldmap[$colv] = $lf; |
| | | } |
| | | |
| | | // support for composite address |
| | | if ($this->fieldmap['street'] && $this->fieldmap['locality']) { |
| | | if ($this->coltypes['street'] && $this->coltypes['locality']) { |
| | | $this->coltypes['address'] = array( |
| | | 'limit' => max(1, $this->coltypes['locality']['limit'] + $this->coltypes['address']['limit']), |
| | | 'subtypes' => array_merge((array)$this->coltypes['address']['subtypes'], $this->coltypes['locality']['subtypes']), |
| | | 'subtypes' => array_merge((array)$this->coltypes['address']['subtypes'], (array)$this->coltypes['locality']['subtypes']), |
| | | 'childs' => array(), |
| | | ) + (array)$this->coltypes['address']; |
| | | |
| | | foreach (array('street','locality','zipcode','region','country') as $childcol) { |
| | | if ($this->fieldmap[$childcol]) { |
| | | if ($this->coltypes[$childcol]) { |
| | | $this->coltypes['address']['childs'][$childcol] = array('type' => 'text'); |
| | | unset($this->coltypes[$childcol]); // remove address child col from global coltypes list |
| | | } |
| | | } |
| | | |
| | | // at least one address type must be specified |
| | | if (empty($this->coltypes['address']['subtypes'])) { |
| | | $this->coltypes['address']['subtypes'] = array('home'); |
| | | } |
| | | } |
| | | else if ($this->coltypes['address']) { |
| | | $this->coltypes['address'] = array('type' => 'textarea', 'childs' => null, 'limit' => 1, 'size' => 40); |
| | | $this->coltypes['address'] += array('type' => 'textarea', 'childs' => null, 'size' => 40); |
| | | |
| | | // 'serialized' means the UI has to present a composite address field |
| | | if ($this->coltypes['address']['serialized']) { |
| | | $childprop = array('type' => 'text'); |
| | | $this->coltypes['address']['type'] = 'composite'; |
| | | $this->coltypes['address']['childs'] = array('street' => $childprop, 'locality' => $childprop, 'zipcode' => $childprop, 'country' => $childprop); |
| | | } |
| | | } |
| | | |
| | | // make sure 'required_fields' is an array |
| | |
| | | } |
| | | |
| | | // make sure LDAP_rdn field is required |
| | | if (!empty($this->prop['LDAP_rdn']) && !in_array($this->prop['LDAP_rdn'], $this->prop['required_fields'])) { |
| | | if (!empty($this->prop['LDAP_rdn']) && !in_array($this->prop['LDAP_rdn'], $this->prop['required_fields']) |
| | | && !in_array($this->prop['LDAP_rdn'], array_keys((array)$this->prop['autovalues']))) { |
| | | $this->prop['required_fields'][] = $this->prop['LDAP_rdn']; |
| | | } |
| | | |
| | |
| | | */ |
| | | function set_sort_order($sort_col, $sort_order = null) |
| | | { |
| | | if ($this->fieldmap[$sort_col]) |
| | | $this->sort_col = $this->fieldmap[$sort_col]; |
| | | if ($this->coltypes[$sort_col]['attributes']) |
| | | $this->sort_col = $this->coltypes[$sort_col]['attributes'][0]; |
| | | } |
| | | |
| | | |
| | |
| | | } |
| | | |
| | | // use VLV pseudo-search for autocompletion |
| | | if ($this->prop['vlv_search'] && $this->conn && join(',', (array)$fields) == 'email,name') |
| | | $rcube = rcube::get_instance(); |
| | | $list_fields = $rcube->config->get('contactlist_fields'); |
| | | |
| | | if ($this->prop['vlv_search'] && $this->conn && join(',', (array)$fields) == join(',', $list_fields)) |
| | | { |
| | | // add general filter to query |
| | | if (!empty($this->prop['filter']) && empty($this->filter)) |
| | |
| | | |
| | | for ($i = 0; $i < $entries['count']; $i++) { |
| | | $rec = $this->_ldap2result($entries[$i]); |
| | | foreach (array('email', 'name') as $f) { |
| | | $val = mb_strtolower($rec[$f]); |
| | | switch ($mode) { |
| | | case 1: |
| | | $got = ($val == $search); |
| | | break; |
| | | case 2: |
| | | $got = ($search == substr($val, 0, strlen($search))); |
| | | break; |
| | | default: |
| | | $got = (strpos($val, $search) !== false); |
| | | break; |
| | | } |
| | | foreach ($fields as $f) { |
| | | foreach ((array)$rec[$f] as $val) { |
| | | $val = mb_strtolower($val); |
| | | switch ($mode) { |
| | | case 1: |
| | | $got = ($val == $search); |
| | | break; |
| | | case 2: |
| | | $got = ($search == substr($val, 0, strlen($search))); |
| | | break; |
| | | default: |
| | | $got = (strpos($val, $search) !== false); |
| | | break; |
| | | } |
| | | |
| | | if ($got) { |
| | | $this->result->add($rec); |
| | | $this->result->count++; |
| | | break; |
| | | if ($got) { |
| | | $this->result->add($rec); |
| | | $this->result->count++; |
| | | break 2; |
| | | } |
| | | } |
| | | } |
| | | } |
| | |
| | | { |
| | | foreach ((array)$fields as $idx => $field) { |
| | | $val = is_array($value) ? $value[$idx] : $value; |
| | | if ($f = $this->_map_field($field)) { |
| | | $filter .= "($f=$wp" . $this->_quote_string($val) . "$ws)"; |
| | | if ($attrs = $this->_map_field($field)) { |
| | | if (count($attrs) > 1) |
| | | $filter .= '(|'; |
| | | foreach ($attrs as $f) |
| | | $filter .= "($f=$wp" . $this->_quote_string($val) . "$ws)"; |
| | | if (count($attrs) > 1) |
| | | $filter .= ')'; |
| | | } |
| | | } |
| | | } |
| | |
| | | |
| | | // add required (non empty) fields filter |
| | | $req_filter = ''; |
| | | foreach ((array)$required as $field) |
| | | if ($f = $this->_map_field($field)) |
| | | $req_filter .= "($f=*)"; |
| | | foreach ((array)$required as $field) { |
| | | if ($attrs = $this->_map_field($field)) { |
| | | if (count($attrs) > 1) |
| | | $req_filter .= '(|'; |
| | | foreach ($attrs as $f) |
| | | $req_filter .= "($f=*)"; |
| | | if (count($attrs) > 1) |
| | | $req_filter .= ')'; |
| | | } |
| | | } |
| | | |
| | | if (!empty($req_filter)) |
| | | $filter = '(&' . $req_filter . $filter . ')'; |
| | |
| | | $newentry = $this->_map_data($save_cols); |
| | | $newentry['objectClass'] = $this->prop['LDAP_Object_Classes']; |
| | | |
| | | // add automatically generated attributes |
| | | $this->add_autovalues($newentry); |
| | | |
| | | // Verify that the required fields are set. |
| | | $missing = null; |
| | | foreach ($this->prop['required_fields'] as $fld) { |
| | |
| | | else if ($val == '') { |
| | | // Field supplied is empty, verify that it is not required. |
| | | if (!in_array($fld, $this->prop['required_fields'])) { |
| | | // It is not, safe to clear. |
| | | $deletedata[$fld] = $old_data[$fld]; |
| | | // ...It is not, safe to clear. |
| | | // #1488420: Workaround "ldap_mod_del(): Modify: Inappropriate matching in..." |
| | | // jpegPhoto attribute require an array() here. It looks to me that it works for other attribs too |
| | | $deletedata[$fld] = array(); |
| | | //$deletedata[$fld] = $old_data[$fld]; |
| | | } |
| | | } |
| | | else { |
| | |
| | | } |
| | | } |
| | | |
| | | /** |
| | | * Generate missing attributes as configured |
| | | * |
| | | * @param array LDAP record attributes |
| | | */ |
| | | protected function add_autovalues(&$attrs) |
| | | { |
| | | $attrvals = array(); |
| | | foreach ($attrs as $k => $v) { |
| | | $attrvals['{'.$k.'}'] = is_array($v) ? $v[0] : $v; |
| | | } |
| | | |
| | | foreach ((array)$this->prop['autovalues'] as $lf => $templ) { |
| | | if (empty($attrs[$lf])) { |
| | | // replace {attr} placeholders with concrete attribute values |
| | | $templ = preg_replace('/\{\w+\}/', '', strtr($templ, $attrvals)); |
| | | |
| | | if (strpos($templ, '(') !== false) |
| | | $attrs[$lf] = eval("return ($templ);"); |
| | | else |
| | | $attrs[$lf] = $templ; |
| | | } |
| | | } |
| | | } |
| | | |
| | | /** |
| | | * Execute the LDAP search based on the stored credentials |
| | |
| | | list($col, $subtype) = explode(':', $rf); |
| | | $out['_raw_attrib'][$lf][$i] = $value; |
| | | |
| | | if ($rf == 'email' && $this->mail_domain && !strpos($value, '@')) |
| | | if ($col == 'email' && $this->mail_domain && !strpos($value, '@')) |
| | | $out[$rf][] = sprintf('%s@%s', $value, $this->mail_domain); |
| | | else if (in_array($col, array('street','zipcode','locality','country','region'))) |
| | | $out['address'.($subtype?':':'').$subtype][$i][$col] = $value; |
| | |
| | | |
| | | |
| | | /** |
| | | * Return real field name (from fields map) |
| | | * Return LDAP attribute(s) for the given field |
| | | */ |
| | | private function _map_field($field) |
| | | { |
| | | return $this->fieldmap[$field]; |
| | | return (array)$this->coltypes[$field]['attributes']; |
| | | } |
| | | |
| | | |
| | |
| | | } |
| | | |
| | | $ldap_data = array(); |
| | | foreach ($this->fieldmap as $col => $fld) { |
| | | $val = $save_cols[$col]; |
| | | foreach ($this->fieldmap as $rf => $fld) { |
| | | $val = $save_cols[$rf]; |
| | | |
| | | // check for value in base field (eg.g email instead of email:foo) |
| | | list($col, $subtype) = explode(':', $rf); |
| | | if (!$val && !empty($save_cols[$col])) { |
| | | $val = $save_cols[$col]; |
| | | unset($save_cols[$col]); // only use this value once |
| | | } |
| | | else if (!$val && !$subtype) { // extract values from subtype cols |
| | | $val = $this->get_col_values($col, $save_cols, true); |
| | | } |
| | | |
| | | if (is_array($val)) |
| | | $val = array_filter($val); // remove empty entries |
| | | if ($fld && $val) { |
| | |
| | | # a0 = type context-specific/constructed with a length of 06 (6) bytes following |
| | | # 02 = type integer with 2 bytes following (offset): 01 01 (ie 1) |
| | | # 02 = type integer with 2 bytes following (contentCount): 01 00 |
| | | |
| | | |
| | | # whith a search string present: |
| | | # 81 = type context-specific/constructed with a length of 04 (4) bytes following (the length will change here) |
| | | # 81 indicates a user string is present where as a a0 indicates just a offset search |
| | | # 81 = type context-specific/constructed with a length of 06 (6) bytes following |
| | | |
| | | |
| | | # 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 |
| | |
| | | # of the second (to the left of first octet) octet: |
| | | # a) shall not all be ones; and |
| | | # b) shall not all be zero |
| | | |
| | | |
| | | if ($search) |
| | | { |
| | | $search = preg_replace('/[^-[:alpha:] ,.()0-9]+/', '', $search); |
| | |
| | | // now compute length over $str |
| | | $str = self::_ber_addseq($str, 'a0'); |
| | | } |
| | | |
| | | |
| | | // now tack on records per page |
| | | $str = "020100" . self::_ber_addseq(self::_ber_encode_int($rpp-1), '02') . $str; |
| | | |