Issues in sharedmount.php - New Issues - Inspection of "Merge pull request #4421 from nextcloud/stable9-fi..." - nextcloud/server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — stable9 ( 485cb1...e094cf )

by Lukas

created 2017-04-21 17:16 UTC

apps/files_sharing/lib/sharedmount.php (1 issue)

Labels

Severity

Minor 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php
/**
 * @copyright Copyright (c) 2016, ownCloud, Inc.
 *
 * @author Björn Schießle <[email protected]>
 * @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]>
 *
 * @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\Filesystem;
use OC\Files\Mount\MountPoint;
use OC\Files\Mount\MoveableMount;
use OC\Files\View;

/**
 * Shared mount points can be moved by the user
 */
class SharedMount extends MountPoint implements MoveableMount {
	/**
	 * @var \OC\Files\Storage\Shared $storage
	 */
	protected $storage = null;

	/**
	 * @var \OC\Files\View
	 */
	private $recipientView;

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

	/**
	 * @param string $storage
	 * @param SharedMount[] $mountpoints
	 * @param array|null $arguments
	 * @param \OCP\Files\Storage\IStorageFactory $loader
	 */
	public function __construct($storage, array $mountpoints, $arguments = null, $loader = null) {
		$this->user = $arguments['user'];
		$this->recipientView = new View('/' . $this->user . '/files');
		$newMountPoint = $this->verifyMountPoint($arguments['share'], $mountpoints);
		$absMountPoint = '/' . $this->user . '/files' . $newMountPoint;
		$arguments['ownerView'] = new View('/' . $arguments['share']['uid_owner'] . '/files');
		parent::__construct($storage, $absMountPoint, $arguments, $loader);
	}

	/**
	 * check if the parent folder exists otherwise move the mount point up
	 *
	 * @param array $share
	 * @param SharedMount[] $mountpoints
	 * @return string
	 */
	private function verifyMountPoint(&$share, array $mountpoints) {

		$mountPoint = basename($share['file_target']);
		$parent = dirname($share['file_target']);

		if (!$this->recipientView->is_dir($parent)) {
			$parent = Helper::getShareFolder($this->recipientView);
		}

		$newMountPoint = $this->generateUniqueTarget(
			\OC\Files\Filesystem::normalizePath($parent . '/' . $mountPoint),
			$this->recipientView,
			$mountpoints
		);

		if ($newMountPoint !== $share['file_target']) {
			$this->updateFileTarget($newMountPoint, $share);
			$share['file_target'] = $newMountPoint;
			$share['unique_name'] = true;
		}

		return $newMountPoint;
	}

	/**
	 * @param string $path
	 * @param View $view
	 * @param SharedMount[] $mountpoints
	 * @return mixed
	 */
	private function generateUniqueTarget($path, $view, array $mountpoints) {
		$pathinfo = pathinfo($path);
		$ext = (isset($pathinfo['extension'])) ? '.'.$pathinfo['extension'] : '';
		$name = $pathinfo['filename'];
		$dir = $pathinfo['dirname'];

		// Helper function to find existing mount points
		$mountpointExists = function($path) use ($mountpoints) {
			foreach ($mountpoints as $mountpoint) {
				if ($mountpoint->getShare()['file_target'] === $path) {
					return true;
				}
			}
			return false;
		};

		$i = 2;
		while ($view->file_exists($path) || $mountpointExists($path)) {
			$path = Filesystem::normalizePath($dir . '/' . $name . ' ('.$i.')' . $ext);
			$i++;
		}

		return $path;
	}

