Merge pull request #150 from FroostySnoowman/master

V3.0.0 Layout Fixes

Author: doluk

chat_exporter/__init__.py

@@ -7,7 +7,7 @@
     AttachmentToWebhookHandler,
     AttachmentToDiscordChannelHandler)
 
-__version__ = "3.0.0"
+__version__ = "3.0.1"
 
 __all__ = (
     export,

chat_exporter/construct/assets/embed.py

@@ -1,5 +1,7 @@
 import html
 
+from pytz import timezone
+
 from chat_exporter.ext.discord_import import discord
 
 from chat_exporter.ext.html_generator import (
@@ -44,9 +46,11 @@ class Embed:
 
     check_against = None
 
-    def __init__(self, embed, guild):
+    def __init__(self, embed, guild, pytz_timezone=None, military_time=True):
         self.embed: discord.Embed = embed
         self.guild: discord.Guild = guild
+        self.pytz_timezone = pytz_timezone
+        self.military_time = military_time
 
     async def flow(self):
         self.check_against = _gather_checker()
@@ -68,13 +72,45 @@ def build_colour(self):
             if self.embed.colour != self.check_against else (0x4A, 0x4A, 0x50)
         )
 
+    def _format_embed_timestamp(self) -> str:
+        timestamp = getattr(self.embed, "timestamp", None)
+        if not timestamp or timestamp == self.check_against:
+            return ""
+
+        time_value = timestamp
+        if not getattr(time_value, "tzinfo", None):
+            time_value = timezone("UTC").localize(time_value)
+
+        tz_name = self.pytz_timezone or getattr(self.guild, "timezone", "UTC") or "UTC"
+        try:
+            tz = timezone(tz_name)
+        except Exception:
+            tz = timezone("UTC")
+
+        local_time = time_value.astimezone(tz)
+        if self.military_time:
+            return local_time.strftime("%d-%m-%Y %H:%M")
+        return local_time.strftime("%d-%m-%Y %I:%M %p")
+
     async def build_title(self):
-        self.title = html.escape(self.embed.title) if self.embed.title != self.check_against else ""
+        raw_title = html.escape(self.embed.title) if self.embed.title != self.check_against else ""
 
-        if self.title:
-            self.title = await fill_out(self.guild, embed_title, [
-                ("EMBED_TITLE", self.title, PARSE_MODE_MARKDOWN)
-            ])
+        if not raw_title:
+            self.title = ""
+            return
+
+        title_html = await fill_out(self.guild, "{{EMBED_TITLE}}", [
+            ("EMBED_TITLE", raw_title, PARSE_MODE_MARKDOWN)
+        ])
+
+        url_value = getattr(self.embed, "url", self.check_against)
+        if url_value and url_value != self.check_against:
+            safe_url = html.escape(str(url_value), quote=True)
+            title_html = f'<a href="{safe_url}">{title_html}</a>'
+
+        self.title = await fill_out(self.guild, embed_title, [
+            ("EMBED_TITLE", title_html, PARSE_MODE_NONE)
+        ])
 
     async def build_description(self):
         self.description = html.escape(self.embed.description) if self.embed.description != self.check_against else ""
@@ -136,25 +172,32 @@ async def build_thumbnail(self):
             if self.embed.thumbnail and self.embed.thumbnail.url != self.check_against else ""
 
     async def build_footer(self):
-        self.footer = html.escape(self.embed.footer.text) if (
+        footer_text = html.escape(self.embed.footer.text) if (
                 self.embed.footer and self.embed.footer.text != self.check_against
         ) else ""
 
         footer_icon = self.embed.footer.icon_url if (
                 self.embed.footer and self.embed.footer.icon_url != self.check_against
         ) else None
 
-        if not self.footer:
+        timestamp_text = self._format_embed_timestamp()
+        if footer_text and timestamp_text:
+            footer_text = f"{footer_text} | {timestamp_text}"
+        elif not footer_text and timestamp_text:
+            footer_text = timestamp_text
+
+        if not footer_text:
+            self.footer = ""
             return
 
         if footer_icon is not None:
             self.footer = await fill_out(self.guild, embed_footer_icon, [
-                ("EMBED_FOOTER", self.footer, PARSE_MODE_NONE),
+                ("EMBED_FOOTER", footer_text, PARSE_MODE_NONE),
                 ("EMBED_FOOTER_ICON", footer_icon, PARSE_MODE_NONE)
             ])
         else:
             self.footer = await fill_out(self.guild, embed_footer, [
-                ("EMBED_FOOTER", self.footer, PARSE_MODE_NONE)])
+                ("EMBED_FOOTER", footer_text, PARSE_MODE_NONE)])
 
     async def build_embed(self):
         self.embed = await fill_out(self.guild, embed_body, [
@@ -168,4 +211,4 @@ async def build_embed(self):
             ("EMBED_DESC", self.description, PARSE_MODE_NONE),
             ("EMBED_FIELDS", self.fields, PARSE_MODE_NONE),
             ("EMBED_FOOTER", self.footer, PARSE_MODE_NONE),
-        ])
+        ])

