Multi language support (#262)

This pull request adds multi-language support #251. It does this via tornado.locale using the load_translations with files of the form LOCALE.csv, e.g. es_LA.csv. According to the documentation, it would use the browser's locale by default and offer the closest matching locale. I created some translations via Google Translate as a starting point / example, located in the locale folder.

If the player wants to force a translation, they can specify "force_locale" in the configuration file to specify a locale file under the locale directory (force_locale="es_LA").

.gitignore

@@ -22,6 +22,9 @@ files/*.cfg
 #Alembic
 alembic/alembic.ini
 
+#Locale
+locale/.~*
+
 # Packages
 *.egg
 *.egg-info

README.md

@@ -24,6 +24,7 @@ Additional platform [screenshots](https://github.com/moloch--/RootTheBox/wiki/Sc
 -   Optional [in-game Botnets](https://github.com/moloch--/RootTheBox/wiki/Features) or wall of sheep displaying cracked passwords
 -   Unlocks and upgrades as users capture flags
 -   Export and share Boxes/Flags
+-   Multiple Language Support
 -   Site Themes and other cool stuff
 
 ## Setup

handlers/BaseHandlers.py

@@ -42,6 +42,7 @@
     from urllib.parse import urlparse
 except ImportError:
     from urlparse import urlparse
+from tornado import locale
 from tornado.web import RequestHandler
 from tornado.ioloop import IOLoop
 from tornado.websocket import WebSocketHandler
@@ -244,6 +245,15 @@ def timer(self):
             timer = str(timerdiff)
         return timer
 
+    def get_user_locale(self):
+        """
+        Get user lang value from config.
+        If None is returned, Tornado fall back to get_browser_locale()
+        """
+        if len(self.config.force_locale) > 0:
+            return locale.get(self.config.force_locale)
+        return None
+
 
 class BaseWebSocketHandler(WebSocketHandler):
 

handlers/__init__.py

@@ -26,20 +26,27 @@
 
 
 import sys
+import tornado.locale
 
 from setup import __version__
 from os import urandom, _exit, path as os_path
+from tornado import netutil, locale
+from tornado.web import Application
+from tornado.httpserver import HTTPServer
+from tornado.ioloop import IOLoop, PeriodicCallback
+from tornado.options import options
+from sqlalchemy.exc import OperationalError
+from alembic.config import Config, command
+from builtins import str
+
 from modules.Menu import Menu
 from modules.Recaptcha import Recaptcha
 from modules.AppTheme import AppTheme
 from libs.ConsoleColors import *
 from libs.Scoreboard import Scoreboard, score_bots
 from libs.GameHistory import GameHistory
-from tornado import netutil
-from tornado.web import Application
-from tornado.httpserver import HTTPServer
-from tornado.ioloop import IOLoop, PeriodicCallback
-from sqlalchemy.exc import OperationalError
+from libs.DatabaseConnection import DatabaseConnection
+from libs.StringCoding import encode
 from handlers.BotnetHandlers import *
 from handlers.UserHandlers import *
 from handlers.AdminHandlers import *
@@ -55,11 +62,7 @@
 from handlers.MaterialsHandler import *
 from handlers.ChefHandler import *
 from handlers.StaticFileHandler import StaticFileHandler
-from alembic.config import Config, command
-from libs.DatabaseConnection import DatabaseConnection
-from libs.StringCoding import encode
-from builtins import str
-from tornado.options import options
+
 
 try:
     from urllib.parse import unquote_plus
@@ -266,6 +269,8 @@ def start_server():
         logging.warn(
             "%sDebug mode is enabled; DO NOT USE THIS IN PRODUCTION%s" % (bold + R, W)
         )
+    locale.set_default_locale("en_US")
+    locale.load_translations("locale")
     if options.autostart_game:
         logging.info("The game is about to begin, good hunting!")
         app.settings["history_callback"].start()