From 739a1603caa33ed113335ec64c900e1c559e3ef2 Mon Sep 17 00:00:00 2001 From: thepra Date: Tue, 10 Nov 2026 01:59:20 +0100 Subject: [PATCH] Every route is a constant in ApiPaths All 384 routes, the Mastodon API, the client API and the frozen federation paths, are read from one class with one nested class per controller. Their values are unchanged, checked one by one against the old literals; decePubClient keeps its own APIs class. Checked against GoToSocial in the pasture: 64 passed, 0 failed. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01W4YtEJrgxG12Pc39Fai8Bd --- CLAUDE.md | 6 +- PrivaPub/Api/Mastodon/Auth/TokenController.cs | 2 +- .../Controllers/AccountsController.cs | 72 +-- .../Controllers/AnnouncementsController.cs | 8 +- .../Mastodon/Controllers/AppsController.cs | 4 +- .../Mastodon/Controllers/CdnsController.cs | 4 +- .../Controllers/CustomEmojisController.cs | 2 +- .../Controllers/FeaturedTagsController.cs | 10 +- .../Mastodon/Controllers/FiltersController.cs | 38 +- .../Controllers/InstanceController.cs | 20 +- .../Mastodon/Controllers/ListsController.cs | 20 +- .../Mastodon/Controllers/MediaController.cs | 10 +- .../NotificationRequestsController.cs | 22 +- .../Mastodon/Controllers/PollsController.cs | 4 +- .../Controllers/ProvenanceController.cs | 8 +- .../Mastodon/Controllers/PushController.cs | 8 +- .../Controllers/ReactionsController.cs | 6 +- .../Mastodon/Controllers/ReportsController.cs | 2 +- .../ScheduledStatusesController.cs | 8 +- .../Mastodon/Controllers/SearchController.cs | 30 +- .../Controllers/StatusesController.cs | 56 +- .../Controllers/StreamingController.cs | 6 +- .../Controllers/SuggestionsController.cs | 6 +- .../Mastodon/Controllers/TagsController.cs | 12 +- .../Controllers/TimelinesController.cs | 42 +- .../Mastodon/Controllers/TrendsController.cs | 8 +- PrivaPub/ApiPaths.cs | 577 ++++++++++++++++++ .../ClientToServer/AdminController.cs | 20 +- .../ClientToServer/BackupController.cs | 24 +- .../ClientToServer/DataController.cs | 8 +- .../ClientToServer/DomainBlockController.cs | 8 +- .../ClientToServer/EmojiAdminController.cs | 10 +- .../ClientToServer/GroupController.cs | 22 +- .../ClientToServer/InstanceAdminController.cs | 30 +- .../ClientToServer/ModeratorController.cs | 18 +- .../PersonaArchiveController.cs | 22 +- .../ClientToServer/PostController.cs | 16 +- .../ClientToServer/PrivateAvatarController.cs | 14 +- .../ClientToServer/RootUserController.cs | 52 +- .../ClientToServer/SocialController.cs | 8 +- .../ClientToServer/StatisticsController.cs | 18 +- .../ClientToServer/TimelineController.cs | 8 +- .../Controllers/EmojisController.cs | 2 +- .../Controllers/PeasantsController.cs | 42 +- .../Federation/Controllers/UsersController.cs | 4 +- .../Controllers/WellKnownController.cs | 6 +- PrivaPub/Program.cs | 2 +- 47 files changed, 952 insertions(+), 373 deletions(-) create mode 100644 PrivaPub/ApiPaths.cs diff --git a/CLAUDE.md b/CLAUDE.md index 5389f91..b3009c5 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1095,8 +1095,10 @@ same rules. Applied to PrivaPub: (HR0009). - Numbers shown to a reader go through formatting helpers (HR0011). The ISO week key (`InstanceDescriber.Week`) and the six-digit email code (`EmailVerificationJob.NewCode`) are identifiers, and say so. -- **Still open:** route constants shared with decePubClient (HR0305; the frozen literals above stay their values) - and source-generated JSON contexts (HR0306). +- **Routes** are constants in `PrivaPub/ApiPaths.cs` (HR0305): one nested class per controller, `GET_`/`POST_`/…, + `_M_` when the template has parameters, `Prefix` for a controller's own `[Route]`. The values are the frozen routes + above, never changed by a rename. decePubClient keeps its own `APIs` class (owner, 2026-11-10: kept separate). +- **Still open:** source-generated JSON contexts (HR0306). ## Verifying diff --git a/PrivaPub/Api/Mastodon/Auth/TokenController.cs b/PrivaPub/Api/Mastodon/Auth/TokenController.cs index 2140321..432cb36 100644 --- a/PrivaPub/Api/Mastodon/Auth/TokenController.cs +++ b/PrivaPub/Api/Mastodon/Auth/TokenController.cs @@ -18,7 +18,7 @@ namespace PrivaPub.Api.Mastodon.Auth public class TokenController( DbEntities dbEntities) : ControllerBase { - [HttpPost("/oauth/token"), IgnoreAntiforgeryToken, Produces("application/json")] + [HttpPost(ApiPaths.Token.POST_Exchange), IgnoreAntiforgeryToken, Produces("application/json")] public async Task Exchange(CancellationToken token) { var request = HttpContext.GetOpenIddictServerRequest(); diff --git a/PrivaPub/Api/Mastodon/Controllers/AccountsController.cs b/PrivaPub/Api/Mastodon/Controllers/AccountsController.cs index 2257523..3251e05 100644 --- a/PrivaPub/Api/Mastodon/Controllers/AccountsController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/AccountsController.cs @@ -33,10 +33,10 @@ namespace PrivaPub.Api.Mastodon.Controllers IFeedFollows feedFollows) : MastodonController { // Mastodon 4.4: a token with the profile scope alone may read it too - [HttpGet("/api/v1/accounts/verify_credentials"), Scope("read:accounts|profile")] + [HttpGet(ApiPaths.Accounts.GET_VerifyCredentials), Scope("read:accounts|profile")] public async Task VerifyCredentials(CancellationToken token) => Json(await mapper.Local(Me, withSource: true, token)); - [HttpPatch("/api/v1/accounts/update_credentials"), Scope("write:accounts"), EnableRateLimiting(RateLimiting.Uploads), RequestSizeLimit(20 * 1024 * 1024), + [HttpPatch(ApiPaths.Accounts.PATCH_UpdateCredentials), Scope("write:accounts"), EnableRateLimiting(RateLimiting.Uploads), RequestSizeLimit(20 * 1024 * 1024), RequestFormLimits(MultipartBodyLengthLimit = 20 * 1024 * 1024)] public async Task UpdateCredentials([FromServices] IMediaService media, CancellationToken token) { @@ -113,10 +113,10 @@ namespace PrivaPub.Api.Mastodon.Controllers } // Mastodon's: the picture goes (to the trash), the profile shows the default again, and followers are told - [HttpDelete("/api/v1/profile/avatar"), Scope("write:accounts")] + [HttpDelete(ApiPaths.Accounts.DELETE_DeleteAvatar), Scope("write:accounts")] public Task DeleteAvatar([FromServices] IMediaService media, CancellationToken token) => DeletePicture(media, "avatar", token); - [HttpDelete("/api/v1/profile/header"), Scope("write:accounts")] + [HttpDelete(ApiPaths.Accounts.DELETE_DeleteHeader), Scope("write:accounts")] public Task DeleteHeader([FromServices] IMediaService media, CancellationToken token) => DeletePicture(media, "header", token); async Task DeletePicture(IMediaService media, string kind, CancellationToken token) @@ -134,7 +134,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await mapper.Local(actor, withSource: true, token)); } - [HttpGet("/api/v1/accounts/lookup"), Scope("read:accounts", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Accounts.GET_Lookup), Scope("read:accounts", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] public async Task Lookup(CancellationToken token) { var acct = Params.Get("acct")?.Trim().TrimStart('@'); @@ -154,7 +154,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return foreign == default ? NotFoundError() : Json(mapper.Foreign(foreign)); } - [HttpGet("/api/v1/accounts/relationships"), Scope("read:follows")] + [HttpGet(ApiPaths.Accounts.GET_Relationships), Scope("read:follows")] public async Task Relationships(CancellationToken token) { var relationships = new List(); @@ -163,14 +163,14 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(relationships); } - [HttpGet("/api/v1/accounts/search"), Scope("read:accounts")] + [HttpGet(ApiPaths.Accounts.GET_Search), Scope("read:accounts")] public async Task Search([FromServices] AccountSearch search, CancellationToken token) => Json(Params.Bool("following") == true && MyId != default ? await search.Followed(MyId, Params.Get("q"), Limit(), token) : await search.Find(Params.Get("q"), Params.Bool("resolve") == true && MyId != default, Limit(), token)); // Mastodon 4.3: several accounts at once (at most 40), those that exist, in no promised order - [HttpGet("/api/v1/accounts"), Scope("read:accounts", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Accounts.GET_Many), Scope("read:accounts", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] public async Task Many(CancellationToken token) { var accounts = new List(); @@ -180,14 +180,14 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(accounts); } - [HttpGet("/api/v1/accounts/{id}"), Scope("read:accounts", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Accounts.GET_M_Get), Scope("read:accounts", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] public async Task Get(string id, CancellationToken token) { var account = await mapper.Account(id, token); return account == default ? NotFoundError() : Json(account); } - [HttpGet("/api/v1/accounts/{id}/statuses"), Scope("read:statuses", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Accounts.GET_M_Statuses), Scope("read:statuses", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] public async Task Statuses(string id, CancellationToken token) { var (local, remote) = await Find(id, token); @@ -240,7 +240,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(statuses); } - [HttpGet("/api/v1/accounts/{id}/followers"), Scope("read:accounts", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Accounts.GET_M_Followers), Scope("read:accounts", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] public async Task Followers(string id, CancellationToken token) { var (local, _) = await Find(id, token); @@ -252,7 +252,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await AccountsFor(followers.Select(f => f.ActorURI), token)); } - [HttpGet("/api/v1/accounts/{id}/following"), Scope("read:accounts", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Accounts.GET_M_Following), Scope("read:accounts", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] public async Task Following(string id, CancellationToken token) { var (local, remote) = await Find(id, token); @@ -269,7 +269,7 @@ namespace PrivaPub.Api.Mastodon.Controllers } // PrivaPub's own: the feeds the persona reads (a feed's timeline is /api/v1/timelines/feed/:id) - [HttpGet("/api/v1/feeds"), Scope("read:follows")] + [HttpGet(ApiPaths.Accounts.GET_Feeds), Scope("read:follows")] public async Task Feeds(CancellationToken token) { var read = await DB.Default.Find().Match(s => s.AvatarId == MyId).Sort(s => s.ID, MongoDB.Entities.Order.Descending).ExecuteAsync(token); @@ -277,7 +277,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(read.Select(s => accounts.GetValueOrDefault(s.FeedAccountId)).Where(a => a != default).ToList()); } - [HttpPost("/api/v1/accounts/{id}/follow"), Scope("write:follows")] + [HttpPost(ApiPaths.Accounts.POST_M_Follow), Scope("write:follows")] public async Task Follow(string id, CancellationToken token) { var (local, remote) = await Find(id, token); @@ -297,7 +297,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return following == default ? Error(StatusCodes.Status403Forbidden, "This action is not allowed") : Json(await Relationship(id, token)); } - [HttpPost("/api/v1/accounts/{id}/unfollow"), Scope("write:follows")] + [HttpPost(ApiPaths.Accounts.POST_M_Unfollow), Scope("write:follows")] public async Task Unfollow(string id, CancellationToken token) { var (local, remote) = await Find(id, token); @@ -310,7 +310,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await Relationship(id, token)); } - [HttpPost("/api/v1/accounts/{id}/remove_from_followers"), Scope("write:follows")] + [HttpPost(ApiPaths.Accounts.POST_M_RemoveFromFollowers), Scope("write:follows")] public async Task RemoveFromFollowers(string id, CancellationToken token) { var (local, remote) = await Find(id, token); @@ -321,7 +321,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await Relationship(id, token)); } - [HttpPost("/api/v1/accounts/{id}/block"), Scope("write:blocks")] + [HttpPost(ApiPaths.Accounts.POST_M_Block), Scope("write:blocks")] public async Task Block(string id, CancellationToken token) { var (local, remote) = await Find(id, token); @@ -331,7 +331,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await Relationship(id, token)); } - [HttpPost("/api/v1/accounts/{id}/unblock"), Scope("write:blocks")] + [HttpPost(ApiPaths.Accounts.POST_M_Unblock), Scope("write:blocks")] public async Task Unblock(string id, CancellationToken token) { var (local, remote) = await Find(id, token); @@ -341,7 +341,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await Relationship(id, token)); } - [HttpPost("/api/v1/accounts/{id}/mute"), Scope("write:mutes")] + [HttpPost(ApiPaths.Accounts.POST_M_Mute), Scope("write:mutes")] public async Task Mute(string id, CancellationToken token) { var (local, remote) = await Find(id, token); @@ -352,7 +352,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await Relationship(id, token)); } - [HttpPost("/api/v1/accounts/{id}/unmute"), Scope("write:mutes")] + [HttpPost(ApiPaths.Accounts.POST_M_Unmute), Scope("write:mutes")] public async Task Unmute(string id, CancellationToken token) { var (local, remote) = await Find(id, token); @@ -362,7 +362,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await Relationship(id, token)); } - [HttpGet("/api/v1/blocks"), Scope("read:blocks")] + [HttpGet(ApiPaths.Accounts.GET_Blocks), Scope("read:blocks")] public async Task Blocks(CancellationToken token) { var blocks = await Page.From(Params, Limit(40, 80)).Fetch(DB.Default.Find().Match(b => b.AvatarId == MyId), b => b.ID, token); @@ -371,7 +371,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(blocks.Select(b => accounts.GetValueOrDefault(b.TargetAccountId)).Where(a => a != default).ToList()); } - [HttpGet("/api/v1/mutes"), Scope("read:mutes")] + [HttpGet(ApiPaths.Accounts.GET_Mutes), Scope("read:mutes")] public async Task Mutes(CancellationToken token) { var mutes = await Page.From(Params, Limit(40, 80)).Fetch(DB.Default.Find().Match(m => m.AvatarId == MyId), m => m.ID, token); @@ -380,14 +380,14 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(mutes.Select(m => accounts.GetValueOrDefault(m.TargetAccountId)).Where(a => a != default).ToList()); } - [HttpGet("/api/v1/domain_blocks"), Scope("read:blocks")] + [HttpGet(ApiPaths.Accounts.GET_DomainBlocks), Scope("read:blocks")] public async Task DomainBlocks(CancellationToken token) => Json((await DB.Default.Find().Match(b => b.AvatarId == MyId).Sort(b => b.Domain, Order.Ascending).ExecuteAsync(token)).Select(b => b.Domain).ToList()); // Mastodon's preview of a server block: how many of the accounts the persona follows, and of those following it, the // block would take away, counted as BlockDomain takes them (an account on the server or a subdomain, or whose handle // is) - [HttpGet("/api/v1/domain_blocks/preview"), Scope("write:blocks")] + [HttpGet(ApiPaths.Accounts.GET_PreviewDomainBlock), Scope("write:blocks")] public async Task PreviewDomainBlock(CancellationToken token) { var domain = Params.Get("domain")?.Trim().ToLowerInvariant(); @@ -406,21 +406,21 @@ namespace PrivaPub.Api.Mastodon.Controllers }); } - [HttpPost("/api/v1/domain_blocks"), Scope("write:blocks")] + [HttpPost(ApiPaths.Accounts.POST_BlockDomain), Scope("write:blocks")] public async Task BlockDomain(CancellationToken token) { await relationshipService.BlockDomain(Me, Params.Get("domain"), token); return Json(new { }); } - [HttpDelete("/api/v1/domain_blocks"), Scope("write:blocks")] + [HttpDelete(ApiPaths.Accounts.DELETE_UnblockDomain), Scope("write:blocks")] public async Task UnblockDomain(CancellationToken token) { await relationshipService.UnblockDomain(Me, Params.Get("domain"), token); return Json(new { }); } - [HttpGet("/api/v1/follow_requests"), Scope("read:follows")] + [HttpGet(ApiPaths.Accounts.GET_FollowRequests), Scope("read:follows")] public async Task FollowRequests(CancellationToken token) { var requests = await dbEntities.Followers.Match(f => f.LocalActorId == Me.Id && f.LocalActorKind == LocalActorKind.Person && !f.IsAccepted) @@ -428,24 +428,24 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await AccountsFor(requests.Select(r => r.ActorURI), token)); } - [HttpPost("/api/v1/follow_requests/{id}/authorize"), Scope("write:follows")] + [HttpPost(ApiPaths.Accounts.POST_M_Authorize), Scope("write:follows")] public async Task Authorize(string id, CancellationToken token) => await followService.Decide(Me, id, accept: true, token) ? Json(await Relationship(id, token)) : NotFoundError(); - [HttpPost("/api/v1/follow_requests/{id}/reject"), Scope("write:follows")] + [HttpPost(ApiPaths.Accounts.POST_M_Reject), Scope("write:follows")] public async Task Reject(string id, CancellationToken token) => await followService.Decide(Me, id, accept: false, token) ? Json(await Relationship(id, token)) : NotFoundError(); // Familiar followers stay empty by design: which of the accounts the persona follows also follow another account would // tell who follows whom among the personas here (and their followers lists are never shown, hide_collections), so // every account answers none - [HttpGet("/api/v1/accounts/familiar_followers"), Scope("read:follows")] + [HttpGet(ApiPaths.Accounts.GET_FamiliarFollowers), Scope("read:follows")] public IActionResult FamiliarFollowers() => Json(Params.List("id").Select(id => new { id, accounts = Array.Empty() }).ToList()); // Endorsements (R8): Mastodon's account pins under their old names (pin, unpin) and 4.4's (endorse, unendorse). Only an // account the persona follows may be endorsed, as Mastodon requires; they are the persona's alone, never federated as // featured accounts and never listed to anyone else (the owner's default: endorsements stay private) - [HttpPost("/api/v1/accounts/{id}/pin"), HttpPost("/api/v1/accounts/{id}/endorse"), Scope("write:accounts")] + [HttpPost(ApiPaths.Accounts.POST_M_Endorse), HttpPost(ApiPaths.Accounts.POST_M_EndorseV1), Scope("write:accounts")] public async Task Endorse(string id, CancellationToken token) { var (local, remote) = await Find(id, token); @@ -469,7 +469,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await Relationship(id, token)); } - [HttpPost("/api/v1/accounts/{id}/unpin"), HttpPost("/api/v1/accounts/{id}/unendorse"), Scope("write:accounts")] + [HttpPost(ApiPaths.Accounts.POST_M_Unendorse), HttpPost(ApiPaths.Accounts.POST_M_UnendorseV1), Scope("write:accounts")] public async Task Unendorse(string id, CancellationToken token) { var (local, remote) = await Find(id, token); @@ -481,12 +481,12 @@ namespace PrivaPub.Api.Mastodon.Controllers } // the persona's own endorsements, newest first, those it still follows - [HttpGet("/api/v1/endorsements"), Scope("read:accounts")] + [HttpGet(ApiPaths.Accounts.GET_Endorsements), Scope("read:accounts")] public Task Endorsements(CancellationToken token) => EndorsementsOf("/api/v1/endorsements", token); // Mastodon 4.4: an account's endorsements. Only the persona's own are answered, to the persona itself: endorsements // stay private, so every other account answers none - [HttpGet("/api/v1/accounts/{id}/endorsements"), Scope("read:accounts", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Accounts.GET_M_EndorsementsOfAccount), Scope("read:accounts", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] public async Task EndorsementsOfAccount(string id, CancellationToken token) => MyId != default && id == MyId ? await EndorsementsOf($"/api/v1/accounts/{id}/endorsements", token) : Json(Array.Empty()); @@ -503,7 +503,7 @@ namespace PrivaPub.Api.Mastodon.Controllers // A private note on an account (R8): the persona's own (PersonaNote, never its login's), shown only to it in the // relationship's `note`, never federated; an empty comment takes it away - [HttpPost("/api/v1/accounts/{id}/note"), Scope("write:accounts")] + [HttpPost(ApiPaths.Accounts.POST_M_Note), Scope("write:accounts")] public async Task Note(string id, CancellationToken token) { var (local, remote) = await Find(id, token); @@ -526,7 +526,7 @@ namespace PrivaPub.Api.Mastodon.Controllers // Mastodon's preferences: posting defaults (update_credentials' source) and reading ones (R8: AvatarSettings, set // through /clientapi/avatar/private/preferences, since Mastodon's API sets none) - [HttpGet("/api/v1/preferences"), Scope("read:accounts")] + [HttpGet(ApiPaths.Accounts.GET_Preferences), Scope("read:accounts")] public IActionResult Preferences() => Json(new Dictionary { ["posting:default:visibility"] = Me.Settings.DefaultVisibility ?? "public", diff --git a/PrivaPub/Api/Mastodon/Controllers/AnnouncementsController.cs b/PrivaPub/Api/Mastodon/Controllers/AnnouncementsController.cs index 9775d61..7e8d152 100644 --- a/PrivaPub/Api/Mastodon/Controllers/AnnouncementsController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/AnnouncementsController.cs @@ -15,18 +15,18 @@ namespace PrivaPub.Api.Mastodon.Controllers public class AnnouncementsController( IAnnouncements announcementService) : MastodonController { - [HttpGet("/api/v1/announcements"), Scope("read", requiresUser: false), AllowAnonymous] + [HttpGet(ApiPaths.Announcements.GET_List), Scope("read", requiresUser: false), AllowAnonymous] public async Task List(CancellationToken token) => Json(await Map(await announcementService.Shown(token), MyId, token)); - [HttpPost("/api/v1/announcements/{id}/dismiss"), Scope("write:accounts")] + [HttpPost(ApiPaths.Announcements.POST_M_Dismiss), Scope("write:accounts")] public async Task Dismiss(string id, CancellationToken token) => await announcementService.Dismiss(id, MyId, token) ? Json(new { }) : NotFoundError(); - [HttpPut("/api/v1/announcements/{id}/reactions/{name}"), Scope("write:favourites")] + [HttpPut(ApiPaths.Announcements.PUT_M_React), Scope("write:favourites")] public Task React(string id, string name, CancellationToken token) => Reaction(id, name, add: true, token); - [HttpDelete("/api/v1/announcements/{id}/reactions/{name}"), Scope("write:favourites")] + [HttpDelete(ApiPaths.Announcements.DELETE_M_Unreact), Scope("write:favourites")] public Task Unreact(string id, string name, CancellationToken token) => Reaction(id, name, add: false, token); async Task Reaction(string id, string name, bool add, CancellationToken token) diff --git a/PrivaPub/Api/Mastodon/Controllers/AppsController.cs b/PrivaPub/Api/Mastodon/Controllers/AppsController.cs index a8f80a2..51fd764 100644 --- a/PrivaPub/Api/Mastodon/Controllers/AppsController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/AppsController.cs @@ -17,7 +17,7 @@ namespace PrivaPub.Api.Mastodon.Controllers IOpenIddictApplicationManager applications, PrivaPub.Infrastructure.Push.IVapid vapid) : MastodonController { - [HttpPost("/api/v1/apps"), AllowAnonymous] + [HttpPost(ApiPaths.Apps.POST_Create), AllowAnonymous] public async Task Create(CancellationToken token) { var name = Params.Get("client_name")?.Trim(); @@ -69,7 +69,7 @@ namespace PrivaPub.Api.Mastodon.Controllers }); } - [HttpGet("/api/v1/apps/verify_credentials")] + [HttpGet(ApiPaths.Apps.GET_Verify)] public async Task Verify(CancellationToken token) { var clientId = User.GetPresenters().FirstOrDefault() ?? User.GetClaim(Claims.ClientId); diff --git a/PrivaPub/Api/Mastodon/Controllers/CdnsController.cs b/PrivaPub/Api/Mastodon/Controllers/CdnsController.cs index 900e0a3..62ab596 100644 --- a/PrivaPub/Api/Mastodon/Controllers/CdnsController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/CdnsController.cs @@ -14,10 +14,10 @@ namespace PrivaPub.Api.Mastodon.Controllers const int MaxWeeks = 260; - [HttpGet("/api/privapub/v1/cdns"), Scope("read", requiresUser: false), AllowAnonymous] + [HttpGet(ApiPaths.Cdns.GET_List), Scope("read", requiresUser: false), AllowAnonymous] public async Task List(CancellationToken token) => Json((await places.Cdns(token)).Select(Summary).ToList()); - [HttpGet("/api/privapub/v1/cdns/{key}"), Scope("read", requiresUser: false), AllowAnonymous] + [HttpGet(ApiPaths.Cdns.GET_M_Detail), Scope("read", requiresUser: false), AllowAnonymous] public async Task Detail(string key, CancellationToken token) { var history = await places.Cdn(key, Math.Clamp(Params.Int("weeks") ?? 52, 1, MaxWeeks), token); diff --git a/PrivaPub/Api/Mastodon/Controllers/CustomEmojisController.cs b/PrivaPub/Api/Mastodon/Controllers/CustomEmojisController.cs index 17abce9..341eb78 100644 --- a/PrivaPub/Api/Mastodon/Controllers/CustomEmojisController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/CustomEmojisController.cs @@ -12,7 +12,7 @@ namespace PrivaPub.Api.Mastodon.Controllers // change reloads at once (and that is read again when five minutes old), so no request reads the database. public class CustomEmojisController : MastodonController { - [HttpGet("/api/v1/custom_emojis"), AllowAnonymous] + [HttpGet(ApiPaths.CustomEmojis.GET_List), AllowAnonymous] public IActionResult List() => Json(LocalEmojis.Current.Values .Where(e => e.VisibleInPicker) .OrderBy(e => e.Shortcode, StringComparer.Ordinal) diff --git a/PrivaPub/Api/Mastodon/Controllers/FeaturedTagsController.cs b/PrivaPub/Api/Mastodon/Controllers/FeaturedTagsController.cs index 594267c..6c1123c 100644 --- a/PrivaPub/Api/Mastodon/Controllers/FeaturedTagsController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/FeaturedTagsController.cs @@ -25,22 +25,22 @@ namespace PrivaPub.Api.Mastodon.Controllers const int SuggestionPosts = 200; - [HttpGet("/api/v1/featured_tags"), Scope("read:accounts")] + [HttpGet(ApiPaths.FeaturedTags.GET_Mine), Scope("read:accounts")] public async Task Mine(CancellationToken token) => Json(await Entities(await featuredTags.Of(MyId, token), token)); - [HttpPost("/api/v1/featured_tags"), Scope("write:accounts")] + [HttpPost(ApiPaths.FeaturedTags.POST_Feature), Scope("write:accounts")] public async Task Feature(CancellationToken token) { var (tag, error) = await featuredTags.Feature(Me, Params.Get("name"), token); return tag == default ? Error(StatusCodes.Status422UnprocessableEntity, error) : Json((await Entities(new List { tag }, token))[0]); } - [HttpDelete("/api/v1/featured_tags/{id}"), Scope("write:accounts")] + [HttpDelete(ApiPaths.FeaturedTags.DELETE_M_Unfeature), Scope("write:accounts")] public async Task Unfeature(string id, CancellationToken token) => await featuredTags.Unfeature(Me, id, default, token) == default ? NotFoundError() : Json(new { }); // the tags the persona used lately and does not feature yet, the most used first, as Mastodon's Tag - [HttpGet("/api/v1/featured_tags/suggestions"), Scope("read:accounts")] + [HttpGet(ApiPaths.FeaturedTags.GET_Suggestions), Scope("read:accounts")] public async Task Suggestions(CancellationToken token) { var featured = (await featuredTags.Of(MyId, token)).Select(t => t.Name).ToHashSet(StringComparer.Ordinal); @@ -62,7 +62,7 @@ namespace PrivaPub.Api.Mastodon.Controllers // what an account features: a persona's own hashtags, or what an account elsewhere tells (its featuredTags, its Add // and Remove); a community features none. A suspended account's answer 404, as its account does (R6). - [HttpGet("/api/v1/accounts/{id}/featured_tags"), Scope("read:accounts", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.FeaturedTags.GET_M_OfAccount), Scope("read:accounts", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] public async Task OfAccount(string id, CancellationToken token) { var avatar = await dbEntities.Avatars.MatchID(id).Match(a => !a.DeletionAt.HasValue).ExecuteFirstAsync(token); diff --git a/PrivaPub/Api/Mastodon/Controllers/FiltersController.cs b/PrivaPub/Api/Mastodon/Controllers/FiltersController.cs index 49506f5..96931a1 100644 --- a/PrivaPub/Api/Mastodon/Controllers/FiltersController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/FiltersController.cs @@ -139,16 +139,16 @@ namespace PrivaPub.Api.Mastodon.Controllers // -- v2 - [HttpGet("/api/v2/filters"), Scope("read:filters")] + [HttpGet(ApiPaths.Filters.GET_All), Scope("read:filters")] public async Task All(CancellationToken token) => Json((await DB.Default.Find().Match(f => f.AvatarId == MyId).Sort(f => f.ID, Order.Ascending).ExecuteAsync(token)) .Select(Filters.View).ToList()); - [HttpGet("/api/v2/filters/{id}"), Scope("read:filters")] + [HttpGet(ApiPaths.Filters.GET_M_One), Scope("read:filters")] public async Task One(string id, CancellationToken token) => await Mine(id, token) is { } filter ? Json(Filters.View(filter)) : NotFoundError(); - [HttpPost("/api/v2/filters"), Scope("write:filters")] + [HttpPost(ApiPaths.Filters.POST_Create), Scope("write:filters")] public async Task Create(CancellationToken token) { if (await DB.Default.CountAsync(f => f.AvatarId == MyId, token) >= MaxFilters) @@ -160,7 +160,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(Filters.View(filter)); } - [HttpPut("/api/v2/filters/{id}"), Scope("write:filters")] + [HttpPut(ApiPaths.Filters.PUT_M_Update), Scope("write:filters")] public async Task Update(string id, CancellationToken token) { if (await Mine(id, token) is not { } filter) @@ -171,7 +171,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(Filters.View(filter)); } - [HttpDelete("/api/v2/filters/{id}"), Scope("write:filters")] + [HttpDelete(ApiPaths.Filters.DELETE_M_Delete), Scope("write:filters")] public async Task Delete(string id, CancellationToken token) { if (await Mine(id, token) is not { } filter) @@ -180,11 +180,11 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(new { }); } - [HttpGet("/api/v2/filters/{id}/keywords"), Scope("read:filters")] + [HttpGet(ApiPaths.Filters.GET_M_Keywords), Scope("read:filters")] public async Task Keywords(string id, CancellationToken token) => await Mine(id, token) is { } filter ? Json(filter.Keywords.Select(Filters.Keyword).ToList()) : NotFoundError(); - [HttpPost("/api/v2/filters/{id}/keywords"), Scope("write:filters")] + [HttpPost(ApiPaths.Filters.POST_M_AddKeyword), Scope("write:filters")] public async Task AddKeyword(string id, CancellationToken token) { if (await Mine(id, token) is not { } filter) @@ -198,11 +198,11 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(Filters.Keyword(filter.Keywords[^1])); } - [HttpGet("/api/v2/filters/keywords/{id}"), Scope("read:filters")] + [HttpGet(ApiPaths.Filters.GET_M_Keyword), Scope("read:filters")] public async Task Keyword(string id, CancellationToken token) => await WithKeyword(id, token) is { } filter ? Json(Filters.Keyword(filter.Keywords.First(k => k.Id == id))) : NotFoundError(); - [HttpPut("/api/v2/filters/keywords/{id}"), Scope("write:filters")] + [HttpPut(ApiPaths.Filters.PUT_M_UpdateKeyword), Scope("write:filters")] public async Task UpdateKeyword(string id, CancellationToken token) { if (await WithKeyword(id, token) is not { } filter) @@ -216,7 +216,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(Filters.Keyword(filter.Keywords.First(k => k.Id == id))); } - [HttpDelete("/api/v2/filters/keywords/{id}"), Scope("write:filters")] + [HttpDelete(ApiPaths.Filters.DELETE_M_DeleteKeyword), Scope("write:filters")] public async Task DeleteKeyword(string id, CancellationToken token) { if (await WithKeyword(id, token) is not { } filter) @@ -226,12 +226,12 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(new { }); } - [HttpGet("/api/v2/filters/{id}/statuses"), Scope("read:filters")] + [HttpGet(ApiPaths.Filters.GET_M_Statuses), Scope("read:filters")] public async Task Statuses(string id, CancellationToken token) => await Mine(id, token) is { } filter ? Json(filter.Statuses.Select(Filters.Status).ToList()) : NotFoundError(); // a status the persona can see, once per filter - [HttpPost("/api/v2/filters/{id}/statuses"), Scope("write:filters")] + [HttpPost(ApiPaths.Filters.POST_M_AddStatus), Scope("write:filters")] public async Task AddStatus(string id, CancellationToken token) { if (await Mine(id, token) is not { } filter) @@ -250,11 +250,11 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(Filters.Status(added)); } - [HttpGet("/api/v2/filters/statuses/{id}"), Scope("read:filters")] + [HttpGet(ApiPaths.Filters.GET_M_Status), Scope("read:filters")] public async Task Status(string id, CancellationToken token) => await WithStatus(id, token) is { } filter ? Json(Filters.Status(filter.Statuses.First(s => s.Id == id))) : NotFoundError(); - [HttpDelete("/api/v2/filters/statuses/{id}"), Scope("write:filters")] + [HttpDelete(ApiPaths.Filters.DELETE_M_DeleteStatus), Scope("write:filters")] public async Task DeleteStatus(string id, CancellationToken token) { if (await WithStatus(id, token) is not { } filter) @@ -276,12 +276,12 @@ namespace PrivaPub.Api.Mastodon.Controllers Irreversible = filter.Action == FilterActions.Hide }; - [HttpGet("/api/v1/filters"), Scope("read:filters")] + [HttpGet(ApiPaths.Filters.GET_AllV1), Scope("read:filters")] public async Task AllV1(CancellationToken token) => Json((await DB.Default.Find().Match(f => f.AvatarId == MyId).Sort(f => f.ID, Order.Ascending).ExecuteAsync(token)) .SelectMany(f => f.Keywords.Select(k => V1(f, k))).ToList()); - [HttpGet("/api/v1/filters/{id}"), Scope("read:filters")] + [HttpGet(ApiPaths.Filters.GET_M_OneV1), Scope("read:filters")] public async Task OneV1(string id, CancellationToken token) => await WithKeyword(id, token) is { } filter ? Json(V1(filter, filter.Keywords.First(k => k.Id == id))) : NotFoundError(); @@ -315,7 +315,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return default; } - [HttpPost("/api/v1/filters"), Scope("write:filters")] + [HttpPost(ApiPaths.Filters.POST_CreateV1), Scope("write:filters")] public async Task CreateV1(CancellationToken token) { if (await DB.Default.CountAsync(f => f.AvatarId == MyId, token) >= MaxFilters) @@ -328,7 +328,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(V1(filter, keyword)); } - [HttpPut("/api/v1/filters/{id}"), Scope("write:filters")] + [HttpPut(ApiPaths.Filters.PUT_M_UpdateV1), Scope("write:filters")] public async Task UpdateV1(string id, CancellationToken token) { if (await WithKeyword(id, token) is not { } filter) @@ -341,7 +341,7 @@ namespace PrivaPub.Api.Mastodon.Controllers } // the keyword goes, and its filter with it when nothing else is left in it - [HttpDelete("/api/v1/filters/{id}"), Scope("write:filters")] + [HttpDelete(ApiPaths.Filters.DELETE_M_DeleteV1), Scope("write:filters")] public async Task DeleteV1(string id, CancellationToken token) { if (await WithKeyword(id, token) is not { } filter) diff --git a/PrivaPub/Api/Mastodon/Controllers/InstanceController.cs b/PrivaPub/Api/Mastodon/Controllers/InstanceController.cs index 80ba832..f0772a3 100644 --- a/PrivaPub/Api/Mastodon/Controllers/InstanceController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/InstanceController.cs @@ -116,7 +116,7 @@ namespace PrivaPub.Api.Mastodon.Controllers max_expiration = PrivaPub.Domain.Statuses.PollService.MaxExpiration }; - [HttpGet("/api/v1/instance"), AllowAnonymous] + [HttpGet(ApiPaths.Instance.GET_V1), AllowAnonymous] public async Task V1(CancellationToken token) { var settings = Settings; @@ -150,7 +150,7 @@ namespace PrivaPub.Api.Mastodon.Controllers static async Task KnownServers(CancellationToken token) => await DB.Default.CountAsync(i => i.Seen == "touched", token); - [HttpGet("/api/v2/instance"), AllowAnonymous] + [HttpGet(ApiPaths.Instance.GET_V2), AllowAnonymous] public async Task V2(CancellationToken token) => Json(new { domain = Domain, @@ -177,13 +177,13 @@ namespace PrivaPub.Api.Mastodon.Controllers rules = Rules(Settings) }); - [HttpGet("/api/v1/instance/peers"), AllowAnonymous] + [HttpGet(ApiPaths.Instance.GET_Peers), AllowAnonymous] public IActionResult Peers() => Json(Array.Empty()); // Mastodon's weekly activity, only when the administrator publishes it (off by default): twelve weeks, this one first, // counted as Counted counts (local posts, logins made); sign-ins are not kept, so `logins` is 0. Worked out at most // once an hour. - [HttpGet("/api/v1/instance/activity"), AllowAnonymous] + [HttpGet(ApiPaths.Instance.GET_Activity), AllowAnonymous] public async Task Activity(CancellationToken token) { if (!Settings.PublishActivity) @@ -201,10 +201,10 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(weeks); } - [HttpGet("/api/v1/instance/rules"), AllowAnonymous] + [HttpGet(ApiPaths.Instance.GET_InstanceRules), AllowAnonymous] public IActionResult InstanceRules() => Json(Rules(Settings)); - [HttpGet("/api/v1/instance/extended_description"), AllowAnonymous] + [HttpGet(ApiPaths.Instance.GET_ExtendedDescription), AllowAnonymous] public IActionResult ExtendedDescription() { var settings = Settings; @@ -215,7 +215,7 @@ namespace PrivaPub.Api.Mastodon.Controllers }); } - [HttpGet("/api/v1/instance/privacy_policy"), AllowAnonymous] + [HttpGet(ApiPaths.Instance.GET_PrivacyPolicy), AllowAnonymous] public IActionResult PrivacyPolicy() { var settings = Settings; @@ -227,10 +227,10 @@ namespace PrivaPub.Api.Mastodon.Controllers } // Mastodon 4.4's terms of service: the one version the server keeps, 404 while it has none - [HttpGet("/api/v1/instance/terms_of_service"), AllowAnonymous] + [HttpGet(ApiPaths.Instance.GET_TermsOfService), AllowAnonymous] public IActionResult TermsOfService() => Terms(default); - [HttpGet("/api/v1/instance/terms_of_service/{date}"), AllowAnonymous] + [HttpGet(ApiPaths.Instance.GET_M_TermsOfServiceOn), AllowAnonymous] public IActionResult TermsOfServiceOn(string date) => DateTime.TryParseExact(date, "yyyy-MM-dd", CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal | DateTimeStyles.AdjustToUniversal, out var on) ? Terms(on.Date) @@ -255,7 +255,7 @@ namespace PrivaPub.Api.Mastodon.Controllers // the server's blocks the administrator chose to publish (off for each by default: publishing one tells the blocked // server, and everyone else, that it is blocked), its name partly hidden when asked, as Mastodon hides it - [HttpGet("/api/v1/instance/domain_blocks"), AllowAnonymous] + [HttpGet(ApiPaths.Instance.GET_DomainBlocks), AllowAnonymous] public async Task DomainBlocks(CancellationToken token) => Json((await DB.Default.Find().Match(b => b.Published).Sort(b => b.Domain, Order.Ascending).ExecuteAsync(token)) .Select(b => new diff --git a/PrivaPub/Api/Mastodon/Controllers/ListsController.cs b/PrivaPub/Api/Mastodon/Controllers/ListsController.cs index 908ad9f..390a7c4 100644 --- a/PrivaPub/Api/Mastodon/Controllers/ListsController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/ListsController.cs @@ -40,16 +40,16 @@ namespace PrivaPub.Api.Mastodon.Controllers return members.Where(followed.Contains).ToList(); } - [HttpGet("/api/v1/lists"), Scope("read:lists")] + [HttpGet(ApiPaths.Lists.GET_All), Scope("read:lists")] public async Task All(CancellationToken token) => Json((await DB.Default.Find().Match(l => l.AvatarId == MyId).Sort(l => l.Title, MongoDB.Entities.Order.Ascending) .ExecuteAsync(token)).Select(View).ToList()); - [HttpGet("/api/v1/lists/{id}"), Scope("read:lists")] + [HttpGet(ApiPaths.Lists.GET_M_One), Scope("read:lists")] public async Task One(string id, CancellationToken token) => await Mine(id, token) is { } list ? Json(View(list)) : NotFoundError(); - [HttpPost("/api/v1/lists"), Scope("write:lists")] + [HttpPost(ApiPaths.Lists.POST_Create), Scope("write:lists")] public async Task Create(CancellationToken token) { var title = Params.Get("title")?.Trim(); @@ -65,7 +65,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(View(list)); } - [HttpPut("/api/v1/lists/{id}"), Scope("write:lists")] + [HttpPut(ApiPaths.Lists.PUT_M_Update), Scope("write:lists")] public async Task Update(string id, CancellationToken token) { if (await Mine(id, token) is not { } list) @@ -90,7 +90,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(View(list)); } - [HttpDelete("/api/v1/lists/{id}"), Scope("write:lists")] + [HttpDelete(ApiPaths.Lists.DELETE_M_Delete), Scope("write:lists")] public async Task Delete(string id, CancellationToken token) { if (await Mine(id, token) is not { } list) @@ -100,7 +100,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(new { }); } - [HttpGet("/api/v1/lists/{id}/accounts"), Scope("read:lists")] + [HttpGet(ApiPaths.Lists.GET_M_Accounts), Scope("read:lists")] public async Task Accounts(string id, CancellationToken token) { if (await Mine(id, token) is not { } list) @@ -113,7 +113,7 @@ namespace PrivaPub.Api.Mastodon.Controllers } // only accounts the persona follows may join its list, as on Mastodon - [HttpPost("/api/v1/lists/{id}/accounts"), Scope("write:lists")] + [HttpPost(ApiPaths.Lists.POST_M_Add), Scope("write:lists")] public async Task Add(string id, CancellationToken token) { if (await Mine(id, token) is not { } list) @@ -134,7 +134,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(new { }); } - [HttpDelete("/api/v1/lists/{id}/accounts"), Scope("write:lists")] + [HttpDelete(ApiPaths.Lists.DELETE_M_Remove), Scope("write:lists")] public async Task Remove(string id, CancellationToken token) { if (await Mine(id, token) is not { } list) @@ -144,7 +144,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(new { }); } - [HttpGet("/api/v1/accounts/{id}/lists"), Scope("read:lists")] + [HttpGet(ApiPaths.Lists.GET_M_Containing), Scope("read:lists")] public async Task Containing(string id, CancellationToken token) { var listIds = (await DB.Default.Find().Match(m => m.AvatarId == MyId && m.AccountId == id).ExecuteAsync(token)) @@ -155,7 +155,7 @@ namespace PrivaPub.Api.Mastodon.Controllers // the list's timeline: the persona's home entries by its members. Replies are kept as Mastodon keeps them: a member's // replies to itself and to the persona always, to others as the policy says (anyone followed, the list's members, no one) - [HttpGet("/api/v1/timelines/list/{id}"), Scope("read:lists")] + [HttpGet(ApiPaths.Lists.GET_M_Timeline), Scope("read:lists")] public async Task Timeline(string id, CancellationToken token) { if (await Mine(id, token) is not { } list) diff --git a/PrivaPub/Api/Mastodon/Controllers/MediaController.cs b/PrivaPub/Api/Mastodon/Controllers/MediaController.cs index bbbd85d..8d06857 100644 --- a/PrivaPub/Api/Mastodon/Controllers/MediaController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/MediaController.cs @@ -25,7 +25,7 @@ namespace PrivaPub.Api.Mastodon.Controllers - [HttpPost("/api/v1/media"), HttpPost("/api/v2/media"), Scope("write:media"), EnableRateLimiting(RateLimiting.Uploads), RequestSizeLimit(UploadLimit), + [HttpPost(ApiPaths.Media.POST_Upload), HttpPost(ApiPaths.Media.POST_UploadV2), Scope("write:media"), EnableRateLimiting(RateLimiting.Uploads), RequestSizeLimit(UploadLimit), RequestFormLimits(MultipartBodyLengthLimit = UploadLimit)] public async Task Upload(CancellationToken token) { @@ -43,7 +43,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return new JsonResult(View(outcome.Attachment)) { StatusCode = StatusCodes.Status202Accepted }; } - [HttpGet("/api/v1/media/{id}"), Scope("write:media")] + [HttpGet(ApiPaths.Media.GET_M_Get), Scope("write:media")] public async Task Get(string id, CancellationToken token) { var attachment = await DB.Default.Find().Match(m => m.ID == id && m.OwnerAvatarId == MyId && m.TrashedAt == null && m.ProfileOfAvatarId == null).ExecuteFirstAsync(token); @@ -58,7 +58,7 @@ namespace PrivaPub.Api.Mastodon.Controllers // Mastodon 4.4: a persona's own upload, while nothing holds it (not posted, not scheduled, not a profile picture), goes to // the trash as the janitor would take it - [HttpDelete("/api/v1/media/{id}"), Scope("write:media")] + [HttpDelete(ApiPaths.Media.DELETE_M_Delete), Scope("write:media")] public async Task Delete(string id, CancellationToken token) { var attachment = await DB.Default.Find().Match(m => m.ID == id && m.OwnerAvatarId == MyId && m.TrashedAt == null && m.ProfileOfAvatarId == null).ExecuteFirstAsync(token); @@ -71,7 +71,7 @@ namespace PrivaPub.Api.Mastodon.Controllers } // as on Mastodon, only media not posted yet: a posted one's description and focus change by editing its post (media_attributes) - [HttpPut("/api/v1/media/{id}"), Scope("write:media")] + [HttpPut(ApiPaths.Media.PUT_M_Update), Scope("write:media")] public async Task Update(string id, CancellationToken token) { var attachment = await DB.Default.Find().Match(m => m.ID == id && m.OwnerAvatarId == MyId && m.TrashedAt == null && m.ProfileOfAvatarId == null && m.PostId == null).ExecuteFirstAsync(token); @@ -85,7 +85,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(View(attachment)); } - [HttpGet("/media/proxy/{signature}/{encoded}"), AllowAnonymous, EnableRateLimiting(RateLimiting.Proxy), ApiExplorerSettings(IgnoreApi = true)] + [HttpGet(ApiPaths.Media.GET_M_Proxy), AllowAnonymous, EnableRateLimiting(RateLimiting.Proxy), ApiExplorerSettings(IgnoreApi = true)] public async Task Proxy(string signature, string encoded, CancellationToken token) { var url = mediaProxy.Verified(signature, encoded); diff --git a/PrivaPub/Api/Mastodon/Controllers/NotificationRequestsController.cs b/PrivaPub/Api/Mastodon/Controllers/NotificationRequestsController.cs index 5ac767f..4884a93 100644 --- a/PrivaPub/Api/Mastodon/Controllers/NotificationRequestsController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/NotificationRequestsController.cs @@ -59,10 +59,10 @@ namespace PrivaPub.Api.Mastodon.Controllers summary = await Summary(token) }; - [HttpGet("/api/v2/notifications/policy"), Scope("read:notifications")] + [HttpGet(ApiPaths.NotificationRequests.GET_Policy), Scope("read:notifications")] public async Task Policy(CancellationToken token) => Json(await V2(await NotificationPolicies.Of(MyId, token), token)); - [HttpPatch("/api/v2/notifications/policy"), HttpPut("/api/v2/notifications/policy"), Scope("write:notifications")] + [HttpPatch(ApiPaths.NotificationRequests.PATCH_SetPolicy), HttpPut(ApiPaths.NotificationRequests.PUT_SetPolicy), Scope("write:notifications")] public async Task SetPolicy(CancellationToken token) { var policy = await NotificationPolicies.Of(MyId, token); @@ -75,10 +75,10 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await V2(policy, token)); } - [HttpGet("/api/v1/notifications/policy"), Scope("read:notifications")] + [HttpGet(ApiPaths.NotificationRequests.GET_PolicyV1), Scope("read:notifications")] public async Task PolicyV1(CancellationToken token) => Json(await V1(await NotificationPolicies.Of(MyId, token), token)); - [HttpPut("/api/v1/notifications/policy"), HttpPatch("/api/v1/notifications/policy"), Scope("write:notifications")] + [HttpPut(ApiPaths.NotificationRequests.PUT_SetPolicyV1), HttpPatch(ApiPaths.NotificationRequests.PATCH_SetPolicyV1), Scope("write:notifications")] public async Task SetPolicyV1(CancellationToken token) { var policy = await NotificationPolicies.Of(MyId, token); @@ -110,7 +110,7 @@ namespace PrivaPub.Api.Mastodon.Controllers }; } - [HttpGet("/api/v1/notifications/requests"), Scope("read:notifications")] + [HttpGet(ApiPaths.NotificationRequests.GET_Requests), Scope("read:notifications")] public async Task Requests(CancellationToken token) { var requests = await Page.From(Params, Limit(40, 80)).Fetch(DB.Default.Find().Match(r => r.AvatarId == MyId), r => r.ID, token); @@ -125,14 +125,14 @@ namespace PrivaPub.Api.Mastodon.Controllers Task Mine(string id, CancellationToken token) => DB.Default.Find().Match(r => r.ID == id && r.AvatarId == MyId).ExecuteFirstAsync(token); - [HttpGet("/api/v1/notifications/requests/merged"), Scope("read:notifications")] + [HttpGet(ApiPaths.NotificationRequests.GET_Merged), Scope("read:notifications")] public IActionResult Merged() => Json(new { merged = true }); - [HttpGet("/api/v1/notifications/requests/{id}"), Scope("read:notifications")] + [HttpGet(ApiPaths.NotificationRequests.GET_M_Request), Scope("read:notifications")] public async Task Request(string id, CancellationToken token) => await Mine(id, token) is { } request && await Map(request, token) is { } mapped ? Json(mapped) : NotFoundError(); - [HttpPost("/api/v1/notifications/requests/{id}/accept"), Scope("write:notifications")] + [HttpPost(ApiPaths.NotificationRequests.POST_M_Accept), Scope("write:notifications")] public async Task Accept(string id, CancellationToken token) { if (await Mine(id, token) is not { } request) @@ -141,7 +141,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(new { }); } - [HttpPost("/api/v1/notifications/requests/{id}/dismiss"), Scope("write:notifications")] + [HttpPost(ApiPaths.NotificationRequests.POST_M_Dismiss), Scope("write:notifications")] public async Task Dismiss(string id, CancellationToken token) { if (await Mine(id, token) is not { } request) @@ -150,7 +150,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(new { }); } - [HttpPost("/api/v1/notifications/requests/accept"), Scope("write:notifications")] + [HttpPost(ApiPaths.NotificationRequests.POST_AcceptMany), Scope("write:notifications")] public async Task AcceptMany(CancellationToken token) { foreach (var id in Params.List("id").Take(100)) @@ -159,7 +159,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(new { }); } - [HttpPost("/api/v1/notifications/requests/dismiss"), Scope("write:notifications")] + [HttpPost(ApiPaths.NotificationRequests.POST_DismissMany), Scope("write:notifications")] public async Task DismissMany(CancellationToken token) { foreach (var id in Params.List("id").Take(100)) diff --git a/PrivaPub/Api/Mastodon/Controllers/PollsController.cs b/PrivaPub/Api/Mastodon/Controllers/PollsController.cs index 956ad34..33ce939 100644 --- a/PrivaPub/Api/Mastodon/Controllers/PollsController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/PollsController.cs @@ -17,14 +17,14 @@ namespace PrivaPub.Api.Mastodon.Controllers MastodonMapper mapper, IPollService pollService) : MastodonController { - [HttpGet("/api/v1/polls/{id}"), Scope("read:statuses", requiresUser: false), AllowAnonymous] + [HttpGet(ApiPaths.Polls.GET_M_Get), Scope("read:statuses", requiresUser: false), AllowAnonymous] public async Task Get(string id, CancellationToken token) { var post = await Visible(id, token); return post?.Poll == default ? NotFoundError() : Json(mapper.Poll(post, MyId, await pollService.OwnVotes(post.ID, MyId, token))); } - [HttpPost("/api/v1/polls/{id}/votes"), Scope("write:statuses")] + [HttpPost(ApiPaths.Polls.POST_M_Vote), Scope("write:statuses")] public async Task Vote(string id, CancellationToken token) { var post = await Visible(id, token); diff --git a/PrivaPub/Api/Mastodon/Controllers/ProvenanceController.cs b/PrivaPub/Api/Mastodon/Controllers/ProvenanceController.cs index 9b5e52a..fef14ab 100644 --- a/PrivaPub/Api/Mastodon/Controllers/ProvenanceController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/ProvenanceController.cs @@ -34,7 +34,7 @@ namespace PrivaPub.Api.Mastodon.Controllers const int MaxWeeks = 260; - [HttpGet("/api/privapub/v1/statuses/{id}/provenance"), Scope("read:statuses", requiresUser: false), AllowAnonymous] + [HttpGet(ApiPaths.Provenance.GET_M_Status), Scope("read:statuses", requiresUser: false), AllowAnonymous] public async Task Status(string id, CancellationToken token) { var post = await dbEntities.Posts.Match(p => p.ID == id).Match(VisibilityPolicy.IsShown).ExecuteFirstAsync(token); @@ -53,7 +53,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(Describe(post, record, instance, beforeCdn)); } - [HttpGet("/api/privapub/v1/instances/{host}"), Scope("read", requiresUser: false), AllowAnonymous] + [HttpGet(ApiPaths.Provenance.GET_M_Instance), Scope("read", requiresUser: false), AllowAnonymous] public async Task Instance(string host, CancellationToken token) { var described = await Describe(new[] { host }, token); @@ -61,11 +61,11 @@ namespace PrivaPub.Api.Mastodon.Controllers } //up to MaxHosts at once (host[]=...), in the order asked; hosts this server does not know are left out - [HttpGet("/api/privapub/v1/instances"), Scope("read", requiresUser: false), AllowAnonymous] + [HttpGet(ApiPaths.Provenance.GET_Instances), Scope("read", requiresUser: false), AllowAnonymous] public async Task Instances(CancellationToken token) => Json(await Describe(Params.List("host"), token)); //the server's weekly snapshots, newest first (weeks=, at most MaxWeeks): its place as shown publicly, its CDN, its size - [HttpGet("/api/privapub/v1/instances/{host}/history"), Scope("read", requiresUser: false), AllowAnonymous] + [HttpGet(ApiPaths.Provenance.GET_M_History), Scope("read", requiresUser: false), AllowAnonymous] public async Task History(string host, CancellationToken token) { host = host?.Trim().ToLowerInvariant(); diff --git a/PrivaPub/Api/Mastodon/Controllers/PushController.cs b/PrivaPub/Api/Mastodon/Controllers/PushController.cs index 9a7f6d1..3617ddc 100644 --- a/PrivaPub/Api/Mastodon/Controllers/PushController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/PushController.cs @@ -31,7 +31,7 @@ namespace PrivaPub.Api.Mastodon.Controllers string TokenId => User.GetTokenId(); // a new subscription replaces the one this token had, as on Mastodon - [HttpPost("/api/v1/push/subscription"), Scope("push")] + [HttpPost(ApiPaths.Push.POST_Create), Scope("push")] public async Task Create(CancellationToken token) { var endpoint = Params.Get("subscription[endpoint]")?.Trim(); @@ -82,12 +82,12 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await View(subscription, token)); } - [HttpGet("/api/v1/push/subscription"), Scope("push")] + [HttpGet(ApiPaths.Push.GET_Show), Scope("push")] public async Task Show(CancellationToken token) => await Mine(token) is { } subscription ? Json(await View(subscription, token)) : NotFoundError(); // Mastodon's update: the data given replaces what was there (alerts left out are off, the policy left out is all) - [HttpPut("/api/v1/push/subscription"), Scope("push")] + [HttpPut(ApiPaths.Push.PUT_Update), Scope("push")] public async Task Update(CancellationToken token) { var subscription = await Mine(token); @@ -107,7 +107,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await View(subscription, token)); } - [HttpDelete("/api/v1/push/subscription"), Scope("push")] + [HttpDelete(ApiPaths.Push.DELETE_Delete), Scope("push")] public async Task Delete(CancellationToken token) { await WebPush.ForgetToken(TokenId, token); diff --git a/PrivaPub/Api/Mastodon/Controllers/ReactionsController.cs b/PrivaPub/Api/Mastodon/Controllers/ReactionsController.cs index e5f0d57..ef84a84 100644 --- a/PrivaPub/Api/Mastodon/Controllers/ReactionsController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/ReactionsController.cs @@ -20,7 +20,7 @@ namespace PrivaPub.Api.Mastodon.Controllers MastodonMapper mapper, IReactions reactionService) : MastodonController { - [HttpGet("/api/v1/pleroma/statuses/{id}/reactions"), Scope("read:statuses", requiresUser: false), AllowAnonymous] + [HttpGet(ApiPaths.Reactions.GET_M_List), Scope("read:statuses", requiresUser: false), AllowAnonymous] public async Task List(string id, CancellationToken token) { var post = await Visible(id, token); @@ -38,7 +38,7 @@ namespace PrivaPub.Api.Mastodon.Controllers }).OrderByDescending(r => r.count).ToList()); } - [HttpPut("/api/v1/pleroma/statuses/{id}/reactions/{emoji}"), Scope("write:favourites")] + [HttpPut(ApiPaths.Reactions.PUT_M_React), Scope("write:favourites")] public async Task React(string id, string emoji, CancellationToken token) { var post = await Visible(id, token); @@ -49,7 +49,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await mapper.Status(post, MyId, token)); } - [HttpDelete("/api/v1/pleroma/statuses/{id}/reactions/{emoji}"), Scope("write:favourites")] + [HttpDelete(ApiPaths.Reactions.DELETE_M_Unreact), Scope("write:favourites")] public async Task Unreact(string id, string emoji, CancellationToken token) { var post = await Visible(id, token); diff --git a/PrivaPub/Api/Mastodon/Controllers/ReportsController.cs b/PrivaPub/Api/Mastodon/Controllers/ReportsController.cs index 26e27c6..0de70a0 100644 --- a/PrivaPub/Api/Mastodon/Controllers/ReportsController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/ReportsController.cs @@ -10,7 +10,7 @@ namespace PrivaPub.Api.Mastodon.Controllers IReportService reportService, MastodonMapper mapper) : MastodonController { - [HttpPost("/api/v1/reports"), Scope("write:reports")] + [HttpPost(ApiPaths.Reports.POST_Create), Scope("write:reports")] public async Task Create(CancellationToken token) { var report = await reportService.File(Me, Params.Get("account_id"), Params.List("status_ids"), Params.Get("comment"), Params.Get("category"), diff --git a/PrivaPub/Api/Mastodon/Controllers/ScheduledStatusesController.cs b/PrivaPub/Api/Mastodon/Controllers/ScheduledStatusesController.cs index a643662..3329341 100644 --- a/PrivaPub/Api/Mastodon/Controllers/ScheduledStatusesController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/ScheduledStatusesController.cs @@ -52,7 +52,7 @@ namespace PrivaPub.Api.Mastodon.Controllers Task Mine(string id, CancellationToken token) => DB.Default.Find().Match(s => s.ID == id && s.AvatarId == MyId).ExecuteFirstAsync(token); - [HttpGet("/api/v1/scheduled_statuses"), Scope("read:statuses")] + [HttpGet(ApiPaths.ScheduledStatuses.GET_All), Scope("read:statuses")] public async Task All(CancellationToken token) { var page = await Page.From(Params, Limit(20, 40)).Fetch(DB.Default.Find().Match(s => s.AvatarId == MyId), s => s.ID, token); @@ -63,11 +63,11 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(views); } - [HttpGet("/api/v1/scheduled_statuses/{id}"), Scope("read:statuses")] + [HttpGet(ApiPaths.ScheduledStatuses.GET_M_One), Scope("read:statuses")] public async Task One(string id, CancellationToken token) => await Mine(id, token) is { } scheduled ? Json(await View(scheduled, mediaService, token)) : NotFoundError(); - [HttpPut("/api/v1/scheduled_statuses/{id}"), Scope("write:statuses")] + [HttpPut(ApiPaths.ScheduledStatuses.PUT_M_Move), Scope("write:statuses")] public async Task Move(string id, CancellationToken token) { if (await Mine(id, token) is not { } scheduled) @@ -83,7 +83,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await View(scheduled, mediaService, token)); } - [HttpDelete("/api/v1/scheduled_statuses/{id}"), Scope("write:statuses")] + [HttpDelete(ApiPaths.ScheduledStatuses.DELETE_M_Drop), Scope("write:statuses")] public async Task Drop(string id, CancellationToken token) { if (await Mine(id, token) is not { } scheduled) diff --git a/PrivaPub/Api/Mastodon/Controllers/SearchController.cs b/PrivaPub/Api/Mastodon/Controllers/SearchController.cs index 3272579..b02b70a 100644 --- a/PrivaPub/Api/Mastodon/Controllers/SearchController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/SearchController.cs @@ -24,7 +24,7 @@ namespace PrivaPub.Api.Mastodon.Controllers AccountSearch accountSearch) : MastodonController { // Anyone may search, as on Mastodon; only resolving (which fetches from other servers) and paging need a sign-in. - [HttpGet("/api/v2/search"), Scope("read:search", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Search.GET_Search), Scope("read:search", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] public async Task Search(CancellationToken token) { var q = Params.Get("q")?.Trim(); @@ -130,58 +130,58 @@ namespace PrivaPub.Api.Mastodon.Controllers { // Routes Mastodon answers that we have nothing behind: an empty or default answer lets clients degrade, where a // 404 breaks some of them (Mastodon invariant 5) - [HttpGet("/api/v1/timelines/link"), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Stubs.GET_LinkTimeline), Microsoft.AspNetCore.Authorization.AllowAnonymous] public IActionResult LinkTimeline() => Json(Array.Empty()); - [HttpGet("/api/v1/accounts/{id}/identity_proofs"), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Stubs.GET_M_IdentityProofs), Microsoft.AspNetCore.Authorization.AllowAnonymous] public IActionResult IdentityProofs(string id) => Json(Array.Empty()); - [HttpGet("/api/v1/instance/languages"), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Stubs.GET_Languages), Microsoft.AspNetCore.Authorization.AllowAnonymous] public IActionResult Languages() => Json(InstanceController.LanguageCodes(HttpContext.RequestServices) .Select(code => new { code, name = System.Globalization.CultureInfo.GetCultureInfo(code).EnglishName })); - [HttpGet("/api/v1/instance/translation_languages"), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Stubs.GET_TranslationLanguages), Microsoft.AspNetCore.Authorization.AllowAnonymous] public IActionResult TranslationLanguages() => Json(new { }); // translation is cut (owner decision 2026-10-17): no language offers any (translation_languages), and a client that // asks anyway is told so, as Mastodon tells it when it can't translate - [HttpPost("/api/v1/statuses/{id}/translate"), Scope("read:statuses")] + [HttpPost(ApiPaths.Stubs.POST_M_Translate), Scope("read:statuses")] public IActionResult Translate(string id) => Error(StatusCodes.Status422UnprocessableEntity, "Translation is not available on this server"); // Mastodon 4.3's yearly reports (Wrapstodon): none are made here, so there are never any to show, for any year (4.4's // show), and marking one read changes nothing - [HttpGet("/api/v1/annual_reports"), HttpGet("/api/v1/annual_reports/{year}"), Scope("read:accounts")] + [HttpGet(ApiPaths.Stubs.GET_AnnualReports), HttpGet(ApiPaths.Stubs.GET_M_AnnualReports), Scope("read:accounts")] public IActionResult AnnualReports(string year) => Json(new { annual_reports = Array.Empty(), accounts = Array.Empty(), statuses = Array.Empty() }); - [HttpPost("/api/v1/annual_reports/{year}/read"), Scope("write:accounts")] + [HttpPost(ApiPaths.Stubs.POST_M_ReadAnnualReport), Scope("write:accounts")] public IActionResult ReadAnnualReport(string year) => Json(new { }); // Registration through the API is cut (owner decision 2026-10-17): a login is made by setup or an invitation, on // /clientapi. Mastodon answers this when its registrations are closed; its e-mail confirmation routes follow, since no // account here waits for one - [HttpPost("/api/v1/accounts"), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpPost(ApiPaths.Stubs.POST_Register), Microsoft.AspNetCore.Authorization.AllowAnonymous] public IActionResult Register() => Error(StatusCodes.Status403Forbidden, "This action is not allowed"); - [HttpPost("/api/v1/emails/confirmations"), Scope("write:accounts")] + [HttpPost(ApiPaths.Stubs.POST_ResendConfirmation), Scope("write:accounts")] public IActionResult ResendConfirmation() => Error(StatusCodes.Status403Forbidden, "This method is only available while the e-mail is awaiting confirmation"); - [HttpGet("/api/v1/emails/check_confirmation"), Scope("read:accounts")] + [HttpGet(ApiPaths.Stubs.GET_CheckConfirmation), Scope("read:accounts")] public IActionResult CheckConfirmation() => Json(true); // the peers' names are not published (/instance/peers stays empty), so a search of them finds none - [HttpGet("/api/v1/peers/search"), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Stubs.GET_SearchPeers), Microsoft.AspNetCore.Authorization.AllowAnonymous] public IActionResult SearchPeers() => Json(Array.Empty()); // Mastodon 4.4's asynchronous refreshes are announced by a Mastodon-Async-Refresh header, which PrivaPub never sends // (a thread's replies are read again in the background and simply show up): there is never one to ask about - [HttpGet("/api/v1_alpha/async_refreshes/{id}"), Scope("read")] + [HttpGet(ApiPaths.Stubs.GET_M_AsyncRefresh), Scope("read")] public IActionResult AsyncRefresh(string id) => NotFoundError(); // the Mastodon admin API is cut: moderation stays on /clientapi (ModeratorController, AdminController), so every // admin route answers as Mastodon answers an account that may not use it, whoever asks - [HttpGet("/api/v1/admin/{**rest}"), HttpPost("/api/v1/admin/{**rest}"), HttpPut("/api/v1/admin/{**rest}"), HttpPatch("/api/v1/admin/{**rest}"), - HttpDelete("/api/v1/admin/{**rest}"), HttpGet("/api/v2/admin/{**rest}"), HttpPost("/api/v2/admin/{**rest}"), + [HttpGet(ApiPaths.Stubs.GET_M_Admin), HttpPost(ApiPaths.Stubs.POST_M_Admin), HttpPut(ApiPaths.Stubs.PUT_M_Admin), HttpPatch(ApiPaths.Stubs.PATCH_M_Admin), + HttpDelete(ApiPaths.Stubs.DELETE_M_Admin), HttpGet(ApiPaths.Stubs.GET_M_AdminV2), HttpPost(ApiPaths.Stubs.POST_M_AdminV2), ApiExplorerSettings(IgnoreApi = true), Microsoft.AspNetCore.Authorization.AllowAnonymous] public IActionResult Admin(string rest) => Error(StatusCodes.Status403Forbidden, "This action is not allowed"); } diff --git a/PrivaPub/Api/Mastodon/Controllers/StatusesController.cs b/PrivaPub/Api/Mastodon/Controllers/StatusesController.cs index f2a0d64..7fb1089 100644 --- a/PrivaPub/Api/Mastodon/Controllers/StatusesController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/StatusesController.cs @@ -36,7 +36,7 @@ namespace PrivaPub.Api.Mastodon.Controllers - [HttpPost("/api/v1/statuses"), Scope("write:statuses")] + [HttpPost(ApiPaths.Statuses.POST_Create), Scope("write:statuses")] public async Task Create(CancellationToken token) { var idempotency = Request.Headers["Idempotency-Key"].ToString(); @@ -121,7 +121,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await ScheduledStatusesController.View(scheduled, mediaService, token)); } - [HttpGet("/api/v1/statuses"), Scope("read:statuses", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Statuses.GET_Many), Scope("read:statuses", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] public async Task Many(CancellationToken token) { var ids = Params.List("id").Take(20).ToList(); @@ -133,7 +133,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await mapper.Statuses(visible, MyId, token)); } - [HttpGet("/api/v1/statuses/{id}"), Scope("read:statuses", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Statuses.GET_M_Get), Scope("read:statuses", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] public async Task Get(string id, CancellationToken token) { var post = await Visible(id, token); @@ -141,7 +141,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return status == default ? NotFoundError() : Json(status); } - [HttpPut("/api/v1/statuses/{id}"), Scope("write:statuses")] + [HttpPut(ApiPaths.Statuses.PUT_M_Edit), Scope("write:statuses")] public async Task Edit(string id, CancellationToken token) { var outcome = await statusService.Edit(Me, id, new StatusDraft @@ -186,7 +186,7 @@ namespace PrivaPub.Api.Mastodon.Controllers : default; } - [HttpDelete("/api/v1/statuses/{id}"), Scope("write:statuses")] + [HttpDelete(ApiPaths.Statuses.DELETE_M_Delete), Scope("write:statuses")] public async Task Delete(string id, CancellationToken token) { var before = await dbEntities.Posts.Match(p => p.ID == id && p.GroupUserId == MyId && !p.IsFederatedCopy && !p.DeletedAt.HasValue).ExecuteFirstAsync(token); @@ -218,7 +218,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(status); } - [HttpGet("/api/v1/statuses/{id}/context"), Scope("read:statuses", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Statuses.GET_M_Context), Scope("read:statuses", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] public async Task Context(string id, CancellationToken token) { var post = await Visible(id, token); @@ -262,7 +262,7 @@ namespace PrivaPub.Api.Mastodon.Controllers }); } - [HttpGet("/api/v1/statuses/{id}/history"), Scope("read:statuses", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Statuses.GET_M_History), Scope("read:statuses", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] public async Task History(string id, CancellationToken token) { var post = await Visible(id, token); @@ -290,7 +290,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(edits); } - [HttpGet("/api/v1/statuses/{id}/source"), Scope("read:statuses")] + [HttpGet(ApiPaths.Statuses.GET_M_Source), Scope("read:statuses")] public async Task Source(string id, CancellationToken token) { var post = await dbEntities.Posts.Match(p => p.ID == id && p.GroupUserId == MyId && !p.IsFederatedCopy && !p.DeletedAt.HasValue).ExecuteFirstAsync(token); @@ -299,44 +299,44 @@ namespace PrivaPub.Api.Mastodon.Controllers // a persona joins or leaves a remote event (owner decision 2026-10-05); the status says how it stands // (privapub.event.participation) - [HttpPost("/api/privapub/v1/statuses/{id}/join"), Scope("write:statuses")] + [HttpPost(ApiPaths.Statuses.POST_M_Join), Scope("write:statuses")] public async Task Join(string id, CancellationToken token) { var outcome = await participations.Join(Me, id, token); return outcome.Ok ? Json(await mapper.Status(outcome.Post, MyId, token)) : Error(outcome.Status, outcome.Error); } - [HttpPost("/api/privapub/v1/statuses/{id}/leave"), Scope("write:statuses")] + [HttpPost(ApiPaths.Statuses.POST_M_Leave), Scope("write:statuses")] public async Task Leave(string id, CancellationToken token) { var outcome = await participations.Leave(Me, id, token); return outcome.Ok ? Json(await mapper.Status(outcome.Post, MyId, token)) : Error(outcome.Status, outcome.Error); } - [HttpPost("/api/v1/statuses/{id}/favourite"), Scope("write:favourites")] + [HttpPost(ApiPaths.Statuses.POST_M_Favourite), Scope("write:favourites")] public Task Favourite(string id, CancellationToken token) => Toggle(statusService.Favourite(Me, id, true, token), id, token); - [HttpPost("/api/v1/statuses/{id}/unfavourite"), Scope("write:favourites")] + [HttpPost(ApiPaths.Statuses.POST_M_Unfavourite), Scope("write:favourites")] public Task Unfavourite(string id, CancellationToken token) => Toggle(statusService.Favourite(Me, id, false, token), id, token); // PrivaPub's own, for the threadiverse's downvotes (a favourite is the upvote) - [HttpPost("/api/v1/statuses/{id}/downvote"), Scope("write:favourites")] + [HttpPost(ApiPaths.Statuses.POST_M_Downvote), Scope("write:favourites")] public Task Downvote(string id, CancellationToken token) => Toggle(statusService.Downvote(Me, id, true, token), id, token); - [HttpPost("/api/v1/statuses/{id}/undownvote"), Scope("write:favourites")] + [HttpPost(ApiPaths.Statuses.POST_M_Undownvote), Scope("write:favourites")] public Task Undownvote(string id, CancellationToken token) => Toggle(statusService.Downvote(Me, id, false, token), id, token); - [HttpPost("/api/v1/statuses/{id}/reblog"), Scope("write:statuses")] + [HttpPost(ApiPaths.Statuses.POST_M_Reblog), Scope("write:statuses")] public async Task Reblog(string id, CancellationToken token) { var outcome = await statusService.Reblog(Me, id, true, Visibility(Params.Get("visibility")), token); return outcome.Ok ? Json(await mapper.Status(outcome.Post, MyId, token)) : Error(outcome.Status, outcome.Error); } - [HttpPost("/api/v1/statuses/{id}/unreblog"), Scope("write:statuses")] + [HttpPost(ApiPaths.Statuses.POST_M_Unreblog), Scope("write:statuses")] public Task Unreblog(string id, CancellationToken token) => Toggle(statusService.Reblog(Me, id, false, PostVisibility.Public, token), id, token); - [HttpGet("/api/v1/statuses/{id}/favourited_by"), Scope("read:accounts", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Statuses.GET_M_FavouritedBy), Scope("read:accounts", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] public async Task FavouritedBy(string id, CancellationToken token) { if (await Visible(id, token) == default) @@ -346,7 +346,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(favourites.Select(f => accounts.GetValueOrDefault(f.AccountId)).Where(a => a != default).ToList()); } - [HttpGet("/api/v1/statuses/{id}/reblogged_by"), Scope("read:accounts", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Statuses.GET_M_RebloggedBy), Scope("read:accounts", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] public async Task RebloggedBy(string id, CancellationToken token) { if (await Visible(id, token) == default) @@ -356,7 +356,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(reblogs.Select(r => accounts.GetValueOrDefault(MastodonMapper.AuthorOf(r))).Where(a => a != default).ToList()); } - [HttpGet("/api/v1/statuses/{id}/quotes"), Scope("read:statuses", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Statuses.GET_M_Quotes), Scope("read:statuses", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] public async Task Quotes(string id, CancellationToken token) { if (await Visible(id, token) == default) @@ -371,7 +371,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await mapper.Statuses(visible, MyId, token)); } - [HttpPost("/api/v1/statuses/{id}/quotes/{quotingId}/revoke"), Scope("write:statuses")] + [HttpPost(ApiPaths.Statuses.POST_M_RevokeQuote), Scope("write:statuses")] public async Task RevokeQuote(string id, string quotingId, CancellationToken token) { var quoted = await dbEntities.Posts.Match(p => p.ID == id && p.GroupUserId == MyId && !p.IsFederatedCopy && !p.DeletedAt.HasValue).ExecuteFirstAsync(token); @@ -381,7 +381,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await mapper.Status(await dbEntities.Posts.MatchID(quoting.ID).ExecuteFirstAsync(token), MyId, token)); } - [HttpPut("/api/v1/statuses/{id}/interaction_policy"), Scope("write:statuses")] + [HttpPut(ApiPaths.Statuses.PUT_M_InteractionPolicy), Scope("write:statuses")] public async Task InteractionPolicy(string id, CancellationToken token) { var post = await dbEntities.Posts.Match(p => p.ID == id && p.GroupUserId == MyId && !p.IsFederatedCopy && !p.DeletedAt.HasValue).ExecuteFirstAsync(token); @@ -397,7 +397,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await mapper.Status(post, MyId, token)); } - [HttpPost("/api/v1/statuses/{id}/bookmark"), Scope("write:bookmarks")] + [HttpPost(ApiPaths.Statuses.POST_M_Bookmark), Scope("write:bookmarks")] public async Task Bookmark(string id, CancellationToken token) { var post = await Visible(id, token); @@ -413,14 +413,14 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await mapper.Status(post, MyId, token)); } - [HttpPost("/api/v1/statuses/{id}/unbookmark"), Scope("write:bookmarks")] + [HttpPost(ApiPaths.Statuses.POST_M_Unbookmark), Scope("write:bookmarks")] public async Task Unbookmark(string id, CancellationToken token) { await DB.Default.DeleteAsync(b => b.AvatarId == MyId && b.PostId == id); return await Unchanged(id, token); } - [HttpGet("/api/v1/bookmarks"), Scope("read:bookmarks")] + [HttpGet(ApiPaths.Statuses.GET_Bookmarks), Scope("read:bookmarks")] public async Task Bookmarks(CancellationToken token) { var bookmarks = await Page.From(Params, Limit()).Fetch(DB.Default.Find().Match(b => b.AvatarId == MyId), b => b.ID, token); @@ -434,13 +434,13 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await mapper.Statuses(visible, MyId, token)); } - [HttpPost("/api/v1/statuses/{id}/mute"), Scope("write:mutes")] + [HttpPost(ApiPaths.Statuses.POST_M_Mute), Scope("write:mutes")] public Task Mute(string id, CancellationToken token) => Unchanged(id, token); - [HttpPost("/api/v1/statuses/{id}/unmute"), Scope("write:mutes")] + [HttpPost(ApiPaths.Statuses.POST_M_Unmute), Scope("write:mutes")] public Task Unmute(string id, CancellationToken token) => Unchanged(id, token); - [HttpPost("/api/v1/statuses/{id}/pin"), Scope("write:accounts")] + [HttpPost(ApiPaths.Statuses.POST_M_Pin), Scope("write:accounts")] public async Task Pin(string id, CancellationToken token) { var post = await dbEntities.Posts.Match(p => p.ID == id && p.GroupUserId == MyId && !p.IsFederatedCopy && !p.DeletedAt.HasValue && p.ReblogOfPostId == null) @@ -466,7 +466,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await mapper.Status(post, MyId, token)); } - [HttpPost("/api/v1/statuses/{id}/unpin"), Scope("write:accounts")] + [HttpPost(ApiPaths.Statuses.POST_M_Unpin), Scope("write:accounts")] public async Task Unpin(string id, CancellationToken token) { var unpinned = await DB.Default.DeleteAsync(p => p.AvatarId == MyId && p.PostId == id); diff --git a/PrivaPub/Api/Mastodon/Controllers/StreamingController.cs b/PrivaPub/Api/Mastodon/Controllers/StreamingController.cs index 0059e82..a0f856e 100644 --- a/PrivaPub/Api/Mastodon/Controllers/StreamingController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/StreamingController.cs @@ -27,7 +27,7 @@ namespace PrivaPub.Api.Mastodon.Controllers static readonly TimeSpan KeepAlive = TimeSpan.FromSeconds(15); - [HttpGet("/api/v1/streaming/health"), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Streaming.GET_Health), Microsoft.AspNetCore.Authorization.AllowAnonymous] public IActionResult Health() => Content("OK", "text/plain"); // the stream a name and its parameter make, or why not: a hashtag needs its tag, a list must be the persona's own @@ -85,7 +85,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return status == default ? default : JsonSerializer.Serialize(status, MastodonJson.Options); } - [HttpGet("/api/v1/streaming"), Scope("read")] + [HttpGet(ApiPaths.Streaming.GET_Socket), Scope("read")] public async Task Socket(CancellationToken token) { if (!HttpContext.WebSockets.IsWebSocketRequest) @@ -178,7 +178,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return new EmptyResult(); } - [HttpGet("/api/v1/streaming/{*stream}"), Scope("read")] + [HttpGet(ApiPaths.Streaming.GET_M_Events), Scope("read")] public async Task Events(string stream, CancellationToken token) { var name = stream.Replace('/', ':'); diff --git a/PrivaPub/Api/Mastodon/Controllers/SuggestionsController.cs b/PrivaPub/Api/Mastodon/Controllers/SuggestionsController.cs index d856cff..55d03dc 100644 --- a/PrivaPub/Api/Mastodon/Controllers/SuggestionsController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/SuggestionsController.cs @@ -19,13 +19,13 @@ namespace PrivaPub.Api.Mastodon.Controllers MastodonMapper mapper, IInstanceSettings settings) : MastodonController { - [HttpGet("/api/v1/suggestions"), Scope("read")] + [HttpGet(ApiPaths.Suggestions.GET_V1), Scope("read")] public async Task V1(CancellationToken token) => Json((await Suggested(token)).Select(s => s.Account).ToList()); - [HttpGet("/api/v2/suggestions"), Scope("read")] + [HttpGet(ApiPaths.Suggestions.GET_V2), Scope("read")] public async Task V2(CancellationToken token) => Json(await Suggested(token)); - [HttpDelete("/api/v1/suggestions/{accountId}"), Scope("read")] + [HttpDelete(ApiPaths.Suggestions.DELETE_M_Dismiss), Scope("read")] public async Task Dismiss(string accountId, CancellationToken token) { if (!string.IsNullOrEmpty(accountId) && accountId.Length <= 64) diff --git a/PrivaPub/Api/Mastodon/Controllers/TagsController.cs b/PrivaPub/Api/Mastodon/Controllers/TagsController.cs index f64729d..9159256 100644 --- a/PrivaPub/Api/Mastodon/Controllers/TagsController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/TagsController.cs @@ -68,14 +68,14 @@ namespace PrivaPub.Api.Mastodon.Controllers : featuring ?? await DB.Default.Find().Match(t => t.AvatarId == viewerId && t.Name == tag).ExecuteAnyAsync(token) }; - [HttpGet("/api/v1/tags/{name}"), Scope("read", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Tags.GET_M_Tag), Scope("read", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] public async Task Tag(string name, CancellationToken token) { var tag = Normalise(name); return tag.Length == 0 ? NotFoundError() : Json(await View(tag, default, token: token)); } - [HttpPost("/api/v1/tags/{name}/follow"), Scope("write:follows")] + [HttpPost(ApiPaths.Tags.POST_M_Follow), Scope("write:follows")] public async Task Follow(string name, CancellationToken token) { var tag = Normalise(name); @@ -96,7 +96,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await View(tag, true, token: token)); } - [HttpPost("/api/v1/tags/{name}/unfollow"), Scope("write:follows")] + [HttpPost(ApiPaths.Tags.POST_M_Unfollow), Scope("write:follows")] public async Task Unfollow(string name, CancellationToken token) { var tag = Normalise(name); @@ -105,14 +105,14 @@ namespace PrivaPub.Api.Mastodon.Controllers } // Mastodon 4.4: a hashtag featured on the persona's profile, or no longer (R8, Domain/Social/FeaturedTags) - [HttpPost("/api/v1/tags/{name}/feature"), Scope("write:accounts")] + [HttpPost(ApiPaths.Tags.POST_M_Feature), Scope("write:accounts")] public async Task Feature(string name, [FromServices] Domain.Social.IFeaturedTags featured, CancellationToken token) { var (tag, error) = await featured.Feature(Me, name, token); return tag == default ? Error(StatusCodes.Status422UnprocessableEntity, error) : Json(await View(tag.Name, default, featuring: true, token)); } - [HttpPost("/api/v1/tags/{name}/unfeature"), Scope("write:accounts")] + [HttpPost(ApiPaths.Tags.POST_M_Unfeature), Scope("write:accounts")] public async Task Unfeature(string name, [FromServices] Domain.Social.IFeaturedTags featured, CancellationToken token) { var tag = Normalise(name); @@ -122,7 +122,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await View(tag, default, featuring: false, token)); } - [HttpGet("/api/v1/followed_tags"), Scope("read:follows")] + [HttpGet(ApiPaths.Tags.GET_Followed), Scope("read:follows")] public async Task Followed(CancellationToken token) { var page = await Page.From(Params, Limit(100, 200)).Fetch(DB.Default.Find().Match(t => t.AvatarId == MyId), t => t.ID, token); diff --git a/PrivaPub/Api/Mastodon/Controllers/TimelinesController.cs b/PrivaPub/Api/Mastodon/Controllers/TimelinesController.cs index fef9634..f7339ec 100644 --- a/PrivaPub/Api/Mastodon/Controllers/TimelinesController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/TimelinesController.cs @@ -23,7 +23,7 @@ namespace PrivaPub.Api.Mastodon.Controllers MastodonMapper mastodonMapper, DbEntities db) : MastodonController { - [HttpGet("/api/v1/timelines/home"), Scope("read:statuses")] + [HttpGet(ApiPaths.Timelines.GET_Home), Scope("read:statuses")] public async Task Home(CancellationToken token) { //an exclusive list's members are read in that list, not at home @@ -44,7 +44,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(statuses); } - [HttpGet("/api/v1/timelines/public"), Scope("read:statuses", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Timelines.GET_Public), Scope("read:statuses", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] public async Task Public(CancellationToken token) { var query = db.Posts.Match(p => p.Visibility == PostVisibility.Public && p.ReblogOfPostId == null).Match(VisibilityPolicy.IsPublic) @@ -60,7 +60,7 @@ namespace PrivaPub.Api.Mastodon.Controllers // PrivaPub's own: a feed the persona reads (Lemmy's multi-community, PieFed's feed), its communities' threads, // newest first, as the server's reader of feeds brings them in (owner decision 2026-10-07) - [HttpGet("/api/v1/timelines/feed/{id}"), Scope("read:statuses")] + [HttpGet(ApiPaths.Timelines.GET_M_Feed), Scope("read:statuses")] public async Task Feed(string id, CancellationToken token) { var feed = await db.ForeignAvatars.MatchID(id).ExecuteFirstAsync(token); @@ -78,7 +78,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return await Respond(query, $"/api/v1/timelines/feed/{id}", token); } - [HttpGet("/api/v1/timelines/tag/{hashtag}"), Scope("read:statuses", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Timelines.GET_M_Tag), Scope("read:statuses", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] public async Task Tag(string hashtag, CancellationToken token) { var tag = hashtag.TrimStart('#').ToLowerInvariant(); @@ -89,7 +89,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return await Respond(query, $"/api/v1/timelines/tag/{hashtag}", token); } - [HttpGet("/api/v1/favourites"), Scope("read:favourites")] + [HttpGet(ApiPaths.Timelines.GET_Favourites), Scope("read:favourites")] public async Task Favourites(CancellationToken token) { var favourites = await Page.From(Params, Limit()).Fetch(db.Favourites.Match(f => f.AccountId == MyId), f => f.ID, token); @@ -106,7 +106,7 @@ namespace PrivaPub.Api.Mastodon.Controllers // the persona's direct conversations, by their newest post (paged like Mastodon's by that post's id), each with its // other members and whether its newest post, someone else's, is newer than what the persona read; the ones it took // off its list stay off until a newer message - [HttpGet("/api/v1/conversations"), Scope("read:statuses")] + [HttpGet(ApiPaths.Timelines.GET_Conversations), Scope("read:statuses")] public async Task Conversations(CancellationToken token) { var groups = await Page.From(Params, Limit(20, 40)).Fetch( @@ -159,7 +159,7 @@ namespace PrivaPub.Api.Mastodon.Controllers await db.DmGroups.Match(g => g.ID == id && !g.DeletionAt.HasValue && g.Members.Any(m => !m.IsForeign && m.AvatarId == MyId)) .ExecuteFirstAsync(token); - [HttpPost("/api/v1/conversations/{id}/read"), Scope("write:conversations")] + [HttpPost(ApiPaths.Timelines.POST_M_ReadConversation), Scope("write:conversations")] public async Task ReadConversation(string id, CancellationToken token) { var group = await MyConversation(id, token); @@ -171,7 +171,7 @@ namespace PrivaPub.Api.Mastodon.Controllers } // Mastodon's unread (R9): shown unread again until it is read - [HttpPost("/api/v1/conversations/{id}/unread"), Scope("write:conversations")] + [HttpPost(ApiPaths.Timelines.POST_M_UnreadConversation), Scope("write:conversations")] public async Task UnreadConversation(string id, CancellationToken token) { var group = await MyConversation(id, token); @@ -183,7 +183,7 @@ namespace PrivaPub.Api.Mastodon.Controllers } // off the persona's list until a newer message; the messages themselves stay - [HttpDelete("/api/v1/conversations/{id}"), Scope("write:conversations")] + [HttpDelete(ApiPaths.Timelines.DELETE_M_RemoveConversation), Scope("write:conversations")] public async Task RemoveConversation(string id, CancellationToken token) { var group = await MyConversation(id, token); @@ -194,7 +194,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(new { }); } - [HttpGet("/api/v1/markers"), Scope("read:statuses")] + [HttpGet(ApiPaths.Timelines.GET_Markers), Scope("read:statuses")] public async Task Markers(CancellationToken token) { var wanted = Params.List("timeline"); @@ -203,7 +203,7 @@ namespace PrivaPub.Api.Mastodon.Controllers .ToDictionary(m => m.Timeline, m => new Entities.Marker { LastReadId = m.LastReadId, Version = m.Version, UpdatedAt = MastodonJson.Time(m.UpdatedAt) })); } - [HttpPost("/api/v1/markers"), Scope("write:statuses")] + [HttpPost(ApiPaths.Timelines.POST_SaveMarkers), Scope("write:statuses")] public async Task SaveMarkers(CancellationToken token) { var result = new Dictionary(); @@ -276,7 +276,7 @@ namespace PrivaPub.Api.Mastodon.Controllers // (notifications made before the policy have no Filtered at all) static readonly FilterDefinition NotFiltered = Builders.Filter.Ne(n => n.Filtered, true); - [HttpGet("/api/v1/notifications"), Scope("read:notifications")] + [HttpGet(ApiPaths.Notifications.GET_List), Scope("read:notifications")] public async Task List(CancellationToken token) { var notifications = await Page.From(Params, Limit(15, 30)).Fetch(Filtered(), n => n.ID, token); @@ -356,7 +356,7 @@ namespace PrivaPub.Api.Mastodon.Controllers }; } - [HttpGet("/api/v2/notifications"), Scope("read:notifications")] + [HttpGet(ApiPaths.Notifications.GET_GroupedList), Scope("read:notifications")] public async Task GroupedList(CancellationToken token) { var notifications = await Page.From(Params, Limit(40, 80)).Fetch(Filtered(), n => n.ID, token); @@ -364,7 +364,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await Groups(notifications, Grouped(), token)); } - [HttpGet("/api/v2/notifications/unread_count"), Scope("read:notifications")] + [HttpGet(ApiPaths.Notifications.GET_GroupedUnreadCount), Scope("read:notifications")] public async Task GroupedUnreadCount(CancellationToken token) { var unread = await Filtered().Match(n => !n.IsRead).Sort(n => n.ID, Order.Descending) @@ -374,7 +374,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(new { count = unread.Where(n => shown.Contains(n.ID)).Select(n => GroupKey(n, grouped)).Distinct().Count() }); } - [HttpGet("/api/v2/notifications/{groupKey}"), Scope("read:notifications")] + [HttpGet(ApiPaths.Notifications.GET_M_Group), Scope("read:notifications")] public async Task Group(string groupKey, CancellationToken token) { var members = await Members(groupKey, token); @@ -383,7 +383,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await Groups(members, new HashSet(DefaultGrouped.Append(Names[members[0].Type])), token)); } - [HttpGet("/api/v2/notifications/{groupKey}/accounts"), Scope("read:notifications")] + [HttpGet(ApiPaths.Notifications.GET_M_GroupAccounts), Scope("read:notifications")] public async Task GroupAccounts(string groupKey, CancellationToken token) { var members = await Members(groupKey, token); @@ -392,7 +392,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json((await Map(members, token)).Select(n => n.Account).DistinctBy(a => a.Id).ToList()); } - [HttpPost("/api/v2/notifications/{groupKey}/dismiss"), Scope("write:notifications")] + [HttpPost(ApiPaths.Notifications.POST_M_DismissGroup), Scope("write:notifications")] public async Task DismissGroup(string groupKey, CancellationToken token) { if (InGroup(groupKey) is not { } filter) @@ -401,7 +401,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(new { }); } - [HttpGet("/api/v1/notifications/{id}"), Scope("read:notifications")] + [HttpGet(ApiPaths.Notifications.GET_M_Get), Scope("read:notifications")] public async Task Get(string id, CancellationToken token) { var notification = await dbEntities.Notifications.Match(n => n.ID == id && n.AvatarId == MyId).ExecuteFirstAsync(token); @@ -409,14 +409,14 @@ namespace PrivaPub.Api.Mastodon.Controllers return mapped == default ? NotFoundError() : Json(mapped); } - [HttpPost("/api/v1/notifications/clear"), HttpPost("/api/v2/notifications/clear"), Scope("write:notifications")] + [HttpPost(ApiPaths.Notifications.POST_Clear), HttpPost(ApiPaths.Notifications.POST_ClearV2), Scope("write:notifications")] public async Task Clear(CancellationToken token) { await DB.Default.DeleteAsync(n => n.AvatarId == MyId); return Json(new { }); } - [HttpPost("/api/v1/notifications/{id}/dismiss"), Scope("write:notifications")] + [HttpPost(ApiPaths.Notifications.POST_M_Dismiss), Scope("write:notifications")] public async Task Dismiss(string id, CancellationToken token) { await DB.Default.DeleteAsync(n => n.ID == id && n.AvatarId == MyId); @@ -425,7 +425,7 @@ namespace PrivaPub.Api.Mastodon.Controllers // counts what the list would show (Map drops notifications from gone accounts and about hidden posts), at most // `limit` of them, as Mastodon does - [HttpGet("/api/v1/notifications/unread_count"), Scope("read:notifications")] + [HttpGet(ApiPaths.Notifications.GET_UnreadCount), Scope("read:notifications")] public async Task UnreadCount(CancellationToken token) { var unread = await DB.Default.Find().Match(n => n.AvatarId == MyId && !n.IsRead).Match(NotFiltered) diff --git a/PrivaPub/Api/Mastodon/Controllers/TrendsController.cs b/PrivaPub/Api/Mastodon/Controllers/TrendsController.cs index 567f7b0..5205363 100644 --- a/PrivaPub/Api/Mastodon/Controllers/TrendsController.cs +++ b/PrivaPub/Api/Mastodon/Controllers/TrendsController.cs @@ -31,7 +31,7 @@ namespace PrivaPub.Api.Mastodon.Controllers IEnumerable Window(IEnumerable items, int fallback, int max) => items.Skip(Math.Max(0, Params.Int("offset") ?? 0)).Take(Limit(fallback, max)); - [HttpGet("/api/v1/trends"), HttpGet("/api/v1/trends/tags"), Scope("read", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Trends.GET_Tags), HttpGet(ApiPaths.Trends.GET_TagsV1), Scope("read", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] public async Task Tags(CancellationToken token) { var followed = MyId == default @@ -46,7 +46,7 @@ namespace PrivaPub.Api.Mastodon.Controllers }).ToList()); } - [HttpGet("/api/v1/trends/statuses"), Scope("read", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Trends.GET_Statuses), Scope("read", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] public async Task Statuses(CancellationToken token) { var ids = Window(await trendService.Statuses(token), 20, 40).ToList(); @@ -54,7 +54,7 @@ namespace PrivaPub.Api.Mastodon.Controllers return Json(await mapper.Statuses(ids.Where(posts.ContainsKey).Select(id => posts[id]).ToList(), MyId, token)); } - [HttpGet("/api/v1/trends/links"), Scope("read", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Trends.GET_Links), Scope("read", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] public async Task Links(CancellationToken token) { var trends = Window(await trendService.Links(token), 10, 20).ToList(); @@ -75,7 +75,7 @@ namespace PrivaPub.Api.Mastodon.Controllers // order=active: by their latest public post PrivaPub holds; order=new: by when they say they joined, which for a // persona is its published day (never its creation, so personas made together are not told apart by their order) - [HttpGet("/api/v1/directory"), Scope("read", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] + [HttpGet(ApiPaths.Trends.GET_Directory), Scope("read", requiresUser: false), Microsoft.AspNetCore.Authorization.AllowAnonymous] public async Task Directory(CancellationToken token) { var offset = Math.Max(0, Params.Int("offset") ?? 0); diff --git a/PrivaPub/ApiPaths.cs b/PrivaPub/ApiPaths.cs new file mode 100644 index 0000000..2bd4ad4 --- /dev/null +++ b/PrivaPub/ApiPaths.cs @@ -0,0 +1,577 @@ +namespace PrivaPub +{ + public static class ApiPaths + { + public static class Token + { + public const string POST_Exchange = "/oauth/token"; + } + + public static class Accounts + { + public const string GET_VerifyCredentials = "/api/v1/accounts/verify_credentials"; + public const string PATCH_UpdateCredentials = "/api/v1/accounts/update_credentials"; + public const string DELETE_DeleteAvatar = "/api/v1/profile/avatar"; + public const string DELETE_DeleteHeader = "/api/v1/profile/header"; + public const string GET_Lookup = "/api/v1/accounts/lookup"; + public const string GET_Relationships = "/api/v1/accounts/relationships"; + public const string GET_Search = "/api/v1/accounts/search"; + public const string GET_Many = "/api/v1/accounts"; + public const string GET_M_Get = "/api/v1/accounts/{id}"; + public const string GET_M_Statuses = "/api/v1/accounts/{id}/statuses"; + public const string GET_M_Followers = "/api/v1/accounts/{id}/followers"; + public const string GET_M_Following = "/api/v1/accounts/{id}/following"; + public const string GET_Feeds = "/api/v1/feeds"; + public const string POST_M_Follow = "/api/v1/accounts/{id}/follow"; + public const string POST_M_Unfollow = "/api/v1/accounts/{id}/unfollow"; + public const string POST_M_RemoveFromFollowers = "/api/v1/accounts/{id}/remove_from_followers"; + public const string POST_M_Block = "/api/v1/accounts/{id}/block"; + public const string POST_M_Unblock = "/api/v1/accounts/{id}/unblock"; + public const string POST_M_Mute = "/api/v1/accounts/{id}/mute"; + public const string POST_M_Unmute = "/api/v1/accounts/{id}/unmute"; + public const string GET_Blocks = "/api/v1/blocks"; + public const string GET_Mutes = "/api/v1/mutes"; + public const string GET_DomainBlocks = "/api/v1/domain_blocks"; + public const string GET_PreviewDomainBlock = "/api/v1/domain_blocks/preview"; + public const string POST_BlockDomain = "/api/v1/domain_blocks"; + public const string DELETE_UnblockDomain = "/api/v1/domain_blocks"; + public const string GET_FollowRequests = "/api/v1/follow_requests"; + public const string POST_M_Authorize = "/api/v1/follow_requests/{id}/authorize"; + public const string POST_M_Reject = "/api/v1/follow_requests/{id}/reject"; + public const string GET_FamiliarFollowers = "/api/v1/accounts/familiar_followers"; + public const string POST_M_Endorse = "/api/v1/accounts/{id}/pin"; + public const string POST_M_EndorseV1 = "/api/v1/accounts/{id}/endorse"; + public const string POST_M_Unendorse = "/api/v1/accounts/{id}/unpin"; + public const string POST_M_UnendorseV1 = "/api/v1/accounts/{id}/unendorse"; + public const string GET_Endorsements = "/api/v1/endorsements"; + public const string GET_M_EndorsementsOfAccount = "/api/v1/accounts/{id}/endorsements"; + public const string POST_M_Note = "/api/v1/accounts/{id}/note"; + public const string GET_Preferences = "/api/v1/preferences"; + } + + public static class Announcements + { + public const string GET_List = "/api/v1/announcements"; + public const string POST_M_Dismiss = "/api/v1/announcements/{id}/dismiss"; + public const string PUT_M_React = "/api/v1/announcements/{id}/reactions/{name}"; + public const string DELETE_M_Unreact = "/api/v1/announcements/{id}/reactions/{name}"; + } + + public static class Apps + { + public const string POST_Create = "/api/v1/apps"; + public const string GET_Verify = "/api/v1/apps/verify_credentials"; + } + + public static class Cdns + { + public const string GET_List = "/api/privapub/v1/cdns"; + public const string GET_M_Detail = "/api/privapub/v1/cdns/{key}"; + } + + public static class CustomEmojis + { + public const string GET_List = "/api/v1/custom_emojis"; + } + + public static class FeaturedTags + { + public const string GET_Mine = "/api/v1/featured_tags"; + public const string POST_Feature = "/api/v1/featured_tags"; + public const string DELETE_M_Unfeature = "/api/v1/featured_tags/{id}"; + public const string GET_Suggestions = "/api/v1/featured_tags/suggestions"; + public const string GET_M_OfAccount = "/api/v1/accounts/{id}/featured_tags"; + } + + public static class Filters + { + public const string GET_All = "/api/v2/filters"; + public const string GET_M_One = "/api/v2/filters/{id}"; + public const string POST_Create = "/api/v2/filters"; + public const string PUT_M_Update = "/api/v2/filters/{id}"; + public const string DELETE_M_Delete = "/api/v2/filters/{id}"; + public const string GET_M_Keywords = "/api/v2/filters/{id}/keywords"; + public const string POST_M_AddKeyword = "/api/v2/filters/{id}/keywords"; + public const string GET_M_Keyword = "/api/v2/filters/keywords/{id}"; + public const string PUT_M_UpdateKeyword = "/api/v2/filters/keywords/{id}"; + public const string DELETE_M_DeleteKeyword = "/api/v2/filters/keywords/{id}"; + public const string GET_M_Statuses = "/api/v2/filters/{id}/statuses"; + public const string POST_M_AddStatus = "/api/v2/filters/{id}/statuses"; + public const string GET_M_Status = "/api/v2/filters/statuses/{id}"; + public const string DELETE_M_DeleteStatus = "/api/v2/filters/statuses/{id}"; + public const string GET_AllV1 = "/api/v1/filters"; + public const string GET_M_OneV1 = "/api/v1/filters/{id}"; + public const string POST_CreateV1 = "/api/v1/filters"; + public const string PUT_M_UpdateV1 = "/api/v1/filters/{id}"; + public const string DELETE_M_DeleteV1 = "/api/v1/filters/{id}"; + } + + public static class Instance + { + public const string GET_V1 = "/api/v1/instance"; + public const string GET_V2 = "/api/v2/instance"; + public const string GET_Peers = "/api/v1/instance/peers"; + public const string GET_Activity = "/api/v1/instance/activity"; + public const string GET_InstanceRules = "/api/v1/instance/rules"; + public const string GET_ExtendedDescription = "/api/v1/instance/extended_description"; + public const string GET_PrivacyPolicy = "/api/v1/instance/privacy_policy"; + public const string GET_TermsOfService = "/api/v1/instance/terms_of_service"; + public const string GET_M_TermsOfServiceOn = "/api/v1/instance/terms_of_service/{date}"; + public const string GET_DomainBlocks = "/api/v1/instance/domain_blocks"; + } + + public static class Lists + { + public const string GET_All = "/api/v1/lists"; + public const string GET_M_One = "/api/v1/lists/{id}"; + public const string POST_Create = "/api/v1/lists"; + public const string PUT_M_Update = "/api/v1/lists/{id}"; + public const string DELETE_M_Delete = "/api/v1/lists/{id}"; + public const string GET_M_Accounts = "/api/v1/lists/{id}/accounts"; + public const string POST_M_Add = "/api/v1/lists/{id}/accounts"; + public const string DELETE_M_Remove = "/api/v1/lists/{id}/accounts"; + public const string GET_M_Containing = "/api/v1/accounts/{id}/lists"; + public const string GET_M_Timeline = "/api/v1/timelines/list/{id}"; + } + + public static class Media + { + public const string POST_Upload = "/api/v1/media"; + public const string POST_UploadV2 = "/api/v2/media"; + public const string GET_M_Get = "/api/v1/media/{id}"; + public const string DELETE_M_Delete = "/api/v1/media/{id}"; + public const string PUT_M_Update = "/api/v1/media/{id}"; + public const string GET_M_Proxy = "/media/proxy/{signature}/{encoded}"; + } + + public static class NotificationRequests + { + public const string GET_Policy = "/api/v2/notifications/policy"; + public const string PATCH_SetPolicy = "/api/v2/notifications/policy"; + public const string PUT_SetPolicy = "/api/v2/notifications/policy"; + public const string GET_PolicyV1 = "/api/v1/notifications/policy"; + public const string PUT_SetPolicyV1 = "/api/v1/notifications/policy"; + public const string PATCH_SetPolicyV1 = "/api/v1/notifications/policy"; + public const string GET_Requests = "/api/v1/notifications/requests"; + public const string GET_Merged = "/api/v1/notifications/requests/merged"; + public const string GET_M_Request = "/api/v1/notifications/requests/{id}"; + public const string POST_M_Accept = "/api/v1/notifications/requests/{id}/accept"; + public const string POST_M_Dismiss = "/api/v1/notifications/requests/{id}/dismiss"; + public const string POST_AcceptMany = "/api/v1/notifications/requests/accept"; + public const string POST_DismissMany = "/api/v1/notifications/requests/dismiss"; + } + + public static class Polls + { + public const string GET_M_Get = "/api/v1/polls/{id}"; + public const string POST_M_Vote = "/api/v1/polls/{id}/votes"; + } + + public static class Provenance + { + public const string GET_M_Status = "/api/privapub/v1/statuses/{id}/provenance"; + public const string GET_M_Instance = "/api/privapub/v1/instances/{host}"; + public const string GET_Instances = "/api/privapub/v1/instances"; + public const string GET_M_History = "/api/privapub/v1/instances/{host}/history"; + } + + public static class Push + { + public const string POST_Create = "/api/v1/push/subscription"; + public const string GET_Show = "/api/v1/push/subscription"; + public const string PUT_Update = "/api/v1/push/subscription"; + public const string DELETE_Delete = "/api/v1/push/subscription"; + } + + public static class Reactions + { + public const string GET_M_List = "/api/v1/pleroma/statuses/{id}/reactions"; + public const string PUT_M_React = "/api/v1/pleroma/statuses/{id}/reactions/{emoji}"; + public const string DELETE_M_Unreact = "/api/v1/pleroma/statuses/{id}/reactions/{emoji}"; + } + + public static class Reports + { + public const string POST_Create = "/api/v1/reports"; + } + + public static class ScheduledStatuses + { + public const string GET_All = "/api/v1/scheduled_statuses"; + public const string GET_M_One = "/api/v1/scheduled_statuses/{id}"; + public const string PUT_M_Move = "/api/v1/scheduled_statuses/{id}"; + public const string DELETE_M_Drop = "/api/v1/scheduled_statuses/{id}"; + } + + public static class Search + { + public const string GET_Search = "/api/v2/search"; + } + + public static class Stubs + { + public const string GET_LinkTimeline = "/api/v1/timelines/link"; + public const string GET_M_IdentityProofs = "/api/v1/accounts/{id}/identity_proofs"; + public const string GET_Languages = "/api/v1/instance/languages"; + public const string GET_TranslationLanguages = "/api/v1/instance/translation_languages"; + public const string POST_M_Translate = "/api/v1/statuses/{id}/translate"; + public const string GET_AnnualReports = "/api/v1/annual_reports"; + public const string GET_M_AnnualReports = "/api/v1/annual_reports/{year}"; + public const string POST_M_ReadAnnualReport = "/api/v1/annual_reports/{year}/read"; + public const string POST_Register = "/api/v1/accounts"; + public const string POST_ResendConfirmation = "/api/v1/emails/confirmations"; + public const string GET_CheckConfirmation = "/api/v1/emails/check_confirmation"; + public const string GET_SearchPeers = "/api/v1/peers/search"; + public const string GET_M_AsyncRefresh = "/api/v1_alpha/async_refreshes/{id}"; + public const string GET_M_Admin = "/api/v1/admin/{**rest}"; + public const string POST_M_Admin = "/api/v1/admin/{**rest}"; + public const string PUT_M_Admin = "/api/v1/admin/{**rest}"; + public const string PATCH_M_Admin = "/api/v1/admin/{**rest}"; + public const string DELETE_M_Admin = "/api/v1/admin/{**rest}"; + public const string GET_M_AdminV2 = "/api/v2/admin/{**rest}"; + public const string POST_M_AdminV2 = "/api/v2/admin/{**rest}"; + } + + public static class Statuses + { + public const string POST_Create = "/api/v1/statuses"; + public const string GET_Many = "/api/v1/statuses"; + public const string GET_M_Get = "/api/v1/statuses/{id}"; + public const string PUT_M_Edit = "/api/v1/statuses/{id}"; + public const string DELETE_M_Delete = "/api/v1/statuses/{id}"; + public const string GET_M_Context = "/api/v1/statuses/{id}/context"; + public const string GET_M_History = "/api/v1/statuses/{id}/history"; + public const string GET_M_Source = "/api/v1/statuses/{id}/source"; + public const string POST_M_Join = "/api/privapub/v1/statuses/{id}/join"; + public const string POST_M_Leave = "/api/privapub/v1/statuses/{id}/leave"; + public const string POST_M_Favourite = "/api/v1/statuses/{id}/favourite"; + public const string POST_M_Unfavourite = "/api/v1/statuses/{id}/unfavourite"; + public const string POST_M_Downvote = "/api/v1/statuses/{id}/downvote"; + public const string POST_M_Undownvote = "/api/v1/statuses/{id}/undownvote"; + public const string POST_M_Reblog = "/api/v1/statuses/{id}/reblog"; + public const string POST_M_Unreblog = "/api/v1/statuses/{id}/unreblog"; + public const string GET_M_FavouritedBy = "/api/v1/statuses/{id}/favourited_by"; + public const string GET_M_RebloggedBy = "/api/v1/statuses/{id}/reblogged_by"; + public const string GET_M_Quotes = "/api/v1/statuses/{id}/quotes"; + public const string POST_M_RevokeQuote = "/api/v1/statuses/{id}/quotes/{quotingId}/revoke"; + public const string PUT_M_InteractionPolicy = "/api/v1/statuses/{id}/interaction_policy"; + public const string POST_M_Bookmark = "/api/v1/statuses/{id}/bookmark"; + public const string POST_M_Unbookmark = "/api/v1/statuses/{id}/unbookmark"; + public const string GET_Bookmarks = "/api/v1/bookmarks"; + public const string POST_M_Mute = "/api/v1/statuses/{id}/mute"; + public const string POST_M_Unmute = "/api/v1/statuses/{id}/unmute"; + public const string POST_M_Pin = "/api/v1/statuses/{id}/pin"; + public const string POST_M_Unpin = "/api/v1/statuses/{id}/unpin"; + } + + public static class Streaming + { + public const string GET_Health = "/api/v1/streaming/health"; + public const string GET_Socket = "/api/v1/streaming"; + public const string GET_M_Events = "/api/v1/streaming/{*stream}"; + } + + public static class Suggestions + { + public const string GET_V1 = "/api/v1/suggestions"; + public const string GET_V2 = "/api/v2/suggestions"; + public const string DELETE_M_Dismiss = "/api/v1/suggestions/{accountId}"; + } + + public static class Tags + { + public const string GET_M_Tag = "/api/v1/tags/{name}"; + public const string POST_M_Follow = "/api/v1/tags/{name}/follow"; + public const string POST_M_Unfollow = "/api/v1/tags/{name}/unfollow"; + public const string POST_M_Feature = "/api/v1/tags/{name}/feature"; + public const string POST_M_Unfeature = "/api/v1/tags/{name}/unfeature"; + public const string GET_Followed = "/api/v1/followed_tags"; + } + + public static class Timelines + { + public const string GET_Home = "/api/v1/timelines/home"; + public const string GET_Public = "/api/v1/timelines/public"; + public const string GET_M_Feed = "/api/v1/timelines/feed/{id}"; + public const string GET_M_Tag = "/api/v1/timelines/tag/{hashtag}"; + public const string GET_Favourites = "/api/v1/favourites"; + public const string GET_Conversations = "/api/v1/conversations"; + public const string POST_M_ReadConversation = "/api/v1/conversations/{id}/read"; + public const string POST_M_UnreadConversation = "/api/v1/conversations/{id}/unread"; + public const string DELETE_M_RemoveConversation = "/api/v1/conversations/{id}"; + public const string GET_Markers = "/api/v1/markers"; + public const string POST_SaveMarkers = "/api/v1/markers"; + } + + public static class Notifications + { + public const string GET_List = "/api/v1/notifications"; + public const string GET_GroupedList = "/api/v2/notifications"; + public const string GET_GroupedUnreadCount = "/api/v2/notifications/unread_count"; + public const string GET_M_Group = "/api/v2/notifications/{groupKey}"; + public const string GET_M_GroupAccounts = "/api/v2/notifications/{groupKey}/accounts"; + public const string POST_M_DismissGroup = "/api/v2/notifications/{groupKey}/dismiss"; + public const string GET_M_Get = "/api/v1/notifications/{id}"; + public const string POST_Clear = "/api/v1/notifications/clear"; + public const string POST_ClearV2 = "/api/v2/notifications/clear"; + public const string POST_M_Dismiss = "/api/v1/notifications/{id}/dismiss"; + public const string GET_UnreadCount = "/api/v1/notifications/unread_count"; + } + + public static class Trends + { + public const string GET_Tags = "/api/v1/trends"; + public const string GET_TagsV1 = "/api/v1/trends/tags"; + public const string GET_Statuses = "/api/v1/trends/statuses"; + public const string GET_Links = "/api/v1/trends/links"; + public const string GET_Directory = "/api/v1/directory"; + } + + public static class Admin + { + public const string Prefix = "clientapi/admin"; + public const string DELETE_RemoveUsers = "/clientapi/admin/remove/users"; + public const string POST_BanUsers = "/clientapi/admin/ban/users"; + public const string POST_UnbanUsers = "/clientapi/admin/unban/users"; + public const string GET_Roots = "/clientapi/admin/roots"; + public const string GET_M_Root = "/clientapi/admin/roots/{id}"; + public const string POST_M_Role = "/clientapi/admin/roots/{id}/role"; + public const string POST_M_ResetTotp = "/clientapi/admin/roots/{id}/totp/reset"; + public const string POST_M_DeletePersona = "/clientapi/admin/personas/{id}/delete"; + public const string POST_M_DeleteGroup = "/clientapi/admin/groups/{id}/delete"; + } + + public static class Backup + { + public const string Prefix = "clientapi/admin/backups"; + public const string GET_List = ""; + public const string POST_Create = ""; + public const string DELETE_M_Delete = "{id}"; + public const string POST_M_Ticket = "{id}/ticket"; + public const string GET_M_Download = "download/{ticket}"; + public const string POST_StartUpload = "uploads"; + public const string GET_M_Upload = "uploads/{id}"; + public const string PUT_M_Append = "uploads/{id}"; + public const string POST_M_FinishUpload = "uploads/{id}/finish"; + public const string DELETE_M_CancelUpload = "uploads/{id}"; + public const string POST_M_Restore = "{id}/restore"; + } + + public static class Data + { + public const string Prefix = "clientapi/data"; + public const string GET_Ping = "/clientapi/data/ping"; + public const string GET_CurrentVersion = "/clientapi/data/current-version"; + public const string GET_Languages = "/clientapi/data/languages"; + } + + public static class DomainBlock + { + public const string Prefix = "clientapi/admin/domainblocks"; + public const string GET_List = "/clientapi/admin/domainblocks/list"; + public const string POST_Insert = "/clientapi/admin/domainblocks/insert"; + public const string POST_Delete = "/clientapi/admin/domainblocks/delete"; + } + + public static class EmojiAdmin + { + public const string Prefix = "clientapi/admin/emoji"; + public const string GET_List = "list"; + public const string POST_Insert = "insert"; + public const string POST_Update = "update"; + public const string POST_Delete = "delete"; + } + + public static class Group + { + public const string Prefix = "clientapi/group"; + public const string GET_List = "/clientapi/group/list"; + public const string POST_Insert = "/clientapi/group/insert"; + public const string POST_Update = "/clientapi/group/update"; + public const string POST_Join = "/clientapi/group/join"; + public const string POST_Leave = "/clientapi/group/leave"; + public const string POST_Approve = "/clientapi/group/approve"; + public const string GET_Members = "/clientapi/group/members"; + public const string POST_Reject = "/clientapi/group/reject"; + public const string POST_Remove = "/clientapi/group/remove"; + public const string POST_Delete = "/clientapi/group/delete"; + } + + public static class InstanceAdmin + { + public const string Prefix = "clientapi/admin"; + public const string GET_Settings = "/clientapi/admin/settings"; + public const string POST_SaveSettings = "/clientapi/admin/settings"; + public const string POST_SaveThumbnail = "/clientapi/admin/settings/thumbnail"; + public const string DELETE_DeleteThumbnail = "/clientapi/admin/settings/thumbnail"; + public const string GET_Announcements = "/clientapi/admin/announcements/list"; + public const string POST_InsertAnnouncement = "/clientapi/admin/announcements/insert"; + public const string POST_UpdateAnnouncement = "/clientapi/admin/announcements/update"; + public const string POST_DeleteAnnouncement = "/clientapi/admin/announcements/delete"; + public const string GET_StaffPicks = "/clientapi/admin/staff-picks"; + public const string POST_InsertStaffPick = "/clientapi/admin/staff-picks/insert"; + public const string POST_DeleteStaffPick = "/clientapi/admin/staff-picks/delete"; + public const string GET_Relays = "/clientapi/admin/relays"; + public const string POST_InsertRelay = "/clientapi/admin/relays/insert"; + public const string POST_DeleteRelay = "/clientapi/admin/relays/delete"; + } + + public static class Moderator + { + public const string Prefix = "clientapi/moderator"; + public const string GET_Reports = "/clientapi/moderator/reports"; + public const string POST_M_Resolve = "/clientapi/moderator/reports/{id}/resolve"; + public const string GET_Accounts = "/clientapi/moderator/accounts"; + public const string GET_Moderated = "/clientapi/moderator/accounts/moderated"; + public const string GET_M_Account = "/clientapi/moderator/accounts/{id}"; + public const string POST_Moderate = "/clientapi/moderator/accounts/moderate"; + public const string POST_RemovePost = "/clientapi/moderator/posts/remove"; + public const string GET_Log = "/clientapi/moderator/log"; + } + + public static class PersonaArchive + { + public const string Prefix = "clientapi/persona"; + public const string GET_M_Status = "{avatarId}/archive"; + public const string POST_M_Export = "{avatarId}/archive"; + public const string POST_M_Ticket = "{avatarId}/archive/ticket"; + public const string GET_M_Download = "archive/download/{ticket}"; + public const string POST_StartUpload = "archive/uploads"; + public const string GET_M_Upload = "archive/uploads/{id}"; + public const string PUT_M_Append = "archive/uploads/{id}"; + public const string DELETE_M_CancelUpload = "archive/uploads/{id}"; + public const string POST_M_Import = "{avatarId}/archive/import"; + public const string POST_M_Stop = "{avatarId}/archive/import/stop"; + } + + public static class Post + { + public const string Prefix = "clientapi/post"; + public const string GET_List = "/clientapi/post/list"; + public const string POST_Insert = "/clientapi/post/insert"; + public const string GET_Nearby = "/clientapi/post/nearby"; + public const string POST_Update = "/clientapi/post/update"; + public const string POST_Delete = "/clientapi/post/delete"; + public const string GET_Dms = "/clientapi/dm/list"; + public const string POST_InsertDm = "/clientapi/dm/insert"; + } + + public static class PrivateAvatar + { + public const string Prefix = "clientapi/avatar/private"; + public const string GET_GetAvatars = "/clientapi/avatar/private/list"; + public const string POST_InsertAvatar = "/clientapi/avatar/private/insert"; + public const string POST_DeleteAvatar = "/clientapi/avatar/private/delete"; + public const string GET_Preferences = "/clientapi/avatar/private/preferences"; + public const string POST_SavePreferences = "/clientapi/avatar/private/preferences"; + public const string POST_UpdateAvatar = "/clientapi/avatar/private/update"; + } + + public static class RootUser + { + public const string Prefix = "clientapi/user"; + public const string POST_SignUp = "/clientapi/user/signup"; + public const string POST_Login = "/clientapi/user/login"; + public const string POST_InvitationSignUp = "/clientapi/user/invitation/signup"; + public const string POST_InvitationLogin = "/clientapi/user/invitation/login"; + public const string GET_Setup = "/clientapi/user/setup"; + public const string POST_SetUp = "/clientapi/user/setup"; + public const string GET_Logout = "/clientapi/user/logout"; + public const string POST_LogoutEverywhere = "/clientapi/user/logout/everywhere"; + public const string POST_UpdateUser = "/clientapi/user/update"; + public const string GET_Account = "/clientapi/user/account"; + public const string POST_RequestEmailChange = "/clientapi/user/email"; + public const string POST_VerifyEmail = "/clientapi/user/email/verify"; + public const string POST_TotpSetup = "/clientapi/user/totp/setup"; + public const string POST_TotpEnable = "/clientapi/user/totp/enable"; + public const string POST_TotpDisable = "/clientapi/user/totp/disable"; + public const string POST_RemoveEmail = "/clientapi/user/email/remove"; + public const string POST_UpdateUserSettings = "/clientapi/user/update/settings"; + public const string POST_UpdatePassword = "/clientapi/user/update/password"; + public const string GET_GetStorage = "/clientapi/user/storage"; + public const string GET_GetUserSettings = "/clientapi/user/settings"; + public const string POST_RecoverPassword = "/clientapi/user/recover/password"; + public const string POST_IsValidRecoveryCode = "/clientapi/user/recover/valid"; + public const string POST_ChangePassword = "/clientapi/user/recover/update/password"; + public const string POST_RemoveSelf = "/clientapi/user/delete"; + public const string GET_SniffAgain = "/clientapi/user/sniff/again"; + } + + public static class Social + { + public const string Prefix = "clientapi/social"; + public const string POST_Follow = "/clientapi/follow"; + public const string POST_Unfollow = "/clientapi/unfollow"; + public const string GET_Following = "/clientapi/following"; + } + + public static class Statistics + { + public const string Prefix = "clientapi/admin/statistics"; + public const string GET_Crawler = "/clientapi/admin/statistics/crawler"; + public const string GET_Overview = "/clientapi/admin/statistics/overview"; + public const string GET_Hosts = "/clientapi/admin/statistics/hosts"; + public const string GET_M_Host = "/clientapi/admin/statistics/hosts/{host}"; + public const string GET_Events = "/clientapi/admin/statistics/events"; + public const string GET_Server = "/clientapi/admin/statistics/server"; + public const string POST_M_Rollup = "/clientapi/admin/statistics/rollups/{day}"; + public const string POST_M_Describe = "/clientapi/admin/statistics/hosts/{host}/describe"; + } + + public static class Timeline + { + public const string Prefix = "clientapi/timeline"; + public const string GET_Home = "/clientapi/timeline/home"; + public const string GET_Notifications = "/clientapi/notifications"; + public const string POST_Read = "/clientapi/notifications/read"; + } + + public static class Emojis + { + public const string GET_Get = "/"; + } + + public static class Peasants + { + public const string Prefix = "peasants"; + public const string GET_M_GetActor = "{actor}"; + public const string GET_Root = "/"; + public const string GET_M_Outbox = "{actor}/anus"; + public const string GET_M_Followers = "{actor}/groupies"; + public const string GET_M_Wall = "{actor}/"; + public const string GET_M_RollCall = "{actor}/groupies/roll-call"; + public const string GET_M_Following = "{actor}/stalking"; + public const string GET_M_Members = "{actor}/flock"; + public const string GET_M_Moderators = "{actor}/wardens"; + public const string GET_M_Featured = "{actor}/trophies"; + public const string GET_M_FeaturedTags = "{actor}/tattoos"; + public const string GET_M_Post = "{actor}/scribbles/{postId}"; + public const string GET_M_Replies = "{actor}/scribbles/{postId}/replies"; + public const string GET_M_Context = "{actor}/scribbles/{postId}/context"; + public const string GET_M_ParrotLicence = "{actor}/parrot-licences/{licenceId}"; + public const string GET_M_Grunt = "{actor}/grunts/{activityId}"; + public const string GET_M_Whispers = "{actor}/whispers/{conversationId}"; + public const string POST_M_Inbox = "{actor}/mouth"; + public const string POST_M_ActorSharedInbox = "{actor}/human-centipede"; + public const string POST_SharedInbox = "/human-centipede"; + } + + public static class Users + { + public const string Prefix = "users"; + public const string GET_M_GetActor = "{actor}"; + } + + public static class WellKnown + { + public const string GET_WebFinger = "/.well-known/webfinger"; + public const string GET_NodeInfoLinks = "/.well-known/nodeinfo"; + public const string GET_M_NodeInfo = "/nodeinfo/{version:regex(^2\\.[[01]]$)}"; + } + + public static class Build + { + public const string GET_BuildJson = "/build.json"; + } + } +} diff --git a/PrivaPub/Controllers/ClientToServer/AdminController.cs b/PrivaPub/Controllers/ClientToServer/AdminController.cs index 6d4b947..41b7552 100644 --- a/PrivaPub/Controllers/ClientToServer/AdminController.cs +++ b/PrivaPub/Controllers/ClientToServer/AdminController.cs @@ -29,7 +29,7 @@ namespace PrivaPub.Controllers.ClientToServer // login's two-factor sign-in off. Every act is kept in the staff's log; an entry about a login names none of its // personas. [ApiController, - Route("clientapi/admin"), + Route(ApiPaths.Admin.Prefix), Authorize(Policy = Policies.IsAdmin)] public class AdminController( ILogger logger, @@ -58,7 +58,7 @@ namespace PrivaPub.Controllers.ClientToServer : (await DB.Default.Find().Match(u => ids.Contains(u.ID) && u.DeletedAt == null).ExecuteAsync(token)).ToDictionary(u => u.ID, u => u.UserName); } - [HttpDelete, Route("/clientapi/admin/remove/users")] + [HttpDelete, Route(ApiPaths.Admin.DELETE_RemoveUsers)] public async Task RemoveUsers([Required] UsersIds usersIds, CancellationToken token) { var result = new WebResult(); @@ -82,7 +82,7 @@ namespace PrivaPub.Controllers.ClientToServer // A ban ends the login's sessions and holds its personas back as suspended ones (Restrictions), without writing a word // on any of them; unbanning gives them back as they were. - [HttpPost, Route("/clientapi/admin/ban/users")] + [HttpPost, Route(ApiPaths.Admin.POST_BanUsers)] public async Task BanUsers([Required] UsersIds usersIds, [FromServices] IRootSessions sessions, CancellationToken token) { if (!ModelState.IsValid) @@ -114,7 +114,7 @@ namespace PrivaPub.Controllers.ClientToServer } } - [HttpPost, Route("/clientapi/admin/unban/users")] + [HttpPost, Route(ApiPaths.Admin.POST_UnbanUsers)] public async Task UnbanUsers([Required] UsersIds usersIds, CancellationToken token) { if (!ModelState.IsValid) @@ -142,7 +142,7 @@ namespace PrivaPub.Controllers.ClientToServer // The logins, newest first, each with its personas and the groups they own; q finds a login by its name, or by the // name of one of its personas. - [HttpGet, Route("/clientapi/admin/roots")] + [HttpGet, Route(ApiPaths.Admin.GET_Roots)] public async Task Roots([FromQuery] string q, [FromQuery] string before, [FromQuery] int limit = 50, CancellationToken token = default) { limit = Math.Clamp(limit, 1, MaxRootsPage); @@ -171,7 +171,7 @@ namespace PrivaPub.Controllers.ClientToServer }); } - [HttpGet, Route("/clientapi/admin/roots/{id}")] + [HttpGet, Route(ApiPaths.Admin.GET_M_Root)] public async Task Root(string id, CancellationToken token) { var root = await DB.Default.Find().MatchID(id).Match(u => u.DeletedAt == null).ExecuteFirstAsync(token); @@ -179,7 +179,7 @@ namespace PrivaPub.Controllers.ClientToServer } // A login's role: user, moderator or administrator. Never one's own, and never the last administrator's. - [HttpPost, Route("/clientapi/admin/roots/{id}/role")] + [HttpPost, Route(ApiPaths.Admin.POST_M_Role)] public async Task Role(string id, RootRoleForm form, CancellationToken token) { if (!ModelState.IsValid || !RootUser.TryParseRole(form.Role, out var role)) @@ -217,7 +217,7 @@ namespace PrivaPub.Controllers.ClientToServer // A login that lost its authenticator and its recovery codes, as `PrivaPub admin reset-totp` does it: its two-factor // sign-in goes, its password and sessions stay. Never one's own (that is /clientapi/user/totp/disable, with a code). - [HttpPost, Route("/clientapi/admin/roots/{id}/totp/reset")] + [HttpPost, Route(ApiPaths.Admin.POST_M_ResetTotp)] public async Task ResetTotp(string id, CancellationToken token) { if (id == User.GetUserId()) @@ -232,7 +232,7 @@ namespace PrivaPub.Controllers.ClientToServer // A persona deleted by an administrator, who types their own password again: as its login would delete it // (PersonaRemoval), the groups it owns with it. The log keeps it without who acted when it is the administrator's own. - [HttpPost, Route("/clientapi/admin/personas/{id}/delete")] + [HttpPost, Route(ApiPaths.Admin.POST_M_DeletePersona)] public async Task DeletePersona(string id, AdminPasswordForm form, [FromServices] IPersonaRemoval personas, CancellationToken token) { if (!ModelState.IsValid) @@ -249,7 +249,7 @@ namespace PrivaPub.Controllers.ClientToServer return Ok(); } - [HttpPost, Route("/clientapi/admin/groups/{id}/delete")] + [HttpPost, Route(ApiPaths.Admin.POST_M_DeleteGroup)] public async Task DeleteGroup(string id, AdminPasswordForm form, [FromServices] IGroupRemoval groups, CancellationToken token) { if (!ModelState.IsValid) diff --git a/PrivaPub/Controllers/ClientToServer/BackupController.cs b/PrivaPub/Controllers/ClientToServer/BackupController.cs index 721389a..d6ee715 100644 --- a/PrivaPub/Controllers/ClientToServer/BackupController.cs +++ b/PrivaPub/Controllers/ClientToServer/BackupController.cs @@ -22,12 +22,12 @@ namespace PrivaPub.Controllers.ClientToServer // restore for the server's host typed out. A restore asked for stops the service within seconds, and the next start // carries it out (ServerRestore). [ApiController, - Route("clientapi/admin/backups"), + Route(ApiPaths.Backup.Prefix), Authorize(Policy = Policies.IsAdmin)] public class BackupController(Backups backups, TransferStore transfers, IPasswordHasher hasher, IStringLocalizer localizer, ILogger logger, IModerationLog log) : ControllerBase { - [HttpGet, Route("")] + [HttpGet, Route(ApiPaths.Backup.GET_List)] public async Task List(CancellationToken token) { if (await Administrator(token) == default) @@ -57,7 +57,7 @@ namespace PrivaPub.Controllers.ClientToServer } // a backup made now, while the page polls the list - [HttpPost, Route("")] + [HttpPost, Route(ApiPaths.Backup.POST_Create)] public async Task Create(CancellationToken token) { var admin = await Administrator(token); @@ -84,7 +84,7 @@ namespace PrivaPub.Controllers.ClientToServer return Accepted(); } - [HttpDelete, Route("{id}")] + [HttpDelete, Route(ApiPaths.Backup.DELETE_M_Delete)] public async Task Delete(string id, CancellationToken token) { var admin = await Administrator(token); @@ -99,7 +99,7 @@ namespace PrivaPub.Controllers.ClientToServer } // a link to download it with, for the password - [HttpPost, Route("{id}/ticket")] + [HttpPost, Route(ApiPaths.Backup.POST_M_Ticket)] public async Task Ticket(string id, BackupPasswordForm form, CancellationToken token) { var admin = await Administrator(token); @@ -114,7 +114,7 @@ namespace PrivaPub.Controllers.ClientToServer } // the backup as one tar, for a ticket: a plain link, so the browser downloads it to disk and resumes it - [HttpGet, Route("download/{ticket}"), AllowAnonymous] + [HttpGet, Route(ApiPaths.Backup.GET_M_Download), AllowAnonymous] public async Task Download(string ticket, CancellationToken token) { var id = transfers.Redeem(ticket); @@ -150,7 +150,7 @@ namespace PrivaPub.Controllers.ClientToServer await tar.Write(Response.Body, from, to, token); } - [HttpPost, Route("uploads")] + [HttpPost, Route(ApiPaths.Backup.POST_StartUpload)] public async Task StartUpload(CancellationToken token) { var admin = await Administrator(token); @@ -159,7 +159,7 @@ namespace PrivaPub.Controllers.ClientToServer return Ok(new ViewBackupUpload { Id = transfers.Start(admin.UserName), ChunkBytes = TransferStore.ChunkBytes }); } - [HttpGet, Route("uploads/{id}")] + [HttpGet, Route(ApiPaths.Backup.GET_M_Upload)] public async Task Upload(string id, CancellationToken token) { if (await Administrator(token) == default) @@ -169,7 +169,7 @@ namespace PrivaPub.Controllers.ClientToServer } // a piece, at the offset already received: 409 with what was received when it isn't - [HttpPut, Route("uploads/{id}"), RequestSizeLimit(TransferStore.ChunkBytes + 1024 * 1024)] + [HttpPut, Route(ApiPaths.Backup.PUT_M_Append), RequestSizeLimit(TransferStore.ChunkBytes + 1024 * 1024)] public async Task Append(string id, [FromQuery] long offset, CancellationToken token) { if (await Administrator(token) == default) @@ -181,7 +181,7 @@ namespace PrivaPub.Controllers.ClientToServer return taken ? Ok(view) : Conflict(view); } - [HttpPost, Route("uploads/{id}/finish")] + [HttpPost, Route(ApiPaths.Backup.POST_M_FinishUpload)] public async Task FinishUpload(string id, CancellationToken token) { if (await Administrator(token) == default) @@ -194,7 +194,7 @@ namespace PrivaPub.Controllers.ClientToServer return Ok(View(backup, 0, ServerBackup.CodeMigration())); } - [HttpDelete, Route("uploads/{id}")] + [HttpDelete, Route(ApiPaths.Backup.DELETE_M_CancelUpload)] public async Task CancelUpload(string id, CancellationToken token) { if (await Administrator(token) == default) @@ -203,7 +203,7 @@ namespace PrivaPub.Controllers.ClientToServer } // asked for with the password and the host typed out: the service stops within seconds and restores it as it starts - [HttpPost, Route("{id}/restore")] + [HttpPost, Route(ApiPaths.Backup.POST_M_Restore)] public async Task Restore(string id, RestoreBackupForm form, CancellationToken token) { var admin = await Administrator(token); diff --git a/PrivaPub/Controllers/ClientToServer/DataController.cs b/PrivaPub/Controllers/ClientToServer/DataController.cs index 58413fc..01c42f6 100644 --- a/PrivaPub/Controllers/ClientToServer/DataController.cs +++ b/PrivaPub/Controllers/ClientToServer/DataController.cs @@ -8,19 +8,19 @@ using PrivaPub.Services.ClientToServer.Public; namespace PrivaPub.Controllers.ClientToServer { [ApiController, - Route("clientapi/data")] + Route(ApiPaths.Data.Prefix)] public class DataController( IDataService dataService, ILogger logger) : ControllerBase { - [HttpGet, Route("/clientapi/data/ping"), AllowAnonymous] + [HttpGet, Route(ApiPaths.Data.GET_Ping), AllowAnonymous] public async ValueTask Ping(CancellationToken token = default) => NoContent(); - [HttpGet, Route("/clientapi/data/current-version"), AllowAnonymous] + [HttpGet, Route(ApiPaths.Data.GET_CurrentVersion), AllowAnonymous] public IActionResult CurrentVersion() => Ok(dataService.GetCurrentVersion()); - [HttpGet, Route("/clientapi/data/languages"), AllowAnonymous] + [HttpGet, Route(ApiPaths.Data.GET_Languages), AllowAnonymous] public async Task Languages(CancellationToken cancellationToken) { var result = new WebResult(); diff --git a/PrivaPub/Controllers/ClientToServer/DomainBlockController.cs b/PrivaPub/Controllers/ClientToServer/DomainBlockController.cs index 03948f0..8ade9b3 100644 --- a/PrivaPub/Controllers/ClientToServer/DomainBlockController.cs +++ b/PrivaPub/Controllers/ClientToServer/DomainBlockController.cs @@ -16,7 +16,7 @@ using PrivaPub.Resources; namespace PrivaPub.Controllers.ClientToServer { [ApiController, - Route("clientapi/admin/domainblocks"), + Route(ApiPaths.DomainBlock.Prefix), Authorize(Policy = Policies.IsAdmin)] public class DomainBlockController( IDomainBlocks domainBlocks, @@ -25,11 +25,11 @@ namespace PrivaPub.Controllers.ClientToServer IModerationLog log, IAccountModeration moderation) : ControllerBase { - [HttpGet, Route("/clientapi/admin/domainblocks/list")] + [HttpGet, Route(ApiPaths.DomainBlock.GET_List)] public async Task List(CancellationToken token) => Ok((await DB.Default.Find().Sort(b => b.Domain, Order.Ascending).ExecuteAsync(token)).Select(ToView).ToList()); - [HttpPost, Route("/clientapi/admin/domainblocks/insert")] + [HttpPost, Route(ApiPaths.DomainBlock.POST_Insert)] public async Task Insert(DomainBlockForm form, CancellationToken token) { var domain = DomainBlocks.Normalise(form.Domain); @@ -60,7 +60,7 @@ namespace PrivaPub.Controllers.ClientToServer return Ok(ToView(block)); } - [HttpPost, Route("/clientapi/admin/domainblocks/delete")] + [HttpPost, Route(ApiPaths.DomainBlock.POST_Delete)] public async Task Delete([FromQuery] string domain, CancellationToken token) { domain = DomainBlocks.Normalise(domain); diff --git a/PrivaPub/Controllers/ClientToServer/EmojiAdminController.cs b/PrivaPub/Controllers/ClientToServer/EmojiAdminController.cs index cf75b85..47ba6a2 100644 --- a/PrivaPub/Controllers/ClientToServer/EmojiAdminController.cs +++ b/PrivaPub/Controllers/ClientToServer/EmojiAdminController.cs @@ -24,7 +24,7 @@ namespace PrivaPub.Controllers.ClientToServer // by an administrator, checked again against the database. Every act is kept in the staff's log (emoji.insert, // emoji.update, emoji.delete). An emoji is never renamed: its shortcode is its id on other servers (/grimaces/{shortcode}). [ApiController, - Route("clientapi/admin/emoji"), + Route(ApiPaths.EmojiAdmin.Prefix), Authorize(Policy = Policies.IsAdmin)] public class EmojiAdminController( IModerationLog log, @@ -45,7 +45,7 @@ namespace PrivaPub.Controllers.ClientToServer IActionResult Refused(int status, string message) => StatusCode(status, new WebResult().Invalidate(localizer[message], status)); - [HttpGet, Route("list")] + [HttpGet, Route(ApiPaths.EmojiAdmin.GET_List)] public async Task List(CancellationToken token) { if (await Administrator(token) == default) @@ -55,7 +55,7 @@ namespace PrivaPub.Controllers.ClientToServer } // a new emoji; a shortcode deleted before comes back as it was written, with its new picture (the same id elsewhere) - [HttpPost, Route("insert"), RequestSizeLimit(MaxRequestBytes), RequestFormLimits(MultipartBodyLengthLimit = MaxRequestBytes)] + [HttpPost, Route(ApiPaths.EmojiAdmin.POST_Insert), RequestSizeLimit(MaxRequestBytes), RequestFormLimits(MultipartBodyLengthLimit = MaxRequestBytes)] public async Task Insert([FromForm] LocalEmojiForm form, CancellationToken token) { var admin = await Administrator(token); @@ -104,7 +104,7 @@ namespace PrivaPub.Controllers.ClientToServer // the emoji with that shortcode as it should be now: its category, the picker, disabled or not, and a new picture if // one is sent - [HttpPost, Route("update"), RequestSizeLimit(MaxRequestBytes), RequestFormLimits(MultipartBodyLengthLimit = MaxRequestBytes)] + [HttpPost, Route(ApiPaths.EmojiAdmin.POST_Update), RequestSizeLimit(MaxRequestBytes), RequestFormLimits(MultipartBodyLengthLimit = MaxRequestBytes)] public async Task Update([FromForm] LocalEmojiForm form, CancellationToken token) { var admin = await Administrator(token); @@ -167,7 +167,7 @@ namespace PrivaPub.Controllers.ClientToServer // deleted: offered nowhere, left out of what posts and profiles render, its picture trashed, and its id answers 410. // No other server is told (Mastodon tells none either); they keep their copy until they read a post again. - [HttpPost, Route("delete")] + [HttpPost, Route(ApiPaths.EmojiAdmin.POST_Delete)] public async Task Delete([FromQuery] string shortcode, CancellationToken token) { var admin = await Administrator(token); diff --git a/PrivaPub/Controllers/ClientToServer/GroupController.cs b/PrivaPub/Controllers/ClientToServer/GroupController.cs index 4875d12..2d70bc7 100644 --- a/PrivaPub/Controllers/ClientToServer/GroupController.cs +++ b/PrivaPub/Controllers/ClientToServer/GroupController.cs @@ -11,51 +11,51 @@ using PrivaPub.Services; namespace PrivaPub.Controllers.ClientToServer { [ApiController, - Route("clientapi/group"), + Route(ApiPaths.Group.Prefix), Authorize(Policy = Policies.IsUser)] public class GroupController( IGroupUsersService groupUsersService, IStringLocalizer localizer) : ControllerBase { - [HttpGet, Route("/clientapi/group/list")] + [HttpGet, Route(ApiPaths.Group.GET_List)] public async Task List([FromQuery] string avatarId, CancellationToken token) => Answer(await groupUsersService.GetGroups(User.GetUserId(), avatarId, token)); - [HttpPost, Route("/clientapi/group/insert")] + [HttpPost, Route(ApiPaths.Group.POST_Insert)] public async Task Insert(InsertGroupForm form, CancellationToken token) => !ModelState.IsValid ? Invalid() : Answer(await groupUsersService.InsertGroup(User.GetUserId(), form, token)); - [HttpPost, Route("/clientapi/group/update")] + [HttpPost, Route(ApiPaths.Group.POST_Update)] public async Task Update(UpdateGroupForm form, CancellationToken token) => !ModelState.IsValid ? Invalid() : Answer(await groupUsersService.UpdateGroup(User.GetUserId(), form, token)); - [HttpPost, Route("/clientapi/group/join")] + [HttpPost, Route(ApiPaths.Group.POST_Join)] public async Task Join(JoinGroupForm form, CancellationToken token) => !ModelState.IsValid ? Invalid() : Answer(await groupUsersService.JoinGroup(User.GetUserId(), form, token)); - [HttpPost, Route("/clientapi/group/leave")] + [HttpPost, Route(ApiPaths.Group.POST_Leave)] public async Task Leave(GroupMembershipForm form, CancellationToken token) => !ModelState.IsValid ? Invalid() : Answer(await groupUsersService.LeaveGroup(User.GetUserId(), form, token)); - [HttpPost, Route("/clientapi/group/approve")] + [HttpPost, Route(ApiPaths.Group.POST_Approve)] public async Task Approve(GroupMembershipForm form, CancellationToken token) => !ModelState.IsValid ? Invalid() : Answer(await groupUsersService.ApproveMember(User.GetUserId(), form, token)); - [HttpGet, Route("/clientapi/group/members")] + [HttpGet, Route(ApiPaths.Group.GET_Members)] public async Task Members([FromQuery] string avatarId, [FromQuery] string groupId, CancellationToken token) => Answer(await groupUsersService.GetMembers(User.GetUserId(), avatarId, groupId, token)); - [HttpPost, Route("/clientapi/group/reject")] + [HttpPost, Route(ApiPaths.Group.POST_Reject)] public async Task Reject(GroupMembershipForm form, CancellationToken token) => !ModelState.IsValid ? Invalid() : Answer(await groupUsersService.RejectMember(User.GetUserId(), form, token)); - [HttpPost, Route("/clientapi/group/remove")] + [HttpPost, Route(ApiPaths.Group.POST_Remove)] public async Task Remove(GroupMembershipForm form, CancellationToken token) => !ModelState.IsValid ? Invalid() : Answer(await groupUsersService.RemoveMember(User.GetUserId(), form, token)); // the group's owner deletes it, with the login's password (R6): its members and followers are told, its name stays // taken (GroupRemoval) - [HttpPost, Route("/clientapi/group/delete"), Microsoft.AspNetCore.RateLimiting.EnableRateLimiting(Infrastructure.RateLimiting.Accounts)] + [HttpPost, Route(ApiPaths.Group.POST_Delete), Microsoft.AspNetCore.RateLimiting.EnableRateLimiting(Infrastructure.RateLimiting.Accounts)] public async Task Delete(DeleteGroupForm form, [FromServices] IRootUsersService users, [FromServices] IGroupRemoval groups, [FromServices] StaticServices.DbEntities dbEntities, CancellationToken token) { diff --git a/PrivaPub/Controllers/ClientToServer/InstanceAdminController.cs b/PrivaPub/Controllers/ClientToServer/InstanceAdminController.cs index a8d6228..1361e74 100644 --- a/PrivaPub/Controllers/ClientToServer/InstanceAdminController.cs +++ b/PrivaPub/Controllers/ClientToServer/InstanceAdminController.cs @@ -28,7 +28,7 @@ namespace PrivaPub.Controllers.ClientToServer // its thumbnail, its media limits, whether its activity is published, its announcements and the relays it subscribes to. // Only an administrator, checked again against the database. Every change is kept in the staff's log. [ApiController, - Route("clientapi/admin"), + Route(ApiPaths.InstanceAdmin.Prefix), Authorize(Policy = Policies.IsAdmin)] public class InstanceAdminController( IInstanceSettings instanceSettings, @@ -52,7 +52,7 @@ namespace PrivaPub.Controllers.ClientToServer #region settings - [HttpGet, Route("/clientapi/admin/settings")] + [HttpGet, Route(ApiPaths.InstanceAdmin.GET_Settings)] public async Task Settings(CancellationToken token) { if (await Administrator(token) == default) @@ -60,7 +60,7 @@ namespace PrivaPub.Controllers.ClientToServer return Ok(await View(instanceSettings.Current, token)); } - [HttpPost, Route("/clientapi/admin/settings")] + [HttpPost, Route(ApiPaths.InstanceAdmin.POST_SaveSettings)] public async Task SaveSettings(ServerSettingsForm form, CancellationToken token) { var admin = await Administrator(token); @@ -172,7 +172,7 @@ namespace PrivaPub.Controllers.ClientToServer } // the server's thumbnail (the instance API's), from a picture checked and re-encoded like a profile picture - [HttpPost, Route("/clientapi/admin/settings/thumbnail"), RequestSizeLimit(MediaLimitsFromSettings.MaxImageBytes + 1024 * 1024), + [HttpPost, Route(ApiPaths.InstanceAdmin.POST_SaveThumbnail), RequestSizeLimit(MediaLimitsFromSettings.MaxImageBytes + 1024 * 1024), RequestFormLimits(MultipartBodyLengthLimit = MediaLimitsFromSettings.MaxImageBytes + 1024 * 1024)] public async Task SaveThumbnail([FromServices] IMediaService media, CancellationToken token) { @@ -196,7 +196,7 @@ namespace PrivaPub.Controllers.ClientToServer return Ok(await View(saved, token)); } - [HttpDelete, Route("/clientapi/admin/settings/thumbnail")] + [HttpDelete, Route(ApiPaths.InstanceAdmin.DELETE_DeleteThumbnail)] public async Task DeleteThumbnail([FromServices] IMediaService media, CancellationToken token) { var admin = await Administrator(token); @@ -292,7 +292,7 @@ namespace PrivaPub.Controllers.ClientToServer #region announcements - [HttpGet, Route("/clientapi/admin/announcements/list")] + [HttpGet, Route(ApiPaths.InstanceAdmin.GET_Announcements)] public async Task Announcements([FromServices] IAnnouncements announcements, CancellationToken token) { if (await Administrator(token) == default) @@ -303,7 +303,7 @@ namespace PrivaPub.Controllers.ClientToServer return Ok(views); } - [HttpPost, Route("/clientapi/admin/announcements/insert")] + [HttpPost, Route(ApiPaths.InstanceAdmin.POST_InsertAnnouncement)] public async Task InsertAnnouncement([FromServices] IAnnouncements announcements, AnnouncementForm form, CancellationToken token) { var admin = await Administrator(token); @@ -317,7 +317,7 @@ namespace PrivaPub.Controllers.ClientToServer return Ok(await View(made, token)); } - [HttpPost, Route("/clientapi/admin/announcements/update")] + [HttpPost, Route(ApiPaths.InstanceAdmin.POST_UpdateAnnouncement)] public async Task UpdateAnnouncement([FromServices] IAnnouncements announcements, AnnouncementForm form, CancellationToken token) { var admin = await Administrator(token); @@ -333,7 +333,7 @@ namespace PrivaPub.Controllers.ClientToServer return Ok(await View(updated, token)); } - [HttpPost, Route("/clientapi/admin/announcements/delete")] + [HttpPost, Route(ApiPaths.InstanceAdmin.POST_DeleteAnnouncement)] public async Task DeleteAnnouncement([FromServices] IAnnouncements announcements, [FromQuery] string id, CancellationToken token) { var admin = await Administrator(token); @@ -383,7 +383,7 @@ namespace PrivaPub.Controllers.ClientToServer // the accounts suggested first to every persona (completion program R8, Domain/Social/Suggestions): a persona here or an // account elsewhere the administrators choose, in their order; kept in the settings, changed only here, every change in // the staff's log (an entry about a persona of the acting login keeps no actor, ModerationLog) - [HttpGet, Route("/clientapi/admin/staff-picks")] + [HttpGet, Route(ApiPaths.InstanceAdmin.GET_StaffPicks)] public async Task StaffPicks(CancellationToken token) { if (await Administrator(token) == default) @@ -391,7 +391,7 @@ namespace PrivaPub.Controllers.ClientToServer return Ok(await StaffPickViews(instanceSettings.Current, token)); } - [HttpPost, Route("/clientapi/admin/staff-picks/insert")] + [HttpPost, Route(ApiPaths.InstanceAdmin.POST_InsertStaffPick)] public async Task InsertStaffPick(StaffPickForm form, CancellationToken token) { var admin = await Administrator(token); @@ -415,7 +415,7 @@ namespace PrivaPub.Controllers.ClientToServer return Ok(await StaffPickViews(saved, token)); } - [HttpPost, Route("/clientapi/admin/staff-picks/delete")] + [HttpPost, Route(ApiPaths.InstanceAdmin.POST_DeleteStaffPick)] public async Task DeleteStaffPick([FromQuery] string accountId, CancellationToken token) { var admin = await Administrator(token); @@ -477,7 +477,7 @@ namespace PrivaPub.Controllers.ClientToServer #region relays - [HttpGet, Route("/clientapi/admin/relays")] + [HttpGet, Route(ApiPaths.InstanceAdmin.GET_Relays)] public async Task Relays(CancellationToken token) { if (await Administrator(token) == default) @@ -486,7 +486,7 @@ namespace PrivaPub.Controllers.ClientToServer } // a relay named by the settings: subscribed to at once (in the background: resolving it is a fetch), the page polls - [HttpPost, Route("/clientapi/admin/relays/insert")] + [HttpPost, Route(ApiPaths.InstanceAdmin.POST_InsertRelay)] public async Task InsertRelay([FromServices] IRelays relays, RelayForm form, CancellationToken token) { var admin = await Administrator(token); @@ -513,7 +513,7 @@ namespace PrivaPub.Controllers.ClientToServer } // a relay the settings named: unsubscribed at once (its Undo is queued); the configuration's are removed only there - [HttpPost, Route("/clientapi/admin/relays/delete")] + [HttpPost, Route(ApiPaths.InstanceAdmin.POST_DeleteRelay)] public async Task DeleteRelay([FromServices] IRelays relays, [FromQuery] string address, CancellationToken token) { var admin = await Administrator(token); diff --git a/PrivaPub/Controllers/ClientToServer/ModeratorController.cs b/PrivaPub/Controllers/ClientToServer/ModeratorController.cs index ddc21ae..443c077 100644 --- a/PrivaPub/Controllers/ClientToServer/ModeratorController.cs +++ b/PrivaPub/Controllers/ClientToServer/ModeratorController.cs @@ -15,7 +15,7 @@ using PrivaPub.Models.User; namespace PrivaPub.Controllers.ClientToServer { [ApiController, - Route("clientapi/moderator"), + Route(ApiPaths.Moderator.Prefix), Authorize(Policy = Policies.IsModerator)] public class ModeratorController( IInstanceSettings settings, @@ -29,7 +29,7 @@ namespace PrivaPub.Controllers.ClientToServer const int MaxAccountsPage = 100; - [HttpGet, Route("/clientapi/moderator/reports")] + [HttpGet, Route(ApiPaths.Moderator.GET_Reports)] public async Task Reports([FromQuery] bool resolved, CancellationToken token) { var rules = settings.Current.Rules.ToDictionary(r => r.Id, r => r.Text ?? string.Empty); @@ -60,7 +60,7 @@ namespace PrivaPub.Controllers.ClientToServer // A report resolved, and with it what the staff does about it (R6): nothing more, the reported account silenced or // suspended, or the reported posts removed. The act comes first: one that fails leaves the report open. The body is // optional (a report only marked resolved, as before R6). - [HttpPost, Route("/clientapi/moderator/reports/{id}/resolve")] + [HttpPost, Route(ApiPaths.Moderator.POST_M_Resolve)] public async Task Resolve(string id, [FromBody(EmptyBodyBehavior = Microsoft.AspNetCore.Mvc.ModelBinding.EmptyBodyBehavior.Allow)] ResolveReportForm form, CancellationToken token) { @@ -105,7 +105,7 @@ namespace PrivaPub.Controllers.ClientToServer // Accounts to moderate, found by a name (a persona's, or user@host for an account elsewhere) or an actor's address: // personas here, never their logins, and accounts elsewhere PrivaPub holds - [HttpGet, Route("/clientapi/moderator/accounts")] + [HttpGet, Route(ApiPaths.Moderator.GET_Accounts)] public async Task Accounts([FromQuery] string q, [FromQuery] int limit = 20, CancellationToken token = default) { limit = Math.Clamp(limit, 1, 40); @@ -145,7 +145,7 @@ namespace PrivaPub.Controllers.ClientToServer // what the staff silenced or suspended, here and elsewhere, most recently moderated first (a banned login's personas // are never among them: the ban is the login's, and only administrators see logins) - [HttpGet, Route("/clientapi/moderator/accounts/moderated")] + [HttpGet, Route(ApiPaths.Moderator.GET_Moderated)] public async Task Moderated([FromQuery] int offset = 0, [FromQuery] int limit = 50, CancellationToken token = default) { offset = Math.Max(0, offset); @@ -163,12 +163,12 @@ namespace PrivaPub.Controllers.ClientToServer static DateTime Latest(DateTime? a, DateTime? b) => (a ?? DateTime.MinValue) > (b ?? DateTime.MinValue) ? a ?? DateTime.MinValue : b ?? DateTime.MinValue; - [HttpGet, Route("/clientapi/moderator/accounts/{id}")] + [HttpGet, Route(ApiPaths.Moderator.GET_M_Account)] public async Task Account(string id, CancellationToken token) => await accountModeration.View(id, token) is { } account ? Ok(account) : NotFound(); // silence, unsilence, suspend or unsuspend a persona here or an account elsewhere - [HttpPost, Route("/clientapi/moderator/accounts/moderate")] + [HttpPost, Route(ApiPaths.Moderator.POST_Moderate)] public async Task Moderate(ModerateAccountForm form, CancellationToken token) { if (!ModelState.IsValid) @@ -178,7 +178,7 @@ namespace PrivaPub.Controllers.ClientToServer } // a post taken down: deleted when it is ours (the deletion federates), hidden here when it is a copy - [HttpPost, Route("/clientapi/moderator/posts/remove")] + [HttpPost, Route(ApiPaths.Moderator.POST_RemovePost)] public async Task RemovePost(RemovePostForm form, CancellationToken token) { if (!ModelState.IsValid) @@ -190,7 +190,7 @@ namespace PrivaPub.Controllers.ClientToServer // The staff's log, newest first, a page at a time (before: the last id of the page before). Administrators read all // of it; a moderator who isn't one reads what isn't about a login, and who acted only when it was the command line or // themselves. - [HttpGet, Route("/clientapi/moderator/log")] + [HttpGet, Route(ApiPaths.Moderator.GET_Log)] public async Task Log([FromQuery] string before, [FromQuery] int limit = 50, CancellationToken token = default) { var me = await DB.Default.Find().MatchID(User.GetUserId()).ExecuteFirstAsync(token); diff --git a/PrivaPub/Controllers/ClientToServer/PersonaArchiveController.cs b/PrivaPub/Controllers/ClientToServer/PersonaArchiveController.cs index 51cdd2c..99f9b17 100644 --- a/PrivaPub/Controllers/ClientToServer/PersonaArchiveController.cs +++ b/PrivaPub/Controllers/ClientToServer/PersonaArchiveController.cs @@ -17,12 +17,12 @@ namespace PrivaPub.Controllers.ClientToServer // ten minutes; another archive (its own, or Mastodon's) uploaded in pieces and imported into it in a job, the parts the // root picks, with progress, until it asks to stop. Only the persona's own root, never a banned one. [ApiController, - Route("clientapi/persona"), + Route(ApiPaths.PersonaArchive.Prefix), Authorize(Policy = Policies.IsUser)] public class PersonaArchiveController(Backups backups, TransferStore transfers, IJobQueue jobs, Federation.Actors.ILocalActorService localActors) : ControllerBase { - [HttpGet, Route("{avatarId}/archive")] + [HttpGet, Route(ApiPaths.PersonaArchive.GET_M_Status)] public async Task Status(string avatarId, CancellationToken token) { if (!await Owns(avatarId, token)) @@ -31,7 +31,7 @@ namespace PrivaPub.Controllers.ClientToServer return Ok(PersonaArchives.View(await PersonaArchives.Of(avatarId, token))); } - [HttpPost, Route("{avatarId}/archive")] + [HttpPost, Route(ApiPaths.PersonaArchive.POST_M_Export)] public async Task Export(string avatarId, CancellationToken token) { if (!await Owns(avatarId, token)) @@ -47,7 +47,7 @@ namespace PrivaPub.Controllers.ClientToServer return Accepted(PersonaArchives.View(state)); } - [HttpPost, Route("{avatarId}/archive/ticket")] + [HttpPost, Route(ApiPaths.PersonaArchive.POST_M_Ticket)] public async Task Ticket(string avatarId, CancellationToken token) { if (!await Owns(avatarId, token)) @@ -61,7 +61,7 @@ namespace PrivaPub.Controllers.ClientToServer } // the archive itself, for a ticket: a plain link, so the browser saves it to disk (and resumes it) - [HttpGet, Route("archive/download/{ticket}"), AllowAnonymous] + [HttpGet, Route(ApiPaths.PersonaArchive.GET_M_Download), AllowAnonymous] public IActionResult Download(string ticket) { if (transfers.Redeem(ticket) is not { } what || what.Split('/') is not ["persona", var avatarId, var name] || name.Contains("..")) @@ -73,11 +73,11 @@ namespace PrivaPub.Controllers.ClientToServer return PhysicalFile(file, "application/zip", name, enableRangeProcessing: true); } - [HttpPost, Route("archive/uploads")] + [HttpPost, Route(ApiPaths.PersonaArchive.POST_StartUpload)] public IActionResult StartUpload() => Ok(new ViewArchiveUpload { Id = transfers.Start(User.GetUserId()), ChunkBytes = TransferStore.ChunkBytes }); - [HttpGet, Route("archive/uploads/{id}")] + [HttpGet, Route(ApiPaths.PersonaArchive.GET_M_Upload)] public IActionResult Upload(string id) { if (transfers.Owner(id) != User.GetUserId()) @@ -85,7 +85,7 @@ namespace PrivaPub.Controllers.ClientToServer return Ok(new ViewArchiveUpload { Id = id, Received = transfers.Received(id), ChunkBytes = TransferStore.ChunkBytes }); } - [HttpPut, Route("archive/uploads/{id}"), RequestSizeLimit(TransferStore.ChunkBytes + 1024 * 1024)] + [HttpPut, Route(ApiPaths.PersonaArchive.PUT_M_Append), RequestSizeLimit(TransferStore.ChunkBytes + 1024 * 1024)] public async Task Append(string id, [FromQuery] long offset, CancellationToken token) { if (transfers.Owner(id) != User.GetUserId()) @@ -95,7 +95,7 @@ namespace PrivaPub.Controllers.ClientToServer return taken ? Ok(view) : Conflict(view); } - [HttpDelete, Route("archive/uploads/{id}")] + [HttpDelete, Route(ApiPaths.PersonaArchive.DELETE_M_CancelUpload)] public IActionResult CancelUpload(string id) { if (transfers.Owner(id) != User.GetUserId()) @@ -105,7 +105,7 @@ namespace PrivaPub.Controllers.ClientToServer } // an uploaded archive imported into the persona: refused at once when it is not one, or holds what it must not - [HttpPost, Route("{avatarId}/archive/import")] + [HttpPost, Route(ApiPaths.PersonaArchive.POST_M_Import)] public async Task Import(string avatarId, ImportPersonaArchiveForm form, CancellationToken token) { if (!await Owns(avatarId, token)) @@ -142,7 +142,7 @@ namespace PrivaPub.Controllers.ClientToServer return Accepted(PersonaArchives.View(state)); } - [HttpPost, Route("{avatarId}/archive/import/stop")] + [HttpPost, Route(ApiPaths.PersonaArchive.POST_M_Stop)] public async Task Stop(string avatarId, CancellationToken token) { if (!await Owns(avatarId, token)) diff --git a/PrivaPub/Controllers/ClientToServer/PostController.cs b/PrivaPub/Controllers/ClientToServer/PostController.cs index 0ccdbdc..ab1c266 100644 --- a/PrivaPub/Controllers/ClientToServer/PostController.cs +++ b/PrivaPub/Controllers/ClientToServer/PostController.cs @@ -11,37 +11,37 @@ using PrivaPub.Services; namespace PrivaPub.Controllers.ClientToServer { [ApiController, - Route("clientapi/post"), + Route(ApiPaths.Post.Prefix), Authorize(Policy = Policies.IsUser)] public class PostController( IPostsService postsService, IStringLocalizer localizer) : ControllerBase { - [HttpGet, Route("/clientapi/post/list")] + [HttpGet, Route(ApiPaths.Post.GET_List)] public async Task List([FromQuery] string avatarId, [FromQuery] string groupId, CancellationToken token) => Answer(await postsService.GetPosts(User.GetUserId(), avatarId, groupId, token)); - [HttpPost, Route("/clientapi/post/insert")] + [HttpPost, Route(ApiPaths.Post.POST_Insert)] public async Task Insert(InsertPostForm form, CancellationToken token) => !ModelState.IsValid ? Invalid() : Answer(await postsService.InsertPost(User.GetUserId(), form, token)); - [HttpGet, Route("/clientapi/post/nearby")] + [HttpGet, Route(ApiPaths.Post.GET_Nearby)] public async Task Nearby([FromQuery] string avatarId, [FromQuery] double latitude, [FromQuery] double longitude, CancellationToken token) => Answer(await postsService.Nearby(User.GetUserId(), avatarId, latitude, longitude, token)); - [HttpPost, Route("/clientapi/post/update")] + [HttpPost, Route(ApiPaths.Post.POST_Update)] public async Task Update(UpdatePostForm form, CancellationToken token) => !ModelState.IsValid ? Invalid() : Answer(await postsService.UpdatePost(User.GetUserId(), form, token)); - [HttpPost, Route("/clientapi/post/delete")] + [HttpPost, Route(ApiPaths.Post.POST_Delete)] public async Task Delete(DeletePostForm form, CancellationToken token) => !ModelState.IsValid ? Invalid() : Answer(await postsService.DeletePost(User.GetUserId(), form, token)); - [HttpGet, Route("/clientapi/dm/list")] + [HttpGet, Route(ApiPaths.Post.GET_Dms)] public async Task Dms([FromQuery] string avatarId, [FromQuery] string dmGroupId, CancellationToken token) => Answer(await postsService.GetDms(User.GetUserId(), avatarId, dmGroupId, token)); - [HttpPost, Route("/clientapi/dm/insert")] + [HttpPost, Route(ApiPaths.Post.POST_InsertDm)] public async Task InsertDm(InsertDmForm form, CancellationToken token) => !ModelState.IsValid ? Invalid() : Answer(await postsService.InsertDm(User.GetUserId(), form, token)); diff --git a/PrivaPub/Controllers/ClientToServer/PrivateAvatarController.cs b/PrivaPub/Controllers/ClientToServer/PrivateAvatarController.cs index 95cf27b..eed5534 100644 --- a/PrivaPub/Controllers/ClientToServer/PrivateAvatarController.cs +++ b/PrivaPub/Controllers/ClientToServer/PrivateAvatarController.cs @@ -11,21 +11,21 @@ using PrivaPub.ClientModels.User.Avatar; namespace PrivaPub.Controllers.ClientToServer { [ApiController, - Route("clientapi/avatar/private"), + Route(ApiPaths.PrivateAvatar.Prefix), Authorize(Policy = Policies.IsUser)] public class PrivateAvatarController( IPrivateAvatarUsersService privateAvatarUsersService, IStringLocalizer localizer, ILogger logger) : ControllerBase { - [HttpGet, Route("/clientapi/avatar/private/list")] + [HttpGet, Route(ApiPaths.PrivateAvatar.GET_GetAvatars)] public async Task GetAvatars(CancellationToken token) { var result = await privateAvatarUsersService.GetRootAvatars(User.GetUserId(), token); return result.IsValid ? Ok(result.Data) : StatusCode(result.StatusCode, result); } - [HttpPost, Route("/clientapi/avatar/private/insert")] + [HttpPost, Route(ApiPaths.PrivateAvatar.POST_InsertAvatar)] public async Task InsertAvatar(InsertAvatarForm model, CancellationToken token = default) { var result = new WebResult(); @@ -49,7 +49,7 @@ namespace PrivaPub.Controllers.ClientToServer // A login deletes one of its personas, with its password again (R6): everything public it had goes, the groups it owns // with it, as when the whole login is deleted (PersonaRemoval). A suspended persona may be deleted too. - [HttpPost, Route("/clientapi/avatar/private/delete"), Microsoft.AspNetCore.RateLimiting.EnableRateLimiting(Infrastructure.RateLimiting.Accounts)] + [HttpPost, Route(ApiPaths.PrivateAvatar.POST_DeleteAvatar), Microsoft.AspNetCore.RateLimiting.EnableRateLimiting(Infrastructure.RateLimiting.Accounts)] public async Task DeleteAvatar(DeletePersonaForm form, [FromServices] Services.IRootUsersService users, [FromServices] Services.IPersonaRemoval personas, [FromServices] StaticServices.DbEntities dbEntities, CancellationToken token) { @@ -65,7 +65,7 @@ namespace PrivaPub.Controllers.ClientToServer } // how the persona's clients show what others post (R8): Mastodon's reading preferences, which its API only reads - [HttpGet, Route("/clientapi/avatar/private/preferences")] + [HttpGet, Route(ApiPaths.PrivateAvatar.GET_Preferences)] public async Task Preferences([FromQuery] string avatarId, [FromServices] StaticServices.DbEntities dbEntities, CancellationToken token) { var avatar = await OwnPersona(avatarId, dbEntities, token); @@ -74,7 +74,7 @@ namespace PrivaPub.Controllers.ClientToServer : Ok(PreferencesOf(avatar)); } - [HttpPost, Route("/clientapi/avatar/private/preferences")] + [HttpPost, Route(ApiPaths.PrivateAvatar.POST_SavePreferences)] public async Task SavePreferences(PersonaPreferencesForm form, [FromServices] StaticServices.DbEntities dbEntities, CancellationToken token) { if (!ModelState.IsValid) @@ -109,7 +109,7 @@ namespace PrivaPub.Controllers.ClientToServer ExpandSpoilers = avatar.Settings.ExpandSpoilers }; - [HttpPost, Route("/clientapi/avatar/private/update")] + [HttpPost, Route(ApiPaths.PrivateAvatar.POST_UpdateAvatar)] public async Task UpdateAvatar(UpdateAvatarForm model, CancellationToken token = default) { var result = new WebResult(); diff --git a/PrivaPub/Controllers/ClientToServer/RootUserController.cs b/PrivaPub/Controllers/ClientToServer/RootUserController.cs index 028de9f..0559f42 100644 --- a/PrivaPub/Controllers/ClientToServer/RootUserController.cs +++ b/PrivaPub/Controllers/ClientToServer/RootUserController.cs @@ -27,7 +27,7 @@ using System.ComponentModel.DataAnnotations; namespace PrivaPub.Controllers.ClientToServer { [ApiController, - Route("clientapi/user")] + Route(ApiPaths.RootUser.Prefix)] public class RootUserController( IRootUsersService usersService, IGroupUsersService groupUsersService, @@ -41,7 +41,7 @@ namespace PrivaPub.Controllers.ClientToServer { #region User endpoints - [HttpPost, Route("/clientapi/user/signup"), EnableRateLimiting(RateLimiting.Accounts), Authorize(Policy = Policies.IsUser), AllowAnonymous] + [HttpPost, Route(ApiPaths.RootUser.POST_SignUp), EnableRateLimiting(RateLimiting.Accounts), Authorize(Policy = Policies.IsUser), AllowAnonymous] public async Task SignUp(LoginForm signUpForm, CancellationToken token = default) { if (User.Identity?.IsAuthenticated ?? false) return Redirect("/"); @@ -67,7 +67,7 @@ namespace PrivaPub.Controllers.ClientToServer } } - [HttpPost, Route("/clientapi/user/login"), EnableRateLimiting(RateLimiting.Accounts), Authorize(Policy = Policies.IsUser), AllowAnonymous] + [HttpPost, Route(ApiPaths.RootUser.POST_Login), EnableRateLimiting(RateLimiting.Accounts), Authorize(Policy = Policies.IsUser), AllowAnonymous] public async Task Login(LoginForm loginForm, CancellationToken token = default) { if (User.Identity?.IsAuthenticated ?? false) return Redirect("/"); @@ -93,7 +93,7 @@ namespace PrivaPub.Controllers.ClientToServer } } - [HttpPost, Route("/clientapi/user/invitation/signup"), EnableRateLimiting(RateLimiting.Accounts), AllowAnonymous] + [HttpPost, Route(ApiPaths.RootUser.POST_InvitationSignUp), EnableRateLimiting(RateLimiting.Accounts), AllowAnonymous] public async Task InvitationSignUp(InvitationLoginForm signUpForm, CancellationToken token) { var result = new WebResult(); @@ -137,7 +137,7 @@ namespace PrivaPub.Controllers.ClientToServer } } - [HttpPost, Route("/clientapi/user/invitation/login"), EnableRateLimiting(RateLimiting.Accounts), AllowAnonymous] + [HttpPost, Route(ApiPaths.RootUser.POST_InvitationLogin), EnableRateLimiting(RateLimiting.Accounts), AllowAnonymous] public async Task InvitationLogin(InvitationLoginForm loginForm, CancellationToken token) { var result = new WebResult(); @@ -188,14 +188,14 @@ namespace PrivaPub.Controllers.ClientToServer } } - [HttpGet, Route("/clientapi/user/setup"), AllowAnonymous] + [HttpGet, Route(ApiPaths.RootUser.GET_Setup), AllowAnonymous] public async Task Setup(CancellationToken token) => Ok(new ViewServerSetup { IsPending = await ServerSetup.IsPending(token) }); // The server's first login, made while it has no administrator (owner decision 2026-10-16: first come, first served): // it is made the administrator, with its first persona, and setup closes for good. Sign-up stays closed to everyone // else (registrations), so NodeInfo and the instance API don't change. - [HttpPost, Route("/clientapi/user/setup"), EnableRateLimiting(RateLimiting.Accounts), AllowAnonymous] + [HttpPost, Route(ApiPaths.RootUser.POST_SetUp), EnableRateLimiting(RateLimiting.Accounts), AllowAnonymous] public async Task SetUp(SetupForm setupForm, CancellationToken token) { if (User.Identity?.IsAuthenticated ?? false) return Redirect("/"); @@ -272,7 +272,7 @@ namespace PrivaPub.Controllers.ClientToServer // This device signs out: its session (every token it renewed) is refused from now on. A token from before sessions had // ids can't be told apart from the others, so it signs every device out. - [HttpGet, Route("/clientapi/user/logout"), Authorize(Policy = Policies.IsUser)] + [HttpGet, Route(ApiPaths.RootUser.GET_Logout), Authorize(Policy = Policies.IsUser)] public async Task Logout([FromServices] IRootSessions sessions, CancellationToken token) { var result = new WebResult(); @@ -292,7 +292,7 @@ namespace PrivaPub.Controllers.ClientToServer } } - [HttpPost, Route("/clientapi/user/logout/everywhere"), Authorize(Policy = Policies.IsUser)] + [HttpPost, Route(ApiPaths.RootUser.POST_LogoutEverywhere), Authorize(Policy = Policies.IsUser)] public async Task LogoutEverywhere([FromServices] IRootSessions sessions, CancellationToken token) { var result = new WebResult(); @@ -310,19 +310,19 @@ namespace PrivaPub.Controllers.ClientToServer // The address is changed only with the password and a code sent to it (/clientapi/user/email); this older route, which // took neither and said whether an address was taken, no longer changes anything. - [HttpPost, Route("/clientapi/user/update"), Authorize(Policy = Policies.IsUser)] + [HttpPost, Route(ApiPaths.RootUser.POST_UpdateUser), Authorize(Policy = Policies.IsUser)] public IActionResult UpdateUser(UserForm userEmailForm) => StatusCode(StatusCodes.Status422UnprocessableEntity, new WebResult().Invalidate(localizer["Changing the address takes your password and a code sent to it."], StatusCodes.Status422UnprocessableEntity)); - [HttpGet, Route("/clientapi/user/account"), Authorize(Policy = Policies.IsUser)] + [HttpGet, Route(ApiPaths.RootUser.GET_Account), Authorize(Policy = Policies.IsUser)] public async Task Account(CancellationToken token = default) { var result = await usersService.AccountAsync(User.GetUserId(), token); return result.IsValid ? Ok(result.Data) : StatusCode(result.StatusCode, result); } - [HttpPost, Route("/clientapi/user/email"), EnableRateLimiting(RateLimiting.Accounts), Authorize(Policy = Policies.IsUser)] + [HttpPost, Route(ApiPaths.RootUser.POST_RequestEmailChange), EnableRateLimiting(RateLimiting.Accounts), Authorize(Policy = Policies.IsUser)] public async Task RequestEmailChange(EmailChangeForm form, CancellationToken token = default) { if (!ModelState.IsValid) @@ -331,7 +331,7 @@ namespace PrivaPub.Controllers.ClientToServer return result.IsValid ? Ok(result.Data) : StatusCode(result.StatusCode, result); } - [HttpPost, Route("/clientapi/user/email/verify"), EnableRateLimiting(RateLimiting.Accounts), Authorize(Policy = Policies.IsUser)] + [HttpPost, Route(ApiPaths.RootUser.POST_VerifyEmail), EnableRateLimiting(RateLimiting.Accounts), Authorize(Policy = Policies.IsUser)] public async Task VerifyEmail(EmailCodeForm form, CancellationToken token = default) { if (!ModelState.IsValid) @@ -340,7 +340,7 @@ namespace PrivaPub.Controllers.ClientToServer return result.IsValid ? Ok(result.Data) : StatusCode(result.StatusCode, result); } - [HttpPost, Route("/clientapi/user/totp/setup"), EnableRateLimiting(RateLimiting.Accounts), Authorize(Policy = Policies.IsUser)] + [HttpPost, Route(ApiPaths.RootUser.POST_TotpSetup), EnableRateLimiting(RateLimiting.Accounts), Authorize(Policy = Policies.IsUser)] public async Task TotpSetup(PasswordForm form, CancellationToken token = default) { if (!ModelState.IsValid) @@ -350,7 +350,7 @@ namespace PrivaPub.Controllers.ClientToServer } // on with the app's first code; every other session ends, and this device goes on with a new one - [HttpPost, Route("/clientapi/user/totp/enable"), EnableRateLimiting(RateLimiting.Accounts), Authorize(Policy = Policies.IsUser)] + [HttpPost, Route(ApiPaths.RootUser.POST_TotpEnable), EnableRateLimiting(RateLimiting.Accounts), Authorize(Policy = Policies.IsUser)] public async Task TotpEnable(TotpCodeForm form, CancellationToken token = default) { if (!ModelState.IsValid) @@ -362,7 +362,7 @@ namespace PrivaPub.Controllers.ClientToServer return Ok(new ViewTotpEnabled { RecoveryCodes = codes, Session = authTokenManager.GenerateToken(user, userSettings) }); } - [HttpPost, Route("/clientapi/user/totp/disable"), EnableRateLimiting(RateLimiting.Accounts), Authorize(Policy = Policies.IsUser)] + [HttpPost, Route(ApiPaths.RootUser.POST_TotpDisable), EnableRateLimiting(RateLimiting.Accounts), Authorize(Policy = Policies.IsUser)] public async Task TotpDisable(TotpDisableForm form, CancellationToken token = default) { if (!ModelState.IsValid) @@ -371,7 +371,7 @@ namespace PrivaPub.Controllers.ClientToServer return result.IsValid ? Ok(result.Data) : StatusCode(result.StatusCode, result); } - [HttpPost, Route("/clientapi/user/email/remove"), EnableRateLimiting(RateLimiting.Accounts), Authorize(Policy = Policies.IsUser)] + [HttpPost, Route(ApiPaths.RootUser.POST_RemoveEmail), EnableRateLimiting(RateLimiting.Accounts), Authorize(Policy = Policies.IsUser)] public async Task RemoveEmail(PasswordForm form, CancellationToken token = default) { if (!ModelState.IsValid) @@ -380,7 +380,7 @@ namespace PrivaPub.Controllers.ClientToServer return result.IsValid ? Ok(result.Data) : StatusCode(result.StatusCode, result); } - [HttpPost, Route("/clientapi/user/update/settings"), Authorize(Policy = Policies.IsUser)] + [HttpPost, Route(ApiPaths.RootUser.POST_UpdateUserSettings), Authorize(Policy = Policies.IsUser)] public async Task UpdateUserSettings(ViewUserSettings userSettings, CancellationToken token = default) { var result = new WebResult(); @@ -401,7 +401,7 @@ namespace PrivaPub.Controllers.ClientToServer } } - [HttpPost, Route("/clientapi/user/update/password"), Authorize(Policy = Policies.IsUser)] + [HttpPost, Route(ApiPaths.RootUser.POST_UpdatePassword), Authorize(Policy = Policies.IsUser)] public async Task UpdatePassword(UserPasswordForm userPasswordForm, CancellationToken token = default) { var result = new WebResult(); @@ -425,7 +425,7 @@ namespace PrivaPub.Controllers.ClientToServer } // what the login's media take, every persona's, and its quota when the server sets one - [HttpGet, Route("/clientapi/user/storage"), Authorize(Policy = Policies.IsUser)] + [HttpGet, Route(ApiPaths.RootUser.GET_GetStorage), Authorize(Policy = Policies.IsUser)] public async Task GetStorage([FromServices] Microsoft.Extensions.Options.IOptionsMonitor media, CancellationToken token) { var (bytes, files) = await Domain.Privacy.Counted.MediaOfRoot(User.GetUserId(), token); @@ -433,7 +433,7 @@ namespace PrivaPub.Controllers.ClientToServer return Ok(new PrivaPub.ClientModels.User.ViewStorage { MediaBytes = bytes, MediaFiles = files, QuotaBytes = quota > 0 ? quota : null }); } - [HttpGet, Route("/clientapi/user/settings"), Authorize(Policy = Policies.IsUser)] + [HttpGet, Route(ApiPaths.RootUser.GET_GetUserSettings), Authorize(Policy = Policies.IsUser)] public async Task GetUserSettings(CancellationToken token = default) { var result = new WebResult(); @@ -451,7 +451,7 @@ namespace PrivaPub.Controllers.ClientToServer } } - [HttpPost, Route("/clientapi/user/recover/password"), EnableRateLimiting(RateLimiting.Accounts), AllowAnonymous] + [HttpPost, Route(ApiPaths.RootUser.POST_RecoverPassword), EnableRateLimiting(RateLimiting.Accounts), AllowAnonymous] public async Task RecoverPassword(PasswordRecoveryForm passwordRecoveryForm, CancellationToken token = default) { var result = new WebResult(); @@ -475,7 +475,7 @@ namespace PrivaPub.Controllers.ClientToServer } } - [HttpPost, Route("/clientapi/user/recover/valid"), EnableRateLimiting(RateLimiting.Accounts), AllowAnonymous] + [HttpPost, Route(ApiPaths.RootUser.POST_IsValidRecoveryCode), EnableRateLimiting(RateLimiting.Accounts), AllowAnonymous] public async Task IsValidRecoveryCode( [FromBody, Required(ErrorMessageResourceName = "Required", ErrorMessageResourceType = typeof(ErrorsResource)), @@ -498,7 +498,7 @@ namespace PrivaPub.Controllers.ClientToServer } } - [HttpPost, Route("/clientapi/user/recover/update/password"), EnableRateLimiting(RateLimiting.Accounts), AllowAnonymous] + [HttpPost, Route(ApiPaths.RootUser.POST_ChangePassword), EnableRateLimiting(RateLimiting.Accounts), AllowAnonymous] public async Task ChangePassword(NewPasswordForm newPasswordForm, CancellationToken token = default) { var result = new WebResult(); @@ -519,7 +519,7 @@ namespace PrivaPub.Controllers.ClientToServer } } - [HttpPost, Route("/clientapi/user/delete"), EnableRateLimiting(RateLimiting.Accounts), Authorize(Policy = Policies.IsUser)] + [HttpPost, Route(ApiPaths.RootUser.POST_RemoveSelf), EnableRateLimiting(RateLimiting.Accounts), Authorize(Policy = Policies.IsUser)] public async Task RemoveSelf(RemoveSelfForm form, CancellationToken token = default) { var result = new WebResult(); @@ -541,7 +541,7 @@ namespace PrivaPub.Controllers.ClientToServer #region Auth refresh - [HttpGet, Route("/clientapi/user/sniff/again"), Authorize(Policy = Policies.IsUser)] + [HttpGet, Route(ApiPaths.RootUser.GET_SniffAgain), Authorize(Policy = Policies.IsUser)] public async Task SniffAgain([FromServices] DbEntities dbEntities, CancellationToken token) { var result = new WebResult(); diff --git a/PrivaPub/Controllers/ClientToServer/SocialController.cs b/PrivaPub/Controllers/ClientToServer/SocialController.cs index e060949..363ae18 100644 --- a/PrivaPub/Controllers/ClientToServer/SocialController.cs +++ b/PrivaPub/Controllers/ClientToServer/SocialController.cs @@ -11,21 +11,21 @@ using PrivaPub.Resources; namespace PrivaPub.Controllers.ClientToServer { [ApiController, - Route("clientapi/social"), + Route(ApiPaths.Social.Prefix), Authorize(Policy = Policies.IsUser)] public class SocialController( IFollowService follows, IStringLocalizer localizer) : ControllerBase { - [HttpPost, Route("/clientapi/follow")] + [HttpPost, Route(ApiPaths.Social.POST_Follow)] public async Task Follow(FollowForm form, CancellationToken token) => !ModelState.IsValid ? Invalid() : Answer(await follows.Follow(User.GetUserId(), form, token)); - [HttpPost, Route("/clientapi/unfollow")] + [HttpPost, Route(ApiPaths.Social.POST_Unfollow)] public async Task Unfollow(FollowForm form, CancellationToken token) => !ModelState.IsValid ? Invalid() : Answer(await follows.Unfollow(User.GetUserId(), form, token)); - [HttpGet, Route("/clientapi/following")] + [HttpGet, Route(ApiPaths.Social.GET_Following)] public async Task Following([FromQuery] string avatarId, CancellationToken token) => Answer(await follows.Followings(User.GetUserId(), avatarId, token)); diff --git a/PrivaPub/Controllers/ClientToServer/StatisticsController.cs b/PrivaPub/Controllers/ClientToServer/StatisticsController.cs index aa585e6..1cc9af3 100644 --- a/PrivaPub/Controllers/ClientToServer/StatisticsController.cs +++ b/PrivaPub/Controllers/ClientToServer/StatisticsController.cs @@ -12,18 +12,18 @@ using System.Globalization; namespace PrivaPub.Controllers.ClientToServer { [ApiController, - Route("clientapi/admin/statistics"), + Route(ApiPaths.Statistics.Prefix), Authorize(Policy = Policies.IsAdmin)] public class StatisticsController( StatisticsQueries queries, IJobQueue queue, Microsoft.Extensions.Options.IOptionsMonitor options) : ControllerBase { - [HttpGet, Route("/clientapi/admin/statistics/crawler")] + [HttpGet, Route(ApiPaths.Statistics.GET_Crawler)] public async Task Crawler(CancellationToken token) => Ok(await queries.Crawler(options.CurrentValue.Crawler.Enabled, options.CurrentValue.Crawler.RevisitDays, token)); - [HttpGet, Route("/clientapi/admin/statistics/overview")] + [HttpGet, Route(ApiPaths.Statistics.GET_Overview)] public async Task Overview([FromServices] Domain.Media.IMediaService media, [FromQuery] int days = 30, CancellationToken token = default) { var overview = await queries.Overview(days, token); @@ -35,25 +35,25 @@ namespace PrivaPub.Controllers.ClientToServer static long Bytes(string root) => Directory.Exists(root) ? new DirectoryInfo(root).EnumerateFiles("*", SearchOption.AllDirectories).Sum(f => f.Length) : 0; - [HttpGet, Route("/clientapi/admin/statistics/hosts")] + [HttpGet, Route(ApiPaths.Statistics.GET_Hosts)] public async Task Hosts([FromQuery] int days = 30, [FromQuery] string sort = default, [FromQuery] string software = default, [FromQuery] int page = 1, [FromQuery] int limit = 50, CancellationToken token = default) => Ok(await queries.Hosts(days, sort, software, page, limit, token)); - [HttpGet, Route("/clientapi/admin/statistics/hosts/{host}")] + [HttpGet, Route(ApiPaths.Statistics.GET_M_Host)] public async Task Host(string host, [FromQuery] int days = 90, CancellationToken token = default) => await queries.Host(host, days, token) is { } found ? Ok(found) : NotFound(); - [HttpGet, Route("/clientapi/admin/statistics/events")] + [HttpGet, Route(ApiPaths.Statistics.GET_Events)] public async Task Events([FromQuery] string host = default, [FromQuery] string channel = default, [FromQuery] string outcome = default, [FromQuery] string reason = default, [FromQuery] DateTime? before = default, [FromQuery] int limit = 100, CancellationToken token = default) => Ok(await queries.Events(host, channel, outcome, reason, before, limit, token)); - [HttpGet, Route("/clientapi/admin/statistics/server")] + [HttpGet, Route(ApiPaths.Statistics.GET_Server)] public async Task Server([FromQuery] int days = 30, CancellationToken token = default) => Ok(await queries.Server(days, token)); - [HttpPost, Route("/clientapi/admin/statistics/rollups/{day}")] + [HttpPost, Route(ApiPaths.Statistics.POST_M_Rollup)] public async Task Rollup(string day, CancellationToken token) { if (!DateTime.TryParseExact(day, "yyyy-MM-dd", CultureInfo.InvariantCulture, DateTimeStyles.AdjustToUniversal | DateTimeStyles.AssumeUniversal, out var parsed) @@ -65,7 +65,7 @@ namespace PrivaPub.Controllers.ClientToServer return Accepted(); } - [HttpPost, Route("/clientapi/admin/statistics/hosts/{host}/describe")] + [HttpPost, Route(ApiPaths.Statistics.POST_M_Describe)] public async Task Describe(string host, CancellationToken token) { host = Interactions.Host(host); diff --git a/PrivaPub/Controllers/ClientToServer/TimelineController.cs b/PrivaPub/Controllers/ClientToServer/TimelineController.cs index 5fde29c..e10f67d 100644 --- a/PrivaPub/Controllers/ClientToServer/TimelineController.cs +++ b/PrivaPub/Controllers/ClientToServer/TimelineController.cs @@ -8,22 +8,22 @@ using PrivaPub.Extensions; namespace PrivaPub.Controllers.ClientToServer { [ApiController, - Route("clientapi/timeline"), + Route(ApiPaths.Timeline.Prefix), Authorize(Policy = Policies.IsUser)] public class TimelineController( ITimelineService timelines) : ControllerBase { - [HttpGet, Route("/clientapi/timeline/home")] + [HttpGet, Route(ApiPaths.Timeline.GET_Home)] public async Task Home([FromQuery] string avatarId, [FromQuery(Name = "max_id")] string maxId, [FromQuery] int limit = 20, CancellationToken token = default) => Answer(await timelines.Home(User.GetUserId(), avatarId, maxId, limit, token)); - [HttpGet, Route("/clientapi/notifications")] + [HttpGet, Route(ApiPaths.Timeline.GET_Notifications)] public async Task Notifications([FromQuery] string avatarId, [FromQuery(Name = "max_id")] string maxId, [FromQuery] int limit = 20, CancellationToken token = default) => Answer(await timelines.Notifications(User.GetUserId(), avatarId, maxId, limit, token)); - [HttpPost, Route("/clientapi/notifications/read")] + [HttpPost, Route(ApiPaths.Timeline.POST_Read)] public async Task Read([FromQuery] string avatarId, CancellationToken token) => Answer(await timelines.MarkNotificationsRead(User.GetUserId(), avatarId, token)); diff --git a/PrivaPub/Federation/Controllers/EmojisController.cs b/PrivaPub/Federation/Controllers/EmojisController.cs index d8420d6..4b5d7da 100644 --- a/PrivaPub/Federation/Controllers/EmojisController.cs +++ b/PrivaPub/Federation/Controllers/EmojisController.cs @@ -23,7 +23,7 @@ namespace PrivaPub.Federation.Controllers const string ActivityContentType = "application/activity+json; charset=utf-8"; - [HttpGet, Route("/" + LocalEmojis.Path + "/{shortcode}")] + [HttpGet, Route(ApiPaths.Emojis.GET_Get + LocalEmojis.Path + "/{shortcode}")] public async Task Get(string shortcode, CancellationToken token) { Response.Headers.Vary = "Accept"; diff --git a/PrivaPub/Federation/Controllers/PeasantsController.cs b/PrivaPub/Federation/Controllers/PeasantsController.cs index 6dbcbc2..7cee7fb 100644 --- a/PrivaPub/Federation/Controllers/PeasantsController.cs +++ b/PrivaPub/Federation/Controllers/PeasantsController.cs @@ -25,7 +25,7 @@ using PrivaPub.Infrastructure; namespace PrivaPub.Federation.Controllers { - [ApiController, Route("peasants")] + [ApiController, Route(ApiPaths.Peasants.Prefix)] public class PeasantsController( ILocalActorService localActors, IInboxReceiver inboxReceiver, @@ -38,7 +38,7 @@ namespace PrivaPub.Federation.Controllers const int OutboxSize = 20; - [HttpGet, Route("{actor}")] + [HttpGet, Route(ApiPaths.Peasants.GET_M_GetActor)] public async Task GetActor(string actor, CancellationToken token) { var local = await localActors.FindByUserName(actor, token); @@ -65,7 +65,7 @@ namespace PrivaPub.Federation.Controllers // The instance actor at the server's root, for whoever asks for ActivityPub there: PieFed reads the inbox it sends a // community's announces to from the Application at a peer's root, as Lemmy serves its own, and assumes /inbox otherwise - [HttpGet, Route("/")] + [HttpGet, Route(ApiPaths.Peasants.GET_Root)] public async Task Root(CancellationToken token) { var accept = Request.Headers.Accept.ToString(); @@ -74,7 +74,7 @@ namespace PrivaPub.Federation.Controllers return Activity(ActivityPubRenderer.Actor(await localActors.GetInstanceActor(token))); } - [HttpGet, Route("{actor}/anus")] + [HttpGet, Route(ApiPaths.Peasants.GET_M_Outbox)] public async Task Outbox(string actor, [FromQuery] bool page, [FromQuery(Name = "max_id")] string maxId, CancellationToken token) { @@ -120,7 +120,7 @@ namespace PrivaPub.Federation.Controllers return Activity(ActivityPubRenderer.OrderedCollectionPage(pageId, local.Outbox, items, next, default)); } - [HttpGet, Route("{actor}/groupies")] + [HttpGet, Route(ApiPaths.Peasants.GET_M_Followers)] public async Task Followers(string actor, CancellationToken token) { var local = await localActors.FindByUserName(actor, token); @@ -136,7 +136,7 @@ namespace PrivaPub.Federation.Controllers // a persona's wall (FEP-400e): its own public posts that start a thread, and what its followers wrote on it, newest // first, as links; Smithereen reads it when one of its accounts starts following the persona - [HttpGet, Route("{actor}/" + Walls.Path)] + [HttpGet, Route(ApiPaths.Peasants.GET_M_Wall + Walls.Path)] public async Task Wall(string actor, [FromQuery] bool page, [FromQuery(Name = "max_id")] string maxId, CancellationToken token) { var local = await localActors.FindByUserName(actor, token); @@ -160,7 +160,7 @@ namespace PrivaPub.Federation.Controllers } // FEP-8fcf: the persona's followers on the server that signs the request, and nobody else's (FollowersSynchronization) - [HttpGet, Route("{actor}/groupies/roll-call")] + [HttpGet, Route(ApiPaths.Peasants.GET_M_RollCall)] public async Task RollCall(string actor, CancellationToken token) { var local = await localActors.FindByUserName(actor, token); @@ -173,7 +173,7 @@ namespace PrivaPub.Federation.Controllers return Activity(ActivityPubRenderer.OrderedCollection(FollowersSynchronization.RollCall(local), there.Count, there.Select(f => (JsonNode)f))); } - [HttpGet, Route("{actor}/stalking")] + [HttpGet, Route(ApiPaths.Peasants.GET_M_Following)] public async Task Following(string actor, CancellationToken token) { var local = await localActors.FindByUserName(actor, token); @@ -186,7 +186,7 @@ namespace PrivaPub.Federation.Controllers return Activity(ActivityPubRenderer.OrderedCollection(local.Following, (int)following, default)); } - [HttpGet, Route("{actor}/flock")] + [HttpGet, Route(ApiPaths.Peasants.GET_M_Members)] public async Task Members(string actor, CancellationToken token) { var local = await localActors.FindByUserName(actor, token); @@ -198,7 +198,7 @@ namespace PrivaPub.Federation.Controllers return Activity(ActivityPubRenderer.OrderedCollection(local.Flock, group.Members.Count, default)); } - [HttpGet, Route("{actor}/wardens")] + [HttpGet, Route(ApiPaths.Peasants.GET_M_Moderators)] public async Task Moderators(string actor, CancellationToken token) { var local = await localActors.FindByUserName(actor, token); @@ -214,7 +214,7 @@ namespace PrivaPub.Federation.Controllers return Activity(ActivityPubRenderer.OrderedCollection(local.Wardens, moderators.Count, moderators)); } - [HttpGet, Route("{actor}/trophies")] + [HttpGet, Route(ApiPaths.Peasants.GET_M_Featured)] public async Task Featured(string actor, CancellationToken token) { var local = await localActors.FindByUserName(actor, token); @@ -235,7 +235,7 @@ namespace PrivaPub.Federation.Controllers // the hashtags a persona features (R8), as Hashtag objects in the order it featured them, as Mastodon's featured tags // collection lists them (Mastodon reads Collection and OrderedCollection alike); a group features none - [HttpGet, Route("{actor}/tattoos")] + [HttpGet, Route(ApiPaths.Peasants.GET_M_FeaturedTags)] public async Task FeaturedTags(string actor, CancellationToken token) { var local = await localActors.FindByUserName(actor, token); @@ -250,7 +250,7 @@ namespace PrivaPub.Federation.Controllers return Activity(collection); } - [HttpGet, Route("{actor}/scribbles/{postId}")] + [HttpGet, Route(ApiPaths.Peasants.GET_M_Post)] public async Task Post(string actor, string postId, CancellationToken token) { var (local, post) = await PublicPost(actor, postId, token); @@ -274,7 +274,7 @@ namespace PrivaPub.Federation.Controllers } // the public and unlisted replies PrivaPub holds to a public post (owner decision 2026-10-06), oldest first - [HttpGet, Route("{actor}/scribbles/{postId}/replies")] + [HttpGet, Route(ApiPaths.Peasants.GET_M_Replies)] public async Task Replies(string actor, string postId, CancellationToken token) { var (local, post) = await PublicPost(actor, postId, token); @@ -288,7 +288,7 @@ namespace PrivaPub.Federation.Controllers } // a public conversation this post starts (FEP-7888): it and every public or unlisted reply under it PrivaPub holds - [HttpGet, Route("{actor}/scribbles/{postId}/context")] + [HttpGet, Route(ApiPaths.Peasants.GET_M_Context)] public async Task Context(string actor, string postId, CancellationToken token) { var (local, root) = await PublicPost(actor, postId, token); @@ -310,7 +310,7 @@ namespace PrivaPub.Federation.Controllers const int MaxThread = 500; - [HttpGet, Route("{actor}/parrot-licences/{licenceId}")] + [HttpGet, Route(ApiPaths.Peasants.GET_M_ParrotLicence)] public async Task ParrotLicence(string actor, string licenceId, CancellationToken token) { var author = await localActors.FindByUserName(actor, token); @@ -337,7 +337,7 @@ namespace PrivaPub.Federation.Controllers }); } - [HttpGet, Route("{actor}/grunts/{activityId}")] + [HttpGet, Route(ApiPaths.Peasants.GET_M_Grunt)] public async Task Grunt(string actor, string activityId, CancellationToken token) { if (activityId.StartsWith("announce-", StringComparison.Ordinal)) @@ -363,7 +363,7 @@ namespace PrivaPub.Federation.Controllers } // A DM's `context`: the conversation's posts, for its participants (or their servers' instance actors) only. - [HttpGet, Route("{actor}/whispers/{conversationId}")] + [HttpGet, Route(ApiPaths.Peasants.GET_M_Whispers)] public async Task Whispers(string actor, string conversationId, CancellationToken token) { var local = await localActors.FindByUserName(actor, token); @@ -387,7 +387,7 @@ namespace PrivaPub.Federation.Controllers }); } - [HttpPost, Route("{actor}/mouth"), EnableRateLimiting(RateLimiting.Inbox)] + [HttpPost, Route(ApiPaths.Peasants.POST_M_Inbox), EnableRateLimiting(RateLimiting.Inbox)] public async Task Inbox(string actor, CancellationToken token) { var local = await localActors.FindByUserName(actor, token); @@ -398,11 +398,11 @@ namespace PrivaPub.Federation.Controllers return Answer(await inboxReceiver.Receive(Request, local, token)); } - [HttpPost, Route("{actor}/human-centipede"), EnableRateLimiting(RateLimiting.Inbox)] + [HttpPost, Route(ApiPaths.Peasants.POST_M_ActorSharedInbox), EnableRateLimiting(RateLimiting.Inbox)] public async Task ActorSharedInbox(string actor, CancellationToken token) => Answer(await inboxReceiver.Receive(Request, default, token)); - [HttpPost, Route("/human-centipede"), EnableRateLimiting(RateLimiting.Inbox)] + [HttpPost, Route(ApiPaths.Peasants.POST_SharedInbox), EnableRateLimiting(RateLimiting.Inbox)] public async Task SharedInbox(CancellationToken token) => Answer(await inboxReceiver.Receive(Request, default, token)); diff --git a/PrivaPub/Federation/Controllers/UsersController.cs b/PrivaPub/Federation/Controllers/UsersController.cs index c22ef5c..4c9a8fe 100644 --- a/PrivaPub/Federation/Controllers/UsersController.cs +++ b/PrivaPub/Federation/Controllers/UsersController.cs @@ -2,10 +2,10 @@ using Microsoft.AspNetCore.Mvc; namespace PrivaPub.Federation.Controllers { - [ApiController, Route("users")] + [ApiController, Route(ApiPaths.Users.Prefix)] public class UsersController : ControllerBase { - [HttpGet, Route("{actor}")] + [HttpGet, Route(ApiPaths.Users.GET_M_GetActor)] public IActionResult GetActor(string actor) => RedirectPermanent($"/peasants/{Uri.EscapeDataString(actor)}"); } diff --git a/PrivaPub/Federation/Controllers/WellKnownController.cs b/PrivaPub/Federation/Controllers/WellKnownController.cs index 6143886..df9caaf 100644 --- a/PrivaPub/Federation/Controllers/WellKnownController.cs +++ b/PrivaPub/Federation/Controllers/WellKnownController.cs @@ -23,7 +23,7 @@ namespace PrivaPub.Federation.Controllers IOptionsMonitor registrations, Domain.Instance.IInstanceSettings settings) : ControllerBase { - [HttpGet, Route("/.well-known/webfinger")] + [HttpGet, Route(ApiPaths.WellKnown.GET_WebFinger)] public async Task WebFinger([FromQuery] string resource, CancellationToken token) { if (string.IsNullOrEmpty(resource)) @@ -76,7 +76,7 @@ namespace PrivaPub.Federation.Controllers return Content(document.ToJsonString(), "application/jrd+json; charset=utf-8"); } - [HttpGet, Route("/.well-known/nodeinfo")] + [HttpGet, Route(ApiPaths.WellKnown.GET_NodeInfoLinks)] public async Task NodeInfoLinks(CancellationToken token) { var document = new JsonObject @@ -102,7 +102,7 @@ namespace PrivaPub.Federation.Controllers return Content(document.ToJsonString(), "application/json; charset=utf-8"); } - [HttpGet, Route("/nodeinfo/{version:regex(^2\\.[[01]]$)}")] + [HttpGet, Route(ApiPaths.WellKnown.GET_M_NodeInfo)] public async Task NodeInfo(string version, CancellationToken token) { var users = await Counted.Users(token); diff --git a/PrivaPub/Program.cs b/PrivaPub/Program.cs index 2fb46b2..5868fea 100644 --- a/PrivaPub/Program.cs +++ b/PrivaPub/Program.cs @@ -210,7 +210,7 @@ try app.UseAuthentication(); app.UseAuthorization(); - app.MapGet("/build.json", () => Results.Json(new + app.MapGet(PrivaPub.ApiPaths.Build.GET_BuildJson, () => Results.Json(new { commit = BuildInfo.Commit, buildRef = BuildInfo.Ref,