Merge pull request #32077 from nextcloud/cleanup/lock

Cleanup lock related code

1 files changed, 15 insertions, 38 deletions

diff --git a/lib/private/Lock/AbstractLockingProvider.php b/lib/private/Lock/AbstractLockingProvider.php
index f4899bbb2b2..6e8289db12e 100644
--- a/lib/private/Lock/AbstractLockingProvider.php
+++ b/lib/private/Lock/AbstractLockingProvider.php
@@ -30,24 +30,18 @@ use OCP\Lock\ILockingProvider;
 
 /**
  * Base locking provider that keeps track of locks acquired during the current request
- * to release any left over locks at the end of the request
+ * to release any leftover locks at the end of the request
  */
 abstract class AbstractLockingProvider implements ILockingProvider {
-	/** @var int $ttl */
-	protected $ttl; // how long until we clear stray locks in seconds
+	/** how long until we clear stray locks in seconds */
+	protected int $ttl;
 
 	protected $acquiredLocks = [
 		'shared' => [],
 		'exclusive' => []
 	];
 
-	/**
-	 * Check if we've locally acquired a lock
-	 *
-	 * @param string $path
-	 * @param int $type
-	 * @return bool
-	 */
+	/** @inheritDoc */
 	protected function hasAcquiredLock(string $path, int $type): bool {
 		if ($type === self::LOCK_SHARED) {
 			return isset($this->acquiredLocks['shared'][$path]) && $this->acquiredLocks['shared'][$path] > 0;
@@ -56,14 +50,9 @@ abstract class AbstractLockingProvider implements ILockingProvider {
 		}
 	}
 
-	/**
-	 * Mark a locally acquired lock
-	 *
-	 * @param string $path
-	 * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
-	 */
-	protected function markAcquire(string $path, int $type) {
-		if ($type === self::LOCK_SHARED) {
+	/** @inheritDoc */
+	protected function markAcquire(string $path, int $targetType): void {
+		if ($targetType === self::LOCK_SHARED) {
 			if (!isset($this->acquiredLocks['shared'][$path])) {
 				$this->acquiredLocks['shared'][$path] = 0;
 			}
@@ -73,13 +62,8 @@ abstract class AbstractLockingProvider implements ILockingProvider {
 		}
 	}
 
-	/**
-	 * Mark a release of a locally acquired lock
-	 *
-	 * @param string $path
-	 * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
-	 */
-	protected function markRelease(string $path, int $type) {
+	/** @inheritDoc */
+	protected function markRelease(string $path, int $type): void {
 		if ($type === self::LOCK_SHARED) {
 			if (isset($this->acquiredLocks['shared'][$path]) and $this->acquiredLocks['shared'][$path] > 0) {
 				$this->acquiredLocks['shared'][$path]--;
@@ -92,13 +76,8 @@ abstract class AbstractLockingProvider implements ILockingProvider {
 		}
 	}
 
-	/**
-	 * Change the type of an existing tracked lock
-	 *
-	 * @param string $path
-	 * @param int $targetType self::LOCK_SHARED or self::LOCK_EXCLUSIVE
-	 */
-	protected function markChange(string $path, int $targetType) {
+	/** @inheritDoc */
+	protected function markChange(string $path, int $targetType): void {
 		if ($targetType === self::LOCK_SHARED) {
 			unset($this->acquiredLocks['exclusive'][$path]);
 			if (!isset($this->acquiredLocks['shared'][$path])) {
@@ -111,10 +90,8 @@ abstract class AbstractLockingProvider implements ILockingProvider {
 		}
 	}
 
-	/**
-	 * release all lock acquired by this instance which were marked using the mark* methods
-	 */
-	public function releaseAll() {
+	/** @inheritDoc */
+	public function releaseAll(): void {
 		foreach ($this->acquiredLocks['shared'] as $path => $count) {
 			for ($i = 0; $i < $count; $i++) {
 				$this->releaseLock($path, self::LOCK_SHARED);
@@ -126,7 +103,7 @@ abstract class AbstractLockingProvider implements ILockingProvider {
 		}
 	}
 
-	protected function getOwnSharedLockCount(string $path) {
-		return isset($this->acquiredLocks['shared'][$path]) ? $this->acquiredLocks['shared'][$path] : 0;
+	protected function getOwnSharedLockCount(string $path): int {
+		return $this->acquiredLocks['shared'][$path] ?? 0;
 	}
 }