Miguel Barão · Miguel Barão · Miguel Barão · Miguel Barão
Showing 9 changed files Show diff stats
.gitignore
perguntations/TODO
perguntations/__init__.py
perguntations/app.py
perguntations/initdb.py
perguntations/models.py
perguntations/serve.py
perguntations/testfactory.py
setup.py
+# ignore virtual environment
+.venv
+
 __pycache__/
 .DS_Store
 demo/ans
@@ -0,0 +1,17 @@
+# TODO
+
+- opcao correct de testes que nao foram corrigidos automaticamente.
+- tests should store identification of the perguntations version.
+- detailed CSV devia ter as refs das perguntas e so preencher as que o aluno respondeu.
+- long pooling admin
+- student sends updated answers
+- questions with parts
+
+
+---- Estados -----
+
+inicialização (sincrona)
+    test factory
+    database setup: define lista de estudantes com teste=None
+    login admin:
+        gera todos os testes para os alunos na lista
@@ -21,7 +21,7 @@
 # SOFTWARE.
-"""A webserver for running tests in class
+'''A webserver for running tests in class
 perguntations is a webserver that is intended to be run in an isolated
 local network in classroom environment.
@@ -29,13 +29,13 @@ The server will run a preconfigured test and serve the test as a web form.
 The answers submitted by the students are immediatly checked and classified.
 The grades are stored in a database and the tests are stored in JSON files as
 proof of submission and for review.
-"""
+'''
-APP_NAME = "perguntations"
-APP_VERSION = "2022.04.dev1"
+APP_NAME = 'perguntations'
+APP_VERSION = '2024.07.dev1'
 APP_DESCRIPTION = str(__doc__)
-__author__ = "Miguel Barão"
-__copyright__ = "Copyright 2022, Miguel Barão"
-__license__ = "MIT license"
+__author__ = 'Miguel Barão'
+__copyright__ = 'Copyright 2024, Miguel Barão'
+__license__ = 'MIT license'
 __version__ = APP_VERSION
@@ -14,7 +14,7 @@ import os
 from typing import Optional
 # installed packages
-import bcrypt
+import argon2
 from sqlalchemy import create_engine, select
 from sqlalchemy.exc import OperationalError, NoResultFound, IntegrityError
 from sqlalchemy.orm import Session
@@ -30,21 +30,24 @@ from .questions import question_from
 # setup logger for this module
 logger = logging.getLogger(__name__)
+# ============================================================================
+ph = argon2.PasswordHasher()
-async def check_password(password: str, hashed: bytes) -> bool:
+async def check_password(password: str, hashed: str) -> bool:
     """check password in executor"""
     loop = asyncio.get_running_loop()
-    return await loop.run_in_executor(
-        None, bcrypt.checkpw, password.encode("utf-8"), hashed
-    )
-
-
-async def hash_password(password: str) -> bytes:
+    try:
+        return await loop.run_in_executor(None, ph.verify, hashed, password)
+    except argon2.exceptions.VerifyMismatchError:
+        return False
+    except Exception:
+        logger.error('Unkown error while verifying password')
+        return False
+
+async def hash_password(password: str) -> str:
     """get hash for password"""
     loop = asyncio.get_running_loop()
-    return await loop.run_in_executor(
-        None, bcrypt.hashpw, password.encode("utf-8"), bcrypt.gensalt()
-    )
+    return await loop.run_in_executor(None, ph.hash, password)
 # ============================================================================
@@ -66,7 +69,7 @@ class App:
         self._make_test_factory(config["testfile"])
         self._db_setup()  # setup engine and load all students
-        # FIXME get_event_loop will be deprecated in python3.10
+        # FIXME: get_event_loop will be deprecated in python3.
         asyncio.get_event_loop().run_until_complete(self._assign_tests())
         # command line options:  --allow-all, --allow-list filename
@@ -9,10 +9,9 @@ import csv
 import argparse
 import re
 from string import capwords
-from concurrent.futures import ThreadPoolExecutor
 # installed packages
-import bcrypt
+from argon2 import PasswordHasher
 from sqlalchemy import create_engine, select
 from sqlalchemy.orm import Session
 from sqlalchemy.exc import IntegrityError
@@ -80,7 +79,7 @@ def parse_commandline_arguments():
 # ============================================================================
-def get_students_from_csv(filename):
+def get_students_from_csv(filename: str):
     """
     SIIUE names have alien strings like "(TE)" and are sometimes capitalized
     We remove them so that students dont keep asking what it means
@@ -111,17 +110,6 @@ def get_students_from_csv(filename):
     return students
-# ============================================================================
-def hashpw(student, password=None) -> None:
-    """replace password by hash for a single student"""
-    print(".", end="", flush=True)
-    if password is None:
-        student["pw"] = ""
-    else:
-        student["pw"] = bcrypt.hashpw(password.encode("utf-8"), bcrypt.gensalt())
-
-
-# ============================================================================
 def insert_students_into_db(session, students) -> None:
     """insert list of students into the database"""
     try:
@@ -129,7 +117,6 @@ def insert_students_into_db(session, students) -&gt; None:
             [Student(id=s["uid"], name=s["name"], password=s["pw"]) for s in students]
         )
         session.commit()
-
     except IntegrityError:
         print("!!! Integrity error. Users already in database. Aborted !!!\n")
         session.rollback()
@@ -139,7 +126,6 @@ def insert_students_into_db(session, students) -&gt; None:
 def show_students_in_database(session, verbose=False):
     """get students from database"""
     users = session.execute(select(Student)).scalars().all()
-    # users = session.query(Student).all()
     total = len(users)
     print("Registered users:")
@@ -165,15 +151,16 @@ def show_students_in_database(session, verbose=False):
 def main():
     """insert, update, show students from database"""
+    ph = PasswordHasher()
     args = parse_commandline_arguments()
     # --- database
     print(f"Database: {args.db}")
     engine = create_engine(f"sqlite:///{args.db}", echo=False, future=True)
     Base.metadata.create_all(engine)  # Criates schema if needed
-    session = Session(engine, future=True)
+    session = Session(engine, future=True) # FIXME: future?
-    # --- make list of students to insert
+    # --- build list of new students to insert
     students = []
     if args.admin:
@@ -191,35 +178,45 @@ def main():
     # --- insert new students
     if students:
-        print("Generating password hashes", end="")
-        with ThreadPoolExecutor() as executor:  # hashing
-            executor.map(lambda s: hashpw(s, args.pw), students)
-        print(f"\nInserting {len(students)}")
+        if args.pw is None:
+            print('Set passwords to empty')
+            for s in students:
+                s['pw'] = ''
+        else:
+            print('Generating password hashes')
+            for s in students:
+                s['pw'] = ph.hash(args.pw)
+                print('.', end='', flush=True)
+        print(f'\nInserting {len(students)}')
         insert_students_into_db(session, students)
     # --- update all students
     if args.update_all:
-        all_students = (
-            session.execute(select(Student).where(Student.id != "0")).scalars().all()
-        )
-
-        print(f"Updating password of {len(all_students)} users", end="")
-        for student in all_students:
-            password = (args.pw or student.id).encode("utf-8")
-            student.password = bcrypt.hashpw(password, bcrypt.gensalt())
-            print(".", end="", flush=True)
-        print()
+        query = select(Student).where(Student.id != '0')
+        all_students = session.execute(query).scalars().all()
+        if args.pw is None:
+            print(f'Resetting password of {len(all_students)} users')
+            for student in all_students:
+                student.password = ''
+        else:
+            print(f'Updating password of {len(all_students)} users')
+            for student in all_students:
+                student.password = ph.hash(args.pw)
+                print('.', end='', flush=True)
+            print()
         session.commit()
-    # --- update some students
+    # --- update only specified students
     else:
         for student_id in args.update:
-            print(f"Updating password of {student_id}")
-            student = session.execute(
-                select(Student).where(Student.id == student_id)
-            ).scalar_one()
-            new_password = (args.pw or student_id).encode("utf-8")
-            student.password = bcrypt.hashpw(new_password, bcrypt.gensalt())
+            query = select(Student).where(Student.id == student_id)
+            student = session.execute(query).scalar_one()
+            if args.pw is None:
+                print(f'Resetting password of user {student_id}')
+                student.password = ''
+            else:
+                print(f'Updating password of user {student_id}')
+                student.password = ph.hash(args.pw)
         session.commit()
     show_students_in_database(session, args.verbose)
@@ -3,100 +3,59 @@ perguntations/models.py
 SQLAlchemy ORM
 """
-from typing import Any
+from typing import List
-from sqlalchemy import Column, ForeignKey, Integer, Float, String
-from sqlalchemy.orm import declarative_base, relationship
+from sqlalchemy import ForeignKey, Integer, String
+from sqlalchemy.orm import DeclarativeBase, Mapped, relationship, mapped_column
-# FIXME Any is a workaround for static type checking
-# (https://github.com/python/mypy/issues/6372)
-Base: Any = declarative_base()
+class Base(DeclarativeBase):
+    pass
+# [Student] ---1:N--- [Test] ---1:N--- [Question]
+
 # ----------------------------------------------------------------------------
 class Student(Base):
-    """Student table"""
-
-    __tablename__ = "students"
-    id = Column(String, primary_key=True)
-    name = Column(String)
-    password = Column(String)
+    __tablename__ = 'students'
+    id = mapped_column(String, primary_key=True)
+    name: Mapped[str]
+    password: Mapped[str]
     # ---
-    tests = relationship("Test", back_populates="student")
-
-    def __repr__(self):
-        return (
-            f"Student("
-            f"id={self.id!r}, "
-            f"name={self.name!r}, "
-            f"password={self.password!r})"
-        )
-
+    tests: Mapped[List['Test']] = relationship(back_populates='student')
 # ----------------------------------------------------------------------------
 class Test(Base):
-    """Test table"""
-
-    __tablename__ = "tests"
-    id = Column(Integer, primary_key=True)  # auto_increment
-    ref = Column(String)
-    title = Column(String)
-    grade = Column(Float)
-    state = Column(String)  # ACTIVE, SUBMITTED, CORRECTED, QUIT, NULL
-    comment = Column(String)
-    starttime = Column(String)
-    finishtime = Column(String)
-    filename = Column(String)
-    student_id = Column(String, ForeignKey("students.id"))
-
+    __tablename__ = 'tests'
+
+    id = mapped_column(Integer, primary_key=True)  # auto_increment
+    ref: Mapped[str]
+    title: Mapped[str]
+    grade: Mapped[float]
+    state: Mapped[str]  # ACTIVE, SUBMITTED, CORRECTED, QUIT, NULL
+    comment: Mapped[str]
+    starttime: Mapped[str]
+    finishtime: Mapped[str]
+    filename: Mapped[str]
+    student_id = mapped_column(String, ForeignKey('students.id'))
     # ---
-    student = relationship("Student", back_populates="tests")
-    questions = relationship("Question", back_populates="test")
-
-    def __repr__(self):
-        return (
-            f"Test("
-            f"id={self.id!r}, "
-            f"ref={self.ref!r}, "
-            f"title={self.title!r}, "
-            f"grade={self.grade!r}, "
-            f"state={self.state!r}, "
-            f"comment={self.comment!r}, "
-            f"starttime={self.starttime!r}, "
-            f"finishtime={self.finishtime!r}, "
-            f"filename={self.filename!r}, "
-            f"student_id={self.student_id!r})"
-        )
+    student: Mapped['Student'] = relationship(back_populates='tests')
+    questions: Mapped[List['Question']] = relationship(back_populates='test')
 # ---------------------------------------------------------------------------
 class Question(Base):
-    """Question table"""
-
-    __tablename__ = "questions"
-    id = Column(Integer, primary_key=True)  # auto_increment
-    number = Column(Integer)  # question number (ref may be not be unique)
-    ref = Column(String)
-    grade = Column(Float)
-    comment = Column(String)
-    starttime = Column(String)
-    finishtime = Column(String)
-    test_id = Column(String, ForeignKey("tests.id"))
-
+    __tablename__ = 'questions'
+
+    id = mapped_column(Integer, primary_key=True)  # auto_increment
+    number: Mapped[int] # question number (ref may be repeated in the same test)
+    ref: Mapped[str]
+    grade: Mapped[float]
+    comment: Mapped[str]
+    starttime: Mapped[str]
+    finishtime: Mapped[str]
+    test_id = mapped_column(String, ForeignKey('tests.id'))
     # ---
-    test = relationship("Test", back_populates="questions")
-    def __repr__(self):
-        return (
-            f"Question("
-            f"id={self.id!r}, "
-            f"number={self.number!r}, "
-            f"ref={self.ref!r}, "
-            f"grade={self.grade!r}, "
-            f"comment={self.comment!r}, "
-            f"starttime={self.starttime!r}, "
-            f"finishtime={self.finishtime!r}, "
-            f"test_id={self.test_id!r})"
-        )
+    test: Mapped['Test'] = relationship(back_populates='questions')
-#!/usr/bin/env python3
 """
 Handles the web, http & html part of the application interface.
@@ -21,9 +20,7 @@ from typing import Dict, Tuple
 import uuid
 # user installed libraries
-import tornado.ioloop
-import tornado.web
-import tornado.httpserver
+import tornado
 # this project
 from .parser_markdown import md_to_html
@@ -262,7 +259,7 @@ class RootHandler(BaseHandler):
 # ----------------------------------------------------------------------------
 # pylint: disable=abstract-method
-# FIXME also to update answers
+# FIXME: also to update answers
 class StudentWebservice(BaseHandler):
     """
     Receive ajax from students during the test in response to the events
@@ -66,7 +66,7 @@ test_schema = schema.Schema(
     },
     ignore_extra_keys=True,
 )
-# FIXME schema error with 'testfile' which is added in the code
+# FIXME: schema error with 'testfile' which is added in the code
 # ============================================================================
 class TestFactoryException(Exception):
@@ -105,7 +105,7 @@ class TestFactory(dict):
         normalize_question_list(self["questions"])
         # --- for review, we are done. no factories needed
-        # if self['review']:  FIXME
+        # if self['review']:  FIXME:
         #     logger.info('Review mode. No questions loaded. No factories.')
         #     return
@@ -267,7 +267,7 @@ class TestFactory(dict):
         checks if questions can be correctly generated and corrected
         """
         logger.info("Checking questions...")
-        # FIXME get_event_loop will be deprecated in python3.10
+        # FIXME: get_event_loop will be deprecated in python3.10
         loop = asyncio.get_event_loop()
         for i, (qref, qfact) in enumerate(self["question_factory"].items()):
             try:
@@ -22,15 +22,15 @@ setup(
     url="https://git.xdi.uevora.pt/mjsb/perguntations.git",
     packages=find_packages(),
     include_package_data=True,   # install files from MANIFEST.in
-    python_requires='>=3.8.*',
+    python_requires='>=3.9',
     install_requires=[
-        'bcrypt>=3.1',
+        'argon2-cffi>=23.1',
         'mistune<2.0',
         'pyyaml>=5.1',
         'pygments',
         'schema>=0.7.5',
-        'sqlalchemy>=1.4',
-        'tornado>=6.1',
+        'sqlalchemy>=2.0',
+        'tornado>=6.4',
         ],
     entry_points={
         'console_scripts': [
		1	+# ignore virtual environment
		2	+.venv
		3	+
1	__pycache__/	4	__pycache__/
2	.DS_Store	5	.DS_Store
3	demo/ans	6	demo/ans
@@ -0,0 +1,17 @@		@@ -0,0 +1,17 @@
	1	+# TODO
	2	+
	3	+- opcao correct de testes que nao foram corrigidos automaticamente.
	4	+- tests should store identification of the perguntations version.
	5	+- detailed CSV devia ter as refs das perguntas e so preencher as que o aluno respondeu.
	6	+- long pooling admin
	7	+- student sends updated answers
	8	+- questions with parts
	9	+
	10	+
	11	+---- Estados -----
	12	+
	13	+inicialização (sincrona)
	14	+ test factory
	15	+ database setup: define lista de estudantes com teste=None
	16	+ login admin:
	17	+ gera todos os testes para os alunos na lista
	@@ -3,100 +3,59 @@ perguntations/models.py		@@ -3,100 +3,59 @@ perguntations/models.py
3	SQLAlchemy ORM	3	SQLAlchemy ORM
4	"""	4	"""
5		5
6	-from typing import Any	6	+from typing import List
7		7
8	-from sqlalchemy import Column, ForeignKey, Integer, Float, String
9	-from sqlalchemy.orm import declarative_base, relationship	8	+from sqlalchemy import ForeignKey, Integer, String
		9	+from sqlalchemy.orm import DeclarativeBase, Mapped, relationship, mapped_column
10		10
11		11
12	-# FIXME Any is a workaround for static type checking
13	-# (https://github.com/python/mypy/issues/6372)
14	-Base: Any = declarative_base()	12	+class Base(DeclarativeBase):
		13	+ pass
15		14
16		15
		16	+# [Student] ---1:N--- [Test] ---1:N--- [Question]
		17	+
17	# ----------------------------------------------------------------------------	18	# ----------------------------------------------------------------------------
18	class Student(Base):	19	class Student(Base):
19	- """Student table"""
20	-
21	- __tablename__ = "students"
22	- id = Column(String, primary_key=True)
23	- name = Column(String)
24	- password = Column(String)	20	+ __tablename__ = 'students'
25		21
		22	+ id = mapped_column(String, primary_key=True)
		23	+ name: Mapped[str]
		24	+ password: Mapped[str]
26	# ---	25	# ---
27	- tests = relationship("Test", back_populates="student")
28	-
29	- def __repr__(self):
30	- return (
31	- f"Student("
32	- f"id={self.id!r}, "
33	- f"name={self.name!r}, "
34	- f"password={self.password!r})"
35	- )
36	-	26	+ tests: Mapped[List['Test']] = relationship(back_populates='student')
37		27
38	# ----------------------------------------------------------------------------	28	# ----------------------------------------------------------------------------
39	class Test(Base):	29	class Test(Base):
40	- """Test table"""
41	-
42	- __tablename__ = "tests"
43	- id = Column(Integer, primary_key=True) # auto_increment
44	- ref = Column(String)
45	- title = Column(String)
46	- grade = Column(Float)
47	- state = Column(String) # ACTIVE, SUBMITTED, CORRECTED, QUIT, NULL
48	- comment = Column(String)
49	- starttime = Column(String)
50	- finishtime = Column(String)
51	- filename = Column(String)
52	- student_id = Column(String, ForeignKey("students.id"))
53	-	30	+ __tablename__ = 'tests'
		31	+
		32	+ id = mapped_column(Integer, primary_key=True) # auto_increment
		33	+ ref: Mapped[str]
		34	+ title: Mapped[str]
		35	+ grade: Mapped[float]
		36	+ state: Mapped[str] # ACTIVE, SUBMITTED, CORRECTED, QUIT, NULL
		37	+ comment: Mapped[str]
		38	+ starttime: Mapped[str]
		39	+ finishtime: Mapped[str]
		40	+ filename: Mapped[str]
		41	+ student_id = mapped_column(String, ForeignKey('students.id'))
54	# ---	42	# ---
55	- student = relationship("Student", back_populates="tests")
56	- questions = relationship("Question", back_populates="test")
57	-
58	- def __repr__(self):
59	- return (
60	- f"Test("
61	- f"id={self.id!r}, "
62	- f"ref={self.ref!r}, "
63	- f"title={self.title!r}, "
64	- f"grade={self.grade!r}, "
65	- f"state={self.state!r}, "
66	- f"comment={self.comment!r}, "
67	- f"starttime={self.starttime!r}, "
68	- f"finishtime={self.finishtime!r}, "
69	- f"filename={self.filename!r}, "
70	- f"student_id={self.student_id!r})"
71	- )
72		43
		44	+ student: Mapped['Student'] = relationship(back_populates='tests')
		45	+ questions: Mapped[List['Question']] = relationship(back_populates='test')
73		46
74	# ---------------------------------------------------------------------------	47	# ---------------------------------------------------------------------------
75	class Question(Base):	48	class Question(Base):
76	- """Question table"""
77	-
78	- __tablename__ = "questions"
79	- id = Column(Integer, primary_key=True) # auto_increment
80	- number = Column(Integer) # question number (ref may be not be unique)
81	- ref = Column(String)
82	- grade = Column(Float)
83	- comment = Column(String)
84	- starttime = Column(String)
85	- finishtime = Column(String)
86	- test_id = Column(String, ForeignKey("tests.id"))
87	-	49	+ __tablename__ = 'questions'
		50	+
		51	+ id = mapped_column(Integer, primary_key=True) # auto_increment
		52	+ number: Mapped[int] # question number (ref may be repeated in the same test)
		53	+ ref: Mapped[str]
		54	+ grade: Mapped[float]
		55	+ comment: Mapped[str]
		56	+ starttime: Mapped[str]
		57	+ finishtime: Mapped[str]
		58	+ test_id = mapped_column(String, ForeignKey('tests.id'))
88	# ---	59	# ---
89	- test = relationship("Test", back_populates="questions")
90		60
91	- def __repr__(self):
92	- return (
93	- f"Question("
94	- f"id={self.id!r}, "
95	- f"number={self.number!r}, "
96	- f"ref={self.ref!r}, "
97	- f"grade={self.grade!r}, "
98	- f"comment={self.comment!r}, "
99	- f"starttime={self.starttime!r}, "
100	- f"finishtime={self.finishtime!r}, "
101	- f"test_id={self.test_id!r})"
102	- )	61	+ test: Mapped['Test'] = relationship(back_populates='questions')
	@@ -66,7 +66,7 @@ test_schema = schema.Schema(		@@ -66,7 +66,7 @@ test_schema = schema.Schema(
66	},	66	},
67	ignore_extra_keys=True,	67	ignore_extra_keys=True,
68	)	68	)
69	-# FIXME schema error with 'testfile' which is added in the code	69	+# FIXME: schema error with 'testfile' which is added in the code
70		70
71	# ============================================================================	71	# ============================================================================
72	class TestFactoryException(Exception):	72	class TestFactoryException(Exception):
	@@ -105,7 +105,7 @@ class TestFactory(dict):		@@ -105,7 +105,7 @@ class TestFactory(dict):
105	normalize_question_list(self["questions"])	105	normalize_question_list(self["questions"])
106		106
107	# --- for review, we are done. no factories needed	107	# --- for review, we are done. no factories needed
108	- # if self['review']: FIXME	108	+ # if self['review']: FIXME:
109	# logger.info('Review mode. No questions loaded. No factories.')	109	# logger.info('Review mode. No questions loaded. No factories.')
110	# return	110	# return
111		111
	@@ -267,7 +267,7 @@ class TestFactory(dict):		@@ -267,7 +267,7 @@ class TestFactory(dict):
267	checks if questions can be correctly generated and corrected	267	checks if questions can be correctly generated and corrected
268	"""	268	"""
269	logger.info("Checking questions...")	269	logger.info("Checking questions...")
270	- # FIXME get_event_loop will be deprecated in python3.10	270	+ # FIXME: get_event_loop will be deprecated in python3.10
271	loop = asyncio.get_event_loop()	271	loop = asyncio.get_event_loop()
272	for i, (qref, qfact) in enumerate(self["question_factory"].items()):	272	for i, (qref, qfact) in enumerate(self["question_factory"].items()):
273	try:	273	try: