Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[stable31] fix(timeout): compare creation time to now - timeout #530

Merged
merged 3 commits into from
Feb 13, 2025
Merged

[stable31] fix(timeout): compare creation time to now - timeout #530

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f494170
fix(timeout): compare creation time to now - timeout
max-nextcloud Jan 20, 2025
0e6084a
test(timeout): locks are deprecated after expiry
max-nextcloud Feb 3, 2025
a8530ef
fix(psalm): drop TLogger completely
max-nextcloud Feb 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions lib/Controller/LockController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
use OCA\FilesLock\Model\FileLock;
use OCA\FilesLock\Service\FileService;
use OCA\FilesLock\Service\LockService;
use OCA\FilesLock\Tools\Traits\TLogger;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\OCSController;
Expand All @@ -26,19 +25,21 @@
use OCP\IL10N;
use OCP\IRequest;
use OCP\IUserSession;
use Psr\Log\LoggerInterface;

/**
* Class LockController
*
* @package OCA\FilesLock\Controller
*/
class LockController extends OCSController {
use TLogger;

private int $ocsVersion;
private LoggerInterface $logger;

public function __construct(
IRequest $request,
LoggerInterface $logger,
private IUserSession $userSession,
private FileService $fileService,
private LockService $lockService,
Expand All @@ -56,6 +57,7 @@ public function __construct(
$this->registerResponder('xml', function ($data) {
return $this->buildOCSResponse('xml', $data);
});
$this->logger = $logger;
}


Expand Down Expand Up @@ -171,7 +173,7 @@ protected function fail(
);

if ($log) {
$this->log(2, $status . ' - ' . json_encode($data));
$this->logger->warning('[warning] ' . $status . ' - ' . json_encode($data));
}

return new DataResponse($data, $status);
Expand Down
5 changes: 4 additions & 1 deletion lib/Db/LocksRequest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
use Exception;
use OCA\FilesLock\Exceptions\LockNotFoundException;
use OCA\FilesLock\Model\FileLock;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\DB\QueryBuilder\IQueryBuilder;

/**
Expand Down Expand Up @@ -124,8 +125,10 @@ public function getAll(): array {
* @throws Exception
*/
public function getLocksOlderThan(int $timeout): array {
$now = \OC::$server->get(ITimeFactory::class)->getTime();
$oldCreationTime = $now - $timeout * 60;
$qb = $this->getLocksSelectSql();
$qb->andWhere($qb->expr()->lt('l.creation', $qb->createNamedParameter($timeout * 60, IQueryBuilder::PARAM_INT)));
$qb->andWhere($qb->expr()->lt('l.creation', $qb->createNamedParameter($oldCreationTime, IQueryBuilder::PARAM_INT)));

return $this->getLocksFromRequest($qb);
}
Expand Down
22 changes: 11 additions & 11 deletions lib/Service/LockService.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
use OCA\FilesLock\Exceptions\LockNotFoundException;
use OCA\FilesLock\Exceptions\UnauthorizedUnlockException;
use OCA\FilesLock\Model\FileLock;
use OCA\FilesLock\Tools\Traits\TLogger;
use OCA\FilesLock\Tools\Traits\TStringTools;
use OCP\App\IAppManager;
use OCP\EventDispatcher\IEventDispatcher;
Expand All @@ -27,14 +26,13 @@
use OCP\IRequest;
use OCP\IUserManager;
use OCP\IUserSession;
use Psr\Log\LoggerInterface;

class LockService {
public const PREFIX = 'files_lock';


use TStringTools;
use TLogger;


private IUserManager $userManager;
private IL10N $l10n;
Expand All @@ -45,6 +43,7 @@ class LockService {
private IEventDispatcher $eventDispatcher;
private IUserSession $userSession;
private IRequest $request;
private LoggerInterface $logger;


private array $locks = [];
Expand All @@ -64,6 +63,7 @@ public function __construct(
IEventDispatcher $eventDispatcher,
IUserSession $userSession,
IRequest $request,
LoggerInterface $logger,
) {
$this->l10n = $l10n;
$this->userManager = $userManager;
Expand All @@ -74,8 +74,7 @@ public function __construct(
$this->eventDispatcher = $eventDispatcher;
$this->userSession = $userSession;
$this->request = $request;

$this->setup('app', 'files_lock');
$this->logger = $logger;
}

/**
Expand Down Expand Up @@ -153,7 +152,7 @@ public function lock(LockContext $lockScope): FileLock {
$known->setTimeout(
$known->getETA() !== FileLock::ETA_INFINITE ? $known->getTimeout() - $known->getETA() + $this->configService->getTimeoutSeconds() : 0
);
$this->notice('extending existing lock', false, ['fileLock' => $known]);
$this->logger->notice('extending existing lock', ['fileLock' => $known]);
$this->locksRequest->update($known);
$this->injectMetadata($known);
return $known;
Expand All @@ -165,7 +164,7 @@ public function lock(LockContext $lockScope): FileLock {
$lock = FileLock::fromLockScope($lockScope, $this->configService->getTimeoutSeconds());
$this->generateToken($lock);
$lock->setCreation(time());
$this->notice('locking file', false, ['fileLock' => $lock]);
$this->logger->notice('locking file', ['fileLock' => $lock]);
$this->injectMetadata($lock);
$this->locksRequest->save($lock);
$this->propagateEtag($lockScope);
Expand All @@ -189,7 +188,7 @@ public function getAppName(string $appId): ?string {
* @throws UnauthorizedUnlockException
*/
public function unlock(LockContext $lock, bool $force = false): FileLock {
$this->notice('unlocking file', false, ['fileLock' => $lock]);
$this->logger->notice('unlocking file', ['fileLock' => $lock]);

$known = $this->getLockFromFileId($lock->getNode()->getId());
if (!$force) {
Expand Down Expand Up @@ -280,15 +279,16 @@ public function unlockFile(int $fileId, string $userId, bool $force = false, int
public function getDeprecatedLocks(): array {
$timeout = (int)$this->configService->getAppValue(ConfigService::LOCK_TIMEOUT);
if ($timeout === 0) {
$this->notice(
'ConfigService::LOCK_TIMEOUT is not numerical, using default', true, ['current' => $timeout]
$this->logger->notice(
'ConfigService::LOCK_TIMEOUT is not numerical, using default', ['current' => $timeout, 'exception' => new \Exception()]
);
$timeout = (int)$this->configService->defaults[ConfigService::LOCK_TIMEOUT];
}

try {
$locks = $this->locksRequest->getLocksOlderThan($timeout);
} catch (Exception $e) {
$this->logger->warning('Failed to get locks older then timeout', ['exception' => $e]);
return [];
}

Expand Down Expand Up @@ -376,7 +376,7 @@ function (FileLock $lock) {
}, $locks
);

$this->notice('removing locks', false, ['ids' => $ids]);
$this->logger->notice('removing locks', ['ids' => $ids]);

$this->locksRequest->removeIds($ids);
}
Expand Down
181 changes: 0 additions & 181 deletions lib/Tools/Traits/TLogger.php
View file
Open in desktop

This file was deleted.

11 changes: 11 additions & 0 deletions tests/Feature/LockFeatureTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
use OCA\FilesLock\AppInfo\Application;
use OCA\FilesLock\Model\FileLock;
use OCA\FilesLock\Service\ConfigService;
use OCA\FilesLock\Service\LockService;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\Files\File;
use OCP\Files\IRootFolder;
Expand Down Expand Up @@ -204,6 +205,16 @@ public function testLockUserExpire() {
self::assertEquals('CCC', $file->getContent());
}

public function testExpiredLocksAreDeprecated() {
\OCP\Server::get(IConfig::class)->setAppValue(Application::APP_ID, ConfigService::LOCK_TIMEOUT, 30);
$file = $this->loginAndGetUserFolder(self::TEST_USER1)
->newFile('test-expired-lock-is-deprecated', 'AAA');
$this->lockManager->lock(new LockContext($file, ILock::TYPE_USER, self::TEST_USER1));
$this->toTheFuture(3600);
$deprecated = \OCP\Server::get(LockService::class)->getDeprecatedLocks();
self::assertNotEmpty($deprecated);
}

public function testLockUserInfinite() {
\OCP\Server::get(IConfig::class)->setAppValue(Application::APP_ID, ConfigService::LOCK_TIMEOUT, 0);
$file = $this->loginAndGetUserFolder(self::TEST_USER1)
Expand Down
Loading