Media Element

lib/Controller/Widget.php

@@ -518,9 +518,6 @@ public function editWidget(Request $request, Response $response, $id)
             $template = $this->moduleTemplateFactory->getByDataTypeAndId($module->dataType, $existingTemplateId);
         }
 
-        // Before we start, clean out any cached media
-        $widget->clearCachedMedia();
-
         // We're expecting all of our properties to be supplied for editing.
         foreach ($module->properties as $property) {
             if ($property->type === 'message') {
@@ -561,6 +558,8 @@ public function editWidget(Request $request, Response $response, $id)
             }
         }
 
+        // TODO: remove media which is no longer referenced, without removing primary media and/or media in elements
+
         // If we have a validator interface, then use it now
         foreach ($widgetValidators as $widgetValidator) {
             $widgetValidator->validate($module, $widget, 'save');
@@ -1622,6 +1621,19 @@ public function saveElements(Request $request, Response $response, $id)
         // Store the target regionId
         $widget->load();
 
+        // Get a list of elements that already exist and their mediaId's
+        $newMediaIds = [];
+        $existingMediaIds = [];
+        foreach (json_decode($widget->getOptionValue('elements', '[]'), true) as $widgetElement) {
+            foreach ($widgetElement['elements'] ?? [] as $element) {
+                if (!empty($element['mediaId'])) {
+                    $existingMediaIds[] = intval($element['mediaId']);
+                }
+            }
+        }
+
+        $this->getLog()->debug('saveElements: there are ' . count($existingMediaIds) . ' existing mediaIds');
+
         // Pull out elements directly from the request body
         $elements = $request->getBody()->getContents();
         $elementJson = json_decode($elements, true);
@@ -1639,6 +1651,18 @@ public function saveElements(Request $request, Response $response, $id)
                     $slots[] = $slotNo;
                     $uniqueSlots++;
                 }
+
+                // Handle elements with the mediaId property so that media is linked and unlinked correctly.
+                if (!empty($element['mediaId'])) {
+                    $mediaId = intval($element['mediaId']);
+
+                    if (!in_array($mediaId, $existingMediaIds)) {
+                        // Make sure it exists, and we have permission to use it.
+                        $this->mediaFactory->getById($mediaId, false);
+                    }
+                    $widget->assignMedia($mediaId);
+                    $newMediaIds[] = $mediaId;
+                }
             }
         }
 
@@ -1649,11 +1673,18 @@ public function saveElements(Request $request, Response $response, $id)
         // Save elements
         $widget->setOptionValue('elements', 'raw', $elements);
 
+        // Unassign any mediaIds from elements which are no longer used.
+        foreach ($existingMediaIds as $existingMediaId) {
+            if (!in_array($existingMediaId, $newMediaIds)) {
+                $widget->unassignMedia($existingMediaId);
+            }
+        }
+
         // Save
         $widget->save([
             'saveWidgetOptions' => true,
             'saveWidgetAudio' => false,
-            'saveWidgetMedia' => false,
+            'saveWidgetMedia' => true,
             'notifyDisplays' => false,
             'audit' => true
         ]);

lib/Entity/Widget.php

@@ -222,10 +222,7 @@ class Widget implements \JsonSerializable
     public $folderId;
     public $permissionsFolderId;
 
-    /** @var int[] Original Module Media Ids */
-    private $originalModuleMediaIds = [];
-
-    /** @var array[int] Original Media IDs */
+    /** @var int[] Original Media IDs */
     private $originalMediaIds = [];
 
     /** @var array[WidgetAudio] Original Widget Audio */
@@ -598,16 +595,6 @@ public function getPrimaryMediaPath(): string
         return $this->widgetMediaFactory->getPathForMediaId($this->getPrimaryMediaId());
     }
 
-    /**
-     * Clear Media
-     *  this must only clear module media, not "primary" media
-     */
-    public function clearCachedMedia()
-    {
-        $this->load();
-        $this->mediaIds = array_values(array_diff($this->mediaIds, $this->originalModuleMediaIds));
-    }
-
     /**
      * Assign Audio Media
      * @param WidgetAudio $audio
@@ -830,7 +817,6 @@ public function load(bool $loadActions = true): Widget
         // Load any media assignments for this widget
         $this->mediaIds = $this->widgetMediaFactory->getByWidgetId($this->widgetId);
         $this->originalMediaIds = $this->mediaIds;
-        $this->originalModuleMediaIds = $this->widgetMediaFactory->getModuleOnlyByWidgetId($this->widgetId);
 
         // Load any widget audio assignments
         $this->audio = $this->widgetAudioFactory->getByWidgetId($this->widgetId);

lib/Factory/MediaFactory.php

@@ -366,9 +366,13 @@ public function processDownloads($success = null, $failure = null, $rejected = n
      * @return Media
      * @throws NotFoundException
      */
