Add commands page

Author: dmptrluke

cloudbot/web/main.py

@@ -6,6 +6,8 @@
 
 from jinja2 import Environment, PackageLoader
 
+from operator import attrgetter
+
 wi = None
 
 
@@ -17,6 +19,7 @@ def get_template_env():
 def get_application():
     app = Application([
         (r'/', TestHandler),
+        (r'/commands/', CommandsHandler),
         (r"/s/(.*)", StaticFileHandler, {"path": "./cloudbot/web/static"}),
     ])
     return app
@@ -35,6 +38,45 @@ def get(self):
         self.write(template.render(**args))
 
 
+class CommandsHandler(RequestHandler):
+    @gen.coroutine
+    def get(self):
+        template = wi.env.get_template('commands.html')
+        commands = []
+
+        for plugin in sorted(set(wi.bot.plugin_manager.commands.values()), key=attrgetter("name")):
+            # use set to remove duplicate commands (from multiple aliases), and sorted to sort by name
+            command = plugin.name
+
+            aliases = ", ".join([i for i in plugin.aliases if not i == command])
+
+            if aliases:
+                cmd = "{} ({})".format(command, aliases)
+            else:
+                cmd = "{}".format(command)
+
+            if plugin.doc:
+                if plugin.doc.split()[0].isalpha():
+                    doc = plugin.doc
+                else:
+                    doc = "{} {}".format(command, plugin.doc)
+            else:
+                doc = "Command has no documentation.".format(command)
+
+            if plugin.permissions:
+                doc += " (Permission required: {})\n\n".format(", ".join(plugin.permissions))
+
+            commands.append((cmd, doc))
+
+        args = {
+            'bot_name': wi.config.get('bot_name', 'CloudBot'),
+            'bot_version': cloudbot.__version__,
+            'commands': commands
+        }
+
+        self.write(template.render(**args))
+
+
 class WebInterface():
     def __init__(self, bot):
         self.bot = bot

cloudbot/web/templates/commands.html

@@ -0,0 +1,27 @@
+{% extends "layout.html" %}
+{% set active_page = "commands" %}
+{% block title %}Commands - {{ super() }}{% endblock %}
+{% block content %}
+    <div class="row">
+        <div class="col-lg-12">
+            <div class="page-header">
+                <h2 id="container">Commands</h2>
+            </div>
+            <!--<p class="lead">How to use {{ bot_name }} commands.</p>-->
+            <table class="table table-striped table-hover ">
+                <thead>
+                <tr>
+                    <th>Command</th>
+                    <th>Description</th>
+                </tr>
+                </thead>
+                {% for cmd, doc in commands %}
+                    <tr>
+                        <td>{{ cmd }}</td>
+                        <td>{{ doc }}</td>
+                    </tr>
+                {% endfor %}
+            </table>
+        </div>
+    </div>
+{% endblock %}

cloudbot/web/templates/layout.html

@@ -17,8 +17,8 @@
 
         <title>{% block title %}{{ bot_name }}{% endblock %}</title>
 
-        <link href="./s/css/bootstrap.min.css" rel="stylesheet">
-        <link href="./s/css/style.css" rel="stylesheet">
+        <link href="/s/css/bootstrap.min.css" rel="stylesheet">
+        <link href="/s/css/style.css" rel="stylesheet">
 
         <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
         <!--[if lt IE 9]>
@@ -83,7 +83,7 @@ <h4 class="modal-title">About Me</h4>
 
 <!-- javascript -->
 <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
-<script src="./s/js/bootstrap.min.js"></script>
+<script src="/s/js/bootstrap.min.js"></script>
 <!-- IE10 viewport hack for Surface/desktop Windows 8 bug -->
-<script src="./s/js/ie10-viewport-bug-workaround.js"></script>
+<script src="/s/js/ie10-viewport-bug-workaround.js"></script>
 </body>