refactor(pdfengines): embeds => attachments

pkg/modules/pdfengines/pdfengines.go

@@ -28,18 +28,16 @@ func init() {
 // the [api.Router] interface to expose relevant PDF processing routes if
 // enabled.
 type PdfEngines struct {
-	mergeNames          []string
-	splitNames          []string
-	flattenNames        []string
-	convertNames        []string
-	readMetadataNames   []string
-	writeMetadataNames  []string
-	encryptNames        []string
-	embedNames          []string
-	readBookmarksNames  []string
-	writeBookmarksNames []string
-	engines             []gotenberg.PdfEngine
-	disableRoutes       bool
+	mergeNames         []string
+	splitNames         []string
+	flattenNames       []string
+	convertNames       []string
+	readMetadataNames  []string
+	writeMetadataNames []string
+	encryptNames       []string
+	attachmentsNames   []string
+	engines            []gotenberg.PdfEngine
+	disableRoutes      bool
 }
 
 // Descriptor returns a PdfEngines' module descriptor.
@@ -54,19 +52,10 @@ func (mod *PdfEngines) Descriptor() gotenberg.ModuleDescriptor {
 			fs.StringSlice("pdfengines-convert-engines", []string{"libreoffice-pdfengine"}, "Set the PDF engines and their order for the convert feature - empty means all")
 			fs.StringSlice("pdfengines-read-metadata-engines", []string{"exiftool"}, "Set the PDF engines and their order for the read metadata feature - empty means all")
 			fs.StringSlice("pdfengines-write-metadata-engines", []string{"exiftool"}, "Set the PDF engines and their order for the write metadata feature - empty means all")
-			fs.StringSlice("pdfengines-encrypt-engines", []string{"qpdf", "pdftk", "pdfcpu"}, "Set the PDF engines and their order for the password protection feature - empty means all")
-			fs.StringSlice("pdfengines-embed-engines", []string{"pdfcpu"}, "Set the PDF engines and their order for the file embedding feature - empty means all")
-			fs.StringSlice("pdfengines-read-bookmarks-engines", []string{"pdfcpu"}, "Set the PDF engines and their order for the read bookmarks feature - empty means all")
-			fs.StringSlice("pdfengines-write-bookmarks-engines", []string{"pdfcpu"}, "Set the PDF engines and their order for the write bookmarks feature - empty means all")
+			fs.StringSlice("pdfengines-encrypt-engines", []string{"qpdf", "pdfcpu", "pdftk"}, "Set the PDF engines and their order for the password protection feature - empty means all")
+			fs.StringSlice("pdfengines-add-attachments-engines", []string{"pdfcpu"}, "Set the PDF engines and their order for the file attaching feature - empty means all")
 			fs.Bool("pdfengines-disable-routes", false, "Disable the routes")
 
-			// Deprecated flags.
-			fs.StringSlice("pdfengines-engines", make([]string, 0), "Set the default PDF engines and their default order - all by default")
-			err := fs.MarkDeprecated("pdfengines-engines", "use other flags for a more granular selection of PDF engines per method")
-			if err != nil {
-				panic(err)
-			}
-
 			return fs
 		}(),
 		New: func() gotenberg.Module { return new(PdfEngines) },
@@ -84,9 +73,7 @@ func (mod *PdfEngines) Provision(ctx *gotenberg.Context) error {
 	readMetadataNames := flags.MustStringSlice("pdfengines-read-metadata-engines")
 	writeMetadataNames := flags.MustStringSlice("pdfengines-write-metadata-engines")
 	encryptNames := flags.MustStringSlice("pdfengines-encrypt-engines")
-	embedNames := flags.MustStringSlice("pdfengines-embed-engines")
-	readBookmarksNames := flags.MustStringSlice("pdfengines-read-bookmarks-engines")
-	writeBookmarksNames := flags.MustStringSlice("pdfengines-write-bookmarks-engines")
+	attachmentsNames := flags.MustStringSlice("pdfengines-add-attachments-engines")
 	mod.disableRoutes = flags.MustBool("pdfengines-disable-routes")
 
 	engines, err := ctx.Modules(new(gotenberg.PdfEngine))
@@ -108,7 +95,7 @@ func (mod *PdfEngines) Provision(ctx *gotenberg.Context) error {
 	// Example in the case of deprecated module name.
 	//for i, name := range defaultNames {
 	//	if name == "unoconv-pdfengine" || name == "uno-pdfengine" {
-	//		logger.Warn(fmt.Sprintf("%s is deprecated; prefer libreoffice-pdfengine instead", name))
+	//		logger.WarnContext(ctx, fmt.Sprintf("%s is deprecated; prefer libreoffice-pdfengine instead", name))
 	//		mod.defaultNames[i] = "libreoffice-pdfengine"
 	//	}
 	//}
@@ -148,19 +135,9 @@ func (mod *PdfEngines) Provision(ctx *gotenberg.Context) error {
 		mod.encryptNames = encryptNames
 	}
 
-	mod.embedNames = defaultNames
-	if len(embedNames) > 0 {
-		mod.embedNames = embedNames
-	}
-
-	mod.readBookmarksNames = defaultNames
-	if len(readBookmarksNames) > 0 {
-		mod.readBookmarksNames = readBookmarksNames
-	}
-
-	mod.writeBookmarksNames = defaultNames
-	if len(writeBookmarksNames) > 0 {
-		mod.writeBookmarksNames = writeBookmarksNames
+	mod.attachmentsNames = defaultNames
+	if len(attachmentsNames) > 0 {
+		mod.attachmentsNames = attachmentsNames
 	}
 
 	return nil
@@ -211,9 +188,7 @@ func (mod *PdfEngines) Validate() error {
 	findNonExistingEngines(mod.readMetadataNames)
 	findNonExistingEngines(mod.writeMetadataNames)
 	findNonExistingEngines(mod.encryptNames)
-	findNonExistingEngines(mod.embedNames)
-	findNonExistingEngines(mod.readBookmarksNames)
-	findNonExistingEngines(mod.writeBookmarksNames)
+	findNonExistingEngines(mod.attachmentsNames)
 
 	if len(nonExistingEngines) == 0 {
 		return nil
@@ -233,9 +208,6 @@ func (mod *PdfEngines) SystemMessages() []string {
 		fmt.Sprintf("read metadata engines - %s", strings.Join(mod.readMetadataNames[:], " ")),
 		fmt.Sprintf("write metadata engines - %s", strings.Join(mod.writeMetadataNames[:], " ")),
 		fmt.Sprintf("encrypt engines - %s", strings.Join(mod.encryptNames[:], " ")),
-		fmt.Sprintf("embed engines - %s", strings.Join(mod.embedNames[:], " ")),
-		fmt.Sprintf("read bookmarks engines - %s", strings.Join(mod.readBookmarksNames[:], " ")),
-		fmt.Sprintf("write bookmarks engines - %s", strings.Join(mod.writeBookmarksNames[:], " ")),
 	}
 }
 
@@ -263,9 +235,7 @@ func (mod *PdfEngines) PdfEngine() (gotenberg.PdfEngine, error) {
 		engines(mod.readMetadataNames),
 		engines(mod.writeMetadataNames),
 		engines(mod.encryptNames),
-		engines(mod.embedNames),
-		engines(mod.readBookmarksNames),
-		engines(mod.writeBookmarksNames),
+		engines(mod.attachmentsNames),
 	), nil
 }
 
@@ -289,10 +259,8 @@ func (mod *PdfEngines) Routes() ([]api.Route, error) {
 		convertRoute(engine),
 		readMetadataRoute(engine),
 		writeMetadataRoute(engine),
-		readBookmarksRoute(engine),
-		writeBookmarksRoute(engine),
 		encryptRoute(engine),
-		embedRoute(engine),
+		attachmentsRoute(engine),
 	}, nil
 }