-    public function getById($mediaId)
+    public function getById($mediaId, bool $isDisableUserCheck = true)
     {
-        $media = $this->query(null, array('disableUserCheck' => 1, 'mediaId' => $mediaId, 'allModules' => 1));
+        $media = $this->query(null, [
+            'disableUserCheck' => $isDisableUserCheck ? 1 : 0,
+            'mediaId' => $mediaId,
+            'allModules' => 1,
+        ]);
 
         if (count($media) <= 0) {
             throw new NotFoundException(__('Cannot find media'));

lib/Factory/WidgetMediaFactory.php

@@ -37,16 +37,6 @@ public function getByWidgetId($widgetId)
         return $this->query(null, array('widgetId' => $widgetId));
     }
 
-    /**
-     * Media Linked to Widgets by WidgetId
-     * @param int $widgetId
-     * @return array[int]
-     */
-    public function getModuleOnlyByWidgetId($widgetId)
-    {
-        return $this->query(null, ['widgetId' => $widgetId, 'moduleOnly' => 1]);
-    }
-
     /**
      * @param int $mediaId
      * @return int

lib/Widget/Render/WidgetHtmlRenderer.php

@@ -428,7 +428,7 @@ private function render(
 
         // Extend any elements which need to be extended.
         foreach ($moduleTemplates as $moduleTemplate) {
-            if ($moduleTemplate->type === 'element' && $moduleTemplate->dataType !== 'global'
+            if ($moduleTemplate->type === 'element'
                 && !empty($moduleTemplate->extends)
                 && array_key_exists($moduleTemplate->extends->template, $globalElements)
             ) {
@@ -614,6 +614,14 @@ private function render(
                                     );
                             }
                         }
+
+                        // Check the element for a mediaId property and set it to
+                        // [[mediaId=the_id_from_the_mediaId_property]]
+                        if (!empty($element['mediaId'])) {
+                            // Update the element so we output the mediaId replacement
+                            $widgetElements[$widgetIndex]['elements'][$elementIndex]['properties']['mediaId']
+                                = '[[mediaId=' . $element['mediaId'] . ']]';
+                        }
                     }
                 }
 
@@ -624,6 +632,8 @@ private function render(
         // Render out HBS/style from templates
         // we do not render Twig here
         foreach ($moduleTemplates as $moduleTemplate) {
+            $this->getLog()->debug('render: outputting module template ' . $moduleTemplate->templateId);
+
             // Handle extends.
             $extension = $moduleTemplate->getUnmatchedProperty('extends');
             $isExtensionHasHead = false;

modules/templates/global-elements.xml

@@ -465,9 +465,6 @@ $(target).find('.date').each(function(_idx, dateEl){
         <canRotate>true</canRotate>
         <startWidth>250</startWidth>
         <startHeight>250</startHeight>
-        <properties>
-            <property id="mediaId" type="text"></property>
-        </properties>
     </template>
     <template>
         <id>line</id>

ui/src/editor-core/widget.js

@@ -661,15 +661,6 @@ Widget.prototype.saveElements = function(
     // Save only id and value for element properties if they are not empty
     if (element.properties != undefined) {
       element.properties = Object.values(element.properties).map((property) => {
-        // If property is mediaId and it's null, use element mediaId
-        if (
-          property.id === 'mediaId' &&
-          element.mediaId !== undefined &&
-          property.value === null
-        ) {
-          property.value = element.mediaId;
-        }
-
         return {
           id: property.id,
           value: property.value,

ui/src/layout-editor/viewer.js

@@ -1746,7 +1746,7 @@ Viewer.prototype.renderElementContent = function(
             convertedProperties[extendOverrideKey] = meta[metaKey];
           } else if (extendWithDataKey === 'mediaId') {
             convertedProperties[extendOverrideKey] =
-              '[[mediaId=' + convertedProperties[extendWithDataKey] + ']]';
+              '[[mediaId=' + element.mediaId + ']]';
           } else {
             convertedProperties[extendOverrideKey] =
               (elData) && elData[extendWithDataKey];