Initial Upload

lib/Controller/Logging.php

@@ -0,0 +1,166 @@
+<?php
+/*
+ * Copyright (C) 2023 Xibo Signage Ltd
+ *
+ * Xibo - Digital Signage - https://xibosignage.com
+ *
+ * This file is part of Xibo.
+ *
+ * Xibo is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * any later version.
+ *
+ * Xibo is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with Xibo.  If not, see <http://www.gnu.org/licenses/>.
+ */
+namespace Xibo\Controller;
+
+use Carbon\Carbon;
+use Slim\Http\Response as Response;
+use Slim\Http\ServerRequest as Request;
+use Xibo\Factory\LogFactory;
+use Xibo\Factory\UserFactory;
+use Xibo\Helper\DateFormatHelper;
+use Xibo\Storage\StorageServiceInterface;
+use Xibo\Support\Exception\AccessDeniedException;
+
+/**
+ * Class Logging
+ * @package Xibo\Controller
+ */
+class Logging extends Base
+{
+    /**
+     * @var LogFactory
+     */
+    private $logFactory;
+
+    /** @var StorageServiceInterface  */
+    private $store;
+
+    /** @var  UserFactory */
+    private $userFactory;
+
+    /**
+     * Set common dependencies.
+     * @param StorageServiceInterface $store
+     * @param LogFactory $logFactory
+     * @param UserFactory $userFactory
+     */
+    public function __construct($store, $logFactory, $userFactory)
+    {
+        $this->store = $store;
+        $this->logFactory = $logFactory;
+        $this->userFactory = $userFactory;
+    }
+
+    /**
+     * @param Request $request
+     * @param Response $response
+     * @return \Psr\Http\Message\ResponseInterface|Response
+     * @throws \Xibo\Support\Exception\ControllerNotImplemented
+     * @throws \Xibo\Support\Exception\GeneralException
+     */
+    public function displayPage(Request $request, Response $response)
+    {
+        $this->getState()->template = 'log-page';
+
+        return $this->render($request, $response);
+    }
+
+    /**
+     * @param Request $request
+     * @param Response $response
+     * @return \Psr\Http\Message\ResponseInterface|Response
+     * @throws \Xibo\Support\Exception\ControllerNotImplemented
+     * @throws \Xibo\Support\Exception\GeneralException
+     */
+    function grid(Request $request, Response $response)
+    {
+        $parsedQueryParams = $this->getSanitizer($request->getQueryParams());
+
+        // Date time criteria
+        $seconds = $parsedQueryParams->getInt('seconds', ['default' => 120]);
+        $intervalType = $parsedQueryParams->getInt('intervalType', ['default' => 1]);
+        $fromDt = $parsedQueryParams->getDate('fromDt', ['default' => Carbon::now()]);
+
+        $logs = $this->logFactory->query($this->gridRenderSort($parsedQueryParams), $this->gridRenderFilter([
+            'fromDt' => $fromDt->clone()->subSeconds($seconds * $intervalType)->format('U'),
+            'toDt' => $fromDt->format('U'),
+            'type' => $parsedQueryParams->getString('level'),
+            'page' => $parsedQueryParams->getString('page'),
+            'channel' => $parsedQueryParams->getString('channel'),
+            'function' => $parsedQueryParams->getString('function'),
+            'displayId' => $parsedQueryParams->getInt('displayId'),
+            'userId' => $parsedQueryParams->getInt('userId'),
+            'excludeLog' => $parsedQueryParams->getCheckbox('excludeLog'),
+            'runNo' => $parsedQueryParams->getString('runNo'),
+            'message' => $parsedQueryParams->getString('message'),
+            'display' => $parsedQueryParams->getString('display'),
+            'useRegexForName' => $parsedQueryParams->getCheckbox('useRegexForName'),
+            'displayGroupId' => $parsedQueryParams->getInt('displayGroupId'),
+        ], $parsedQueryParams));
+
+        foreach ($logs as $log) {
+            // Normalise the date
+            $log->logDate = Carbon::createFromTimeString($log->logDate)->format(DateFormatHelper::getSystemFormat());
+        }
+
+        $this->getState()->template = 'grid';
+        $this->getState()->recordsTotal = $this->logFactory->countLast();
+        $this->getState()->setData($logs);
+
+        return $this->render($request, $response);
+    }
+
+    /**
+     * Truncate Log Form
+     * @param Request $request
+     * @param Response $response
+     * @return \Psr\Http\Message\ResponseInterface|Response
+     * @throws AccessDeniedException
+     * @throws \Xibo\Support\Exception\ControllerNotImplemented
+     * @throws \Xibo\Support\Exception\GeneralException
+     */
+    public function truncateForm(Request $request, Response $response)
+    {
+        if ($this->getUser()->userTypeId != 1) {
+            throw new AccessDeniedException(__('Only Administrator Users can truncate the log'));
+        }
+
+        $this->getState()->template = 'log-form-truncate';
+        $this->getState()->autoSubmit = $this->getAutoSubmit('truncateForm');
+        return $this->render($request, $response);
+    }
+
+    /**
+     * Truncate the Log
+     * @param Request $request
+     * @param Response $response
+     * @return \Psr\Http\Message\ResponseInterface|Response
+     * @throws AccessDeniedException
+     * @throws \Xibo\Support\Exception\ControllerNotImplemented
+     * @throws \Xibo\Support\Exception\GeneralException
+     */
+    public function truncate(Request $request, Response $response)
+    {
+        if ($this->getUser()->userTypeId != 1) {
+            throw new AccessDeniedException(__('Only Administrator Users can truncate the log'));
+        }
+
+        $this->store->update('TRUNCATE TABLE log', array());
+
+        // Return
+        $this->getState()->hydrate([
+            'message' => __('Log Truncated')
+        ]);
+
+        return $this->render($request, $response);
+    }
+}