kunsi/pretalx-plugin-broadcast-tools
1
0
Fork 0
mirror of https://github.com/Kunsi/pretalx-plugin-broadcast-tools synced 2024-11-21 20:11:01 +00:00
Code Releases Activity

Merge pull request #10 from Kunsi/kunsi-feature-pdf-export

Browse source 
add feature "export pdf page for each talk happening"
This commit is contained in:
Franzi 2022-11-07 04:13:32 +01:00 committed by GitHub
commit 31b6686279
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 365 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

324
pretalx_broadcast_tools/exporter.py Normal file
View file

@ -0,0 +1,324 @@
from tempfile import NamedTemporaryFile
from django.utils.timezone import now
from pretalx.schedule.exporters import ScheduleData
from reportlab.lib import colors
from reportlab.lib.enums import TA_CENTER
from reportlab.lib.pagesizes import A4
from reportlab.lib.styles import ParagraphStyle, StyleSheet1
from reportlab.lib.units import mm
from reportlab.platypus import (
Flowable,
PageBreak,
Paragraph,
SimpleDocTemplate,
Spacer,
Table,
TableStyle,
)
A4_WIDTH, A4_HEIGHT = A4
PAGE_PADDING = 10 * mm
class PDFInfoPage(Flowable):
def __init__(self, event, schedule, fahrplan_day, room_details, talk, style):
super().__init__()
self.event = event
self.schedule = schedule
self.day = fahrplan_day
self.room = room_details
self.talk = talk
self.style = style
self.y_position = PAGE_PADDING
@property
def _questions(self):
return {
int(i.strip())
for i in self.event.settings.broadcast_tools_pdf_questions_to_include.split(
","
)
if i
}
def _add(self, item, gap=2):
_, height = item.wrapOn(
self.canv, A4_WIDTH - 2 * PAGE_PADDING, A4_HEIGHT - 2 * PAGE_PADDING
)
self.y_position += height + gap * mm
item.drawOn(self.canv, PAGE_PADDING, -self.y_position)
def _checkbox_text(self, text, **kwargs):
item = Paragraph(text, **kwargs)
_, height = item.wrapOn(
self.canv, A4_WIDTH - 2 * PAGE_PADDING, A4_HEIGHT - 2 * PAGE_PADDING
)
self.y_position += height + 2 * mm
item.drawOn(self.canv, PAGE_PADDING + 1.3 * height, -self.y_position)
self.canv.rect(PAGE_PADDING, -self.y_position, height * 0.8, height * 0.8)
def _question_text(self, question, answer, **kwargs):
item = Paragraph(question, **kwargs)
_, height = item.wrapOn(
self.canv, A4_WIDTH - 2 * PAGE_PADDING, A4_HEIGHT - 2 * PAGE_PADDING
)
self.y_position += height + 2 * mm
item.drawOn(self.canv, PAGE_PADDING, -self.y_position)
item = Paragraph(answer, **kwargs)
_, height = item.wrapOn(
self.canv, A4_WIDTH - 3 * PAGE_PADDING, A4_HEIGHT - 2 * PAGE_PADDING
)
self.y_position += height + 2 * mm
item.drawOn(self.canv, 2 * PAGE_PADDING, -self.y_position)
def _space(self):
self._add(Spacer(1, PAGE_PADDING / 2))
def draw(self):
# add some information horizontally to the side of the page
self.canv.saveState()
self.canv.rotate(90)
self.canv.setFont("Helvetica", 12)
self.canv.drawString(
-(A4_HEIGHT - (PAGE_PADDING / 3)),
-(PAGE_PADDING / 3),
" | ".join(
[
self.talk.submission.code,
str(self.talk.submission.submission_type.name),
str(self.event.name),
self.talk.local_start.isoformat(),
f"Day {self.day['index']}",
str(self.room["name"]),
f"Schedule {self.schedule.version}",
],
),
)
self.canv.restoreState()
if self.talk.submission.do_not_record:
self._add(
Paragraph("DO NOT RECORD - DO NOT STREAM", style=self.style["Warning"]),
gap=0,
)
self._space()
self._add(
Paragraph(
" | ".join(
[
str(self.event.name),
str(self.room["name"]),
self.talk.local_start.strftime("%F %T"),
],
),
style=self.style["Meta"],
)
)
self._add(
Paragraph(self.talk.submission.title, style=self.style["Title"]), gap=0
)
self._space()
for spk in self.talk.submission.speakers.all():
self._checkbox_text(
spk.get_display_name(),
style=self.style["Speaker"],
)
self._space()
self._add(
Table(
[
(
"Duration",
"Language",
"Type",
"Code",
),
(
self.talk.export_duration,
self.talk.submission.content_locale,
self.talk.submission.submission_type.name,
self.talk.submission.code,
),
],
colWidths=30 * mm,
style=TableStyle(
[
("ALIGN", (0, 0), (-1, -1), "CENTER"),
("VALIGN", (0, 0), (-1, -1), "TOP"),
("INNERGRID", (0, 0), (-1, -1), 0.25, colors.black),
("BOX", (0, 0), (-1, -1), 0.25, colors.black),
]
),
)
)
if self.talk.submission.abstract:
self._add(
Paragraph(
self.talk.submission.abstract,
style=self.style["Abstract"],
)
)
if self.talk.submission.answers and self._questions:
self._space()
self._add(
Paragraph(
"Questions",
style=self.style["Heading"],
)
)
for answer in sorted(self.talk.submission.answers.all()):
if answer.question.id not in self._questions:
continue
self._question_text(
str(answer.question.question),
answer.answer,
style=self.style["Question"],
)
if self.talk.submission.notes:
self._space()
self._add(
Paragraph(
"Notes",
style=self.style["Heading"],
)
)
for line in self.talk.submission.notes.splitlines():
line = line.strip()
if not line:
continue
self._add(
Paragraph(
line,
style=self.style["Notes"],
)
)
if (
self.talk.submission.internal_notes
and self.event.settings.broadcast_tools_pdf_show_internal_notes
):
self._space()
self._add(
Paragraph(
"Internal Notes",
style=self.style["Heading"],
)
)
for line in self.talk.submission.internal_notes.splitlines():
line = line.strip()
if not line:
continue
self._add(
Paragraph(
line,
style=self.style["Notes"],
)
)
class PDFExporter(ScheduleData):
identifier = "broadcast_pdf"
verbose_name = "Broadcast Tools PDF"
public = False
show_qrcode = False
icon = "fa-file-pdf"
def _add_pages(self, doc):
style = self._style()
pages = []
for fahrplan_day in self.data:
for room_details in fahrplan_day["rooms"]:
for talk in room_details["talks"]:
if (
talk.submission.do_not_record
and self.event.settings.broadcast_tools_pdf_ignore_do_not_record
):
continue
pages.append(
PDFInfoPage(
self.event,
self.schedule,
fahrplan_day,
room_details,
talk,
style,
)
)
pages.append(PageBreak())
return pages
def _style(self):
stylesheet = StyleSheet1()
stylesheet.add(
ParagraphStyle(name="Normal", fontName="Helvetica", fontSize=12, leading=14)
)
stylesheet.add(
ParagraphStyle(
name="Title", fontName="Helvetica-Bold", fontSize=20, leading=24
)
)
stylesheet.add(
ParagraphStyle(
name="Speaker", fontName="Helvetica-Oblique", fontSize=12, leading=14
)
)
stylesheet.add(
ParagraphStyle(name="Meta", fontName="Helvetica", fontSize=14, leading=16)
)
stylesheet.add(
ParagraphStyle(
name="Heading", fontName="Helvetica-Bold", fontSize=14, leading=16
)
)
stylesheet.add(
ParagraphStyle(
name="Question", fontName="Helvetica", fontSize=12, leading=14
)
)
stylesheet.add(
ParagraphStyle(
name="Abstract", fontName="Helvetica-Oblique", fontSize=10, leading=12
)
)
stylesheet.add(
ParagraphStyle(name="Notes", fontName="Helvetica", fontSize=12, leading=14)
)
stylesheet.add(
ParagraphStyle(
name="Warning",
fontName="Helvetica-Bold",
fontSize=20,
leading=24,
alignment=TA_CENTER,
textColor=colors.red,
)
)
return stylesheet
def render(self, *args, **kwargs):
with NamedTemporaryFile(suffix=".pdf") as f:
doc = SimpleDocTemplate(
f.name,
pagesize=A4,
rightMargin=0,
leftMargin=0,
topMargin=0,
bottomMargin=0,
)
doc.build(self._add_pages(doc))
f.seek(0)
timestamp = now().strftime("%Y-%m-%d-%H%M")
return (
f"{self.event.slug}_broadcast_tools_{timestamp}.pdf",
"application/pdf",
f.read(),
)

