Merge pull request #8 from makeopensource/develop

Allow on-site students to re-enqueue themselves via the website

Author: jessehartloff

api/database/db_interface.py

@@ -4,9 +4,10 @@
 from api.database.idb_ratings import IRatings
 from api.database.idb_accounts import IAccounts
 from api.database.idb_roster import IRoster
+from api.database.idb_sessions import ISessions
 
 
-class DBInterface(IQueue, IRatings, IAccounts, IRoster, ABC):
+class DBInterface(IQueue, IRatings, IAccounts, IRoster, ISessions, ABC):
 
     # All database implements must extend this class
 

api/database/idb_sessions.py

@@ -0,0 +1,31 @@
+from abc import ABC, abstractmethod
+
+
+class ISessions(ABC):
+
+    @abstractmethod
+    def update_swipe_time(self, user):
+        """ Update time user was enqueued to current time """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def reset_swipe_time(self, user):
+        """ Reset time user was enqueued """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def get_swipe_time(self, user):
+        """ Return time user was enqueued """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def get_on_site(self):
+        """ Return list of students who have swiped in <= 2 hours
+            who are not currently in the queue
+        """
+        raise NotImplementedError()
+
+    @abstractmethod
+    def clear_on_site(self):
+        """ Reset everyone's last enqueue time """
+        raise NotImplementedError()

api/database/idb_visits.py

@@ -32,6 +32,18 @@ def end_visit(self, visit_id, reason):
         """
         raise NotImplementedError()
 
+    @abstractmethod
+    def cancel_visit(self, visit_id):
+        """ Destroy this visit from the database if it's still in progress.
+        Un-dequeue this student from the queue if they have been dequeued.
+
+        :param visit_id:
+        :return:
+        """
+
+
+        raise NotImplementedError()
+
     @abstractmethod
     def get_in_progress_visits(self):
         """ Return all database entries for visits that have

api/database/relational_db/relational_db.py

@@ -6,10 +6,11 @@
 from api.database.relational_db.relational_db_queue import RelationalDBQueue
 from api.database.relational_db.relational_db_accounts import RelationalDBAccounts
 from api.database.relational_db.relational_db_ratings import RelationalDBRatings
+from api.database.relational_db.relational_db_sessions import RelationalDBSessions
 from api.database.relational_db.relational_db_visits import RelationalDBVisits
 
 
-class RelationalDB(DBInterface, RelationalDBAccounts, RelationalDBQueue, RelationalDBRatings, RelationalDBVisits):
+class RelationalDB(DBInterface, RelationalDBAccounts, RelationalDBQueue, RelationalDBRatings, RelationalDBVisits, RelationalDBSessions):
 
     def __init__(self):
         super().__init__()
@@ -27,7 +28,8 @@ def initialize(self):
                     last_name VARCHAR(255),
                     ubit VARCHAR(16) UNIQUE,
                     person_num INTEGER UNIQUE,
-                    course_role VARCHAR(16)
+                    course_role VARCHAR(16),
+                    last_swipe  TEXT
                 );
                 """
             )
@@ -39,7 +41,8 @@ def initialize(self):
                     user_id INTEGER UNIQUE,
                     joined TEXT DEFAULT (datetime('now', 'localtime')),
                     priority INTEGER,
-                    enqueue_reason TEXT
+                    enqueue_reason TEXT,
+                    dequeued BOOLEAN DEFAULT false
                 );
                 """
             )

api/database/relational_db/relational_db_accounts.py

@@ -1,3 +1,4 @@
+import datetime
 import hashlib
 import secrets
 
