Open-source event management and ticket selling platform — perfect for concerts, conferences, and everything in between 🎟️ If you find this project helpful, please consider giving us a star ⭐️
PHP attendize-alternativedoor-managementevent-check-inevent-managementevent-registrationevent-ticketingeventbrite-alternativeeventslaravelopen-sourcephpreactself-hostedsell-ticketssell-tickets-onlineticket-sellingticketing-systemtickettailor-alternativetito-alternative
Fix: Render Chinese and Japanese characters on invoice PDFs (#1383)
Dave Earley722eb2dfc809
diff --git a/backend/app/Mail/Order/OrderSummary.php b/backend/app/Mail/Order/OrderSummary.phpindex 5d2bc6910..83b4fcaa2 100644--- a/backend/app/Mail/Order/OrderSummary.php+++ b/backend/app/Mail/Order/OrderSummary.php@@ -2,7 +2,6 @@namespace HiEvents\Mail\Order;-use Barryvdh\DomPDF\Facade\Pdf;use HiEvents\DomainObjects\EventDomainObject;use HiEvents\DomainObjects\EventOccurrenceDomainObject;use HiEvents\DomainObjects\EventSettingDomainObject;@@ -12,6 +11,7 @@ use HiEvents\DomainObjects\OrganizerDomainObject;use HiEvents\Helper\Url;use HiEvents\Mail\BaseMail;use HiEvents\Services\Domain\Email\DTO\RenderedEmailTemplateDTO;+use HiEvents\Services\Domain\Order\InvoicePdfRenderer;use Illuminate\Mail\Mailables\Attachment;use Illuminate\Mail\Mailables\Content;use Illuminate\Mail\Mailables\Envelope;@@ -84,13 +84,13 @@ class OrderSummary extends BaseMailreturn [];}- $invoice = Pdf::loadView('invoice', [- 'order' => $this->order,- 'event' => $this->event,- 'organizer' => $this->organizer,- 'eventSettings' => $this->eventSettings,- 'invoice' => $this->invoice,- ]);+ $invoice = app(InvoicePdfRenderer::class)->render(+ order: $this->order,+ event: $this->event,+ organizer: $this->organizer,+ eventSettings: $this->eventSettings,+ invoice: $this->invoice,+ );return [Attachment::fromData(diff --git a/backend/app/Services/Domain/Order/GenerateOrderInvoicePDFService.php b/backend/app/Services/Domain/Order/GenerateOrderInvoicePDFService.phpindex 27e706c20..011c3fbd9 100644--- a/backend/app/Services/Domain/Order/GenerateOrderInvoicePDFService.php+++ b/backend/app/Services/Domain/Order/GenerateOrderInvoicePDFService.php@@ -2,7 +2,6 @@namespace HiEvents\Services\Domain\Order;-use Barryvdh\DomPDF\Facade\Pdf;use HiEvents\DomainObjects\EventDomainObject;use HiEvents\DomainObjects\EventSettingDomainObject;use HiEvents\DomainObjects\OrganizerDomainObject;@@ -17,6 +16,7 @@ class GenerateOrderInvoicePDFServicepublic function __construct(private readonly OrderRepositoryInterface $orderRepository,private readonly InvoiceRepositoryInterface $invoiceRepository,+ private readonly InvoicePdfRenderer $invoicePdfRenderer,) {}public function generatePdfFromOrderShortId(string $orderShortId, int $eventId): InvoicePdfResponseDTO@@ -55,13 +55,13 @@ class GenerateOrderInvoicePDFService}return new InvoicePdfResponseDTO(- pdf: Pdf::loadView('invoice', [- 'order' => $order,- 'event' => $order->getEvent(),- 'organizer' => $order->getEvent()->getOrganizer(),- 'eventSettings' => $order->getEvent()->getEventSettings(),- 'invoice' => $invoice,- ]),+ pdf: $this->invoicePdfRenderer->render(+ order: $order,+ event: $order->getEvent(),+ organizer: $order->getEvent()->getOrganizer(),+ eventSettings: $order->getEvent()->getEventSettings(),+ invoice: $invoice,+ ),filename: $invoice->getInvoiceNumber().'.pdf');}diff --git a/backend/app/Services/Domain/Order/InvoicePdfRenderer.php b/backend/app/Services/Domain/Order/InvoicePdfRenderer.phpnew file mode 100644index 000000000..3f9707206--- /dev/null+++ b/backend/app/Services/Domain/Order/InvoicePdfRenderer.php@@ -0,0 +1,62 @@+<?php++namespace HiEvents\Services\Domain\Order;++use Barryvdh\DomPDF\Facade\Pdf;+use Barryvdh\DomPDF\PDF as DomPdf;+use HiEvents\DomainObjects\EventDomainObject;+use HiEvents\DomainObjects\EventSettingDomainObject;+use HiEvents\DomainObjects\InvoiceDomainObject;+use HiEvents\DomainObjects\OrderDomainObject;+use HiEvents\DomainObjects\OrganizerDomainObject;+use Psr\Log\LoggerInterface;++class InvoicePdfRenderer+{+ public function __construct(+ private readonly LoggerInterface $logger,+ ) {}++ public function render(+ OrderDomainObject $order,+ EventDomainObject $event,+ OrganizerDomainObject $organizer,+ EventSettingDomainObject $eventSettings,+ InvoiceDomainObject $invoice,+ ): DomPdf {+ return Pdf::loadView('invoice', [+ 'order' => $order,+ 'event' => $event,+ 'organizer' => $organizer,+ 'eventSettings' => $eventSettings,+ 'invoice' => $invoice,+ 'embedCjkFont' => $this->fontCacheIsWritable(),+ ])->setOption('isFontSubsettingEnabled', true);+ }++ private function fontCacheIsWritable(): bool+ {+ foreach (array_unique([config('dompdf.options.font_dir'), config('dompdf.options.font_cache')]) as $directory) {+ if (! is_dir($directory) && ! @mkdir($directory, 0755, true) && ! is_dir($directory)) {+ $this->logFontCacheUnavailable($directory);++ return false;+ }++ if (! is_writable($directory)) {+ $this->logFontCacheUnavailable($directory);++ return false;+ }+ }++ return true;+ }++ private function logFontCacheUnavailable(string $directory): void+ {+ $this->logger->warning('Invoice PDF font cache directory is not writable, rendering invoice without the CJK font', [+ 'directory' => $directory,+ ]);+ }+}diff --git a/backend/resources/fonts/NotoSansSC-Bold.ttf b/backend/resources/fonts/NotoSansSC-Bold.ttfnew file mode 100644index 000000000..1e56ab5fdBinary files /dev/null and b/backend/resources/fonts/NotoSansSC-Bold.ttf differdiff --git a/backend/resources/fonts/NotoSansSC-OFL.txt b/backend/resources/fonts/NotoSansSC-OFL.txtnew file mode 100644index 000000000..1c9f43281--- /dev/null+++ b/backend/resources/fonts/NotoSansSC-OFL.txt@@ -0,0 +1,93 @@+Copyright 2014-2021 Adobe (http://www.adobe.com/), with Reserved Font Name 'Source'++This Font Software is licensed under the SIL Open Font License, Version 1.1.+This license is copied below, and is also available with a FAQ at:+https://scripts.sil.org/OFL+++-----------------------------------------------------------+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007+-----------------------------------------------------------++PREAMBLE+The goals of the Open Font License (OFL) are to stimulate worldwide+development of collaborative font projects, to support the font creation+efforts of academic and linguistic communities, and to provide a free and+open framework in which fonts may be shared and improved in partnership+with others.++The OFL allows the licensed fonts to be used, studied, modified and+redistributed freely as long as they are not sold by themselves. The+fonts, including any derivative works, can be bundled, embedded,+redistributed and/or sold with any software provided that any reserved+names are not used by derivative works. The fonts and derivatives,+however, cannot be released under any other type of license. The+requirement for fonts to remain under this license does not apply+to any document created using the fonts or their derivatives.++DEFINITIONS+"Font Software" refers to the set of files released by the Copyright+Holder(s) under this license and clearly marked as such. This may+include source files, build scripts and documentation.++"Reserved Font Name" refers to any names specified as such after the+copyright statement(s).++"Original Version" refers to the collection of Font Software components as+distributed by the Copyright Holder(s).++"Modified Version" refers to any derivative made by adding to, deleting,+or substituting -- in part or in whole -- any of the components of the+Original Version, by changing formats or by porting the Font Software to a+new environment.++"Author" refers to any designer, engineer, programmer, technical+writer or other person who contributed to the Font Software.++PERMISSION & CONDITIONS+Permission is hereby granted, free of charge, to any person obtaining+a copy of the Font Software, to use, study, copy, merge, embed, modify,+redistribute, and sell modified and unmodified copies of the Font+Software, subject to the following conditions:++1) Neither the Font Software nor any of its individual components,+in Original or Modified Versions, may be sold by itself.++2) Original or Modified Versions of the Font Software may be bundled,+redistributed and/or sold with any software, provided that each copy+contains the above copyright notice and this license. These can be+included either as stand-alone text files, human-readable headers or+in the appropriate machine-readable metadata fields within text or+binary files as long as those fields can be easily viewed by the user.++3) No Modified Version of the Font Software may use the Reserved Font+Name(s) unless explicit written permission is granted by the corresponding+Copyright Holder. This restriction only applies to the primary font name as+presented to the users.++4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font+Software shall not be used to promote, endorse or advertise any+Modified Version, except to acknowledge the contribution(s) of the+Copyright Holder(s) and the Author(s) or with their explicit written+permission.++5) The Font Software, modified or unmodified, in part or in whole,+must be distributed entirely under this license, and must not be+distributed under any other license. The requirement for fonts to+remain under this license does not apply to any document created+using the Font Software.++TERMINATION+This license becomes null and void if any of the above conditions are+not met.++DISCLAIMER+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM+OTHER DEALINGS IN THE FONT SOFTWARE.diff --git a/backend/resources/fonts/NotoSansSC-Regular.ttf b/backend/resources/fonts/NotoSansSC-Regular.ttfnew file mode 100644index 000000000..f94e068aeBinary files /dev/null and b/backend/resources/fonts/NotoSansSC-Regular.ttf differdiff --git a/backend/resources/views/invoice.blade.php b/backend/resources/views/invoice.blade.phpindex 9db23e899..c4521cf69 100644--- a/backend/resources/views/invoice.blade.php+++ b/backend/resources/views/invoice.blade.php@@ -17,6 +17,22 @@<meta name="viewport" content="width=device-width, initial-scale=1.0"><title>{{ $eventSettings->getInvoiceLabel() ?? __('Invoice') }} #{{ $invoice->getInvoiceNumber() }}</title><style>+ @if($embedCjkFont)+ @font-face {+ font-family: 'Noto Sans SC';+ src: url('{{ resource_path('fonts/NotoSansSC-Regular.ttf') }}') format('truetype');+ font-weight: normal;+ font-style: normal;+ }++ @font-face {+ font-family: 'Noto Sans SC';+ src: url('{{ resource_path('fonts/NotoSansSC-Bold.ttf') }}') format('truetype');+ font-weight: bold;+ font-style: normal;+ }+ @endif+* {margin: 0;padding: 0;@@ -24,7 +40,7 @@}body {- font-family: 'DejaVu Sans', Arial, sans-serif;+ font-family: 'DejaVu Sans', 'Noto Sans SC', sans-serif;font-size: 12px;line-height: 1.5;color: #1a1a1a;@@ -41,7 +57,7 @@}.logo-title {- font-family: 'DejaVu Sans', Arial, sans-serif;+ font-family: 'DejaVu Sans', 'Noto Sans SC', sans-serif;font-size: 28px;font-weight: 700;color: #1a1a1a;@@ -50,7 +66,7 @@}.header-event-name {- font-family: 'DejaVu Sans', Arial, sans-serif;+ font-family: 'DejaVu Sans', 'Noto Sans SC', sans-serif;font-size: 12px;color: #666;margin: 0;@@ -72,7 +88,7 @@padding: 4px 14px;margin-top: 6px;border-radius: 4px;- font-family: 'DejaVu Sans', Arial, sans-serif;+ font-family: 'DejaVu Sans', 'Noto Sans SC', sans-serif;font-size: 11px;font-weight: bold;letter-spacing: 0.5px;@@ -110,7 +126,7 @@}.info-label {- font-family: 'DejaVu Sans', Arial, sans-serif;+ font-family: 'DejaVu Sans', 'Noto Sans SC', sans-serif;color: #888;font-size: 10px;font-weight: bold;@@ -121,9 +137,9 @@}.info-value {- font-family: 'DejaVu Sans', Arial, sans-serif;+ font-family: 'DejaVu Sans', 'Noto Sans SC', sans-serif;font-size: 13px;- font-weight: 500;+ font-weight: bold;}.billing-section {diff --git a/backend/storage/fonts/.gitignore b/backend/storage/fonts/.gitignorenew file mode 100644index 000000000..d6b7ef32c--- /dev/null+++ b/backend/storage/fonts/.gitignore@@ -0,0 +1,2 @@+*+!.gitignorediff --git a/backend/tests/Feature/Services/Domain/Order/InvoicePdfRendererTest.php b/backend/tests/Feature/Services/Domain/Order/InvoicePdfRendererTest.phpnew file mode 100644index 000000000..bafa7405d--- /dev/null+++ b/backend/tests/Feature/Services/Domain/Order/InvoicePdfRendererTest.php@@ -0,0 +1,116 @@+<?php++declare(strict_types=1);++namespace Tests\Feature\Services\Domain\Order;++use HiEvents\DomainObjects\EventDomainObject;+use HiEvents\DomainObjects\EventSettingDomainObject;+use HiEvents\DomainObjects\InvoiceDomainObject;+use HiEvents\DomainObjects\OrderDomainObject;+use HiEvents\DomainObjects\OrganizerDomainObject;+use HiEvents\DomainObjects\Status\InvoiceStatus;+use HiEvents\Services\Domain\Order\InvoicePdfRenderer;+use Mockery;+use Psr\Log\LoggerInterface;+use Tests\TestCase;++class InvoicePdfRendererTest extends TestCase+{+ public function test_chinese_text_is_rendered_with_an_embedded_cjk_font_subset(): void+ {+ $output = $this->renderInvoice(+ fullName: ['张', '伟'],+ eventTitle: '2026 上海国际音乐节',+ invoiceNumber: '发票-0001',+ itemName: '普通门票',+ address: ['address_line_1' => '北京市朝阳区建国路88号', 'city' => '北京', 'country' => 'CN'],+ );++ $this->assertStringContainsString('+NotoSansSC-Regular', $output);+ $this->assertStringContainsString('+NotoSansSC-Bold', $output);+ $this->assertStringNotContainsString('/BaseFont /Times', $output);+ $this->assertLessThan(200_000, strlen($output));+ }++ public function test_latin_only_invoice_does_not_embed_the_cjk_font(): void+ {+ $output = $this->renderInvoice(+ fullName: ['Jane', 'Doe'],+ eventTitle: 'Summer Festival',+ invoiceNumber: 'INV-0001',+ itemName: 'General Admission',+ address: ['address_line_1' => '1 Main Street', 'city' => 'Dublin', 'country' => 'IE'],+ );++ $this->assertStringContainsString('+DejaVuSans', $output);+ $this->assertStringNotContainsString('NotoSansSC', $output);+ $this->assertStringNotContainsString('/BaseFont /Times', $output);+ }++ public function test_invoice_still_renders_without_the_cjk_font_when_the_font_cache_is_not_writable(): void+ {+ $logger = Mockery::spy(LoggerInterface::class);+ $this->app->instance(LoggerInterface::class, $logger);+ $blockingFile = tempnam(sys_get_temp_dir(), 'font-cache');+ $viewData = [];+ $this->app['view']->composer('invoice', function ($view) use (&$viewData) {+ $viewData = $view->getData();+ });+ config([+ 'dompdf.options.font_dir' => $blockingFile.'/fonts',+ 'dompdf.options.font_cache' => $blockingFile.'/fonts',+ ]);++ try {+ $output = $this->renderInvoice(+ fullName: ['张', '伟'],+ eventTitle: 'Summer Festival',+ invoiceNumber: 'INV-0001',+ itemName: 'General Admission',+ address: [],+ );+ } finally {+ unlink($blockingFile);+ }++ $this->assertStringStartsWith('%PDF-', $output);+ $this->assertFalse($viewData['embedCjkFont']);+ $logger->shouldHaveReceived('warning')->once();+ }++ private function renderInvoice(array $fullName, string $eventTitle, string $invoiceNumber, string $itemName, array $address): string+ {+ $order = (new OrderDomainObject)+ ->setFirstName($fullName[0])+ ->setLastName($fullName[1])+ ->setEmail('[email protected]')+ ->setCurrency('USD')+ ->setTotalBeforeAdditions(25)+ ->setTotalGross(25)+ ->setTotalTax(0)+ ->setTotalFee(0)+ ->setAddress($address);++ $invoice = (new InvoiceDomainObject)+ ->setInvoiceNumber($invoiceNumber)+ ->setIssueDate('2026-10-11 00:00:00')+ ->setStatus(InvoiceStatus::PAID->name)+ ->setItems([[+ 'item_name' => $itemName,+ 'description' => null,+ 'price' => 25,+ 'price_before_discount' => null,+ 'quantity' => 1,+ 'total_before_additions' => 25,+ ]]);++ return app(InvoicePdfRenderer::class)->render(+ order: $order,+ event: (new EventDomainObject)->setTitle($eventTitle),+ organizer: (new OrganizerDomainObject)->setName('Organizer'),+ eventSettings: (new EventSettingDomainObject)->setOrganizationName('Organizer'),+ invoice: $invoice,+ )->output();+ }+}