feat: Add support for user deletion based on target type (expired or limited)

Author: x0sina

app/db/crud/user.py

@@ -1,7 +1,7 @@
 from copy import deepcopy
 from datetime import UTC, datetime, timedelta, timezone
 from enum import Enum
-from typing import List, Optional, Sequence
+from typing import List, Literal, Optional, Sequence
 
 from sqlalchemy import and_, case, delete, desc, func, literal, not_, or_, select, update
 from sqlalchemy.ext.asyncio import AsyncSession
@@ -376,12 +376,20 @@ async def get_expired_users(
     expired_after: datetime | None = None,
     expired_before: datetime | None = None,
     admin_id: int | None = None,
+    target: Literal["expired", "limited"] = "expired",
 ):
-    query = select(User).where(User.status.in_([UserStatus.limited, UserStatus.expired])).where(User.is_expired)
-    if expired_after:
-        query = query.where(User.expire >= expired_after)
-    if expired_before:
-        query = query.where(User.expire <= expired_before)
+    query = select(User)
+
+    if target == "limited":
+        query = query.where(User.status == UserStatus.limited).where(User.is_limited)
+    else:
+        # Time-expired users support expiration date range filtering.
+        query = query.where(User.status == UserStatus.expired).where(User.is_expired)
+        if expired_after:
+            query = query.where(User.expire >= expired_after)
+        if expired_before:
+            query = query.where(User.expire <= expired_before)
+
     if admin_id:
         query = query.where(User.admin_id == admin_id)
 

app/operation/user.py

@@ -3,6 +3,7 @@
 import secrets
 from collections import Counter
 from datetime import datetime as dt, timedelta as td, timezone as tz
+from typing import Literal
 
 from fastapi import HTTPException
 from pydantic import ValidationError
@@ -559,22 +560,24 @@ async def get_expired_users(
         expired_after: dt = None,
         expired_before: dt = None,
         admin_username: str = None,
+        target: Literal["expired", "limited"] = "expired",
     ) -> list[str]:
         """
         Get users who have expired within the specified date range.
 
+        - **target**: `expired` (time-based) or `limited` (usage-based).
         - **expired_after** UTC datetime (optional)
         - **expired_before** UTC datetime (optional)
-        - At least one of expired_after or expired_before must be provided for filtering
-        - If both are omitted, returns all expired users
+        - Date range filters are applied only when target is `expired`.
+        - If both dates are omitted, returns all users matching target.
         """
 
         expired_after, expired_before = await self.validate_dates(expired_after, expired_before, False)
         if admin_username:
             admin_id = (await self.get_validated_admin(db, admin_username)).id
         else:
             admin_id = None
