v3.0.0 (#18)

internal/app/api/api.go

@@ -0,0 +1,125 @@
+package api
+
+import (
+	"context"
+	"fmt"
+	"net/http"
+	"os"
+	"os/signal"
+	"time"
+
+	"github.com/labstack/echo"
+	"github.com/labstack/echo/middleware"
+	"github.com/thecodingmachine/gotenberg/internal/pkg/notify"
+	"github.com/thecodingmachine/gotenberg/internal/pkg/pm2"
+	"github.com/thecodingmachine/gotenberg/internal/pkg/printer"
+	"github.com/thecodingmachine/gotenberg/internal/pkg/rand"
+)
+
+// Start starts the API server on port 3000.
+func Start() error {
+	e := setup()
+	// start Chrome headless and
+	// unoconv listener with PM2.
+	chrome := &pm2.Chrome{}
+	unoconv := &pm2.Unoconv{}
+	if err := chrome.Launch(); err != nil {
+		return err
+	}
+	if err := unoconv.Launch(); err != nil {
+		return err
+	}
+	// run our API in a goroutine so that it doesn't block.
+	go func() {
+		notify.Println("http server started on port 3000")
+		if err := e.Start(":3000"); err != nil {
+			e.Logger.Fatalf("%v", err)
+			os.Exit(1)
+		}
+	}()
+	quit := make(chan os.Signal, 1)
+	// we'll accept graceful shutdowns when quit via SIGINT (Ctrl+C)
+	// SIGKILL, SIGQUIT or SIGTERM (Ctrl+/) will not be caught.
+	signal.Notify(quit, os.Interrupt)
+	// block until we receive our signal.
+	<-quit
+	// create a deadline to wait for.
+	ctx, cancel := context.WithTimeout(context.Background(), 120*time.Second)
+	defer cancel()
+	// doesn't block if no connections, but will otherwise wait
+	// until the timeout deadline.
+	notify.Println("shutting down http server... (Ctrl+C to force)")
+	return e.Shutdown(ctx)
+}
+
+func setup() *echo.Echo {
+	e := echo.New()
+	e.HideBanner = true
+	e.HidePort = true
+	e.Use(middleware.Logger())
+	e.Use(func(next echo.HandlerFunc) echo.HandlerFunc {
+		return func(c echo.Context) error {
+			if err := next(c); err != nil {
+				// TODO should return a better HTTP status code
+				// than 500 for some cases.
+				return echo.NewHTTPError(http.StatusInternalServerError, fmt.Sprintf("%v", err))
+			}
+			return nil
+		}
+	})
+	e.POST("/merge", merge)
+	g := e.Group("/convert")
+	g.POST("/html", convertHTML)
+	g.POST("/markdown", convertMarkdown)
+	g.POST("/office", convertOffice)
+	return e
+}
+
+func newContext(r *resource) (context.Context, context.CancelFunc) {
+	webhookURL := r.webhookURL()
+	if webhookURL == "" {
+		ctx, cancel := context.WithTimeout(context.Background(), 120*time.Second)
+		return ctx, cancel
+	}
+	return context.Background(), nil
+}
+
+func print(c echo.Context, p printer.Printer, r *resource) error {
+	baseFilename, err := rand.Get()
+	if err != nil {
+		return fmt.Errorf("getting result file name: %v", err)
+	}
+	filename := fmt.Sprintf("%s.pdf", baseFilename)
+	fpath := fmt.Sprintf("%s/%s", r.dirPath, filename)
+	if r.webhookURL() == "" {
+		// if no webhook URL given, run conversion
+		// and directly return the resulting PDF file
+		// or and error.
+		if err := p.Print(fpath); err != nil {
+			return err
+		}
+		return c.Attachment(fpath, filename)
+	}
+	// as a webhook URL has been given, we
+	// run the following lines in a goroutine so that
+	// it doesn't block.
+	go func() {
+		if err := p.Print(fpath); err != nil {
+			c.Logger().Errorf("%v", err)
+			return
+		}
+		f, err := os.Open(fpath)
+		if err != nil {
+			c.Logger().Errorf("%v", err)
+			return
+		}
+		defer f.Close()
+		resp, err := http.Post(r.webhookURL(), "application/pdf", f)
+		if err != nil {
+			c.Logger().Errorf("%v", err)
+			return
+		}
+		defer resp.Body.Close()
+	}()
+	return nil
+}

internal/app/api/doc.go

@@ -0,0 +1,9 @@
+/*
+Package api starts a HTTP server on port 3000.
+
+It accepts POST requests with a multipart/form-data Content-Type
+for converting HTML, Markdown and Office documents to PDF.
+
+It is also able to merge a list of PDF files.
+*/
+package api

internal/app/api/html.go

@@ -0,0 +1,52 @@
+package api
+
+import (
+	"github.com/labstack/echo"
+	"github.com/thecodingmachine/gotenberg/internal/pkg/printer"
+)
+
+func convertHTML(c echo.Context) error {
+	r, err := newResource(c)
+	if err != nil {
+		return err
+	}
+	defer r.removeAll()
+	ctx, cancel := newContext(r)
+	if cancel != nil {
+		defer cancel()
+	}
+	p := &printer.HTML{Context: ctx}
+	indexPath, err := r.filePath("index.html")
+	if err != nil {
+		return err
+	}
+	p.WithLocalURL(indexPath)
+	headerPath, _ := r.filePath("header.html")
+	if err := p.WithHeaderFile(headerPath); err != nil {
+		return err
+	}
+	footerPath, _ := r.filePath("footer.html")
+	if err := p.WithFooterFile(footerPath); err != nil {
+		return err
+	}
+	paperSize, err := r.paperSize()
+	if err != nil {
+		return err
+	}
+	p.PaperWidth = paperSize[0]
+	p.PaperHeight = paperSize[1]
+	paperMargins, err := r.paperMargins()
+	if err != nil {
+		return err
+	}
+	p.MarginTop = paperMargins[0]
+	p.MarginBottom = paperMargins[1]
+	p.MarginLeft = paperMargins[2]
+	p.MarginRight = paperMargins[3]
+	landscape, err := r.landscape()
+	if err != nil {
+		return err
+	}
+	p.Landscape = landscape
+	return print(c, p, r)
+}

internal/app/api/html_test.go

@@ -0,0 +1,21 @@
+package api
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/labstack/echo"
+	"github.com/stretchr/testify/assert"
+	"github.com/thecodingmachine/gotenberg/test"
+)
+
+func TestHTML(t *testing.T) {
+	body, contentType := test.HTMLMultipartForm(t)
+	req := httptest.NewRequest(http.MethodPost, "/convert/html", body)
+	req.Header.Set(echo.HeaderContentType, contentType)
+	rec := httptest.NewRecorder()
+	e := echo.New()
+	c := e.NewContext(req, rec)
+	assert.NoError(t, convertHTML(c))
+}