@@ -86,7 +87,7 @@ def get_authenticated_user(self, auth_token):
         with self.cursor() as cursor:
             user = cursor.execute(
                 """
-                SELECT preferred_name, last_name, ubit, person_num, course_role, users.user_id 
+                SELECT preferred_name, last_name, ubit, person_num, course_role, users.user_id, last_swipe 
                 FROM users
                 INNER JOIN auth ON users.user_id = auth.user_id
                 WHERE auth_token = ?
@@ -98,13 +99,28 @@ def get_authenticated_user(self, auth_token):
         if not user:
             return None
 
+        enqueue_time = user[6]
+
+        if enqueue_time is None:
+            on_site = False
+        else:
+            # YYYY-MM-DD HH:MM:SS
+            time_format = "%Y-%m-%d %H:%M:%S"
+
+            now = datetime.datetime.now()
+            enqueue_time = datetime.datetime.strptime(enqueue_time, time_format)
+            seconds = (now - enqueue_time).seconds
+
+            on_site = seconds <= 7200
+
         return {
             "preferred_name": user[0],
             "last_name": user[1],
             "ubit": user[2],
             "person_num": user[3],
             "course_role": user[4],
             "user_id": user[5],
+            "on_site": on_site
         }
 
     def sign_up(self, username, pw) -> str | None:

api/database/relational_db/relational_db_queue.py

@@ -44,7 +44,7 @@ def dequeue_student(self):
                 ORDER BY priority DESC, joined
             """
             ).fetchone()
