Blame view

sources/apps/contacts/lib/backend/ldap.php 24 KB
d1bafeea1   Kload   [fix] Upgrade to ...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
  <?php
  /**
   * ownCloud - Base class for Contacts backends
   *
   * @author Nicolas Mora
   * @copyright 2013 Nicolas Mora (mail@babelouest.org)
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
   * License as published by the Free Software Foundation; either
   * version 3 of the License, or any later version.
   *
   * This library is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the
   * GNU AFFERO GENERAL PUBLIC LICENSE for more details.
   *
   * You should have received a copy of the GNU Affero General Public
   * License along with this library.	If not, see <http://www.gnu.org/licenses/>.
   *
   */
  
  namespace OCA\Contacts\Backend;
  
  use OCA\Contacts\Contact;
  use OCA\Contacts\VObject\VCard;
  use Sabre\VObject\Reader;
  use OCA\Contacts\Connector\LdapConnector;
  
  /**
   * Subclass this class for Cantacts backends
   */
  
  class Ldap extends AbstractBackend {
  
  	/**
  	 * The name of the backend.
  	 * @var string
  	 */
  	public $name='ldap';
d1bafeea1   Kload   [fix] Upgrade to ...
41
42
43
44
  	private $ldapConnection = null;
  	private $connector = null;
  	
  	/**
6d9380f96   Cédric Dupont   Update sources OC...
45
46
47
48
49
50
  	 * The cached address books.
  	 * @var array[]
  	 */
  	public $addressbooks;
  
  	/**
d1bafeea1   Kload   [fix] Upgrade to ...
51
52
53
54
55
56
57
  	* @brief validates and sets the ldap parameters
  	* @param $ldapParams array containing the parameters
  	* return boolean
  	*/
  	public function setLdapParams($aid) {
  		$tmp = $this->getPreferences($aid);
  		if ($tmp != false) {
6d9380f96   Cédric Dupont   Update sources OC...
58
  			$this->ldapParams = (array)$tmp;
d1bafeea1   Kload   [fix] Upgrade to ...
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
  			$this->connector = new LdapConnector($this->ldapParams['ldap_vcard_connector']);
  			return true;
  		} else {
  			return false;
  		}
  	}
  
  
  	/**
  	 * @brief creates the ldap connection, then binds it according to the parameters previously given
  	 * @return boolean connexion status
  	 */
  	public function ldapCreateAndBindConnection() {
  		if (!self::ldapIsConnected() && $this->ldapParams != null) {
  			// ldap connect
  			$this->ldapConnection = ldap_connect($this->ldapParams['ldapurl']);
  			ldap_set_option($this->ldapConnection, LDAP_OPT_REFERRALS, 0);
  			ldap_set_option($this->ldapConnection, LDAP_OPT_PROTOCOL_VERSION, 3);
  			if ($this->ldapConnection) {
  				// ldap bind
  				if ($this->ldapParams['ldapanonymous'] == 1) {
  					$ldapbind = ldap_bind($this->ldapConnection);
  				} else {
  					$ldapbind = ldap_bind($this->ldapConnection, $this->ldapParams['ldapuser'], base64_decode($this->ldapParams['ldappass']));
  				}
  				return $ldapbind;
  			}
  			return false;
  		}
  		return self::ldapIsConnected();
  	}
  	
  	/**
  	 * @brief close the current connection
  	 * @return boolean closing success
  	 */
  	public function ldapCloseConnection() {
  		if (self::ldapIsConnected()) {
  			ldap_unbind($this->ldapConnection);
  			$this->ldapConnection = null;
  			return true;
  		}
  	}
  	
  	/**
  	 * 
  	 */
  	public function ldapIsConnected() {
  		return ($this->ldapConnection != null);
  	}
  	
  	/**
  	 * @brief search a list in ldap server
  	 * @param $ldapbasedn the base dn
  	 * @param $bindsearch the search filter
  	 * @param $entries the ldap entries to reach
  	 * @param $start the starting point
  	 * @param $num the number of entries to return
  	 * @return array|false
  	 */
  	public function ldapFindMultiple($ldapbasedn, $bindsearch, $entriesName, $start=null, $num=null) {
  		if (($entriesName != null) && self::ldapCreateAndBindConnection() && $ldapbasedn != null && $bindsearch != null) {
  			
  			if ($start==null) {
  				$start=0;
  			}
  			
  			if ($num==null) {
  				$num=PHP_INT_MAX;
  			}
  			
  			$pageSize = isset($this->ldapParams['ldappagesize'])?$this->ldapParams['ldappagesize']:"20";
  
  			$cookie = '';
  			
  			$entries = array();
  			
  			$cpt=0;
  			
  			\OC_Log::write('contacts_ldap', __METHOD__." - search what $ldapbasedn, $bindsearch $pageSize", \OC_Log::DEBUG);
  			do {
  				
  				ldap_control_paged_result($this->ldapConnection, $pageSize, true, $cookie);
  				$ldap_results = ldap_search ($this->ldapConnection, $ldapbasedn, $bindsearch, $entriesName);
  				
  				$LdapEntries = ldap_get_entries ($this->ldapConnection, $ldap_results);
  				
  				for ($i=0; $i<$LdapEntries['count']; $i++) {
  					$entries[] = $LdapEntries[$i];
  				}
  				ldap_control_paged_result_response($this->ldapConnection, $ldap_results, $cookie);
  
  				$cpt++;
  			} while($cookie !== null && $cookie != '' && $cpt < 10);
  			
  			$entries['count'] = count($entries);
  			
  			return $entries;
  
  			self::ldapCloseConnection();
  		}
  		return false;
  	}
  	
  	
  	/**
  	* @brief search one contact in ldap server
  	* @param $ldapbasedn the base dn
  	* @param $bindsearch the search filter
  	* @param $entries the ldap entries to reach
  	* @param $start the starting point
  	* @param $num the number of entries to return
  	* @return array|false
  	*/
  	public function ldapFindOne($ldapbasedn, $bindsearch, $entries, $start=null, $num=null) {
  		if (($entries != null) && self::ldapCreateAndBindConnection() && $ldapbasedn != null && $bindsearch != null) {
  
  			if ($start==null) {
  				$start=0;
  			}
  
  			if ($num==null) {
  				$num=PHP_INT_MAX;
  			}
6d9380f96   Cédric Dupont   Update sources OC...
183
  			\OC_Log::write('contacts_ldap', __METHOD__." - search $ldapbasedn, $bindsearch ", \OC_Log::DEBUG);
d1bafeea1   Kload   [fix] Upgrade to ...
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
  
  			$ldap_results = @ldap_search ($this->ldapConnection, $ldapbasedn, $bindsearch, $entries);
  			if ($ldap_results) {
  				$entries = ldap_get_entries ($this->ldapConnection, $ldap_results);
  				if ($entries['count'] > 0) {
  					return $entries[0];
  				} else {
  					return false;
  				}
  			}
  
  			self::ldapCloseConnection();
  		}
  		return false;
  	}
  
  	/**
  	 * @brief adds a new ldap entry
  	 * @param $ldapDN the new DN (must be unique)
  	 * @param $ldapValues the ldif values
  	 * @return boolean insert status
  	 */
  	public function ldapAdd($ldapDN, $ldapValues) {
  		if (self::ldapIsConnected()) {
  			return @ldap_add($this->ldapConnection, $ldapDN, $ldapValues);
  		}
  		return false;
  	}
  	
  	/**
  	 * @brief modify a ldap entry
  	 * @param $ldapDN the DN (must exists)
  	 * @param $ldapValues the ldif values
  	 * @return boolean modify status
  	 */
  	public function ldapUpdate($ldapDN, $ldapValues) {
  		if (self::ldapIsConnected()) {
6d9380f96   Cédric Dupont   Update sources OC...
221
  			return @ldap_modify($this->ldapConnection, $ldapDN, $ldapValues);
d1bafeea1   Kload   [fix] Upgrade to ...
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
  		}
  		return false;
  	}
  	
  	/**
  	 * @brief delete a ldap entry
  	 * @param $ldapDN the DN (must exists)
  	 * @return boolean delete status
  	 */
  	public function ldapDelete($ldapDN) {
  		if (self::ldapIsConnected()) {
  			ldap_delete($this->ldapConnection, $ldapDN);
  			return true;
  		}
  		return false;
  	}
  	
  	/**
  	* Sets up the backend
  	*
  	* @param string $cardsTableName
  	*/
  	public function __construct(
  		$userid = null,
  		$addressBooksTableName = '*PREFIX*contacts_ldap_addressbooks'
  	) {
  		$this->userid = $userid ? $userid : \OCP\User::getUser();
  		$this->addressbooks = array();
  	}
  
  	/**
  	 * Returns the list of active addressbooks for a specific user.
   	 *
  	 * @param string $userid
  	 * @return array
  	 */
  	public function getAddressBooksForUser(array $options = array()) {
6d9380f96   Cédric Dupont   Update sources OC...
259
260
261
  		$addressbookidList = $this->getAddressbookList();
  		foreach($addressbookidList as $addressbookid) {
  			$this->addressbooks[] = self::getAddressBook($addressbookid);
d1bafeea1   Kload   [fix] Upgrade to ...
262
  		}
6d9380f96   Cédric Dupont   Update sources OC...
263
  		return $this->addressbooks;
d1bafeea1   Kload   [fix] Upgrade to ...
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
  	}
  
  	/**
  	 * Get an addressbook's properties
  	 *
  	 * The returned array MUST contain 'displayname' and an integer 'permissions'
  	 * value using there ownCloud CRUDS constants (which MUST be at least
  	 * \OCP\PERMISSION_READ).
  	 * Currently the only ones supported are 'displayname' and
  	 * 'description', but backends can implement additional.
  	 *
  	 * @param string $addressbookid
  	 * @return array $properties
  	 */
  	public function getAddressBook($addressbookid, array $options = array()) {
  		//\OC_Log::write('contacts', __METHOD__.' id: '
  		//	. $addressbookid, \OC_Log::DEBUG);
  		if($this->addressbooks && isset($this->addressbooks[$addressbookid])) {
  			//print(__METHOD__ . ' ' . __LINE__ .' addressBookInfo: ' . print_r($this->addressbooks[$addressbookid], true));
  			return $this->addressbooks[$addressbookid];
  		}
  		// Hmm, not found. Lets query the db.
  		$preferences = self::getPreferences($addressbookid);
6d9380f96   Cédric Dupont   Update sources OC...
287
288
289
290
291
292
293
294
295
296
297
298
299
  		if (count($preferences) > 0) {
  			$preferences['id'] = (string)$addressbookid;
  			$preferences['backend'] = $this->name;
  			$preferences['owner'] = $this->userid;
  			$preferences['permissions'] = \OCP\PERMISSION_ALL;
  			$preferences['lastmodified'] = self::lastModifiedAddressBook($addressbookid);
  			
  			// remove the ldappassword from the return value if exists
  			if (isset($preferences['ldappass']) && (isset($options['getpwd']) && !$options['getpwd'])) {
  				unset($preferences['ldappass']);
  			}
  			
  			return $preferences;
d1bafeea1   Kload   [fix] Upgrade to ...
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
  		} else {
  			return array();
  		}
  	}
  
  	/**
  	 * Test if the address book exists
  	 * @return bool
  	 */
  	public function hasAddressBook($addressbookid) {
  		if($this->addressbooks && isset($this->addressbooks[$addressbookid])) {
  			return true;
  		}
  		return count($this->getAddressBook($addressbookid)) > 0;
  	}
  
  	/**
  	 * Updates an addressbook's properties
  	 *
  	 * The $properties array contains the changes to be made.
  	 *
  	 * Currently the only ones supported are 'displayname' and
  	 * 'description', but backends can implement additional.
  	 *
  	 * @param string $addressbookid
  	 * @param array $properties
6d9380f96   Cédric Dupont   Update sources OC...
326
  	 * @return string|false The ID if the modified AddressBook or false on error.
d1bafeea1   Kload   [fix] Upgrade to ...
327
328
  	 */
  	public function updateAddressBook($addressbookid, array $properties, array $options = array()) {
6d9380f96   Cédric Dupont   Update sources OC...
329
330
331
332
333
334
335
336
337
338
339
  		if ($this->hasAddressBook($addressbookid)) {
  			// Addressbook exists, modify it through the create function
  			if (isset($properties['ldappassmodified']) && $properties['ldappassmodified'] != 'true') {
  				// If password hasn't changed, get it from the preferences
  				$addrbook = $this->getAddressBook($addressbookid, array('getpwd' => true));
  				$properties['ldappass'] = base64_decode($addrbook['ldappass']);
  			}
  			return $this->setAddressBook($properties, $options);
  		} else {
  			return false;
  		}
d1bafeea1   Kload   [fix] Upgrade to ...
340
  	}
6d9380f96   Cédric Dupont   Update sources OC...
341
  	
d1bafeea1   Kload   [fix] Upgrade to ...
342
343
344
345
346
347
348
349
350
351
352
  	/**
  	 * Creates a new address book
  	 *
  	 * Currently the only ones supported are 'displayname' and
  	 * 'description', but backends can implement additional.
  	 * 'displayname' MUST be present.
  	 *
  	 * @param array $properties
  	 * @return string|false The ID if the newly created AddressBook or false on error.
  	 */
  	public function createAddressBook(array $properties, array $options = array()) {
6d9380f96   Cédric Dupont   Update sources OC...
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
  		if (!isset($properties['uri']) || $this->hasAddressBook($properties['uri'])) {
  			return false;
  		} else {
  			return $this->setAddressBook($properties, $options);
  		}
  	}
  
  	/*
  	 * Sets the parameters for a new or existing addressbook
  	 *
  	 * @param array $properties
  	 * @return string|false The ID if the newly created AddressBook or false on error.
  	 */
  	public function setAddressBook(array $properties, array $options = array()) {
  		if (count($properties) === 0) {
  			return false;
  		}
  		if (isset($properties['displayname']) && $properties['displayname'] != '' &&
  			isset($properties['uri']) && $properties['uri'] != '' &&
  			isset($properties['ldapurl']) && $properties['ldapurl'] != '' &&
  			isset($properties['ldappagesize']) && $properties['ldappagesize'] != '' &&
  			isset($properties['ldapbasednsearch']) && $properties['ldapbasednsearch'] != '' &&
  			isset($properties['ldapfilter']) && $properties['ldapfilter'] != '' &&
  			isset($properties['ldapvcardconnector']) &&
  			isset($properties['ldapanonymous']) &&
  				($properties['ldapanonymous']=='true' 
  					|| ($properties['ldapanonymous']=='false' 
  						&& isset($properties['ldapuser']) && $properties['ldapuser'] != ''
  						&& isset($properties['ldappass']) && $properties['ldappass'] != ''
  						)
  				) &&
  			isset($properties['ldapreadonly']) &&
  				($properties['ldapreadonly']=='true' 
  					|| ($properties['ldapreadonly']=='false' 
  						&& isset($properties['ldapbasednmodify']) && $properties['ldapbasednmodify'] != ''
  						)
  				)
  			) {
  			$addressbookSettings = array();
  			$addressbookSettings['uri'] = $properties['uri'];
  			$addressbookSettings['displayname'] = $properties['displayname'];
  			$addressbookSettings['description'] = $properties['description'];
  			$addressbookSettings['ldapurl'] = $properties['ldapurl'];
  			$addressbookSettings['ldapanonymous'] = ($properties['ldapanonymous']=='true');
  			$addressbookSettings['ldapreadonly'] = ($properties['ldapreadonly']=='true');
  			$addressbookSettings['ldapuser'] = ($properties['ldapanonymous']=='false')?$properties['ldapuser']:"";
  			$addressbookSettings['ldappass'] = ($properties['ldapanonymous']=='false')?base64_encode($properties['ldappass']):"";
  			$addressbookSettings['ldappagesize'] = $properties['ldappagesize'];
  			$addressbookSettings['ldapbasednsearch'] = $properties['ldapbasednsearch'];
  			$addressbookSettings['ldapfilter'] = $properties['ldapfilter'];
  			$addressbookSettings['ldapbasednmodify'] = ($properties['ldapanonymous']=='false')?$properties['ldapbasednmodify']:"";
  			$addressbookSettings['ldapconnectorid'] = $properties['ldapvcardconnector'];
  			
  			if ($properties['ldapvcardconnector'] != '') {
  				$prefix = "backend_ldap_";
  				$suffix = "_connector.xml";
  				$path = __DIR__ . "/../../formats/";
  				if (file_exists( $path.$prefix.$properties['ldapvcardconnector'].$suffix )) {
  					$addressbookSettings['ldap_vcard_connector'] = file_get_contents ( $path.$prefix.$properties['ldapvcardconnector'].$suffix );
  				}
  			} else {
  				$addressbookSettings['ldap_vcard_connector'] = $properties['ldapvcardconnectorvalue'];
  			}
  
  			$addressbookList = $this->getAddressbookList();
  			if (!in_array($properties['uri'], $addressbookList)) {
  				$addressbookList[] = $properties['uri'];
  				$this->setAddressbookList($addressbookList);
  			}
  			$this->setPreferences($properties['uri'], $addressbookSettings);
  			$this->setActive(1, $properties['uri']);
  			return $properties['uri'];
  		}
  		return false;
d1bafeea1   Kload   [fix] Upgrade to ...
427
428
429
430
431
432
433
434
435
  	}
  
  	/**
  	 * Deletes an entire addressbook and all its contents
  	 *
  	 * @param string $addressbookid
  	 * @return bool
  	 */
  	public function deleteAddressBook($addressbookid, array $options = array()) {
6d9380f96   Cédric Dupont   Update sources OC...
436
437
438
439
440
441
442
443
444
445
  		//$addressbook = self::getAddressBook($addressbookid);
  		$addressbookList = $this->getAddressbookList();
  		$toRemove = array_search($addressbookid, $addressbookList);
  		if (is_int($toRemove)) {
  			unset($addressbookList[$toRemove]);
  			$addressbookList = array_values($addressbookList);
  			$this->setAddressbookList($addressbookList);
  		}
  
  		self::removePreferences($addressbookid);
d1bafeea1   Kload   [fix] Upgrade to ...
446
447
448
449
450
451
  
  		// TODO: use backend settings
  		return true;
  	}
  
  	/**
d1bafeea1   Kload   [fix] Upgrade to ...
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
  	 * Returns all contacts for a specific addressbook id.
  	 *
  	 * The returned array MUST contain the unique ID of the contact mapped to 'id', a
  	 * displayname mapped to 'displayname' and an integer 'permissions' value using there
  	 * ownCloud CRUDS constants (which MUST be at least \OCP\PERMISSION_READ), and SHOULD
  	 * contain the properties of the contact formatted as a vCard 3.0
  	 * https://tools.ietf.org/html/rfc2426 mapped to 'carddata' or as an
  	 * \OCA\Contacts\VObject\VCard object mapped to 'vcard'.
  	 *
  	 * Example:
  	 *
  	 * array(
  	 *	 0 => array('id' => '4e111fef5df', 'permissions' => 1, 'displayname' => 'John Q. Public', 'vcard' => $object),
  	 *	 1 => array('id' => 'bbcca2d1535', 'permissions' => 32, 'displayname' => 'Jane Doe', 'carddata' => $data)
  	 * );
  	 *
  	 * For contacts that contain loads of data, the 'carddata' or 'vcard' MAY be omitted
  	 * as it can be fetched later.
  	 *
  	 * TODO: Some sort of ETag?
  	 *
  	 * @param string $addressbookid
  	 * @param bool $omitdata Don't fetch the entire carddata or vcard.
  	 * @return array
  	 */
  	public function getContacts($addressbookid, array $options = array()) {
6d9380f96   Cédric Dupont   Update sources OC...
478
479
480
481
482
483
484
485
486
487
  		$backtrace = debug_backtrace();
  		$trace=array();
  		foreach ($backtrace as $elt) {
  			foreach ($elt as $key => $line) {
  				if ($key == "file" || $key == "line") {
  					$trace[] = $line;
  				}
  			}
  		}
  		
d1bafeea1   Kload   [fix] Upgrade to ...
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
  		$cards = array();
  		$vcards = array();
  		if(is_array($addressbookid) && count($addressbookid)) {
  			$id_array = $addressbookid;
  		} elseif(is_int($addressbookid) || is_string($addressbookid)) {
  			$id_array = array($addressbookid);
  		} else {
  			\OC_Log::write('contacts_ldap', __METHOD__.'. Addressbook id(s) argument is empty: '. print_r($id, true), \OC_Log::DEBUG);
  			return false;
  		}
  		
  		foreach ($id_array as $one_id) {
  			if (self::setLdapParams($one_id)) {
  				//OCP\Util::writeLog('contacts_ldap', __METHOD__.' Connector OK', \OC_Log::DEBUG);
  				$info = self::ldapFindMultiple(
  					$this->ldapParams['ldapbasednsearch'],
6d9380f96   Cédric Dupont   Update sources OC...
504
  					$this->ldapParams['ldapfilter'],
d1bafeea1   Kload   [fix] Upgrade to ...
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
  					$this->connector->getLdapEntries(),
  					isset($options['offset']) ? $options['offset'] : null,
  					isset($options['limit']) ? $options['limit'] : null
  				);
  				for ($i=0; $i<$info["count"]; $i++) {
  					$a_card = $this->connector->ldapToVCard($info[$i]);
  					$cards[] = self::getSabreFormatCard($addressbookid, $a_card);
  				}
  				//OCP\Util::writeLog('contacts_ldap', __METHOD__.' counts '.count($cards), \OC_Log::DEBUG);
  			}
  		}
  		return $cards;
  	}
  	
  	/**
  	 * Returns a specfic contact.
  	 *
  	 * Same as getContacts except that either 'carddata' or 'vcard' is mandatory.
  	 *
  	 * @param string $addressbookid
  	 * @param mixed $id
  	 * @return array|bool
  	 */
  	public function getContact($addressbookid, $ids, array $options = array()) {
  		if (!is_array($ids)) {
  			$a_ids = array($ids);
  		} else {
  			$a_ids = $ids;
  		}
  		
  		$cards = array();
  		$toReturn = false;
d1bafeea1   Kload   [fix] Upgrade to ...
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
  		if (self::setLdapParams($addressbookid)) {
  			foreach ($a_ids as $id) {
  				$cid = str_replace(".vcf", "", $id);
  				if (ldap_explode_dn(base64_decode($cid),0) == false) {
  					$ldifEntry = $this->connector->getLdifEntry("X-URI", null);
  					$filter = "";
  					if (isset($ldifEntry[0]['unassigned'])) {
  						$filter = $this->connector->getUnassignedVCardProperty() . "=X-URI:" . $cid ."*";
  					} else {
  						$filter = $ldifEntry[0]['name'] . "=" . $cid ."*";
  					}
  					$card = self::ldapFindOne($this->ldapParams['ldapbasednsearch'],
  																	$filter,
  																	$this->connector->getLdapEntries());
  				} else {
  					$card = self::ldapFindOne(base64_decode($cid),
6d9380f96   Cédric Dupont   Update sources OC...
553
  																	$this->ldapParams['ldapfilter'],
d1bafeea1   Kload   [fix] Upgrade to ...
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
  																	$this->connector->getLdapEntries());
  				}
  			}
  			if ($card != null) {
  				return self::getSabreFormatCard($addressbookid, $this->connector->ldapToVCard($card));
  			}
  		}
  		return false;
  	}
  
  	/**
  	 * @brief construct a vcard in Sabre format
  	 * @param integer $aid Addressbook Id
  	 * @param OC_VObject $card VCard
  	 * @return array
  	 */
  	public static function getSabreFormatCard($aid, $vcard) {
  		/*
  		 * array return format :
       * array( 'id' => 'bbcca2d1535', 
       *        'permissions' => 32, 
       *        'displayname' => 'Jane Doe', 
       *        'carddata' => $data)
  		 */
  		$FN = (string)$vcard->FN;
  		$UID = (string)$vcard->UID;
  		$REV = (string)$vcard->REV;
  		if (isset($vcard->{'X-URI'})) {
  			$URI = (string)$vcard->{'X-URI'};
  		} else if (isset($vcard->UID)) {
  			$URI = (string)$vcard->UID.'.vcf';
  		} else {
  			$URI = (string)$vcard->{'X-LDAP-DN'};
  		}
  		return array('id' => $UID,
6d9380f96   Cédric Dupont   Update sources OC...
589
  								 'permissions' => \OCP\PERMISSION_ALL,
d1bafeea1   Kload   [fix] Upgrade to ...
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
  								 'displayname' => $FN,
  								 'carddata' => $vcard->serialize(),
  								 'uri' => $URI,
  								 'lastmodified' => $REV);
  	}
  
  	/**
  	 * Creates a new contact
  	 *
  	 * @param string $addressbookid
  	 * @param VCard|string $carddata
  	 * @return string|bool The identifier for the new contact or false on error.
  	 */
  	public function createContact($addressbookid, $contact, array $options = array()) {
  
  		$uri = isset($options['uri']) ? $options['uri'] : null;
6d9380f96   Cédric Dupont   Update sources OC...
606
607
608
609
610
611
612
613
614
615
  		
  		$datetime = new \DateTime; 
  		$contact->REV = $datetime->format(\DateTime::W3C);
  		
  		// 2014/02/13 Sometimes, a card is created without a name (I don't like that)...
  		if (!isset($contact->N)) {
  			$generated = "nocn-".rand(0, 65535);
  			$contact->N = $generated;
  			$contact->FN = $generated;
  		}
d1bafeea1   Kload   [fix] Upgrade to ...
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
  
  		if(!$contact instanceof VCard) {
  			try {
  				$contact = Reader::read($contact);
  			} catch(\Exception $e) {
  				\OCP\Util::writeLog('contacts', __METHOD__.', exception: '.$e->getMessage(), \OCP\Util::ERROR);
  				return false;
  			}
  		}
  
  		try {
  			$contact->validate(VCard::REPAIR|VCard::UPGRADE);
  		} catch (\Exception $e) {
  			OCP\Util::writeLog('contacts', __METHOD__ . ' ' .
  				'Error validating vcard: ' . $e->getMessage(), \OCP\Util::ERROR);
  			return false;
  		}
  
  		self::setLdapParams($addressbookid);
  		
  		self::ldapCreateAndBindConnection();
  		$newDN = $this->connector->getLdapId() . "=" . $contact->FN . "," . $this->ldapParams['ldapbasednmodify'];
  		$contact->{'X-LDAP-DN'} = base64_encode($newDN);
  		if ($uri!=null) {
  			$contact->{'X-URI'} = $uri;
6d9380f96   Cédric Dupont   Update sources OC...
641
642
  		} else {
  			$contact->{'X-URI'} = $contact->{'UID'}.".vcf";
d1bafeea1   Kload   [fix] Upgrade to ...
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
  		}
  				
  		$ldifEntries = $this->connector->VCardToLdap($contact);
  		
  		// Inserts the new card
  		$cardId = self::ldapAdd($newDN, $ldifEntries);
  		if ($cardId) {
  			self::ldapCloseConnection();
  			return $contact->UID;
  		} else {
  			self::ldapCloseConnection();
  			return false;
  		}
  	}
  
  	/**
  	 * Updates a contact
  	 *
  	 * @param string $addressbookid
  	 * @param mixed $id
  	 * @param string $carddata
  	 * @return bool
  	 */
  	public function updateContact($addressbookid, $id, $carddata, array $options = array()) {
6d9380f96   Cédric Dupont   Update sources OC...
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
  		if(!$carddata instanceof VCard) {
  			try {
  				$vcard = \Sabre\VObject\Reader::read($carddata);
  			} catch(\Exception $e) {
  				\OCP\Util::writeLog('contacts', __METHOD__.', exception: '.$e->getMessage(), \OCP\Util::ERROR);
  				return false;
  			}
  		} else {
  			$vcard = $carddata;
  		}
  		
  		try {
  			$vcard->validate(VCard::REPAIR|VCard::UPGRADE);
  		} catch (\Exception $e) {
  			OCP\Util::writeLog('contacts', __METHOD__ . ' ' .
  				'Error validating vcard: ' . $e->getMessage(), \OCP\Util::ERROR);
  			return false;
  		}
  		//$vcard->REV = (new \DateTime)->format(\DateTime::W3C);
d1bafeea1   Kload   [fix] Upgrade to ...
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
  		
  		if (!is_array($id)) {
  			$a_ids = array($id);
  		} else {
  			$a_ids = $id;
  		}
  
  		self::setLdapParams($addressbookid);
  		self::ldapCreateAndBindConnection();
  		$ldifEntries = $this->connector->VCardToLdap($vcard);
  		foreach ($a_ids as $cid) {
  			// Never EVER modify an Ldap:dn nor a VCard:UID
  			if (isset($vcard->{'X-LDAP-DN'})) {
  				$dn = base64_decode($vcard->{'X-LDAP-DN'});
  			} else {
  				// A little bit complicated but hopefully, we won't often go into this
  				$tmpCard = self::getContact($addressbookid, array($cid));
  				$tmpVCard = \Sabre\VObject\Reader::read($tmpCard['carddata']);
  				$dn = base64_decode($tmpVCard->{'X-LDAP-DN'});
  			}
  			// Updates the existing card
6d9380f96   Cédric Dupont   Update sources OC...
707
708
  			$ldifSource = self::ldapFindOne($dn, $this->ldapParams['ldapfilter'], $this->connector->getLdapEntries());
  			$this->connector->insertEmptyEntries($ldifSource, $ldifEntries);
d1bafeea1   Kload   [fix] Upgrade to ...
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
  			$result = self::ldapUpdate($dn, $ldifEntries);
  		}
  		self::ldapCloseConnection();
  		return $result;
  	}
  
  	/**
  	 * Deletes a contact
  	 *
  	 * @param string $addressbookid
  	 * @param mixed $id
  	 * @return bool
  	 */
  	public function deleteContact($addressbookid, $id, array $options = array()) {
  		self::setLdapParams($addressbookid);
  		self::ldapCreateAndBindConnection();
6d9380f96   Cédric Dupont   Update sources OC...
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
  		if (is_array($id)) {
  			$card = self::getContact($addressbookid, $id);
  		} else {
  			$card = self::getContact($addressbookid, array($id));
  		}
  		if ($card) {
  			$vcard = \Sabre\VObject\Reader::read($card['carddata']);
  			$decodedId = base64_decode($vcard->{'X-LDAP-DN'});
  			// Deletes the existing card
  			$result = self::ldapDelete($decodedId);
  			self::ldapCloseConnection();
  			return $result;
  		} else {
  			return false;
  		}
d1bafeea1   Kload   [fix] Upgrade to ...
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
  	}
  
  	/**
  	 * @brief Get the last modification time for a contact.
  	 *
  	 * Must return a UNIX time stamp or null if the backend
  	 * doesn't support it.
  	 *
  	 * @param string $addressbookid
  	 * @param mixed $id
  	 * @returns int | null
  	 */
  	public function lastModifiedContact($addressbookid, $id) {
  		$contact = getContact($addressbookid, $id);
  		if ($contact != null) {
  			return $contact['lastmodified'];
  		} else {
  			return null;
  		}
  	}
  	
6d9380f96   Cédric Dupont   Update sources OC...
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
  	/**
  	 * @brief sets the list of ldap addressbooks in the preferences
  	 * with the list given in parameter
  	 * @param the new list
  	 * @returns result|false
  	 */
  	protected function setAddressbookList(array $addressbookList) {
  		$key = $this->name . "_list";
  		$data = json_encode($addressbookList);
  		
  		return $data
  			? \OCP\Config::setUserValue($this->userid, 'contacts', $key, $data)
  			: false;
  	}
  	
  	/**
  	 * @brief gets the list of ldap addressbooks in the preferences
  	 * returns array()
  	 */
  	protected function getAddressbookList() {
  		$key = $this->name . "_list";
  		$data = \OCP\Config::getUserValue($this->userid, 'contacts', $key, false);
  		
  		return $data ? json_decode($data) : array();
  	}
  
  	public function getSearchProvider($addressbook) {
  		return new \OCA\Contacts\AddressbookProvider($addressbook);
  	}
d1bafeea1   Kload   [fix] Upgrade to ...
790
  }