Add Notifications CMS functionality

composer.json

@@ -32,6 +32,7 @@
         "colinmollenhour/credis": "1.15.0",
         "composer/package-versions-deprecated": "1.11.99.5",
         "composer/semver": "3.4.0",
+        "elgigi/commonmark-emoji": "2.0.0",
         "endroid/qr-code": "4.8.2",
         "laminas/laminas-cache": "3.10.1",
         "laminas/laminas-cache-storage-adapter-blackhole": "^2.0",

config/vufind/permissionBehavior.ini

@@ -91,3 +91,6 @@ deniedTemplateBehavior = showTemplate:error/loginForAccess
 ; block this for some users, you should change the defaultAccountPage in
 ; config.ini to avoid causing login problems.
 ;deniedControllerBehavior = "exception::You are not logged in!"
+
+[notifications.Admin]
+deniedControllerBehavior = "showMessage:Access to notifications administration not granted"

config/vufind/permissions.ini

@@ -183,3 +183,10 @@ role = loggedin
 ;permission[] = "access.alma.webhook.challenge"
 ;require = ALL
 ;ipRange[] = "127.0.0.1"
+
+; Example permission for Notifications
+[notifications.Admin]
+permission[] = notifications.Admin
+role = loggedin
+; Add usernames to restrict the access to certain users
+;username[] = admin

module/VuFind/config/module.config.php

@@ -183,6 +183,7 @@
             'VuFind\Controller\LibraryCardsController' => 'VuFind\Controller\AbstractBaseFactory',
             'VuFind\Controller\MissingrecordController' => 'VuFind\Controller\AbstractBaseFactory',
             'VuFind\Controller\MyResearchController' => 'VuFind\Controller\AbstractBaseFactory',
+            'VuFind\Controller\NotificationsController' => 'VuFind\Controller\AbstractBaseFactory',
             'VuFind\Controller\OaiController' => 'VuFind\Controller\AbstractBaseFactory',
             'VuFind\Controller\OAuth2Controller' => 'VuFind\Controller\OAuth2ControllerFactory',
             'VuFind\Controller\OverdriveController' => 'VuFind\Controller\AbstractBaseFactory',
@@ -289,6 +290,8 @@
             'missingrecord' => 'VuFind\Controller\MissingrecordController',
             'MyResearch' => 'VuFind\Controller\MyResearchController',
             'myresearch' => 'VuFind\Controller\MyResearchController',
+            'Notifications' => 'VuFind\Controller\NotificationsController',
+            'notifications' => 'VuFind\Controller\NotificationsController',
             'OAI' => 'VuFind\Controller\OaiController',
             'oai' => 'VuFind\Controller\OaiController',
             'OAuth2' => 'VuFind\Controller\OAuth2Controller',
@@ -370,6 +373,12 @@
             'storageRetrievalRequests' => 'VuFind\Controller\Plugin\StorageRetrievalRequests',
         ],
     ],
