Cloud-CMS/lib/Listener/NotificationDataProviderListener.php

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

use Carbon\Carbon;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Xibo\Entity\User;
use Xibo\Event\NotificationCacheKeyRequestEvent;
use Xibo\Event\NotificationDataRequestEvent;
use Xibo\Event\NotificationModifiedDtRequestEvent;
use Xibo\Factory\NotificationFactory;
use Xibo\Service\ConfigServiceInterface;
use Xibo\Widget\Provider\DataProviderInterface;

/**
 * Listens to request for data from Notification.
 */
class NotificationDataProviderListener
{

    use ListenerLoggerTrait;

    /** @var \Xibo\Service\ConfigServiceInterface */
    private $config;

    /** @var \Xibo\Factory\NotificationFactory */
    private $notificationFactory;

    /**
     * @var User
     */
    private $user;

    public function __construct(
        ConfigServiceInterface $config,
        NotificationFactory $notificationFactory,
        User $user
    ) {
        $this->config = $config;
        $this->notificationFactory = $notificationFactory;
        $this->user = $user;
    }

    public function registerWithDispatcher(EventDispatcherInterface $dispatcher): NotificationDataProviderListener
    {
        $dispatcher->addListener(NotificationDataRequestEvent::$NAME, [$this, 'onDataRequest']);
        $dispatcher->addListener(NotificationModifiedDtRequestEvent::$NAME, [$this, 'onModifiedDtRequest']);
        return $this;
    }

    public function onDataRequest(NotificationDataRequestEvent $event)
    {
        $this->getData($event->getDataProvider());
    }

    public function getData(DataProviderInterface $dataProvider)
    {
        $age = $dataProvider->getProperty('age', 0);

        $filter = [
            'releaseDt' => ($age === 0) ? null : Carbon::now()->subMinutes($age)->unix(),
            'onlyReleased' => 1,
        ];

        if ($dataProvider->isPreview()) {
            $filter['userId'] = $this->user->getId();
        } else {
            $filter['displayId'] = $dataProvider->getDisplayId();
        }

        $sort = ['releaseDt DESC', 'createDt DESC', 'subject'];

        $notifications = $this->notificationFactory->query($sort, $filter);

        foreach ($notifications as $notification) {
            $item = [];
            $item['subject'] = $notification->subject;
            $item['body'] = strip_tags($notification->body);
            $item['date'] = Carbon::createFromTimestamp($notification->releaseDt)->format('c');
            $item['createdAt'] = Carbon::createFromTimestamp($notification->createDt)->format('c');

            $dataProvider->addItem($item);
        }

        $dataProvider->setIsHandled();
    }

    public function onModifiedDtRequest(NotificationModifiedDtRequestEvent $event)
    {
        $this->getLogger()->debug('onModifiedDtRequest');

        // Get the latest notification according to the filter provided.
        $displayId = $event->getDisplayId();

        // If we're a user, we should always refresh
        if ($displayId === 0) {
            $event->setModifiedDt(Carbon::maxValue());
            return;
        }

        $notifications = $this->notificationFactory->query(['releaseDt DESC'], [
            'onlyReleased' => 1,
            'displayId' => $displayId,
            'length' => 1,
        ]);

        if (count($notifications) > 0) {
            $event->setModifiedDt(Carbon::createFromTimestamp($notifications[0]->releaseDt));
        }
    }
}