25
pretalx_broadcast_tools/forms.py
View file

@ -1,3 +1,4 @@
from django.forms import BooleanField, CharField
from django.utils.translation import gettext_lazy as _
from hierarkey.forms import HierarkeyForm
from i18nfield.forms import I18nFormField, I18nFormMixin, I18nTextInput
@ -18,3 +19,27 @@ class BroadcastToolsSettingsForm(I18nFormMixin, HierarkeyForm):
required=False,
widget=I18nTextInput,
)
broadcast_tools_pdf_show_internal_notes = BooleanField(
help_text=_(
"If checked, the value of the 'internal notes' field in a "
"submission will get added to the pdf export."
),
label=_("Show internal notes in pdf export"),
required=False,
)
broadcast_tools_pdf_ignore_do_not_record = BooleanField(
help_text=_(
"If checked, 'do not record' talks will not generate a page "
"in the pdf export."
),
label=_("Ignore 'do not record' talks when generating pdf"),
required=False,
)
broadcast_tools_pdf_questions_to_include = CharField(
help_text=_(
"Comma-Separated list of question ids to include in pdf export. "
"If empty, no questions will get added."
),
label=_("Questions to include"),
required=False,
)

8
pretalx_broadcast_tools/signals.py
View file

@ -4,6 +4,7 @@ from django.utils.translation import gettext_noop
from django.utils.translation import ugettext_lazy as _
from i18nfield.strings import LazyI18nString
from pretalx.common.models.settings import hierarkey
from pretalx.common.signals import register_data_exporters
from pretalx.orga.signals import nav_event_settings
hierarkey.add_default(
@ -34,3 +35,10 @@ def navbar_info(sender, request, **kwargs):
and url.url_name == "orga",
}
]
@receiver(register_data_exporters, dispatch_uid="exporter_broadcast_pdfexporter")
def register_data_exporter(sender, **kwargs):
from .exporter import PDFExporter
return PDFExporter

8
pretalx_broadcast_tools/templates/pretalx_broadcast_tools/orga.html
View file

@ -36,6 +36,14 @@
</ul>
{% endif %}
</fieldset>
<fieldset>
<legend>
{% translate "PDF export" %}
</legend>
{% bootstrap_field form.broadcast_tools_pdf_show_internal_notes layout='event' %}
{% bootstrap_field form.broadcast_tools_pdf_ignore_do_not_record layout='event' %}
{% bootstrap_field form.broadcast_tools_pdf_questions_to_include layout='event' %}
</fieldset>
<fieldset>
<div class="submit-group panel">
<span></span>