Support unicode emojis and remove emojify.js

.eslintrc

@@ -20,9 +20,9 @@ globals:
   __webpack_public_path__: true
   CodeMirror: false
   Dropzone: false
-  emojify: false
   SimpleMDE: false
   u2fApi: false
+  Tribute: false
 
 overrides:
   - files: ["web_src/**/*.worker.js"]

build/generate-emoji.go

@@ -0,0 +1,184 @@
+// Copyright 2020 The Gitea Authors. All rights reserved.
+// Copyright 2015 Kenneth Shaw
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+// +build ignore
+
+package main
+
+import (
+	"encoding/json"
+	"flag"
+	"fmt"
+	"go/format"
+	"io/ioutil"
+	"log"
+	"net/http"
+	"regexp"
+	"sort"
+	"strconv"
+	"strings"
+)
+
+const (
+	gemojiURL         = "https://raw.githubusercontent.com/github/gemoji/master/db/emoji.json"
+	maxUnicodeVersion = 12
+)
+
+var (
+	flagOut = flag.String("o", "modules/emoji/emoji_data.go", "out")
+)
+
+// Gemoji is a set of emoji data.
+type Gemoji []Emoji
+
+// Emoji represents a single emoji and associated data.
+type Emoji struct {
+	Emoji          string   `json:"emoji"`
+	Description    string   `json:"description,omitempty"`
+	Aliases        []string `json:"aliases"`
+	UnicodeVersion string   `json:"unicode_version,omitempty"`
+}
+
+// Don't include some fields in JSON
+func (e Emoji) MarshalJSON() ([]byte, error) {
+	type emoji Emoji
+	x := emoji(e)
+	x.UnicodeVersion = ""
+	x.Description = ""
+	return json.Marshal(x)
+}
+
+func main() {
+	var err error
+
+	flag.Parse()
+
+	// generate data
+	buf, err := generate()
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	// write
+	err = ioutil.WriteFile(*flagOut, buf, 0644)
+	if err != nil {
+		log.Fatal(err)
+	}
+}
+
+var replacer = strings.NewReplacer(
+	"main.Gemoji", "Gemoji",
+	"main.Emoji", "\n",
+	"}}", "},\n}",
+	", Description:", ", ",
+	", Aliases:", ", ",
+	", UnicodeVersion:", ", ",
+)
+
+var emojiRE = regexp.MustCompile(`\{Emoji:"([^"]*)"`)
+
+func generate() ([]byte, error) {
+	var err error
+
+	// load gemoji data
+	res, err := http.Get(gemojiURL)
+	if err != nil {
+		return nil, err
+	}
+	defer res.Body.Close()
+
+	// read all
+	body, err := ioutil.ReadAll(res.Body)
+	if err != nil {
+		return nil, err
+	}
+
+	// unmarshal
+	var data Gemoji
+	err = json.Unmarshal(body, &data)
+	if err != nil {
+		return nil, err
+	}
+
+	var re = regexp.MustCompile(`keycap|registered|copyright`)
+	tmp := data[:0]
+
+	// filter out emoji that require greater than max unicode version
+	for i := range data {
+		val, _ := strconv.ParseFloat(data[i].UnicodeVersion, 64)
+		if int(val) <= maxUnicodeVersion {
+			// remove these keycaps for now they really complicate matching since
+			// they include normal letters in them
+			if re.MatchString(data[i].Description) {
+				continue
+			}
+			tmp = append(tmp, data[i])
+		}
+	}
+	data = tmp
+
+	sort.Slice(data, func(i, j int) bool {
+		return data[i].Aliases[0] < data[j].Aliases[0]
+	})
+
+	aliasPairs := make([]string, 0)
+	aliasMap := make(map[string]int, len(data))
+
+	for i, e := range data {
+		if e.Emoji == "" || len(e.Aliases) == 0 {
+			continue
+		}
+		for _, a := range e.Aliases {
+			if a == "" {
+				continue
+			}
+			aliasMap[a] = i
+			aliasPairs = append(aliasPairs, ":"+a+":", e.Emoji)
+		}
+	}
+
+	// gitea customizations
+	i, ok := aliasMap["tada"]
+	if ok {
+		data[i].Aliases = append(data[i].Aliases, "hooray")
+	}
+	i, ok = aliasMap["laughing"]
+	if ok {
+		data[i].Aliases = append(data[i].Aliases, "laugh")
+	}
+
+	// add header
+	str := replacer.Replace(fmt.Sprintf(hdr, gemojiURL, data))
+
+	// change the format of the unicode string
+	str = emojiRE.ReplaceAllStringFunc(str, func(s string) string {
+		var err error
+		s, err = strconv.Unquote(s[len("{Emoji:"):])
+		if err != nil {
+			panic(err)
+		}
+		return "{" + strconv.QuoteToASCII(s)
+	})
+
+	// write a JSON file to use with tribute
+	file, _ := json.Marshal(data)
+	_ = ioutil.WriteFile("assets/emoji.json", file, 0644)
+
+	// format
+	return format.Source([]byte(str))
+}
+
+const hdr = `
+// Copyright 2020 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 emoji
+
+// Code generated by gen.go. DO NOT EDIT.
+// Sourced from %s
+//
+var GemojiData = %#v
+`

