// #define LOG_SKIP using System.Net.Http.Json; using System.Text.Json; using System.Text.Json.Nodes; using System.Net.Http.Json; using System.Text.Json; using System.Text.Json.Nodes; using System.Text.Json.Serialization; using ArcaneLibs.Extensions; using LibMatrix.Homeservers.ImplementationDetails.Synapse.Models.Filters; using LibMatrix.Homeservers.ImplementationDetails.Synapse.Models.Requests; using LibMatrix.Homeservers.ImplementationDetails.Synapse.Models.Responses; using LibMatrix.Responses; using LibMatrix.Filters; using LibMatrix.Homeservers.ImplementationDetails.Synapse.Models.Filters; using LibMatrix.Homeservers.ImplementationDetails.Synapse.Models.Responses; using LibMatrix.Responses; namespace LibMatrix.Homeservers.ImplementationDetails.Synapse; public class SynapseAdminApiClient(AuthenticatedHomeserverSynapse authenticatedHomeserver) { private SynapseAdminUserCleanupExecutor UserCleanupExecutor { get; } = new(authenticatedHomeserver); // https://github.com/element-hq/synapse/tree/develop/docs/admin_api // https://github.com/element-hq/synapse/tree/develop/docs/usage/administration/admin_api #region Rooms public async IAsyncEnumerable SearchRoomsAsync(int limit = int.MaxValue, int chunkLimit = 250, string orderBy = "name", string dir = "f", string? searchTerm = null, SynapseAdminLocalRoomQueryFilter? localFilter = null) { SynapseAdminRoomListResult? res = null; var i = 0; int? totalRooms = null; do { var url = $"/_synapse/admin/v1/rooms?limit={Math.Min(limit, chunkLimit)}&dir={dir}&order_by={orderBy}"; if (!string.IsNullOrEmpty(searchTerm)) url += $"&search_term={searchTerm}"; if (res?.NextBatch is not null) url += $"&from={res.NextBatch}"; Console.WriteLine($"--- ADMIN Querying Room List with URL: {url} - Already have {i} items... ---"); res = await authenticatedHomeserver.ClientHttpClient.GetFromJsonAsync(url); totalRooms ??= res.TotalRooms; // Console.WriteLine(res.ToJson(false)); foreach (var room in res.Rooms) { if (localFilter is not null) { if (!string.IsNullOrWhiteSpace(localFilter.RoomIdContains) && !room.RoomId.Contains(localFilter.RoomIdContains, StringComparison.OrdinalIgnoreCase)) { totalRooms--; #if LOG_SKIP Console.WriteLine($"Skipped room {room.ToJson(indent: false)} on rule roomid."); #endif continue; } if (!string.IsNullOrWhiteSpace(localFilter.NameContains) && room.Name?.Contains(localFilter.NameContains, StringComparison.OrdinalIgnoreCase) != true) { totalRooms--; #if LOG_SKIP Console.WriteLine($"Skipped room {room.ToJson(indent: false)} on rule roomname."); #endif continue; } if (!string.IsNullOrWhiteSpace(localFilter.CanonicalAliasContains) && room.CanonicalAlias?.Contains(localFilter.CanonicalAliasContains, StringComparison.OrdinalIgnoreCase) != true) { totalRooms--; #if LOG_SKIP Console.WriteLine($"Skipped room {room.ToJson(indent: false)} on rule alias."); #endif continue; } if (!string.IsNullOrWhiteSpace(localFilter.VersionContains) && !room.Version.Contains(localFilter.VersionContains, StringComparison.OrdinalIgnoreCase)) { totalRooms--; #if LOG_SKIP Console.WriteLine($"Skipped room {room.ToJson(indent: false)} on rule version."); #endif continue; } if (!string.IsNullOrWhiteSpace(localFilter.CreatorContains) && !room.Creator.Contains(localFilter.CreatorContains, StringComparison.OrdinalIgnoreCase)) { totalRooms--; #if LOG_SKIP Console.WriteLine($"Skipped room {room.ToJson(indent: false)} on rule creator."); #endif continue; } if (!string.IsNullOrWhiteSpace(localFilter.EncryptionContains) && room.Encryption?.Contains(localFilter.EncryptionContains, StringComparison.OrdinalIgnoreCase) != true) { totalRooms--; #if LOG_SKIP Console.WriteLine($"Skipped room {room.ToJson(indent: false)} on rule encryption."); #endif continue; } if (!string.IsNullOrWhiteSpace(localFilter.JoinRulesContains) && room.JoinRules?.Contains(localFilter.JoinRulesContains, StringComparison.OrdinalIgnoreCase) != true) { totalRooms--; #if LOG_SKIP Console.WriteLine($"Skipped room {room.ToJson(indent: false)} on rule joinrules."); #endif continue; } if (!string.IsNullOrWhiteSpace(localFilter.GuestAccessContains) && room.GuestAccess?.Contains(localFilter.GuestAccessContains, StringComparison.OrdinalIgnoreCase) != true) { totalRooms--; #if LOG_SKIP Console.WriteLine($"Skipped room {room.ToJson(indent: false)} on rule guestaccess."); #endif continue; } if (!string.IsNullOrWhiteSpace(localFilter.HistoryVisibilityContains) && room.HistoryVisibility?.Contains(localFilter.HistoryVisibilityContains, StringComparison.OrdinalIgnoreCase) != true) { totalRooms--; #if LOG_SKIP Console.WriteLine($"Skipped room {room.ToJson(indent: false)} on rule history visibility."); #endif continue; } if (localFilter.CheckFederation && room.Federatable != localFilter.Federatable) { totalRooms--; #if LOG_SKIP Console.WriteLine($"Skipped room {room.ToJson(indent: false)} on rule federation."); #endif continue; } if (localFilter.CheckPublic && room.Public != localFilter.Public) { totalRooms--; #if LOG_SKIP Console.WriteLine($"Skipped room {room.ToJson(indent: false)} on rule public."); #endif continue; } if (room.StateEvents < localFilter.StateEventsGreaterThan || room.StateEvents > localFilter.StateEventsLessThan) { totalRooms--; #if LOG_SKIP Console.WriteLine($"Skipped room {room.ToJson(indent: false)} on rule joined local members."); #endif continue; } if (room.JoinedMembers < localFilter.JoinedMembersGreaterThan || room.JoinedMembers > localFilter.JoinedMembersLessThan) { totalRooms--; #if LOG_SKIP Console.WriteLine($"Skipped room {room.ToJson(indent: false)} on rule joined members: {localFilter.JoinedMembersGreaterThan} < {room.JoinedLocalMembers} < {localFilter.JoinedMembersLessThan}."); #endif continue; } if (room.JoinedLocalMembers < localFilter.JoinedLocalMembersGreaterThan || room.JoinedLocalMembers > localFilter.JoinedLocalMembersLessThan) { totalRooms--; #if LOG_SKIP Console.WriteLine($"Skipped room {room.ToJson(indent: false)} on rule joined local members: {localFilter.JoinedLocalMembersGreaterThan} < {room.JoinedLocalMembers} < {localFilter.JoinedLocalMembersLessThan}."); #endif continue; } } // if (contentSearch is not null && !string.IsNullOrEmpty(contentSearch) && // !( // room.Name?.Contains(contentSearch, StringComparison.InvariantCultureIgnoreCase) == true || // room.CanonicalAlias?.Contains(contentSearch, StringComparison.InvariantCultureIgnoreCase) == true || // room.Creator?.Contains(contentSearch, StringComparison.InvariantCultureIgnoreCase) == true // ) // ) { // totalRooms--; // continue; // } i++; yield return room; } } while (i < Math.Min(limit, totalRooms ?? limit)); } #endregion #region Users public async IAsyncEnumerable SearchUsersAsync(int limit = int.MaxValue, int chunkLimit = 250, SynapseAdminLocalUserQueryFilter? localFilter = null) { // TODO: implement filters string? from = null; while (limit > 0) { var url = new Uri("/_synapse/admin/v3/users", UriKind.Relative); url = url.AddQuery("limit", Math.Min(limit, chunkLimit).ToString()); if (!string.IsNullOrWhiteSpace(from)) url = url.AddQuery("from", from); Console.WriteLine($"--- ADMIN Querying User List with URL: {url} ---"); // TODO: implement URI methods in http client var res = await authenticatedHomeserver.ClientHttpClient.GetFromJsonAsync(url.ToString()); foreach (var user in res.Users) { limit--; yield return user; } if (string.IsNullOrWhiteSpace(res.NextToken)) break; from = res.NextToken; } } public async Task LoginUserAsync(string userId, TimeSpan expireAfter) { var url = new Uri($"/_synapse/admin/v1/users/{userId.UrlEncode()}/login", UriKind.Relative); url.AddQuery("valid_until_ms", DateTimeOffset.UtcNow.Add(expireAfter).ToUnixTimeMilliseconds().ToString()); var resp = await authenticatedHomeserver.ClientHttpClient.PostAsJsonAsync(url.ToString(), new()); var loginResp = await resp.Content.ReadFromJsonAsync(); loginResp.UserId = userId; // Synapse only returns the access token return loginResp; } #endregion #region Reports public async IAsyncEnumerable GetEventReportsAsync(int limit = int.MaxValue, int chunkLimit = 250, string dir = "f", SynapseAdminLocalEventReportQueryFilter? filter = null) { // TODO: implement filters string? from = null; while (limit > 0) { var url = new Uri("/_synapse/admin/v1/event_reports", UriKind.Relative); url = url.AddQuery("limit", Math.Min(limit, chunkLimit).ToString()); if (!string.IsNullOrWhiteSpace(from)) url = url.AddQuery("from", from); Console.WriteLine($"--- ADMIN Querying Reports with URL: {url} ---"); var res = await authenticatedHomeserver.ClientHttpClient.GetFromJsonAsync(url.ToString()); foreach (var report in res.Reports) { limit--; yield return report; } if (string.IsNullOrWhiteSpace(res.NextToken)) break; from = res.NextToken; } } public async Task GetEventReportDetailsAsync(string reportId) { var url = new Uri($"/_synapse/admin/v1/event_reports/{reportId.UrlEncode()}", UriKind.Relative); return await authenticatedHomeserver.ClientHttpClient .GetFromJsonAsync(url.ToString()); } // Utility function to get details straight away public async IAsyncEnumerable GetEventReportsWithDetailsAsync(int limit = int.MaxValue, int chunkLimit = 250, string dir = "f", SynapseAdminLocalEventReportQueryFilter? filter = null) { Queue> tasks = []; await foreach (var report in GetEventReportsAsync(limit, chunkLimit, dir, filter)) { tasks.Enqueue(GetEventReportDetailsAsync(report.Id)); while (tasks.Peek().IsCompleted) yield return await tasks.Dequeue(); // early return if possible } while (tasks.Count > 0) yield return await tasks.Dequeue(); } public async Task DeleteEventReportAsync(string reportId) { var url = new Uri($"/_synapse/admin/v1/event_reports/{reportId.UrlEncode()}", UriKind.Relative); await authenticatedHomeserver.ClientHttpClient.DeleteAsync(url.ToString()); } #endregion #region Background Updates public async Task GetBackgroundUpdatesEnabledAsync() { var url = new Uri("/_synapse/admin/v1/background_updates/enabled", UriKind.Relative); // The return type is technically wrong, but includes the field we want. var resp = await authenticatedHomeserver.ClientHttpClient.GetFromJsonAsync(url.ToString()); return resp.Enabled; } public async Task SetBackgroundUpdatesEnabledAsync(bool enabled) { var url = new Uri("/_synapse/admin/v1/background_updates/enabled", UriKind.Relative); // The used types are technically wrong, but include the field we want. var resp = await authenticatedHomeserver.ClientHttpClient.PostAsJsonAsync(url.ToString(), new JsonObject { ["enabled"] = enabled }); var json = await resp.Content.ReadFromJsonAsync(); return json!.Enabled; } public async Task GetBackgroundUpdatesStatusAsync() { var url = new Uri("/_synapse/admin/v1/background_updates/status", UriKind.Relative); return await authenticatedHomeserver.ClientHttpClient.GetFromJsonAsync(url.ToString()); } /// /// Run a background job /// /// One of "populate_stats_process_rooms" or "regenerate_directory" public async Task RunBackgroundJobsAsync(string jobName) { var url = new Uri("/_synapse/admin/v1/background_updates/run", UriKind.Relative); await authenticatedHomeserver.ClientHttpClient.PostAsJsonAsync(url.ToString(), new JsonObject() { ["job_name"] = jobName }); } #endregion #region Federation public async IAsyncEnumerable GetFederationDestinationsAsync(int limit = int.MaxValue, int chunkLimit = 250) { string? from = null; while (limit > 0) { var url = new Uri("/_synapse/admin/v1/federation/destinations", UriKind.Relative); url = url.AddQuery("limit", Math.Min(limit, chunkLimit).ToString()); if (!string.IsNullOrWhiteSpace(from)) url = url.AddQuery("from", from); Console.WriteLine($"--- ADMIN Querying Federation Destinations with URL: {url} ---"); var res = await authenticatedHomeserver.ClientHttpClient.GetFromJsonAsync(url.ToString()); foreach (var dest in res.Destinations) { limit--; yield return dest; } } } public async Task GetFederationDestinationDetailsAsync(string destination) { var url = new Uri($"/_synapse/admin/v1/federation/destinations/{destination}", UriKind.Relative); return await authenticatedHomeserver.ClientHttpClient.GetFromJsonAsync(url.ToString()); } public async IAsyncEnumerable GetFederationDestinationRoomsAsync(string destination, int limit = int.MaxValue, int chunkLimit = 250) { string? from = null; while (limit > 0) { var url = new Uri($"/_synapse/admin/v1/federation/destinations/{destination}/rooms", UriKind.Relative); url = url.AddQuery("limit", Math.Min(limit, chunkLimit).ToString()); if (!string.IsNullOrWhiteSpace(from)) url = url.AddQuery("from", from); Console.WriteLine($"--- ADMIN Querying Federation Destination Rooms with URL: {url} ---"); var res = await authenticatedHomeserver.ClientHttpClient.GetFromJsonAsync(url.ToString()); foreach (var room in res.Rooms) { limit--; yield return room; } } } public async Task ResetFederationConnectionTimeoutAsync(string destination) { await authenticatedHomeserver.ClientHttpClient.PostAsJsonAsync($"/_synapse/admin/v1/federation/destinations/{destination}/reset_connection", new JsonObject()); } #endregion #region Registration Tokens // does not support pagination public async Task> GetRegistrationTokensAsync() { var url = new Uri("/_synapse/admin/v1/registration_tokens", UriKind.Relative); var resp = await authenticatedHomeserver.ClientHttpClient.GetFromJsonAsync(url.ToString()); return resp.RegistrationTokens; } public async Task GetRegistrationTokenAsync(string token) { var url = new Uri($"/_synapse/admin/v1/registration_tokens/{token.UrlEncode()}", UriKind.Relative); var resp = await authenticatedHomeserver.ClientHttpClient.GetFromJsonAsync(url.ToString()); return resp; } public async Task CreateRegistrationTokenAsync( SynapseAdminRegistrationTokenCreateRequest request) { var url = new Uri("/_synapse/admin/v1/", UriKind.Relative); var resp = await authenticatedHomeserver.ClientHttpClient.PostAsJsonAsync(url.ToString(), request); var token = await resp.Content.ReadFromJsonAsync(); return token!; } public async Task UpdateRegistrationTokenAsync(string token, SynapseAdminRegistrationTokenUpdateRequest request) { var url = new Uri($"/_synapse/admin/v1/registration_tokens/{token.UrlEncode()}", UriKind.Relative); var resp = await authenticatedHomeserver.ClientHttpClient.PutAsJsonAsync(url.ToString(), request); return await resp.Content.ReadFromJsonAsync(); } public async Task DeleteRegistrationTokenAsync(string token) { var url = new Uri($"/_synapse/admin/v1/registration_tokens/{token.UrlEncode()}", UriKind.Relative); await authenticatedHomeserver.ClientHttpClient.DeleteAsync(url.ToString()); } #endregion #region Account Validity // Does anyone even use this? // README: https://github.com/matrix-org/synapse/issues/15271 // -> Don't implement unless requested, if not for this feature almost never being used. #endregion #region Experimental Features public async Task> GetExperimentalFeaturesAsync(string userId) { var url = new Uri($"/_synapse/admin/v1/experimental_features/{userId.UrlEncode()}", UriKind.Relative); var resp = await authenticatedHomeserver.ClientHttpClient.GetFromJsonAsync(url.ToString()); return resp["features"]!.GetValue>(); } public async Task SetExperimentalFeaturesAsync(string userId, Dictionary features) { var url = new Uri($"/_synapse/admin/v1/experimental_features/{userId.UrlEncode()}", UriKind.Relative); await authenticatedHomeserver.ClientHttpClient.PostAsJsonAsync(url.ToString(), new JsonObject { ["features"] = JsonSerializer.Deserialize(features.ToJson()) }); } #endregion #region Media public async Task GetRoomMediaAsync(string roomId) { var url = new Uri($"/_synapse/admin/v1/room/{roomId.UrlEncode()}/media", UriKind.Relative); return await authenticatedHomeserver.ClientHttpClient.GetFromJsonAsync(url.ToString()); } // This is in the user admin API section // public async IAsyncEnumerable #endregion public async Task DeleteAllMessages(string mxid, List? rooms = null, string? reason = null, int? limit = 100000, bool waitForCompletion = true) { rooms ??= []; Dictionary payload = new(); if (rooms.Count > 0) payload["rooms"] = rooms; if (!string.IsNullOrEmpty(reason)) payload["reason"] = reason; if (limit.HasValue) payload["limit"] = limit.Value; var redactIdResp = await authenticatedHomeserver.ClientHttpClient.PostAsJsonAsync($"/_synapse/admin/v1/user/{mxid}/redact", payload); var redactId = await redactIdResp.Content.ReadFromJsonAsync(); if (waitForCompletion) { while (true) { var status = await GetRedactStatus(redactId!.RedactionId); if (status?.Status != "pending") break; await Task.Delay(1000); } } return redactId; } public async Task GetRedactStatus(string redactId) { return await authenticatedHomeserver.ClientHttpClient.GetFromJsonAsync( $"/_synapse/admin/v1/user/redact_status/{redactId}"); } public async Task DeactivateUserAsync(string mxid, bool erase = false, bool eraseMessages = false, bool extraCleanup = false) { if (eraseMessages) { await DeleteAllMessages(mxid); } if (extraCleanup) { await UserCleanupExecutor.CleanupUser(mxid); } await authenticatedHomeserver.ClientHttpClient.PostAsJsonAsync($"/_synapse/admin/v1/deactivate", new { erase }); } public async Task ResetPasswordAsync(string mxid, string newPassword, bool logoutDevices = false) { await authenticatedHomeserver.ClientHttpClient.PostAsJsonAsync($"/_synapse/admin/v1/reset_password/{mxid}", new { new_password = newPassword, logout_devices = logoutDevices }); } public async Task GetUserMediaAsync(string mxid, int? limit = 100, string? from = null, string? orderBy = null, string? dir = null) { var url = $"/_synapse/admin/v1/users/{mxid}/media"; if (limit.HasValue) url += $"?limit={limit}"; if (!string.IsNullOrEmpty(from)) url += $"&from={from}"; if (!string.IsNullOrEmpty(orderBy)) url += $"&order_by={orderBy}"; if (!string.IsNullOrEmpty(dir)) url += $"&dir={dir}"; return await authenticatedHomeserver.ClientHttpClient.GetFromJsonAsync(url); } public async IAsyncEnumerable GetUserMediaEnumerableAsync(string mxid, int chunkSize = 100, string? orderBy = null, string? dir = null) { SynapseAdminUserMediaResult? res = null; do { res = await GetUserMediaAsync(mxid, chunkSize, res?.NextToken, orderBy, dir); foreach (var media in res.Media) { yield return media; } } while (!string.IsNullOrEmpty(res.NextToken)); } public async Task BlockRoom(string roomId, bool block = true) { await authenticatedHomeserver.ClientHttpClient.PutAsJsonAsync($"/_synapse/admin/v1/rooms/{roomId}/block", new { block }); } public async Task DeleteRoom(string roomId, SynapseAdminRoomDeleteRequest request, bool waitForCompletion = true) { var resp = await authenticatedHomeserver.ClientHttpClient.DeleteAsJsonAsync($"/_synapse/admin/v2/rooms/{roomId}", request); var deleteResp = await resp.Content.ReadFromJsonAsync(); if (waitForCompletion) { while (true) { var status = await GetRoomDeleteStatus(deleteResp!.DeleteId); if (status?.Status != "pending") break; await Task.Delay(1000); } } return deleteResp!; } public async Task GetRoomDeleteStatusByRoomId(string roomId) { return await authenticatedHomeserver.ClientHttpClient.GetFromJsonAsync( $"/_synapse/admin/v2/rooms/{roomId}/delete_status"); } public async Task GetRoomDeleteStatus(string deleteId) { return await authenticatedHomeserver.ClientHttpClient.GetFromJsonAsync( $"/_synapse/admin/v2/rooms/delete_status/{deleteId}"); } public async Task GetRoomMembersAsync(string roomId) { return await authenticatedHomeserver.ClientHttpClient.GetFromJsonAsync($"/_synapse/admin/v1/rooms/{roomId}/members"); } public async Task QuarantineMediaByRoomId(string roomId) { await authenticatedHomeserver.ClientHttpClient.PutAsJsonAsync($"/_synapse/admin/v1/room/{roomId}/media/quarantine", new { }); } public async Task QuarantineMediaByUserId(string mxid) { await authenticatedHomeserver.ClientHttpClient.PutAsJsonAsync($"/_synapse/admin/v1/user/{mxid}/media/quarantine", new { }); } public async Task QuarantineMediaById(string serverName, string mediaId) { await authenticatedHomeserver.ClientHttpClient.PutAsJsonAsync($"/_synapse/admin/v1/media/quarantine/{serverName}/{mediaId}", new { }); } public async Task QuarantineMediaById(MxcUri mxcUri) { await authenticatedHomeserver.ClientHttpClient.PutAsJsonAsync($"/_synapse/admin/v1/media/quarantine/{mxcUri.ServerName}/{mxcUri.MediaId}", new { }); } public async Task DeleteMediaById(string serverName, string mediaId) { await authenticatedHomeserver.ClientHttpClient.DeleteAsync($"/_synapse/admin/v1/media/{serverName}/{mediaId}"); } public async Task DeleteMediaById(MxcUri mxcUri) { await authenticatedHomeserver.ClientHttpClient.DeleteAsync($"/_synapse/admin/v1/media/{mxcUri.ServerName}/{mxcUri.MediaId}"); } }