feat(webhook): send multiple webhook for user usages

Author: ImMohammad20000

.env.example

@@ -82,7 +82,7 @@ UVICORN_PORT = 8000
 # NOTIFY_USER_DATA_USED_RESET = True
 # NOTIFY_USER_SUB_REVOKED = True
 # NOTIFY_IF_DATA_USAGE_PERCENT_REACHED = True
-# NOTIFY_IF_DAYS_LEF_REACHED = True
+# NOTIFY_IF_DAYS_LEFT_REACHED = True
 # NOTIFY_LOGIN = True
 
 ## Whitelist of IPs/hosts to disable login notifications
@@ -95,6 +95,8 @@ UVICORN_PORT = 8000
 # If You Want To Send Webhook To Multiple Server Add Multi Address
 # WEBHOOK_ADDRESS = "http://127.0.0.1:9000/,http://127.0.0.1:9001/"
 # WEBHOOK_SECRET = "something-very-very-secret"
+# NOTIFY_DAYS_LEFT=3,7
+# NOTIFY_REACHED_USAGE_PERCENT=80,90
 
 # VITE_BASE_API="https://example.com/api/"
 # JWT_ACCESS_TOKEN_EXPIRE_MINUTES = 1440

app/db/crud.py

@@ -41,7 +41,6 @@
 )
 from app.models.user_template import UserTemplateCreate, UserTemplateModify
 from app.utils.helpers import calculate_expiration_days, calculate_usage_percent
-from app.utils.notification import Notification
 from config import NOTIFY_DAYS_LEFT, NOTIFY_REACHED_USAGE_PERCENT, USERS_AUTODELETE_DAYS
 
 
@@ -455,8 +454,8 @@ def update_user(db: Session, dbuser: User, modify: UserModify) -> User:
     if modify.inbounds:
         for proxy_type, tags in modify.excluded_inbounds.items():
             dbproxy = db.query(Proxy) \
-                          .where(Proxy.user == dbuser, Proxy.type == proxy_type) \
-                          .first() or added_proxies.get(proxy_type)
+                .where(Proxy.user == dbuser, Proxy.type == proxy_type) \
+                .first() or added_proxies.get(proxy_type)
             if dbproxy:
                 dbproxy.excluded_inbounds = [get_or_create_inbound(db, tag) for tag in tags]
 
@@ -470,9 +469,13 @@ def update_user(db: Session, dbuser: User, modify: UserModify) -> User:
                 if dbuser.status != UserStatus.on_hold:
                     dbuser.status = UserStatus.active
 
-                if not dbuser.data_limit or (calculate_usage_percent(
-                        dbuser.used_traffic, dbuser.data_limit) < NOTIFY_REACHED_USAGE_PERCENT):
-                    delete_notification_reminder_by_type(db, dbuser.id, ReminderType.data_usage)
+                for percent in sorted(NOTIFY_REACHED_USAGE_PERCENT, reverse=True):
+                    if not dbuser.data_limit or (calculate_usage_percent(
+                            dbuser.used_traffic, dbuser.data_limit) < percent):
+                        reminder = get_notification_reminder(db, dbuser.id, ReminderType.data_usage, threshold=percent)
+                        if reminder:
+                            delete_notification_reminder(db, reminder)
+
             else:
                 dbuser.status = UserStatus.limited
 
@@ -481,9 +484,12 @@ def update_user(db: Session, dbuser: User, modify: UserModify) -> User:
         if dbuser.status in (UserStatus.active, UserStatus.expired):
             if not dbuser.expire or dbuser.expire > datetime.utcnow().timestamp():
                 dbuser.status = UserStatus.active
-                if not dbuser.expire or (calculate_expiration_days(
-                        dbuser.expire) > NOTIFY_DAYS_LEFT):
-                    delete_notification_reminder_by_type(db, dbuser.id, ReminderType.expiration_date)
+                for days_left in sorted(NOTIFY_DAYS_LEFT):
+                    if not dbuser.expire or (calculate_expiration_days(
+                            dbuser.expire) > days_left):
+                        reminder = get_notification_reminder(db, dbuser.id, ReminderType.expiration_date, threshold=days_left)
+                        if reminder:
+                            delete_notification_reminder(db, reminder)
             else:
                 dbuser.status = UserStatus.expired
 
