pp-planer/app/Services/ProExportService.php
Thorsten Bus 4e548bbeed feat(export): honor per-service arrangement
ProPresenter export ignored service_songs.song_arrangement_id and
always used the default/is_default arrangement. Now the chosen
arrangement is pre-selected while ALL arrangements stay in the file,
so users can still switch in ProPresenter.

Import-stable, by NAME (avoids the fragile playlist arrangement UUID
that breaks on import):
- .pro: set selected_arrangement (protobuf field 10) to the chosen
  arrangement via Song::setSelectedArrangementUuid(getArrangementByName).
- .proplaylist: set the presentation item arrangement_name (field 5).

buildGroups now emits the UNION of sections across all arrangements
(selected first, in play order, with first/last-slide macro anchoring;
other arrangements' sections appended without position macros) so every
arrangement's group-name refs resolve instead of being silently dropped.

No parser package changes; installed public API only. Library/no-service
context keeps default-arrangement behaviour unchanged.
2026-07-05 23:16:59 +02:00

277 lines
9.2 KiB
PHP

<?php
namespace App\Services;
use App\Models\Service;
use App\Models\Song;
use App\Models\SongArrangement;
use ProPresenter\Parser\ProFileGenerator;
use ProPresenter\Parser\ProFileWriter;
class ProExportService
{
public function __construct(
private readonly MacroResolutionService $macroResolutionService,
private readonly ServiceImageResolver $imageResolver,
) {}
public function generateProFile(Song $song, ?Service $service = null, ?SongArrangement $selected = null): string
{
$tempPath = sys_get_temp_dir().'/'.uniqid('pro-export-').'.pro';
$parserSong = $this->generateParserSong($song, $service, $selected);
ProFileWriter::write($parserSong, $tempPath);
return $tempPath;
}
public function generateParserSong(Song $song, ?Service $service = null, ?SongArrangement $selected = null): \ProPresenter\Parser\Song
{
$song->loadMissing(['arrangements.arrangementSections.section.slides', 'arrangements.arrangementSections.section.label']);
$parserSong = ProFileGenerator::generate(
$song->title,
$this->buildGroups($song, $service, $selected),
$this->buildArrangements($song),
$this->buildCcliMetadata($song),
);
// Pre-select the chosen arrangement (protobuf field 10) by name so the export honours the
// per-service selection while keeping ALL arrangements available in the .pro file.
$chosen = $this->chosenArrangement($song, $selected);
if ($chosen !== null) {
$arrangement = $parserSong->getArrangementByName($chosen->name);
if ($arrangement !== null) {
$parserSong->setSelectedArrangementUuid($arrangement->getUuid());
}
}
return $parserSong;
}
private function buildGroups(Song $song, ?Service $service = null, ?SongArrangement $selected = null): array
{
$selectedArr = $this->chosenArrangement($song, $selected);
if ($selectedArr === null) {
return [];
}
$background = $this->backgroundData($service);
// Ordered, de-duplicated sections of the SELECTED arrangement (its play order).
$selectedSections = $this->uniqueSectionsFor($selectedArr);
$selectedSectionIds = array_map(static fn ($section) => $section->id, $selectedSections);
// Total slide count across the selected arrangement's play order so that 'first_slide'
// and 'last_slide' macros anchor to the selected arrangement's very first/last slide.
$totalSlidesInSong = 0;
foreach ($selectedSections as $section) {
$totalSlidesInSong += $section->slides->count();
}
$groups = [];
$globalSlideIndex = 0;
// 1) Emit the selected arrangement's sections first, with position-aware macros.
foreach ($selectedSections as $section) {
$label = $section->label;
$slides = [];
foreach ($section->slides->sortBy('order')->values() as $slide) {
$slideData = $this->baseSlideData($slide, $background);
if ($service !== null) {
$macros = $this->macroResolutionService->macrosForSlide(
$service,
'song',
['index' => $globalSlideIndex, 'total' => $totalSlidesInSong, 'label_id' => $label->id],
);
if (! empty($macros)) {
// ProPresenter parser currently supports one `macro` entry per slide; keep the first resolved macro until stacked macros are supported.
$slideData['macro'] = $macros[0];
}
}
$slides[] = $slideData;
$globalSlideIndex++;
}
$groups[] = [
'name' => $label->name,
'color' => ProImportService::hexToRgba($label->color ?? '#808080'),
'slides' => $slides,
];
}
// 2) Append sections referenced by OTHER arrangements so every arrangement's group-name refs
// resolve in the parser (unknown group names are silently dropped otherwise). These sections
// are not part of the selected play order → no position-based macros, no slide-index advance.
foreach ($this->appendedSections($song, $selectedSectionIds) as $section) {
$slides = [];
foreach ($section->slides->sortBy('order')->values() as $slide) {
$slides[] = $this->baseSlideData($slide, $background);
}
$groups[] = [
'name' => $section->label->name,
'color' => ProImportService::hexToRgba($section->label->color ?? '#808080'),
'slides' => $slides,
];
}
return $groups;
}
/**
* Resolve the chosen arrangement: explicit selection → default (is_default) → first.
*/
private function chosenArrangement(Song $song, ?SongArrangement $selected): ?SongArrangement
{
return $selected
?? $song->arrangements->firstWhere('is_default', true)
?? $song->arrangements->first();
}
/**
* Ordered, de-duplicated valid sections (section + label present) of a single arrangement.
*
* @return array<int, \App\Models\SongSection>
*/
private function uniqueSectionsFor(SongArrangement $arrangement): array
{
$arrangement->loadMissing('arrangementSections.section.slides', 'arrangementSections.section.label');
$sections = [];
$seen = [];
foreach ($arrangement->arrangementSections->sortBy('order') as $arrangementSection) {
$section = $arrangementSection->section;
if ($section === null || $section->label === null) {
continue;
}
if (in_array($section->id, $seen, true)) {
continue;
}
$seen[] = $section->id;
$sections[] = $section;
}
return $sections;
}
/**
* Sections used by any arrangement but NOT already emitted for the selected arrangement.
* Stable order: arrangements in song order, sections in each arrangement's play order.
*
* @param array<int, int> $excludeSectionIds
* @return array<int, \App\Models\SongSection>
*/
private function appendedSections(Song $song, array $excludeSectionIds): array
{
$sections = [];
$seen = $excludeSectionIds;
foreach ($song->arrangements as $arrangement) {
foreach ($this->uniqueSectionsFor($arrangement) as $section) {
if (in_array($section->id, $seen, true)) {
continue;
}
$seen[] = $section->id;
$sections[] = $section;
}
}
return $sections;
}
/**
* Base slideData shared by selected and appended sections: text, optional translation, optional background.
*/
private function baseSlideData(object $slide, ?array $background): array
{
$slideData = ['text' => $slide->text_content ?? ''];
if ($slide->text_content_translated) {
$slideData['translation'] = $slide->text_content_translated;
}
if ($background !== null && ! $this->isFullCoverImageSlide($slide, $slideData)) {
$slideData['background'] = $background;
}
return $slideData;
}
private function backgroundData(?Service $service): ?array
{
if ($service === null) {
return null;
}
$background = $this->imageResolver->backgroundFor($service);
if ($background === null) {
return null;
}
return [
'path' => ServiceImageResolver::BACKGROUND_EXPORT_NAME,
'format' => 'JPG',
'width' => 1920,
'height' => 1080,
'bundleRelative' => true,
];
}
private function isFullCoverImageSlide(object $slide, array $slideData): bool
{
if (! isset($slideData['media'])) {
return false;
}
return ($slide->cover_mode ?? null) === true;
}
private function buildArrangements(Song $song): array
{
$arrangements = [];
foreach ($song->arrangements as $arrangement) {
$arrangement->loadMissing('arrangementSections.section.label');
$groupNames = $arrangement->arrangementSections
->sortBy('order')
->map(fn ($arrangementSection) => $arrangementSection->section?->label?->name)
->filter()
->values()
->toArray();
$arrangements[] = [
'name' => $arrangement->name,
'groupNames' => $groupNames,
];
}
return $arrangements;
}
private function buildCcliMetadata(Song $song): array
{
return array_filter([
'author' => $song->author,
'song_title' => $song->title,
'copyright_year' => $song->copyright_year,
'publisher' => $song->publisher,
'song_number' => $song->ccli_id ? (int) $song->ccli_id : null,
]);
}
}