From df1ef1e21d8d889a2c9abd440039533c6a43818f Mon Sep 17 00:00:00 2001 From: crupest Date: Thu, 7 Jan 2021 16:23:20 +0800 Subject: 史诗级重构！ MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- BackEnd/Timeline/Services/TimelineService.cs | 449 +++++++++------------------ 1 file changed, 154 insertions(+), 295 deletions(-) (limited to 'BackEnd/Timeline/Services/TimelineService.cs') diff --git a/BackEnd/Timeline/Services/TimelineService.cs b/BackEnd/Timeline/Services/TimelineService.cs index b65b3cf4..e310951a 100644 --- a/BackEnd/Timeline/Services/TimelineService.cs +++ b/BackEnd/Timeline/Services/TimelineService.cs @@ -1,7 +1,6 @@ using Microsoft.EntityFrameworkCore; using System; using System.Collections.Generic; -using System.Globalization; using System.Linq; using System.Threading.Tasks; using Timeline.Entities; @@ -19,7 +18,7 @@ namespace Timeline.Services if (name.StartsWith("@", StringComparison.OrdinalIgnoreCase)) { isPersonal = true; - return name.Substring(1); + return name[1..]; } else { @@ -48,6 +47,13 @@ namespace Timeline.Services public long UserId { get; set; } } + public class TimelineChangePropertyParams + { + public string? Title { get; set; } + public string? Description { get; set; } + public TimelineVisibility? Visibility { get; set; } + } + /// /// This define the interface of both personal timeline and ordinary timeline. /// @@ -56,139 +62,94 @@ namespace Timeline.Services /// /// Get the timeline last modified time (not include name change). /// - /// The name of the timeline. - /// The timeline info. - /// Thrown when is null. - /// Throw when is of bad format. - /// - /// Thrown when timeline with name does not exist. - /// If it is a personal timeline, then inner exception is . - /// - Task GetTimelineLastModifiedTime(string timelineName); + /// The id of the timeline. + /// The timeline modified time. + /// Thrown when timeline does not exist. + Task GetTimelineLastModifiedTime(long id); /// /// Get the timeline unique id. /// - /// The name of the timeline. - /// The timeline info. - /// Thrown when is null. - /// Throw when is of bad format. - /// - /// Thrown when timeline with name does not exist. - /// If it is a personal timeline, then inner exception is . - /// - Task GetTimelineUniqueId(string timelineName); + /// The id of the timeline. + /// The timeline unique id. + /// Thrown when timeline does not exist. + Task GetTimelineUniqueId(long id); /// /// Get the timeline info. /// - /// The name of the timeline. + /// Id of timeline. /// The timeline info. - /// Thrown when is null. - /// Throw when is of bad format. - /// - /// Thrown when timeline with name does not exist. - /// If it is a personal timeline, then inner exception is . - /// - Task GetTimeline(string timelineName); + /// Thrown when timeline does not exist. + Task GetTimeline(long id); /// - /// Get timeline by id. + /// Set the properties of a timeline. /// - /// Id of timeline. - /// The timeline. + /// The id of the timeline. + /// The new properties. Null member means not to change. + /// Thrown when is null. /// Thrown when timeline with given id does not exist. - Task GetTimelineById(long id); + Task ChangeProperty(long id, TimelineChangePropertyParams newProperties); /// - /// Set the properties of a timeline. + /// Add a member to timeline. /// - /// The name of the timeline. - /// The new properties. Null member means not to change. - /// Thrown when or is null. - /// Throw when is of bad format. - /// - /// Thrown when timeline with name does not exist. - /// If it is a personal timeline, then inner exception is . - /// - Task ChangeProperty(string timelineName, TimelineChangePropertyRequest newProperties); + /// Timeline id. + /// User id. + /// True if the memeber was added. False if it is already a member. + /// Thrown when timeline does not exist. + /// Thrown when the user does not exist. + Task AddMember(long timelineId, long userId); /// - /// Change member of timeline. + /// Remove a member from timeline. /// - /// The name of the timeline. - /// A list of usernames of members to add. May be null. - /// A list of usernames of members to remove. May be null. - /// Thrown when is null. - /// Throw when is of bad format. - /// - /// Thrown when timeline with name does not exist. - /// If it is a personal timeline, then inner exception is . - /// - /// Thrown when names in or is not a valid username. - /// Thrown when one of the user to change does not exist. - /// - /// Operating on a username that is of bad format or does not exist always throws. - /// Add a user that already is a member has no effects. - /// Remove a user that is not a member also has not effects. - /// Add and remove an identical user results in no effects. - /// More than one same usernames are regarded as one. - /// - Task ChangeMember(string timelineName, IList? membersToAdd, IList? membersToRemove); + /// Timeline id. + /// User id. + /// True if the memeber was removed. False if it was not a member before. + /// Thrown when timeline does not exist. + /// Thrown when the user does not exist. + Task RemoveMember(long timelineId, long userId); /// /// Check whether a user can manage(change timeline info, member, ...) a timeline. /// - /// The name of the timeline. + /// The id of the timeline. /// The id of the user to check on. /// True if the user can manage the timeline, otherwise false. - /// Thrown when is null. - /// Throw when is of bad format. - /// - /// Thrown when timeline with name does not exist. - /// If it is a personal timeline, then inner exception is . - /// + /// Thrown when timeline does not exist. /// /// This method does not check whether visitor is administrator. /// Return false if user with user id does not exist. /// - Task HasManagePermission(string timelineName, long userId); + Task HasManagePermission(long timelineId, long userId); /// /// Verify whether a visitor has the permission to read a timeline. /// - /// The name of the timeline. + /// The id of the timeline. /// The id of the user to check on. Null means visitor without account. /// True if can read, false if can't read. - /// Thrown when is null. - /// Throw when is of bad format. - /// - /// Thrown when timeline with name does not exist. - /// If it is a personal timeline, then inner exception is . - /// + /// Thrown when timeline does not exist. /// /// This method does not check whether visitor is administrator. /// Return false if user with visitor id does not exist. /// - Task HasReadPermission(string timelineName, long? visitorId); + Task HasReadPermission(long timelineId, long? visitorId); /// /// Verify whether a user is member of a timeline. /// - /// The name of the timeline. + /// The id of the timeline. /// The id of user to check on. /// True if it is a member, false if not. - /// Thrown when is null. - /// Throw when is of bad format. - /// - /// Thrown when timeline with name does not exist. - /// If it is a personal timeline, then inner exception is . - /// + /// Thrown when timeline does not exist. /// /// Timeline owner is also considered as a member. /// Return false when user with user id does not exist. /// - Task IsMemberOf(string timelineName, long userId); + Task IsMemberOf(long timelineId, long userId); /// /// Get all timelines including personal and ordinary timelines. @@ -199,7 +160,7 @@ namespace Timeline.Services /// /// If user with related user id does not exist, empty list will be returned. /// - Task> GetTimelines(TimelineUserRelationship? relate = null, List? visibility = null); + Task> GetTimelines(TimelineUserRelationship? relate = null, List? visibility = null); /// /// Create a timeline. @@ -211,36 +172,33 @@ namespace Timeline.Services /// Thrown when timeline name is invalid. /// Thrown when the timeline already exists. /// Thrown when the owner user does not exist. - Task CreateTimeline(string timelineName, long ownerId); + Task CreateTimeline(string timelineName, long ownerId); /// /// Delete a timeline. /// - /// The name of the timeline to delete. - /// Thrown when is null. - /// Thrown when timeline name is invalid. + /// The id of the timeline to delete. /// Thrown when the timeline does not exist. - Task DeleteTimeline(string timelineName); + Task DeleteTimeline(long id); /// /// Change name of a timeline. /// - /// The old timeline name. + /// The timeline id. /// The new timeline name. - /// The new timeline info. - /// Thrown when or is null. - /// Thrown when or is of invalid format. + /// Thrown when is null. + /// Thrown when is of invalid format. /// Thrown when timeline does not exist. /// Thrown when a timeline with new name already exists. /// /// You can only change name of general timeline. /// - Task ChangeTimelineName(string oldTimelineName, string newTimelineName); + Task ChangeTimelineName(long id, string newTimelineName); } public class TimelineService : BasicTimelineService, ITimelineService { - public TimelineService(DatabaseContext database, IUserService userService, IClock clock) + public TimelineService(DatabaseContext database, IBasicUserService userService, IClock clock) : base(database, userService, clock) { _database = database; @@ -250,12 +208,10 @@ namespace Timeline.Services private readonly DatabaseContext _database; - private readonly IUserService _userService; + private readonly IBasicUserService _userService; private readonly IClock _clock; - private readonly UsernameValidator _usernameValidator = new UsernameValidator(); - private readonly TimelineNameValidator _timelineNameValidator = new TimelineNameValidator(); private void ValidateTimelineName(string name, string paramName) @@ -266,230 +222,138 @@ namespace Timeline.Services } } - /// Remember to include Members when query. - private async Task MapTimelineFromEntity(TimelineEntity entity) + public async Task GetTimelineLastModifiedTime(long id) { - var owner = await _userService.GetUser(entity.OwnerId); + var entity = await _database.Timelines.Where(t => t.Id == id).Select(t => new { t.LastModified }).SingleOrDefaultAsync(); - var members = new List(); - foreach (var memberEntity in entity.Members) - { - members.Add(await _userService.GetUser(memberEntity.UserId)); - } - - var name = entity.Name ?? ("@" + owner.Username); - - return new TimelineInfo( - entity.UniqueId, - name, - entity.NameLastModified, - string.IsNullOrEmpty(entity.Title) ? name : entity.Title, - entity.Description ?? "", - owner, - entity.Visibility, - members, - entity.CreateTime, - entity.LastModified - ); - } - - public async Task GetTimelineLastModifiedTime(string timelineName) - { - if (timelineName == null) - throw new ArgumentNullException(nameof(timelineName)); - - var timelineId = await GetTimelineIdByName(timelineName); - - var timelineEntity = await _database.Timelines.Where(t => t.Id == timelineId).Select(t => new { t.LastModified }).SingleAsync(); - - return timelineEntity.LastModified; - } - - public async Task GetTimelineUniqueId(string timelineName) - { - if (timelineName == null) - throw new ArgumentNullException(nameof(timelineName)); - - var timelineId = await GetTimelineIdByName(timelineName); - - var timelineEntity = await _database.Timelines.Where(t => t.Id == timelineId).Select(t => new { t.UniqueId }).SingleAsync(); + if (entity is null) + throw new TimelineNotExistException(id); - return timelineEntity.UniqueId; + return entity.LastModified; } - public async Task GetTimeline(string timelineName) + public async Task GetTimelineUniqueId(long id) { - if (timelineName == null) - throw new ArgumentNullException(nameof(timelineName)); - - var timelineId = await GetTimelineIdByName(timelineName); + var entity = await _database.Timelines.Where(t => t.Id == id).Select(t => new { t.UniqueId }).SingleOrDefaultAsync(); - var timelineEntity = await _database.Timelines.Where(t => t.Id == timelineId).Include(t => t.Members).SingleAsync(); + if (entity is null) + throw new TimelineNotExistException(id); - return await MapTimelineFromEntity(timelineEntity); + return entity.UniqueId; } - public async Task GetTimelineById(long id) + public async Task GetTimeline(long id) { - var timelineEntity = await _database.Timelines.Where(t => t.Id == id).Include(t => t.Members).SingleOrDefaultAsync(); + var entity = await _database.Timelines.Where(t => t.Id == id).Include(t => t.Owner).ThenInclude(o => o.Permissions).Include(t => t.Members).ThenInclude(m => m.User).ThenInclude(u => u.Permissions).SingleOrDefaultAsync(); - if (timelineEntity is null) + if (entity is null) throw new TimelineNotExistException(id); - return await MapTimelineFromEntity(timelineEntity); + return entity; } - public async Task ChangeProperty(string timelineName, TimelineChangePropertyRequest newProperties) + public async Task ChangeProperty(long id, TimelineChangePropertyParams newProperties) { - if (timelineName == null) - throw new ArgumentNullException(nameof(timelineName)); - if (newProperties == null) + if (newProperties is null) throw new ArgumentNullException(nameof(newProperties)); - var timelineId = await GetTimelineIdByName(timelineName); + var entity = await _database.Timelines.Where(t => t.Id == id).SingleOrDefaultAsync(); - var timelineEntity = await _database.Timelines.Where(t => t.Id == timelineId).SingleAsync(); + if (entity is null) + throw new TimelineNotExistException(id); var changed = false; if (newProperties.Title != null) { changed = true; - timelineEntity.Title = newProperties.Title; + entity.Title = newProperties.Title; } if (newProperties.Description != null) { changed = true; - timelineEntity.Description = newProperties.Description; + entity.Description = newProperties.Description; } if (newProperties.Visibility.HasValue) { changed = true; - timelineEntity.Visibility = newProperties.Visibility.Value; + entity.Visibility = newProperties.Visibility.Value; } if (changed) { var currentTime = _clock.GetCurrentTime(); - timelineEntity.LastModified = currentTime; + entity.LastModified = currentTime; } await _database.SaveChangesAsync(); } - public async Task ChangeMember(string timelineName, IList? add, IList? remove) + public async Task AddMember(long timelineId, long userId) { - if (timelineName == null) - throw new ArgumentNullException(nameof(timelineName)); + if (!await CheckExistence(timelineId)) + throw new TimelineNotExistException(timelineId); - List? RemoveDuplicateAndCheckFormat(IList? list, string paramName) - { - if (list != null) - { - List result = new List(); - var count = list.Count; - for (var index = 0; index < count; index++) - { - var username = list[index]; - if (result.Contains(username)) - { - continue; - } - var (validationResult, message) = _usernameValidator.Validate(username); - if (!validationResult) - throw new ArgumentException(string.Format(CultureInfo.CurrentCulture, ExceptionChangeMemberUsernameBadFormat, index), nameof(paramName)); - result.Add(username); - } - return result; - } - else - { - return null; - } - } - var simplifiedAdd = RemoveDuplicateAndCheckFormat(add, nameof(add)); - var simplifiedRemove = RemoveDuplicateAndCheckFormat(remove, nameof(remove)); + if (!await _userService.CheckUserExistence(userId)) + throw new UserNotExistException(userId); - // remove those both in add and remove - if (simplifiedAdd != null && simplifiedRemove != null) - { - var usersToClean = simplifiedRemove.Where(u => simplifiedAdd.Contains(u)).ToList(); - foreach (var u in usersToClean) - { - simplifiedAdd.Remove(u); - simplifiedRemove.Remove(u); - } + if (await _database.TimelineMembers.AnyAsync(m => m.TimelineId == timelineId && m.UserId == userId)) + return false; - if (simplifiedAdd.Count == 0) - simplifiedAdd = null; - if (simplifiedRemove.Count == 0) - simplifiedRemove = null; - } + var entity = new TimelineMemberEntity { UserId = userId, TimelineId = timelineId }; + _database.TimelineMembers.Add(entity); - if (simplifiedAdd == null && simplifiedRemove == null) - return; + var timelineEntity = await _database.Timelines.Where(t => t.Id == timelineId).SingleAsync(); + timelineEntity.LastModified = _clock.GetCurrentTime(); - var timelineId = await GetTimelineIdByName(timelineName); + await _database.SaveChangesAsync(); + return true; + } - async Task?> CheckExistenceAndGetId(List? list) - { - if (list == null) - return null; + public async Task RemoveMember(long timelineId, long userId) + { + if (!await CheckExistence(timelineId)) + throw new TimelineNotExistException(timelineId); - List result = new List(); - foreach (var username in list) - { - result.Add(await _userService.GetUserIdByUsername(username)); - } - return result; - } - var userIdsAdd = await CheckExistenceAndGetId(simplifiedAdd); - var userIdsRemove = await CheckExistenceAndGetId(simplifiedRemove); + if (!await _userService.CheckUserExistence(userId)) + throw new UserNotExistException(userId); - if (userIdsAdd != null) - { - var membersToAdd = userIdsAdd.Select(id => new TimelineMemberEntity { UserId = id, TimelineId = timelineId }).ToList(); - _database.TimelineMembers.AddRange(membersToAdd); - } + var entity = await _database.TimelineMembers.SingleOrDefaultAsync(m => m.TimelineId == timelineId && m.UserId == userId); + if (entity is null) return false; - if (userIdsRemove != null) - { - var membersToRemove = await _database.TimelineMembers.Where(m => m.TimelineId == timelineId && userIdsRemove.Contains(m.UserId)).ToListAsync(); - _database.TimelineMembers.RemoveRange(membersToRemove); - } + _database.TimelineMembers.Remove(entity); var timelineEntity = await _database.Timelines.Where(t => t.Id == timelineId).SingleAsync(); timelineEntity.LastModified = _clock.GetCurrentTime(); await _database.SaveChangesAsync(); + return true; } - public async Task HasManagePermission(string timelineName, long userId) + public async Task HasManagePermission(long timelineId, long userId) { - if (timelineName == null) - throw new ArgumentNullException(nameof(timelineName)); + var entity = await _database.Timelines.Where(t => t.Id == timelineId).Select(t => new { t.OwnerId }).SingleOrDefaultAsync(); - var timelineId = await GetTimelineIdByName(timelineName); - var timelineEntity = await _database.Timelines.Where(t => t.Id == timelineId).Select(t => new { t.OwnerId }).SingleAsync(); + if (entity is null) + throw new TimelineNotExistException(timelineId); - return userId == timelineEntity.OwnerId; + return entity.OwnerId == userId; } - public async Task HasReadPermission(string timelineName, long? visitorId) + public async Task HasReadPermission(long timelineId, long? visitorId) { - if (timelineName == null) - throw new ArgumentNullException(nameof(timelineName)); + var entity = await _database.Timelines.Where(t => t.Id == timelineId).Select(t => new { t.Visibility }).SingleOrDefaultAsync(); - var timelineId = await GetTimelineIdByName(timelineName); - var timelineEntity = await _database.Timelines.Where(t => t.Id == timelineId).Select(t => new { t.Visibility }).SingleAsync(); + if (entity is null) + throw new TimelineNotExistException(timelineId); - if (timelineEntity.Visibility == TimelineVisibility.Public) + if (entity.Visibility == TimelineVisibility.Public) return true; - if (timelineEntity.Visibility == TimelineVisibility.Register && visitorId != null) + if (entity.Visibility == TimelineVisibility.Register && visitorId != null) return true; if (visitorId == null) @@ -499,26 +363,24 @@ namespace Timeline.Services else { var memberEntity = await _database.TimelineMembers.Where(m => m.UserId == visitorId && m.TimelineId == timelineId).SingleOrDefaultAsync(); - return memberEntity != null; + return memberEntity is not null; } } - public async Task IsMemberOf(string timelineName, long userId) + public async Task IsMemberOf(long timelineId, long userId) { - if (timelineName == null) - throw new ArgumentNullException(nameof(timelineName)); - - var timelineId = await GetTimelineIdByName(timelineName); + var entity = await _database.Timelines.Where(t => t.Id == timelineId).Select(t => new { t.OwnerId }).SingleOrDefaultAsync(); - var timelineEntity = await _database.Timelines.Where(t => t.Id == timelineId).Select(t => new { t.OwnerId }).SingleAsync(); + if (entity is null) + throw new TimelineNotExistException(timelineId); - if (userId == timelineEntity.OwnerId) + if (userId == entity.OwnerId) return true; return await _database.TimelineMembers.AnyAsync(m => m.TimelineId == timelineId && m.UserId == userId); } - public async Task> GetTimelines(TimelineUserRelationship? relate = null, List? visibility = null) + public async Task> GetTimelines(TimelineUserRelationship? relate = null, List? visibility = null) { List entities; @@ -535,7 +397,7 @@ namespace Timeline.Services if (relate == null) { - entities = await ApplyTimelineVisibilityFilter(_database.Timelines).Include(t => t.Members).ToListAsync(); + entities = await ApplyTimelineVisibilityFilter(_database.Timelines).Include(t => t.Owner).ThenInclude(o => o.Permissions).Include(t => t.Members).ThenInclude(m => m.User).ThenInclude(u => u.Permissions).ToListAsync(); } else { @@ -543,80 +405,66 @@ namespace Timeline.Services if ((relate.Type & TimelineUserRelationshipType.Own) != 0) { - entities.AddRange(await ApplyTimelineVisibilityFilter(_database.Timelines.Where(t => t.OwnerId == relate.UserId)).Include(t => t.Members).ToListAsync()); + entities.AddRange(await ApplyTimelineVisibilityFilter(_database.Timelines.Where(t => t.OwnerId == relate.UserId)).Include(t => t.Owner).ThenInclude(o => o.Permissions).Include(t => t.Members).ThenInclude(m => m.User).ThenInclude(u => u.Permissions).ToListAsync()); } if ((relate.Type & TimelineUserRelationshipType.Join) != 0) { - entities.AddRange(await ApplyTimelineVisibilityFilter(_database.TimelineMembers.Where(m => m.UserId == relate.UserId).Include(m => m.Timeline).ThenInclude(t => t.Members).Select(m => m.Timeline)).ToListAsync()); + entities.AddRange(await ApplyTimelineVisibilityFilter(_database.TimelineMembers.Where(m => m.UserId == relate.UserId).Include(m => m.Timeline).ThenInclude(t => t.Members).ThenInclude(m => m.User).ThenInclude(u => u.Permissions).Include(t => t.Timeline.Owner.Permissions).Select(m => m.Timeline)).ToListAsync()); } } - var result = new List(); - foreach (var entity in entities) - { - result.Add(await MapTimelineFromEntity(entity)); - } - - return result; + return entities; } - public async Task CreateTimeline(string name, long owner) + public async Task CreateTimeline(string name, long owner) { if (name == null) throw new ArgumentNullException(nameof(name)); ValidateTimelineName(name, nameof(name)); - var user = await _userService.GetUser(owner); - var conflict = await _database.Timelines.AnyAsync(t => t.Name == name); if (conflict) throw new EntityAlreadyExistException(EntityNames.Timeline, null, ExceptionTimelineNameConflict); - var newEntity = CreateNewTimelineEntity(name, user.Id); + var entity = CreateNewTimelineEntity(name, owner); - _database.Timelines.Add(newEntity); + _database.Timelines.Add(entity); await _database.SaveChangesAsync(); - return await MapTimelineFromEntity(newEntity); + await _database.Entry(entity).Reference(e => e.Owner).Query().Include(o => o.Permissions).LoadAsync(); + await _database.Entry(entity).Collection(e => e.Members).Query().Include(m => m.User).ThenInclude(u => u.Permissions).LoadAsync(); + + return entity; } - public async Task DeleteTimeline(string name) + public async Task DeleteTimeline(long id) { - if (name == null) - throw new ArgumentNullException(nameof(name)); - - ValidateTimelineName(name, nameof(name)); + var entity = await _database.Timelines.Where(t => t.Id == id).SingleOrDefaultAsync(); - var entity = await _database.Timelines.Where(t => t.Name == name).SingleOrDefaultAsync(); - - if (entity == null) - throw new TimelineNotExistException(name); + if (entity is null) + throw new TimelineNotExistException(id); _database.Timelines.Remove(entity); await _database.SaveChangesAsync(); } - public async Task ChangeTimelineName(string oldTimelineName, string newTimelineName) + public async Task ChangeTimelineName(long id, string newTimelineName) { - if (oldTimelineName == null) - throw new ArgumentNullException(nameof(oldTimelineName)); if (newTimelineName == null) throw new ArgumentNullException(nameof(newTimelineName)); - ValidateTimelineName(oldTimelineName, nameof(oldTimelineName)); ValidateTimelineName(newTimelineName, nameof(newTimelineName)); - var entity = await _database.Timelines.Include(t => t.Members).Where(t => t.Name == oldTimelineName).SingleOrDefaultAsync(); + var entity = await _database.Timelines.Where(t => t.Id == id).SingleOrDefaultAsync(); - if (entity == null) - throw new TimelineNotExistException(oldTimelineName); + if (entity is null) + throw new TimelineNotExistException(id); - if (oldTimelineName == newTimelineName) - return await MapTimelineFromEntity(entity); + if (entity.Name == newTimelineName) return; var conflict = await _database.Timelines.AnyAsync(t => t.Name == newTimelineName); @@ -630,8 +478,19 @@ namespace Timeline.Services entity.LastModified = now; await _database.SaveChangesAsync(); + } + } - return await MapTimelineFromEntity(entity); + public static class TimelineServiceExtensions + { + public static async Task> GetTimelineList(this ITimelineService service, IEnumerable ids) + { + var timelines = new List(); + foreach (var id in ids) + { + timelines.Add(await service.GetTimeline(id)); + } + return timelines; } } } -- cgit v1.2.3