OCA\Circles\Service\MiscService

Complexity

Total Complexity

30

Size/Duplication

Total Lines	239
Duplicated Lines	2.09 %

Coupling/Cohesion

Components	3
Dependencies	1

Importance

Changes	6
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	log()	0	8	1
A	get()	0	7	2
A	mustContains()	0	11	4
A	fail()	0	8	1
A	success()	0	6	1
A	getRealUserId()	0	8	2
A	getDisplay()	0	8	1
A	getDisplayMember()	0	11	3
A	getDisplayContact()	0	8	2
A	getContactData()	0	16	2
B	getDisplayContactFromArray()	5	13	5
A	getDisplayName()	0	12	3
A	asyncAndLeaveClientOutOfThis()	0	14	2

<?php
/**
 * Circles - Bring cloud-users closer together.
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Maxence Lange <maxence@pontapreta.net>
 * @copyright 2017
 * @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\Circles\Service;

use Exception;
use OC\User\NoUserException;
use OCA\Circles\Exceptions\MissingKeyInArrayException;
use OCA\Circles\Model\Member;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\DataResponse;
use OCP\ILogger;
use OCP\IUserManager;

class MiscService {

	/** @var ILogger */
	private $logger;

	/** @var string */
	private $appName;

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

	public function __construct(ILogger $logger, $appName, IUserManager $userManager) {
		$this->logger = $logger;
		$this->appName = $appName;
		$this->userManager = $userManager;
	}

	public function log($message, $level = 2) {
		$data = array(
			'app'   => $this->appName,
			'level' => $level
		);

		$this->logger->log($level, $message, $data);
	}


	/**
	 * @param $arr
	 * @param $k
	 *
	 * @return string|array
	 */
	public static function get($arr, $k) {
		if (!key_exists($k, $arr)) {
			return '';
		}

		return $arr[$k];
	}


	public static function mustContains($data, $arr) {
		if (!is_array($arr)) {
			$arr = [$arr];
		}

		foreach ($arr as $k) {
			if (!key_exists($k, $data)) {
				throw new MissingKeyInArrayException('missing_key_in_array');
			}
		}
	}


	/**
	 * @param $data
	 *
	 * @return DataResponse
	 */
	public function fail($data) {
		$this->log(json_encode($data));

		return new DataResponse(
			array_merge($data, array('status' => 0)),
			Http::STATUS_NON_AUTHORATIVE_INFORMATION
		);
	}


	/**
	 * @param $data
	 *
	 * @return DataResponse
	 */
	public function success($data) {
		return new DataResponse(
			array_merge($data, array('status' => 1)),
			Http::STATUS_CREATED
		);
	}


	/**
	 * return the real userId, with its real case
	 *
	 * @param $userId
	 *
	 * @return string
	 * @throws NoUserException
	 */
	public function getRealUserId($userId) {
		if (!$this->userManager->userExists($userId)) {
			throw new NoUserException();
		}

		return $this->userManager->get($userId)
								 ->getUID();
	}


	/**
	 * @param string $ident
	 * @param int $type
	 *
	 * @return string
	 */
	public static function getDisplay($ident, $type) {
		$display = $ident;

		self::getDisplayMember($display, $ident, $type);
		self::getDisplayContact($display, $ident, $type);

		return $display;
	}


	/**
	 * @param string $display
	 * @param string $ident
	 * @param int $type
	 */
	private static function getDisplayMember(&$display, $ident, $type) {
		if ($type !== Member::TYPE_USER) {
			return;
		}

		$user = \OC::$server->getUserManager()
							->get($ident);
		if ($user !== null) {
			$display = $user->getDisplayName();
		}
	}


	/**
	 * @param string $display
	 * @param string $ident
	 * @param int $type
	 */
	private static function getDisplayContact(&$display, $ident, $type) {
		if ($type !== Member::TYPE_CONTACT) {
			return;
		}

		$contact = self::getContactData($ident);

The method OCA\Circles\Service\MiscService::getContactData() has been deprecated with message: - move this somewhere else, no static if possible

		self::getDisplayContactFromArray($display, $contact);
	}


	/**
	 * @param $ident
	 *
	 * @deprecated - move this somewhere else, no static if possible
	 * @return mixed|string
	 */
	public static function getContactData($ident) {
		list($userId, $contactId) = explode(':', $ident);

		try {
			/** @noinspection PhpUnnecessaryFullyQualifiedNameInspection */
			$contactApp = new \OCA\DAV\AppInfo\Application();
			$cm = \OC::$server->getContactsManager();
			$contactApp->setupContactsProvider($cm, $userId);
			$contact = $cm->search($contactId, ['UID']);

			return array_shift($contact);
		} catch (Exception $e) {

Consider adding a comment why this CATCH block is empty.

		}

		return null;
	}


	/**
	 * @param string $display
	 * @param array $contact
	 */
	private static function getDisplayContactFromArray(&$display, $contact) {
		if (key_exists('FN', $contact) && $contact['FN'] !== '') {
			$display = $contact['FN'];

			return;
		}

		if (key_exists('EMAIL', $contact) && $contact['EMAIL'] !== '') {

This code seems to be duplicated across your project.

			$display = $contact['EMAIL'];

			return;
		}
	}

	/**
	 * return Display Name if user exists and display name exists.
	 * returns Exception if user does not exist.
	 *
	 * However, with noException set to true, will return userId even if user does not exist
	 *
	 * @param $userId
	 * @param bool $noException
	 *
	 * @return string
	 * @throws NoUserException
	 */
	public function getDisplayName($userId, $noException = false) {
		$user = $this->userManager->get($userId);
		if ($user === null) {
			if ($noException) {
				return $userId;
			} else {
				throw new NoUserException();
			}
		}

		return $user->getDisplayName();
	}


	/**
	 * Hacky way to async the rest of the process without keeping client on hold.
	 *
	 * @param string $result
	 */
	public function asyncAndLeaveClientOutOfThis($result = '') {
		if (ob_get_contents() !== false) {
			ob_end_clean();
		}

		header('Connection: close');
		ignore_user_abort();
		ob_start();
		echo($result);
		$size = ob_get_length();
		header('Content-Length: ' . $size);
		ob_end_flush();
		flush();
	}

}