code.gitea.io/gitea@v1.22.3/modules/charset/escape.go (about)

     1  // Copyright 2022 The Gitea Authors. All rights reserved.
     2  // SPDX-License-Identifier: MIT
     3  
     4  //go:generate go run invisible/generate.go -v -o ./invisible_gen.go
     5  
     6  //go:generate go run ambiguous/generate.go -v -o ./ambiguous_gen.go ambiguous/ambiguous.json
     7  
     8  package charset
     9  
    10  import (
    11  	"html/template"
    12  	"io"
    13  	"strings"
    14  
    15  	"code.gitea.io/gitea/modules/log"
    16  	"code.gitea.io/gitea/modules/setting"
    17  	"code.gitea.io/gitea/modules/translation"
    18  )
    19  
    20  // RuneNBSP is the codepoint for NBSP
    21  const RuneNBSP = 0xa0
    22  
    23  // EscapeControlHTML escapes the unicode control sequences in a provided html document
    24  func EscapeControlHTML(html template.HTML, locale translation.Locale, allowed ...rune) (escaped *EscapeStatus, output template.HTML) {
    25  	sb := &strings.Builder{}
    26  	escaped, _ = EscapeControlReader(strings.NewReader(string(html)), sb, locale, allowed...) // err has been handled in EscapeControlReader
    27  	return escaped, template.HTML(sb.String())
    28  }
    29  
    30  // EscapeControlReader escapes the unicode control sequences in a provided reader of HTML content and writer in a locale and returns the findings as an EscapeStatus
    31  func EscapeControlReader(reader io.Reader, writer io.Writer, locale translation.Locale, allowed ...rune) (escaped *EscapeStatus, err error) {
    32  	if !setting.UI.AmbiguousUnicodeDetection {
    33  		_, err = io.Copy(writer, reader)
    34  		return &EscapeStatus{}, err
    35  	}
    36  	outputStream := &HTMLStreamerWriter{Writer: writer}
    37  	streamer := NewEscapeStreamer(locale, outputStream, allowed...).(*escapeStreamer)
    38  
    39  	if err = StreamHTML(reader, streamer); err != nil {
    40  		streamer.escaped.HasError = true
    41  		log.Error("Error whilst escaping: %v", err)
    42  	}
    43  	return streamer.escaped, err
    44  }