Add page to view log list and several fixes

.github/workflows/docker-image.yml

@@ -0,0 +1,42 @@
+
+name: Create and publish a Docker image
+
+on:
+  push:
+    branches: ['master']
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v2
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v3
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

Pipfile

@@ -11,6 +11,7 @@ motor = "~=3.0"
 natural = "~=0.2.0"
 pymongo = {version = "*", extras = ['srv']}  # Required by motor
 python-dateutil = "~=2.8.2"
+python-dotenv = "~=0.18.0"
 sanic = "~=22.6.0"
 
 [scripts]

app.py

@@ -2,13 +2,16 @@
 
 import os
 
+from dotenv import load_dotenv
 from motor.motor_asyncio import AsyncIOMotorClient
 from sanic import Sanic, response
 from sanic.exceptions import NotFound
 from jinja2 import Environment, FileSystemLoader
 
-from core.models import LogEntry
+from core.models import LogEntry, LogList
+from core.utils import loglist
 
+load_dotenv()
 
 if "URL_PREFIX" in os.environ:
     print("Using the legacy config var `URL_PREFIX`, rename it to `LOG_URL_PREFIX`")
@@ -19,9 +22,11 @@
 if prefix == "NONE":
     prefix = ""
 
-MONGO_URI = os.getenv("MONGO_URI")
+MONGO_URI = os.getenv("MONGO_URI") or os.getenv("CONNECTION_URI")
 if not MONGO_URI:
-    MONGO_URI = os.environ['CONNECTION_URI']
+    print("No CONNECTION_URI config var found. "
+          "Please enter your MongoDB connection URI in the configuration or .env file.")
+    exit(1)
 
 app = Sanic(__name__)
 app.static("/static", "./static")
@@ -49,7 +54,20 @@ async def not_found(request, exc):
 
 @app.get("/")
 async def index(request):
-    return render_template("index")
+    return render_template("index", prefix=prefix)
+
+
+@app.get(prefix)
+@loglist()
+async def get_log_list(request, document, page, max_page, status_open, count_all):
+    """Returns the html rendered log list"""
+
+    if document is None:
+        raise NotFound
+
+    log_list = LogList(app, document, prefix, page, max_page, status_open, count_all)
+
+    return log_list.render_html()
 
 
 @app.get(prefix + "/raw/<key>")

core/formatter.py

@@ -22,6 +22,10 @@ def encode_inline_codeblock(m):
     # Encode inline codeblocks (`text`)
     content = re.sub(r"`([^`]+)`", encode_inline_codeblock, content)
 
+    # Encode inline blockquotes (> test)
+    # Multiline blockquotes (>>> test) are saved as single in Mongo (> test)
+    content = re.sub(r"(&gt; )([^\n]+)", r"<blockquote>\2</blockquote>", content)
+
     # Encode links
     if allow_links:
 

core/models.py

@@ -1,21 +1,21 @@
-from datetime import datetime
+from datetime import datetime, timezone
 import dateutil.parser
 
 from sanic import response
 from natural.date import duration
 
-from .formatter import format_content_html
+from core.formatter import format_content_html
 
 
 class LogEntry:
     def __init__(self, app, data):
         self.app = app
         self.key = data["key"]
         self.open = data["open"]
-        self.created_at = dateutil.parser.parse(data["created_at"])
-        self.human_created_at = duration(self.created_at, now=datetime.utcnow())
+        self.created_at = dateutil.parser.parse(data["created_at"]).astimezone(timezone.utc)
+        self.human_created_at = duration(self.created_at, now=datetime.now(timezone.utc))
         self.closed_at = (
-            dateutil.parser.parse(data["closed_at"]) if not self.open else None
+            dateutil.parser.parse(data["closed_at"]).astimezone(timezone.utc) if not self.open else None
         )
         self.channel_id = int(data["channel_id"])
         self.guild_id = int(data["guild_id"])
@@ -31,11 +31,11 @@ def __init__(self, app, data):
 
     @property
     def system_avatar_url(self):
-        return "https://discordapp.com/assets/" "f78426a064bc9dd24847519259bc42af.png"
+        return "/static/img/avatar_self.png"
 
     @property
     def human_closed_at(self):
-        return duration(self.closed_at, now=datetime.utcnow())
+        return duration(self.closed_at, now=datetime.now(timezone.utc))
 
     @property
     def message_groups(self):
@@ -110,6 +110,19 @@ def render_plain_text(self):
 
         return response.text(out)
 
+class LogList:
+    def __init__(self, app, data, prefix, page, max_page, status_open, count_all):
+        self.app = app
+        self.logs = data
+        self.prefix = prefix
+        self.page = page
+        self.max_page = max_page
+        self.status_open = status_open
+        self.count_all = count_all
+
+    def render_html(self):
+        return self.app.ctx.render_template("loglist", data=self)
+
 
 class User:
     def __init__(self, data):
