gitscope
← marzneshin / v0.3.0-alpha5 / app/db/crud.py
https://dev.kronoz.win/r/marzneshin.git
app/db/crud.py · Python
Blame Raw
  1import json
  2import secrets
  3from datetime import datetime, timedelta
  4from enum import Enum
  5from typing import List, Optional, Tuple, Union
  6
  7from sqlalchemy import and_, delete, update, select
  8from sqlalchemy.orm import Session
  9
 10from app.db.models import (
 11    JWT,
 12    TLS,
 13    Admin,
 14    Node,
 15    NodeUsage,
 16    NodeUserUsage,
 17    NotificationReminder,
 18    InboundHost,
 19    Service,
 20    Inbound,
 21    System,
 22    User,
 23    UserUsageResetLogs,
 24)
 25from app.models.admin import AdminCreate, AdminModify, AdminPartialModify
 26from app.models.node import NodeCreate, NodeModify, NodeStatus, NodeUsageResponse
 27from app.models.proxy import InboundHost as InboundHostModify
 28from app.models.service import Service as ServiceModify, ServiceCreate
 29from app.models.user import (
 30    ReminderType,
 31    UserCreate,
 32    UserDataLimitResetStrategy,
 33    UserModify,
 34    UserStatus,
 35    UserUsageResponse,
 36)
 37from app.utils.helpers import calculate_expiration_days, calculate_usage_percent
 38from config import NOTIFY_DAYS_LEFT, NOTIFY_REACHED_USAGE_PERCENT
 39
 40
 41def add_default_hosts(db: Session, inbounds: List[Inbound]):
 42    hosts = [
 43        InboundHost(
 44            remark="🚀 Marz ({USERNAME}) [{PROTOCOL} - {TRANSPORT}]",
 45            address="{SERVER_IP}",
 46            inbound=i,
 47        )
 48        for i in inbounds
 49    ]
 50    db.add_all(hosts)
 51    db.commit()
 52
 53
 54def assure_node_inbounds(db: Session, inbounds: List[Inbound], node_id: int):
 55    current_tags = [
 56        i[0]
 57        for i in db.execute(
 58            select(Inbound.tag).filter(Inbound.node_id == node_id)
 59        ).all()
 60    ]
 61    updated_tags = set(i.tag for i in list(inbounds))
 62    inbound_additions, tag_deletions = list(), set()
 63    for tag in current_tags:
 64        if tag not in updated_tags:
 65            tag_deletions.add(tag)
 66    db_inbounds = db.query(Inbound).where(
 67        and_(Inbound.node_id == node_id, Inbound.tag.in_(tag_deletions))
 68    )
 69    for i in db_inbounds:
 70        db.delete(i)
 71
 72    for inb in inbounds:
 73        if inb.tag in current_tags:
 74            stmt = (
 75                update(Inbound)
 76                .where(and_(Inbound.node_id == node_id, Inbound.tag == inb.tag))
 77                .values(protocol=json.loads(inb.config)["protocol"], config=inb.config)
 78            )
 79            db.execute(stmt)
 80        else:
 81            inbound_additions.append(inb)
 82    new_inbounds = [
 83        Inbound(
 84            tag=inb.tag,
 85            protocol=json.loads(inb.config)["protocol"],
 86            config=inb.config,
 87            node_id=node_id,
 88        )
 89        for inb in inbound_additions
 90    ]
 91    db.add_all(new_inbounds)
 92    db.flush()
 93    for i in new_inbounds:
 94        db.refresh(i)
 95    add_default_hosts(db, new_inbounds)
 96    db.commit()
 97
 98
 99def get_node_users(
100    db: Session, node_id: Optional[int], statuses: Optional[List[UserStatus]] = None
101):
102    query = (
103        db.query(User.id, User.username, User.key, Inbound)
104        .distinct()
105        .where(User.enabled is True)
106        .join(Inbound.services)
107        .join(Service.users)
108        .filter(Inbound.node_id == node_id)
109    )
110    if isinstance(statuses, list):
111        query = query.filter(User.status.in_(statuses))
112    return query.all()
113
114
115def get_user_hosts(db: Session, user_id: int):
116    return (
117        db.query(InboundHost)
118        .distinct()
119        .join(User.services)
120        .join(Service.inbounds)
121        .join(Inbound.hosts)
122        .filter(User.id == user_id)
123        .all()
124    )
125
126
127def get_inbound_hosts(db: Session, inbound_id: int) -> List[InboundHost]:
128    return db.query(InboundHost).filter(InboundHost.inbound_id == inbound_id).all()
129
130
131def get_all_inbounds(db: Session):
132    return db.query(Inbound).all()
133
134
135def get_inbound(db: Session, inbound_id: int) -> Inbound | None:
136    return db.query(Inbound).filter(Inbound.id == inbound_id).first()
137
138
139def get_host(db: Session, host_id) -> InboundHost:
140    return db.query(InboundHost).filter(InboundHost.id == host_id).first()
141
142
143def add_host(db: Session, inbound: Inbound, host: InboundHostModify):
144    host = InboundHost(
145        remark=host.remark,
146        address=host.address,
147        port=host.port,
148        path=host.path,
149        sni=host.sni,
150        host=host.host,
151        inbound=inbound,
152        security=host.security,
153        alpn=host.alpn,
154        fingerprint=host.fingerprint,
155    )
156    inbound.hosts.append(host)
157    db.commit()
158    db.refresh(host)
159    return host
160
161
162def update_host(db: Session, db_host: InboundHost, host: InboundHostModify):
163    db_host.remark = host.remark
164    db_host.address = host.address
165    db_host.port = host.port
166    db_host.path = host.path
167    db_host.sni = host.sni
168    db_host.host = host.host
169    db_host.security = host.security
170    db_host.alpn = host.alpn
171    db_host.fingerprint = host.fingerprint
172    db.commit()
173    db.refresh(db_host)
174    return db_host
175
176
177def get_user(db: Session, username: str):
178    return db.query(User).filter(User.username == username).first()
179
180
181def get_user_by_id(db: Session, user_id: int):
182    return db.query(User).filter(User.id == user_id).first()
183
184
185UsersSortingOptions = Enum(
186    "UsersSortingOptions",
187    {
188        "username": User.username.asc(),
189        "used_traffic": User.used_traffic.asc(),
190        "data_limit": User.data_limit.asc(),
191        "expire": User.expire.asc(),
192        "created_at": User.created_at.asc(),
193        "-username": User.username.desc(),
194        "-used_traffic": User.used_traffic.desc(),
195        "-data_limit": User.data_limit.desc(),
196        "-expire": User.expire.desc(),
197        "-created_at": User.created_at.desc(),
198    },
199)
200
201
202def get_users(
203    db: Session,
204    offset: Optional[int] = None,
205    limit: Optional[int] = None,
206    usernames: Optional[List[str]] = None,
207    status: Optional[Union[UserStatus, list]] = None,
208    sort: Optional[List[UsersSortingOptions]] = None,
209    admin: Optional[Admin] = None,
210    reset_strategy: Optional[Union[UserDataLimitResetStrategy, list]] = None,
211    return_with_count: bool = False,
212) -> Union[List[User], Tuple[List[User], int]]:
213    query = db.query(User)
214
215    if usernames:
216        if len(usernames) == 1:
217            query = query.filter(User.username.ilike(f"%{usernames[0]}%"))
218        else:
219            query = query.filter(User.username.in_(usernames))
220
221    if status:
222        if isinstance(status, list):
223            query = query.filter(User.status.in_(status))
224        else:
225            query = query.filter(User.status == status)
226
227    if reset_strategy:
228        if isinstance(reset_strategy, list):
229            query = query.filter(User.data_limit_reset_strategy.in_(reset_strategy))
230        else:
231            query = query.filter(User.data_limit_reset_strategy == reset_strategy)
232
233    if admin:
234        query = query.filter(User.admin == admin)
235
236    # count it before applying limit and offset
237    if return_with_count:
238        count = query.count()
239
240    if sort:
241        query = query.order_by(*(opt.value for opt in sort))
242
243    if offset:
244        query = query.offset(offset)
245    if limit:
246        query = query.limit(limit)
247
248    if return_with_count:
249        return query.all(), count
250
251    return query.all()
252
253
254def get_user_usages(
255    db: Session,
256    dbuser: User,
257    start: datetime,
258    end: datetime,
259) -> List[UserUsageResponse]:
260    usages = dict()
261
262    for node in db.query(Node).all():
263        usages[node.id] = UserUsageResponse(
264            node_id=node.id, node_name=node.name, used_traffic=0
265        )
266
267    cond = and_(
268        NodeUserUsage.user_id == dbuser.id,
269        NodeUserUsage.created_at >= start,
270        NodeUserUsage.created_at <= end,
271    )
272
273    for v in db.query(NodeUserUsage).filter(cond):
274        try:
275            usages[v.node_id or 0].used_traffic += v.used_traffic
276        except KeyError:
277            pass
278
279    return list(usages.values())
280
281
282def get_users_count(db: Session, status: UserStatus = None, admin: Admin = None):
283    query = db.query(User.id)
284    if admin:
285        query = query.filter(User.admin == admin)
286    if status:
287        query = query.filter(User.status == status)
288    return query.count()
289
290
291def create_user(db: Session, user: UserCreate, admin: Admin = None):
292    dbuser = User(
293        username=user.username,
294        # proxies=proxies,
295        key=user.key,
296        services=db.query(Service)
297        .filter(Service.id.in_(user.services))
298        .all(),  # user.services,
299        status=user.status,
300        data_limit=(user.data_limit or None),
301        expire=(user.expire or None),
302        admin=admin,
303        data_limit_reset_strategy=user.data_limit_reset_strategy,
304        note=user.note,
305        on_hold_expire_duration=(user.on_hold_expire_duration or None),
306        on_hold_timeout=(user.on_hold_timeout or None),
307    )
308    db.add(dbuser)
309    db.commit()
310    db.refresh(dbuser)
311    return dbuser
312
313
314def remove_user(db: Session, dbuser: User):
315    db.delete(dbuser)
316    # db.query(User).filter_by(id=user_id).delete()
317    db.commit()
318
319
320def update_user(db: Session, dbuser: User, modify: UserModify):
321    if modify.status is not None:
322        dbuser.status = modify.status
323
324    if modify.data_limit is not None:
325        dbuser.data_limit = modify.data_limit or None
326        if dbuser.status not in (UserStatus.expired, UserStatus.disabled):
327            if not dbuser.data_limit or dbuser.used_traffic < dbuser.data_limit:
328                if dbuser.status != UserStatus.on_hold:
329                    dbuser.status = UserStatus.active
330
331                if not dbuser.data_limit or (
332                    calculate_usage_percent(dbuser.used_traffic, dbuser.data_limit)
333                    < NOTIFY_REACHED_USAGE_PERCENT
334                ):
335                    delete_notification_reminder_by_type(
336                        db, dbuser.id, ReminderType.data_usage
337                    )
338            else:
339                dbuser.status = UserStatus.limited
340
341    if modify.expire is not None:
342        dbuser.expire = modify.expire or None
343        if dbuser.status in (UserStatus.active, UserStatus.expired):
344            if not dbuser.expire or dbuser.expire > datetime.utcnow():
345                dbuser.status = UserStatus.active
346                if not dbuser.expire or (
347                    calculate_expiration_days(dbuser.expire) > NOTIFY_DAYS_LEFT
348                ):
349                    delete_notification_reminder_by_type(
350                        db, dbuser.id, ReminderType.expiration_date
351                    )
352            else:
353                dbuser.status = UserStatus.expired
354
355    if modify.note is not None:
356        dbuser.note = modify.note or None
357
358    if modify.data_limit_reset_strategy is not None:
359        dbuser.data_limit_reset_strategy = modify.data_limit_reset_strategy.value
360
361    if modify.on_hold_timeout is not None:
362        dbuser.on_hold_timeout = modify.on_hold_timeout
363
364    if modify.on_hold_expire_duration is not None:
365        dbuser.on_hold_expire_duration = modify.on_hold_expire_duration
366
367    if modify.services is not None:
368        dbuser.services = (
369            db.query(Service).filter(Service.id.in_(modify.services)).all()
370        )
371    dbuser.edit_at = datetime.utcnow()
372
373    db.commit()
374    db.refresh(dbuser)
375    return dbuser
376
377
378def reset_user_data_usage(db: Session, dbuser: User):
379    usage_log = UserUsageResetLogs(
380        user=dbuser,
381        used_traffic_at_reset=dbuser.used_traffic,
382    )
383    db.add(usage_log)
384
385    dbuser.used_traffic = 0
386    dbuser.node_usages.clear()
387    if dbuser.status == UserStatus.limited:
388        dbuser.status = UserStatus.active.value
389    db.add(dbuser)
390
391    db.commit()
392    db.refresh(dbuser)
393    return dbuser
394
395
396def revoke_user_sub(db: Session, dbuser: User):
397    dbuser.key = secrets.token_hex(16)
398    db.commit()
399    db.refresh(dbuser)
400    return dbuser
401
402
403def update_user_sub(db: Session, dbuser: User, user_agent: str):
404    dbuser.sub_updated_at = datetime.utcnow()
405    dbuser.sub_last_user_agent = user_agent
406
407    db.commit()
408    db.refresh(dbuser)
409    return dbuser
410
411
412def reset_all_users_data_usage(db: Session, admin: Optional[Admin] = None):
413    query = db.query(User)
414
415    if admin:
416        query = query.filter(User.admin == admin)
417
418    for dbuser in query.all():
419        dbuser.used_traffic = 0
420        if dbuser.status not in [
421            UserStatus.on_hold,
422            UserStatus.expired,
423            UserStatus.disabled,
424        ]:
425            dbuser.status = UserStatus.active
426        dbuser.usage_logs.clear()
427        dbuser.node_usages.clear()
428        db.add(dbuser)
429
430    db.commit()
431
432
433def update_user_status(db: Session, dbuser: User, status: UserStatus):
434    dbuser.status = status
435    db.commit()
436    db.refresh(dbuser)
437    return dbuser
438
439
440def set_owner(db: Session, dbuser: User, admin: Admin):
441    dbuser.admin = admin
442    db.commit()
443    db.refresh(dbuser)
444    return dbuser
445
446
447def start_user_expire(db: Session, dbuser: User):
448    expire = datetime.utcnow() + timedelta(seconds=dbuser.on_hold_expire_duration)
449    dbuser.expire = expire
450    db.commit()
451    db.refresh(dbuser)
452    return dbuser
453
454
455def get_system_usage(db: Session):
456    return db.query(System).first()
457
458
459def get_jwt_secret_key(db: Session):
460    return db.query(JWT).first().secret_key
461
462
463def get_tls_certificate(db: Session):
464    return db.query(TLS).first()
465
466
467def get_admin(db: Session, username: str):
468    return db.query(Admin).filter(Admin.username == username).first()
469
470
471def create_admin(db: Session, admin: AdminCreate):
472    dbadmin = Admin(
473        username=admin.username,
474        hashed_password=admin.hashed_password,
475        is_sudo=admin.is_sudo,
476    )
477    db.add(dbadmin)
478    db.commit()
479    db.refresh(dbadmin)
480    return dbadmin
481
482
483def update_admin(db: Session, dbadmin: Admin, modified_admin: AdminModify):
484    dbadmin.is_sudo = modified_admin.is_sudo
485    if dbadmin.hashed_password != modified_admin.hashed_password:
486        dbadmin.hashed_password = modified_admin.hashed_password
487        dbadmin.password_reset_at = datetime.utcnow()
488    db.commit()
489    db.refresh(dbadmin)
490    return dbadmin
491
492
493def partial_update_admin(
494    db: Session, dbadmin: Admin, modified_admin: AdminPartialModify
495):
496    if modified_admin.is_sudo is not None:
497        dbadmin.is_sudo = modified_admin.is_sudo
498    if (
499        modified_admin.password is not None
500        and dbadmin.hashed_password != modified_admin.hashed_password
501    ):
502        dbadmin.hashed_password = modified_admin.hashed_password
503        dbadmin.password_reset_at = datetime.utcnow()
504
505    db.commit()
506    db.refresh(dbadmin)
507    return dbadmin
508
509
510def remove_admin(db: Session, dbadmin: Admin):
511    db.delete(dbadmin)
512    db.commit()
513    return dbadmin
514
515
516def get_admins(
517    db: Session,
518    offset: Optional[int] = None,
519    limit: Optional[int] = None,
520    username: Optional[str] = None,
521):
522    query = db.query(Admin)
523    if username:
524        query = query.filter(Admin.username.ilike(f"%{username}%"))
525    if offset:
526        query = query.offset(offset)
527    if limit:
528        query = query.limit(limit)
529    return query.all()
530
531
532def create_service(db: Session, service: ServiceCreate) -> Service:
533    dbservice = Service(
534        name=service.name,
535        inbounds=db.query(Inbound).filter(Inbound.id.in_(service.inbounds)).all(),
536        users=db.query(User).filter(User.id.in_(service.users)).all(),
537    )
538    db.add(dbservice)
539    db.commit()
540    db.refresh(dbservice)
541    return dbservice
542
543
544def get_service(db: Session, service_id: id) -> Service:
545    return db.query(Service).filter(Service.id == service_id).first()
546
547
548def get_services(db: Session) -> List[Service]:
549    return db.query(Service).all()
550
551
552def update_service(db: Session, db_service: Service, modification: ServiceModify):
553    if modification.name is not None:
554        db_service.name = modification.name
555
556    if modification.inbounds is not None:
557        db_service.inbounds = (
558            db.query(Inbound).filter(Inbound.id.in_(modification.inbounds)).all()
559        )
560
561    db.commit()
562    db.refresh(db_service)
563    return db_service
564
565
566def remove_service(db: Session, db_service: Service):
567    db.delete(db_service)
568    db.commit()
569    return db_service
570
571
572def get_node(db: Session, name: str):
573    return db.query(Node).filter(Node.name == name).first()
574
575
576def get_node_by_id(db: Session, node_id: int):
577    return db.query(Node).filter(Node.id == node_id).first()
578
579
580def get_nodes(
581    db: Session, status: Optional[Union[NodeStatus, list]] = None, enabled: bool = None
582):
583    query = db.query(Node)
584
585    if status:
586        if isinstance(status, list):
587            query = query.filter(Node.status.in_(status))
588        else:
589            query = query.filter(Node.status == status)
590
591    if enabled:
592        query = query.filter(Node.status != NodeStatus.disabled)
593
594    return query.all()
595
596
597def get_nodes_usage(
598    db: Session, start: datetime, end: datetime
599) -> List[NodeUsageResponse]:
600    usages = dict()
601
602    usages[0] = NodeUsageResponse(  # Main Core
603        node_id=None, node_name="Master", uplink=0, downlink=0
604    )
605    for node in db.query(Node).all():
606        usages[node.id] = NodeUsageResponse(
607            node_id=node.id, node_name=node.name, uplink=0, downlink=0
608        )
609
610    cond = and_(NodeUsage.created_at >= start, NodeUsage.created_at <= end)
611
612    for v in db.query(NodeUsage).filter(cond):
613        try:
614            usages[v.node_id or 0].uplink += v.uplink
615            usages[v.node_id or 0].downlink += v.downlink
616        except KeyError:
617            pass
618
619    return list(usages.values())
620
621
622def create_node(db: Session, node: NodeCreate):
623    dbnode = Node(
624        name=node.name,
625        address=node.address,
626        port=node.port,
627        connection_backend=node.connection_backend,
628    )
629
630    db.add(dbnode)
631    db.commit()
632    db.refresh(dbnode)
633    return dbnode
634
635
636def remove_node(db: Session, dbnode: Node):
637    db.delete(dbnode)
638    db.commit()
639    return dbnode
640
641
642def update_node(db: Session, dbnode: Node, modify: NodeModify):
643    if modify.name is not None:
644        dbnode.name = modify.name
645
646    if modify.address is not None:
647        dbnode.address = modify.address
648
649    if modify.port is not None:
650        dbnode.port = modify.port
651
652    if modify.status is NodeStatus.disabled:
653        dbnode.status = modify.status
654        dbnode.xray_version = None
655        dbnode.message = None
656    else:
657        dbnode.status = NodeStatus.unhealthy
658
659    if modify.usage_coefficient:
660        dbnode.usage_coefficient = modify.usage_coefficient
661
662    db.commit()
663    db.refresh(dbnode)
664    return dbnode
665
666
667def update_node_status(
668    db: Session,
669    node_id: int,
670    status: NodeStatus,
671    message: str = None,
672    version: str = None,
673):
674    db_node = db.query(Node).where(Node.id == node_id).first()
675    db_node.status = status
676    if message:
677        db_node.message = message
678    db_node.last_status_change = datetime.utcnow()
679    db.commit()
680
681
682def create_notification_reminder(
683    db: Session, reminder_type: ReminderType, expires_at: datetime, user_id: int
684) -> NotificationReminder:
685    reminder = NotificationReminder(
686        type=reminder_type, expires_at=expires_at, user_id=user_id
687    )
688    db.add(reminder)
689    db.commit()
690    db.refresh(reminder)
691    return reminder
692
693
694def get_notification_reminder(
695    db: Session,
696    user_id: int,
697    reminder_type: ReminderType,
698) -> Optional[NotificationReminder]:
699    reminder = (
700        db.query(NotificationReminder)
701        .filter(NotificationReminder.user_id == user_id)
702        .filter(NotificationReminder.type == reminder_type)
703        .first()
704    )
705    if reminder is None:
706        return
707    if reminder.expires_at and reminder.expires_at < datetime.utcnow():
708        db.delete(reminder)
709        db.commit()
710        return
711    return reminder
712
713
714def delete_notification_reminder_by_type(
715    db: Session, user_id: int, reminder_type: ReminderType
716) -> None:
717    """Deletes notification reminder filtered by user_id and type if exists"""
718    stmt = delete(NotificationReminder).where(
719        NotificationReminder.user_id == user_id,
720        NotificationReminder.type == reminder_type,
721    )
722    db.execute(stmt)
723    db.commit()
724    return
725
726
727def delete_notification_reminder(db: Session, dbreminder: NotificationReminder) -> None:
728    db.delete(dbreminder)
729    db.commit()
730    return