Add general account informations

Author: Suiram1701

API.Test/ProfileTests.cs

@@ -5,6 +5,7 @@
 using System.Threading.Tasks;
 using static API.Test.AuthentificationTests;
 using SixLabors.ImageSharp;
+using WebUntisAPI.Client.Models;
 
 namespace API.Test;
 
@@ -25,4 +26,46 @@ public void GetRecipientProfileImgTest()
         imgDownload.Wait();
         imgDownload.Result.SaveAsPng("DownloadImg.png");
     }
+
+    [Test]
+    public void GetSupportedLanguages()
+    {
+        Client.LoginAsync(s_Server, s_LoginName, s_UserName, s_Password).Wait();
+
+        Task<Dictionary<string, string>> languages = Client.GetAvailableLanguagesAsync();
+        languages.Wait();
+
+        if (languages.Result.Count > 0)
+            Assert.Pass();
+        else
+            Assert.Fail();
+    }
+
+    [Test]
+    public void GetAccountConfiguration()
+    {
+        Client.LoginAsync(s_Server, s_LoginName, s_UserName, s_Password).Wait();
+
+        Task<AccountConfig> accountConfig = Client.GetAccountConfigAsync();
+        accountConfig.Wait();
+
+        if (accountConfig.Result is not null)
+            Assert.Pass();
+        else
+            Assert.Fail();
+    }
+
+    [Test]
+    public void GetGenerallyInformation()
+    {
+        Client.LoginAsync(s_Server, s_LoginName, s_UserName, s_Password).Wait();
+
+        Task<GeneralAccount> account = Client.GetGenerallyAccountInformationAsync();
+        account.Wait();
+
+        if (account.Result is not null)
+            Assert.Pass();
+        else
+            Assert.Fail();
+    }
 }

WebUntisAPI.Client/Models/AccountConfig.cs

@@ -0,0 +1,21 @@
+using Newtonsoft.Json;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace WebUntisAPI.Client.Models
+{
+    /// <summary>
+    /// Account configuration details
+    /// </summary>
+    public class AccountConfig
+    {
+        /// <summary>
+        /// Can display the contact details for this account
+        /// </summary>
+        [JsonProperty("canReadContactDetail")]
+        public bool CanReadContactDetails { get; set; } = false;
+    }
+}

WebUntisAPI.Client/Models/GeneralAccount.cs

