Merge pull request #1968 from sbwalker/dev

improved UX in Event Log by preserving criteria when viewing Details, added RowClass and ColumnClass parameters to Pager component, added initial-scale=1.0 to viewport specification in _host, added default visitor tracking filter, fixed "The given key 'level' was not present in the dictionary" issue in Visitor Management - Details by ensuring data was fully loaded

Oqtane.Client/Modules/Admin/Logs/Detail.razor

@@ -9,6 +9,8 @@
 @inject IStringLocalizer<Detail> Localizer
 @inject IStringLocalizer<SharedResources> SharedLocalizer
 
+@if (_initialized)
+{
 	<div class="container">
 		<div class="row mb-1 align-items-center">
 			<Label Class="col-sm-3" For="dateTime" HelpText="The date and time of this log" ResourceKey="DateTime">Date/Time: </Label>
@@ -107,10 +109,11 @@
             </div>
         </div>
     </div>
-
+}
-    <NavLink class="btn btn-secondary" href="@NavigateUrl()">@SharedLocalizer["Cancel"]</NavLink>
+<NavLink class="btn btn-secondary" href="@NavigateUrl(PageState.Page.Path, "level=" + PageState.QueryString["level"] + "&function=" + PageState.QueryString["function"] + "&rows=" + PageState.QueryString["rows"] + "&page=" + PageState.QueryString["page"])">@SharedLocalizer["Cancel"]</NavLink>
 
 @code {
+	private bool _initialized = false;
     private int _logId;
     private string _logDate = string.Empty;
     private string _level = string.Empty;
@@ -176,6 +179,7 @@
                 _exception = log.Exception;
                 _properties = log.Properties;
                 _server = log.Server;
+				_initialized = true;
             }
         }
         catch (Exception ex)

Oqtane.Client/Modules/Admin/Logs/Index.razor

@@ -17,7 +17,7 @@ else
 				<div class="row mb-1 align-items-center">
 					<div class="col-sm-4">
 						<Label For="level" HelpText="Select the log level for event log items" ResourceKey="Level">Level: </Label><br /><br />
-						<select id="level" class="form-select" @onchange="(e => LevelChanged(e))">
+						<select id="level" class="form-select" value="@_level" @onchange="(e => LevelChanged(e))">
 							<option value="-">&lt;@Localizer["AllLevels"]&gt;</option>
 							<option value="Trace">@Localizer["Trace"]</option>
 							<option value="Debug">@Localizer["Debug"]</option>
@@ -29,7 +29,7 @@ else
 					</div>            
 					<div class="col-sm-4">
 						<Label For="function" HelpText="Select the function for event log items" ResourceKey="Function">Function: </Label><br /><br />
-						<select id="function" class="form-select" @onchange="(e => FunctionChanged(e))">
+						<select id="function" class="form-select" value="@_function" @onchange="(e => FunctionChanged(e))">
 							<option value="-">&lt;@Localizer["AllFunctions"]&gt;</option>
 							<option value="Create">@Localizer["Create"]</option>
 							<option value="Read">@Localizer["Read"]</option>
@@ -41,7 +41,7 @@ else
 					</div>            
 					<div class="col-sm-4">
 						<Label For="rows" HelpText="Select the maximum number of event log items to review. Please note that if you choose more than 10 items the information will be split into pages." ResourceKey="Rows">Maximum Items: </Label><br /><br />
-						<select id="rows" class="form-select" @onchange="(e => RowsChanged(e))">
+						<select id="rows" class="form-select" value="@_rows" @onchange="(e => RowsChanged(e))">
 							<option value="10">10</option>
 							<option value="50">50</option>
 							<option value="100">100</option>
