Spaces:
Running
Running
File size: 10,863 Bytes
f961a19 60212b7 f961a19 0474003 f961a19 0474003 f961a19 60212b7 f961a19 60212b7 f961a19 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 |
"""Service for saving research reports to files."""
import hashlib
import tempfile
from datetime import datetime
from pathlib import Path
from typing import Literal
import structlog
from src.utils.config import settings
from src.utils.exceptions import ConfigurationError
logger = structlog.get_logger()
class ReportFileService:
"""
Service for saving research reports to files.
Handles file creation, naming, and directory management for report outputs.
Supports saving reports in multiple formats (markdown, HTML, PDF).
"""
def __init__(
self,
output_directory: str | None = None,
enabled: bool | None = None,
file_format: Literal["md", "md_html", "md_pdf"] | None = None,
) -> None:
"""
Initialize the report file service.
Args:
output_directory: Directory to save reports. If None, uses settings or temp directory.
enabled: Whether file saving is enabled. If None, uses settings.
file_format: File format to save. If None, uses settings.
"""
self.enabled = enabled if enabled is not None else settings.save_reports_to_file
self.file_format = file_format or settings.report_file_format
self.filename_template = settings.report_filename_template
# Determine output directory
if output_directory:
self.output_directory = Path(output_directory)
elif settings.report_output_directory:
self.output_directory = Path(settings.report_output_directory)
else:
# Use system temp directory
self.output_directory = Path(tempfile.gettempdir()) / "deepcritical_reports"
# Create output directory if it doesn't exist
if self.enabled:
try:
self.output_directory.mkdir(parents=True, exist_ok=True)
logger.debug(
"Report output directory initialized",
path=str(self.output_directory),
enabled=self.enabled,
)
except Exception as e:
logger.error(
"Failed to create report output directory",
error=str(e),
path=str(self.output_directory),
)
raise ConfigurationError(f"Failed to create report output directory: {e}") from e
def _generate_filename(self, query: str | None = None, extension: str = ".md") -> str:
"""
Generate filename for report using template.
Args:
query: Optional query string for hash generation
extension: File extension (e.g., ".md", ".html")
Returns:
Generated filename
"""
# Generate timestamp
timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
# Generate query hash if query provided
query_hash = ""
if query:
query_hash = hashlib.md5(query.encode()).hexdigest()[:8]
# Generate date
date = datetime.now().strftime("%Y-%m-%d")
# Replace template placeholders
filename = self.filename_template
filename = filename.replace("{timestamp}", timestamp)
filename = filename.replace("{query_hash}", query_hash)
filename = filename.replace("{date}", date)
# Ensure correct extension
if not filename.endswith(extension):
# Remove existing extension if present
if "." in filename:
filename = filename.rsplit(".", 1)[0]
filename += extension
return filename
def save_report(
self,
report_content: str,
query: str | None = None,
filename: str | None = None,
) -> str:
"""
Save a report to a file.
Args:
report_content: The report content (markdown string)
query: Optional query string for filename generation
filename: Optional custom filename. If None, generates from template.
Returns:
Path to saved file
Raises:
ConfigurationError: If file saving is disabled or fails
"""
if not self.enabled:
logger.debug("File saving disabled, skipping")
raise ConfigurationError("Report file saving is disabled")
if not report_content or not report_content.strip():
raise ValueError("Report content cannot be empty")
# Generate filename if not provided
if not filename:
filename = self._generate_filename(query=query, extension=".md")
# Ensure filename is safe
filename = self._sanitize_filename(filename)
# Build full file path
file_path = self.output_directory / filename
try:
# Write file
with open(file_path, "w", encoding="utf-8") as f:
f.write(report_content)
logger.info(
"Report saved to file",
path=str(file_path),
size=len(report_content),
query=query[:50] if query else None,
)
return str(file_path)
except Exception as e:
logger.error("Failed to save report to file", error=str(e), path=str(file_path))
raise ConfigurationError(f"Failed to save report to file: {e}") from e
def save_report_multiple_formats(
self,
report_content: str,
query: str | None = None,
) -> dict[str, str]:
"""
Save a report in multiple formats.
Args:
report_content: The report content (markdown string)
query: Optional query string for filename generation
Returns:
Dictionary mapping format to file path (e.g., {"md": "/path/to/report.md"})
Raises:
ConfigurationError: If file saving is disabled or fails
"""
if not self.enabled:
logger.debug("File saving disabled, skipping")
raise ConfigurationError("Report file saving is disabled")
saved_files: dict[str, str] = {}
# Always save markdown
md_path = self.save_report(report_content, query=query, filename=None)
saved_files["md"] = md_path
# Save additional formats based on file_format setting
if self.file_format == "md_html":
# TODO: Implement HTML conversion
logger.warning("HTML format not yet implemented, saving markdown only")
elif self.file_format == "md_pdf":
# Generate PDF from markdown
try:
pdf_path = self._save_pdf(report_content, query=query)
saved_files["pdf"] = pdf_path
logger.info("PDF report generated", pdf_path=pdf_path)
except Exception as e:
logger.warning(
"PDF generation failed, markdown saved",
error=str(e),
md_path=md_path,
)
# Continue without PDF - markdown is already saved
return saved_files
def _save_pdf(
self,
report_content: str,
query: str | None = None,
) -> str:
"""
Save report as PDF.
Args:
report_content: The report content (markdown string)
query: Optional query string for filename generation
Returns:
Path to saved PDF file
Raises:
ConfigurationError: If PDF generation fails
"""
try:
from src.utils.md_to_pdf import md_to_pdf
except ImportError as e:
raise ConfigurationError(
"PDF generation requires md2pdf. Install with: pip install md2pdf"
) from e
# Generate PDF filename
pdf_filename = self._generate_filename(query=query, extension=".pdf")
pdf_filename = self._sanitize_filename(pdf_filename)
pdf_path = self.output_directory / pdf_filename
try:
# Convert markdown to PDF
md_to_pdf(report_content, str(pdf_path))
logger.info(
"PDF report saved",
path=str(pdf_path),
size=pdf_path.stat().st_size if pdf_path.exists() else 0,
query=query[:50] if query else None,
)
return str(pdf_path)
except Exception as e:
logger.error("Failed to generate PDF", error=str(e), path=str(pdf_path))
raise ConfigurationError(f"Failed to generate PDF: {e}") from e
def _sanitize_filename(self, filename: str) -> str:
"""
Sanitize filename to remove unsafe characters.
Args:
filename: Original filename
Returns:
Sanitized filename
"""
# Remove or replace unsafe characters
unsafe_chars = '<>:"/\\|?*'
sanitized = filename
for char in unsafe_chars:
sanitized = sanitized.replace(char, "_")
# Limit length
if len(sanitized) > 200:
name, ext = sanitized.rsplit(".", 1) if "." in sanitized else (sanitized, "")
sanitized = name[:190] + ext
return sanitized
def cleanup_old_files(self, max_age_days: int = 7) -> int:
"""
Clean up old report files.
Args:
max_age_days: Maximum age in days for files to keep
Returns:
Number of files deleted
"""
if not self.output_directory.exists():
return 0
deleted_count = 0
cutoff_time = datetime.now().timestamp() - (max_age_days * 24 * 60 * 60)
try:
for file_path in self.output_directory.iterdir():
if file_path.is_file() and file_path.stat().st_mtime < cutoff_time:
try:
file_path.unlink()
deleted_count += 1
except Exception as e:
logger.warning(
"Failed to delete old file", path=str(file_path), error=str(e)
)
if deleted_count > 0:
logger.info(
"Cleaned up old report files", deleted=deleted_count, max_age_days=max_age_days
)
except Exception as e:
logger.error("Failed to cleanup old files", error=str(e))
return deleted_count
def get_report_file_service() -> ReportFileService:
"""
Get or create a ReportFileService instance (singleton pattern).
Returns:
ReportFileService instance
"""
# Use lru_cache for singleton pattern
from functools import lru_cache
@lru_cache(maxsize=1)
def _get_service() -> ReportFileService:
return ReportFileService()
return _get_service()
|