Sending to nextcloud groups

.gitignore

@@ -31,3 +31,6 @@ translations.js
 
 # JS coverage
 coverage/
+
+# vim
+.*.sw?

lib/AppInfo/Application.php

@@ -33,6 +33,8 @@
 use OCA\Mail\Service\MailManager;
 use OCA\Mail\Service\MailTransmission;
 use OCA\Mail\Service\UserPreferenceSevice;
+use OCA\Mail\Service\Group\IGroupService;
+use OCA\Mail\Service\Group\NextcloudGroupService;
 use OCP\AppFramework\App;
 use OCP\Util;
 
@@ -71,6 +73,8 @@ private function initializeAppContainer() {
 
 		$container->registerAlias('ErrorMiddleware', ErrorMiddleware::class);
 		$container->registerMiddleWare('ErrorMiddleware');
+
+		$container->registerAlias(IGroupService::class, NextcloudGroupService::class);
 	}
 
 }

lib/Controller/AccountsController.php

@@ -7,6 +7,7 @@
  * @author Lukas Reschke <lukas@owncloud.com>
  * @author Robin McCorkell <rmccorkell@karoshi.org.uk>
  * @author Thomas Müller <thomas.mueller@tmit.eu>
+ * @author Matthias Rella <mrella@pisys.eu>
  *
  * Mail
  *
@@ -38,6 +39,7 @@
 use OCA\Mail\Service\AliasesService;
 use OCA\Mail\Service\Logger;
 use OCA\Mail\Service\SetupService;
+use OCA\Mail\Service\GroupsIntegration;
 use OCP\AppFramework\Controller;
 use OCP\AppFramework\Http;
 use OCP\IL10N;