@@ -53,7 +53,7 @@ else
 
 			@if (_logs.Any())
 			{
-				<Pager Items="@_logs">
+				<Pager Items="@_logs" CurrentPage="@_page.ToString()" OnPageChange="OnPageChange">
 					<Header>
 						<th style="width: 1px;">&nbsp;</th>
 						<th>@Localizer["Date"]</th>
@@ -62,7 +62,7 @@ else
 						<th>@Localizer["Function"]</th>
 					</Header>
 					<Row>
-						<td class="@GetClass(context.Function)"><ActionLink Action="Detail" Parameters="@($"id=" + context.LogId.ToString())" ResourceKey="LogDetails" /></td>
+						<td class="@GetClass(context.Function)"><ActionLink Action="Detail" Parameters="@($"id=" + context.LogId.ToString() + "&level=" + _level + "&function=" + _function + "&rows=" + _rows + "&page=" + _page.ToString())" ResourceKey="LogDetails" /></td>
 						<td class="@GetClass(context.Function)">@context.LogDate</td>
 						<td class="@GetClass(context.Function)">@context.Level</td>
 						<td class="@GetClass(context.Function)">@context.Feature</td>
@@ -94,6 +94,7 @@ else
     private string _level = "-";
     private string _function = "-";
     private string _rows = "10";
+	private int _page = 1;
     private List<Log> _logs;
     private string _retention = "";
 
@@ -103,8 +104,27 @@ else
     {
         try
         {
+			if (PageState.QueryString.ContainsKey("level"))
+			{
+				_level = PageState.QueryString["level"];
+			}
+			if (PageState.QueryString.ContainsKey("function"))
+			{
+				_function = PageState.QueryString["function"];
+			}
+			if (PageState.QueryString.ContainsKey("rows"))
+			{
+				_rows = PageState.QueryString["rows"];
+			}
+			if (PageState.QueryString.ContainsKey("page") && int.TryParse(PageState.QueryString["page"], out int page))
+			{
+				_page = page;
+			}
+
             await GetLogs();
-			_retention = SettingService.GetSetting(PageState.Site.Settings, "LogRetention", "30");
+
+			var settings = await SettingService.GetSiteSettingsAsync(PageState.Site.SiteId);
+			_retention = SettingService.GetSetting(settings, "LogRetention", "30");
         }
         catch (Exception ex)
         {
@@ -208,4 +228,9 @@ else
 		}
 	}
 
+	private void OnPageChange(int page)
+	{
+		_page = page;	
+	}
+
 }

Oqtane.Client/Modules/Admin/Visitors/Detail.razor

@@ -7,6 +7,8 @@
 @inject IStringLocalizer<Detail> Localizer
 @inject IStringLocalizer<SharedResources> SharedLocalizer
 
+@if (_initialized)
+{
 	<div class="container">
 		<div class="row mb-1 align-items-center">
 			<Label Class="col-sm-3" For="ip" HelpText="The last recorded IP address for this visitor" ResourceKey="IP">IP Address: </Label>
@@ -66,10 +68,12 @@
 			</div>
 		</div>
 	</div>
+}
 
 <NavLink class="btn btn-secondary" href="@NavigateUrl(PageState.Page.Path, "type=" + PageState.QueryString["type"] + "&days=" + PageState.QueryString["days"] + "&page=" + PageState.QueryString["page"])">@SharedLocalizer["Cancel"]</NavLink>
 
 @code {
+	private bool _initialized = false;
 	private int _visitorId;
 	private string _ip = string.Empty;
 	private string _language = string.Empty;
@@ -108,6 +112,7 @@
 						_user = user.DisplayName;
 					}
 				}
+				_initialized = true;
 			}
 			else
 			{

Oqtane.Client/Modules/Admin/Visitors/Index.razor

@@ -70,7 +70,7 @@ else
 					</div>
 				</div>
 				<div class="row mb-1 align-items-center">
-					<Label Class="col-sm-3" For="filter" HelpText="Comma delimited list of terms which may exist in IP addresses, user agents, or languages which identify visitors which should not be tracked (ie. bots)" ResourceKey="Filter">Filter: </Label>
+					<Label Class="col-sm-3" For="filter" HelpText="Comma delimited list of terms which may exist in IP addresses, user agents, or languages identifying visitors which should not be tracked" ResourceKey="Filter">Filter: </Label>
 					<div class="col-sm-9">
 						<textarea id="filter" class="form-control" @bind="@_filter" rows="3"></textarea>
 					</div>
@@ -117,8 +117,9 @@ else
 		await GetVisitors();
 
 		_tracking = PageState.Site.VisitorTracking.ToString();
-		_filter = SettingService.GetSetting(PageState.Site.Settings, "VisitorFilter", "");
+		var settings = await SettingService.GetSiteSettingsAsync(PageState.Site.SiteId);
-		_retention = SettingService.GetSetting(PageState.Site.Settings, "VisitorRetention", "30");
+		_filter = SettingService.GetSetting(settings, "VisitorFilter", Constants.DefaultVisitorFilter);
+		_retention = SettingService.GetSetting(settings, "VisitorRetention", "30");
 	}
 
 	private async void TypeChanged(ChangeEventArgs e)

Oqtane.Client/Modules/Controls/Pager.razor

