Add option to not render PageViewStats in content items (#8)

neoscie · web-flow · commit 9683cd296178 · 2022-12-17T01:08:22.000+08:00
- Minor change in UI
diff --git a/Neolution.OrchardCoreModules.PageViewStats/Controllers/DashboardController.cs b/Neolution.OrchardCoreModules.PageViewStats/Controllers/DashboardController.cs
@@ -99,7 +99,7 @@ public async Task<ActionResult> Index(int history)
         {
             History = history,
             PageViewsByDay = pageViews,
-            PageViewsBySite = pageViewsPerSite
+            PageViewsByContentItem = pageViewsPerSite
         };
 
         return View(viewModel);
diff --git a/Neolution.OrchardCoreModules.PageViewStats/Drivers/PageViewStatsContentDisplayDriver.cs b/Neolution.OrchardCoreModules.PageViewStats/Drivers/PageViewStatsContentDisplayDriver.cs
@@ -12,6 +12,8 @@
     using Microsoft.AspNetCore.Authorization;
     using Microsoft.AspNetCore.Http;
     using OrchardCore.Admin;
+    using Neolution.OrchardCoreModules.PageViewStats.Settings;
+    using OrchardCore.Entities;
 
     public class PageViewStatsContentDisplayDriver : ContentDisplayDriver
     {
@@ -43,12 +45,17 @@ public override async Task<IDisplayResult> DisplayAsync(ContentItem contentItem,
             {
                 return null;
             }
-
             var settings = await this.siteService.GetSiteSettingsAsync().ConfigureAwait(false);
             var tz = TimeZoneInfo.FindSystemTimeZoneById(settings.TimeZoneId);
             var now = TimeZoneInfo.ConvertTimeFromUtc(DateTime.UtcNow, tz);
             var today = DateOnly.FromDateTime(now);
 
+            var pageViewsettings = settings.As<PageViewStatsSettings>();
+            if (!pageViewsettings.RenderInContentItem)
+            {
+                return null;
+            }
+
             var pageViews = await this.repository.LoadPageViewsAsync(today.AddDays(-30), today).ConfigureAwait(false);
             var contentPageViews = pageViews.SelectMany(x => x.PageViews).Where(x => x.ContentItemId == contentItem.ContentItemId).ToList();
             var totalViews = await this.repository.LoadAllPageViewsAsync().ConfigureAwait(false);
diff --git a/Neolution.OrchardCoreModules.PageViewStats/Drivers/PageViewStatsSettingsDisplayDriver.cs b/Neolution.OrchardCoreModules.PageViewStats/Drivers/PageViewStatsSettingsDisplayDriver.cs
@@ -36,6 +36,7 @@ public override async Task<IDisplayResult> EditAsync(PageViewStatsSettings setti
                 m.CollectUserIp = settings.CollectUserIp;
                 m.CollectUserAgentString = settings.CollectUserAgentString;
                 m.CollectRequestReferer = settings.CollectRequestReferer;
+                m.RenderInContentItem = settings.RenderInContentItem;
             })
             .Location("Content:1").OnGroup(GroupId);
     }
@@ -59,6 +60,7 @@ public override async Task<IDisplayResult> UpdateAsync(PageViewStatsSettings set
             settings.CollectUserIp = model.CollectUserIp;
             settings.CollectUserAgentString = model.CollectUserAgentString;
             settings.CollectRequestReferer = model.CollectRequestReferer;
+            settings.RenderInContentItem = model.RenderInContentItem;
         }
 
         return await EditAsync(settings, context);
diff --git a/Neolution.OrchardCoreModules.PageViewStats/Settings/PageViewStatsSettings.cs b/Neolution.OrchardCoreModules.PageViewStats/Settings/PageViewStatsSettings.cs
@@ -15,4 +15,6 @@ public class PageViewStatsSettings
     public bool CollectUserAgentString { get; set; }
 
     public bool CollectRequestReferer { get; set; }
+
+    public bool RenderInContentItem { get; set; }
 }
