Add user detail service.

3 files changed, 109 insertions, 8 deletions

diff --git a/Timeline/Services/DatabaseExtensions.cs b/Timeline/Services/DatabaseExtensions.cs
index 8cbc8fef..140c3146 100644
--- a/Timeline/Services/DatabaseExtensions.cs
+++ b/Timeline/Services/DatabaseExtensions.cs
@@ -9,6 +9,8 @@ namespace Timeline.Services
 {

     internal static class DatabaseExtensions

     {

+        private static readonly UsernameValidator usernameValidator = new UsernameValidator();

+

         /// <summary>

         /// Check the existence and get the id of the user.

         /// </summary>

@@ -17,11 +19,11 @@ namespace Timeline.Services
         /// <exception cref="ArgumentNullException">Thrown if <paramref name="username"/> is null.</exception>

         /// <exception cref="UsernameBadFormatException">Thrown if <paramref name="username"/> is of bad format.</exception>

         /// <exception cref="UserNotExistException">Thrown if user does not exist.</exception>

-        internal static async Task<long> CheckAndGetUser(DbSet<User> userDbSet, UsernameValidator validator, string username)

+        internal static async Task<long> CheckAndGetUser(DbSet<User> userDbSet, string? username)

         {

             if (username == null)

                 throw new ArgumentNullException(nameof(username));

-            var (result, message) = validator.Validate(username);

+            var (result, message) = usernameValidator.Validate(username);

             if (!result)

                 throw new UsernameBadFormatException(username, message);

 

diff --git a/Timeline/Services/UserAvatarService.cs b/Timeline/Services/UserAvatarService.cs
index 2afe9093..01201864 100644
--- a/Timeline/Services/UserAvatarService.cs
+++ b/Timeline/Services/UserAvatarService.cs
@@ -177,8 +177,6 @@ namespace Timeline.Services
 

         private readonly IETagGenerator _eTagGenerator;

 

-        private readonly UsernameValidator _usernameValidator;

-

         private readonly IClock _clock;

 

         public UserAvatarService(

@@ -194,13 +192,12 @@ namespace Timeline.Services
             _defaultUserAvatarProvider = defaultUserAvatarProvider;

             _avatarValidator = avatarValidator;

             _eTagGenerator = eTagGenerator;

-            _usernameValidator = new UsernameValidator();

             _clock = clock;

         }

 

         public async Task<string> GetAvatarETag(string username)

         {

-            var userId = await DatabaseExtensions.CheckAndGetUser(_database.Users, _usernameValidator, username);

+            var userId = await DatabaseExtensions.CheckAndGetUser(_database.Users, username);

 

             var eTag = (await _database.UserAvatars.Where(a => a.UserId == userId).Select(a => new { a.ETag }).SingleOrDefaultAsync())?.ETag;

             if (eTag == null)

@@ -211,7 +208,7 @@ namespace Timeline.Services
 

         public async Task<AvatarInfo> GetAvatar(string username)

         {

-            var userId = await DatabaseExtensions.CheckAndGetUser(_database.Users, _usernameValidator, username);

+            var userId = await DatabaseExtensions.CheckAndGetUser(_database.Users, username);

 

             var avatarEntity = await _database.UserAvatars.Where(a => a.UserId == userId).Select(a => new { a.Type, a.Data, a.LastModified }).SingleOrDefaultAsync();

 

@@ -253,7 +250,7 @@ namespace Timeline.Services
                     throw new ArgumentException(Resources.Services.UserAvatarService.ExceptionAvatarTypeNullOrEmpty, nameof(avatar));

             }

 

-            var userId = await DatabaseExtensions.CheckAndGetUser(_database.Users, _usernameValidator, username);

+            var userId = await DatabaseExtensions.CheckAndGetUser(_database.Users, username);

             var avatarEntity = await _database.UserAvatars.Where(a => a.UserId == userId).SingleOrDefaultAsync();

 

             if (avatar == null)

diff --git a/Timeline/Services/UserDetailService.cs b/Timeline/Services/UserDetailService.cs
new file mode 100644
index 00000000..0b24e4e2
--- /dev/null
+++ b/Timeline/Services/UserDetailService.cs
@@ -0,0 +1,102 @@
+using Microsoft.Extensions.Logging;

+using System;

+using System.Linq;

+using System.Threading.Tasks;

+using Timeline.Entities;

+using static Timeline.Resources.Services.UserDetailService;

+

+namespace Timeline.Services

+{

+    public interface IUserDetailService

+    {

+        /// <summary>

+        /// Get the nickname of the user with given username.

+        /// If the user does not set a nickname, the username is returned as the nickname.

+        /// </summary>

+        /// <param name="username">The username of the user to get nickname of.</param>

+        /// <returns>The nickname of the user.</returns>

+        /// <exception cref="ArgumentNullException">Thrown when <paramref name="username"/> is null.</exception>

+        /// <exception cref="UsernameBadFormatException">Thrown when <paramref name="username"/> is of bad format.</exception>

+        /// <exception cref="UserNotExistException">Thrown when the user does not exist.</exception>

+        Task<string> GetNickname(string username);

+

+        /// <summary>

+        /// Set the nickname of the user with given username.

+        /// </summary>

+        /// <param name="username">The username of the user to set nickname of.</param>

+        /// <param name="nickname">The nickname. Pass null to unset.</param>

+        /// <exception cref="ArgumentNullException">Thrown when <paramref name="username"/> is null.</exception>

+        /// <exception cref="ArgumentException">Thrown when <paramref name="nickname"/> is not null but its length is bigger than 10.</exception>

+        /// <exception cref="UsernameBadFormatException">Thrown when <paramref name="username"/> is of bad format.</exception>

+        /// <exception cref="UserNotExistException">Thrown when the user does not exist.</exception>

+        Task SetNickname(string username, string? nickname);

+    }

+

+    public class UserDetailService : IUserDetailService

+    {

+        private readonly DatabaseContext _database;

+

+        private readonly ILogger<UserDetailService> _logger;

+

+        public UserDetailService(DatabaseContext database, ILogger<UserDetailService> logger)

+        {

+            _database = database;

+            _logger = logger;

+        }

+

+        public async Task<string> GetNickname(string username)

+        {

+            var userId = await DatabaseExtensions.CheckAndGetUser(_database.Users, username);

+            var nickname = _database.UserDetails.Where(d => d.UserId == userId).Select(d => new { d.Nickname }).SingleOrDefault()?.Nickname;

+            return nickname ?? username;

+        }

+

+        public async Task SetNickname(string username, string? nickname)

+        {

+            if (nickname != null && nickname.Length > 10)

+            {

+                throw new ArgumentException(ExceptionNicknameTooLong, nameof(nickname));

+            }

+            var userId = await DatabaseExtensions.CheckAndGetUser(_database.Users, username);

+            var userDetail = _database.UserDetails.Where(d => d.UserId == userId).SingleOrDefault();

+            if (nickname == null)

+            {

+                if (userDetail == null || userDetail.Nickname == null)

+                {

+                    return;

+                }

+                else

+                {

+                    userDetail.Nickname = null;

+                    await _database.SaveChangesAsync();

+                    _logger.LogInformation(LogEntityNicknameSetToNull, userId);

+                }

+            }

+            else

+            {

+                var create = userDetail == null;

+                if (create)

+                {

+                    userDetail = new UserDetail

+                    {

+                        UserId = userId

+                    };

+                }

+                userDetail!.Nickname = nickname;

+                if (create)

+                {

+                    _database.UserDetails.Add(userDetail);

+                }

+                await _database.SaveChangesAsync();

+                if (create)

+                {

+                    _logger.LogInformation(LogEntityNicknameCreate, userId, nickname);

+                }

+                else

+                {

+                    _logger.LogInformation(LogEntityNicknameSetNotNull, userId, nickname);

+                }

+            }

+        }

+    }

+}