using Microsoft.Extensions.Logging;
using Umbraco.Cms.Core.Events;
using Umbraco.Cms.Core.Models;
using Umbraco.Cms.Core.Models.Membership;
using Umbraco.Cms.Core.Notifications;
using Umbraco.Cms.Core.Persistence;
using Umbraco.Cms.Core.Persistence.Querying;
using Umbraco.Cms.Core.Persistence.Repositories;
using Umbraco.Cms.Core.Scoping;
using Umbraco.Extensions;
namespace Umbraco.Cms.Core.Services
{
///
/// Represents the MemberService.
///
public class MemberService : RepositoryService, IMemberService
{
private readonly IMemberRepository _memberRepository;
private readonly IMemberTypeRepository _memberTypeRepository;
private readonly IMemberGroupRepository _memberGroupRepository;
private readonly IAuditRepository _auditRepository;
private readonly IMemberGroupService _memberGroupService;
#region Constructor
public MemberService(
ICoreScopeProvider provider,
ILoggerFactory loggerFactory,
IEventMessagesFactory eventMessagesFactory,
IMemberGroupService memberGroupService,
IMemberRepository memberRepository,
IMemberTypeRepository memberTypeRepository,
IMemberGroupRepository memberGroupRepository,
IAuditRepository auditRepository)
: base(provider, loggerFactory, eventMessagesFactory)
{
_memberRepository = memberRepository;
_memberTypeRepository = memberTypeRepository;
_memberGroupRepository = memberGroupRepository;
_auditRepository = auditRepository;
_memberGroupService = memberGroupService ?? throw new ArgumentNullException(nameof(memberGroupService));
}
#endregion
#region Count
///
/// Gets the total number of Members based on the count type
///
///
/// The way the Online count is done is the same way that it is done in the MS SqlMembershipProvider - We query for any members
/// that have their last active date within the Membership.UserIsOnlineTimeWindow (which is in minutes). It isn't exact science
/// but that is how MS have made theirs so we'll follow that principal.
///
/// to count by
/// with number of Members for passed in type
public int GetCount(MemberCountType countType)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
IQuery? query;
switch (countType)
{
case MemberCountType.All:
query = Query();
break;
case MemberCountType.LockedOut:
query = Query()?.Where(x => x.IsLockedOut == true);
break;
case MemberCountType.Approved:
query = Query()?.Where(x => x.IsApproved == true);
break;
default:
throw new ArgumentOutOfRangeException(nameof(countType));
}
return _memberRepository.GetCountByQuery(query);
}
///
/// Gets the count of Members by an optional MemberType alias
///
/// If no alias is supplied then the count for all Member will be returned
/// Optional alias for the MemberType when counting number of Members
/// with number of Members
public int Count(string? memberTypeAlias = null)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
return _memberRepository.Count(memberTypeAlias);
}
#endregion
#region Create
///
/// Creates an object without persisting it
///
/// This method is convenient for when you need to add properties to a new Member
/// before persisting it in order to limit the amount of times its saved.
/// Also note that the returned will not have an Id until its saved.
/// Username of the Member to create
/// Email of the Member to create
/// Name of the Member to create
/// Alias of the MemberType the Member should be based on
/// Thrown when a member type for the given alias isn't found
///
public IMember CreateMember(string username, string email, string name, string memberTypeAlias)
{
IMemberType memberType = GetMemberType(memberTypeAlias);
if (memberType == null)
{
throw new ArgumentException("No member type with that alias.", nameof(memberTypeAlias));
}
var member = new Member(name, email.ToLower().Trim(), username, memberType, 0);
return member;
}
///
/// Creates an object without persisting it
///
/// This method is convenient for when you need to add properties to a new Member
/// before persisting it in order to limit the amount of times its saved.
/// Also note that the returned will not have an Id until its saved.
/// Username of the Member to create
/// Email of the Member to create
/// Name of the Member to create
/// MemberType the Member should be based on
///
public IMember CreateMember(string username, string email, string name, IMemberType memberType)
{
if (memberType == null)
{
throw new ArgumentNullException(nameof(memberType));
}
var member = new Member(name, email.ToLower().Trim(), username, memberType, 0);
return member;
}
///
/// Creates and persists a new
///
/// An can be of type or
/// Username of the to create
/// Email of the to create
/// This value should be the encoded/encrypted/hashed value for the password that will be stored in the database
/// Alias of the Type
/// Is the member approved
///
IMember IMembershipMemberService.CreateWithIdentity(string username, string email, string passwordValue, string memberTypeAlias)
=> CreateMemberWithIdentity(username, email, username, passwordValue, memberTypeAlias);
///
/// Creates and persists a new
///
/// An can be of type or
/// Username of the to create
/// Email of the to create
/// This value should be the encoded/encrypted/hashed value for the password that will be stored in the database
/// Alias of the Type
///
///
IMember IMembershipMemberService.CreateWithIdentity(string username, string email, string passwordValue, string memberTypeAlias, bool isApproved)
=> CreateMemberWithIdentity(username, email, username, passwordValue, memberTypeAlias, isApproved);
public IMember CreateMemberWithIdentity(string username, string email, string memberTypeAlias)
=> CreateMemberWithIdentity(username, email, username, string.Empty, memberTypeAlias);
public IMember CreateMemberWithIdentity(string username, string email, string memberTypeAlias, bool isApproved)
=> CreateMemberWithIdentity(username, email, string.Empty, string.Empty, memberTypeAlias, isApproved);
public IMember CreateMemberWithIdentity(string username, string email, string name, string memberTypeAlias)
=> CreateMemberWithIdentity(username, email, name, string.Empty, memberTypeAlias);
public IMember CreateMemberWithIdentity(string username, string email, string name, string memberTypeAlias, bool isApproved)
=> CreateMemberWithIdentity(username, email, name, string.Empty, memberTypeAlias, isApproved);
///
/// Creates and persists a Member
///
/// Using this method will persist the Member object before its returned
/// meaning that it will have an Id available (unlike the CreateMember method)
/// Username of the Member to create
/// Email of the Member to create
/// Name of the Member to create
/// Alias of the MemberType the Member should be based on
/// Optional IsApproved of the Member to create
///
public IMember CreateMemberWithIdentity(string username, string email, string name, string passwordValue, string memberTypeAlias, bool isApproved = true)
{
using (ICoreScope scope = ScopeProvider.CreateCoreScope())
{
// locking the member tree secures member types too
scope.WriteLock(Constants.Locks.MemberTree);
IMemberType memberType = GetMemberType(scope, memberTypeAlias); // + locks // + locks
if (memberType == null)
{
throw new ArgumentException("No member type with that alias.", nameof(memberTypeAlias)); // causes rollback // causes rollback
}
var member = new Member(name, email.ToLower().Trim(), username, passwordValue, memberType, isApproved, -1);
Save(member);
scope.Complete();
return member;
}
}
public IMember CreateMemberWithIdentity(string username, string email, IMemberType memberType)
=> CreateMemberWithIdentity(username, email, username, string.Empty, memberType);
///
/// Creates and persists a Member
///
/// Using this method will persist the Member object before its returned
/// meaning that it will have an Id available (unlike the CreateMember method)
/// Username of the Member to create
/// Email of the Member to create
/// MemberType the Member should be based on
///
public IMember CreateMemberWithIdentity(string username, string email, IMemberType memberType, bool isApproved)
=> CreateMemberWithIdentity(username, email, username, string.Empty, memberType, isApproved);
public IMember CreateMemberWithIdentity(string username, string email, string name, IMemberType memberType)
=> CreateMemberWithIdentity(username, email, name, string.Empty, memberType);
///
/// Creates and persists a Member
///
/// Using this method will persist the Member object before its returned
/// meaning that it will have an Id available (unlike the CreateMember method)
/// Username of the Member to create
/// Email of the Member to create
/// Name of the Member to create
/// MemberType the Member should be based on
///
public IMember CreateMemberWithIdentity(string username, string email, string name, IMemberType memberType, bool isApproved)
=> CreateMemberWithIdentity(username, email, name, string.Empty, memberType, isApproved);
///
/// Creates and persists a Member
///
/// Using this method will persist the Member object before its returned
/// meaning that it will have an Id available (unlike the CreateMember method)
/// Username of the Member to create
/// Email of the Member to create
/// Name of the Member to create
/// This value should be the encoded/encrypted/hashed value for the password that will be stored in the database
/// MemberType the Member should be based on
///
private IMember CreateMemberWithIdentity(string username, string email, string name, string passwordValue, IMemberType memberType, bool isApproved = true)
{
if (memberType == null)
{
throw new ArgumentNullException(nameof(memberType));
}
using ICoreScope scope = ScopeProvider.CreateCoreScope();
scope.WriteLock(Constants.Locks.MemberTree);
// ensure it all still make sense
// ensure it all still make sense
IMemberType? vrfy = GetMemberType(scope, memberType.Alias); // + locks
if (vrfy == null || vrfy.Id != memberType.Id)
{
throw new ArgumentException($"Member type with alias {memberType.Alias} does not exist or is a different member type."); // causes rollback
}
var member = new Member(name, email.ToLower().Trim(), username, passwordValue, memberType, isApproved, -1);
Save(member);
scope.Complete();
return member;
}
#endregion
#region Get, Has, Is, Exists...
///
/// Gets a Member by its integer id
///
/// Id
///
public IMember? GetById(int id)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
return _memberRepository.Get(id);
}
///
/// Gets a Member by the unique key
///
/// The guid key corresponds to the unique id in the database
/// and the user id in the membership provider.
/// Id
///
public IMember? GetByKey(Guid id)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
IQuery query = Query().Where(x => x.Key == id);
return _memberRepository.Get(query)?.FirstOrDefault();
}
///
/// Gets a list of paged objects
///
/// Current page index
/// Size of the page
/// Total number of records found (out)
///
public IEnumerable GetAll(long pageIndex, int pageSize, out long totalRecords)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
return _memberRepository.GetPage(null, pageIndex, pageSize, out totalRecords, null, Ordering.By("LoginName"));
}
public IEnumerable GetAll(
long pageIndex,
int pageSize,
out long totalRecords,
string orderBy,
Direction orderDirection,
string? memberTypeAlias = null,
string filter = "") =>
GetAll(pageIndex, pageSize, out totalRecords, orderBy, orderDirection, true, memberTypeAlias, filter);
public IEnumerable GetAll(
long pageIndex,
int pageSize,
out long totalRecords,
string orderBy,
Direction orderDirection,
bool orderBySystemField,
string? memberTypeAlias,
string filter)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
IQuery? query1 = memberTypeAlias == null ? null : Query()?.Where(x => x.ContentTypeAlias == memberTypeAlias);
IQuery? query2 = filter == null ? null : Query()?.Where(x => (x.Name != null && x.Name.Contains(filter)) || x.Username.Contains(filter) || x.Email.Contains(filter));
return _memberRepository.GetPage(query1, pageIndex, pageSize, out totalRecords, query2, Ordering.By(orderBy, orderDirection, isCustomField: !orderBySystemField));
}
///
/// Gets an by its provider key
///
/// Id to use for retrieval
///
public IMember? GetByProviderKey(object id)
{
Attempt asGuid = id.TryConvertTo();
if (asGuid.Success)
{
return GetByKey(asGuid.Result);
}
Attempt asInt = id.TryConvertTo();
if (asInt.Success)
{
return GetById(asInt.Result);
}
return null;
}
///
/// Get an by email
///
/// Email to use for retrieval
///
public IMember? GetByEmail(string email)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
IQuery query = Query().Where(x => x.Email.Equals(email));
return _memberRepository.Get(query)?.FirstOrDefault();
}
///
/// Get an by username
///
/// Username to use for retrieval
///
public IMember? GetByUsername(string? username)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
return _memberRepository.GetByUsername(username);
}
///
/// Gets all Members for the specified MemberType alias
///
/// Alias of the MemberType
///
public IEnumerable GetMembersByMemberType(string memberTypeAlias)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
IQuery query = Query().Where(x => x.ContentTypeAlias == memberTypeAlias);
return _memberRepository.Get(query);
}
///
/// Gets all Members for the MemberType id
///
/// Id of the MemberType
///
public IEnumerable GetMembersByMemberType(int memberTypeId)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
IQuery query = Query().Where(x => x.ContentTypeId == memberTypeId);
return _memberRepository.Get(query);
}
///
/// Gets all Members within the specified MemberGroup name
///
/// Name of the MemberGroup
///
public IEnumerable GetMembersByGroup(string memberGroupName)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
return _memberRepository.GetByMemberGroup(memberGroupName);
}
///
/// Gets all Members with the ids specified
///
/// If no Ids are specified all Members will be retrieved
/// Optional list of Member Ids
///
public IEnumerable GetAllMembers(params int[] ids)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
return _memberRepository.GetMany(ids);
}
///
/// Finds Members based on their display name
///
/// Display name to match
/// Current page index
/// Size of the page
/// Total number of records found (out)
/// The type of match to make as . Default is
///
public IEnumerable FindMembersByDisplayName(string displayNameToMatch, long pageIndex, int pageSize, out long totalRecords, StringPropertyMatchType matchType = StringPropertyMatchType.StartsWith)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
IQuery? query = Query();
switch (matchType)
{
case StringPropertyMatchType.Exact:
query?.Where(member => string.Equals(member.Name, displayNameToMatch));
break;
case StringPropertyMatchType.Contains:
query?.Where(member => member.Name != null && member.Name.Contains(displayNameToMatch));
break;
case StringPropertyMatchType.StartsWith:
query?.Where(member => member.Name != null && member.Name.StartsWith(displayNameToMatch));
break;
case StringPropertyMatchType.EndsWith:
query?.Where(member => member.Name != null && member.Name.EndsWith(displayNameToMatch));
break;
case StringPropertyMatchType.Wildcard:
query?.Where(member => member.Name != null && member.Name.SqlWildcard(displayNameToMatch, TextColumnType.NVarchar));
break;
default:
throw new ArgumentOutOfRangeException(nameof(matchType)); // causes rollback // causes rollback
}
return _memberRepository.GetPage(query, pageIndex, pageSize, out totalRecords, null, Ordering.By("Name"));
}
///
/// Finds a list of objects by a partial email string
///
/// Partial email string to match
/// Current page index
/// Size of the page
/// Total number of records found (out)
/// The type of match to make as . Default is
///
public IEnumerable FindByEmail(string emailStringToMatch, long pageIndex, int pageSize, out long totalRecords, StringPropertyMatchType matchType = StringPropertyMatchType.StartsWith)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
IQuery? query = Query();
switch (matchType)
{
case StringPropertyMatchType.Exact:
query?.Where(member => member.Email.Equals(emailStringToMatch));
break;
case StringPropertyMatchType.Contains:
query?.Where(member => member.Email.Contains(emailStringToMatch));
break;
case StringPropertyMatchType.StartsWith:
query?.Where(member => member.Email.StartsWith(emailStringToMatch));
break;
case StringPropertyMatchType.EndsWith:
query?.Where(member => member.Email.EndsWith(emailStringToMatch));
break;
case StringPropertyMatchType.Wildcard:
query?.Where(member => member.Email.SqlWildcard(emailStringToMatch, TextColumnType.NVarchar));
break;
default:
throw new ArgumentOutOfRangeException(nameof(matchType));
}
return _memberRepository.GetPage(query, pageIndex, pageSize, out totalRecords, null, Ordering.By("Email"));
}
///
/// Finds a list of objects by a partial username
///
/// Partial username to match
/// Current page index
/// Size of the page
/// Total number of records found (out)
/// The type of match to make as . Default is
///
public IEnumerable FindByUsername(string login, long pageIndex, int pageSize, out long totalRecords, StringPropertyMatchType matchType = StringPropertyMatchType.StartsWith)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
IQuery? query = Query();
switch (matchType)
{
case StringPropertyMatchType.Exact:
query?.Where(member => member.Username.Equals(login));
break;
case StringPropertyMatchType.Contains:
query?.Where(member => member.Username.Contains(login));
break;
case StringPropertyMatchType.StartsWith:
query?.Where(member => member.Username.StartsWith(login));
break;
case StringPropertyMatchType.EndsWith:
query?.Where(member => member.Username.EndsWith(login));
break;
case StringPropertyMatchType.Wildcard:
query?.Where(member => member.Username.SqlWildcard(login, TextColumnType.NVarchar));
break;
default:
throw new ArgumentOutOfRangeException(nameof(matchType));
}
return _memberRepository.GetPage(query, pageIndex, pageSize, out totalRecords, null, Ordering.By("LoginName"));
}
///
/// Gets a list of Members based on a property search
///
/// Alias of the PropertyType to search for
/// Value to match
/// The type of match to make as . Default is
///
public IEnumerable? GetMembersByPropertyValue(string propertyTypeAlias, string value, StringPropertyMatchType matchType = StringPropertyMatchType.Exact)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
IQuery query;
switch (matchType)
{
case StringPropertyMatchType.Exact:
query = Query().Where(x => ((Member) x).PropertyTypeAlias == propertyTypeAlias && (((Member) x).LongStringPropertyValue!.SqlEquals(value, TextColumnType.NText) || ((Member) x).ShortStringPropertyValue!.SqlEquals(value, TextColumnType.NVarchar)));
break;
case StringPropertyMatchType.Contains:
query = Query().Where(x => ((Member) x).PropertyTypeAlias == propertyTypeAlias && (((Member) x).LongStringPropertyValue!.SqlContains(value, TextColumnType.NText) || ((Member) x).ShortStringPropertyValue!.SqlContains(value, TextColumnType.NVarchar)));
break;
case StringPropertyMatchType.StartsWith:
query = Query().Where(x => ((Member) x).PropertyTypeAlias == propertyTypeAlias && (((Member) x).LongStringPropertyValue.SqlStartsWith(value, TextColumnType.NText) || ((Member) x).ShortStringPropertyValue.SqlStartsWith(value, TextColumnType.NVarchar)));
break;
case StringPropertyMatchType.EndsWith:
query = Query().Where(x => ((Member) x).PropertyTypeAlias == propertyTypeAlias && (((Member) x).LongStringPropertyValue!.SqlEndsWith(value, TextColumnType.NText) || ((Member) x).ShortStringPropertyValue!.SqlEndsWith(value, TextColumnType.NVarchar)));
break;
default:
throw new ArgumentOutOfRangeException(nameof(matchType));
}
return _memberRepository.Get(query);
}
///
/// Gets a list of Members based on a property search
///
/// Alias of the PropertyType to search for
/// Value to match
/// The type of match to make as . Default is
///
public IEnumerable? GetMembersByPropertyValue(string propertyTypeAlias, int value, ValuePropertyMatchType matchType = ValuePropertyMatchType.Exact)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
IQuery query;
switch (matchType)
{
case ValuePropertyMatchType.Exact:
query = Query().Where(x => ((Member) x).PropertyTypeAlias == propertyTypeAlias && ((Member) x).IntegerPropertyValue == value);
break;
case ValuePropertyMatchType.GreaterThan:
query = Query().Where(x => ((Member) x).PropertyTypeAlias == propertyTypeAlias && ((Member) x).IntegerPropertyValue > value);
break;
case ValuePropertyMatchType.LessThan:
query = Query().Where(x => ((Member) x).PropertyTypeAlias == propertyTypeAlias && ((Member) x).IntegerPropertyValue < value);
break;
case ValuePropertyMatchType.GreaterThanOrEqualTo:
query = Query().Where(x => ((Member) x).PropertyTypeAlias == propertyTypeAlias && ((Member) x).IntegerPropertyValue >= value);
break;
case ValuePropertyMatchType.LessThanOrEqualTo:
query = Query().Where(x => ((Member) x).PropertyTypeAlias == propertyTypeAlias && ((Member) x).IntegerPropertyValue <= value);
break;
default:
throw new ArgumentOutOfRangeException(nameof(matchType));
}
return _memberRepository.Get(query);
}
///
/// Gets a list of Members based on a property search
///
/// Alias of the PropertyType to search for
/// Value to match
///
public IEnumerable? GetMembersByPropertyValue(string propertyTypeAlias, bool value)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
IQuery query = Query().Where(x => ((Member) x).PropertyTypeAlias == propertyTypeAlias && ((Member) x).BoolPropertyValue == value);
return _memberRepository.Get(query);
}
///
/// Gets a list of Members based on a property search
///
/// Alias of the PropertyType to search for
/// Value to match
/// The type of match to make as . Default is
///
public IEnumerable? GetMembersByPropertyValue(string propertyTypeAlias, DateTime value, ValuePropertyMatchType matchType = ValuePropertyMatchType.Exact)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
IQuery query;
switch (matchType)
{
case ValuePropertyMatchType.Exact:
query = Query().Where(x => ((Member) x).PropertyTypeAlias == propertyTypeAlias && ((Member) x).DateTimePropertyValue == value);
break;
case ValuePropertyMatchType.GreaterThan:
query = Query().Where(x => ((Member) x).PropertyTypeAlias == propertyTypeAlias && ((Member) x).DateTimePropertyValue > value);
break;
case ValuePropertyMatchType.LessThan:
query = Query().Where(x => ((Member) x).PropertyTypeAlias == propertyTypeAlias && ((Member) x).DateTimePropertyValue < value);
break;
case ValuePropertyMatchType.GreaterThanOrEqualTo:
query = Query().Where(x => ((Member) x).PropertyTypeAlias == propertyTypeAlias && ((Member) x).DateTimePropertyValue >= value);
break;
case ValuePropertyMatchType.LessThanOrEqualTo:
query = Query().Where(x => ((Member) x).PropertyTypeAlias == propertyTypeAlias && ((Member) x).DateTimePropertyValue <= value);
break;
default:
throw new ArgumentOutOfRangeException(nameof(matchType)); // causes rollback // causes rollback
}
// TODO: Since this is by property value, we need a GetByPropertyQuery on the repo!
return _memberRepository.Get(query);
}
///
/// Checks if a Member with the id exists
///
/// Id of the Member
/// True if the Member exists otherwise False
public bool Exists(int id)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
return _memberRepository.Exists(id);
}
///
/// Checks if a Member with the username exists
///
/// Username to check
/// True if the Member exists otherwise False
public bool Exists(string username)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
return _memberRepository.Exists(username);
}
#endregion
#region Save
///
[Obsolete("This is now a NoOp since last login date is no longer an umbraco property, set the date on the IMember directly and Save it instead, scheduled for removal in V11.")]
public void SetLastLogin(string username, DateTime date)
{
}
///
public void Save(IMember member)
{
// trimming username and email to make sure we have no trailing space
member.Username = member.Username.Trim();
member.Email = member.Email.Trim();
EventMessages evtMsgs = EventMessagesFactory.Get();
using ICoreScope scope = ScopeProvider.CreateCoreScope();
var savingNotification = new MemberSavingNotification(member, evtMsgs);
if (scope.Notifications.PublishCancelable(savingNotification))
{
scope.Complete();
return;
}
if (string.IsNullOrWhiteSpace(member.Name))
{
throw new ArgumentException("Cannot save member with empty name.");
}
scope.WriteLock(Constants.Locks.MemberTree);
_memberRepository.Save(member);
scope.Notifications.Publish(new MemberSavedNotification(member, evtMsgs).WithStateFrom(savingNotification));
Audit(AuditType.Save, 0, member.Id);
scope.Complete();
}
///
public void Save(IEnumerable members)
{
IMember[] membersA = members.ToArray();
EventMessages evtMsgs = EventMessagesFactory.Get();
using ICoreScope scope = ScopeProvider.CreateCoreScope();
var savingNotification = new MemberSavingNotification(membersA, evtMsgs);
if (scope.Notifications.PublishCancelable(savingNotification))
{
scope.Complete();
return;
}
scope.WriteLock(Constants.Locks.MemberTree);
foreach (IMember member in membersA)
{
//trimming username and email to make sure we have no trailing space
member.Username = member.Username.Trim();
member.Email = member.Email.Trim();
_memberRepository.Save(member);
}
scope.Notifications.Publish(new MemberSavedNotification(membersA, evtMsgs).WithStateFrom(savingNotification));
Audit(AuditType.Save, 0, -1, "Save multiple Members");
scope.Complete();
}
#endregion
#region Delete
///
/// Deletes an
///
/// to Delete
public void Delete(IMember member)
{
EventMessages evtMsgs = EventMessagesFactory.Get();
using ICoreScope scope = ScopeProvider.CreateCoreScope();
var deletingNotification = new MemberDeletingNotification(member, evtMsgs);
if (scope.Notifications.PublishCancelable(deletingNotification))
{
scope.Complete();
return;
}
scope.WriteLock(Constants.Locks.MemberTree);
DeleteLocked(scope, member, evtMsgs, deletingNotification.State);
Audit(AuditType.Delete, 0, member.Id);
scope.Complete();
}
private void DeleteLocked(ICoreScope scope, IMember member, EventMessages evtMsgs, IDictionary? notificationState = null)
{
// a member has no descendants
_memberRepository.Delete(member);
scope.Notifications.Publish(new MemberDeletedNotification(member, evtMsgs).WithState(notificationState));
// media files deleted by QueuingEventDispatcher
}
#endregion
#region Roles
public void AddRole(string roleName)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope();
scope.WriteLock(Constants.Locks.MemberTree);
_memberGroupRepository.CreateIfNotExists(roleName);
scope.Complete();
}
///
/// Returns a list of all member roles
///
/// A list of member roles
public IEnumerable GetAllRoles()
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
return _memberGroupRepository.GetMany().Distinct();
}
///
/// Returns a list of all member roles for a given member ID
///
///
/// A list of member roles
public IEnumerable GetAllRoles(int memberId)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
IEnumerable result = _memberGroupRepository.GetMemberGroupsForMember(memberId);
return result.Select(x => x.Name).WhereNotNull().Distinct();
}
public IEnumerable GetAllRoles(string username)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
IEnumerable result = _memberGroupRepository.GetMemberGroupsForMember(username);
return result.Where(x => x.Name != null).Select(x => x.Name).Distinct()!;
}
public IEnumerable GetAllRolesIds()
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
return _memberGroupRepository.GetMany().Select(x => x.Id).Distinct();
}
public IEnumerable GetAllRolesIds(int memberId)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
IEnumerable result = _memberGroupRepository.GetMemberGroupsForMember(memberId);
return result.Select(x => x.Id).Distinct();
}
public IEnumerable GetAllRolesIds(string username)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
IEnumerable result = _memberGroupRepository.GetMemberGroupsForMember(username);
return result.Select(x => x.Id).Distinct();
}
public IEnumerable GetMembersInRole(string roleName)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
return _memberRepository.GetByMemberGroup(roleName);
}
public IEnumerable FindMembersInRole(string roleName, string usernameToMatch, StringPropertyMatchType matchType = StringPropertyMatchType.StartsWith)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
scope.ReadLock(Constants.Locks.MemberTree);
return _memberRepository.FindMembersInRole(roleName, usernameToMatch, matchType);
}
public bool DeleteRole(string roleName, bool throwIfBeingUsed)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope();
scope.WriteLock(Constants.Locks.MemberTree);
if (throwIfBeingUsed)
{
// get members in role
IEnumerable membersInRole = _memberRepository.GetByMemberGroup(roleName);
if (membersInRole.Any())
{
throw new InvalidOperationException("The role " + roleName + " is currently assigned to members");
}
}
IQuery query = Query().Where(g => g.Name == roleName);
IMemberGroup[]? found = _memberGroupRepository.Get(query)?.ToArray();
if (found is not null)
{
foreach (IMemberGroup memberGroup in found)
{
_memberGroupService.Delete(memberGroup);
}
}
scope.Complete();
return found?.Length > 0;
}
public void AssignRole(string username, string roleName) => AssignRoles(new[] { username }, new[] { roleName });
public void AssignRoles(string[] usernames, string[] roleNames)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope();
scope.WriteLock(Constants.Locks.MemberTree);
var ids = _memberRepository.GetMemberIds(usernames);
_memberGroupRepository.AssignRoles(ids, roleNames);
scope.Notifications.Publish(new AssignedMemberRolesNotification(ids, roleNames));
scope.Complete();
}
public void DissociateRole(string username, string roleName) => DissociateRoles(new[] { username }, new[] { roleName });
public void DissociateRoles(string[] usernames, string[] roleNames)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope();
scope.WriteLock(Constants.Locks.MemberTree);
var ids = _memberRepository.GetMemberIds(usernames);
_memberGroupRepository.DissociateRoles(ids, roleNames);
scope.Notifications.Publish(new RemovedMemberRolesNotification(ids, roleNames));
scope.Complete();
}
public void AssignRole(int memberId, string roleName) => AssignRoles(new[] { memberId }, new[] { roleName });
public void AssignRoles(int[] memberIds, string[] roleNames)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope();
scope.WriteLock(Constants.Locks.MemberTree);
_memberGroupRepository.AssignRoles(memberIds, roleNames);
scope.Notifications.Publish(new AssignedMemberRolesNotification(memberIds, roleNames));
scope.Complete();
}
public void DissociateRole(int memberId, string roleName) => DissociateRoles(new[] { memberId }, new[] { roleName });
public void DissociateRoles(int[] memberIds, string[] roleNames)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope();
scope.WriteLock(Constants.Locks.MemberTree);
_memberGroupRepository.DissociateRoles(memberIds, roleNames);
scope.Notifications.Publish(new RemovedMemberRolesNotification(memberIds, roleNames));
scope.Complete();
}
public void ReplaceRoles(string[] usernames, string[] roleNames)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope();
scope.WriteLock(Constants.Locks.MemberTree);
int[] ids = _memberRepository.GetMemberIds(usernames);
_memberGroupRepository.ReplaceRoles(ids, roleNames);
scope.Notifications.Publish(new AssignedMemberRolesNotification(ids, roleNames));
scope.Complete();
}
public void ReplaceRoles(int[] memberIds, string[] roleNames)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope();
scope.WriteLock(Constants.Locks.MemberTree);
_memberGroupRepository.ReplaceRoles(memberIds, roleNames);
scope.Notifications.Publish(new AssignedMemberRolesNotification(memberIds, roleNames));
scope.Complete();
}
#endregion
#region Private Methods
private void Audit(AuditType type, int userId, int objectId, string? message = null) => _auditRepository.Save(new AuditItem(objectId, type, userId, ObjectTypes.GetName(UmbracoObjectTypes.Member), message));
#endregion
#region Membership
///
/// Exports a member.
///
///
/// This is internal for now and is used to export a member in the member editor,
/// it will raise an event so that auditing logs can be created.
///
public MemberExportModel? ExportMember(Guid key)
{
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
IQuery? query = Query().Where(x => x.Key == key);
IMember? member = _memberRepository.Get(query)?.FirstOrDefault();
if (member == null)
{
return null;
}
var model = new MemberExportModel
{
Id = member.Id,
Key = member.Key,
Name = member.Name,
Username = member.Username,
Email = member.Email,
Groups = GetAllRoles(member.Id).ToList(),
ContentTypeAlias = member.ContentTypeAlias,
CreateDate = member.CreateDate,
UpdateDate = member.UpdateDate,
Properties = new List(GetPropertyExportItems(member))
};
scope.Notifications.Publish(new ExportedMemberNotification(member, model));
return model;
}
private static IEnumerable GetPropertyExportItems(IMember member)
{
if (member == null)
{
throw new ArgumentNullException(nameof(member));
}
var exportProperties = new List();
foreach (IProperty property in member.Properties)
{
var propertyExportModel = new MemberExportProperty
{
Id = property.Id,
Alias = property.Alias,
Name = property.PropertyType.Name,
Value = property.GetValue(), // TODO: ignoring variants
CreateDate = property.CreateDate,
UpdateDate = property.UpdateDate
};
exportProperties.Add(propertyExportModel);
}
return exportProperties;
}
#endregion
#region Content Types
///
/// Delete Members of the specified MemberType id
///
/// Id of the MemberType
public void DeleteMembersOfType(int memberTypeId)
{
EventMessages evtMsgs = EventMessagesFactory.Get();
// note: no tree to manage here
using ICoreScope scope = ScopeProvider.CreateCoreScope();
scope.WriteLock(Constants.Locks.MemberTree);
// TODO: What about content that has the contenttype as part of its composition?
IQuery? query = Query().Where(x => x.ContentTypeId == memberTypeId);
IMember[]? members = _memberRepository.Get(query)?.ToArray();
if (members is null)
{
return;
}
if (scope.Notifications.PublishCancelable(new MemberDeletingNotification(members, evtMsgs)))
{
scope.Complete();
return;
}
foreach (IMember member in members)
{
// delete media
// triggers the deleted event (and handles the files)
DeleteLocked(scope, member, evtMsgs);
}
scope.Complete();
}
private IMemberType GetMemberType(ICoreScope scope, string memberTypeAlias)
{
if (memberTypeAlias == null)
{
throw new ArgumentNullException(nameof(memberTypeAlias));
}
if (string.IsNullOrWhiteSpace(memberTypeAlias))
{
throw new ArgumentException("Value can't be empty or consist only of white-space characters.", nameof(memberTypeAlias));
}
scope.ReadLock(Constants.Locks.MemberTypes);
IMemberType? memberType = _memberTypeRepository.Get(memberTypeAlias);
if (memberType == null)
{
throw new Exception($"No MemberType matching the passed in Alias: '{memberTypeAlias}' was found"); // causes rollback
}
return memberType;
}
private IMemberType GetMemberType(string memberTypeAlias)
{
if (memberTypeAlias == null)
{
throw new ArgumentNullException(nameof(memberTypeAlias));
}
if (string.IsNullOrWhiteSpace(memberTypeAlias))
{
throw new ArgumentException("Value can't be empty or consist only of white-space characters.", nameof(memberTypeAlias));
}
using ICoreScope scope = ScopeProvider.CreateCoreScope(autoComplete: true);
return GetMemberType(scope, memberTypeAlias);
}
#endregion
}
}