Image.php

<?php
/*
 * Copyright (C) 2024 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\Widget;

use Intervention\Image\Exception\NotReadableException;
use Intervention\Image\ImageManagerStatic as Img;
use Respect\Validation\Validator as v;
use Slim\Http\Response as Response;
use Slim\Http\ServerRequest as Request;
use Xibo\Support\Exception\InvalidArgumentException;

/**
 * Class Image
 * @package Xibo\Widget
 */
class Image extends ModuleWidget
{
    /** @inheritdoc */
    public function settingsForm()
    {
        return 'image-form-settings';
    }

    /** @inheritdoc */
    public function settings(Request $request, Response $response): Response
    {
        $this->module->settings['defaultScaleTypeId'] = $this->getSanitizer($request->getParams())->getString('defaultScaleTypeId');

        return parent::settings($request, $response);
    }

    /** @inheritdoc */
    public function setDefaultWidgetOptions()
    {
        parent::setDefaultWidgetOptions();

        $this->setOption('scaleType', $this->getSetting('defaultScaleTypeId', 'center'));
    }

    /**
     * @inheritDoc
     */
    public function layoutDesignerJavaScript()
    {
        // We use the same javascript as the data set view designer
        return 'image-designer-javascript';
    }

    /**
     * Edit an Image Widget
     * @SWG\Put(
     *  path="/playlist/widget/{widgetId}?image",
     *  operationId="WidgetImageEdit",
     *  tags={"widget"},
     *  summary="Parameters for editing existing image on a layout",
     *  description="For uploading new image files, please refer to POST /library documentation.
     *               For assigning existing image file to a Playlist please see POST /playlist/library/assign/{playlistId} documentation.
     *               This call will replace existing Widget object, all not supplied parameters will be set to default.",
     *  @SWG\Parameter(
     *      name="widgetId",
     *      in="path",
     *      description="The WidgetId ID",
     *      type="integer",
     *      required=true
     *  ),
     *  @SWG\Parameter(
     *      name="name",
     *      in="formData",
     *      description="Optional Widget Name",
     *      type="string",
     *      required=false
     *  ),
     *  @SWG\Parameter(
     *      name="duration",
     *      in="formData",
     *      description="The Widget Duration",
     *      type="integer",
     *      required=false
     *  ),
     *  @SWG\Parameter(
     *      name="useDuration",
     *      in="formData",
     *      description="Select 1 only if you will provide duration parameter as well",
     *      type="integer",
     *      required=false
     *  ),
     *  @SWG\Parameter(
     *      name="scaleTypeId",
     *      in="formData",
     *      description="Select scale type available options: center, stretch",
     *      type="string",
     *      required=false
     *   ),
     *  @SWG\Parameter(
     *      name="alignId",
     *      in="formData",
     *      description="Horizontal alignment - left, center, bottom",
     *      type="string",
     *      required=false
     *   ),
     *  @SWG\Parameter(
     *      name="valignId",
     *      in="formData",
     *      description="Vertical alignment - top, middle, bottom",
     *      type="string",
     *      required=false
     *   ),
     *  @SWG\Parameter(
     *      name="enableStat",
     *      in="formData",
     *      description="The option (On, Off, Inherit) to enable the collection of Widget Proof of Play statistics",
     *      type="string",
     *      required=false
     *   ),
     *  @SWG\Response(
     *      response=201,
     *      description="successful operation",
     *      @SWG\Schema(ref="#/definitions/Widget"),
     *      @SWG\Header(
     *          header="Location",
     *          description="Location of the new widget",
     *          type="string"
     *      )
     *  )
     * )
     *
     * @inheritDoc
     */
    public function edit(Request $request, Response $response): Response
    {
        $sanitizedParams = $this->getSanitizer($request->getParams());
        // Set the properties specific to Images
        $this->setDuration($sanitizedParams->getInt('duration', ['default' => $this->getDuration()]));
        $this->setUseDuration($sanitizedParams->getCheckbox('useDuration'));
        $this->setOption('name', $sanitizedParams->getString('name'));
        $this->setOption('scaleType', $sanitizedParams->getString('scaleTypeId', ['default' => 'center']));
        $this->setOption('align', $sanitizedParams->getString('alignId', ['default' => 'center']));
        $this->setOption('valign', $sanitizedParams->getString('valignId', ['default' => 'middle']));
        $this->setOption('enableStat', $sanitizedParams->getString('enableStat'));

        $this->isValid();
        $this->saveWidget();

        return $response;
    }

    /** @inheritdoc */
    public function preview($width, $height, $scaleOverride = 0)
    {
        if ($this->module->previewEnabled == 0) {
            return parent::preview($width, $height, $scaleOverride);
        }

        $proportional = ($this->getOption('scaleType') !== 'stretch') ? 1 : 0;
        $fit = $this->getOption('scaleType') === 'fit' ? 1 : 0;
        $align = $this->getOption('align', 'center');
        $vAlign = $this->getOption('valign', 'middle');

        $url = $this->urlFor('library.download', [
            'regionId' => $this->region->regionId,
            'id' => $this->getMediaId()
            ]) . '?preview=1&width=' . $width . '&height=' . $height . '&proportional=' . $proportional . '&fit=' . $fit;

        // Show the image - scaled to the aspect ratio of this region (get from GET)
        return '<div style="display:table; width:100%; height: ' . $height . 'px">
            <div style="text-align:' . $align . '; display: table-cell; vertical-align: ' . $vAlign . ';">
                <img src="' . $url . '" />
            </div>
        </div>';
    }

