Skip to content

Commit 3de6932

Browse files
committed
feat(pdfengines): apply multiple stamps and watermarks on every route
1 parent e9a6713 commit 3de6932

8 files changed

Lines changed: 299 additions & 245 deletions

File tree

‎pkg/modules/api/formdata.go‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -494,6 +494,21 @@ func (form *FormData) Stamps(target *[]string) *FormData {
494494
return form
495495
}
496496

497+
// Watermarks binds the absolute paths of every file uploaded with the
498+
// "watermark" field name, in submission order. Unlike [FormData.Watermark], it
499+
// keeps all of them so a route can apply several watermarks in a single request.
500+
func (form *FormData) Watermarks(target *[]string) *FormData {
501+
if form.errors != nil {
502+
return form
503+
}
504+
505+
if paths, ok := form.filesByField[WatermarkFormField]; ok {
506+
*target = paths
507+
}
508+
509+
return form
510+
}
511+
497512
// Strings binds every value submitted for key, in submission order. A field
498513
// repeated in the multipart body (e.g. multiple "stampSource") contributes one
499514
// entry per occurrence, which lets a route read parallel field arrays.

‎pkg/modules/api/formdata_test.go‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1880,3 +1880,18 @@ func TestFormData_Stamps(t *testing.T) {
18801880
t.Errorf("expected nil when no stamp file was uploaded, got %+v", none)
18811881
}
18821882
}
1883+
1884+
func TestFormData_Watermarks(t *testing.T) {
1885+
form := &FormData{
1886+
filesByField: map[string][]string{
1887+
WatermarkFormField: {"/tmp/abc/a.png"},
1888+
},
1889+
}
1890+
1891+
var got []string
1892+
form.Watermarks(&got)
1893+
1894+
if want := []string{"/tmp/abc/a.png"}; !reflect.DeepEqual(got, want) {
1895+
t.Errorf("expected %+v, got %+v", want, got)
1896+
}
1897+
}

‎pkg/modules/chromium/routes.go‎