-            cursor.execute("DELETE FROM queue WHERE user_id = ?", (user[0],))
+            cursor.execute("UPDATE queue SET dequeued = true WHERE user_id = ?", (user[0],))
 
         return {
             "user_id": user[0],
@@ -68,7 +68,7 @@ def dequeue_specified_student(self, student_id):
             if user is None:
                 return None
 
-            cursor.execute("DELETE FROM queue WHERE user_id = ?", (user[0],))
+            cursor.execute("UPDATE queue SET dequeued = true WHERE user_id = ?", (user[0],))
 
         return {
             "user_id": user[0],
@@ -85,6 +85,7 @@ def get_queue(self):
                 """
                 SELECT users.user_id, preferred_name, ubit, person_num 
                 FROM queue INNER JOIN users ON queue.user_id = users.user_id 
+                WHERE dequeued = false
                 ORDER BY priority DESC, joined
                 """
             )
@@ -106,7 +107,7 @@ def get_queue(self):
     def clear_queue(self):
         with self.cursor() as cursor:
             cursor.execute(
-                "DELETE FROM queue"
+                "DELETE FROM queue WHERE dequeued = false"
             )
 
     def remove_student(self, student):
@@ -116,6 +117,8 @@ def remove_student(self, student):
             if queue_info is None:
                 return None
 
+        with self.cursor() as cursor:
+
             cursor.execute("DELETE FROM queue WHERE user_id = ?", (student, ))
 
             return {"user_id": queue_info[0], "joined": queue_info[1]}

api/database/relational_db/relational_db_sessions.py

@@ -0,0 +1,61 @@
+from api.database.idb_sessions import ISessions
+
+
+class RelationalDBSessions(ISessions):
+
+    def update_swipe_time(self, user):
+        with self.cursor() as cursor:
+            cursor.execute("""
+                UPDATE users
+                SET last_swipe = datetime('now', 'localtime')
+                WHERE user_id = ?
+            """, (user,))
+
+    def reset_swipe_time(self, user):
+        with self.cursor() as cursor:
+            cursor.execute("""
+                UPDATE users
+                SET last_swipe = NULL
+                WHERE user_id = ?
+            """, (user, ))
+
+    def get_swipe_time(self, user):
+        with self.cursor() as cursor:
+            time = cursor.execute("""
+                SELECT last_swipe FROM users 
+                WHERE last_swipe > datetime('now', 'localtime', '-2 hours') AND user_id = ?
+            """, (user,)).fetchone()
+
+        if time is None:
+            return None
+
+        return time[0]
+
+    def get_on_site(self):
+        with self.cursor() as cursor:
+            users = cursor.execute(
+                """
+                SELECT users.user_id, preferred_name, ubit, person_num
+                FROM users
+                         LEFT JOIN queue ON users.user_id = queue.user_id
+                WHERE last_swipe > datetime('now', 'localtime', '-2 hours')
+                  AND queue.user_id IS NULL
+                """
+            )
+            users_l = list()
+            for user in users:
+                users_l.append(
+                    {
+                        "id": user[0],
+                        "preferred_name": user[1],
+                        "ubit": user[2],
+                        "pn": user[3],
+                    }
+                )
+        return users_l
+
+    def clear_on_site(self):
+        with self.cursor as cursor:
+            cursor.execute("""
+                UPDATE users SET last_swipe = NULL
+            """)

api/database/relational_db/relational_db_visits.py

@@ -25,12 +25,36 @@ def end_visit(self, visit_id, reason):
         now = str(datetime.datetime.now().isoformat(' ', timespec="seconds"))
 
         with self.cursor() as cursor:
+
+            student = cursor.execute("SELECT (student_id) from visits WHERE visit_id = ?", (visit_id, )).fetchone()
+
+            if student is None:
+                return
+
+            student = student[0]
+
             cursor.execute("""
                 UPDATE visits
                 SET session_end = ?, session_end_reason = ?
                 WHERE visit_id = ? AND session_end is null
             """, (now, reason, visit_id))
 
+        self.remove_student(student)
+
+    def cancel_visit(self, visit_id):
+        with self.cursor() as cursor:
+
+            student = cursor.execute("SELECT (student_id) from visits WHERE visit_id = ?", (visit_id,)).fetchone()
+
+            if student is None:
+                return
+
+            student = student[0]
+
+            cursor.execute("DELETE from visits WHERE visit_id = ?", (visit_id,))
+
+            cursor.execute("UPDATE queue SET dequeued = false WHERE user_id = ?", (student, ))
+
 
     def get_in_progress_visits(self):
         with self.cursor() as cursor:

api/queue/controller.py

@@ -1,3 +1,5 @@
+import datetime
+
 from api.database.db import db
 
 
@@ -13,6 +15,7 @@ def add_to_queue_by_card_swipe(swipe_data):
     student = db.lookup_person_number(pn)
     if student is not None:
         add_to_queue(student)
+        db.update_swipe_time(student["user_id"])
         return True
     return False
 
@@ -24,6 +27,7 @@ def add_to_queue_by_ta_override(identifier, front=False):
             add_to_front_of_queue(student)
         else:
             add_to_queue(student)
+        db.update_swipe_time(student["user_id"])
         return True
     return False
 
@@ -46,3 +50,66 @@ def remove_from_queue_without_visit(student, reason):
     db.end_visit(visit, reason)
     return True
 
+def self_add_to_queue(student):
+    if is_active(student):
+        db.enqueue_student(student)
+        return True
+    return False
+
+def is_active(student):
+    # YYYY-MM-DD HH:MM:SS
+    time_format = "%Y-%m-%d %H:%M:%S"
+
+    now = datetime.datetime.now()
+    enqueue_time = db.get_swipe_time(student)
+
+    if enqueue_time is None:
+        return False
+
+    enqueue_time = datetime.datetime.strptime(enqueue_time, time_format)
+
+    seconds = (now - enqueue_time).seconds
+
+    if seconds > 7200:
+        return False
+
+    return True
+
+def get_students_visit(student):
+    in_progress = db.get_in_progress_visits()
+    in_progress = list(filter(lambda v: v["student_id"] == student, in_progress))
+
+    if len(in_progress) == 0:
+        return None
+
+
+    visit = in_progress[0]
+    ta = db.lookup_identifier(visit["ta_id"])
+
+    return {
+        "ta_name": ta["preferred_name"]
+    }
+
+
+def get_tas_visit(ta):
+
+    in_progress = db.get_in_progress_visits()
+    in_progress = list(filter(lambda v: v["ta_id"] == ta, in_progress))
+
+    if len(in_progress) == 0:
+        return None
+
+    visit = in_progress[0]
+    student = db.lookup_identifier(visit["student_id"])
+
+    return {
+        "id": visit["student_id"],
+        "username": student["ubit"],
+        "pn": student["person_num"],
+        "preferred_name": student["preferred_name"],
+        "visitID": visit["visit_id"],
+        "visit_reason": visit["student_visit_reason"]
+    }
+
+
+