"""
crate_anon/crateweb/extra/pdf.py
===============================================================================
Copyright (C) 2015, University of Cambridge, Department of Psychiatry.
Created by Rudolf Cardinal (rnc1001@cam.ac.uk).
This file is part of CRATE.
CRATE is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
CRATE is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with CRATE. If not, see <https://www.gnu.org/licenses/>.
===============================================================================
**Assistance functions for working with PDFs.**
"""
import logging
from typing import Any, Dict, Optional, TYPE_CHECKING
from cardinal_pythonlib.dicts import merge_two_dicts
from cardinal_pythonlib.django.serve import serve_buffer
from cardinal_pythonlib.pdf import (
get_pdf_from_html,
make_pdf_on_disk_from_html,
PdfPlan,
)
from django.conf import settings
from django.http import HttpResponse
from django.template.loader import render_to_string
if TYPE_CHECKING:
from crate_anon.crateweb.consent.constants import EthicsInfo
log = logging.getLogger(__name__)
# =============================================================================
# CratePdfPlan
# =============================================================================
[docs]class CratePdfPlan(PdfPlan):
"""
Specializes :class:`cardinal_pythonlib.pdf.PdfPlan` for our default
header/footer.
"""
[docs] def __init__(self, *args, ethics_doccode: str = None, **kwargs) -> None:
if "header_html" not in kwargs:
kwargs["header_html"] = get_pdf_header_html()
if "footer_html" not in kwargs:
kwargs["footer_html"] = get_pdf_footer_html(
ethics_doccode=ethics_doccode
)
if "wkhtmltopdf_filename" not in kwargs: # added 2018-06-28
kwargs["wkhtmltopdf_filename"] = settings.WKHTMLTOPDF_FILENAME
if "wkhtmltopdf_options" not in kwargs: # added 2018-06-28
kwargs["wkhtmltopdf_options"] = settings.WKHTMLTOPDF_OPTIONS
super().__init__(*args, **kwargs)
# =============================================================================
# Create PDFs from HTML
# =============================================================================
[docs]def get_pdf_from_html_with_django_settings(
html: str,
header_html: str = None,
footer_html: str = None,
wkhtmltopdf_filename: str = None,
wkhtmltopdf_options: Dict[str, Any] = None,
debug_content: bool = False,
debug_options: bool = False,
fix_pdfkit_encoding_bug: bool = None,
) -> bytes:
"""
Applies our ``settings.WKHTMLTOPDF_OPTIONS`` and then makes a PDF from the
supplied HTML.
See the arguments to :func:`cardinal_pythonlib.pdf.make_pdf_from_html`.
Returns:
a binary PDF
"""
# Customized for this Django site
wkhtmltopdf_filename = (
wkhtmltopdf_filename or settings.WKHTMLTOPDF_FILENAME
)
if wkhtmltopdf_options is None:
wkhtmltopdf_options = settings.WKHTMLTOPDF_OPTIONS.copy()
else:
wkhtmltopdf_options = merge_two_dicts(
settings.WKHTMLTOPDF_OPTIONS, wkhtmltopdf_options
)
# log.debug(f"{wkhtmltopdf_options!r}")
return get_pdf_from_html(
html=html,
header_html=header_html,
footer_html=footer_html,
wkhtmltopdf_filename=wkhtmltopdf_filename,
wkhtmltopdf_options=wkhtmltopdf_options,
debug_content=debug_content,
debug_options=debug_options,
fix_pdfkit_encoding_bug=fix_pdfkit_encoding_bug,
)
[docs]def make_pdf_on_disk_from_html_with_django_settings(
html: str,
header_html: str = None,
footer_html: str = None,
wkhtmltopdf_filename: str = None,
wkhtmltopdf_options: Dict[str, Any] = None,
output_path: str = None,
debug_content: bool = False,
debug_options: bool = False,
fix_pdfkit_encoding_bug: bool = None,
) -> bool:
"""
Applies our ``settings.WKHTMLTOPDF_OPTIONS`` and then makes a PDF from the
supplied ``html`` and stores it in the file named by ``output_path``.
See the arguments to :func:`cardinal_pythonlib.pdf.make_pdf_from_html`.
Returns:
success?
"""
# Customized for this Django site
wkhtmltopdf_filename = (
wkhtmltopdf_filename or settings.WKHTMLTOPDF_FILENAME
)
if wkhtmltopdf_options is None:
wkhtmltopdf_options = settings.WKHTMLTOPDF_OPTIONS.copy()
else:
wkhtmltopdf_options = merge_two_dicts(
settings.WKHTMLTOPDF_OPTIONS, wkhtmltopdf_options
)
return make_pdf_on_disk_from_html(
html=html,
output_path=output_path,
header_html=header_html,
footer_html=footer_html,
wkhtmltopdf_filename=wkhtmltopdf_filename,
wkhtmltopdf_options=wkhtmltopdf_options,
debug_content=debug_content,
debug_options=debug_options,
fix_pdfkit_encoding_bug=fix_pdfkit_encoding_bug,
)
# =============================================================================
# Serve PDFs from HTML
# =============================================================================
[docs]def serve_pdf_from_html(
html: str, offered_filename: str = "test.pdf", **kwargs
) -> HttpResponse:
"""
Converts HTML into a PDF and serves it.
Args:
html: HTML to make into a PDF and serve
offered_filename: filename from the user's perspective
**kwargs: passed to :func:`get_pdf_from_html_with_django_settings`
"""
pdf = get_pdf_from_html_with_django_settings(html, **kwargs)
return serve_buffer(
pdf,
offered_filename=offered_filename,
content_type="application/pdf",
as_attachment=False,
as_inline=True,
)
[docs]def serve_html_or_pdf(
html: str, viewtype: str, ethics_doccode: str = None
) -> HttpResponse:
"""
Serves some HTML as HTML or after converting it to a PDF in our letter
style. For development.
Args:
html: contents
viewtype: ``"pdf"`` or ``"html"``
ethics_doccode: ethics document code
"""
if viewtype == "pdf":
return serve_pdf_from_html(
html,
header_html=get_pdf_header_html(),
footer_html=get_pdf_footer_html(ethics_doccode=ethics_doccode),
)
elif viewtype == "html":
return HttpResponse(html)
else:
raise ValueError("Bad viewtype")