@@ -1395,7 +1644,7 @@ use TheCodingMachine\Gotenberg\HTMLRequest;
use TheCodingMachine\Gotenberg\Request;
$client = new Client('http://localhost:3000', new \Http\Adapter\Guzzle6\Client());
-$index = DocumentFactory::makeFromPath('index.html', 'index.html');
+$index = DocumentFactory::makeFromPath('index.html', '/path/to/file');
$request = new HTMLRequest($index);
$request->setResultFilename('foo.pdf');
$resp = $client->post($request);
@@ -1447,14 +1696,14 @@ if the API is under heavy load.
For instance, using the following Docker Compose file:
-version: '3'
+version: '3'
-services:
+services:
# your others services
- gotenberg:
- image: thecodingmachine/gotenberg:6
+ gotenberg:
+ image: thecodingmachine/gotenberg:6
You may now launch your services using:
diff --git a/internal/app/xhttp/handler.go b/internal/app/xhttp/handler.go
index 7c819bd2..92cf22ea 100644
--- a/internal/app/xhttp/handler.go
+++ b/internal/app/xhttp/handler.go
@@ -15,31 +15,45 @@ import (
"github.com/thecodingmachine/gotenberg/internal/pkg/xtime"
)
-const (
- pingEndpoint string = "/ping"
- mergeEndpoint string = "/merge"
- convertGroupEndpoint string = "/convert"
- htmlEndpoint string = "/html"
- urlEndpoint string = "/url"
- markdownEndpoint string = "/markdown"
- officeEndpoint string = "/office"
-)
+func pingEndpoint(config conf.Config) string {
+ return fmt.Sprintf("%s%s", config.RootPath(), "ping")
+}
+
+func mergeEndpoint(config conf.Config) string {
+ return fmt.Sprintf("%s%s", config.RootPath(), "merge")
+}
+
+func htmlEndpoint(config conf.Config) string {
+ return fmt.Sprintf("%s%s", config.RootPath(), "convert/html")
+}
+
+func urlEndpoint(config conf.Config) string {
+ return fmt.Sprintf("%s%s", config.RootPath(), "convert/url")
+}
+
+func markdownEndpoint(config conf.Config) string {
+ return fmt.Sprintf("%s%s", config.RootPath(), "convert/markdown")
+}
+
+func officeEndpoint(config conf.Config) string {
+ return fmt.Sprintf("%s%s", config.RootPath(), "convert/office")
+}
func isMultipartFormDataEndpoint(config conf.Config, path string) bool {
var multipartFormDataEndpoints []string
- multipartFormDataEndpoints = append(multipartFormDataEndpoints, mergeEndpoint)
+ multipartFormDataEndpoints = append(multipartFormDataEndpoints, mergeEndpoint(config))
if !config.DisableGoogleChrome() {
multipartFormDataEndpoints = append(
multipartFormDataEndpoints,
- fmt.Sprintf("%s%s", convertGroupEndpoint, htmlEndpoint),
- fmt.Sprintf("%s%s", convertGroupEndpoint, urlEndpoint),
- fmt.Sprintf("%s%s", convertGroupEndpoint, markdownEndpoint),
+ htmlEndpoint(config),
+ urlEndpoint(config),
+ markdownEndpoint(config),
)
}
if !config.DisableUnoconv() {
multipartFormDataEndpoints = append(
multipartFormDataEndpoints,
- fmt.Sprintf("%s%s", convertGroupEndpoint, officeEndpoint),
+ officeEndpoint(config),
)
}
for _, endpoint := range multipartFormDataEndpoints {
@@ -124,6 +138,7 @@ func urlHandler(c echo.Context) error {
if err != nil {
return err
}
+ opts.CustomHTTPHeaders = resource.RemoteURLCustomHTTPHeaders(r)
if !r.HasArg(resource.RemoteURLArgKey) {
return xerror.Invalid(
op,
@@ -308,20 +323,50 @@ func convertAsync(ctx context.Context, p printer.Printer, filename, fpath string
defer f.Close() // nolint: errcheck
logger.DebugfOp(
op,
- "sending result file '%s' to '%s'",
+ "preparing to send result file '%s' to '%s'...",
filename,
webhookURL,
)
httpClient := &http.Client{
Timeout: xtime.Duration(webhookURLTimeout),
}
- resp, err := httpClient.Post(webhookURL, "application/pdf", f) /* #nosec */
+ req, err := http.NewRequest(http.MethodPost, webhookURL, f)
+ if err != nil {
+ xerr := xerror.New(op, err)
+ logger.ErrorOp(xerror.Op(xerr), xerr)
+ return
+ }
+ req.Header.Set(echo.HeaderContentType, "application/pdf")
+ // set custom headers (if any).
+ customHTTPHeaders := resource.WebhookURLCustomHTTPHeaders(r)
+ if len(customHTTPHeaders) > 0 {
+ for key, value := range customHTTPHeaders {
+ req.Header.Set(key, value)
+ logger.DebugfOp(op, "set '%s' to custom HTTP header '%s'", value, key)
+ }
+ } else {
+ logger.DebugOp(op, "skipping custom HTTP headers as none have been provided...")
+ }
+ // send the result file.
+ logger.DebugfOp(
+ op,
+ "sending result file '%s' to '%s'...",
+ filename,
+ webhookURL,
+ )
+ resp, err := httpClient.Do(req) /* #nosec */
if err != nil {
xerr := xerror.New(op, err)
logger.ErrorOp(xerror.Op(xerr), xerr)
return
}
defer resp.Body.Close() // nolint: errcheck
+ logger.DebugfOp(
+ op,
+ "result file '%s' sent to '%s'",
+ filename,
+ webhookURL,
+ )
}()
return nil
}
diff --git a/internal/app/xhttp/handler_test.go b/internal/app/xhttp/handler_test.go
index 5602d90b..7e141d53 100644
--- a/internal/app/xhttp/handler_test.go
+++ b/internal/app/xhttp/handler_test.go
@@ -19,49 +19,51 @@ func TestPingHandler(t *testing.T) {
// should return 200.
config := conf.DefaultConfig()
srv := New(config)
- req := httptest.NewRequest(http.MethodGet, pingEndpoint, nil)
+ endpoint := pingEndpoint(config)
+ req := httptest.NewRequest(http.MethodGet, endpoint, nil)
test.AssertStatusCode(t, http.StatusOK, srv, req)
// should return 405 as Method is wrong.
- req = httptest.NewRequest(http.MethodPost, pingEndpoint, nil)
+ req = httptest.NewRequest(http.MethodPost, endpoint, nil)
test.AssertStatusCode(t, http.StatusMethodNotAllowed, srv, req)
}
func TestMergeHandler(t *testing.T) {
config := conf.DefaultConfig()
srv := New(config)
+ endpoint := mergeEndpoint(config)
// should return 200.
body, contentType := test.MergeMultipartForm(t, nil)
- req := httptest.NewRequest(http.MethodPost, mergeEndpoint, body)
+ req := httptest.NewRequest(http.MethodPost, endpoint, body)
req.Header.Set(echo.HeaderContentType, contentType)
test.AssertStatusCode(t, http.StatusOK, srv, req)
// should return 405 as Method is wrong.
- req = httptest.NewRequest(http.MethodGet, mergeEndpoint, nil)
+ req = httptest.NewRequest(http.MethodGet, endpoint, nil)
test.AssertStatusCode(t, http.StatusMethodNotAllowed, srv, req)
// should return 415 as Content-Type is wrong.
body, _ = test.MergeMultipartForm(t, nil)
- req = httptest.NewRequest(http.MethodPost, mergeEndpoint, body)
+ req = httptest.NewRequest(http.MethodPost, endpoint, body)
test.AssertStatusCode(t, http.StatusUnsupportedMediaType, srv, req)
// should return 400 as "waitTimeout" form field
// value is < 0.
body, contentType = test.MergeMultipartForm(t, map[string]string{string(resource.WaitTimeoutArgKey): "-1"})
- req = httptest.NewRequest(http.MethodPost, mergeEndpoint, body)
+ req = httptest.NewRequest(http.MethodPost, endpoint, body)
req.Header.Set(echo.HeaderContentType, contentType)
test.AssertStatusCode(t, http.StatusBadRequest, srv, req)
// should return 400 as "waitTimeout" form field
// value is is > config.MaximumWaitTimeout().
body, contentType = test.MergeMultipartForm(t, map[string]string{string(resource.WaitTimeoutArgKey): "31"})
- req = httptest.NewRequest(http.MethodPost, mergeEndpoint, body)
+ req = httptest.NewRequest(http.MethodPost, endpoint, body)
req.Header.Set(echo.HeaderContentType, contentType)
test.AssertStatusCode(t, http.StatusBadRequest, srv, req)
// should return 400 as "waitTimeout" form field
// value is invalid.
body, contentType = test.MergeMultipartForm(t, map[string]string{string(resource.WaitTimeoutArgKey): "not a float"})
- req = httptest.NewRequest(http.MethodPost, mergeEndpoint, body)
+ req = httptest.NewRequest(http.MethodPost, endpoint, body)
req.Header.Set(echo.HeaderContentType, contentType)
test.AssertStatusCode(t, http.StatusBadRequest, srv, req)
// should return 504.
body, contentType = test.MergeMultipartForm(t, map[string]string{string(resource.WaitTimeoutArgKey): "0"})
- req = httptest.NewRequest(http.MethodPost, mergeEndpoint, body)
+ req = httptest.NewRequest(http.MethodPost, endpoint, body)
req.Header.Set(echo.HeaderContentType, contentType)
test.AssertStatusCode(t, http.StatusGatewayTimeout, srv, req)
}
@@ -69,7 +71,7 @@ func TestMergeHandler(t *testing.T) {
func TestHTMLHandler(t *testing.T) {
config := conf.DefaultConfig()
srv := New(config)
- endpoint := fmt.Sprintf("%s%s", convertGroupEndpoint, htmlEndpoint)
+ endpoint := htmlEndpoint(config)
// should return 200.
body, contentType := test.HTMLMultipartForm(t, nil)
req := httptest.NewRequest(http.MethodPost, endpoint, body)
@@ -224,7 +226,7 @@ func TestHTMLHandler(t *testing.T) {
func TestURLHandler(t *testing.T) {
config := conf.DefaultConfig()
srv := New(config)
- endpoint := fmt.Sprintf("%s%s", convertGroupEndpoint, urlEndpoint)
+ endpoint := urlEndpoint(config)
// should return 200.
body, contentType := test.URLMultipartForm(t, nil)
req := httptest.NewRequest(http.MethodPost, endpoint, body)
@@ -379,7 +381,7 @@ func TestURLHandler(t *testing.T) {
func TestMarkdownHandler(t *testing.T) {
config := conf.DefaultConfig()
srv := New(config)
- endpoint := fmt.Sprintf("%s%s", convertGroupEndpoint, markdownEndpoint)
+ endpoint := markdownEndpoint(config)
// should return 200.
body, contentType := test.MarkdownMultipartForm(t, nil)
req := httptest.NewRequest(http.MethodPost, endpoint, body)
@@ -534,7 +536,7 @@ func TestMarkdownHandler(t *testing.T) {
func TestOfficeHandler(t *testing.T) {
config := conf.DefaultConfig()
srv := New(config)
- endpoint := fmt.Sprintf("%s%s", convertGroupEndpoint, officeEndpoint)
+ endpoint := officeEndpoint(config)
// should return 200.
body, contentType := test.OfficeMultipartForm(t, nil)
req := httptest.NewRequest(http.MethodPost, endpoint, body)
@@ -579,11 +581,18 @@ func TestOfficeHandler(t *testing.T) {
}
func TestWebhook(t *testing.T) {
+ customHeaderRealKey := http.CanonicalHeaderKey("MyCustomHeader")
+ customHeaderKey := fmt.Sprintf("%s%s", resource.WebhookURLCustomHTTPHeaderCanonicalBaseKey, customHeaderRealKey)
+ customHeaderValue := "foo"
status := make(chan error, 2)
rcv := echo.New()
rcv.POST("/foo", func(c echo.Context) error {
- if c.Request().Header.Get("Content-type") != "application/pdf" {
- status <- fmt.Errorf("wrong Content-type: got %s want %s", c.Request().Header.Get("Content-type"), "application/pdf")
+ if c.Request().Header.Get(echo.HeaderContentType) != "application/pdf" {
+ status <- fmt.Errorf("wrong Content-type: got '%s' want '%s'", c.Request().Header.Get(echo.HeaderContentType), "application/pdf")
+ return nil
+ }
+ if c.Request().Header.Get(customHeaderRealKey) != customHeaderValue {
+ status <- fmt.Errorf("wrong '%s': got '%s' want '%s'", customHeaderRealKey, c.Request().Header.Get(customHeaderRealKey), customHeaderValue)
return nil
}
body, err := ioutil.ReadAll(c.Request().Body)
@@ -605,8 +614,9 @@ func TestWebhook(t *testing.T) {
srv := New(config)
// our custom server should receive the PDF.
body, contentType := test.MergeMultipartForm(t, map[string]string{string(resource.WebhookURLArgKey): "http://localhost:3001/foo"})
- req := httptest.NewRequest(http.MethodPost, mergeEndpoint, body)
+ req := httptest.NewRequest(http.MethodPost, mergeEndpoint(config), body)
req.Header.Set(echo.HeaderContentType, contentType)
+ req.Header.Set(customHeaderKey, customHeaderValue)
test.AssertStatusCode(t, http.StatusOK, srv, req)
err := <-status
assert.NoError(t, err)
@@ -616,9 +626,9 @@ func TestResultFilename(t *testing.T) {
config := conf.DefaultConfig()
srv := New(config)
body, contentType := test.MergeMultipartForm(t, map[string]string{string(resource.ResultFilenameArgKey): "foo.pdf"})
- req := httptest.NewRequest(http.MethodPost, mergeEndpoint, body)
+ req := httptest.NewRequest(http.MethodPost, mergeEndpoint(config), body)
req.Header.Set(echo.HeaderContentType, contentType)
rec := httptest.NewRecorder()
srv.ServeHTTP(rec, req)
- assert.Equal(t, "attachment; filename=\"foo.pdf\"", rec.Header().Get("Content-Disposition"))
+ assert.Equal(t, "attachment; filename=\"foo.pdf\"", rec.Header().Get(echo.HeaderContentDisposition))
}
diff --git a/internal/app/xhttp/middleware.go b/internal/app/xhttp/middleware.go
index ff722c6a..4049b9ac 100644
--- a/internal/app/xhttp/middleware.go
+++ b/internal/app/xhttp/middleware.go
@@ -30,7 +30,7 @@ func contextMiddleware(config conf.Config) echo.MiddlewareFunc {
// there is no need to create a Resource.
if !isMultipartFormDataEndpoint(config, ctx.Path()) {
// validate method for healthcheck endpoint.
- if ctx.Path() == pingEndpoint && ctx.Request().Method != http.MethodGet {
+ if ctx.Path() == pingEndpoint(config) && ctx.Request().Method != http.MethodGet {
err := doErr(ctx, echo.NewHTTPError(http.StatusMethodNotAllowed))
return ctx.LogRequestResult(err, false)
}
@@ -60,14 +60,14 @@ func contextMiddleware(config conf.Config) echo.MiddlewareFunc {
}
// loggerMiddleware logs the result of a request.
-func loggerMiddleware() echo.MiddlewareFunc {
+func loggerMiddleware(config conf.Config) echo.MiddlewareFunc {
return func(next echo.HandlerFunc) echo.HandlerFunc {
return func(c echo.Context) error {
ctx := context.MustCastFromEchoContext(c)
err := next(ctx)
// we do not want to log healthcheck requests if
// log level is not set to DEBUG.
- isDebug := ctx.Path() == pingEndpoint
+ isDebug := ctx.Path() == pingEndpoint(config)
return ctx.LogRequestResult(err, isDebug)
}
}
diff --git a/internal/app/xhttp/option.go b/internal/app/xhttp/option.go
index 2afb6984..5a9a3759 100644
--- a/internal/app/xhttp/option.go
+++ b/internal/app/xhttp/option.go
@@ -48,23 +48,29 @@ func chromePrinterOptions(r resource.Resource, config conf.Config) (printer.Chro
if err != nil {
return printer.ChromePrinterOptions{}, err
}
+ pageRanges, err := r.StringArg(resource.PageRangesArgKey, "")
+ if err != nil {
+ return printer.ChromePrinterOptions{}, err
+ }
googleChromeRpccBufferSize, err := resource.GoogleChromeRpccBufferSizeArg(r, config)
if err != nil {
return printer.ChromePrinterOptions{}, err
}
return printer.ChromePrinterOptions{
- WaitTimeout: waitTimeout,
- WaitDelay: waitDelay,
- HeaderHTML: headerHTML,
- FooterHTML: footerHTML,
- PaperWidth: paperWidth,
- PaperHeight: paperHeight,
- MarginTop: marginTop,
- MarginBottom: marginBottom,
- MarginLeft: marginLeft,
- MarginRight: marginRight,
- Landscape: landscape,
- RpccBufferSize: googleChromeRpccBufferSize,
+ WaitTimeout: waitTimeout,
+ WaitDelay: waitDelay,
+ HeaderHTML: headerHTML,
+ FooterHTML: footerHTML,
+ PaperWidth: paperWidth,
+ PaperHeight: paperHeight,
+ MarginTop: marginTop,
+ MarginBottom: marginBottom,
+ MarginLeft: marginLeft,
+ MarginRight: marginRight,
+ Landscape: landscape,
+ PageRanges: pageRanges,
+ RpccBufferSize: googleChromeRpccBufferSize,
+ CustomHTTPHeaders: make(map[string]string),
}, nil
}
opts, err := resolver()
@@ -85,9 +91,14 @@ func officePrinterOptions(r resource.Resource, config conf.Config) (printer.Offi
if err != nil {
return printer.OfficePrinterOptions{}, err
}
+ pageRanges, err := r.StringArg(resource.PageRangesArgKey, "")
+ if err != nil {
+ return printer.OfficePrinterOptions{}, err
+ }
return printer.OfficePrinterOptions{
WaitTimeout: waitTimeout,
Landscape: landscape,
+ PageRanges: pageRanges,
}, nil
}
opts, err := resolver()
diff --git a/internal/app/xhttp/pkg/context/context.go b/internal/app/xhttp/pkg/context/context.go
index d1065b58..b8e0b892 100644
--- a/internal/app/xhttp/pkg/context/context.go
+++ b/internal/app/xhttp/pkg/context/context.go
@@ -12,7 +12,6 @@ import (
"github.com/labstack/echo/v4"
"github.com/thecodingmachine/gotenberg/internal/app/xhttp/pkg/resource"
"github.com/thecodingmachine/gotenberg/internal/pkg/conf"
- "github.com/thecodingmachine/gotenberg/internal/pkg/normalize"
"github.com/thecodingmachine/gotenberg/internal/pkg/xerror"
"github.com/thecodingmachine/gotenberg/internal/pkg/xlog"
)
@@ -79,6 +78,10 @@ func (ctx *Context) WithResource(directoryName string) error {
if err != nil {
return r, err
}
+ // retrieve custom headers from request.
+ for key, value := range ctx.Request().Header {
+ r.WithCustomHTTPHeader(key, value[0])
+ }
// retrieve form values from request.
for _, key := range resource.ArgKeys() {
r.WithArg(key, ctx.FormValue(string(key)))
@@ -103,11 +106,7 @@ func (ctx *Context) WithResource(directoryName string) error {
return r, err
}
defer in.Close() // nolint: errcheck
- filename, err := normalize.String(fh.Filename)
- if err != nil {
- return r, err
- }
- if err := r.WithFile(filename, in); err != nil {
+ if err := r.WithFile(fh.Filename, in); err != nil {
return r, err
}
}
diff --git a/internal/app/xhttp/pkg/resource/arg.go b/internal/app/xhttp/pkg/resource/arg.go
index 706e8952..80063925 100644
--- a/internal/app/xhttp/pkg/resource/arg.go
+++ b/internal/app/xhttp/pkg/resource/arg.go
@@ -51,6 +51,9 @@ const (
// LandscapeArgKey is the key
// of the argument "landscape".
LandscapeArgKey ArgKey = "landscape"
+ // PageRangesArgKey is the key
+ // of the argument "pageRanges".
+ PageRangesArgKey ArgKey = "pageRanges"
// GoogleChromeRpccBufferSizeArgKey is the key
// of the argument "googleChromeRpccBufferSize".
GoogleChromeRpccBufferSizeArgKey ArgKey = "googleChromeRpccBufferSize"
@@ -76,6 +79,7 @@ func ArgKeys() []ArgKey {
MarginLeftArgKey,
MarginRightArgKey,
LandscapeArgKey,
+ PageRangesArgKey,
GoogleChromeRpccBufferSizeArgKey,
}
}
diff --git a/internal/app/xhttp/pkg/resource/arg_test.go b/internal/app/xhttp/pkg/resource/arg_test.go
index 1485c5d5..230add46 100644
--- a/internal/app/xhttp/pkg/resource/arg_test.go
+++ b/internal/app/xhttp/pkg/resource/arg_test.go
@@ -24,6 +24,7 @@ func TestArgKeys(t *testing.T) {
MarginLeftArgKey,
MarginRightArgKey,
LandscapeArgKey,
+ PageRangesArgKey,
GoogleChromeRpccBufferSizeArgKey,
}
assert.Equal(t, expected, ArgKeys())
diff --git a/internal/app/xhttp/pkg/resource/header.go b/internal/app/xhttp/pkg/resource/header.go
new file mode 100644
index 00000000..fa4c8814
--- /dev/null
+++ b/internal/app/xhttp/pkg/resource/header.go
@@ -0,0 +1,37 @@
+package resource
+
+import (
+ "strings"
+)
+
+const (
+ // RemoteURLCustomHTTPHeaderCanonicalBaseKey is the base key
+ // of custom headers send to the remote URL.
+ RemoteURLCustomHTTPHeaderCanonicalBaseKey string = "Gotenberg-Remoteurl-"
+ // WebhookURLCustomHTTPHeaderCanonicalBaseKey is the base key
+ // of custom headers send to the webhook URL.
+ WebhookURLCustomHTTPHeaderCanonicalBaseKey string = "Gotenberg-Webhookurl-"
+)
+
+func fetchCustomHTTPHeaders(r Resource, baseKey string) map[string]string {
+ customHeaders := make(map[string]string)
+ for key, value := range r.customHeaders {
+ if strings.Contains(key, baseKey) {
+ realKey := strings.Replace(key, baseKey, "", 1)
+ customHeaders[realKey] = value
+ }
+ }
+ return customHeaders
+}
+
+// RemoteURLCustomHTTPHeaders is a helper for retrieving
+// the custom headers for the URL conversion.
+func RemoteURLCustomHTTPHeaders(r Resource) map[string]string {
+ return fetchCustomHTTPHeaders(r, RemoteURLCustomHTTPHeaderCanonicalBaseKey)
+}
+
+// WebhookURLCustomHTTPHeaders is a helper for retrieving
+// the custom headers for the webhook URL.
+func WebhookURLCustomHTTPHeaders(r Resource) map[string]string {
+ return fetchCustomHTTPHeaders(r, WebhookURLCustomHTTPHeaderCanonicalBaseKey)
+}
diff --git a/internal/app/xhttp/pkg/resource/header_test.go b/internal/app/xhttp/pkg/resource/header_test.go
new file mode 100644
index 00000000..35a944f8
--- /dev/null
+++ b/internal/app/xhttp/pkg/resource/header_test.go
@@ -0,0 +1,54 @@
+package resource
+
+import (
+ "fmt"
+ "net/http"
+ "testing"
+
+ "github.com/stretchr/testify/assert"
+ "github.com/thecodingmachine/gotenberg/test"
+)
+
+func TestRemoteURLCustomHeaders(t *testing.T) {
+ const resourceDirectoryName string = "foo"
+ logger := test.DebugLogger()
+ r, err := New(logger, resourceDirectoryName)
+ assert.Nil(t, err)
+ // should find the custom header.
+ customHeaderValue := "bar"
+ customHeaderCanonicalRealKey := "Foo"
+ customHeaderCanonicalKey := http.CanonicalHeaderKey(fmt.Sprintf("%s%s", RemoteURLCustomHTTPHeaderCanonicalBaseKey, customHeaderCanonicalRealKey))
+ r.WithCustomHTTPHeader(customHeaderCanonicalKey, customHeaderValue)
+ r.WithCustomHTTPHeader("Bar", "Bar")
+ expected := map[string]string{
+ customHeaderCanonicalRealKey: customHeaderValue,
+ }
+ notExpected := map[string]string{
+ customHeaderCanonicalKey: customHeaderValue,
+ }
+ v := RemoteURLCustomHTTPHeaders(r)
+ assert.Equal(t, expected, v)
+ assert.NotEqual(t, notExpected, v)
+}
+
+func TestWebhookURLCustomHeaders(t *testing.T) {
+ const resourceDirectoryName string = "foo"
+ logger := test.DebugLogger()
+ r, err := New(logger, resourceDirectoryName)
+ assert.Nil(t, err)
+ // should find the custom header.
+ customHeaderValue := "bar"
+ customHeaderCanonicalRealKey := "Foo"
+ customHeaderCanonicalKey := http.CanonicalHeaderKey(fmt.Sprintf("%s%s", WebhookURLCustomHTTPHeaderCanonicalBaseKey, customHeaderCanonicalRealKey))
+ r.WithCustomHTTPHeader(customHeaderCanonicalKey, customHeaderValue)
+ r.WithCustomHTTPHeader("Bar", "Bar")
+ expected := map[string]string{
+ customHeaderCanonicalRealKey: customHeaderValue,
+ }
+ notExpected := map[string]string{
+ customHeaderCanonicalKey: customHeaderValue,
+ }
+ v := WebhookURLCustomHTTPHeaders(r)
+ assert.Equal(t, expected, v)
+ assert.NotEqual(t, notExpected, v)
+}
diff --git a/internal/app/xhttp/pkg/resource/resource.go b/internal/app/xhttp/pkg/resource/resource.go
index 81cf001a..3a983f18 100644
--- a/internal/app/xhttp/pkg/resource/resource.go
+++ b/internal/app/xhttp/pkg/resource/resource.go
@@ -3,9 +3,12 @@ package resource
import (
"fmt"
"io"
+ "net/http"
"os"
"path/filepath"
+ "strings"
+ "github.com/thecodingmachine/gotenberg/internal/pkg/normalize"
"github.com/thecodingmachine/gotenberg/internal/pkg/xassert"
"github.com/thecodingmachine/gotenberg/internal/pkg/xerror"
"github.com/thecodingmachine/gotenberg/internal/pkg/xlog"
@@ -21,10 +24,11 @@ const TemporaryDirectory string = "tmp"
// Resource helps managing
// arguments and files for a conversion.
type Resource struct {
- logger xlog.Logger
- dirPath string
- args map[ArgKey]string
- files map[string]file
+ logger xlog.Logger
+ dirPath string
+ customHeaders map[string]string
+ args map[ArgKey]string
+ files map[string]file
}
// New creates a Resource where its files will
@@ -48,10 +52,11 @@ func New(logger xlog.Logger, directoryName string) (Resource, error) {
}
logger.DebugfOp(op, "resource directory '%s' created", directoryName)
return Resource{
- logger: logger,
- dirPath: dirPath,
- args: make(map[ArgKey]string),
- files: make(map[string]file),
+ logger: logger,
+ dirPath: dirPath,
+ customHeaders: make(map[string]string),
+ args: make(map[ArgKey]string),
+ files: make(map[string]file),
}, nil
}
@@ -70,6 +75,21 @@ func (r Resource) Close() error {
return nil
}
+// WithCustomHTTPHeader add a new custom header to the Resource.
+// Given key should be in canonical format.
+func (r *Resource) WithCustomHTTPHeader(key string, value string) {
+ const op string = "resource.Resource.WithCustomHTTPHeader"
+ // should already be in canonical format.
+ canonicalKey := http.CanonicalHeaderKey(key)
+ if strings.Contains(canonicalKey, RemoteURLCustomHTTPHeaderCanonicalBaseKey) ||
+ strings.Contains(canonicalKey, WebhookURLCustomHTTPHeaderCanonicalBaseKey) {
+ r.customHeaders[canonicalKey] = value
+ r.logger.DebugfOp(op, "added '%s' with value '%s' to resource custom HTTP headers", canonicalKey, value)
+ return
+ }
+ r.logger.DebugfOp(op, "skipping '%s' as it is not a custom HTTP header...", canonicalKey)
+}
+
// WithArg add a new argument to the Resource.
func (r *Resource) WithArg(key ArgKey, value string) {
const op string = "resource.Resource.WithArg"
@@ -80,13 +100,24 @@ func (r *Resource) WithArg(key ArgKey, value string) {
// WithFile add a new file to the Resource.
func (r *Resource) WithFile(filename string, in io.Reader) error {
const op string = "resource.Resource.WithFile"
- fpath := fmt.Sprintf("%s/%s", r.dirPath, filename)
- file := file{fpath: fpath}
- if err := file.write(in); err != nil {
+ resolver := func() error {
+ // see https://github.com/thecodingmachine/gotenberg/issues/104.
+ normalized, err := normalize.String(filename)
+ if err != nil {
+ return err
+ }
+ fpath := fmt.Sprintf("%s/%s", r.dirPath, normalized)
+ file := file{fpath: fpath}
+ if err := file.write(in); err != nil {
+ return err
+ }
+ r.files[filename] = file
+ r.logger.DebugfOp(op, "resource file '%s' created", filename)
+ return nil
+ }
+ if err := resolver(); err != nil {
return xerror.New(op, err)
}
- r.files[filename] = file
- r.logger.DebugfOp(op, "resource file '%s' created", filename)
return nil
}
diff --git a/internal/app/xhttp/xhttp.go b/internal/app/xhttp/xhttp.go
index 7324997e..02db10e1 100644
--- a/internal/app/xhttp/xhttp.go
+++ b/internal/app/xhttp/xhttp.go
@@ -11,22 +11,21 @@ func New(config conf.Config) *echo.Echo {
srv.HideBanner = true
srv.HidePort = true
srv.Use(contextMiddleware(config))
- srv.Use(loggerMiddleware())
+ srv.Use(loggerMiddleware(config))
srv.Use(cleanupMiddleware())
srv.Use(errorMiddleware())
- srv.GET(pingEndpoint, pingHandler)
- srv.POST(mergeEndpoint, mergeHandler)
+ srv.GET(pingEndpoint(config), pingHandler)
+ srv.POST(mergeEndpoint(config), mergeHandler)
if config.DisableGoogleChrome() && config.DisableUnoconv() {
return srv
}
- g := srv.Group(convertGroupEndpoint)
if !config.DisableGoogleChrome() {
- g.POST(htmlEndpoint, htmlHandler)
- g.POST(urlEndpoint, urlHandler)
- g.POST(markdownEndpoint, markdownHandler)
+ srv.POST(htmlEndpoint(config), htmlHandler)
+ srv.POST(urlEndpoint(config), urlHandler)
+ srv.POST(markdownEndpoint(config), markdownHandler)
}
if !config.DisableUnoconv() {
- g.POST(officeEndpoint, officeHandler)
+ srv.POST(officeEndpoint(config), officeHandler)
}
return srv
}
diff --git a/internal/app/xhttp/xhttp_test.go b/internal/app/xhttp/xhttp_test.go
index 801407ec..f4fe3df0 100644
--- a/internal/app/xhttp/xhttp_test.go
+++ b/internal/app/xhttp/xhttp_test.go
@@ -1,7 +1,6 @@
package xhttp
import (
- "fmt"
"net/http"
"net/http/httptest"
"os"
@@ -28,31 +27,31 @@ func TestDisableChromeEndpoints(t *testing.T) {
assert.Nil(t, err)
srv := New(config)
// Ping endpoint should return 200.
- req := httptest.NewRequest(http.MethodGet, pingEndpoint, nil)
+ req := httptest.NewRequest(http.MethodGet, pingEndpoint(config), nil)
test.AssertStatusCode(t, http.StatusOK, srv, req)
// Merge endpoint should return 200.
body, contentType := test.MergeMultipartForm(t, nil)
- req = httptest.NewRequest(http.MethodPost, mergeEndpoint, body)
+ req = httptest.NewRequest(http.MethodPost, mergeEndpoint(config), body)
req.Header.Set(echo.HeaderContentType, contentType)
test.AssertStatusCode(t, http.StatusOK, srv, req)
// HTML endpoint should return 404.
body, contentType = test.HTMLMultipartForm(t, nil)
- req = httptest.NewRequest(http.MethodPost, fmt.Sprintf("%s%s", convertGroupEndpoint, htmlEndpoint), body)
+ req = httptest.NewRequest(http.MethodPost, htmlEndpoint(config), body)
req.Header.Set(echo.HeaderContentType, contentType)
test.AssertStatusCode(t, http.StatusNotFound, srv, req)
// URL endpoint should return 404.
body, contentType = test.URLMultipartForm(t, nil)
- req = httptest.NewRequest(http.MethodPost, fmt.Sprintf("%s%s", convertGroupEndpoint, urlEndpoint), body)
+ req = httptest.NewRequest(http.MethodPost, urlEndpoint(config), body)
req.Header.Set(echo.HeaderContentType, contentType)
test.AssertStatusCode(t, http.StatusNotFound, srv, req)
// Markdown endpoint should return 404.
body, contentType = test.MarkdownMultipartForm(t, nil)
- req = httptest.NewRequest(http.MethodPost, fmt.Sprintf("%s%s", convertGroupEndpoint, markdownEndpoint), body)
+ req = httptest.NewRequest(http.MethodPost, markdownEndpoint(config), body)
req.Header.Set(echo.HeaderContentType, contentType)
test.AssertStatusCode(t, http.StatusNotFound, srv, req)
// Office endpoint should return 200.
body, contentType = test.OfficeMultipartForm(t, nil)
- req = httptest.NewRequest(http.MethodPost, fmt.Sprintf("%s%s", convertGroupEndpoint, officeEndpoint), body)
+ req = httptest.NewRequest(http.MethodPost, officeEndpoint(config), body)
req.Header.Set(echo.HeaderContentType, contentType)
test.AssertStatusCode(t, http.StatusOK, srv, req)
// finally...
@@ -65,31 +64,31 @@ func TestDisableUnoconvEndpoints(t *testing.T) {
assert.Nil(t, err)
srv := New(config)
// Ping endpoint should return 200.
- req := httptest.NewRequest(http.MethodGet, pingEndpoint, nil)
+ req := httptest.NewRequest(http.MethodGet, pingEndpoint(config), nil)
test.AssertStatusCode(t, http.StatusOK, srv, req)
// Merge endpoint should return 200.
body, contentType := test.MergeMultipartForm(t, nil)
- req = httptest.NewRequest(http.MethodPost, mergeEndpoint, body)
+ req = httptest.NewRequest(http.MethodPost, mergeEndpoint(config), body)
req.Header.Set(echo.HeaderContentType, contentType)
test.AssertStatusCode(t, http.StatusOK, srv, req)
// HTML endpoint should return 200.
body, contentType = test.HTMLMultipartForm(t, nil)
- req = httptest.NewRequest(http.MethodPost, fmt.Sprintf("%s%s", convertGroupEndpoint, htmlEndpoint), body)
+ req = httptest.NewRequest(http.MethodPost, htmlEndpoint(config), body)
req.Header.Set(echo.HeaderContentType, contentType)
test.AssertStatusCode(t, http.StatusOK, srv, req)
// URL endpoint should return 200.
body, contentType = test.URLMultipartForm(t, nil)
- req = httptest.NewRequest(http.MethodPost, fmt.Sprintf("%s%s", convertGroupEndpoint, urlEndpoint), body)
+ req = httptest.NewRequest(http.MethodPost, urlEndpoint(config), body)
req.Header.Set(echo.HeaderContentType, contentType)
test.AssertStatusCode(t, http.StatusOK, srv, req)
// Markdown endpoint should return 200.
body, contentType = test.MarkdownMultipartForm(t, nil)
- req = httptest.NewRequest(http.MethodPost, fmt.Sprintf("%s%s", convertGroupEndpoint, markdownEndpoint), body)
+ req = httptest.NewRequest(http.MethodPost, markdownEndpoint(config), body)
req.Header.Set(echo.HeaderContentType, contentType)
test.AssertStatusCode(t, http.StatusOK, srv, req)
// Office endpoint should return 404.
body, contentType = test.OfficeMultipartForm(t, nil)
- req = httptest.NewRequest(http.MethodPost, fmt.Sprintf("%s%s", convertGroupEndpoint, officeEndpoint), body)
+ req = httptest.NewRequest(http.MethodPost, officeEndpoint(config), body)
req.Header.Set(echo.HeaderContentType, contentType)
test.AssertStatusCode(t, http.StatusNotFound, srv, req)
// finally...
@@ -102,34 +101,71 @@ func TestDisableChromeAndUnoconvEndpoints(t *testing.T) {
assert.Nil(t, err)
srv := New(config)
// Ping endpoint should return 200.
- req := httptest.NewRequest(http.MethodGet, pingEndpoint, nil)
+ req := httptest.NewRequest(http.MethodGet, pingEndpoint(config), nil)
test.AssertStatusCode(t, http.StatusOK, srv, req)
// Merge endpoint should return 200.
body, contentType := test.MergeMultipartForm(t, nil)
- req = httptest.NewRequest(http.MethodPost, mergeEndpoint, body)
+ req = httptest.NewRequest(http.MethodPost, mergeEndpoint(config), body)
req.Header.Set(echo.HeaderContentType, contentType)
test.AssertStatusCode(t, http.StatusOK, srv, req)
// HTML endpoint should return 404.
body, contentType = test.HTMLMultipartForm(t, nil)
- req = httptest.NewRequest(http.MethodPost, fmt.Sprintf("%s%s", convertGroupEndpoint, htmlEndpoint), body)
+ req = httptest.NewRequest(http.MethodPost, htmlEndpoint(config), body)
req.Header.Set(echo.HeaderContentType, contentType)
test.AssertStatusCode(t, http.StatusNotFound, srv, req)
// URL endpoint should return 404.
body, contentType = test.URLMultipartForm(t, nil)
- req = httptest.NewRequest(http.MethodPost, fmt.Sprintf("%s%s", convertGroupEndpoint, urlEndpoint), body)
+ req = httptest.NewRequest(http.MethodPost, urlEndpoint(config), body)
req.Header.Set(echo.HeaderContentType, contentType)
test.AssertStatusCode(t, http.StatusNotFound, srv, req)
// Markdown endpoint should return 404.
body, contentType = test.MarkdownMultipartForm(t, nil)
- req = httptest.NewRequest(http.MethodPost, fmt.Sprintf("%s%s", convertGroupEndpoint, markdownEndpoint), body)
+ req = httptest.NewRequest(http.MethodPost, markdownEndpoint(config), body)
req.Header.Set(echo.HeaderContentType, contentType)
test.AssertStatusCode(t, http.StatusNotFound, srv, req)
// Office endpoint should return 404.
body, contentType = test.OfficeMultipartForm(t, nil)
- req = httptest.NewRequest(http.MethodPost, fmt.Sprintf("%s%s", convertGroupEndpoint, officeEndpoint), body)
+ req = httptest.NewRequest(http.MethodPost, officeEndpoint(config), body)
req.Header.Set(echo.HeaderContentType, contentType)
test.AssertStatusCode(t, http.StatusNotFound, srv, req)
// finally...
os.Setenv(conf.DisableGoogleChromeEnvVar, "0")
os.Setenv(conf.DisableUnoconvEnvVar, "0")
}
+
+func TestCustomRootPath(t *testing.T) {
+ os.Setenv(conf.RootPathEnvVar, "/foo/")
+ config, err := conf.FromEnv()
+ assert.Nil(t, err)
+ srv := New(config)
+ // Ping endpoint should return 200.
+ req := httptest.NewRequest(http.MethodGet, pingEndpoint(config), nil)
+ test.AssertStatusCode(t, http.StatusOK, srv, req)
+ // Merge endpoint should return 200.
+ body, contentType := test.MergeMultipartForm(t, nil)
+ req = httptest.NewRequest(http.MethodPost, mergeEndpoint(config), body)
+ req.Header.Set(echo.HeaderContentType, contentType)
+ test.AssertStatusCode(t, http.StatusOK, srv, req)
+ // HTML endpoint should return 200.
+ body, contentType = test.HTMLMultipartForm(t, nil)
+ req = httptest.NewRequest(http.MethodPost, htmlEndpoint(config), body)
+ req.Header.Set(echo.HeaderContentType, contentType)
+ test.AssertStatusCode(t, http.StatusOK, srv, req)
+ // URL endpoint should return 200.
+ body, contentType = test.URLMultipartForm(t, nil)
+ req = httptest.NewRequest(http.MethodPost, urlEndpoint(config), body)
+ req.Header.Set(echo.HeaderContentType, contentType)
+ test.AssertStatusCode(t, http.StatusOK, srv, req)
+ // Markdown endpoint should return 200.
+ body, contentType = test.MarkdownMultipartForm(t, nil)
+ req = httptest.NewRequest(http.MethodPost, markdownEndpoint(config), body)
+ req.Header.Set(echo.HeaderContentType, contentType)
+ test.AssertStatusCode(t, http.StatusOK, srv, req)
+ // Office endpoint should return 200.
+ body, contentType = test.OfficeMultipartForm(t, nil)
+ req = httptest.NewRequest(http.MethodPost, officeEndpoint(config), body)
+ req.Header.Set(echo.HeaderContentType, contentType)
+ test.AssertStatusCode(t, http.StatusOK, srv, req)
+ // finally...
+ os.Setenv(conf.RootPathEnvVar, "/")
+}
diff --git a/internal/pkg/conf/conf.go b/internal/pkg/conf/conf.go
index 89100c73..45d1bce1 100644
--- a/internal/pkg/conf/conf.go
+++ b/internal/pkg/conf/conf.go
@@ -34,6 +34,9 @@ const (
// LogLevelEnvVar contains the name
// of the environment variable "LOG_LEVEL".
LogLevelEnvVar string = "LOG_LEVEL"
+ // RootPathEnvVar contains the name
+ // of the environment variable "ROOT_PATH".
+ RootPathEnvVar string = "ROOT_PATH"
// DefaultGoogleChromeRpccBufferSizeEnvVar contains the name
// of the environment variable "DEFAULT_GOOGLE_CHROME_RPCC_BUFFER_SIZE".
DefaultGoogleChromeRpccBufferSizeEnvVar string = "DEFAULT_GOOGLE_CHROME_RPCC_BUFFER_SIZE"
@@ -51,6 +54,7 @@ type Config struct {
disableGoogleChrome bool
disableUnoconv bool
logLevel xlog.Level
+ rootPath string
maximumGoogleChromeRpccBufferSize int64
defaultGoogleChromeRpccBufferSize int64
}
@@ -68,6 +72,7 @@ func DefaultConfig() Config {
disableGoogleChrome: false,
disableUnoconv: false,
logLevel: xlog.InfoLevel,
+ rootPath: "/",
maximumGoogleChromeRpccBufferSize: 104857600, // ~100 MB
defaultGoogleChromeRpccBufferSize: 1048576, // 1 MB
}
@@ -163,6 +168,16 @@ func FromEnv() (Config, error) {
if err != nil {
return c, err
}
+ rootPath, err := xassert.StringFromEnv(
+ RootPathEnvVar,
+ c.rootPath,
+ xassert.StringStartWith("/"),
+ xassert.StringEndWith("/"),
+ )
+ c.rootPath = rootPath
+ if err != nil {
+ return c, err
+ }
defaultGoogleChromeRpccBufferSize, err := xassert.Int64FromEnv(
DefaultGoogleChromeRpccBufferSizeEnvVar,
c.defaultGoogleChromeRpccBufferSize,
@@ -242,6 +257,12 @@ func (c Config) LogLevel() xlog.Level {
return c.logLevel
}
+// RootPath returns the rooth path from
+// the configuration.
+func (c Config) RootPath() string {
+ return c.rootPath
+}
+
// MaximumGoogleChromeRpccBufferSize returns the maximum
// Google Chrome rpcc buffer size from the configuration.
func (c Config) MaximumGoogleChromeRpccBufferSize() int64 {
diff --git a/internal/pkg/conf/conf_test.go b/internal/pkg/conf/conf_test.go
index 45ed01da..678ac2aa 100644
--- a/internal/pkg/conf/conf_test.go
+++ b/internal/pkg/conf/conf_test.go
@@ -320,6 +320,29 @@ func TestLogLevelFromEnv(t *testing.T) {
os.Unsetenv(LogLevelEnvVar)
}
+func TestRootPathFromEnv(t *testing.T) {
+ var (
+ expected Config
+ result Config
+ err error
+ )
+ // ROOT_PATH correctly set.
+ os.Setenv(RootPathEnvVar, "/foo/")
+ expected = DefaultConfig()
+ expected.rootPath = "/foo/"
+ result, err = FromEnv()
+ assert.Nil(t, err)
+ assert.Equal(t, expected, result)
+ os.Unsetenv(RootPathEnvVar)
+ // ROOT_PATH wrongly set.
+ os.Setenv(RootPathEnvVar, "foo")
+ expected = DefaultConfig()
+ result, err = FromEnv()
+ test.AssertError(t, err)
+ assert.Equal(t, expected, result)
+ os.Unsetenv(RootPathEnvVar)
+}
+
func TestDefaultGoogleChromeRpccBufferSizeFromEnv(t *testing.T) {
var (
expected Config
@@ -368,6 +391,7 @@ func TestGetters(t *testing.T) {
assert.Equal(t, result.disableGoogleChrome, result.DisableGoogleChrome())
assert.Equal(t, result.disableUnoconv, result.DisableUnoconv())
assert.Equal(t, result.logLevel, result.LogLevel())
+ assert.Equal(t, result.rootPath, result.RootPath())
assert.Equal(t, result.maximumGoogleChromeRpccBufferSize, result.MaximumGoogleChromeRpccBufferSize())
assert.Equal(t, result.defaultGoogleChromeRpccBufferSize, result.DefaultGoogleChromeRpccBufferSize())
}
diff --git a/internal/pkg/printer/chrome.go b/internal/pkg/printer/chrome.go
index 8f1cc473..4fe79d33 100644
--- a/internal/pkg/printer/chrome.go
+++ b/internal/pkg/printer/chrome.go
@@ -2,6 +2,7 @@ package printer
import (
"context"
+ "encoding/json"
"fmt"
"io/ioutil"
"strings"
@@ -30,18 +31,20 @@ type chromePrinter struct {
// ChromePrinterOptions helps customizing the
// Google Chrome Printer behaviour.
type ChromePrinterOptions struct {
- WaitTimeout float64
- WaitDelay float64
- HeaderHTML string
- FooterHTML string
- PaperWidth float64
- PaperHeight float64
- MarginTop float64
- MarginBottom float64
- MarginLeft float64
- MarginRight float64
- Landscape bool
- RpccBufferSize int64
+ WaitTimeout float64
+ WaitDelay float64
+ HeaderHTML string
+ FooterHTML string
+ PaperWidth float64
+ PaperHeight float64
+ MarginTop float64
+ MarginBottom float64
+ MarginLeft float64
+ MarginRight float64
+ Landscape bool
+ PageRanges string
+ RpccBufferSize int64
+ CustomHTTPHeaders map[string]string
}
// DefaultChromePrinterOptions returns the default
@@ -49,18 +52,20 @@ type ChromePrinterOptions struct {
func DefaultChromePrinterOptions(config conf.Config) ChromePrinterOptions {
const defaultHeaderFooterHTML string = ""
return ChromePrinterOptions{
- WaitTimeout: config.DefaultWaitTimeout(),
- WaitDelay: 0.0,
- HeaderHTML: defaultHeaderFooterHTML,
- FooterHTML: defaultHeaderFooterHTML,
- PaperWidth: 8.27,
- PaperHeight: 11.7,
- MarginTop: 1.0,
- MarginBottom: 1.0,
- MarginLeft: 1.0,
- MarginRight: 1.0,
- Landscape: false,
- RpccBufferSize: config.DefaultGoogleChromeRpccBufferSize(),
+ WaitTimeout: config.DefaultWaitTimeout(),
+ WaitDelay: 0.0,
+ HeaderHTML: defaultHeaderFooterHTML,
+ FooterHTML: defaultHeaderFooterHTML,
+ PaperWidth: 8.27,
+ PaperHeight: 11.7,
+ MarginTop: 1.0,
+ MarginBottom: 1.0,
+ MarginLeft: 1.0,
+ MarginRight: 1.0,
+ Landscape: false,
+ PageRanges: "",
+ RpccBufferSize: config.DefaultGoogleChromeRpccBufferSize(),
+ CustomHTTPHeaders: make(map[string]string),
}
}
@@ -144,6 +149,10 @@ func (p chromePrinter) Print(destination string) error {
if err := p.enableEvents(ctx, targetClient); err != nil {
return err
}
+ // add custom headers (if any).
+ if err := p.setCustomHTTPHeaders(ctx, targetClient); err != nil {
+ return err
+ }
// listen for all events.
if err := p.listenEvents(ctx, targetClient); err != nil {
return err
@@ -156,23 +165,35 @@ func (p chromePrinter) Print(destination string) error {
} else {
p.logger.DebugOp(op, "no wait delay to apply, moving on...")
}
+ printToPdfArgs := page.NewPrintToPDFArgs().
+ SetPaperWidth(p.opts.PaperWidth).
+ SetPaperHeight(p.opts.PaperHeight).
+ SetMarginTop(p.opts.MarginTop).
+ SetMarginBottom(p.opts.MarginBottom).
+ SetMarginLeft(p.opts.MarginLeft).
+ SetMarginRight(p.opts.MarginRight).
+ SetLandscape(p.opts.Landscape).
+ SetDisplayHeaderFooter(true).
+ SetHeaderTemplate(p.opts.HeaderHTML).
+ SetFooterTemplate(p.opts.FooterHTML).
+ SetPrintBackground(true)
+ if p.opts.PageRanges != "" {
+ printToPdfArgs.SetPageRanges(p.opts.PageRanges)
+ }
// print the page to PDF.
print, err := targetClient.Page.PrintToPDF(
ctx,
- page.NewPrintToPDFArgs().
- SetPaperWidth(p.opts.PaperWidth).
- SetPaperHeight(p.opts.PaperHeight).
- SetMarginTop(p.opts.MarginTop).
- SetMarginBottom(p.opts.MarginBottom).
- SetMarginLeft(p.opts.MarginLeft).
- SetMarginRight(p.opts.MarginRight).
- SetLandscape(p.opts.Landscape).
- SetDisplayHeaderFooter(true).
- SetHeaderTemplate(p.opts.HeaderHTML).
- SetFooterTemplate(p.opts.FooterHTML).
- SetPrintBackground(true),
+ printToPdfArgs,
)
if err != nil {
+ // find a way to check it in the handlers?
+ if strings.Contains(err.Error(), "Page range syntax error") {
+ return xerror.Invalid(
+ op,
+ fmt.Sprintf("'%s' is not a valid Google Chrome page ranges", p.opts.PageRanges),
+ err,
+ )
+ }
if strings.Contains(err.Error(), "rpcc: message too large") {
return xerror.Invalid(
op,
@@ -247,6 +268,32 @@ func (p chromePrinter) enableEvents(ctx context.Context, client *cdp.Client) err
return nil
}
+func (p chromePrinter) setCustomHTTPHeaders(ctx context.Context, client *cdp.Client) error {
+ const op string = "printer.chromePrinter.setCustomHTTPHeaders"
+ resolver := func() error {
+ if len(p.opts.CustomHTTPHeaders) == 0 {
+ p.logger.DebugOp(op, "skipping custom HTTP headers as none have been provided...")
+ return nil
+ }
+ customHTTPHeaders := make(map[string]string)
+ // useless but for the logs.
+ for key, value := range p.opts.CustomHTTPHeaders {
+ customHTTPHeaders[key] = value
+ p.logger.DebugfOp(op, "set '%s' to custom HTTP header '%s'", value, key)
+ }
+ b, err := json.Marshal(customHTTPHeaders)
+ if err != nil {
+ return err
+ }
+ // should always be called after client.Network.Enable.
+ return client.Network.SetExtraHTTPHeaders(ctx, network.NewSetExtraHTTPHeadersArgs(b))
+ }
+ if err := resolver(); err != nil {
+ return xerror.New(op, err)
+ }
+ return nil
+}
+
func (p chromePrinter) listenEvents(ctx context.Context, client *cdp.Client) error {
const op string = "printer.chromePrinter.listenEvents"
resolver := func() error {
diff --git a/internal/pkg/printer/html_test.go b/internal/pkg/printer/html_test.go
index 4a233163..e69539fa 100644
--- a/internal/pkg/printer/html_test.go
+++ b/internal/pkg/printer/html_test.go
@@ -38,6 +38,26 @@ func TestHTMLPrinter(t *testing.T) {
assert.Nil(t, err)
err = os.RemoveAll(dest)
assert.Nil(t, err)
+ // options with a page ranges.
+ opts = DefaultChromePrinterOptions(config)
+ opts.PageRanges = "1"
+ p = NewHTMLPrinter(logger, fpath, opts)
+ dest = test.GenerateDestination()
+ err = p.Print(dest)
+ assert.Nil(t, err)
+ err = os.RemoveAll(dest)
+ assert.Nil(t, err)
+ // should not be OK as options have
+ // a wrong page ranges.
+ opts = DefaultChromePrinterOptions(config)
+ opts.PageRanges = "foo"
+ p = NewHTMLPrinter(logger, fpath, opts)
+ dest = test.GenerateDestination()
+ err = p.Print(dest)
+ test.AssertError(t, err)
+ assert.Equal(t, xerror.InvalidCode, xerror.Code(err))
+ err = os.RemoveAll(dest)
+ assert.Nil(t, err)
// should not be OK as context.Context
// should timeout.
opts = DefaultChromePrinterOptions(config)
diff --git a/internal/pkg/printer/markdown_test.go b/internal/pkg/printer/markdown_test.go
index c5115a3a..9627cdea 100644
--- a/internal/pkg/printer/markdown_test.go
+++ b/internal/pkg/printer/markdown_test.go
@@ -40,6 +40,28 @@ func TestMarkdownPrinter(t *testing.T) {
assert.Nil(t, err)
err = os.RemoveAll(dest)
assert.Nil(t, err)
+ // options with a page ranges.
+ opts = DefaultChromePrinterOptions(config)
+ opts.PageRanges = "1"
+ p, err = NewMarkdownPrinter(logger, fpath, opts)
+ assert.Nil(t, err)
+ dest = test.GenerateDestination()
+ err = p.Print(dest)
+ assert.Nil(t, err)
+ err = os.RemoveAll(dest)
+ assert.Nil(t, err)
+ // should not be OK as options have
+ // a wrong page ranges.
+ opts = DefaultChromePrinterOptions(config)
+ opts.PageRanges = "foo"
+ p, err = NewMarkdownPrinter(logger, fpath, opts)
+ assert.Nil(t, err)
+ dest = test.GenerateDestination()
+ err = p.Print(dest)
+ test.AssertError(t, err)
+ assert.Equal(t, xerror.InvalidCode, xerror.Code(err))
+ err = os.RemoveAll(dest)
+ assert.Nil(t, err)
// should not be OK as context.Context
// should timeout.
opts = DefaultChromePrinterOptions(config)
diff --git a/internal/pkg/printer/office.go b/internal/pkg/printer/office.go
index 1b31d461..020e5688 100644
--- a/internal/pkg/printer/office.go
+++ b/internal/pkg/printer/office.go
@@ -6,6 +6,7 @@ import (
"os"
"path/filepath"
"sort"
+ "strings"
"github.com/phayes/freeport"
"github.com/thecodingmachine/gotenberg/internal/pkg/conf"
@@ -27,6 +28,7 @@ type officePrinter struct {
type OfficePrinterOptions struct {
WaitTimeout float64
Landscape bool
+ PageRanges string
}
// DefaultOfficePrinterOptions returns the default
@@ -35,6 +37,7 @@ func DefaultOfficePrinterOptions(config conf.Config) OfficePrinterOptions {
return OfficePrinterOptions{
WaitTimeout: config.DefaultWaitTimeout(),
Landscape: false,
+ PageRanges: "",
}
}
@@ -62,7 +65,7 @@ func (p officePrinter) Print(destination string) error {
baseFilename := xrand.Get()
tmpDest := fmt.Sprintf("%s/%d%s.pdf", dirPath, i, baseFilename)
p.logger.DebugfOp(op, "converting '%s' to PDF...", fpath)
- if err := unoconv(ctx, p.logger, fpath, tmpDest, p.opts); err != nil {
+ if err := p.unoconv(ctx, fpath, tmpDest); err != nil {
return err
}
p.logger.DebugfOp(op, "'%s.pdf' created", baseFilename)
@@ -88,7 +91,7 @@ func (p officePrinter) Print(destination string) error {
return nil
}
-func unoconv(ctx context.Context, logger xlog.Logger, fpath, destination string, opts OfficePrinterOptions) error {
+func (p officePrinter) unoconv(ctx context.Context, fpath, destination string) error {
const op string = "printer.unoconv"
resolver := func() error {
port, err := freeport.GetFreePort()
@@ -103,11 +106,25 @@ func unoconv(ctx context.Context, logger xlog.Logger, fpath, destination string,
"--format",
"pdf",
}
- if opts.Landscape {
+ if p.opts.Landscape {
args = append(args, "--printer", "PaperOrientation=landscape")
}
+ if p.opts.PageRanges != "" {
+ args = append(args, "--export", fmt.Sprintf("PageRange=%s", p.opts.PageRanges))
+ }
args = append(args, "--output", destination, fpath)
- return xexec.Run(ctx, logger, "unoconv", args...)
+ if err := xexec.Run(ctx, p.logger, "unoconv", args...); err != nil {
+ // find a way to check it in the handlers?
+ if p.opts.PageRanges != "" && strings.Contains(err.Error(), "exit status 5") {
+ return xerror.Invalid(
+ op,
+ fmt.Sprintf("'%s' is not a valid LibreOffice page ranges", p.opts.PageRanges),
+ err,
+ )
+ }
+ return err
+ }
+ return nil
}
if err := resolver(); err != nil {
return xerror.New(op, err)
diff --git a/internal/pkg/printer/office_test.go b/internal/pkg/printer/office_test.go
index b6a0235b..5eb8992e 100644
--- a/internal/pkg/printer/office_test.go
+++ b/internal/pkg/printer/office_test.go
@@ -46,6 +46,26 @@ func TestOfficePrinter(t *testing.T) {
assert.Nil(t, err)
err = os.RemoveAll(dest)
assert.Nil(t, err)
+ // options with page ranges.
+ opts = DefaultOfficePrinterOptions(config)
+ opts.PageRanges = "1-1"
+ p = NewOfficePrinter(logger, []string{fpaths[0]}, opts)
+ dest = test.GenerateDestination()
+ err = p.Print(dest)
+ assert.Nil(t, err)
+ err = os.RemoveAll(dest)
+ assert.Nil(t, err)
+ // should not be OK as options have
+ // a wrong page ranges.
+ opts = DefaultOfficePrinterOptions(config)
+ opts.PageRanges = "foo"
+ p = NewOfficePrinter(logger, []string{fpaths[0]}, opts)
+ dest = test.GenerateDestination()
+ err = p.Print(dest)
+ test.AssertError(t, err)
+ assert.Equal(t, xerror.InvalidCode, xerror.Code(err))
+ err = os.RemoveAll(dest)
+ assert.Nil(t, err)
// should not be OK as context.Context
// should timeout.
opts = DefaultOfficePrinterOptions(config)
diff --git a/internal/pkg/printer/url_test.go b/internal/pkg/printer/url_test.go
index 2c0b99f7..ef477e75 100644
--- a/internal/pkg/printer/url_test.go
+++ b/internal/pkg/printer/url_test.go
@@ -38,6 +38,26 @@ func TestURLPrinter(t *testing.T) {
assert.Nil(t, err)
err = os.RemoveAll(dest)
assert.Nil(t, err)
+ // options with a pages ranges.
+ opts = DefaultChromePrinterOptions(config)
+ opts.PageRanges = "1"
+ p = NewURLPrinter(logger, URL, opts)
+ dest = test.GenerateDestination()
+ err = p.Print(dest)
+ assert.Nil(t, err)
+ err = os.RemoveAll(dest)
+ assert.Nil(t, err)
+ // should not be OK as options have
+ // a wrong page ranges.
+ opts = DefaultChromePrinterOptions(config)
+ opts.PageRanges = "foo"
+ p = NewURLPrinter(logger, URL, opts)
+ dest = test.GenerateDestination()
+ err = p.Print(dest)
+ test.AssertError(t, err)
+ assert.Equal(t, xerror.InvalidCode, xerror.Code(err))
+ err = os.RemoveAll(dest)
+ assert.Nil(t, err)
// should not be OK as context.Context
// should timeout.
opts = DefaultChromePrinterOptions(config)
diff --git a/internal/pkg/xassert/string.go b/internal/pkg/xassert/string.go
index 540eee9b..d59bea8a 100644
--- a/internal/pkg/xassert/string.go
+++ b/internal/pkg/xassert/string.go
@@ -2,6 +2,7 @@ package xassert
import (
"fmt"
+ "strings"
"github.com/thecodingmachine/gotenberg/internal/pkg/xerror"
)
@@ -54,7 +55,67 @@ func StringOneOf(values []string) RuleString {
}
}
+type ruleStringStartWith struct {
+ *baseRuleString
+ startWith string
+}
+
+func (r ruleStringStartWith) validate() error {
+ const op string = "xassert.ruleStringStartWith.validate"
+ if strings.HasPrefix(r.value, r.startWith) {
+ return nil
+ }
+ return xerror.Invalid(
+ op,
+ fmt.Sprintf("'%s' should start with '%s', got '%s'", r.key, r.startWith, r.value),
+ nil,
+ )
+}
+
+/*
+StringStartWith returns a RuleString for
+validating that a string starts with
+given string.
+*/
+func StringStartWith(startWith string) RuleString {
+ return ruleStringStartWith{
+ &baseRuleString{},
+ startWith,
+ }
+}
+
+type ruleStringEndWith struct {
+ *baseRuleString
+ endWith string
+}
+
+func (r ruleStringEndWith) validate() error {
+ const op string = "xassert.ruleStringEndWith.validate"
+ if strings.HasSuffix(r.value, r.endWith) {
+ return nil
+ }
+ return xerror.Invalid(
+ op,
+ fmt.Sprintf("'%s' should end with '%s', got '%s'", r.key, r.endWith, r.value),
+ nil,
+ )
+}
+
+/*
+StringEndWith returns a RuleString for
+validating that a string ends with
+given string.
+*/
+func StringEndWith(endWith string) RuleString {
+ return ruleStringEndWith{
+ &baseRuleString{},
+ endWith,
+ }
+}
+
// Compile-time checks to ensure type implements desired interfaces.
var (
_ = RuleString(new(ruleStringOneOf))
+ _ = RuleString(new(ruleStringStartWith))
+ _ = RuleString(new(ruleStringEndWith))
)
diff --git a/internal/pkg/xassert/string_test.go b/internal/pkg/xassert/string_test.go
index 87ad8065..fb1c0d4e 100644
--- a/internal/pkg/xassert/string_test.go
+++ b/internal/pkg/xassert/string_test.go
@@ -18,3 +18,27 @@ func TestStringOfOne(t *testing.T) {
err = rule.validate()
test.AssertError(t, err)
}
+
+func TestStringStartWith(t *testing.T) {
+ rule := StringStartWith("foo")
+ // should be OK.
+ rule.with("FOO", "foobarfoo")
+ err := rule.validate()
+ assert.Nil(t, err)
+ // should not be OK.
+ rule.with("FOO", "qux")
+ err = rule.validate()
+ test.AssertError(t, err)
+}
+
+func TestStringEndWith(t *testing.T) {
+ rule := StringEndWith("foo")
+ // should be OK.
+ rule.with("FOO", "foobarfoo")
+ err := rule.validate()
+ assert.Nil(t, err)
+ // should not be OK.
+ rule.with("FOO", "qux")
+ err = rule.validate()
+ test.AssertError(t, err)
+}
diff --git a/scripts/publish.sh b/scripts/publish.sh
index 009fce2d..74e0073d 100755
--- a/scripts/publish.sh
+++ b/scripts/publish.sh
@@ -4,7 +4,7 @@ set -e
GOLANG_VERSION="$1"
TINI_VERSION="$2"
-DOCKER_REPOSITORY="$3"
+DOCKER_REGISTRY="$3"
VERSION="$4"
DOCKER_USER="$5"
DOCKER_PASSWORD="$6"
@@ -23,13 +23,13 @@ fi
docker build \
--build-arg VERSION=${VERSION} \
--build-arg TINI_VERSION=${TINI_VERSION} \
- -t ${DOCKER_REPOSITORY}/gotenberg:latest \
- -t ${DOCKER_REPOSITORY}/gotenberg:${SEMVER[0]} \
- -t ${DOCKER_REPOSITORY}/gotenberg:${SEMVER[0]}.${SEMVER[1]} \
- -t ${DOCKER_REPOSITORY}/gotenberg:${SEMVER[0]}.${SEMVER[1]}.${SEMVER[2]} \
+ -t ${DOCKER_REGISTRY}/gotenberg:latest \
+ -t ${DOCKER_REGISTRY}/gotenberg:${SEMVER[0]} \
+ -t ${DOCKER_REGISTRY}/gotenberg:${SEMVER[0]}.${SEMVER[1]} \
+ -t ${DOCKER_REGISTRY}/gotenberg:${SEMVER[0]}.${SEMVER[1]}.${SEMVER[2]} \
-f build/package/Dockerfile .
-docker push "${DOCKER_REPOSITORY}/gotenberg:latest"
-docker push "${DOCKER_REPOSITORY}/gotenberg:${SEMVER[0]}"
-docker push "${DOCKER_REPOSITORY}/gotenberg:${SEMVER[0]}.${SEMVER[1]}"
-docker push "${DOCKER_REPOSITORY}/gotenberg:${SEMVER[0]}.${SEMVER[1]}.${SEMVER[2]}"
\ No newline at end of file
+docker push "${DOCKER_REGISTRY}/gotenberg:latest"
+docker push "${DOCKER_REGISTRY}/gotenberg:${SEMVER[0]}"
+docker push "${DOCKER_REGISTRY}/gotenberg:${SEMVER[0]}.${SEMVER[1]}"
+docker push "${DOCKER_REGISTRY}/gotenberg:${SEMVER[0]}.${SEMVER[1]}.${SEMVER[2]}"
\ No newline at end of file
diff --git a/scripts/tests.sh b/scripts/tests.sh
index 3824cc6d..814d50f0 100755
--- a/scripts/tests.sh
+++ b/scripts/tests.sh
@@ -2,15 +2,15 @@
set -e
-DOCKER_REPOSITORY="$1"
+DOCKER_REGISTRY="$1"
CODE_COVERAGE="$2"
touch "$PWD/coverage.txt"
chmod 777 "$PWD/coverage.txt"
-docker build -t "$DOCKER_REPOSITORY/gotenberg:tests" -f build/tests/Dockerfile .
+docker build -t "$DOCKER_REGISTRY/gotenberg:tests" -f build/tests/Dockerfile .
if [ "$CODE_COVERAGE" = "1" ]; then
- docker run --rm -e "CODE_COVERAGE=$CODE_COVERAGE" -v "$PWD/coverage.txt:/gotenberg/tests/coverage.txt" "$DOCKER_REPOSITORY/gotenberg:tests"
+ docker run --rm -e "CODE_COVERAGE=$CODE_COVERAGE" -v "$PWD/coverage.txt:/gotenberg/tests/coverage.txt" "$DOCKER_REGISTRY/gotenberg:tests"
else
- docker run --rm -e "CODE_COVERAGE=$CODE_COVERAGE" "$DOCKER_REPOSITORY/gotenberg:tests"
+ docker run --rm -e "CODE_COVERAGE=$CODE_COVERAGE" "$DOCKER_REGISTRY/gotenberg:tests"
fi
\ No newline at end of file
diff --git a/test/multipartform.go b/test/multipartform.go
index 0bc73508..00e8e552 100644
--- a/test/multipartform.go
+++ b/test/multipartform.go
@@ -79,7 +79,7 @@ func multipartForm(
require.Nil(t, err)
}
if kind == "url" {
- err := writer.WriteField("remoteURL", "http://google.com")
+ err := writer.WriteField("remoteURL", "https://google.com")
require.Nil(t, err)
}
for k, v := range formValues {
diff --git a/test/testdata.go b/test/testdata.go
index e40ab818..fc72472b 100644
--- a/test/testdata.go
+++ b/test/testdata.go
@@ -75,6 +75,7 @@ func OfficeFpaths(t *testing.T) []string {
fpath(t, "office", "document.docx"),
fpath(t, "office", "document.rtf"),
fpath(t, "office", "document.txt"),
+ fpath(t, "office", "document_with_special_éà.txt"),
}
}
diff --git a/test/testdata/office/document_with_special_éà.txt b/test/testdata/office/document_with_special_éà.txt
new file mode 100644
index 00000000..16eab9d7
--- /dev/null
+++ b/test/testdata/office/document_with_special_éà.txt
@@ -0,0 +1,3 @@
+Gutenberg
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
\ No newline at end of file