Nextcloud address book

plugins/nextcloud/NextcloudAddressBook.php

@@ -0,0 +1,207 @@
+<?php
+
+use RainLoop\Providers\AddressBook\Classes\Contact;
+
+class NextcloudAddressBook implements \RainLoop\Providers\AddressBook\AddressBookInterface
+{
+	use RainLoop\Providers\AddressBook\CardDAV;
+
+	private const SETTINGS_KEY = 'nextcloudAddressBookUri';
+
+	private string $defaultUri;
+	private string $defaultName;
+	private string $defaultDescription;
+	private bool $ignoreSystemAddressBook;
+	private $contactsManager;
+
+	function __construct(string $defaultUri = 'webmail', string $defaultName = 'WebMail', string $defaultDescription = 'Recipients from snappymail', bool $ignoreSystemAddressBook = true)
+	{
+		$this->defaultUri = $defaultUri;
+		$this->defaultName = $defaultName;
+		$this->defaultDescription = $defaultDescription;
+		$this->ignoreSystemAddressBook = $ignoreSystemAddressBook;
+
+		$this->GetSavedAddressBookKey();
+	}
+
+	private function getContactsManager()
+	{
+		if ($this->contactsManager == null) {
+			$this->contactsManager = \OC::$server->getContactsManager();
+		}
+
+		return $this->contactsManager;
+	}
+
+	private function GetSavedAddressBookKey() : string
+	{
+		if ($this->ignoreSystemAddressBook) {
+			foreach ($this->getContactsManager()->getUserAddressBooks() as $addressBook) {
+				if ($addressBook->isSystemAddressBook()) {
+					$this->getContactsManager()->unregisterAddressBook($addressBook);
+				}
+			}
+		}
+
+		$uid = \OC::$server->getUserSession()->getUser()->getUID();
+		$cardDavBackend = \OC::$server->get(\OCA\DAV\CardDAV\CardDavBackend::class);
+		$principalUri = 'principals/users/' . $uid;
+		$uri = $this->GetSavedUri();
+		$addressBookId = $cardDavBackend->getAddressBooksByUri($principalUri, $uri);
+
+		if ($addressBookId === null) {
+			return $cardDavBackend->createAddressBook($principalUri, $uri, array_filter([
+				'{DAV:}displayname' => $this->defaultName,
+				'{urn:ietf:params:xml:ns:carddav}addressbook-description' => $this->defaultDescription,
+			]));
+		}
+
+		return $addressBookId['id'];
+	}
+
+	public function IsSupported() : bool
+	{
+		// Maybe just return true, contacts app is just a frontend
+		// return \OC::$server->getAppManager()->isEnabledForUser('contacts');
+		return true;
+	}
+
+	public function SetEmail(string $sEmail) : bool
+	{
+		return true;
+	}
+
+	public function Sync() : bool
+	{
+		return false;
+	}
+
+	public function Export(string $sType = 'vcf') : bool
+	{
+		return false;
+	}
+
+	public function ContactSave(Contact $oContact) : bool
+	{
+		return false;
+	}
+
+	public function DeleteContacts(array $aContactIds) : bool
+	{
+		return false;
+	}
+
+	public function DeleteAllContacts(string $sEmail) : bool
+	{
+		return false;
+	}
+
+	public function GetContacts(int $iOffset = 0, int $iLimit = 20, string $sSearch = '', int &$iResultCount = 0) : array
+	{
+		return [];
+	}
+
+	public function GetContactByEmail(string $sEmail) : ?Contact
+	{
+		return null;
+	}
+
+	public function GetContactByID($mID, bool $bIsStrID = false) : ?Contact
+	{
+		return null;
+	}
+
+	public function GetSuggestions(string $sSearch, int $iLimit = 20) : array
+	{
+		return [];
+	}
+
+	private function GetEmailObjects(array $aEmails) : array
+	{
+		$aEmailsObjects = \array_map(function ($mItem) {
+			$oResult = null;
+			try {
+				$oResult = \MailSo\Mime\Email::Parse(\trim($mItem));
+			} catch (\Throwable $oException) {
+				unset($oException);
+			}
+			return $oResult;
+		}, $aEmails);
+
+		$aEmailsObjects = \array_filter($aEmailsObjects, function ($oItem) {
+			return !!$oItem;
+		});
+		return $aEmailsObjects;
+	}
+
+	/**
+	 * Add/increment email address usage
+	 * Handy for "most used" sorting suggestions in PdoAddressBook
+	 */
+	public function IncFrec(array $aEmails, bool $bCreateAuto = true) : bool
+	{
+		if ($bCreateAuto) {
+			$aEmailsObjects = $this->GetEmailObjects($aEmails);
+
+			if (!count($aEmailsObjects)) {
+				return false;
+			}
+
+			foreach ($aEmailsObjects as $oEmail) {
+				$this->createOrUpdateContact($oEmail);
+			}
+
+			return true;
+		}
+
+		return false;
+	}
+
+	private function createOrUpdateContact($oEmail)
+	{
+		if ('' === \trim($oEmail->GetEmail())) {
+			return;
+		}
+		$sEmail = \trim($oEmail->GetEmail(true));
+		$existingResults = $this->getContactsManager()->search($sEmail, ['EMAIL'], ['strict_search' => true]);
+
+		if (!empty($existingResults)) {
+			return;
+		}
+
+		$properties = [
+			'EMAIL' => $sEmail,
+			'FN' => $sEmail
+		];
+
+		if ('' !== \trim($oEmail->GetDisplayName())) {
+			$properties['FN'] = $oEmail->GetDisplayName();
+		}
+		$this->getContactsManager()->createOrUpdate($properties, $this->GetSavedAddressBookKey());
+	}
+
+	public function Test() : string
+	{
+		return '';
+	}
+
+	private function Account() : \RainLoop\Model\Account
+	{
+		return \RainLoop\Api::Actions()->getAccountFromToken();
+	}
+
+	private function SettingsProvider() : \RainLoop\Providers\Settings
+	{
+		return \RainLoop\Api::Actions()->SettingsProvider(true);
+	}
+
+	private function Settings() : \RainLoop\Settings
+	{
+		return $this->SettingsProvider()->Load($this->Account());
+	}
+
+	private function GetSavedUri() : string
+	{
+		return $this->Settings()->GetConf(self::SETTINGS_KEY, $this->defaultUri);
+	}
+}

