about summary refs log tree commit diff
path: root/LibMatrix/Homeservers
diff options
context:
space:
mode:
authorRory& <root@rory.gay>2024-08-08 02:44:16 +0200
committerRory& <root@rory.gay>2024-08-08 02:44:16 +0200
commitbba7333ee6581a92bbbc7479d72325e704fe7fa6 (patch)
treebfbc301f5ee9c51a672534b7ec8eea64c71569c3 /LibMatrix/Homeservers
parentSync storage (diff)
downloadLibMatrix-bba7333ee6581a92bbbc7479d72325e704fe7fa6.tar.xz
More synapse admin apis
Diffstat (limited to 'LibMatrix/Homeservers')
-rw-r--r--LibMatrix/Homeservers/AuthenticatedHomeserverSynapse.cs1
-rw-r--r--LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Filters/SynapseAdminLocalEventReportQueryFilter.cs27
-rw-r--r--LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Filters/SynapseAdminLocalRoomQueryFilter.cs27
-rw-r--r--LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Filters/SynapseAdminLocalUserQueryFilter.cs27
-rw-r--r--LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Responses/AdminRoomListResult.cs (renamed from LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Responses/AdminRoomListingResult.cs)8
-rw-r--r--LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Responses/AdminUserListResult.cs58
-rw-r--r--LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Responses/SynapseAdminEventReportListResult.cs58
-rw-r--r--LibMatrix/Homeservers/ImplementationDetails/Synapse/SynapseAdminApiClient.cs80
8 files changed, 275 insertions, 11 deletions
diff --git a/LibMatrix/Homeservers/AuthenticatedHomeserverSynapse.cs b/LibMatrix/Homeservers/AuthenticatedHomeserverSynapse.cs
index 83ebf20..9acdd58 100644
--- a/LibMatrix/Homeservers/AuthenticatedHomeserverSynapse.cs
+++ b/LibMatrix/Homeservers/AuthenticatedHomeserverSynapse.cs
@@ -1,7 +1,6 @@
 using ArcaneLibs.Extensions;
 using LibMatrix.Filters;
 using LibMatrix.Homeservers.ImplementationDetails.Synapse;
-using LibMatrix.Responses.Admin;
 using LibMatrix.Services;
 
 namespace LibMatrix.Homeservers;
