rename server implementation to bancho.py

Author: cmyui

.env.example

@@ -1,7 +1,7 @@
-# gulag supports both INET and UNIX sockets
+# 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/gulag.sock
+SERVER_ADDR=/tmp/bancho.sock
 SERVER_PORT=
 
 DB_DSN=mysql://username:password@localhost:3306/database
@@ -37,7 +37,7 @@ DISALLOWED_PASSWORDS=password,abc123
 DISCORD_AUDIT_LOG_WEBHOOK=
 
 # automatically share information with the primary
-# developer of gulag (https://github.com/cmyui)
+# developer of bancho.py (https://github.com/cmyui)
 # for debugging & development purposes.
 AUTOMATICALLY_REPORT_PROBLEMS=False
 

README.md

@@ -1,18 +1,18 @@
-# gulag - a dev-oriented, production-geared osu! server
+# bancho.py - a dev-oriented, production-geared osu! server
 [![Python 3.9+](https://img.shields.io/badge/python-3.9+-blue.svg)](https://www.python.org/downloads/)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
-[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/osuAkatsuki/gulag/master.svg)](https://results.pre-commit.ci/latest/github/osuAkatsuki/gulag/master)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/osuAkatsuki/bancho.py/master.svg)](https://results.pre-commit.ci/latest/github/osuAkatsuki/bancho.py/master)
 [![Discord](https://discordapp.com/api/guilds/748687781605408908/widget.png?style=shield)](https://discord.gg/ShEQgUx)
 
-gulag is an in-progress osu! server implementation geared towards running production
+bancho.py is an in-progress osu! server implementation geared towards running production
 servers - it is developed primarily by [Akatsuki](https://akatsuki.pw/) with our
 long-term goal being to replace our current [Ripple](https://github.com/osuripple)
 stack with something more easily maintainable, reliable, scalable, and feature-rich.
 
 # Setup
 ```sh
 # clone the repository & init the submodules
-git clone https://github.com/osuAkatsuki/gulag.git && cd gulag
+git clone https://github.com/osuAkatsuki/bancho.py.git && cd bancho.py
 
 # clone the submodules (oppai-ng)
 git submodule update --init
@@ -29,7 +29,7 @@ sudo apt install python3.9-dev python3.9-distutils cmake build-essential \
 wget https://bootstrap.pypa.io/get-pip.py
 python3.9 get-pip.py && rm get-pip.py
 
-# install gulag's python requirements
+# install bancho.py's python requirements
 python3.9 -m pip install -U pip setuptools
 python3.9 -m pip install -r requirements.txt
 
@@ -39,10 +39,10 @@ pre-commit install
 
 ######################################
 # NOTE: before continuing, create an #
-# empty database in mysql for gulag  #
+# empty database in mysql for bancho.py  #
 ######################################
 
-# import gulag's mysql structure
+# import bancho.py's mysql structure
 mysql -u your_sql_username -p your_db_name < migrations/base.sql
 
 # generate an ssl certificate for your domain (change email & domain)
@@ -55,8 +55,8 @@ sudo certbot certonly \
     -d *.your.domain
 
 # copy our nginx config to `sites-enabled` & open for editing
-sudo cp ext/nginx.conf /etc/nginx/sites-enabled/gulag.conf
-sudo nano /etc/nginx/sites-enabled/gulag.conf
+sudo cp ext/nginx.conf /etc/nginx/sites-enabled/bancho.conf
+sudo nano /etc/nginx/sites-enabled/bancho.conf
 
 ##########################################
 # NOTE: before continuing, make sure you #
@@ -124,5 +124,5 @@ nano .env
     |
     ├── ext                   # external entities used when running the server
     ├── migrations            # database migrations - updates to schema
-    ├── tools                 # various tools made throughout gulag's history
+    ├── tools                 # various tools made throughout bancho.py's history
     └── main.py               # an entry point (script) to run the server

app/api/domains/api.py

@@ -1,4 +1,4 @@
-""" api: gulag's developer api for interacting with server state """
+""" api: bancho.py's developer api for interacting with server state """
 from __future__ import annotations
 
 import hashlib
@@ -31,7 +31,7 @@
 SCREENSHOTS_PATH = SystemPath.cwd() / ".data/ss"
 
 
-router = APIRouter(tags=["gulag API"])
+router = APIRouter(tags=["bancho.py API"])
 
 # NOTE: the api is still under design and is subject to change.
 # to keep up with breaking changes, please either join our discord,
@@ -188,13 +188,13 @@ async def api_get_player_info(
 
         for idx, mode_stats in enumerate([dict(row) for row in rows]):
             rank = await app.state.services.redis.zrevrank(
-                f"gulag:leaderboard:{idx}",
+                f"bancho:leaderboard:{idx}",
                 str(resolved_user_id),
             )
             mode_stats["rank"] = rank + 1 if rank is not None else 0
 
             country_rank = await app.state.services.redis.zrevrank(
-                f"gulag:leaderboard:{idx}:{resolved_country}",
+                f"bancho:leaderboard:{idx}:{resolved_country}",
                 str(resolved_user_id),
             )
             mode_stats["country_rank"] = (

app/api/domains/cho.py

@@ -87,9 +87,9 @@ async def bancho_http_handler():
         b"<!DOCTYPE html>"
         + "<br>".join(
             (
-                f"Running gulag v{app.settings.VERSION}",
+                f"Running bancho.py v{app.settings.VERSION}",
                 f"Players online: {len(app.state.sessions.players) - 1}",
-                '<a href="https://github.com/cmyui/gulag">Source code</a>',
+                '<a href="https://github.com/osuAkatsuki/bancho.py">Source code</a>',
                 "",
                 f"<b>packets handled ({len(packets)})</b>",
                 "<br>".join([f"{p.name} ({p.value})" for p in packets]),
@@ -377,7 +377,7 @@ async def handle(self, p: Player) -> None:
 )
 
 WELCOME_NOTIFICATION = app.packets.notification(
-    f"Welcome back to {BASE_DOMAIN}!\nRunning gulag v{app.settings.VERSION}.",
+    f"Welcome back to {BASE_DOMAIN}!\nRunning bancho.py v{app.settings.VERSION}.",
 )
 
 OFFLINE_NOTIFICATION = app.packets.notification(
@@ -700,7 +700,7 @@ async def login(
             user_info["geoloc"] = await app.state.services.fetch_geoloc_web(ip)
 
         if db_country == "xx":
-            # bugfix for old gulag versions when
+            # bugfix for old bancho.py versions when
             # country wasn't stored on registration.
             log(f"Fixing {username}'s country.", Ansi.LGREEN)
 
@@ -882,10 +882,10 @@ async def login(
 
     if app.state.services.datadog:
         if not p.restricted:
-            app.state.services.datadog.increment("gulag.online_players")
+            app.state.services.datadog.increment("bancho.online_players")
 
         time_taken = time.time() - login_time
-        app.state.services.datadog.histogram("gulag.login_time", time_taken)
+        app.state.services.datadog.histogram("bancho.login_time", time_taken)
 
     user_os = "unix (wine)" if is_wine else "win32"
     country_code = p.geoloc["country"]["acronym"].upper()

app/api/domains/osu.py

@@ -224,14 +224,14 @@ async def osuGetFriends(
     return "\n".join(map(str, player.friends)).encode()
 
 
-def gulag_to_osuapi_status(gulag_status: int) -> int:
+def bancho_to_osuapi_status(bancho_status: int) -> int:
     return {
         0: 0,
         2: 1,
         3: 2,
         4: 3,
         5: 4,
-    }[gulag_status]
+    }[bancho_status]
 
 
 @router.post("/web/osu-getbeatmapinfo.php")
@@ -257,8 +257,8 @@ async def osuGetBeatmapInfo(
 
         row = dict(row)  # make mutable copy
 
-        # convert from gulag -> osu!api status
-        row["status"] = gulag_to_osuapi_status(row["status"])
+        # convert from bancho.py -> osu!api status
+        row["status"] = bancho_to_osuapi_status(row["status"])
 
         # try to get the user's grades on the map osu!
         # only allows us to send back one per gamemode,
@@ -410,7 +410,7 @@ async def lastFM(
     """
 
 
-# gulag supports both cheesegull mirrors & chimu.moe.
+# bancho.py supports both cheesegull mirrors & chimu.moe.
 # chimu.moe handles things a bit differently than cheesegull,
 # and has some extra features we'll eventually use more of.
 USING_CHIMU = "chimu.moe" in app.settings.MIRROR_URL
@@ -685,11 +685,11 @@ async def osuSubmitModularSelector(
     """ Score submission checks completed; submit the score. """
 
     if app.state.services.datadog:
-        app.state.services.datadog.increment("gulag.submitted_scores")
+        app.state.services.datadog.increment("bancho.submitted_scores")
 
     if score.status == SubmissionStatus.BEST:
         if app.state.services.datadog:
-            app.state.services.datadog.increment("gulag.submitted_scores_best")
+            app.state.services.datadog.increment("bancho.submitted_scores_best")
 
         if score.bmap.has_leaderboard:
             if (
@@ -1243,7 +1243,7 @@ async def getScores(
     # we've found a beatmap for the request.
 
     if app.state.services.datadog:
-        app.state.services.datadog.increment("gulag.leaderboards_served")
+        app.state.services.datadog.increment("bancho.leaderboards_served")
 
     if bmap.status < RankedStatus.Ranked:
         # only show leaderboards for ranked,
@@ -1792,7 +1792,7 @@ async def register_account(
             )
 
         if app.state.services.datadog:
-            app.state.services.datadog.increment("gulag.registrations")
+            app.state.services.datadog.increment("bancho.registrations")
 
         log(f"<{username} ({user_id})> has registered!", Ansi.LGREEN)
 

app/api/init_api.py

@@ -93,7 +93,7 @@ async def on_startup() -> None:
                 flush_in_thread=True,
                 flush_interval=15,
             )
-            app.state.services.datadog.gauge("gulag.online_players", 0)
+            app.state.services.datadog.gauge("bancho.online_players", 0)
 
         app.state.services.ip_resolver = app.state.services.IPResolver()
 
@@ -138,7 +138,7 @@ def init_routes(asgi_app: FastAPI) -> None:
         asgi_app.host(f"osu.{domain}", domains.osu.router)
         asgi_app.host(f"b.{domain}", domains.map.router)
 
-        # gulag's developer-facing api
+        # bancho.py's developer-facing api
         asgi_app.host(f"api.{domain}", domains.api.router)
 
 

app/commands.py

@@ -349,7 +349,7 @@ async def recent(ctx: Context) -> Optional[str]:
         rank = s.rank if s.status == SubmissionStatus.BEST else "NA"
         l.append(f"PASS {{{s.pp:.2f}pp #{rank}}}")
     else:
-        # XXX: prior to v3.2.0, gulag didn't parse total_length from
+        # XXX: prior to v3.2.0, bancho.py didn't parse total_length from
         # the osu!api, and thus this can do some zerodivision moments.
         # this can probably be removed in the future, or better yet
         # replaced with a better system to fix the maps.
@@ -1440,7 +1440,7 @@ async def reload(ctx: Context) -> Optional[str]:
 async def server(ctx: Context) -> Optional[str]:
     """Retrieve performance data about the server."""
 
-    build_str = f"gulag v{app.settings.VERSION} ({app.settings.DOMAIN})"
+    build_str = f"bancho.py v{app.settings.VERSION} ({app.settings.DOMAIN})"
 
     # get info about this process
     proc = psutil.Process(os.getpid())
@@ -1463,9 +1463,9 @@ async def server(ctx: Context) -> Optional[str]:
     # get system-wide ram usage
     sys_ram = psutil.virtual_memory()
 
-    # output ram usage as `{gulag_used}MB / {sys_used}MB / {sys_total}MB`
-    gulag_ram = proc.memory_info()[0]
-    ram_values = (gulag_ram, sys_ram.used, sys_ram.total)
+    # output ram usage as `{bancho_used}MB / {sys_used}MB / {sys_total}MB`
+    bancho_ram = proc.memory_info()[0]
+    ram_values = (bancho_ram, sys_ram.used, sys_ram.total)
     ram_info = " / ".join([f"{v // 1024 ** 2}MB" for v in ram_values])
 
     # current state of settings
@@ -1532,7 +1532,7 @@ async def server(ctx: Context) -> Optional[str]:
     @command(Privileges.DEVELOPER)
     async def py(ctx: Context) -> Optional[str]:
         """Allow for (async) access to the python interpreter."""
-        # This can be very good for getting used to gulag's API; just look
+        # This can be very good for getting used to bancho.py's API; just look
         # around the codebase and find things to play with in your server.
         # Ex: !py return (await app.state.sessions.players.get(name='cmyui')).status.action
         if not ctx.args:
@@ -1973,7 +1973,7 @@ async def mp_condition(ctx: Context, match: Match) -> Optional[str]:
 
     if cond == "pp":
         # special case - pp can't actually be used as an ingame
-        # win condition, but gulag allows it to be passed into
+        # win condition, but bancho.py allows it to be passed into
         # this command during a scrims to use pp as a win cond.
         if not match.is_scrimming:
             return "PP is only useful as a win condition during scrims."
@@ -2462,7 +2462,7 @@ async def pool_info(ctx: Context) -> Optional[str]:
 
 
 """ Clan managment commands
-# The commands below are for managing gulag
+# The commands below are for managing bancho.py
 # clans, for users, clan staff, and server staff.
 """
 
@@ -2653,7 +2653,7 @@ async def clan_list(ctx: Context) -> Optional[str]:
     if offset >= (total_clans := len(app.state.sessions.clans)):
         return "No clans found."
 
-    msg = [f"gulag clans listing ({total_clans} total)."]
+    msg = [f"bancho.py clans listing ({total_clans} total)."]
 
     for idx, clan in enumerate(app.state.sessions.clans, offset):
         msg.append(f"{idx + 1}. {clan!r}")

app/objects/beatmap.py

@@ -452,7 +452,7 @@ async def from_bid(cls, bid: int) -> Optional[Beatmap]:
     """ Lower level API """
     # These functions are meant for internal use under
     # all normal circumstances and should only be used
-    # if you're really modifying gulag by adding new
+    # if you're really modifying bancho.py by adding new
     # features, or perhaps optimizing parts of the code.
 
     def _parse_from_osuapi_resp(self, osuapi_resp: dict[str, Any]) -> None:
@@ -608,7 +608,7 @@ def all_officially_ranked_or_approved(self) -> bool:
         for bmap in self.maps:
             if (
                 bmap.status not in (RankedStatus.Ranked, RankedStatus.Approved)
-                or bmap.frozen  # ranked/approved, but only on gulag
+                or bmap.frozen  # ranked/approved, but only on bancho.py
             ):
                 return False
         return True
@@ -619,7 +619,7 @@ def all_officially_loved(self) -> bool:
         for bmap in self.maps:
             if (
                 bmap.status != RankedStatus.Loved
-                or bmap.frozen  # loved, but only on gulag
+                or bmap.frozen  # loved, but only on bancho.py
             ):
                 return False
         return True
@@ -696,7 +696,7 @@ async def _update_if_available(self) -> None:
 
                     bmap._parse_from_osuapi_resp(new_map)
 
-                    # (some gulag-specific stuff not given by api)
+                    # (some implementation-specific stuff not given by api)
                     bmap.frozen = False
                     bmap.passes = 0
                     bmap.plays = 0
@@ -844,7 +844,7 @@ async def _from_bsid_sql(cls, bsid: int) -> Optional[BeatmapSet]:
             ):
                 bmap = Beatmap(**row, map_set=bmap_set)
 
-                # XXX: tempfix for gulag <v3.4.1,
+                # XXX: tempfix for bancho.py <v3.4.1,
                 # where filenames weren't stored.
                 if not bmap.filename:
                     bmap.filename = (
@@ -868,7 +868,7 @@ async def _from_bsid_osuapi(cls, bsid: int) -> Optional[BeatmapSet]:
         if api_data := await osuapiv1_getbeatmaps(s=bsid):
             self = cls(id=bsid, last_osuapi_check=datetime.now())
 
-            # XXX: pre-mapset gulag support
+            # XXX: pre-mapset bancho.py support
             # select all current beatmaps
             # that're frozen in the db
             res = await app.state.services.database.fetch_all(
@@ -892,7 +892,7 @@ async def _from_bsid_osuapi(cls, bsid: int) -> Optional[BeatmapSet]:
 
                 bmap._parse_from_osuapi_resp(api_bmap)
 
-                # (some gulag-specific stuff not given by api)
+                # (some implementation-specific stuff not given by api)
                 bmap.passes = 0
                 bmap.plays = 0
 

app/objects/clan.py

@@ -15,7 +15,7 @@
 
 
 class Clan:
-    """A class to represent a single gulag clan."""
+    """A class to represent a single bancho.py clan."""
 
     __slots__ = ("id", "name", "tag", "created_at", "owner_id", "member_ids")
 
@@ -28,7 +28,7 @@ def __init__(
         owner_id: int,
         member_ids: set[int] = set(),
     ) -> None:
-        """A class representing one of gulag's clans."""
+        """A class representing one of bancho.py's clans."""
         self.id = id
         self.name = name
         self.tag = tag