Merge pull request #24 from CampusPulse/manual-status

Allow admins to manually update status

Author: MoralCode

app.py

@@ -45,13 +45,13 @@
 from flask_migrate import Migrate, stamp, upgrade
 from flask_cors import CORS, cross_origin
 from s3 import S3Bucket
-from typing import Optional
+from typing import Optional, Union
 import shutil
 import pandas as pd
 import json_log_formatter
 from pathlib import Path
 from dotenv import load_dotenv
-from helpers import floor_to_integer, RoomNumber, integer_to_floor, MapLocation, ServiceNowStatus, ServiceNowUpdateType, save_user_details, check_for_admin_role, get_logged_in_user_id, get_logged_in_user
+from helpers import floor_to_integer, RoomNumber, integer_to_floor, MapLocation, ServiceNowStatus, ServiceNowUpdateType, save_user_details, check_for_admin_role, get_logged_in_user_id, get_logged_in_user, get_logged_in_user_info
 from urllib.parse import quote_plus, urlencode
 from authlib.integrations.flask_client import OAuth
 
@@ -249,6 +249,24 @@ def access_point_json(access_point: AccessPoint):
             })
     return base_data
 
+def access_point_admin_json(access_point: AccessPoint):
+
+    status = get_item_status(access_point)
+    report = get_item_report(access_point)
+
+    status_categories = {i.name: i.value for i in StatusType}
+    
+
+    # TODO: use marshmallow to serialize
+    admin_data = {
+        "status_ticket_number": (status.report.ref or "No Ticket") if status else "No Status",
+        "status_report_id": status.report.id,
+        "report_id": report.id,
+        "status_categories": status_categories
+    }
+
+    return admin_data
+
 
 """
 Creates a geojson for map feature
@@ -597,7 +615,7 @@ def import_data(file):
 """
 
 
-def getAccessPoint(id):
+def getAccessPoint(id, is_admin=False):
     access_point = db.session.execute(
         db.select(AccessPoint).where(AccessPoint.id == id)
     ).scalar()
@@ -608,6 +626,8 @@ def getAccessPoint(id):
         return None
 
     accessPointInfo = access_point_json(access_point)
+    if is_admin:
+        accessPointInfo.update(access_point_admin_json(access_point))
     logging.debug(accessPointInfo)
     return accessPointInfo
 
@@ -910,15 +930,18 @@ def tags():
 
 @app.route("/access_points/<id>")
 def access_point(id):
-    if checkAccessPointExists(id):
-        return render_template(
-            "access_point.html", 
-            authsession=get_logged_in_user(),
-            is_admin=check_for_admin_role(get_logged_in_user_id()),
-            accessPointDetails=getAccessPoint(id)
-        )
-    else:
+    if not checkAccessPointExists(id):
         return render_template("404.html"), 404
+    
+    is_admin = check_for_admin_role(get_logged_in_user_id())
+    return render_template(
+        "access_point.html", 
+        authsession=get_logged_in_user(),
+        is_admin=is_admin,
+        accessPointDetails=getAccessPoint(id, is_admin=is_admin)
+        
+    )
+        
 
 
 ########################
@@ -1138,6 +1161,53 @@ def add_ticket(item_id):
 
     return ("", 200)
 
+
+@app.route("/add_status/<item_id>", methods=["POST"])
+@requires_admin
+def add_status(item_id):
+    if not checkAccessPointExists(item_id):
+        return "Not found", 404
+
+    status_text = request.form.get("status")
+    note_text = request.form.get("note")
+    category = StatusType(int(request.form.get("category")))
+    author = get_logged_in_user_info()
+    author_identifier = f" - manually added by {author['name']} ({author['sub']}) via web UI"
+
+    note_text += author_identifier
+
+    prior_report = get_item_report(item_id)
+    current_report = None
+
+    previous_report_has_ticket = prior_report.ref is not None
+
+    if previous_report_has_ticket or category == StatusType.BROKEN:
+        current_report = Report()
+        db.session.add(current_report)
+        db.session.flush()
+
+        # associate new report with this access point
+        association = AccessPointReports(
+            report_id=current_report.id,
+            access_point_id=item_id
+        )
+        db.session.add(association)
+    
+    else:
+        current_report = prior_report
+
+    status_update = Status(
+        report = current_report,
+        status = status_text,
+        status_type = category,
+        timestamp = datetime.utcnow(),
+        notes = note_text
+    )
+    db.session.add(status_update)
+    db.session.commit()
+
+    return redirect(f"/access_points/{item_id}")
+
 ########################
 #
 # region Management Helpers
@@ -1225,25 +1295,48 @@ def associate_thumbnail(file_hash, thumbnail_file, item_identifier):
     db.session.commit()
 
 
-def get_item_status(item):
-    """Fetch the status for the provided item.
+def get_item_status(item: Union[AccessPoint, int]):
+    """Fetch the most recent status for the provided item.
 
     Args:
-        item (AccessPoint): The item (in this case AccessPoint) to fetch status for
+        item (Union[AccessPoint, int]): The item (in this case AccessPoint) to fetch status for (or its integer ID)
 
     Returns:
         Status: the status of the access point, or None if none were found
     """
-
+    item_id = item.id if isinstance(item, AccessPoint) else item
     status = db.session.execute(
         db.select(Status)
         .join(AccessPointReports, AccessPointReports.report_id == Status.report_id)
-        .where(AccessPointReports.access_point_id == item.id)
+        .where(AccessPointReports.access_point_id == item_id)
         .order_by(Status.timestamp.desc())
     ).scalars().first()
 
     return status
 
+def get_item_report(item:Union[AccessPoint, int]):
+    """Fetch the latest report for the provided item.
+
+    While you can get this using get_item_status and accessing it through the associated report,
+    that method can miss scenarios where a report has been created but there is no status yet
+    This can happen when associating a ticket before any email has come in yet.
+
+    Args:
+        item (Union[AccessPoint, int]): The item (in this case AccessPoint) to fetch the report for (or its integer ID)
+
+    Returns:
+        Report: the report of the access point, or None if none were found
+    """
+    item_id = item.id if isinstance(item, AccessPoint) else item
+    report = db.session.execute(
+        db.select(Report)
+        .join(AccessPointReports, AccessPointReports.report_id == Report.id)
+        .where(AccessPointReports.access_point_id == item_id)
+        .order_by(Report.id.desc())
+    ).scalars().first()
+    
+    return report
+
 
 """
 Delete tag and all relations from DB

templates/access_point.html

@@ -117,6 +117,11 @@ <h3>Location:</h3>
                     <br>{% endif %}
                     <strong>Room</strong>: {{ accessPointDetails["room"] }}<br>
                     <strong>Status Last Updated</strong>: {{ accessPointDetails["status_updated"] }}<br>
+                    {% if authsession and is_admin %}
+                    <strong>Last Report Ticket #</strong>: {{ accessPointDetails["status_ticket_number"] }}<br>
+                    <strong>Last Report ID #</strong>: {{ accessPointDetails["report_id"] }}<br>
+                    <strong>Last Report ID #</strong>: {{ accessPointDetails["status_report_id"] }} (By Status)<br>
+                    {% endif %}
                 </p>
 
 
@@ -188,11 +193,38 @@ <h2 class="accordion-header" id="headingOne">
                 {% if authsession and is_admin %}
 
                 <form action="/add_ticket/{{accessPointDetails['id']}}" method="post">
-                    <label for="ticket_ref" class="form-label"><b>Ticket Number</b></label>
+                    <details>
+                        <summary><label for="ticket_ref" class="form-label"><b>Assign Ticket Number</b></label></summary>
                     <p class="thin">Filed a ticket for this item? Ensure the system email is on the watch list and add the ticket number here!</p>
-                    <input type="text" class="form-control"  id="ticket_ref" name="ticket_ref" placeholder="WOT1234567" required >
+                    <input type="text" class="form-control"  id="ticket_ref" name="ticket_ref" placeholder="WOT1234567" required pattern="WOT[0-9]+" title="Work order ticket number like WOT1234567">
                     <button type="submit" class="btn btn-primary">Submit</button>
+                    </details>
+                </form>
+
+                <form action="/add_status/{{accessPointDetails['id']}}" method="post">
+                    <details>
+                        <summary><b>Assign Manual Status</b></summary>
+                        <p class="thin">Sign on the elevator? Heard from another channel that its broken? Update it here! Don't forget to come back and update it again if it is fixed!</p>
+                        <label>
+                            Status Bubble Text: 
+                            <input type="text" class="form-control" id="status" name="status" title="The name for the status bubble (1-30 char)" required pattern=".{1,30}" placeholder="Reported">
+                        </label>
+                        <label>
+                            Note
+                            <input type="text" class="form-control" id="note" name="note" title="Brief note about why this status changed" required placeholder="Theres a sign on the door">
+                        </label>
+                        <label>
+                            Category
+                            <select name="category">
+                                {% for name, val in accessPointDetails['status_categories'].items() %}
+                                <option value="{{val}}">{{name}}</option>
+                                {% endfor %}
+                            </select>
+                        </label><br>
+                        <button type="submit" class="btn btn-primary">Submit</button>
+                    </details>
                 </form>
+
                 {% endif %}
             </div>
         </div>