OCA\Polls\Service\SystemService

Complexity

Total Complexity

55

Size/Duplication

Total Lines	392
Duplicated Lines	0 %

Importance

Changes	6
Bugs	1	Features	1

10 Methods

Rating	Name	Duplication	Size	Complexity
A	isValidEmail()	0	2	2
A	getContactsGroups()	0	26	5
A	validateEmailAddress()	0	5	2
B	getContactsGroupMembers()	0	36	8
A	__construct()	0	10	1
A	getSiteGroups()	0	30	4
A	getSiteUsers()	0	21	4
B	getSiteUsersAndGroups()	0	48	8
C	validatePublicUsername()	0	72	14
B	getContacts()	0	32	7

<?php
/**
 * @copyright Copyright (c) 2017 Vinzenz Rosenkranz <vinzenz.rosenkranz@gmail.com>
 *
 * @author René Gieling <github@dartcafe.de>
 *
 * @license GNU AGPL version 3 or any later version
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as
 *  published by the Free Software Foundation, either version 3 of the
 *  License, or (at your option) any later version.
 *
 *  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
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

namespace OCA\Polls\Service;

use OCA\Polls\Exceptions\NotAuthorizedException;
use OCA\Polls\Exceptions\TooShortException;
use OCA\Polls\Exceptions\InvalidUsernameException;
use OCA\Polls\Exceptions\InvalidEmailAddress;

use OCP\IGroupManager;
use OCP\IUserManager;
use OCA\Polls\Db\Share;
use OCA\Polls\Db\ShareMapper;
use OCA\Polls\Db\VoteMapper;

class SystemService {

	/** @var IGroupManager */
	private $groupManager;

	/** @var IUserManager */
	private $userManager;

	/** @var VoteMapper */
	private $voteMapper;

	/** @var ShareMapper */
	private $shareMapper;

	/**
	 * SystemService constructor.
	 * @param IGroupManager $groupManager
	 * @param IUserManager $userManager
	 * @param VoteMapper $voteMapper
	 * @param ShareMapper $shareMapper
	 */
	public function __construct(
		IGroupManager $groupManager,
		IUserManager $userManager,
		VoteMapper $voteMapper,
		ShareMapper $shareMapper
	) {
		$this->groupManager = $groupManager;
		$this->userManager = $userManager;
		$this->voteMapper = $voteMapper;
		$this->shareMapper = $shareMapper;
	}

	/**
	 * Validate string as email address
	 * @NoAdminRequired
	 * @param string $emailAddress
	 * @return bool
	 */
	private function isValidEmail($emailAddress) {
		return (!preg_match('/^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$/', $emailAddress)) ? false : true;
	}


	/**
	 * Get a list of users
	 * @NoAdminRequired
	 * @param string $query
	 * @param array $skip - usernames to skip in return array
	 * @return Array
	 */
	public function getSiteUsers($query = '', $skip = []) {
		$users = [];
		foreach ($this->userManager->searchDisplayName($query) as $user) {
			if (!in_array($user->getUID(), $skip) && $user->isEnabled()) {
				$users[] = [
					'id' => $user->getUID(),
					'user' => $user->getUID(),
					'displayName' => $user->getDisplayName(),
					'organisation' => '',
					'emailAddress' => $user->getEMailAddress(),
					'desc' => 'User',
					'type' => 'user',
					'icon' => 'icon-user',
					'avatarURL' => '',
					'avatar' => '',
					'lastLogin' => $user->getLastLogin(),
					'cloudId' => $user->getCloudId()
				];
			}
		}
		return $users;
	}

	/**
	 * Get a list of user groups
	 * @NoAdminRequired
	 * @param string $query
	 * @param array $skip - group names to skip in return array
	 * @return Array
	 */
	public function getSiteGroups($query = '', $skip = []) {
		$groups = [];
		foreach ($this->groupManager->search($query) as $group) {
			if (!in_array($group->getGID(), $skip)) {
				try {
					// seems to work only from NC19 on
					$displayName = $group->getDisplayName();
				} catch (\Exception $e) {
					// fallback
					$displayName = $group->getGID();
				}

				$groups[] = [
					'id' => $group->getGID(),
					'user' => $group->getGID(),
					'organisation' => '',
					'displayName' => $displayName,
					'emailAddress' => '',
					'desc' => 'Group',
					'type' => 'group',
					'icon' => 'icon-group',
					'avatarURL' => '',
					'avatar' => '',
					'lastLogin' => '',
					'cloudId' => ''

				];
			}
		}
		return $groups;
	}

	/**
	 * Get a list of contacts
	 * @NoAdminRequired
	 * @param string $query
	 * @return Array
	 */
	public function getContacts($query = '') {
		$contacts = [];
		foreach (\OC::$server->getContactsManager()->search($query, ['FN', 'EMAIL', 'ORG', 'CATEGORIES']) as $contact) {
			if (!array_key_exists('isLocalSystemBook', $contact) && array_key_exists('EMAIL', $contact)) {
				$emailAdresses = $contact['EMAIL'];

				if (!is_array($emailAdresses)) {
					$emailAdresses = [$emailAdresses];
				} else {
					// take the first eMail address for now
					$emailAdresses = [$emailAdresses[0]];
				}

				foreach ($emailAdresses as $emailAddress) {
					$contacts[] = [
						'id' => $contact['UID'],
						'user' => $contact['FN'],
						'displayName' => $contact['FN'],
						'organisation' => isset($contact['ORG']) ? $contact['ORG'] : '',
						'emailAddress' => $emailAddress,
						'desc' => 'Contact',
						'type' => 'contact',
						'icon' => 'icon-mail',
						'avatarURL' => '',
						'avatar' => '',
						'lastLogin' => '',
						'cloudId' => '',
					];
				}
			}
		}
		return $contacts;
	}

	/**
	 * Get a list of contacts
	 * @NoAdminRequired
	 * @param string $query
	 * @return Array
	 */
	public function getContactsGroupMembers($query = '') {
		$contacts = [];
		foreach (\OC::$server->getContactsManager()->search($query, ['CATEGORIES']) as $contact) {
			if (
				   !array_key_exists('isLocalSystemBook', $contact)
				&& array_key_exists('EMAIL', $contact)
				&& in_array($query, explode(',', $contact['CATEGORIES']))
			) {
				$emailAdresses = $contact['EMAIL'];

				if (!is_array($emailAdresses)) {
					$emailAdresses = [$emailAdresses];
				} else {
					// take the first eMail address for now
					$emailAdresses = [$emailAdresses[0]];
				}

				foreach ($emailAdresses as $emailAddress) {
					$contacts[] = [
						'id' => $contact['UID'],
						'user' => $contact['FN'],
						'displayName' => $contact['FN'],
						'organisation' => isset($contact['ORG']) ? $contact['ORG'] : '',
						'emailAddress' => $emailAddress,
						'desc' => 'Contact',
						'type' => 'contact',
						'icon' => 'icon-mail',
						'avatarURL' => '',
						'avatar' => '',
						'lastLogin' => '',
						'cloudId' => '',
					];
				}
			}
		}
		return $contacts;
	}

	/**
	 * Get a list of contact groups
	 * @NoAdminRequired
	 * @param string $query
	 * @return Array
	 */
	public function getContactsGroups($query = '') {
		$contactGroups = [];
		$foundContacts = [];

		foreach (\OC::$server->getContactsManager()->search($query, ['CATEGORIES']) as $contact) {
			foreach (explode(',', $contact['CATEGORIES']) as $contactGroup) {
				if (strpos($contactGroup, $query) === 0 && !in_array($contactGroup, $foundContacts)) {
					$foundContacts[] = $contactGroup;
					$contactGroups[] = [
						'id' => 'contactgroup_' +$contactGroup,
						'user' => $contactGroup,
						'displayName' => $contactGroup,
						'organisation' => '',
						'emailAddress' => '',
						'desc' => 'Contact Group',
						'type' => 'contactGroup',
						'icon' => 'icon-group',
						'avatarURL' => '',
						'avatar' => '',
						'lastLogin' => '',
						'cloudId' => '',
					];
				};
			}
		}
		return $contactGroups;
	}


	/**
	 * Get a combined list of NC users, groups and contacts
	 * @NoAdminRequired
	 * @param string $query
	 * @param bool $getGroups - search in groups
	 * @param bool $getUsers - search in site users
	 * @param bool $getContacts - search in contacs
	 * @param bool $getContactGroups - search in contacs
	 * @param array $skipGroups - group names to skip in return array
	 * @param array $skipUsers - user names to skip in return array
	 * @return Array
	 */
	public function getSiteUsersAndGroups(
		$query = '',
		$getGroups = true,
		$getUsers = true,
		$getContacts = true,
		$getContactGroups = true,

The parameter $getContactGroups is not used and could be removed.

		$getMail = false,
		$skipGroups = [],
		$skipUsers = []
	) {
		$list = [];

		if ($getMail && $this->isValidEmail($query)) {
			$list[] = [
				'id' => '',
				'user' => '',
				'organisation' => '',
				'displayName' => '',
				'emailAddress' => $query,
				'desc' => $query,
				'type' => 'email',
				'icon' => 'icon-mail',
				'avatarURL' => '',
				'avatar' => '',
				'lastLogin' => '',
				'cloudId' => ''

			];
		}
		if ($getGroups) {
			$list = array_merge($list, $this->getSiteGroups($query, $skipGroups));
		}

		if ($getUsers) {
			$list = array_merge($list, $this->getSiteUsers($query, $skipUsers));
		}

		if (\OC::$server->getContactsManager()->isEnabled()) {
			if ($getContacts) {
				$list = array_merge($list, $this->getContacts($query, $skipUsers));

The call to OCA\Polls\Service\SystemService::getContacts() has too many arguments starting with $skipUsers.

			}

			if ($getContacts) {
				$list = array_merge($list, $this->getContactsGroups($query, $skipGroups));

The call to OCA\Polls\Service\SystemService::getContactsGroups() has too many arguments starting with $skipGroups.

			}
		}

		return $list;
	}

	/**
	 * Validate it the user name is reservrd
	 * return false, if this username already exists as a user or as
	 * a participant of the poll
	 * @NoAdminRequired
	 * @return Boolean
	 * @throws InvalidEmailAddress
	 */
	public function validateEmailAddress($emailAddress) {
		if (!$this->isValidEmail($emailAddress)) {
			throw new InvalidEmailAddress;
		}
		return true;
	}


	/**
	 * Validate it the user name is reservrd
	 * return false, if this username already exists as a user or as
	 * a participant of the poll
	 * @NoAdminRequired
	 * @return Boolean
	 * @throws NotAuthorizedException
	 * @throws TooShortException
	 * @throws InvalidUsernameException
	 */
	public function validatePublicUsername($pollId, $userName, $token) {

		// return forbidden, if $pollId does not match the share's pollId, force int compare
		if (intval($this->shareMapper->findByToken($token)->getPollId()) !== intVal($pollId)) {
			throw new NotAuthorizedException;
		}

		// return forbidden, if the length of the userame is lower than 3 characters
		if (strlen(trim($userName)) < 3) {
			return new TooShortException('Username must have at least 3 characters');
		}

		$list = [];

		// get all groups
		$groups = $this->groupManager->search('');
		foreach ($groups as $group) {
			$list[] = [
				'id' => $group->getGID(),
				'user' => $group->getGID(),
				'type' => 'group',
				'displayName' => $group->getGID(),
			];
		}

		// get all users
		$users = $this->userManager->searchDisplayName('');
		foreach ($users as $user) {
			$list[] = [
				'id' => $user->getUID(),
				'user' => $user->getUID(),
				'type' => 'user',
				'displayName' => $user->getDisplayName(),
			];
		}

		// get all participants
		$votes = $this->voteMapper->findParticipantsByPoll($pollId);
		foreach ($votes as $vote) {
			if ($vote->getUserId() !== '' && $vote->getUserId() !== null) {
				$list[] = [
					'id' => $vote->getUserId(),
					'user' => $vote->getUserId(),
					'type' => 'participant',
					'displayName' => $vote->getUserId(),
				];
			}
		}

		// get all shares for this poll
		$shares = $this->shareMapper->findByPoll($pollId);
		foreach ($shares as $share) {
			if ($share->getUserId() !== '' && $share->getUserId() !== null) {
				$list[] = [
					'id' => $share->getUserId(),
					'user' => $share->getUserId(),
					'type' => 'share',
					'displayName' => $share->getUserId(),
				];
			}
		}

		// check if the username is contained inside the generated list
		// return forbidden, if list contains requested username
		foreach ($list as $element) {
			if (strtolower(trim($userName)) === strtolower(trim($element['id'])) || strtolower(trim($userName)) === strtolower(trim($element['displayName']))) {
				throw new InvalidUsernameException;
			}
		}

		// return true, if username is allowed
		return true;
	}
}