Mawoka
272 lines
7.8 KiB
Python
272 lines
7.8 KiB
Python
# This Source Code Form is subject to the terms of the Mozilla Public
|
|
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
# file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
|
import os
|
|
import re
|
|
import uuid
|
|
from datetime import datetime
|
|
from typing import Optional
|
|
|
|
import ormar
|
|
from pydantic import BaseModel, Json, validator
|
|
from enum import Enum
|
|
from . import metadata, database
|
|
from ..config import server_regex
|
|
|
|
|
|
class UserAuthTypes(Enum):
|
|
LOCAL = "LOCAL"
|
|
GOOGLE = "GOOGLE"
|
|
GITHUB = "GITHUB"
|
|
|
|
|
|
class User(ormar.Model):
|
|
"""
|
|
The user model in the database
|
|
"""
|
|
|
|
id: uuid.UUID = ormar.UUID(primary_key=True, default=uuid.uuid4())
|
|
email: str = ormar.String(unique=True, max_length=100)
|
|
username: str = ormar.String(unique=True, max_length=100)
|
|
password: Optional[str] = ormar.String(max_length=100, nullable=True)
|
|
verified: bool = ormar.Boolean(default=False)
|
|
verify_key: str = ormar.String(unique=True, max_length=100, nullable=True)
|
|
created_at: datetime = ormar.DateTime(default=datetime.now())
|
|
auth_type: UserAuthTypes = ormar.Enum(enum_class=UserAuthTypes, default=UserAuthTypes.LOCAL)
|
|
google_uid: Optional[str] = ormar.String(unique=True, max_length=255, nullable=True)
|
|
avatar: bytes = ormar.LargeBinary(max_length=25000, represent_as_base64_str=True)
|
|
github_user_id: int | None = ormar.Integer(nullable=True)
|
|
require_password: bool = ormar.Boolean(default=True, nullable=False)
|
|
backup_code: str = ormar.String(max_length=64, min_length=64, nullable=False, default=os.urandom(32).hex())
|
|
totp_secret: str = ormar.String(max_length=32, min_length=32, nullable=True, default=None)
|
|
|
|
class Meta:
|
|
tablename = "users"
|
|
metadata = metadata
|
|
database = database
|
|
|
|
class Config:
|
|
use_enum_values = True
|
|
|
|
|
|
class FidoCredentials(ormar.Model):
|
|
pk: int = ormar.Integer(autoincrement=True, primary_key=True)
|
|
id: bytes = ormar.LargeBinary(max_length=256)
|
|
public_key: bytes = ormar.LargeBinary(max_length=256)
|
|
sign_count: int = ormar.Integer()
|
|
user: Optional[User] = ormar.ForeignKey(User)
|
|
|
|
class Meta:
|
|
tablename = "fido_credentials"
|
|
metadata = metadata
|
|
database = database
|
|
|
|
|
|
class ApiKey(ormar.Model):
|
|
key: str = ormar.String(max_length=48, min_length=48, primary_key=True)
|
|
user: Optional[User] = ormar.ForeignKey(User)
|
|
|
|
class Meta:
|
|
tablename = "api_keys"
|
|
metadata = metadata
|
|
database = database
|
|
|
|
|
|
class UserSession(ormar.Model):
|
|
"""
|
|
The user session model for user-sessions
|
|
"""
|
|
|
|
id: uuid.UUID = ormar.UUID(primary_key=True, default=uuid.uuid4())
|
|
user: Optional[User] = ormar.ForeignKey(User)
|
|
session_key: str = ormar.String(unique=True, max_length=64)
|
|
created_at: datetime = ormar.DateTime(default=datetime.now())
|
|
ip_address: str = ormar.String(max_length=100, nullable=True)
|
|
user_agent: str = ormar.String(max_length=255, nullable=True)
|
|
last_seen: datetime = ormar.DateTime(default=datetime.now())
|
|
|
|
class Meta:
|
|
tablename = "user_sessions"
|
|
metadata = metadata
|
|
database = database
|
|
|
|
|
|
class ABCDQuizAnswer(BaseModel):
|
|
right: bool
|
|
answer: str
|
|
color: str | None
|
|
|
|
|
|
class RangeQuizAnswer(BaseModel):
|
|
min: int
|
|
max: int
|
|
min_correct: int
|
|
max_correct: int
|
|
|
|
|
|
class VotingQuizAnswer(BaseModel):
|
|
answer: str
|
|
image: str | None = None
|
|
color: str | None
|
|
|
|
|
|
class QuizQuestionType(str, Enum):
|
|
ABCD = "ABCD"
|
|
RANGE = "RANGE"
|
|
VOTING = "VOTING"
|
|
SLIDE = "SLIDE"
|
|
TEXT = "TEXT"
|
|
|
|
|
|
class TextQuizAnswer(BaseModel):
|
|
answer: str
|
|
case_sensitive: bool
|
|
|
|
|
|
class QuizQuestion(BaseModel):
|
|
question: str
|
|
time: str # in Secs
|
|
type: None | QuizQuestionType = QuizQuestionType.ABCD
|
|
answers: list[ABCDQuizAnswer] | RangeQuizAnswer | list[TextQuizAnswer] | list[VotingQuizAnswer] | str
|
|
image: str | None = None
|
|
|
|
@validator("answers")
|
|
def answers_not_none_if_abcd_type(cls, v, values):
|
|
if values["type"] == QuizQuestionType.ABCD and type(v[0]) != ABCDQuizAnswer:
|
|
raise ValueError("Answers can't be none if type is ABCD")
|
|
if values["type"] == QuizQuestionType.RANGE and type(v) != RangeQuizAnswer:
|
|
raise ValueError("Answer must be from type RangeQuizAnswer if type is RANGE")
|
|
if values["type"] == QuizQuestionType.VOTING and type(v[0]) != VotingQuizAnswer:
|
|
raise ValueError("Answer must be from type VotingQuizAnswer if type is VOTING")
|
|
if values["type"] == QuizQuestionType.TEXT and type(v[0]) != TextQuizAnswer:
|
|
raise ValueError("Answer must be from type TextQuizAnswer if type is TEXT")
|
|
if values["type"] == QuizQuestionType.SLIDE and type(v[0]) != str:
|
|
raise ValueError("Answer must be from type SlideElement if type is SLIDE")
|
|
return v
|
|
|
|
|
|
class QuizInput(BaseModel):
|
|
public: bool = False
|
|
title: str
|
|
description: str
|
|
cover_image: str | None
|
|
background_color: str | None
|
|
questions: list[QuizQuestion]
|
|
background_image: str | None
|
|
|
|
@validator("background_image")
|
|
def must_come_from_local_cdn(cls, v):
|
|
if v is None:
|
|
return v
|
|
elif bool(re.match(server_regex, v)):
|
|
return v
|
|
else:
|
|
raise ValueError("does not match url scheme")
|
|
|
|
|
|
class Quiz(ormar.Model):
|
|
id: uuid.UUID = ormar.UUID(primary_key=True, default=uuid.uuid4(), nullable=False, unique=True)
|
|
public: bool = ormar.Boolean(default=False)
|
|
title: str = ormar.Text()
|
|
description: str = ormar.Text(nullable=True)
|
|
created_at: datetime = ormar.DateTime(default=datetime.now())
|
|
updated_at: datetime = ormar.DateTime(default=datetime.now())
|
|
user_id: uuid.UUID = ormar.ForeignKey(User)
|
|
questions: Json[list[QuizQuestion]] = ormar.JSON(nullable=False)
|
|
imported_from_kahoot: Optional[bool] = ormar.Boolean(default=False, nullable=True)
|
|
cover_image: Optional[str] = ormar.Text(nullable=True, unique=False)
|
|
background_color: str | None = ormar.Text(nullable=True, unique=False)
|
|
background_image: str | None = ormar.Text(nullable=True, unique=False)
|
|
|
|
@validator("background_image")
|
|
def must_come_from_local_cdn(cls, v):
|
|
if v is None:
|
|
return v
|
|
elif bool(re.match(server_regex, v)):
|
|
return v
|
|
else:
|
|
raise ValueError("does not match url scheme")
|
|
|
|
class Meta:
|
|
tablename = "quiz"
|
|
metadata = metadata
|
|
database = database
|
|
|
|
|
|
class InstanceData(ormar.Model):
|
|
instance_id: uuid.UUID = ormar.UUID(primary_key=True, default=uuid.uuid4(), nullable=False, unique=True)
|
|
|
|
class Meta:
|
|
tablename = "instance_data"
|
|
metadata = metadata
|
|
database = database
|
|
|
|
|
|
class Token(BaseModel):
|
|
"""
|
|
For JWT
|
|
"""
|
|
|
|
access_token: str
|
|
token_type: str
|
|
|
|
|
|
class TokenData(BaseModel):
|
|
"""
|
|
For JWT
|
|
"""
|
|
|
|
email: str | None = None
|
|
|
|
|
|
class PlayGame(BaseModel):
|
|
quiz_id: uuid.UUID | str
|
|
description: str
|
|
user_id: uuid.UUID
|
|
title: str
|
|
questions: list[QuizQuestion]
|
|
game_id: uuid.UUID
|
|
game_pin: str
|
|
started: bool = False
|
|
captcha_enabled: bool = False
|
|
cover_image: str | None
|
|
game_mode: str | None
|
|
current_question: int = -1
|
|
background_color: str | None
|
|
background_image: str | None
|
|
custom_field: str | None
|
|
|
|
|
|
class GamePlayer(BaseModel):
|
|
username: str
|
|
sid: str
|
|
|
|
|
|
class GameAnswer2(BaseModel):
|
|
username: str
|
|
right: bool
|
|
answer: str
|
|
|
|
|
|
class GameAnswer1(BaseModel):
|
|
id: int
|
|
answers: list[GameAnswer2]
|
|
|
|
|
|
class GameSession(BaseModel):
|
|
admin: str
|
|
game_id: str
|
|
# players: list[GamePlayer | None]
|
|
answers: list[GameAnswer1 | None]
|
|
|
|
|
|
class UpdatePassword(BaseModel):
|
|
old_password: str
|
|
new_password: str
|
|
|
|
|
|
class GameInLobby(BaseModel):
|
|
game_pin: str
|
|
quiz_title: str
|
|
game_id: uuid.UUID
|