mirror of
https://github.com/OWASP/www-project-ai-testing-guide.git
synced 2026-02-12 13:42:44 +00:00
Add adjusted PDF generator from AIMA project
This commit is contained in:
Philippe Schrettenbrunner
399
PDFGenerator/generate_pdf_preview.py
Executable file
399
PDFGenerator/generate_pdf_preview.py
Executable file
@@ -0,0 +1,399 @@
|
||||
#!/usr/bin/env python3
|
||||
import argparse
|
||||
import re
|
||||
import subprocess
|
||||
from datetime import datetime
|
||||
from markdown import markdown
|
||||
from pathlib import Path
|
||||
from weasyprint import HTML
|
||||
|
||||
VALIDATE_STRUCTURE = False
|
||||
|
||||
def sanitize_heading(text):
|
||||
return re.sub(r'[^a-zA-Z0-9_-]', '', text.replace(' ', '_'))
|
||||
|
||||
def get_git_info():
|
||||
try:
|
||||
commit = subprocess.check_output(["git", "rev-parse", "--short", "HEAD"]).decode().strip()
|
||||
branch = subprocess.check_output(["git", "rev-parse", "--abbrev-ref", "HEAD"]).decode().strip()
|
||||
return branch, commit
|
||||
except Exception:
|
||||
return "unknown", "unknown"
|
||||
|
||||
def transform_special_blockquotes(md_text: str) -> str:
|
||||
md_text = re.sub(
|
||||
r'(?m)^> NOTE:\s*(.*)',
|
||||
r'<blockquote class="note"><strong>Note:</strong> \1</blockquote>',
|
||||
md_text
|
||||
)
|
||||
md_text = re.sub(
|
||||
r'(?m)^> COMMENT:\s*(.*)',
|
||||
r'<blockquote class="comment"><strong>Comment:</strong> \1</blockquote>',
|
||||
md_text
|
||||
)
|
||||
return md_text
|
||||
|
||||
def validate_markdown(file_path: Path, html: str):
|
||||
headings = re.findall(r'<h([123])>(.*?)</h\1>', html)
|
||||
|
||||
if VALIDATE_STRUCTURE:
|
||||
if not any(level == '1' for level, _ in headings):
|
||||
raise ValueError(f"Validation failed: No <h1> heading found in {file_path}")
|
||||
|
||||
return headings
|
||||
|
||||
def resolve_image_paths(html: str, base_path: Path) -> str:
|
||||
def repl(match):
|
||||
src = match.group(1)
|
||||
abs_path = (base_path / src).resolve()
|
||||
if not abs_path.exists():
|
||||
print(f"Warning: Image file not found: {abs_path}")
|
||||
else:
|
||||
print(f"Embedding image: {src} → {abs_path}")
|
||||
return f'<img src="file://{abs_path}" style="display: block; margin: 2em auto; max-width: 100%;" />'
|
||||
|
||||
return re.sub(r'<img\s+[^>]*src="([^"]+)"[^>]*>', repl, html)
|
||||
|
||||
def parse_toc_file(toc_path: Path) -> list[Path]:
|
||||
"""Parse a markdown ToC file and extract file paths in order."""
|
||||
print(f"\nParsing ToC file: {toc_path}")
|
||||
with open(toc_path, encoding='utf-8') as f:
|
||||
toc_content = f.read()
|
||||
|
||||
# Extract all markdown links: [text](path)
|
||||
link_pattern = r'\[([^\]]+)\]\(([^)]+\.md)\)'
|
||||
matches = re.findall(link_pattern, toc_content)
|
||||
|
||||
file_paths = []
|
||||
toc_dir = toc_path.parent
|
||||
|
||||
for title, relative_path in matches:
|
||||
# Resolve relative path from ToC file location
|
||||
# Clean up paths like ../Document/../Document/content/file.md
|
||||
abs_path = (toc_dir / relative_path).resolve()
|
||||
|
||||
if not abs_path.exists():
|
||||
print(f" ⚠ Warning: File not found: {relative_path} → {abs_path}")
|
||||
else:
|
||||
file_paths.append(abs_path)
|
||||
print(f" ✓ Found: {relative_path}")
|
||||
|
||||
print(f"\nTotal files found: {len(file_paths)}")
|
||||
return file_paths
|
||||
|
||||
def scan_directory(input_dir: Path) -> list[Path]:
|
||||
"""Scan directory for markdown files with numeric naming pattern."""
|
||||
print(f"\nScanning directory: {input_dir}")
|
||||
markdown_files = sorted(
|
||||
[
|
||||
p for p in input_dir.rglob('*.md')
|
||||
if re.match(r'^\d{2}', p.name)
|
||||
and re.match(r'^\d{2}', p.relative_to(input_dir).parts[0])
|
||||
],
|
||||
key=lambda p: str(p)
|
||||
)
|
||||
print(f"Total files found: {len(markdown_files)}")
|
||||
return markdown_files
|
||||
|
||||
def generate_pdf(input_path: Path, output_file: Path):
|
||||
# Determine input mode: ToC file or directory
|
||||
if input_path.is_file():
|
||||
print(f"Mode: ToC file")
|
||||
markdown_files = parse_toc_file(input_path)
|
||||
elif input_path.is_dir():
|
||||
print(f"Mode: Directory scan")
|
||||
markdown_files = scan_directory(input_path)
|
||||
else:
|
||||
raise ValueError(f"Input path does not exist: {input_path}")
|
||||
|
||||
if not markdown_files:
|
||||
raise ValueError("No markdown files found to process")
|
||||
|
||||
toc_entries = []
|
||||
content_blocks = []
|
||||
|
||||
h1_counter = 0
|
||||
h2_counter = 0
|
||||
h3_counter = 0
|
||||
|
||||
print(f"\nProcessing {len(markdown_files)} files...")
|
||||
for file in markdown_files:
|
||||
print(f" Processing: {file.name}")
|
||||
with open(file, encoding='utf-8') as f:
|
||||
raw_md = f.read()
|
||||
raw_md = transform_special_blockquotes(raw_md)
|
||||
html = markdown(raw_md, extensions=['extra', 'nl2br', 'sane_lists', 'attr_list'])
|
||||
html = resolve_image_paths(html, file.parent)
|
||||
headings = validate_markdown(file, html)
|
||||
|
||||
for level, heading in headings:
|
||||
if level == '1':
|
||||
h1_counter += 1
|
||||
h2_counter = 0
|
||||
h3_counter = 0
|
||||
number = f"{h1_counter}"
|
||||
elif level == '2':
|
||||
h2_counter += 1
|
||||
h3_counter = 0
|
||||
number = f"{h1_counter}.{h2_counter}"
|
||||
elif level == '3':
|
||||
h3_counter += 1
|
||||
number = f"{h1_counter}.{h2_counter}.{h3_counter}"
|
||||
else:
|
||||
number = ""
|
||||
|
||||
numbered_heading = f"{number} {heading}"
|
||||
anchor = sanitize_heading(f"{number}_{heading}")
|
||||
toc_entries.append(
|
||||
f"<li class='toc-level-{level}'><a href='#{anchor}'>{numbered_heading}</a></li>"
|
||||
)
|
||||
html = html.replace(
|
||||
f"<h{level}>{heading}</h{level}>",
|
||||
f"<h{level} id='{anchor}'>{numbered_heading}</h{level}>"
|
||||
)
|
||||
|
||||
content_blocks.append(html)
|
||||
|
||||
current_date = datetime.utcnow().strftime('%Y-%m-%d %H:%M UTC')
|
||||
branch, commit = get_git_info()
|
||||
|
||||
combined_html = f"""
|
||||
<html>
|
||||
<head>
|
||||
<meta charset='utf-8'>
|
||||
<style>
|
||||
@page {{
|
||||
size: A4;
|
||||
margin: 2.5cm 2.5cm 3.5cm 2.5cm;
|
||||
background-size: cover;
|
||||
background: url('background.svg') no-repeat fixed top left;
|
||||
|
||||
@bottom-right {{
|
||||
content: "Page " counter(page);
|
||||
width: 1.8cm;
|
||||
font-size: 10pt;
|
||||
text-align: center;
|
||||
transform: translate(0, -0.5cm);
|
||||
}}
|
||||
}}
|
||||
|
||||
body {{
|
||||
font-family: 'Georgia', 'Times New Roman', serif;
|
||||
font-size: 11.5pt;
|
||||
line-height: 1.6;
|
||||
color: #222;
|
||||
margin: 0 auto;
|
||||
max-width: 75ch;
|
||||
}}
|
||||
|
||||
h1, h2, h3 {{
|
||||
font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;
|
||||
color: #111;
|
||||
}}
|
||||
|
||||
h1 {{
|
||||
font-size: 2.4em;
|
||||
margin-top: 2.5em;
|
||||
margin-bottom: 0.5em;
|
||||
border-bottom: 2px solid #888;
|
||||
page-break-before: always;
|
||||
break-before: page;
|
||||
line-height: 1.1;
|
||||
}}
|
||||
|
||||
h2 {{
|
||||
font-size: 1.8em;
|
||||
margin-top: 2em;
|
||||
margin-bottom: 0.4em;
|
||||
line-height: 1.2;
|
||||
break-inside: avoid;
|
||||
}}
|
||||
|
||||
h3 {{
|
||||
font-size: 1.4em;
|
||||
margin-top: 1.4em;
|
||||
margin-bottom: 0.3em;
|
||||
letter-spacing: 0.05em;
|
||||
line-height: 1.25;
|
||||
break-inside: avoid;
|
||||
}}
|
||||
|
||||
p {{
|
||||
text-align: justify;
|
||||
hyphens: auto;
|
||||
}}
|
||||
|
||||
p, li, table, blockquote {{
|
||||
orphans: 2;
|
||||
widows: 2;
|
||||
}}
|
||||
|
||||
img {{
|
||||
display: block;
|
||||
margin: 2em auto;
|
||||
max-width: 100%;
|
||||
height: auto;
|
||||
}}
|
||||
|
||||
.watermark {{
|
||||
position: fixed;
|
||||
top: 35%;
|
||||
left: 0;
|
||||
width: 100%;
|
||||
text-align: center;
|
||||
opacity: 0.10;
|
||||
transform: rotate(-45deg);
|
||||
z-index: 9999;
|
||||
font-size: 12em;
|
||||
font-weight: bold;
|
||||
color: red;
|
||||
pointer-events: none;
|
||||
}}
|
||||
|
||||
table {{
|
||||
width: 100%;
|
||||
border-collapse: collapse;
|
||||
margin: 2em 0;
|
||||
font-size: 10.5pt;
|
||||
}}
|
||||
|
||||
th, td {{
|
||||
border: 1px solid #ddd;
|
||||
padding: 6px 10px;
|
||||
text-align: left;
|
||||
vertical-align: top;
|
||||
}}
|
||||
|
||||
th {{
|
||||
background-color: #f5f5f5;
|
||||
font-weight: 600;
|
||||
}}
|
||||
|
||||
blockquote {{
|
||||
background-color: #f5f5f5;
|
||||
border-left: 4px solid #bbb;
|
||||
padding: 0.8em 1.2em;
|
||||
margin: 1.2em 0;
|
||||
font-size: 0.95em;
|
||||
}}
|
||||
|
||||
blockquote.note {{
|
||||
background-color: #fff8dc;
|
||||
border-left: 4px solid #f0c040;
|
||||
}}
|
||||
|
||||
blockquote.comment {{
|
||||
background-color: #e6f0ff;
|
||||
border-left: 4px solid #6699cc;
|
||||
}}
|
||||
|
||||
.cover {{
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
height: 100vh;
|
||||
page-break-after: always;
|
||||
}}
|
||||
|
||||
.cover h1 {{
|
||||
padding-top: 4em;
|
||||
font-size: 4em;
|
||||
margin: 0;
|
||||
}}
|
||||
|
||||
.cover p {{
|
||||
font-size: 1em;
|
||||
margin-top: 2em;
|
||||
}}
|
||||
|
||||
.disclaimer {{
|
||||
margin: 2em 0;
|
||||
padding: 1.5em;
|
||||
border: 1px solid #ccc;
|
||||
background-color: #f9f9f9;
|
||||
font-size: 0.95em;
|
||||
page-break-after: always;
|
||||
}}
|
||||
|
||||
.disclaimer h2 {{
|
||||
margin-top: 0;
|
||||
font-size: 1.6em;
|
||||
}}
|
||||
|
||||
.toc {{
|
||||
page-break-after: always;
|
||||
}}
|
||||
|
||||
.toc h2 {{
|
||||
font-family: 'Helvetica Neue', Helvetica, Arial, sans-serif;
|
||||
font-size: 2em;
|
||||
margin-bottom: 1em;
|
||||
border-bottom: 1px solid #ccc;
|
||||
}}
|
||||
|
||||
.toc ul {{
|
||||
list-style: none;
|
||||
padding-left: 0;
|
||||
}}
|
||||
|
||||
.toc li {{
|
||||
margin: 0.2em 0;
|
||||
font-size: 1.05em;
|
||||
line-height: 1.6;
|
||||
}}
|
||||
|
||||
.toc li.toc-level-2 {{
|
||||
margin-left: 1.5em;
|
||||
font-size: 1em;
|
||||
}}
|
||||
|
||||
.toc li.toc-level-3 {{
|
||||
margin-left: 3em;
|
||||
font-size: 0.95em;
|
||||
}}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class='watermark'>DRAFT</div>
|
||||
<div class='cover'>
|
||||
<h1>AI Testing Guide</h1>
|
||||
<p><b>PDF Preview</b></p>
|
||||
<p>Generated on: {current_date} <br/>
|
||||
From Branch: {branch} <br/>
|
||||
From Commit: {commit}</p>
|
||||
</div>
|
||||
<div class='disclaimer'>
|
||||
<h2>Draft Disclaimer</h2>
|
||||
<p>This PDF is an automatically generated draft intended for internal review and development purposes. It is <strong>not final</strong>, <strong>not publication-ready</strong>, and may contain formatting or structural inconsistencies.</p>
|
||||
<p>Content, structure, and layout are subject to change. For questions or feedback, please refer to the project repository or connect via Slack.</p>
|
||||
</div>
|
||||
<div class='toc'>
|
||||
<h2>Table of Contents</h2>
|
||||
<ul>
|
||||
{''.join(toc_entries)}
|
||||
</ul>
|
||||
</div>
|
||||
{''.join(content_blocks)}
|
||||
</body>
|
||||
</html>
|
||||
"""
|
||||
|
||||
output_file.parent.mkdir(parents=True, exist_ok=True)
|
||||
print(f"\nGenerating PDF: {output_file}")
|
||||
HTML(string=combined_html).write_pdf(str(output_file))
|
||||
print(f"✓ PDF generated successfully")
|
||||
|
||||
if __name__ == "__main__":
|
||||
parser = argparse.ArgumentParser(
|
||||
description="Generate PDF from markdown files. Supports both directory scanning and ToC file parsing."
|
||||
)
|
||||
parser.add_argument(
|
||||
"input_path",
|
||||
type=Path,
|
||||
help="Path to ToC markdown file OR root directory containing markdown files"
|
||||
)
|
||||
parser.add_argument("output_file", type=Path, help="Path to output PDF file")
|
||||
|
||||
args = parser.parse_args()
|
||||
generate_pdf(args.input_path, args.output_file)
|
||||
Reference in New Issue
Block a user