OCA\Circles\Service\RemoteUpstreamService

Complexity

Total Complexity

31

Size/Duplication

Total Lines	286
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	15

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	17	1
A	broadcastWrapper()	0	17	3
A	broadcastEvent()	0	22	1
A	getEventsByToken()	0	3	1
A	synchronize()	0	7	1
A	synchronizeCircles()	0	12	3
A	removeDeprecatedCircles()	0	14	4
A	checkCircle()	0	8	2
C	confirmCircleStatus()	0	76	13
A	syncEvents()	0	3	1
A	removeDeprecatedEvents()	0	4	1

<?php

declare(strict_types=1);


/**
 * 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@artificial-owl.com>
 * @copyright 2021
 * @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 daita\MySmallPhpTools\Exceptions\RequestContentException;
use daita\MySmallPhpTools\Exceptions\RequestNetworkException;
use daita\MySmallPhpTools\Exceptions\RequestResultNotJsonException;
use daita\MySmallPhpTools\Exceptions\RequestResultSizeException;
use daita\MySmallPhpTools\Exceptions\RequestServerException;
use daita\MySmallPhpTools\Exceptions\SignatoryException;
use daita\MySmallPhpTools\Exceptions\SignatureException;
use daita\MySmallPhpTools\Model\Nextcloud\nc21\NC21Request;
use daita\MySmallPhpTools\Model\Request;
use daita\MySmallPhpTools\Model\SimpleDataStore;
use daita\MySmallPhpTools\Traits\Nextcloud\nc21\TNC21Request;
use Exception;
use OCA\Circles\Db\DeprecatedCirclesRequest;
use OCA\Circles\Db\DeprecatedMembersRequest;
use OCA\Circles\Db\RemoteWrapperRequest;
use OCA\Circles\Exceptions\GSStatusException;
use OCA\Circles\Exceptions\RemoteNotFoundException;
use OCA\Circles\Exceptions\RemoteResourceNotFoundException;
use OCA\Circles\Exceptions\UnknownRemoteException;
use OCA\Circles\GlobalScale\CircleStatus;
use OCA\Circles\Model\DeprecatedCircle;
use OCA\Circles\Model\GlobalScale\GSEvent;
use OCA\Circles\Model\GlobalScale\GSWrapper;
use OCA\Circles\Model\Remote\RemoteEvent;
use OCA\Circles\Model\Remote\RemoteInstance;
use OCA\Circles\Model\Remote\RemoteWrapper;
use OCP\IURLGenerator;


/**
 * Class RemoteUpstreamService
 *
 * @package OCA\Circles\Service
 */
class RemoteUpstreamService {


	use TNC21Request;


	/** @var IURLGenerator */
	private $urlGenerator;

	/** @var RemoteWrapperRequest */
	private $remoteWrapperRequest;

	/** @var DeprecatedCirclesRequest */
	private $circlesRequest;

	/** @var DeprecatedMembersRequest */
	private $membersRequest;

	/** @var RemoteService */
	private $remoteService;

	/** @var RemoteEventService */
	private $remoteEventService;

	/** @var ConfigService */
	private $configService;


	public function __construct(
		IURLGenerator $urlGenerator,
		RemoteWrapperRequest $remoteWrapperRequest,
		DeprecatedCirclesRequest $circlesRequest,
		DeprecatedMembersRequest $membersRequest,
		RemoteService $remoteService,
		RemoteEventService $remoteEventService,
		ConfigService $configService
	) {
		$this->urlGenerator = $urlGenerator;
		$this->remoteWrapperRequest = $remoteWrapperRequest;
		$this->circlesRequest = $circlesRequest;
		$this->membersRequest = $membersRequest;
		$this->remoteService = $remoteService;
		$this->remoteEventService = $remoteEventService;
		$this->configService = $configService;
	}


	/**
	 * @param RemoteWrapper $wrapper
	 */
	public function broadcastWrapper(RemoteWrapper $wrapper): void {
		$status = RemoteWrapper::STATUS_FAILED;

		try {
			$this->broadcastEvent($wrapper->getEvent(), $wrapper->getInstance());
			$status = GSWrapper::STATUS_DONE;
		} catch (Exception $e) {

Consider adding a comment why this CATCH block is empty.

		}

		if ($wrapper->getSeverity() === GSEvent::SEVERITY_HIGH) {
			$wrapper->setStatus($status);
		} else {
			$wrapper->setStatus(GSWrapper::STATUS_OVER);
		}

		$this->remoteWrapperRequest->update($wrapper);
	}


	/**
	 * @param RemoteEvent $event
	 * @param string $instance
	 *
	 * @throws RequestNetworkException
	 * @throws SignatoryException
	 * @throws SignatureException
	 * @throws RemoteNotFoundException
	 * @throws RemoteResourceNotFoundException
	 * @throws UnknownRemoteException
	 */
	public function broadcastEvent(RemoteEvent $event, string $instance): void {
//		if ($this->configService->isLocalInstance($instance)) {
//			$request = new NC21Request('', Request::TYPE_POST);
//			$this->configService->configureRequest($request, 'circles.RemoteWrapper.broadcast');
//		} else {
//			$path = $this->urlGenerator->linkToRoute('circles.RemoteWrapper.broadcast');
//			$request = new NC21Request($path, Request::TYPE_POST);
//			$this->configService->configureRequest($request);
//			$request->setInstance($instance);
//		}

//		$request->setDataSerialize($event);

		$data = $this->remoteService->requestRemoteInstance(
			$instance,
			RemoteInstance::INCOMING,
			Request::TYPE_POST,
			$event
		);

		$event->setResult(new SimpleDataStore($this->getArray('incoming', $data, [])));
	}