internal/app/api/markdown.go

@@ -0,0 +1,51 @@
+package api
+
+import (
+	"github.com/labstack/echo"
+	"github.com/thecodingmachine/gotenberg/internal/pkg/printer"
+)
+
+func convertMarkdown(c echo.Context) error {
+	r, err := newResource(c)
+	if err != nil {
+		return err
+	}
+	defer r.removeAll()
+	ctx, cancel := newContext(r)
+	if cancel != nil {
+		defer cancel()
+	}
+	indexPath, err := r.filePath("index.html")
+	if err != nil {
+		return err
+	}
+	p := &printer.Markdown{Context: ctx, TemplatePath: indexPath}
+	headerPath, _ := r.filePath("header.html")
+	if err := p.WithHeaderFile(headerPath); err != nil {
+		return err
+	}
+	footerPath, _ := r.filePath("footer.html")
+	if err := p.WithFooterFile(footerPath); err != nil {
+		return err
+	}
+	paperSize, err := r.paperSize()
+	if err != nil {
+		return err
+	}
+	p.PaperWidth = paperSize[0]
+	p.PaperHeight = paperSize[1]
+	paperMargins, err := r.paperMargins()
+	if err != nil {
+		return err
+	}
+	p.MarginTop = paperMargins[0]
+	p.MarginBottom = paperMargins[1]
+	p.MarginLeft = paperMargins[2]
+	p.MarginRight = paperMargins[3]
+	landscape, err := r.landscape()
+	if err != nil {
+		return err
+	}
+	p.Landscape = landscape
+	return print(c, p, r)
+}

