Initial Upload
This commit is contained in:
Matt Batchelder
414
lib/Controller/WidgetData.php
Normal file
414
lib/Controller/WidgetData.php
Normal file
@@ -0,0 +1,414 @@
|
||||
<?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 Slim\Http\Response as Response;
|
||||
use Slim\Http\ServerRequest as Request;
|
||||
use Xibo\Factory\ModuleFactory;
|
||||
use Xibo\Factory\WidgetDataFactory;
|
||||
use Xibo\Factory\WidgetFactory;
|
||||
use Xibo\Support\Exception\AccessDeniedException;
|
||||
use Xibo\Support\Exception\InvalidArgumentException;
|
||||
|
||||
/**
|
||||
* Controller for managing Widget Data
|
||||
*/
|
||||
class WidgetData extends Base
|
||||
{
|
||||
public function __construct(
|
||||
private readonly WidgetDataFactory $widgetDataFactory,
|
||||
private readonly WidgetFactory $widgetFactory,
|
||||
private readonly ModuleFactory $moduleFactory
|
||||
) {
|
||||
}
|
||||
|
||||
// phpcs:disable
|
||||
/**
|
||||
* @SWG\Get(
|
||||
* path="/playlist/widget/data/{id}",
|
||||
* operationId="getWidgetData",
|
||||
* tags={"widget"},
|
||||
* summary="Get data for Widget",
|
||||
* description="Return all of the fallback data currently assigned to this Widget",
|
||||
* @SWG\Parameter(
|
||||
* name="id",
|
||||
* in="path",
|
||||
* description="The Widget ID that this data should be added to",
|
||||
* type="integer",
|
||||
* required=true
|
||||
* ),
|
||||
* @SWG\Response(
|
||||
* response=201,
|
||||
* description="successful operation",
|
||||
* @SWG\Schema(
|
||||
* type="array",
|
||||
* @SWG\Items(ref="#/definitions/WidgetData")
|
||||
* )
|
||||
* )
|
||||
* )
|
||||
* @throws \Xibo\Support\Exception\GeneralException
|
||||
*/
|
||||
// phpcs:enable
|
||||
public function get(Request $request, Response $response, int $id): Response
|
||||
{
|
||||
$widget = $this->widgetFactory->getById($id);
|
||||
if (!$this->getUser()->checkEditable($widget)) {
|
||||
throw new AccessDeniedException(__('This Widget is not shared with you with edit permission'));
|
||||
}
|
||||
|
||||
return $response->withJson($this->widgetDataFactory->getByWidgetId($widget->widgetId));
|
||||
}
|
||||
|
||||
// phpcs:disable
|
||||
/**
|
||||
* @SWG\Post(
|
||||
* path="/playlist/widget/data/{id}",
|
||||
* operationId="addWidgetData",
|
||||
* tags={"widget"},
|
||||
* summary="Add a data to a Widget",
|
||||
* description="Add fallback data to a data Widget",
|
||||
* @SWG\Parameter(
|
||||
* name="id",
|
||||
* in="path",
|
||||
* description="The Widget ID that this data should be added to",
|
||||
* type="integer",
|
||||
* required=true
|
||||
* ),
|
||||
* @SWG\Parameter(
|
||||
* name="data",
|
||||
* in="path",
|
||||
* description="A JSON formatted string containing a single data item for this widget's data type",
|
||||
* type="string",
|
||||
* required=true
|
||||
* ),
|
||||
* @SWG\Parameter(
|
||||
* name="displayOrder",
|
||||
* in="formData",
|
||||
* description="Optional integer to say which position this data should appear if there is more than one data item",
|
||||
* type="integer",
|
||||
* required=false
|
||||
* ),
|
||||
* @SWG\Response(
|
||||
* response=201,
|
||||
* description="successful operation",
|
||||
* @SWG\Header(
|
||||
* header="Location",
|
||||
* description="Location of the new record",
|
||||
* type="string"
|
||||
* )
|
||||
* )
|
||||
* )
|
||||
* @throws \Xibo\Support\Exception\GeneralException
|
||||
*/
|
||||
// phpcs:enable
|
||||
public function add(Request $request, Response $response, int $id): Response
|
||||
{
|
||||
// Check that we have permission to edit this widget
|
||||
$widget = $this->widgetFactory->getById($id);
|
||||
if (!$this->getUser()->checkEditable($widget)) {
|
||||
throw new AccessDeniedException(__('This Widget is not shared with you with edit permission'));
|
||||
}
|
||||
|
||||
// Get the other params.
|
||||
$params = $this->getSanitizer($request->getParams());
|
||||
$widgetData = $this->widgetDataFactory
|
||||
->create(
|
||||
$widget->widgetId,
|
||||
$this->parseAndValidate($widget, $params->getArray('data')),
|
||||
$params->getInt('displayOrder', ['default' => 1]),
|
||||
)
|
||||
->save();
|
||||
|
||||
// Update the widget modified dt
|
||||
$widget->modifiedDt =
|
||||
|
||||
// Successful
|
||||
$this->getState()->hydrate([
|
||||
'httpStatus' => 201,
|
||||
'message' => __('Added data for Widget'),
|
||||
'id' => $widgetData->id,
|
||||
'data' => $widgetData,
|
||||
]);
|
||||
|
||||
return $this->render($request, $response);
|
||||
}
|
||||
|
||||
// phpcs:disable
|
||||
/**
|
||||
* @SWG\Put(
|
||||
* path="/playlist/widget/data/{id}/{dataId}",
|
||||
* operationId="editWidgetData",
|
||||
* tags={"widget"},
|
||||
* summary="Edit data on a Widget",
|
||||
* description="Edit fallback data on a data Widget",
|
||||
* @SWG\Parameter(
|
||||
* name="id",
|
||||
* in="path",
|
||||
* description="The Widget ID that this data is attached to",
|
||||
* type="integer",
|
||||
* required=true
|
||||
* ),
|
||||
* @SWG\Parameter(
|
||||
* name="dataId",
|
||||
* in="path",
|
||||
* description="The ID of the data to be edited",
|
||||
* type="integer",
|
||||
* required=true
|
||||
* ),
|
||||
* @SWG\Parameter(
|
||||
* name="data",
|
||||
* in="path",
|
||||
* description="A JSON formatted string containing a single data item for this widget's data type",
|
||||
* type="string",
|
||||
* required=true
|
||||
* ),
|
||||
* @SWG\Parameter(
|
||||
* name="displayOrder",
|
||||
* in="formData",
|
||||
* description="Optional integer to say which position this data should appear if there is more than one data item",
|
||||
* type="integer",
|
||||
* required=false
|
||||
* ),
|
||||
* @SWG\Response(
|
||||
* response=204,
|
||||
* description="successful operation"
|
||||
* )
|
||||
* )
|
||||
* @throws \Xibo\Support\Exception\GeneralException
|
||||
*/
|
||||
// phpcs:enable
|
||||
public function edit(Request $request, Response $response, int $id, int $dataId): Response
|
||||
{
|
||||
// Check that we have permission to edit this widget
|
||||
$widget = $this->widgetFactory->getById($id);
|
||||
if (!$this->getUser()->checkEditable($widget)) {
|
||||
throw new AccessDeniedException(__('This Widget is not shared with you with edit permission'));
|
||||
}
|
||||
|
||||
// Make sure this dataId is for this widget
|
||||
$widgetData = $this->widgetDataFactory->getById($dataId);
|
||||
|
||||
if ($id !== $widgetData->widgetId) {
|
||||
throw new AccessDeniedException(__('This widget data does not belong to this widget'));
|
||||
}
|
||||
|
||||
// Get params and process the edit
|
||||
$params = $this->getSanitizer($request->getParams());
|
||||
$widgetData->data = $this->parseAndValidate($widget, $params->getArray('data'));
|
||||
$widgetData->displayOrder = $params->getInt('displayOrder', ['default' => 1]);
|
||||
$widgetData->save();
|
||||
|
||||
// Successful
|
||||
$this->getState()->hydrate([
|
||||
'message' => __('Edited data for Widget'),
|
||||
'id' => $widgetData->id,
|
||||
'data' => $widgetData,
|
||||
'httpStatus' => 204,
|
||||
]);
|
||||
|
||||
return $this->render($request, $response);
|
||||
}
|
||||
|
||||
// phpcs:disable
|
||||
/**
|
||||
* @SWG\Delete(
|
||||
* path="/playlist/widget/data/{id}/{dataId}",
|
||||
* operationId="deleteWidgetData",
|
||||
* tags={"widget"},
|
||||
* summary="Delete data on a Widget",
|
||||
* description="Delete fallback data on a data Widget",
|
||||
* @SWG\Parameter(
|
||||
* name="id",
|
||||
* in="path",
|
||||
* description="The Widget ID that this data is attached to",
|
||||
* type="integer",
|
||||
* required=true
|
||||
* ),
|
||||
* @SWG\Parameter(
|
||||
* name="dataId",
|
||||
* in="path",
|
||||
* description="The ID of the data to be deleted",
|
||||
* type="integer",
|
||||
* required=true
|
||||
* ),
|
||||
* @SWG\Response(
|
||||
* response=204,
|
||||
* description="successful operation"
|
||||
* )
|
||||
* )
|
||||
* @throws \Xibo\Support\Exception\GeneralException
|
||||
*/
|
||||
// phpcs:enable
|
||||
public function delete(Request $request, Response $response, int $id, int $dataId): Response
|
||||
{
|
||||
// Check that we have permission to edit this widget
|
||||
$widget = $this->widgetFactory->getById($id);
|
||||
if (!$this->getUser()->checkEditable($widget)) {
|
||||
throw new AccessDeniedException(__('This Widget is not shared with you with edit permission'));
|
||||
}
|
||||
|
||||
// Make sure this dataId is for this widget
|
||||
$widgetData = $this->widgetDataFactory->getById($dataId);
|
||||
|
||||
if ($id !== $widgetData->widgetId) {
|
||||
throw new AccessDeniedException(__('This widget data does not belong to this widget'));
|
||||
}
|
||||
|
||||
// Delete it.
|
||||
$widgetData->delete();
|
||||
|
||||
// Successful
|
||||
$this->getState()->hydrate(['message' => __('Deleted'), 'httpStatus' => 204]);
|
||||
|
||||
return $this->render($request, $response);
|
||||
}
|
||||
|
||||
// phpcs:disable
|
||||
/**
|
||||
* @SWG\Definition(
|
||||
* definition="WidgetDataOrder",
|
||||
* @SWG\Property(
|
||||
* property="dataId",
|
||||
* type="integer",
|
||||
* description="Data ID"
|
||||
* ),
|
||||
* @SWG\Property(
|
||||
* property="displayOrder",
|
||||
* type="integer",
|
||||
* description="Desired display order"
|
||||
* )
|
||||
* )
|
||||
*
|
||||
* @SWG\Post(
|
||||
* path="/playlist/widget/data/{id}/order",
|
||||
* operationId="orderWidgetData",
|
||||
* tags={"widget"},
|
||||
* summary="Update the order of data on a Widget",
|
||||
* description="Provide all data to be ordered on a widget",
|
||||
* @SWG\Parameter(
|
||||
* name="id",
|
||||
* in="path",
|
||||
* description="The Widget ID that this data is attached to",
|
||||
* type="integer",
|
||||
* required=true
|
||||
* ),
|
||||
* @SWG\Parameter(
|
||||
* name="dataId",
|
||||
* in="path",
|
||||
* description="The ID of the data to be deleted",
|
||||
* type="integer",
|
||||
* required=true
|
||||
* ),
|
||||
* @SWG\Parameter(
|
||||
* name="order",
|
||||
* in="body",
|
||||
* description="An array of any widget data records that should be re-ordered",
|
||||
* @SWG\Schema(
|
||||
* type="array",
|
||||
* @SWG\Items(ref="WidgetDataOrder")
|
||||
* ),
|
||||
* required=true
|
||||
* ),
|
||||
* @SWG\Response(
|
||||
* response=204,
|
||||
* description="successful operation"
|
||||
* )
|
||||
* )
|
||||
* @throws \Xibo\Support\Exception\GeneralException
|
||||
*/
|
||||
// phpcs:enable
|
||||
public function setOrder(Request $request, Response $response, int $id): Response
|
||||
{
|
||||
// Check that we have permission to edit this widget
|
||||
$widget = $this->widgetFactory->getById($id);
|
||||
if (!$this->getUser()->checkEditable($widget)) {
|
||||
throw new AccessDeniedException(__('This Widget is not shared with you with edit permission'));
|
||||
}
|
||||
|
||||
// Expect an array of `id` in order.
|
||||
$params = $this->getSanitizer($request->getParams());
|
||||
foreach ($params->getArray('order', ['default' => []]) as $item) {
|
||||
$itemParams = $this->getSanitizer($item);
|
||||
|
||||
// Make sure this dataId is for this widget
|
||||
$widgetData = $this->widgetDataFactory->getById($itemParams->getInt('dataId'));
|
||||
$widgetData->displayOrder = $itemParams->getInt('displayOrder');
|
||||
|
||||
if ($id !== $widgetData->widgetId) {
|
||||
throw new AccessDeniedException(__('This widget data does not belong to this widget'));
|
||||
}
|
||||
|
||||
// Save it
|
||||
$widgetData->save();
|
||||
}
|
||||
|
||||
// Successful
|
||||
$this->getState()->hydrate([
|
||||
'message' => __('Updated the display order for data on Widget'),
|
||||
'id' => $widget->widgetId,
|
||||
'httpStatus' => 204,
|
||||
]);
|
||||
|
||||
return $this->render($request, $response);
|
||||
}
|
||||
|
||||
/**
|
||||
* Parse and validate the data provided in params.
|
||||
* @throws \Xibo\Support\Exception\InvalidArgumentException
|
||||
* @throws \Xibo\Support\Exception\NotFoundException
|
||||
*/
|
||||
private function parseAndValidate(\Xibo\Entity\Widget $widget, array $item): array
|
||||
{
|
||||
// Check that this module is a data widget
|
||||
$module = $this->moduleFactory->getByType($widget->type);
|
||||
if (!$module->isDataProviderExpected()) {
|
||||
throw new InvalidArgumentException(__('This is not a data widget'));
|
||||
}
|
||||
|
||||
if ($module->fallbackData !== 1) {
|
||||
throw new InvalidArgumentException(__('Fallback data is not expected for this Widget'));
|
||||
}
|
||||
|
||||
// Parse out the data string we've been given and make sure it's valid according to this widget's datatype
|
||||
$data = [];
|
||||
$params = $this->getSanitizer($item);
|
||||
|
||||
$dataType = $this->moduleFactory->getDataTypeById($module->dataType);
|
||||
foreach ($dataType->fields as $field) {
|
||||
if ($field->isRequired && !$params->hasParam($field->id)) {
|
||||
throw new InvalidArgumentException(sprintf(
|
||||
'Data is missing a field called %s',
|
||||
$field->title
|
||||
));
|
||||
}
|
||||
|
||||
$value = match ($field->type) {
|
||||
'number' => $params->getDouble($field->id),
|
||||
default => $params->getString($field->id),
|
||||
};
|
||||
$data[$field->id] = $value;
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user