aboutsummaryrefslogtreecommitdiff
path: root/BackEnd/Timeline/Services/User/UserPermissions.cs
blob: 1c27b4b87f2ebc85f678eb50465164a25fbefc18 (plain)
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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;

namespace Timeline.Services.User
{
    /// <summary>
    /// Represents a user's permissions.
    /// </summary>
    public class UserPermissions : IEnumerable<UserPermission>, IEquatable<UserPermissions>
    {
        public static UserPermissions AllPermissions { get; } = new UserPermissions(Enum.GetValues<UserPermission>());

        /// <summary>
        /// Create an instance containing given permissions.
        /// </summary>
        /// <param name="permissions">Permission list.</param>
        public UserPermissions(params UserPermission[] permissions) : this(permissions as IEnumerable<UserPermission>)
        {

        }

        /// <summary>
        /// Create an instance containing given permissions.
        /// </summary>
        /// <param name="permissions">Permission list.</param>
        /// <exception cref="ArgumentNullException">Thrown when <paramref name="permissions"/> is null.</exception>
        public UserPermissions(IEnumerable<UserPermission> permissions)
        {
            if (permissions == null) throw new ArgumentNullException(nameof(permissions));
            _permissions = new SortedSet<UserPermission>(permissions);
        }

        private readonly SortedSet<UserPermission> _permissions = new();

        /// <summary>
        /// Check if a permission is contained in the list.
        /// </summary>
        /// <param name="permission">The permission to check.</param>
        /// <returns>True if contains. Otherwise false.</returns>
        public bool Contains(UserPermission permission)
        {
            return _permissions.Contains(permission);
        }

        /// <summary>
        /// To a serializable string list.
        /// </summary>
        /// <returns>A string list.</returns>
        public List<string> ToStringList()
        {
            return _permissions.Select(p => p.ToString()).ToList();
        }

        /// <summary>
        /// Convert a string list to user permissions.
        /// </summary>
        /// <param name="list">The string list.</param>
        /// <returns>An instance.</returns>
        /// <exception cref="ArgumentNullException">Thrown when <paramref name="list"/> is null.</exception>
        /// <exception cref="ArgumentException">Thrown when there is unknown permission name.</exception>
        public static UserPermissions FromStringList(IEnumerable<string> list)
        {
            List<UserPermission> permissions = new();

            foreach (var value in list)
            {
                if (Enum.TryParse<UserPermission>(value, false, out var result))
                {
                    permissions.Add(result);
                }
                else
                {
                    throw new ArgumentException("Unknown permission name.", nameof(list));
                }
            }

            return new UserPermissions(permissions);
        }

        public IEnumerator<UserPermission> GetEnumerator()
        {
            return _permissions.GetEnumerator();
        }

        IEnumerator IEnumerable.GetEnumerator()
        {
            return ((IEnumerable)_permissions).GetEnumerator();
        }

        public bool Equals(UserPermissions? other)
        {
            if (other == null)
                return false;

            return _permissions.SequenceEqual(other._permissions);
        }

        public override bool Equals(object? obj)
        {
            return Equals(obj as UserPermissions);
        }

        public override int GetHashCode()
        {
            int result = 0;
            foreach (var permission in Enum.GetValues<UserPermission>())
            {
                if (_permissions.Contains(permission))
                {
                    result += 1;
                }
                result <<= 1;
            }
            return result;
        }
    }
}