Added example for using adafruit_templateengine with adafruit_httpserver

michalpokusa · michalpokusa · commit 0ad3c2cffe07 · 2023-10-26T09:02:13.000Z
diff --git a/examples/directory_listing.tpl.html b/examples/directory_listing.tpl.html
@@ -0,0 +1,54 @@
+# SPDX-FileCopyrightText: 2023 Michal Pokusa
+#
+# SPDX-License-Identifier: Unlicense
+
+<html lang="en">
+
+{% exec path = context.get("path") %}
+{% exec items = context.get("items") %}
+
+<head>
+    <meta charset="UTF-8">
+    <title>Directory listing for /{{ path }}</title>
+</head>
+
+<body>
+    <h1>Directory listing for /{{ path }}</h1>
+
+    <input type="text" placeholder="Search...">
+
+    <ul>
+        {# Going to parent directory if not alredy in #}
+        {% if path %}
+            <li><a href="?path=/{{ "".join(path.split('/')[:-1]) }}">..</a></li>
+        {% endif %}
+
+        {# Listing items #}
+        {% for item in items %}
+            <li><a href="?path={{ f'/{path}/{item}' if path else f'/{item}' }}">{{ item }}</a></li>
+        {% endfor %}
+
+    </ul>
+
+    {# Script for filtering items #}
+    <script>
+        const search = document.querySelector('input');
+        const items = document.querySelectorAll('li');
+
+        search.addEventListener('keyup', (e) => {
+            const term = e.target.value.toLowerCase();
+
+            items.forEach(item => {
+                const text = item.innerText.toLowerCase();
+
+                if (text.indexOf(term) != -1) {
+                    item.style.display = 'list-item';
+                } else {
+                    item.style.display = 'none';
+                }
+            });
+        });
+    </script>
+</body>
+
+</html>
diff --git a/examples/httpserver_templates.py b/examples/httpserver_templates.py
@@ -0,0 +1,61 @@
+# SPDX-FileCopyrightText: 2023 Michal Pokusa
+#
+# SPDX-License-Identifier: Unlicense
+import os
+import re
+
+import socketpool
+import wifi
+
+from adafruit_httpserver import Server, Request, Response, FileResponse
+
+try:
+    from adafruit_templateengine import render_template
+except ImportError as e:
+    raise ImportError("This example requires adafruit_templateengine library.") from e
+
+
+pool = socketpool.SocketPool(wifi.radio)
+server = Server(pool, "/static", debug=True)
+
+# Create /static directory if it doesn't exist
+try:
+    os.listdir("/static")
+except OSError as e:
+    raise OSError("Please create a /static directory on the CIRCUITPY drive.") from e
+
+
+@server.route("/")
+def directory_listing(request: Request):
+    path = request.query_params.get("path") or ""
+
+    # Remove .. and . from path
+    path = re.sub(r"\/(\.\.|\.)\/|\/(\.\.|\.)|(\.\.|\.)\/", "/", path).strip("/")
+
+    if path:
+        is_file = (
+            os.stat(f"/static/{path}")[0] & 0b_11110000_00000000
+        ) == 0b_10000000_00000000
+    else:
+        is_file = False
+
+    # If path is a file, return it as a file response
+    if is_file:
+        return FileResponse(request, path)
+
+    # Otherwise, return a directory listing
+    return Response(
+        request,
+        render_template(
+            "directory_listing.tpl.html",
+            context={
+                "path": path,
+                "items": os.listdir(f"/static/{path}"),
+            },
+        ),
+        content_type="text/html",
+    )
+
+
+# Start the server.
+server.serve_forever(str(wifi.radio.ipv4_address))