plugins/nextcloud/README.md

@@ -0,0 +1,14 @@
+# SnappyMail plugin for nextcloud
+
+## Nextcloud Addressbook to save recipients' contacts
+
+ This plugin can let user to choose which nextcloud addressbook to use save recipients (requires enableing snappyMail contacts) . This is opt-in feature (enabled by admin). After admin enable this, user will find a dropdown in his/her SnappyMail's `Contacts` section, containing all his/her addressbook. It works better with [Nextcloud Contacts App](https://github.com/nextcloud/contacts/)
+
+### Admin settings
+
+- `enableNcAddressbook` : Enable: save recipient contacts into nextcloud addressbook feature. User will see a new section into her/his `Contacts` setting, so s/he can choose Nextcloud addressbook to save recipients' contacts. Default value: `false`
+- `disableSnappymailContactsUI` : Hide SnappyMail internal addressbook accesspoint. This is recomended if nextcloud addressbook to save recipients contacts is being used. So, users won't be confused to having multiple addressbook options. Default value: `false`
+- `defaultNCAddressbookUri` : Default nextcloud addressbook URI to save recipients' contacts. Ignored if `enableNcAddressbook` is set to false. User can change this value for her/his account. Default value: `webmail`
+- `defaultNCAddressbookName` : Default nextcloud addressbook Name to save recipients' contacts. Ignored if `enableNcAddressbook` is set to false. User can change this value for her/his account. Default value: `WebMail`
+- `defaultNCAddressbookDescription` : Default nextcloud addressbook description to save recipients' contacts. Ignored if `enableNcAddressbook` is set to false. User can change this value for her/his account. Default value: `Recipients from snappymail`
+