Use UTC for system dates in Umbraco (#19822)

* Persist and expose Umbraco system dates as UTC (#19705)

* Updated persistence DTOs defining default dates to use UTC.

* Remove ForceToUtc = false from all persistence DTO attributes (default when not specified is true).

* Removed use of SpecifyKind setting dates to local.

* Removed unnecessary Utc suffixes on properties.

* Persist current date time with UtcNow.

* Removed further necessary Utc suffixes and fixed failing unit tests.

* Added migration for SQL server to update database date default constraints.

* Added comment justifying not providing a migration for SQLite default date constraints.

* Ensure UTC for datetimes created from persistence DTOs.

* Ensure UTC when creating dates for published content rendering in Razor and outputting in delivery API.

* Fixed migration SQL syntax.

* Introduced AuditItemFactory for creating entries for the backoffice document history, so we can control the UTC setting on the retrieved persisted dates.

* Ensured UTC dates are retrieved for document versions.

* Ensured UTC is returned for backoffice display of last edited and published for variant content.

* Fixed SQLite syntax for default current datetime.

* Apply suggestions from code review

Co-authored-by: Laura Neto <[email protected]>

* Further updates from code review.

---------

Co-authored-by: Laura Neto <[email protected]>

* Migrate system dates from local server time to UTC (#19798)

* Add settings for the migration.

* Add migration and implement for SQL server.

* Implement for SQLite.

* Fixes from testing with SQL Server.

* Fixes from testing with SQLite.

* Code tidy.

* Cleaned up usings.

* Removed audit log date from conversion.

* Removed webhook log date from conversion.

* Updated update date initialization on saving dictionary items.

* Updated filter on log queries.

* Use timezone ID instead of system name to work cross-culture.

---------

Co-authored-by: Laura Neto <[email protected]>

Author: AndyButland

src/Umbraco.Cms.Api.Management/Controllers/Security/BackOfficeController.cs

@@ -254,7 +254,7 @@ public async Task<IActionResult> Token()
         if (associatedUser is not null)
         {
             // log current datetime as last login (this also ensures that the user is not flagged as inactive)
-            associatedUser.LastLoginDateUtc = DateTime.UtcNow;
+            associatedUser.LastLoginDate = DateTime.UtcNow;
             await _backOfficeUserManager.UpdateAsync(associatedUser);
 
             return await SignInBackOfficeUser(associatedUser, request);

src/Umbraco.Cms.Persistence.SqlServer/Services/SqlServerSyntaxProvider.cs

@@ -312,11 +312,8 @@ protected override string FormatIdentity(ColumnDefinition column) =>
                 return "NEWID()";
             case SystemMethods.CurrentDateTime:
                 return "GETDATE()";
-
-                // case SystemMethods.NewSequentialId:
-                //    return "NEWSEQUENTIALID()";
-                // case SystemMethods.CurrentUTCDateTime:
-                //    return "GETUTCDATE()";
+            case SystemMethods.CurrentUTCDateTime:
+                return "GETUTCDATE()";
         }
 
         return null;

src/Umbraco.Cms.Persistence.Sqlite/Services/SqliteSyntaxProvider.cs

@@ -205,13 +205,14 @@ private static string GetColumnName(PropertyInfo column)
     /// <inheritdoc />
     protected override string? FormatSystemMethods(SystemMethods systemMethod)
     {
-        // TODO: SQLite
         switch (systemMethod)
         {
             case SystemMethods.NewGuid:
-                return "NEWID()"; // No NEWID() in SQLite perhaps try RANDOM()
+                return null; // Not available in SQLite.
             case SystemMethods.CurrentDateTime:
-                return "DATE()"; // No GETDATE() trying DATE()
+                return null; // Not available in SQLite.
+            case SystemMethods.CurrentUTCDateTime:
+                return "CURRENT_TIMESTAMP";
         }
 
         return null;

src/Umbraco.Core/Configuration/Models/SystemDateMigrationSettings.cs

@@ -0,0 +1,28 @@
+// Copyright (c) Umbraco.
+// See LICENSE for more details.
+
+using System.ComponentModel;
+
+namespace Umbraco.Cms.Core.Configuration.Models;
+
+/// <summary>
+/// Typed configuration options used for migration of system dates to UTC from a Umbraco 16 or lower solution.
+/// </summary>
+[UmbracoOptions(Constants.Configuration.ConfigSystemDateMigration)]
+public class SystemDateMigrationSettings
+{
+    private const bool StaticEnabled = true;
+
+    /// <summary>
+    /// Gets or sets a value indicating whether the migration is enabled.
+    /// </summary>
+    [DefaultValue(StaticEnabled)]
+    public bool Enabled { get; set; } = StaticEnabled;
+
+    /// <summary>
+    /// Gets or sets the local server timezone standard name.
+    /// If not provided, the local server time zone is detected.
+    /// </summary>
+    [DefaultValue(null)]
+    public string? LocalServerTimeZone { get; set; }
+}

src/Umbraco.Core/Configuration/Models/Validation/SystemDateMigrationSettingsValidator.cs

@@ -0,0 +1,30 @@
+// Copyright (c) Umbraco.
+// See LICENSE for more details.
+
+using Microsoft.Extensions.Options;
+
+namespace Umbraco.Cms.Core.Configuration.Models.Validation;
+
+/// <summary>
+///     Validator for configuration representated as <see cref="SystemDateMigrationSettings" />.
+/// </summary>
+public class SystemDateMigrationSettingsValidator
+    : IValidateOptions<SystemDateMigrationSettings>
+{
+    /// <inheritdoc />
+    public ValidateOptionsResult Validate(string? name, SystemDateMigrationSettings options)
+    {
+        if (string.IsNullOrWhiteSpace(options.LocalServerTimeZone))
+        {
+            return ValidateOptionsResult.Success;
+        }
+
+        if (TimeZoneInfo.TryFindSystemTimeZoneById(options.LocalServerTimeZone, out _) is false)
+        {
+            return ValidateOptionsResult.Fail(
+                $"Configuration entry {Constants.Configuration.ConfigSystemDateMigration} contains an invalid time zone: {options.LocalServerTimeZone}.");
+        }
+
+        return ValidateOptionsResult.Success;
+    }
+}

src/Umbraco.Core/Constants-Configuration.cs

@@ -28,6 +28,7 @@ public static class Configuration
         public const string ConfigActiveDirectory = ConfigPrefix + "ActiveDirectory";
         public const string ConfigMarketplace = ConfigPrefix + "Marketplace";
         public const string ConfigLegacyPasswordMigration = ConfigPrefix + "LegacyPasswordMigration";
+        public const string ConfigSystemDateMigration = ConfigPrefix + "SystemDateMigration";
         public const string ConfigContent = ConfigPrefix + "Content";
         public const string ConfigDeliveryApi = ConfigPrefix + "DeliveryApi";
         public const string ConfigCoreDebug = ConfigCorePrefix + "Debug";

src/Umbraco.Core/DependencyInjection/UmbracoBuilder.Configuration.cs

@@ -47,6 +47,7 @@ public static IUmbracoBuilder AddConfiguration(this IUmbracoBuilder builder)
         builder.Services.AddSingleton<IValidateOptions<RequestHandlerSettings>, RequestHandlerSettingsValidator>();
         builder.Services.AddSingleton<IValidateOptions<UnattendedSettings>, UnattendedSettingsValidator>();
         builder.Services.AddSingleton<IValidateOptions<SecuritySettings>, SecuritySettingsValidator>();
+        builder.Services.AddSingleton<IValidateOptions<SystemDateMigrationSettings>, SystemDateMigrationSettingsValidator>();
 
         // Register configuration sections.
         builder
@@ -86,7 +87,8 @@ public static IUmbracoBuilder AddConfiguration(this IUmbracoBuilder builder)
             .AddUmbracoOptions<HelpPageSettings>()
             .AddUmbracoOptions<DataTypesSettings>()
             .AddUmbracoOptions<WebhookSettings>()
-            .AddUmbracoOptions<CacheSettings>();
+            .AddUmbracoOptions<CacheSettings>()
+            .AddUmbracoOptions<SystemDateMigrationSettings>();
 
         // Configure connection string and ensure it's updated when the configuration changes
         builder.Services.AddSingleton<IConfigureOptions<ConnectionStrings>, ConfigureConnectionStrings>();

src/Umbraco.Core/Extensions/EntityFactoryDateTimeExtensions.cs

@@ -0,0 +1,30 @@
+namespace Umbraco.Cms.Core.Extensions;
+
+/// <summary>
+/// Provides extensions on <see cref="DateTime"/> purely when building entities from persistence DTOs.
+/// </summary>
+public static class EntityFactoryDateTimeExtensions
+{
+    /// <summary>
+    /// Ensures the provided DateTime is in UTC format.
+    /// </summary>
+    /// <remarks>
+    /// We need this in the particular cases of building entities from persistence DTOs. NPoco isn't consistent in what it returns
+    /// here across databases, sometimes providing a Kind of Unspecified. We are consistently persisting UTC for Umbraco's system
+    /// dates so we should enforce this Kind on the entity before exposing it further within the Umbraco application.
+    /// </remarks>
+    public static DateTime EnsureUtc(this DateTime dateTime)
+    {
+        if (dateTime.Kind == DateTimeKind.Utc)
+        {
+            return dateTime;
+        }
+
+        if (dateTime.Kind == DateTimeKind.Local)
+        {
+            return dateTime.ToUniversalTime();
+        }
+
+        return DateTime.SpecifyKind(dateTime, DateTimeKind.Utc);
+    }
+}

src/Umbraco.Core/Models/AuditEntry.cs

@@ -49,7 +49,7 @@ public string? PerformingIp
     }
 
     /// <inheritdoc />
-    public DateTime EventDateUtc
+    public DateTime EventDate
     {
         get => CreateDate;
         set => CreateDate = value;

src/Umbraco.Core/Models/ContentBase.cs

@@ -307,7 +307,7 @@ public void SetCultureName(string? name, string? culture)
             // set
             else if (GetCultureName(culture) != name)
             {
-                this.SetCultureInfo(culture!, name, DateTime.Now);
+                this.SetCultureInfo(culture!, name, DateTime.UtcNow);
             }
         }