mirror of
https://github.com/gotenberg/gotenberg.git
synced 2026-08-18 05:02:15 +01:00
feat(libreoffice): add many more options for conversions
This commit is contained in:
@@ -41,44 +41,129 @@ type Api struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Options gathers available options when converting a document to PDF.
|
// Options gathers available options when converting a document to PDF.
|
||||||
|
// See: https://help.libreoffice.org/latest/en-US/text/shared/guide/pdf_params.html.
|
||||||
type Options struct {
|
type Options struct {
|
||||||
// Landscape allows to change the orientation of the resulting PDF.
|
// Landscape allows to change the orientation of the resulting PDF.
|
||||||
// Optional.
|
|
||||||
Landscape bool
|
Landscape bool
|
||||||
|
|
||||||
// PageRanges allows to select the pages to convert.
|
// PageRanges allows to select the pages to convert.
|
||||||
// Optional.
|
|
||||||
PageRanges string
|
PageRanges string
|
||||||
|
|
||||||
// ExportFormFields allows to... export form fields in the resulting PDF.
|
// ExportFormFields specifies whether form fields are exported as widgets
|
||||||
// Optional.
|
// or only their fixed print representation is exported.
|
||||||
ExportFormFields bool
|
ExportFormFields bool
|
||||||
|
|
||||||
// SinglePageSheets allows to output each sheet as a single page in the
|
// AllowDuplicateFieldNames specifies whether multiple form fields exported
|
||||||
// resulting PDF.
|
// are allowed to have the same field name.
|
||||||
// Optional
|
AllowDuplicateFieldNames bool
|
||||||
SinglePageSheets bool
|
|
||||||
|
|
||||||
// ExportNotesInMargin allows to export comments in margin.
|
// ExportBookmarks specifies if bookmarks are exported to PDF.
|
||||||
// Optional
|
ExportBookmarks bool
|
||||||
|
|
||||||
|
// ExportBookmarksToPdfDestination specifies that the bookmarks contained
|
||||||
|
// in the source LibreOffice file should be exported to the PDF file as
|
||||||
|
// Named Destination.
|
||||||
|
ExportBookmarksToPdfDestination bool
|
||||||
|
|
||||||
|
// ExportPlaceholders exports the placeholders fields visual markings only.
|
||||||
|
// The exported placeholder is ineffective.
|
||||||
|
ExportPlaceholders bool
|
||||||
|
|
||||||
|
// ExportNotes specifies if notes are exported to PDF.
|
||||||
|
ExportNotes bool
|
||||||
|
|
||||||
|
// ExportNotesPages specifies if notes pages are exported to PDF.
|
||||||
|
// Notes pages are available in Impress documents only.
|
||||||
|
ExportNotesPages bool
|
||||||
|
|
||||||
|
// ExportOnlyNotesPages specifies, if the property ExportNotesPages is set
|
||||||
|
// to true, if only notes pages are exported to PDF.
|
||||||
|
ExportOnlyNotesPages bool
|
||||||
|
|
||||||
|
// ExportNotesInMargin specifies if notes in margin are exported to PDF.
|
||||||
ExportNotesInMargin bool
|
ExportNotesInMargin bool
|
||||||
|
|
||||||
// LosslessImageCompression allows turning lossless compression on or off
|
// ConvertOooTargetToPdfTarget specifies that the target documents with
|
||||||
// to tweak image conversion performance.
|
// .od[tpgs] extension, will have that extension changed to .pdf when the
|
||||||
// Optional
|
// link is exported to PDF. The source document remains untouched.
|
||||||
|
ConvertOooTargetToPdfTarget bool
|
||||||
|
|
||||||
|
// ExportLinksRelativeFsys specifies that the file system related
|
||||||
|
// hyperlinks (file:// protocol) present in the document will be exported
|
||||||
|
// as relative to the source document location.
|
||||||
|
ExportLinksRelativeFsys bool
|
||||||
|
|
||||||
|
// ExportHiddenSlides exports, for LibreOffice Impress, slides that are not
|
||||||
|
// included in slide shows.
|
||||||
|
ExportHiddenSlides bool
|
||||||
|
|
||||||
|
// SkipEmptyPages specifies that automatically inserted empty pages are
|
||||||
|
// suppressed. This option is active only if storing Writer documents.
|
||||||
|
SkipEmptyPages bool
|
||||||
|
|
||||||
|
// AddOriginalDocumentAsStream specifies that a stream is inserted to the
|
||||||
|
// PDF file which contains the original document for archiving purposes.
|
||||||
|
AddOriginalDocumentAsStream bool
|
||||||
|
|
||||||
|
// SinglePageSheets ignores each sheet’s paper size, print ranges and
|
||||||
|
// shown/hidden status and puts every sheet (even hidden sheets) on exactly
|
||||||
|
// one page.
|
||||||
|
SinglePageSheets bool
|
||||||
|
|
||||||
|
// LosslessImageCompression specifies if images are exported to PDF using
|
||||||
|
// a lossless compression format like PNG or compressed using the JPEG
|
||||||
|
// format.
|
||||||
LosslessImageCompression bool
|
LosslessImageCompression bool
|
||||||
|
|
||||||
// ReduceImageResolution allows turning on or off image resolution
|
// Quality specifies the quality of the JPG export. A higher value produces
|
||||||
// reduction to tweak image conversion performance.
|
// a higher-quality image and a larger file. Between 1 and 90.
|
||||||
// Optional
|
Quality int
|
||||||
|
|
||||||
|
// ReduceImageResolution specifies if the resolution of each image is
|
||||||
|
// reduced to the resolution specified by the property MaxImageResolution.
|
||||||
ReduceImageResolution bool
|
ReduceImageResolution bool
|
||||||
|
|
||||||
|
// MaxImageResolution, if the property ReduceImageResolution is set to
|
||||||
|
// true, tells if all images will be reduced to the given value in DPI.
|
||||||
|
// Possible values are: 75, 150, 300, 600 and 1200.
|
||||||
|
MaxImageResolution int
|
||||||
|
|
||||||
// PdfFormats allows to convert the resulting PDF to PDF/A-1b, PDF/A-2b,
|
// PdfFormats allows to convert the resulting PDF to PDF/A-1b, PDF/A-2b,
|
||||||
// PDF/A-3b and PDF/UA.
|
// PDF/A-3b and PDF/UA.
|
||||||
// Optional.
|
|
||||||
PdfFormats gotenberg.PdfFormats
|
PdfFormats gotenberg.PdfFormats
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// DefaultOptions returns the default values for Options.
|
||||||
|
func DefaultOptions() Options {
|
||||||
|
return Options{
|
||||||
|
Landscape: false,
|
||||||
|
PageRanges: "",
|
||||||
|
ExportFormFields: true,
|
||||||
|
AllowDuplicateFieldNames: false,
|
||||||
|
ExportBookmarks: true,
|
||||||
|
ExportBookmarksToPdfDestination: false,
|
||||||
|
ExportPlaceholders: false,
|
||||||
|
ExportNotes: false,
|
||||||
|
ExportNotesPages: false,
|
||||||
|
ExportOnlyNotesPages: false,
|
||||||
|
ExportNotesInMargin: false,
|
||||||
|
ConvertOooTargetToPdfTarget: false,
|
||||||
|
ExportLinksRelativeFsys: false,
|
||||||
|
ExportHiddenSlides: false,
|
||||||
|
SkipEmptyPages: false,
|
||||||
|
AddOriginalDocumentAsStream: false,
|
||||||
|
SinglePageSheets: false,
|
||||||
|
LosslessImageCompression: false,
|
||||||
|
Quality: 90,
|
||||||
|
ReduceImageResolution: false,
|
||||||
|
MaxImageResolution: 300,
|
||||||
|
PdfFormats: gotenberg.PdfFormats{
|
||||||
|
PdfA: "",
|
||||||
|
PdfUa: false,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// Uno is an abstraction on top of the Universal Network Objects API.
|
// Uno is an abstraction on top of the Universal Network Objects API.
|
||||||
type Uno interface {
|
type Uno interface {
|
||||||
Pdf(ctx context.Context, logger *zap.Logger, inputPath, outputPath string, options Options) error
|
Pdf(ctx context.Context, logger *zap.Logger, inputPath, outputPath string, options Options) error
|
||||||
|
|||||||
@@ -14,6 +14,15 @@ import (
|
|||||||
"github.com/gotenberg/gotenberg/v8/pkg/gotenberg"
|
"github.com/gotenberg/gotenberg/v8/pkg/gotenberg"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
func TestDefaultOptions(t *testing.T) {
|
||||||
|
actual := DefaultOptions()
|
||||||
|
notExpect := Options{}
|
||||||
|
|
||||||
|
if reflect.DeepEqual(actual, notExpect) {
|
||||||
|
t.Errorf("expected %v and got identical %v", actual, notExpect)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
func TestApi_Descriptor(t *testing.T) {
|
func TestApi_Descriptor(t *testing.T) {
|
||||||
descriptor := new(Api).Descriptor()
|
descriptor := new(Api).Descriptor()
|
||||||
|
|
||||||
|
|||||||
@@ -273,25 +273,26 @@ func (p *libreOfficeProcess) pdf(ctx context.Context, logger *zap.Logger, inputP
|
|||||||
args = append(args, "--export", fmt.Sprintf("PageRange=%s", options.PageRanges))
|
args = append(args, "--export", fmt.Sprintf("PageRange=%s", options.PageRanges))
|
||||||
}
|
}
|
||||||
|
|
||||||
if !options.ExportFormFields {
|
args = append(args, "--export", fmt.Sprintf("ExportFormFields=%t", options.ExportFormFields))
|
||||||
args = append(args, "--export", "ExportFormFields=false")
|
args = append(args, "--export", fmt.Sprintf("AllowDuplicateFieldNames=%t", options.AllowDuplicateFieldNames))
|
||||||
}
|
args = append(args, "--export", fmt.Sprintf("ExportBookmarks=%t", options.ExportBookmarks))
|
||||||
|
args = append(args, "--export", fmt.Sprintf("ExportBookmarks=%t", options.ExportBookmarks))
|
||||||
if options.SinglePageSheets {
|
args = append(args, "--export", fmt.Sprintf("ExportBookmarksToPDFDestination=%t", options.ExportBookmarksToPdfDestination))
|
||||||
args = append(args, "--export", "SinglePageSheets=true")
|
args = append(args, "--export", fmt.Sprintf("ExportPlaceholders=%t", options.ExportPlaceholders))
|
||||||
}
|
args = append(args, "--export", fmt.Sprintf("ExportNotes=%t", options.ExportNotes))
|
||||||
|
args = append(args, "--export", fmt.Sprintf("ExportNotesPages=%t", options.ExportNotesPages))
|
||||||
if options.ExportNotesInMargin {
|
args = append(args, "--export", fmt.Sprintf("ExportOnlyNotesPages=%t", options.ExportOnlyNotesPages))
|
||||||
args = append(args, "--export", "ExportNotesInMargin=true")
|
args = append(args, "--export", fmt.Sprintf("ExportNotesInMargin=%t", options.ExportNotesInMargin))
|
||||||
}
|
args = append(args, "--export", fmt.Sprintf("ConvertOOoTargetToPDFTarget=%t", options.ConvertOooTargetToPdfTarget))
|
||||||
|
args = append(args, "--export", fmt.Sprintf("ExportLinksRelativeFsys=%t", options.ExportLinksRelativeFsys))
|
||||||
if options.LosslessImageCompression {
|
args = append(args, "--export", fmt.Sprintf("ExportHiddenSlides=%t", options.ExportHiddenSlides))
|
||||||
args = append(args, "--export", "UseLosslessCompression=true")
|
args = append(args, "--export", fmt.Sprintf("IsSkipEmptyPages=%t", options.SkipEmptyPages))
|
||||||
}
|
args = append(args, "--export", fmt.Sprintf("IsAddStream=%t", options.AddOriginalDocumentAsStream))
|
||||||
|
args = append(args, "--export", fmt.Sprintf("SinglePageSheets=%t", options.SinglePageSheets))
|
||||||
if !options.ReduceImageResolution {
|
args = append(args, "--export", fmt.Sprintf("UseLosslessCompression=%t", options.LosslessImageCompression))
|
||||||
args = append(args, "--export", "ReduceImageResolution=false")
|
args = append(args, "--export", fmt.Sprintf("Quality=%d", options.Quality))
|
||||||
}
|
args = append(args, "--export", fmt.Sprintf("ReduceImageResolution=%t", options.ReduceImageResolution))
|
||||||
|
args = append(args, "--export", fmt.Sprintf("MaxImageResolution=%d", options.MaxImageResolution))
|
||||||
|
|
||||||
switch options.PdfFormats.PdfA {
|
switch options.PdfFormats.PdfA {
|
||||||
case "":
|
case "":
|
||||||
|
|||||||
@@ -336,7 +336,7 @@ func TestLibreOfficeProcess_pdf(t *testing.T) {
|
|||||||
expectError: false,
|
expectError: false,
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
scenario: "success (landscape)",
|
scenario: "success (not default options)",
|
||||||
libreOffice: newLibreOfficeProcess(
|
libreOffice: newLibreOfficeProcess(
|
||||||
libreOfficeArguments{
|
libreOfficeArguments{
|
||||||
binPath: os.Getenv("LIBREOFFICE_BIN_PATH"),
|
binPath: os.Getenv("LIBREOFFICE_BIN_PATH"),
|
||||||
@@ -352,188 +352,36 @@ func TestLibreOfficeProcess_pdf(t *testing.T) {
|
|||||||
t.Fatalf(fmt.Sprintf("expected no error but got: %v", err))
|
t.Fatalf(fmt.Sprintf("expected no error but got: %v", err))
|
||||||
}
|
}
|
||||||
|
|
||||||
err = os.WriteFile(fmt.Sprintf("%s/document.txt", fs.WorkingDirPath()), []byte("Landscape"), 0o755)
|
err = os.WriteFile(fmt.Sprintf("%s/document.txt", fs.WorkingDirPath()), []byte("Success"), 0o755)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("expected no error but got: %v", err)
|
t.Fatalf("expected no error but got: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
return fs
|
return fs
|
||||||
}(),
|
}(),
|
||||||
options: Options{Landscape: true},
|
options: Options{
|
||||||
cancelledCtx: false,
|
Landscape: true,
|
||||||
start: true,
|
PageRanges: "1",
|
||||||
expectError: false,
|
ExportFormFields: false,
|
||||||
},
|
AllowDuplicateFieldNames: true,
|
||||||
{
|
ExportBookmarks: false,
|
||||||
scenario: "success (disable form fields)",
|
ExportBookmarksToPdfDestination: true,
|
||||||
libreOffice: newLibreOfficeProcess(
|
ExportPlaceholders: true,
|
||||||
libreOfficeArguments{
|
ExportNotes: true,
|
||||||
binPath: os.Getenv("LIBREOFFICE_BIN_PATH"),
|
ExportNotesPages: true,
|
||||||
unoBinPath: os.Getenv("UNOCONVERTER_BIN_PATH"),
|
ExportOnlyNotesPages: true,
|
||||||
startTimeout: 5 * time.Second,
|
ExportNotesInMargin: true,
|
||||||
},
|
ConvertOooTargetToPdfTarget: true,
|
||||||
),
|
ExportLinksRelativeFsys: true,
|
||||||
fs: func() *gotenberg.FileSystem {
|
ExportHiddenSlides: true,
|
||||||
fs := gotenberg.NewFileSystem()
|
SkipEmptyPages: true,
|
||||||
|
AddOriginalDocumentAsStream: true,
|
||||||
err := os.MkdirAll(fs.WorkingDirPath(), 0o755)
|
SinglePageSheets: true,
|
||||||
if err != nil {
|
LosslessImageCompression: true,
|
||||||
t.Fatalf(fmt.Sprintf("expected no error but got: %v", err))
|
Quality: 100,
|
||||||
}
|
ReduceImageResolution: true,
|
||||||
|
MaxImageResolution: 600,
|
||||||
err = os.WriteFile(fmt.Sprintf("%s/document.txt", fs.WorkingDirPath()), []byte("DisableFormFields"), 0o755)
|
},
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected no error but got: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return fs
|
|
||||||
}(),
|
|
||||||
options: Options{ExportFormFields: false},
|
|
||||||
cancelledCtx: false,
|
|
||||||
start: true,
|
|
||||||
expectError: false,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
scenario: "success (single page sheets)",
|
|
||||||
libreOffice: newLibreOfficeProcess(
|
|
||||||
libreOfficeArguments{
|
|
||||||
binPath: os.Getenv("LIBREOFFICE_BIN_PATH"),
|
|
||||||
unoBinPath: os.Getenv("UNOCONVERTER_BIN_PATH"),
|
|
||||||
startTimeout: 5 * time.Second,
|
|
||||||
},
|
|
||||||
),
|
|
||||||
fs: func() *gotenberg.FileSystem {
|
|
||||||
fs := gotenberg.NewFileSystem()
|
|
||||||
|
|
||||||
err := os.MkdirAll(fs.WorkingDirPath(), 0o755)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf(fmt.Sprintf("expected no error but got: %v", err))
|
|
||||||
}
|
|
||||||
|
|
||||||
err = os.WriteFile(fmt.Sprintf("%s/document.txt", fs.WorkingDirPath()), []byte("SinglePageSheets"), 0o755)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected no error but got: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return fs
|
|
||||||
}(),
|
|
||||||
options: Options{SinglePageSheets: true},
|
|
||||||
cancelledCtx: false,
|
|
||||||
start: true,
|
|
||||||
expectError: false,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
scenario: "success (page ranges)",
|
|
||||||
libreOffice: newLibreOfficeProcess(
|
|
||||||
libreOfficeArguments{
|
|
||||||
binPath: os.Getenv("LIBREOFFICE_BIN_PATH"),
|
|
||||||
unoBinPath: os.Getenv("UNOCONVERTER_BIN_PATH"),
|
|
||||||
startTimeout: 5 * time.Second,
|
|
||||||
},
|
|
||||||
),
|
|
||||||
fs: func() *gotenberg.FileSystem {
|
|
||||||
fs := gotenberg.NewFileSystem()
|
|
||||||
|
|
||||||
err := os.MkdirAll(fs.WorkingDirPath(), 0o755)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf(fmt.Sprintf("expected no error but got: %v", err))
|
|
||||||
}
|
|
||||||
|
|
||||||
err = os.WriteFile(fmt.Sprintf("%s/document.txt", fs.WorkingDirPath()), []byte("Landscape"), 0o755)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected no error but got: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return fs
|
|
||||||
}(),
|
|
||||||
options: Options{PageRanges: "1-1"},
|
|
||||||
cancelledCtx: false,
|
|
||||||
start: true,
|
|
||||||
expectError: false,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
scenario: "success ExportNotesInMargin",
|
|
||||||
libreOffice: newLibreOfficeProcess(
|
|
||||||
libreOfficeArguments{
|
|
||||||
binPath: os.Getenv("LIBREOFFICE_BIN_PATH"),
|
|
||||||
unoBinPath: os.Getenv("UNOCONVERTER_BIN_PATH"),
|
|
||||||
startTimeout: 5 * time.Second,
|
|
||||||
},
|
|
||||||
),
|
|
||||||
fs: func() *gotenberg.FileSystem {
|
|
||||||
fs := gotenberg.NewFileSystem()
|
|
||||||
|
|
||||||
err := os.MkdirAll(fs.WorkingDirPath(), 0o755)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf(fmt.Sprintf("expected no error but got: %v", err))
|
|
||||||
}
|
|
||||||
|
|
||||||
err = os.WriteFile(fmt.Sprintf("%s/document.txt", fs.WorkingDirPath()), []byte("ExportNotesInMargin"), 0o755)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected no error but got: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return fs
|
|
||||||
}(),
|
|
||||||
options: Options{ExportNotesInMargin: true},
|
|
||||||
cancelledCtx: false,
|
|
||||||
start: true,
|
|
||||||
expectError: false,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
scenario: "success LosslessImageCompression",
|
|
||||||
libreOffice: newLibreOfficeProcess(
|
|
||||||
libreOfficeArguments{
|
|
||||||
binPath: os.Getenv("LIBREOFFICE_BIN_PATH"),
|
|
||||||
unoBinPath: os.Getenv("UNOCONVERTER_BIN_PATH"),
|
|
||||||
startTimeout: 5 * time.Second,
|
|
||||||
},
|
|
||||||
),
|
|
||||||
fs: func() *gotenberg.FileSystem {
|
|
||||||
fs := gotenberg.NewFileSystem()
|
|
||||||
|
|
||||||
err := os.MkdirAll(fs.WorkingDirPath(), 0o755)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf(fmt.Sprintf("expected no error but got: %v", err))
|
|
||||||
}
|
|
||||||
|
|
||||||
err = os.WriteFile(fmt.Sprintf("%s/document.txt", fs.WorkingDirPath()), []byte("LosslessImageCompression"), 0o755)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected no error but got: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return fs
|
|
||||||
}(),
|
|
||||||
options: Options{LosslessImageCompression: true},
|
|
||||||
cancelledCtx: false,
|
|
||||||
start: true,
|
|
||||||
expectError: false,
|
|
||||||
},
|
|
||||||
{
|
|
||||||
scenario: "success ReduceImageResolution",
|
|
||||||
libreOffice: newLibreOfficeProcess(
|
|
||||||
libreOfficeArguments{
|
|
||||||
binPath: os.Getenv("LIBREOFFICE_BIN_PATH"),
|
|
||||||
unoBinPath: os.Getenv("UNOCONVERTER_BIN_PATH"),
|
|
||||||
startTimeout: 5 * time.Second,
|
|
||||||
},
|
|
||||||
),
|
|
||||||
fs: func() *gotenberg.FileSystem {
|
|
||||||
fs := gotenberg.NewFileSystem()
|
|
||||||
|
|
||||||
err := os.MkdirAll(fs.WorkingDirPath(), 0o755)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf(fmt.Sprintf("expected no error but got: %v", err))
|
|
||||||
}
|
|
||||||
|
|
||||||
err = os.WriteFile(fmt.Sprintf("%s/document.txt", fs.WorkingDirPath()), []byte("ReduceImageResolution"), 0o755)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected no error but got: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return fs
|
|
||||||
}(),
|
|
||||||
options: Options{ReduceImageResolution: false},
|
|
||||||
cancelledCtx: false,
|
cancelledCtx: false,
|
||||||
start: true,
|
start: true,
|
||||||
expectError: false,
|
expectError: false,
|
||||||
|
|||||||
@@ -5,6 +5,8 @@ import (
|
|||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"slices"
|
||||||
|
"strconv"
|
||||||
|
|
||||||
"github.com/labstack/echo/v4"
|
"github.com/labstack/echo/v4"
|
||||||
|
|
||||||
@@ -22,33 +24,100 @@ func convertRoute(libreOffice libreofficeapi.Uno, engine gotenberg.PdfEngine) ap
|
|||||||
IsMultipart: true,
|
IsMultipart: true,
|
||||||
Handler: func(c echo.Context) error {
|
Handler: func(c echo.Context) error {
|
||||||
ctx := c.Get("context").(*api.Context)
|
ctx := c.Get("context").(*api.Context)
|
||||||
|
defaultOptions := libreofficeapi.DefaultOptions()
|
||||||
|
|
||||||
// Let's get the data from the form and validate them.
|
// Let's get the data from the form and validate them.
|
||||||
var (
|
var (
|
||||||
inputPaths []string
|
inputPaths []string
|
||||||
landscape bool
|
landscape bool
|
||||||
nativePageRanges string
|
nativePageRanges string
|
||||||
exportFormFields bool
|
exportFormFields bool
|
||||||
singlePageSheets bool
|
allowDuplicateFieldNames bool
|
||||||
exportNotesInMargin bool
|
exportBookmarks bool
|
||||||
losslessImageCompression bool
|
exportBookmarksToPdfDestination bool
|
||||||
reduceImageResolution bool
|
exportPlaceholders bool
|
||||||
pdfa string
|
exportNotes bool
|
||||||
pdfua bool
|
exportNotesPages bool
|
||||||
nativePdfFormats bool
|
exportOnlyNotesPages bool
|
||||||
merge bool
|
exportNotesInMargin bool
|
||||||
metadata map[string]interface{}
|
convertOooTargetToPdfTarget bool
|
||||||
|
exportLinksRelativeFsys bool
|
||||||
|
exportHiddenSlides bool
|
||||||
|
skipEmptyPages bool
|
||||||
|
addOriginalDocumentAsStream bool
|
||||||
|
singlePageSheets bool
|
||||||
|
losslessImageCompression bool
|
||||||
|
quality int
|
||||||
|
reduceImageResolution bool
|
||||||
|
maxImageResolution int
|
||||||
|
pdfa string
|
||||||
|
pdfua bool
|
||||||
|
nativePdfFormats bool
|
||||||
|
merge bool
|
||||||
|
metadata map[string]interface{}
|
||||||
)
|
)
|
||||||
|
|
||||||
err := ctx.FormData().
|
err := ctx.FormData().
|
||||||
MandatoryPaths(libreOffice.Extensions(), &inputPaths).
|
MandatoryPaths(libreOffice.Extensions(), &inputPaths).
|
||||||
Bool("landscape", &landscape, false).
|
Bool("landscape", &landscape, defaultOptions.Landscape).
|
||||||
String("nativePageRanges", &nativePageRanges, "").
|
String("nativePageRanges", &nativePageRanges, defaultOptions.PageRanges).
|
||||||
Bool("exportFormFields", &exportFormFields, true).
|
Bool("exportFormFields", &exportFormFields, defaultOptions.ExportFormFields).
|
||||||
Bool("singlePageSheets", &singlePageSheets, false).
|
Bool("allowDuplicateFieldNames", &allowDuplicateFieldNames, defaultOptions.AllowDuplicateFieldNames).
|
||||||
Bool("exportNotesInMargin", &exportNotesInMargin, false).
|
Bool("exportBookmarks", &exportBookmarks, defaultOptions.ExportBookmarks).
|
||||||
Bool("losslessImageCompression", &losslessImageCompression, false).
|
Bool("exportBookmarksToPdfDestination", &exportBookmarksToPdfDestination, defaultOptions.ExportBookmarksToPdfDestination).
|
||||||
Bool("reduceImageResolution", &reduceImageResolution, true).
|
Bool("exportPlaceholders", &exportPlaceholders, defaultOptions.ExportPlaceholders).
|
||||||
|
Bool("exportNotes", &exportNotes, defaultOptions.ExportNotes).
|
||||||
|
Bool("exportNotesPages", &exportNotesPages, defaultOptions.ExportNotesPages).
|
||||||
|
Bool("exportOnlyNotesPages", &exportOnlyNotesPages, defaultOptions.ExportOnlyNotesPages).
|
||||||
|
Bool("exportNotesInMargin", &exportNotesInMargin, defaultOptions.ExportNotesInMargin).
|
||||||
|
Bool("convertOooTargetToPdfTarget", &convertOooTargetToPdfTarget, defaultOptions.ConvertOooTargetToPdfTarget).
|
||||||
|
Bool("exportLinksRelativeFsys", &exportLinksRelativeFsys, defaultOptions.ExportLinksRelativeFsys).
|
||||||
|
Bool("exportHiddenSlides", &exportHiddenSlides, defaultOptions.ExportHiddenSlides).
|
||||||
|
Bool("skipEmptyPages", &skipEmptyPages, defaultOptions.SkipEmptyPages).
|
||||||
|
Bool("addOriginalDocumentAsStream", &addOriginalDocumentAsStream, defaultOptions.AddOriginalDocumentAsStream).
|
||||||
|
Bool("singlePageSheets", &singlePageSheets, defaultOptions.SinglePageSheets).
|
||||||
|
Bool("losslessImageCompression", &losslessImageCompression, defaultOptions.LosslessImageCompression).
|
||||||
|
Custom("quality", func(value string) error {
|
||||||
|
if value == "" {
|
||||||
|
quality = defaultOptions.Quality
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
intValue, err := strconv.Atoi(value)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if intValue < 1 {
|
||||||
|
return errors.New("value is inferior to 1")
|
||||||
|
}
|
||||||
|
|
||||||
|
if intValue > 100 {
|
||||||
|
return errors.New("value is superior to 100")
|
||||||
|
}
|
||||||
|
|
||||||
|
quality = intValue
|
||||||
|
return nil
|
||||||
|
}).
|
||||||
|
Bool("reduceImageResolution", &reduceImageResolution, defaultOptions.ReduceImageResolution).
|
||||||
|
Custom("maxImageResolution", func(value string) error {
|
||||||
|
if value == "" {
|
||||||
|
maxImageResolution = defaultOptions.MaxImageResolution
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
intValue, err := strconv.Atoi(value)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
if !slices.Contains([]int{75, 150, 300, 600, 1200}, intValue) {
|
||||||
|
return errors.New("value is not 75, 150, 300, 600 or 1200")
|
||||||
|
}
|
||||||
|
|
||||||
|
maxImageResolution = intValue
|
||||||
|
return nil
|
||||||
|
}).
|
||||||
String("pdfa", &pdfa, "").
|
String("pdfa", &pdfa, "").
|
||||||
Bool("pdfua", &pdfua, false).
|
Bool("pdfua", &pdfua, false).
|
||||||
Bool("nativePdfFormats", &nativePdfFormats, true).
|
Bool("nativePdfFormats", &nativePdfFormats, true).
|
||||||
@@ -77,13 +146,27 @@ func convertRoute(libreOffice libreofficeapi.Uno, engine gotenberg.PdfEngine) ap
|
|||||||
for i, inputPath := range inputPaths {
|
for i, inputPath := range inputPaths {
|
||||||
outputPaths[i] = ctx.GeneratePath(".pdf")
|
outputPaths[i] = ctx.GeneratePath(".pdf")
|
||||||
options := libreofficeapi.Options{
|
options := libreofficeapi.Options{
|
||||||
Landscape: landscape,
|
Landscape: landscape,
|
||||||
PageRanges: nativePageRanges,
|
PageRanges: nativePageRanges,
|
||||||
ExportFormFields: exportFormFields,
|
ExportFormFields: exportFormFields,
|
||||||
SinglePageSheets: singlePageSheets,
|
AllowDuplicateFieldNames: allowDuplicateFieldNames,
|
||||||
ExportNotesInMargin: exportNotesInMargin,
|
ExportBookmarks: exportBookmarks,
|
||||||
LosslessImageCompression: losslessImageCompression,
|
ExportBookmarksToPdfDestination: exportBookmarksToPdfDestination,
|
||||||
ReduceImageResolution: reduceImageResolution,
|
ExportPlaceholders: exportPlaceholders,
|
||||||
|
ExportNotes: exportNotes,
|
||||||
|
ExportNotesPages: exportNotesPages,
|
||||||
|
ExportOnlyNotesPages: exportOnlyNotesPages,
|
||||||
|
ExportNotesInMargin: exportNotesInMargin,
|
||||||
|
ConvertOooTargetToPdfTarget: convertOooTargetToPdfTarget,
|
||||||
|
ExportLinksRelativeFsys: exportLinksRelativeFsys,
|
||||||
|
ExportHiddenSlides: exportHiddenSlides,
|
||||||
|
SkipEmptyPages: skipEmptyPages,
|
||||||
|
AddOriginalDocumentAsStream: addOriginalDocumentAsStream,
|
||||||
|
SinglePageSheets: singlePageSheets,
|
||||||
|
LosslessImageCompression: losslessImageCompression,
|
||||||
|
Quality: quality,
|
||||||
|
ReduceImageResolution: reduceImageResolution,
|
||||||
|
MaxImageResolution: maxImageResolution,
|
||||||
}
|
}
|
||||||
|
|
||||||
if nativePdfFormats {
|
if nativePdfFormats {
|
||||||
|
|||||||
@@ -39,6 +39,116 @@ func TestConvertRoute(t *testing.T) {
|
|||||||
expectHttpStatus: http.StatusBadRequest,
|
expectHttpStatus: http.StatusBadRequest,
|
||||||
expectOutputPathsCount: 0,
|
expectOutputPathsCount: 0,
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
scenario: "invalid quality form field (not an integer)",
|
||||||
|
ctx: func() *api.ContextMock {
|
||||||
|
ctx := &api.ContextMock{Context: new(api.Context)}
|
||||||
|
ctx.SetFiles(map[string]string{
|
||||||
|
"document.docx": "/document.docx",
|
||||||
|
})
|
||||||
|
ctx.SetValues(map[string][]string{
|
||||||
|
"quality": {
|
||||||
|
"foo",
|
||||||
|
},
|
||||||
|
})
|
||||||
|
return ctx
|
||||||
|
}(),
|
||||||
|
libreOffice: &libreofficeapi.ApiMock{ExtensionsMock: func() []string {
|
||||||
|
return []string{".docx"}
|
||||||
|
}},
|
||||||
|
expectError: true,
|
||||||
|
expectHttpError: true,
|
||||||
|
expectHttpStatus: http.StatusBadRequest,
|
||||||
|
expectOutputPathsCount: 0,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
scenario: "invalid quality form field (< 1)",
|
||||||
|
ctx: func() *api.ContextMock {
|
||||||
|
ctx := &api.ContextMock{Context: new(api.Context)}
|
||||||
|
ctx.SetFiles(map[string]string{
|
||||||
|
"document.docx": "/document.docx",
|
||||||
|
})
|
||||||
|
ctx.SetValues(map[string][]string{
|
||||||
|
"quality": {
|
||||||
|
"0",
|
||||||
|
},
|
||||||
|
})
|
||||||
|
return ctx
|
||||||
|
}(),
|
||||||
|
libreOffice: &libreofficeapi.ApiMock{ExtensionsMock: func() []string {
|
||||||
|
return []string{".docx"}
|
||||||
|
}},
|
||||||
|
expectError: true,
|
||||||
|
expectHttpError: true,
|
||||||
|
expectHttpStatus: http.StatusBadRequest,
|
||||||
|
expectOutputPathsCount: 0,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
scenario: "invalid quality form field (> 100)",
|
||||||
|
ctx: func() *api.ContextMock {
|
||||||
|
ctx := &api.ContextMock{Context: new(api.Context)}
|
||||||
|
ctx.SetFiles(map[string]string{
|
||||||
|
"document.docx": "/document.docx",
|
||||||
|
})
|
||||||
|
ctx.SetValues(map[string][]string{
|
||||||
|
"quality": {
|
||||||
|
"101",
|
||||||
|
},
|
||||||
|
})
|
||||||
|
return ctx
|
||||||
|
}(),
|
||||||
|
libreOffice: &libreofficeapi.ApiMock{ExtensionsMock: func() []string {
|
||||||
|
return []string{".docx"}
|
||||||
|
}},
|
||||||
|
expectError: true,
|
||||||
|
expectHttpError: true,
|
||||||
|
expectHttpStatus: http.StatusBadRequest,
|
||||||
|
expectOutputPathsCount: 0,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
scenario: "invalid maxImageResolution form field (not an integer)",
|
||||||
|
ctx: func() *api.ContextMock {
|
||||||
|
ctx := &api.ContextMock{Context: new(api.Context)}
|
||||||
|
ctx.SetFiles(map[string]string{
|
||||||
|
"document.docx": "/document.docx",
|
||||||
|
})
|
||||||
|
ctx.SetValues(map[string][]string{
|
||||||
|
"maxImageResolution": {
|
||||||
|
"foo",
|
||||||
|
},
|
||||||
|
})
|
||||||
|
return ctx
|
||||||
|
}(),
|
||||||
|
libreOffice: &libreofficeapi.ApiMock{ExtensionsMock: func() []string {
|
||||||
|
return []string{".docx"}
|
||||||
|
}},
|
||||||
|
expectError: true,
|
||||||
|
expectHttpError: true,
|
||||||
|
expectHttpStatus: http.StatusBadRequest,
|
||||||
|
expectOutputPathsCount: 0,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
scenario: "invalid maxImageResolution form field (not in range)",
|
||||||
|
ctx: func() *api.ContextMock {
|
||||||
|
ctx := &api.ContextMock{Context: new(api.Context)}
|
||||||
|
ctx.SetFiles(map[string]string{
|
||||||
|
"document.docx": "/document.docx",
|
||||||
|
})
|
||||||
|
ctx.SetValues(map[string][]string{
|
||||||
|
"maxImageResolution": {
|
||||||
|
"1",
|
||||||
|
},
|
||||||
|
})
|
||||||
|
return ctx
|
||||||
|
}(),
|
||||||
|
libreOffice: &libreofficeapi.ApiMock{ExtensionsMock: func() []string {
|
||||||
|
return []string{".docx"}
|
||||||
|
}},
|
||||||
|
expectError: true,
|
||||||
|
expectHttpError: true,
|
||||||
|
expectHttpStatus: http.StatusBadRequest,
|
||||||
|
expectOutputPathsCount: 0,
|
||||||
|
},
|
||||||
{
|
{
|
||||||
scenario: "invalid metadata form field",
|
scenario: "invalid metadata form field",
|
||||||
ctx: func() *api.ContextMock {
|
ctx: func() *api.ContextMock {
|
||||||
@@ -285,6 +395,12 @@ func TestConvertRoute(t *testing.T) {
|
|||||||
"document2.docx": "/document2.docx",
|
"document2.docx": "/document2.docx",
|
||||||
})
|
})
|
||||||
ctx.SetValues(map[string][]string{
|
ctx.SetValues(map[string][]string{
|
||||||
|
"quality": {
|
||||||
|
"100",
|
||||||
|
},
|
||||||
|
"maxImageResolution": {
|
||||||
|
"1200",
|
||||||
|
},
|
||||||
"merge": {
|
"merge": {
|
||||||
"true",
|
"true",
|
||||||
},
|
},
|
||||||
|
|||||||
Reference in New Issue
Block a user