class.ilAssQuestionProcessLockerFile.php

Go to the documentation of this file.

<?php
 
use ILIAS\Test\Logging\TestLogger;
 
class ilAssQuestionProcessLockerFile extends ilAssQuestionProcessLocker
{
    public const PROCESS_NAME_QUESTION_WORKING_STATE_UPDATE = 'questionWorkingStateUpdate';
 
    protected $lockFileHandles = [];
 
    public function __construct(
        private ilAssQuestionProcessLockFileStorage $lockFileStorage,
        private ilLogger|TestLogger $logger
    ) {
    }
 
    protected function onBeforeExecutingPersistWorkingStateOperation(): void
    {
        $this->requestLock(self::PROCESS_NAME_QUESTION_WORKING_STATE_UPDATE);
    }
 
    protected function onAfterExecutingPersistWorkingStateOperation(): void
    {
        $this->releaseLock(self::PROCESS_NAME_QUESTION_WORKING_STATE_UPDATE);
    }
 
    protected function onBeforeExecutingUserSolutionAdoptOperation(): void
    {
        $this->requestLock(self::PROCESS_NAME_QUESTION_WORKING_STATE_UPDATE);
    }
 
    protected function onAfterExecutingUserSolutionAdoptOperation(): void
    {
        $this->releaseLock(self::PROCESS_NAME_QUESTION_WORKING_STATE_UPDATE);
    }
 
    private function requestLock($processName): void
    {
        $lockFilePath = $this->getLockFilePath($processName);
        $this->lockFileHandles[$processName] = fopen($lockFilePath, 'w');
        if (!flock($this->lockFileHandles[$processName], LOCK_EX)) {
            $this->logger->error("Flock failed for {$lockFilePath}.");
        }
    }
 
    private function getLockFilePath($processName): string
    {
        $path = $this->lockFileStorage->getAbsolutePath();
        return $path . '/' . $processName . '.lock';
    }
 
    private function releaseLock($processName): void
    {
        flock($this->lockFileHandles[$processName], LOCK_UN);
        fclose($this->lockFileHandles[$processName]);
    }
}