@@ -1254,7 +1260,7 @@ def update_node_status(db: Session, dbnode: Node, status: NodeStatus, message: s
 
 
 def create_notification_reminder(
-        db: Session, reminder_type: ReminderType, expires_at: datetime, user_id: int) -> NotificationReminder:
+        db: Session, reminder_type: ReminderType, expires_at: datetime, user_id: int, threshold: Optional[int] = None) -> NotificationReminder:
     """
     Creates a new notification reminder.
 
@@ -1263,19 +1269,22 @@ def create_notification_reminder(
         reminder_type (ReminderType): The type of reminder.
         expires_at (datetime): The expiration time of the reminder.
         user_id (int): The ID of the user associated with the reminder.
+        threshold (Optional[int]): The threshold value to check for (e.g., days left or usage percent).
 
     Returns:
         NotificationReminder: The newly created NotificationReminder object.
     """
     reminder = NotificationReminder(type=reminder_type, expires_at=expires_at, user_id=user_id)
+    if threshold is not None:
+        reminder.threshold = threshold
     db.add(reminder)
     db.commit()
     db.refresh(reminder)
     return reminder
 
 
 def get_notification_reminder(
-        db: Session, user_id: int, reminder_type: ReminderType,
+        db: Session, user_id: int, reminder_type: ReminderType, threshold: Optional[int] = None
 ) -> Union[NotificationReminder, None]:
     """
     Retrieves a notification reminder for a user.
@@ -1284,38 +1293,57 @@ def get_notification_reminder(
         db (Session): The database session.
         user_id (int): The ID of the user.
         reminder_type (ReminderType): The type of reminder to retrieve.
+        threshold (Optional[int]): The threshold value to check for (e.g., days left or usage percent).
 
     Returns:
         Union[NotificationReminder, None]: The NotificationReminder object if found and not expired, None otherwise.
     """
-    reminder = db.query(NotificationReminder).filter(
-        NotificationReminder.user_id == user_id).filter(
-        NotificationReminder.type == reminder_type).first()
+    query = db.query(NotificationReminder).filter(
+        NotificationReminder.user_id == user_id,
+        NotificationReminder.type == reminder_type
+    )
+
+    # If a threshold is provided, filter for reminders with this threshold
+    if threshold is not None:
+        query = query.filter(NotificationReminder.threshold == threshold)
+
+    reminder = query.first()
+
     if reminder is None:
-        return
+        return None
+
+    # Check if the reminder has expired
     if reminder.expires_at and reminder.expires_at < datetime.utcnow():
         db.delete(reminder)
         db.commit()
-        return
+        return None
+
     return reminder
 
 
-def delete_notification_reminder_by_type(db: Session, user_id: int, reminder_type: ReminderType) -> None:
+def delete_notification_reminder_by_type(
+        db: Session, user_id: int, reminder_type: ReminderType, threshold: Optional[int] = None
+) -> None:
     """
-    Deletes a notification reminder for a user based on the reminder type.
+    Deletes a notification reminder for a user based on the reminder type and optional threshold.
 
     Args:
         db (Session): The database session.
         user_id (int): The ID of the user.
         reminder_type (ReminderType): The type of reminder to delete.
+        threshold (Optional[int]): The threshold to delete (e.g., days left or usage percent). If not provided, deletes all reminders of that type.
     """
     stmt = delete(NotificationReminder).where(
         NotificationReminder.user_id == user_id,
-        NotificationReminder.type == reminder_type,
+        NotificationReminder.type == reminder_type
     )
+
+    # If a threshold is provided, include it in the filter
+    if threshold is not None:
+        stmt = stmt.where(NotificationReminder.threshold == threshold)
+
     db.execute(stmt)
     db.commit()
-    return
 
 
 def delete_notification_reminder(db: Session, dbreminder: NotificationReminder) -> None:

app/db/migrations/versions/21226bc711ac_add_threshold_to_notificationreminder.py

