Every route is a constant in ApiPaths
Build / Build (push) Successful in 35s

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 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01W4YtEJrgxG12Pc39Fai8Bd
This commit is contained in:
thepraandClaude Opus 5.5 committed 2026-11-10 01:59:20 +01:00
1 parent 0f73f69239
commit 739a1603ca
47 files changed
+952 -373

No files matched your search

@@ -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<RootUserController> logger,
@@ -58,7 +58,7 @@ namespace PrivaPub.Controllers.ClientToServer
: (await DB.Default.Find<RootUser>().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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> Root(string id, CancellationToken token)
{
var root = await DB.Default.Find<RootUser>().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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> DeleteGroup(string id, AdminPasswordForm form, [FromServices] IGroupRemoval groups, CancellationToken token)
{
if (!ModelState.IsValid)
@@ -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<GenericRes> localizer,
ILogger<BackupController> logger, IModerationLog log) : ControllerBase
{
[HttpGet, Route("")]
[HttpGet, Route(ApiPaths.Backup.GET_List)]
public async Task<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> Restore(string id, RestoreBackupForm form, CancellationToken token)
{
var admin = await Administrator(token);
@@ -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<DataController> logger) : ControllerBase
{
[HttpGet, Route("/clientapi/data/ping"), AllowAnonymous]
[HttpGet, Route(ApiPaths.Data.GET_Ping), AllowAnonymous]
public async ValueTask<IActionResult> 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<IActionResult> Languages(CancellationToken cancellationToken)
{
var result = new WebResult();
@@ -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<IActionResult> List(CancellationToken token) =>
Ok((await DB.Default.Find<DomainBlock>().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<IActionResult> 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<IActionResult> Delete([FromQuery] string domain, CancellationToken token)
{
domain = DomainBlocks.Normalise(domain);
@@ -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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> Delete([FromQuery] string shortcode, CancellationToken token)
{
var admin = await Administrator(token);
@@ -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<GenericRes> localizer) : ControllerBase
{
[HttpGet, Route("/clientapi/group/list")]
[HttpGet, Route(ApiPaths.Group.GET_List)]
public async Task<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> Delete(DeleteGroupForm form, [FromServices] IRootUsersService users, [FromServices] IGroupRemoval groups,
[FromServices] StaticServices.DbEntities dbEntities, CancellationToken token)
{
@@ -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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> DeleteRelay([FromServices] IRelays relays, [FromQuery] string address, CancellationToken token)
{
var admin = await Administrator(token);
@@ -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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> Log([FromQuery] string before, [FromQuery] int limit = 50, CancellationToken token = default)
{
var me = await DB.Default.Find<RootUser>().MatchID(User.GetUserId()).ExecuteFirstAsync(token);
@@ -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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> Stop(string avatarId, CancellationToken token)
{
if (!await Owns(avatarId, token))
@@ -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<GenericRes> localizer) : ControllerBase
{
[HttpGet, Route("/clientapi/post/list")]
[HttpGet, Route(ApiPaths.Post.GET_List)]
public async Task<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> InsertDm(InsertDmForm form, CancellationToken token) =>
!ModelState.IsValid ? Invalid() : Answer(await postsService.InsertDm(User.GetUserId(), form, token));
@@ -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<GenericRes> localizer,
ILogger<PrivateAvatarController> logger) : ControllerBase
{
[HttpGet, Route("/clientapi/avatar/private/list")]
[HttpGet, Route(ApiPaths.PrivateAvatar.GET_GetAvatars)]
public async Task<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> UpdateAvatar(UpdateAvatarForm model, CancellationToken token = default)
{
var result = new WebResult();
@@ -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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> GetStorage([FromServices] Microsoft.Extensions.Options.IOptionsMonitor<Domain.Media.MediaOptions> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> SniffAgain([FromServices] DbEntities dbEntities, CancellationToken token)
{
var result = new WebResult();
@@ -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<GenericRes> localizer) : ControllerBase
{
[HttpPost, Route("/clientapi/follow")]
[HttpPost, Route(ApiPaths.Social.POST_Follow)]
public async Task<IActionResult> 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<IActionResult> 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<IActionResult> Following([FromQuery] string avatarId, CancellationToken token) =>
Answer(await follows.Followings(User.GetUserId(), avatarId, token));
@@ -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<StatisticsOptions> options) : ControllerBase
{
[HttpGet, Route("/clientapi/admin/statistics/crawler")]
[HttpGet, Route(ApiPaths.Statistics.GET_Crawler)]
public async Task<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> 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<IActionResult> Describe(string host, CancellationToken token)
{
host = Interactions.Host(host);
@@ -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<IActionResult> 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<IActionResult> 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<IActionResult> Read([FromQuery] string avatarId, CancellationToken token) =>
Answer(await timelines.MarkNotificationsRead(User.GetUserId(), avatarId, token));