nextcloud/apps/contacts/lib/addressbook.php

321 lines
9.2 KiB
PHP
Raw Normal View History

2011-08-07 00:32:06 +04:00
<?php
/**
* ownCloud - Addressbook
*
* @author Jakob Sack
* @copyright 2011 Jakob Sack mail@jakobsack.de
*
* 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/>.
*
*/
/*
*
* The following SQL statement is just a help for developers and will not be
* executed!
*
* CREATE TABLE contacts_addressbooks (
* id INT(11) UNSIGNED NOT NULL PRIMARY KEY AUTO_INCREMENT,
* userid VARCHAR(255) NOT NULL,
* displayname VARCHAR(255),
* uri VARCHAR(100),
* description TEXT,
* ctag INT(11) UNSIGNED NOT NULL DEFAULT '1'
* );
2011-09-15 13:06:21 +04:00
*
2011-08-07 00:32:06 +04:00
*/
/**
* This class manages our addressbooks.
*/
class OC_Contacts_Addressbook{
2011-09-09 01:36:47 +04:00
/**
* @brief Returns the list of addressbooks for a specific user.
* @param string $uid
2012-07-05 19:12:52 +04:00
* @param boolean $active Only return addressbooks with this $active state, default(=false) is don't care
* @return array or false.
2011-09-09 01:36:47 +04:00
*/
2012-07-05 00:12:56 +04:00
public static function all($uid, $active=false){
$values = array($uid);
$active_where = '';
if ($active){
$active_where = ' AND active = ?';
$values[] = 1;
}
try {
2012-07-05 00:12:56 +04:00
$stmt = OCP\DB::prepare( 'SELECT * FROM *PREFIX*contacts_addressbooks WHERE userid = ? ' . $active_where . ' ORDER BY displayname' );
$result = $stmt->execute($values);
} catch(Exception $e) {
OCP\Util::writeLog('contacts',__CLASS__.'::'.__METHOD__.' exception: '.$e->getMessage(),OCP\Util::ERROR);
OCP\Util::writeLog('contacts',__CLASS__.'::'.__METHOD__.' uid: '.$uid,OCP\Util::DEBUG);
return false;
}
2011-08-07 00:32:06 +04:00
$addressbooks = array();
while( $row = $result->fetchRow()){
$addressbooks[] = $row;
}
2012-07-05 00:12:56 +04:00
if(!$active && !count($addressbooks)) {
self::addDefault($uid);
}
2011-08-07 00:32:06 +04:00
return $addressbooks;
}
2011-09-15 13:06:21 +04:00
2012-07-05 00:12:56 +04:00
/**
* @brief Get active addressbook IDs for a user.
* @param integer $uid User id. If null current user will be used.
* @return array
*/
public static function activeIds($uid = null){
if(is_null($uid)){
$uid = OCP\USER::getUser();
}
$activeaddressbooks = self::all($uid, true);
$ids = array();
foreach($activeaddressbooks as $addressbook) {
$ids[] = $addressbook['userid'];
}
return $ids;
}
/**
* @brief Returns the list of active addressbooks for a specific user.
* @param string $uid
* @return array
*/
public static function active($uid){
return self::all($uid, true);
}
2011-09-09 01:36:47 +04:00
/**
* @brief Returns the list of addressbooks for a principal (DAV term of user)
* @param string $principaluri
* @return array
*/
public static function allWherePrincipalURIIs($principaluri){
2011-08-07 00:32:06 +04:00
$uid = self::extractUserID($principaluri);
2011-12-16 20:42:07 +04:00
return self::all($uid);
2011-08-07 00:32:06 +04:00
}
2011-09-09 01:36:47 +04:00
/**
* @brief Gets the data of one address book
* @param integer $id
* @return associative array or false.
2011-09-09 01:36:47 +04:00
*/
public static function find($id){
try {
$stmt = OCP\DB::prepare( 'SELECT * FROM *PREFIX*contacts_addressbooks WHERE id = ?' );
$result = $stmt->execute(array($id));
} catch(Exception $e) {
OCP\Util::writeLog('contacts',__CLASS__.'::'.__METHOD__.', exception: '.$e->getMessage(),OCP\Util::ERROR);
OCP\Util::writeLog('contacts',__CLASS__.'::'.__METHOD__.', id: '.$id,OCP\Util::DEBUG);
return false;
}
2011-08-07 00:32:06 +04:00
return $result->fetchRow();
}
/**
* @brief Adds default address book
* @return $id ID of the newly created addressbook or false on error.
*/
public static function addDefault($uid = null){
if(is_null($uid)) {
$uid = OCP\USER::getUser();
}
$id = self::add($uid,'default','Default Address Book');
if($id !== false) {
self::setActive($id, true);
}
return $id;
}
2011-09-09 01:36:47 +04:00
/**
* @brief Creates a new address book
* @param string $userid
* @param string $name
* @param string $description
* @return insertid
*/
public static function add($uid,$name,$description=''){
$all = self::all($uid);
2011-08-07 00:32:06 +04:00
$uris = array();
foreach($all as $i){
$uris[] = $i['uri'];
}
2011-08-09 16:15:11 +04:00
$uri = self::createURI($name, $uris );
try {
$stmt = OCP\DB::prepare( 'INSERT INTO *PREFIX*contacts_addressbooks (userid,displayname,uri,description,ctag) VALUES(?,?,?,?,?)' );
$result = $stmt->execute(array($uid,$name,$uri,$description,1));
} catch(Exception $e) {
OCP\Util::writeLog('contacts',__CLASS__.'::'.__METHOD__.', exception: '.$e->getMessage(),OCP\Util::ERROR);
OCP\Util::writeLog('contacts',__CLASS__.'::'.__METHOD__.', uid: '.$uid,OCP\Util::DEBUG);
return false;
}
2011-08-07 00:32:06 +04:00
2012-05-03 15:06:08 +04:00
return OCP\DB::insertid('*PREFIX*contacts_addressbooks');
2011-08-07 00:32:06 +04:00
}
2011-09-09 01:36:47 +04:00
/**
* @brief Creates a new address book from the data sabredav provides
* @param string $principaluri
* @param string $uri
* @param string $name
* @param string $description
* @return insertid or false
2011-09-09 01:36:47 +04:00
*/
public static function addFromDAVData($principaluri,$uri,$name,$description){
$uid = self::extractUserID($principaluri);
2011-09-15 13:06:21 +04:00
try {
$stmt = OCP\DB::prepare('INSERT INTO *PREFIX*contacts_addressbooks (userid,displayname,uri,description,ctag) VALUES(?,?,?,?,?)');
$result = $stmt->execute(array($uid,$name,$uri,$description,1));
} catch(Exception $e) {
OCP\Util::writeLog('contacts',__CLASS__.'::'.__METHOD__.', exception: '.$e->getMessage(),OCP\Util::ERROR);
OCP\Util::writeLog('contacts',__CLASS__.'::'.__METHOD__.', uid: '.$uid,OCP\Util::DEBUG);
OCP\Util::writeLog('contacts',__CLASS__.'::'.__METHOD__.', uri: '.$uri,OCP\Util::DEBUG);
return false;
}
2011-08-07 00:32:06 +04:00
2012-05-03 15:06:08 +04:00
return OCP\DB::insertid('*PREFIX*contacts_addressbooks');
2011-08-07 00:32:06 +04:00
}
2011-09-09 01:36:47 +04:00
/**
* @brief Edits an addressbook
* @param integer $id
* @param string $name
* @param string $description
* @return boolean
*/
public static function edit($id,$name,$description){
2011-08-07 00:32:06 +04:00
// Need these ones for checking uri
$addressbook = self::find($id);
if(is_null($name)){
$name = $addressbook['name'];
}
if(is_null($description)){
$description = $addressbook['description'];
}
2011-09-15 13:06:21 +04:00
try {
$stmt = OCP\DB::prepare('UPDATE *PREFIX*contacts_addressbooks SET displayname=?,description=?, ctag=ctag+1 WHERE id=?');
$result = $stmt->execute(array($name,$description,$id));
} catch(Exception $e) {
OCP\Util::writeLog('contacts',__CLASS__.'::'.__METHOD__.', exception: '.$e->getMessage(),OCP\Util::ERROR);
OCP\Util::writeLog('contacts',__CLASS__.'::'.__METHOD__.', id: '.$id,OCP\Util::DEBUG);
return false;
}
2011-08-07 00:32:06 +04:00
return true;
}
/**
* @brief Activates an addressbook
* @param integer $id
2012-06-20 22:59:33 +04:00
* @param boolean $active
* @return boolean
*/
public static function setActive($id,$active){
2012-07-05 00:12:56 +04:00
$sql = 'UPDATE *PREFIX*contacts_addressbooks SET active = ? WHERE id = ?';
OCP\Util::writeLog('contacts',__CLASS__.'::'.__METHOD__.', id: '.$id.', active: '.intval($active),OCP\Util::ERROR);
try {
$stmt = OCP\DB::prepare($sql);
$stmt->execute(array(intval($active), $id));
return true;
} catch(Exception $e) {
OCP\Util::writeLog('contacts',__CLASS__.'::'.__METHOD__.', exception for '.$id.': '.$e->getMessage(),OCP\Util::ERROR);
return false;
}
}
/**
* @brief Checks if an addressbook is active.
* @param integer $id ID of the address book.
* @return boolean
*/
public static function isActive($id){
2012-07-05 00:12:56 +04:00
$sql = 'SELECT active FROM *PREFIX*contacts_addressbooks WHERE id = ?';
try {
$stmt = OCP\DB::prepare( $sql );
$result = $stmt->execute(array($id));
$row = $result->fetchRow();
return (bool)$row['active'];
} catch(Exception $e) {
OCP\Util::writeLog('contacts',__CLASS__.'::'.__METHOD__.', exception: '.$e->getMessage(),OCP\Util::ERROR);
}
}
2011-09-09 01:36:47 +04:00
/**
* @brief removes an address book
* @param integer $id
* @return boolean
*/
public static function delete($id){
self::setActive($id, false);
2012-06-20 22:59:33 +04:00
try {
$stmt = OCP\DB::prepare( 'DELETE FROM *PREFIX*contacts_addressbooks WHERE id = ?' );
$stmt->execute(array($id));
} catch(Exception $e) {
OCP\Util::writeLog('contacts',__CLASS__.'::'.__METHOD__.', exception for '.$id.': '.$e->getMessage(),OCP\Util::ERROR);
2012-06-20 22:59:33 +04:00
return false;
}
$cards = OC_Contacts_VCard::all($id);
foreach($cards as $card){
OC_Contacts_VCard::delete($card['id']);
2011-08-07 00:32:06 +04:00
}
return true;
}
2011-09-09 01:36:47 +04:00
/**
* @brief Updates ctag for addressbook
* @param integer $id
2011-09-09 01:36:47 +04:00
* @return boolean
*/
public static function touch($id){
2012-05-03 15:06:08 +04:00
$stmt = OCP\DB::prepare( 'UPDATE *PREFIX*contacts_addressbooks SET ctag = ctag + 1 WHERE id = ?' );
2011-08-07 00:32:06 +04:00
$stmt->execute(array($id));
return true;
}
2011-09-09 01:36:47 +04:00
/**
* @brief Creates a URI for Addressbook
* @param string $name name of the addressbook
2011-09-16 01:20:49 +04:00
* @param array $existing existing addressbook URIs
* @return string new name
2011-09-09 01:36:47 +04:00
*/
2011-08-07 00:32:06 +04:00
public static function createURI($name,$existing){
$name = strtolower($name);
$newname = $name;
$i = 1;
while(in_array($newname,$existing)){
$newname = $name.$i;
$i = $i + 1;
}
return $newname;
}
2011-09-09 01:36:47 +04:00
/**
* @brief gets the userid from a principal path
* @return string
*/
2011-08-07 00:32:06 +04:00
public static function extractUserID($principaluri){
list($prefix,$userid) = Sabre_DAV_URLUtil::splitPath($principaluri);
return $userid;
}
}