@@ -0,0 +1,28 @@
+"""add threshold to NotificationReminder
+
+Revision ID: 21226bc711ac
+Revises: 2ea33513efc0
+Create Date: 2024-10-18 12:26:30.504491
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '21226bc711ac'
+down_revision = '2ea33513efc0'
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.add_column('notification_reminders', sa.Column('threshold', sa.Integer(), nullable=True))
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_column('notification_reminders', 'threshold')
+    # ### end Alembic commands ###

app/db/models.py

@@ -299,5 +299,6 @@ class NotificationReminder(Base):
     user_id = Column(Integer, ForeignKey("users.id"))
     user = relationship("User", back_populates="notification_reminders")
     type = Column(Enum(ReminderType), nullable=False)
+    threshold = Column(Integer, nullable=True)
     expires_at = Column(DateTime, nullable=True)
     created_at = Column(DateTime, default=datetime.utcnow)

app/jobs/review_users.py

@@ -19,8 +19,7 @@
 
 def add_notification_reminders(db: Session, user: "User", now: datetime = datetime.utcnow()) -> None:
     if user.data_limit:
-        usage_percent = calculate_usage_percent(
-            user.used_traffic, user.data_limit)
+        usage_percent = calculate_usage_percent(user.used_traffic, user.data_limit)
         if (usage_percent >= NOTIFY_REACHED_USAGE_PERCENT) and (not get_notification_reminder(db, user.id, ReminderType.data_usage)):
             report.data_usage_percent_reached(
                 db, usage_percent, UserResponse.from_orm(user),
@@ -34,6 +33,32 @@ def add_notification_reminders(db: Session, user: "User", now: datetime = dateti
                 user.id, user.expire)
 
 
+def add_notification_reminders(db: Session, user: "User", now: datetime = datetime.utcnow()) -> None:
+    if user.data_limit:
+        usage_percent = calculate_usage_percent(user.used_traffic, user.data_limit)
+
+        for percent in sorted(NOTIFY_REACHED_USAGE_PERCENT, reverse=True):
+            if usage_percent >= percent:
+                if not get_notification_reminder(db, user.id, ReminderType.data_usage, threshold=percent):
+                    report.data_usage_percent_reached(
+                        db, usage_percent, UserResponse.from_orm(user),
+                        user.id, user.expire, threshold=percent
+                    )
+                break
+
+    if user.expire:
+        expire_days = calculate_expiration_days(user.expire)
+
+        for days_left in sorted(NOTIFY_DAYS_LEFT):
+            if expire_days <= days_left:
+                if not get_notification_reminder(db, user.id, ReminderType.expiration_date, threshold=days_left):
+                    report.expire_days_reached(
+                        db, expire_days, UserResponse.from_orm(user),
+                        user.id, user.expire, threshold=days_left
+                    )
+                break
+
+
 def review():
     now = datetime.utcnow()
     now_ts = now.timestamp()

app/utils/report.py

@@ -22,7 +22,7 @@
     NOTIFY_USER_DATA_USED_RESET,
     NOTIFY_USER_SUB_REVOKED,
     NOTIFY_IF_DATA_USAGE_PERCENT_REACHED,
-    NOTIFY_IF_DAYS_LEF_REACHED,
+    NOTIFY_IF_DAYS_LEFT_REACHED,
     NOTIFY_LOGIN
 )
 
@@ -164,19 +164,19 @@ def user_subscription_revoked(user: UserResponse, by: Admin, user_admin: Admin =
 
 
 def data_usage_percent_reached(
-        db: Session, percent: float, user: UserResponse, user_id: int, expire: Optional[int] = None) -> None:
+        db: Session, percent: float, user: UserResponse, user_id: int, expire: Optional[int] = None, threshold: Optional[int] = None) -> None:
     if NOTIFY_IF_DATA_USAGE_PERCENT_REACHED:
         notify(ReachedUsagePercent(username=user.username, user=user, used_percent=percent))
         create_notification_reminder(db, ReminderType.data_usage,
-                                     expires_at=dt.utcfromtimestamp(expire) if expire else None, user_id=user_id)
+                                     expires_at=dt.utcfromtimestamp(expire) if expire else None, user_id=user_id, threshold=threshold)
 
 
-def expire_days_reached(db: Session, days: int, user: UserResponse, user_id: int, expire: int) -> None:
+def expire_days_reached(db: Session, days: int, user: UserResponse, user_id: int, expire: int, threshold=None) -> None:
     notify(ReachedDaysLeft(username=user.username, user=user, days_left=days))
-    if NOTIFY_IF_DAYS_LEF_REACHED:
+    if NOTIFY_IF_DAYS_LEFT_REACHED:
         create_notification_reminder(
             db, ReminderType.expiration_date, expires_at=dt.utcfromtimestamp(expire),
-            user_id=user_id)
+            user_id=user_id, threshold=threshold)
 
 
 def login(username: str, password: str, client_ip: str, success: bool) -> None:

config.py

@@ -65,7 +65,8 @@
 GRPC_USER_AGENT_TEMPLATE = config("GRPC_USER_AGENT_TEMPLATE", default="user_agent/grpc.json")
 
 EXTERNAL_CONFIG = config("EXTERNAL_CONFIG", default="", cast=str)
-LOGIN_NOTIFY_WHITE_LIST = [ip.strip() for ip in config("LOGIN_NOTIFY_WHITE_LIST", default="", cast=str).split(",") if ip.strip()]
+LOGIN_NOTIFY_WHITE_LIST = [ip.strip() for ip in config("LOGIN_NOTIFY_WHITE_LIST",
+                                                       default="", cast=str).split(",") if ip.strip()]
 
 USE_CUSTOM_JSON_DEFAULT = config("USE_CUSTOM_JSON_DEFAULT", default=False, cast=bool)
 USE_CUSTOM_JSON_FOR_V2RAYN = config("USE_CUSTOM_JSON_FOR_V2RAYN", default=False, cast=bool)
@@ -79,7 +80,7 @@
 NOTIFY_USER_DATA_USED_RESET = config("NOTIFY_USER_DATA_USED_RESET", default=True, cast=bool)
 NOTIFY_USER_SUB_REVOKED = config("NOTIFY_USER_SUB_REVOKED", default=True, cast=bool)
 NOTIFY_IF_DATA_USAGE_PERCENT_REACHED = config("NOTIFY_IF_DATA_USAGE_PERCENT_REACHED", default=True, cast=bool)
-NOTIFY_IF_DAYS_LEF_REACHED = config("NOTIFY_IF_DAYS_LEF_REACHED", default=True, cast=bool)
+NOTIFY_IF_DAYS_LEFT_REACHED = config("NOTIFY_IF_DAYS_LEFT_REACHED", default=True, cast=bool)
 NOTIFY_LOGIN = config("NOTIFY_LOGIN", default=True, cast=bool)
 
 ACTIVE_STATUS_TEXT = config("ACTIVE_STATUS_TEXT", default="Active")
@@ -113,10 +114,18 @@
 NUMBER_OF_RECURRENT_NOTIFICATIONS = config("NUMBER_OF_RECURRENT_NOTIFICATIONS", default=3, cast=int)
 
 # sends a notification when the user uses this much of thier data
-NOTIFY_REACHED_USAGE_PERCENT = config("NOTIFY_REACHED_USAGE_PERCENT", default=80, cast=int)
+NOTIFY_REACHED_USAGE_PERCENT = config(
+    "NOTIFY_REACHED_USAGE_PERCENT",
+    default=[80],
+    cast=lambda v: [int(p.strip()) for p in v.split(',')] if v else []
+)
 
 # sends a notification when there is n days left of their service
-NOTIFY_DAYS_LEFT = config("NOTIFY_DAYS_LEFT", default=3, cast=int)
+NOTIFY_DAYS_LEFT = config(
+    "NOTIFY_DAYS_LEFT",
+    default=[3],
+    cast=lambda v: [int(d.strip()) for d in v.split(',')] if v else []
+)
 
 DISABLE_RECORDING_NODE_USAGE = config("DISABLE_RECORDING_NODE_USAGE", cast=bool, default=False)