Merge pull request #16652 from umbraco/v14/feature/merge-2024-06-25

Code changes from V13.4

Author: bergmania

src/Umbraco.Core/DeliveryApi/ApiMediaUrlProvider.cs

@@ -17,6 +17,6 @@ public string GetUrl(IPublishedContent media)
             throw new ArgumentException("Media URLs can only be generated from Media items.", nameof(media));
         }
 
-        return _publishedUrlProvider.GetMediaUrl(media, UrlMode.Relative);
+        return _publishedUrlProvider.GetMediaUrl(media);
     }
 }

src/Umbraco.Core/Routing/IPublishedRouter.cs

@@ -47,4 +47,37 @@ public interface IPublishedRouter
     ///     </para>
     /// </remarks>
     Task<IPublishedRequest> UpdateRequestAsync(IPublishedRequest request, IPublishedContent? publishedContent);
+
+    /// <summary>
+    /// Finds the site root (if any) matching the http request, and updates the PublishedRequest and VariationContext accordingly.
+    /// <remarks>
+    /// <para>
+    /// This method is used for VirtualPage routing.
+    /// </para>
+    /// <para>
+    /// In this case we do not want to run the entire routing pipeline since ContentFinders are not needed here.
+    /// However, we do want to set the culture on VariationContext and PublishedRequest to the values specified by the domains.
+    /// </para>
+    /// </remarks>
+    /// </summary>
+    /// <param name="request">The request to update the culture on domain on</param>
+    /// <returns>True if a domain was found otherwise false.</returns>
+    bool RouteDomain(IPublishedRequestBuilder request) => false;
+
+    /// <summary>
+    /// Finds the site root (if any) matching the http request, and updates the VariationContext accordingly.
+    /// </summary>
+    /// <remarks>
+    /// <para>
+    /// This is used for VirtualPage routing.
+    /// </para>
+    /// <para>
+    /// This is required to set the culture on VariationContext to the values specified by the domains, before the FindContent method is called.
+    /// In order to allow the FindContent implementer to correctly find content based off the culture. Before the PublishedRequest is built.
+    /// </para>
+    /// </remarks>
+    /// <param name="uri">The URI to resolve the domain from.</param>
+    /// <returns>True if a domain was found, otherwise false.</returns>
+    bool UpdateVariationContext(Uri uri) => false;
+
 }

src/Umbraco.Core/Routing/PublishedRouter.cs

