serve.py
11.3 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
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
#!/usr/bin/env python3.6
# python standard library
from os import path
import sys
import base64
import uuid
import logging.config
import argparse
# user installed libraries
import tornado.ioloop
import tornado.web
import tornado.httpserver
from tornado import template #, gen
# this project
from learnapp import LearnApp
from tools import load_yaml, md_to_html
# ============================================================================
# WebApplication - Tornado Web Server
# ============================================================================
class WebApplication(tornado.web.Application):
def __init__(self, learnapp, debug=False):
handlers = [
(r'/login', LoginHandler),
(r'/logout', LogoutHandler),
(r'/change_password', ChangePasswordHandler),
(r'/question', QuestionHandler), # each question
(r'/topic/(.+)', TopicHandler), # page for doing a topic
# (r'/file/(.+)', FileHandler), # FIXME
(r'/.*', RootHandler), # show list of topics
]
settings = {
'template_path': path.join(path.dirname(__file__), 'templates'),
'static_path': path.join(path.dirname(__file__), 'static'),
'static_url_prefix': '/static/',
'xsrf_cookies': False, # FIXME see how to do it...
'cookie_secret': base64.b64encode(uuid.uuid4().bytes),
'login_url': '/login',
'debug': debug,
}
super().__init__(handlers, **settings)
self.learn = learnapp
# ============================================================================
# Handlers
# ============================================================================
# ----------------------------------------------------------------------------
# Base handler common to all handlers.
# ----------------------------------------------------------------------------
class BaseHandler(tornado.web.RequestHandler):
@property
def learn(self):
return self.application.learn
def get_current_user(self):
cookie = self.get_secure_cookie("user")
if cookie:
user = cookie.decode('utf-8')
return user
# FIXME if the cookie exists but user is not in learn.online, this will force new login and store new (duplicate?) cookie. is this correct??
# if user in self.learn.online:
# return user
# ----------------------------------------------------------------------------
# /auth/login and /auth/logout
# ----------------------------------------------------------------------------
class LoginHandler(BaseHandler):
def get(self):
self.render('login.html', error='')
# @gen.coroutine
def post(self):
uid = self.get_body_argument('uid')
pw = self.get_body_argument('pw')
if self.learn.login(uid, pw):
self.set_secure_cookie("user", str(uid), expires_days=30)
self.redirect(self.get_argument("next", "/"))
else:
self.render("login.html", error='Número ou senha incorrectos')
# ----------------------------------------------------------------------------
class LogoutHandler(BaseHandler):
@tornado.web.authenticated
def get(self):
self.learn.logout(self.current_user)
self.clear_cookie('user')
self.redirect(self.get_argument('next', '/'))
# ----------------------------------------------------------------------------
class ChangePasswordHandler(BaseHandler):
@tornado.web.authenticated
def post(self):
uid = self.current_user
pw = self.get_body_arguments('new_password')[0];
if self.learn.change_password(uid, pw):
notification = tornado.escape.to_unicode(self.render_string('notification.html', type='success', msg='A password foi alterada!'))
else:
notification = tornado.escape.to_unicode(self.render_string('notification.html', type='danger', msg='A password não foi alterada!'))
self.write({'msg': notification})
# ----------------------------------------------------------------------------
# Main page: /
# Shows a list of topics and proficiency (stars, locked).
# ----------------------------------------------------------------------------
class RootHandler(BaseHandler):
@tornado.web.authenticated
def get(self):
uid = self.current_user
self.render('maintopics.html',
uid=uid,
name=self.learn.get_student_name(uid),
state=self.learn.get_student_state(uid),
title=self.learn.get_title()
)
# ----------------------------------------------------------------------------
# Start a given topic: /topic/...
# ----------------------------------------------------------------------------
class TopicHandler(BaseHandler):
@tornado.web.authenticated
def get(self, topic):
uid = self.current_user
try:
ok = self.learn.start_topic(uid, topic)
except KeyError:
self.redirect('/')
else:
if ok:
self.render('topic.html',
uid=uid,
name=self.learn.get_student_name(uid),
)
else:
self.redirect('/')
# ----------------------------------------------------------------------------
class FileHandler(BaseHandler):
@tornado.web.authenticated
def get(self, filename):
uid = self.current_user
public_dir = self.learn.get_current_public_dir(uid)
filepath = path.expanduser(path.join(public_dir, filename))
try:
f = open(filepath, 'rb')
except FileNotFoundError:
raise tornado.web.HTTPError(404)
else:
self.write(f.read())
f.close()
# ----------------------------------------------------------------------------
# respond to AJAX to get a JSON question
# ----------------------------------------------------------------------------
class QuestionHandler(BaseHandler):
templates = {
'checkbox': 'question-checkbox.html',
'radio': 'question-radio.html',
'text': 'question-text.html',
'text-regex': 'question-text.html',
'numeric-interval': 'question-text.html',
'textarea': 'question-textarea.html',
# -- information panels --
# 'information': 'question-information.html',
# 'info': 'question-information.html',
# 'success': 'question-success.html',
# 'warning': '', FIXME
# 'warn': '', FIXME
# 'alert': '', FIXME
}
def new_question(self, user):
question = self.learn.get_student_question(user) # Question
template = self.templates[question['type']]
question_html = self.render_string(template, question=question, md=md_to_html)
return {
'method': 'new_question',
'params': {
'question': tornado.escape.to_unicode(question_html),
'progress': self.learn.get_student_progress(user),
}
}
def wrong_answer(self, user):
progress = self.learn.get_student_progress(user) # in the current topic
return {
'method': 'shake',
'params': {
'progress': progress,
}
}
def finished_topic(self, user): # FIXME user unused
return {
'method': 'finished_topic',
'params': { # FIXME no html here please!
'question': f'<img src="/static/trophy.svg" alt="trophy" class="img-fluid mx-auto d-block" width="35%">'
}
}
@tornado.web.authenticated
def get(self):
logging.debug('QuestionHandler.get()')
user = self.current_user
question = self.learn.get_student_question(user)
template = self.templates[question['type']]
question_html = self.render_string(template, question=question, md=md_to_html)
self.write({
'method': 'new_question',
'params': {
'question': tornado.escape.to_unicode(question_html),
'progress': self.learn.get_student_progress(user) ,
}
})
# handles answer posted
@tornado.web.authenticated
def post(self):
logging.debug('QuestionHandler.post()')
user = self.current_user
# check answer and get next question (same, new or None)
answer = self.get_body_arguments('answer') # list
if not answer:
answer = None
else:
# answers returned in a list. fix depending on question type
qtype = self.learn.get_student_question_type(user)
if qtype in ('success', 'information', 'info'): # FIXME danger...
answer = None
elif qtype != 'checkbox': # radio, text, textarea, ...
answer = answer[0]
grade = self.learn.check_answer(user, answer)
question = self.learn.get_student_question(user)
if question is None:
self.write(self.finished_topic(user))
elif grade > 0.999:
self.write(self.new_question(user))
else:
self.write(self.wrong_answer(user))
# -------------------------------------------------------------------------
# Tornado web server
# ----------------------------------------------------------------------------
def main():
# --- Commandline argument parsing
argparser = argparse.ArgumentParser(description='Server for online learning. Enrolled students and topics have to be previously configured. Please read the documentation included with this software before running the server.')
argparser.add_argument('conffile', type=str, nargs='+',
help='Topics configuration file in YAML format.') # FIXME only one
argparser.add_argument('--debug', action='store_true',
help='Enable debug messages.')
arg = argparser.parse_args()
# --- Setup logging
logger_file = 'logger-debug.yaml' if arg.debug else 'logger.yaml'
SERVER_PATH = path.dirname(path.realpath(__file__))
LOGGER_CONF = path.join(SERVER_PATH, f'config/{logger_file}')
try:
logging.config.dictConfig(load_yaml(LOGGER_CONF))
except:
print('An error ocurred while setting up the logging system.')
sys.exit(1)
logging.info('====================================================')
# --- start application
logging.info('Starting App.')
learnapp = LearnApp(arg.conffile[0])
# --- create web application
logging.info('Starting Web App (tornado)')
try:
webapp = WebApplication(learnapp, debug=arg.debug)
except Exception as e:
logging.critical('Failed to start application.')
raise e
# --- create webserver
http_server = tornado.httpserver.HTTPServer(webapp,
ssl_options={
"certfile": "certs/cert.pem",
"keyfile": "certs/key.pem"
})
http_server.listen(8443)
# --- run webserver
logging.info('Webserver running...')
try:
tornado.ioloop.IOLoop.current().start() # running...
except KeyboardInterrupt:
tornado.ioloop.IOLoop.current().stop()
logging.critical('Webserver stopped.')
# ----------------------------------------------------------------------------
if __name__ == "__main__":
main()