+    'form_elements' => [
+        'factories' => [
+            'VuFind\Form\BroadcastsForm' => 'VuFind\Form\BroadcastsFormFactory',
+            'VuFind\Form\PagesForm' => 'VuFind\Form\PagesFormFactory',
+        ],
+    ],
     'service_manager' => [
         'allow_override' => true,
         'factories' => [
@@ -720,6 +729,7 @@
     'Feedback' => ['feedback-form' => 'Form/[:id]'],
     'MyResearch' => ['userList' => 'MyList/[:id]', 'editList' => 'EditList/[:id]'],
     'LibraryCards' => ['editLibraryCard' => 'editCard/[:id]'],
+    'Notifications' => ['notifications-page' => 'Page/[:page_id]'],
 ];
 
 // Define static routes -- Controller/Action strings

module/VuFind/sql/mysql.sql

@@ -409,3 +409,35 @@ CREATE TABLE `access_token` (
   CONSTRAINT `access_token_ibfk_1` FOREIGN KEY (`user_id`) REFERENCES `user` (`id`) ON DELETE CASCADE
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE utf8mb4_unicode_ci;
 /*!40101 SET character_set_client = @saved_cs_client */;
+
+CREATE TABLE `notifications_broadcasts` (
+                                            `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
+                                            `broadcast_id` int(11) DEFAULT NULL,
+                                            `visibility` tinyint(1) DEFAULT NULL,
+                                            `visibility_global` tinyint(1) DEFAULT NULL,
+                                            `priority` int(11) DEFAULT NULL,
+                                            `author_id` int(11) DEFAULT NULL,
+                                            `content` text DEFAULT NULL,
+                                            `color` varchar(255) DEFAULT NULL,
+                                            `startdate` datetime DEFAULT NULL,
+                                            `endate` datetime DEFAULT NULL,
+                                            `change_date` datetime DEFAULT NULL,
+                                            `create_date` datetime DEFAULT NULL,
+                                            `language` varchar(255) DEFAULT NULL,
+                                            PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1;
+
+CREATE TABLE `notifications_pages` (
+                                       `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
+                                       `page_id` int(11) DEFAULT NULL,
+                                       `visibility` tinyint(1) DEFAULT NULL,
+                                       `priority` int(11) DEFAULT NULL,
+                                       `author_id` int(11) DEFAULT NULL,
+                                       `headline` varchar(255) DEFAULT NULL,
+                                       `nav_title` varchar(255) DEFAULT NULL,
+                                       `content` text DEFAULT NULL,
+                                       `change_date` datetime DEFAULT NULL,
+                                       `create_date` datetime DEFAULT NULL,
+                                       `language` varchar(255) DEFAULT NULL,
+                                       PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=latin1;

module/VuFind/src/VuFind/AjaxHandler/NotificationsClose.php

@@ -0,0 +1,105 @@
+<?php
+
+/**
+ * AJAX handler to close a broadcast for the current browser session.
+ *
+ * PHP version 8
+ *
+ * Copyright (C) effective WEBWORK GmbH 2023.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2,
+ * as published by the Free Software Foundation.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * @category VuFind
+ * @package  Controller
+ * @author   Demian Katz <[email protected]>
+ * @author   Johannes Schultze <[email protected]>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org Main Page
+ */
+
+namespace VuFind\AjaxHandler;
+
+use Laminas\Mvc\Controller\Plugin\Params;
+
+/**
+ * AJAX handler to change the visibility of a notification.
+ *
+ * @category VuFind
+ * @package  AJAX
+ * @author   Demian Katz <[email protected]>
+ * @author   Johannes Schultze <[email protected]>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org/wiki/development Wiki
+ */
+class NotificationsClose extends AbstractBase
+{
+    /**
+     * Session containing Notification status information
+     *
+     * @var \Laminas\Session\Container
+     */
+    protected $session;
+
+    /**
+     * SessionManager
+     *
+     * @var \Laminas\Session\SessionManager
+     */
+    protected $sessionManager;
+
+    /**
+     * Constructor
+     *
+     */
+    public function __construct(\Laminas\Session\SessionManager $sessionManager)
+    {
+        $this->sessionManager = $sessionManager;
+    }
+
+    /**
+     * Handle a request.
+     *
+     * @param Params $params Parameter helper from controller
+     *
+     * @return array [response data, HTTP status code]
+     */
+    public function handleRequest(Params $params)
+    {
+        $broadcast_id = $params->fromPost('broadcast-id', $params->fromQuery('broadcast-id', null));
+
+        $session = $this->getSession();
+        if (!isset($session->closedBrodcasts)) {
+            $session->closedBrodcasts = [];
+        }
+        $session->closedBrodcasts[] = $broadcast_id;
+        return $this->formatResponse(['Closed brodcasts' => $session->closedBrodcasts ? 1 : 0]);
+    }
+
+    /**
+     * Get the session container (constructing it on demand if not already present)
+     *
+     * @return SessionContainer
+     */
+    protected function getSession()
+    {
+        // SessionContainer not defined yet? Build it now:
+        if (null === $this->session) {
+            $this->session = new \Laminas\Session\Container(
+                'Notifications',
+                $this->sessionManager
+            );
+        }
+        return $this->session;
+    }
+}

module/VuFind/src/VuFind/AjaxHandler/NotificationsCloseFactory.php

@@ -0,0 +1,76 @@
+<?php
+
+/**
+ * Factory for NotificationsVisibility AJAX handler.
+ *
+ * PHP version 8
+ *
+ * Copyright (C) effective WEBWORK GmbH 2023.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2,
+ * as published by the Free Software Foundation.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * @category VuFind
+ * @package  Controller
+ * @author   Demian Katz <[email protected]>
+ * @author   Johannes Schultze <[email protected]>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org Main Page
+ */
+
+namespace VuFind\AjaxHandler;
+
+use Interop\Container\ContainerInterface;
+use Interop\Container\Exception\ContainerException;
+use Laminas\ServiceManager\Exception\ServiceNotCreatedException;
+use Laminas\ServiceManager\Exception\ServiceNotFoundException;
+use Laminas\ServiceManager\Factory\FactoryInterface;
+
+/**
+ * Factory for NotificationsClose AJAX handler.
+ *
+ * @category VuFind
+ * @package  AJAX
+ * @author   Demian Katz <[email protected]>
+ * @author   Johannes Schultze <[email protected]>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org/wiki/development Wiki
+ */
+class NotificationsCloseFactory implements FactoryInterface
+{
+    /**
+     * Create an object
+     *
+     * @param ContainerInterface $container     Service manager
+     * @param string             $requestedName Service being created
+     * @param null|array         $options       Extra options (optional)
+     *
+     * @return object
+     *
+     * @throws ServiceNotFoundException if unable to resolve the service.
+     * @throws ServiceNotCreatedException if an exception is raised when
+     * creating a service.
+     * @throws ContainerException&\Throwable if any other error occurs
+     *
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
+    {
+        if (!empty($options)) {
+            throw new \Exception('Unexpected options sent to factory.');
+        }
+        return new $requestedName(
+            $container->get(\Laminas\Session\SessionManager::class)
+        );
+    }
+}

module/VuFind/src/VuFind/AjaxHandler/NotificationsReorder.php

@@ -0,0 +1,101 @@
+<?php
+
+/**
+ * AJAX handler to change the order of notifications.
+ *
+ * PHP version 8
+ *
+ * Copyright (C) effective WEBWORK GmbH 2023.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 2,
+ * as published by the Free Software Foundation.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * @category VuFind
+ * @package  Controller
+ * @author   Demian Katz <[email protected]>
+ * @author   Johannes Schultze <[email protected]>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org Main Page
+ */
+
+namespace VuFind\AjaxHandler;
+
+use Laminas\Mvc\Controller\Plugin\Params;
+use VuFind\Db\Table\Broadcasts;
+use VuFind\Db\Table\Pages;
+
+/**
+ * AJAX handler to change the order of notifications.
+ *
+ * @category VuFind
+ * @package  AJAX
+ * @author   Demian Katz <[email protected]>
+ * @author   Johannes Schultze <[email protected]>
+ * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
+ * @link     https://vufind.org/wiki/development Wiki
+ */
+class NotificationsReorder extends AbstractBase
+{
+    /**
+     * Database table for pages
+     *
+     * @var Pages
+     */
+    private $pagesTable;
+
+    /**
+     * Database table for broadcasts
+     *
+     * @var Broadcasts
+     */
+    private $broadcastsTable;
+
+    /**
+     * Constructor
+     *
+     * @param Pages      $pagesTable  Database table for pages
+     * @param Broadcasts $broadcastsTable  Database table for broadcasts
+     */
+    public function __construct(Pages $pagesTable, Broadcasts $broadcastsTable)
+    {
+        $this->pagesTable = $pagesTable;
+        $this->broadcastsTable = $broadcastsTable;
+    }
+
+    /**
+     * Handle a request.
+     *
+     * @param Params $params Parameter helper from controller
+     *
+     * @return array [response data, HTTP status code]
+     */
+    public function handleRequest(Params $params)
+    {
+        $order = $params->fromPost('order', $params->fromQuery('order', []));
+        $type = $params->fromPost('type', $params->fromQuery('type', []));
+
+        if ($type == 'page') {
+            foreach ($order as $index => $page_id) {
+                $this->pagesTable->setPriorityForPageId($index, $page_id);
+            }
+        }
+        if ($type == 'broadcast') {
+            foreach ($order as $index => $broadcast_id) {
+                $this->broadcastsTable->setPriorityForBroadcastId($index, $broadcast_id);
+            }
+        }
+
+        $result = ['success' => true];
+        return $this->formatResponse(compact($result));
+    }
+}