Merge pull request #2965 from xibosignage/develop

Release 4.2.2

Author: dasgarner

eslint.config.mjs

@@ -34,6 +34,7 @@ export default [...compat.extends('google'), {
     'valid-jsdoc': 'off',
     'require-jsdoc': 'off',
     'new-cap': 'off',
+    'no-const-assign': 'error',
   },
 }, {
   files: ['**/*.js'],

lib/Controller/Campaign.php

@@ -253,6 +253,7 @@ public function grid(Request $request, Response $response)
             'layoutId' => $parsedParams->getInt('layoutId'),
             'logicalOperator' => $parsedParams->getString('logicalOperator'),
             'logicalOperatorName' => $parsedParams->getString('logicalOperatorName'),
+            'excludeMedia' => $parsedParams->getInt('excludeMedia'),
         ];
 
         $embed = ($parsedParams->getString('embed') !== null) ? explode(',', $parsedParams->getString('embed')) : [];

lib/Controller/DisplayProfileConfigFields.php

@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright (C) 2024 Xibo Signage Ltd
+ * Copyright (C) 2025 Xibo Signage Ltd
  *
  * Xibo - Digital Signage - https://xibosignage.com
  *
@@ -907,6 +907,24 @@ public function editConfigFields($displayProfile, $sanitizedParams, $config = nu
                 // Encode option and save it as a string to the lock setting
                 $displayProfile->setSetting('lockOptions', json_encode($lockOptions), $ownConfig, $config);
 
+                // Multiple video decoders
+                if ($sanitizedParams->hasParam('isUseMultipleVideoDecoders')) {
+                    $this->handleChangedSettings(
+                        'isUseMultipleVideoDecoders',
+                        ($ownConfig)
+                            ? $displayProfile->getSetting('isUseMultipleVideoDecoders')
+                            : $display->getSetting('isUseMultipleVideoDecoders'),
+                        $sanitizedParams->getString('isUseMultipleVideoDecoders'),
+                        $changedSettings
+                    );
+                    $displayProfile->setSetting(
+                        'isUseMultipleVideoDecoders',
+                        $sanitizedParams->getString('isUseMultipleVideoDecoders'),
+                        $ownConfig,
+                        $config
+                    );
+                }
+
                 break;
 
             case 'chromeOS':
@@ -962,6 +980,23 @@ public function editConfigFields($displayProfile, $sanitizedParams, $config = nu
                     );
                 }
 
+                if ($sanitizedParams->hasParam('sendCurrentLayoutAsStatusUpdate')) {
+                    $this->handleChangedSettings(
+                        'sendCurrentLayoutAsStatusUpdate',
+                        ($ownConfig)
+                            ? $displayProfile->getSetting('sendCurrentLayoutAsStatusUpdate')
+                            : $display->getSetting('sendCurrentLayoutAsStatusUpdate'),
+                        $sanitizedParams->getCheckbox('sendCurrentLayoutAsStatusUpdate'),
+                        $changedSettings
+                    );
+                    $displayProfile->setSetting(
+                        'sendCurrentLayoutAsStatusUpdate',
+                        $sanitizedParams->getCheckbox('sendCurrentLayoutAsStatusUpdate'),
+                        $ownConfig,
+                        $config
+                    );
+                }
+
                 if ($sanitizedParams->hasParam('playerVersionId')) {
                     $this->handleChangedSettings('playerVersionId', ($ownConfig) ? $displayProfile->getSetting('playerVersionId') : $display->getSetting('playerVersionId'), $sanitizedParams->getInt('playerVersionId'), $changedSettings);
                     $displayProfile->setSetting('playerVersionId', $sanitizedParams->getInt('playerVersionId'), $ownConfig, $config);

lib/Controller/Folder.php

@@ -405,6 +405,26 @@ public function delete(Request $request, Response $response, $folderId)
             );
         }
 
