summaryrefslogtreecommitdiff
path: root/internal/text/emojify.go
blob: 961ce8771affac44d4deeac4d1ef22c64f447418 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
// GoToSocial
// Copyright (C) GoToSocial Authors admin@gotosocial.org
// SPDX-License-Identifier: AGPL-3.0-or-later
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

package text

import (
	"bytes"
	"html"
	"html/template"

	apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
	"github.com/superseriousbusiness/gotosocial/internal/regexes"
)

// EmojifyWeb replaces emoji shortcodes like `:example:` in the given HTML
// fragment with `<img>` tags suitable for rendering on the web frontend.
func EmojifyWeb(emojis []apimodel.Emoji, html template.HTML) template.HTML {
	out := emojify(
		emojis,
		string(html),
		func(url, staticURL, code string, buf *bytes.Buffer) {
			// Open a picture tag so we
			// can present multiple options.
			buf.WriteString(`<picture>`)

			// Static version.
			buf.WriteString(`<source `)
			{
				buf.WriteString(`class="emoji" `)
				buf.WriteString(`srcset="` + staticURL + `" `)
				buf.WriteString(`type="image/png" `)
				// Show this version when user
				// doesn't want an animated emoji.
				buf.WriteString(`media="(prefers-reduced-motion: reduce)" `)
				// Limit size to avoid showing
				// huge emojis when unstyled.
				buf.WriteString(`width="25" height="25" `)
			}
			buf.WriteString(`/>`)

			// Original image source.
			buf.WriteString(`<img `)
			{
				buf.WriteString(`class="emoji" `)
				buf.WriteString(`src="` + url + `" `)
				buf.WriteString(`title=":` + code + `:" `)
				buf.WriteString(`alt=":` + code + `:" `)
				// Lazy load emojis when
				// they scroll into view.
				buf.WriteString(`loading="lazy" `)
				// Limit size to avoid showing
				// huge emojis when unstyled.
				buf.WriteString(`width="25" height="25" `)
			}
			buf.WriteString(`/>`)

			// Close the picture tag.
			buf.WriteString(`</picture>`)
		},
	)

	// If input was safe,
	// we can trust output.
	return template.HTML(out) // #nosec G203
}

// EmojifyRSS replaces emoji shortcodes like `:example:` in the given text
// fragment with `<img>` tags suitable for rendering as RSS content.
func EmojifyRSS(emojis []apimodel.Emoji, text string) string {
	return emojify(
		emojis,
		text,
		func(url, staticURL, code string, buf *bytes.Buffer) {
			// Original image source.
			buf.WriteString(`<img `)
			{
				buf.WriteString(`src="` + url + `" `)
				buf.WriteString(`title=":` + code + `:" `)
				buf.WriteString(`alt=":` + code + `:" `)
				// Limit size to avoid showing
				// huge emojis in RSS readers.
				buf.WriteString(`width="25" height="25" `)
			}
			buf.WriteString(`/>`)
		},
	)
}

// Demojify replaces emoji shortcodes like `:example:` in the given text
// fragment with empty strings, essentially stripping them from the text.
// This is useful for text used in OG Meta headers.
func Demojify(text string) string {
	return regexes.EmojiFinder.ReplaceAllString(text, "")
}

func emojify(
	emojis []apimodel.Emoji,
	input string,
	write func(url, staticURL, code string, buf *bytes.Buffer),
) string {
	// Build map of shortcodes. Normalize each
	// shortcode by readding closing colons.
	emojisMap := make(map[string]apimodel.Emoji, len(emojis))
	for _, emoji := range emojis {
		shortcode := ":" + emoji.Shortcode + ":"
		emojisMap[shortcode] = emoji
	}

	return regexes.ReplaceAllStringFunc(
		regexes.EmojiFinder,
		input,
		func(shortcode string, buf *bytes.Buffer) string {
			// Look for emoji with this shortcode.
			emoji, ok := emojisMap[shortcode]
			if !ok {
				return shortcode
			}

			// Escape raw emoji content.
			url := html.EscapeString(emoji.URL)
			staticURL := html.EscapeString(emoji.StaticURL)
			code := html.EscapeString(emoji.Shortcode)

			// Write emoji repr to buffer.
			write(url, staticURL, code, buf)
			return buf.String()
		},
	)
}