FederatedService::getLink() - Code Metrics - Inspection of "avoid duplicate link" - nextcloud/circles - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — federated-circles ( c0d7e5...47921f )

by Maxence

created 2017-05-17 21:22 UTC

FederatedService::getLink() A

↳ Parent: FederatedService

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	3
rs	10
cc	1
eloc	2
nc	1
nop	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 <[email protected]>
 * @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\Http\Client\ClientService;
use OCA\Circles\Db\CirclesMapper;
use OCA\Circles\Db\FederatedLinksRequest;
use OCA\Circles\Db\MembersMapper;
use OCA\Circles\Exceptions\FederatedCircleLinkFormatException;
use OCA\Circles\Exceptions\FederatedCircleNotAllowedException;
use OCA\Circles\Exceptions\CircleTypeNotValid;
use OCA\Circles\Exceptions\FederatedLinkCreationIssue;
use OCA\Circles\Exceptions\FederatedRemoteCircleDoesNotExistException;
use OCA\Circles\Exceptions\FederatedRemoteDoesNotAllowException;
use OCA\Circles\Exceptions\MemberIsNotAdminException;
use OCA\Circles\Model\Circle;
use OCA\Circles\Model\FederatedLink;
use OCP\IL10N;

class FederatedService {


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

	/** @var IL10N */
	private $l10n;

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

	/** @var CirclesService */
	private $circlesService;

	/** @var FederatedLinksRequest */
	private $federatedLinksRequest;

	/** @var CirclesMapper */
	private $dbCircles;

	/** @var MembersMapper */
	private $dbMembers;

	/** @var ClientService */
	private $clientService;

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


	/**
	 * CirclesService constructor.
	 *
	 * @param $userId
	 * @param IL10N $l10n
	 * @param ConfigService $configService
	 * @param DatabaseService $databaseService
	 * @param CirclesService $circlesService
	 * @param FederatedLinksRequest $federatedLinksRequest
	 * @param string $serverHost
	 * @param ClientService $clientService
	 * @param MiscService $miscService
	 */
	public function __construct(
		$userId,
		IL10N $l10n,
		ConfigService $configService,
		DatabaseService $databaseService,
		CirclesService $circlesService,
		FederatedLinksRequest $federatedLinksRequest,
		string $serverHost,
		ClientService $clientService,
		MiscService $miscService
	) {
		$this->userId = $userId;
		$this->l10n = $l10n;
		$this->configService = $configService;
		$this->circlesService = $circlesService;
		$this->federatedLinksRequest = $federatedLinksRequest;
		$this->serverHost = $serverHost;
class MyClass { }

$x = new MyClass();
$x->foo = true;
		$this->clientService = $clientService;

		$this->miscService = $miscService;

		$this->dbCircles = $databaseService->getCirclesMapper();
		$this->dbMembers = $databaseService->getMembersMapper();
	}


	/**
	 * link to a circle.
	 *
	 * @param int $circleId
	 * @param string $remote
	 *
	 * @throws Exception
	 * @throws FederatedCircleLinkFormatException
	 * @throws CircleTypeNotValid
	 * @throws MemberIsNotAdminException
	 *
	 * @return FederatedLink
	 */
	public function linkCircle($circleId, $remote) {

		if (!$this->configService->isFederatedAllowed()) {
			throw new FederatedCircleNotAllowedException(
				$this->l10n->t("Federated circles are not allowed on this Nextcloud")
			);
		}

		if (strpos($remote, '@') === false) {
			throw new FederatedCircleLinkFormatException(
				$this->l10n->t("Federated link does not have a valid format")
			);
		}

		try {
			return $this->requestLinkWithCircle($circleId, $remote);
		} catch (Exception $e) {
			throw $e;
		}
	}


	/**
	 * @param $circleId
	 * @param $remote
	 *
	 * @return FederatedLink
	 * @throws Exception
	 */
	private function requestLinkWithCircle($circleId, $remote) {

		$link = null;
		try {
			list($remoteCircle, $remoteAddress) = explode('@', $remote, 2);

			$circle = $this->circlesService->detailsCircle($circleId);
			$circle->getUser()
				   ->hasToBeAdmin();
			$circle->cantBePersonal();

			$link = new FederatedLink();
			$link->setCircleId($circleId)
				 ->setLocalAddress($this->serverHost)
				 ->setAddress($remoteAddress)
				 ->setRemoteCircleName($remoteCircle)
				 ->setStatus(FederatedLink::STATUS_LINK_SETUP)
				 ->generateToken();

			$this->federatedLinksRequest->create($link);
			$this->requestLink($circle, $link);

		} catch (Exception $e) {
			$this->federatedLinksRequest->delete($link);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
			throw $e;
		}

		return $link;
	}


