Internal: Add course access tracking- BT#21694

Author: christianbeeznest

src/CoreBundle/EventListener/CidReqListener.php

@@ -9,6 +9,7 @@
 use Chamilo\CoreBundle\Controller\EditorController;
 use Chamilo\CoreBundle\Entity\Course;
 use Chamilo\CoreBundle\Entity\Session;
+use Chamilo\CoreBundle\Entity\TrackECourseAccess;
 use Chamilo\CoreBundle\Entity\User;
 use Chamilo\CoreBundle\Exception\NotAllowedException;
 use Chamilo\CoreBundle\Security\Authorization\Voter\CourseVoter;
@@ -17,6 +18,7 @@
 use Chamilo\CourseBundle\Controller\CourseControllerInterface;
 use Chamilo\CourseBundle\Entity\CGroup;
 use ChamiloSession;
+use DateTime;
 use Doctrine\ORM\EntityManagerInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Event\ControllerEvent;
@@ -268,6 +270,13 @@ public function cleanSessionHandler(Request $request): void
             ChamiloSession::erase('course_already_visited');
         }
 
+        $user = $this->tokenStorage->getToken()->getUser();
+        $courseId = $sessionHandler->get('cid', 0);
+        $sessionId = $sessionHandler->get('sid', 0);
+        $ip = $request->getClientIp();
+        if ($courseId !== 0) {
+            $this->logoutAccess($user, $courseId, $sessionId, $ip);
+        }
         $sessionHandler->remove('toolgroup');
         $sessionHandler->remove('_cid');
         $sessionHandler->remove('cid');
@@ -326,4 +335,45 @@ private function generateCourseUrl(?Course $course, int $sessionId, int $groupId
 
         return '';
     }
+
+    private function logoutAccess(User $user, int $courseId, int $sessionId, string $ip): void
+    {
+        $now = new DateTime("now", new \DateTimeZone("UTC"));
+        $sessionLifetime = 3600;
+        $limitTime = (new DateTime())->setTimestamp(time() - $sessionLifetime);
+
+        $access = $this->entityManager->getRepository(TrackECourseAccess::class)
+            ->createQueryBuilder('a')
+            ->where('a.user = :user AND a.cId = :courseId AND a.sessionId = :sessionId')
+            ->andWhere('a.loginCourseDate > :limitTime')
+            ->setParameters([
+                'user' => $user,
+                'courseId' => $courseId,
+                'sessionId' => $sessionId,
+                'limitTime' => $limitTime,
+            ])
+            ->orderBy('a.loginCourseDate', 'DESC')
+            ->setMaxResults(1)
+            ->getQuery()
+            ->getOneOrNullResult();
+
+        if ($access) {
+            $access->setLogoutCourseDate($now);
+            $access->setCounter($access->getCounter() + 1);
+            $this->entityManager->flush();
+        } else {
+            // No access found or existing access is outside the session lifetime
+            // Insert new access record
+            $newAccess = new TrackECourseAccess();
+            $newAccess->setUser($user);
+            $newAccess->setCId($courseId);
+            $newAccess->setSessionId($sessionId);
+            $newAccess->setUserIp($ip);
+            $newAccess->setLoginCourseDate($now);
+            $newAccess->setLogoutCourseDate($now);
+            $newAccess->setCounter(1);
+            $this->entityManager->persist($newAccess);
+            $this->entityManager->flush();
+        }
+    }
 }

src/CoreBundle/EventListener/CourseAccessListener.php

@@ -7,41 +7,80 @@
 namespace Chamilo\CoreBundle\EventListener;
 
 use Chamilo\CoreBundle\Entity\TrackECourseAccess;
