1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
using Microsoft.AspNetCore.Hosting;
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Logging;
using System;
using System.IO;
using System.Linq;
using System.Threading.Tasks;
using Timeline.Entities;
namespace Timeline.Services
{
public class Avatar
{
public string Type { get; set; }
public byte[] Data { get; set; }
}
/// <summary>
/// Thrown when avatar is of bad format.
/// </summary>
[Serializable]
public class AvatarDataException : Exception
{
public AvatarDataException(Avatar avatar, string message) : base(message) { Avatar = avatar; }
public AvatarDataException(Avatar avatar, string message, Exception inner) : base(message, inner) { Avatar = avatar; }
protected AvatarDataException(
System.Runtime.Serialization.SerializationInfo info,
System.Runtime.Serialization.StreamingContext context) : base(info, context) { }
public Avatar Avatar { get; set; }
}
/// <summary>
/// Provider for default user avatar.
/// </summary>
/// <remarks>
/// Mainly for unit tests.
/// </remarks>
public interface IDefaultUserAvatarProvider
{
/// <summary>
/// Get the default avatar.
/// </summary>
Task<Avatar> GetDefaultAvatar();
}
public interface IUserAvatarService
{
/// <summary>
/// Get avatar of a user. If the user has no avatar, a default one is returned.
/// </summary>
/// <param name="username">The username of the user to get avatar of.</param>
/// <returns>The avatar.</returns>
/// <exception cref="ArgumentException">Thrown if <paramref name="username"/> is null or empty.</exception>
/// <exception cref="UserNotExistException">Thrown if the user does not exist.</exception>
Task<Avatar> GetAvatar(string username);
/// <summary>
/// Set avatar for a user.
/// </summary>
/// <param name="username">The username of the user to set avatar for.</param>
/// <param name="avatar">The avatar. Can be null to delete the saved avatar.</param>
/// <exception cref="ArgumentException">Throw if <paramref name="username"/> is null or empty.
/// Or thrown if <paramref name="avatar"/> is not null but <see cref="Avatar.Type"/> is null or empty or <see cref="Avatar.Data"/> is null.</exception>
/// <exception cref="UserNotExistException">Thrown if the user does not exist.</exception>
/// <exception cref="AvatarDataException">Thrown if avatar is of bad format.</exception>
Task SetAvatar(string username, Avatar avatar);
}
public class DefaultUserAvatarProvider : IDefaultUserAvatarProvider
{
private readonly IHostingEnvironment _environment;
public DefaultUserAvatarProvider(IHostingEnvironment environment)
{
_environment = environment;
}
public async Task<Avatar> GetDefaultAvatar()
{
return new Avatar
{
Type = "image/png",
Data = await File.ReadAllBytesAsync(Path.Combine(_environment.ContentRootPath, "default-avatar.png"))
};
}
}
public class UserAvatarService : IUserAvatarService
{
private readonly ILogger<UserAvatarService> _logger;
private readonly DatabaseContext _database;
private readonly IDefaultUserAvatarProvider _defaultUserAvatarProvider;
public UserAvatarService(ILogger<UserAvatarService> logger, DatabaseContext database, IDefaultUserAvatarProvider defaultUserAvatarProvider)
{
_logger = logger;
_database = database;
_defaultUserAvatarProvider = defaultUserAvatarProvider;
}
public async Task<Avatar> GetAvatar(string username)
{
if (string.IsNullOrEmpty(username))
throw new ArgumentException("Username is null or empty.", nameof(username));
var user = await _database.Users.Where(u => u.Name == username).SingleOrDefaultAsync();
if (user == null)
throw new UserNotExistException(username);
await _database.Entry(user).Reference(u => u.Avatar).LoadAsync();
var avatar = user.Avatar;
if (avatar == null)
{
return await _defaultUserAvatarProvider.GetDefaultAvatar();
}
else
{
return new Avatar
{
Type = avatar.Type,
Data = avatar.Data
};
}
}
public async Task SetAvatar(string username, Avatar avatar)
{
if (string.IsNullOrEmpty(username))
throw new ArgumentException("Username is null or empty.", nameof(username));
if (avatar != null)
{
if (string.IsNullOrEmpty(avatar.Type))
throw new ArgumentException("Type of avatar is null or empty.", nameof(avatar));
if (avatar.Data == null)
throw new ArgumentException("Data of avatar is null.", nameof(avatar));
}
var user = await _database.Users.Where(u => u.Name == username).SingleOrDefaultAsync();
if (user == null)
throw new UserNotExistException(username);
await _database.Entry(user).Reference(u => u.Avatar).LoadAsync();
var avatarEntity = user.Avatar;
if (avatar == null)
{
if (avatarEntity == null)
return;
else
{
_database.UserAvatars.Remove(avatarEntity);
await _database.SaveChangesAsync();
}
}
else
{
// TODO: Use image library to check the format to prohibit bad data.
if (avatarEntity == null)
{
user.Avatar = new UserAvatar
{
Type = avatar.Type,
Data = avatar.Data
};
}
else
{
avatarEntity.Type = avatar.Type;
avatarEntity.Data = avatar.Data;
}
await _database.SaveChangesAsync();
}
}
}
public static class UserAvatarServiceCollectionExtensions
{
public static void AddUserAvatarService(this IServiceCollection services)
{
services.AddScoped<IUserAvatarService, UserAvatarService>();
services.AddSingleton<IDefaultUserAvatarProvider, DefaultUserAvatarProvider>();
}
}
}
|