v5.0.0 - Overall project restructuring & refactoring

.env.example

@@ -1,16 +1,28 @@
+# the environment your application is running in
+# options include: local, staging, production
+APP_ENV=local
+
 # bancho.py supports both INET and UNIX sockets
 # INET: provide an IP for SERVER_ADDR, and a port for SERVER_PORT
 # UNIX: provide a filesystem path for SERVER_ADDR, and no SERVER_PORT
 SERVER_ADDR=/tmp/bancho.sock
 SERVER_PORT=
 
-DB_DSN=mysql://username:password@localhost:3306/database
-REDIS_DSN=redis://localhost
+# database connections (mysql)
+DB_HOST=localhost
+DB_PORT=3306
+DB_USER=username
+DB_PASS=password
+# NOTE: test db will have a suffix of "_test"
+DB_NAME=bancho
+
+REDIS_HOST=localhost
+REDIS_PORT=6379
 
 OSU_API_KEY=
 
 DOMAIN=cmyui.xyz
-MIRROR_URL=https://api.chimu.moe/v1
+MIRROR_URL=https://catboy.best/api
 
 COMMAND_PREFIX=!
 
@@ -22,17 +34,18 @@ MENU_ONCLICK_URL=https://akatsuki.pw
 DATADOG_API_KEY=
 DATADOG_APP_KEY=
 
-DEBUG=False
+# CRITICAL: 50 | ERROR: 40 | WARNING: 30 | INFO: 20 | DEBUG: 10
+# https://docs.python.org/3/library/logging.html#levels
+LOG_LEVEL=20
 
-# redirect beatmaps, beatmapsets, and forum
+# redirect beatmaps, beatmap sets, and forum
 # pages of maps to the official osu! website
 REDIRECT_OSU_URLS=True
 
 PP_CACHED_ACCS=90,95,98,99,100
 PP_CACHED_SCORES=800000,850000,900000,950000,1000000
 
 DISALLOWED_NAMES=mrekk,vaxei,btmc,cookiezi
-DISALLOWED_PASSWORDS=password,abc123
 
 DISCORD_AUDIT_LOG_WEBHOOK=
 

.gitignore

@@ -8,3 +8,4 @@ ext/GeoLite2-City.mmdb
 .env
 tools/migrate_v420/go.sum
 tools/migrate_v420/scoreMigrator
+.coverage

.pre-commit-config.yaml

@@ -8,7 +8,6 @@ repos:
     -   id: check-ast
     -   id: check-builtin-literals
     -   id: check-yaml
-    -   id: debug-statements
     -   id: end-of-file-fixer
     -   id: requirements-txt-fixer
     -   id: trailing-whitespace

README.md

@@ -41,7 +41,6 @@ we aim to minimize our dependencies, but still rely on ones such as
 - python (programming language)
 - mysql (relational database)
 - nginx (http(s) reverse proxy)
-- certbot (ssl certificate tool)
 - cmake and build-essential (build tools for c/c++)
 
 as well as some others.
@@ -52,10 +51,10 @@ as well as some others.
 sudo add-apt-repository ppa:deadsnakes
 
 # install required programs for running bancho.py
-sudo apt install python3.9-dev python3.9-distutils \
+sudo apt install -y python3.9-dev python3.9-distutils \
                  cmake build-essential \
                  mysql-server redis-server \
-                 nginx certbot
+                 nginx
 
 # install python's package manager, pip
 # it's used to install python-specific dependencies
@@ -73,7 +72,7 @@ python3.9 -m pip install -r requirements.txt
 you will need to create a database for bancho.py to store persistent data.
 
 the server uses this database to store metadata & logs, such as user accounts
-and stats, beatmaps and beatmapsets, chat channels, tourney mappools and more.
+and stats, beatmaps and beatmap sets, chat channels, tourney mappools and more.
 
 ```sh
 # login to mysql's shell with root - the default admin account
@@ -136,22 +135,6 @@ sql commands that can be run in sequence to create the base state we want.
 mysql -u YOUR_DB_USER -p YOUR_DB_NAME < migrations/base.sql
 ```
 
-## creating an ssl certificate (to allow https traffic)
-```sh
-# you'll need to change:
-# - YOUR_EMAIL_ADDRESS
-# - YOUR_DOMAIN
-
-# generate an ssl certificate for your domain
-sudo certbot certonly \
-    --manual \
-    --preferred-challenges=dns \
-    --email YOUR_EMAIL_ADDRESS \
-    --server https://acme-v02.api.letsencrypt.org/directory \
-    --agree-tos \
-    -d *.YOUR_DOMAIN
-```
-
 ## configuring a reverse proxy (we'll use nginx)
 bancho.py relies on a reverse proxy for tls (https) support, and for ease-of-use
 in terms of configuration. nginx is an open-source and efficient web server we'll

app/__init__.py

@@ -2,12 +2,17 @@
 from __future__ import annotations
 
 from . import api
-from . import bg_loops
 from . import commands
 from . import constants
 from . import discord
+from . import housekeeping
 from . import logging
+from . import menus
 from . import objects
 from . import packets
+from . import repositories
+from . import responses
 from . import state
+from . import usecases
 from . import utils
+from . import validation

app/_typing.py

@@ -2,6 +2,46 @@
 
 from ipaddress import IPv4Address
 from ipaddress import IPv6Address
+from typing import Literal
 from typing import Union
 
+AppEnvironments = Literal["local", "staging", "production"]
+
 IPAddress = Union[IPv4Address, IPv6Address]
+
+# some types used within the osu! client
+
+
+OsuClientModes = Literal[
+    "Menu",
+    "Edit",
+    "Play",
+    "Exit",
+    "SelectEdit",
+    "SelectPlay",
+    "SelectDrawings",
+    "Rank",
+    "Update",
+    "Busy",
+    "Unknown",
+    "Lobby",
+    "MatchSetup",
+    "SelectMulti",
+    "RankingVs",
+    "OnlineSelection",
+    "OptionsOffsetWizard",
+    "RankingTagCoop",
+    "RankingTeam",
+    "BeatmapImport",
+    "PackageUpdater",
+    "Benchmark",
+    "Tourney",
+    "Charts",
+]
+
+OsuClientGameModes = Literal[
+    "Osu",
+    "Taiko",
+    "CatchTheBeat",
+    "OsuMania",
+]