Add Translations layer (CTFd#2288)

* Add rough translations support into CTFd
* Add `flask-babel` dependency
* Adds language column to users table
* Closes CTFd#570 

---------

Co-authored-by: Miłosz Skaza <milosz.skaza@ctfd.io>

Author: ColdHeat

CTFd/__init__.py

@@ -7,6 +7,7 @@
 import jinja2
 from flask import Flask, Request
 from flask.helpers import safe_join
+from flask_babel import Babel
 from flask_migrate import upgrade
 from jinja2 import FileSystemLoader
 from jinja2.sandbox import SandboxedEnvironment
@@ -28,6 +29,7 @@
 from CTFd.utils.migrations import create_database, migrations, stamp_latest_revision
 from CTFd.utils.sessions import CachingSessionInterface
 from CTFd.utils.updates import update_check
+from CTFd.utils.user import get_locale
 
 __version__ = "3.5.2"
 __channel__ = "oss"
@@ -208,6 +210,10 @@ def create_app(config="CTFd.config.Config"):
         # Register Flask-Migrate
         migrations.init_app(app, db)
 
+        babel = Babel()
+        babel.locale_selector_func = get_locale
+        babel.init_app(app)
+
         # Alembic sqlite support is lacking so we should just create_all anyway
         if url.drivername.startswith("sqlite"):
             # Enable foreign keys for SQLite. This must be before the

CTFd/admin/__init__.py

@@ -1,7 +1,7 @@
 import csv  # noqa: I001
 import datetime
-from io import StringIO
 import os
+from io import StringIO
 
 from flask import Blueprint, abort
 from flask import current_app as app

CTFd/constants/languages.py

@@ -0,0 +1,18 @@
+from CTFd.constants import RawEnum
+
+
+class Languages(str, RawEnum):
+    ENGLISH = "en"
+    GERMAN = "de"
+    POLISH = "pl"
+
+
+LANGUAGE_NAMES = {
+    "en": "English",
+    "de": "Deutsch",
+    "pl": "Polski",
+}
+
+SELECT_LANGUAGE_LIST = [("", "")] + [
+    (str(lang), LANGUAGE_NAMES.get(str(lang))) for lang in Languages
+]

CTFd/constants/users.py

@@ -16,6 +16,7 @@
         "hidden",
         "banned",
         "verified",
+        "language",
         "team_id",
         "created",
     ],

CTFd/forms/auth.py

@@ -1,3 +1,4 @@
+from flask_babel import lazy_gettext as _l
 from wtforms import PasswordField, StringField
 from wtforms.fields.html5 import EmailField
 from wtforms.validators import InputRequired
@@ -15,11 +16,11 @@
 def RegistrationForm(*args, **kwargs):
     class _RegistrationForm(BaseForm):
         name = StringField(
-            "User Name", validators=[InputRequired()], render_kw={"autofocus": True}
+            _l("User Name"), validators=[InputRequired()], render_kw={"autofocus": True}
         )
-        email = EmailField("Email", validators=[InputRequired()])
-        password = PasswordField("Password", validators=[InputRequired()])
-        submit = SubmitField("Submit")
+        email = EmailField(_l("Email"), validators=[InputRequired()])
+        password = PasswordField(_l("Password"), validators=[InputRequired()])
+        submit = SubmitField(_l("Submit"))
 
         @property
         def extra(self):
@@ -35,27 +36,27 @@ def extra(self):
 
 class LoginForm(BaseForm):
     name = StringField(
-        "User Name or Email",
+        _l("User Name or Email"),
         validators=[InputRequired()],
         render_kw={"autofocus": True},
     )
-    password = PasswordField("Password", validators=[InputRequired()])
-    submit = SubmitField("Submit")
+    password = PasswordField(_l("Password"), validators=[InputRequired()])
+    submit = SubmitField(_l("Submit"))
 
 
 class ConfirmForm(BaseForm):
-    submit = SubmitField("Resend Confirmation Email")
+    submit = SubmitField(_l("Resend Confirmation Email"))
 
 
 class ResetPasswordRequestForm(BaseForm):
     email = EmailField(
-        "Email", validators=[InputRequired()], render_kw={"autofocus": True}
+        _l("Email"), validators=[InputRequired()], render_kw={"autofocus": True}
     )
-    submit = SubmitField("Submit")
+    submit = SubmitField(_l("Submit"))
 
 
 class ResetPasswordForm(BaseForm):
     password = PasswordField(
-        "Password", validators=[InputRequired()], render_kw={"autofocus": True}
+        _l("Password"), validators=[InputRequired()], render_kw={"autofocus": True}
     )
-    submit = SubmitField("Submit")
+    submit = SubmitField(_l("Submit"))

CTFd/forms/self.py

@@ -1,7 +1,9 @@
 from flask import session
+from flask_babel import lazy_gettext as _l
 from wtforms import PasswordField, SelectField, StringField
 from wtforms.fields.html5 import DateField, URLField
 
+from CTFd.constants.languages import SELECT_LANGUAGE_LIST
 from CTFd.forms import BaseForm
 from CTFd.forms.fields import SubmitField
 from CTFd.forms.users import attach_custom_user_fields, build_custom_user_fields
