Add Notifications CMS functionality

composer.json

@@ -33,6 +33,7 @@
         "colinmollenhour/credis": "1.16.1",
         "composer/package-versions-deprecated": "1.11.99.5",
         "composer/semver": "3.4.3",
+        "elgigi/commonmark-emoji": "2.0.0",
         "endroid/qr-code": "5.1.0",
         "guzzlehttp/guzzle": "7.9.2",
         "jaybizzle/crawler-detect": "^1.2",

config/vufind/Notifications.yaml

@@ -0,0 +1,23 @@
+# Configuration file for notifications
+
+Notifications:
+  # Activated languages.
+  # Add more as two character abbreviations.
+  languages:
+    - "en"
+
+  # Types of broadcasts.
+  # Add more by specifying a name ("success") ad the two colors for the box.
+  broadcast_types:
+    success:
+      background_color: "#E2EEDA"
+      border_color: "#74B566"
+    info:
+      background_color: "#DDECF6"
+      border_color: "#75BFDB"
+    warning:
+      background_color: "#FBF8E5"
+      border_color: "#E7AF5F"
+    danger:
+      background_color: "#EFDFDE"
+      border_color: "#C95C54"

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

@@ -199,3 +199,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

languages/de.ini

@@ -18,6 +18,7 @@ account_requests_other = "Anderer Status"
 Add a Library Card = "Bibliotheksausweis hinzufügen"
 Add a Library Card using login = "Hinzufügen einer Bibliothekskarte mit institutionellem Login"
 Add a Note = "Bemerkung hinzufügen"
+Add New Notification = "Neu"
 Add Tag = "Tag hinzufügen"
 Add Tags = "Tags hinzufügen"
 Add to another list = "Einer anderen Liste hinzufügen"
@@ -143,6 +144,13 @@ bound_with_intro = "Folgende Werke befinden sich in dem Buch mit der oben genann
 Braille = "Blindenschrift"
 Breadcrumbs = "Navigation"
 Brief View = "Übersicht"
+Broadcast = "Broadcast"
+Broadcasts = "Broadcasts"
+broadcasts_color = "Farbe"
+broadcasts_enddate = "Bis"
+broadcasts_startdate = "Von"
+broadcasts_visible = "Sichtbar auf der Startseite"
+broadcasts_visible_global = "Sichtbar auf jeder Seite"
 Browse = "Durchstöbern"
 Browse Alphabetically = "Alphabetisch durchstöbern"
 Browse for Authors = "Nach Verfasser durchstöbern"
@@ -936,6 +944,19 @@ note_785_7 = "Fusioniert mit / Bildet"
 note_785_8 = "Wieder u.d. Tit."
 note_787 = "Andere Beziehung"
 Notes = "Anmerkungen"
+notifications_broadcasts = "Notifications Broadcasts"
+notifications_broadcast_close_for_this_session = "Broadcast für diese Sitzung schließen"
+notifications_content = "Inhalt"
+notifications_delete_page_warning = "Sind Sie sicher, dass Sie den folgenden Eintrag löschen möchten?"
+notifications_markdown_help = "Hilfe zu Markdown und Emojis"
+notifications_pages = "Notifications Pages"
+notifications_pages_external_url = "Externe URL"
+notifications_pages_headline = "Überschrift"
+notifications_pages_is_external_url = "Auf externe Seite verlinken"
+notifications_pages_nav_title = "Anzeige Navigation"
+notifications_pages_short = "Pages"
+notifications_pages_visible = "Sichtbar"
+notifications_tab_header = "Inhalt"
 Number = "Nummer"
 number_decimal_point = ","
 number_thousands_separator = "."

languages/en.ini

@@ -18,6 +18,7 @@ account_requests_other = "Other Status"
 Add a Library Card = "Add a Library Card"
 Add a Library Card using login = "Add a Library Card using institutional Login"
 Add a Note = "Add a Note"
+Add New Notification = "New"
 Add Tag = "Add Tag"
 Add Tags = "Add Tags"
 Add to another list = "Add to another list"
@@ -143,6 +144,13 @@ bound_with_intro = "The following works are all found in the book indicated by t
 Braille = "Braille"
 Breadcrumbs = "Breadcrumbs"
 Brief View = "Brief View"
+Broadcast = "Broadcast"
+Broadcasts = "Broadcasts"
+broadcasts_color = "Color"
+broadcasts_enddate = "To"
+broadcasts_startdate = "From"
+broadcasts_visible = "Visible on the home page"
+broadcasts_visible_global = "Visible on every page"
 Browse = "Browse"
 Browse Alphabetically = "Browse Alphabetically"
 Browse for Authors = "Browse for Authors"
