support wating time for html convert to pdf or image

Author: Nick

CHANGELOG.md

@@ -1,3 +1,6 @@
+### v0.3.0
+- support waiting time for html convert to pdf
+- support waiting time for html convert to image
 ### v0.2.0
 - add pprof
 - add chinese readme doc

Makefile

@@ -1,8 +1,8 @@
 .DEFAULT: help
 
 IMAGE_NAME ?= lampnick/doctron
-CENTOS_IMAGE_TAG ?= v0.2.0-centos
-ALPINE_IMAGE_TAG ?= v0.2.0-alpine
+CENTOS_IMAGE_TAG ?= v0.3.0-centos
+ALPINE_IMAGE_TAG ?= v0.3.0-alpine
 
 help: Makefile
 	@echo "Doctron is a document convert tools for html pdf image etc.\r\n"

README.md

@@ -99,6 +99,7 @@ http://127.0.0.1:8080/convert/html2pdf?u=doctron&p=lampnick&url=<url>&marginTop=
 - marginRight // Right margin in inches. core.Defaults to 1cm (~0.4 inches).
 - pageRanges // Paper ranges to print, e.g., '1-5, 8, 11-13'. core.Defaults to the empty string, which means print all pages.
 - ignoreInvalidPageRanges // Whether to silently ignore invalid but successfully parsed page ranges, such as '3-2'. core.Defaults to false.
+- WaitingTime // Waiting time after the page loaded. Default 0 means not wait. unit:Millisecond
 
 ### Html convert to image
 ###### basic
@@ -121,6 +122,7 @@ http://127.0.0.1:8080/convert/html2image?u=doctron&p=lampnick&url=<url>&customCl
 - clipY // Capture the screenshot of a given region only.Y offset in device independent pixels (dip).
 - clipWidth // Capture the screenshot of a given region only.Rectangle width in device independent pixels (dip).
 - clipHeight // Capture the screenshot of a given region only.Rectangle height in device independent pixels (dip).
+WaitingTime // Waiting time after the page loaded. Default 0 means not wait. unit:Millisecond
 
 ### Pdf add watermark
 ###### add image watermark

README_ZH.md

@@ -100,6 +100,7 @@ http://127.0.0.1:8080/convert/html2pdf?u=doctron&p=lampnick&url=<url>&marginTop=
 - marginRight // 右外边距，单位英尺。默认纸0.4英尺（1厘米）. 
 - pageRanges // 需要打印的PDF的页数。默认为空字符串，表示所有页面.
 - ignoreInvalidPageRanges // 是否静默的忽略掉不可用的但是成功解析的页面。例如'3-2',默认false.
+- WaitingTime // 页面加载后等待时长. 默认为0代表不等待. 单位：毫秒
 
 ### Html转图片
 ###### 基础转换
@@ -122,6 +123,7 @@ http://127.0.0.1:8080/convert/html2image?u=doctron&p=lampnick&url=<url>&customCl
 - clipY // 裁剪Y轴方向距离.
 - clipWidth // 裁剪宽度.
 - clipHeight // 裁剪高度.
+- WaitingTime // 页面加载后等待时长. 默认为0代表不等待. 单位：毫秒
 
 ### Pdf加水印
 ###### 添加图片水印

common/const.go

@@ -1,4 +1,4 @@
 package common
 
 //Version Version
-const Version = "0.2.0"
+const Version = "0.3.0"

controller/html2image_controller.go

