refactor: migrated single session page to controller (#3257)

thorsten · Nov 29, 2024 · ece9e7f · ece9e7f
1 parent 01add1d
commit ece9e7f
Show file tree

Hide file tree

Showing 17 changed files with 129 additions and 124 deletions.
diff --git a/phpmyfaq/admin/assets/src/index.js b/phpmyfaq/admin/assets/src/index.js
@@ -21,6 +21,7 @@ import {
   handleDeleteAdminLog,
   handleDeleteSessions,
   handleSessions,
+  handleSessionsFilter,
   handleStatistics,
 } from './statistics';
 import {
@@ -135,6 +136,7 @@ document.addEventListener('DOMContentLoaded', async () => {
   handleClearRatings();
   handleClearVisits();
   handleDeleteSessions();
+  handleSessionsFilter();
 
   // Configuration → FAQ configuration
   await handleConfiguration();

diff --git a/phpmyfaq/admin/assets/src/statistics/sessions.js b/phpmyfaq/admin/assets/src/statistics/sessions.js
@@ -16,6 +16,21 @@
 import { pushErrorNotification, pushNotification } from '../utils';
 import { clearVisits, deleteSessions } from '../api/index.js';
 
+export const handleSessionsFilter = () => {
+  const button = document.getElementById('pmf-admin-session-day');
+
+  if (button) {
+    button.addEventListener('click', async (event) => {
+      event.preventDefault();
+      const form = document.getElementById('pmf-admin-form-session');
+      const timestamp = document.getElementById('day').value;
+      const day = new Date(timestamp * 1000).toISOString().split('T')[0];
+      form.action = `./statistics/sessions/${day}`;
+      form.submit();
+    });
+  }
+};
+
 export const handleSessions = () => {
   const firstHour = document.getElementById('firstHour');
   const lastHour = document.getElementById('lastHour');

diff --git a/phpmyfaq/admin/index.php b/phpmyfaq/admin/index.php
@@ -315,9 +315,6 @@
                 require 'glossary.php';
                 break;
             // functions for session administration
-            case 'viewsession':
-                require 'statistics.show.php';
-                break;
             case 'truncatesearchterms':
             case 'searchstats':
                 require 'statistics.search.php';

diff --git a/phpmyfaq/admin/statistics.show.php b/phpmyfaq/admin/statistics.show.php
diff --git a/phpmyfaq/assets/templates/admin/statistics/sessions.day.twig b/phpmyfaq/assets/templates/admin/statistics/sessions.day.twig
@@ -23,10 +23,15 @@
           <tr>
             <td>{{ data.ip }}</td>
             <td>{{ data.time | date }}</td>
-            <td><a href="?action=viewsession&id={{ sid }}">{{ sid }}</a></td>
+            <td><a href="./statistics/session/{{ sid }}">{{ sid }}</a></td>
           </tr>
         {% endfor %}
         </tbody>
+        <tfoot>
+          <tr>
+            <td colspan="3"><a href="./statistics/sessions">{{ 'ad_sess_back' | translate }}</a></td>
+          </tr>
+        </tfoot>
       </table>
     </div>
   </div>

diff --git a/phpmyfaq/assets/templates/admin/statistics/sessions.session.twig b/phpmyfaq/assets/templates/admin/statistics/sessions.session.twig
@@ -0,0 +1,47 @@
+{% extends '@admin/index.twig' %}
+
+{% block content %}
+  <div class="d-flex justify-content-between flex-wrap flex-md-nowrap align-items-center pt-3 pb-2 mb-3 border-bottom">
+    <h1 class="h2">
+      <i aria-hidden="true" class="bi bi-clock-history"></i>
+      {{ ad_sess_session }} #{{ sessionId }}
+    </h1>
+  </div>
+  <table class="table table-striped align-middle border shadow">
+    <tbody>
+    {% set num = 0 %}
+    {% for line in trackingData %}
+      {% set data = line|split(';') %}
+      {% if data.0 == sessionId %}
+        {% set num = num + 1 %}
+        <tr>
+          <td>{{ data.7|date('Y-m-d H:i:s') }}</td>
+          <td>{{ data.1 }} ({{ data.2 }})</td>
+        </tr>
+        {% if num == 1 %}
+          <tr>
+            <td>{{ ad_sess_referer }}:</td>
+            <td>
+              {% set temp = data.5|replace({'?': '? '}) %}
+              {{ temp|escape }}
+            </td>
+          </tr>
+          <tr>
+            <td>{{ ad_sess_browser }}:</td>
+            <td>{{ data.6|escape }}</td>
+          </tr>
+          <tr>
+            <td>{{ ad_sess_ip }}:</td>
+            <td>{{ data.3|escape }}</td>
+          </tr>
+        {% endif %}
+      {% endif %}
+    {% endfor %}
+    </tbody>
+    <tfoot>
+      <tr>
+        <td colspan="2"><a href="./statistics/sessions/{{ thisDay }}">{{ ad_sess_back }}</a></td>
+      </tr>
+    </tfoot>
+  </table>
+{% endblock %}
diff --git a/phpmyfaq/assets/templates/admin/statistics/sessions.twig b/phpmyfaq/assets/templates/admin/statistics/sessions.twig
@@ -47,8 +47,8 @@
             <tr>
               <th>{{ msgSessionBrowse }}</th>
               <td class="col-lg-10">
-                <form action="./statistics/session" method="post" accept-charset="utf-8"
-                      class="row row-cols-lg-auto g-3 align-items-center">
+                <form class="row row-cols-lg-auto g-3 align-items-center" method="post" id="pmf-admin-form-session"
+                      action="">
                   <div class="mr-2">
                     <label for="day" class="d-none">
                       {{ msgSessionBrowse }}
@@ -57,7 +57,7 @@
                       {{ renderedDaySelector | raw }}
                     </select>
                   </div>
-                  <button class="btn btn-primary" type="submit" name="statbrowse">
+                  <button class="btn btn-primary" type="button" id="pmf-admin-session-day">
                     {{ buttonOkay }}
                   </button>
                 </form>

diff --git a/phpmyfaq/assets/templates/admin/statistics/statistics.show.twig b/phpmyfaq/assets/templates/admin/statistics/statistics.show.twig
diff --git a/phpmyfaq/src/admin-routes.php b/phpmyfaq/src/admin-routes.php
@@ -163,10 +163,15 @@
         'controller' => [StatisticsSessionsController::class, 'index'],
         'methods' => 'GET'
     ],
-    'admin.statistics.session' => [
-        'path' => '/statistics/session',
-        'controller' => [StatisticsSessionsController::class, 'session'],
-        'methods' => 'POST'
+    'admin.statistics.sessions.day' => [
+        'path' => '/statistics/sessions/{date}',
+        'controller' => [StatisticsSessionsController::class, 'viewDay'],
+        'methods' => 'POST, GET'
+    ],
+    'admin.statistics.session.id' => [
+        'path' => '/statistics/session/{sessionId}',
+        'controller' => [StatisticsSessionsController::class, 'viewSession'],
+        'methods' => 'GET'
     ],
     'admin.stopwords' => [
         'path' => '/stopwords',

diff --git a/phpmyfaq/src/phpMyFAQ/Administration/Session.php b/phpmyfaq/src/phpMyFAQ/Administration/Session.php
@@ -126,13 +126,12 @@ public function deleteAllSessions(): bool
      *
      * @return array<int, stdClass>
      */
-    public function getLast30DaysVisits(): array
+    public function getLast30DaysVisits(int $endDate): array
     {
         $stats = [];
         $visits = [];
         $completeData = [];
         $startDate = strtotime('-1 month');
-        $endDate = Request::createFromGlobals()->server->get('REQUEST_TIME');
 
         $query = sprintf(
             'SELECT time FROM %sfaqsessions WHERE time > %d AND time < %d;',

diff --git a/phpmyfaq/src/phpMyFAQ/Application.php b/phpmyfaq/src/phpMyFAQ/Application.php
@@ -21,6 +21,7 @@
 use phpMyFAQ\Core\Exception;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpFoundation\Exception\BadRequestException;
+use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver;
@@ -112,7 +113,7 @@ private function handleRequest(RouteCollection $routeCollection): void
                 Response::HTTP_NOT_FOUND
             );
         } catch (UnauthorizedHttpException) {
-            $response = new Response('Unauthorized', Response::HTTP_UNAUTHORIZED);
+            $response = new RedirectResponse('/login');
         } catch (BadRequestException $exception) {
             $response = new Response(
                 sprintf(

diff --git a/phpmyfaq/src/phpMyFAQ/Controller/Administration/Api/DashboardController.php b/phpmyfaq/src/phpMyFAQ/Controller/Administration/Api/DashboardController.php
@@ -78,13 +78,14 @@ public function versions(): JsonResponse
      * @throws \Exception
      */
     #[Route('admin/api/dashboard/visits')]
-    public function visits(): JsonResponse
+    public function visits(Request $request): JsonResponse
     {
         $this->userIsAuthenticated();
 
         if ($this->configuration->get('main.enableUserTracking')) {
             $session = $this->container->get('phpmyfaq.admin.session');
-            return $this->json($session->getLast30DaysVisits());
+            $endDate = $request->server->get('REQUEST_TIME');
+            return $this->json($session->getLast30DaysVisits($endDate));
         }
 
         return $this->json(['error' => 'User tracking is disabled.'], 400);

diff --git a/phpmyfaq/src/phpMyFAQ/Controller/Administration/StatisticsSessionsController.php b/phpmyfaq/src/phpMyFAQ/Controller/Administration/StatisticsSessionsController.php
@@ -74,12 +74,13 @@ public function index(Request $request): Response
      * @throws LoaderError
      * @throws \Exception
      */
-    #[Route('/statistics/session', name: 'admin.statistics.session', methods: ['GET'])]
-    public function session(Request $request): Response
+    #[Route('/statistics/sessions/:day', name: 'admin.statistics.session', methods: ['GET'])]
+    public function viewDay(Request $request): Response
     {
         $this->userHasPermission(PermissionType::STATISTICS_VIEWLOGS);
 
         $day = Filter::filterVar($request->get('day'), FILTER_VALIDATE_INT);
+
         $firstHour = strtotime('midnight', $day);
         $lastHour = strtotime('tomorrow', $firstHour) - 1;
 
@@ -100,4 +101,37 @@ public function session(Request $request): Response
             ]
         );
     }
+
+    /**
+     * @throws Exception
+     * @throws LoaderError
+     * @throws \Exception
+     */
+    #[Route('/statistics/session/:sessionId', name: 'admin.statistics.session', methods: ['POST'])]
+    public function viewSession(Request $request): Response
+    {
+        $this->userHasPermission(PermissionType::STATISTICS_VIEWLOGS);
+
+        $sessionId = Filter::filterVar($request->get('sessionId'), FILTER_VALIDATE_INT);
+
+        $session = $this->container->get('phpmyfaq.admin.session');
+        $time = $session->getTimeFromSessionId($sessionId);
+        $trackingData = explode("\n", file_get_contents(PMF_CONTENT_DIR . '/core/data/tracking' . date('dmY', $time)));
+
+        return $this->render(
+            '@admin/statistics/sessions.session.twig',
+            [
+                ... $this->getHeader($request),
+                ... $this->getFooter(),
+                'ad_sess_session' => Translation::get('ad_sess_session'),
+                'sessionId' => $sessionId,
+                'ad_sess_back' => Translation::get('ad_sess_back'),
+                'ad_sess_referer' => Translation::get('ad_sess_referer'),
+                'ad_sess_browser' => Translation::get('ad_sess_browser'),
+                'ad_sess_ip' => Translation::get('ad_sess_ip'),
+                'trackingData' => $trackingData,
+                'thisDay' => date('Y-m-d', $time),
+            ]
+        );
+    }
 }
diff --git a/phpmyfaq/src/phpMyFAQ/Date.php b/phpmyfaq/src/phpMyFAQ/Date.php
@@ -74,10 +74,10 @@ public function getTrackingFileDate(string $file, bool $endOfDay = false): int
             $year = Strings::substr($file, 12, 4);
 
             if (!$endOfDay) {
-                return mktime(0, 0, 0, (int)$month, (int)$day, (int)$year);
+                return gmmktime(0, 0, 0, (int)$month, (int)$day, (int)$year);
             }
 
-            return mktime(23, 59, 59, (int) $month, (int) $day, (int) $year);
+            return gmmktime(23, 59, 59, (int) $month, (int) $day, (int) $year);
         }
 
         return -1;

diff --git a/phpmyfaq/src/phpMyFAQ/Helper/StatisticsHelper.php b/phpmyfaq/src/phpMyFAQ/Helper/StatisticsHelper.php
@@ -124,8 +124,6 @@ public function getAllTrackingDates(): array
 
     public function deleteTrackingFiles(string $month): bool
     {
-        return false;
-        /*
         $dir = opendir(PMF_ROOT_DIR . '/content/core/data');
         $first = PHP_INT_MAX;
         $last = 0;
@@ -150,7 +148,6 @@ public function deleteTrackingFiles(string $month): bool
         closedir($dir);
 
         return $this->session->deleteSessions($first, $last);
-        */
     }
 
     public function clearAllVisits(): bool

diff --git a/tests/phpMyFAQ/Administration/SessionTest.php b/tests/phpMyFAQ/Administration/SessionTest.php
@@ -132,7 +132,7 @@ public function testGetLast30DaysVisits()
         $this->databaseMock->method('query')->willReturn(true);
         $this->databaseMock->method('fetchObject')->willReturnOnConsecutiveCalls($resultMock, false);
 
-        $actualVisits = $this->session->getLast30DaysVisits();
+        $actualVisits = $this->session->getLast30DaysVisits($endDate);
 
         $expectedVisits = [];
         for ($date = $startDate; $date <= $endDate; $date += 86400) {