basic auth support for calendar (optional)

Author: JW-CH

ImmichFrame.Core/Services/IcalCalendarService.cs

@@ -1,15 +1,20 @@
+using System.Net.Http.Headers;
+using System.Text;
 using Ical.Net;
 using ImmichFrame.Core.Helpers;
 using ImmichFrame.Core.Interfaces;
 using ImmichFrame.WebApi.Helpers;
+using Microsoft.Extensions.Logging;
 
 public class IcalCalendarService : ICalendarService
 {
     private readonly IGeneralSettings _serverSettings;
-    private readonly IApiCache _appointmentCache = new ApiCache(TimeSpan.FromMinutes(15));
+    private readonly ILogger<IcalCalendarService> _logger;
+    private readonly ApiCache<List<IAppointment>> _appointmentCache = new(TimeSpan.FromMinutes(15));
 
-    public IcalCalendarService(IGeneralSettings serverSettings)
+    public IcalCalendarService(IGeneralSettings serverSettings, ILogger<IcalCalendarService> logger)
     {
+        _logger = logger;
         _serverSettings = serverSettings;
     }
 
@@ -19,7 +24,9 @@ public async Task<List<IAppointment>> GetAppointments()
         {
             var appointments = new List<IAppointment>();
 
-            var icals = await GetCalendars(_serverSettings.Webcalendars);
+            List<(string? auth, string url)> cals = _serverSettings.Webcalendars.Select(x => x.Contains(';') ? (x.Split(';')[0], x.Split(';')[1]) : (null, x.ToString())).ToList();
+
+            var icals = await GetCalendars(cals);
 
             foreach (var ical in icals)
             {
@@ -32,29 +39,38 @@ public async Task<List<IAppointment>> GetAppointments()
         });
     }
 
-    public async Task<List<string>> GetCalendars(IEnumerable<string> calendars)
+    public async Task<List<string>> GetCalendars(IEnumerable<(string? auth, string url)> calendars)
     {
         var icals = new List<string>();
 
-        foreach (var webcal in calendars)
+        using (HttpClient client = new HttpClient())
         {
-            string httpUrl = webcal.Replace("webcal://", "https://");
-
-            using (HttpClient client = new HttpClient())
+            foreach (var calendar in calendars)
             {
+                _logger.LogDebug($"Loading calendar: {calendar.auth ?? "no auth"} - {calendar.url}");
+                client.DefaultRequestHeaders.Authorization = null;
+
+                string httpUrl = calendar.url.Replace("webcal://", "https://");
+
+                if (!string.IsNullOrEmpty(calendar.auth))
+                {
+                    var byteArray = Encoding.ASCII.GetBytes($"{calendar.auth}");
+                    client.DefaultRequestHeaders.Authorization =
+                        new AuthenticationHeaderValue("Basic", Convert.ToBase64String(byteArray));
+                }
+
                 HttpResponseMessage response = await client.GetAsync(httpUrl);
                 if (response.IsSuccessStatusCode)
                 {
                     icals.Add(await response.Content.ReadAsStringAsync());
                 }
                 else
                 {
-                    throw new Exception("Failed to load calendar data");
+                    _logger.LogError($"Failed to load calendar data from '{httpUrl}' (Status: {response.StatusCode})");
                 }
             }
         }
 
         return icals;
     }
-
 }

ImmichFrame.WebApi/appsettings.Development.json

@@ -1,8 +1 @@
-{
-  "Logging": {
-    "LogLevel": {
-      "Default": "Information",
-      "Microsoft.AspNetCore": "Warning"
-    }
-  }
-}
+{}

docs/docs/getting-started/configuration.md

@@ -159,6 +159,14 @@ Weather is enabled by entering an API key. Get yours free from [OpenWeatherMap][
 ### Calendar
 If you are using Google Calendar, more information can be found [here](https://support.google.com/calendar/answer/37648?hl=en#zippy=%2Cget-your-calendar-view-only).
 
+Calendar supports basic authentication:
+Example:
+No Auth: `https://calendar.google.com/calendar/ical/XXXXXX/public/basic.ics`
+With Auth: `username:password;https://calendar.google.com/calendar/ical/XXXXXX/public/basic.ics`
+
+### Metadata
+Needs documentation
+
 ### Misc
 #### Webhook
 A webhook to notify an external service is available. This is only enabled when the `Webhook`-Setting is set in your configuration. Your configured Webhook will be notified via `HTTP POST`-request.