@@ -57,12 +57,12 @@
 		<div class="table-responsive">
 			<table class="@Class">
 				<thead>
-					<tr>@Header</tr>
+					<tr class="@RowClass">@Header</tr>
 				</thead>
 				<tbody>
 					@foreach (var item in ItemList)
 					{
-						<tr>@Row(item)</tr>
+						<tr class="@RowClass">@Row(item)</tr>
 						@if (Detail != null)
 						{
 							<tr>@Detail(item)</tr>
@@ -93,23 +93,19 @@
 			}
         }
         <div class="@Class">
-            @if (Header != null)
-            {
-                <div class="row"><div class="col">@Header</div></div>
-            }
             @for (int row = 0; row < rows; row++)
             {
-                <div class="row">
+                <div class="@RowClass">
                     @for (int col = 0; col < cols; col++)
                     {
                         int index = (row * _columns) + col;
                         if (index < ItemList.Count())
                         {
-                            <div class="col">@Row(ItemList.ElementAt(index))</div>
+                            <div class="@ColumnClass">@Row(ItemList.ElementAt(index))</div>
                         }
                         else
                         {
-                            <div class="col">&nbsp;</div>
+                            <div>&nbsp;</div>
                         }
                     }
                 </div>
@@ -182,10 +178,10 @@
     public string Toolbar { get; set; } // Top, Bottom or Both
 
     [Parameter]
-    public RenderFragment Header { get; set; } = null;
+    public RenderFragment Header { get; set; } = null; // only applicable to Table layouts
 
     [Parameter]
-    public RenderFragment<TableItem> Row { get; set; } = null;
+    public RenderFragment<TableItem> Row { get; set; } = null; // required
 
     [Parameter]
     public RenderFragment<TableItem> Detail { get; set; } = null; // only applicable to Table layouts
@@ -197,19 +193,25 @@
     public string PageSize { get; set; } // number of items to display on a page
 
     [Parameter]
-    public string Columns { get; set; } // only applicable to Grid layouts
+    public string Columns { get; set; } // only applicable to Grid layouts - default is zero indicating use responsive behavior
 
     [Parameter]
-    public string CurrentPage { get; set; } // optional property to set the initial page to display
+    public string CurrentPage { get; set; } // sets the initial page to display
 
     [Parameter]
     public string DisplayPages { get; set; } // maximum number of page numbers to display for user selection
 
     [Parameter]
-    public string Class { get; set; }
+    public string Class { get; set; } // class for the containing element - ie. <table> for Table or <div> for Grid
 
     [Parameter]
-    public Action<int> OnPageChange { get; set; } // optional - executes a method in the calling component when the page changes
+    public string RowClass { get; set; } // class for row element - ie. <tr> for Table or <div> for Grid
+
+	[Parameter]
+    public string ColumnClass { get; set; } // class for column element - only applicable to Grid format
+
+    [Parameter]
+    public Action<int> OnPageChange { get; set; } // a method to be executed in the calling component when the page changes
 
     private IEnumerable<TableItem> ItemList { get; set; }
 
@@ -233,7 +235,31 @@
             }
             else
             {
-                Class = "container-fluid px-0";
+                Class = "container-fluid";
+            }
+        }
+
+        if (string.IsNullOrEmpty(RowClass))
+        {
+            if (Format == "Table")
+            {
+                RowClass = "";
+            }
+            else
+            {
+                RowClass = "row";
+            }
+        }	
+		
+        if (string.IsNullOrEmpty(ColumnClass))
+        {
+            if (Format == "Table")
+            {
+                ColumnClass = "";
+            }
+            else
+            {
+                ColumnClass = "col";
             }
         }	
 		

Oqtane.Client/Resources/Modules/Admin/Visitors/Index.resx

@@ -175,7 +175,7 @@
     <value>Details</value>
   </data>
   <data name="Filter.HelpText" xml:space="preserve">
-    <value>Comma delimited list of terms which may exist in IP addresses, user agents, or languages which identify visitors which should not be tracked (ie. bots)</value>
+    <value>Comma delimited list of terms which may exist in IP addresses, user agents, or languages identifying visitors which should not be tracked</value>
   </data>
   <data name="Filter.Text" xml:space="preserve">
     <value>Filter:</value>

Oqtane.Server/Pages/_Host.cshtml

@@ -6,7 +6,7 @@
 <html lang="@Model.Language">
 <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <title>@Model.Title</title>
     <base href="~/" />
     <link id="app-favicon" rel="shortcut icon" type="image/x-icon" href="@Model.FavIcon" />

