Updates to notifications

rxtur · rxtur · commit a16a45928688 · 2019-08-25T14:54:21.000-05:00
diff --git a/docs/Notifications.md b/docs/Notifications.md
@@ -1,19 +1,14 @@
-Blogifier does not expose any endpoints to push notifications to the blog - 
-it only pulls notifications from known sources. Notifications can be sent
-to individual user or to all application users. 
+There are three types of notifications supported by Blogifier. They all listed and maintained
+in the admin under `admin/notifications`, along with newsletter subscriptions.
+All notifications require admin access.
 
-### Removing notificaton
-Every notification has an `active`
-flag and by closing specific notification in UI this flag is set to `false` 
-and notification will no longer appear in the UI, but still exists on the back-end. 
-There should be not too many notifications, mostly system generated. For now
-we just display 5 latest active notifications and do not clear old messages
-from database.
+### System notifications
+Notifications posted by the system, for example when new release is available. These are
+pull notifications, Blogifier calls external site (`github`) to check for system notifications.
 
-### Checking for Latest Release
-On admin page load, notification service calls Github API to check latest
-release available in Blogifier repository. This call is cached for 10 
-minutes so it does not slow down admin site. If version in repository is newer,
-service will generate notification to all users providing link to download page.
-Eventually, this will be transformed into blog auto-update functionality with
-message sent only to admins and ability to upgrade blog from admin panel.
+### User notificatoins
+Right now mostly a placeholder. When implemented will allow blog users send messages to
+each other.
+
+### Contact notificatoins
+Notifications submitted by "contact us" form, if theme supports this.
diff --git a/src/App/Pages/Admin/Notifications/Index.cshtml b/src/App/Pages/Admin/Notifications/Index.cshtml
@@ -3,13 +3,43 @@
 @{
     ViewData["Title"] = Localizer["notifications"];
 }
-
+<style>
+    .modal-body .row {
+        line-height: 2.5em;
+        border-bottom: 1px solid #efefef;
+    }
+    .card-contact {
+        margin-bottom: 10px;
+    }
+    .btn-group {
+        margin-top: 15px;
+    }
+    .form-group-label a {
+        float: right;
+        color: red;
+    }
+    h1 {
+        font-size: 1.2em;
+    }
+</style>
 <div class="bf-main">
     <partial name="~/Pages/Admin/Shared/_Notifybar.cshtml" />
     <div id="app" class="bf-body">
-        <div class="bf-content">
-            <label class="form-group-label">@Localizer["notifications"] placeholder</label>
-
+        <div class="bf-content" style="display:none">
+            <div class="row">
+                <div v-for="(item, index) in messages" class="col-md-6 card-contact">
+                    <div class="card">
+                        <div class="card-body">
+                            <div class="form-group-label">
+                                {{getDate(item.dateNotified)}} / {{item.notifier}}
+                                <a href="#" v-on:click="remove(item.id)"><i class="fa fa-times"></i></a>
+                            </div>
+                            <hr />
+                            <div v-html="item.content"> </div>
+                        </div>
+                    </div>
+                </div>
+            </div>
         </div>
     </div>
 </div>