diff --git a/Neolution.OrchardCoreModules.PageViewStats/ViewModels/DashboardViewModel.cs b/Neolution.OrchardCoreModules.PageViewStats/ViewModels/DashboardViewModel.cs
@@ -7,5 +7,5 @@ public class DashboardViewModel
 {
     public int History { get; set; }
     public IList<DailyArchive> PageViewsByDay { get; set; }
-    public List<PageViewsPerContentItem> PageViewsBySite { get; set; }
+    public List<PageViewsPerContentItem> PageViewsByContentItem { get; set; }
 }
diff --git a/Neolution.OrchardCoreModules.PageViewStats/ViewModels/PageViewStatsSettingsViewModel.cs b/Neolution.OrchardCoreModules.PageViewStats/ViewModels/PageViewStatsSettingsViewModel.cs
@@ -3,9 +3,12 @@
 public class PageViewStatsSettingsViewModel
 {
     public bool IsEnabled { get; set; }
+
     public bool CollectUserIp { get; set; }
 
     public bool CollectUserAgentString { get; set; }
 
     public bool CollectRequestReferer { get; set; }
+
+    public bool RenderInContentItem { get; set; }
 }
diff --git a/Neolution.OrchardCoreModules.PageViewStats/Views/Dashboard/Index.cshtml b/Neolution.OrchardCoreModules.PageViewStats/Views/Dashboard/Index.cshtml
@@ -19,7 +19,7 @@
         <a class="nav-link active" id="byday-tab" data-bs-toggle="tab" href="#byday" role="tab" aria-controls="byday" aria-selected="true">@T["By day"]</a>
     </li>
     <li class="nav-item pr-md-2">
-        <a class="nav-link" id="bysite-tab" data-bs-toggle="tab" href="#bysite" role="tab" aria-controls="bysite">@T["By site"]</a>
+        <a class="nav-link" id="bycontentitem-tab" data-bs-toggle="tab" href="#bycontentitem" role="tab" aria-controls="bycontentitem">@T["By content item"]</a>
     </li>
 </ul>
 
@@ -65,19 +65,19 @@
             </tbody>
         </table>
     </div>
-    <div class="tab-pane fade" id="bysite" role="tabpanel" aria-labelledby="bysite-tab">
+    <div class="tab-pane fade" id="bycontentitem" role="tabpanel" aria-labelledby="bycontentitem-tab">
         <div class="form-group d-inline-flex float-end mb-1">
             <div class="btn-group">
                 <div class="dropdown order-md-1">
                     <button type="button" class="btn btn-secondary btn-sm dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
                         @GetDropDownButtonText()
                     </button>
                     <ul class="dropdown-menu">
-                        <li><a class="dropdown-item" href="?history=7#bysite">Last week</a></li>
-                        <li><a class="dropdown-item" href="?history=14#bysite">Last two weeks</a></li>
-                        <li><a class="dropdown-item" href="?history=21#bysite">Last three weeks</a></li>
-                        <li><a class="dropdown-item" href="?history=30#bysite">Last month</a></li>
-                        <li><a class="dropdown-item" href="?history=0#bysite">Since ever</a></li>
+                        <li><a class="dropdown-item" href="?history=7#bycontentitem">Last week</a></li>
+                        <li><a class="dropdown-item" href="?history=14#bycontentitem">Last two weeks</a></li>
+                        <li><a class="dropdown-item" href="?history=21#bycontentitem">Last three weeks</a></li>
+                        <li><a class="dropdown-item" href="?history=30#bycontentitem">Last month</a></li>
+                        <li><a class="dropdown-item" href="?history=0#bycontentitem">Since ever</a></li>
                     </ul>
                 </div>
             </div>
@@ -94,7 +94,7 @@
                 </tr>
             </thead>
             <tbody>
