ctfd-plugin-webhooks/events.py at main · u-ctf/ctfd-plugin-webhooks · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
from flask import has_request_context, request
from sqlalchemy import event
from sqlalchemy.orm import Session, object_session

from CTFd.models import Fails, Partials, Ratelimiteds, Solves, Users, db

from .dispatch import configure_dispatch, dispatch_pending_events

_EVENTS_REGISTERED = False


def register_event_listeners(app):
    global _EVENTS_REGISTERED

    if _EVENTS_REGISTERED:
        return

    configure_dispatch(app, db)

    event.listen(Solves, "after_insert", _enqueue_solve_event)
    event.listen(Fails, "after_insert", _enqueue_fail_event)
    event.listen(Partials, "after_insert", _enqueue_partial_event)
    event.listen(Ratelimiteds, "after_insert", _enqueue_ratelimited_event)
    event.listen(Users, "after_insert", _enqueue_registration_event)
    event.listen(Session, "after_commit", _after_commit)
    event.listen(Session, "after_rollback", _after_rollback)

    _EVENTS_REGISTERED = True


def _enqueue_solve_event(_mapper, _connection, target):
    _push_pending_event(target, event_type="challenge_solved", record_id=target.id)


def _enqueue_fail_event(_mapper, _connection, target):
    _push_pending_event(target, event_type="failed_flag", record_id=target.id)


def _enqueue_partial_event(_mapper, _connection, target):
    _push_pending_event(target, event_type="challenge_partial", record_id=target.id)


def _enqueue_ratelimited_event(_mapper, _connection, target):
    _push_pending_event(target, event_type="rate_limited", record_id=target.id)


def _enqueue_registration_event(_mapper, _connection, target):
    if not _is_public_registration_request():
        return
    _push_pending_event(target, event_type="new_registration", record_id=target.id)


def _after_commit(session):
    pending_events = session.info.pop("ctfd_plugin_webhooks_pending_events", [])
    if pending_events:
        dispatch_pending_events(pending_events)


def _after_rollback(session):
    session.info.pop("ctfd_plugin_webhooks_pending_events", None)


def _push_pending_event(target, event_type, record_id):
    session = object_session(target)
    if session is None:
        return

    pending_events = session.info.setdefault(
        "ctfd_plugin_webhooks_pending_events", []
    )
    pending_events.append(
        {
            "event_type": event_type,
            "record_id": record_id,
            "base_url": _current_base_url(),
        }
    )


def _is_public_registration_request():
    return has_request_context() and request.endpoint == "auth.register"


def _current_base_url():
    if not has_request_context():
        return None

    base_url = request.host_url.rstrip("/")
    script_root = request.script_root.rstrip("/")
    if script_root:
        base_url = f"{base_url}{script_root}"
    return base_url