Customizable documentation (#1300)

Allows documentation for multiple languges, when docs_path is not set
the legacy stl_path variable is used mantaining retrocompatibility.

Co-authored-by: Edoardo Morassutto <edoardo.morassutto@gmail.com>

Author: Virv12

cms/conf.py

@@ -136,6 +136,7 @@ def __init__(self):
         self.max_submission_length = 100_000  # 100 KB
         self.max_input_length = 5_000_000  # 5 MB
         self.stl_path = "/usr/share/cppreference/doc/html/"
+        self.docs_path = None
         # Prefix of 'shared-mime-info'[1] installation. It can be found
         # out using `pkg-config --variable=prefix shared-mime-info`, but
         # it's almost universally the same (i.e. '/usr') so it's hardly

cms/server/contest/handlers/__init__.py

@@ -99,7 +99,7 @@
 
     # The following prefixes are handled by WSGI middlewares:
     # * /static, defined in cms/io/web_service.py
-    # * /stl, defined in cms/server/contest/server.py
+    # * /docs, defined in cms/server/contest/server.py
 ]
 
 

cms/server/contest/handlers/main.py

@@ -31,6 +31,7 @@
 import ipaddress
 import json
 import logging
+import os.path
 import re
 
 import collections
@@ -48,6 +49,7 @@
 
 from cms import config
 from cms.db import PrintJob, User, Participation, Team
+from cms.grading.languagemanager import get_language
 from cms.grading.steps import COMPILATION_MESSAGES, EVALUATION_MESSAGES
 from cms.server import multi_contest
 from cms.server.contest.authentication import validate_login
@@ -367,7 +369,21 @@ class DocumentationHandler(ContestHandler):
     @tornado_web.authenticated
     @multi_contest
     def get(self):
+        contest = self.r_params.get("contest")
+        languages = [get_language(lang) for lang in contest.languages]
+
+        language_docs = []
+        if config.docs_path is not None:
+            for language in languages:
+                ext = language.source_extensions[0][1:] # remove dot
+                path = os.path.join(config.docs_path, ext)
+                if os.path.exists(path):
+                    language_docs.append((language.name, ext))
+        else:
+            language_docs.append(("C++", "en"))
+
         self.render("documentation.html",
                     COMPILATION_MESSAGES=COMPILATION_MESSAGES,
                     EVALUATION_MESSAGES=EVALUATION_MESSAGES,
+                    language_docs=language_docs,
                     **self.r_params)

cms/server/contest/server.py

@@ -100,7 +100,7 @@ def __init__(self, shard, contest_id=None):
             listen_address=listen_address)
 
         self.wsgi_app = SharedDataMiddleware(
-            self.wsgi_app, {"/stl": config.stl_path},
+            self.wsgi_app, {"/docs": config.docs_path or config.stl_path},
             cache=True, cache_timeout=SECONDS_IN_A_YEAR,
             fallback_mimetype="application/octet-stream")
 

cms/server/contest/templates/documentation.html

@@ -11,11 +11,10 @@ <h1>{% trans %}Documentation{% endtrans %}</h1>
 
 <h2>{% trans %}Programming languages and libraries{% endtrans %}</h2>
 
-{% if contest.languages|map("to_language")|map(attribute="source_extensions")|any("contains", ".cpp") %}
-<h3>C++</h3>
-
-<p><a href="{{ url("stl", "en", "index.html") }}">{% trans %}Standard Template Library{% endtrans %}</a></p>
-{% endif %}
+{% for name, ext in language_docs %}
+<h3>{{name}}</h3>
+<p><a href="{{ url("docs", ext, "index.html") }}">{% trans %}Documentation{% endtrans %}</a></p>
+{% endfor %}
 
 {% if contest.languages|map("to_language")|map(attribute="source_extensions")|any("contains", ".java") %}
 <h3>Java</h3>

config/cms.conf.sample

@@ -130,8 +130,10 @@
     "max_submission_length": 100000,
     "max_input_length": 5000000,
 
-    "_help": "STL documentation path in the system (exposed in CWS).",
-    "stl_path": "/usr/share/cppreference/doc/html/",
+    "_help": "Path to the documentation exposed by CWS. To show a documentation",
+    "_help": "link add a folder for each language with index.html inside. For",
+    "_help": "example for C++ add 'cpp/index.html', for Java 'java/index.html'.",
+    "docs_path": "/usr/share/cms/docs",