Lines changed: 48 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -474,10 +474,16 @@ func convertUrlRoute(chromium Api, engine gotenberg.PdfEngine) api.Route {
474474
metadata := pdfengines.FormDataPdfMetadata(form, false)
475475
encrypt := pdfengines.FormDataPdfEncrypt(form)
476476
embedPaths := pdfengines.FormDataPdfEmbeds(form)
477-
watermark := pdfengines.FormDataPdfWatermark(form, false)
478-
watermarkFile := pdfengines.FormDataPdfWatermarkFile(form)
479-
stamp := pdfengines.FormDataPdfStamp(form, false)
480-
stampFile := pdfengines.FormDataPdfStampFile(form)
477+
watermarks, wErr := pdfengines.FormDataPdfWatermarks(form)
478+
if wErr != nil {
479+
return fmt.Errorf("form data watermarks: %w", wErr)
480+
}
481+
stamps, sErr := pdfengines.FormDataPdfStamps(form)
482+
if sErr != nil {
483+
return fmt.Errorf("form data stamps: %w", sErr)
484+
}
485+
var watermarkFiles, stampFiles []string
486+
form.Watermarks(&watermarkFiles).Stamps(&stampFiles)
481487
rotateAngle, rotatePages := pdfengines.FormDataPdfRotate(form, false)
482488
optimizeImages, imageQuality := pdfengines.FormDataPdfOptimize(form)
483489
embedsMetadata := pdfengines.FormDataPdfEmbedsMetadata(form)
@@ -496,16 +502,16 @@ func convertUrlRoute(chromium Api, engine gotenberg.PdfEngine) api.Route {
496502
return fmt.Errorf("reject URL scheme: %w", err)
497503
}
498504

499-
err = pdfengines.EnsureWatermarkFile(&watermark, watermarkFile)
505+
err = pdfengines.BindWatermarkFiles(watermarks, watermarkFiles)
500506
if err != nil {
501-
return fmt.Errorf("validate watermark: %w", err)
507+
return fmt.Errorf("bind watermark files: %w", err)
502508
}
503-
err = pdfengines.EnsureStampFile(&stamp, stampFile)
509+
err = pdfengines.BindStampFiles(stamps, stampFiles)
504510
if err != nil {
505-
return fmt.Errorf("validate stamp: %w", err)
511+
return fmt.Errorf("bind stamp files: %w", err)
506512
}
507513

508-
err = convertUrl(ctx, chromium, engine, url, options, mode, pdfFormats, metadata, encrypt, embedPaths, embedsMetadata, facturX, facturxXmlPath, watermark, stamp, rotateAngle, rotatePages, optimizeImages, imageQuality)
514+
err = convertUrl(ctx, chromium, engine, url, options, mode, pdfFormats, metadata, encrypt, embedPaths, embedsMetadata, facturX, facturxXmlPath, watermarks, stamps, rotateAngle, rotatePages, optimizeImages, imageQuality)
509515
if err != nil {
510516
return fmt.Errorf("convert URL to PDF: %w", err)
511517
}
@@ -564,10 +570,16 @@ func convertHtmlRoute(chromium Api, engine gotenberg.PdfEngine) api.Route {
564570
metadata := pdfengines.FormDataPdfMetadata(form, false)
565571
encrypt := pdfengines.FormDataPdfEncrypt(form)
566572
embedPaths := pdfengines.FormDataPdfEmbeds(form)
567-
watermark := pdfengines.FormDataPdfWatermark(form, false)
568-
watermarkFile := pdfengines.FormDataPdfWatermarkFile(form)
569-
stamp := pdfengines.FormDataPdfStamp(form, false)
570-
stampFile := pdfengines.FormDataPdfStampFile(form)
573+
watermarks, wErr := pdfengines.FormDataPdfWatermarks(form)
574+
if wErr != nil {
575+
return fmt.Errorf("form data watermarks: %w", wErr)
576+
}
577+
stamps, sErr := pdfengines.FormDataPdfStamps(form)
578+
if sErr != nil {
579+
return fmt.Errorf("form data stamps: %w", sErr)
580+
}
581+
var watermarkFiles, stampFiles []string
582+
form.Watermarks(&watermarkFiles).Stamps(&stampFiles)
571583
rotateAngle, rotatePages := pdfengines.FormDataPdfRotate(form, false)
572584
optimizeImages, imageQuality := pdfengines.FormDataPdfOptimize(form)
573585
embedsMetadata := pdfengines.FormDataPdfEmbedsMetadata(form)
@@ -581,18 +593,18 @@ func convertHtmlRoute(chromium Api, engine gotenberg.PdfEngine) api.Route {
581593
return fmt.Errorf("validate form data: %w", err)
582594
}
583595

584-
err = pdfengines.EnsureWatermarkFile(&watermark, watermarkFile)
596+
err = pdfengines.BindWatermarkFiles(watermarks, watermarkFiles)
585597
if err != nil {
586-
return fmt.Errorf("validate watermark: %w", err)
598+
return fmt.Errorf("bind watermark files: %w", err)
587599
}
588-
err = pdfengines.EnsureStampFile(&stamp, stampFile)
600+
err = pdfengines.BindStampFiles(stamps, stampFiles)
589601
if err != nil {
590-
return fmt.Errorf("validate stamp: %w", err)
602+
return fmt.Errorf("bind stamp files: %w", err)
591603
}
592604

593605
url := fmt.Sprintf("file://%s", inputPath)
594606
options.AllowedFilePrefixes = []string{ctx.DirPath()}
595-
err = convertUrl(ctx, chromium, engine, url, options, mode, pdfFormats, metadata, encrypt, embedPaths, embedsMetadata, facturX, facturxXmlPath, watermark, stamp, rotateAngle, rotatePages, optimizeImages, imageQuality)
607+
err = convertUrl(ctx, chromium, engine, url, options, mode, pdfFormats, metadata, encrypt, embedPaths, embedsMetadata, facturX, facturxXmlPath, watermarks, stamps, rotateAngle, rotatePages, optimizeImages, imageQuality)
596608
if err != nil {
597609
return fmt.Errorf("convert HTML to PDF: %w", err)
598610
}
@@ -648,10 +660,16 @@ func convertMarkdownRoute(chromium Api, engine gotenberg.PdfEngine) api.Route {
648660
metadata := pdfengines.FormDataPdfMetadata(form, false)
649661
encrypt := pdfengines.FormDataPdfEncrypt(form)
650662
embedPaths := pdfengines.FormDataPdfEmbeds(form)
651-
watermark := pdfengines.FormDataPdfWatermark(form, false)
652-
watermarkFile := pdfengines.FormDataPdfWatermarkFile(form)
653-
stamp := pdfengines.FormDataPdfStamp(form, false)
654-
stampFile := pdfengines.FormDataPdfStampFile(form)
663+
watermarks, wErr := pdfengines.FormDataPdfWatermarks(form)
664+
if wErr != nil {
665+
return fmt.Errorf("form data watermarks: %w", wErr)
666+
}
667+
stamps, sErr := pdfengines.FormDataPdfStamps(form)
668+
if sErr != nil {
669+
return fmt.Errorf("form data stamps: %w", sErr)
670+
}
671+
var watermarkFiles, stampFiles []string
672+
form.Watermarks(&watermarkFiles).Stamps(&stampFiles)
655673
rotateAngle, rotatePages := pdfengines.FormDataPdfRotate(form, false)
656674
optimizeImages, imageQuality := pdfengines.FormDataPdfOptimize(form)
657675
embedsMetadata := pdfengines.FormDataPdfEmbedsMetadata(form)
@@ -670,13 +688,13 @@ func convertMarkdownRoute(chromium Api, engine gotenberg.PdfEngine) api.Route {
670688
return fmt.Errorf("validate form data: %w", err)
671689
}
672690

673-
err = pdfengines.EnsureWatermarkFile(&watermark, watermarkFile)
691+
err = pdfengines.BindWatermarkFiles(watermarks, watermarkFiles)
674692
if err != nil {
675-
return fmt.Errorf("validate watermark: %w", err)
693+
return fmt.Errorf("bind watermark files: %w", err)
676694
}
677-
err = pdfengines.EnsureStampFile(&stamp, stampFile)
695+
err = pdfengines.BindStampFiles(stamps, stampFiles)
678696
if err != nil {
679-
return fmt.Errorf("validate stamp: %w", err)
697+
return fmt.Errorf("bind stamp files: %w", err)
680698
}
681699

682700
url, err := markdownToHtml(ctx, inputPath, markdownPaths)
@@ -685,7 +703,7 @@ func convertMarkdownRoute(chromium Api, engine gotenberg.PdfEngine) api.Route {
685703
}
686704

687705
options.AllowedFilePrefixes = []string{ctx.DirPath()}
688-
err = convertUrl(ctx, chromium, engine, url, options, mode, pdfFormats, metadata, encrypt, embedPaths, embedsMetadata, facturX, facturxXmlPath, watermark, stamp, rotateAngle, rotatePages, optimizeImages, imageQuality)
706+
err = convertUrl(ctx, chromium, engine, url, options, mode, pdfFormats, metadata, encrypt, embedPaths, embedsMetadata, facturX, facturxXmlPath, watermarks, stamps, rotateAngle, rotatePages, optimizeImages, imageQuality)
689707
if err != nil {
690708
return fmt.Errorf("convert markdown to PDF: %w", err)
691709
}
@@ -810,7 +828,7 @@ func markdownToHtml(ctx *api.Context, inputPath string, markdownPaths []string)
810828
return fmt.Sprintf("file://%s", inputPath), nil
811829
}
812830

813-
func convertUrl(ctx *api.Context, chromium Api, engine gotenberg.PdfEngine, url string, options PdfOptions, mode gotenberg.SplitMode, pdfFormats gotenberg.PdfFormats, metadata map[string]any, encrypt gotenberg.EncryptOptions, embedPaths []string, embedsMetadata map[string]map[string]string, facturX gotenberg.FacturX, facturxXmlPath string, watermark, stamp gotenberg.Stamp, rotateAngle int, rotatePages string, optimizeImages bool, imageQuality int) error {
831+
func convertUrl(ctx *api.Context, chromium Api, engine gotenberg.PdfEngine, url string, options PdfOptions, mode gotenberg.SplitMode, pdfFormats gotenberg.PdfFormats, metadata map[string]any, encrypt gotenberg.EncryptOptions, embedPaths []string, embedsMetadata map[string]map[string]string, facturX gotenberg.FacturX, facturxXmlPath string, watermarks, stamps []gotenberg.Stamp, rotateAngle int, rotatePages string, optimizeImages bool, imageQuality int) error {
814832
outputPath := ctx.GeneratePath(".pdf")
815833
// See https://github.com/gotenberg/gotenberg/issues/1130.
816834
filename := ctx.OutputFilename(outputPath)
@@ -892,12 +910,12 @@ func convertUrl(ctx *api.Context, chromium Api, engine gotenberg.PdfEngine, url
892910
return fmt.Errorf("split PDF: %w", err)
893911
}
894912

895-
err = pdfengines.WatermarkStub(ctx, engine, watermark, outputPaths)
913+
err = pdfengines.WatermarkStub(ctx, engine, watermarks, outputPaths)
896914
if err != nil {
897915
return fmt.Errorf("watermark PDFs: %w", err)
898916
}
899917

900-
err = pdfengines.StampStub(ctx, engine, stamp, outputPaths)
918+
err = pdfengines.StampStub(ctx, engine, stamps, outputPaths)
901919
if err != nil {
902920
return fmt.Errorf("stamp PDFs: %w", err)
903921
}

‎pkg/modules/libreoffice/routes.go‎

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,16 @@ func convertRoute(libreOffice libreofficeapi.Uno, engine gotenberg.PdfEngine) ap
3737
metadata := pdfengines.FormDataPdfMetadata(form, false)
3838
encrypt := pdfengines.FormDataPdfEncrypt(form)
3939
embedPaths := pdfengines.FormDataPdfEmbeds(form)
40-
watermark := pdfengines.FormDataPdfWatermark(form, false)
41-
watermarkFile := pdfengines.FormDataPdfWatermarkFile(form)
42-
stamp := pdfengines.FormDataPdfStamp(form, false)
43-
stampFile := pdfengines.FormDataPdfStampFile(form)
40+
watermarks, wErr := pdfengines.FormDataPdfWatermarks(form)
41+
if wErr != nil {
42+
return fmt.Errorf("form data watermarks: %w", wErr)
43+
}
44+
stamps, sErr := pdfengines.FormDataPdfStamps(form)
45+
if sErr != nil {
46+
return fmt.Errorf("form data stamps: %w", sErr)
47+
}
48+
var watermarkFiles, stampFiles []string
49+
form.Watermarks(&watermarkFiles).Stamps(&stampFiles)
4450
angle, rotatePages := pdfengines.FormDataPdfRotate(form, false)
4551
embedsMetadata := pdfengines.FormDataPdfEmbedsMetadata(form)
4652
facturX, facturxXmlPath := pdfengines.FormDataPdfFacturX(form)
@@ -311,13 +317,13 @@ func convertRoute(libreOffice libreofficeapi.Uno, engine gotenberg.PdfEngine) ap
311317
return fmt.Errorf("validate form data: %w", err)
312318
}
313319

314-
err = pdfengines.EnsureWatermarkFile(&watermark, watermarkFile)
320+
err = pdfengines.BindWatermarkFiles(watermarks, watermarkFiles)
315321
if err != nil {
316-
return fmt.Errorf("validate watermark: %w", err)
322+
return fmt.Errorf("bind watermark files: %w", err)
317323
}
318-
err = pdfengines.EnsureStampFile(&stamp, stampFile)
324+
err = pdfengines.BindStampFiles(stamps, stampFiles)
319325
if err != nil {
320-
return fmt.Errorf("validate stamp: %w", err)
326+
return fmt.Errorf("bind stamp files: %w", err)
321327
}
322328

323329
err = pdfengines.ValidatePdfFormatsCompat(pdfFormats, encrypt.UserPassword, embedPaths)
@@ -339,7 +345,7 @@ func convertRoute(libreOffice libreofficeapi.Uno, engine gotenberg.PdfEngine) ap
339345
// requested. The conversion runs as a post-processing step below.
340346
pdfFormats = pdfengines.FacturXPdfFormats(ctx, engine, facturX, pdfFormats, true, nil)
341347

342-
hasPostProcessing := watermark.Source != "" || stamp.Source != "" || angle != 0 ||
348+
hasPostProcessing := len(watermarks) > 0 || len(stamps) > 0 || angle != 0 ||
343349
len(embedPaths) > 0 || len(metadata) > 0 || flatten || facturX.ConformanceLevel != ""
344350

345351
outputPaths := make([]string, len(inputPaths))
@@ -494,12 +500,12 @@ func convertRoute(libreOffice libreofficeapi.Uno, engine gotenberg.PdfEngine) ap
494500
}
495501
}
496502

497-
err = pdfengines.WatermarkStub(ctx, engine, watermark, outputPaths)
503+
err = pdfengines.WatermarkStub(ctx, engine, watermarks, outputPaths)
498504
if err != nil {
499505
return fmt.Errorf("watermark PDFs: %w", err)
500506
}
501507

502-
err = pdfengines.StampStub(ctx, engine, stamp, outputPaths)
508+
err = pdfengines.StampStub(ctx, engine, stamps, outputPaths)
503509
if err != nil {
504510
return fmt.Errorf("stamp PDFs: %w", err)
505511
}

0 commit comments

Comments
 (0)