diff --git a/LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Filters/SynapseAdminLocalEventReportQueryFilter.cs b/LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Filters/SynapseAdminLocalEventReportQueryFilter.cs
new file mode 100644
index 0000000..c34ad7c
--- /dev/null
+++ b/LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Filters/SynapseAdminLocalEventReportQueryFilter.cs
@@ -0,0 +1,27 @@
+namespace LibMatrix.Homeservers.ImplementationDetails.Synapse.Models.Filters;
+
+public class SynapseAdminLocalEventReportQueryFilter {
+    public string UserIdContains { get; set; } = "";
+    public string NameContains { get; set; } = "";
+    public string CanonicalAliasContains { get; set; } = "";
+    public string VersionContains { get; set; } = "";
+    public string CreatorContains { get; set; } = "";
+    public string EncryptionContains { get; set; } = "";
+    public string JoinRulesContains { get; set; } = "";
+    public string GuestAccessContains { get; set; } = "";
+    public string HistoryVisibilityContains { get; set; } = "";
+
+    public bool Federatable { get; set; } = true;
+    public bool Public { get; set; } = true;
+
+    public int JoinedMembersGreaterThan { get; set; }
+    public int JoinedMembersLessThan { get; set; } = int.MaxValue;
+
+    public int JoinedLocalMembersGreaterThan { get; set; }
+    public int JoinedLocalMembersLessThan { get; set; } = int.MaxValue;
+    public int StateEventsGreaterThan { get; set; }
+    public int StateEventsLessThan { get; set; } = int.MaxValue;
+
+    public bool CheckFederation { get; set; }
+    public bool CheckPublic { get; set; }
+}
\ No newline at end of file
diff --git a/LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Filters/SynapseAdminLocalRoomQueryFilter.cs b/LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Filters/SynapseAdminLocalRoomQueryFilter.cs
new file mode 100644
index 0000000..b8929a0
--- /dev/null
+++ b/LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Filters/SynapseAdminLocalRoomQueryFilter.cs
@@ -0,0 +1,27 @@
+namespace LibMatrix.Homeservers.ImplementationDetails.Synapse.Models.Filters;
+
+public class SynapseAdminLocalRoomQueryFilter {
+    public string RoomIdContains { get; set; } = "";
+    public string NameContains { get; set; } = "";
+    public string CanonicalAliasContains { get; set; } = "";
+    public string VersionContains { get; set; } = "";
+    public string CreatorContains { get; set; } = "";
+    public string EncryptionContains { get; set; } = "";
+    public string JoinRulesContains { get; set; } = "";
+    public string GuestAccessContains { get; set; } = "";
+    public string HistoryVisibilityContains { get; set; } = "";
+
+    public bool Federatable { get; set; } = true;
+    public bool Public { get; set; } = true;
+
+    public int JoinedMembersGreaterThan { get; set; }
+    public int JoinedMembersLessThan { get; set; } = int.MaxValue;
+
+    public int JoinedLocalMembersGreaterThan { get; set; }
+    public int JoinedLocalMembersLessThan { get; set; } = int.MaxValue;
+    public int StateEventsGreaterThan { get; set; }
+    public int StateEventsLessThan { get; set; } = int.MaxValue;
+
+    public bool CheckFederation { get; set; }
+    public bool CheckPublic { get; set; }
+}
\ No newline at end of file
diff --git a/LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Filters/SynapseAdminLocalUserQueryFilter.cs b/LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Filters/SynapseAdminLocalUserQueryFilter.cs
new file mode 100644
index 0000000..62b291b
--- /dev/null
+++ b/LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Filters/SynapseAdminLocalUserQueryFilter.cs
@@ -0,0 +1,27 @@
+namespace LibMatrix.Homeservers.ImplementationDetails.Synapse.Models.Filters;
+
+public class SynapseAdminLocalUserQueryFilter {
+    public string UserIdContains { get; set; } = "";
+    public string NameContains { get; set; } = "";
+    public string CanonicalAliasContains { get; set; } = "";
+    public string VersionContains { get; set; } = "";
+    public string CreatorContains { get; set; } = "";
+    public string EncryptionContains { get; set; } = "";
+    public string JoinRulesContains { get; set; } = "";
+    public string GuestAccessContains { get; set; } = "";
+    public string HistoryVisibilityContains { get; set; } = "";
+
+    public bool Federatable { get; set; } = true;
+    public bool Public { get; set; } = true;
+
+    public int JoinedMembersGreaterThan { get; set; }
+    public int JoinedMembersLessThan { get; set; } = int.MaxValue;
+
+    public int JoinedLocalMembersGreaterThan { get; set; }
+    public int JoinedLocalMembersLessThan { get; set; } = int.MaxValue;
+    public int StateEventsGreaterThan { get; set; }
+    public int StateEventsLessThan { get; set; } = int.MaxValue;
+
+    public bool CheckFederation { get; set; }
+    public bool CheckPublic { get; set; }
+}
\ No newline at end of file
diff --git a/LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Responses/AdminRoomListingResult.cs b/LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Responses/AdminRoomListResult.cs
index 7ab96ac..c9d7e52 100644
--- a/LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Responses/AdminRoomListingResult.cs
+++ b/LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Responses/AdminRoomListResult.cs
@@ -1,8 +1,8 @@
 using System.Text.Json.Serialization;
 
-namespace LibMatrix.Responses.Admin;
+namespace LibMatrix.Homeservers.ImplementationDetails.Synapse.Models.Responses;
 
