OCA\Circles\Controller\SharesController

Complexity

Total Complexity

11

Size/Duplication

Total Lines	205
Duplicated Lines	8.78 %

Coupling/Cohesion

Components	1
Dependencies	11

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	18	18	1
A	create()	0	28	2
A	initShareDelivery()	0	21	3
A	public()	0	15	2
A	checkContactMail()	0	21	3

<?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\Controller;

use daita\MySmallPhpTools\Traits\TStringTools;
use Exception;
use OCA\Circles\Db\SharesRequest;
use OCA\Circles\Db\TokensRequest;
use OCA\Circles\Exceptions\MemberDoesNotExistException;
use OCA\Circles\Model\Member;
use OCA\Circles\Model\SharesToken;
use OCA\Circles\Model\SharingFrame;
use OCA\Circles\Service\BroadcastService;
use OCA\Circles\Service\ConfigService;
use OCA\Circles\Service\MembersService;
use OCA\Circles\Service\MiscService;
use OCA\Circles\Service\SharingFrameService;
use OCP\AppFramework\Controller;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\Http\RedirectResponse;
use OCP\IRequest;
use OCP\IURLGenerator;


/**
 * Class SharesController
 *
 * @package OCA\Circles\Controller
 */
class SharesController extends Controller {


	use TStringTools;


	/** @var TokensRequest */
	private $tokenRequest;

	/** @var SharesRequest */
	private $sharesRequest;

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

	/** @var MembersService */
	private $membersService;

	/** @var BroadcastService */
	private $broadcastService;

	/** @var SharingFrameService */
	private $sharingFrameService;

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

	/** @var MiscService */
	private $miscService;


	/**
	 * SharesController constructor.
	 *
	 * @param $appName
	 * @param IRequest $request
	 * @param TokensRequest $tokenRequest
	 * @param SharesRequest $sharesRequest
	 * @param IURLGenerator $urlGenerator
	 * @param MembersService $membersService
	 * @param BroadcastService $broadcastService
	 * @param SharingFrameService $sharingFrameService
	 * @param ConfigService $configService
	 * @param MiscService $miscService
	 */
	public function __construct(

This method seems to be duplicated in your project.

		$appName, IRequest $request, TokensRequest $tokenRequest, SharesRequest $sharesRequest,
		IUrlGenerator $urlGenerator, MembersService $membersService,
		BroadcastService $broadcastService,
		SharingFrameService $sharingFrameService, ConfigService $configService,
		MiscService $miscService
	) {
		parent::__construct($appName, $request);

		$this->tokenRequest = $tokenRequest;
		$this->sharesRequest = $sharesRequest;
		$this->urlGenerator = $urlGenerator;
		$this->membersService = $membersService;
		$this->broadcastService = $broadcastService;
		$this->sharingFrameService = $sharingFrameService;
		$this->configService = $configService;
		$this->miscService = $miscService;
	}


	/**
	 * Called by the JavaScript API when creating a new Share item that will be
	 * broadcasted to the circle itself, and any other circle linked to it.
	 *
	 * @NoAdminRequired
	 * @NoSubAdminRequired
	 *
	 * @param string $circleUniqueId
	 * @param string $source
	 * @param string $type
	 * @param array $payload
	 *
	 * @return DataResponse
	 */
	public function create($circleUniqueId, $source, $type, $payload) {

		try {
			$share = new SharingFrame($source, $type);
			$share->setPayload($payload);

			$this->sharingFrameService->createFrame($circleUniqueId, $share);
		} catch (\Exception $e) {
			return $this->fail(
				[
					'circle_id' => $circleUniqueId,
					'source'    => $source,
					'type'      => $type,
					'payload'   => $payload,
					'error'     => $e->getMessage()
				]
			);
		}

		return $this->success(
			[
				'circle_id' => $circleUniqueId,
				'source'    => $source,
				'type'      => $type,
				'payload'   => $payload
			]
		);
	}


	/**
	 * initShareDelivery()
	 *
	 * Note: this function will close the request mid-run from the client but will still
	 * running its process.
	 *
	 * Called by locally, the function will get the SharingFrame by its uniqueId from the database.
	 * After closing the socket, will broadcast the Frame locally and - if Federated Shares are
	 * enable - will deliver it to each remote circles linked to the circle the Payload belongs to.
	 *
	 * A status response is sent to free the client process before starting to broadcast the item
	 * to other federated links.
	 *
	 * @PublicPage
	 * @NoCSRFRequired
	 *
	 * @param string $circleId
	 * @param string $frameId
	 *
	 * @return DataResponse
	 */
	public function initShareDelivery($circleId, $frameId) {

		try {
			$frame = $this->sharingFrameService->getFrameFromUniqueId($circleId, $frameId);
		} catch (Exception $e) {
			return $this->fail($e->getMessage());
		}

		// We don't want to keep the connection up
		$this->miscService->asyncAndLeaveClientOutOfThis('done');

		$this->broadcastService->broadcastFrame($frame);

It seems like $frame defined by $this->sharingFrameService->getFrameFromUniqueId($circleId, $frameId) on line 187 can be null; however, OCA\Circles\Service\BroadcastService::broadcastFrame() does not accept null, maybe add an additional type check?

		// TODO - do not update cloudId to avoid duplicate, use it's own field and keep cloudId
		$this->sharingFrameService->updateFrameWithCloudId($frame);

It seems like $frame defined by $this->sharingFrameService->getFrameFromUniqueId($circleId, $frameId) on line 187 can be null; however, OCA\Circles\Service\SharingFrameService::updateFrameWithCloudId() does not accept null, maybe add an additional type check?

		if ($this->configService->isFederatedCirclesAllowed()) {
			$this->sharingFrameService->forwardSharingFrame($frame);

It seems like $frame defined by $this->sharingFrameService->getFrameFromUniqueId($circleId, $frameId) on line 187 can be null; however, OCA\Circles\Service\SharingFrameService::forwardSharingFrame() does not accept null, maybe add an additional type check?

		}

		exit();
	}


	/**
	 * @PublicPage
	 * @NoCSRFRequired
	 *
	 * @param string $token
	 *
	 * @return RedirectResponse
	 */
	public function public(string $token) {
		try {
			$shareToken = $this->tokenRequest->getByToken($token);
			$this->checkContactMail($shareToken);

			$token = $this->sharesRequest->getTokenByShareId($shareToken->getShareId());
		} catch (Exception $e) {
			$this->miscService->log(
				'token ' . $token . ' not found - ' . get_class($e) . ' - ' . $e->getMessage()
			);
			$token = $this->uuid(15);
		}

		return new RedirectResponse($this->urlGenerator->getAbsoluteURL('/s/' . $token));
	}


	/**
	 * @param SharesToken $shareToken
	 *
	 * @throws MemberDoesNotExistException
	 */
	private function checkContactMail(SharesToken $shareToken) {
		try {
			$this->membersService->getMember(
				$shareToken->getCircleId(), $shareToken->getUserId(), Member::TYPE_MAIL, true
			);

			return;
		} catch (Exception $e) {

Consider adding a comment why this CATCH block is empty.

		}

		try {
			$this->membersService->getMember(
				$shareToken->getCircleId(), $shareToken->getUserId(), Member::TYPE_MAIL, true
			);

			return;
		} catch (Exception $e) {

Consider adding a comment why this CATCH block is empty.

		}

		throw new MemberDoesNotExistException();
	}
}