- using mistune to render markdown.

Miguel Barão
1 parent bae2d15e
Showing 9 changed files with 71 additions and 61 deletions Show diff stats
BUGS.md
demo/questions/questions-tutorial.yaml
serve.py
templates/question-checkbox.html
templates/question-radio.html
templates/question.html
templates/review.html
templates/test.html
tools.py
 # BUGS
+- fazer renderer para formulas com mathjax serverside (mathjax-node).
+- fazer renderer para imagens, com links /file?ref=xpto;name=zzz.jpg
+- fazer renderer para linguagem assembly mips?
+- converter markdown para mistune.
 - qual a diferenca entre md_to_html e md_to_html_review, parece desnecessario haver dois.
 - servir imagens das perguntas
 - hints nao funciona
@@ -42,7 +42,8 @@
     ref: tut-alert
     type: alert
     title: alert
-    text: Texto negativo (alerta). Não conta para avaliação.
+    text: Texto negativo (alerta). Não conta para avaliação. ![alt text](abc.jpg "Logo Title Text 1")
+
 # ----------------------------------------------------------------------------
 -
     ref: tut-radio
@@ -18,7 +18,7 @@ import tornado.httpserver
 from tornado import template, gen
 # project
-from tools import load_yaml, md_to_html, md_to_html_review
+from tools import load_yaml, md_to_html  #, md_to_html_review
 from app import App, AppException
@@ -98,7 +98,9 @@ class FileHandler(BaseHandler):
     def get(self):
         uid = self.current_user
         qref = self.get_query_argument('ref')
-        qfile = self.get_query_argument('filename')
+        qfile = self.get_query_argument('file')
+        print(f'FileHandler: ref={ref}, file={file}')
+
         self.write(self.testapp.get_file(ref, filename))
@@ -222,7 +224,7 @@ class ReviewHandler(BaseHandler):
         else:
             with f:
                 t = json.load(f)
-                self.render('review.html', t=t, md=md_to_html_review, templ=self._templates)
+                self.render('review.html', t=t, md=md_to_html, templ=self._templates)
 # --- FILE -------------------------------------------------------------
@@ -7,7 +7,7 @@
     {% for n, opt in enumerate(q['options']) %}
             <a class="list-group-item">
                 <input type="checkbox" id="{{i}}:{{n}}" name="{{i}}" value="{{n}}">
-                <label for="{{n}}">{{ md(opt, q['ref'], q['files']) }}</label>
+                <label for="{{n}}">{{ md(opt, q) }}</label>
             </a>
     {% end %}
     </div>
@@ -7,7 +7,7 @@
     {% for n, opt in enumerate(q['options']) %}
             <a class="list-group-item">
                 <input type="radio" id="{{i}}:{{n}}" name="{{i}}" value="{{n}}">
-                <label for="{{n}}">{{ md(opt, q['ref'], q['files']) }}</label>
+                <label for="{{n}}">{{ md(opt, q) }}</label>
             </a>
     {% end %}
     </div>
@@ -11,7 +11,7 @@
   </h5>
   <div class="card-body">
     <div id="text">
-      {{ md(q['text'], md) }}
+      {{ md(q['text'], q) }}
     </div>
     {% block answer %}{% end %}
@@ -34,7 +34,7 @@
 <div class="container">
   <div class="jumbotron">
     <h1 class="display-5">{{ t['title'] }}</h1>
-    {{ t.get('duration', '') }}
+    {{ t.get('duration', chr(8734)) }}
     <hr>
     <h3>
@@ -76,9 +76,6 @@
     <div class="col-12">
       <button type="button" class="btn btn-success btn-lg btn-block" data-toggle="modal" data-target="#confirmar" id="form-button-submit">Submeter teste</button>
     </div>
-<!--     <div class="col-2">
-      <button type="button" class="btn btn-danger btn-lg btn-block" data-toggle="modal" data-target="#sair" id="form-button-sair">Desisto</button>
-    </div> -->
   </div>
   </form>
   <hr>
@@ -105,25 +102,6 @@
   </div>
 </div>
-<!-- Modal de confirmacao sair -->
-<div class="modal fade" id="sair" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true">
-  <div class="modal-dialog" role="document">
-    <div class="modal-content">
-      <div class="modal-header">
-        <h4 class="modal-title">Deseja desistir?</h4>
-      </div>
-      <div class="modal-body">
-        Se desistir, será registada a desistência da prova e terá uma classificação de 0 valores.
-      </div>
-      <div class="modal-footer">
-        <button type="button" class="btn btn-danger btn-lg" data-dismiss="modal">Não!</button>
-        <a href="/giveup" class="btn btn-success btn-lg" role="button">Sim, desisto</a>
-      </div>
-    </div>
-  </div>
-</div>
-
-
 <!-- ===================================================================== -->
