mirror of
https://github.com/owncloudarchive/contacts.git
synced 2024-12-10 21:24:33 +01:00
768 lines
24 KiB
PHP
768 lines
24 KiB
PHP
<?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';
|
|
static private $preparedQueries = array();
|
|
private $ldapParams = array();
|
|
private $ldapConnection = null;
|
|
private $connector = null;
|
|
private $addressBooksTableName = null;
|
|
|
|
/**
|
|
* @brief validates and sets the ldap parameters
|
|
* @param $ldapParams array containing the parameters
|
|
* return boolean
|
|
*/
|
|
public function setLdapParams($aid) {
|
|
//error_log( __METHOD__.', id: '.$aid);
|
|
$sql = 'SELECT displayname, uri, description, ldapurl, ldapbasednsearch, ldapbasednmodify, ldapuser, ldappass, ldapanonymous, ldapreadonly, ldappagesize, ldap_vcard_connector FROM `'.$this->addressBooksTableName.'` WHERE `id` = ? and `active` = 1';
|
|
try {
|
|
$stmt = \OCP\DB::prepare($sql);
|
|
$result = $stmt->execute(array($aid));
|
|
} catch(Exception $e) {
|
|
\OC_Log::write('contacts_ldap', __METHOD__.', exception: '.$e->getMessage(), \OCP\Util::ERROR);
|
|
\OC_Log::write('contacts_ldap', __METHOD__.', id: '.$aid, \OC_Log::DEBUG);
|
|
\OC_Log::write('contacts_ldap', __METHOD__.'SQL:'.$sql, \OC_Log::DEBUG);
|
|
return false;
|
|
}
|
|
|
|
if(!is_null($result)) {
|
|
$row = $result->fetchRow();
|
|
//var_dump($row);
|
|
$this->ldapParams = array('ldapurl' => $row['ldapurl'],
|
|
'ldapbasednsearch' => $row['ldapbasednsearch'],
|
|
'ldapbasednmodify' => $row['ldapbasednmodify'],
|
|
'ldapuser' => $row['ldapuser'],
|
|
'ldappass' => base64_decode($row['ldappass']),
|
|
'ldapanonymous' => intval($row['ldapanonymous']),
|
|
'ldapreadonly' => intval($row['ldapreadonly']),
|
|
'ldappagesize' => intval($row['ldappagesize']),
|
|
'ldap_vcard_connector' => $row['ldap_vcard_connector']);
|
|
$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);
|
|
//error_log( __METHOD__.', anonymous bind');
|
|
} else {
|
|
$ldapbind = ldap_bind($this->ldapConnection, $this->ldapParams['ldapuser'], $this->ldapParams['ldappass']);
|
|
error_log( __METHOD__.", log in and bind as '".$this->ldapParams['ldapuser']."' - '".$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;
|
|
}
|
|
error_log(__METHOD__." - search what $ldapbasedn, $bindsearch ");
|
|
|
|
$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;
|
|
}
|
|
} else {
|
|
error_log(__METHOD__." - search failed $ldapbasedn , $bindsearch ");
|
|
}
|
|
|
|
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()) {
|
|
//error_log("inserting new $ldapDN - ".print_r($ldapValues, true));
|
|
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()) {
|
|
error_log("updating $ldapDN ".print_r($ldapValues, true));
|
|
$result = @ldap_modify($this->ldapConnection, $ldapDN, $ldapValues);
|
|
if (!$result) {
|
|
error_log("Error updating : ".ldap_error($this->ldapConnection));
|
|
self::ldapDelete($ldapDN);
|
|
return self::ldapAdd($ldapDN, $ldapValues);
|
|
}
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @brief delete a ldap entry
|
|
* @param $ldapDN the DN (must exists)
|
|
* @return boolean delete status
|
|
*/
|
|
public function ldapDelete($ldapDN) {
|
|
if (self::ldapIsConnected()) {
|
|
error_log("deleting $ldapDN");
|
|
ldap_delete($this->ldapConnection, $ldapDN);
|
|
error_log("Error updating : ".ldap_error($this->ldapConnection));
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Sets up the backend
|
|
*
|
|
* @param string $addressBooksTableName
|
|
* @param string $cardsTableName
|
|
*/
|
|
public function __construct(
|
|
$userid = null,
|
|
$addressBooksTableName = '*PREFIX*contacts_ldap_addressbooks'
|
|
) {
|
|
$this->userid = $userid ? $userid : \OCP\User::getUser();
|
|
$this->addressBooksTableName = $addressBooksTableName;
|
|
$this->addressbooks = array();
|
|
}
|
|
|
|
/**
|
|
* Returns the list of active addressbooks for a specific user.
|
|
*
|
|
* @param string $userid
|
|
* @return array
|
|
*/
|
|
public function getAddressBooksForUser($userid = null) {
|
|
$userid = $userid ? $userid : $this->userid;
|
|
|
|
try {
|
|
if(!isset(self::$preparedQueries['addressbooksforuser'])) {
|
|
$sql = 'SELECT `id` FROM `'
|
|
. $this->addressBooksTableName
|
|
. '` WHERE `active` = 1 AND `owner` = ? ';
|
|
self::$preparedQueries['addressbooksforuser'] = \OCP\DB::prepare($sql);
|
|
}
|
|
$result = self::$preparedQueries['addressbooksforuser']->execute(array($userid));
|
|
if (\OC_DB::isError($result)) {
|
|
\OCP\Util::write('contacts', __METHOD__. 'DB error: ' . \OC_DB::getErrorMessage($result), \OCP\Util::ERROR);
|
|
return $this->addressbooks;
|
|
}
|
|
} catch(\Exception $e) {
|
|
\OC_Log::write('contacts', __METHOD__.' exception: ' . $e->getMessage(), \OCP\Util::ERROR);
|
|
return $this->addressbooks;
|
|
}
|
|
|
|
$this->addressbooks = array();
|
|
while( $row = $result->fetchRow()) {
|
|
$this->addressbooks[] = self::getAddressBook($row['id']);
|
|
}
|
|
return $this->addressbooks;
|
|
}
|
|
|
|
/**
|
|
* Returns the list of all addressbooks for a specific user.
|
|
*
|
|
* @param string $userid
|
|
* @return array
|
|
*/
|
|
public function getAllAddressBooksForUser($userid = null) {
|
|
$userid = $userid ? $userid : $this->userid;
|
|
|
|
try {
|
|
if(!isset(self::$preparedQueries['addressbooksforuser'])) {
|
|
$sql = 'SELECT `id` FROM `'
|
|
. $this->addressBooksTableName
|
|
. '` WHERE `owner` = ? ';
|
|
self::$preparedQueries['addressbooksforuser'] = \OCP\DB::prepare($sql);
|
|
}
|
|
$result = self::$preparedQueries['addressbooksforuser']->execute(array($userid));
|
|
if (\OC_DB::isError($result)) {
|
|
\OCP\Util::write('contacts', __METHOD__. 'DB error: ' . \OC_DB::getErrorMessage($result), \OCP\Util::ERROR);
|
|
return $this->addressbooks;
|
|
}
|
|
} catch(\Exception $e) {
|
|
\OC_Log::write('contacts', __METHOD__.' exception: ' . $e->getMessage(), \OCP\Util::ERROR);
|
|
return $this->addressbooks;
|
|
}
|
|
|
|
$this->addressbooks = array();
|
|
while($row = $result->fetchRow()) {
|
|
$this->addressbooks[] = self::getAddressBook($row['id']);
|
|
}
|
|
return $this->addressbooks;
|
|
}
|
|
|
|
/**
|
|
* 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) {
|
|
//\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.
|
|
try {
|
|
$query = 'SELECT `id`, `displayname`, `description`, `owner`, `uri` FROM `'
|
|
. $this->addressBooksTableName
|
|
. '` WHERE `active` = 1 AND `id` = ?';
|
|
if(!isset(self::$preparedQueries['getaddressbook'])) {
|
|
self::$preparedQueries['getaddressbook'] = \OCP\DB::prepare($query);
|
|
}
|
|
$result = self::$preparedQueries['getaddressbook']->execute(array($addressbookid));
|
|
if (\OC_DB::isError($result)) {
|
|
\OCP\Util::write('contacts', __METHOD__. 'DB error: '
|
|
. \OC_DB::getErrorMessage($result), \OCP\Util::ERROR);
|
|
return array();
|
|
}
|
|
$row = $result->fetchRow();
|
|
$row['permissions'] = \OCP\PERMISSION_ALL;
|
|
$row['lastmodified'] = self::lastModifiedAddressBook($addressbookid);
|
|
return $row;
|
|
} catch(\Exception $e) {
|
|
\OC_Log::write('contacts', __METHOD__.' exception: '
|
|
. $e->getMessage(), \OCP\Util::ERROR);
|
|
return array();
|
|
}
|
|
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
|
|
* @return bool
|
|
*/
|
|
public function updateAddressBook($addressbookid, array $properties) {
|
|
// Need these ones for checking uri
|
|
$addressbook = self::getAddressBook($id);
|
|
$name = $addressbook['name'];
|
|
$description = $addressbook['description'];
|
|
|
|
try {
|
|
$stmt = \OCP\DB::prepare('UPDATE `'.$this->addressBooksTableName.'` SET `displayname`=?,`description`=?, `ldapurl`=?,`ldapbasedn`=?,`ldapuser`=?,`ldappass`=?,`ldapanonymous`=?,`ldapreadonly`=? WHERE `id`=?');
|
|
$result = $stmt->execute(array($name,$properties['description'],$properties['ldapurl'],$properties['ldapbasedn'],$properties['ldapuser'],$properties['ldappass'],$properties['ldapanonymous'],$properties['ldapreadonly'],$properties['id']));
|
|
} catch(Exception $e) {
|
|
OCP\Util::writeLog('contacts_ldap', __CLASS__.'::'.__METHOD__.', exception: '.$e->getMessage(), \OCP\Util::ERROR);
|
|
OCP\Util::writeLog('contacts_ldap', __CLASS__.'::'.__METHOD__.', id: '.$id, \OC_Log::DEBUG);
|
|
throw new Exception(
|
|
OC_Contacts_App_Ldap::$l10n->t(
|
|
'There was an error updating the addressbook.'
|
|
)
|
|
);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* 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) {
|
|
try {
|
|
$stmt = \OCP\DB::prepare( 'SELECT `uri` FROM `'.$this->addressBooksTableName.'` WHERE `owner` = ? ' );
|
|
$result = $stmt->execute(array($uid));
|
|
} catch(Exception $e) {
|
|
OCP\Util::writeLog('contacts_ldap', __CLASS__.'::'.__METHOD__.' exception: '.$e->getMessage(), \OCP\Util::ERROR);
|
|
OCP\Util::writeLog('contacts_ldap', __CLASS__.'::'.__METHOD__.' uid: '.$uid, \OC_Log::DEBUG);
|
|
return false;
|
|
}
|
|
$uris = array();
|
|
while($row = $result->fetchRow()) {
|
|
$uris[] = $row['uri'];
|
|
}
|
|
|
|
$uri = self::createURI($name, $uris );
|
|
try {
|
|
$stmt = \OCP\DB::prepare( 'INSERT INTO `'.$this->addressBooksTableName.'` (`owner`,`displayname`,`uri`,`description`,`ldapurl`,`ldapbasedn`,`ldapuser`,`ldappass`,`ldapanonymous`,`ldapreadonly`) VALUES(?,?,?,?,?,?,?,?,?,?,?)' );
|
|
$result = $stmt->execute(array($name,$properties['description'],$properties['ldapurl'],$properties['ldapbasedn'],$properties['ldapuser'],$properties['ldappass'],$properties['ldapanonymous'],$properties['ldapreadonly']));
|
|
} catch(Exception $e) {
|
|
OCP\Util::writeLog('contacts_ldap', __CLASS__.'::'.__METHOD__.', exception: '.$e->getMessage(), \OCP\Util::ERROR);
|
|
OCP\Util::writeLog('contacts_ldap', __CLASS__.'::'.__METHOD__.', uid: '.$uid, \OC_Log::DEBUG);
|
|
return false;
|
|
}
|
|
|
|
return \OCP\DB::insertid($this->addressBooksTableName);
|
|
}
|
|
|
|
/**
|
|
* Deletes an entire addressbook and all its contents
|
|
*
|
|
* @param string $addressbookid
|
|
* @return bool
|
|
*/
|
|
public function deleteAddressBook($addressbookid) {
|
|
$addressbook = self::getAddressBook($addressbookid);
|
|
|
|
try {
|
|
$stmt = \OCP\DB::prepare('DELETE FROM `'.$this->addressBooksTableName.'` WHERE `id` = ?');
|
|
$stmt->execute(array($id));
|
|
} catch(Exception $e) {
|
|
OCP\Util::writeLog('contacts_ldap',
|
|
__METHOD__.', exception for ' . $addressbookid . ': '
|
|
. $e->getMessage(),
|
|
OCP\Util::ERROR);
|
|
throw new Exception(
|
|
OC_Contacts_App_Ldap::$l10n->t(
|
|
'There was an error deleting this addressbook.'
|
|
)
|
|
);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @brief Get the last modification time for an address book.
|
|
*
|
|
* Must return a UNIX time stamp or null if the backend
|
|
* doesn't support it.
|
|
*
|
|
* TODO: Implement default methods get/set for backends that
|
|
* don't support.
|
|
* @param string $addressbookid
|
|
* @returns int | null
|
|
*/
|
|
public function lastModifiedAddressBook($addressbookid) {
|
|
$datetime = new \DateTime('NOW');
|
|
return $datetime->format(\DateTime::W3C);
|
|
// TODO use ldap_sort and get the last element
|
|
}
|
|
|
|
/**
|
|
* 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, $limit = null, $offset = null, $omitdata = false) {
|
|
$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'],
|
|
'(objectclass=person)',
|
|
$this->connector->getLdapEntries(),
|
|
$offset,
|
|
$limit);
|
|
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) {
|
|
//error_log(__METHOD__." - addressbook is $addressbookid");
|
|
if (!is_array($ids)) {
|
|
$a_ids = array($ids);
|
|
} else {
|
|
$a_ids = $ids;
|
|
}
|
|
|
|
$cards = array();
|
|
$toReturn = false;
|
|
self::setLdapParams($addressbookid);
|
|
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 {
|
|
//error_log(__METHOD__." - contact id is '$cid'");
|
|
$card = self::ldapFindOne(base64_decode($cid),
|
|
'objectClass=*',
|
|
$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,
|
|
'permissions' => \OCP\PERMISSION_READ,
|
|
'displayname' => $FN,
|
|
'carddata' => $vcard->serialize(),
|
|
'uri' => $URI,
|
|
'lastmodified' => $REV);
|
|
}
|
|
|
|
/**
|
|
* Creates a new contact
|
|
*
|
|
* @param string $addressbookid
|
|
* @param string $carddata
|
|
* @return string|bool The identifier for the new contact or false on error.
|
|
*/
|
|
public function createContact($addressbookid, $carddata, $uri = null) {
|
|
$vcard = \Sabre\VObject\Reader::read($carddata);
|
|
self::setLdapParams($addressbookid);
|
|
|
|
self::ldapCreateAndBindConnection();
|
|
$newDN = $this->connector->getLdapId() . "=" . $vcard->FN . "," . $this->ldapParams['ldapbasednmodify'];
|
|
$vcard->{'X-LDAP-DN'} = base64_encode($newDN);
|
|
if ($uri!=null) {
|
|
$vcard->{'X-URI'} = $uri;
|
|
}
|
|
|
|
$ldifEntries = $this->connector->VCardToLdap($vcard);
|
|
//error_log(__METHOD__." - $uri - $newDN");
|
|
|
|
// Inserts the new card
|
|
$cardId = self::ldapAdd($newDN, $ldifEntries);
|
|
if ($cardId) {
|
|
self::ldapCloseConnection();
|
|
return $vcard->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) {
|
|
$vcard = \Sabre\VObject\Reader::read($carddata);
|
|
|
|
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
|
|
$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) {
|
|
//error_log(__METHOD__);
|
|
self::setLdapParams($addressbookid);
|
|
self::ldapCreateAndBindConnection();
|
|
$card = self::getContact($addressbookid, array($id));
|
|
$vcard = \Sabre\VObject\Reader::read($card['carddata']);
|
|
$decodedId = base64_decode($vcard->{'X-LDAP-DN'});
|
|
// Deletes the existing card
|
|
//error_log("to delete $decodedId");
|
|
$result = self::ldapDelete($decodedId);
|
|
self::ldapCloseConnection();
|
|
return $result;
|
|
}
|
|
|
|
/**
|
|
* @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($addrebookid, $id);
|
|
if ($contact != null) {
|
|
return $contact['lastmodified'];
|
|
} else {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
}
|