- fix browser redirection to /question when enter key is pressed.

- fix direction of graph edges. - use config file given in a commandline option. - improved debug messages - removed panel from question html

- fix browser redirection to /question when enter key is pressed.
- fix direction of graph edges. - use config file given in a commandline option. - improved debug messages - removed panel from question html
Miguel Barão
1 parent db2aceed
Showing 7 changed files with 57 additions and 42 deletions Show diff stats
BUGS.md
app.py
knowledge.py
questions.py
serve.py
templates/learn.html
templates/question.html
 BUGS:
-- de vez em quando o browser é redireccionado para /question em vez de fazer um post?? não percebo...
-- load/save the knowledge state of the student
+- não entra à primeira
+- logs mostram que está a gerar cada pergunta 2 vezes...??
+- mostra tópicos do lado esquerdo, indicando quais estão feitos e quantas perguntas contêm.
 - se students.db não existe, rebenta.
 - database hardcoded in LearnApp.
 - implementar xsrf. Ver [http://www.tornadoweb.org/en/stable/guide/security.html#cross-site-request-forgery-protection]()
@@ -15,6 +16,8 @@ TODO:
 SOLVED:
+- o browser é redireccionado para /question em vez de fazer um post?? quando se pressiona enter numa caixa text edit.
+- load/save the knowledge state of the student
 - servir ficheiros de public temporariamente
 - path dos generators scripts mal construido
 - questions hardcoded in LearnApp.
@@ -28,7 +28,7 @@ logger = logging.getLogger(__name__)
 # LearnApp - application logic
 # ============================================================================
 class LearnApp(object):
-    def __init__(self):
+    def __init__(self, conffile='demo/demo.yaml'):
         # online students
         self.online = {}
@@ -36,7 +36,7 @@ class LearnApp(object):
         self.db_setup('students.db')    # FIXME
         # build dependency graph
-        self.build_dependency_graph('demo/config.yaml')  # FIXME
+        self.build_dependency_graph(conffile)  # FIXME
         # add topics from depgraph to the database
         self.db_add_topics()
@@ -103,7 +103,7 @@ class LearnApp(object):
     # ------------------------------------------------------------------------
     def get_current_public_dir(self, uid):
-        topic = self.online[uid]['state'].topic
+        topic = self.online[uid]['state'].get_current_topic()
         p = self.depgraph.graph['path']
         return path.join(p, topic, 'public')
@@ -164,7 +164,7 @@ class LearnApp(object):
         # Build dependency graph
         deps = config.get('dependencies', {})
         for n,dd in deps.items():
-            g.add_edges_from((n,d) for d in dd)
+            g.add_edges_from((d,n) for d in dd)
         # Builds factories for each node
         for n in g.nodes_iter():
@@ -30,7 +30,10 @@ class Knowledge(object):
     def topic_generator(self):
         topics = nx.topological_sort(self.depgraph) # FIXME for now...
         for t in topics:
+            if self.state.get(t, 0.0) > 0.999:
+                continue
             self.questions = self.generate_questions_for_topic(t)
+            logger.info(f'Generated {len(self.questions)} questions for topic "{t}"')
             yield t
     # ------------------------------------------------------------------------
@@ -43,6 +46,10 @@ class Knowledge(object):
         return self.current_question
     # ------------------------------------------------------------------------
+    def get_current_topic(self):
+        return self.current_topic
+
+    # ------------------------------------------------------------------------
     def get_knowledge_state(self):
         return self.state
@@ -61,8 +68,6 @@ class Knowledge(object):
                     self.current_topic = next(self.topic)
                     self.questions = self.generate_questions_for_topic(self.current_topic)
-            print(self.current_topic)
-            print(self.current_question)
             self.current_question = self.questions.pop(0)
             self.current_question['start_time'] = datetime.now()
@@ -406,7 +406,7 @@ class QFactory(object):
     # i.e. a question object (radio, checkbox, ...).
     # -----------------------------------------------------------------------
     def generate(self):
-        logger.debug('generate()')
+        logger.debug(f'generate "{self.question["ref"]}"')
         # Shallow copy so that script generated questions will not replace
         # the original generators
         q = self.question.copy()
@@ -415,10 +415,8 @@ class QFactory(object):
         # which will print a valid question in yaml format to stdout. This
         # output is then converted to a dictionary and `q` becomes that dict.
         if q['type'] == 'generator':
-            logger.debug('Running script to generate question "{0}".'.format(q['ref']))
+            logger.debug(f'Running script "{q["script"]}"...')
             q.setdefault('arg', '') # optional arguments will be sent to stdin
-            # print(q['path'])
-            # print(q['script'])
             script = path.join(q['path'], q['script'])
             out = run_script(script=script, stdin=q['arg'])
             q.update(out)
@@ -433,18 +431,11 @@ class QFactory(object):
             #         })
         # Finally we create an instance of Question()
-        logger.debug('create instance...')
-        # try:
-        #     qinstance = self._types[q['type']](q)   # instance with correct class
-        # except KeyError as e:
-        #     logger.error('Unknown question type "{0}" in "{1}:{2}".'.format(q['type'], q['filename'], q['ref']))
-        #     raise e
-        # except:
-        #     logger.error('Failed to create question "{0}" from file "{1}".'.format(q['ref'], q['filename']))
-        # else:
-        #     logger.debug('Generated question "{}".'.format(ref))
-        #     return qinstance
-        qinstance = self._types[q['type']](q)   # instance with correct class
-        logger.debug('returning')
-        return qinstance
+        try:
+            qinstance = self._types[q['type']](q)   # instance with correct class
+        except KeyError as e:
+            logger.error(f'Unknown question type "{q["type"]}"')
+            raise e
+        else:
+            return qinstance
@@ -8,6 +8,7 @@ import base64
 import uuid
 import concurrent.futures
 import logging.config
+import argparse
 # user installed libraries
 try:
@@ -32,7 +33,7 @@ from tools import load_yaml, md
 # WebApplication - Tornado Web Server
 # ============================================================================
 class WebApplication(tornado.web.Application):
-    def __init__(self):
+    def __init__(self, learnapp):
         handlers = [
             (r'/login',     LoginHandler),
             (r'/logout',    LogoutHandler),
@@ -50,7 +51,7 @@ class WebApplication(tornado.web.Application):
             'debug': True,
         }
         super().__init__(handlers, **settings)
-        self.learn = LearnApp()
+        self.learn = learnapp
 # ============================================================================
 # Handlers
@@ -169,6 +170,16 @@ def main():
     SERVER_PATH = os.path.dirname(os.path.realpath(__file__))
     LOGGER_CONF = os.path.join(SERVER_PATH, 'config/logger.yaml')
+    # --- 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.')
+    # FIXME:
+        # serverconf_file = path.normpath(path.join(SERVER_PATH, 'config', 'server.conf'))
+        # argparser.add_argument('--conf', default=serverconf_file, type=str, help='server configuration file')
+        # argparser.add_argument('--debug', action='store_true', help='Enable debug logging.')
+        # argparser.add_argument('--allow-all', action='store_true',
+            # help='Students are initially allowed to login (can be denied later)')
+    argparser.add_argument('conffile', type=str, nargs='+', help='Topics configuration file in YAML format.') # FIXME only one supported at the moment
+    arg = argparser.parse_args()
     # --- Setup logging
     try:
@@ -179,8 +190,9 @@ def main():
         sys.exit(1)
     # --- start application
+    learnapp = LearnApp(arg.conffile[0])
     try:
-        webapp = WebApplication()
+        webapp = WebApplication(learnapp)
     except Exception as e:
         logging.critical('Can\'t start application.')
         # sys.exit(1)
@@ -66,12 +66,12 @@
 <!-- ===================================================================== -->
 <!-- Container -->
 <div class="container">
-<audio>
+<!-- <audio>
     <source id="snd-intro" src="/static/sounds/intro.mp3" type="audio/mpeg">
     <source id="snd-correct" src="/static/sounds/correct.mp3" type="audio/mpeg">
     <source id="snd-wrong" src="/static/sounds/wrong.mp3" type="audio/mpeg">
 </audio>
-
+ -->
 <form action="/question" method="post" id="question_form" autocomplete="off">
     {% module xsrf_form_html() %}
@@ -106,9 +106,11 @@ function updateQuestion(response){
         MathJax.Hub.Queue(["Typeset",MathJax.Hub,"question_div"]);
         $("textarea, input:text, input:radio, input:checkbox").keydown(function (e) {
-            if (e.keyCode == 13 && e.shiftKey) {
+            if (e.keyCode == 13) {
                 e.preventDefault();
-                getQuestion();
+                if  (e.shiftKey) {
+                    getQuestion();
+                }
             }
         });
         // var audio = new Audio('/static/sounds/correct.mp3');
 {% autoescape %}
-<div class="panel panel-default">
-  <div class="panel-body">
+<!-- <div class="panel panel-default">
+    <div class="panel-body">
+ -->
+        <h3>{{ question['title'] }}</h3>
-<h3>{{ question['title'] }}</h3>
+        <div id="text">
+            {{ md(question['text']) }}
+        </div>
-<div id="text">
-{{ md(question['text']) }}
-</div>
-
-{% block answer %}{% end %}
+        {% block answer %}{% end %}
-</div></div>
 \ No newline at end of file
+<!--     </div>
+</div>
+ -->
 \ No newline at end of file
1	BUGS:	1	BUGS:
2		2
3	-- de vez em quando o browser é redireccionado para /question em vez de fazer um post?? não percebo...
4	-- load/save the knowledge state of the student	3	+- não entra à primeira
		4	+- logs mostram que está a gerar cada pergunta 2 vezes...??
		5	+- mostra tópicos do lado esquerdo, indicando quais estão feitos e quantas perguntas contêm.
5	- se students.db não existe, rebenta.	6	- se students.db não existe, rebenta.
6	- database hardcoded in LearnApp.	7	- database hardcoded in LearnApp.
7	- implementar xsrf. Ver [http://www.tornadoweb.org/en/stable/guide/security.html#cross-site-request-forgery-protection]()	8	- implementar xsrf. Ver [http://www.tornadoweb.org/en/stable/guide/security.html#cross-site-request-forgery-protection]()
	@@ -15,6 +16,8 @@ TODO:		@@ -15,6 +16,8 @@ TODO:
15		16
16	SOLVED:	17	SOLVED:
17		18
		19	+- o browser é redireccionado para /question em vez de fazer um post?? quando se pressiona enter numa caixa text edit.
		20	+- load/save the knowledge state of the student
18	- servir ficheiros de public temporariamente	21	- servir ficheiros de public temporariamente
19	- path dos generators scripts mal construido	22	- path dos generators scripts mal construido
20	- questions hardcoded in LearnApp.	23	- questions hardcoded in LearnApp.
	@@ -28,7 +28,7 @@ logger = logging.getLogger(__name__)		@@ -28,7 +28,7 @@ logger = logging.getLogger(__name__)
28	# LearnApp - application logic	28	# LearnApp - application logic
29	# ============================================================================	29	# ============================================================================
30	class LearnApp(object):	30	class LearnApp(object):
31	- def __init__(self):	31	+ def __init__(self, conffile='demo/demo.yaml'):
32	# online students	32	# online students
33	self.online = {}	33	self.online = {}
34		34
	@@ -36,7 +36,7 @@ class LearnApp(object):		@@ -36,7 +36,7 @@ class LearnApp(object):
36	self.db_setup('students.db') # FIXME	36	self.db_setup('students.db') # FIXME
37		37
38	# build dependency graph	38	# build dependency graph
39	- self.build_dependency_graph('demo/config.yaml') # FIXME	39	+ self.build_dependency_graph(conffile) # FIXME
40		40
41	# add topics from depgraph to the database	41	# add topics from depgraph to the database
42	self.db_add_topics()	42	self.db_add_topics()
	@@ -103,7 +103,7 @@ class LearnApp(object):		@@ -103,7 +103,7 @@ class LearnApp(object):
103		103
104	# ------------------------------------------------------------------------	104	# ------------------------------------------------------------------------
105	def get_current_public_dir(self, uid):	105	def get_current_public_dir(self, uid):
106	- topic = self.online[uid]['state'].topic	106	+ topic = self.online[uid]['state'].get_current_topic()
107	p = self.depgraph.graph['path']	107	p = self.depgraph.graph['path']
108	return path.join(p, topic, 'public')	108	return path.join(p, topic, 'public')
109		109
	@@ -164,7 +164,7 @@ class LearnApp(object):		@@ -164,7 +164,7 @@ class LearnApp(object):
164	# Build dependency graph	164	# Build dependency graph
165	deps = config.get('dependencies', {})	165	deps = config.get('dependencies', {})
166	for n,dd in deps.items():	166	for n,dd in deps.items():
167	- g.add_edges_from((n,d) for d in dd)	167	+ g.add_edges_from((d,n) for d in dd)
168		168
169	# Builds factories for each node	169	# Builds factories for each node
170	for n in g.nodes_iter():	170	for n in g.nodes_iter():