Files
InvoiceShelf/app/Traits/GeneratesPdfTrait.php
Darko Gjorgjijoski 6d1816bd1b refactor: reorganize app/Services and app/Support by domain
The app/Services/ directory had grown into 22 flat files at the root plus 7 uneven subdirectories — finding anything required scrolling through an alphabetical mix of small CRUD services, infrastructure drivers, and install-time utilities. This commit groups services by domain, folds Backup into a new Storage namespace, and moves framework-infrastructure and install-time helpers out of Services and into Support where they belong.

New Services layout: Documents/ (Invoice, Estimate, RecurringInvoice, Payment, Expense, Transaction, DocumentItem, SerialNumber, Currency — matches the 'Documents' navigation group); Company/ (Company, Member, Invitation); Mail/ (MailConfiguration, CompanyMailConfig); Storage/ (FileDisk, plus Backup folded in). ExchangeRateProviderService moves next to its drivers in ExchangeRate/; FontService moves into Pdf/ where it belongs. CustomerService, ItemService, CustomFieldService stay at the Services root as standalone single-file domains.

Moves to Support/: Hashids/ (library wrapper — not business logic); Setup/ (one-shot install-time utilities — stateless helpers); Pdf/ (ImageUtils, PdfTemplateUtils, plus the existing PdfHtmlSanitizer consolidated into the same subdir). These are all framework infrastructure and stateless utilities — the 'service' label never really fit them.

Namespace declarations in 29 moved files updated to match new paths. 62 consumer files (controllers, other services, tests, database factories, seeders, routes, bootstrap/providers.php) have their use statements rewritten via a literal-string replacement script — no regex meant no risk of half-matching. Three Documents services needed an explicit 'use App\Services\Mail\CompanyMailConfigService' added because the same-namespace short reference they relied on no longer resolves after the split.

Verified: composer dump-autoload, 350 tests pass (850 assertions), vendor/bin/pint clean, npm run build succeeds.
2026-04-11 10:00: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\Pdf\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);
}
}