1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853
|
import argparse
import asyncio
import errno
import functools
import logging
import logging.handlers
import os
import os.path
import sys
import signal
import time
import tornado.httpserver
import tornado.ioloop
import tornado.netutil
import tornado.template
import tornado.web
from tornado.ioloop import IOLoop
from tornado.netutil import bind_sockets
# do not add tornado.platform here without changing do_chroot()
import webtiles
from webtiles import auth, load_games, process_handler, userdb, config
from webtiles import game_data_handler, util, ws_handler, status
servers = None
https_port = None
# port should already be formatted with a ":"
class HTTPSRedirectHandler(tornado.web.RequestHandler):
def get(self):
global https_port
if https_port is None:
# this will probably break unless 80/443 are in use
https_port = ""
self.redirect(f"https://{self.request.host_name}{https_port}{self.request.uri}", permanent=True)
class MainHandler(tornado.web.RequestHandler):
# async def _execute(self, transforms, *args, **kwargs):
# await tornado.web.RequestHandler._execute(self, transforms, *args, **kwargs)
def get(self):
host = self.request.host
if self.request.protocol == "https" or self.request.headers.get("x-forwarded-proto") == "https":
protocol = "wss://"
else:
protocol = "ws://"
recovery_token = None
recovery_token_error = None
recovery_token = self.get_argument("ResetToken",None)
if recovery_token:
recovery_token_error = userdb.find_recovery_token(recovery_token)[2]
if recovery_token_error:
logging.warning("Recovery token error from %s", self.request.remote_ip)
with util.SlowWarning("Slow IO: render client.html"):
self.render("client.html", socket_server = protocol + host + "/socket",
game_version = _crawl_version,
username = None,
config = config,
reset_token = recovery_token, reset_token_error = recovery_token_error)
class NoCacheHandler(tornado.web.StaticFileHandler):
def set_extra_headers(self, path):
self.set_header("Cache-Control", "no-cache, no-store, must-revalidate")
self.set_header("Pragma", "no-cache")
self.set_header("Expires", "0")
_crawl_version = "unknown"
def load_version():
global _crawl_version
try:
# this is the "bad" way to do this. However, the supposedly good ways
# to do this are all insanely complicated in ways that are irrelevant
# to webtiles.
with open(os.path.join(os.path.dirname(__file__), 'version.txt')) as f:
_crawl_version = f.readline().strip()
except:
_crawl_version = "unknown"
def version_data():
v = sys.version_info
supported = 8 # minimum version, see https://devguide.python.org/versions/
return dict(
webtiles=_crawl_version,
tornado=tornado.version,
python="%d.%d.%d" % (v[0], v[1], v[2]),
python_supported=v[0] >= 3 and v[1] >= supported)
def version():
vdata = version_data()
# TODO convert to f string some day...
result = "Webtiles (%s) running with Tornado %s and Python %s" % (
vdata["webtiles"],
vdata["tornado"],
vdata["python"])
if not vdata['python_supported']:
result = result + "\nUnsupported Python version! Please use a supported version: https://devguide.python.org/versions/"
return result
def err_exit(errmsg, exc_info=False):
if exc_info or config.get('logging_config').get('filename'):
# don't print duplicate messages on stdout
logging.error(errmsg, exc_info=exc_info)
sys.exit(errmsg)
def daemonize():
try:
pid = os.fork()
if pid > 0:
os._exit(0)
except OSError as e:
err_exit("Fork #1 failed! (%s)" % (e.strerror))
os.setsid()
try:
pid = os.fork()
if pid > 0:
os._exit(0)
except OSError as e:
err_exit("Fork #2 failed! (%s)" % e.strerror)
with open("/dev/null", "r") as f:
os.dup2(f.fileno(), sys.stdin.fileno())
with open("/dev/null", "w") as f:
os.dup2(f.fileno(), sys.stdout.fileno())
os.dup2(f.fileno(), sys.stderr.fileno())
def write_pidfile():
pidfile = config.get('pidfile')
if not pidfile:
return
if os.path.exists(pidfile):
try:
with open(pidfile) as f:
pid = int(f.read())
except ValueError:
err_exit("PIDfile %s contains non-numeric value" % pidfile)
try:
os.kill(pid, 0)
except OSError as why:
if why.errno == errno.ESRCH:
# The pid doesn't exist.
logging.warn("Removing stale pidfile %s" % pidfile)
os.remove(pidfile)
else:
err_exit("Can't check status of PID %s from pidfile %s: %s" %
(pid, pidfile, why.strerror))
else:
err_exit("Another Webtiles server is running, PID %s\n" % pid)
with open(pidfile, "w") as f:
f.write(str(os.getpid()))
def remove_pidfile():
pidfile = config.get('pidfile')
if not pidfile:
return
try:
os.remove(pidfile)
except OSError as e:
if e.errno == errno.EACCES or e.errno == errno.EPERM:
logging.warn("No permission to delete pidfile!")
else:
logging.error("Failed to delete pidfile!")
except:
logging.error("Failed to delete pidfile!")
def shed_privileges():
if config.get('gid') is not None:
os.setgid(config.get('gid'))
if config.get('uid') is not None:
os.setuid(config.get('uid'))
def all_tasks_compat():
try:
# only present since py37; maybe safe to assume?
return asyncio.all_tasks()
except AttributeError:
# removed in py39
return asyncio.Task.all_tasks()
def stop_everything(shutdown_event):
# prevent reload signals from interacting with shutdown
if config.get('hup_reloads_config'):
asyncio.get_event_loop().remove_signal_handler(signal.SIGHUP)
asyncio.get_event_loop().remove_signal_handler(signal.SIGUSR1)
global servers
# shut down servers first -- stop accepting new connections
for server in servers:
server.stop()
# shut down ongoing games
# XX any errors in this code will prevent shutdown, do something more?
ws_handler.shutdown()
# an open question -- are there cases where even stronger measures might be
# needed for stuck processes? task.cancel() handled everything I could think
# of locally.
def do_stop(tries=0):
if len(ws_handler.sockets) == 0:
shutdown_event.set()
elif tries > 60: # 30s
# try something a bit stronger
logging.error("Stop failed after 30s, cancelling remaining tasks.")
logging.error("Remaining sockets: %s", ws_handler.describe_sockets(names=True))
for task in all_tasks_compat():
task.cancel()
else:
IOLoop.current().add_timeout(time.time() + 0.5,
functools.partial(do_stop, tries=tries + 1))
do_stop()
def stop_handler(signum, shutdown_event):
logging.info("Received signal %i, beginning shutdown.", signum)
IOLoop.current().add_callback(functools.partial(stop_everything, shutdown_event))
def reload_config_handler(signum):
logging.info("Received signal %i, reloading all config data.", signum)
IOLoop.current().add_callback(config.reload)
def reload_games_handler(signum):
logging.info("Received signal %i, reloading game config data.", signum)
IOLoop.current().add_callback_from_signal(config.load_game_data)
def bind_server_sockets():
nonsecure = []
secure = []
if config.get('bind_nonsecure'):
if config.get('bind_pairs'):
listens = config.get('bind_pairs')
else:
listens = ( (config.get('bind_address'), config.get('bind_port')), )
for (addr, port) in listens:
logging.info("Listening on http://%s:%d" % (addr, port))
nonsecure.append(bind_sockets(port, addr))
if config.get('ssl_options'):
if config.get('ssl_bind_pairs'):
listens = config.get('ssl_bind_pairs')
else:
listens = ( (config.get('ssl_address'), config.get('ssl_port')), )
global https_port
for (addr, port) in listens:
logging.info("Listening on https://%s:%d" % (addr, port))
if https_port is None:
https_port = f":{port}"
secure.append(bind_sockets(port, addr))
return nonsecure, secure
def bind_server(nonsecure_sockets, secure_sockets):
settings = {
"static_path": config.get('static_path'),
"template_loader": util.DynamicTemplateLoader.get(config.get('template_path')),
"debug": bool(config.get('development_mode', False)),
}
if config.get('no_cache', False):
settings["static_handler_class"] = NoCacheHandler
handlers = [
(r"/", MainHandler),
(r"/socket", ws_handler.CrawlWebSocket),
(r"/gamedata/([0-9a-f]*\/.*)", game_data_handler.GameDataHandler),
(r"/status/lobby/", status.LobbyHandler),
(r"/status/version/", status.VersionHandler),
]
application = tornado.web.Application(handlers,
gzip=config.get('use_gzip'), **settings)
kwargs = {}
if config.get('http_connection_timeout') is not None:
kwargs["idle_connection_timeout"] = config.get('http_connection_timeout')
# TODO: the logic looks odd here, as it is set to None in the default
# config.py. But I'm not really sure how this is used so I don't want to
# mess with it...
if config.get('http_xheaders', False):
kwargs["xheaders"] = config.get('http_xheaders')
global servers
servers = []
if nonsecure_sockets:
if config.get('bind_nonsecure') == "redirect":
http_app = tornado.web.Application([(r"/", HTTPSRedirectHandler)])
else:
http_app = application
server = tornado.httpserver.HTTPServer(http_app, **kwargs)
for s in nonsecure_sockets:
server.add_sockets(s)
servers.append(server)
if secure_sockets:
# TODO: allow different ssl_options per bind pair?
server = tornado.httpserver.HTTPServer(application,
ssl_options=config.get('ssl_options'), **kwargs)
for s in secure_sockets:
server.add_sockets(s)
servers.append(server)
if not servers:
# config validation should preempt this, but it's here for robustness
raise ValueError("No ports succesfully configured!")
return servers
def init_logging(logging_config):
filename = logging_config.get("filename")
if filename:
max_bytes = logging_config.get("max_bytes", 10*1000*1000)
backup_count = logging_config.get("backup_count", 5)
hdlr = logging.handlers.RotatingFileHandler(
filename, maxBytes=max_bytes, backupCount=backup_count)
else:
hdlr = logging.StreamHandler(None)
fs = logging_config.get("format", "%(levelname)s:%(name)s:%(message)s")
dfs = logging_config.get("datefmt", None)
fmt = logging.Formatter(fs, dfs)
hdlr.setFormatter(fmt)
logging.getLogger().addHandler(hdlr)
level = logging_config.get("level")
if level is not None:
logging.getLogger().setLevel(level)
if tornado.version_info[0] >= 3:
# hide regular successful access messages, e.g. `200 GET` messages
# messages. 404s are still shown. TODO: would there be demand for
# sending this to its own file in a configurable way?
logging.getLogger("tornado.access").setLevel(logging.WARNING)
else:
# the tornado version is ancient enough that it doesn't have its own
# logging streams; this filter suppresses any logging done from the
# `web` module at level INFO.
logging.getLogger().addFilter(util.TornadoFilter())
logging.addLevelName(logging.DEBUG, "DEBG")
logging.addLevelName(logging.WARNING, "WARN")
def parse_args_main():
parser = argparse.ArgumentParser(
description='Dungeon Crawl webtiles server',
epilog='Command line options will override config settings. See wtutil.py for database commands.')
parser.add_argument('-p', '--port', type=int, help='A port to bind; disables SSL.')
parser.add_argument('--ssl-port', type=int, help='An SSL port to bind. Requires configured `ssl_options`.')
parser.add_argument('--logfile',
help='A logfile to write to; use "-" for stdout.')
parser.add_argument('--daemon', action='store_true', default=None,
help='Daemonize after start.')
parser.add_argument('-n', '--no-daemon', action='store_false', default=None,
dest='daemon',
help='Do not daemonize after start.')
parser.add_argument('--no-pidfile', dest='pidfile', action='store_false',
default=None, help='Do not use a PID-file.')
# live debug mode is intended to be able to run (more or less) safely with
# a concurrent real webtiles server. However, still be careful with this...
parser.add_argument('--live-debug', action='store_true',
help=('Debug mode for server admins. Will use a separate directory for sockets. '
'Entails --no-pidfile, --no-daemon, --logfile -, watch_socket_dirs=False. '
'(Further command line options can override these.)'))
result = parser.parse_args()
if result.live_debug:
if not result.logfile:
result.logfile = '-'
if result.daemon is None:
result.daemon = False
result.pidfile = False
config.set('live_debug', True)
return result
# override config with any arguments supplied on the command line
def export_args_to_config(args):
if config.get('live_debug'):
config.server_config._load_override_file(os.path.join(
config.get("server_path", ""), "debug-config.yml"))
config.do_early_logging() # sigh
if args.port:
if args.ssl_port:
err_exit("Can't combine --port and --ssl-port.")
config.set('bind_nonsecure', True)
config.set('bind_address', "") # TODO: ??
config.set('bind_port', args.port)
if config.get('bind_pairs') is not None:
config.pop('bind_pairs')
logging.info("Using command-line supplied port: %d", args.port)
if config.get('ssl_options'):
logging.info(" (Overrides config-specified SSL settings.)")
config.set('ssl_options', None)
elif args.ssl_port:
config.set('bind_nonsecure', False)
config.set('ssl_bind_pairs', (('', args.ssl_port),))
if not config.get('ssl_options'):
err_exit("--ssl-port option requires configured `ssl_options`")
logging.info("Using command-line supplied ssl port: %d", args.ssl_port)
if args.daemon is not None:
logging.info("Command line override for daemonize: %r", args.daemon)
config.set('daemon', args.daemon)
if args.pidfile is not None:
if not args.pidfile:
if config.get('pidfile'):
logging.info("Command line overrides config-specified PID file!")
config.set('pidfile', None)
def reset_token_commands(args):
if args.clear_reset:
username = args.clear_reset
else:
username = args.reset
user_info = userdb.get_user_info(username)
if not user_info:
err_exit("Reset/clear password failed; invalid user: %s" % username)
username = user_info.username # canonicalize
# don't crash on the default config
if config.get('lobby_url') is None:
config.set('lobby_url', "[insert lobby url here]")
if args.clear_reset:
ok, msg = userdb.clear_password_token(username)
if not ok:
err_exit("Error clearing password reset token for %s: %s" % (username, msg))
else:
print("Password reset token cleared for account '%s'." % username)
return True
else:
ok, msg = userdb.generate_forgot_password(username)
if not ok:
err_exit("Error generating password reset token for %s: %s" % (username, msg))
else:
if not user_info.email:
logging.warning("No email set for account '%s', use caution!" % username)
print("Setting a password reset token on account '%s'." % username)
print("Email: %s\nMessage body to send to user:\n%s\n" % (user_info.email, msg))
return True
return False
def mode_to_flag(mode):
if mode == "admin":
return userdb.DGLACCT_ADMIN
elif mode == "ban":
return userdb.DGLACCT_LOGIN_LOCK
elif mode == "hold":
return userdb.DGLACCT_ACCOUNT_HOLD
elif mode == "wizard":
if not config.get('wizard_accounts'):
logging.warning("Wizard accounts not enabled on this server, do you want `admin`?")
return userdb.DGLACCT_WIZARD
elif mode == "bot":
if not config.get('bot_accounts'):
logging.warning("Bot accounts are not enabled on this server...")
return userdb.DGLACCT_BOT
return 0
def show_flags(username):
r = userdb.get_user_info(username)
if not r:
err_exit("Unknown user '%s'!" % username)
# XX would be nice to normalize username
if not r.flags:
print("User '%s' (id %d) has no flags set." % (r.username, r.id))
else:
print("Flags for '%s' (id %d): %s" % (r.username, r.id, userdb.flag_description(r.flags)))
return True
def flag_commands(args):
if args.show:
return show_flags(args.show)
# everything below here needs an explicit flag
if not args.flag:
print("Missing flag to query!", file=sys.stderr)
return False
flag = mode_to_flag(args.flag)
if not flag:
print("Unknown flag '%s'" % args.list, file=sys.stderr)
return False
if args.list:
l = userdb.get_users_by_flag(flag)
if not l:
print("No matching users.")
else:
print("Users with flag '%s': %s" %
(userdb.flag_description(flag), ", ".join([u.username for u in l])))
return True
elif args.set:
r = userdb.set_flags(args.set, flag, mask=flag)
if r:
err_exit("Error when setting flag %s for '%s': %s" % (args.set, arg.flag, r))
else:
print("Flag set.")
show_flags(args.set)
return True
elif args.clear:
r = userdb.set_flags(args.clear, 0, mask=flag)
if r:
err_exit("Error when clearing flag %s for '%s': %s" % (args.clear, arg.flag, r))
else:
print("Flag cleared.")
show_flags(args.clear)
return True
return False
def ban_commands(args):
if args.check_config_bans or args.run_config_bans:
# potentially very heavy commands on old servers...
all_users = userdb.get_all_users()
affected = [n.username for n in all_users if not config.check_name(n.username)]
if not affected:
print("No affected users.")
return True
if args.check_config_bans:
print("%d existing user(s) have banned names:" % len(affected))
else:
print("Banning %d user(s)!" % len(affected))
for n in affected:
userdb.set_ban(n, True)
if affected:
print(" Affected users: %s" % ', '.join(affected))
return True
elif args.list or args.list_holds:
banned, held = userdb.get_bans()
if args.list:
if len(banned):
print("Banned users: " + ", ".join(banned))
else:
print("No banned users!")
if len(held):
print("Account holds: " + ", ".join(held))
else:
print("No account holds!")
return True
elif args.clear_holds:
banned, held = userdb.get_bans()
if len(held):
cleared = []
for u in held:
err = userdb.set_account_hold(u, False)
if err:
err_exit("Error when clearing hold for '%s': %s" % (u, err))
else:
cleared.append(u)
if len(cleared):
print("Holds cleared for: " + ", ".join(cleared))
else:
print("No holds cleared.")
else:
print("No holds to clear.")
return True
elif args.add:
err = userdb.set_ban(args.add, True)
if err:
err_exit("Error when trying to ban user '%s': %s" % (args.add, err))
else:
print("'%s' is now banned." % args.add)
return True
elif args.hold:
err = userdb.set_account_hold(args.hold, True)
if err:
err_exit("Error when trying to set hold for user '%s': %s" % (args.hold, err))
else:
print("Account hold set for '%s'." % args.hold)
return True
elif args.clear:
err1 = userdb.set_account_hold(args.clear, False)
if err1:
err2 = userdb.set_ban(args.clear, False)
if err2:
err_exit("Error when trying to clear hold for user '%s': %s" % (args.clear, err2))
else:
print("'%s' is no longer banned." % args.clear)
else:
print("Account hold cleared for '%s'." % args.clear)
return True
return False
def parse_args_util():
parser = argparse.ArgumentParser(
description='Dungeon Crawl webtiles utilities.',
epilog='Command line options will override config settings.')
parser.add_argument('--logfile',
default='-',
help='A logfile to write to; use "-" for stdout (the default, overrides config).')
subparsers = parser.add_subparsers(help='Mode', dest='mode')
subparsers.required = True
parser_pw = subparsers.add_parser('password',
help="Set and clear password reset tokens.",
description="Set and clear password reset tokens.")
parser_pw.add_argument('--reset', type=str,
help='Generate a password reset token for the specified username.')
parser_pw.add_argument('--clear-reset', type=str,
help='Clear any password reset tokens for the specified username.')
parser_ban = subparsers.add_parser('ban',
help="Set and clear bans and account holds by username.",
description="Set and clear bans and account holds by username.")
parser_ban.add_argument('--add', type=str, help='Set an account ban for a user. Replaces any account holds.')
parser_ban.add_argument('--hold', type=str, help='Set an account hold for a user. Replaces any ban flags.')
parser_ban.add_argument('--clear', type=str, help='Clear a ban/hold for a user.')
parser_ban.add_argument('--run-config-bans', action='store_true',
help='Ban any existing usernames disallowed by server config banned name options')
parser_ban.add_argument('--check-config-bans', action='store_true',
help='List any existing usernames that would be banned by --run-config-bans')
parser_ban.add_argument('--list', action='store_true',
help='List current banned users and account holds.')
parser_ban.add_argument('--list-holds', action='store_true',
help='List current account holds.')
parser_ban.add_argument ('--clear-holds', action='store_true',
help='Clear all current account holds')
parser_flag = subparsers.add_parser('flag',
help="Low level interface to query and set userdb flags.",
description="Low-level interface to query and set userdb flags. For managing bans/holds, the 'ban' command is recommended instead.")
parser_flag.add_argument('flag', type=str, nargs='?', default="", help='a flag to query with (ban, hold, admin, wizard, bot)')
parser_flag.add_argument('--list', action='store_true',
help='List any users with the indicated flag')
parser_flag.add_argument('--set', type=str, help='Set a flag on a specified user.')
parser_flag.add_argument('--clear', type=str, help='Clear a flag on a specified user.')
parser_flag.add_argument('--show', type=str, help='Show flags on a specified user (does not require [flag]).')
result = parser.parse_args()
help_fun = parser.print_help
if result.mode == "password":
help_fun = parser_pw.print_help
elif result.mode == "ban":
help_fun = parser_ban.print_help
elif result.mode == "flag":
help_fun = parser_flag.print_help
if not result.logfile:
result.logfile = '-'
result.daemon = False
result.pidfile = False
return result, help_fun
def do_chroot():
if config.get('chroot'):
os.chroot(config.get('chroot'))
try:
# try to fail early, with an informative message, if this is not
# going to work
# the choice of tornado.platform is a bit heuristic, but it is
# currently where the webserver seems to fail on import after a chroot.
# If it is ever imported at the top of this file, something else would
# be needed.
import tornado.platform
except:
# no logging available yet
print("Error: can't import `tornado.platform` in chroot. Did you copy"
" the python library for this version of python into the chroot?",
file=sys.stderr)
raise
def run_util():
args, help_fun = parse_args_util()
do_chroot()
if config.source_file is None:
sys.exit("No configuration provided!")
try:
config.validate()
except:
err_exit("Errors in config. Exiting.", exc_info=True)
# duplicate some minimal setup needed for this to work. Note that unlike
# the main server.py call, this arg parser sets '-' as the default for
# the log, overriding config.
if not args.logfile or args.logfile == "-":
config.get('logging_config').pop('filename', None)
else:
config.get('logging_config')['filename'] = args.logfile
init_logging(config.get('logging_config'))
userdb.init_db_connections()
mode_fun = None
if args.mode == "password":
mode_fun = reset_token_commands
elif args.mode == "ban":
mode_fun = ban_commands
elif args.mode == "flag":
mode_fun = flag_commands
if not mode_fun or not mode_fun(args):
help_fun()
sys.exit(1)
def init_signals(shutdown_event):
# if we can ensure >=py37 (probably?) this should be get_running_loop
loop = asyncio.get_event_loop()
stop_sigs = [signal.SIGTERM, signal.SIGINT]
reload_sigs = []
reload_game_sigs = [signal.SIGUSR1]
if config.get('hup_reloads_config'):
reload_sigs.append(signal.SIGHUP)
else:
stop_sigs.append(signal.SIGHUP)
for s in stop_sigs:
loop.add_signal_handler(s, functools.partial(stop_handler, s, shutdown_event))
for s in reload_sigs:
loop.add_signal_handler(s, functools.partial(reload_config_handler, s))
for s in reload_game_sigs:
loop.add_signal_handler(s, functools.partial(reload_games_handler, s))
async def async_run_server(nonsecure_sockets, secure_sockets):
# is this ever set to False by anyone in practice?
dgl_mode = config.get('dgl_mode')
# XX possibly some of this should move into async_run
if dgl_mode:
ws_handler.status_file_timeout() # note: tornado coroutine
auth.purge_login_tokens_timeout()
ws_handler.start_reading_milestones()
if config.get('watch_socket_dirs'):
process_handler.watch_socket_dirs()
# set up various timeout loops
ws_handler.do_periodic_lobby_updates()
webtiles.config.init_config_timeouts()
bind_server(nonsecure_sockets, secure_sockets)
shutdown_event = tornado.locks.Event()
init_signals(shutdown_event)
logging.info("DCSS Webtiles server started! (PID: %s)" % os.getpid())
logging.info(version())
await shutdown_event.wait()
# before running, this needs to have its config source set up. See
# ../server.py in the official repository for an example.
def run():
args = parse_args_main()
do_chroot()
if config.source_file is None:
# we could try to automatically figure this out from server_path, if
# it is set?
sys.exit("No configuration provided!")
# do this here so it can happen before logging init
if args.logfile:
if args.logfile == "-":
config.get('logging_config').pop('filename', None)
args.logfile = "<stdout>" # make the log message easier to read
else:
config.get('logging_config')['filename'] = args.logfile
init_logging(config.get('logging_config'))
try:
logging.info("Loaded server configuration from: %s", config.source_file)
config.do_early_logging()
if config.get('live_debug'):
logging.info("Starting in live-debug mode.")
config.set('watch_socket_dirs', False)
if args.logfile:
logging.info("Using command-line supplied logfile: '%s'", args.logfile)
export_args_to_config(args)
try:
config.load_game_data()
config.validate()
except:
err_exit("Errors in game data. Exiting.", exc_info=True)
if config.get('daemon', False):
daemonize()
if config.get('umask') is not None:
os.umask(config.get('umask'))
# bind sockets and shed privileges before starting up the ioloop
nonsecure_sockets, secure_sockets = bind_server_sockets()
# note -- shed_privileges cannot move later, or various files end up
# owned by root, breaking dgl-config installs! Particularly pidfile,
# but it's not the only one.
shed_privileges()
except SystemExit: # err_exit in the try blocks
# logging already done, hopefully
raise
except:
err_exit("Server startup failed!", exc_info=True)
try:
write_pidfile()
userdb.init_db_connections()
try:
# finally -- start things up for real
asyncio.run(async_run_server(nonsecure_sockets, secure_sockets))
logging.info("Bye!")
except asyncio.exceptions.CancelledError:
# triggered by the cancel case in stop_everything
err_exit("Normal server stop failed, some tasks were force-cancelled!")
except SystemExit:
raise
except:
err_exit("Server exited with error!", exc_info=True)
except SystemExit:
raise
except:
err_exit("Server startup failed!", exc_info=True)
finally:
# warning: need to be careful what appears in this finally block, since
# it may be called by child processes on fork in terminal.py in the
# event of rare bad timing or bugs. (So any global state that may be
# used here should be reset in the child process...)
remove_pidfile()
load_version()
# TODO: it might be nice to simply make this module runnable, but that would
# need some way of specifying the config source and `config.server_path`.
|