1
0
mirror of https://github.com/owncloudarchive/contacts.git synced 2024-12-04 15:24:35 +01:00
OwncloudContactsOfficial/lib/addressbook.php

504 lines
12 KiB
PHP
Raw Normal View History

2011-08-06 22:32:06 +02:00
<?php
/**
* ownCloud - Addressbook
*
2013-03-12 09:15:40 +01:00
* @author Thomas Tanghus
2014-01-26 00:40:22 +01:00
* @copyright 2013-2014 Thomas Tanghus (thomas@tanghus.net)
2011-08-06 22:32:06 +02:00
*
* 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/>.
*
*/
2012-10-25 03:34:12 +02:00
namespace OCA\Contacts;
use OC_L10N;
use OCA\Contacts\Backend\AbstractBackend;
2014-03-23 19:02:16 +01:00
use OCP\AppFramework\Http;
2011-08-06 22:32:06 +02:00
/**
* This class manages our addressbooks.
*/
2013-04-25 01:03:05 +02:00
class Addressbook extends AbstractPIMCollection {
2013-03-12 09:15:40 +01:00
/**
* @brief language object
*
* @var OC_L10N
*/
public static $l10n;
2013-03-28 17:33:30 +01:00
protected $_count;
2014-03-08 16:22:51 +01:00
2013-03-28 17:33:30 +01:00
/**
* @var Backend\AbstractBackend
*/
2013-03-16 15:59:23 +01:00
protected $backend;
2013-03-12 09:15:40 +01:00
/**
* An array containing the mandatory:
* 'displayname'
* 'discription'
* 'permissions'
*
* And the optional:
* 'Etag'
* 'lastModified'
*
2013-03-28 17:33:30 +01:00
* @var array
2013-03-12 09:15:40 +01:00
*/
protected $addressBookInfo;
/**
* @param AbstractBackend $backend The storage backend
* @param array $addressBookInfo
2014-03-08 19:09:17 +01:00
* @throws \Exception
2013-03-12 09:15:40 +01:00
*/
2013-03-16 15:59:23 +01:00
public function __construct(Backend\AbstractBackend $backend, array $addressBookInfo) {
2013-09-16 02:24:08 +02:00
self::$l10n = \OCP\Util::getL10N('contacts');
2013-03-12 09:15:40 +01:00
$this->backend = $backend;
$this->addressBookInfo = $addressBookInfo;
2014-03-08 19:09:17 +01:00
if (is_null($this->getId())) {
$id = $this->backend->createAddressBook($addressBookInfo);
2014-03-08 19:09:17 +01:00
if ($id === false) {
2014-03-23 19:02:16 +01:00
throw new \Exception('Error creating address book.', Http::STATUS_INTERNAL_SERVER_ERROR);
}
2014-03-08 19:09:17 +01:00
$this->addressBookInfo = $this->backend->getAddressBook($id);
2013-03-17 23:06:14 +01:00
}
2014-03-08 19:09:17 +01:00
2013-03-16 15:59:23 +01:00
//\OCP\Util::writeLog('contacts', __METHOD__.' backend: ' . print_r($this->backend, true), \OCP\Util::DEBUG);
2013-03-12 09:15:40 +01:00
}
2014-03-08 16:22:51 +01:00
/**
* @return AbstractBackend
*/
public function getBackend() {
return $this->backend;
}
2013-03-12 09:15:40 +01:00
/**
2013-03-17 21:32:53 +01:00
* @return string|null
2013-03-12 09:15:40 +01:00
*/
public function getId() {
2013-03-17 21:32:53 +01:00
return isset($this->addressBookInfo['id'])
? $this->addressBookInfo['id']
: null;
2013-03-12 09:15:40 +01:00
}
2013-03-16 15:59:23 +01:00
/**
* @return array
*/
public function getMetaData() {
$metadata = $this->addressBookInfo;
$metadata['lastmodified'] = $this->lastModified();
$metadata['active'] = $this->isActive();
2013-03-25 17:10:21 +01:00
$metadata['backend'] = $this->getBackend()->name;
2014-04-24 13:39:29 +02:00
$metadata['owner'] = $this->getOwner();
2013-03-16 15:59:23 +01:00
return $metadata;
}
2013-03-12 09:15:40 +01:00
/**
* @return string
*/
public function getDisplayName() {
return $this->addressBookInfo['displayname'];
}
/**
* @return string
*/
public function getURI() {
return $this->addressBookInfo['uri'];
}
/**
* @return string
*/
public function getOwner() {
2014-04-24 13:39:29 +02:00
return isset($this->addressBookInfo['owner'])
? $this->addressBookInfo['owner']
: \OCP\User::getUser();
2013-03-12 09:15:40 +01:00
}
/**
* Returns the lowest permission of what the backend allows and what it supports.
* @return int
2013-03-12 09:15:40 +01:00
*/
public function getPermissions() {
return $this->addressBookInfo['permissions'];
2013-03-12 09:15:40 +01:00
}
/**
* @brief Query whether an address book is active
* @return boolean
*/
public function isActive() {
return $this->backend->isActive($this->getId());
}
/**
* @brief Activate an address book
* @param bool $active
* @return void
*/
public function setActive($active) {
$this->backend->setActive($active, $this->getId());
}
2013-03-12 09:15:40 +01:00
/**
* Returns a specific child node, referenced by its id
*
* @param string $id
2013-03-17 21:32:53 +01:00
* @return Contact|null
2014-03-08 19:09:17 +01:00
* @throws \Exception On not found
2013-03-12 09:15:40 +01:00
*/
2013-05-30 20:52:12 +02:00
public function getChild($id) {
//\OCP\Util::writeLog('contacts', __METHOD__.' id: '.$id, \OCP\Util::DEBUG);
2014-03-08 19:09:17 +01:00
if (!$this->hasPermission(\OCP\PERMISSION_READ)) {
2014-03-23 19:02:16 +01:00
throw new \Exception(
2014-05-25 13:14:06 +02:00
self::$l10n->t('You do not have permissions to see this contact'),
2014-03-23 19:02:16 +01:00
Http::STATUS_FORBIDDEN
);
}
2014-03-08 19:09:17 +01:00
if (!isset($this->objects[(string)$id])) {
$contact = $this->backend->getContact($this->getId(), $id);
2014-03-08 19:09:17 +01:00
if ($contact) {
$this->objects[(string)$id] = new Contact($this, $this->backend, $contact);
} else {
2014-03-23 19:02:16 +01:00
throw new \Exception(
self::$l10n->t('Contact not found'),
Http::STATUS_NOT_FOUND
);
2013-03-12 09:15:40 +01:00
}
}
2014-03-08 19:09:17 +01:00
2013-03-17 21:32:53 +01:00
// When requesting a single contact we preparse it
if (isset($this->objects[(string)$id])) {
$this->objects[(string)$id]->retrieve();
return $this->objects[(string)$id];
2013-03-17 21:32:53 +01:00
}
2013-03-12 09:15:40 +01:00
}
/**
* Checks if a child-node with the specified id exists
*
* @param string $id
* @return bool
*/
2013-05-30 20:52:12 +02:00
public function childExists($id) {
if(isset($this->objects[$id])) {
return true;
}
try {
return ($this->getChild($id) !== null);
} catch (\Exception $e) {
return false;
}
2013-03-12 09:15:40 +01:00
}
/**
* Returns an array with all the child nodes
*
2014-03-09 15:03:21 +01:00
* @param int $limit
* @param int $offset
* @param bool $omitdata
2013-03-16 15:59:23 +01:00
* @return Contact[]
2013-03-12 09:15:40 +01:00
*/
2013-05-30 20:52:12 +02:00
public function getChildren($limit = null, $offset = null, $omitdata = false) {
2014-03-08 19:09:17 +01:00
if (!$this->hasPermission(\OCP\PERMISSION_READ)) {
2014-03-23 19:02:16 +01:00
throw new \Exception(
self::$l10n->t('You do not have permissions to see these contacts'),
Http::STATUS_FORBIDDEN
);
}
2013-05-18 16:49:02 +02:00
2013-03-12 09:15:40 +01:00
$contacts = array();
$options = array('limit' => $limit, 'offset' => $offset, 'omitdata' => $omitdata);
2014-03-08 19:09:17 +01:00
foreach ($this->backend->getContacts($this->getId(), $options) as $contact) {
2013-03-16 15:59:23 +01:00
//\OCP\Util::writeLog('contacts', __METHOD__.' id: '.$contact['id'], \OCP\Util::DEBUG);
2014-03-08 19:09:17 +01:00
if (!isset($this->objects[$contact['id']])) {
2013-03-12 20:00:22 +01:00
$this->objects[$contact['id']] = new Contact($this, $this->backend, $contact);
}
2014-03-08 19:09:17 +01:00
2013-03-12 20:00:22 +01:00
$contacts[] = $this->objects[$contact['id']];
2013-03-12 09:15:40 +01:00
}
2014-03-08 19:09:17 +01:00
2013-04-25 01:03:05 +02:00
//\OCP\Util::writeLog('contacts', __METHOD__.' children: '.count($contacts), \OCP\Util::DEBUG);
2013-03-12 09:15:40 +01:00
return $contacts;
}
/**
2013-03-17 21:32:53 +01:00
* Add a contact to the address book
* This takes an array or a VCard|Contact and return
* the ID or false.
2013-03-17 21:32:53 +01:00
*
* @param array|VObject\VCard $data
* @return int|bool
2014-03-08 19:09:17 +01:00
* @throws \Exception on missing permissions
2013-03-17 21:32:53 +01:00
*/
2013-03-25 17:10:21 +01:00
public function addChild($data = null) {
2014-03-08 19:09:17 +01:00
if (!$this->hasPermission(\OCP\PERMISSION_CREATE)) {
2014-03-23 19:02:16 +01:00
throw new \Exception(
self::$l10n->t('You do not have permissions add contacts to the address book'),
Http::STATUS_FORBIDDEN
);
}
2014-03-08 19:09:17 +01:00
if (!$this->getBackend()->hasContactMethodFor(\OCP\PERMISSION_CREATE)) {
2014-03-23 19:02:16 +01:00
throw new \Exception(
self::$l10n->t('The backend for this address book does not support adding contacts'),
Http::STATUS_NOT_IMPLEMENTED
);
}
2014-03-08 19:09:17 +01:00
$contact = new Contact($this, $this->backend, $data);
2014-03-08 19:09:17 +01:00
2014-03-18 23:51:32 +01:00
if (is_null($data)) {
// A new Contact, don't try to load from backend
$contact->setRetrieved(true);
}
2014-03-08 19:09:17 +01:00
if ($contact->save() === false) {
return false;
}
2014-03-08 19:09:17 +01:00
$id = $contact->getId();
2014-03-08 19:09:17 +01:00
// If this method is called directly the index isn't set.
if (!isset($this->objects[$id])) {
$this->objects[$id] = $contact;
}
/* If count() hasn't been called yet don't _count hasn't been initialized
* so incrementing it would give a misleading value.
*/
if (isset($this->_count)) {
$this->_count += 1;
}
2014-03-08 19:09:17 +01:00
2014-03-18 23:51:32 +01:00
//\OCP\Util::writeLog('contacts', __METHOD__.' id: ' . $id, \OCP\Util::DEBUG);
return $id;
}
/**
* Delete a contact from the address book
*
* @param string $id
* @param array $options
* @return bool
2013-09-03 14:08:12 +02:00
* @throws \Exception on missing permissions
*/
public function deleteChild($id, $options = array()) {
2014-03-08 19:09:17 +01:00
if (!$this->hasPermission(\OCP\PERMISSION_DELETE)) {
2014-03-23 19:02:16 +01:00
throw new \Exception(
self::$l10n->t('You do not have permissions to delete this contact'),
Http::STATUS_FORBIDDEN
);
}
2014-03-08 19:09:17 +01:00
if (!$this->getBackend()->hasContactMethodFor(\OCP\PERMISSION_DELETE)) {
2014-03-23 19:02:16 +01:00
throw new \Exception(
self::$l10n->t('The backend for this address book does not support deleting contacts'),
Http::STATUS_NOT_IMPLEMENTED
);
}
2014-03-08 19:09:17 +01:00
if ($this->backend->deleteContact($this->getId(), $id, $options)) {
if (isset($this->objects[$id])) {
unset($this->objects[$id]);
}
2014-03-08 19:09:17 +01:00
/* If count() hasn't been called yet don't _count hasn't been initialized
* so decrementing it would give a misleading value.
*/
if (isset($this->_count)) {
$this->_count -= 1;
}
2014-03-08 19:09:17 +01:00
return true;
2013-03-17 21:32:53 +01:00
}
2014-03-08 19:09:17 +01:00
return false;
2013-03-17 21:32:53 +01:00
}
2013-09-03 14:08:12 +02:00
/**
* Delete a list of contacts from the address book
*
* @param array $ids
* @return array containing the status
* @throws \Exception on missing permissions
*/
public function deleteChildren($ids) {
2014-03-08 19:09:17 +01:00
if (!$this->hasPermission(\OCP\PERMISSION_DELETE)) {
2014-03-23 19:02:16 +01:00
throw new \Exception(
self::$l10n->t('You do not have permissions to delete this contact'),
Http::STATUS_FORBIDDEN
);
2013-09-03 14:08:12 +02:00
}
2014-03-08 19:09:17 +01:00
if (!$this->getBackend()->hasContactMethodFor(\OCP\PERMISSION_DELETE)) {
2014-03-23 19:02:16 +01:00
throw new \Exception(
self::$l10n->t('The backend for this address book does not support deleting contacts'),
Http::STATUS_NOT_IMPLEMENTED
);
2013-09-03 14:08:12 +02:00
}
$response = array();
2013-09-16 02:24:08 +02:00
\OCP\Util::emitHook('OCA\Contacts', 'pre_deleteContact',
array('id' => $ids)
);
2014-03-08 19:09:17 +01:00
foreach ($ids as $id) {
2013-09-03 14:08:12 +02:00
try {
2014-03-08 19:09:17 +01:00
if (!$this->deleteChild($id, array('isBatch' => true))) {
2013-09-03 14:08:12 +02:00
\OCP\Util::writeLog(
'contacts', __METHOD__.' Error deleting contact: '
. $this->getBackend()->name . '::'
. $this->getId() . '::' . $id,
\OCP\Util::ERROR
);
$response[] = array(
'id' => (string)$id,
'status' => 'error',
'message' => self::$l10n->t('Unknown error')
);
} else {
$response[] = array(
'id' => (string)$id,
'status' => 'success'
);
}
} catch(\Exception $e) {
$response[] = array(
'id' => (string)$id,
'status' => 'error',
'message' => $e->getMessage()
);
}
}
return $response;
}
/**
* @internal implements Countable
* @return int|null
*/
public function count() {
2014-03-08 19:09:17 +01:00
if (!isset($this->_count)) {
$this->_count = $this->backend->numContacts($this->getId());
}
2014-03-08 19:09:17 +01:00
return $this->_count;
}
2013-03-17 21:32:53 +01:00
/**
* Update and save the address book data to backend
2013-03-17 23:06:14 +01:00
* NOTE: @see IPIMObject::update for consistency considerations.
2013-03-12 09:15:40 +01:00
*
* @param array $data
* @return bool
*/
public function update(array $data) {
2014-03-08 19:09:17 +01:00
if (!$this->hasPermission(\OCP\PERMISSION_UPDATE)) {
2014-03-23 19:02:16 +01:00
throw new \Exception(
self::$l10n->t('Access denied'),
Http::STATUS_FORBIDDEN
2014-03-23 19:02:16 +01:00
);
}
2014-03-08 19:09:17 +01:00
if (!$this->getBackend()->hasContactMethodFor(\OCP\PERMISSION_UPDATE)) {
2014-03-23 19:02:16 +01:00
throw new \Exception(
self::$l10n->t('The backend for this address book does not support updating'),
Http::STATUS_NOT_IMPLEMENTED
);
2013-05-18 16:49:02 +02:00
}
2014-03-08 19:09:17 +01:00
if (count($data) === 0) {
2013-03-17 23:06:14 +01:00
return false;
}
2014-03-08 19:09:17 +01:00
foreach ($data as $key => $value) {
switch ($key) {
2013-03-12 09:15:40 +01:00
case 'displayname':
$this->addressBookInfo['displayname'] = $value;
break;
case 'description':
$this->addressBookInfo['description'] = $value;
break;
}
}
2014-03-08 19:09:17 +01:00
2013-03-17 23:06:14 +01:00
return $this->backend->updateAddressBook($this->getId(), $data);
2013-03-12 09:15:40 +01:00
}
/**
* Delete the address book from backend
*
* @return bool
*/
public function delete() {
2014-03-08 19:09:17 +01:00
if (!$this->hasPermission(\OCP\PERMISSION_DELETE)) {
throw new \Exception(
2014-03-23 19:02:16 +01:00
self::$l10n->t('You don\'t have permissions to delete the address book.'),
Http::STATUS_FORBIDDEN
);
}
2014-03-08 19:09:17 +01:00
return $this->backend->deleteAddressBook($this->getId());
2013-03-17 21:32:53 +01:00
}
2013-03-12 09:15:40 +01:00
/**
* @brief Get the last modification time for the object.
*
* Must return a UNIX time stamp or null if the backend
* doesn't support it.
*
2014-03-20 21:52:44 +01:00
* @return int | null
2013-03-12 09:15:40 +01:00
*/
public function lastModified() {
return $this->backend->lastModifiedAddressBook($this->getId());
}
/**
* Get an array of birthday events for contacts in this address book.
*
* @return \Sabre\VObject\Component\VEvent[]
*/
public function getBirthdayEvents() {
$events = array();
2014-03-08 19:09:17 +01:00
foreach ($this->getChildren() as $contact) {
if ($event = $contact->getBirthdayEvent()) {
$events[] = $event;
}
}
2014-03-09 15:03:21 +01:00
return $events;
}
2014-04-18 12:47:44 +02:00
2014-04-18 12:52:52 +02:00
/**
* Returns the searchProvider for a specific backend.
*
* @return \OCP\IAddressBook
2014-04-18 12:52:52 +02:00
*/
public function getSearchProvider() {
2014-04-23 08:42:17 +02:00
return $this->backend->getSearchProvider($this);
2014-04-18 12:47:44 +02:00
}
2011-08-06 22:32:06 +02:00
}