From 08d1b7b7316adb4a06a11bd7034742f4843ef634 Mon Sep 17 00:00:00 2001 From: Xusheng Date: Tue, 22 Sep 2026 21:59:31 -0400 Subject: [PATCH] Add paginated player scoreboard --- app/controllers/index.py | 35 +++++++- app/models/solve.py | 62 ++++++++++++++ templates/partial/menu.html | 4 + templates/scoreboard/index.html | 46 +++++++++++ tests/test_routes.py | 2 +- tests/test_scoreboard.py | 142 ++++++++++++++++++++++++++++++++ 6 files changed, 289 insertions(+), 2 deletions(-) create mode 100644 templates/scoreboard/index.html create mode 100644 tests/test_scoreboard.py diff --git a/app/controllers/index.py b/app/controllers/index.py index 8b20e1d..a6d5bfd 100644 --- a/app/controllers/index.py +++ b/app/controllers/index.py @@ -2,10 +2,13 @@ Index controller - Home page. """ -from flask import Blueprint, render_template +from math import ceil + +from flask import Blueprint, abort, redirect, render_template from app.models.user import count_users from app.models.crackme import count_crackmes from app.models.solution import count_solutions +from app.models.solve import scoreboard index_bp = Blueprint('index', __name__) @@ -25,3 +28,33 @@ def index(): nbusers=nbusers, nbcrackmes=nbcrackmes, nbsolutions=nbsolutions) + + +@index_bp.route('/scoreboard') +def scoreboard_index(): + return _scoreboard_page(1) + + +def _scoreboard_page(page): + try: + rows, has_more, total = scoreboard(page) + except Exception as e: + print(f"Error getting scoreboard: {e}") + abort(500) + + if page > 1 and not rows: + last_page = max(1, ceil(total / 25)) + return redirect('/scoreboard' if last_page == 1 + else f'/scoreboard/{last_page}') + + return render_template('scoreboard/index.html', + scoreboard=rows, + page=page, + has_more=has_more) + + +@index_bp.route('/scoreboard/') +def scoreboard_page(page): + if page < 2: + return redirect('/scoreboard') + return _scoreboard_page(page) diff --git a/app/models/solve.py b/app/models/solve.py index 903cae3..c0bb42f 100644 --- a/app/models/solve.py +++ b/app/models/solve.py @@ -117,6 +117,68 @@ def user_score(user_hexid): return sum(solve.get('points', 0) for solve in solves) +def scoreboard(page=1, per_page=25): + """Rank visible players by score, then by when they reached that score. + + Scores remain derived from solve records. User documents are resolved + after aggregation so deleted, hidden, or otherwise missing accounts never + appear on the public scoreboard. + """ + if not check_connection(): + raise ErrUnavailable("Database is unavailable") + + from app.models.user import users_by_hexids + + totals = list(get_collection('solve').aggregate([ + {'$group': { + '_id': '$user_hexid', + 'score': {'$sum': {'$ifNull': ['$points', 0]}}, + 'last_solve_at': {'$max': { + '$cond': [{'$gt': ['$points', 0]}, '$created_at', None] + }}, + 'last_undated_solve_id': {'$max': { + '$cond': [{'$and': [ + {'$gt': ['$points', 0]}, + {'$eq': [{'$ifNull': ['$created_at', None]}, None]}, + ]}, '$_id', None] + }}, + }}, + {'$match': {'score': {'$gt': 0}}}, + ])) + users = users_by_hexids(total['_id'] for total in totals) + + def reached_at(total): + candidates = [] + if total.get('last_solve_at'): + candidates.append(total['last_solve_at']) + if total.get('last_undated_solve_id'): + candidates.append(total['last_undated_solve_id'].generation_time) + return max(timestamp.replace(tzinfo=timezone.utc) + if timestamp.tzinfo is None else timestamp + for timestamp in candidates) + + rows = [ + { + 'user_hexid': total['_id'], + 'username': users[total['_id']]['name'], + 'score': total['score'], + 'reached_at': reached_at(total), + } + for total in totals + if total['_id'] in users and not users[total['_id']].get('deleted', False) + ] + rows.sort(key=lambda row: (-row['score'], row['reached_at'], + row['user_hexid'])) + + for position, row in enumerate(rows, start=1): + row['rank'] = position + + page = max(page, 1) + start = (page - 1) * per_page + paginated_rows = rows[start:start + per_page] + return paginated_rows, start + per_page < len(rows), len(rows) + + def count_solves_by_crackme(crackme_hexid): """Count how many users have solved a crackme.""" if not check_connection(): diff --git a/templates/partial/menu.html b/templates/partial/menu.html index 2a1ee03..e34a5fa 100644 --- a/templates/partial/menu.html +++ b/templates/partial/menu.html @@ -12,6 +12,7 @@

crackmes.one

Search Upload crackme Latest + Scoreboard Faq Discord Blog @@ -32,6 +33,7 @@

crackmes.one

  • Search
  • Upload crackme
  • Latest
    • +
  • Scoreboard
  • Discord
  • Faq
  • Blog
    • @@ -48,6 +50,7 @@

    crackmes.one

    Search Latest + Scoreboard Faq Discord Blog @@ -66,6 +69,7 @@

    crackmes.one

    • Search
    • Latest
      • +
    • Scoreboard
    • Faq
    • Discord
    • Blog
      • diff --git a/templates/scoreboard/index.html b/templates/scoreboard/index.html new file mode 100644 index 0000000..bf5b476 --- /dev/null +++ b/templates/scoreboard/index.html @@ -0,0 +1,46 @@ +{% extends "base.html" %} +{% block title %}Scoreboard{% endblock %} +{% block page_title %}Scoreboard{% endblock %} +{% block content %} +
      +

      Scoreboard

      + {% if scoreboard %} +
      + + + + + + + + + + {% for player in scoreboard %} + + + + + + {% endfor %} + +
      RankPlayerScore
      {{ player.rank }}{{ player.username }}{{ player.score }}
      +
      +
      + {% if page > 1 %} + Previous + {% else %} + + {% endif %} + Page {{ page }} + {% if has_more %} + Next + {% else %} + + {% endif %} +
      + {% else %} +

      No players have scored points yet.

      + {% endif %} +
      +{% include 'partial/footer.html' %} +{% endblock %} diff --git a/tests/test_routes.py b/tests/test_routes.py index e39b553..9c442c5 100644 --- a/tests/test_routes.py +++ b/tests/test_routes.py @@ -6,7 +6,7 @@ def test_public_pages_load(client): for path in ('/', '/faq', '/upload/crackmerules', '/upload/writeuprules', '/login', '/register', '/search', '/latest', '/lasts/1', - '/latest/solutions/1', '/latest/solves/1'): + '/latest/solutions/1', '/latest/solves/1', '/scoreboard'): assert client.get(path).status_code == 200, path diff --git a/tests/test_scoreboard.py b/tests/test_scoreboard.py new file mode 100644 index 0000000..7fe57dc --- /dev/null +++ b/tests/test_scoreboard.py @@ -0,0 +1,142 @@ +"""Scoreboard ranking, navigation, and pagination.""" + +from datetime import datetime, timedelta, timezone + +from bson import ObjectId + + +def _user(db, name, *, visible=True, deleted=False): + object_id = ObjectId() + user = { + '_id': object_id, + 'hexid': str(object_id), + 'name': name, + 'visible': visible, + 'deleted': deleted, + } + db.user.insert_one(user) + return user + + +def _solve(db, user, points, index=0, created_at=None): + object_id = ObjectId() + db.solve.insert_one({ + '_id': object_id, + 'hexid': str(object_id), + 'user_hexid': user.get('hexid') or str(user['_id']), + 'crackme_hexid': f'crackme-{index}', + 'points': points, + 'created_at': created_at or datetime.now(timezone.utc), + }) + + +def test_scoreboard_orders_scores_and_excludes_zero_or_hidden_users( + client, db): + alice = _user(db, 'alice') + bob = _user(db, 'bob') + zero = _user(db, 'zero') + hidden = _user(db, 'hidden', visible=False) + deleted = _user(db, 'deleted', deleted=True) + _solve(db, alice, 200) + _solve(db, alice, 300, 1) + _solve(db, bob, 400) + _solve(db, zero, 0) + _solve(db, hidden, 900) + _solve(db, deleted, 800) + + html = client.get('/scoreboard').get_data(as_text=True) + + assert html.index('>alice') < html.index('>bob') + assert '500' in html + assert '400' in html + assert '>zero' not in html + assert '>hidden' not in html + assert '>deleted' not in html + + +def test_scoreboard_ties_rank_by_time_of_reaching_score(client, db): + zed = _user(db, 'zed') + amy = _user(db, 'Amy') + lower = _user(db, 'lower') + start = datetime(2026, 1, 1, tzinfo=timezone.utc) + _solve(db, zed, 200, created_at=start) + _solve(db, amy, 500, created_at=start + timedelta(minutes=1)) + _solve(db, zed, 300, 1, created_at=start + timedelta(minutes=2)) + _solve(db, lower, 400, created_at=start + timedelta(minutes=3)) + + html = client.get('/scoreboard').get_data(as_text=True) + + assert html.index('>Amy') < html.index('>zed') + assert '1' in html + assert '2' in html + assert '3' in html + + +def test_scoreboard_ties_with_legacy_solve_without_timestamp(client, db): + legacy = _user(db, 'legacy') + newer = _user(db, 'newer') + legacy_id = ObjectId.from_datetime(datetime(2025, 1, 1, tzinfo=timezone.utc)) + db.solve.insert_one({ + '_id': legacy_id, + 'user_hexid': legacy['hexid'], + 'points': 100, + }) + _solve(db, newer, 100, created_at=datetime(2026, 1, 1, tzinfo=timezone.utc)) + + html = client.get('/scoreboard').get_data(as_text=True) + assert html.index('>legacy') < html.index('>newer') + + +def test_scoreboard_uses_latest_legacy_solve_among_mixed_formats(client, db): + mixed = _user(db, 'mixed') + other = _user(db, 'other') + start = datetime(2026, 1, 1, tzinfo=timezone.utc) + _solve(db, mixed, 50, created_at=start) + _solve(db, other, 100, created_at=start + timedelta(days=1)) + db.solve.insert_one({ + '_id': ObjectId.from_datetime(start + timedelta(days=2)), + 'user_hexid': mixed['hexid'], + 'points': 50, + }) + + html = client.get('/scoreboard').get_data(as_text=True) + assert html.index('>other') < html.index('>mixed') + + +def test_zero_point_solve_does_not_change_time_score_was_reached(client, db): + first = _user(db, 'first') + second = _user(db, 'second') + start = datetime(2026, 1, 1, tzinfo=timezone.utc) + _solve(db, first, 500, created_at=start) + _solve(db, second, 500, created_at=start + timedelta(days=1)) + _solve(db, first, 0, 1, created_at=start + timedelta(days=2)) + + html = client.get('/scoreboard').get_data(as_text=True) + assert html.index('>first') < html.index('>second') + + +def test_scoreboard_paginates_with_global_rank(client, db): + for index in range(26): + user = _user(db, f'player-{index:02d}') + _solve(db, user, 1000 - index, index) + + first_page = client.get('/scoreboard').get_data(as_text=True) + assert '>player-00' in first_page + assert '>player-24' in first_page + assert '>player-25' not in first_page + assert 'href="/scoreboard/2"' in first_page + + second_page = client.get('/scoreboard/2').get_data(as_text=True) + assert '>player-00' not in second_page + assert '>player-25' in second_page + assert '26' in second_page + assert 'href="/scoreboard"' in second_page + assert client.get('/scoreboard/0').location == '/scoreboard' + assert client.get('/scoreboard/99').location == '/scoreboard/2' + + +def test_scoreboard_is_linked_from_navigation_but_not_embedded_on_homepage(client): + home = client.get('/').get_data(as_text=True) + assert 'href="/scoreboard" class="btn btn-link">Scoreboard' in home + assert '

      Scoreboard

      ' not in home + assert client.get('/scoreboard').status_code == 200