+        // Check if the folder is in use
+        $this->folderFactory->decorateWithUsage($folder);
+        $usage = $folder->getUnmatchedProperty('usage');
+
+        // Prevent deletion if the folder has any usage
+        if (!empty($usage)) {
+            $usageDetails = [];
+
+            // Loop through usage data and construct the formatted message
+            foreach ($usage as $item) {
+                $usageDetails[] = $item['type'] . ' (' . $item['count'] . ')';
+            }
+
+            throw new InvalidArgumentException(
+                __('Cannot remove Folder with content: ' . implode(', ', $usageDetails)),
+                'folderId',
+                __('Reassign objects from this Folder before deleting.')
+            );
+        }
+
         try {
             $folder->delete();
         } catch (\Exception $exception) {

lib/Controller/Layout.php

@@ -3539,7 +3539,7 @@ public function createFullScreenLayout(Request $request, Response $response): Re
         $layout->schemaVersion = Environment::$XLF_VERSION;
         $layout->folderId = ($type === 'media') ? $media->folderId : $playlist->folderId;
 
-        $layout->save();
+        $layout->save(['type' => $type]);
 
         $draft = $this->layoutFactory->checkoutLayout($layout);
 
@@ -3590,6 +3590,12 @@ public function createFullScreenLayout(Request $request, Response $response): Re
         // Calculate the duration
         $widget->calculateDuration($module);
 
+        // Set loop for media items with custom duration
+        if ($type === 'media' && $media->mediaType === 'video' && $itemDuration > $media->duration) {
+            $widget->setOptionValue('loop', 'attrib', 1);
+            $widget->save();
+        }
+
         // Assign the widget to the playlist
         $region->getPlaylist()->assignWidget($widget);
         // Save the playlist

lib/Controller/MenuBoardCategory.php

@@ -316,6 +316,7 @@ public function add(Request $request, Response $response, $id): Response
 
         $menuBoardCategory = $this->menuBoardCategoryFactory->create($id, $name, $mediaId, $code, $description);
         $menuBoardCategory->save();
+        $menuBoard->save(['audit' => false]);
 
         // Return
         $this->getState()->hydrate([
@@ -430,6 +431,7 @@ public function edit(Request $request, Response $response, $id): Response
         $menuBoardCategory->code = $sanitizedParams->getString('code');
         $menuBoardCategory->description = $sanitizedParams->getString('description');
         $menuBoardCategory->save();
+        $menuBoard->save();
 
         // Success
         $this->getState()->hydrate([

lib/Controller/Tag.php

@@ -738,7 +738,7 @@ public function editMultiple(Request $request, Response $response)
                     $entity->assignTag($tag);
                 }
 
-                $entity->save();
+                $entity->save(['isTagEdit' => true]);
             }
 
             // Once we're done, and if we're a Display entity, we need to calculate the dynamic display groups

lib/Controller/Widget.php

@@ -1694,14 +1694,14 @@ public function widgetSetRegion(Request $request, Response $response, $id)
      * @param Request $request
      * @param Response $response
      * @param $id
-     * @return \Psr\Http\Message\ResponseInterface|Response
-     * @throws AccessDeniedException
-     * @throws GeneralException
-     * @throws InvalidArgumentException
-     * @throws NotFoundException
+     * @return \Slim\Http\Response
+     * @throws \Xibo\Support\Exception\AccessDeniedException
      * @throws \Xibo\Support\Exception\ControllerNotImplemented
+     * @throws \Xibo\Support\Exception\GeneralException
+     * @throws \Xibo\Support\Exception\InvalidArgumentException
+     * @throws \Xibo\Support\Exception\NotFoundException
      */
-    public function saveElements(Request $request, Response $response, $id)
+    public function saveElements(Request $request, Response $response, $id): Response
     {
         $widget = $this->widgetFactory->getById($id);
         if (!$this->getUser()->checkEditable($widget)) {
@@ -1747,20 +1747,39 @@ public function saveElements(Request $request, Response $response, $id)
             );
         }
 
-        // Parse the element JSON to see if we need to set `itemsPerPage`
+        // Parse the element JSON
         $slots = [];
         $uniqueSlots = 0;
         $isMediaOnlyWidget = true;
         $maxDuration = 1;
 
-        foreach ($elementJson as $widgetElement) {
-            foreach ($widgetElement['elements'] ?? [] as $element) {
+        foreach ($elementJson as $widgetIndex => $widgetElement) {
+            foreach ($widgetElement['elements'] ?? [] as $elementIndex => $element) {
+                $this->getLog()->debug('saveElements: processing widget index ' . $widgetIndex
+                    . ', element index ' . $elementIndex . ' with id ' . $element['id']);
+
                 $slotNo = 'slot_' . ($element['slot'] ?? 0);
                 if (!in_array($slotNo, $slots)) {
                     $slots[] = $slotNo;
                     $uniqueSlots++;
                 }
 
+                // Handle some of the common properties.
+                $elementParams = $this->getSanitizer([
+                    'elementName' => $element['elementName'],
+                ]);
+                $groupParams = $this->getSanitizer($element['groupProperties'] ?? []);
+
+                // Reassert safely
+                // TODO: we should parse out all of the fields available in the JSON provided.
+                $elementJson[$widgetIndex]['elements'][$elementIndex]['elementName']
+                    = $elementParams->getString('elementName');
+                $elementGroupName = $groupParams->getString('elementGroupName');
+                if (!empty($elementGroupName)) {
+                    $elementJson[$widgetIndex]['elements'][$elementIndex]['groupProperties']['elementGroupName']
+                        = $elementGroupName;
+                }
+
                 // Handle elements with the mediaId property so that media is linked and unlinked correctly.
                 if (!empty($element['mediaId'])) {
                     $mediaId = intval($element['mediaId']);
@@ -1776,14 +1795,69 @@ public function saveElements(Request $request, Response $response, $id)
                     $isMediaOnlyWidget = false;
                 }
 
-                // Temporary workaround to process properties from the mediaSelector component when used by elements
-                foreach ($element['properties'] ?? [] as $property) {
-                    if (!empty($property['mediaId'])) {
-                        $mediaId = intval($property['mediaId']);
-                        $widget->assignMedia($mediaId);
-                        $newMediaIds[] = $mediaId;
+                // Get this elements template
+                $elementTemplate = $this->moduleTemplateFactory->getByTypeAndId('element', $element['id']);
+
+                // Does this template extend another? if so combine their properties
+                if ($elementTemplate->extends !== null) {
+                    $extendedTemplate = $this->moduleTemplateFactory->getByTypeAndId(
+                        'element',
+                        $elementTemplate->extends->template,
+                    );
+
+                    $elementTemplate->properties = array_merge(
+                        $elementTemplate->properties,
+                        $extendedTemplate->properties
+                    );
+                }
+
+                // Process element properties.
+                // Switch from {id:'',value:''} to key/value
+                $elementPropertyParams = [];
+                foreach (($element['properties'] ?? []) as $elementProperty) {
+                    $elementPropertyParams[$elementProperty['id']] = $elementProperty['value'] ?? null;
+                }
+
+                $this->getLog()->debug('saveElements: parsed ' . count($elementPropertyParams)
+                    . ' properties from request, there are ' . count($elementTemplate->properties)
+                    . ' properties defined in the template');
+
+                // Load into a sanitizer
+                $elementProperties = $this->getSanitizer($elementPropertyParams);
+
+                // Process each property against its definition
+                foreach ($elementTemplate->properties as $property) {
+                    if ($property->type === 'message') {
+                        continue;
+                    }
+                    $property->setValueByType($elementProperties);
+
+                    // Process properties from the mediaSelector component
+                    if ($property->type === 'mediaSelector') {
+                        if (!empty($property->value) && is_numeric($property->value)) {
+                            $mediaId = intval($property->value);
+                            $widget->assignMedia($mediaId);
+                            $newMediaIds[] = $mediaId;
+                        }
                     }
                 }
+
+                $elementTemplate->validateProperties('save');
+
+                // Convert these back into objects
+                // and reassert new properties.
+                $elementJson[$widgetIndex]['elements'][$elementIndex]['properties'] = [];
+                foreach ($elementTemplate->getPropertyValues(
+                    false,
+                    null,
+                    false,
+                    true
+                ) as $propertyKey => $propertyValue) {
+                    $elementJson[$widgetIndex]['elements'][$elementIndex]['properties'][] = [
+                        'id' => $propertyKey,
+                        'value' => $propertyValue,
+                    ];
+                }
             }
         }
 
@@ -1803,7 +1877,7 @@ public function saveElements(Request $request, Response $response, $id)
         }
 
         // Save elements
-        $widget->setOptionValue('elements', 'raw', $elements);
+        $widget->setOptionValue('elements', 'raw', json_encode($elementJson));
 
         // Unassign any mediaIds from elements which are no longer used.
         foreach ($existingMediaIds as $existingMediaId) {
@@ -1841,7 +1915,8 @@ public function saveElements(Request $request, Response $response, $id)
         // Successful
         $this->getState()->hydrate([
             'httpStatus' => 204,
-            'message' => __('Saved elements')
+            'message' => __('Saved elements'),
+            'data' => $elementJson,
         ]);
 
         return $this->render($request, $response);

lib/Entity/Campaign.php

@@ -525,11 +525,17 @@ public function save($options = [])
             'validate' => true,
             'notify' => true,
             'collectNow' => true,
-            'saveTags' => true
+            'saveTags' => true,
+            'isTagEdit' => false
         ], $options);
 
         $this->getLog()->debug('Saving ' . $this);
 
+        // Manually load display group IDs when editing only campaign tags.
+        if ($options['isTagEdit']) {
+            $this->displayGroupIds = $this->loadDisplayGroupIds();
+        }
+
         if ($options['validate']) {
             $this->validate();
         }

lib/Entity/Layout.php

@@ -891,7 +891,8 @@ public function save($options = [])
             'import' => false,
             'appendCountOnDuplicate' => false,
             'setModifiedDt' => true,
-            'auditMessage' => null,
+            'auditMessage' => 'Saved',
+            'type' => null
         ], $options);
 
         if ($options['validate']) {
@@ -1099,7 +1100,9 @@ public function validate($options)
         }
 
         // Validation
-        if (empty($this->layout) || strlen($this->layout) > 50 || strlen($this->layout) < 1) {
+        // Layout created from media follows the media character limit
+        if ((empty($this->layout) || strlen($this->layout) > 50 || strlen($this->layout) < 1)
+            && $options['type'] !== 'media') {
             throw new InvalidArgumentException(
                 __('Layout Name must be between 1 and 50 characters'),
                 'name'