internal/app/api/markdown_test.go

@@ -0,0 +1,21 @@
+package api
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/labstack/echo"
+	"github.com/stretchr/testify/assert"
+	"github.com/thecodingmachine/gotenberg/test"
+)
+
+func TestMarkdown(t *testing.T) {
+	body, contentType := test.MarkdownMultipartForm(t)
+	req := httptest.NewRequest(http.MethodPost, "/convert/markdown", body)
+	req.Header.Set(echo.HeaderContentType, contentType)
+	rec := httptest.NewRecorder()
+	e := echo.New()
+	c := e.NewContext(req, rec)
+	assert.NoError(t, convertMarkdown(c))
+}

internal/app/api/merge.go

@@ -0,0 +1,57 @@
+package api
+
+import (
+	"fmt"
+	"net/http"
+	"os"
+
+	"github.com/labstack/echo"
+	"github.com/thecodingmachine/gotenberg/internal/pkg/printer"
+	"github.com/thecodingmachine/gotenberg/internal/pkg/rand"
+)
+
+func merge(c echo.Context) error {
+	r, err := newResource(c)
+	if err != nil {
+		return err
+	}
+	defer r.removeAll()
+	fpaths, err := r.filePaths([]string{".pdf"})
+	if err != nil {
+		return err
+	}
+	baseFilename, err := rand.Get()
+	if err != nil {
+		return fmt.Errorf("getting result file name: %v", err)
+	}
+	filename := fmt.Sprintf("%s.pdf", baseFilename)
+	dest := fmt.Sprintf("%s/%s", r.dirPath, filename)
+	if r.webhookURL() == "" {
+		// if no webhook URL given, run merge
+		// and directly return the resulting PDF file
+		// or and error.
+		return printer.Merge(fpaths, dest)
+	}
+	// as a webhook URL has been given, we
+	// run the following lines in a goroutine so that
+	// it doesn't block.
+	go func() {
+		if err := printer.Merge(fpaths, dest); err != nil {
+			c.Logger().Errorf("%v", err)
+			return
+		}
+		f, err := os.Open(dest)
+		if err != nil {
+			c.Logger().Errorf("%v", err)
+			return
+		}
+		defer f.Close()
+		resp, err := http.Post(r.webhookURL(), "application/pdf", f)
+		if err != nil {
+			c.Logger().Errorf("%v", err)
+			return
+		}
+		defer resp.Body.Close()
+	}()
+	return nil
+}

internal/app/api/merge_test.go

@@ -0,0 +1,21 @@
+package api
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/labstack/echo"
+	"github.com/stretchr/testify/assert"
+	"github.com/thecodingmachine/gotenberg/test"
+)
+
+func TestMerge(t *testing.T) {
+	body, contentType := test.PDFMultipartForm(t)
+	req := httptest.NewRequest(http.MethodPost, "/merge", body)
+	req.Header.Set(echo.HeaderContentType, contentType)
+	rec := httptest.NewRecorder()
+	e := echo.New()
+	c := e.NewContext(req, rec)
+	assert.NoError(t, merge(c))
+}

internal/app/api/office.go