@@ -108,7 +108,7 @@ public async Task<IPublishedRequest> RouteRequestAsync(
         // find domain
         if (builder.Domain == null)
         {
-            FindDomain(builder);
+            FindAndSetDomain(builder);
         }
 
         await RouteRequestInternalAsync(builder);
@@ -185,7 +185,7 @@ internal IPublishedRequest BuildRequest(IPublishedRequestBuilder builder)
 
     private async Task<IPublishedRequest> TryRouteRequest(IPublishedRequestBuilder request)
     {
-        FindDomain(request);
+        FindAndSetDomain(request);
 
         if (request.IsRedirect())
         {
@@ -270,18 +270,31 @@ private async Task RouteRequestInternalAsync(IPublishedRequestBuilder builder, b
         // to find out the appropriate template
     }
 
-    /// <summary>
-    ///     Finds the site root (if any) matching the http request, and updates the PublishedRequest accordingly.
-    /// </summary>
-    /// <returns>A value indicating whether a domain was found.</returns>
-    internal bool FindDomain(IPublishedRequestBuilder request)
+    /// <inheritdoc />
+    public bool RouteDomain(IPublishedRequestBuilder request)
+    {
+        var found = FindAndSetDomain(request);
+        HandleWildcardDomains(request);
+        SetVariationContext(request.Culture);
+        return found;
+    }
+
+    /// <inheritdoc />
+    public bool UpdateVariationContext(Uri uri)
+    {
+        DomainAndUri? domain = FindDomain(uri, out _);
+        SetVariationContext(domain?.Culture);
+        return domain?.Culture is not null;
+    }
+
+    private DomainAndUri? FindDomain(Uri uri, out string? defaultCulture)
     {
         const string tracePrefix = "FindDomain: ";
 
         // note - we are not handling schemes nor ports here.
         if (_logger.IsEnabled(LogLevel.Debug))
         {
-            _logger.LogDebug("{TracePrefix}Uri={RequestUri}", tracePrefix, request.Uri);
+            _logger.LogDebug("{TracePrefix}Uri={RequestUri}", tracePrefix, uri);
         }
 
         IUmbracoContext umbracoContext = _umbracoContextAccessor.GetRequiredUmbracoContext();
@@ -315,10 +328,20 @@ bool IsPublishedContentDomain(Domain domain)
 
         domains = domains?.Where(IsPublishedContentDomain).ToList();
 
-        var defaultCulture = domainsCache?.DefaultCulture;
+        defaultCulture = domainsCache?.DefaultCulture;
 
+        return DomainUtilities.SelectDomain(domains, uri, defaultCulture: defaultCulture);
+    }
+
+    /// <summary>
+    ///     Finds the site root (if any) matching the http request, and updates the PublishedRequest accordingly.
+    /// </summary>
+    /// <returns>A value indicating whether a domain was found.</returns>
+    internal bool FindAndSetDomain(IPublishedRequestBuilder request)
+    {
+        const string tracePrefix = "FindDomain: ";
         // try to find a domain matching the current request
-        DomainAndUri? domainAndUri = DomainUtilities.SelectDomain(domains, request.Uri, defaultCulture: defaultCulture);
+        DomainAndUri? domainAndUri = FindDomain(request.Uri, out var defaultCulture);
 
         // handle domain - always has a contentId and a culture
         if (domainAndUri != null)

src/Umbraco.Core/Services/ContentService.cs

@@ -1140,6 +1140,8 @@ public PublishResult Publish(IContent content, string[] cultures, int userId = C
             throw new ArgumentException("Cultures cannot be null or whitespace", nameof(cultures));
         }
 
+        EventMessages evtMsgs = EventMessagesFactory.Get();
+
         // we need to guard against unsaved changes before proceeding; the content will be saved, but we're not firing any saved notifications
         if (HasUnsavedChanges(content))
         {
@@ -1186,8 +1188,6 @@ public PublishResult Publish(IContent content, string[] cultures, int userId = C
 
             var allLangs = _languageRepository.GetMany().ToList();
 
-            EventMessages evtMsgs = EventMessagesFactory.Get();
-
             // this will create the correct culture impact even if culture is * or null
             IEnumerable<CultureImpact?> impacts =
                 cultures.Select(culture => _cultureImpactFactory.Create(culture, IsDefaultCulture(allLangs, culture), content));
@@ -1199,7 +1199,15 @@ public PublishResult Publish(IContent content, string[] cultures, int userId = C
                 content.PublishCulture(impact);
             }
 
-            PublishResult result = CommitDocumentChangesInternal(scope, content, evtMsgs, allLangs, userId, out _);
+            // Change state to publishing
+            content.PublishedState = PublishedState.Publishing;
+            var publishingNotification = new ContentPublishingNotification(content, evtMsgs);
+            if (scope.Notifications.PublishCancelable(publishingNotification))
+            {
+                return new PublishResult(PublishResultType.FailedPublishCancelledByEvent, evtMsgs, content);
+            }
+
+            PublishResult result = CommitDocumentChangesInternal(scope, content, evtMsgs, allLangs, publishingNotification.State, userId);
             scope.Complete();
             return result;
         }
@@ -1254,6 +1262,12 @@ public PublishResult Unpublish(IContent content, string? culture = "*", int user
 
             var allLangs = _languageRepository.GetMany().ToList();
 
+            var savingNotification = new ContentSavingNotification(content, evtMsgs);
+            if (scope.Notifications.PublishCancelable(savingNotification))
+            {
+                return new PublishResult(PublishResultType.FailedPublishCancelledByEvent, evtMsgs, content);
+            }
+
             // all cultures = unpublish whole
             if (culture == "*" || (!content.ContentType.VariesByCulture() && culture == null))
             {
@@ -1262,7 +1276,7 @@ public PublishResult Unpublish(IContent content, string? culture = "*", int user
                 // We are however unpublishing all cultures, so we will set this to unpublishing.
                 content.UnpublishCulture(culture);
                 content.PublishedState = PublishedState.Unpublishing;
-                PublishResult result = CommitDocumentChangesInternal(scope, content, evtMsgs, allLangs, userId, out _);
+                PublishResult result = CommitDocumentChangesInternal(scope, content, evtMsgs, allLangs, savingNotification.State, userId);
                 scope.Complete();
                 return result;
             }
@@ -1276,7 +1290,7 @@ public PublishResult Unpublish(IContent content, string? culture = "*", int user
                 var removed = content.UnpublishCulture(culture);
 
                 // Save and publish any changes
-                PublishResult result = CommitDocumentChangesInternal(scope, content, evtMsgs, allLangs, userId, out _);
+                PublishResult result = CommitDocumentChangesInternal(scope, content, evtMsgs, allLangs, savingNotification.State, userId);
 
                 scope.Complete();
 
@@ -1327,9 +1341,15 @@ internal PublishResult CommitDocumentChanges(IContent content, int userId = Cons
 
             scope.WriteLock(Constants.Locks.ContentTree);
 
+            var savingNotification = new ContentSavingNotification(content, evtMsgs);
+            if (scope.Notifications.PublishCancelable(savingNotification))
+            {
+                return new PublishResult(PublishResultType.FailedPublishCancelledByEvent, evtMsgs, content);
+            }
+
             var allLangs = _languageRepository.GetMany().ToList();
 
-            PublishResult result = CommitDocumentChangesInternal(scope, content, evtMsgs, allLangs, userId, out _);
+            PublishResult result = CommitDocumentChangesInternal(scope, content, evtMsgs, allLangs, savingNotification.State, userId);
             scope.Complete();
             return result;
         }
@@ -1359,8 +1379,8 @@ private PublishResult CommitDocumentChangesInternal(
         IContent content,
         EventMessages eventMessages,
         IReadOnlyCollection<ILanguage> allLangs,
+        IDictionary<string, object?>? notificationState,
         int userId,
-        out IDictionary<string, object?>? initialNotificationState,
         bool branchOne = false,
         bool branchRoot = false)
     {
@@ -1422,7 +1442,6 @@ void SaveDocument(IContent c)
             _documentRepository.Save(c);
         }
 
-        initialNotificationState = null;
         if (publishing)
         {
             // Determine cultures publishing/unpublishing which will be based on previous calls to content.PublishCulture and ClearPublishInfo
@@ -1440,9 +1459,18 @@ void SaveDocument(IContent c)
                 culturesUnpublishing,
                 eventMessages,
                 allLangs,
-                out initialNotificationState);
+                notificationState);
+
             if (publishResult.Success)
             {
+                // raise Publishing notification
+                if (scope.Notifications.PublishCancelable(
+                        new ContentPublishingNotification(content, eventMessages).WithState(notificationState)))
+                {
+                    _logger.LogInformation("Document {ContentName} (id={ContentId}) cannot be published: {Reason}", content.Name, content.Id, "publishing was cancelled");
+                    return new PublishResult(PublishResultType.FailedPublishCancelledByEvent, eventMessages, content);
+                }
+
                 // note: StrategyPublish flips the PublishedState to Publishing!
                 publishResult = StrategyPublish(content, culturesPublishing, culturesUnpublishing, eventMessages);
 
@@ -1503,7 +1531,7 @@ void SaveDocument(IContent c)
                 // handling events, business rules, etc
                 // note: StrategyUnpublish flips the PublishedState to Unpublishing!
                 // note: This unpublishes the entire document (not different variants)
-                unpublishResult = StrategyCanUnpublish(scope, content, eventMessages, out initialNotificationState);
+                unpublishResult = StrategyCanUnpublish(scope, content, eventMessages, notificationState);
                 if (unpublishResult.Success)
                 {
                     unpublishResult = StrategyUnpublish(content, eventMessages);
@@ -1539,7 +1567,7 @@ void SaveDocument(IContent c)
             {
                 // events and audit
                 scope.Notifications.Publish(
-                    new ContentUnpublishedNotification(content, eventMessages).WithState(initialNotificationState));
+                    new ContentUnpublishedNotification(content, eventMessages).WithState(notificationState));
                 scope.Notifications.Publish(new ContentTreeChangeNotification(content, TreeChangeTypes.RefreshBranch, eventMessages));
 
                 if (culturesUnpublishing != null)
@@ -1601,7 +1629,7 @@ void SaveDocument(IContent c)
                     scope.Notifications.Publish(
                         new ContentTreeChangeNotification(content, changeType, eventMessages));
                     scope.Notifications.Publish(
-                        new ContentPublishedNotification(content, eventMessages).WithState(initialNotificationState));
+                        new ContentPublishedNotification(content, eventMessages).WithState(notificationState));
                 }
 
                 // it was not published and now is... descendants that were 'published' (but
@@ -1611,7 +1639,7 @@ void SaveDocument(IContent c)
                 {
                     IContent[] descendants = GetPublishedDescendantsLocked(content).ToArray();
                     scope.Notifications.Publish(
-                        new ContentPublishedNotification(descendants, eventMessages).WithState(initialNotificationState));
+                        new ContentPublishedNotification(descendants, eventMessages).WithState(notificationState));
                 }
 
                 switch (publishResult.Result)
@@ -1711,6 +1739,13 @@ private void PerformScheduledPublishingExpiration(DateTime date, List<PublishRes
                         continue; // shouldn't happen but no point in processing this document if there's nothing there
                     }
 
+                    var savingNotification = new ContentSavingNotification(d, evtMsgs);
+                    if (scope.Notifications.PublishCancelable(savingNotification))
+                    {
+                        results.Add(new PublishResult(PublishResultType.FailedPublishCancelledByEvent, evtMsgs, d));
+                        continue;
+                    }
+
                     foreach (var c in pendingCultures)
                     {
                         // Clear this schedule for this culture
@@ -1721,7 +1756,7 @@ private void PerformScheduledPublishingExpiration(DateTime date, List<PublishRes
                     }
 
                     _documentRepository.PersistContentSchedule(d, contentSchedule);
-                    PublishResult result = CommitDocumentChangesInternal(scope, d, evtMsgs, allLangs.Value, d.WriterId, out _);
+                    PublishResult result = CommitDocumentChangesInternal(scope, d, evtMsgs, allLangs.Value, savingNotification.State, d.WriterId);
                     if (result.Success == false)
                     {
                         _logger.LogError(null, "Failed to publish document id={DocumentId}, reason={Reason}.", d.Id, result.Result);
@@ -1775,6 +1810,13 @@ private void PerformScheduledPublishingRelease(DateTime date, List<PublishResult
                     {
                         continue; // shouldn't happen but no point in processing this document if there's nothing there
                     }
+                    var savingNotification = new ContentSavingNotification(d, evtMsgs);
+                    if (scope.Notifications.PublishCancelable(savingNotification))
+                    {
+                        results.Add(new PublishResult(PublishResultType.FailedPublishCancelledByEvent, evtMsgs, d));
+                        continue;
+                    }
+
 
                     var publishing = true;
                     foreach (var culture in pendingCultures)
@@ -1820,7 +1862,7 @@ private void PerformScheduledPublishingRelease(DateTime date, List<PublishResult
                     else
                     {
                         _documentRepository.PersistContentSchedule(d, contentSchedule);
-                        result = CommitDocumentChangesInternal(scope, d, evtMsgs, allLangs.Value, d.WriterId, out _);
+                        result = CommitDocumentChangesInternal(scope, d, evtMsgs, allLangs.Value, savingNotification.State, d.WriterId);
                     }
 
                     if (result.Success == false)
@@ -2162,14 +2204,20 @@ internal IEnumerable<PublishResult> PublishBranch(
             return new PublishResult(PublishResultType.SuccessPublishAlready, evtMsgs, document);
         }
 
+        var savingNotification = new ContentSavingNotification(document, evtMsgs);
+        if (scope.Notifications.PublishCancelable(savingNotification))
+        {
+            return new PublishResult(PublishResultType.FailedPublishCancelledByEvent, evtMsgs, document);
+        }
+
         // publish & check if values are valid
         if (!publishCultures(document, culturesToPublish, allLangs))
         {
             // TODO: Based on this callback behavior there is no way to know which properties may have been invalid if this failed, see other results of FailedPublishContentInvalid
             return new PublishResult(PublishResultType.FailedPublishContentInvalid, evtMsgs, document);
         }
 
-        PublishResult result = CommitDocumentChangesInternal(scope, document, evtMsgs, allLangs, userId, out initialNotificationState, true, isRoot);
+        PublishResult result = CommitDocumentChangesInternal(scope, document, evtMsgs, allLangs, savingNotification.State, userId, true, isRoot);
         if (result.Success)
         {
             publishedDocuments.Add(document);
@@ -3018,19 +3066,8 @@ private PublishResult StrategyCanPublish(
         IReadOnlyCollection<string>? culturesUnpublishing,
         EventMessages evtMsgs,
         IReadOnlyCollection<ILanguage> allLangs,
-        out IDictionary<string, object?>? initialNotificationState)
+        IDictionary<string, object?>? notificationState)
     {
-        // raise Publishing notification
-        var notification = new ContentPublishingNotification(content, evtMsgs);
-        var notificationResult = scope.Notifications.PublishCancelable(notification);
-        initialNotificationState = notification.State;
-
-        if (notificationResult)
-        {
-            _logger.LogInformation("Document {ContentName} (id={ContentId}) cannot be published: {Reason}", content.Name, content.Id, "publishing was cancelled");
-            return new PublishResult(PublishResultType.FailedPublishCancelledByEvent, evtMsgs, content);
-        }
-
         var variesByCulture = content.ContentType.VariesByCulture();
 
         // If it's null it's invariant
@@ -3268,12 +3305,11 @@ private PublishResult StrategyCanUnpublish(
         ICoreScope scope,
         IContent content,
         EventMessages evtMsgs,
-        out IDictionary<string, object?>? initialNotificationState)
+        IDictionary<string, object?>? notificationState)
     {
         // raise Unpublishing notification
-        var notification = new ContentUnpublishingNotification(content, evtMsgs);
+        var notification = new ContentUnpublishingNotification(content, evtMsgs).WithState(notificationState);
         var notificationResult = scope.Notifications.PublishCancelable(notification);
-        initialNotificationState = notification.State;
 
         if (notificationResult)
         {