@@ -11,14 +13,15 @@
 
 def SettingsForm(*args, **kwargs):
     class _SettingsForm(BaseForm):
-        name = StringField("User Name")
-        email = StringField("Email")
-        password = PasswordField("Password")
-        confirm = PasswordField("Current Password")
-        affiliation = StringField("Affiliation")
-        website = URLField("Website")
-        country = SelectField("Country", choices=SELECT_COUNTRIES_LIST)
-        submit = SubmitField("Submit")
+        name = StringField(_l("User Name"))
+        email = StringField(_l("Email"))
+        language = SelectField(_l("Language"), choices=SELECT_LANGUAGE_LIST)
+        password = PasswordField(_l("Password"))
+        confirm = PasswordField(_l("Current Password"))
+        affiliation = StringField(_l("Affiliation"))
+        website = URLField(_l("Website"))
+        country = SelectField(_l("Country"), choices=SELECT_COUNTRIES_LIST)
+        submit = SubmitField(_l("Submit"))
 
         @property
         def extra(self):
@@ -46,5 +49,5 @@ def get_field_kwargs():
 
 
 class TokensForm(BaseForm):
-    expiration = DateField("Expiration")
-    submit = SubmitField("Generate")
+    expiration = DateField(_l("Expiration"))
+    submit = SubmitField(_l("Generate"))

CTFd/forms/setup.py

@@ -1,3 +1,4 @@
+from flask_babel import lazy_gettext as _l
 from wtforms import (
     FileField,
     HiddenField,
@@ -18,62 +19,72 @@
 
 class SetupForm(BaseForm):
     ctf_name = StringField(
-        "Event Name", description="The name of your CTF event/workshop"
+        _l("Event Name"), description=_l("The name of your CTF event/workshop")
     )
     ctf_description = TextAreaField(
-        "Event Description", description="Description for the CTF"
+        _l("Event Description"), description=_l("Description for the CTF")
     )
     user_mode = RadioField(
-        "User Mode",
-        choices=[("teams", "Team Mode"), ("users", "User Mode")],
+        _l("User Mode"),
+        choices=[("teams", _l("Team Mode")), ("users", _l("User Mode"))],
         default="teams",
-        description="Controls whether users join together in teams to play (Team Mode) or play as themselves (User Mode)",
+        description=_l(
+            "Controls whether users join together in teams to play (Team Mode) or play as themselves (User Mode)"
+        ),
         validators=[InputRequired()],
     )
 
     name = StringField(
-        "Admin Username",
-        description="Your username for the administration account",
+        _l("Admin Username"),
+        description=_l("Your username for the administration account"),
         validators=[InputRequired()],
     )
     email = EmailField(
-        "Admin Email",
-        description="Your email address for the administration account",
+        _l("Admin Email"),
+        description=_l("Your email address for the administration account"),
         validators=[InputRequired()],
     )
     password = PasswordField(
-        "Admin Password",
-        description="Your password for the administration account",
+        _l("Admin Password"),
+        description=_l("Your password for the administration account"),
         validators=[InputRequired()],
     )
 
     ctf_logo = FileField(
-        "Logo",
-        description="Logo to use for the website instead of a CTF name. Used as the home page button. Optional.",
+        _l("Logo"),
+        description=_l(
+            "Logo to use for the website instead of a CTF name. Used as the home page button. Optional."
+        ),
     )
     ctf_banner = FileField(
-        "Banner", description="Banner to use for the homepage. Optional."
+        _l("Banner"), description=_l("Banner to use for the homepage. Optional.")
     )
     ctf_small_icon = FileField(
-        "Small Icon",
-        description="favicon used in user's browsers. Only PNGs accepted. Must be 32x32px. Optional.",
+        _l("Small Icon"),
+        description=_l(
+            "favicon used in user's browsers. Only PNGs accepted. Must be 32x32px. Optional."
+        ),
     )
     ctf_theme = SelectField(
-        "Theme",
-        description="CTFd Theme to use. Can be changed later.",
+        _l("Theme"),
+        description=_l("CTFd Theme to use. Can be changed later."),
         choices=list(zip(get_themes(), get_themes())),
         default=DEFAULT_THEME,
         validators=[InputRequired()],
     )
     theme_color = HiddenField(
-        "Theme Color",
-        description="Color used by theme to control aesthetics. Requires theme support. Optional.",
+        _l("Theme Color"),
+        description=_l(
+            "Color used by theme to control aesthetics. Requires theme support. Optional."
+        ),
     )
 
     start = StringField(
-        "Start Time", description="Time when your CTF is scheduled to start. Optional."
+        _l("Start Time"),
+        description=_l("Time when your CTF is scheduled to start. Optional."),
     )
     end = StringField(
-        "End Time", description="Time when your CTF is scheduled to end. Optional."
+        _l("End Time"),
+        description=_l("Time when your CTF is scheduled to end. Optional."),
     )
-    submit = SubmitField("Finish")
+    submit = SubmitField(_l("Finish"))