chat_exporter/construct/message.py

@@ -94,6 +94,48 @@ def get_message_snapshots(self):
             return self.message.snapshots
         return []
 
+    @staticmethod
+    def _collect_attachment_urls(attachment):
+        urls = set()
+        for attr in ("url", "proxy_url"):
+            value = getattr(attachment, attr, None)
+            if value:
+                urls.add(str(value))
+        return urls
+
+    @staticmethod
+    def _embed_has_non_image_content(embed) -> bool:
+        if getattr(embed, "title", None):
+            return True
+        if getattr(embed, "description", None):
+            return True
+        if getattr(embed, "fields", None):
+            if len(embed.fields) > 0:
+                return True
+        author = getattr(embed, "author", None)
+        if author and getattr(author, "name", None):
+            return True
+        footer = getattr(embed, "footer", None)
+        if footer and getattr(footer, "text", None):
+            return True
+        thumbnail = getattr(embed, "thumbnail", None)
+        if thumbnail and getattr(thumbnail, "url", None):
+            return True
+        return False
+
+    def _is_duplicate_image_embed(self, embed, attachment_urls) -> bool:
+        if not attachment_urls:
+            return False
+        image = getattr(embed, "image", None)
+        if not image:
+            return False
+        image_url = getattr(image, "proxy_url", None) or getattr(image, "url", None)
+        if not image_url or str(image_url) not in attachment_urls:
+            return False
+        if self._embed_has_non_image_content(embed):
+            return False
+        return True
+
     async def construct_message(
         self,
     ) -> (str, dict):
@@ -308,8 +350,8 @@ async def build_sticker(self):
         ])
 
     async def build_assets(self):
-        for e in self.message.embeds:
-            self.embeds += await Embed(e, self.guild).flow()
+        processed_attachments = []
+        attachment_urls = set()
 
         for snapshot in self.get_message_snapshots():
             if hasattr(snapshot, "embeds"):
@@ -320,6 +362,15 @@ async def build_assets(self):
         for a in self.message.attachments:
             if self.attachment_handler and isinstance(self.attachment_handler, AttachmentHandler):
                 a = await self.attachment_handler.process_asset(a)
+            processed_attachments.append(a)
+            attachment_urls.update(self._collect_attachment_urls(a))
+
+        for e in self.message.embeds:
+            if self._is_duplicate_image_embed(e, attachment_urls):
+                continue
+            self.embeds += await Embed(e, self.guild, self.pytz_timezone, self.military_time).flow()
+
+        for a in processed_attachments:
             self.attachments += await Attachment(a, self.guild).flow()
 
         for snapshot in self.get_message_snapshots():

chat_exporter/html/base.html

@@ -474,6 +474,9 @@
 
         .chatlog__attachment.chatlog__attachment-spoiler {
             overflow: hidden;
+            position: relative;
+            display: block;
+            width: fit-content;
         }
 
         .chatlog__attachment.chatlog__attachment-spoiler::before {
@@ -554,7 +557,7 @@
 
         .chatlog__embed {
             --embed-color: rgba(74, 74, 80, 1);
-            display: inline-grid;
+            display: grid;
             grid-template-columns: minmax(0, 1fr) auto;
             column-gap: 1rem;
             margin-top: 0.35em;

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "chat_exporter"
 description = "A simple Discord chat exporter for Python Discord bots."
-version = "3.0.0"
+version = "3.0.1"
 readme = "README.md"
 authors = [
     { name="mahtoid", email="info@mahto.id" }