2024-10-12 16:12:31 +00:00
|
|
|
from datetime import datetime
|
|
|
|
|
from io import BytesIO
|
|
|
|
|
from pathlib import Path
|
|
|
|
|
from typing import Dict, Any, List
|
|
|
|
|
|
|
|
|
|
from markdown import markdown
|
|
|
|
|
from xhtml2pdf import pisa
|
|
|
|
|
|
2024-10-13 07:05:28 +00:00
|
|
|
import site
|
|
|
|
|
from fpdf import FPDF
|
|
|
|
|
|
|
|
|
|
from open_webui.env import STATIC_DIR, FONTS_DIR
|
2024-10-12 16:12:31 +00:00
|
|
|
from open_webui.apps.webui.models.chats import ChatTitleMessagesForm
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class PDFGenerator:
|
|
|
|
|
"""
|
|
|
|
|
Description:
|
|
|
|
|
The `PDFGenerator` class is designed to create PDF documents from chat messages.
|
|
|
|
|
The process involves transforming markdown content into HTML and then into a PDF format,
|
|
|
|
|
which can be easily returned as a response to the routes.
|
|
|
|
|
|
|
|
|
|
It depends on xhtml2pdf for converting HTML to PDF (more details at https://github.com/xhtml2pdf/xhtml2pdf).
|
|
|
|
|
I found xhtml2pdf issues when rendering list html tag, see https://github.com/xhtml2pdf/xhtml2pdf/issues/550
|
|
|
|
|
and https://github.com/xhtml2pdf/xhtml2pdf/issues/756.
|
|
|
|
|
|
|
|
|
|
Attributes:
|
|
|
|
|
- `form_data`: An instance of `ChatTitleMessagesForm` containing title and messages.
|
|
|
|
|
|
|
|
|
|
"""
|
|
|
|
|
|
|
|
|
|
def __init__(self, form_data: ChatTitleMessagesForm):
|
|
|
|
|
self.html_body = None
|
|
|
|
|
self.messages_html = None
|
|
|
|
|
self.form_data = form_data
|
|
|
|
|
|
2024-10-13 07:05:28 +00:00
|
|
|
self.css = Path(STATIC_DIR / "assets" / "pdf-style.css").read_text()
|
|
|
|
|
|
|
|
|
|
def format_timestamp(self, timestamp: float) -> str:
|
|
|
|
|
"""Convert a UNIX timestamp to a formatted date string."""
|
|
|
|
|
try:
|
|
|
|
|
date_time = datetime.fromtimestamp(timestamp)
|
|
|
|
|
return date_time.strftime("%Y-%m-%d, %H:%M:%S")
|
|
|
|
|
except (ValueError, TypeError) as e:
|
|
|
|
|
# Log the error if necessary
|
|
|
|
|
return ""
|
|
|
|
|
|
|
|
|
|
def _build_html_message(self, message: Dict[str, Any]) -> str:
|
2024-10-12 16:12:31 +00:00
|
|
|
"""Build HTML for a single message."""
|
|
|
|
|
role = message.get("role", "user")
|
|
|
|
|
content = message.get("content", "")
|
2024-10-13 07:05:28 +00:00
|
|
|
timestamp = message.get("timestamp")
|
2024-10-12 16:12:31 +00:00
|
|
|
|
2024-10-13 07:05:28 +00:00
|
|
|
model = message.get("model") if role == "assistant" else ""
|
2024-10-12 16:12:31 +00:00
|
|
|
|
2024-10-13 07:05:28 +00:00
|
|
|
date_str = self.format_timestamp(timestamp) if timestamp else ""
|
2024-10-12 16:12:31 +00:00
|
|
|
|
|
|
|
|
# extends pymdownx extension to convert markdown to html.
|
|
|
|
|
# - https://facelessuser.github.io/pymdown-extensions/usage_notes/
|
2024-10-13 07:05:28 +00:00
|
|
|
html_content = markdown(content, extensions=["pymdownx.extra"])
|
2024-10-12 16:12:31 +00:00
|
|
|
|
|
|
|
|
html_message = f"""
|
|
|
|
|
<div class="message">
|
|
|
|
|
<small> {date_str} </small>
|
|
|
|
|
<div>
|
|
|
|
|
<h2>
|
|
|
|
|
<strong>{role.title()}</strong>
|
|
|
|
|
<small class="text-muted">{model}</small>
|
|
|
|
|
</h2>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="markdown-section">
|
|
|
|
|
{html_content}
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
"""
|
|
|
|
|
return html_message
|
|
|
|
|
|
2024-10-13 07:05:28 +00:00
|
|
|
def _fetch_resources(self, uri: str, rel: str) -> str:
|
|
|
|
|
|
|
|
|
|
print(str(STATIC_DIR / uri))
|
|
|
|
|
return str(STATIC_DIR / uri)
|
|
|
|
|
|
|
|
|
|
def _create_pdf_from_html(self) -> bytes:
|
2024-10-12 16:12:31 +00:00
|
|
|
"""Convert HTML content to PDF and return the bytes."""
|
|
|
|
|
pdf_buffer = BytesIO()
|
2024-10-13 07:05:28 +00:00
|
|
|
pisa_status = pisa.CreatePDF(
|
|
|
|
|
src=self.html_body.encode("UTF-8"),
|
|
|
|
|
dest=pdf_buffer,
|
|
|
|
|
encoding="UTF-8",
|
|
|
|
|
link_callback=self._fetch_resources,
|
|
|
|
|
)
|
2024-10-12 16:12:31 +00:00
|
|
|
if pisa_status.err:
|
|
|
|
|
raise RuntimeError("Error generating PDF")
|
|
|
|
|
|
|
|
|
|
return pdf_buffer.getvalue()
|
|
|
|
|
|
2024-10-13 07:05:28 +00:00
|
|
|
def _generate_html_body(self) -> str:
|
2024-10-12 16:12:31 +00:00
|
|
|
"""Generate the full HTML body for the PDF."""
|
|
|
|
|
return f"""
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="UTF-8">
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
2024-10-13 07:05:28 +00:00
|
|
|
<style type="text/css">
|
|
|
|
|
{self.css}
|
|
|
|
|
</style>
|
2024-10-12 16:12:31 +00:00
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
<div class="container">
|
|
|
|
|
<div class="text-center">
|
|
|
|
|
<h1>{self.form_data.title}</h1>
|
|
|
|
|
</div>
|
|
|
|
|
<div>
|
|
|
|
|
{self.messages_html}
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
|
|
|
|
"""
|
2024-10-13 07:05:28 +00:00
|
|
|
|
|
|
|
|
def generate_chat_pdf(self) -> bytes:
|
|
|
|
|
"""
|
|
|
|
|
Generate a PDF from chat messages.
|
|
|
|
|
"""
|
|
|
|
|
try:
|
|
|
|
|
global FONTS_DIR
|
|
|
|
|
|
|
|
|
|
pdf = FPDF()
|
|
|
|
|
pdf.add_page()
|
|
|
|
|
|
|
|
|
|
# When running using `pip install` the static directory is in the site packages.
|
|
|
|
|
if not FONTS_DIR.exists():
|
|
|
|
|
FONTS_DIR = Path(site.getsitepackages()[0]) / "static/fonts"
|
|
|
|
|
# When running using `pip install -e .` the static directory is in the site packages.
|
|
|
|
|
# This path only works if `open-webui serve` is run from the root of this project.
|
|
|
|
|
if not FONTS_DIR.exists():
|
|
|
|
|
FONTS_DIR = Path("./backend/static/fonts")
|
|
|
|
|
|
|
|
|
|
pdf.add_font("NotoSans", "", f"{FONTS_DIR}/NotoSans-Regular.ttf")
|
|
|
|
|
pdf.add_font("NotoSans", "b", f"{FONTS_DIR}/NotoSans-Bold.ttf")
|
|
|
|
|
pdf.add_font("NotoSans", "i", f"{FONTS_DIR}/NotoSans-Italic.ttf")
|
|
|
|
|
pdf.add_font("NotoSansKR", "", f"{FONTS_DIR}/NotoSansKR-Regular.ttf")
|
|
|
|
|
pdf.add_font("NotoSansJP", "", f"{FONTS_DIR}/NotoSansJP-Regular.ttf")
|
|
|
|
|
pdf.add_font("NotoSansSC", "", f"{FONTS_DIR}/NotoSansSC-Regular.ttf")
|
|
|
|
|
|
|
|
|
|
pdf.set_font("NotoSans", size=12)
|
|
|
|
|
pdf.set_fallback_fonts(["NotoSansKR", "NotoSansJP", "NotoSansSC"])
|
|
|
|
|
|
|
|
|
|
pdf.set_auto_page_break(auto=True, margin=15)
|
|
|
|
|
|
|
|
|
|
# Adjust the effective page width for multi_cell
|
|
|
|
|
effective_page_width = (
|
|
|
|
|
pdf.w - 2 * pdf.l_margin - 10
|
|
|
|
|
) # Subtracted an additional 10 for extra padding
|
|
|
|
|
|
|
|
|
|
# Add chat messages
|
|
|
|
|
for message in self.form_data.messages:
|
|
|
|
|
role = message["role"]
|
|
|
|
|
content = message["content"]
|
|
|
|
|
pdf.set_font("NotoSans", "B", size=14) # Bold for the role
|
|
|
|
|
pdf.multi_cell(effective_page_width, 10, f"{role.upper()}", 0, "L")
|
|
|
|
|
pdf.ln(1) # Extra space between messages
|
|
|
|
|
|
|
|
|
|
pdf.set_font("NotoSans", size=10) # Regular for content
|
|
|
|
|
pdf.multi_cell(effective_page_width, 6, content, 0, "L")
|
|
|
|
|
pdf.ln(1.5) # Extra space between messages
|
|
|
|
|
|
|
|
|
|
# Save the pdf with name .pdf
|
|
|
|
|
pdf_bytes = pdf.output()
|
|
|
|
|
|
|
|
|
|
return bytes(pdf_bytes)
|
|
|
|
|
except Exception as e:
|
|
|
|
|
raise e
|