    /** @inheritDoc */
    public function download(Request $request, Response $response): Response
    {
        $sanitizedParams = $this->getSanitizer($request->getQueryParams());
        $this->getLog()->debug('Image Module: download for ' . $this->getMediaId());

        $libraryLocation = $this->getConfig()->getSetting('LIBRARY_LOCATION');
        $media = $this->mediaFactory->getById($this->getMediaId());
        $filePath = $libraryLocation . $media->storedAs;
        $this->getLog()->debug('Media Returned: ' . $media->storedAs);
        
        $width = intval($sanitizedParams->getDouble('width'));
        $height = intval($sanitizedParams->getDouble('height'));

        // Get the extension if we can (module files do not have an extension stored with them)
        if (stripos($media->storedAs, '.') > -1) {
            $extension = explode('.', $media->storedAs)[1];
        } else if (stripos($media->fileName, '.')) {
            $explode = explode('.', $media->fileName);
            $extension = $explode[count($explode) - 1];
        } else {
            $extension = null;
        }

        // Preview or download?
        if ($sanitizedParams->getCheckbox('preview')) {
            // What type of download are we?
            $isThumb = $sanitizedParams->getCheckbox('isThumb') == 1;

            // We expect the preview to load, manipulate and output a thumbnail (even on error).
            // Therefore, we need to end output buffering and wipe any output so far.
            // this means that we do not buffer the image output into memory
            while (ob_get_level() > 0) {
                ob_end_clean();
            }

            // Preview (we output the file to the browser with image headers)
            try {
                Img::configure(['driver' => 'gd']);

                // Do we want a thumbnail
                if ($isThumb) {
                    // Thumbnail
                    $thumbPath = $libraryLocation . 'tn_' . $media->storedAs;
                    $proportional = true;
                    $width = 120;
                    $height = 120;

                    $this->getLog()->debug('Thumbnail: ' . $thumbPath . ' requested');

                    // Does the thumbnail exist already?
                    $img = null;
                    $regenerate = true;
                    if (file_exists($thumbPath)) {
                        $img = Img::make($filePath);
                        if ($img->width() === $width || $img->height() === $height) {
                            // Correct cache
                            $regenerate = false;
                        }
                    }

                    if ($regenerate) {
                        // Get the full image and make a thumbnail
                        $img = Img::make($filePath);
                        $img->resize($width, $height, function ($constraint) use ($proportional) {
                            if ($proportional) {
                                $constraint->aspectRatio();
                            }
                        });
                        $img->save($thumbPath);
                    }

                    // Output Etag
                    $response = $this->cacheProvider->withEtag($response, md5_file($thumbPath));
                } else {
                    // Not a thumbnail, output the whole file
                    $proportional = !$sanitizedParams->hasParam('proportional')
                        || $sanitizedParams->getCheckbox('proportional') == 1;

                    $fit = $proportional && $sanitizedParams->getCheckbox('fit') === 1;

                    // only use upsize constraint, if we the requested dimensions are larger than resize limit.
                    $resizeLimit = $this->getConfig()->getSetting('DEFAULT_RESIZE_LIMIT', 6000);
                    $useUpsizeConstraint = max($width, $height) > $resizeLimit;

                    $this->getLog()->debug('Whole file: ' . $filePath
                        . ' requested with Width and Height ' . $width . ' x ' . $height
                        . ', proportional: ' . var_export($proportional, true)
                        . ', fit: ' . var_export($fit, true)
                        . ', upsizeConstraint ' . var_export($useUpsizeConstraint, true));

                    $img = Img::make($filePath);

                    // Output a specific width/height
                    if ($width > 0 && $height > 0) {
                        if ($fit) {
                            $img->fit($width, $height);
                        } else {
                            $img->resize($width, $height, function ($constraint) use ($proportional, $useUpsizeConstraint) {
                                if ($proportional) {
                                    $constraint->aspectRatio();
                                }
                                if ($useUpsizeConstraint) {
                                    $constraint->upsize();
                                }
                            });
                        }
                    }
                }

                // Output
                $response = $this->cacheProvider->withExpires($response, '+1 week');
                echo $img->encode($extension);
            } catch (NotReadableException $notReadableException) {
                $this->getLog()->debug($notReadableException->getTraceAsString());
                $this->getLog()->error('Image not readable: ' . $notReadableException->getMessage());

                // Output the thumbnail
                $img = Img::make($this->getConfig()->uri('img/error.png', true));

                if ($width != 0 || $height != 0) {
                    $img->resize($width, $height, function ($constraint) use ($proportional) {
                        if ($proportional) {
                            $constraint->aspectRatio();
                        }
                    });
                }

                echo $img->encode();
            }

            return $response;
        } else {
            // Download the file
            return parent::download($request, $response);
        }
    }

    /** @inheritDoc */
    public function isValid()
    {
        if ($this->getMedia()->released == 0) {
            $this->statusMessage = __('%s is pending conversion', $this->getMedia()->name);
            return self::$STATUS_PLAYER;
        } elseif ($this->getMedia()->released == 2) {
            $resizeLimit = $this->getConfig()->getSetting('DEFAULT_RESIZE_LIMIT');
            $this->statusMessage = __('%s is too large. Please ensure that none of the images in your layout are larger than %s pixels on their longest edge. Please check the allowed Resize Limit in Administration -> Settings', $this->getMedia()->name, $resizeLimit);
            throw new InvalidArgumentException(__('%s is too large. Please ensure that none of the images in your layout are larger than %s pixels on their longest edge. Please check the allowed Resize Limit in Administration -> Settings', $this->getMedia()->name, $resizeLimit), 'name');
        }

        if (!v::intType()->min(1, true)->validate($this->getDuration())) {
            throw new InvalidArgumentException(__('You must enter a duration.'), 'duration');
        }

        return self::$STATUS_VALID;
    }

    /**
     * @inheritDoc
     */
    public function getResource($displayId = 0)
    {
        return '';
    }

    public function hasThumbnail()
    {
        return true;
    }
}