Context Navigation

source: subversion/branches/release-0.7/program/include/rcube_ldap.php @ 5393

Last change on this file since 5393 was 5393, checked in by thomasb, 19 months ago
Backported r5392 to release branch
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 63.4 KB

Line
1	<?php
2	/*
3	+-----------------------------------------------------------------------+
4	\| program/include/rcube_ldap.php \|
5	\| \|
6	\| This file is part of the Roundcube Webmail client \|
7	\| Copyright (C) 2006-2011, The Roundcube Dev Team \|
8	\| Copyright (C) 2011, Kolab Systems AG \|
9	\| Licensed under the GNU GPL \|
10	\| \|
11	\| PURPOSE: \|
12	\| Interface to an LDAP address directory \|
13	\| \|
14	+-----------------------------------------------------------------------+
15	\| Author: Thomas Bruederli <roundcube@gmail.com> \|
16	\| Andreas Dick <andudi (at) gmx (dot) ch> \|
17	\| Aleksander Machniak <machniak@kolabsys.com> \|
18	+-----------------------------------------------------------------------+
19
20	$Id$
21
22	*/
23
24
25	/**
26	* Model class to access an LDAP address directory
27	*
28	* @package Addressbook
29	*/
30	class rcube_ldap extends rcube_addressbook
31	{
32	/** public properties */
33	public $primary_key = 'ID';
34	public $groups = false;
35	public $readonly = true;
36	public $ready = false;
37	public $group_id = 0;
38	public $list_page = 1;
39	public $page_size = 10;
40	public $coltypes = array();
41
42	/** private properties */
43	protected $conn;
44	protected $prop = array();
45	protected $fieldmap = array();
46
47	protected $filter = '';
48	protected $result = null;
49	protected $ldap_result = null;
50	protected $sort_col = '';
51	protected $mail_domain = '';
52	protected $debug = false;
53
54	private $base_dn = '';
55	private $groups_base_dn = '';
56	private $group_url = null;
57	private $cache;
58
59	private $vlv_active = false;
60	private $vlv_count = 0;
61
62
63	/**
64	* Object constructor
65	*
66	* @param array LDAP connection properties
67	* @param boolean Enables debug mode
68	* @param string Current user mail domain name
69	* @param integer User-ID
70	*/
71	function __construct($p, $debug=false, $mail_domain=NULL)
72	{
73	$this->prop = $p;
74
75	if (isset($p['searchonly']))
76	$this->searchonly = $p['searchonly'];
77
78	// check if groups are configured
79	if (is_array($p['groups']) && count($p['groups'])) {
80	$this->groups = true;
81	// set member field
82	if (!empty($p['groups']['member_attr']))
83	$this->prop['member_attr'] = strtolower($p['groups']['member_attr']);
84	else if (empty($p['member_attr']))
85	$this->prop['member_attr'] = 'member';
86	// set default name attribute to cn
87	if (empty($this->prop['groups']['name_attr']))
88	$this->prop['groups']['name_attr'] = 'cn';
89	if (empty($this->prop['groups']['scope']))
90	$this->prop['groups']['scope'] = 'sub';
91	}
92
93	// fieldmap property is given
94	if (is_array($p['fieldmap'])) {
95	foreach ($p['fieldmap'] as $rf => $lf)
96	$this->fieldmap[$rf] = $this->_attr_name(strtolower($lf));
97	}
98	else {
99	// read deprecated *_field properties to remain backwards compatible
100	foreach ($p as $prop => $value)
101	if (preg_match('/^(.+)_field$/', $prop, $matches))
102	$this->fieldmap[$matches[1]] = $this->_attr_name(strtolower($value));
103	}
104
105	// use fieldmap to advertise supported coltypes to the application
106	foreach ($this->fieldmap as $col => $lf) {
107	list($col, $type) = explode(':', $col);
108	if (!is_array($this->coltypes[$col])) {
109	$subtypes = $type ? array($type) : null;
110	$this->coltypes[$col] = array('limit' => 2, 'subtypes' => $subtypes);
111	}
112	elseif ($type) {
113	$this->coltypes[$col]['subtypes'][] = $type;
114	$this->coltypes[$col]['limit']++;
115	}
116	if ($type && !$this->fieldmap[$col])
117	$this->fieldmap[$col] = $lf;
118	}
119
120	if ($this->fieldmap['street'] && $this->fieldmap['locality'])
121	$this->coltypes['address'] = array('limit' => 1);
122	else if ($this->coltypes['address'])
123	$this->coltypes['address'] = array('type' => 'textarea', 'childs' => null, 'limit' => 1, 'size' => 40);
124
125	// make sure 'required_fields' is an array
126	if (!is_array($this->prop['required_fields']))
127	$this->prop['required_fields'] = (array) $this->prop['required_fields'];
128
129	foreach ($this->prop['required_fields'] as $key => $val)
130	$this->prop['required_fields'][$key] = $this->_attr_name(strtolower($val));
131
132	$this->sort_col = is_array($p['sort']) ? $p['sort'][0] : $p['sort'];
133	$this->debug = $debug;
134	$this->mail_domain = $mail_domain;
135
136	// initialize cache
137	$rcmail = rcmail::get_instance();
138	$this->cache = $rcmail->get_cache('LDAP.' . asciiwords($this->prop['name']), 'db', 600);
139
140	$this->_connect();
141	}
142
143
144	/**
145	* Establish a connection to the LDAP server
146	*/
147	private function _connect()
148	{
149	global $RCMAIL;
150
151	if (!function_exists('ldap_connect'))
152	raise_error(array('code' => 100, 'type' => 'ldap',
153	'file' => __FILE__, 'line' => __LINE__,
154	'message' => "No ldap support in this installation of PHP"),
155	true, true);
156
157	if (is_resource($this->conn))
158	return true;
159
160	if (!is_array($this->prop['hosts']))
161	$this->prop['hosts'] = array($this->prop['hosts']);
162
163	if (empty($this->prop['ldap_version']))
164	$this->prop['ldap_version'] = 3;
165
166	foreach ($this->prop['hosts'] as $host)
167	{
168	$host = idn_to_ascii(rcube_parse_host($host));
169	$hostname = $host.($this->prop['port'] ? ':'.$this->prop['port'] : '');
170
171	$this->_debug("C: Connect [$hostname]");
172
173	if ($lc = @ldap_connect($host, $this->prop['port']))
174	{
175	if ($this->prop['use_tls'] === true)
176	if (!ldap_start_tls($lc))
177	continue;
178
179	$this->_debug("S: OK");
180
181	ldap_set_option($lc, LDAP_OPT_PROTOCOL_VERSION, $this->prop['ldap_version']);
182	$this->prop['host'] = $host;
183	$this->conn = $lc;
184
185	if (isset($this->prop['referrals']))
186	ldap_set_option($lc, LDAP_OPT_REFERRALS, $this->prop['referrals']);
187	break;
188	}
189	$this->_debug("S: NOT OK");
190	}
191
192	// See if the directory is writeable.
193	if ($this->prop['writable']) {
194	$this->readonly = false;
195	}
196
197	if (!is_resource($this->conn)) {
198	raise_error(array('code' => 100, 'type' => 'ldap',
199	'file' => __FILE__, 'line' => __LINE__,
200	'message' => "Could not connect to any LDAP server, last tried $hostname"), true);
201
202	return false;
203	}
204
205	$bind_pass = $this->prop['bind_pass'];
206	$bind_user = $this->prop['bind_user'];
207	$bind_dn = $this->prop['bind_dn'];
208
209	$this->base_dn = $this->prop['base_dn'];
210	$this->groups_base_dn = ($this->prop['groups']['base_dn']) ?
211	$this->prop['groups']['base_dn'] : $this->base_dn;
212
213	// User specific access, generate the proper values to use.
214	if ($this->prop['user_specific']) {
215	// No password set, use the session password
216	if (empty($bind_pass)) {
217	$bind_pass = $RCMAIL->decrypt($_SESSION['password']);
218	}
219
220	// Get the pieces needed for variable replacement.
221	if ($fu = $RCMAIL->user->get_username())
222	list($u, $d) = explode('@', $fu);
223	else
224	$d = $this->mail_domain;
225
226	$dc = 'dc='.strtr($d, array('.' => ',dc=')); // hierarchal domain string
227
228	$replaces = array('%dn' => '', '%dc' => $dc, '%d' => $d, '%fu' => $fu, '%u' => $u);
229
230	if ($this->prop['search_base_dn'] && $this->prop['search_filter']) {
231	// Search for the dn to use to authenticate
232	$this->prop['search_base_dn'] = strtr($this->prop['search_base_dn'], $replaces);
233	$this->prop['search_filter'] = strtr($this->prop['search_filter'], $replaces);
234
235	$this->_debug("S: searching with base {$this->prop['search_base_dn']} for {$this->prop['search_filter']}");
236
237	$res = @ldap_search($this->conn, $this->prop['search_base_dn'], $this->prop['search_filter'], array('uid'));
238	if ($res) {
239	if (($entry = ldap_first_entry($this->conn, $res))
240	&& ($bind_dn = ldap_get_dn($this->conn, $entry))
241	) {
242	$this->_debug("S: search returned dn: $bind_dn");
243	$dn = ldap_explode_dn($bind_dn, 1);
244	$replaces['%dn'] = $dn[0];
245	}
246	}
247	else {
248	$this->_debug("S: ".ldap_error($this->conn));
249	}
250
251	// DN not found
252	if (empty($replaces['%dn'])) {
253	if (!empty($this->prop['search_dn_default']))
254	$replaces['%dn'] = $this->prop['search_dn_default'];
255	else {
256	raise_error(array(
257	'code' => 100, 'type' => 'ldap',
258	'file' => __FILE__, 'line' => __LINE__,
259	'message' => "DN not found using LDAP search."), true);
260	return false;
261	}
262	}
263	}
264
265	// Replace the bind_dn and base_dn variables.
266	$bind_dn = strtr($bind_dn, $replaces);
267	$this->base_dn = strtr($this->base_dn, $replaces);
268	$this->groups_base_dn = strtr($this->groups_base_dn, $replaces);
269
270	if (empty($bind_user)) {
271	$bind_user = $u;
272	}
273	}
274
275	if (empty($bind_pass)) {
276	$this->ready = true;
277	}
278	else {
279	if (!empty($bind_dn)) {
280	$this->ready = $this->bind($bind_dn, $bind_pass);
281	}
282	else if (!empty($this->prop['auth_cid'])) {
283	$this->ready = $this->sasl_bind($this->prop['auth_cid'], $bind_pass, $bind_user);
284	}
285	else {
286	$this->ready = $this->sasl_bind($bind_user, $bind_pass);
287	}
288	}
289
290	return $this->ready;
291	}
292
293
294	/**
295	* Bind connection with (SASL-) user and password
296	*
297	* @param string $authc Authentication user
298	* @param string $pass Bind password
299	* @param string $authz Autorization user
300	*
301	* @return boolean True on success, False on error
302	*/
303	public function sasl_bind($authc, $pass, $authz=null)
304	{
305	if (!$this->conn) {
306	return false;
307	}
308
309	if (!function_exists('ldap_sasl_bind')) {
310	raise_error(array('code' => 100, 'type' => 'ldap',
311	'file' => __FILE__, 'line' => __LINE__,
312	'message' => "Unable to bind: ldap_sasl_bind() not exists"),
313	true, true);
314	}
315
316	if (!empty($authz)) {
317	$authz = 'u:' . $authz;
318	}
319
320	if (!empty($this->prop['auth_method'])) {
321	$method = $this->prop['auth_method'];
322	}
323	else {
324	$method = 'DIGEST-MD5';
325	}
326
327	$this->_debug("C: Bind [mech: $method, authc: $authc, authz: $authz] [pass: $pass]");
328
329	if (ldap_sasl_bind($this->conn, NULL, $pass, $method, NULL, $authc, $authz)) {
330	$this->_debug("S: OK");
331	return true;
332	}
333
334	$this->_debug("S: ".ldap_error($this->conn));
335
336	raise_error(array(
337	'code' => ldap_errno($this->conn), 'type' => 'ldap',
338	'file' => __FILE__, 'line' => __LINE__,
339	'message' => "Bind failed for authcid=$authc ".ldap_error($this->conn)),
340	true);
341
342	return false;
343	}
344
345
346	/**
347	* Bind connection with DN and password
348	*
349	* @param string Bind DN
350	* @param string Bind password
351	*
352	* @return boolean True on success, False on error
353	*/
354	public function bind($dn, $pass)
355	{
356	if (!$this->conn) {
357	return false;
358	}
359
360	$this->_debug("C: Bind [dn: $dn] [pass: $pass]");
361
362	if (@ldap_bind($this->conn, $dn, $pass)) {
363	$this->_debug("S: OK");
364	return true;
365	}
366
367	$this->_debug("S: ".ldap_error($this->conn));
368
369	raise_error(array(
370	'code' => ldap_errno($this->conn), 'type' => 'ldap',
371	'file' => __FILE__, 'line' => __LINE__,
372	'message' => "Bind failed for dn=$dn: ".ldap_error($this->conn)),
373	true);
374
375	return false;
376	}
377
378
379	/**
380	* Close connection to LDAP server
381	*/
382	function close()
383	{
384	if ($this->conn)
385	{
386	$this->_debug("C: Close");
387	ldap_unbind($this->conn);
388	$this->conn = null;
389	}
390	}
391
392
393	/**
394	* Returns address book name
395	*
396	* @return string Address book name
397	*/
398	function get_name()
399	{
400	return $this->prop['name'];
401	}
402
403
404	/**
405	* Set internal list page
406	*
407	* @param number $page Page number to list
408	*/
409	function set_page($page)
410	{
411	$this->list_page = (int)$page;
412	}
413
414
415	/**
416	* Set internal page size
417	*
418	* @param number $size Number of messages to display on one page
419	*/
420	function set_pagesize($size)
421	{
422	$this->page_size = (int)$size;
423	}
424
425
426	/**
427	* Save a search string for future listings
428	*
429	* @param string $filter Filter string
430	*/
431	function set_search_set($filter)
432	{
433	$this->filter = $filter;
434	}
435
436
437	/**
438	* Getter for saved search properties
439	*
440	* @return mixed Search properties used by this class
441	*/
442	function get_search_set()
443	{
444	return $this->filter;
445	}
446
447
448	/**
449	* Reset all saved results and search parameters
450	*/
451	function reset()
452	{
453	$this->result = null;
454	$this->ldap_result = null;
455	$this->filter = '';
456	}
457
458
459	/**
460	* List the current set of contact records
461	*
462	* @param array List of cols to show
463	* @param int Only return this number of records
464	*
465	* @return array Indexed list of contact records, each a hash array
466	*/
467	function list_records($cols=null, $subset=0)
468	{
469	if ($this->prop['searchonly'] && empty($this->filter) && !$this->group_id)
470	{
471	$this->result = new rcube_result_set(0);
472	$this->result->searchonly = true;
473	return $this->result;
474	}
475
476	// fetch group members recursively
477	if ($this->group_id && $this->group_data['dn'])
478	{
479	$entries = $this->list_group_members($this->group_data['dn']);
480
481	// make list of entries unique and sort it
482	$seen = array();
483	foreach ($entries as $i => $rec) {
484	if ($seen[$rec['dn']]++)
485	unset($entries[$i]);
486	}
487	usort($entries, array($this, '_entry_sort_cmp'));
488
489	$entries['count'] = count($entries);
490	$this->result = new rcube_result_set($entries['count'], ($this->list_page-1) * $this->page_size);
491	}
492	else
493	{
494	// add general filter to query
495	if (!empty($this->prop['filter']) && empty($this->filter))
496	$this->set_search_set($this->prop['filter']);
497
498	// exec LDAP search if no result resource is stored
499	if ($this->conn && !$this->ldap_result)
500	$this->_exec_search();
501
502	// count contacts for this user
503	$this->result = $this->count();
504
505	// we have a search result resource
506	if ($this->ldap_result && $this->result->count > 0)
507	{
508	// sorting still on the ldap server
509	if ($this->sort_col && $this->prop['scope'] !== 'base' && !$this->vlv_active)
510	ldap_sort($this->conn, $this->ldap_result, $this->sort_col);
511
512	// get all entries from the ldap server
513	$entries = ldap_get_entries($this->conn, $this->ldap_result);
514	}
515
516	} // end else
517
518	// start and end of the page
519	$start_row = $this->vlv_active ? 0 : $this->result->first;
520	$start_row = $subset < 0 ? $start_row + $this->page_size + $subset : $start_row;
521	$last_row = $this->result->first + $this->page_size;
522	$last_row = $subset != 0 ? $start_row + abs($subset) : $last_row;
523
524	// filter entries for this page
525	for ($i = $start_row; $i < min($entries['count'], $last_row); $i++)
526	$this->result->add($this->_ldap2result($entries[$i]));
527
528	return $this->result;
529	}
530
531	/**
532	* Get all members of the given group
533	*
534	* @param string Group DN
535	* @param array Group entries (if called recursively)
536	* @return array Accumulated group members
537	*/
538	function list_group_members($dn, $count = false, $entries = null)
539	{
540	$group_members = array();
541
542	// fetch group object
543	if (empty($entries)) {
544	$result = @ldap_read($this->conn, $dn, '(objectClass=*)', array('dn','objectClass','member','uniqueMember','memberURL'));
545	if ($result === false)
546	{
547	$this->_debug("S: ".ldap_error($this->conn));
548	return $group_members;
549	}
550
551	$entries = @ldap_get_entries($this->conn, $result);
552	}
553
554	for ($i=0; $i < $entries["count"]; $i++)
555	{
556	$entry = $entries[$i];
557
558	if (empty($entry['objectclass']))
559	continue;
560
561	foreach ((array)$entry['objectclass'] as $objectclass)
562	{
563	switch (strtolower($objectclass)) {
564	case "groupofnames":
565	case "kolabgroupofnames":
566	$group_members = array_merge($group_members, $this->_list_group_members($dn, $entry, 'member', $count));
567	break;
568	case "groupofuniquenames":
569	case "kolabgroupofuniquenames":
570	$group_members = array_merge($group_members, $this->_list_group_members($dn, $entry, 'uniquemember', $count));
571	break;
572	case "groupofurls":
573	$group_members = array_merge($group_members, $this->_list_group_memberurl($dn, $entry, $count));
574	break;
575	}
576	}
577
578	if ($this->prop['sizelimit'] && count($group_members) > $this->prop['sizelimit'])
579	break;
580	}
581
582	return array_filter($group_members);
583	}
584
585	/**
586	* Fetch members of the given group entry from server
587	*
588	* @param string Group DN
589	* @param array Group entry
590	* @param string Member attribute to use
591	* @return array Accumulated group members
592	*/
593	private function _list_group_members($dn, $entry, $attr, $count)
594	{
595	// Use the member attributes to return an array of member ldap objects
596	// NOTE that the member attribute is supposed to contain a DN
597	$group_members = array();
598	if (empty($entry[$attr]))
599	return $group_members;
600
601	// read these attributes for all members
602	$attrib = $count ? array('dn') : array_values($this->fieldmap);
603	$attrib[] = 'objectClass';
604	$attrib[] = 'member';
605	$attrib[] = 'uniqueMember';
606	$attrib[] = 'memberURL';
607
608	for ($i=0; $i < $entry[$attr]['count']; $i++)
609	{
610	$result = @ldap_read($this->conn, $entry[$attr][$i], '(objectclass=*)',
611	$attrib, 0, (int)$this->prop['sizelimit'], (int)$this->prop['timelimit']);
612
613	$members = @ldap_get_entries($this->conn, $result);
614	if ($members == false)
615	{
616	$this->_debug("S: ".ldap_error($this->conn));
617	$members = array();
618	}
619
620	// for nested groups, call recursively
621	$nested_group_members = $this->list_group_members($entry[$attr][$i], $count, $members);
622
623	unset($members['count']);
624	$group_members = array_merge($group_members, array_filter($members), $nested_group_members);
625	}
626
627	return $group_members;
628	}
629
630	/**
631	* List members of group class groupOfUrls
632	*
633	* @param string Group DN
634	* @param array Group entry
635	* @param boolean True if only used for counting
636	* @return array Accumulated group members
637	*/
638	private function _list_group_memberurl($dn, $entry, $count)
639	{
640	$group_members = array();
641
642	for ($i=0; $i < $entry['memberurl']['count']; $i++)
643	{
644	// extract components from url
645	if (!preg_match('!ldap:///([^\?]+)\?\?(\w+)\?(.*)$!', $entry['memberurl'][$i], $m))
646	continue;
647
648	// add search filter if any
649	$filter = $this->filter ? '(&(' . $m[3] . ')(' . $this->filter . '))' : $m[3];
650	$func = $m[2] == 'sub' ? 'ldap_search' : ($m[2] == 'base' ? 'ldap_read' : 'ldap_list');
651
652	$attrib = $count ? array('dn') : array_values($this->fieldmap);
653	if ($result = @$func($this->conn, $m[1], $filter,
654	$attrib, 0, (int)$this->prop['sizelimit'], (int)$this->prop['timelimit']))
655	{
656	$this->_debug("S: ".ldap_count_entries($this->conn, $result)." record(s) for ".$m[1]);
657	if ($err = ldap_errno($this->conn))
658	$this->_debug("S: Error: " .ldap_err2str($err));
659	}
660	else
661	{
662	$this->_debug("S: ".ldap_error($this->conn));
663	return $group_members;
664	}
665
666	$entries = @ldap_get_entries($this->conn, $result);
667	for ($j = 0; $j < $entries['count']; $j++)
668	{
669	if ($nested_group_members = $this->list_group_members($entries[$j]['dn'], $count))
670	$group_members = array_merge($group_members, $nested_group_members);
671	else
672	$group_members[] = $entries[$j];
673	}
674	}
675
676	return $group_members;
677	}
678
679	/**
680	* Callback for sorting entries
681	*/
682	function _entry_sort_cmp($a, $b)
683	{
684	return strcmp($a[$this->sort_col][0], $b[$this->sort_col][0]);
685	}
686
687
688	/**
689	* Search contacts
690	*
691	* @param mixed $fields The field name of array of field names to search in
692	* @param mixed $value Search value (or array of values when $fields is array)
693	* @param boolean $strict True for strict, False for partial (fuzzy) matching
694	* @param boolean $select True if results are requested, False if count only
695	* @param boolean $nocount (Not used)
696	* @param array $required List of fields that cannot be empty
697	*
698	* @return array Indexed list of contact records and 'count' value
699	*/
700	function search($fields, $value, $strict=false, $select=true, $nocount=false, $required=array())
701	{
702	// special treatment for ID-based search
703	if ($fields == 'ID' \|\| $fields == $this->primary_key)
704	{
705	$ids = !is_array($value) ? explode(',', $value) : $value;
706	$result = new rcube_result_set();
707	foreach ($ids as $id)
708	{
709	if ($rec = $this->get_record($id, true))
710	{
711	$result->add($rec);
712	$result->count++;
713	}
714	}
715	return $result;
716	}
717
718	// use VLV pseudo-search for autocompletion
719	if ($this->prop['vlv_search'] && $this->conn && join(',', (array)$fields) == 'email,name')
720	{
721	// add general filter to query
722	if (!empty($this->prop['filter']) && empty($this->filter))
723	$this->set_search_set($this->prop['filter']);
724
725	// set VLV controls with encoded search string
726	$this->_vlv_set_controls($this->prop, $this->list_page, $this->page_size, $value);
727
728	$function = $this->_scope2func($this->prop['scope']);
729	$this->ldap_result = @$function($this->conn, $this->base_dn, $this->filter ? $this->filter : '(objectclass=*)',
730	array_values($this->fieldmap), 0, (int)$this->prop['sizelimit'], (int)$this->prop['timelimit']);
731
732	// get all entries of this page and post-filter those that really match the query
733	$this->result = new rcube_result_set(0);
734	$entries = ldap_get_entries($this->conn, $this->ldap_result);
735	for ($i = 0; $i < $entries['count']; $i++) {
736	$rec = $this->_ldap2result($entries[$i]);
737	if (stripos($rec['name'] . $rec['email'], $value) !== false) {
738	$this->result->add($rec);
739	$this->result->count++;
740	}
741	}
742
743	return $this->result;
744	}
745
746	// use AND operator for advanced searches
747	$filter = is_array($value) ? '(&' : '(\|';
748	$wc = !$strict && $this->prop['fuzzy_search'] ? '*' : '';
749
750	if ($fields == '*')
751	{
752	// search_fields are required for fulltext search
753	if (empty($this->prop['search_fields']))
754	{
755	$this->set_error(self::ERROR_SEARCH, 'nofulltextsearch');
756	$this->result = new rcube_result_set();
757	return $this->result;
758	}
759	if (is_array($this->prop['search_fields']))
760	{
761	foreach ($this->prop['search_fields'] as $field) {
762	$filter .= "($field=$wc" . $this->_quote_string($value) . "$wc)";
763	}
764	}
765	}
766	else
767	{
768	foreach ((array)$fields as $idx => $field) {
769	$val = is_array($value) ? $value[$idx] : $value;
770	if ($f = $this->_map_field($field)) {
771	$filter .= "($f=$wc" . $this->_quote_string($val) . "$wc)";
772	}
773	}
774	}
775	$filter .= ')';
776
777	// add required (non empty) fields filter
778	$req_filter = '';
779	foreach ((array)$required as $field)
780	if ($f = $this->_map_field($field))
781	$req_filter .= "($f=*)";
782
783	if (!empty($req_filter))
784	$filter = '(&' . $req_filter . $filter . ')';
785
786	// avoid double-wildcard if $value is empty
787	$filter = preg_replace('/\+/', '', $filter);
788
789	// add general filter to query
790	if (!empty($this->prop['filter']))
791	$filter = '(&(' . preg_replace('/^\(\|\)$/', '', $this->prop['filter']) . ')' . $filter . ')';
792
793	// set filter string and execute search
794	$this->set_search_set($filter);
795	$this->_exec_search();
796
797	if ($select)
798	$this->list_records();
799	else
800	$this->result = $this->count();
801
802	return $this->result;
803	}
804
805
806	/**
807	* Count number of available contacts in database
808	*
809	* @return object rcube_result_set Resultset with values for 'count' and 'first'
810	*/
811	function count()
812	{
813	$count = 0;
814	if ($this->conn && $this->ldap_result) {
815	$count = $this->vlv_active ? $this->vlv_count : ldap_count_entries($this->conn, $this->ldap_result);
816	}
817	else if ($this->group_id && $this->group_data['dn']) {
818	$count = count($this->list_group_members($this->group_data['dn'], true));
819	}
820	else if ($this->conn) {
821	// We have a connection but no result set, attempt to get one.
822	if (empty($this->filter)) {
823	// The filter is not set, set it.
824	$this->filter = $this->prop['filter'];
825	}
826	$this->_exec_search(true);
827	if ($this->ldap_result) {
828	$count = ldap_count_entries($this->conn, $this->ldap_result);
829	}
830	}
831
832	return new rcube_result_set($count, ($this->list_page-1) * $this->page_size);
833	}
834
835
836	/**
837	* Return the last result set
838	*
839	* @return object rcube_result_set Current resultset or NULL if nothing selected yet
840	*/
841	function get_result()
842	{
843	return $this->result;
844	}
845
846
847	/**
848	* Get a specific contact record
849	*
850	* @param mixed Record identifier
851	* @param boolean Return as associative array
852	*
853	* @return mixed Hash array or rcube_result_set with all record fields
854	*/
855	function get_record($dn, $assoc=false)
856	{
857	$res = null;
858	if ($this->conn && $dn)
859	{
860	$dn = self::dn_decode($dn);
861
862	$this->_debug("C: Read [dn: $dn] [(objectclass=*)]");
863
864	if ($this->ldap_result = @ldap_read($this->conn, $dn, '(objectclass=*)', array_values($this->fieldmap)))
865	$entry = ldap_first_entry($this->conn, $this->ldap_result);
866	else
867	$this->_debug("S: ".ldap_error($this->conn));
868
869	if ($entry && ($rec = ldap_get_attributes($this->conn, $entry)))
870	{
871	$this->_debug("S: OK"/* . print_r($rec, true)*/);
872
873	$rec = array_change_key_case($rec, CASE_LOWER);
874
875	// Add in the dn for the entry.
876	$rec['dn'] = $dn;
877	$res = $this->_ldap2result($rec);
878	$this->result = new rcube_result_set(1);
879	$this->result->add($res);
880	}
881	}
882
883	return $assoc ? $res : $this->result;
884	}
885
886
887	/**
888	* Check the given data before saving.
889	* If input not valid, the message to display can be fetched using get_error()
890	*
891	* @param array Assoziative array with data to save
892	* @param boolean Try to fix/complete record automatically
893	* @return boolean True if input is valid, False if not.
894	*/
895	public function validate(&$save_data, $autofix = false)
896	{
897	// check for name input
898	if (empty($save_data['name'])) {
899	$this->set_error(self::ERROR_VALIDATE, 'nonamewarning');
900	return false;
901	}
902
903	// Verify that the required fields are set.
904	$missing = null;
905	$ldap_data = $this->_map_data($save_data);
906	foreach ($this->prop['required_fields'] as $fld) {
907	if (!isset($ldap_data[$fld])) {
908	$missing[$fld] = 1;
909	}
910	}
911
912	if ($missing) {
913	// try to complete record automatically
914	if ($autofix) {
915	$reverse_map = array_flip($this->fieldmap);
916	$name_parts = preg_split('/[\s,.]+/', $save_data['name']);
917	if ($missing['sn']) {
918	$sn_field = $reverse_map['sn'];
919	$save_data[$sn_field] = array_pop ($name_parts);
920	}
921	if ($missing[($fn_field = $this->fieldmap['firstname'])]) {
922	$save_data['firstname'] = array_shift($name_parts);
923	}
924
925	return $this->validate($save_data, false);
926	}
927
928	// TODO: generate message saying which fields are missing
929	$this->set_error(self::ERROR_VALIDATE, 'formincomplete');
930	return false;
931	}
932
933	// validate e-mail addresses
934	return parent::validate($save_data, $autofix);
935	}
936
937
938	/**
939	* Create a new contact record
940	*
941	* @param array Hash array with save data
942	*
943	* @return encoded record ID on success, False on error
944	*/
945	function insert($save_cols)
946	{
947	// Map out the column names to their LDAP ones to build the new entry.
948	$newentry = $this->_map_data($save_cols);
949	$newentry['objectClass'] = $this->prop['LDAP_Object_Classes'];
950
951	// Verify that the required fields are set.
952	$missing = null;
953	foreach ($this->prop['required_fields'] as $fld) {
954	if (!isset($newentry[$fld])) {
955	$missing[] = $fld;
956	}
957	}
958
959	// abort process if requiered fields are missing
960	// TODO: generate message saying which fields are missing
961	if ($missing) {
962	$this->set_error(self::ERROR_VALIDATE, 'formincomplete');
963	return false;
964	}
965
966	// Build the new entries DN.
967	$dn = $this->prop['LDAP_rdn'].'='.$this->_quote_string($newentry[$this->prop['LDAP_rdn']], true).','.$this->base_dn;
968
969	$this->_debug("C: Add [dn: $dn]: ".print_r($newentry, true));
970
971	$res = ldap_add($this->conn, $dn, $newentry);
972	if ($res === FALSE) {
973	$this->_debug("S: ".ldap_error($this->conn));
974	$this->set_error(self::ERROR_SAVING, 'errorsaving');
975	return false;
976	} // end if
977
978	$this->_debug("S: OK");
979
980	$dn = self::dn_encode($dn);
981
982	// add new contact to the selected group
983	if ($this->groups)
984	$this->add_to_group($this->group_id, $dn);
985
986	return $dn;
987	}
988
989
990	/**
991	* Update a specific contact record
992	*
993	* @param mixed Record identifier
994	* @param array Hash array with save data
995	*
996	* @return boolean True on success, False on error
997	*/
998	function update($id, $save_cols)
999	{
1000	$record = $this->get_record($id, true);
1001	$result = $this->get_result();
1002	$record = $result->first();
1003
1004	$newdata = array();
1005	$replacedata = array();
1006	$deletedata = array();
1007
1008	// flatten composite fields in $record
1009	if (is_array($record['address'])) {
1010	foreach ($record['address'] as $i => $struct) {
1011	foreach ($struct as $col => $val) {
1012	$record[$col][$i] = $val;
1013	}
1014	}
1015	}
1016
1017	foreach ($this->fieldmap as $col => $fld) {
1018	$val = $save_cols[$col];
1019	if ($fld) {
1020	// remove empty array values
1021	if (is_array($val))
1022	$val = array_filter($val);
1023	// The field does exist compare it to the ldap record.
1024	if ($record[$col] != $val) {
1025	// Changed, but find out how.
1026	if (!isset($record[$col])) {
1027	// Field was not set prior, need to add it.
1028	$newdata[$fld] = $val;
1029	} // end if
1030	elseif ($val == '') {
1031	// Field supplied is empty, verify that it is not required.
1032	if (!in_array($fld, $this->prop['required_fields'])) {
1033	// It is not, safe to clear.
1034	$deletedata[$fld] = $record[$col];
1035	} // end if
1036	} // end elseif
1037	else {
1038	// The data was modified, save it out.
1039	$replacedata[$fld] = $val;
1040	} // end else
1041	} // end if
1042	} // end if
1043	} // end foreach
1044
1045	$dn = self::dn_decode($id);
1046
1047	// Update the entry as required.
1048	if (!empty($deletedata)) {
1049	// Delete the fields.
1050	$this->_debug("C: Delete [dn: $dn]: ".print_r($deletedata, true));
1051	if (!ldap_mod_del($this->conn, $dn, $deletedata)) {
1052	$this->_debug("S: ".ldap_error($this->conn));
1053	$this->set_error(self::ERROR_SAVING, 'errorsaving');
1054	return false;
1055	}
1056	$this->_debug("S: OK");
1057	} // end if
1058
1059	if (!empty($replacedata)) {
1060	// Handle RDN change
1061	if ($replacedata[$this->prop['LDAP_rdn']]) {
1062	$newdn = $this->prop['LDAP_rdn'].'='
1063	.$this->_quote_string($replacedata[$this->prop['LDAP_rdn']], true)
1064	.','.$this->base_dn;
1065	if ($dn != $newdn) {
1066	$newrdn = $this->prop['LDAP_rdn'].'='
1067	.$this->_quote_string($replacedata[$this->prop['LDAP_rdn']], true);
1068	unset($replacedata[$this->prop['LDAP_rdn']]);
1069	}
1070	}
1071	// Replace the fields.
1072	if (!empty($replacedata)) {
1073	$this->_debug("C: Replace [dn: $dn]: ".print_r($replacedata, true));
1074	if (!ldap_mod_replace($this->conn, $dn, $replacedata)) {
1075	$this->_debug("S: ".ldap_error($this->conn));
1076	return false;
1077	}
1078	$this->_debug("S: OK");
1079	} // end if
1080	} // end if
1081
1082	if (!empty($newdata)) {
1083	// Add the fields.
1084	$this->_debug("C: Add [dn: $dn]: ".print_r($newdata, true));
1085	if (!ldap_mod_add($this->conn, $dn, $newdata)) {
1086	$this->_debug("S: ".ldap_error($this->conn));
1087	$this->set_error(self::ERROR_SAVING, 'errorsaving');
1088	return false;
1089	}
1090	$this->_debug("S: OK");
1091	} // end if
1092
1093	// Handle RDN change
1094	if (!empty($newrdn)) {
1095	$this->_debug("C: Rename [dn: $dn] [dn: $newrdn]");
1096	if (!ldap_rename($this->conn, $dn, $newrdn, NULL, TRUE)) {
1097	$this->_debug("S: ".ldap_error($this->conn));
1098	return false;
1099	}
1100	$this->_debug("S: OK");
1101
1102	$dn = self::dn_encode($dn);
1103	$newdn = self::dn_encode($newdn);
1104
1105	// change the group membership of the contact
1106	if ($this->groups)
1107	{
1108	$group_ids = $this->get_record_groups($dn);
1109	foreach ($group_ids as $group_id)
1110	{
1111	$this->remove_from_group($group_id, $dn);
1112	$this->add_to_group($group_id, $newdn);
1113	}
1114	}
1115
1116	return $newdn;
1117	}
1118
1119	return true;
1120	}
1121
1122
1123	/**
1124	* Mark one or more contact records as deleted
1125	*
1126	* @param array Record identifiers
1127	* @param boolean Remove record(s) irreversible (unsupported)
1128	*
1129	* @return boolean True on success, False on error
1130	*/
1131	function delete($ids, $force=true)
1132	{
1133	if (!is_array($ids)) {
1134	// Not an array, break apart the encoded DNs.
1135	$ids = explode(',', $ids);
1136	} // end if
1137
1138	foreach ($ids as $id) {
1139	$dn = self::dn_decode($id);
1140	$this->_debug("C: Delete [dn: $dn]");
1141	// Delete the record.
1142	$res = ldap_delete($this->conn, $dn);
1143	if ($res === FALSE) {
1144	$this->_debug("S: ".ldap_error($this->conn));
1145	$this->set_error(self::ERROR_SAVING, 'errorsaving');
1146	return false;
1147	} // end if
1148	$this->_debug("S: OK");
1149
1150	// remove contact from all groups where he was member
1151	if ($this->groups) {
1152	$dn = self::dn_encode($dn);
1153	$group_ids = $this->get_record_groups($dn);
1154	foreach ($group_ids as $group_id) {
1155	$this->remove_from_group($group_id, $dn);
1156	}
1157	}
1158	} // end foreach
1159
1160	return count($ids);
1161	}
1162
1163
1164	/**
1165	* Execute the LDAP search based on the stored credentials
1166	*/
1167	private function _exec_search($count = false)
1168	{
1169	if ($this->ready)
1170	{
1171	$filter = $this->filter ? $this->filter : '(objectclass=*)';
1172	$function = $this->_scope2func($this->prop['scope'], $ns_function);
1173
1174	$this->_debug("C: Search [$filter][dn: $this->base_dn]");
1175
1176	// when using VLV, we get the total count by...
1177	if (!$count && $function != 'ldap_read' && $this->prop['vlv'] && !$this->group_id) {
1178	// ...either reading numSubOrdinates attribute
1179	if ($this->prop['numsub_filter'] && ($result_count = @$ns_function($this->conn, $this->base_dn, $this->prop['numsub_filter'], array('numSubOrdinates'), 0, 0, 0))) {
1180	$counts = ldap_get_entries($this->conn, $result_count);
1181	for ($this->vlv_count = $j = 0; $j < $counts['count']; $j++)
1182	$this->vlv_count += $counts[$j]['numsubordinates'][0];
1183	$this->_debug("D: total numsubordinates = " . $this->vlv_count);
1184	}
1185	else // ...or by fetching all records dn and count them
1186	$this->vlv_count = $this->_exec_search(true);
1187
1188	$this->vlv_active = $this->_vlv_set_controls($this->prop, $this->list_page, $this->page_size);
1189	}
1190
1191	// only fetch dn for count (should keep the payload low)
1192	$attrs = $count ? array('dn') : array_values($this->fieldmap);
1193	if ($this->ldap_result = @$function($this->conn, $this->base_dn, $filter,
1194	$attrs, 0, (int)$this->prop['sizelimit'], (int)$this->prop['timelimit']))
1195	{
1196	$this->_debug("S: ".ldap_count_entries($this->conn, $this->ldap_result)." record(s)");
1197	if ($err = ldap_errno($this->conn))
1198	$this->_debug("S: Error: " .ldap_err2str($err));
1199	return $count ? ldap_count_entries($this->conn, $this->ldap_result) : true;
1200	}
1201	else
1202	{
1203	$this->_debug("S: ".ldap_error($this->conn));
1204	}
1205	}
1206
1207	return false;
1208	}
1209
1210	/**
1211	* Choose the right PHP function according to scope property
1212	*/
1213	private function _scope2func($scope, &$ns_function = null)
1214	{
1215	switch ($scope) {
1216	case 'sub':
1217	$function = $ns_function = 'ldap_search';
1218	break;
1219	case 'base':
1220	$function = $ns_function = 'ldap_read';
1221	break;
1222	default:
1223	$function = 'ldap_list';
1224	$ns_function = 'ldap_read';
1225	break;
1226	}
1227
1228	return $function;
1229	}
1230
1231	/**
1232	* Set server controls for Virtual List View (paginated listing)
1233	*/
1234	private function _vlv_set_controls($prop, $list_page, $page_size, $search = null)
1235	{
1236	$sort_ctrl = array('oid' => "1.2.840.113556.1.4.473", 'value' => $this->_sort_ber_encode((array)$prop['sort']));
1237	$vlv_ctrl = array('oid' => "2.16.840.1.113730.3.4.9", 'value' => $this->_vlv_ber_encode(($offset = ($list_page-1) * $page_size + 1), $page_size, $search), 'iscritical' => true);
1238
1239	$sort = (array)$prop['sort'];
1240	$this->_debug("C: set controls sort=" . join(' ', unpack('H'.(strlen($sort_ctrl['value'])*2), $sort_ctrl['value'])) . " ($sort[0]);"
1241	. " vlv=" . join(' ', (unpack('H'.(strlen($vlv_ctrl['value'])*2), $vlv_ctrl['value']))) . " ($offset/$page_size)");
1242
1243	if (!ldap_set_option($this->conn, LDAP_OPT_SERVER_CONTROLS, array($sort_ctrl, $vlv_ctrl))) {
1244	$this->_debug("S: ".ldap_error($this->conn));
1245	$this->set_error(self::ERROR_SEARCH, 'vlvnotsupported');
1246	return false;
1247	}
1248
1249	return true;
1250	}
1251
1252
1253	/**
1254	* Converts LDAP entry into an array
1255	*/
1256	private function _ldap2result($rec)
1257	{
1258	$out = array();
1259
1260	if ($rec['dn'])
1261	$out[$this->primary_key] = self::dn_encode($rec['dn']);
1262
1263	foreach ($this->fieldmap as $rf => $lf)
1264	{
1265	for ($i=0; $i < $rec[$lf]['count']; $i++) {
1266	if (!($value = $rec[$lf][$i]))
1267	continue;
1268	if ($rf == 'email' && $this->mail_domain && !strpos($value, '@'))
1269	$out[$rf][] = sprintf('%s@%s', $value, $this->mail_domain);
1270	else if (in_array($rf, array('street','zipcode','locality','country','region')))
1271	$out['address'][$i][$rf] = $value;
1272	else if ($rec[$lf]['count'] > 1)
1273	$out[$rf][] = $value;
1274	else
1275	$out[$rf] = $value;
1276	}
1277
1278	// Make sure name fields aren't arrays (#1488108)
1279	if (is_array($out[$rf]) && in_array($rf, array('name', 'surname', 'firstname', 'middlename', 'nickname'))) {
1280	$out[$rf] = $out[$rf][0];
1281	}
1282	}
1283
1284	return $out;
1285	}
1286
1287
1288	/**
1289	* Return real field name (from fields map)
1290	*/
1291	private function _map_field($field)
1292	{
1293	return $this->fieldmap[$field];
1294	}
1295
1296
1297	/**
1298	* Convert a record data set into LDAP field attributes
1299	*/
1300	private function _map_data($save_cols)
1301	{
1302	$ldap_data = array();
1303	foreach ($this->fieldmap as $col => $fld) {
1304	$val = $save_cols[$col];
1305	if (is_array($val))
1306	$val = array_filter($val); // remove empty entries
1307	if ($fld && $val) {
1308	// The field does exist, add it to the entry.
1309	$ldap_data[$fld] = $val;
1310	}
1311	}
1312
1313	return $ldap_data;
1314	}
1315
1316
1317	/**
1318	* Returns unified attribute name (resolving aliases)
1319	*/
1320	private static function _attr_name($name)
1321	{
1322	// list of known attribute aliases
1323	$aliases = array(
1324	'gn' => 'givenname',
1325	'rfc822mailbox' => 'email',
1326	'userid' => 'uid',
1327	'emailaddress' => 'email',
1328	'pkcs9email' => 'email',
1329	);
1330	return isset($aliases[$name]) ? $aliases[$name] : $name;
1331	}
1332
1333
1334	/**
1335	* Prints debug info to the log
1336	*/
1337	private function _debug($str)
1338	{
1339	if ($this->debug)
1340	write_log('ldap', $str);
1341	}
1342
1343
1344	/**
1345	* Quotes attribute value string
1346	*
1347	* @param string $str Attribute value
1348	* @param bool $dn True if the attribute is a DN
1349	*
1350	* @return string Quoted string
1351	*/
1352	private static function _quote_string($str, $dn=false)
1353	{
1354	// take firt entry if array given
1355	if (is_array($str))
1356	$str = reset($str);
1357
1358	if ($dn)
1359	$replace = array(','=>'\2c', '='=>'\3d', '+'=>'\2b', '<'=>'\3c',
1360	'>'=>'\3e', ';'=>'\3b', '\\'=>'\5c', '"'=>'\22', '#'=>'\23');
1361	else
1362	$replace = array('*'=>'\2a', '('=>'\28', ')'=>'\29', '\\'=>'\5c',
1363	'/'=>'\2f');
1364
1365	return strtr($str, $replace);
1366	}
1367
1368
1369	/**
1370	* Setter for the current group
1371	* (empty, has to be re-implemented by extending class)
1372	*/
1373	function set_group($group_id)
1374	{
1375	if ($group_id)
1376	{
1377	if (($group_cache = $this->cache->get('groups')) === null)
1378	$group_cache = $this->_fetch_groups();
1379
1380	$this->group_id = $group_id;
1381	$this->group_data = $group_cache[$group_id];
1382	}
1383	else
1384	{
1385	$this->group_id = 0;
1386	$this->group_data = null;
1387	}
1388	}
1389
1390	/**
1391	* List all active contact groups of this source
1392	*
1393	* @param string Optional search string to match group name
1394	* @return array Indexed list of contact groups, each a hash array
1395	*/
1396	function list_groups($search = null)
1397	{
1398	if (!$this->groups)
1399	return array();
1400
1401	// use cached list for searching
1402	$this->cache->expunge();
1403	if (!$search \|\| ($group_cache = $this->cache->get('groups')) === null)
1404	$group_cache = $this->_fetch_groups();
1405
1406	$groups = array();
1407	if ($search) {
1408	$search = strtolower($search);
1409	foreach ($group_cache as $group) {
1410	if (strstr(strtolower($group['name']), $search))
1411	$groups[] = $group;
1412	}
1413	}
1414	else
1415	$groups = $group_cache;
1416
1417	return array_values($groups);
1418	}
1419
1420	/**
1421	* Fetch groups from server
1422	*/
1423	private function _fetch_groups($vlv_page = 0)
1424	{
1425	$base_dn = $this->groups_base_dn;
1426	$filter = $this->prop['groups']['filter'];
1427	$name_attr = $this->prop['groups']['name_attr'];
1428	$email_attr = $this->prop['groups']['email_attr'] ? $this->prop['groups']['email_attr'] : 'mail';
1429	$sort_attrs = $this->prop['groups']['sort'] ? (array)$this->prop['groups']['sort'] : array($name_attr);
1430	$sort_attr = $sort_attrs[0];
1431
1432	$this->_debug("C: Search [$filter][dn: $base_dn]");
1433
1434	// use vlv to list groups
1435	if ($this->prop['groups']['vlv']) {
1436	$page_size = 200;
1437	if (!$this->prop['groups']['sort'])
1438	$this->prop['groups']['sort'] = $sort_attrs;
1439	$vlv_active = $this->_vlv_set_controls($this->prop['groups'], $vlv_page+1, $page_size);
1440	}
1441
1442	$function = $this->_scope2func($this->prop['groups']['scope'], $ns_function);
1443	$res = @$function($this->conn, $base_dn, $filter, array_unique(array('dn', 'objectClass', $name_attr, $email_attr, $sort_attr)));
1444	if ($res === false)
1445	{
1446	$this->_debug("S: ".ldap_error($this->conn));
1447	return array();
1448	}
1449
1450	$ldap_data = ldap_get_entries($this->conn, $res);
1451	$this->_debug("S: ".ldap_count_entries($this->conn, $res)." record(s)");
1452
1453	$groups = array();
1454	$group_sortnames = array();
1455	$group_count = $ldap_data["count"];
1456	for ($i=0; $i < $group_count; $i++)
1457	{
1458	$group_name = is_array($ldap_data[$i][$name_attr]) ? $ldap_data[$i][$name_attr][0] : $ldap_data[$i][$name_attr];
1459	$group_id = self::dn_encode($group_name);
1460	$groups[$group_id]['ID'] = $group_id;
1461	$groups[$group_id]['dn'] = $ldap_data[$i]['dn'];
1462	$groups[$group_id]['name'] = $group_name;
1463	$groups[$group_id]['member_attr'] = $this->prop['member_attr'];
1464
1465	// check objectClass attributes of group and act accordingly
1466	for ($j=0; $j < $ldap_data[$i]['objectclass']['count']; $j++) {
1467	switch (strtolower($ldap_data[$i]['objectclass'][$j])) {
1468	case 'groupofnames':
1469	case 'kolabgroupofnames':
1470	$groups[$group_id]['member_attr'] = 'member';
1471	break;
1472
1473	case 'groupofuniquenames':
1474	case 'kolabgroupofuniquenames':
1475	$groups[$group_id]['member_attr'] = 'uniqueMember';
1476	break;
1477	}
1478	}
1479
1480	// list email attributes of a group
1481	for ($j=0; $ldap_data[$i][$email_attr] && $j < $ldap_data[$i][$email_attr]['count']; $j++) {
1482	if (strpos($ldap_data[$i][$email_attr][$j], '@') > 0)
1483	$groups[$group_id]['email'][] = $ldap_data[$i][$email_attr][$j];
1484	}
1485
1486	$group_sortnames[] = strtolower($ldap_data[$i][$sort_attr][0]);
1487	}
1488
1489	// recursive call can exit here
1490	if ($vlv_page > 0)
1491	return $groups;
1492
1493	// call recursively until we have fetched all groups
1494	while ($vlv_active && $group_count == $page_size)
1495	{
1496	$next_page = $this->_fetch_groups(++$vlv_page);
1497	$groups = array_merge($groups, $next_page);
1498	$group_count = count($next_page);
1499	}
1500
1501	// when using VLV the list of groups is already sorted
1502	if (!$this->prop['groups']['vlv'])
1503	array_multisort($group_sortnames, SORT_ASC, SORT_STRING, $groups);
1504
1505	// cache this
1506	$this->cache->set('groups', $groups);
1507
1508	return $groups;
1509	}
1510
1511	/**
1512	* Get group properties such as name and email address(es)
1513	*
1514	* @param string Group identifier
1515	* @return array Group properties as hash array
1516	*/
1517	function get_group($group_id)
1518	{
1519	if (($group_cache = $this->cache->get('groups')) === null)
1520	$group_cache = $this->_fetch_groups();
1521
1522	$group_data = $group_cache[$group_id];
1523	unset($group_data['dn'], $group_data['member_attr']);
1524
1525	return $group_data;
1526	}
1527
1528	/**
1529	* Create a contact group with the given name
1530	*
1531	* @param string The group name
1532	* @return mixed False on error, array with record props in success
1533	*/
1534	function create_group($group_name)
1535	{
1536	$base_dn = $this->groups_base_dn;
1537	$new_dn = "cn=$group_name,$base_dn";
1538	$new_gid = self::dn_encode($group_name);
1539	$name_attr = $this->prop['groups']['name_attr'];
1540
1541	$new_entry = array(
1542	'objectClass' => $this->prop['groups']['object_classes'],
1543	$name_attr => $group_name,
1544	);
1545
1546	$this->_debug("C: Add [dn: $new_dn]: ".print_r($new_entry, true));
1547
1548	$res = ldap_add($this->conn, $new_dn, $new_entry);
1549	if ($res === false)
1550	{
1551	$this->_debug("S: ".ldap_error($this->conn));
1552	$this->set_error(self::ERROR_SAVING, 'errorsaving');
1553	return false;
1554	}
1555
1556	$this->_debug("S: OK");
1557	$this->cache->remove('groups');
1558
1559	return array('id' => $new_gid, 'name' => $group_name);
1560	}
1561
1562	/**
1563	* Delete the given group and all linked group members
1564	*
1565	* @param string Group identifier
1566	* @return boolean True on success, false if no data was changed
1567	*/
1568	function delete_group($group_id)
1569	{
1570	if (($group_cache = $this->cache->get('groups')) === null)
1571	$group_cache = $this->_fetch_groups();
1572
1573	$base_dn = $this->groups_base_dn;
1574	$group_name = $group_cache[$group_id]['name'];
1575	$del_dn = "cn=$group_name,$base_dn";
1576
1577	$this->_debug("C: Delete [dn: $del_dn]");
1578
1579	$res = ldap_delete($this->conn, $del_dn);
1580	if ($res === false)
1581	{
1582	$this->_debug("S: ".ldap_error($this->conn));
1583	$this->set_error(self::ERROR_SAVING, 'errorsaving');
1584	return false;
1585	}
1586
1587	$this->_debug("S: OK");
1588	$this->cache->remove('groups');
1589
1590	return true;
1591	}
1592
1593	/**
1594	* Rename a specific contact group
1595	*
1596	* @param string Group identifier
1597	* @param string New name to set for this group
1598	* @param string New group identifier (if changed, otherwise don't set)
1599	* @return boolean New name on success, false if no data was changed
1600	*/
1601	function rename_group($group_id, $new_name, &$new_gid)
1602	{
1603	if (($group_cache = $this->cache->get('groups')) === null)
1604	$group_cache = $this->_fetch_groups();
1605
1606	$base_dn = $this->groups_base_dn;
1607	$group_name = $group_cache[$group_id]['name'];
1608	$old_dn = "cn=$group_name,$base_dn";
1609	$new_rdn = "cn=$new_name";
1610	$new_gid = self::dn_encode($new_name);
1611
1612	$this->_debug("C: Rename [dn: $old_dn] [dn: $new_rdn]");
1613
1614	$res = ldap_rename($this->conn, $old_dn, $new_rdn, NULL, TRUE);
1615	if ($res === false)
1616	{
1617	$this->_debug("S: ".ldap_error($this->conn));
1618	$this->set_error(self::ERROR_SAVING, 'errorsaving');
1619	return false;
1620	}
1621
1622	$this->_debug("S: OK");
1623	$this->cache->remove('groups');
1624
1625	return $new_name;
1626	}
1627
1628	/**
1629	* Add the given contact records the a certain group
1630	*
1631	* @param string Group identifier
1632	* @param array List of contact identifiers to be added
1633	* @return int Number of contacts added
1634	*/
1635	function add_to_group($group_id, $contact_ids)
1636	{
1637	if (($group_cache = $this->cache->get('groups')) === null)
1638	$group_cache = $this->_fetch_groups();
1639
1640	$base_dn = $this->groups_base_dn;
1641	$group_name = $group_cache[$group_id]['name'];
1642	$member_attr = $group_cache[$group_id]['member_attr'];
1643	$group_dn = "cn=$group_name,$base_dn";
1644
1645	$new_attrs = array();
1646	foreach (explode(",", $contact_ids) as $id)
1647	$new_attrs[$member_attr][] = self::dn_decode($id);
1648
1649	$this->_debug("C: Add [dn: $group_dn]: ".print_r($new_attrs, true));
1650
1651	$res = ldap_mod_add($this->conn, $group_dn, $new_attrs);
1652	if ($res === false)
1653	{
1654	$this->_debug("S: ".ldap_error($this->conn));
1655	$this->set_error(self::ERROR_SAVING, 'errorsaving');
1656	return 0;
1657	}
1658
1659	$this->_debug("S: OK");
1660	$this->cache->remove('groups');
1661
1662	return count($new_attrs['member']);
1663	}
1664
1665	/**
1666	* Remove the given contact records from a certain group
1667	*
1668	* @param string Group identifier
1669	* @param array List of contact identifiers to be removed
1670	* @return int Number of deleted group members
1671	*/
1672	function remove_from_group($group_id, $contact_ids)
1673	{
1674	if (($group_cache = $this->cache->get('groups')) === null)
1675	$group_cache = $this->_fetch_groups();
1676
1677	$base_dn = $this->groups_base_dn;
1678	$group_name = $group_cache[$group_id]['name'];
1679	$member_attr = $group_cache[$group_id]['member_attr'];
1680	$group_dn = "cn=$group_name,$base_dn";
1681
1682	$del_attrs = array();
1683	foreach (explode(",", $contact_ids) as $id)
1684	$del_attrs[$member_attr][] = self::dn_decode($id);
1685
1686	$this->_debug("C: Delete [dn: $group_dn]: ".print_r($del_attrs, true));
1687
1688	$res = ldap_mod_del($this->conn, $group_dn, $del_attrs);
1689	if ($res === false)
1690	{
1691	$this->_debug("S: ".ldap_error($this->conn));
1692	$this->set_error(self::ERROR_SAVING, 'errorsaving');
1693	return 0;
1694	}
1695
1696	$this->_debug("S: OK");
1697	$this->cache->remove('groups');
1698
1699	return count($del_attrs['member']);
1700	}
1701
1702	/**
1703	* Get group assignments of a specific contact record
1704	*
1705	* @param mixed Record identifier
1706	*
1707	* @return array List of assigned groups as ID=>Name pairs
1708	* @since 0.5-beta
1709	*/
1710	function get_record_groups($contact_id)
1711	{
1712	if (!$this->groups)
1713	return array();
1714
1715	$base_dn = $this->groups_base_dn;
1716	$contact_dn = self::dn_decode($contact_id);
1717	$name_attr = $this->prop['groups']['name_attr'];
1718	$member_attr = $this->prop['member_attr'];
1719	$add_filter = '';
1720	if ($member_attr != 'member' && $member_attr != 'uniqueMember')
1721	$add_filter = "($member_attr=$contact_dn)";
1722	$filter = strtr("(\|(member=$contact_dn)(uniqueMember=$contact_dn)$add_filter)", array('\\' => '\\\\'));
1723
1724	$this->_debug("C: Search [$filter][dn: $base_dn]");
1725
1726	$res = @ldap_search($this->conn, $base_dn, $filter, array($name_attr));
1727	if ($res === false)
1728	{
1729	$this->_debug("S: ".ldap_error($this->conn));
1730	return array();
1731	}
1732	$ldap_data = ldap_get_entries($this->conn, $res);
1733	$this->_debug("S: ".ldap_count_entries($this->conn, $res)." record(s)");
1734
1735	$groups = array();
1736	for ($i=0; $i<$ldap_data["count"]; $i++)
1737	{
1738	$group_name = $ldap_data[$i][$name_attr][0];
1739	$group_id = self::dn_encode($group_name);
1740	$groups[$group_id] = $group_id;
1741	}
1742	return $groups;
1743	}
1744
1745
1746	/**
1747	* Generate BER encoded string for Virtual List View option
1748	*
1749	* @param integer List offset (first record)
1750	* @param integer Records per page
1751	* @return string BER encoded option value
1752	*/
1753	private function _vlv_ber_encode($offset, $rpp, $search = '')
1754	{
1755	# this string is ber-encoded, php will prefix this value with:
1756	# 04 (octet string) and 10 (length of 16 bytes)
1757	# the code behind this string is broken down as follows:
1758	# 30 = ber sequence with a length of 0e (14) bytes following
1759	# 02 = type integer (in two's complement form) with 2 bytes following (beforeCount): 01 00 (ie 0)
1760	# 02 = type integer (in two's complement form) with 2 bytes following (afterCount): 01 18 (ie 25-1=24)
1761	# a0 = type context-specific/constructed with a length of 06 (6) bytes following
1762	# 02 = type integer with 2 bytes following (offset): 01 01 (ie 1)
1763	# 02 = type integer with 2 bytes following (contentCount): 01 00
1764
1765	# whith a search string present:
1766	# 81 = type context-specific/constructed with a length of 04 (4) bytes following (the length will change here)
1767	# 81 indicates a user string is present where as a a0 indicates just a offset search
1768	# 81 = type context-specific/constructed with a length of 06 (6) bytes following
1769
1770	# the following info was taken from the ISO/IEC 8825-1:2003 x.690 standard re: the
1771	# encoding of integer values (note: these values are in
1772	# two-complement form so since offset will never be negative bit 8 of the
1773	# leftmost octet should never by set to 1):
1774	# 8.3.2: If the contents octets of an integer value encoding consist
1775	# of more than one octet, then the bits of the first octet (rightmost) and bit 8
1776	# of the second (to the left of first octet) octet:
1777	# a) shall not all be ones; and
1778	# b) shall not all be zero
1779
1780	if ($search)
1781	{
1782	$search = preg_replace('/[^-[:alpha:] ,.()0-9]+/', '', $search);
1783	$ber_val = self::_string2hex($search);
1784	$str = self::_ber_addseq($ber_val, '81');
1785	}
1786	else
1787	{
1788	# construct the string from right to left
1789	$str = "020100"; # contentCount
1790
1791	$ber_val = self::_ber_encode_int($offset); // returns encoded integer value in hex format
1792
1793	// calculate octet length of $ber_val
1794	$str = self::_ber_addseq($ber_val, '02') . $str;
1795
1796	// now compute length over $str
1797	$str = self::_ber_addseq($str, 'a0');
1798	}
1799
1800	// now tack on records per page
1801	$str = "020100" . self::_ber_addseq(self::_ber_encode_int($rpp-1), '02') . $str;
1802
1803	// now tack on sequence identifier and length
1804	$str = self::_ber_addseq($str, '30');
1805
1806	return pack('H'.strlen($str), $str);
1807	}
1808
1809
1810	/**
1811	* create ber encoding for sort control
1812	*
1813	* @param array List of cols to sort by
1814	* @return string BER encoded option value
1815	*/
1816	private function _sort_ber_encode($sortcols)
1817	{
1818	$str = '';
1819	foreach (array_reverse((array)$sortcols) as $col) {
1820	$ber_val = self::_string2hex($col);
1821
1822	# 30 = ber sequence with a length of octet value
1823	# 04 = octet string with a length of the ascii value
1824	$oct = self::_ber_addseq($ber_val, '04');
1825	$str = self::_ber_addseq($oct, '30') . $str;
1826	}
1827
1828	// now tack on sequence identifier and length
1829	$str = self::_ber_addseq($str, '30');
1830
1831	return pack('H'.strlen($str), $str);
1832	}
1833
1834	/**
1835	* Add BER sequence with correct length and the given identifier
1836	*/
1837	private static function _ber_addseq($str, $identifier)
1838	{
1839	$len = dechex(strlen($str)/2);
1840	if (strlen($len) % 2 != 0)
1841	$len = '0'.$len;
1842
1843	return $identifier . $len . $str;
1844	}
1845
1846	/**
1847	* Returns BER encoded integer value in hex format
1848	*/
1849	private static function _ber_encode_int($offset)
1850	{
1851	$val = dechex($offset);
1852	$prefix = '';
1853
1854	// check if bit 8 of high byte is 1
1855	if (preg_match('/^[89abcdef]/', $val))
1856	$prefix = '00';
1857
1858	if (strlen($val)%2 != 0)
1859	$prefix .= '0';
1860
1861	return $prefix . $val;
1862	}
1863
1864	/**
1865	* Returns ascii string encoded in hex
1866	*/
1867	private static function _string2hex($str)
1868	{
1869	$hex = '';
1870	for ($i=0; $i < strlen($str); $i++)
1871	$hex .= dechex(ord($str[$i]));
1872	return $hex;
1873	}
1874
1875	/**
1876	* HTML-safe DN string encoding
1877	*
1878	* @param string $str DN string
1879	*
1880	* @return string Encoded HTML identifier string
1881	*/
1882	static function dn_encode($str)
1883	{
1884	// @TODO: to make output string shorter we could probably
1885	// remove dc=* items from it
1886	return rtrim(strtr(base64_encode($str), '+/', '-_'), '=');
1887	}
1888
1889	/**
1890	* Decodes DN string encoded with _dn_encode()
1891	*
1892	* @param string $str Encoded HTML identifier string
1893	*
1894	* @return string DN string
1895	*/
1896	static function dn_decode($str)
1897	{
1898	$str = str_pad(strtr($str, '-_', '+/'), strlen($str) % 4, '=', STR_PAD_RIGHT);
1899	return base64_decode($str);
1900	}
1901	}

Note: See TracBrowser for help on using the repository browser.

Download in other formats: