Use flask.Blueprint for endpoint grouping

This is a cleaner way to split them up, but more importantly also allows
the same local function name to be used across routes submodules (e.g.
"routes.legacy.get_room", "routes.rooms.get_room" clash without
Blueprints).

Author: jagerman

sogs/routes/__init__.py

@@ -3,7 +3,11 @@
 from .. import config, crypto, http, utils
 from ..model.room import get_readable_rooms
 
-from . import auth, converters, general, legacy, onion_request  # noqa: F401
+from . import auth, converters  # noqa: F401
+
+from .legacy import legacy as legacy_endpoints
+from .general import general as general_endpoints
+from .onion_request import onion_request as onion_request_endpoints
 
 from io import BytesIO
 
@@ -12,6 +16,11 @@
 from PIL.Image import NEAREST
 
 
+app.register_blueprint(legacy_endpoints)
+app.register_blueprint(general_endpoints)
+app.register_blueprint(onion_request_endpoints)
+
+
 @app.get("/")
 def serve_index():
     rooms = get_readable_rooms()

sogs/routes/general.py

@@ -4,12 +4,14 @@
 from .. import utils
 from .subrequest import make_subrequest
 
-from flask import request, abort, jsonify
+from flask import request, abort, jsonify, Blueprint
 
 # General purpose routes for things like capability retrieval and batching
 
+general = Blueprint('general', __name__)
 
-@app.get("/capabilities")
+
+@general.get("/capabilities")
 def get_caps():
     """
     Return the list of server features/capabilities.  Optionally takes a required= parameter
@@ -114,7 +116,7 @@ def parse_batch_req(r):
     return method, path, headers, json, body
 
 
-@app.post("/batch")
+@general.post("/batch")
 def batch(_sequential=False):
     """
     Submits multiple requests wrapped up in a single request, runs them all, then returns the result
@@ -162,7 +164,7 @@ def batch(_sequential=False):
     return utils.jsonify_with_base64(response)
 
 
-@app.post("/sequence")
+@general.post("/sequence")
 def sequence():
     """
     This is like batch, except that it guarantees to submit requests sequentially in the order

sogs/routes/legacy.py

@@ -1,4 +1,4 @@
-from flask import abort, request, jsonify, g
+from flask import abort, request, jsonify, g, Blueprint
 from werkzeug.exceptions import HTTPException
 from ..web import app
 from .. import crypto, config, db, http, utils
@@ -12,6 +12,8 @@
 # an endpoint (via onion request) that doesn't start with a `/` -- we prepend `/legacy/` and submit
 # it as an internal request to land here.
 
+legacy = Blueprint('legacy', __name__, url_prefix='/legacy')
+
 
 def get_pubkey_from_token(token):
     if not token:
@@ -90,7 +92,7 @@ def legacy_check_user_room(
     return (user, room)
 
 
-@app.get("/legacy/rooms")
+@legacy.get("/rooms")
 def get_rooms():
     """serve public room list for user"""
 
@@ -103,7 +105,7 @@ def get_rooms():
     )
 
 
-@app.get("/legacy/rooms/<Room:room>")
+@legacy.get("/rooms/<Room:room>")
 def get_room_info(room):
     """serve room metadata"""
     # This really should be authenticated but legacy Session just doesn't pass along auth info.
@@ -112,7 +114,7 @@ def get_room_info(room):
     return jsonify({'room': room_info, 'status_code': http.OK})
 
 
-@app.get("/legacy/rooms/<Room:room>/image")
+@legacy.get("/rooms/<Room:room>/image")
 def legacy_serve_room_image(room):
     """serve room icon"""
     # This really should be authenticated but legacy Session just doesn't pass along auth info.
@@ -124,20 +126,20 @@ def legacy_serve_room_image(room):
     return jsonify({"status_code": http.OK, "result": room.image.read_base64()})
 
 
-@app.get("/legacy/member_count")
+@legacy.get("/member_count")
 def legacy_member_count():
     user, room = legacy_check_user_room(read=True)
 
     return jsonify({"status_code": http.OK, "member_count": room.active_users()})
 
 
-@app.post("/legacy/claim_auth_token")
+@legacy.post("/claim_auth_token")
 def legacy_claim_auth():
     """this does nothing but needs to exist for backwards compat"""
     return jsonify({'status_code': http.OK})
 
 
-@app.get("/legacy/auth_token_challenge")
+@legacy.get("/auth_token_challenge")
 def legacy_auth_token_challenge():
     """
     legacy endpoint to give back an encrypted auth token bundle for the client to use to
@@ -170,7 +172,7 @@ def legacy_transform_message(m):
     }
 
 
-@app.post("/legacy/messages")
+@legacy.post("/messages")
 def handle_post_legacy_message():
 
     user, room = legacy_check_user_room(write=True)
@@ -187,7 +189,7 @@ def handle_post_legacy_message():
     )
 
 
-@app.get("/legacy/messages")
+@legacy.get("/messages")
 def handle_legacy_get_messages():
     from_id = request.args.get('from_server_id')
     limit = utils.get_int_param('limit', 256, min=1, max=256, truncate=True)
@@ -205,7 +207,7 @@ def handle_legacy_get_messages():
     )
 
 
-@app.post("/legacy/compact_poll")
+@legacy.post("/compact_poll")
 def handle_comapct_poll():
     req_list = request.json
     result = list()
@@ -272,22 +274,22 @@ def process_legacy_file_upload_for_room(
     return room.upload_file(file_content, user, filename=filename, lifetime=lifetime)
 
 
-@app.post("/legacy/files")
+@legacy.post("/files")
 def handle_legacy_store_file():
     user, room = legacy_check_user_room(write=True, upload=True)
     file_id = process_legacy_file_upload_for_room(user, room)
     return jsonify({'status_code': http.OK, 'result': file_id})
 
 
-@app.post("/legacy/rooms/<Room:room>/image")
+@legacy.post("/rooms/<Room:room>/image")
 def handle_legacy_upload_room_image(room):
     user, room = legacy_check_user_room(write=True, upload=True, moderator=True)
     file_id = process_legacy_file_upload_for_room(user, room, lifetime=None)
     room.image = file_id
     return jsonify({'status_code': http.OK, 'result': file_id})
 
 
-@app.get("/legacy/files/<int:file_id>")
+@legacy.get("/files/<int:file_id>")
 def handle_legacy_get_file(file_id):
     user, room = legacy_check_user_room(read=True)
 
@@ -300,7 +302,7 @@ def handle_legacy_get_file(file_id):
     return jsonify_with_base64({'status_code': http.OK, 'result': file_content})
 
 
-@app.post("/legacy/delete_messages")
+@legacy.post("/delete_messages")
 def handle_legacy_delete_messages(ids=None):
     user, room = legacy_check_user_room(read=True)
 
@@ -315,12 +317,12 @@ def handle_legacy_delete_messages(ids=None):
     return jsonify({'status_code': http.OK})
 
 
-@app.delete("/legacy/messages/<int:msgid>")
+@legacy.delete("/messages/<int:msgid>")
 def handle_legacy_single_delete(msgid):
     return handle_legacy_delete_messages(ids=[msgid])
 
 
-@app.post("/legacy/block_list")
+@legacy.post("/block_list")
 def handle_legacy_ban():
     user, room = legacy_check_user_room(moderator=True)
     ban = User(session_id=request.json['public_key'], autovivify=True)
@@ -330,7 +332,7 @@ def handle_legacy_ban():
     return jsonify({"status_code": http.OK})
 
 
-@app.post("/legacy/ban_and_delete_all")
+@legacy.post("/ban_and_delete_all")
 def handle_legacy_banhammer():
     mod, room = legacy_check_user_room(moderator=True)
     ban = User(session_id=request.json['public_key'], autovivify=True)
@@ -342,7 +344,7 @@ def handle_legacy_banhammer():
     return jsonify({"status_code": http.OK})
 
 
-@app.delete("/legacy/block_list/<SessionID:session_id>")
+@legacy.delete("/block_list/<SessionID:session_id>")
 def handle_legacy_unban(session_id):
     user, room = legacy_check_user_room(moderator=True)
     to_unban = User(session_id=session_id, autovivify=False)
@@ -352,7 +354,7 @@ def handle_legacy_unban(session_id):
     abort(http.NOT_FOUND)
 
 
-@app.get("/legacy/block_list")
+@legacy.get("/block_list")
 def handle_legacy_banlist():
     # Bypass permission checks here because we want to continue even if we are banned:
     user, room = legacy_check_user_room(no_perms=True)
@@ -369,7 +371,7 @@ def handle_legacy_banlist():
     return jsonify({"status_code": http.OK, "banned_members": bans})
 
 
-@app.get("/legacy/moderators")
+@legacy.get("/moderators")
 def handle_legacy_get_mods():
     user, room = legacy_check_user_room(read=True)
 
@@ -379,7 +381,7 @@ def handle_legacy_get_mods():
 
 # Posting here adds an admin and requires admin access.  Legacy Session doesn't understand the
 # moderator/admin distinction so we don't support moderator adjustment at all here.
-@app.post("/legacy/moderators")
+@legacy.post("/moderators")
 def handle_legacy_add_admin():
     user, room = legacy_check_user_room(admin=True)
 
@@ -396,7 +398,7 @@ def handle_legacy_add_admin():
 # DELETE here removes an admin or moderator and requires admin access.  (Legacy Session doesn't
 # understand the moderator/admin distinction so we don't distinguish between them and just remove
 # both powers, if present).
-@app.delete("/legacy/moderators/<SessionID:session_id>")
+@legacy.delete("/moderators/<SessionID:session_id>")
 def handle_legacy_remove_admin(session_id):
     user, room = legacy_check_user_room(admin=True)
 

sogs/routes/onion_request.py

@@ -1,11 +1,13 @@
-from flask import request, abort
+from flask import request, abort, Blueprint
 import json
 
 from ..web import app
 from .. import crypto, http, utils
 
 from .subrequest import make_subrequest
 
+onion_request = Blueprint('onion_request', __name__)
+
 
 def handle_onionreq_plaintext(body):
     """
@@ -82,8 +84,8 @@ def handle_onionreq_plaintext(body):
         return json.dumps({'status_code': http.BAD_REQUEST}).encode()
 
 
-@app.post("/oxen/v3/lsrpc")
-@app.post("/loki/v3/lsrpc")
+@onion_request.post("/oxen/v3/lsrpc")
+@onion_request.post("/loki/v3/lsrpc")
 def handle_onion_request():
     """
     Parse an onion request, handle it as a subrequest, then encrypt the subrequest result and send

sogs/web.py

@@ -10,14 +10,15 @@
 # below, because they depend on this existing.
 if not hasattr(flask.Flask, 'post'):
 
-    def _add_flask_method(name):
+    def _add_route_shortcut(on, name):
         def meth(self, rule: str, **options):
             return self.route(rule, methods=[name.upper()], **options)
 
-        setattr(flask.Flask, name, meth)
+        setattr(on, name, meth)
 
     for method in ('get', 'post', 'put', 'delete', 'patch'):
-        _add_flask_method(method)
+        _add_route_shortcut(flask.Flask, method)
+        _add_route_shortcut(flask.Blueprint, method)
 
 
 def get_db_conn():