Shared_Updater - Code Metrics - Inspection of "Merge pull request #24212 from owncloud/no_need_to..." - owncloud/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8f8ae9...3a7ad7 )

by Roeland

created 2016-04-30 10:40 UTC

Shared_Updater A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	95
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	15

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	10
c	1
b	0
f	0
lcom	1
cbo	15
dl	0
loc	95
rs	9.1666

4 Methods

Rating	Name	Size	Complexity
A	renameHook()	4	1
A	fixBrokenSharesOnAppUpdate()	8	1
A	renameChildren()	15	3
B	moveShareToShare()	36	5

<?php
/**
 * @author Björn Schießle <[email protected]>
 * @author Joas Schilling <[email protected]>
 * @author Michael Gapczynski <[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) 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 OC\Files\Cache;

class Shared_Updater {

	/**
	 * @param array $params
	 */
	static public function renameHook($params) {
		self::renameChildren($params['oldpath'], $params['newpath']);
		self::moveShareToShare($params['newpath']);
	}

	/**
	 * Fix for https://github.com/owncloud/core/issues/20769
	 *
	 * The owner is allowed to move their files (if they are shared) into a receiving folder
	 * In this case we need to update the parent of the moved share. Since they are
	 * effectively handing over ownership of the file the rest of the code needs to know
	 * they need to build up the reshare tree.
	 *
	 * @param string $path
	 */
	static private function moveShareToShare($path) {
		$userFolder = \OC::$server->getUserFolder();

		// If the user folder can't be constructed (e.g. link share) just return.
		if ($userFolder === null) {
			return;
		}

		$src = $userFolder->get($path);

		$shareManager = \OC::$server->getShareManager();

		$shares = $shareManager->getSharesBy($userFolder->getOwner()->getUID(), \OCP\Share::SHARE_TYPE_USER, $src, false, -1);
		$shares = array_merge($shares, $shareManager->getSharesBy($userFolder->getOwner()->getUID(), \OCP\Share::SHARE_TYPE_GROUP, $src, false, -1));

		// If the path we move is not a share we don't care
		if (empty($shares)) {
			return;
		}

		// Check if the destination is inside a share
		$mountManager = \OC::$server->getMountManager();
		$dstMount = $mountManager->find($src->getPath());
		if (!($dstMount instanceof \OCA\Files_Sharing\SharedMount)) {
			return;
		}

		$newOwner = $dstMount->getShare()->getShareOwner();

		//Ownership is moved over
		foreach ($shares as $share) {
			/** @var \OCP\Share\IShare $share */
			$share->setShareOwner($newOwner);
			$shareManager->updateShare($share);
		}
	}

	/**
	 * clean up oc_share table from files which are no longer exists
	 *
	 * This fixes issues from updates from files_sharing < 0.3.5.6 (ownCloud 4.5)
	 * It will just be called during the update of the app
	 */
	static public function fixBrokenSharesOnAppUpdate() {
		// delete all shares where the original file no longer exists
		$findAndRemoveShares = \OCP\DB::prepare('DELETE FROM `*PREFIX*share` ' .
			'WHERE `item_type` IN (\'file\', \'folder\') ' .
			'AND `file_source` NOT IN (SELECT `fileid` FROM `*PREFIX*filecache`)'
		);
		$findAndRemoveShares->execute(array());
	}

	/**
	 * rename mount point from the children if the parent was renamed
	 *
	 * @param string $oldPath old path relative to data/user/files
	 * @param string $newPath new path relative to data/user/files
	 */
	static private function renameChildren($oldPath, $newPath) {

		$absNewPath =  \OC\Files\Filesystem::normalizePath('/' . \OCP\User::getUser() . '/files/' . $newPath);
		$absOldPath =  \OC\Files\Filesystem::normalizePath('/' . \OCP\User::getUser() . '/files/' . $oldPath);

		$mountManager = \OC\Files\Filesystem::getMountManager();
		$mountedShares = $mountManager->findIn('/' . \OCP\User::getUser() . '/files/' . $oldPath);
		foreach ($mountedShares as $mount) {
			if ($mount->getStorage()->instanceOfStorage('OCA\Files_Sharing\ISharedStorage')) {
				$mountPoint = $mount->getMountPoint();
				$target = str_replace($absOldPath, $absNewPath, $mountPoint);
				$mount->moveMount($target);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
			}
		}
	}

}


