Scanner::scan() - Code Metrics - Inspection of "With objectstore, scan from sourcescanner for shar..." - owncloud/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#32377)

by Piotr

created 2018-08-19 14:58 UTC

Scanner::scan() A

↳ Parent: Scanner

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	9
Ratio	100 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	4
dl	9
loc	9
rs	9.9666
c	0
b	0
f	0

<?php
/**
 * @author Joas Schilling <[email protected]>
 * @author Morris Jobke <[email protected]>
 * @author Robin Appelman <[email protected]>
 * @author Roeland Jago Douma <[email protected]>
 * @author Vincent Petry <[email protected]>
 *
 * @copyright Copyright (c) 2018, ownCloud GmbH
 * @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;
use OC\Files\Cache\Scanner as CacheScanner;

/**
 * Scanner for SharedStorage
 */
class Scanner extends CacheScanner {

	/**
	 * @var null|CacheScanner
	 */
	private $sourceScanner;

	/**
	 * Scan a single file and use source scanner if needed
	 *
	 * @inheritdoc
	 */
	public function scanFile($file, $reuseExisting = 0, $parentId = -1, $cacheData = null, $lock = true) {
		$sourceScanner = $this->getSourceScanner();
		if ($sourceScanner instanceof NoopScanner) {
			// No Operation Scanner will not update share permission (scanFile won't call getData)
			list(, $internalPath) = $this->storage->resolvePath($file);
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.
    }
}
			return $sourceScanner->scanFile($internalPath, $reuseExisting, $parentId, $cacheData, $lock);
		} else {
			return parent::scanFile($file, $reuseExisting, $parentId, $cacheData, $lock);
		}
	}

	/**
	 * Returns metadata from the shared storage, but
	 * with permissions from the source storage.
	 *
	 * NOTE: This function gets called from within scanFile parent function
	 *
	 * @inheritdoc
	 */
	protected 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('\OCA\Files_Sharing\SharedStorage')) {
			/** @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;
		}
	}
}


Pull Request — master (#32377)

Scanner::scan() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

1			<?php
2			/**
3			* @author Joas Schilling <[email protected]>
4			* @author Morris Jobke <[email protected]>
5			* @author Robin Appelman <[email protected]>
6			* @author Roeland Jago Douma <[email protected]>
7			* @author Vincent Petry <[email protected]>
8			*
9			* @copyright Copyright (c) 2018, ownCloud GmbH
10			* @license AGPL-3.0
11			*
12			* This code is free software: you can redistribute it and/or modify
13			* it under the terms of the GNU Affero General Public License, version 3,
14			* as published by the Free Software Foundation.
15			*
16			* This program is distributed in the hope that it will be useful,
17			* but WITHOUT ANY WARRANTY; without even the implied warranty of
18			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19			* GNU Affero General Public License for more details.
20			*
21			* You should have received a copy of the GNU Affero General Public License, version 3,
22			* along with this program. If not, see <http://www.gnu.org/licenses/>
23			*
24			*/
25
26			namespace OCA\Files_Sharing;
27
28			use OC\Files\ObjectStore\NoopScanner;
29			use OC\Files\Cache\Scanner as CacheScanner;
30
31			/**
32			* Scanner for SharedStorage
33			*/
34			class Scanner extends CacheScanner {
35
36			/**
37			* @var null\|CacheScanner
38			*/
39			private $sourceScanner;
40
41			/**
42			* Scan a single file and use source scanner if needed
43			*
44			* @inheritdoc
45			*/
46			public function scanFile($file, $reuseExisting = 0, $parentId = -1, $cacheData = null, $lock = true) {
47			$sourceScanner = $this->getSourceScanner();
48			if ($sourceScanner instanceof NoopScanner) {
49			// No Operation Scanner will not update share permission (scanFile won't call getData)
50			list(, $internalPath) = $this->storage->resolvePath($file);
			0 ignored issues – show Bug introduced 2018-08-15 20:39 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: `OCA\Files_Sharing\SharedStorage`, `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...
51			return $sourceScanner->scanFile($internalPath, $reuseExisting, $parentId, $cacheData, $lock);
52			} else {
53			return parent::scanFile($file, $reuseExisting, $parentId, $cacheData, $lock);
54			}
55			}
56
57			/**
58			* Returns metadata from the shared storage, but
59			* with permissions from the source storage.
60			*
61			* NOTE: This function gets called from within scanFile parent function
62			*
63			* @inheritdoc
64			*/
65			protected function getData($path) {
66			$data = parent::getData($path);
67			if ($data === null) {
68			return null;
69			}
70			list($sourceStorage, $internalPath) = $this->storage->resolvePath($path);
			0 ignored issues – show Bug introduced 2016-06-01 12:46 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: `OCA\Files_Sharing\SharedStorage`, `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...
71			$data['permissions'] = $sourceStorage->getPermissions($internalPath);
72			return $data;
73			}
74
75			private function getSourceScanner() {
76			if ($this->sourceScanner) {
77			return $this->sourceScanner;
78			}
79			if ($this->storage->instanceOfStorage('\OCA\Files_Sharing\SharedStorage')) {
80			/** @var \OC\Files\Storage\Storage $storage */
81			list($storage) = $this->storage->resolvePath('');
			0 ignored issues – show Bug introduced 2016-06-01 12:46 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: `OCA\Files_Sharing\SharedStorage`, `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...
82			$this->sourceScanner = $storage->getScanner();
83			return $this->sourceScanner;
84			} else {
85			return null;
86			}
87			}
88			}
89

owncloud / core

Pull Request — master (#32377)

Scanner::scan() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like