MDL-65896 core: add emoji data to thirdpartylibs

.eslintignore

@@ -62,6 +62,7 @@ lib/amd/src/popper.js
 lib/geopattern-php/
 lib/php-jwt/
 lib/babel-polyfill/
+lib/emoji-data/
 media/player/videojs/amd/src/video-lazy.js
 media/player/videojs/amd/src/Youtube-lazy.js
 media/player/videojs/videojs/

.stylelintignore

@@ -63,6 +63,7 @@ lib/amd/src/popper.js
 lib/geopattern-php/
 lib/php-jwt/
 lib/babel-polyfill/
+lib/emoji-data/
 media/player/videojs/amd/src/video-lazy.js
 media/player/videojs/amd/src/Youtube-lazy.js
 media/player/videojs/videojs/

lib/emoji-data/data.js.mustache

@@ -0,0 +1,25 @@
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle 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 General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Emoji data based on the data available from https://github.com/iamcal/emoji-data.
+ *
+ * @copyright  2019 Ryan Wyllie <[email protected]>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+export const byCategory = {{{byCategory}}};
+
+export const byShortName = {{{byShortName}}};

lib/emoji-data/generate_emoji_data.php

@@ -0,0 +1,125 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle 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 General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * @copyright 2019 Ryan Wyllie <[email protected]>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+define('CLI_SCRIPT', true);
+
+require(__DIR__.'/../../config.php');
+
+$categorysortorder = [
+    'Smileys & People',
+    'Animals & Nature',
+    'Food & Drink',
+    'Travel & Places',
+    'Activities',
+    'Objects',
+    'Symbols',
+    'Flags'
+];
+
+// Source: https://github.com/iamcal/emoji-data
+$rawdata = file_get_contents('./emoji_pretty.json');
+$jsondata = json_decode($rawdata, true);
+$emojibycategory = [];
+$obsoletes = [];
+
+foreach ($jsondata as $data) {
+    $category = $data['category'];
+    $unified = $data['unified'];
+
+    if ($category === 'Skin Tones') {
+        continue;
+    }
+
+    if (!empty($data['obsoleted_by'])) {
+        // Skip any obsolete emojis. We'll merge these short names into the
+        // newer emoji later on.
+        $obsoletes[] = [
+            'shortname' => $data['short_name'],
+            'by' => $data['obsoleted_by']
+        ];
+        continue;
+    }
+
+    if (!isset($emojibycategory[$category])) {
+        $emojibycategory[$category] = [
+            'name' => $category,
+            'emojis' => []
+        ];
+    }
+
+    $emojibycategory[$category]['emojis'][] = [
+        'sortorder' => (int) $data['sort_order'],
+        'unified' => $unified,
+        'shortnames' => [$data['short_name']]
+    ];
+}
+
+$emojibycategory = array_values($emojibycategory);
+// Sort the emojis within each category into the order specified in the raw data.
+$emojibycategory = array_map(function($category) {
+    usort($category['emojis'], function($a, $b) {
+        return $a['sortorder'] <=> $b['sortorder'];
+    });
+    return $category;
+}, $emojibycategory);
+
+// Add the short names for the obsoleted emojis into the list of short names
+// of the newer emoji.
+foreach ($obsoletes as $obsolete) {
+    $emojibycategory = array_map(function($category) use ($obsolete) {
+        $category['emojis'] = array_map(function($emoji) use ($obsolete) {
+            if ($obsolete['by'] == $emoji['unified']) {
+                $emoji['shortnames'] = array_merge($emoji['shortnames'], [$obsolete['shortname']]);
+            }
+            unset($emoji['sortorder']);
+            return $emoji;
+        }, $category['emojis']);
+        return $category;
+    }, $emojibycategory);
+}
+// Sort the emoji categories into the correct order.
+usort($emojibycategory, function($a, $b) use ($categorysortorder) {
+    $aindex = array_search($a['name'], $categorysortorder);
+    $bindex = array_search($b['name'], $categorysortorder);
+    return $aindex <=> $bindex;
+});
+
+$emojibyshortname = array_reduce($jsondata, function($carry, $data) {
+    $unified = null;
+    $shortname = $data['short_name'];
+    if (!empty($data['obsoleted_by'])) {
+        $unified = $data['obsoleted_by'];
+    } else {
+        $unified = $data['unified'];
+    }
+    $carry[$shortname] = $unified;
+    return $carry;
+}, []);
+
+$loader = new \Mustache_Loader_ArrayLoader([
+    'data.js' => file_get_contents('./data.js.mustache')
+]);
+$mustache = new \core\output\mustache_engine(['loader' => $loader]);
+
+echo $mustache->render('data.js', [
+    'byCategory' => json_encode($emojibycategory, JSON_PRETTY_PRINT),
+    'byShortName' => json_encode($emojibyshortname, JSON_PRETTY_PRINT)
+]);

lib/emoji-data/readme_moodle.txt

@@ -0,0 +1,13 @@
+Description of emoji data import into Moodle.
+
+1. Download the latest release of emoji data from https://github.com/iamcal/emoji-data/releases
+
+2. Copy emoji_pretty.json into lib/emoji-data/
+
+3. Run the generate_emoji_data.php script to create the new data.js file
+   E.g. php lib/emoji-data/generate_emoji_data.php > lib/amd/src/emoji/data.js
+
+4. Build the new emoji data.js file
+   E.g. grunt amd --files=lib/amd/src/emoji/data.js
+
+5. Delete the emoji_pretty.json file from step 3

lib/thirdpartylibs.xml

@@ -308,4 +308,10 @@
     <license>MIT</license>
     <version>6.26.0</version>
   </library>
+  <library>
+    <location>emoji-data</location>
+    <name>Emoji data</name>
+    <license>MIT</license>
+    <version>4.1.0</version>
+  </library>
 </libraries>