-use Chamilo\CourseBundle\Event\CourseAccess;
-use Doctrine\ORM\EntityManager;
-use Symfony\Component\HttpFoundation\Request;
+use Chamilo\CoreBundle\Entity\User;
+use Chamilo\CoreBundle\ServiceHelper\CidReqHelper;
+use DateTime;
+use Symfony\Component\HttpKernel\Event\RequestEvent;
+use Doctrine\ORM\EntityManagerInterface;
 use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
 
 /**
  * In and outs of a course
  * This listener is always called when user enters the course home.
  */
 class CourseAccessListener
 {
-    protected ?Request $request = null;
-
     public function __construct(
-        private readonly EntityManager $em,
-        RequestStack $requestStack
-    ) {
-        $this->request = $requestStack->getCurrentRequest();
+        private readonly EntityManagerInterface $em,
+        private readonly RequestStack $requestStack,
+        private readonly CidReqHelper $cidReqHelper,
+        private readonly TokenStorageInterface $tokenStorage,
+    ) {}
+
+    public function onKernelRequest(RequestEvent $event): void
+    {
+        if (!$event->isMainRequest() || $event->getRequest()->attributes->get('access_checked')) {
+            // If it's not the main request or we've already handled access in this request, do nothing
+            return;
+        }
+
+        $courseId = (int) $this->cidReqHelper->getCourseId();
+        $sessionId = (int) $this->cidReqHelper->getSessionId();
+
+        if ($courseId > 0) {
+            $user = $this->tokenStorage->getToken()?->getUser();
+            if ($user instanceof User) {
+                $ip = $this->requestStack->getCurrentRequest()->getClientIp();
+                $access = $this->findExistingAccess($user, $courseId, $sessionId);
+
+                if ($access) {
+                    $this->updateAccess($access);
+                } else {
+                    $this->recordAccess($user, $courseId, $sessionId, $ip);
+                }
+
+                // Set a flag on the request to indicate that access has been checked
+                $event->getRequest()->attributes->set('access_checked', true);
+            }
+        }
     }
 
-    public function __invoke(CourseAccess $event): void
+    private function findExistingAccess(User $user, int $courseId, int $sessionId)
     {
-        // CourseAccess
-        $user = $event->getUser();
-        $course = $event->getCourse();
-        $ip = $this->request->getClientIp();
+        return $this->em->getRepository(TrackECourseAccess::class)
+            ->findOneBy(['user' => $user, 'cId' => $courseId, 'sessionId' => $sessionId]);
+    }
 
-        $access = new TrackECourseAccess();
-        $access
-            ->setCId($course->getId())
-            ->setUser($user)
-            ->setSessionId(0)
-            ->setUserIp($ip)
-        ;
+    private function updateAccess(TrackECourseAccess $access): void
+    {
+        $now = new DateTime();
+        if (!$access->getLogoutCourseDate() || $now->getTimestamp() - $access->getLogoutCourseDate()->getTimestamp() > 300) {
+            $access->setLogoutCourseDate($now);
+            $access->setCounter($access->getCounter() + 1);
+            $this->em->flush();
+        }
+    }
 
+    private function recordAccess(User $user, int $courseId, int $sessionId, string $ip): void
+    {
+        $access = new TrackECourseAccess();
+        $access->setUser($user);
+        $access->setCId($courseId);
+        $access->setSessionId($sessionId);
+        $access->setUserIp($ip);
+        $access->setLoginCourseDate(new \DateTime());
+        $access->setCounter(1);
         $this->em->persist($access);
         $this->em->flush();
     }

src/CoreBundle/Resources/config/listeners.yml

@@ -17,12 +17,11 @@ services:
 
     # Sets the user access in a course listener
     Chamilo\CoreBundle\EventListener\CourseAccessListener:
-        arguments:
-            - '@doctrine.orm.entity_manager'
-        tags:
-            - {name: kernel.event_listener, event: chamilo_course.course.access}
+      tags:
+        - { name: kernel.event_listener, event: kernel.request, method: onKernelRequest, priority: 6 }
+
 
-    # Sets the user access in a course session listener
+  # Sets the user access in a course session listener
     Chamilo\CoreBundle\EventListener\SessionAccessListener:
         tags:
             - {name: kernel.event_listener, event: chamilo_course.course.session}