-                @foreach (var item in Model.PageViewsBySite)
+                @foreach (var item in Model.PageViewsByContentItem)
                 {
                     <tr>
                         <td>@item.ContentItemId</td>
diff --git a/Neolution.OrchardCoreModules.PageViewStats/Views/PageViewStatsSettings.Edit.cshtml b/Neolution.OrchardCoreModules.PageViewStats/Views/PageViewStatsSettings.Edit.cshtml
@@ -30,4 +30,12 @@
         <label asp-for="CollectRequestReferer" class="custom-control-label">@T["Collect request referer of visitors"]</label>
     </div>
     <span class="hint">@T["Collecting the request referer may allow you to track which from which website the visitors where linked to your site."]</span>
+</fieldset>
+
+<fieldset class="form-group" asp-validation-class-for="RenderInContentItem">
+    <div class="custom-control custom-checkbox">
+        <input asp-for="RenderInContentItem" class="custom-control-input" type="checkbox" />
+        <label asp-for="RenderInContentItem" class="custom-control-label">@T["Render stats summary in content items"]</label>
+    </div>
+    <span class="hint">@T["Renders an overview of the page view statistics for each content item next to it in the content items section."]</span>
 </fieldset>

Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,7 @@ public async Task<ActionResult> Index(int history)`
`99`	`99`	`{`
`100`	`100`	`History = history,`
`101`	`101`	`PageViewsByDay = pageViews,`
`102`		`- PageViewsBySite = pageViewsPerSite`
	`102`	`+ PageViewsByContentItem = pageViewsPerSite`
`103`	`103`	`};`
`104`	`104`
`105`	`105`	`return View(viewModel);`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,7 @@ public override async Task<IDisplayResult> EditAsync(PageViewStatsSettings setti`
`36`	`36`	`m.CollectUserIp = settings.CollectUserIp;`
`37`	`37`	`m.CollectUserAgentString = settings.CollectUserAgentString;`
`38`	`38`	`m.CollectRequestReferer = settings.CollectRequestReferer;`
	`39`	`+ m.RenderInContentItem = settings.RenderInContentItem;`
`39`	`40`	`})`
`40`	`41`	`.Location("Content:1").OnGroup(GroupId);`
`41`	`42`	`}`
`@@ -59,6 +60,7 @@ public override async Task<IDisplayResult> UpdateAsync(PageViewStatsSettings set`
`59`	`60`	`settings.CollectUserIp = model.CollectUserIp;`
`60`	`61`	`settings.CollectUserAgentString = model.CollectUserAgentString;`
`61`	`62`	`settings.CollectRequestReferer = model.CollectRequestReferer;`
	`63`	`+ settings.RenderInContentItem = model.RenderInContentItem;`
`62`	`64`	`}`
`63`	`65`
`64`	`66`	`return await EditAsync(settings, context);`
Original file line number	Diff line number	Diff line change
`@@ -15,4 +15,6 @@ public class PageViewStatsSettings`
`15`	`15`	`public bool CollectUserAgentString { get; set; }`
`16`	`16`
`17`	`17`	`public bool CollectRequestReferer { get; set; }`
	`18`	`+`
	`19`	`+ public bool RenderInContentItem { get; set; }`
`18`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,5 +7,5 @@ public class DashboardViewModel`
`7`	`7`	`{`
`8`	`8`	`public int History { get; set; }`
`9`	`9`	`public IList<DailyArchive> PageViewsByDay { get; set; }`
`10`		`- public List<PageViewsPerContentItem> PageViewsBySite { get; set; }`
	`10`	`+ public List<PageViewsPerContentItem> PageViewsByContentItem { get; set; }`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,9 +3,12 @@`
`3`	`3`	`public class PageViewStatsSettingsViewModel`
`4`	`4`	`{`
`5`	`5`	`public bool IsEnabled { get; set; }`
	`6`	`+`
`6`	`7`	`public bool CollectUserIp { get; set; }`
`7`	`8`
`8`	`9`	`public bool CollectUserAgentString { get; set; }`
`9`	`10`
`10`	`11`	`public bool CollectRequestReferer { get; set; }`
	`12`	`+`
	`13`	`+ public bool RenderInContentItem { get; set; }`
`11`	`14`	`}`