Oqtane.Server/Pages/_Host.cshtml.cs

@@ -5,7 +5,6 @@ using Oqtane.Modules;
 using Oqtane.Models;
 using Oqtane.Themes;
 using System;
-using System.Globalization;
 using System.Linq;
 using System.Reflection;
 using Oqtane.Repository;
@@ -20,6 +19,7 @@ using Microsoft.AspNetCore.Http;
 using System.Security.Claims;
 using System.Net;
 using Microsoft.Extensions.Primitives;
+using Oqtane.Enums;
 
 namespace Oqtane.Pages
 {
@@ -36,8 +36,9 @@ namespace Oqtane.Pages
         private readonly IVisitorRepository _visitors;
         private readonly IAliasRepository _aliases;
         private readonly ISettingRepository _settings;
+        private readonly ILogManager _logger;
 
-        public HostModel(IConfiguration configuration, ITenantManager tenantManager, ILocalizationManager localizationManager, ILanguageRepository languages, IAntiforgery antiforgery, ISiteRepository sites, IPageRepository pages, IUrlMappingRepository urlMappings, IVisitorRepository visitors, IAliasRepository aliases, ISettingRepository settings)
+        public HostModel(IConfiguration configuration, ITenantManager tenantManager, ILocalizationManager localizationManager, ILanguageRepository languages, IAntiforgery antiforgery, ISiteRepository sites, IPageRepository pages, IUrlMappingRepository urlMappings, IVisitorRepository visitors, IAliasRepository aliases, ISettingRepository settings, ILogManager logger)
         {
             _configuration = configuration;
             _tenantManager = tenantManager;
@@ -50,6 +51,7 @@ namespace Oqtane.Pages
             _visitors = visitors;
             _aliases = aliases;
             _settings = settings;
+            _logger = logger;
         }
 
         public string Language = "en";
@@ -205,6 +207,8 @@ namespace Oqtane.Pages
         }
 
         private void TrackVisitor(int SiteId)
+        {
+            try
             {
                 // get request attributes
                 string useragent = (Request.Headers[HeaderNames.UserAgent] != StringValues.Empty) ? Request.Headers[HeaderNames.UserAgent] : "(none)";
@@ -214,17 +218,19 @@ namespace Oqtane.Pages
                 language = (language.Trim().Length == 0) ? "??" : language;
 
                 // filter
-            var filter = _settings.GetSetting(EntityNames.Site, SiteId, "VisitorFilter");
+                string filter = Constants.DefaultVisitorFilter;
-            if (filter != null && !string.IsNullOrEmpty(filter.SettingValue))
+                var setting = _settings.GetSetting(EntityNames.Site, SiteId, "VisitorFilter");
+                if (setting != null)
                 {
-                foreach (string term in filter.SettingValue.ToLower().Split(new char[] { ',' }, StringSplitOptions.RemoveEmptyEntries).Select(sValue => sValue.Trim()).ToArray())
+                    filter = setting.SettingValue;
+                }
+                foreach (string term in filter.ToLower().Split(new char[] { ',' }, StringSplitOptions.RemoveEmptyEntries).Select(sValue => sValue.Trim()).ToArray())
                 {
                     if (RemoteIPAddress.ToLower().Contains(term) || useragent.ToLower().Contains(term) || language.ToLower().Contains(term))
                     {
                         return;
                     }
                 }
-            }
 
                 string url = Request.GetEncodedUrl();
                 string referrer = (Request.Headers[HeaderNames.Referer] != StringValues.Empty) ? Request.Headers[HeaderNames.Referer] : "";
@@ -287,6 +293,11 @@ namespace Oqtane.Pages
                     }
                 }
             }
+            catch (Exception ex)
+            {
+                _logger.Log(LogLevel.Error, this, LogFunction.Other, "Error Tracking Visitor {Error}", ex.Message);
+            }
+        }
 
         private string CreatePWAScript(Alias alias, Site site, Route route)
         {

Oqtane.Shared/Shared/Constants.cs

@@ -83,5 +83,7 @@ namespace Oqtane.Shared {
         public static readonly string RequestVerificationToken = "__RequestVerificationToken";
         public static readonly string AntiForgeryTokenHeaderName = "X-XSRF-TOKEN-HEADER";
         public static readonly string AntiForgeryTokenCookieName = "X-XSRF-TOKEN-COOKIE";
+
+        public static readonly string DefaultVisitorFilter = "bot,crawler,slurp,spider,(none),??";
     }
 }