@@ -0,0 +1,41 @@
+package api
+
+import (
+	"errors"
+
+	"github.com/labstack/echo"
+	"github.com/thecodingmachine/gotenberg/internal/pkg/printer"
+)
+
+var officeExts = []string{
+	".doc",
+	".docx",
+	".odt",
+	".xls",
+	".xlsx",
+	".ods",
+	".ppt",
+	".pptx",
+	".odp",
+}
+
+func convertOffice(c echo.Context) error {
+	r, err := newResource(c)
+	if err != nil {
+		return err
+	}
+	defer r.removeAll()
+	ctx, cancel := newContext(r)
+	if cancel != nil {
+		defer cancel()
+	}
+	fpaths, err := r.filePaths(officeExts)
+	if err != nil {
+		return err
+	}
+	if len(fpaths) == 0 {
+		return errors.New("no suitable office documents to convert")
+	}
+	p := &printer.Office{Context: ctx, FilePaths: fpaths}
+	return print(c, p, r)
+}

internal/app/api/office_test.go

@@ -0,0 +1,21 @@
+package api
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/labstack/echo"
+	"github.com/stretchr/testify/assert"
+	"github.com/thecodingmachine/gotenberg/test"
+)
+
+func TestOffice(t *testing.T) {
+	body, contentType := test.OfficeMultipartForm(t)
+	req := httptest.NewRequest(http.MethodPost, "/convert/office", body)
+	req.Header.Set(echo.HeaderContentType, contentType)
+	rec := httptest.NewRecorder()
+	e := echo.New()
+	c := e.NewContext(req, rec)
+	assert.NoError(t, convertOffice(c))
+}

internal/app/api/resource.go

