Files
InvoiceShelf/app/Traits/GeneratesPdfTrait.php
Darko Gjorgjijoski f657b53215 refactor(services): split driver infrastructure out of Services into Support
Services/Integrations/ExchangeRate/ and Services/Pdf/ were both mostly Support-shaped: interfaces, abstract classes, static factories, concrete adapter drivers, DTOs, and exceptions — infrastructure that doesn't carry business logic. They only each had one real DI-injected service mixed in.

This commit applies the same Services=DI-business-logic / Support=stateless-plumbing rule we've been using throughout the reorg:

**Moved to Support/Integrations/ExchangeRate/** (7 files): ExchangeRateDriver (abstract), ExchangeRateDriverFactory (static), ExchangeRateException, and the four concrete drivers (CurrencyConverter, CurrencyFreak, CurrencyLayer, OpenExchangeRate). These are HTTP adapters over third-party currency APIs — same shape as the Hashids library wrapper classes already in Support.

**Moved to Support/Pdf/** (6 files, merging with existing Pdf utilities): PdfDriver (interface), PdfDriverFactory (static), PdfService (static facade), GotenbergPdfDriver, GotenbergPdfResponse (DTO), ResponseStream (interface). The Support/Pdf/ dir now contains the full PDF rendering subsystem — drivers + sanitizer + template/image utilities.

**Promoted to Services/ root** (the real DI services): ExchangeRateProviderService (CRUD for ExchangeRateProvider model) and FontService (font package install/download orchestration). Both are proper DI services — instance methods, model writes, HTTP side effects.

Services/Integrations/ and Services/Pdf/ are now empty and deleted. Services/ holds only DI-injected classes; Support/ holds all the plumbing.

17 files renamed (git detects 90-99% similarity), 4 consumer files updated (DriverRegistryProvider, PdfServiceProvider, ExchangeRateProviderController, FontController, GeneratesPdfTrait, test). 350 tests pass, Pint clean.
2026-04-11 16:30:00 +02:00

197 lines
6.9 KiB
PHP

<?php
namespace App\Traits;
use App\Models\Address;
use App\Models\CompanySetting;
use App\Models\FileDisk;
use App\Models\Setting;
use App\Services\FontService;
use App\Support\Pdf\PdfHtmlSanitizer;
use Carbon\Carbon;
use Illuminate\Support\Facades\App;
trait GeneratesPdfTrait
{
public function getGeneratedPDFOrStream($collection_name)
{
$pdf = $this->getGeneratedPDF($collection_name);
if ($pdf && file_exists($pdf['path'])) {
return response()->make(file_get_contents($pdf['path']), 200, [
'Content-Type' => 'application/pdf',
'Content-Disposition' => 'inline; filename="'.$pdf['file_name'].'"',
]);
}
$locale = CompanySetting::getSetting('language', $this->company_id);
App::setLocale($locale);
app(FontService::class)->ensureFontsForLocale($locale);
$pdf = $this->getPDFData();
return response()->make($pdf->stream(), 200, [
'Content-Type' => 'application/pdf',
'Content-Disposition' => 'inline; filename="'.$this[$collection_name.'_number'].'.pdf"',
]);
}
public function getGeneratedPDF($collection_name)
{
try {
$media = $this->getMedia($collection_name)->first();
if ($media) {
$file_disk = FileDisk::find($media->custom_properties['file_disk_id']);
if (! $file_disk) {
return false;
}
$file_disk->setConfig();
$path = null;
if ($file_disk->driver == 'local') {
$path = $media->getPath();
} else {
$path = $media->getTemporaryUrl(Carbon::now()->addMinutes(5));
}
return collect([
'path' => $path,
'file_name' => $media->file_name,
]);
}
} catch (\Exception $e) {
return false;
}
return false;
}
public function generatePDF($collection_name, $file_name, $deleteExistingFile = false)
{
$save_pdf_to_disk = Setting::getSetting('save_pdf_to_disk') ?? 'NO';
if ($save_pdf_to_disk == 'NO') {
return 0;
}
$locale = CompanySetting::getSetting('language', $this->company_id);
App::setLocale($locale);
app(FontService::class)->ensureFontsForLocale($locale);
$pdf = $this->getPDFData();
\Storage::disk('local')->put('temp/'.$collection_name.'/'.$this->id.'/temp.pdf', $pdf->output());
if ($deleteExistingFile) {
$this->clearMediaCollection($this->id);
}
$file_disk = FileDisk::whereSetAsDefault(true)->first();
if ($file_disk) {
$file_disk->setConfig();
}
$media = \Storage::disk('local')->path('temp/'.$collection_name.'/'.$this->id.'/temp.pdf');
try {
$this->addMedia($media)
->withCustomProperties(['file_disk_id' => $file_disk->id])
->usingFileName($file_name.'.pdf')
->toMediaCollection($collection_name, config('filesystems.default'));
\Storage::disk('local')->deleteDirectory('temp/'.$collection_name.'/'.$this->id);
return true;
} catch (\Exception $e) {
return $e->getMessage();
}
}
public function getFieldsArray()
{
$customer = $this->customer;
$shippingAddress = $customer->shippingAddress ?? new Address;
$billingAddress = $customer->billingAddress ?? new Address;
$companyAddress = $this->company->address ?? new Address;
$fields = [
'{SHIPPING_ADDRESS_NAME}' => $shippingAddress->name,
'{SHIPPING_COUNTRY}' => $shippingAddress->country_name,
'{SHIPPING_STATE}' => $shippingAddress->state,
'{SHIPPING_CITY}' => $shippingAddress->city,
'{SHIPPING_ADDRESS_STREET_1}' => $shippingAddress->address_street_1,
'{SHIPPING_ADDRESS_STREET_2}' => $shippingAddress->address_street_2,
'{SHIPPING_PHONE}' => $shippingAddress->phone,
'{SHIPPING_ZIP_CODE}' => $shippingAddress->zip,
'{BILLING_ADDRESS_NAME}' => $billingAddress->name,
'{BILLING_COUNTRY}' => $billingAddress->country_name,
'{BILLING_STATE}' => $billingAddress->state,
'{BILLING_CITY}' => $billingAddress->city,
'{BILLING_ADDRESS_STREET_1}' => $billingAddress->address_street_1,
'{BILLING_ADDRESS_STREET_2}' => $billingAddress->address_street_2,
'{BILLING_PHONE}' => $billingAddress->phone,
'{BILLING_ZIP_CODE}' => $billingAddress->zip,
'{COMPANY_NAME}' => $this->company->name,
'{COMPANY_COUNTRY}' => $companyAddress->country_name,
'{COMPANY_STATE}' => $companyAddress->state,
'{COMPANY_CITY}' => $companyAddress->city,
'{COMPANY_ADDRESS_STREET_1}' => $companyAddress->address_street_1,
'{COMPANY_ADDRESS_STREET_2}' => $companyAddress->address_street_2,
'{COMPANY_PHONE}' => $companyAddress->phone,
'{COMPANY_ZIP_CODE}' => $companyAddress->zip,
'{COMPANY_VAT}' => $this->company->vat_id,
'{COMPANY_TAX}' => $this->company->tax_id,
'{CONTACT_DISPLAY_NAME}' => $customer->name,
'{PRIMARY_CONTACT_NAME}' => $customer->contact_name,
'{CONTACT_EMAIL}' => $customer->email,
'{CONTACT_PHONE}' => $customer->phone,
'{CONTACT_WEBSITE}' => $customer->website,
'{CONTACT_TAX_ID}' => __('pdf_tax_id').': '.$customer->tax_id,
];
$customFields = $this->fields;
$customerCustomFields = $this->customer->fields;
foreach ($customFields as $customField) {
$fields['{'.$customField->customField->slug.'}'] = $customField->defaultAnswer;
}
foreach ($customerCustomFields as $customField) {
$fields['{'.$customField->customField->slug.'}'] = $customField->defaultAnswer;
}
foreach ($fields as $key => $field) {
$fields[$key] = htmlspecialchars($field, ENT_QUOTES, 'UTF-8');
}
return $fields;
}
public function getFormattedString($format)
{
$values = array_merge($this->getFieldsArray(), $this->getExtraFields());
$str = nl2br(strtr($format, $values));
$str = preg_replace('/{(.*?)}/', '', $str);
$str = preg_replace("/<[^\/>]*>([\s]?)*<\/[^>]*>/", '', $str);
$str = str_replace('<p>', '', $str);
$str = str_replace('</p>', '<br />', $str);
// Sanitize the assembled HTML to strip any SSRF vectors that may have
// entered through user-supplied address fields, customer names, or
// custom field values. Notes also pass through this method, so they
// get the same treatment without needing a separate wrapper.
return PdfHtmlSanitizer::sanitize($str);
}
}