OC\Lock\Persistent\LockManager

Complexity

Total Complexity

20

Size/Duplication

Total Lines	106
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
F	lock()	0	69	17
A	unlock()	0	3	1
A	getLocks()	0	3	1

<?php
declare(strict_types=1);
/**
 * @author Thomas Müller <thomas.mueller@tmit.eu>
 * @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 OC\Lock\Persistent;

use OCP\AppFramework\Utility\ITimeFactory;
use OCP\IUserSession;
use OCP\Lock\Persistent\ILock;

class LockManager {

	/** @var LockMapper */
	private $lockMapper;
	/** @var IUserSession */
	private $userSession;
	/** @var ITimeFactory */
	private $timeFactory;

	public function __construct(LockMapper $lockMapper,
								IUserSession $userSession,
								ITimeFactory $timeFactory) {
		$this->lockMapper = $lockMapper;
		$this->userSession = $userSession;
		$this->timeFactory = $timeFactory;
	}

	public function lock(int $storageId, string $internalPath, int $fileId, array $lockInfo) : bool {
		if ($fileId <= 0) {
			throw new \InvalidArgumentException('Invalid file id');
		}
		if (!isset($lockInfo['token'])) {
			throw new \InvalidArgumentException('No token provided in $lockInfo');
		}

		// We're making the lock timeout 30 minutes
		$timeout = 30*60;
		if (isset($lockInfo['timeout'])) {
			$timeout = $lockInfo['timeout'];
		}
		$owner = $lockInfo['owner'] ?? null;
		if ($owner === null && $this->userSession->isLoggedIn()) {
			$user = $this->userSession->getUser();
			if ($user !== null) {
				$owner = $user->getDisplayName();
				if ($user->getEMailAddress() !== null) {
					$owner .= " <{$user->getEMailAddress()}>";
				}
			}
		}

		$locks = $this->lockMapper->getLocksByPath($storageId, $internalPath, false);
		$exists = false;
		foreach ($locks as $lock) {
			if ($lock->getToken() === $lockInfo['token']) {
				$exists = true;
				$lock->setCreatedAt($this->timeFactory->getTime());
				$lock->setTimeout($timeout);
				if ($lock->getOwner() === '' || $lock->getOwner() === null) {
					$lock->setOwner($owner);
				}
				$this->lockMapper->update($lock);
			}
		}

		if ($exists) {
			return true;
		}

		$depth = 0;
		if (isset($lockInfo['depth'])) {
			$depth = $lockInfo['depth'];
		}
		$scope = ILock::LOCK_SCOPE_EXCLUSIVE;
		if (isset($lockInfo['scope'])) {
			$scope = $lockInfo['scope'];
		}

		$lock = new Lock();
		$lock->setFileId($fileId);
		$lock->setCreatedAt($this->timeFactory->getTime());
		$lock->setTimeout($timeout);
		$lock->setOwner($owner);
		$lock->setToken($lockInfo['token']);
		$lock->setScope($scope);
		$lock->setDepth($depth);

		if ($this->userSession->isLoggedIn()) {
			$user = $this->userSession->getUser();
			if ($user !== null) {
				$lock->setOwnerAccountId($user->getAccountId());

The method setOwnerAccountId does not exist on object<OC\Lock\Persistent\Lock>? Since you implemented __call, maybe consider adding a @method annotation.

			}
		}
		$this->lockMapper->insert($lock);
		return true;
	}

	/**
	 * @param int $fileId
	 * @param string $token
	 * @return bool
	 */
	public function unlock(int $fileId, string $token) : bool {
		return $this->lockMapper->deleteByFileIdAndToken($fileId, $token);
	}

	/**
	 * @param int $storageId
	 * @param string $internalPath
	 * @param bool $returnChildLocks
	 * @return ILock[]
	 */
	public function getLocks(int $storageId, string $internalPath, bool $returnChildLocks) : array {
		return $this->lockMapper->getLocksByPath($storageId, $internalPath, $returnChildLocks);
	}
}