Files
Umbraco-CMS/src/Umbraco.Web/Cache/DistributedCacheExtensions.cs

345 lines
12 KiB
C#
Raw Normal View History

2017-07-20 11:21:28 +02:00
using System;
using System.Linq;
using Umbraco.Core.Models;
using Umbraco.Core.Services.Changes;
namespace Umbraco.Web.Cache
{
/// <summary>
/// Extension methods for <see cref="DistributedCache"/>.
/// </summary>
internal static class DistributedCacheExtensions
{
#region PublicAccessCache
public static void RefreshPublicAccess(this DistributedCache dc)
{
dc.RefreshAll(PublicAccessCacheRefresher.UniqueId);
}
#endregion
#region ApplicationTreeCache
2013-04-04 21:57:41 +06:00
public static void RefreshAllApplicationTreeCache(this DistributedCache dc)
{
dc.RefreshAll(ApplicationTreeCacheRefresher.UniqueId);
2013-04-04 21:57:41 +06:00
}
2013-04-04 21:57:41 +06:00
#endregion
#region ApplicationCache
2013-04-04 21:57:41 +06:00
public static void RefreshAllApplicationCache(this DistributedCache dc)
{
dc.RefreshAll(ApplicationCacheRefresher.UniqueId);
2013-04-04 21:57:41 +06:00
}
2013-04-04 21:57:41 +06:00
#endregion
2017-09-08 19:39:13 +02:00
#region User cache
2017-09-08 19:39:13 +02:00
public static void RemoveUserCache(this DistributedCache dc, int userId)
{
2017-09-08 19:39:13 +02:00
dc.Remove(UserCacheRefresher.UniqueId, userId);
}
2017-09-08 19:39:13 +02:00
public static void RefreshUserCache(this DistributedCache dc, int userId)
{
2017-09-08 19:39:13 +02:00
dc.Refresh(UserCacheRefresher.UniqueId, userId);
}
2017-09-08 19:39:13 +02:00
public static void RefreshAllUserCache(this DistributedCache dc)
{
2017-09-08 19:39:13 +02:00
dc.RefreshAll(UserCacheRefresher.UniqueId);
}
#endregion
2017-09-08 19:39:13 +02:00
#region User group cache
2017-09-08 19:39:13 +02:00
public static void RemoveUserGroupCache(this DistributedCache dc, int userId)
{
2017-09-08 19:39:13 +02:00
dc.Remove(UserGroupCacheRefresher.UniqueId, userId);
}
2017-09-08 19:39:13 +02:00
public static void RefreshUserGroupCache(this DistributedCache dc, int userId)
{
2017-09-08 19:39:13 +02:00
dc.Refresh(UserGroupCacheRefresher.UniqueId, userId);
}
2017-09-08 19:39:13 +02:00
public static void RefreshAllUserGroupCache(this DistributedCache dc)
{
2017-09-08 19:39:13 +02:00
dc.RefreshAll(UserGroupCacheRefresher.UniqueId);
}
#endregion
2017-09-08 19:39:13 +02:00
#region User group permissions cache
2017-09-08 19:39:13 +02:00
public static void RemoveUserGroupPermissionsCache(this DistributedCache dc, int groupId)
{
2017-09-08 19:39:13 +02:00
dc.Remove(UserGroupPermissionsCacheRefresher.UniqueId, groupId);
}
2017-09-08 19:39:13 +02:00
public static void RefreshUserGroupPermissionsCache(this DistributedCache dc, int groupId)
{
2017-09-08 19:39:13 +02:00
//TODO: Not sure if we need this yet depends if we start caching permissions
//dc.Refresh(UserGroupPermissionsCacheRefresher.UniqueId, groupId);
}
2017-09-08 19:39:13 +02:00
public static void RefreshAllUserGroupPermissionsCache(this DistributedCache dc)
{
2017-09-08 19:39:13 +02:00
dc.RefreshAll(UserGroupPermissionsCacheRefresher.UniqueId);
}
#endregion
#region TemplateCache
public static void RefreshTemplateCache(this DistributedCache dc, int templateId)
{
dc.Refresh(TemplateCacheRefresher.UniqueId, templateId);
}
public static void RemoveTemplateCache(this DistributedCache dc, int templateId)
{
dc.Remove(TemplateCacheRefresher.UniqueId, templateId);
}
#endregion
#region DictionaryCache
public static void RefreshDictionaryCache(this DistributedCache dc, int dictionaryItemId)
{
dc.Refresh(DictionaryCacheRefresher.UniqueId, dictionaryItemId);
}
public static void RemoveDictionaryCache(this DistributedCache dc, int dictionaryItemId)
{
dc.Remove(DictionaryCacheRefresher.UniqueId, dictionaryItemId);
}
#endregion
#region DataTypeCache
public static void RefreshDataTypeCache(this DistributedCache dc, IDataType dataType)
{
if (dataType == null) return;
var payloads = new[] { new DataTypeCacheRefresher.JsonPayload(dataType.Id, dataType.Key, false) };
dc.RefreshByPayload(DataTypeCacheRefresher.UniqueId, payloads);
}
public static void RemoveDataTypeCache(this DistributedCache dc, IDataType dataType)
{
if (dataType == null) return;
var payloads = new[] { new DataTypeCacheRefresher.JsonPayload(dataType.Id, dataType.Key, true) };
dc.RefreshByPayload(DataTypeCacheRefresher.UniqueId, payloads);
}
#endregion
#region ContentCache
public static void RefreshAllContentCache(this DistributedCache dc)
{
var payloads = new[] { new ContentCacheRefresher.JsonPayload(0, TreeChangeTypes.RefreshAll) };
// note: refresh all content cache does refresh content types too
dc.RefreshByPayload(ContentCacheRefresher.UniqueId, payloads);
}
public static void RefreshContentCache(this DistributedCache dc, TreeChange<IContent>[] changes)
{
if (changes.Length == 0) return;
var payloads = changes
.Select(x => new ContentCacheRefresher.JsonPayload(x.Item.Id, x.ChangeTypes));
dc.RefreshByPayload(ContentCacheRefresher.UniqueId, payloads);
}
#endregion
#region MemberCache
public static void RefreshMemberCache(this DistributedCache dc, params IMember[] members)
{
dc.Refresh(MemberCacheRefresher.UniqueId, x => x.Id, members);
}
public static void RemoveMemberCache(this DistributedCache dc, params IMember[] members)
{
dc.Remove(MemberCacheRefresher.UniqueId, x => x.Id, members);
}
[Obsolete("Use the RefreshMemberCache with strongly typed IMember objects instead")]
public static void RefreshMemberCache(this DistributedCache dc, int memberId)
{
dc.Refresh(MemberCacheRefresher.UniqueId, memberId);
}
[Obsolete("Use the RemoveMemberCache with strongly typed IMember objects instead")]
public static void RemoveMemberCache(this DistributedCache dc, int memberId)
{
dc.Remove(MemberCacheRefresher.UniqueId, memberId);
}
#endregion
#region MemberGroupCache
public static void RefreshMemberGroupCache(this DistributedCache dc, int memberGroupId)
{
dc.Refresh(MemberGroupCacheRefresher.UniqueId, memberGroupId);
}
public static void RemoveMemberGroupCache(this DistributedCache dc, int memberGroupId)
{
dc.Remove(MemberGroupCacheRefresher.UniqueId, memberGroupId);
}
#endregion
#region MediaCache
public static void RefreshAllMediaCache(this DistributedCache dc)
{
var payloads = new[] { new MediaCacheRefresher.JsonPayload(0, TreeChangeTypes.RefreshAll) };
// note: refresh all media cache does refresh content types too
dc.RefreshByPayload(MediaCacheRefresher.UniqueId, payloads);
}
public static void RefreshMediaCache(this DistributedCache dc, TreeChange<IMedia>[] changes)
{
if (changes.Length == 0) return;
var payloads = changes
.Select(x => new MediaCacheRefresher.JsonPayload(x.Item.Id, x.ChangeTypes));
dc.RefreshByPayload(MediaCacheRefresher.UniqueId, payloads);
}
#endregion
2017-10-31 12:48:24 +01:00
#region Published Snapshot
2017-10-31 12:48:24 +01:00
public static void RefreshAllPublishedSnapshot(this DistributedCache dc)
{
// note: refresh all content & media caches does refresh content types too
dc.RefreshAllContentCache();
dc.RefreshAllMediaCache();
dc.RefreshAllDomainCache();
}
#endregion
#region MacroCache
public static void RefreshMacroCache(this DistributedCache dc, IMacro macro)
{
if (macro == null) return;
dc.RefreshByJson(MacroCacheRefresher.UniqueId, MacroCacheRefresher.Serialize(macro));
}
public static void RemoveMacroCache(this DistributedCache dc, IMacro macro)
{
if (macro == null) return;
dc.RefreshByJson(MacroCacheRefresher.UniqueId, MacroCacheRefresher.Serialize(macro));
}
#endregion
#region Content/Media/Member type cache
public static void RefreshContentTypeCache(this DistributedCache dc, ContentTypeChange<IContentType>[] changes)
{
if (changes.Length == 0) return;
var payloads = changes
.Select(x => new ContentTypeCacheRefresher.JsonPayload(typeof (IContentType).Name, x.Item.Id, x.ChangeTypes));
dc.RefreshByPayload(ContentTypeCacheRefresher.UniqueId, payloads);
}
public static void RefreshContentTypeCache(this DistributedCache dc, ContentTypeChange<IMediaType>[] changes)
{
if (changes.Length == 0) return;
var payloads = changes
.Select(x => new ContentTypeCacheRefresher.JsonPayload(typeof(IMediaType).Name, x.Item.Id, x.ChangeTypes));
dc.RefreshByPayload(ContentTypeCacheRefresher.UniqueId, payloads);
}
public static void RefreshContentTypeCache(this DistributedCache dc, ContentTypeChange<IMemberType>[] changes)
{
if (changes.Length == 0) return;
var payloads = changes
.Select(x => new ContentTypeCacheRefresher.JsonPayload(typeof(IMemberType).Name, x.Item.Id, x.ChangeTypes));
dc.RefreshByPayload(ContentTypeCacheRefresher.UniqueId, payloads);
}
#endregion
#region Domain Cache
public static void RefreshDomainCache(this DistributedCache dc, IDomain domain)
{
if (domain == null) return;
var payloads = new[] { new DomainCacheRefresher.JsonPayload(domain.Id, DomainChangeTypes.Refresh) };
dc.RefreshByPayload(DomainCacheRefresher.UniqueId, payloads);
}
public static void RemoveDomainCache(this DistributedCache dc, IDomain domain)
{
if (domain == null) return;
var payloads = new[] { new DomainCacheRefresher.JsonPayload(domain.Id, DomainChangeTypes.Remove) };
dc.RefreshByPayload(DomainCacheRefresher.UniqueId, payloads);
}
public static void RefreshAllDomainCache(this DistributedCache dc)
{
var payloads = new[] { new DomainCacheRefresher.JsonPayload(0, DomainChangeTypes.RefreshAll) };
dc.RefreshByPayload(DomainCacheRefresher.UniqueId, payloads);
}
#endregion
#region Language Cache
public static void RefreshLanguageCache(this DistributedCache dc, ILanguage language)
{
if (language == null) return;
dc.Refresh(LanguageCacheRefresher.UniqueId, language.Id);
}
public static void RemoveLanguageCache(this DistributedCache dc, ILanguage language)
{
if (language == null) return;
dc.Remove(LanguageCacheRefresher.UniqueId, language.Id);
}
#endregion
#region Relation type cache
public static void RefreshRelationTypeCache(this DistributedCache dc, int id)
{
dc.Refresh(RelationTypeCacheRefresher.UniqueId, id);
}
public static void RemoveRelationTypeCache(this DistributedCache dc, int id)
{
dc.Remove(RelationTypeCacheRefresher.UniqueId, id);
}
#endregion
}
2017-07-20 11:21:28 +02:00
}