custom/conf/app.ini.sample

@@ -171,8 +171,9 @@ SHOW_USER_EMAIL = true
 DEFAULT_THEME = gitea
 ; All available themes. Allow users select personalized themes regardless of the value of `DEFAULT_THEME`.
 THEMES = gitea,arc-green
-; All available reactions. Allow users react with different emoji's
-; For the whole list look at https://gitea.com/gitea/gitea.com/issues/8
+;All available reactions users can choose on issues/prs and comments.
+;Values can be emoji alias (:smile:) or a unicode emoji.
+;For custom reactions, add a tightly cropped square image to public/emoji/img/reaction_name.png
 REACTIONS = +1, -1, laugh, hooray, confused, heart, rocket, eyes
 ; Whether the full name of the users should be shown where possible. If the full name isn't set, the username will be used.
 DEFAULT_SHOW_FULL_NAME = false

docs/content/doc/advanced/config-cheat-sheet.en-us.md

@@ -128,7 +128,9 @@ Values containing `#` or `;` must be quoted using `` ` `` or `"""`.
 - `DEFAULT_THEME`: **gitea**: \[gitea, arc-green\]: Set the default theme for the Gitea install.
 - `THEMES`:  **gitea,arc-green**: All available themes. Allow users select personalized themes
   regardless of the value of `DEFAULT_THEME`.
-- `REACTIONS`: All available reactions. Allow users react with different emoji's.
+- `REACTIONS`: All available reactions users can choose on issues/prs and comments
+    Values can be emoji alias (:smile:) or a unicode emoji.
+    For custom reactions, add a tightly cropped square image to public/emoji/img/reaction_name.png
 - `DEFAULT_SHOW_FULL_NAME`: **false**: Whether the full name of the users should be shown where possible. If the full name isn't set, the username will be used.
 - `SEARCH_REPO_DESCRIPTION`: **true**: Whether to search within description at repository search on explore page.
 - `USE_SERVICE_WORKER`: **true**: Whether to enable a Service Worker to cache frontend assets.

docs/content/page/index.en-us.md

@@ -274,7 +274,6 @@ Windows, on architectures like amd64, i386, ARM, PowerPC, and others.
   * [DropzoneJS](http://www.dropzonejs.com/)
   * [Highlight](https://highlightjs.org/)
   * [Clipboard](https://zenorocha.github.io/clipboard.js/)
-  * [Emojify](https://github.com/Ranks/emojify.js)
   * [CodeMirror](https://codemirror.net/)
   * [jQuery Date Time Picker](https://github.com/xdan/datetimepicker)
   * [jQuery MiniColors](https://github.com/claviska/jquery-minicolors)

docs/content/page/index.fr-fr.md

@@ -263,7 +263,6 @@ Le but de ce projet est de fournir de la manière la plus simple, la plus rapide
   * [DropzoneJS](http://www.dropzonejs.com/)
   * [Highlight](https://highlightjs.org/)
   * [Clipboard](https://zenorocha.github.io/clipboard.js/)
-  * [Emojify](https://github.com/Ranks/emojify.js)
   * [CodeMirror](https://codemirror.net/)
   * [jQuery Date Time Picker](https://github.com/xdan/datetimepicker)
   * [jQuery MiniColors](https://github.com/claviska/jquery-minicolors)

docs/content/page/index.zh-cn.md

@@ -56,7 +56,6 @@ Gitea的首要目标是创建一个极易安装，运行非常快速，安装和
   * [DropzoneJS](http://www.dropzonejs.com/)
   * [Highlight](https://highlightjs.org/)
   * [Clipboard](https://zenorocha.github.io/clipboard.js/)
-  * [Emojify](https://github.com/Ranks/emojify.js)
   * [CodeMirror](https://codemirror.net/)
   * [jQuery Date Time Picker](https://github.com/xdan/datetimepicker)
   * [jQuery MiniColors](https://github.com/claviska/jquery-minicolors)

docs/content/page/index.zh-tw.md

@@ -56,7 +56,6 @@ Gitea 的首要目標是建立一個容易安裝，運行快速，安装和使
   * [DropzoneJS](http://www.dropzonejs.com/)
   * [Highlight](https://highlightjs.org/)
   * [Clipboard](https://zenorocha.github.io/clipboard.js/)
-  * [Emojify](https://github.com/Ranks/emojify.js)
   * [CodeMirror](https://codemirror.net/)
   * [jQuery Date Time Picker](https://github.com/xdan/datetimepicker)
   * [jQuery MiniColors](https://github.com/claviska/jquery-minicolors)

modules/emoji/emoji.go

@@ -0,0 +1,119 @@
+// Copyright 2020 The Gitea Authors. All rights reserved.
+// Copyright 2015 Kenneth Shaw
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package emoji
+
+import (
+	"strings"
+	"sync"
+)
+
+// Gemoji is a set of emoji data.
+type Gemoji []Emoji
+
+// Emoji represents a single emoji and associated data.
+type Emoji struct {
+	Emoji          string
+	Description    string
+	Aliases        []string
+	UnicodeVersion string
+}
+
+var (
+	// codeMap provides a map of the emoji unicode code to its emoji data.
+	codeMap map[string]int
+
+	// aliasMap provides a map of the alias to its emoji data.
+	aliasMap map[string]int
+
+	// codeReplacer is the string replacer for emoji codes.
+	codeReplacer *strings.Replacer
+
+	// aliasReplacer is the string replacer for emoji aliases.
+	aliasReplacer *strings.Replacer
+
+	once sync.Once
+)
+
+func loadMap() {
+
+	once.Do(func() {
+
+		// initialize
+		codeMap = make(map[string]int, len(GemojiData))
+		aliasMap = make(map[string]int, len(GemojiData))
+
+		// process emoji codes and aliases
+		codePairs := make([]string, 0)
+		aliasPairs := make([]string, 0)
+		for i, e := range GemojiData {
+			if e.Emoji == "" || len(e.Aliases) == 0 {
+				continue
+			}
+
+			// setup codes
+			codeMap[e.Emoji] = i
+			codePairs = append(codePairs, e.Emoji, ":"+e.Aliases[0]+":")
+
+			// setup aliases
+			for _, a := range e.Aliases {
+				if a == "" {
+					continue
+				}
+
+				aliasMap[a] = i
+				aliasPairs = append(aliasPairs, ":"+a+":", e.Emoji)
+			}
+		}
+
+		// create replacers
+		codeReplacer = strings.NewReplacer(codePairs...)
+		aliasReplacer = strings.NewReplacer(aliasPairs...)
+	})
+}
+
+// FromCode retrieves the emoji data based on the provided unicode code (ie,
+// "\u2618" will return the Gemoji data for "shamrock").
+func FromCode(code string) *Emoji {
+	loadMap()
+	i, ok := codeMap[code]
+	if !ok {
+		return nil
+	}
+
+	return &GemojiData[i]
+}
+
+// FromAlias retrieves the emoji data based on the provided alias in the form
+// "alias" or ":alias:" (ie, "shamrock" or ":shamrock:" will return the Gemoji
+// data for "shamrock").
+func FromAlias(alias string) *Emoji {
+	loadMap()
+	if strings.HasPrefix(alias, ":") && strings.HasSuffix(alias, ":") {
+		alias = alias[1 : len(alias)-1]
+	}
+
+	i, ok := aliasMap[alias]
+	if !ok {
+		return nil
+	}
+
+	return &GemojiData[i]
+}
+
+// ReplaceCodes replaces all emoji codes with the first corresponding emoji
+// alias (in the form of ":alias:") (ie, "\u2618" will be converted to
+// ":shamrock:").
+func ReplaceCodes(s string) string {
+	loadMap()
+	return codeReplacer.Replace(s)
+}
+
+// ReplaceAliases replaces all aliases of the form ":alias:" with its
+// corresponding unicode value.
+func ReplaceAliases(s string) string {
+	loadMap()
+	return aliasReplacer.Replace(s)
+}