-public class AdminRoomListingResult {
+public class AdminRoomListResult {
     [JsonPropertyName("offset")]
     public int Offset { get; set; }
 
@@ -16,9 +16,9 @@ public class AdminRoomListingResult {
     public int? PrevBatch { get; set; }
 
     [JsonPropertyName("rooms")]
-    public List<AdminRoomListingResultRoom> Rooms { get; set; } = new();
+    public List<AdminRoomListResultRoom> Rooms { get; set; } = new();
 
-    public class AdminRoomListingResultRoom {
+    public class AdminRoomListResultRoom {
         [JsonPropertyName("room_id")]
         public required string RoomId { get; set; }
 
diff --git a/LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Responses/AdminUserListResult.cs b/LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Responses/AdminUserListResult.cs
new file mode 100644
index 0000000..9b0c481
--- /dev/null
+++ b/LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Responses/AdminUserListResult.cs
@@ -0,0 +1,58 @@
+using System.Text.Json.Serialization;
+
+namespace LibMatrix.Homeservers.ImplementationDetails.Synapse.Models.Responses;
+
+public class AdminUserListResult {
+    [JsonPropertyName("offset")]
+    public int Offset { get; set; }
+
+    [JsonPropertyName("total")]
+    public int Total { get; set; }
+
+    [JsonPropertyName("next_token")]
+    public string? NextToken { get; set; }
+
+    [JsonPropertyName("users")]
+    public List<AdminUserListResultUser> Users { get; set; } = new();
+
+    public class AdminUserListResultUser {
+        [JsonPropertyName("name")]
+        public string Name { get; set; }
+
+        [JsonPropertyName("is_guest")]
+        public bool? IsGuest { get; set; }
+
+        [JsonPropertyName("admin")]
+        public bool? Admin { get; set; }
+
+        [JsonPropertyName("user_type")]
+        public string? UserType { get; set; }
+
+        [JsonPropertyName("deactivated")]
+        public bool Deactivated { get; set; }
+
+        [JsonPropertyName("erased")]
+        public bool Erased { get; set; }
+
+        [JsonPropertyName("shadow_banned")]
+        public bool ShadowBanned { get; set; }
+
+        [JsonPropertyName("displayname")]
+        public string? DisplayName { get; set; }
+
+        [JsonPropertyName("avatar_url")]
+        public string? AvatarUrl { get; set; }
+
+        [JsonPropertyName("creation_ts")]
+        public long CreationTs { get; set; }
+
+        [JsonPropertyName("last_seen_ts")]
+        public long? LastSeenTs { get; set; }
+
+        [JsonPropertyName("locked")]
+        public bool Locked { get; set; }
+
+        [JsonPropertyName("approved")]
+        public bool Approved { get; set; }
+    }
+}
\ No newline at end of file
diff --git a/LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Responses/SynapseAdminEventReportListResult.cs b/LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Responses/SynapseAdminEventReportListResult.cs
new file mode 100644
index 0000000..030108a
--- /dev/null
+++ b/LibMatrix/Homeservers/ImplementationDetails/Synapse/Models/Responses/SynapseAdminEventReportListResult.cs
@@ -0,0 +1,58 @@
+using System.Text.Json.Serialization;
+
+namespace LibMatrix.Homeservers.ImplementationDetails.Synapse.Models.Responses;
+
+public class SynapseAdminEventReportListResult {
+    [JsonPropertyName("offset")]
+    public int Offset { get; set; }
+
+    [JsonPropertyName("total")]
+    public int Total { get; set; }
+
+    [JsonPropertyName("next_token")]
+    public string? NextToken { get; set; }
+
+    [JsonPropertyName("event_reports")]
+    public List<SynapseAdminEventReportListResultReport> Reports { get; set; } = new();
+
+    public class SynapseAdminEventReportListResultReport {
+        [JsonPropertyName("name")]
+        public string Name { get; set; }
+
+        [JsonPropertyName("is_guest")]
+        public bool? IsGuest { get; set; }
+
+        [JsonPropertyName("admin")]
+        public bool? Admin { get; set; }
+
+        [JsonPropertyName("user_type")]
+        public string? UserType { get; set; }
+
+        [JsonPropertyName("deactivated")]
+        public bool Deactivated { get; set; }
+
+        [JsonPropertyName("erased")]
+        public bool Erased { get; set; }
+
+        [JsonPropertyName("shadow_banned")]
+        public bool ShadowBanned { get; set; }
+
+        [JsonPropertyName("displayname")]
+        public string? DisplayName { get; set; }
+
+        [JsonPropertyName("avatar_url")]
+        public string? AvatarUrl { get; set; }
+
+        [JsonPropertyName("creation_ts")]
+        public long CreationTs { get; set; }
+
+        [JsonPropertyName("last_seen_ts")]
+        public long? LastSeenTs { get; set; }
+
+        [JsonPropertyName("locked")]
+        public bool Locked { get; set; }
+
+        [JsonPropertyName("approved")]
+        public bool Approved { get; set; }
+    }
+}
\ No newline at end of file
diff --git a/LibMatrix/Homeservers/ImplementationDetails/Synapse/SynapseAdminApiClient.cs b/LibMatrix/Homeservers/ImplementationDetails/Synapse/SynapseAdminApiClient.cs
index ac94a7a..b3902eb 100644
--- a/LibMatrix/Homeservers/ImplementationDetails/Synapse/SynapseAdminApiClient.cs
+++ b/LibMatrix/Homeservers/ImplementationDetails/Synapse/SynapseAdminApiClient.cs
@@ -1,24 +1,32 @@
+using System.Net.Http.Json;
+using System.Text.Json.Nodes;
 using ArcaneLibs.Extensions;
 using LibMatrix.Filters;
-using LibMatrix.Responses.Admin;
+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) {
-    public async IAsyncEnumerable<AdminRoomListingResult.AdminRoomListingResultRoom> SearchRoomsAsync(int limit = int.MaxValue, string orderBy = "name", string dir = "f",
-        string? searchTerm = null, LocalRoomQueryFilter? localFilter = null) {
-        AdminRoomListingResult? res = null;
+    // https://github.com/element-hq/synapse/tree/develop/docs/admin_api
+
+#region Rooms
+
+    public async IAsyncEnumerable<AdminRoomListResult.AdminRoomListResultRoom> SearchRoomsAsync(int limit = int.MaxValue, int chunkLimit = 250, string orderBy = "name",
+        string dir = "f", string? searchTerm = null, SynapseAdminLocalRoomQueryFilter? localFilter = null) {
+        AdminRoomListResult? res = null;
         var i = 0;
         int? totalRooms = null;
         do {
-            var url = $"/_synapse/admin/v1/rooms?limit={Math.Min(limit, 250)}&dir={dir}&order_by={orderBy}";
+            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<AdminRoomListingResult>(url);
+            res = await authenticatedHomeserver.ClientHttpClient.GetFromJsonAsync<AdminRoomListResult>(url);
             totalRooms ??= res.TotalRooms;
             Console.WriteLine(res.ToJson(false));
             foreach (var room in res.Rooms) {
@@ -104,4 +112,64 @@ public class SynapseAdminApiClient(AuthenticatedHomeserverSynapse authenticatedH
             }
         } while (i < Math.Min(limit, totalRooms ?? limit));
     }
+
+#endregion
+
+#region Users
+
+    public async IAsyncEnumerable<AdminUserListResult.AdminUserListResultUser> 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<AdminUserListResult>(url.ToString());
+            foreach (var user in res.Users) {
+                limit--;
+                yield return user;
+            }
+
+            if (string.IsNullOrWhiteSpace(res.NextToken)) break;
+            from = res.NextToken;
+        }
+    }
+
+    public async Task<LoginResponse> 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<JsonObject>(url.ToString(), new());
+        var loginResp = await resp.Content.ReadFromJsonAsync<LoginResponse>();
+        loginResp.UserId = userId; // Synapse only returns the access token
+        return loginResp;
+    }
+
+#endregion
+
+#region Reports
+
+    public async IAsyncEnumerable<SynapseAdminEventReportListResult.SynapseAdminEventReportListResultReport> 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<SynapseAdminEventReportListResult>(url.ToString());
+            foreach (var report in res.Reports) {
+                limit--;
+                yield return report;
+            }
+
+            if (string.IsNullOrWhiteSpace(res.NextToken)) break;
+            from = res.NextToken;
+        }
+    }
+
+#endregion
 }
\ No newline at end of file