	/**
	 * @param string $token
	 *
	 * @return RemoteWrapper[]
	 */
	public function getEventsByToken(string $token): array {
		return $this->remoteWrapperRequest->getByToken($token);
	}



	//
	//
	//
	//
	//

	/**
	 * @param array $sync
	 *
	 * @throws GSStatusException
	 */
	public function synchronize(array $sync) {
		$this->configService->getGSStatus();

		$this->synchronizeCircles($sync);
		$this->removeDeprecatedCircles();
		$this->removeDeprecatedEvents();

The call to the method OCA\Circles\Service\RemoteUpstreamService::removeDeprecatedEvents() seems un-needed as the method has no side-effects.

	}


	/**
	 * @param array $circles
	 */
	public function synchronizeCircles(array $circles): void {
		$event = new GSEvent(GSEvent::GLOBAL_SYNC, true);
		$event->setSource($this->configService->getLocalInstance());
		$event->setData(new SimpleDataStore($circles));

		foreach ($this->remoteEventService->getInstances() as $instance) {
			try {
				$this->broadcastEvent($event, $instance);

$event is of type object<OCA\Circles\Model\GlobalScale\GSEvent>, but the function expects a object<OCA\Circles\Model\Remote\RemoteEvent>.

			} catch (RequestContentException | RequestNetworkException | RequestResultSizeException | RequestServerException | RequestResultNotJsonException $e) {

Consider adding a comment why this CATCH block is empty.

			}
		}
	}


	/**
	 *
	 */
	private function removeDeprecatedCircles() {
		$knownCircles = $this->circlesRequest->forceGetCircles();
		foreach ($knownCircles as $knownItem) {
			if ($knownItem->getOwner()
						  ->getInstance() === '') {
				continue;
			}

			try {
				$this->checkCircle($knownItem);
			} catch (GSStatusException $e) {

Consider adding a comment why this CATCH block is empty.

			}
		}
	}


	/**
	 * @param DeprecatedCircle $circle
	 *
	 * @throws GSStatusException
	 */
	private function checkCircle(DeprecatedCircle $circle): void {
		$status = $this->confirmCircleStatus($circle);

		if (!$status) {
			$this->circlesRequest->destroyCircle($circle->getUniqueId());
			$this->membersRequest->removeAllFromCircle($circle->getUniqueId());
		}
	}


	/**
	 * @param DeprecatedCircle $circle
	 *
	 * @return bool
	 * @throws GSStatusException
	 */
	public function confirmCircleStatus(DeprecatedCircle $circle): bool {
		$event = new GSEvent(GSEvent::CIRCLE_STATUS, true);
		$event->setSource($this->configService->getLocalInstance());
		$event->setDeprecatedCircle($circle);

The method OCA\Circles\Model\GlobalScale\GSEvent::setDeprecatedCircle() has been deprecated.

		$this->signEvent($event);

The method signEvent() does not seem to exist on object<OCA\Circles\Service\RemoteUpstreamService>.

		$path = $this->urlGenerator->linkToRoute('circles.RemoteWrapper.status');
		$request = new NC21Request($path, Request::TYPE_POST);
		$this->configService->configureRequest($request);
		$request->setDataSerialize($event);

		$requestIssue = false;
		$notFound = false;
		$foundWithNoOwner = false;
		foreach ($this->remoteEventService->getInstances() as $instance) {
			$request->setHost($instance);

			try {
				$result = $this->retrieveJson($request);
				if ($this->getInt('status', $result, 0) !== 1) {
					throw new RequestContentException('result status is not good');
				}

				$status = $this->getInt('success.data.status', $result);

				// if error, we assume the circle might still exist.
				if ($status === CircleStatus::STATUS_ERROR) {
					return true;
				}

				if ($status === CircleStatus::STATUS_OK) {
					return true;
				}

				// TODO: check the data.supposedOwner entry.
				if ($status === CircleStatus::STATUS_NOT_OWNER) {
					$foundWithNoOwner = true;
				}

				if ($status === CircleStatus::STATUS_NOT_FOUND) {
					$notFound = true;
				}

			} catch (RequestContentException
			| RequestNetworkException
			| RequestResultNotJsonException
			| RequestResultSizeException
			| RequestServerException $e) {
				$requestIssue = true;
				// TODO: log instances that have network issue, after too many tries (7d), remove this circle.
				continue;
			}
		}

		// if no request issue, we can imagine that the instance that owns the circle is down.
		// We'll wait for more information (cf request exceptions management);
		if ($requestIssue) {
			return true;
		}

		// circle were not found in any other instances, we can easily says that the circle does not exists anymore
		if ($notFound && !$foundWithNoOwner) {
			return false;
		}

		// circle were found everywhere but with no owner on every instance. we need to assign a new owner.
		// This should be done by checking admin rights. if no admin rights, let's assume that circle should be removed.
		if (!$notFound && $foundWithNoOwner) {

This if statement, and the following return statement can be replaced with return !$notFound && $foundWithNoOwner;.

			// TODO: assign a new owner and check that when changing owner, we do check that the destination instance is updated FOR SURE!
			return true;
		}

		// some instances returned notFound, some returned circle with no owner. let's assume the circle is deprecated.
		return false;
	}

	/**
	 * @throws GSStatusException
	 */
	public function syncEvents() {

	}

	/**
	 *
	 */
	private function removeDeprecatedEvents() {
//		$this->deprecatedEvents();

	}


}