FederationController::__construct() - Code Metrics - Inspection of "Merge pull request #539 from nextcloud/enh/federat..." - nextcloud/richdocuments - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 125f9f...2c140b )

by Julius

created 2019-08-29 07:32 UTC

FederationController::__construct() A

↳ Parent: FederationController

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	12
ccs	0
cts	12
cp	0
rs	9.8666
c	0
b	0
f	0
cc	1
nc	1
nop	5
crap	2

<?php
/**
 * @copyright Copyright (c) 2019 Julius Härtl <[email protected]>
 *
 * @author Julius Härtl <[email protected]>
 *
 * @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\Richdocuments\Controller;

use OCP\AppFramework\Db\DoesNotExistException;
use \OCP\AppFramework\OCSController;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use OCA\Richdocuments\Db\WopiMapper;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\OCS\OCSNotFoundException;
use OCP\Files\NotFoundException;
use OCP\IConfig;
use OCP\IRequest;
use OCP\Share\Exceptions\ShareNotFound;
use OCP\Share\IManager;

class FederationController extends OCSController {

	/** @var IConfig */
	private $config;

	/** @var WopiMapper */
	private $wopiMapper;

	/** @var IManager */
	private $shareManager;

	public function __construct(
		string $appName,
		IRequest $request,
		IConfig $config,
		WopiMapper $wopiMapper,
		IManager $shareManager
	) {
		parent::__construct($appName, $request);
		$this->config   = $config;
		$this->wopiMapper = $wopiMapper;
		$this->shareManager = $shareManager;
	}

	/**
	 * @PublicPage
	 * @NoCSRFRequired
	 */
	public function index() {
		return new DataResponse([
			'wopi_url' => $this->config->getAppValue('richdocuments', 'wopi_url')
		]);
	}

	/**
	 * @PublicPage
	 * @NoCSRFRequired
	 *
	 * Check the file info of a remote accessing a file
	 *
	 * this is used to make sure we respect reshares of federated shares with the
	 * applied permissions and also have information about the actual editor
	 *
	 * @param $token
	 * @return DataResponse
	 * @throws DoesNotExistException
	 */
	public function remoteWopiToken($token) {
		$wopi = $this->wopiMapper->getWopiForToken($token);
		return new DataResponse([
			'ownerUid' => $wopi->getOwnerUid(),
			'editorUid' => $wopi->getEditorUid(),
			'canwrite' => $wopi->getCanwrite(),
			'hideDownload' => $wopi->getHideDownload(),
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
			'direct' => $wopi->getDirect(),
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
			'serverHost' => $wopi->getServerHost(),
			'guestDisplayname' => $wopi->getGuestDisplayname()
		]);
	}

}


1			<?php
2			/**
3			* @copyright Copyright (c) 2019 Julius Härtl <[email protected]>
4			*
5			* @author Julius Härtl <[email protected]>
6			*
7			* @license GNU AGPL version 3 or any later version
8			*
9			* This program is free software: you can redistribute it and/or modify
10			* it under the terms of the GNU Affero General Public License as
11			* published by the Free Software Foundation, either version 3 of the
12			* License, or (at your option) any later version.
13			*
14			* This program is distributed in the hope that it will be useful,
15			* but WITHOUT ANY WARRANTY; without even the implied warranty of
16			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17			* GNU Affero General Public License for more details.
18			*
19			* You should have received a copy of the GNU Affero General Public License
20			* along with this program. If not, see <http://www.gnu.org/licenses/>.
21			*
22			*/
23			namespace OCA\Richdocuments\Controller;
24
25			use OCP\AppFramework\Db\DoesNotExistException;
26			use \OCP\AppFramework\OCSController;
			0 ignored issues – show Bug introduced 2019-08-27 16:48 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `OCA\Richdocuments\Controller\OCSController`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
27			use OCA\Richdocuments\Db\WopiMapper;
28			use OCP\AppFramework\Http\DataResponse;
29			use OCP\AppFramework\OCS\OCSNotFoundException;
30			use OCP\Files\NotFoundException;
31			use OCP\IConfig;
32			use OCP\IRequest;
33			use OCP\Share\Exceptions\ShareNotFound;
34			use OCP\Share\IManager;
35
36			class FederationController extends OCSController {
37
38			/** @var IConfig */
39			private $config;
40
41			/** @var WopiMapper */
42			private $wopiMapper;
43
44			/** @var IManager */
45			private $shareManager;
46
47			public function __construct(
48			string $appName,
49			IRequest $request,
50			IConfig $config,
51			WopiMapper $wopiMapper,
52			IManager $shareManager
53			) {
54			parent::__construct($appName, $request);
55			$this->config = $config;
56			$this->wopiMapper = $wopiMapper;
57			$this->shareManager = $shareManager;
58			}
59
60			/**
61			* @PublicPage
62			* @NoCSRFRequired
63			*/
64			public function index() {
65			return new DataResponse([
66			'wopi_url' => $this->config->getAppValue('richdocuments', 'wopi_url')
67			]);
68			}
69
70			/**
71			* @PublicPage
72			* @NoCSRFRequired
73			*
74			* Check the file info of a remote accessing a file
75			*
76			* this is used to make sure we respect reshares of federated shares with the
77			* applied permissions and also have information about the actual editor
78			*
79			* @param $token
80			* @return DataResponse
81			* @throws DoesNotExistException
82			*/
83			public function remoteWopiToken($token) {
84			$wopi = $this->wopiMapper->getWopiForToken($token);
85			return new DataResponse([
86			'ownerUid' => $wopi->getOwnerUid(),
87			'editorUid' => $wopi->getEditorUid(),
88			'canwrite' => $wopi->getCanwrite(),
89			'hideDownload' => $wopi->getHideDownload(),
			0 ignored issues – show Documentation Bug introduced 2019-08-27 16:48 UTC by Report Bug Copy Issue Report The method `getHideDownload` does not exist on `object<OCA\Richdocuments\Db\Wopi>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
90			'direct' => $wopi->getDirect(),
			0 ignored issues – show Documentation Bug introduced 2019-08-27 16:48 UTC by Report Bug Copy Issue Report The method `getDirect` does not exist on `object<OCA\Richdocuments\Db\Wopi>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
91			'serverHost' => $wopi->getServerHost(),
92			'guestDisplayname' => $wopi->getGuestDisplayname()
93			]);
94			}
95
96			}
97

nextcloud / richdocuments

Push — master ( 125f9f...2c140b )

FederationController::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like