	/**
	 * update fileTarget in the database if the mount point changed
	 *
	 * @param string $newPath
	 * @param array $share reference to the share which should be modified
	 * @return bool
	 */
	private function updateFileTarget($newPath, &$share) {
		// if the user renames a mount point from a group share we need to create a new db entry
		// for the unique name
		if ($share['share_type'] === \OCP\Share::SHARE_TYPE_GROUP && empty($share['unique_name'])) {
			$query = \OCP\DB::prepare('INSERT INTO `*PREFIX*share` (`item_type`, `item_source`, `item_target`,'
			.' `share_type`, `share_with`, `uid_owner`, `permissions`, `stime`, `file_source`,'
			.' `file_target`, `token`, `parent`) VALUES (?,?,?,?,?,?,?,?,?,?,?,?)');
			$arguments = array($share['item_type'], $share['item_source'], $share['item_target'],
				2, $this->user, $share['uid_owner'], $share['permissions'], $share['stime'], $share['file_source'],
				$newPath, $share['token'], $share['id']);
		} else {
			// rename mount point
			$query = \OCP\DB::prepare(
					'Update `*PREFIX*share`
						SET `file_target` = ?
						WHERE `id` = ?'
			);
			$arguments = array($newPath, $share['id']);
		}

		$result = $query->execute($arguments);

		return $result === 1 ? true : false;
	}

	/**
	 * Format a path to be relative to the /user/files/ directory
	 *
	 * @param string $path the absolute path
	 * @return string e.g. turns '/admin/files/test.txt' into '/test.txt'
	 * @throws \OCA\Files_Sharing\Exceptions\BrokenPath
	 */
	protected function stripUserFilesPath($path) {
		$trimmed = ltrim($path, '/');
		$split = explode('/', $trimmed);

		// it is not a file relative to data/user/files
		if (count($split) < 3 || $split[1] !== 'files') {
			\OCP\Util::writeLog('file sharing',
				'Can not strip userid and "files/" from path: ' . $path,
				\OCP\Util::ERROR);
			throw new \OCA\Files_Sharing\Exceptions\BrokenPath('Path does not start with /user/files', 10);
		}

		// skip 'user' and 'files'

		$sliced = array_slice($split, 2);
		$relPath = implode('/', $sliced);

		return '/' . $relPath;
	}

	/**
	 * Move the mount point to $target
	 *
	 * @param string $target the target mount point
	 * @return bool
	 */
	public function moveMount($target) {

		$relTargetPath = $this->stripUserFilesPath($target);
		$share = $this->storage->getShare();

		$result = true;

		if (!empty($share['grouped'])) {
			foreach ($share['grouped'] as $s) {
				$result = $this->updateFileTarget($relTargetPath, $s) && $result;
			}
		} else {
			$result = $this->updateFileTarget($relTargetPath, $share) && $result;
		}

		if ($result) {
			$this->setMountPoint($target);
			$this->storage->setUniqueName();
			$this->storage->setMountPoint($relTargetPath);

		} else {
			\OCP\Util::writeLog('file sharing',
				'Could not rename mount point for shared folder "' . $this->getMountPoint() . '" to "' . $target . '"',
				\OCP\Util::ERROR);
		}

		return $result;
	}

	/**
	 * Remove the mount points
	 *
	 * @return bool
	 */
	public function removeMount() {
		$mountManager = \OC\Files\Filesystem::getMountManager();
		/** @var $storage \OC\Files\Storage\Shared */
		$storage = $this->getStorage();
		$result = $storage->unshareStorage();
		$mountManager->removeMount($this->mountPoint);

		return $result;
	}

	/**
	 * @return array
	 */
	public function getShare() {
		/** @var $storage \OC\Files\Storage\Shared */
		$storage = $this->getStorage();
		return $storage->getShare();
	}
}


