2017-11-07 07:33:06 +01:00
|
|
|
// Copyright 2017 The Gitea Authors. All rights reserved.
|
|
|
|
// Use of this source code is governed by a MIT-style
|
|
|
|
// license that can be found in the LICENSE file.
|
|
|
|
|
|
|
|
package external
|
|
|
|
|
|
|
|
import (
|
2021-04-20 00:25:08 +02:00
|
|
|
"fmt"
|
2017-11-07 07:33:06 +01:00
|
|
|
"io"
|
|
|
|
"io/ioutil"
|
|
|
|
"os"
|
|
|
|
"os/exec"
|
2018-11-20 23:11:21 +01:00
|
|
|
"runtime"
|
2017-11-07 07:33:06 +01:00
|
|
|
"strings"
|
|
|
|
|
|
|
|
"code.gitea.io/gitea/modules/log"
|
|
|
|
"code.gitea.io/gitea/modules/markup"
|
|
|
|
"code.gitea.io/gitea/modules/setting"
|
2020-08-11 22:05:34 +02:00
|
|
|
"code.gitea.io/gitea/modules/util"
|
2017-11-07 07:33:06 +01:00
|
|
|
)
|
|
|
|
|
2021-04-20 00:25:08 +02:00
|
|
|
// RegisterRenderers registers all supported third part renderers according settings
|
|
|
|
func RegisterRenderers() {
|
|
|
|
for _, renderer := range setting.ExternalMarkupRenderers {
|
|
|
|
if renderer.Enabled && renderer.Command != "" && len(renderer.FileExtensions) > 0 {
|
|
|
|
markup.RegisterRenderer(&Renderer{renderer})
|
2017-11-07 07:33:06 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-04-20 00:25:08 +02:00
|
|
|
// Renderer implements markup.Renderer for external tools
|
|
|
|
type Renderer struct {
|
2021-06-23 23:09:51 +02:00
|
|
|
*setting.MarkupRenderer
|
2017-11-07 07:33:06 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// Name returns the external tool name
|
2021-04-20 00:25:08 +02:00
|
|
|
func (p *Renderer) Name() string {
|
2017-11-07 07:33:06 +01:00
|
|
|
return p.MarkupName
|
|
|
|
}
|
|
|
|
|
2021-04-20 00:25:08 +02:00
|
|
|
// NeedPostProcess implements markup.Renderer
|
|
|
|
func (p *Renderer) NeedPostProcess() bool {
|
|
|
|
return p.MarkupRenderer.NeedPostProcess
|
2021-04-13 09:06:31 +02:00
|
|
|
}
|
|
|
|
|
2017-11-07 07:33:06 +01:00
|
|
|
// Extensions returns the supported extensions of the tool
|
2021-04-20 00:25:08 +02:00
|
|
|
func (p *Renderer) Extensions() []string {
|
2017-11-07 07:33:06 +01:00
|
|
|
return p.FileExtensions
|
|
|
|
}
|
|
|
|
|
2021-06-23 23:09:51 +02:00
|
|
|
// SanitizerRules implements markup.Renderer
|
|
|
|
func (p *Renderer) SanitizerRules() []setting.MarkupSanitizerRule {
|
|
|
|
return p.MarkupSanitizerRules
|
|
|
|
}
|
|
|
|
|
2018-11-20 23:11:21 +01:00
|
|
|
func envMark(envName string) string {
|
|
|
|
if runtime.GOOS == "windows" {
|
|
|
|
return "%" + envName + "%"
|
|
|
|
}
|
|
|
|
return "$" + envName
|
|
|
|
}
|
|
|
|
|
2017-11-07 07:33:06 +01:00
|
|
|
// Render renders the data of the document to HTML via the external tool.
|
2021-04-20 00:25:08 +02:00
|
|
|
func (p *Renderer) Render(ctx *markup.RenderContext, input io.Reader, output io.Writer) error {
|
2017-11-07 07:33:06 +01:00
|
|
|
var (
|
2021-04-20 00:25:08 +02:00
|
|
|
urlRawPrefix = strings.Replace(ctx.URLPrefix, "/src/", "/raw/", 1)
|
|
|
|
command = strings.NewReplacer(envMark("GITEA_PREFIX_SRC"), ctx.URLPrefix,
|
2018-11-20 23:11:21 +01:00
|
|
|
envMark("GITEA_PREFIX_RAW"), urlRawPrefix).Replace(p.Command)
|
|
|
|
commands = strings.Fields(command)
|
2017-11-07 07:33:06 +01:00
|
|
|
args = commands[1:]
|
|
|
|
)
|
|
|
|
|
|
|
|
if p.IsInputFile {
|
|
|
|
// write to temp file
|
|
|
|
f, err := ioutil.TempFile("", "gitea_input")
|
|
|
|
if err != nil {
|
2021-04-20 00:25:08 +02:00
|
|
|
return fmt.Errorf("%s create temp file when rendering %s failed: %v", p.Name(), p.Command, err)
|
2017-11-07 07:33:06 +01:00
|
|
|
}
|
2020-08-11 22:05:34 +02:00
|
|
|
tmpPath := f.Name()
|
|
|
|
defer func() {
|
|
|
|
if err := util.Remove(tmpPath); err != nil {
|
|
|
|
log.Warn("Unable to remove temporary file: %s: Error: %v", tmpPath, err)
|
|
|
|
}
|
|
|
|
}()
|
2017-11-07 07:33:06 +01:00
|
|
|
|
2021-04-20 00:25:08 +02:00
|
|
|
_, err = io.Copy(f, input)
|
2017-11-07 07:33:06 +01:00
|
|
|
if err != nil {
|
|
|
|
f.Close()
|
2021-04-20 00:25:08 +02:00
|
|
|
return fmt.Errorf("%s write data to temp file when rendering %s failed: %v", p.Name(), p.Command, err)
|
2017-11-07 07:33:06 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
err = f.Close()
|
|
|
|
if err != nil {
|
2021-04-20 00:25:08 +02:00
|
|
|
return fmt.Errorf("%s close temp file when rendering %s failed: %v", p.Name(), p.Command, err)
|
2017-11-07 07:33:06 +01:00
|
|
|
}
|
|
|
|
args = append(args, f.Name())
|
|
|
|
}
|
|
|
|
|
|
|
|
cmd := exec.Command(commands[0], args...)
|
2018-10-30 15:34:12 +01:00
|
|
|
cmd.Env = append(
|
|
|
|
os.Environ(),
|
2021-04-20 00:25:08 +02:00
|
|
|
"GITEA_PREFIX_SRC="+ctx.URLPrefix,
|
2018-11-20 23:11:21 +01:00
|
|
|
"GITEA_PREFIX_RAW="+urlRawPrefix,
|
2018-10-30 15:34:12 +01:00
|
|
|
)
|
2017-11-07 07:33:06 +01:00
|
|
|
if !p.IsInputFile {
|
2021-04-20 00:25:08 +02:00
|
|
|
cmd.Stdin = input
|
2017-11-07 07:33:06 +01:00
|
|
|
}
|
2021-04-20 00:25:08 +02:00
|
|
|
cmd.Stdout = output
|
2017-11-07 07:33:06 +01:00
|
|
|
if err := cmd.Run(); err != nil {
|
2021-04-20 00:25:08 +02:00
|
|
|
return fmt.Errorf("%s render run command %s %v failed: %v", p.Name(), commands[0], args, err)
|
2017-11-07 07:33:06 +01:00
|
|
|
}
|
2021-04-20 00:25:08 +02:00
|
|
|
return nil
|
2017-11-07 07:33:06 +01:00
|
|
|
}
|