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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
"""
Submit a form.
"""
import binascii
import hashlib
import uuid
from typing import Any, Optional
import httpx
from pydantic import ValidationError
from pydantic.main import BaseModel
from spectree import Response
from starlette.background import BackgroundTask
from starlette.requests import Request
from starlette.responses import JSONResponse
from backend.constants import FRONTEND_URL, FormFeatures, HCAPTCHA_API_SECRET
from backend.models import Form, FormResponse
from backend.route import Route
from backend.routes.forms.unittesting import execute_unittest
from backend.validation import AuthorizationHeaders, ErrorMessage, api
HCAPTCHA_VERIFY_URL = "https://hcaptcha.com/siteverify"
HCAPTCHA_HEADERS = {
"Content-Type": "application/x-www-form-urlencoded"
}
class SubmissionResponse(BaseModel):
form: Form
response: FormResponse
class PartialSubmission(BaseModel):
response: dict[str, Any]
captcha: Optional[str]
class SubmitForm(Route):
"""
Submit a form with the provided form ID.
"""
name = "submit_form"
path = "/submit/{form_id:str}"
@api.validate(
json=PartialSubmission,
resp=Response(
HTTP_200=SubmissionResponse,
HTTP_404=ErrorMessage,
HTTP_400=ErrorMessage
),
headers=AuthorizationHeaders,
tags=["forms", "responses"]
)
async def post(self, request: Request) -> JSONResponse:
"""Submit a response to the form."""
data = await request.json()
data["timestamp"] = None
if form := await request.state.db.forms.find_one(
{"_id": request.path_params["form_id"], "features": "OPEN"}
):
form = Form(**form)
response = data.copy()
response["id"] = str(uuid.uuid4())
response["form_id"] = form.id
if FormFeatures.DISABLE_ANTISPAM.value not in form.features:
ip_hash_ctx = hashlib.md5()
ip_hash_ctx.update(request.client.host.encode())
ip_hash = binascii.hexlify(ip_hash_ctx.digest())
user_agent_hash_ctx = hashlib.md5()
user_agent_hash_ctx.update(request.headers["User-Agent"].encode())
user_agent_hash = binascii.hexlify(user_agent_hash_ctx.digest())
async with httpx.AsyncClient() as client:
query_params = {
"secret": HCAPTCHA_API_SECRET,
"response": data.get("captcha")
}
r = await client.post(
HCAPTCHA_VERIFY_URL,
params=query_params,
headers=HCAPTCHA_HEADERS
)
r.raise_for_status()
captcha_data = r.json()
response["antispam"] = {
"ip_hash": ip_hash.decode(),
"user_agent_hash": user_agent_hash.decode(),
"captcha_pass": captcha_data["success"]
}
if FormFeatures.REQUIRES_LOGIN.value in form.features:
if request.user.is_authenticated:
response["user"] = request.user.payload
if (
FormFeatures.COLLECT_EMAIL.value in form.features
and "email" not in response["user"]
):
return JSONResponse({
"error": "email_required"
}, status_code=400)
else:
return JSONResponse({
"error": "missing_discord_data"
}, status_code=400)
missing_fields = []
for question in form.questions:
if question.id not in response["response"]:
if not question.required:
response["response"][question.id] = None
else:
missing_fields.append(question.id)
if missing_fields:
return JSONResponse({
"error": "missing_fields",
"fields": missing_fields
}, status_code=400)
try:
response_obj = FormResponse(**response)
except ValidationError as e:
return JSONResponse(e.errors(), status_code=422)
# Run unittests if needed
if any("unittests" in question.data for question in form.questions):
unittest_results = await execute_unittest(response_obj, form)
if not all(test.passed for test in unittest_results):
# Return 500 if we encountered an internal error (code 99).
status_code = 500 if any(
test.return_code == 99 for test in unittest_results
) else 403
return JSONResponse({
"error": "failed_tests",
"test_results": [
test._asdict() for test in unittest_results if not test.passed
]
}, status_code=status_code)
await request.state.db.responses.insert_one(
response_obj.dict(by_alias=True)
)
send_webhook = None
if FormFeatures.WEBHOOK_ENABLED.value in form.features:
send_webhook = BackgroundTask(
self.send_submission_webhook,
form=form,
response=response_obj,
request_user=request.user
)
return JSONResponse({
"form": form.dict(admin=False),
"response": response_obj.dict()
}, background=send_webhook)
else:
return JSONResponse({
"error": "Open form not found"
}, status_code=404)
@staticmethod
async def send_submission_webhook(
form: Form,
response: FormResponse,
request_user: Request.user
) -> None:
"""Helper to send a submission message to a discord webhook."""
# Stop if webhook is not available
if form.webhook is None:
raise ValueError("Got empty webhook.")
try:
mention = request_user.discord_mention
except AttributeError:
mention = "User"
user = response.user
# Build Embed
embed = {
"title": "New Form Response",
"description": f"{mention} submitted a response to `{form.name}`.",
"url": f"{FRONTEND_URL}/path_to_view_form/{response.id}", # TODO: Enter Form View URL
"timestamp": response.timestamp,
"color": 7506394,
}
# Add author to embed
if request_user.is_authenticated:
embed["author"] = {"name": request_user.display_name}
if user and user.avatar:
url = f"https://cdn.discordapp.com/avatars/{user.id}/{user.avatar}.png"
embed["author"]["icon_url"] = url
# Build Hook
hook = {
"embeds": [embed],
"allowed_mentions": {"parse": ["users", "roles"]},
"username": form.name or "Python Discord Forms"
}
# Set hook message
message = form.webhook.message
if message:
# Available variables, see SCHEMA.md
ctx = {
"user": mention,
"response_id": response.id,
"form": form.name,
"form_id": form.id,
"time": response.timestamp,
}
for key in ctx:
message = message.replace(f"{{{key}}}", str(ctx[key]))
hook["content"] = message.replace("_USER_MENTION_", mention)
# Post hook
async with httpx.AsyncClient() as client:
r = await client.post(form.webhook.url, json=hook)
r.raise_for_status()
|