1		<?php
2		/**
3		* @copyright Copyright (c) 2016, ownCloud, Inc.
4		*
5		* @author Björn Schießle <[email protected]>
6		* @author Joas Schilling <[email protected]>
7		* @author Morris Jobke <[email protected]>
8		* @author Robin Appelman <[email protected]>
9		* @author Roeland Jago Douma <[email protected]>
10		* @author Vincent Petry <[email protected]>
11		*
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 OCA\Files_Sharing;
29
30		use OC\Files\Filesystem;
31		use OC\Files\Mount\MountPoint;
32		use OC\Files\Mount\MoveableMount;
33		use OC\Files\View;
34
35		/**
36		* Shared mount points can be moved by the user
37		*/
38		class SharedMount extends MountPoint implements MoveableMount {
39		/**
40		* @var \OC\Files\Storage\Shared $storage
41		*/
42		protected $storage = null;
43
44		/**
45		* @var \OC\Files\View
46		*/
47		private $recipientView;
48
49		/**
50		* @var string
51		*/
52		private $user;
53
54		/**
55		* @param string $storage
56		* @param SharedMount[] $mountpoints
57		* @param array\|null $arguments
58		* @param \OCP\Files\Storage\IStorageFactory $loader
59		*/
60		public function __construct($storage, array $mountpoints, $arguments = null, $loader = null) {
61		$this->user = $arguments['user'];
62		$this->recipientView = new View('/' . $this->user . '/files');
63		$newMountPoint = $this->verifyMountPoint($arguments['share'], $mountpoints);
64		$absMountPoint = '/' . $this->user . '/files' . $newMountPoint;
65		$arguments['ownerView'] = new View('/' . $arguments['share']['uid_owner'] . '/files');
66		parent::__construct($storage, $absMountPoint, $arguments, $loader);
67		}
68
69		/**
70		* check if the parent folder exists otherwise move the mount point up
71		*
72		* @param array $share
73		* @param SharedMount[] $mountpoints
74		* @return string
75		*/
76		private function verifyMountPoint(&$share, array $mountpoints) {
77
78		$mountPoint = basename($share['file_target']);
79		$parent = dirname($share['file_target']);
80
81		if (!$this->recipientView->is_dir($parent)) {
82		$parent = Helper::getShareFolder($this->recipientView);
83		}
84
85		$newMountPoint = $this->generateUniqueTarget(
86		\OC\Files\Filesystem::normalizePath($parent . '/' . $mountPoint),
87		$this->recipientView,
88		$mountpoints
89		);
90
91		if ($newMountPoint !== $share['file_target']) {
92		$this->updateFileTarget($newMountPoint, $share);
93		$share['file_target'] = $newMountPoint;
94		$share['unique_name'] = true;
95		}
96
97		return $newMountPoint;
98		}
99
100		/**
101		* @param string $path
102		* @param View $view
103		* @param SharedMount[] $mountpoints
104		* @return mixed
105		*/
106		private function generateUniqueTarget($path, $view, array $mountpoints) {
107		$pathinfo = pathinfo($path);
108		$ext = (isset($pathinfo['extension'])) ? '.'.$pathinfo['extension'] : '';
109		$name = $pathinfo['filename'];
110		$dir = $pathinfo['dirname'];
111
112		// Helper function to find existing mount points
113		$mountpointExists = function($path) use ($mountpoints) {
114		foreach ($mountpoints as $mountpoint) {
115		if ($mountpoint->getShare()['file_target'] === $path) {
116		return true;
117		}
118		}
119		return false;
120		};
121
122		$i = 2;
123	View Code Duplication	while ($view->file_exists($path) \|\| $mountpointExists($path)) {
124		$path = Filesystem::normalizePath($dir . '/' . $name . ' ('.$i.')' . $ext);
125		$i++;
126		}
127
128		return $path;
129		}
130
131		/**
132		* update fileTarget in the database if the mount point changed
133		*
134		* @param string $newPath
135		* @param array $share reference to the share which should be modified
136		* @return bool
137		*/
138		private function updateFileTarget($newPath, &$share) {
139		// if the user renames a mount point from a group share we need to create a new db entry
140		// for the unique name
141		if ($share['share_type'] === \OCP\Share::SHARE_TYPE_GROUP && empty($share['unique_name'])) {
142		$query = \OCP\DB::prepare('INSERT INTO `PREFIXshare` (`item_type`, `item_source`, `item_target`,'
143		.' `share_type`, `share_with`, `uid_owner`, `permissions`, `stime`, `file_source`,'
144		.' `file_target`, `token`, `parent`) VALUES (?,?,?,?,?,?,?,?,?,?,?,?)');
145		$arguments = array($share['item_type'], $share['item_source'], $share['item_target'],
146		2, $this->user, $share['uid_owner'], $share['permissions'], $share['stime'], $share['file_source'],
147		$newPath, $share['token'], $share['id']);
148		} else {
149		// rename mount point
150		$query = \OCP\DB::prepare(
151		'Update `PREFIXshare`
152		SET `file_target` = ?
153		WHERE `id` = ?'
154		);
155		$arguments = array($newPath, $share['id']);
156		}
157
158		$result = $query->execute($arguments);
159
160		return $result === 1 ? true : false;
161		}
162
163		/**
164		* Format a path to be relative to the /user/files/ directory
165		*
166		* @param string $path the absolute path
167		* @return string e.g. turns '/admin/files/test.txt' into '/test.txt'
168		* @throws \OCA\Files_Sharing\Exceptions\BrokenPath
169		*/
170		protected function stripUserFilesPath($path) {
171		$trimmed = ltrim($path, '/');
172		$split = explode('/', $trimmed);
173
174		// it is not a file relative to data/user/files
175		if (count($split) < 3 \|\| $split[1] !== 'files') {
176		\OCP\Util::writeLog('file sharing',
177		'Can not strip userid and "files/" from path: ' . $path,
178		\OCP\Util::ERROR);
179		throw new \OCA\Files_Sharing\Exceptions\BrokenPath('Path does not start with /user/files', 10);
180		}
181
182		// skip 'user' and 'files'
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-04-18 15:26 UTC by Report Bug Copy Issue Report Show Similar Issues like this `38%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
183		$sliced = array_slice($split, 2);
184		$relPath = implode('/', $sliced);
185
186		return '/' . $relPath;
187		}
188
189		/**
190		* Move the mount point to $target
191		*
192		* @param string $target the target mount point
193		* @return bool
194		*/
195		public function moveMount($target) {
196
197		$relTargetPath = $this->stripUserFilesPath($target);
198		$share = $this->storage->getShare();
199
200		$result = true;
201
202		if (!empty($share['grouped'])) {
203		foreach ($share['grouped'] as $s) {
204		$result = $this->updateFileTarget($relTargetPath, $s) && $result;
205		}
206		} else {
207		$result = $this->updateFileTarget($relTargetPath, $share) && $result;
208		}
209
210		if ($result) {
211		$this->setMountPoint($target);
212		$this->storage->setUniqueName();
213		$this->storage->setMountPoint($relTargetPath);
214
215		} else {
216		\OCP\Util::writeLog('file sharing',
217		'Could not rename mount point for shared folder "' . $this->getMountPoint() . '" to "' . $target . '"',
218		\OCP\Util::ERROR);
219		}
220
221		return $result;
222		}
223
224		/**
225		* Remove the mount points
226		*
227		* @return bool
228		*/
229		public function removeMount() {
230		$mountManager = \OC\Files\Filesystem::getMountManager();
231		/** @var $storage \OC\Files\Storage\Shared */
232		$storage = $this->getStorage();
233		$result = $storage->unshareStorage();
234		$mountManager->removeMount($this->mountPoint);
235
236		return $result;
237		}
238
239		/**
240		* @return array
241		*/
242		public function getShare() {
243		/** @var $storage \OC\Files\Storage\Shared */
244		$storage = $this->getStorage();
245		return $storage->getShare();
246		}
247		}
248

nextcloud / server

Push — stable9 ( 485cb1...e094cf )

apps/files_sharing/lib/sharedmount.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like