mirror of
https://github.com/gotenberg/gotenberg.git
synced 2026-08-11 01:42:15 +01:00
119 lines
2.8 KiB
Go
119 lines
2.8 KiB
Go
package qpdf
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"os"
|
|
"sync"
|
|
|
|
"go.uber.org/zap"
|
|
|
|
"github.com/gotenberg/gotenberg/v7/pkg/gotenberg"
|
|
)
|
|
|
|
func init() {
|
|
gotenberg.MustRegisterModule(new(QPdf))
|
|
}
|
|
|
|
// QPdf abstracts the CLI tool QPDF and implements the [gotenberg.PdfEngine]
|
|
// interface.
|
|
type QPdf struct {
|
|
binPath string
|
|
}
|
|
|
|
// Descriptor returns a [QPdf]'s module descriptor.
|
|
func (engine *QPdf) Descriptor() gotenberg.ModuleDescriptor {
|
|
return gotenberg.ModuleDescriptor{
|
|
ID: "qpdf",
|
|
New: func() gotenberg.Module { return new(QPdf) },
|
|
}
|
|
}
|
|
|
|
// Provision sets the modules properties.
|
|
func (engine *QPdf) Provision(ctx *gotenberg.Context) error {
|
|
binPath, ok := os.LookupEnv("QPDF_BIN_PATH")
|
|
if !ok {
|
|
return errors.New("QPDF_BIN_PATH environment variable is not set")
|
|
}
|
|
|
|
engine.binPath = binPath
|
|
|
|
return nil
|
|
}
|
|
|
|
// Validate validates the module properties.
|
|
func (engine *QPdf) Validate() error {
|
|
_, err := os.Stat(engine.binPath)
|
|
if os.IsNotExist(err) {
|
|
return fmt.Errorf("QPdf binary path does not exist: %w", err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// Metrics returns the metrics.
|
|
func (engine *QPdf) Metrics() ([]gotenberg.Metric, error) {
|
|
// TODO: remove deprecated.
|
|
return []gotenberg.Metric{
|
|
{
|
|
Name: "qpdf_active_instances_count",
|
|
Description: "Current number of active QPDF instances - deprecated.",
|
|
Read: func() float64 {
|
|
activeInstancesCountMu.RLock()
|
|
defer activeInstancesCountMu.RUnlock()
|
|
|
|
return activeInstancesCount
|
|
},
|
|
},
|
|
}, nil
|
|
}
|
|
|
|
// Merge combines multiple PDFs into a single PDF.
|
|
func (engine *QPdf) Merge(ctx context.Context, logger *zap.Logger, inputPaths []string, outputPath string) error {
|
|
var args []string
|
|
args = append(args, "--empty")
|
|
args = append(args, "--pages")
|
|
args = append(args, inputPaths...)
|
|
args = append(args, "--", outputPath)
|
|
|
|
cmd, err := gotenberg.CommandContext(ctx, logger, engine.binPath, args...)
|
|
if err != nil {
|
|
return fmt.Errorf("create command: %w", err)
|
|
}
|
|
|
|
activeInstancesCountMu.Lock()
|
|
activeInstancesCount += 1
|
|
activeInstancesCountMu.Unlock()
|
|
|
|
_, err = cmd.Exec()
|
|
|
|
activeInstancesCountMu.Lock()
|
|
activeInstancesCount -= 1
|
|
activeInstancesCountMu.Unlock()
|
|
|
|
if err == nil {
|
|
return nil
|
|
}
|
|
|
|
return fmt.Errorf("merge PDFs with QPDF: %w", err)
|
|
}
|
|
|
|
// Convert is not available in this implementation.
|
|
func (engine *QPdf) Convert(ctx context.Context, logger *zap.Logger, formats gotenberg.PdfFormats, inputPath, outputPath string) error {
|
|
return fmt.Errorf("convert PDF to '%+v' with QPDF: %w", formats, gotenberg.ErrPdfEngineMethodNotSupported)
|
|
}
|
|
|
|
var (
|
|
activeInstancesCount float64
|
|
activeInstancesCountMu sync.RWMutex
|
|
)
|
|
|
|
var (
|
|
_ gotenberg.Module = (*QPdf)(nil)
|
|
_ gotenberg.Provisioner = (*QPdf)(nil)
|
|
_ gotenberg.Validator = (*QPdf)(nil)
|
|
_ gotenberg.MetricsProvider = (*QPdf)(nil)
|
|
_ gotenberg.PdfEngine = (*QPdf)(nil)
|
|
)
|