Initial Upload
This commit is contained in:
Matt Batchelder
512
lib/Controller/Base.php
Normal file
512
lib/Controller/Base.php
Normal file
@@ -0,0 +1,512 @@
|
||||
<?php
|
||||
/*
|
||||
* Copyright (C) 2025 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 Slim\Routing\RouteContext;
|
||||
use Slim\Views\Twig;
|
||||
use Symfony\Component\EventDispatcher\EventDispatcher;
|
||||
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
|
||||
use Twig\Error\LoaderError;
|
||||
use Twig\Error\RuntimeError;
|
||||
use Twig\Error\SyntaxError;
|
||||
use Xibo\Entity\User;
|
||||
use Xibo\Helper\ApplicationState;
|
||||
use Xibo\Helper\HttpsDetect;
|
||||
use Xibo\Helper\SanitizerService;
|
||||
use Xibo\Service\BaseDependenciesService;
|
||||
use Xibo\Service\ConfigServiceInterface;
|
||||
use Xibo\Service\HelpServiceInterface;
|
||||
use Xibo\Service\LogServiceInterface;
|
||||
use Xibo\Support\Exception\ControllerNotImplemented;
|
||||
use Xibo\Support\Exception\GeneralException;
|
||||
use Xibo\Support\Exception\InvalidArgumentException;
|
||||
|
||||
/**
|
||||
* Class Base
|
||||
* @package Xibo\Controller
|
||||
*
|
||||
* Base for all Controllers.
|
||||
*
|
||||
*/
|
||||
class Base
|
||||
{
|
||||
use DataTablesDotNetTrait;
|
||||
|
||||
/**
|
||||
* @var LogServiceInterface
|
||||
*/
|
||||
private $log;
|
||||
|
||||
/**
|
||||
* @Inject
|
||||
* @var SanitizerService
|
||||
*/
|
||||
private $sanitizerService;
|
||||
|
||||
/**
|
||||
* @var ApplicationState
|
||||
*/
|
||||
private $state;
|
||||
|
||||
/**
|
||||
* @var HelpServiceInterface
|
||||
*/
|
||||
private $helpService;
|
||||
|
||||
/**
|
||||
* @var ConfigServiceInterface
|
||||
*/
|
||||
private $configService;
|
||||
|
||||
/**
|
||||
* @var User
|
||||
*/
|
||||
private $user;
|
||||
|
||||
/**
|
||||
* Automatically output a full page if non-ajax request arrives
|
||||
* @var bool
|
||||
*/
|
||||
private $fullPage = true;
|
||||
|
||||
/**
|
||||
* Have we already rendered this controller.
|
||||
* @var bool
|
||||
*/
|
||||
private $rendered = false;
|
||||
|
||||
/**
|
||||
* Is this controller expected to output anything?
|
||||
* @var bool
|
||||
*/
|
||||
private $noOutput = false;
|
||||
|
||||
/**
|
||||
* @var Twig
|
||||
*/
|
||||
private $view;
|
||||
|
||||
/** @var EventDispatcher */
|
||||
private $dispatcher;
|
||||
|
||||
/** @var BaseDependenciesService */
|
||||
private $baseDependenciesService;
|
||||
|
||||
public function useBaseDependenciesService(BaseDependenciesService $baseDependenciesService)
|
||||
{
|
||||
$this->baseDependenciesService = $baseDependenciesService;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get User
|
||||
* @return User
|
||||
*/
|
||||
public function getUser()
|
||||
{
|
||||
return $this->baseDependenciesService->getUser();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the Application State
|
||||
* @return ApplicationState
|
||||
*/
|
||||
public function getState()
|
||||
{
|
||||
return $this->baseDependenciesService->getState();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Log
|
||||
* @return LogServiceInterface
|
||||
*/
|
||||
public function getLog()
|
||||
{
|
||||
return $this->baseDependenciesService->getLogger();
|
||||
}
|
||||
|
||||
/**
|
||||
* @param $array
|
||||
* @return \Xibo\Support\Sanitizer\SanitizerInterface
|
||||
*/
|
||||
protected function getSanitizer($array)
|
||||
{
|
||||
$sanitizerService = $this->getSanitizerService();
|
||||
return $sanitizerService->getSanitizer($array);
|
||||
}
|
||||
|
||||
public function getSanitizerService(): SanitizerService
|
||||
{
|
||||
return $this->baseDependenciesService->getSanitizer();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Config
|
||||
* @return ConfigServiceInterface
|
||||
*/
|
||||
public function getConfig()
|
||||
{
|
||||
return $this->baseDependenciesService->getConfig();
|
||||
}
|
||||
|
||||
/**
|
||||
* @return \Slim\Views\Twig
|
||||
*/
|
||||
public function getView()
|
||||
{
|
||||
return $this->baseDependenciesService->getView();
|
||||
}
|
||||
|
||||
/**
|
||||
* @return EventDispatcherInterface
|
||||
*/
|
||||
public function getDispatcher(): EventDispatcherInterface
|
||||
{
|
||||
return $this->baseDependenciesService->getDispatcher();
|
||||
}
|
||||
|
||||
/**
|
||||
* Is this the Api?
|
||||
* @param Request $request
|
||||
* @return bool
|
||||
*/
|
||||
protected function isApi(Request $request)
|
||||
{
|
||||
return ($request->getAttribute('_entryPoint') != 'web');
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Url For Route
|
||||
* @param Request $request
|
||||
* @param string $route
|
||||
* @param array $data
|
||||
* @param array $params
|
||||
* @return string
|
||||
*/
|
||||
protected function urlFor(Request $request, $route, $data = [], $params = [])
|
||||
{
|
||||
$routeParser = RouteContext::fromRequest($request)->getRouteParser();
|
||||
return $routeParser->urlFor($route, $data, $params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set to not output a full page automatically
|
||||
*/
|
||||
public function setNotAutomaticFullPage()
|
||||
{
|
||||
$this->fullPage = false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set No output
|
||||
* @param bool $bool
|
||||
*/
|
||||
public function setNoOutput($bool = true)
|
||||
{
|
||||
$this->noOutput = $bool;
|
||||
}
|
||||
|
||||
/**
|
||||
* End the controller execution, calling render
|
||||
* @param Request $request
|
||||
* @param Response $response
|
||||
* @return \Psr\Http\Message\ResponseInterface|Response
|
||||
* @throws ControllerNotImplemented if the controller is not implemented correctly
|
||||
* @throws GeneralException
|
||||
*/
|
||||
public function render(Request $request, Response $response)
|
||||
{
|
||||
if ($this->noOutput) {
|
||||
return $response;
|
||||
}
|
||||
|
||||
// State will contain the current ApplicationState, including a success flag that can be used to determine
|
||||
// if we are in error or not.
|
||||
$state = $this->getState();
|
||||
$data = $state->getData();
|
||||
|
||||
// Grid requests require some extra info appended.
|
||||
// they can come from any application, hence being dealt with first
|
||||
$grid = ($state->template === 'grid');
|
||||
|
||||
if ($grid) {
|
||||
$params = $this->getSanitizer($request->getParams());
|
||||
$recordsTotal = ($state->recordsTotal == null) ? count($data) : $state->recordsTotal;
|
||||
$recordsFiltered = ($state->recordsFiltered == null) ? $recordsTotal : $state->recordsFiltered;
|
||||
|
||||
$data = [
|
||||
'draw' => $params->getInt('draw'),
|
||||
'recordsTotal' => $recordsTotal,
|
||||
'recordsFiltered' => $recordsFiltered,
|
||||
'data' => $data
|
||||
];
|
||||
}
|
||||
|
||||
// API Request
|
||||
if ($this->isApi($request)) {
|
||||
// Envelope by default - the APIView will un-pack if necessary
|
||||
$this->getState()->setData([
|
||||
'grid' => $grid,
|
||||
'success' => $state->success,
|
||||
'status' => $state->httpStatus,
|
||||
'message' => $state->message,
|
||||
'id' => $state->id,
|
||||
'data' => $data
|
||||
]);
|
||||
|
||||
return $this->renderApiResponse($request, $response->withStatus($state->httpStatus));
|
||||
} else if ($request->isXhr()) {
|
||||
// WEB Ajax
|
||||
// --------
|
||||
// Are we a template that should be rendered to HTML
|
||||
// and then returned?
|
||||
if ($state->template != '' && $state->template != 'grid') {
|
||||
return $this->renderTwigAjaxReturn($request, $response);
|
||||
}
|
||||
|
||||
// We always return 200's
|
||||
if ($grid) {
|
||||
$json = $data;
|
||||
} else {
|
||||
$json = $state->asArray();
|
||||
}
|
||||
|
||||
return $response->withJson($json, 200);
|
||||
} else {
|
||||
// WEB Normal
|
||||
// ----------
|
||||
if (empty($state->template)) {
|
||||
$this->getLog()->debug(sprintf('Template Missing. State: %s', json_encode($state)));
|
||||
throw new ControllerNotImplemented(__('Template Missing'));
|
||||
}
|
||||
|
||||
// Append the sidebar content
|
||||
$data['clock'] = Carbon::now()->format('H:i T');
|
||||
$data['currentUser'] = $this->getUser();
|
||||
|
||||
try {
|
||||
$response = $this->getView()->render($response, $state->template . '.twig', $data);
|
||||
} catch (LoaderError | RuntimeError | SyntaxError $e) {
|
||||
$this->getLog()->error('Twig Error' . $e->getMessage());
|
||||
throw new GeneralException(__('Unable to view this page'));
|
||||
}
|
||||
}
|
||||
$this->rendered = true;
|
||||
return $response;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Request $request
|
||||
* @param Response $response
|
||||
* @return \Psr\Http\Message\ResponseInterface|Response
|
||||
* @throws ControllerNotImplemented
|
||||
* @throws GeneralException
|
||||
*/
|
||||
public function renderTwigAjaxReturn(Request $request, Response $response)
|
||||
{
|
||||
$data = $this->getState()->getData();
|
||||
$state = $this->getState();
|
||||
|
||||
// Supply the current user to the view
|
||||
$data['currentUser'] = $this->getUser();
|
||||
|
||||
// Render the view manually with Twig, parse it and pull out various bits
|
||||
try {
|
||||
$view = $this->getView()->render($response, $state->template . '.twig', $data);
|
||||
} catch (LoaderError | RuntimeError | SyntaxError $e) {
|
||||
$this->getLog()->error('Twig Error' . $e->getMessage());
|
||||
throw new GeneralException(__('Unable to view this page'));
|
||||
}
|
||||
|
||||
$view = $view->getBody();
|
||||
|
||||
// Log Rendered View
|
||||
$this->getLog()->debug(sprintf('%s View: %s', $state->template, $view));
|
||||
|
||||
if (!$view = json_decode($view, true)) {
|
||||
$this->getLog()->error(sprintf('Problem with Template: View = %s, Error = %s ', $state->template, json_last_error_msg()));
|
||||
throw new ControllerNotImplemented(__('Problem with Form Template'));
|
||||
}
|
||||
|
||||
$state->html = $view['html'];
|
||||
$state->dialogTitle = trim($view['title']);
|
||||
$state->callBack = $view['callBack'];
|
||||
$state->extra = $view['extra'];
|
||||
|
||||
// Process the buttons
|
||||
$state->buttons = [];
|
||||
// Expect each button on a new line
|
||||
if (trim($view['buttons']) != '') {
|
||||
|
||||
// Convert to an array
|
||||
$view['buttons'] = str_replace("\n\r", "\n", $view['buttons']);
|
||||
$buttons = explode("\n", $view['buttons']);
|
||||
|
||||
foreach ($buttons as $button) {
|
||||
if ($button == '')
|
||||
continue;
|
||||
|
||||
$this->getLog()->debug('Button is ' . $button);
|
||||
|
||||
$button = explode(',', trim($button));
|
||||
|
||||
if (count($button) != 2) {
|
||||
$this->getLog()->error(sprintf('There is a problem with the buttons in the template: %s. Buttons: %s.', $state->template, var_export($view['buttons'], true)));
|
||||
throw new ControllerNotImplemented(__('Problem with Form Template'));
|
||||
}
|
||||
|
||||
$state->buttons[trim($button[0])] = str_replace('|', ',', trim($button[1]));
|
||||
}
|
||||
}
|
||||
|
||||
// Process the fieldActions
|
||||
if (trim($view['fieldActions']) == '') {
|
||||
$state->fieldActions = [];
|
||||
} else {
|
||||
// Convert to an array
|
||||
$state->fieldActions = json_decode($view['fieldActions']);
|
||||
}
|
||||
|
||||
$json = json_decode($state->asJson());
|
||||
return $response = $response->withJson($json, 200);
|
||||
}
|
||||
|
||||
/**
|
||||
* Render a template to string
|
||||
* @param string $template
|
||||
* @param array $data
|
||||
* @return string
|
||||
* @throws \Twig\Error\LoaderError
|
||||
* @throws \Twig\Error\RuntimeError
|
||||
* @throws \Twig\Error\SyntaxError
|
||||
*/
|
||||
public function renderTemplateToString($template, $data)
|
||||
{
|
||||
return $this->getView()->fetch($template . '.twig', $data);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Request $request
|
||||
* @param Response $response
|
||||
* @return \Psr\Http\Message\ResponseInterface|Response
|
||||
*/
|
||||
public function renderApiResponse(Request $request, Response $response)
|
||||
{
|
||||
$data = $this->getState()->getData();
|
||||
|
||||
// Don't envelope unless requested
|
||||
if ($request->getParam('envelope', 0) == 1
|
||||
|| $request->getAttribute('_entryPoint') === 'test'
|
||||
) {
|
||||
// Envelope
|
||||
// append error bool
|
||||
if (!$data['success']) {
|
||||
$data['success'] = false;
|
||||
}
|
||||
|
||||
// append status code
|
||||
$data['status'] = $response->getStatusCode();
|
||||
|
||||
// Enveloped responses always return 200
|
||||
$response = $response->withStatus(200);
|
||||
} else {
|
||||
// Don't envelope
|
||||
// Set status
|
||||
$response = $response->withStatus($data['status']);
|
||||
|
||||
// Are we successful?
|
||||
if (!$data['success']) {
|
||||
// Error condition
|
||||
$data = [
|
||||
'error' => [
|
||||
'message' => $data['message'],
|
||||
'code' => $data['status'],
|
||||
'data' => $data['data']
|
||||
]
|
||||
];
|
||||
} else {
|
||||
// Are we a grid?
|
||||
if ($data['grid'] == true) {
|
||||
// Set the response to our data['data'] object
|
||||
$grid = $data['data'];
|
||||
$data = $grid['data'];
|
||||
|
||||
// Total Number of Rows
|
||||
$totalRows = $grid['recordsTotal'];
|
||||
|
||||
// Set some headers indicating our next/previous pages
|
||||
$sanitizedParams = $this->getSanitizer($request->getParams());
|
||||
$start = $sanitizedParams->getInt('start', ['default' => 0]);
|
||||
$size = $sanitizedParams->getInt('length', ['default' => 10]);
|
||||
|
||||
$linkHeader = '';
|
||||
$url = (new HttpsDetect())->getRootUrl() . $request->getUri()->getPath();
|
||||
|
||||
// Is there a next page?
|
||||
if ($start + $size < $totalRows) {
|
||||
$linkHeader .= '<' . $url . '?start=' . ($start + $size) . '&length=' . $size . '>; rel="next", ';
|
||||
}
|
||||
|
||||
// Is there a previous page?
|
||||
if ($start > 0) {
|
||||
$linkHeader .= '<' . $url . '?start=' . ($start - $size) . '&length=' . $size . '>; rel="prev", ';
|
||||
}
|
||||
|
||||
// The first page
|
||||
$linkHeader .= '<' . $url . '?start=0&length=' . $size . '>; rel="first"';
|
||||
|
||||
$response = $response
|
||||
->withHeader('X-Total-Count', $totalRows)
|
||||
->withHeader('Link', $linkHeader);
|
||||
} else {
|
||||
// Set the response to our data object
|
||||
$data = $data['data'];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return $response->withJson($data);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $form The form name
|
||||
* @return bool
|
||||
* @throws \Xibo\Support\Exception\NotFoundException
|
||||
*/
|
||||
public function getAutoSubmit(string $form)
|
||||
{
|
||||
return $this->getUser()->getOptionValue('autoSubmit.' . $form, 'false') === 'true';
|
||||
}
|
||||
|
||||
public function checkRootFolderAllowSave()
|
||||
{
|
||||
if ($this->getConfig()->getSetting('FOLDERS_ALLOW_SAVE_IN_ROOT') == 0
|
||||
&& !$this->getUser()->isSuperAdmin()
|
||||
) {
|
||||
throw new InvalidArgumentException(
|
||||
__('Saving into root folder is disabled, please select a different folder')
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user