@@ -0,0 +1,155 @@
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace WebUntisAPI.Client.Models
+{
+    /// <summary>
+    /// General information about a account
+    /// </summary>
+    public class GeneralAccount
+    {
+        /// <summary>
+        /// The name of the user
+        /// </summary>
+        public string Name { get; set; }
+
+        /// <summary>
+        /// The user group of the user
+        /// </summary>
+        public string UserGroup { get; set; }
+
+        /// <summary>
+        /// The id of the role of the user
+        /// </summary>
+        public int RoleId { get; set; }
+
+        /// <summary>
+        /// The name of the department (An empty value means the user has not department)
+        /// </summary>
+        public string Department { get; set; }
+
+        /// <summary>
+        /// The language code of the user
+        /// </summary>
+        /// <remarks>
+        /// That are no normal language codes. You must use the values from <see cref="WebUntisClient.GetAvailableLanguagesAsync(System.Threading.CancellationToken)"/>
+        /// </remarks>
+        public string LanguageCode { get; set; }
+
+        /// <summary>
+        /// The email of the user
+        /// </summary>
+        public string Email { get; set; }
+
+        /// <summary>
+        /// The max open bookings
+        /// </summary>
+        public int EffectiveMaxBookings { get; set; }
+
+        /// <summary>
+        /// The current open bookings
+        /// </summary>
+        public int OpenBookings { get; set; }
+
+        /// <summary>
+        /// Forward the messages to the users <see cref="Email"/>
+        /// </summary>
+        public bool ForwardMessageToMail { get; set; }
+
+        /// <summary>
+        /// Notifications from the task and ticket system
+        /// </summary>
+        public bool UserTaskNotifications { get; set; }
+
+        /// <summary>
+        /// Is a password change allowed
+        /// </summary>
+        public bool PasswordChangeAllowed { get; set; }
+
+        /// <summary>
+        /// Forward system mails
+        /// </summary>
+        public bool SystemMailForwarding { get; set; }
+
+        /// <summary>
+        /// The gender of the user
+        /// </summary>
+        public Gender UserGender { get; set; }
+
+        /// <summary>
+        /// The count of items on the start page
+        /// </summary>
+        public int ItemsOnStartPage { get; set; }
+
+        /// <summary>
+        /// Show the lessons of the day
+        /// </summary>
+        public bool ShowLessonsOfDay { get; set; }
+
+        /// <summary>
+        /// Show the next day periods
+        /// </summary>
+        public bool ShowNextDayPeriods { get; set; }
+
+        internal static GeneralAccount ReadFromJson(JsonReader reader)
+        {
+            JObject data = JObject.Load(reader);
+            JObject profile = data["profile"].Value<JObject>();
+
+            return new GeneralAccount
+            {
+                Name = profile["name"].Value<string>(),
+                UserGroup = profile["userGroup"].Value<string>(),
+                RoleId = profile["userRoleId"].Value<int>(),
+                Department = profile["department"].Value<string>(),
+                LanguageCode = profile["languageCode"].Value<string>(),
+                Email = profile["email"].Value<string>(),
+                EffectiveMaxBookings = profile["effectiveMaxBookings"].Value<int>(),
+                OpenBookings = profile["openBookings"].Value<int>(),
+                ForwardMessageToMail = profile["forwardMessageToEmail"].Value<bool>(),
+                UserTaskNotifications = profile["userTaskNotifications"].Value<bool>(),
+                PasswordChangeAllowed = data["pwChangeAllowed"]?.Value<bool>() ?? profile["pwChangeAllowed"].Value<bool>(),
+                SystemMailForwarding = profile["systemMailForwarding"].Value<bool>(),
+                UserGender = profile["gender"].ToObject<Gender>(),
+                ItemsOnStartPage = profile["itemOnStartPage"].Value<int>(),
+                ShowLessonsOfDay = profile["showLessonsOfDay"].Value<bool>(),
+                ShowNextDayPeriods = profile["showNextDayPeriods"].Value<bool>()
+            };
+        }
+
+        /// <summary>
+        /// A user gender
+        /// </summary>
+        public class Gender
+        {
+            /// <summary>
+            /// The gender id
+            /// </summary>
+            [JsonProperty("id")]
+            public int Id { get; set; }
+
+            /// <summary>
+            /// The long label
+            /// </summary>
+            [JsonProperty("longLabel")]
+            public string LongLabel { get; set; }
+
+            /// <summary>
+            /// the short label
+            /// </summary>
+            [JsonProperty("shortLabel")]
+            public string ShortMale { get; set; }
+
+            /// <summary>
+            /// The icon
+            /// </summary>
+            [JsonProperty("icon")]
+            public string Icon { get; set; }
+        }
+    }
+}

WebUntisAPI.Client/WebUntisclient.Profile.cs

@@ -9,10 +9,13 @@
 using System.Threading.Tasks;
 using WebUntisAPI.Client.Models.Messages;
 using System.Drawing.Imaging;
+using Newtonsoft.Json.Linq;
+using WebUntisAPI.Client.Models;
+using Newtonsoft.Json;
+using System.IO;
 #if NET47 || NET481
 using System.Drawing.Drawing2D;
 using System.Drawing;
-using System.IO;
 #elif NET6_0_OR_GREATER
 using SixLabors.Fonts;
 using SixLabors.ImageSharp;
@@ -173,6 +176,136 @@ public async Task<Image> GetMessagePersonProfileImageAsync(MessagePerson person,
 #endif
         }
 