	/**
	 * @param string $remote
	 *
	 * @return string
	 */
	private function generateLinkRemoteURL($remote) {
		if (strpos($remote, 'http') !== 0) {
			$remote = 'https://' . $remote;
		}

		return rtrim($remote, '/') . '/index.php/apps/circles/circles/link/';
	}


	/**
	 * @param Circle $circle
	 * @param FederatedLink $link
	 *
	 * @return int

	 * @throws Exception
	 */
	private function requestLink(Circle $circle, FederatedLink &$link) {
		$args = [
			'token'      => $link->getToken(),
			'uniqueId'   => $circle->getUniqueId(),
			'sourceName' => $circle->getName(),
			'linkTo'     => $link->getRemoteCircleName(),
			'address'    => $link->getLocalAddress()
		];

		$client = $this->clientService->newClient();
		try {
			$request = $client->put(
				$this->generateLinkRemoteURL($link->getAddress()), [
																	 'body'            => $args,
																	 'timeout'         => 10,
																	 'connect_timeout' => 10,
																 ]
			);

			$result = json_decode($request->getBody(), true);
			$this->parsingRequestLinkResult($result);
			$link->setStatus($result['status']);
			$link->setUniqueId($result['uniqueId']);
			$this->federatedLinksRequest->update($link);

			return true;
		} catch (Exception $e) {
			throw $e;
		}
	}


	private function parsingRequestLinkResult($result) {

		if ($result['status'] === FederatedLink::STATUS_REQUEST_SENT
			|| $result['status'] === FederatedLink::STATUS_LINK_UP
		) {
			return;
		}

		if ($result['reason'] === 'federated_not_allowed') {
			throw new FederatedRemoteDoesNotAllowException(
				$this->l10n->t('Federated circles are not allowed on the remote Nextcloud')
			);
		}

		if ($result['reason'] === 'duplicate_unique_id') {
			throw new FederatedRemoteDoesNotAllowException(
				$this->l10n->t('It seems that you are trying to link a circle to itself')
			);
		}

		if ($result['reason'] === 'duplicate_link') {
			throw new FederatedRemoteDoesNotAllowException(
				$this->l10n->t('This link exists already')
			);
		}

		if ($result['reason'] === 'circle_does_not_exist') {
			throw new FederatedRemoteCircleDoesNotExistException(
				$this->l10n->t('The requested remote circle does not exist')
			);
		}

		throw new Exception();
	}


	/**
	 * @param Circle $circle
	 * @param FederatedLink $link
	 *
	 * @return bool
	 */
	public function initiateLink(Circle $circle, FederatedLink &$link) {

		$link->setCircleId($circle->getId());

		if ($circle->getType() === Circle::CIRCLES_PUBLIC) {
			$link->setStatus(FederatedLink::STATUS_LINK_UP);
		} else {
			$link->setStatus(FederatedLink::STATUS_REQUEST_SENT);
		}

		return $this->federatedLinksRequest->create($link);
	}


	/**
	 * @param $circleId
	 * @param $uniqueId
	 *
	 * @return FederatedLink

	 */
	public function getLink($circleId, $uniqueId) {
		return $this->federatedLinksRequest->get($circleId, $uniqueId);
	}

}