@@ -4,11 +4,34 @@ import subprocess
 import logging
 import yaml
-import markdown
+# import markdown
+import mistune
+from pygments import highlight
+from pygments.lexers import get_lexer_by_name
+from pygments.formatters import html
 # setup logger for this module
 logger = logging.getLogger(__name__)
+
+# ---------------------------------------------------------------------------
+class HighlightRenderer(mistune.Renderer):
+    def block_code(self, code, lang=None):
+        if lang is None:
+            return f'\n<pre><code>{mistune.escape(code)}</code></pre>\n'
+        else:
+            lexer = get_lexer_by_name(lang, stripall=True)
+            formatter = html.HtmlFormatter()
+            return highlight(code, lexer, formatter)
+
+    def image(self, src, title, text):
+        src = 'FIXME'  # FIXME
+        return super().image(src, title, text)
+
+renderer = HighlightRenderer(hard_wrap=True)
+markdown = mistune.Markdown(renderer=renderer)
+
+
 # ---------------------------------------------------------------------------
 # load data from yaml file
 # ---------------------------------------------------------------------------
@@ -16,7 +39,7 @@ def load_yaml(filename, default=None):
     try:
         f = open(path.expanduser(filename), 'r', encoding='utf-8')
     except IOError:
-        logger.error('Can\'t open file "{}"'.format(filename))
+        logger.error(f'Can\'t open file "{filename}"')
         return default
     else:
         with f:
@@ -29,7 +52,6 @@ def load_yaml(filename, default=None):
 # ---------------------------------------------------------------------------
 # Runs a script and returns its stdout parsed as yaml, or None on error.
-# Note: requires python 3.5+
 # ---------------------------------------------------------------------------
 def run_script(script, stdin='', timeout=5):
     script = path.expanduser(script)
@@ -42,45 +64,48 @@ def run_script(script, stdin=&#39;&#39;, timeout=5):
             timeout=timeout,
             )
     except FileNotFoundError:
-        logger.error('Script not found: "{0}".'.format(script))
+        logger.error(f'Script "{script}" not found.')
     except PermissionError:
-        logger.error('Script "{0}" not executable (wrong permissions?).'.format(script))
+        logger.error(f'Script "{script}" not executable. Wrong permissions?')
     except subprocess.TimeoutExpired:
-        logger.error('Timeout {0}s exceeded while running script "{1}"'.format(timeout, script))
+        logger.error(f'Timeout {timeout}s exceeded while running "{script}".')
     else:
         if p.returncode != 0:
-            logger.error('Script "{0}" returned error code {1}.'.format(script, p.returncode))
+            logger.error(f'Script "{script}" returned error code {p.returncode}.')
         else:
             try:
                 output = yaml.load(p.stdout)
             except:
-                logger.error('Error parsing yaml output of script "{0}"'.format(script))
+                logger.error('Error parsing yaml output of "{script}"')
             else:
                 return output
 # ---------------------------------------------------------------------------
-def md_to_html(text, ref=None, files={}):
-    if ref is not None:
-        # given q['ref'] and q['files'] replaces references to files by a
-        # GET to /file?ref=???;name=???
-        for k in files:
-            text = text.replace(k, '/file?ref={};name={}'.format(ref, k))
-    return markdown.markdown(text, extensions=[
-        'markdown.extensions.tables',
-        'markdown.extensions.fenced_code',
-        'markdown.extensions.codehilite',
-        'markdown.extensions.def_list',
-        'markdown.extensions.sane_lists'
-    ])
+def md_to_html(text, q=None):
+    return markdown(text)
+
+# def md_to_html(text, ref=None, files={}):
+#     if ref is not None:
+#         # given q['ref'] and q['files'] replaces references to files by a
+#         # GET to /file?ref=???;name=???
+#         for k in files:
+#             text = text.replace(k, '/file?ref={};name={}'.format(ref, k))
+#     return markdown.markdown(text, extensions=[
+#         'markdown.extensions.tables',
+#         'markdown.extensions.fenced_code',
+#         'markdown.extensions.codehilite',
+#         'markdown.extensions.def_list',
+#         'markdown.extensions.sane_lists'
+#     ])
 # ---------------------------------------------------------------------------
