-
-
Notifications
You must be signed in to change notification settings - Fork 116
continuwuityadmin: Add room admin endpoints #452
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
timedoutuk
wants to merge
2
commits into
main
Choose a base branch
from
nexy7574/c10y-admin-api
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+82
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| package continuwuityadmin | ||
|
|
||
| import ( | ||
| "maunium.net/go/mautrix" | ||
| ) | ||
|
|
||
| // Client is a wrapper for the mautrix.Client struct that includes methods for accessing the Continuwuity admin API. | ||
| type Client struct { | ||
| Client *mautrix.Client | ||
| } | ||
|
|
||
| func (cli *Client) BuildAdminURL(path ...any) string { | ||
| return cli.Client.BuildURL(mautrix.ContinuwuityAdminURLPath(path)) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| package continuwuityadmin | ||
|
|
||
| import ( | ||
| "context" | ||
| "net/http" | ||
|
|
||
| "maunium.net/go/mautrix" | ||
| "maunium.net/go/mautrix/id" | ||
| ) | ||
|
|
||
| // RespGetRooms represents the response for `GET /_continuwuity/admin/rooms/list`. | ||
| type RespGetRooms struct { | ||
| Rooms []id.RoomID `json:"rooms"` | ||
| } | ||
|
|
||
| // ReqBanRoom represents the request body for `PUT /_continuwuity/admin/rooms/{room_id}/ban`. | ||
| type ReqBanRoom struct { | ||
| RoomID id.RoomID `json:"room_id"` | ||
| Banned bool `json:"banned"` | ||
| } | ||
|
|
||
| // RespBanRoom represents the response for `PUT /_continuwuity/admin/rooms/{room_id}/ban`. | ||
| type RespBanRoom struct { | ||
| KickedUsers []id.UserID `json:"kicked_users"` | ||
| FailedKickedUsers []id.UserID `json:"failed_kicked_users"` | ||
| LocalAliases []id.RoomAlias `json:"local_aliases"` | ||
| } | ||
|
|
||
| // ListRooms retrieves a list of all room IDs known to the server (excluding banned rooms). | ||
| func (cli *Client) ListRooms(ctx context.Context) (resp *RespGetRooms, err error) { | ||
| reqURL := cli.Client.BuildURL(mautrix.ContinuwuityAdminURLPath{"rooms", "list"}) | ||
| _, err = cli.Client.MakeRequest(ctx, http.MethodGet, reqURL, nil, &resp) | ||
| return resp, err | ||
| } | ||
|
|
||
| // BanRoom bans a room. | ||
| // | ||
| // This will first remove all local users, and then remove all local aliases, | ||
| // returning a list of users that were removed, failed to be removed, and aliases | ||
| // that were removed. | ||
| // | ||
| // This operation may take a long time. | ||
| func (cli *Client) BanRoom(ctx context.Context, roomID id.RoomID) (resp *RespBanRoom, err error) { | ||
| body := ReqBanRoom{ | ||
| RoomID: roomID, | ||
| Banned: true, | ||
| } | ||
| reqURL := cli.Client.BuildURL(mautrix.ContinuwuityAdminURLPath{"rooms", roomID, "ban"}) | ||
| _, err = cli.Client.MakeRequest(ctx, http.MethodPut, reqURL, &body, &resp) | ||
| return resp, err | ||
| } | ||
|
|
||
| // UnbanRoom unbans a room. | ||
| func (cli *Client) UnbanRoom(ctx context.Context, roomID id.RoomID) (resp *RespBanRoom, err error) { | ||
| body := ReqBanRoom{ | ||
| RoomID: roomID, | ||
| Banned: false, | ||
| } | ||
| reqURL := cli.Client.BuildURL(mautrix.ContinuwuityAdminURLPath{"rooms", roomID, "ban"}) | ||
| _, err = cli.Client.MakeRequest(ctx, http.MethodPut, reqURL, &body, &resp) | ||
| return resp, err | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should probably just type alias to the synapse type after renaming failed_kicked_users to failed_to_kick_users