1			<?php
2			/**
3			* @author Björn Schießle <[email protected]>
4			* @author Joas Schilling <[email protected]>
5			* @author Michael Gapczynski <[email protected]>
6			* @author Morris Jobke <[email protected]>
7			* @author Robin Appelman <[email protected]>
8			* @author Roeland Jago Douma <[email protected]>
9			* @author Vincent Petry <[email protected]>
10			*
11			* @copyright Copyright (c) 2016, ownCloud, Inc.
12			* @license AGPL-3.0
13			*
14			* This code is free software: you can redistribute it and/or modify
15			* it under the terms of the GNU Affero General Public License, version 3,
16			* as published by the Free Software Foundation.
17			*
18			* This program is distributed in the hope that it will be useful,
19			* but WITHOUT ANY WARRANTY; without even the implied warranty of
20			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21			* GNU Affero General Public License for more details.
22			*
23			* You should have received a copy of the GNU Affero General Public License, version 3,
24			* along with this program. If not, see <http://www.gnu.org/licenses/>
25			*
26			*/
27
28			namespace OC\Files\Cache;
29
30			class Shared_Updater {
31
32			/**
33			* @param array $params
34			*/
35			static public function renameHook($params) {
36			self::renameChildren($params['oldpath'], $params['newpath']);
37			self::moveShareToShare($params['newpath']);
38			}
39
40			/**
41			* Fix for https://github.com/owncloud/core/issues/20769
42			*
43			* The owner is allowed to move their files (if they are shared) into a receiving folder
44			* In this case we need to update the parent of the moved share. Since they are
45			* effectively handing over ownership of the file the rest of the code needs to know
46			* they need to build up the reshare tree.
47			*
48			* @param string $path
49			*/
50			static private function moveShareToShare($path) {
51			$userFolder = \OC::$server->getUserFolder();
52
53			// If the user folder can't be constructed (e.g. link share) just return.
54			if ($userFolder === null) {
55			return;
56			}
57
58			$src = $userFolder->get($path);
59
60			$shareManager = \OC::$server->getShareManager();
61
62			$shares = $shareManager->getSharesBy($userFolder->getOwner()->getUID(), \OCP\Share::SHARE_TYPE_USER, $src, false, -1);
63			$shares = array_merge($shares, $shareManager->getSharesBy($userFolder->getOwner()->getUID(), \OCP\Share::SHARE_TYPE_GROUP, $src, false, -1));
64
65			// If the path we move is not a share we don't care
66			if (empty($shares)) {
67			return;
68			}
69
70			// Check if the destination is inside a share
71			$mountManager = \OC::$server->getMountManager();
72			$dstMount = $mountManager->find($src->getPath());
73			if (!($dstMount instanceof \OCA\Files_Sharing\SharedMount)) {
74			return;
75			}
76
77			$newOwner = $dstMount->getShare()->getShareOwner();
78
79			//Ownership is moved over
80			foreach ($shares as $share) {
81			/** @var \OCP\Share\IShare $share */
82			$share->setShareOwner($newOwner);
83			$shareManager->updateShare($share);
84			}
85			}
86
87			/**
88			* clean up oc_share table from files which are no longer exists
89			*
90			* This fixes issues from updates from files_sharing < 0.3.5.6 (ownCloud 4.5)
91			* It will just be called during the update of the app
92			*/
93			static public function fixBrokenSharesOnAppUpdate() {
94			// delete all shares where the original file no longer exists
95			$findAndRemoveShares = \OCP\DB::prepare('DELETE FROM `PREFIXshare` ' .
96			'WHERE `item_type` IN (\'file\', \'folder\') ' .
97			'AND `file_source` NOT IN (SELECT `fileid` FROM `PREFIXfilecache`)'
98			);
99			$findAndRemoveShares->execute(array());
100			}
101
102			/**
103			* rename mount point from the children if the parent was renamed
104			*
105			* @param string $oldPath old path relative to data/user/files
106			* @param string $newPath new path relative to data/user/files
107			*/
108			static private function renameChildren($oldPath, $newPath) {
109
110			$absNewPath = \OC\Files\Filesystem::normalizePath('/' . \OCP\User::getUser() . '/files/' . $newPath);
111			$absOldPath = \OC\Files\Filesystem::normalizePath('/' . \OCP\User::getUser() . '/files/' . $oldPath);
112
113			$mountManager = \OC\Files\Filesystem::getMountManager();
114			$mountedShares = $mountManager->findIn('/' . \OCP\User::getUser() . '/files/' . $oldPath);
115			foreach ($mountedShares as $mount) {
116			if ($mount->getStorage()->instanceOfStorage('OCA\Files_Sharing\ISharedStorage')) {
117			$mountPoint = $mount->getMountPoint();
118			$target = str_replace($absOldPath, $absNewPath, $mountPoint);
119			$mount->moveMount($target);
			0 ignored issues – show Bug introduced 2016-02-15 17:54 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `OC\Files\Mount\MountPoint` as the method `moveMount()` does only exist in the following sub-classes of `OC\Files\Mount\MountPoint`: `OCA\Files_External\Lib\PersonalMount`, `OCA\Files_Sharing\External\Mount`, `OCA\Files_Sharing\SharedMount`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
120			}
121			}
122			}
123
124			}
125

owncloud / core

Push — master ( 8f8ae9...3a7ad7 )

Shared_Updater A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

Available Fixes

Duplication Side-by-Side

Filter issues like