2023-04-29 20:02:29 +08:00
// Copyright 2023 The Gitea Authors. All rights reserved.
// SPDX-License-Identifier: MIT
package templates
import (
"context"
"encoding/hex"
"fmt"
"html/template"
"math"
"net/url"
"regexp"
"strings"
"unicode"
issues_model "code.gitea.io/gitea/models/issues"
"code.gitea.io/gitea/modules/emoji"
"code.gitea.io/gitea/modules/log"
"code.gitea.io/gitea/modules/markup"
"code.gitea.io/gitea/modules/markup/markdown"
"code.gitea.io/gitea/modules/setting"
2024-03-13 01:32:05 +08:00
"code.gitea.io/gitea/modules/translation"
2023-05-10 19:19:03 +08:00
"code.gitea.io/gitea/modules/util"
2023-04-29 20:02:29 +08:00
)
// RenderCommitMessage renders commit message with XSS-safe and special links.
2024-01-15 16:49:24 +08:00
func RenderCommitMessage ( ctx context . Context , msg string , metas map [ string ] string ) template . HTML {
2023-04-29 20:02:29 +08:00
cleanMsg := template . HTMLEscapeString ( msg )
// we can safely assume that it will not return any error, since there
// shouldn't be any special HTML.
fullMessage , err := markup . RenderCommitMessage ( & markup . RenderContext {
2024-01-15 16:49:24 +08:00
Ctx : ctx ,
Metas : metas ,
2023-04-29 20:02:29 +08:00
} , cleanMsg )
if err != nil {
log . Error ( "RenderCommitMessage: %v" , err )
return ""
}
msgLines := strings . Split ( strings . TrimSpace ( fullMessage ) , "\n" )
if len ( msgLines ) == 0 {
return template . HTML ( "" )
}
2024-03-28 18:42:31 +08:00
return RenderCodeBlock ( template . HTML ( msgLines [ 0 ] ) )
2023-04-29 20:02:29 +08:00
}
2024-01-15 16:49:24 +08:00
// RenderCommitMessageLinkSubject renders commit message as a XSS-safe link to
2023-04-29 20:02:29 +08:00
// the provided default url, handling for special links without email to links.
2024-01-15 16:49:24 +08:00
func RenderCommitMessageLinkSubject ( ctx context . Context , msg , urlDefault string , metas map [ string ] string ) template . HTML {
2023-04-29 20:02:29 +08:00
msgLine := strings . TrimLeftFunc ( msg , unicode . IsSpace )
lineEnd := strings . IndexByte ( msgLine , '\n' )
if lineEnd > 0 {
msgLine = msgLine [ : lineEnd ]
}
msgLine = strings . TrimRightFunc ( msgLine , unicode . IsSpace )
if len ( msgLine ) == 0 {
return template . HTML ( "" )
}
// we can safely assume that it will not return any error, since there
// shouldn't be any special HTML.
renderedMessage , err := markup . RenderCommitMessageSubject ( & markup . RenderContext {
Ctx : ctx ,
DefaultLink : urlDefault ,
Metas : metas ,
} , template . HTMLEscapeString ( msgLine ) )
if err != nil {
log . Error ( "RenderCommitMessageSubject: %v" , err )
return template . HTML ( "" )
}
2024-03-28 18:42:31 +08:00
return RenderCodeBlock ( template . HTML ( renderedMessage ) )
2023-04-29 20:02:29 +08:00
}
// RenderCommitBody extracts the body of a commit message without its title.
2024-01-15 16:49:24 +08:00
func RenderCommitBody ( ctx context . Context , msg string , metas map [ string ] string ) template . HTML {
2023-06-21 17:14:34 +08:00
msgLine := strings . TrimSpace ( msg )
2023-04-29 20:02:29 +08:00
lineEnd := strings . IndexByte ( msgLine , '\n' )
if lineEnd > 0 {
msgLine = msgLine [ lineEnd + 1 : ]
} else {
2023-06-21 17:14:34 +08:00
return ""
2023-04-29 20:02:29 +08:00
}
msgLine = strings . TrimLeftFunc ( msgLine , unicode . IsSpace )
if len ( msgLine ) == 0 {
2023-06-21 17:14:34 +08:00
return ""
2023-04-29 20:02:29 +08:00
}
renderedMessage , err := markup . RenderCommitMessage ( & markup . RenderContext {
2024-01-15 16:49:24 +08:00
Ctx : ctx ,
Metas : metas ,
2023-04-29 20:02:29 +08:00
} , template . HTMLEscapeString ( msgLine ) )
if err != nil {
log . Error ( "RenderCommitMessage: %v" , err )
return ""
}
return template . HTML ( renderedMessage )
}
// Match text that is between back ticks.
var codeMatcher = regexp . MustCompile ( "`([^`]+)`" )
2023-08-31 13:01:01 +08:00
// RenderCodeBlock renders "`…`" as highlighted "<code>" block, intended for issue and PR titles
2023-04-29 20:02:29 +08:00
func RenderCodeBlock ( htmlEscapedTextToRender template . HTML ) template . HTML {
2023-08-31 13:01:01 +08:00
htmlWithCodeTags := codeMatcher . ReplaceAllString ( string ( htmlEscapedTextToRender ) , ` <code class="inline-code-block">$1</code> ` ) // replace with HTML <code> tags
2023-04-29 20:02:29 +08:00
return template . HTML ( htmlWithCodeTags )
}
// RenderIssueTitle renders issue/pull title with defined post processors
2024-01-15 16:49:24 +08:00
func RenderIssueTitle ( ctx context . Context , text string , metas map [ string ] string ) template . HTML {
2023-04-29 20:02:29 +08:00
renderedText , err := markup . RenderIssueTitle ( & markup . RenderContext {
2024-01-15 16:49:24 +08:00
Ctx : ctx ,
Metas : metas ,
2023-04-29 20:02:29 +08:00
} , template . HTMLEscapeString ( text ) )
if err != nil {
log . Error ( "RenderIssueTitle: %v" , err )
return template . HTML ( "" )
}
return template . HTML ( renderedText )
}
// RenderLabel renders a label
2024-03-13 01:32:05 +08:00
// locale is needed due to an import cycle with our context providing the `Tr` function
func RenderLabel ( ctx context . Context , locale translation . Locale , label * issues_model . Label ) template . HTML {
2024-04-30 10:36:32 +08:00
var extraCSSClasses string
textColor := util . ContrastColor ( label . Color )
labelScope := label . ExclusiveScope ( )
descriptionText := emoji . ReplaceAliases ( label . Description )
2023-04-29 20:02:29 +08:00
2024-03-13 14:04:07 +08:00
if label . IsArchived ( ) {
2024-04-30 10:36:32 +08:00
extraCSSClasses = "archived-label"
descriptionText = fmt . Sprintf ( "(%s) %s" , locale . TrString ( "archived" ) , descriptionText )
2024-03-13 01:32:05 +08:00
}
2023-04-29 20:02:29 +08:00
if labelScope == "" {
// Regular label
2024-04-30 10:36:32 +08:00
return HTMLFormat ( ` <div class="ui label %s" style="color: %s !important; background-color: %s !important;" data-tooltip-content title="%s">%s</div> ` ,
extraCSSClasses , textColor , label . Color , descriptionText , RenderEmoji ( ctx , label . Name ) )
2023-04-29 20:02:29 +08:00
}
// Scoped label
2024-04-30 10:36:32 +08:00
scopeHTML := RenderEmoji ( ctx , labelScope )
itemHTML := RenderEmoji ( ctx , label . Name [ len ( labelScope ) + 1 : ] )
2023-04-29 20:02:29 +08:00
2023-05-10 19:19:03 +08:00
// Make scope and item background colors slightly darker and lighter respectively.
// More contrast needed with higher luminance, empirically tweaked.
2024-04-08 00:19:25 +08:00
luminance := util . GetRelativeLuminance ( label . Color )
2023-05-10 19:19:03 +08:00
contrast := 0.01 + luminance * 0.03
// Ensure we add the same amount of contrast also near 0 and 1.
darken := contrast + math . Max ( luminance + contrast - 1.0 , 0.0 )
lighten := contrast + math . Max ( contrast - luminance , 0.0 )
// Compute factor to keep RGB values proportional.
darkenFactor := math . Max ( luminance - darken , 0.0 ) / math . Max ( luminance , 1.0 / 255.0 )
lightenFactor := math . Min ( luminance + lighten , 1.0 ) / math . Max ( luminance , 1.0 / 255.0 )
2024-04-08 00:19:25 +08:00
r , g , b := util . HexToRBGColor ( label . Color )
2023-05-10 19:19:03 +08:00
scopeBytes := [ ] byte {
uint8 ( math . Min ( math . Round ( r * darkenFactor ) , 255 ) ) ,
uint8 ( math . Min ( math . Round ( g * darkenFactor ) , 255 ) ) ,
uint8 ( math . Min ( math . Round ( b * darkenFactor ) , 255 ) ) ,
2023-04-29 20:02:29 +08:00
}
2023-05-10 19:19:03 +08:00
itemBytes := [ ] byte {
uint8 ( math . Min ( math . Round ( r * lightenFactor ) , 255 ) ) ,
uint8 ( math . Min ( math . Round ( g * lightenFactor ) , 255 ) ) ,
uint8 ( math . Min ( math . Round ( b * lightenFactor ) , 255 ) ) ,
}
itemColor := "#" + hex . EncodeToString ( itemBytes )
scopeColor := "#" + hex . EncodeToString ( scopeBytes )
2023-04-29 20:02:29 +08:00
2024-04-30 10:36:32 +08:00
return HTMLFormat ( ` <span class="ui label %s scope-parent" data-tooltip-content title="%s"> ` +
` <div class="ui label scope-left" style="color: %s !important; background-color: %s !important">%s</div> ` +
` <div class="ui label scope-right" style="color: %s !important; background-color: %s !important">%s</div> ` +
` </span> ` ,
extraCSSClasses , descriptionText ,
textColor , scopeColor , scopeHTML ,
textColor , itemColor , itemHTML )
2023-04-29 20:02:29 +08:00
}
// RenderEmoji renders html text with emoji post processors
func RenderEmoji ( ctx context . Context , text string ) template . HTML {
renderedText , err := markup . RenderEmoji ( & markup . RenderContext { Ctx : ctx } ,
template . HTMLEscapeString ( text ) )
if err != nil {
log . Error ( "RenderEmoji: %v" , err )
return template . HTML ( "" )
}
return template . HTML ( renderedText )
}
// ReactionToEmoji renders emoji for use in reactions
func ReactionToEmoji ( reaction string ) template . HTML {
val := emoji . FromCode ( reaction )
if val != nil {
return template . HTML ( val . Emoji )
}
val = emoji . FromAlias ( reaction )
if val != nil {
return template . HTML ( val . Emoji )
}
return template . HTML ( fmt . Sprintf ( ` <img alt=":%s:" src="%s/assets/img/emoji/%s.png"></img> ` , reaction , setting . StaticURLPrefix , url . PathEscape ( reaction ) ) )
}
func RenderMarkdownToHtml ( ctx context . Context , input string ) template . HTML { //nolint:revive
output , err := markdown . RenderString ( & markup . RenderContext {
2024-01-15 16:49:24 +08:00
Ctx : ctx ,
Metas : map [ string ] string { "mode" : "document" } ,
2023-04-29 20:02:29 +08:00
} , input )
if err != nil {
log . Error ( "RenderString: %v" , err )
}
2024-03-01 15:11:51 +08:00
return output
2023-04-29 20:02:29 +08:00
}
2024-04-13 18:05:33 +08:00
func RenderLabels ( ctx context . Context , locale translation . Locale , labels [ ] * issues_model . Label , repoLink string , issue * issues_model . Issue ) template . HTML {
isPullRequest := issue != nil && issue . IsPull
baseLink := fmt . Sprintf ( "%s/%s" , repoLink , util . Iif ( isPullRequest , "pulls" , "issues" ) )
2023-04-29 20:02:29 +08:00
htmlCode := ` <span class="labels-list"> `
for _ , label := range labels {
// Protect against nil value in labels - shouldn't happen but would cause a panic if so
if label == nil {
continue
}
2024-04-13 18:05:33 +08:00
htmlCode += fmt . Sprintf ( ` <a href="%s?labels=%d">%s</a> ` , baseLink , label . ID , RenderLabel ( ctx , locale , label ) )
2023-04-29 20:02:29 +08:00
}
htmlCode += "</span>"
return template . HTML ( htmlCode )
}