Rello / analytics

lib/Notification/Notifier.php

<?php
declare(strict_types=1);
/**
 * Analytics
 *
 * SPDX-FileCopyrightText: 2019-2022 Marcel Scherello
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace OCA\Analytics\Notification;

use InvalidArgumentException;
use OCP\IURLGenerator;

The type OCP\IURLGenerator was not found. Maybe you did not declare it correctly or list all dependencies?

use OCP\IUserManager;

The type OCP\IUserManager was not found. Maybe you did not declare it correctly or list all dependencies?

use OCP\L10N\IFactory;

The type OCP\L10N\IFactory was not found. Maybe you did not declare it correctly or list all dependencies?

use OCP\Notification\AlreadyProcessedException;

The type OCP\Notification\AlreadyProcessedException was not found. Maybe you did not declare it correctly or list all dependencies?

use OCP\Notification\INotification;

The type OCP\Notification\INotification was not found. Maybe you did not declare it correctly or list all dependencies?

use OCP\Notification\INotifier;

The type OCP\Notification\INotifier was not found. Maybe you did not declare it correctly or list all dependencies?

use Psr\Log\LoggerInterface;

The type Psr\Log\LoggerInterface was not found. Maybe you did not declare it correctly or list all dependencies?

class Notifier implements INotifier
{

    /** @var IFactory */
    protected $l10nFactory;

    /** @var IUserManager */
    protected $userManager;

    /** @var IURLGenerator */
    protected $urlGenerator;

    private $logger;

    public function __construct(IFactory $l10nFactory,
                                IUserManager $userManager,
                                LoggerInterface $logger,
                                IURLGenerator $urlGenerator)
    {
        $this->l10nFactory = $l10nFactory;
        $this->userManager = $userManager;
        $this->logger = $logger;
        $this->urlGenerator = $urlGenerator;
    }

    /**
     * Identifier of the notifier, only use [a-z0-9_]
     *
     * @return string
     * @since 17.0.0
     */
    public function getID(): string
    {
        return 'analytics';
    }

    /**
     * Human readable name describing the notifier
     *
     * @return string
     * @since 17.0.0
     */
    public function getName(): string
    {
        return $this->l10nFactory->get('analytics')->t('Announcements');
    }

    /**
     * @param INotification $notification
     * @param string $languageCode The code of the language that should be used to prepare the notification
     * @return INotification
     * @throws InvalidArgumentException When the notification was not prepared by a notifier
     * @throws AlreadyProcessedException When the notification is not needed anymore and should be deleted
     * @since 9.0.0
     */
    public function prepare(INotification $notification, string $languageCode): INotification
    {
        if ($notification->getApp() !== 'analytics') {
            // Not my app => throw
            throw new InvalidArgumentException('Unknown app');
        }

        // Read the language from the notification
        $l = $this->l10nFactory->get('analytics', $languageCode);
        $parsedSubject = '';

        $parameters = $notification->getSubjectParameters();

        switch ($notification->getObjectType()) {
            case NotificationManager::SUBJECT_THRESHOLD:
                $parsedSubject = $l->t("Report '{report}': {subject} reached the threshold of {rule} {value}");
                $link = $this->urlGenerator->linkToRouteAbsolute('analytics.page.index') . '#/r/' . $notification->getObjectId();

                $notification->setRichSubject(
                    $parsedSubject,
                    [
                        'report' => [
                            'type' => 'highlight',
                            'id' => $notification->getObjectId(),
                            'name' => $parameters['report'],
                            'link' => $link,
                        ],
                        'subject' => [
                            'type' => 'highlight',
                            'id' => $notification->getObjectId(),
                            'name' => $parameters['subject'],
                        ],
                        'rule' => [
                            'type' => 'highlight',
                            'id' => $notification->getObjectId(),
                            'name' => $parameters['rule'],
                        ],
                        'value' => [
                            'type' => 'highlight',
                            'id' => $notification->getObjectId(),
                            'name' => $parameters['value'],
                        ],
                    ]
                );

                break;
            case NotificationManager::DATALOAD_ERROR:
                $parsedSubject = $l->t("Error during data load \"{dataloadName}\" for data set \"{datasetName}\"" );
                $link = $this->urlGenerator->linkToRouteAbsolute('analytics.page.index') . 'a/#/r/' . $notification->getObjectId();

                $notification->setRichSubject(
                    $parsedSubject,
                    [
                        'dataloadName' => [
                            'type' => 'highlight',
                            'id' => $notification->getObjectId(),
                            'name' => $parameters['dataloadName'],
                        ],
                        'datasetName' => [
                            'type' => 'highlight',
                            'id' => $notification->getObjectId(),
                            'name' => $parameters['datasetName'],
                            'link' => $link,
                        ]
                    ]
                );

                break;
            default: // legacy due to switch to subject field filled with an id for notification removal
                //$parsedSubject = $l->t("Report '{report}': {subject} reached the threshold of {rule} {value}");
                //$link = $this->urlGenerator->linkToRouteAbsolute('analytics.page.index') . '#/r/' . $notification->getObjectId();
        }


        $notification->setIcon($this->urlGenerator->getAbsoluteURL($this->urlGenerator->imagePath('analytics', 'app-dark.svg')));
        $this->setParsedSubjectFromRichSubject($notification);
        return $notification;
    }

    // This is a little helper function which automatically sets the simple parsed subject
    // based on the rich subject you set.
    protected function setParsedSubjectFromRichSubject(INotification $notification)
    {
        $placeholders = $replacements = [];
        foreach ($notification->getRichSubjectParameters() as $placeholder => $parameter) {
            $placeholders[] = '{' . $placeholder . '}';
            if ($parameter['type'] === 'file') {
                $replacements[] = $parameter['path'];
            } else {
                $replacements[] = $parameter['name'];
            }
        }

        $notification->setParsedSubject(str_replace($placeholders, $replacements, $notification->getRichSubject()));
    }

}