@@ -3,6 +3,8 @@ package controller
 import (
 	"context"
 	"errors"
+	"time"
+
 	"github.com/gorilla/schema"
 	uuid "github.com/iris-contrib/go.uuid"
 	"github.com/kataras/iris/v12"
@@ -13,7 +15,6 @@ import (
 	"github.com/lampnick/doctron/converter/doctron_core"
 	"github.com/lampnick/doctron/worker"
 	"gopkg.in/go-playground/validator.v9"
-	"time"
 )
 
 func Html2ImageHandler(ctx iris.Context) {
@@ -100,6 +101,7 @@ func convertToHtml2ImageParams(requestDTO *Html2ImageRequestDTO) doctron_core.Ht
 	params.Clip.Height = requestDTO.ClipHeight
 	params.Clip.Scale = requestDTO.ClipScale
 	params.FromSurface = requestDTO.FromSurface
+	params.WaitingTime = requestDTO.WaitingTime
 	return params
 }
 
@@ -114,5 +116,6 @@ func newDefaultHtml2ImageRequestDTO() *Html2ImageRequestDTO {
 		ClipHeight:  doctron_core.DefaultViewportHeight,
 		ClipScale:   doctron_core.DefaultViewportScale,
 		FromSurface: doctron_core.DefaultFromSurface,
+		WaitingTime: doctron_core.DefaultWaitingTime,
 	}
 }

controller/html2pdf_controller.go

