mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

add proper paths to locking exceptions 

while some code paths do wrap the "raw" locking exception into one with a proper path, not all of them do
by adding the proper path to the original exception we ensure that we always have the usefull information in out logs

Signed-off-by: Robin Appelman <robin@icewind.nl>
This commit is contained in:
Robin Appelman 2020-06-30 18:10:42 +02:00
parent 26aa838906
commit da2d425044
No known key found for this signature in database
GPG Key ID: 42B69D8A64526EFB
6 changed files with 17 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
lib/private/Files/Storage/Common.php
View File

@ -747,7 +747,7 @@ abstract class Common implements Storage, ILockingStorage, IWriteStreamStorage {
);
}
try {
$provider->acquireLock('files/' . md5($this->getId() . '::' . trim($path, '/')), $type);
$provider->acquireLock('files/' . md5($this->getId() . '::' . trim($path, '/')), $type, $this->getId() . '::' . $path);
} catch (LockedException $e) {
if ($logger) {
$logger->logException($e, ['level' => ILogger::INFO]);

4
lib/private/Lock/DBLockingProvider.php
View File

@ -180,7 +180,7 @@ class DBLockingProvider extends AbstractLockingProvider {
* @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
* @throws \OCP\Lock\LockedException
*/
public function acquireLock(string $path, int $type) {
public function acquireLock(string $path, int $type, string $readablePath = null) {
$expire = $this->getExpireTime();
if ($type === self::LOCK_SHARED) {
if (!$this->isLocallyLocked($path)) {
@ -208,7 +208,7 @@ class DBLockingProvider extends AbstractLockingProvider {
}
}
if ($result !== 1) {
throw new LockedException($path);
throw new LockedException($path, null, null, $readablePath);
}
$this->markAcquire($path, $type);
}

7
lib/private/Lock/MemcacheLockingProvider.php
View File

@ -71,17 +71,18 @@ class MemcacheLockingProvider extends AbstractLockingProvider {
/**
* @param string $path
* @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
* @param string $readablePath human readable path to use in error messages
* @throws \OCP\Lock\LockedException
*/
public function acquireLock(string $path, int $type) {
public function acquireLock(string $path, int $type, string $readablePath = null) {
if ($type === self::LOCK_SHARED) {
if (!$this->memcache->inc($path)) {
throw new LockedException($path, null, $this->getExistingLockForException($path));
throw new LockedException($path, null, $this->getExistingLockForException($path), $readablePath);
}
} else {
$this->memcache->add($path, 0);
if (!$this->memcache->cas($path, 0, 'exclusive')) {
throw new LockedException($path, null, $this->getExistingLockForException($path));
throw new LockedException($path, null, $this->getExistingLockForException($path), $readablePath);
}
}
$this->setTTL($path);

2
lib/private/Lock/NoopLockingProvider.php
View File

@ -46,7 +46,7 @@ class NoopLockingProvider implements ILockingProvider {
/**
* {@inheritdoc}
*/
public function acquireLock(string $path, int $type) {
public function acquireLock(string $path, int $type, string $readablePath = null) {
// do nothing
}

3
lib/public/Lock/ILockingProvider.php
View File

@ -55,10 +55,11 @@ interface ILockingProvider {
/**
* @param string $path
* @param int $type self::LOCK_SHARED or self::LOCK_EXCLUSIVE
* @param string $readablePath human readable path to use in error messages, since 20.0.0
* @throws \OCP\Lock\LockedException
* @since 8.1.0
*/
public function acquireLock(string $path, int $type);
public function acquireLock(string $path, int $type, string $readablePath = null);
/**
* @param string $path

9
lib/public/Lock/LockedException.php
View File

@ -53,10 +53,15 @@ class LockedException extends \Exception {
* @param string $path locked path
* @param \Exception|null $previous previous exception for cascading
* @param string $existingLock since 14.0.0
* @param string $readablePath since 20.0.0
* @since 8.1.0
*/
public function __construct(string $path, \Exception $previous = null, string $existingLock = null) {
$message = '"' . $path . '" is locked';
public function __construct(string $path, \Exception $previous = null, string $existingLock = null, string $readablePath = null) {
if ($readablePath) {
$message = "\"$path\"(\"$readablePath\") is locked";
} else {
$message = '"' . $path . '" is locked';
}
$this->existingLock = $existingLock;
if ($existingLock) {
$message .= ', existing lock on file: ' . $existingLock;