@@ -165,8 +178,8 @@ def __init__(self, data):
 class Message:
     def __init__(self, data):
         self.id = int(data["message_id"])
-        self.created_at = dateutil.parser.parse(data["timestamp"])
-        self.human_created_at = duration(self.created_at, now=datetime.utcnow())
+        self.created_at = dateutil.parser.parse(data["timestamp"]).astimezone(timezone.utc)
+        self.human_created_at = duration(self.created_at, now=datetime.now(timezone.utc))
         self.raw_content = data["content"]
         self.content = self.format_html_content(self.raw_content)
         self.attachments = [Attachment(a) for a in data["attachments"]]

core/utils.py

@@ -0,0 +1,108 @@
+from functools import wraps
+
+from datetime import datetime, timezone
+import dateutil.parser
+from natural.date import duration
+
+import os
+from dotenv import load_dotenv
+
+load_dotenv()
+
+def loglist():
+    def decorator(func):
+        @wraps(func)
+        async def wrapper(request):
+            app = request.app
+
+            config = await app.ctx.db.config.find_one()
+
+            logs_per_page = 25
+
+            if "PAGINATION" in os.environ:
+                try:
+                    logs_per_page = int(os.environ["PAGINATION"])
+                except ValueError:
+                    print("Invalid PAGINATION config var (must be a number). Defaulting to 25.")
+
+            collection = app.ctx.db.logs
+
+            try:
+                page = int(request.args.get("page", 1))
+                if page < 1: page = 1
+            except ValueError:
+                page = 1
+
+            def parse_date(date):
+                date = dateutil.parser.parse(date).astimezone(timezone.utc)
+                timestamp = duration(date, datetime.now(timezone.utc))
+                return timestamp
+
+            async def find():
+
+                filter_ = {"bot_id": str(config["bot_id"])}
+
+                count_all = await collection.count_documents(filter=filter_)
+
+                status_open = request.args.get("open")
+
+                if status_open == "false":
+                    filter_["open"] = False
+                elif status_open == "true":
+                    filter_["open"] = True
+                else: status_open = None
+
+                if request.args.get("search"): 
+                    search = request.args.get("search")
+                    filter_["$text"] = { "$search": search }
+
+                projection_ = {
+                    "key": 1,
+                    "open": 1,
+                    "created_at": 1,
+                    "closed_at": 1,
+                    "recipient": 1,
+                    "creator": 1,
+                    "title": 1,
+                    "last_message": { "$arrayElemAt": [ "$messages", -1 ] },
+                    "message_count": { "$size": "$messages" },
+                    "nsfw": 1
+                }
+
+                cursor = collection.find(filter=filter_, projection=projection_, skip=(page-1)*logs_per_page).sort(
+                    "created_at", -1
+                )
+
+                count = await collection.count_documents(filter=filter_)
+
+                max_page = count // logs_per_page
+                if (count % logs_per_page) > 0: max_page += 1
+
+                items = await cursor.to_list(length=logs_per_page)
+
+                # iterate over list to change timestamps to readable format
+                for index, item in enumerate(items):
+                    creation_date = item.get('created_at')
+                    items[index].update(created_at=parse_date(creation_date))
+                    close_date = item.get('closed_at')
+
+                    if close_date is not None:
+                        items[index].update(closed_at=parse_date(close_date))
+
+                    try:
+                        last_message = items[index].get("last_message")
+                        last_message_duration = parse_date(
+                            last_message.get("timestamp")
+                        )
+                        items[index]["last_message_time"] = last_message_duration
+                    except Exception:
+                        pass
+
+                return items, max_page, status_open, count_all
+
+            document, max_page, status_open, count_all = await find()
+            return await func(request, document, page, max_page, status_open, count_all)
+
+        return wrapper
+
+    return decorator

requirements.txt

@@ -1,17 +1,18 @@
 -i https://pypi.org/simple
-aiofiles==0.8.0; python_version >= '3.6' and python_version < '4.0'
+aiofiles==22.1.0; python_version >= '3.7' and python_version < '4.0'
 dnspython==2.2.1; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
-httptools==0.4.0; python_full_version >= '3.5.0'
+httptools==0.5.0; python_full_version >= '3.5.0'
 jinja2==3.1.2
 markupsafe==2.1.1; python_version >= '3.7'
 motor==3.0.0
 multidict==6.0.2; python_version >= '3.7'
 natural==0.2.0
 pymongo[srv]==4.2.0
 python-dateutil==2.8.2
+python-dotenv==0.18.0
 sanic==22.6.2
 sanic-routing==22.3.0
 six==1.16.0; python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3'
-ujson==5.4.0; sys_platform != 'win32' and implementation_name == 'cpython'
-uvloop==0.16.0; sys_platform != 'win32' and implementation_name == 'cpython'
+ujson==5.5.0; sys_platform != 'win32' and implementation_name == 'cpython'
+uvloop==0.17.0; sys_platform != 'win32' and implementation_name == 'cpython'
 websockets==10.3; python_version >= '3.7'