SharedScanner::getSourceScanner() - Code Metrics - Inspection of "Merge pull request #24394 from owncloud/cleanup_sh..." - owncloud/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ed3b9d...3835d9 )

by Roeland

created 2016-05-03 05:41 UTC

SharedScanner::getSourceScanner() A

↳ Parent: Scanner

Complexity

Conditions	3
Paths	3

Size

Total Lines	13
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	13
rs	9.4285
cc	3
eloc	9
nc	3
nop	0

<?php
/**
 * @author Morris Jobke <[email protected]>
 * @author Robin Appelman <[email protected]>
 * @author Vincent Petry <[email protected]>
 *
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 * @license AGPL-3.0
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * 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, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OCA\Files_Sharing;

use OC\Files\ObjectStore\NoopScanner;

/**
 * Scanner for SharedStorage
 */
class Scanner extends \OC\Files\Cache\Scanner {
	private $sourceScanner;

	/**
	 * Returns metadata from the shared storage, but
	 * with permissions from the source storage.
	 *
	 * @param string $path path of the file for which to retrieve metadata
	 *
	 * @return array an array of metadata of the file
	 */
	public function getData($path) {
		$data = parent::getData($path);
		if ($data === null) {
			return null;
		}
		list($sourceStorage, $internalPath) = $this->storage->resolvePath($path);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
		$data['permissions'] = $sourceStorage->getPermissions($internalPath);
		return $data;
	}

	private function getSourceScanner() {
		if ($this->sourceScanner) {
			return $this->sourceScanner;
		}
		if ($this->storage->instanceOfStorage('\OC\Files\Storage\Shared')) {
			/** @var \OC\Files\Storage\Storage $storage */
			list($storage) = $this->storage->resolvePath('');
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
			$this->sourceScanner = $storage->getScanner();
			return $this->sourceScanner;
		} else {
			return null;
		}
	}

	public function scanFile($file, $reuseExisting = 0, $parentId = -1, $cacheData = null, $lock = true) {
		$sourceScanner = $this->getSourceScanner();
		if ($sourceScanner instanceof NoopScanner) {
			return [];
		} else {
			return parent::scanFile($file, $reuseExisting, $parentId, $cacheData, $lock);
		}
	}
}



Push — master ( ed3b9d...3835d9 )

SharedScanner::getSourceScanner() A

Complexity

Size

Duplication

Available Fixes

Available Fixes

1			<?php
2			/**
3			* @author Morris Jobke <[email protected]>
4			* @author Robin Appelman <[email protected]>
5			* @author Vincent Petry <[email protected]>
6			*
7			* @copyright Copyright (c) 2016, ownCloud, Inc.
8			* @license AGPL-3.0
9			*
10			* This code is free software: you can redistribute it and/or modify
11			* it under the terms of the GNU Affero General Public License, version 3,
12			* as published by the Free Software Foundation.
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, version 3,
20			* along with this program. If not, see <http://www.gnu.org/licenses/>
21			*
22			*/
23
24			namespace OCA\Files_Sharing;
25
26			use OC\Files\ObjectStore\NoopScanner;
27
28			/**
29			* Scanner for SharedStorage
30			*/
31			class Scanner extends \OC\Files\Cache\Scanner {
32			private $sourceScanner;
33
34			/**
35			* Returns metadata from the shared storage, but
36			* with permissions from the source storage.
37			*
38			* @param string $path path of the file for which to retrieve metadata
39			*
40			* @return array an array of metadata of the file
41			*/
42			public function getData($path) {
43			$data = parent::getData($path);
44			if ($data === null) {
45			return null;
46			}
47			list($sourceStorage, $internalPath) = $this->storage->resolvePath($path);
			0 ignored issues – show Bug introduced 2016-04-15 10:49 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `OC\Files\Storage\Storage` as the method `resolvePath()` does only exist in the following implementations of said interface: `OC\Files\Storage\Shared`, `OC\Files\Storage\Wrapper\Jail`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
48			$data['permissions'] = $sourceStorage->getPermissions($internalPath);
49			return $data;
50			}
51
52			private function getSourceScanner() {
53			if ($this->sourceScanner) {
54			return $this->sourceScanner;
55			}
56			if ($this->storage->instanceOfStorage('\OC\Files\Storage\Shared')) {
57			/** @var \OC\Files\Storage\Storage $storage */
58			list($storage) = $this->storage->resolvePath('');
			0 ignored issues – show Bug introduced 2016-04-13 07:04 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `OC\Files\Storage\Storage` as the method `resolvePath()` does only exist in the following implementations of said interface: `OC\Files\Storage\Shared`, `OC\Files\Storage\Wrapper\Jail`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
59			$this->sourceScanner = $storage->getScanner();
60			return $this->sourceScanner;
61			} else {
62			return null;
63			}
64			}
65
66			public function scanFile($file, $reuseExisting = 0, $parentId = -1, $cacheData = null, $lock = true) {
67			$sourceScanner = $this->getSourceScanner();
68			if ($sourceScanner instanceof NoopScanner) {
69			return [];
70			} else {
71			return parent::scanFile($file, $reuseExisting, $parentId, $cacheData, $lock);
72			}
73			}
74			}
75
76

owncloud / core

Push — master ( ed3b9d...3835d9 )

SharedScanner::getSourceScanner() A

Complexity

Size

Duplication

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like