Created
April 19, 2018 08:00
-
-
Save MatteoPiovanelli-Laser/f729fa0f5cb0db53a108ff4d1da8a301 to your computer and use it in GitHub Desktop.
AutoroutePartHandler using ILockingProvider to reduce the chance of deadlock, while keeping DisplayAlias values unique for published content
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
using System; | |
using Orchard.Autoroute.Models; | |
using Orchard.Autoroute.Services; | |
using Orchard.ContentManagement; | |
using Orchard.ContentManagement.Handlers; | |
using Orchard.Data; | |
using Orchard.Localization; | |
using Orchard.Locking; | |
using Orchard.UI.Notify; | |
namespace Orchard.Autoroute.Handlers { | |
public class AutoroutePartHandler : ContentHandler { | |
private readonly Lazy<IAutorouteService> _autorouteService; | |
private readonly IOrchardServices _orchardServices; | |
private readonly IHomeAliasService _homeAliasService; | |
private readonly ILockingProvider _lockingProvider; | |
public Localizer T { get; set; } | |
public AutoroutePartHandler( | |
IRepository<AutoroutePartRecord> autoroutePartRepository, | |
Lazy<IAutorouteService> autorouteService, | |
IOrchardServices orchardServices, | |
IHomeAliasService homeAliasService, | |
ILockingProvider lockingProvider) { | |
Filters.Add(StorageFilter.For(autoroutePartRepository)); | |
_autorouteService = autorouteService; | |
_orchardServices = orchardServices; | |
_homeAliasService = homeAliasService; | |
_lockingProvider = lockingProvider; | |
OnUpdated<AutoroutePart>((ctx, part) => CreateAlias(part)); | |
OnCreated<AutoroutePart>((ctx, part) => { | |
// non-draftable items | |
if (part.ContentItem.VersionRecord == null) { | |
PublishAlias(part); | |
} | |
}); | |
OnPublished<AutoroutePart>((ctx, part) => PublishAlias(part)); | |
// Remove alias if destroyed, removed or unpublished | |
OnRemoving<AutoroutePart>((ctx, part) => RemoveAlias(part)); | |
OnDestroyed<AutoroutePart>((ctx, part) => RemoveAlias(part)); | |
OnUnpublished<AutoroutePart>((ctx, part) => RemoveAlias(part)); | |
// Register alias as identity | |
OnGetContentItemMetadata<AutoroutePart>((ctx, part) => { | |
if (part.DisplayAlias != null) | |
ctx.Metadata.Identity.Add("alias", part.DisplayAlias); | |
}); | |
} | |
private void CreateAlias(AutoroutePart part) { | |
ProcessAlias(part); | |
} | |
private string LockString { | |
get { | |
return string.Join(".", | |
_orchardServices.WorkContext?.CurrentSite?.BaseUrl ?? "", | |
_orchardServices.WorkContext?.CurrentSite?.SiteName ?? "", | |
"AutoroutePartHandler"); | |
} | |
} | |
private void PublishAlias(AutoroutePart part) { | |
ProcessAlias(part); | |
// Should it become the home page? | |
if (part.PromoteToHomePage) { | |
// Get the current homepage an unmark it as the homepage. | |
var currentHomePageId = _homeAliasService.GetHomePageId(); | |
if(currentHomePageId != part.Id) { | |
var autoroutePart = part.As<AutoroutePart>(); | |
if (autoroutePart != null) { | |
autoroutePart.PromoteToHomePage = false; | |
if(autoroutePart.IsPublished()) | |
_orchardServices.ContentManager.Publish(autoroutePart.ContentItem); | |
} | |
} | |
// Update the home alias to point to this item being published. | |
_homeAliasService.PublishHomeAlias(part); | |
} | |
_lockingProvider.Lock(LockString, | |
() => { _autorouteService.Value.PublishAlias(part); }); | |
} | |
private void ProcessAlias(AutoroutePart part) { | |
LocalizedString message = null; | |
// Generate an alias if one has not already been entered. | |
if (String.IsNullOrWhiteSpace(part.DisplayAlias)) { | |
part.DisplayAlias = _autorouteService.Value.GenerateAlias(part); | |
} | |
_lockingProvider.Lock(LockString, | |
() => { | |
// Lock this portion of the code to prevent race conditions where we are reading the aliases to compute | |
// stuff for a content, while another content is publishing. | |
// If the generated alias is empty, compute a new one. | |
if (String.IsNullOrWhiteSpace(part.DisplayAlias)) { | |
_autorouteService.Value.ProcessPath(part); | |
message = T("The permalink could not be generated, a new slug has been defined: \"{0}\"", part.Path); | |
return; | |
} | |
// Check for permalink conflict, unless we are trying to set the home page. | |
var previous = part.Path; | |
if (!_autorouteService.Value.ProcessPath(part)) | |
message = | |
T("Permalinks in conflict. \"{0}\" is already set for a previously created {2} so now it has the slug \"{1}\"", | |
previous, part.Path, part.ContentItem.ContentType); | |
}); | |
if (message != null) { | |
_orchardServices.Notifier.Warning(message); | |
} | |
} | |
void RemoveAlias(AutoroutePart part) { | |
var homePageId = _homeAliasService.GetHomePageId(); | |
// Is this the current home page? | |
if (part.ContentItem.Id == homePageId) { | |
_orchardServices.Notifier.Warning(T("You removed the content item that served as the site's home page. \nMost possibly this means that instead of the home page a \"404 Not Found\" page will be displayed. \n\nTo prevent this you can e.g. publish a content item that has the \"Set as home page\" checkbox ticked.")); | |
} | |
_lockingProvider.Lock(LockString, | |
() => { _autorouteService.Value.RemoveAliases(part); }); | |
} | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment