2019-08-16 13:55:03 +00:00
|
|
|
// Copyright 2019 The Hugo Authors. All rights reserved.
|
|
|
|
|
//
|
|
|
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
|
// you may not use this file except in compliance with the License.
|
|
|
|
|
// You may obtain a copy of the License at
|
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
//
|
|
|
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
|
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
|
// See the License for the specific language governing permissions and
|
|
|
|
|
// limitations under the License.
|
|
|
|
|
|
|
|
|
|
// Package rst converts content to HTML using the RST external helper.
|
|
|
|
|
package rst
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"bytes"
|
|
|
|
|
"runtime"
|
|
|
|
|
|
2020-12-18 17:20:12 +00:00
|
|
|
"github.com/cli/safeexec"
|
2020-12-23 08:26:23 +00:00
|
|
|
"github.com/gohugoio/hugo/htesting"
|
2020-12-18 17:20:12 +00:00
|
|
|
|
2019-11-27 12:42:36 +00:00
|
|
|
"github.com/gohugoio/hugo/identity"
|
2019-08-16 13:55:03 +00:00
|
|
|
"github.com/gohugoio/hugo/markup/internal"
|
|
|
|
|
|
|
|
|
|
"github.com/gohugoio/hugo/markup/converter"
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
// Provider is the package entry point.
|
2019-11-06 19:10:47 +00:00
|
|
|
var Provider converter.ProviderProvider = provider{}
|
2019-08-16 13:55:03 +00:00
|
|
|
|
|
|
|
|
type provider struct {
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (p provider) New(cfg converter.ProviderConfig) (converter.Provider, error) {
|
2019-11-06 19:10:47 +00:00
|
|
|
return converter.NewProvider("rst", func(ctx converter.DocumentContext) (converter.Converter, error) {
|
2019-08-16 13:55:03 +00:00
|
|
|
return &rstConverter{
|
|
|
|
|
ctx: ctx,
|
|
|
|
|
cfg: cfg,
|
|
|
|
|
}, nil
|
2019-11-06 19:10:47 +00:00
|
|
|
}), nil
|
2019-08-16 13:55:03 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
type rstConverter struct {
|
|
|
|
|
ctx converter.DocumentContext
|
|
|
|
|
cfg converter.ProviderConfig
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (c *rstConverter) Convert(ctx converter.RenderContext) (converter.Result, error) {
|
|
|
|
|
return converter.Bytes(c.getRstContent(ctx.Src, c.ctx)), nil
|
|
|
|
|
}
|
|
|
|
|
|
2019-11-27 12:42:36 +00:00
|
|
|
func (c *rstConverter) Supports(feature identity.Identity) bool {
|
|
|
|
|
return false
|
|
|
|
|
}
|
|
|
|
|
|
2019-08-16 13:55:03 +00:00
|
|
|
// getRstContent calls the Python script rst2html as an external helper
|
|
|
|
|
// to convert reStructuredText content to HTML.
|
|
|
|
|
func (c *rstConverter) getRstContent(src []byte, ctx converter.DocumentContext) []byte {
|
|
|
|
|
logger := c.cfg.Logger
|
|
|
|
|
path := getRstExecPath()
|
|
|
|
|
|
|
|
|
|
if path == "" {
|
2020-10-21 09:17:48 +00:00
|
|
|
logger.Println("rst2html / rst2html.py not found in $PATH: Please install.\n",
|
2019-08-16 13:55:03 +00:00
|
|
|
" Leaving reStructuredText content unrendered.")
|
|
|
|
|
return src
|
|
|
|
|
}
|
2021-01-01 10:50:13 +00:00
|
|
|
|
|
|
|
|
logger.Infoln("Rendering", ctx.DocumentName, "with", path, "...")
|
|
|
|
|
|
2019-08-16 13:55:03 +00:00
|
|
|
var result []byte
|
|
|
|
|
// certain *nix based OSs wrap executables in scripted launchers
|
|
|
|
|
// invoking binaries on these OSs via python interpreter causes SyntaxError
|
|
|
|
|
// invoke directly so that shebangs work as expected
|
|
|
|
|
// handle Windows manually because it doesn't do shebangs
|
|
|
|
|
if runtime.GOOS == "windows" {
|
|
|
|
|
python := internal.GetPythonExecPath()
|
|
|
|
|
args := []string{path, "--leave-comments", "--initial-header-level=2"}
|
|
|
|
|
result = internal.ExternallyRenderContent(c.cfg, ctx, src, python, args)
|
|
|
|
|
} else {
|
|
|
|
|
args := []string{"--leave-comments", "--initial-header-level=2"}
|
|
|
|
|
result = internal.ExternallyRenderContent(c.cfg, ctx, src, path, args)
|
|
|
|
|
}
|
|
|
|
|
// TODO(bep) check if rst2html has a body only option.
|
|
|
|
|
bodyStart := bytes.Index(result, []byte("<body>\n"))
|
|
|
|
|
if bodyStart < 0 {
|
2020-12-02 12:23:25 +00:00
|
|
|
bodyStart = -7 // compensate for length
|
2019-08-16 13:55:03 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
bodyEnd := bytes.Index(result, []byte("\n</body>"))
|
|
|
|
|
if bodyEnd < 0 || bodyEnd >= len(result) {
|
|
|
|
|
bodyEnd = len(result) - 1
|
|
|
|
|
if bodyEnd < 0 {
|
|
|
|
|
bodyEnd = 0
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return result[bodyStart+7 : bodyEnd]
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func getRstExecPath() string {
|
2020-12-18 17:20:12 +00:00
|
|
|
path, err := safeexec.LookPath("rst2html")
|
2019-08-16 13:55:03 +00:00
|
|
|
if err != nil {
|
2020-12-18 17:20:12 +00:00
|
|
|
path, err = safeexec.LookPath("rst2html.py")
|
2019-08-16 13:55:03 +00:00
|
|
|
if err != nil {
|
|
|
|
|
return ""
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return path
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Supports returns whether rst is installed on this computer.
|
|
|
|
|
func Supports() bool {
|
2020-12-23 08:26:23 +00:00
|
|
|
if htesting.SupportsAll() {
|
|
|
|
|
return true
|
|
|
|
|
}
|
2019-08-16 13:55:03 +00:00
|
|
|
return getRstExecPath() != ""
|
|
|
|
|
}
|