@@ -3,6 +3,8 @@ package controller
 import (
 	"context"
 	"errors"
+	"time"
+
 	"github.com/gorilla/schema"
 	uuid "github.com/iris-contrib/go.uuid"
 	"github.com/kataras/iris/v12"
@@ -13,7 +15,6 @@ import (
 	"github.com/lampnick/doctron/converter/doctron_core"
 	"github.com/lampnick/doctron/worker"
 	"gopkg.in/go-playground/validator.v9"
-	"time"
 )
 
 func Html2PdfHandler(ctx iris.Context) {
@@ -106,6 +107,7 @@ func convertToPDFParams(requestDTO *Html2PdfRequestDTO) doctron_core.PDFParams {
 	params.HeaderTemplate = requestDTO.HeaderTemplate
 	params.FooterTemplate = requestDTO.FooterTemplate
 	params.PreferCSSPageSize = requestDTO.PreferCSSPageSize
+	params.WaitingTime = requestDTO.WaitingTime
 	return params
 }
 
@@ -126,5 +128,6 @@ func newDefaultHtml2PdfRequestDTO() *Html2PdfRequestDTO {
 		HeaderTemplate:          doctron_core.DefaultHeaderTemplate,
 		FooterTemplate:          doctron_core.DefaultFooterTemplate,
 		PreferCSSPageSize:       doctron_core.DefaultPreferCSSPageSize,
+		WaitingTime:             doctron_core.DefaultWaitingTime,
 	}
 }

controller/types.go

@@ -26,6 +26,7 @@ type Html2PdfRequestDTO struct {
 	HeaderTemplate          string  `schema:"headerTemplate,omitempty" validate:"omitempty"`          // HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them: - date: formatted print date - title: document title - url: document location - pageNumber: current page number - totalPages: total pages in the document  For example, <span class=title></span> would generate span containing the title.
 	FooterTemplate          string  `schema:"footerTemplate,omitempty" validate:"omitempty"`          // HTML template for the print footer. Should use the same format as the headerTemplate.
 	PreferCSSPageSize       bool    `schema:"preferCSSPageSize,omitempty" validate:"omitempty"`       // Whether or not to prefer page size as defined by css. core.Defaults to false, in which case the content will be scaled to fit the paper size.
+	WaitingTime             int     `schema:"waitingTime,omitempty" validate:"omitempty"`             // Waiting time after the page loaded. Default 0 means not wait. unit:Millisecond
 }
 
 type Html2ImageRequestDTO struct {
@@ -39,6 +40,7 @@ type Html2ImageRequestDTO struct {
 	ClipHeight  float64                      `schema:"clipHeight,omitempty" validate:"omitempty"`  // Capture the screenshot of a given region only.Rectangle height in device independent pixels (dip).
 	ClipScale   float64                      `schema:"clipScale,omitempty" validate:"omitempty"`   // Capture the screenshot of a given region only.Page scale factor.
 	FromSurface bool                         `schema:"fromSurface,omitempty" validate:"omitempty"` // Capture the screenshot from the surface, rather than the view. Defaults to true.
+	WaitingTime int                          `schema:"waitingTime,omitempty" validate:"omitempty"` // Waiting time after the page loaded. Default 0 means not wait. unit:Millisecond
 }
 
 type PdfWatermarkRequestDTO struct {

converter/doctron_core/html2image.go

@@ -3,44 +3,49 @@ package doctron_core
 import (
 	"context"
 	"errors"
+	"time"
+
 	"github.com/chromedp/cdproto/emulation"
 	"github.com/chromedp/cdproto/page"
 	"github.com/chromedp/chromedp"
-	"time"
 )
 
-// Image compression format (defaults to png).
+//FormatPng Image compression format (defaults to png).
 const FormatPng = page.CaptureScreenshotFormatPng
+
+//FormatJpeg Image compression format (defaults to png).
 const FormatJpeg = page.CaptureScreenshotFormatJpeg
 
-// Compression quality from range [0..100] (jpeg only).
+//DefaultQuality Compression quality from range [0..100] (jpeg only).
 const DefaultQuality = 0
 
-// Capture the screenshot from the surface, rather than the view. Defaults to true.
+//DefaultFromSurface Capture the screenshot from the surface, rather than the view. Defaults to true.
 const DefaultFromSurface = true
 
-// Capture the screenshot of a given region only.
+//DefaultViewportX Capture the screenshot of a given region only.
 // X offset in device independent pixels (dip).
 const DefaultViewportX = 0
 
-// Y offset in device independent pixels (dip).
+//DefaultViewportY Y offset in device independent pixels (dip).
 const DefaultViewportY = 0
 
-// Rectangle width in device independent pixels (dip).
+//DefaultViewportWidth Rectangle width in device independent pixels (dip).
 const DefaultViewportWidth = 996
 
-// Rectangle height in device independent pixels (dip).
+//DefaultViewportHeight Rectangle height in device independent pixels (dip).
 const DefaultViewportHeight = 996
 
-// Page scale factor.
+//DefaultViewportScale Page scale factor.
 const DefaultViewportScale = 1
 
-// PrintToHtml2Image print page as PDF.
+//Html2ImageParams print page as PDF.
 type Html2ImageParams struct {
 	page.CaptureScreenshotParams
-	CustomClip bool
+	CustomClip  bool
+	WaitingTime int // Waiting time after the page loaded. Default 0 means not wait. unit:Millisecond
 }
 
+//NewDefaultHtml2ImageParams default html convert to image params
 func NewDefaultHtml2ImageParams() Html2ImageParams {
 	return Html2ImageParams{
 		CustomClip: false,
@@ -56,6 +61,7 @@ func NewDefaultHtml2ImageParams() Html2ImageParams {
 			},
 			FromSurface: DefaultFromSurface,
 		},
+		WaitingTime: DefaultWaitingTime,
 	}
 }
 
@@ -82,6 +88,7 @@ func (ins *html2image) Convert() ([]byte, error) {
 
 	if err := chromedp.Run(ctx,
 		chromedp.Navigate(ins.cc.Url),
+		chromedp.Sleep(time.Duration(params.WaitingTime)*time.Millisecond),
 		chromedp.ActionFunc(func(ctx context.Context) error {
 
 			if !params.CustomClip {

converter/doctron_core/html2pdf.go

@@ -3,64 +3,70 @@ package doctron_core
 import (
 	"context"
 	"errors"
+	"time"
+
 	"github.com/chromedp/cdproto/page"
 	"github.com/chromedp/chromedp"
-	"time"
 )
 
-// Paper orientation. Defaults to false.
+//DefaultLandscape Paper orientation. Defaults to false.
 const DefaultLandscape = false
 
-// Display header and footer. Defaults to false.
+//DefaultDisplayHeaderFooter Display header and footer. Defaults to false.
 const DefaultDisplayHeaderFooter = false
 
-// Print background graphics. Defaults to true.
+//DefaultPrintBackground Print background graphics. Defaults to true.
 const DefaultPrintBackground = true
 
-// Scale of the webpage rendering. Defaults to 1.
+//DefaultScale Scale of the webpage rendering. Defaults to 1.
 const DefaultScale = 1
 
-// Paper width in inches. Defaults to 8.5 inches.
+//DefaultPaperWidth Paper width in inches. Defaults to 8.5 inches.
 const DefaultPaperWidth = 8.5
 
-// Paper height in inches. Defaults to 11 inches.
+//DefaultPaperHeight Paper height in inches. Defaults to 11 inches.
 const DefaultPaperHeight = 11
 
-// Top margin in inches. Defaults to 1cm (~0.4 inches).
+//DefaultMarginTop Top margin in inches. Defaults to 1cm (~0.4 inches).
 const DefaultMarginTop = 0.4
 
-// Bottom margin in inches. Defaults to 1cm (~0.4 inches).
+//DefaultMarginBottom Bottom margin in inches. Defaults to 1cm (~0.4 inches).
 const DefaultMarginBottom = 0.4
 
-// Left margin in inches. Defaults to 1cm (~0.4 inches).
+//DefaultMarginLeft Left margin in inches. Defaults to 1cm (~0.4 inches).
 const DefaultMarginLeft = 0.4
 
-// Right margin in inches. Defaults to 1cm (~0.4 inches).
+//DefaultMarginRight Right margin in inches. Defaults to 1cm (~0.4 inches).
 const DefaultMarginRight = 0.4
 
-// Paper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which means print all pages.
+//DefaultPageRanges Paper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, which means print all pages.
 const DefaultPageRanges = ""
 
-// Whether to silently ignore invalid but successfully parsed page ranges, such as '3-2'. Defaults to false.
+//DefaultIgnoreInvalidPageRanges Whether to silently ignore invalid but successfully parsed page ranges, such as '3-2'. Defaults to false.
 const DefaultIgnoreInvalidPageRanges = false
 
-// HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them: - date: formatted print date - title: document title - url: document location - pageNumber: current page number - totalPages: total pages in the document  For example, <span class=title></span> would generate span containing the title.
+//DefaultHeaderTemplate HTML template for the print header. Should be valid HTML markup with following classes used to inject printing values into them: - date: formatted print date - title: document title - url: document location - pageNumber: current page number - totalPages: total pages in the document  For example, <span class=title></span> would generate span containing the title.
 const DefaultHeaderTemplate = ""
 
-// HTML template for the print footer. Should use the same format as the headerTemplate.
+//DefaultFooterTemplate HTML template for the print footer. Should use the same format as the headerTemplate.
 const DefaultFooterTemplate = ""
 
-// Whether or not to prefer page size as defined by css. Defaults to false, in which case the content will be scaled to fit the paper size.
+//DefaultPreferCSSPageSize Whether or not to prefer page size as defined by css. Defaults to false, in which case the content will be scaled to fit the paper size.
 const DefaultPreferCSSPageSize = false
 
-// PrintToPDFParams print page as PDF.
+//DefaultWaitingTime Waiting time after the page loaded. Default 0 means not wait. unit:Millisecond
+const DefaultWaitingTime = 0
+
+// PDFParams print page as PDF.
 type PDFParams struct {
 	page.PrintToPDFParams
+	WaitingTime int // Waiting time after the page loaded. Default 0 means not wait. unit:Millisecond
 }
 
+//NewDefaultPDFParams default pdf params
 func NewDefaultPDFParams() PDFParams {
 	return PDFParams{
-		page.PrintToPDFParams{
+		PrintToPDFParams: page.PrintToPDFParams{
 			Landscape:               DefaultLandscape,
 			DisplayHeaderFooter:     DefaultDisplayHeaderFooter,
 			PrintBackground:         DefaultPrintBackground,
@@ -77,6 +83,7 @@ func NewDefaultPDFParams() PDFParams {
 			FooterTemplate:          DefaultFooterTemplate,
 			PreferCSSPageSize:       DefaultPreferCSSPageSize,
 		},
+		WaitingTime: DefaultWaitingTime,
 	}
 }
 
@@ -103,6 +110,7 @@ func (ins *html2pdf) Convert() ([]byte, error) {
 
 	if err := chromedp.Run(ctx,
 		chromedp.Navigate(ins.cc.Url),
+		chromedp.Sleep(time.Duration(params.WaitingTime)*time.Millisecond),
 		chromedp.ActionFunc(func(ctx context.Context) error {
 			var err error
 			ins.buf, _, err = params.Do(ctx)