-def md_to_html_review(text, q):
-    for k,f in q['files'].items():
-        text = text.replace(k, '/absfile?name={}'.format(q['files'][k]))
-    return markdown.markdown(text, extensions=[
-        'markdown.extensions.tables',
-        'markdown.extensions.fenced_code',
-        'markdown.extensions.codehilite',
-        'markdown.extensions.def_list',
-        'markdown.extensions.sane_lists'
-    ])
+# def md_to_html_review(text, q):
+#     for k,f in q['files'].items():
+#         text = text.replace(k, '/absfile?name={}'.format(q['files'][k]))
+#     return markdown.markdown(text, extensions=[
+#         'markdown.extensions.tables',
+#         'markdown.extensions.fenced_code',
+#         'markdown.extensions.codehilite',
+#         'markdown.extensions.def_list',
+#         'markdown.extensions.sane_lists'
+#     ])
	@@ -7,7 +7,7 @@		@@ -7,7 +7,7 @@
7	{% for n, opt in enumerate(q['options']) %}	7	{% for n, opt in enumerate(q['options']) %}
8	<a class="list-group-item">	8	<a class="list-group-item">
9	<input type="checkbox" id="{{i}}:{{n}}" name="{{i}}" value="{{n}}">	9	<input type="checkbox" id="{{i}}:{{n}}" name="{{i}}" value="{{n}}">
10	- <label for="{{n}}">{{ md(opt, q['ref'], q['files']) }}</label>	10	+ <label for="{{n}}">{{ md(opt, q) }}</label>
11	</a>	11	</a>
12	{% end %}	12	{% end %}
13	</div>	13	</div>
	@@ -11,7 +11,7 @@		@@ -11,7 +11,7 @@
11	</h5>	11	</h5>
12	<div class="card-body">	12	<div class="card-body">
13	<div id="text">	13	<div id="text">
14	- {{ md(q['text'], md) }}	14	+ {{ md(q['text'], q) }}
15	</div>	15	</div>
16		16
17	{% block answer %}{% end %}	17	{% block answer %}{% end %}
	@@ -34,7 +34,7 @@		@@ -34,7 +34,7 @@
34	<div class="container">	34	<div class="container">
35	<div class="jumbotron">	35	<div class="jumbotron">
36	<h1 class="display-5">{{ t['title'] }}</h1>	36	<h1 class="display-5">{{ t['title'] }}</h1>
37	- {{ t.get('duration', '') }}	37	+ {{ t.get('duration', chr(8734)) }}
38	<hr>	38	<hr>
39		39
40	<h3>	40	<h3>
	@@ -76,9 +76,6 @@		@@ -76,9 +76,6 @@
76	<div class="col-12">	76	<div class="col-12">
77	<button type="button" class="btn btn-success btn-lg btn-block" data-toggle="modal" data-target="#confirmar" id="form-button-submit">Submeter teste</button>	77	<button type="button" class="btn btn-success btn-lg btn-block" data-toggle="modal" data-target="#confirmar" id="form-button-submit">Submeter teste</button>
78	</div>	78	</div>
79	-<!-- <div class="col-2">
80	- <button type="button" class="btn btn-danger btn-lg btn-block" data-toggle="modal" data-target="#sair" id="form-button-sair">Desisto</button>
81	- </div> -->
82	</div>	79	</div>
83	</form>	80	</form>
84	<hr>	81	<hr>
	@@ -105,25 +102,6 @@		@@ -105,25 +102,6 @@
105	</div>	102	</div>
106	</div>	103	</div>
107		104
108	-<!-- Modal de confirmacao sair -->
109	-<div class="modal fade" id="sair" tabindex="-1" role="dialog" aria-labelledby="myModalLabel" aria-hidden="true">
110	- <div class="modal-dialog" role="document">
111	- <div class="modal-content">
112	- <div class="modal-header">
113	- <h4 class="modal-title">Deseja desistir?</h4>
114	- </div>
115	- <div class="modal-body">
116	- Se desistir, será registada a desistência da prova e terá uma classificação de 0 valores.
117	- </div>
118	- <div class="modal-footer">
119	- <button type="button" class="btn btn-danger btn-lg" data-dismiss="modal">Não!</button>
120	- <a href="/giveup" class="btn btn-success btn-lg" role="button">Sim, desisto</a>
121	- </div>
122	- </div>
123	- </div>
124	-</div>
125	-
126	-
127		105
128	<!-- ===================================================================== -->	106	<!-- ===================================================================== -->
129		107