-        users = await get_expired_users(db, expired_after, expired_before, admin_id)
+        users = await get_expired_users(db, expired_after, expired_before, admin_id, target=target)
         return [row.username for row in users]
 
     async def delete_expired_users(
@@ -584,13 +587,15 @@ async def delete_expired_users(
         expired_after: dt | None = None,
         expired_before: dt | None = None,
         admin_username: str = None,
+        target: Literal["expired", "limited"] = "expired",
     ) -> RemoveUsersResponse:
         """
         Delete users who have expired within the specified date range.
 
+        - **target**: `expired` (time-based) or `limited` (usage-based).
         - **expired_after** UTC datetime (optional)
         - **expired_before** UTC datetime (optional)
-        - At least one of expired_after or expired_before must be provided
+        - Date range filters are applied only when target is `expired`.
         """
 
         expired_after, expired_before = await self.validate_dates(expired_after, expired_before, False)
@@ -599,7 +604,7 @@ async def delete_expired_users(
             admin_id = (await self.get_validated_admin(db, admin_username)).id
         else:
             admin_id = None
-        users = await get_expired_users(db, expired_after, expired_before, admin_id)
+        users = await get_expired_users(db, expired_after, expired_before, admin_id, target=target)
         await remove_users(db, users)
 
         username_list = [row.username for row in users]

app/routers/user.py

@@ -1,4 +1,5 @@
 from datetime import datetime as dt
+from typing import Literal
 
 from fastapi import APIRouter, Depends, Query, status
 
@@ -302,38 +303,47 @@ async def get_expired_users(
     db: AsyncSession = Depends(get_db),
     _: AdminDetails = Depends(check_sudo_admin),
     admin_username: str | None = None,
+    target: Literal["expired", "limited"] = Query("expired"),
     expired_after: dt | None = Query(None, examples=["2024-01-01T00:00:00+03:30"]),
     expired_before: dt | None = Query(None, examples=["2024-01-31T23:59:59+03:30"]),
 ):
     """
-    Get users who have expired within the specified date range.
+    Get cleanup-target users in the specified scope.
 
+    - **target**: `expired` (time-based) or `limited` (usage-based)
     - **expired_after** UTC datetime (optional)
     - **expired_before** UTC datetime (optional)
-    - At least one of expired_after or expired_before must be provided for filtering
-    - If both are omitted, returns all expired users
+    - Date range filters are applied only when target is `expired`
     """
 
-    return await user_operator.get_expired_users(db, expired_after, expired_before, admin_username)
+    return await user_operator.get_expired_users(
+        db,
+        expired_after,
+        expired_before,
+        admin_username,
+        target=target,
+    )
 
 
 @router.delete("s/expired", response_model=RemoveUsersResponse)
 async def delete_expired_users(
     db: AsyncSession = Depends(get_db),
     admin: AdminDetails = Depends(check_sudo_admin),
     admin_username: str | None = None,
+    target: Literal["expired", "limited"] = Query("expired"),
     expired_after: dt | None = Query(None, examples=["2024-01-01T00:00:00+03:30"]),
     expired_before: dt | None = Query(None, examples=["2024-01-31T23:59:59+03:30"]),
 ):
     """
-    Delete users who have expired within the specified date range.
+    Delete cleanup-target users in the specified scope.
 
+    - **target**: `expired` (time-based) or `limited` (usage-based)
     - **expired_after** UTC datetime (optional)
     - **expired_before** UTC datetime (optional)
-    - At least one of expired_after or expired_before must be provided
+    - Date range filters are applied only when target is `expired`
     """
     return await user_operator.delete_expired_users(
-        db, admin, expired_after, expired_before, admin_username=admin_username
+        db, admin, expired_after, expired_before, admin_username=admin_username, target=target
     )
 
 

dashboard/public/statics/locales/en.json

@@ -420,19 +420,31 @@
       "expiredUsers": {
         "title": "Delete Expired Accounts",
         "description": "Remove accounts that have expired within a specific date range",
+        "target": "Delete Target",
+        "targetPlaceholder": "Select target",
+        "targets": {
+          "expired": "Time Expired",
+          "limited": "Usage Limited"
+        },
         "expiredAfter": "Expired After",
         "expiredBefore": "Expired Before",
         "expiredAfterPlaceholder": "Select start date",
         "expiredBeforePlaceholder": "Select end date",
         "dateRange": "Date Range",
         "deleteExpired": "Delete Expired",
+        "deleteLimited": "Delete Limited",
         "deleting": "Deleting...",
         "deleteSuccess": "{{count}} expired accounts deleted successfully",
+        "deleteLimitedSuccess": "{{count}} limited accounts deleted successfully",
         "deleteFailed": "Failed to delete expired accounts",
+        "deleteLimitedFailed": "Failed to delete limited accounts",
         "confirmDelete": "Delete Expired Accounts",
+        "confirmDeleteLimited": "Delete Limited Accounts",
         "confirmDeleteMessage": "Are you sure you want to delete all expired accounts in the selected date range? This action cannot be undone.",
+        "confirmDeleteLimitedMessage": "Are you sure you want to delete all usage-limited accounts? This action cannot be undone.",
         "noDateSelected": "Please select at least one date",
-        "selectDateRange": "Select the date range for expired accounts to delete (only past dates are selectable)"
+        "selectDateRange": "Select the date range for expired accounts to delete (only past dates are selectable)",
+        "selectLimitedInfo": "Delete all usage-limited accounts for the selected admin scope."
       },
       "resetUsage": {
         "title": "Reset All Data Usage",

dashboard/public/statics/locales/fa.json

@@ -326,19 +326,31 @@
       "expiredUsers": {
         "title": "حذف حساب‌های منقضی شده",
         "description": "حذف حساب‌هایی که در بازه زمانی مشخصی منقضی شده‌اند",
+        "target": "هدف حذف",
+        "targetPlaceholder": "هدف را انتخاب کنید",
+        "targets": {
+          "expired": "انقضای زمانی",
+          "limited": "محدودیت حجم"
+        },
         "expiredAfter": "منقضی شده بعد از",
         "expiredBefore": "منقضی شده قبل از",
         "expiredAfterPlaceholder": "تاریخ شروع را انتخاب کنید",
         "expiredBeforePlaceholder": "تاریخ پایان را انتخاب کنید",
         "dateRange": "بازه زمانی",
         "deleteExpired": "حذف منقضی‌ها",
+        "deleteLimited": "حذف محدودها",
         "deleting": "در حال حذف...",
         "deleteSuccess": "{{count}} حساب منقضی شده با موفقیت حذف شد",
+        "deleteLimitedSuccess": "{{count}} حساب محدود با موفقیت حذف شد",
         "deleteFailed": "حذف حساب‌های منقضی شده ناموفق بود",
+        "deleteLimitedFailed": "حذف حساب‌های محدود ناموفق بود",
         "confirmDelete": "حذف حساب‌های منقضی شده",
+        "confirmDeleteLimited": "حذف حساب‌های محدود",
         "confirmDeleteMessage": "آیا مطمئن هستید که می‌خواهید همه حساب‌های منقضی شده در بازه زمانی انتخاب شده را حذف کنید؟ این عمل قابل بازگشت نیست.",
+        "confirmDeleteLimitedMessage": "آیا مطمئن هستید که می‌خواهید همه حساب‌های محدود از نظر حجم را حذف کنید؟ این عمل قابل بازگشت نیست.",
         "noDateSelected": "لطفاً حداقل یک تاریخ انتخاب کنید",
-        "selectDateRange": "بازه زمانی حساب‌های منقضی شده برای حذف را انتخاب کنید (فقط تاریخ‌های گذشته قابل انتخاب هستند)"
+        "selectDateRange": "بازه زمانی حساب‌های منقضی شده برای حذف را انتخاب کنید (فقط تاریخ‌های گذشته قابل انتخاب هستند)",
+        "selectLimitedInfo": "همه حساب‌های محدود از نظر حجم در محدوده ادمین انتخاب‌شده حذف می‌شوند."
       },
       "resetUsage": {
         "title": "بازنشانی کل مصرف داده‌ها",

dashboard/public/statics/locales/ru.json

@@ -433,19 +433,31 @@
       "expiredUsers": {
         "title": "Удаление просроченных аккаунтов",
         "description": "Удаление аккаунтов, которые просрочены в определенном диапазоне дат",
+        "target": "Цель удаления",
+        "targetPlaceholder": "Выберите цель",
+        "targets": {
+          "expired": "По сроку",
+          "limited": "По трафику"
+        },
         "expiredAfter": "Просрочено после",
         "expiredBefore": "Просрочено до",
         "expiredAfterPlaceholder": "Выберите дату начала",
         "expiredBeforePlaceholder": "Выберите дату окончания",
         "dateRange": "Диапазон дат",
         "deleteExpired": "Удалить просроченные",
+        "deleteLimited": "Удалить ограниченные",
         "deleting": "Удаление...",
         "deleteSuccess": "{{count}} просроченных аккаунтов успешно удалено",
+        "deleteLimitedSuccess": "Успешно удалено {{count}} ограниченных аккаунтов",
         "deleteFailed": "Не удалось удалить просроченные аккаунты",
+        "deleteLimitedFailed": "Не удалось удалить ограниченные аккаунты",
         "confirmDelete": "Удалить просроченные аккаунты",
+        "confirmDeleteLimited": "Удалить ограниченные аккаунты",
         "confirmDeleteMessage": "Вы уверены, что хотите удалить все просроченные аккаунты в выбранном диапазоне дат? Это действие нельзя отменить.",
+        "confirmDeleteLimitedMessage": "Вы уверены, что хотите удалить все аккаунты с ограничением по трафику? Это действие нельзя отменить.",
         "noDateSelected": "Пожалуйста, выберите хотя бы одну дату",
-        "selectDateRange": "Выберите диапазон дат для просроченных аккаунтов для удаления (доступны только прошедшие даты)"
+        "selectDateRange": "Выберите диапазон дат для просроченных аккаунтов для удаления (доступны только прошедшие даты)",
+        "selectLimitedInfo": "Удаляются все аккаунты с ограничением по трафику в выбранной области администратора."
       },
       "resetUsage": {
         "title": "Сброс всего использования данных",

dashboard/public/statics/locales/zh.json

@@ -401,19 +401,31 @@
       "expiredUsers": {
         "title": "删除过期账户",
         "description": "删除在特定日期范围内过期的账户",
+        "target": "删除目标",
+        "targetPlaceholder": "选择目标",
+        "targets": {
+          "expired": "按时间过期",
+          "limited": "按流量受限"
+        },
         "expiredAfter": "过期时间晚于",
         "expiredBefore": "过期时间早于",
         "expiredAfterPlaceholder": "选择开始日期",
         "expiredBeforePlaceholder": "选择结束日期",
         "dateRange": "日期范围",
         "deleteExpired": "删除过期账户",
+        "deleteLimited": "删除受限账户",
         "deleting": "删除中...",
         "deleteSuccess": "成功删除 {{count}} 个过期账户",
+        "deleteLimitedSuccess": "成功删除 {{count}} 个受限账户",
         "deleteFailed": "删除过期账户失败",
+        "deleteLimitedFailed": "删除受限账户失败",
         "confirmDelete": "删除过期账户",
+        "confirmDeleteLimited": "删除受限账户",
         "confirmDeleteMessage": "您确定要删除所选日期范围内的所有过期账户吗？此操作无法撤销。",
+        "confirmDeleteLimitedMessage": "您确定要删除所有按流量受限的账户吗？此操作无法撤销。",
         "noDateSelected": "请至少选择一个日期",
-        "selectDateRange": "选择要删除过期账户的日期范围（只能选择过去的日期）"
+        "selectDateRange": "选择要删除过期账户的日期范围（只能选择过去的日期）",
+        "selectLimitedInfo": "将删除所选管理员范围内的所有按流量受限账户。"
       },
       "resetUsage": {
         "title": "重置所有数据使用量",