@@ -942,6 +950,19 @@ note_785_7 = "Merged with / Forms"
 note_785_8 = "Changed back to"
 note_787 = "Other relationship"
 Notes = "Notes"
+notifications_broadcasts = "Notifications Broadcasts"
+notifications_broadcast_close_for_this_session = "Close broadcast for this session"
+notifications_content = "Content"
+notifications_delete_page_warning = "Are you sure you want to delete the following page?"
+notifications_markdown_help = "Markdown and emojis help"
+notifications_pages = "Notifications Pages"
+notifications_pages_external_url = "External URL"
+notifications_pages_headline = "Headline"
+notifications_pages_is_external_url = "Link to exteral page"
+notifications_pages_nav_title = "Navigation title"
+notifications_pages_short = "Pages"
+notifications_pages_visible = "Visible"
+notifications_tab_header = "Content"
 Number = "Number"
 number_decimal_point = "."
 number_thousands_separator = ","

module/VuFind/config/module.config.php

@@ -205,6 +205,7 @@
             'VuFind\Controller\LibraryCardsController' => 'VuFind\Controller\AbstractBaseFactory',
             'VuFind\Controller\MissingrecordController' => 'VuFind\Controller\AbstractBaseFactory',
             'VuFind\Controller\MyResearchController' => 'VuFind\Controller\MyResearchControllerFactory',
+            'VuFind\Controller\NotificationsController' => 'VuFind\Controller\AbstractBaseFactory',
             'VuFind\Controller\OaiController' => 'VuFind\Controller\AbstractBaseFactory',
             'VuFind\Controller\OAuth2Controller' => 'VuFind\Controller\OAuth2ControllerFactory',
             'VuFind\Controller\OverdriveController' => 'VuFind\Controller\AbstractBaseFactory',
@@ -312,6 +313,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',
@@ -398,6 +401,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' => [
@@ -768,6 +777,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

@@ -412,6 +412,48 @@ CREATE TABLE `access_token` (
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE utf8mb4_unicode_ci;
 /*!40101 SET character_set_client = @saved_cs_client */;
 
+--
+-- Table structure for table `notifications_broadcasts`
+--
+
+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` date DEFAULT NULL,
+  `enddate` date DEFAULT NULL,
+  `change_date` datetime DEFAULT NULL,
+  `create_date` datetime DEFAULT NULL,
+  `language` varchar(255) DEFAULT NULL,
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE utf8mb4_unicode_ci;
+
+--
+-- Table structure for table `notifications_pages`
+--
+
+CREATE TABLE `notifications_pages` (
+  `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
+  `page_id` int(11) DEFAULT NULL,
+  `visibility` tinyint(1) DEFAULT NULL,
+  `is_external_url` 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,
+  `external_url` varchar(255) DEFAULT NULL,
+  `change_date` datetime DEFAULT NULL,
+  `create_date` datetime DEFAULT NULL,
+  `language` varchar(255) DEFAULT NULL,
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE utf8mb4_unicode_ci;
+
 --
 -- Table structure for table `login_token`
 --

module/VuFind/sql/pgsql.sql

@@ -382,6 +382,52 @@ revoked boolean NOT NULL DEFAULT '0',
 PRIMARY KEY (id, type)
 );
 
+--
+-- Table structure for table `notifications_broadcasts`
+--
+
+DROP TABLE IF EXISTS "notifications_broadcasts";
+
+CREATE TABLE notifications_broadcasts (
+id serial,
+broadcast_id int DEFAULT NULL,
+visibility tinyint DEFAULT NULL,
+visibility_global tinyint DEFAULT NULL,
+priority int DEFAULT NULL,
+author_id int DEFAULT NULL,
+content text DEFAULT NULL,
+color varchar(255) DEFAULT NULL,
+startdate date DEFAULT NULL,
+enddate date DEFAULT NULL,
+change_date date DEFAULT NULL,
+create_date date DEFAULT NULL,
+language varchar(255) DEFAULT NULL,
+PRIMARY KEY (id)
+);
+
+--
+-- Table structure for table `notifications_pages`
+--
+
+DROP TABLE IF EXISTS "notifications_pages";
+
+CREATE TABLE notifications_pages (
+id serial,
+page_id int DEFAULT NULL,
+visibility tinyint DEFAULT NULL,
+is_external_url tinyint DEFAULT NULL,
+priority int DEFAULT NULL,
+author_id int DEFAULT NULL,
+headline varchar(255) DEFAULT NULL,
+nav_title varchar(255) DEFAULT NULL,
+content text DEFAULT NULL,
+external_url varchar(255) DEFAULT NULL,
+change_date date DEFAULT NULL,
+create_date date DEFAULT NULL,
+language varchar(255) DEFAULT NULL,
+PRIMARY KEY (id)
+);
+
 --
 -- Table structure for table `login_token`
 --