Support collecting the request referrer (#2)

Author: neoscie

Neolution.OrchardCoreModules.PageViewStats/Controllers/CountPageViewController.cs

@@ -67,6 +67,11 @@ public async Task<ActionResult> IndexPost(string contentItemId)
             pageView.RequestUserAgentString = this.Request.Headers.UserAgent.ToString();
             pageView.RequestUserAgentIsRobot = this.botDetector.CheckUserAgentString(pageView.RequestUserAgentString);
         }
+
+        if (settings.CollectRequestReferer)
+        {
+            pageView.RequestReferer = this.Request.Headers.Referer.ToString();
+        }
 
         await using var connection = this.dbConnectionAccessor.CreateConnection();
 

Neolution.OrchardCoreModules.PageViewStats/Drivers/PageViewStatsSettingsDisplayDriver.cs

@@ -36,6 +36,7 @@ public override async Task<IDisplayResult> EditAsync(PageViewStatsSettings setti
                 m.IsEnabled = settings.IsEnabled;
                 m.CollectUserIp = settings.CollectUserIp;
                 m.CollectUserAgentString = settings.CollectUserAgentString;
+                m.CollectRequestReferer = settings.CollectRequestReferer;
             })
             .Location("Content:1").OnGroup(GroupId);
     }
@@ -58,6 +59,7 @@ public override async Task<IDisplayResult> UpdateAsync(PageViewStatsSettings set
             settings.IsEnabled = model.IsEnabled;
             settings.CollectUserIp = model.CollectUserIp;
             settings.CollectUserAgentString = model.CollectUserAgentString;
+            settings.CollectRequestReferer = model.CollectRequestReferer;
         }
 
         return await EditAsync(settings, context);

Neolution.OrchardCoreModules.PageViewStats/Migrations.cs

@@ -23,4 +23,13 @@ public int Create()
 
         return 1;
     }
+
+    public int UpdateFrom1()
+    {
+        SchemaBuilder.AlterTable(PageView.TableName, table => table
+            .AddColumn<string>(nameof(PageView.RequestReferer))
+        );
+
+        return 2;
+    }
 }

Neolution.OrchardCoreModules.PageViewStats/Models/PageView.cs

@@ -14,6 +14,11 @@ public class PageView
     /// </summary>
     public Guid Id { get; set; } = Guid.NewGuid();
 
+    /// <summary>
+    /// The <see cref="DateTimeOffset"/> when the page view was recorded.
+    /// </summary>
+    public DateTimeOffset CreatedUtc { get; set; }
+
     /// <summary>
     /// The id of the content item that is recorded by the <see cref="PageView"/> instance.
     /// </summary>
@@ -38,7 +43,7 @@ public class PageView
     public bool? RequestUserAgentIsRobot { get; set; }
 
     /// <summary>
-    /// The <see cref="DateTimeOffset"/> value the task was created.
+    /// Gets or sets the referer of the page view request.
     /// </summary>
-    public DateTimeOffset CreatedUtc { get; set; }
+    public string RequestReferer { get; set; }
 }

Neolution.OrchardCoreModules.PageViewStats/Settings/PageViewStatsSettings.cs

@@ -13,4 +13,6 @@ public class PageViewStatsSettings
     public bool CollectUserIp { get; set; }
 
     public bool CollectUserAgentString { get; set; }
+
+    public bool CollectRequestReferer { get; set; }
 }

Neolution.OrchardCoreModules.PageViewStats/ViewModels/PageViewStatsSettingsViewModel.cs

@@ -6,4 +6,6 @@ public class PageViewStatsSettingsViewModel
     public bool CollectUserIp { get; set; }
 
     public bool CollectUserAgentString { get; set; }
+
+    public bool CollectRequestReferer { get; set; }
 }

Neolution.OrchardCoreModules.PageViewStats/Views/PageViewStatsSettings.Edit.cshtml

@@ -22,4 +22,12 @@
         <label asp-for="CollectUserAgentString" class="custom-control-label">@T["Collect user agent strings of visitors"]</label>
     </div>
     <span class="hint">@T["Collecting the user agent strings may allow you to track which browsers visitors use to visit your site."]</span>
+</fieldset>
+
+<fieldset class="form-group" asp-validation-class-for="CollectRequestReferer">
+    <div class="custom-control custom-checkbox">
+        <input asp-for="CollectRequestReferer" class="custom-control-input" type="checkbox" />
+        <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>