nextcloud / server

lib/private/Lock/DBLockingProvider.php

Indentation +249 added lines, -249 removed lines

@@ -38,276 +38,276 @@
  * Locking provider that stores the locks in the database
  */
 class DBLockingProvider extends AbstractLockingProvider {
-	/**
-	 * @var \OCP\IDBConnection
-	 */
-	private $connection;
+    /**
+     * @var \OCP\IDBConnection
+     */
+    private $connection;
 
-	/**
-	 * @var \OCP\ILogger
-	 */
-	private $logger;
+    /**
+     * @var \OCP\ILogger
+     */
+    private $logger;
 
-	/**
-	 * @var \OCP\AppFramework\Utility\ITimeFactory
-	 */
-	private $timeFactory;
+    /**
+     * @var \OCP\AppFramework\Utility\ITimeFactory
+     */
+    private $timeFactory;
 
-	private $sharedLocks = [];
+    private $sharedLocks = [];
 
-	/**
-	 * @var bool
-	 */
-	private $cacheSharedLocks;
+    /**
+     * @var bool
+     */
+    private $cacheSharedLocks;
 
-	/**
-	 * Check if we have an open shared lock for a path
-	 *
-	 * @param string $path
-	 * @return bool
-	 */
-	protected function isLocallyLocked(string $path): bool {
-		return isset($this->sharedLocks[$path]) && $this->sharedLocks[$path];
-	}
+    /**
+     * Check if we have an open shared lock for a path
+     *
+     * @param string $path
+     * @return bool
+     */
+    protected function isLocallyLocked(string $path): bool {
+        return isset($this->sharedLocks[$path]) && $this->sharedLocks[$path];
+    }
 
-	/**
-	 * 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) {
-		parent::markAcquire($path, $type);
-		if ($this->cacheSharedLocks) {
-			if ($type === self::LOCK_SHARED) {
-				$this->sharedLocks[$path] = true;
-			}
-		}
-	}
+    /**
+     * 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) {
+        parent::markAcquire($path, $type);
+        if ($this->cacheSharedLocks) {
+            if ($type === self::LOCK_SHARED) {
+                $this->sharedLocks[$path] = true;
+            }
+        }
+    }
 
-	/**
-	 * 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) {
-		parent::markChange($path, $targetType);
-		if ($this->cacheSharedLocks) {
-			if ($targetType === self::LOCK_SHARED) {
-				$this->sharedLocks[$path] = true;
-			} else if ($targetType === self::LOCK_EXCLUSIVE) {
-				$this->sharedLocks[$path] = false;
-			}
-		}
-	}
+    /**
+     * 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) {
+        parent::markChange($path, $targetType);
+        if ($this->cacheSharedLocks) {
+            if ($targetType === self::LOCK_SHARED) {
+                $this->sharedLocks[$path] = true;
+            } else if ($targetType === self::LOCK_EXCLUSIVE) {
+                $this->sharedLocks[$path] = false;
+            }
+        }
+    }
 
-	/**
-	 * @param \OCP\IDBConnection $connection
-	 * @param \OCP\ILogger $logger
-	 * @param \OCP\AppFramework\Utility\ITimeFactory $timeFactory
-	 * @param int $ttl
-	 * @param bool $cacheSharedLocks
-	 */
-	public function __construct(
-		IDBConnection $connection,
-		ILogger $logger,
-		ITimeFactory $timeFactory,
-		int $ttl = 3600,
-		$cacheSharedLocks = true
-	) {
-		$this->connection = $connection;
-		$this->logger = $logger;
-		$this->timeFactory = $timeFactory;
-		$this->ttl = $ttl;
-		$this->cacheSharedLocks = $cacheSharedLocks;
-	}
+    /**
+     * @param \OCP\IDBConnection $connection
+     * @param \OCP\ILogger $logger
+     * @param \OCP\AppFramework\Utility\ITimeFactory $timeFactory
+     * @param int $ttl
+     * @param bool $cacheSharedLocks
+     */
+    public function __construct(
+        IDBConnection $connection,
+        ILogger $logger,
+        ITimeFactory $timeFactory,
+        int $ttl = 3600,
+        $cacheSharedLocks = true
+    ) {
+        $this->connection = $connection;
+        $this->logger = $logger;
+        $this->timeFactory = $timeFactory;
+        $this->ttl = $ttl;
+        $this->cacheSharedLocks = $cacheSharedLocks;
+    }
 
-	/**
-	 * Insert a file locking row if it does not exists.
-	 *
-	 * @param string $path
-	 * @param int $lock
-	 * @return int number of inserted rows
-	 */
+    /**
+     * Insert a file locking row if it does not exists.
+     *
+     * @param string $path
+     * @param int $lock
+     * @return int number of inserted rows
+     */
 
-	protected function initLockField(string $path, int $lock = 0): int {
-		$expire = $this->getExpireTime();
-		return $this->connection->insertIfNotExist('*PREFIX*file_locks', ['key' => $path, 'lock' => $lock, 'ttl' => $expire], ['key']);
-	}
+    protected function initLockField(string $path, int $lock = 0): int {
+        $expire = $this->getExpireTime();
+        return $this->connection->insertIfNotExist('*PREFIX*file_locks', ['key' => $path, 'lock' => $lock, 'ttl' => $expire], ['key']);
+    }
 
-	/**
-	 * @return int
-	 */
-	protected function getExpireTime(): int {
-		return $this->timeFactory->getTime() + $this->ttl;
-	}
+    /**
+     * @return int
+     */
+    protected function getExpireTime(): int {
+        return $this->timeFactory->getTime() + $this->ttl;
+    }
 
-	/**
-	 * @param string $path
-	 * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
-	 * @return bool
-	 */
-	public function isLocked(string $path, int $type): bool {
-		if ($this->hasAcquiredLock($path, $type)) {
-			return true;
-		}
-		$query = $this->connection->prepare('SELECT `lock` from `*PREFIX*file_locks` WHERE `key` = ?');
-		$query->execute([$path]);
-		$lockValue = (int)$query->fetchColumn();
-		if ($type === self::LOCK_SHARED) {
-			if ($this->isLocallyLocked($path)) {
-				// if we have a shared lock we kept open locally but it's released we always have at least 1 shared lock in the db
-				return $lockValue > 1;
-			} else {
-				return $lockValue > 0;
-			}
-		} else if ($type === self::LOCK_EXCLUSIVE) {
-			return $lockValue === -1;
-		} else {
-			return false;
-		}
-	}
+    /**
+     * @param string $path
+     * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
+     * @return bool
+     */
+    public function isLocked(string $path, int $type): bool {
+        if ($this->hasAcquiredLock($path, $type)) {
+            return true;
+        }
+        $query = $this->connection->prepare('SELECT `lock` from `*PREFIX*file_locks` WHERE `key` = ?');
+        $query->execute([$path]);
+        $lockValue = (int)$query->fetchColumn();
+        if ($type === self::LOCK_SHARED) {
+            if ($this->isLocallyLocked($path)) {
+                // if we have a shared lock we kept open locally but it's released we always have at least 1 shared lock in the db
+                return $lockValue > 1;
+            } else {
+                return $lockValue > 0;
+            }
+        } else if ($type === self::LOCK_EXCLUSIVE) {
+            return $lockValue === -1;
+        } else {
+            return false;
+        }
+    }
 
-	/**
-	 * @param string $path
-	 * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
-	 * @throws \OCP\Lock\LockedException
-	 */
-	public function acquireLock(string $path, int $type) {
-		$expire = $this->getExpireTime();
-		if ($type === self::LOCK_SHARED) {
-			if (!$this->isLocallyLocked($path)) {
-				$result = $this->initLockField($path, 1);
-				if ($result <= 0) {
-					$result = $this->connection->executeUpdate(
-						'UPDATE `*PREFIX*file_locks` SET `lock` = `lock` + 1, `ttl` = ? WHERE `key` = ? AND `lock` >= 0',
-						[$expire, $path]
-					);
-				}
-			} else {
-				$result = 1;
-			}
-		} else {
-			$existing = 0;
-			if ($this->hasAcquiredLock($path, ILockingProvider::LOCK_SHARED) === false && $this->isLocallyLocked($path)) {
-				$existing = 1;
-			}
-			$result = $this->initLockField($path, -1);
-			if ($result <= 0) {
-				$result = $this->connection->executeUpdate(
-					'UPDATE `*PREFIX*file_locks` SET `lock` = -1, `ttl` = ? WHERE `key` = ? AND `lock` = ?',
-					[$expire, $path, $existing]
-				);
-			}
-		}
-		if ($result !== 1) {
-			throw new LockedException($path);
-		}
-		$this->markAcquire($path, $type);
-	}
+    /**
+     * @param string $path
+     * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
+     * @throws \OCP\Lock\LockedException
+     */
+    public function acquireLock(string $path, int $type) {
+        $expire = $this->getExpireTime();
+        if ($type === self::LOCK_SHARED) {
+            if (!$this->isLocallyLocked($path)) {
+                $result = $this->initLockField($path, 1);
+                if ($result <= 0) {
+                    $result = $this->connection->executeUpdate(
+                        'UPDATE `*PREFIX*file_locks` SET `lock` = `lock` + 1, `ttl` = ? WHERE `key` = ? AND `lock` >= 0',
+                        [$expire, $path]
+                    );
+                }
+            } else {
+                $result = 1;
+            }
+        } else {
+            $existing = 0;
+            if ($this->hasAcquiredLock($path, ILockingProvider::LOCK_SHARED) === false && $this->isLocallyLocked($path)) {
+                $existing = 1;
+            }
+            $result = $this->initLockField($path, -1);
+            if ($result <= 0) {
+                $result = $this->connection->executeUpdate(
+                    'UPDATE `*PREFIX*file_locks` SET `lock` = -1, `ttl` = ? WHERE `key` = ? AND `lock` = ?',
+                    [$expire, $path, $existing]
+                );
+            }
+        }
+        if ($result !== 1) {
+            throw new LockedException($path);
+        }
+        $this->markAcquire($path, $type);
+    }
 
-	/**
-	 * @param string $path
-	 * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
-	 *
-	 * @suppress SqlInjectionChecker
-	 */
-	public function releaseLock(string $path, int $type) {
-		$this->markRelease($path, $type);
+    /**
+     * @param string $path
+     * @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
+     *
+     * @suppress SqlInjectionChecker
+     */
+    public function releaseLock(string $path, int $type) {
+        $this->markRelease($path, $type);
 
-		// we keep shared locks till the end of the request so we can re-use them
-		if ($type === self::LOCK_EXCLUSIVE) {
-			$this->connection->executeUpdate(
-				'UPDATE `*PREFIX*file_locks` SET `lock` = 0 WHERE `key` = ? AND `lock` = -1',
-				[$path]
-			);
-		} else if (!$this->cacheSharedLocks) {
-			$query = $this->connection->getQueryBuilder();
-			$query->update('file_locks')
-				->set('lock', $query->func()->subtract('lock', $query->createNamedParameter(1)))
-				->where($query->expr()->eq('key', $query->createNamedParameter($path)))
-				->andWhere($query->expr()->gt('lock', $query->createNamedParameter(0)));
-			$query->execute();
-		}
-	}
+        // we keep shared locks till the end of the request so we can re-use them
+        if ($type === self::LOCK_EXCLUSIVE) {
+            $this->connection->executeUpdate(
+                'UPDATE `*PREFIX*file_locks` SET `lock` = 0 WHERE `key` = ? AND `lock` = -1',
+                [$path]
+            );
+        } else if (!$this->cacheSharedLocks) {
+            $query = $this->connection->getQueryBuilder();
+            $query->update('file_locks')
+                ->set('lock', $query->func()->subtract('lock', $query->createNamedParameter(1)))
+                ->where($query->expr()->eq('key', $query->createNamedParameter($path)))
+                ->andWhere($query->expr()->gt('lock', $query->createNamedParameter(0)));
+            $query->execute();
+        }
+    }
 
-	/**
-	 * Change the type of an existing lock
-	 *
-	 * @param string $path
-	 * @param int $targetType self::LOCK_SHARED or self::LOCK_EXCLUSIVE
-	 * @throws \OCP\Lock\LockedException
-	 */
-	public function changeLock(string $path, int $targetType) {
-		$expire = $this->getExpireTime();
-		if ($targetType === self::LOCK_SHARED) {
-			$result = $this->connection->executeUpdate(
-				'UPDATE `*PREFIX*file_locks` SET `lock` = 1, `ttl` = ? WHERE `key` = ? AND `lock` = -1',
-				[$expire, $path]
-			);
-		} else {
-			// since we only keep one shared lock in the db we need to check if we have more then one shared lock locally manually
-			if (isset($this->acquiredLocks['shared'][$path]) && $this->acquiredLocks['shared'][$path] > 1) {
-				throw new LockedException($path);
-			}
-			$result = $this->connection->executeUpdate(
-				'UPDATE `*PREFIX*file_locks` SET `lock` = -1, `ttl` = ? WHERE `key` = ? AND `lock` = 1',
-				[$expire, $path]
-			);
-		}
-		if ($result !== 1) {
-			throw new LockedException($path);
-		}
-		$this->markChange($path, $targetType);
-	}
+    /**
+     * Change the type of an existing lock
+     *
+     * @param string $path
+     * @param int $targetType self::LOCK_SHARED or self::LOCK_EXCLUSIVE
+     * @throws \OCP\Lock\LockedException
+     */
+    public function changeLock(string $path, int $targetType) {
+        $expire = $this->getExpireTime();
+        if ($targetType === self::LOCK_SHARED) {
+            $result = $this->connection->executeUpdate(
+                'UPDATE `*PREFIX*file_locks` SET `lock` = 1, `ttl` = ? WHERE `key` = ? AND `lock` = -1',
+                [$expire, $path]
+            );
+        } else {
+            // since we only keep one shared lock in the db we need to check if we have more then one shared lock locally manually
+            if (isset($this->acquiredLocks['shared'][$path]) && $this->acquiredLocks['shared'][$path] > 1) {
+                throw new LockedException($path);
+            }
+            $result = $this->connection->executeUpdate(
+                'UPDATE `*PREFIX*file_locks` SET `lock` = -1, `ttl` = ? WHERE `key` = ? AND `lock` = 1',
+                [$expire, $path]
+            );
+        }
+        if ($result !== 1) {
+            throw new LockedException($path);
+        }
+        $this->markChange($path, $targetType);
+    }
 
-	/**
-	 * cleanup empty locks
-	 */
-	public function cleanExpiredLocks() {
-		$expire = $this->timeFactory->getTime();
-		try {
-			$this->connection->executeUpdate(
-				'DELETE FROM `*PREFIX*file_locks` WHERE `ttl` < ?',
-				[$expire]
-			);
-		} catch (\Exception $e) {
-			// If the table is missing, the clean up was successful
-			if ($this->connection->tableExists('file_locks')) {
-				throw $e;
-			}
-		}
-	}
+    /**
+     * cleanup empty locks
+     */
+    public function cleanExpiredLocks() {
+        $expire = $this->timeFactory->getTime();
+        try {
+            $this->connection->executeUpdate(
+                'DELETE FROM `*PREFIX*file_locks` WHERE `ttl` < ?',
+                [$expire]
+            );
+        } catch (\Exception $e) {
+            // If the table is missing, the clean up was successful
+            if ($this->connection->tableExists('file_locks')) {
+                throw $e;
+            }
+        }
+    }
 
-	/**
-	 * release all lock acquired by this instance which were marked using the mark* methods
-	 *
-	 * @suppress SqlInjectionChecker
-	 */
-	public function releaseAll() {
-		parent::releaseAll();
+    /**
+     * release all lock acquired by this instance which were marked using the mark* methods
+     *
+     * @suppress SqlInjectionChecker
+     */
+    public function releaseAll() {
+        parent::releaseAll();
 
-		if (!$this->cacheSharedLocks) {
-			return;
-		}
-		// since we keep shared locks we need to manually clean those
-		$lockedPaths = array_keys($this->sharedLocks);
-		$lockedPaths = array_filter($lockedPaths, function ($path) {
-			return $this->sharedLocks[$path];
-		});
+        if (!$this->cacheSharedLocks) {
+            return;
+        }
+        // since we keep shared locks we need to manually clean those
+        $lockedPaths = array_keys($this->sharedLocks);
+        $lockedPaths = array_filter($lockedPaths, function ($path) {
+            return $this->sharedLocks[$path];
+        });
 
-		$chunkedPaths = array_chunk($lockedPaths, 100);
+        $chunkedPaths = array_chunk($lockedPaths, 100);
 
-		foreach ($chunkedPaths as $chunk) {
-			$builder = $this->connection->getQueryBuilder();
+        foreach ($chunkedPaths as $chunk) {
+            $builder = $this->connection->getQueryBuilder();
 
-			$query = $builder->update('file_locks')
-				->set('lock', $builder->createFunction('`lock` -1'))
-				->where($builder->expr()->in('key', $builder->createNamedParameter($chunk, IQueryBuilder::PARAM_STR_ARRAY)))
-				->andWhere($builder->expr()->gt('lock', new Literal(0)));
+            $query = $builder->update('file_locks')
+                ->set('lock', $builder->createFunction('`lock` -1'))
+                ->where($builder->expr()->in('key', $builder->createNamedParameter($chunk, IQueryBuilder::PARAM_STR_ARRAY)))
+                ->andWhere($builder->expr()->gt('lock', new Literal(0)));
 
-			$query->execute();
-		}
-	}
+            $query->execute();
+        }
+    }
 }