+        /// <summary>
+        /// Get all by WebUntis supported languages
+        /// </summary>
+        /// <param name="ct">Cancellation token</param>
+        /// <returns>The languages (<see cref="KeyValuePair{TKey, TValue}.Key"/> is the WebUntis internal name of the language and <see cref="KeyValuePair{TKey, TValue}.Value"/> is the full name)</returns>
+        /// <exception cref="ObjectDisposedException">Thrown when the instance was disposed</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when you're logged in</exception>
+        /// <exception cref="HttpRequestException">Thrown when an error happened while the http request</exception>
+        public async Task<Dictionary<string, string>> GetAvailableLanguagesAsync(CancellationToken ct = default)
+        {
+            string responseString = await MakeAPIGetRequestAsync("/WebUntis/api/profile/languages", ct);
+            JArray languageObjects = JObject.Parse(responseString)["data"]["languages"].Value<JArray>();
+
+            Dictionary<string, string> languages = new Dictionary<string, string>();
+            foreach (JObject language in languageObjects.Cast<JObject>())
+                languages.Add(language.Value<string>("key"), language.Value<string>("name"));
+
+            return languages;
+        }
+
+        /// <summary>
+        /// Get the account configuration
+        /// </summary>
+        /// <param name="ct">Cancellation token</param>
+        /// <returns>The account configuration</returns>
+        /// <exception cref="ObjectDisposedException">Thrown when the instance was disposed</exception>
+        /// <exception cref="UnauthorizedAccessException">Thrown when you're logged in</exception>
+        /// <exception cref="HttpRequestException">Thrown when an error happened while the http request</exception>
+        public async Task<AccountConfig> GetAccountConfigAsync(CancellationToken ct = default)
+        {
+            string responseString = await MakeAPIGetRequestAsync("/WebUntis/api/profile/config", ct);
+            return JObject.Parse(responseString)["data"].ToObject<AccountConfig>();
+        }
+
+        /// <summary>
+        /// Get the general information about the current account
+        /// </summary>
+        /// <param name="ct">Cancellation token</param>
+        /// <returns>The information</returns>
+        public async Task<GeneralAccount> GetGenerallyAccountInformationAsync(CancellationToken ct = default)
+        {
+            string responseString = await MakeAPIGetRequestAsync("/WebUntis/api/profile/general", ct);
+            return GeneralAccount.ReadFromJson(JObject.Parse(responseString)["data"].CreateReader());
+        }
+
+        /// <summary>
+        /// Update the general account information
+        /// </summary>
+        /// <remarks>
+        /// When a value shouldn't change then must you set the current value
+        /// </remarks>
+        /// <param name="email"><see cref="GeneralAccount.Email"/></param>
+        /// <param name="forwardMessageToEmail"><see cref="GeneralAccount.ForwardMessageToMail"/></param>
+        /// <param name="itemsOnStartPage"><see cref="GeneralAccount.ItemsOnStartPage"/></param>
+        /// <param name="languageCode"><see cref="GeneralAccount.LanguageCode"/></param>
+        /// <param name="showLessonOfDay"><see cref="GeneralAccount.ShowLessonsOfDay"/></param>
+        /// <param name="showNextDayPeriods"><see cref="GeneralAccount.ShowNextDayPeriods"/></param>
+        /// <param name="userTaskNotifications"><see cref="GeneralAccount.UserTaskNotifications"/></param>
+        /// <param name="ct">Cancellation token</param>
+        /// <returns>Was the update successful</returns>
+        public async Task<bool> UpdateGenerallyAccountInformationAsync(string email, bool forwardMessageToEmail, int itemsOnStartPage, string languageCode, bool showLessonOfDay, bool showNextDayPeriods, bool userTaskNotifications, CancellationToken ct = default)
+        {
+            // Check for disposing
+            if (_disposedValue)
+                throw new ObjectDisposedException(GetType().FullName);
+
+            // Check if you logged in
+            if (!LoggedIn)
+                throw new UnauthorizedAccessException("You're not logged in");
+
+            // Write request
+            StringWriter sw = new StringWriter();
+            using (JsonWriter writer = new JsonTextWriter(sw))
+            {
+                writer.WriteStartObject();
+
+                writer.WritePropertyName("email");
+                writer.WriteValue(email);
+
+                writer.WritePropertyName("forwardMessageToEmail");
+                writer.WriteValue(forwardMessageToEmail);
+
+                writer.WritePropertyName("itemOnStartPage");
+                writer.WriteValue(itemsOnStartPage);
+
+                writer.WritePropertyName("languageCode");
+                writer.WriteValue(languageCode);
+
+                writer.WritePropertyName("showLessonsOfDay");
+                writer.WriteValue(showLessonOfDay);
+
+                writer.WritePropertyName("showNextDayPeriods");
+                writer.WriteValue(showNextDayPeriods);
+
+                writer.WritePropertyName("userTaskNotifications");
+                writer.WriteValue(userTaskNotifications);
+
+                writer.WriteEndObject();
+            }
+
+            HttpRequestMessage request = new HttpRequestMessage()
+            {
+                Method = HttpMethod.Post,
+                RequestUri = new Uri(ServerUrl + "/WebUntis/api/profile/general"),
+                Content = new StringContent(sw.ToString())
+            };
+
+            request.Headers.Add("JSESSIONID", _sessionId);
+            request.Headers.Add("schoolname", _schoolName);
+            request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", _bearerToken);
+
+            HttpResponseMessage response = await _client.SendAsync(request, ct);
 
+            // Check cancellation token
+            if (ct.IsCancellationRequested)
+                return false;
+
+            // Verify response
+            if (response.StatusCode == HttpStatusCode.Unauthorized || response.StatusCode == HttpStatusCode.Forbidden)
+            {
+                _ = LogoutAsync();
+                throw new UnauthorizedAccessException("You're not logged in");
+            }
+
+            if (response.StatusCode != HttpStatusCode.OK)
+                throw new HttpRequestException($"There was an error while the http request (Code: {response.StatusCode}).");
+
+            string responseString = await response.Content.ReadAsStringAsync();
+            JObject responseObject = JObject.Parse(responseString);
+            return responseObject["data"]["success"].Value<bool>();
+        }
     }
 }