abook_carddav_squirrelmail/abook_class.php

<?php
/**
 * plugins/abook_carddav/abook_class.php -- main class
 *
 * SquirrelMail Address Book CardDAV Backend
 * Copyright (C) 2021 Aleksei Shpakovsky
 * This program is licensed under GPLv3. See COPYING for details
 * based on:
 * SquirrelMail Address Book Backend template
 * Copyright (C) 2004 Tomas Kuliavas <tokul@users.sourceforge.net>
 * This program is licensed under GPL. See COPYING for details
 */

require 'quickconfig.php';
require 'vendor/autoload.php';

use MStilkerich\CardDavClient\{Account, AddressbookCollection, Config};
use MStilkerich\CardDavClient\Services\{Discovery, Sync, SyncHandler};

use Psr\Log\{AbstractLogger, NullLogger, LogLevel};
use Sabre\VObject\Component\VCard;

class NullSyncHandler implements SyncHandler
{
    public function addressObjectChanged(string $uri, string $etag, ?VCard $card): void
    {
    }

    public function addressObjectDeleted(string $uri): void
    {
    }

    public function getExistingVCardETags(): array
    {
        return [];
    }

    public function finalizeSync(): void
    {
    }
}

Config::init();

/**
 * address book carddav backend class
 */
class abook_carddav extends addressbook_backend {
    var $btype = 'local';
    var $bname = 'carddav';
    var $writeable = false;
      
    /* ========================== Private ======================= */
      
    /* Constructor */
    function abook_carddav($param) {
        $this->sname = _("carddav address book");
         
        if (is_array($param)) {
            if (!empty($param['name'])) {
               $this->sname = $param['name'];
            }

            if (isset($param['writeable'])) {
               $this->writeable = $param['writeable'];
            }

            if (isset($param['listing'])) {
               $this->listing = $param['listing'];
            }

            return $this->open(true);
        }
        else {
            return $this->set_error('Invalid argument to constructor');
        }
    }

    /**
     *
     */
    function open() {
      // backend open function
      $this->account = new Account(DISCOVERY_URI, USERNAME, PASSWORD);
	// Discover the addressbooks for that account
	try {
	    $discover = new Discovery();
	    $abooks = $discover->discoverAddressbooks($this->account);
	} catch (\Exception $e) {
	    return $this->set_error("!!! Error during addressbook discovery: " . $e->getMessage());
	}
	if (count($abooks) <= 0) {
	    return $this->set_error("Cannot proceed because no addressbooks were found - exiting");
	}
	//////////////////////////////////////////////////////////
	// THE FOLLOWING SHOWS HOW TO PERFORM A SYNCHRONIZATION //
	//////////////////////////////////////////////////////////
	$this->abook = $abooks[0];
	$this->synchandler = new NullSyncHandler();
	$this->syncmgr = new Sync();

	// initial sync - we don't have a sync-token yet
        $this->lastSyncToken = $this->syncmgr->synchronize($this->abook, $this->synchandler, ["FN", "N", "EMAIL", "ORG"], "");

      return true;
    }

    /**
     *
     */
    function close() {
      // ADDME: backend close function

    }
      
      
    /* ========================== Public ======================== */

    /**
     * Search address function
     * @param expr string search expression
     */
    function search($expr) {
        $ret = array();

	// ADDME: search by nickname function

        return $ret;
    }
     
    /**
     * Lookup alias
     * @param alias string
     */
    function lookup($value, $field=SM_ABOOK_FIELD_NICKNAME) {
        // if (empty($alias)) {
            return array();
        // }
	/*
         
        $alias = strtolower($alias);

	// ADDME: address lookup function

	$ret = array('nickname' => "nickname",
                         'name' => "firstname lastname",
    	            'firstname' => "firstname",
                     'lastname' => "lastname",
            		'email' => "email@address",
                	'label' => "info",
                      'backend' => $this->bnum,
                       'source' => $this->sname);

        return $ret;
	 */
    }

    /**
     * List all addresses
     * @return array
     */
    function list_addr() {
        $ret = array();

	// list all addresses having an email
	$all=$this->abook->query(['EMAIL' => "//"],["FN", "N", "EMAIL", "ORG"]);
	/*
	Returns an array of matched VCards:
	The keys of the array are the URIs of the vcards
	The values are associative arrays with keys etag (type: string) and vcard (type: VCard)
	*/
	foreach($all as $uri => $one) {
		$vcard = $one['vcard'];
		$names = $vcard->N->getParts();
		// last,first,additional,prefix,suffix
		array_push($ret,array(
			      'nickname' => $uri,
                                  'name' => (string)$vcard->FN,
                             'firstname' => (string)$names[1],
                              'lastname' => (string)$names[0],
                        	 'email' => (string)$vcard->EMAIL,
                        	 'label' => (string)$vcard->ORG,
                               'backend' => $this->bnum,
                        	'source' => $this->sname));
	}

        return $ret;
    }

    /**
     * Add address
     * @param userdata
     * @return boolean
     */
    function add($userdata) {
        if (!$this->writeable) {
            return $this->set_error(_("Addressbook is read-only"));
        }

        /* See if user exist already */
	/*
        $ret = $this->lookup($userdata['nickname']);
        if (!empty($ret)) {
            return $this->set_error(sprintf(_("User '%s' already exist"),
                                            $ret['nickname']));
        }
	 */
	try {
	    $vcard =  new VCard([
		'FN'  => $userdata['name'],
		'N'   => [$userdata['lastname'], $userdata['firstname'], '', '', ''],
		'EMAIL' => $userdata['email'],
		'ORG' => $userdata['label'],
	    ]);

		// insert address function
		$this->abook->createCard($vcard);
		// now a sync should return that card as well - lets see!
		$this->lastSyncToken = $this->syncmgr->synchronize($this->abook, $this->synchandler, ["FN", "N", "EMAIL", "ORG"], $this->lastSyncToken);

		// return true if operation is succesful.
		return true;
	} catch (\Exception $e) {
		// Return error message if operation fails
		return $this->set_error(_("Address add operation failed: ") . $e->getMessage());
       }
    }

    /**
     * Delete address
     * @param alias
     * @return boolean
     */
    function remove($alias) {
        if (!$this->writeable) {
            return $this->set_error(_("Addressbook is read-only"));
        }

	// ADD: delete address function

	// FIXME:
	// return true if operation is succesful.
	return true;
	// Return error message if operation fails
        return $this->set_error(_("Address delete operation failed"));
    }

    /**
     * Modify address
     * @param alias
     * @param userdata
     * @return boolean
     */
    function modify($alias, $userdata) {
        if (!$this->writeable) {
            return $this->set_error(_("Addressbook is read-only"));
        }

         /* See if user exist */
        $ret = $this->lookup($alias);
        if (empty($ret)) {
            return $this->set_error(sprintf(_("User '%s' does not exist"),
                                            $alias));
        }
	// ADD: modify address function

	// FIXME:
	// return true if operation is succesful.
	return true;
	// Return error message if operation fails
        return $this->set_error(_("Address modify operation failed"));
    }
} /* End of class abook_carddav */
?>