main.py
5.27 KB
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
#!/usr/bin/env python3
'''
Start application and web server
'''
# python standard library
import argparse
import logging
import logging.config
import os
import ssl
import sys
# this project
from .app import App, AppException
from .serve import run_webserver
from .tools import load_yaml
from . import APP_NAME, APP_VERSION
# ----------------------------------------------------------------------------
def parse_cmdline_arguments() -> argparse.Namespace:
'''
Get command line arguments
'''
parser = argparse.ArgumentParser(
description='Server for online tests. Enrolled students and tests '
'have to be previously configured. Please read the documentation '
'included with this software before running the server.')
parser.add_argument('testfile',
type=str,
help='tests in YAML format')
parser.add_argument('--allow-all',
action='store_true',
help='Allow all students to login immediately')
parser.add_argument('--allow-list',
type=str,
help='File with list of students to allow immediately')
parser.add_argument('--debug',
action='store_true',
help='Enable debug messages')
parser.add_argument('--review',
action='store_true',
help='Review mode: doesn\'t generate test')
parser.add_argument('--correct',
action='store_true',
help='Correct test and update JSON files and database')
parser.add_argument('--port',
type=int,
default=8443,
help='port for the HTTPS server (default: 8443)')
parser.add_argument('--version',
action='version',
version=f'{APP_VERSION} - python {sys.version}',
help='Show version information and exit')
return parser.parse_args()
# ----------------------------------------------------------------------------
def get_logger_config(debug=False) -> dict:
'''
Load logger configuration from ~/.config directory if exists,
otherwise set default paramenters.
'''
file = 'logger-debug.yaml' if debug else 'logger.yaml'
path = os.path.expanduser(os.environ.get('XDG_CONFIG_HOME', '~/.config/'))
try:
return load_yaml(os.path.join(path, APP_NAME, file))
except OSError:
print('Using default logger configuration...')
if debug:
level = 'DEBUG'
fmt = '%(asctime)s %(levelname)-8s %(module)-12s%(lineno)4d| %(message)s'
dateformat = ''
else:
level = 'INFO'
fmt = '%(asctime)s| %(levelname)-8s| %(message)s'
dateformat = '%Y-%m-%d %H:%M:%S'
modules = ['main', 'serve', 'app', 'models', 'questions', 'test',
'testfactory', 'tools']
logger = {'handlers': ['default'], 'level': level, 'propagate': False}
return {
'version': 1,
'formatters': {
'standard': {
'format': fmt,
'datefmt': dateformat,
},
},
'handlers': {
'default': {
'level': level,
'class': 'logging.StreamHandler',
'formatter': 'standard',
'stream': 'ext://sys.stdout',
},
},
'loggers': {f'{APP_NAME}.{module}': logger for module in modules}
}
# ----------------------------------------------------------------------------
def main() -> None:
'''
Tornado web server
'''
args = parse_cmdline_arguments()
# --- Setup logging ------------------------------------------------------
logging.config.dictConfig(get_logger_config(args.debug))
logger = logging.getLogger(__name__)
logger.info('================== Start Logging ==================')
# --- start application --------------------------------------------------
config = {
'testfile': args.testfile,
'allow_all': args.allow_all,
'allow_list': args.allow_list,
'debug': args.debug,
'review': args.review,
'correct': args.correct,
}
try:
app = App(config)
except AppException:
logger.critical('Failed to start application!')
sys.exit(1)
# --- get SSL certificates -----------------------------------------------
if 'XDG_DATA_HOME' in os.environ:
certs_dir = os.path.join(os.environ['XDG_DATA_HOME'], 'certs')
else:
certs_dir = os.path.expanduser('~/.local/share/certs')
ssl_opt = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
try:
ssl_opt.load_cert_chain(os.path.join(certs_dir, 'cert.pem'),
os.path.join(certs_dir, 'privkey.pem'))
except FileNotFoundError:
logger.critical('SSL certificates missing in %s', certs_dir)
sys.exit(1)
# --- run webserver ------------------------------------------------------
run_webserver(app=app, ssl_opt=ssl_opt, port=args.port, debug=args.debug)
# ----------------------------------------------------------------------------
if __name__ == "__main__":
main()