1			<?php
2			/**
3			* Circles - Bring cloud-users closer together.
4			*
5			* This file is licensed under the Affero General Public License version 3 or
6			* later. See the COPYING file.
7			*
8			* @author Maxence Lange <[email protected]>
9			* @copyright 2017
10			* @license GNU AGPL version 3 or any later version
11			*
12			* This program is free software: you can redistribute it and/or modify
13			* it under the terms of the GNU Affero General Public License as
14			* published by the Free Software Foundation, either version 3 of the
15			* License, or (at your option) any later version.
16			*
17			* This program is distributed in the hope that it will be useful,
18			* but WITHOUT ANY WARRANTY; without even the implied warranty of
19			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20			* GNU Affero General Public License for more details.
21			*
22			* You should have received a copy of the GNU Affero General Public License
23			* along with this program. If not, see <http://www.gnu.org/licenses/>.
24			*
25			*/
26
27			namespace OCA\Circles\Service;
28
29
30			use Exception;
31			use OC\Http\Client\ClientService;
32			use OCA\Circles\Db\CirclesMapper;
33			use OCA\Circles\Db\FederatedLinksRequest;
34			use OCA\Circles\Db\MembersMapper;
35			use OCA\Circles\Exceptions\FederatedCircleLinkFormatException;
36			use OCA\Circles\Exceptions\FederatedCircleNotAllowedException;
37			use OCA\Circles\Exceptions\CircleTypeNotValid;
38			use OCA\Circles\Exceptions\FederatedLinkCreationIssue;
39			use OCA\Circles\Exceptions\FederatedRemoteCircleDoesNotExistException;
40			use OCA\Circles\Exceptions\FederatedRemoteDoesNotAllowException;
41			use OCA\Circles\Exceptions\MemberIsNotAdminException;
42			use OCA\Circles\Model\Circle;
43			use OCA\Circles\Model\FederatedLink;
44			use OCP\IL10N;
45
46			class FederatedService {
47
48
49			/** @var string */
50			private $userId;
51
52			/** @var IL10N */
53			private $l10n;
54
55			/** @var ConfigService */
56			private $configService;
57
58			/** @var CirclesService */
59			private $circlesService;
60
61			/** @var FederatedLinksRequest */
62			private $federatedLinksRequest;
63
64			/** @var CirclesMapper */
65			private $dbCircles;
66
67			/** @var MembersMapper */
68			private $dbMembers;
69
70			/** @var ClientService */
71			private $clientService;
72
73			/** @var MiscService */
74			private $miscService;
75
76
77			/**
78			* CirclesService constructor.
79			*
80			* @param $userId
81			* @param IL10N $l10n
82			* @param ConfigService $configService
83			* @param DatabaseService $databaseService
84			* @param CirclesService $circlesService
85			* @param FederatedLinksRequest $federatedLinksRequest
86			* @param string $serverHost
87			* @param ClientService $clientService
88			* @param MiscService $miscService
89			*/
90			public function __construct(
91			$userId,
92			IL10N $l10n,
93			ConfigService $configService,
94			DatabaseService $databaseService,
95			CirclesService $circlesService,
96			FederatedLinksRequest $federatedLinksRequest,
97			string $serverHost,
98			ClientService $clientService,
99			MiscService $miscService
100			) {
101			$this->userId = $userId;
102			$this->l10n = $l10n;
103			$this->configService = $configService;
104			$this->circlesService = $circlesService;
105			$this->federatedLinksRequest = $federatedLinksRequest;
106			$this->serverHost = $serverHost;
			0 ignored issues – show Bug introduced 2017-05-17 08:59 UTC by Report Bug Copy Issue Report The property `serverHost` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
107			$this->clientService = $clientService;
108
109			$this->miscService = $miscService;
110
111			$this->dbCircles = $databaseService->getCirclesMapper();
112			$this->dbMembers = $databaseService->getMembersMapper();
113			}
114
115
116			/**
117			* link to a circle.
118			*
119			* @param int $circleId
120			* @param string $remote
121			*
122			* @throws Exception
123			* @throws FederatedCircleLinkFormatException
124			* @throws CircleTypeNotValid
125			* @throws MemberIsNotAdminException
126			*
127			* @return FederatedLink
128			*/
129			public function linkCircle($circleId, $remote) {
130
131			if (!$this->configService->isFederatedAllowed()) {
132			throw new FederatedCircleNotAllowedException(
133			$this->l10n->t("Federated circles are not allowed on this Nextcloud")
134			);
135			}
136
137			if (strpos($remote, '@') === false) {
138			throw new FederatedCircleLinkFormatException(
139			$this->l10n->t("Federated link does not have a valid format")
140			);
141			}
142
143			try {
144			return $this->requestLinkWithCircle($circleId, $remote);
145			} catch (Exception $e) {
146			throw $e;
147			}
148			}
149
150
151			/**
152			* @param $circleId
153			* @param $remote
154			*
155			* @return FederatedLink
156			* @throws Exception
157			*/
158			private function requestLinkWithCircle($circleId, $remote) {
159
160			$link = null;
161			try {
162			list($remoteCircle, $remoteAddress) = explode('@', $remote, 2);
163
164			$circle = $this->circlesService->detailsCircle($circleId);
165			$circle->getUser()
166			->hasToBeAdmin();
167			$circle->cantBePersonal();
168
169			$link = new FederatedLink();
170			$link->setCircleId($circleId)
171			->setLocalAddress($this->serverHost)
172			->setAddress($remoteAddress)
173			->setRemoteCircleName($remoteCircle)
174			->setStatus(FederatedLink::STATUS_LINK_SETUP)
175			->generateToken();
176
177			$this->federatedLinksRequest->create($link);
178			$this->requestLink($circle, $link);
179
180			} catch (Exception $e) {
181			$this->federatedLinksRequest->delete($link);
			0 ignored issues – show Bug introduced 2017-05-17 18:03 UTC by Report Bug Copy Issue Report It seems like `$link` defined by `null` on line `160` can be `null`; however, `OCA\Circles\Db\FederatedLinksRequest::delete()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
182			throw $e;
183			}
184
185			return $link;
186			}
187
188
189			/**
190			* @param string $remote
191			*
192			* @return string
193			*/
194			private function generateLinkRemoteURL($remote) {
195			if (strpos($remote, 'http') !== 0) {
196			$remote = 'https://' . $remote;
197			}
198
199			return rtrim($remote, '/') . '/index.php/apps/circles/circles/link/';
200			}
201
202
203			/**
204			* @param Circle $circle
205			* @param FederatedLink $link
206			*
207			* @return int
			0 ignored issues – show Documentation introduced 2017-05-17 18:03 UTC by Report Bug Copy Issue Report Should the return type not be `boolean`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
208			* @throws Exception
209			*/
210			private function requestLink(Circle $circle, FederatedLink &$link) {
211			$args = [
212			'token' => $link->getToken(),
213			'uniqueId' => $circle->getUniqueId(),
214			'sourceName' => $circle->getName(),
215			'linkTo' => $link->getRemoteCircleName(),
216			'address' => $link->getLocalAddress()
217			];
218
219			$client = $this->clientService->newClient();
220			try {
221			$request = $client->put(
222			$this->generateLinkRemoteURL($link->getAddress()), [
223			'body' => $args,
224			'timeout' => 10,
225			'connect_timeout' => 10,
226			]
227			);
228
229			$result = json_decode($request->getBody(), true);
230			$this->parsingRequestLinkResult($result);
231			$link->setStatus($result['status']);
232			$link->setUniqueId($result['uniqueId']);
233			$this->federatedLinksRequest->update($link);
234
235			return true;
236			} catch (Exception $e) {
237			throw $e;
238			}
239			}
240
241
242			private function parsingRequestLinkResult($result) {
243
244			if ($result['status'] === FederatedLink::STATUS_REQUEST_SENT
245			\|\| $result['status'] === FederatedLink::STATUS_LINK_UP
246			) {
247			return;
248			}
249
250			if ($result['reason'] === 'federated_not_allowed') {
251			throw new FederatedRemoteDoesNotAllowException(
252			$this->l10n->t('Federated circles are not allowed on the remote Nextcloud')
253			);
254			}
255
256			if ($result['reason'] === 'duplicate_unique_id') {
257			throw new FederatedRemoteDoesNotAllowException(
258			$this->l10n->t('It seems that you are trying to link a circle to itself')
259			);
260			}
261
262			if ($result['reason'] === 'duplicate_link') {
263			throw new FederatedRemoteDoesNotAllowException(
264			$this->l10n->t('This link exists already')
265			);
266			}
267
268			if ($result['reason'] === 'circle_does_not_exist') {
269			throw new FederatedRemoteCircleDoesNotExistException(
270			$this->l10n->t('The requested remote circle does not exist')
271			);
272			}
273
274			throw new Exception();
275			}
276
277
278			/**
279			* @param Circle $circle
280			* @param FederatedLink $link
281			*
282			* @return bool
283			*/
284			public function initiateLink(Circle $circle, FederatedLink &$link) {
285
286			$link->setCircleId($circle->getId());
287
288			if ($circle->getType() === Circle::CIRCLES_PUBLIC) {
289			$link->setStatus(FederatedLink::STATUS_LINK_UP);
290			} else {
291			$link->setStatus(FederatedLink::STATUS_REQUEST_SENT);
292			}
293
294			return $this->federatedLinksRequest->create($link);
295			}
296
297
298			/**
299			* @param $circleId
300			* @param $uniqueId
301			*
302			* @return FederatedLink
			0 ignored issues – show Documentation introduced 2017-05-17 21:24 UTC by Report Bug Copy Issue Report Should the return type not be `FederatedLink\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
303			*/
304			public function getLink($circleId, $uniqueId) {
305			return $this->federatedLinksRequest->get($circleId, $uniqueId);
306			}
307
308			}

nextcloud / circles

Push — federated-circles ( c0d7e5...47921f )

FederatedService::getLink() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like