@@ -49,6 +51,9 @@ class AccountsController extends Controller {
 	/** @var AccountService */
 	private $accountService;
 
+	/** @var GroupsIntegration */
+	private $groupsIntegration;
+
 	/** @var string */
 	private $currentUserId;
 
@@ -80,10 +85,11 @@ class AccountsController extends Controller {
 	 * @param ICrypto $crypto
 	 * @param SetupService $setup
 	 */
-	public function __construct($appName, IRequest $request, AccountService $accountService, $UserId, Logger $logger, IL10N $l10n, ICrypto $crypto, AliasesService $aliasesService, IMailTransmission $mailTransmission, SetupService $setup
+	public function __construct($appName, IRequest $request, AccountService $accountService, GroupsIntegration $groupsIntegration, $UserId, Logger $logger, IL10N $l10n, ICrypto $crypto, AliasesService $aliasesService, IMailTransmission $mailTransmission, SetupService $setup
 	) {
 		parent::__construct($appName, $request);
 		$this->accountService = $accountService;
+		$this->groupsIntegration = $groupsIntegration;
 		$this->currentUserId = $UserId;
 		$this->logger = $logger;
 		$this->l10n = $l10n;
@@ -253,7 +259,11 @@ public function send($accountId, $folderId, $subject, $body, $to, $cc, $bcc, $dr
 		$account = $this->accountService->find($this->currentUserId, $accountId);
 		$alias = $aliasId ? $this->aliasesService->find($aliasId, $this->currentUserId) : null;
 
-		$messageData = NewMessageData::fromRequest($account, $to, $cc, $bcc, $subject, $body, $attachments);
+		$expandedTo = $this->groupsIntegration->expand($to);
+		$expandedCc = $this->groupsIntegration->expand($cc);
+		$expandedBcc = $this->groupsIntegration->expand($bcc);
+
+		$messageData = NewMessageData::fromRequest($account, $expandedTo, $expandedCc, $expandedBcc, $subject, $body, $attachments);
 		$repliedMessageData = new RepliedMessageData($account, $folderId, $messageId);
 
 		try {

lib/Service/AutoCompletion/AutoCompleteService.php

@@ -2,6 +2,7 @@
 
 /**
  * @author Christoph Wurst <christoph@winzerhof-wurst.at>
+ * @author Matthias Rella <mrella@pisys.eu>
  *
  * Mail
  *
@@ -23,22 +24,28 @@
 
 use OCA\Mail\Db\CollectedAddress;
 use OCA\Mail\Service\ContactsIntegration;
+use OCA\Mail\Service\GroupsIntegration;
 
 class AutoCompleteService {
 
 	/** @var ContactsIntegration */
 	private $contactsIntegration;
 
+	/** @var GroupsIntegration */
+	private $groupsIntegration;
+
 	/** @var AddressCollector */
 	private $addressCollector;
 
-	public function __construct(ContactsIntegration $ci, AddressCollector $ac) {
+	public function __construct(ContactsIntegration $ci, GroupsIntegration $gi, AddressCollector $ac) {
 		$this->contactsIntegration = $ci;
+		$this->groupsIntegration = $gi;
 		$this->addressCollector = $ac;
 	}
 
 	public function findMatches($term) {
 		$recipientsFromContacts = $this->contactsIntegration->getMatchingRecipient($term);
+		$recipientGroups = $this->groupsIntegration->getMatchingGroups($term);
 		$fromCollector = $this->addressCollector->searchAddress($term);
 
 		// Convert collected addresses into same format as CI creates
@@ -50,7 +57,7 @@ public function findMatches($term) {
 			];
 		}, $fromCollector);
 
-		return array_merge($recipientsFromContacts, $recipientsFromCollector);
+		return array_merge($recipientsFromContacts, $recipientsFromCollector, $recipientGroups);
 	}
 
 }

lib/Service/Group/IGroupService.php

@@ -0,0 +1,50 @@
+<?php
+
+/**
+ * @author Matthias Rella <mrella@pisys.eu>
+ *
+ * Mail
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program 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, version 3,
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCA\Mail\Service\Group;
+
+interface IGroupService {
+
+	/**
+	 * Search the service's groups.
+	 *
+	 * @param string $term
+	 * @return array of matched groups as associative arrays
+	 */
+	public function search($term);
+
+	/**
+	 * Get the group's namespace.
+	 *
+	 * @return string
+	 */
+	public function getNamespace();
+
+	/**
+	 * Get the group's users.
+	 *
+	 * @param string $groupId 
+	 * @return array with group's users as associative arrays 
+	 */
+	public function getUsers($groupId);
+
+}
+

lib/Service/Group/NextcloudGroupService.php

@@ -0,0 +1,81 @@
+<?php
+
+/**
+ * @author Matthias Rella <mrella@pisys.eu>
+ *
+ * Mail
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program 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, version 3,
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCA\Mail\Service\Group;
+
+use OCP\IGroupManager;
+use OCA\Mail\Exception\ServiceException;
+
+class NextcloudGroupService implements IGroupService {
+
+	/**
+	 * Nextcloud's group manager
+	 *
+	 * @var IGroupManager
+	 */
+	private $groupManager;
+
+	/**
+	 * Group's namespace
+	 *
+	 * @var string
+	 */
+	private $namespace = "Nextcloud";
+
+	public function __construct(IGroupManager $groupManager) {
+		$this->groupManager = $groupManager;
+	}
+
+	public function getNamespace() {
+		return $this->namespace;
+	}
+
+	public function search($term) {
+		$groups = $this->groupManager->search($term);
+
+		return array_map(
+			function($g) {
+				return [
+					'id' => $g->getGID(),
+					'name' => $g->getDisplayName()
+				];
+			},
+			$groups
+		);
+	}
+
+	public function getUsers($groupId) {
+		if(!$this->groupManager->groupExists($groupId)) {
+			throw new ServiceException("$groupId ({$this->getNamespace()}) does not exist");
+		}
+		$users = $this->groupManager->get($groupId)->getUsers();
+		return array_map(
+			function($user) {
+				return [
+					'id' => $user->getUID(),
+					'name' => $user->getDisplayName(),
+					'email' => $user->getEMailAddress()
+				];
+			},
+			$users
+		);
+	}
+}

lib/Service/GroupsIntegration.php

@@ -0,0 +1,108 @@
+<?php
+
+/**
+ * @author Matthias Rella <mrella@pisys.eu>
+ *
+ * Mail
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program 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, version 3,
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCA\Mail\Service;
+
+use OCA\Mail\Service\Group\IGroupService;
+use OCA\Mail\Exception\ServiceException;
+
+class GroupsIntegration {
+
+	/**
+	 * The services to get groups from
+	 *
+	 * @var IGroupService[]
+	 */
+	private $groupServices = [];
+
+	public function __construct(IGroupService $groupService) {
+		$this->groupServices[] = $groupService;
+	}
+
+	/**
+	 * Extracts all matching contacts with email address and name
+	 *
+	 * @param string $term
+	 * @return array
+	 */
+	public function getMatchingGroups($term) {
+		$receivers = [];
+		foreach ($this->groupServices as $gs) {
+			$result = $gs->search($term);
+			foreach ($result as $g) {
+				$gid = $this->servicePrefix($gs) . $g['id'];
+				$receivers[] = [
+					'id' => $gid,
+					'label' => $g['name'] . " (" . $gs->getNamespace() . ")",
+					'value' => $gid,
+					'photo' => null,
+				];
+			}
+		}
+
+		return $receivers;
+	}
+
+	/**
+	 * Returns the prefix for the group service.
+	 *
+	 * @param IGroupService $gs
+	 * @return string
+	 */
+	public function servicePrefix(IGroupService $gs) {
+		if (empty($gs->getNamespace())) {
+			throw new ServiceException('GroupService has no namespace');
+		}
+		return strtolower($gs->getNamespace()) . ":";
+	}
+
+	/**
+	 * Expands a string of group names to its members email addresses.
+	 *
+	 * @param string $recipients
+	 * @return string
+	 */
+	public function expand($recipients) {
+		return array_reduce($this->groupServices,
+			function($carry, $service) {
+			return preg_replace_callback(
+				'/' . preg_quote($this->servicePrefix($service)) . '([\w\d ]+)(,?)/',
+				function($matches) use ($service) {
+				if (empty($matches[1])) {
+					return '';
+				}
+				$members = $service->getUsers($matches[1]);
+				if (empty($members)) {
+					throw new ServiceException($matches[1] . " ({$service->getNamespace()}) has no members");
+				}
+				$addresses = [];
+				foreach ($members as $m) {
+					if (!empty($m['email'])) {
+						$addresses[] = $m['email'];
+					}
+				}
+				return implode(',', $addresses)
+					. (!empty($matches[2]) && !empty($addresses) ? ',' : '');
+			}, $carry);
+		}, $recipients);
+	}
+
+}