@@ -0,0 +1,184 @@
+package api
+
+import (
+	"fmt"
+	"io"
+	"os"
+	"path/filepath"
+	"strconv"
+
+	"github.com/labstack/echo"
+	"github.com/thecodingmachine/gotenberg/internal/pkg/rand"
+)
+
+const (
+	webhookURL   string = "webhookURL"
+	paperWidth   string = "paperWidth"
+	paperHeight  string = "paperHeight"
+	marginTop    string = "marginTop"
+	marginBottom string = "marginBottom"
+	marginLeft   string = "marginLeft"
+	marginRight  string = "marginRight"
+	landscape    string = "landscape"
+)
+
+// resource facilitates storing and accessing
+// data from a multipart/form-data request.
+type resource struct {
+	values  map[string]string
+	dirPath string
+}
+
+func newResource(c echo.Context) (*resource, error) {
+	v := make(map[string]string)
+	v[webhookURL] = c.FormValue(webhookURL)
+	v[paperWidth] = c.FormValue(paperWidth)
+	v[paperHeight] = c.FormValue(paperHeight)
+	v[marginTop] = c.FormValue(marginTop)
+	v[marginBottom] = c.FormValue(marginBottom)
+	v[marginLeft] = c.FormValue(marginLeft)
+	v[marginRight] = c.FormValue(marginRight)
+	v[landscape] = c.FormValue(landscape)
+	dirPath, err := rand.Get()
+	if err != nil {
+		return nil, err
+	}
+	if err := os.MkdirAll(dirPath, 0755); err != nil {
+		return nil, fmt.Errorf("%s: making directory: %v", dirPath, err)
+	}
+	r := &resource{values: v, dirPath: dirPath}
+	form, err := c.MultipartForm()
+	if err != nil {
+		return nil, fmt.Errorf("getting multipart form: %v", err)
+	}
+	for _, files := range form.File {
+		for _, fh := range files {
+			in, err := fh.Open()
+			if err != nil {
+				return nil, fmt.Errorf("%s: opening file: %v", fh.Filename, err)
+			}
+			defer in.Close()
+			if err := r.writeFile(fh.Filename, in); err != nil {
+				return nil, err
+			}
+		}
+	}
+	return r, nil
+}
+
+func (r *resource) writeFile(filename string, in io.Reader) error {
+	fpath := fmt.Sprintf("%s/%s", r.dirPath, filename)
+	out, err := os.Create(fpath)
+	if err != nil {
+		return fmt.Errorf("%s: creating new file: %v", fpath, err)
+	}
+	defer out.Close()
+	if err := out.Chmod(0644); err != nil {
+		return fmt.Errorf("%s: changing file mode: %v", fpath, err)
+	}
+	if _, err := io.Copy(out, in); err != nil {
+		return fmt.Errorf("%s: writing file: %v", fpath, err)
+	}
+	if _, err := out.Seek(0, 0); err != nil {
+		return fmt.Errorf("%s: resetting read pointer: %v", fpath, err)
+	}
+	return nil
+}
+
+func (r *resource) filePath(filename string) (string, error) {
+	fpath := fmt.Sprintf("%s/%s", r.dirPath, filename)
+	_, err := os.Stat(fpath)
+	if os.IsNotExist(err) {
+		return "", fmt.Errorf("%s: file does not exist", filename)
+	}
+	absPath, err := filepath.Abs(fpath)
+	if err != nil {
+		return "", fmt.Errorf("%s: getting absolute path: %v", fpath, err)
+	}
+	return absPath, nil
+}
+
+func (r *resource) filePaths(exts []string) ([]string, error) {
+	var fpaths []string
+	err := filepath.Walk(r.dirPath, func(path string, info os.FileInfo, _ error) error {
+		if info.IsDir() {
+			return nil
+		}
+		fpath, err := r.filePath(info.Name())
+		if err != nil {
+			return err
+		}
+		for _, ext := range exts {
+			if filepath.Ext(fpath) == ext {
+				fpaths = append(fpaths, fpath)
+				return nil
+			}
+		}
+		return nil
+	})
+	if err != nil {
+		return nil, err
+	}
+	return fpaths, nil
+}
+
+func (r *resource) paperSize() ([2]float64, error) {
+	defaultSize := [2]float64{8.27, 11.7}
+	widthStr := r.values[paperWidth]
+	heightStr := r.values[paperHeight]
+	if widthStr == "" || heightStr == "" {
+		return defaultSize, nil
+	}
+	width, err := strconv.ParseFloat(widthStr, 64)
+	if err != nil {
+		return defaultSize, fmt.Errorf("paper width: %v", err)
+	}
+	height, err := strconv.ParseFloat(heightStr, 64)
+	if err != nil {
+		return defaultSize, fmt.Errorf("paper height: %v", err)
+	}
+	return [2]float64{width, height}, nil
+}
+
+func (r *resource) paperMargins() ([4]float64, error) {
+	defaultMargins := [4]float64{1, 1, 1, 1}
+	topStr := r.values[marginTop]
+	bottomStr := r.values[marginBottom]
+	leftStr := r.values[marginLeft]
+	rightStr := r.values[marginRight]
+	if topStr == "" || bottomStr == "" || leftStr == "" || rightStr == "" {
+		return defaultMargins, nil
+	}
+	top, err := strconv.ParseFloat(topStr, 64)
+	if err != nil {
+		return defaultMargins, fmt.Errorf("margin top: %v", err)
+	}
+	bottom, err := strconv.ParseFloat(bottomStr, 64)
+	if err != nil {
+		return defaultMargins, fmt.Errorf("margin bottom: %v", err)
+	}
+	left, err := strconv.ParseFloat(leftStr, 64)
+	if err != nil {
+		return defaultMargins, fmt.Errorf("margin left: %v", err)
+	}
+	right, err := strconv.ParseFloat(rightStr, 64)
+	if err != nil {
+		return defaultMargins, fmt.Errorf("margin right: %v", err)
+	}
+	return [4]float64{top, bottom, left, right}, nil
+}
+
+func (r *resource) landscape() (bool, error) {
+	landscapeStr := r.values[landscape]
+	if landscapeStr == "" {
+		return false, nil
+	}
+	landscape, err := strconv.ParseBool(landscapeStr)
+	if err != nil {
+		return false, fmt.Errorf("landscape: %v", err)
+	}
+	return landscape, nil
+}
+
+func (r *resource) webhookURL() string { return r.values[webhookURL] }
+func (r *resource) removeAll() error   { return os.RemoveAll(r.dirPath) }