@@ -19,10 +49,36 @@
         new Vue({
             el: "#app",
             data: {
+                messages: [],
+                pager: {},
+                page: 1,
+                cntFrom: 0,
+                cntTo: 0
             },
             methods: {
                 load: function (page) {
+                    axios.get(webRoot + 'api/notifications/system?page=' + page)
+                        .then(response => {
+                            this.messages = response.data.notifications;
+                            this.pager = response.data.pager;
 
+                            this.cntFrom = this.pager.currentPage == 1 ? 1 : (this.pager.currentPage - 1) * this.pager.itemsPerPage + 1;
+                            this.cntTo = this.pager.currentPage * this.pager.itemsPerPage < this.pager.total ? this.pager.currentPage * this.pager.itemsPerPage : this.pager.total;
+                            $('.bf-content').fadeIn();
+                        })
+                        .catch(function (error) { toastr.error(error); });
+                },
+                remove: function (id) {
+                    var result = confirm("Please confirm removing this message");
+                    if (result) {
+                        axios.delete(webRoot + 'api/notifications/remove/' + id)
+                            .then(response => {
+                                toastr.success('Removed');
+                                setTimeout(function () { location.reload(); }, 1000);
+                            })
+                            .catch(function (error) { toastr.error(error); });
+                    }
+                    return false;
                 }
             },
             beforeMount() {
diff --git a/src/App/Pages/Admin/Shared/_Layout.cshtml b/src/App/Pages/Admin/Shared/_Layout.cshtml
@@ -11,7 +11,7 @@
         if(user != null)
         {
             _isAdmin = user.IsAdmin;
-            _notifications = await _notes.GetNotifications(user.Id);
+            //_notifications = await _notes.PullSystemNotifications(AlertType.System);
         }
     }
     catch { }
@@ -106,42 +106,6 @@
                 <a class="taskbar-item-link" href="#" onclick="document.getElementById('frmOut').submit()" title="@Localizer["sign-out"]"><i class="taskbar-item-icon fas fa-sign-out-alt"></i></a>
             </li>
         </ul>
-
-        <!-- Modal Notifications -->
-        <div class="modal fade" id="notifications" tabindex="-1" role="dialog" aria-labelledby="notificationsLabel" aria-hidden="true">
-            <div class="modal-dialog" role="document">
-                <div class="modal-content">
-                    <div class="modal-header">
-                        <h4 class="modal-title" id="settingsLabel">@Localizer["notifications"]</h4>
-                        <button type="button" class="close" data-dismiss="modal" aria-label="Close"><i class="fa fa-times"></i></button>
-                    </div>
-                    <div class="modal-body">
-                        @if (_notifications.Count() > 0)
-                        {
-                            foreach (var note in _notifications)
-                            {
-                                @if (note.AlertType == AlertType.Sticky)
-                                {
-                                    <div class="alert alert-warning" role="alert">
-                                        @Html.Raw(note.Content)
-                                    </div>
-                                }
-                                else
-                                {
-                                    <div class="alert alert-primary" role="alert">
-                                        @Html.Raw(note.Content)
-                                        <button type="button" class="close" onclick="notificationsController.remove('@note.Id')" data-dismiss="alert" aria-label="Close">
-                                            <span aria-hidden="true">&times;</span>
-                                        </button>
-                                    </div>
-                                }
-                            }
-                        }
-                    </div>
-                </div>
-            </div>
-        </div>
-
         <form method="post" id="frmOut" name="frmOut" asp-controller="Account" asp-action="Logout"></form>
 
         @RenderBody()
diff --git a/src/App/wwwroot/admin/js/app/notificationsController.js b/src/App/wwwroot/admin/js/app/notificationsController.js
@@ -1,8 +1,4 @@
 ﻿var notificationsController = function (dataService) {
-    function open() {
-        $('#notifications').modal();
-        return false;
-    }
     function remove(id) {
         dataService.remove("api/settings/removenotification/" + id, removeCallback, fail);
     }
diff --git a/src/Core/Api/NotificationsController.cs b/src/Core/Api/NotificationsController.cs
@@ -2,6 +2,7 @@
 using Core.Data.Models;
 using Core.Helpers;
 using Core.Services;
+using Markdig;
 using Microsoft.AspNetCore.Cors;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc;
@@ -128,12 +129,22 @@ public async Task<NotificationModel> GetNotifications(string type, int page = 1)
         {
             var pager = new Pager(page);
             IEnumerable<Notification> items;
-            AlertType noteType = AlertType.Primary;
+            AlertType noteType = AlertType.System;
 
             if (type.ToUpper() == "CONTACT")
+            {
                 noteType = AlertType.Contact;
-
-            items = await _data.Notifications.GetList(n => n.AlertType == noteType, pager);
+                items = await _data.Notifications.GetList(n => n.AlertType == noteType, pager);
+            }
+            else
+            {
+                await _notes.PullSystemNotifications();
+                items = await _data.Notifications.GetList(n => n.AlertType == noteType && n.Active == true, pager);
+                foreach (var item in items)
+                {
+                    item.Content = Markdown.ToHtml(item.Content);
+                }
+            }
 
             if (page < 1 || page > pager.LastPage)
                 return null;
@@ -159,7 +170,17 @@ public IActionResult Delete(int id)
                 var notification = _data.Notifications.Single(n => n.Id == id);
                 if (notification != null)
                 {
-                    _data.Notifications.Remove(notification);
+                    if(notification.AlertType == AlertType.System)
+                    {
+                        // system notifications pulled from external sources
+                        // if just remove it, it will be pulled again
+                        // so just mark it as inactive instead
+                        notification.Active = false;
+                    }
+                    else
+                    {
+                        _data.Notifications.Remove(notification);
+                    }
                     _data.Complete();
                 }
                 return Ok(Resources.Removed);
diff --git a/src/Core/Constants.cs b/src/Core/Constants.cs
@@ -4,6 +4,7 @@ public class Constants
     {
         public static string ConfigSectionKey = "Blogifier";
         public static string ConfigRepoKey = "GithubRepoUrl";
+        public static string ConfigNotificationsKey = "GithubNotificationsUrl";
 
         public static string NewestVersion = "last-version";
         public static string UpgradeDirectory = "_upgrade";
diff --git a/src/Core/Core.csproj b/src/Core/Core.csproj
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>netcoreapp2.2</TargetFramework>
-    <Version>2.4.1.0</Version>
+    <Version>2.4.1.1</Version>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
diff --git a/src/Core/Data/AppData.cs b/src/Core/Data/AppData.cs
@@ -81,7 +81,7 @@ public static void Seed(AppDbContext context)
             context.Notifications.Add(new Notification
             {
                 Notifier = "Blogifier",
-                AlertType = AlertType.Primary,
+                AlertType = AlertType.System,
                 AuthorId = 0,
                 Content = "Welcome to Blogifier!",
                 Active = true,
diff --git a/src/Core/Data/Domain/Notification.cs b/src/Core/Data/Domain/Notification.cs
@@ -21,6 +21,6 @@ public class Newsletter
 
     public enum AlertType
     {
-        Primary, Sticky, Contact
+        System, User, Contact
     }
 }
diff --git a/src/Core/Data/Models/GithubModel.cs b/src/Core/Data/Models/GithubModel.cs
@@ -85,4 +85,17 @@ public class Repository
         public string zipball_url { get; set; }
         public string body { get; set; }
     }
+
+    public class GithubFile
+    {
+        public string name { get; set; }
+        public string path { get; set; }
+        public string sha { get; set; }
+        public int size { get; set; }
+        public string url { get; set; }
+        public string html_url { get; set; }
+        public string git_url { get; set; }
+        public string download_url { get; set; }
+        public string type { get; set; }
+    }
 }
diff --git a/src/Core/Services/NotificationService.cs b/src/Core/Services/NotificationService.cs
@@ -9,7 +9,7 @@ namespace Core.Services
 {
     public interface INotificationService
     {
-        Task<IEnumerable<Notification>> GetNotifications(int authorId);
+        Task PullSystemNotifications();
         Task<int> AddNotification(AlertType aType, int authorId, string notifier, string content);
     }
 
@@ -27,7 +27,12 @@ public NotificationService(IDataService db, IWebService web)
 
         public async Task<int> AddNotification(AlertType aType, int authorId, string notifier, string content)
         {
-            var existing = _db.Notifications.Single(n => n.Content == content);
+            var existing = _db.Notifications.Single(n => 
+                n.AlertType == aType && 
+                n.Notifier == notifier && 
+                n.Content == content
+            );
+
             if(existing == null)
             {
                 _db.Notifications.Add(new Notification
@@ -44,51 +49,21 @@ public async Task<int> AddNotification(AlertType aType, int authorId, string not
             return await Task.FromResult(0);
         }
 
-        public async Task<IEnumerable<Notification>> GetNotifications(int authorId)
+        public async Task PullSystemNotifications()
         {
-            if(SystemClock.Now() >= _checkPoint)
+            if (SystemClock.Now() >= _checkPoint)
             {
                 _checkPoint = SystemClock.Now().AddMinutes(30);
-                var result = await _web.CheckForLatestRelease();
-
-                if (!string.IsNullOrEmpty(result))
-                {
-                    await AddNotification(AlertType.Primary, 0, "Github", result);
-                }
-            }
+                var messages = await _web.GetNotifications();
 
-            var notes = _db.Notifications
-                .Find(n => n.Active && (n.AuthorId == 0 || n.AuthorId == authorId))
-                .OrderByDescending(n => n.DateNotified)
-                .Take(5).ToList();
-
-            // add notification if newer version exists
-            if(authorId > 0)
-            {
-                var author = _db.Authors.Single(a => a.Id == authorId);
-                if(author != null && author.IsAdmin)
+                if(messages != null && messages.Count > 0)
                 {
-                    var field = _db.CustomFields.Single(f => f.Name == Constants.NewestVersion && f.AuthorId == 0);
-                    if(field != null)
+                    foreach (var msg in messages)
                     {
-                        int current, latest;
-
-                        int.TryParse(AppSettings.Version.Replace(".", "").Substring(0, 2), out current);
-                        int.TryParse(field.Content, out latest);
-
-                        if(current < latest)
-                        {
-                            notes.Add(new Notification
-                            {
-                                AlertType = AlertType.Sticky,
-                                Content = $"Upgrade to <a href=\"upgrade\">version {field.Content.Substring(0,1)}.{field.Content.Substring(1, 1)}</a>"
-                            });   
-                        }
+                        await AddNotification(AlertType.System, 0, "Blogifier", msg);
                     }
                 }
             }
-
-            return await Task.FromResult(notes);
         }
     }
 }
diff --git a/src/Core/Services/WebService.cs b/src/Core/Services/WebService.cs
diff --git a/tests/Core.Tests/Services/WebServiceTests.cs b/tests/Core.Tests/Services/WebServiceTests.cs

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,4 @@`
`1`	`1`	`var notificationsController = function (dataService) {`
`2`		`- function open() {`
`3`		`- $('#notifications').modal();`
`4`		`- return false;`
`5`		`- }`
`6`	`2`	`function remove(id) {`
`7`	`3`	`dataService.remove("api/settings/removenotification/" + id, removeCallback, fail);`
`8`	`4`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ public class Constants`
`4`	`4`	`{`
`5`	`5`	`public static string ConfigSectionKey = "Blogifier";`
`6`	`6`	`public static string ConfigRepoKey = "GithubRepoUrl";`
	`7`	`+ public static string ConfigNotificationsKey = "GithubNotificationsUrl";`
`7`	`8`
`8`	`9`	`public static string NewestVersion = "last-version";`
`9`	`10`	`public static string UpgradeDirectory = "_upgrade";`
Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,7 @@ public static void Seed(AppDbContext context)`
`81`	`81`	`context.Notifications.Add(new Notification`
`82`	`82`	`{`
`83`	`83`	`Notifier = "Blogifier",`
`84`		`- AlertType = AlertType.Primary,`
	`84`	`+ AlertType = AlertType.System,`
`85`	`85`	`AuthorId = 0,`
`86`	`86`	`Content = "Welcome to Blogifier!",`
`87`	`87`	`Active = true,`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,6 @@ public class Newsletter`
`21`	`21`
`22`	`22`	`public enum AlertType`
`23`	`23`	`{`
`24`		`- Primary, Sticky, Contact`
	`24`	`+ System, User, Contact`
`25`	`25`	`}`
`26`	`26`	`}`