2017-06-01 17:18:06 +03:00
|
|
|
/*
|
2017-06-01 19:29:40 +03:00
|
|
|
Copyright 2016 Aviral Dasgupta
|
2017-06-01 17:18:06 +03:00
|
|
|
Copyright 2017 Vector Creations Ltd
|
2018-06-19 14:06:13 +03:00
|
|
|
Copyright 2017, 2018 New Vector Ltd
|
2017-06-01 17:18:06 +03:00
|
|
|
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
|
you may not use this file except in compliance with the License.
|
|
|
|
You may obtain a copy of the License at
|
|
|
|
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
See the License for the specific language governing permissions and
|
|
|
|
limitations under the License.
|
|
|
|
*/
|
|
|
|
|
2016-07-03 19:45:13 +03:00
|
|
|
import React from 'react';
|
2017-05-25 13:39:08 +03:00
|
|
|
import { _t } from '../languageHandler';
|
2016-06-17 02:28:09 +03:00
|
|
|
import AutocompleteProvider from './AutocompleteProvider';
|
2018-08-13 21:15:42 +03:00
|
|
|
import QueryMatcher from './QueryMatcher';
|
2016-08-17 14:57:19 +03:00
|
|
|
import sdk from '../index';
|
|
|
|
import {PillCompletion} from './Components';
|
2018-06-19 14:06:13 +03:00
|
|
|
import type {Completion, SelectionRange} from './Autocompleter';
|
2017-07-19 18:54:58 +03:00
|
|
|
import _uniq from 'lodash/uniq';
|
|
|
|
import _sortBy from 'lodash/sortBy';
|
2017-10-29 10:43:52 +03:00
|
|
|
import SettingsStore from "../settings/SettingsStore";
|
2019-05-19 18:11:12 +03:00
|
|
|
import { shortcodeToUnicode } from '../HtmlUtils';
|
2016-06-17 02:28:09 +03:00
|
|
|
|
2019-05-19 17:23:43 +03:00
|
|
|
import UNICODE_REGEX from 'emojibase-regex';
|
|
|
|
import EMOTICON_REGEX from 'emojibase-regex/emoticon';
|
|
|
|
import SHORTCODE_REGEX from 'emojibase-regex/shortcode';
|
2017-06-28 13:35:14 +03:00
|
|
|
import EmojiData from '../stripped-emoji.json';
|
2017-06-27 22:13:48 +03:00
|
|
|
|
|
|
|
const LIMIT = 20;
|
|
|
|
const CATEGORY_ORDER = [
|
2017-06-28 13:19:16 +03:00
|
|
|
'people',
|
|
|
|
'food',
|
|
|
|
'objects',
|
|
|
|
'activity',
|
|
|
|
'nature',
|
|
|
|
'travel',
|
|
|
|
'flags',
|
2017-07-11 16:06:15 +03:00
|
|
|
'regional',
|
2017-06-28 13:19:16 +03:00
|
|
|
'symbols',
|
|
|
|
'modifier',
|
2017-06-27 22:13:48 +03:00
|
|
|
];
|
|
|
|
|
2019-05-19 17:23:43 +03:00
|
|
|
// Match for ":wink:" or ascii-style ";-)" provided by emojibase
|
2017-07-07 21:02:51 +03:00
|
|
|
// (^|\s|(emojiUnicode)) to make sure we're either at the start of the string or there's a
|
|
|
|
// whitespace character or an emoji before the emoji. The reason for unicodeRegexp is
|
|
|
|
// that we need to support inputting multiple emoji with no space between them.
|
2019-05-19 17:23:43 +03:00
|
|
|
const EMOJI_REGEX = new RegExp('(?:^|\\s|' + UNICODE_REGEX + ')(' + EMOTICON_REGEX + '|:[+-\\w]*:?)$', 'g');
|
2017-07-07 21:02:51 +03:00
|
|
|
|
|
|
|
// We also need to match the non-zero-length prefixes to remove them from the final match,
|
|
|
|
// and update the range so that we don't replace the whitespace or the previous emoji.
|
2019-05-19 17:23:43 +03:00
|
|
|
const MATCH_PREFIX_REGEX = new RegExp('(\\s|' + UNICODE_REGEX + ')');
|
2017-07-07 21:02:51 +03:00
|
|
|
|
2017-06-28 13:19:16 +03:00
|
|
|
const EMOJI_SHORTNAMES = Object.keys(EmojiData).map((key) => EmojiData[key]).sort(
|
2017-06-27 22:13:48 +03:00
|
|
|
(a, b) => {
|
|
|
|
if (a.category === b.category) {
|
2017-06-28 13:19:16 +03:00
|
|
|
return a.emoji_order - b.emoji_order;
|
2017-06-27 22:13:48 +03:00
|
|
|
}
|
|
|
|
return CATEGORY_ORDER.indexOf(a.category) - CATEGORY_ORDER.indexOf(b.category);
|
|
|
|
},
|
2017-07-19 18:54:58 +03:00
|
|
|
).map((a, index) => {
|
2017-02-10 21:05:13 +03:00
|
|
|
return {
|
2017-06-28 13:19:16 +03:00
|
|
|
name: a.name,
|
|
|
|
shortname: a.shortname,
|
2018-07-24 19:06:45 +03:00
|
|
|
aliases: a.aliases ? a.aliases.join(' ') : '',
|
2017-06-29 13:29:55 +03:00
|
|
|
aliases_ascii: a.aliases_ascii ? a.aliases_ascii.join(' ') : '',
|
2017-07-20 12:51:15 +03:00
|
|
|
// Include the index so that we can preserve the original order
|
2017-07-19 18:54:58 +03:00
|
|
|
_orderBy: index,
|
2017-02-10 21:05:13 +03:00
|
|
|
};
|
|
|
|
});
|
2016-06-17 02:28:09 +03:00
|
|
|
|
2017-08-01 19:36:41 +03:00
|
|
|
function score(query, space) {
|
|
|
|
const index = space.indexOf(query);
|
|
|
|
if (index === -1) {
|
|
|
|
return Infinity;
|
|
|
|
} else {
|
|
|
|
return index;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-06-17 02:28:09 +03:00
|
|
|
export default class EmojiProvider extends AutocompleteProvider {
|
|
|
|
constructor() {
|
2016-06-21 13:16:20 +03:00
|
|
|
super(EMOJI_REGEX);
|
2018-08-13 21:15:42 +03:00
|
|
|
this.matcher = new QueryMatcher(EMOJI_SHORTNAMES, {
|
2018-07-24 19:06:45 +03:00
|
|
|
keys: ['aliases_ascii', 'shortname', 'aliases'],
|
2017-06-29 13:29:55 +03:00
|
|
|
// For matching against ascii equivalents
|
|
|
|
shouldMatchWordsOnly: false,
|
2017-02-10 21:05:13 +03:00
|
|
|
});
|
2018-08-13 21:15:42 +03:00
|
|
|
this.nameMatcher = new QueryMatcher(EMOJI_SHORTNAMES, {
|
2017-07-19 18:54:58 +03:00
|
|
|
keys: ['name'],
|
|
|
|
// For removing punctuation
|
|
|
|
shouldMatchWordsOnly: true,
|
|
|
|
});
|
2016-06-17 02:28:09 +03:00
|
|
|
}
|
|
|
|
|
2018-06-19 14:06:13 +03:00
|
|
|
async getCompletions(query: string, selection: SelectionRange, force?: boolean): Array<Completion> {
|
2019-01-25 06:57:40 +03:00
|
|
|
if (!SettingsStore.getValue("MessageComposerInput.suggestEmoji")) {
|
2017-09-15 06:28:12 +03:00
|
|
|
return []; // don't give any suggestions if the user doesn't want them
|
|
|
|
}
|
|
|
|
|
2016-06-17 02:28:09 +03:00
|
|
|
let completions = [];
|
2017-07-07 21:02:51 +03:00
|
|
|
const {command, range} = this.getCurrentCommand(query, selection);
|
2016-07-03 19:45:13 +03:00
|
|
|
if (command) {
|
2017-07-07 21:02:51 +03:00
|
|
|
let matchedString = command[0];
|
|
|
|
|
|
|
|
// Remove prefix of any length (single whitespace or unicode emoji)
|
|
|
|
const prefixMatch = MATCH_PREFIX_REGEX.exec(matchedString);
|
|
|
|
if (prefixMatch) {
|
|
|
|
matchedString = matchedString.slice(prefixMatch[0].length);
|
|
|
|
range.start += prefixMatch[0].length;
|
|
|
|
}
|
2017-07-19 18:54:58 +03:00
|
|
|
completions = this.matcher.match(matchedString);
|
2017-07-07 21:02:51 +03:00
|
|
|
|
2017-07-19 18:54:58 +03:00
|
|
|
// Do second match with shouldMatchWordsOnly in order to match against 'name'
|
|
|
|
completions = completions.concat(this.nameMatcher.match(matchedString));
|
2017-08-01 19:36:41 +03:00
|
|
|
|
|
|
|
const sorters = [];
|
2017-08-02 12:09:00 +03:00
|
|
|
// First, sort by score (Infinity if matchedString not in shortname)
|
|
|
|
sorters.push((c) => score(matchedString, c.shortname));
|
|
|
|
// If the matchedString is not empty, sort by length of shortname. Example:
|
|
|
|
// matchedString = ":bookmark"
|
2017-08-01 19:36:41 +03:00
|
|
|
// completions = [":bookmark:", ":bookmark_tabs:", ...]
|
2017-08-02 12:09:00 +03:00
|
|
|
if (matchedString.length > 1) {
|
2017-08-01 19:36:41 +03:00
|
|
|
sorters.push((c) => c.shortname.length);
|
|
|
|
}
|
|
|
|
// Finally, sort by original ordering
|
|
|
|
sorters.push((c) => c._orderBy);
|
|
|
|
completions = _sortBy(_uniq(completions), sorters);
|
|
|
|
|
2017-07-19 18:54:58 +03:00
|
|
|
completions = completions.map((result) => {
|
2019-05-19 17:23:43 +03:00
|
|
|
const { shortname } = result;
|
|
|
|
const unicode = shortcodeToUnicode(shortname);
|
2016-06-17 02:28:09 +03:00
|
|
|
return {
|
2016-08-17 14:57:19 +03:00
|
|
|
completion: unicode,
|
2016-06-17 02:28:09 +03:00
|
|
|
component: (
|
2019-05-19 17:23:43 +03:00
|
|
|
<PillCompletion title={shortname} initialComponent={<span style={{maxWidth: '1em'}}>{ unicode }</span>} />
|
2016-07-03 19:45:13 +03:00
|
|
|
),
|
|
|
|
range,
|
2016-06-17 02:28:09 +03:00
|
|
|
};
|
2017-06-27 22:13:48 +03:00
|
|
|
}).slice(0, LIMIT);
|
2016-06-17 02:28:09 +03:00
|
|
|
}
|
2016-09-13 13:11:52 +03:00
|
|
|
return completions;
|
2016-06-17 02:28:09 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
getName() {
|
2017-05-23 17:16:31 +03:00
|
|
|
return '😃 ' + _t('Emoji');
|
2016-06-17 02:28:09 +03:00
|
|
|
}
|
2016-06-20 11:22:55 +03:00
|
|
|
|
2016-08-17 14:57:19 +03:00
|
|
|
renderCompletions(completions: [React.Component]): ?React.Component {
|
2017-07-19 18:20:57 +03:00
|
|
|
return <div className="mx_Autocomplete_Completion_container_pill">
|
2017-10-11 19:56:17 +03:00
|
|
|
{ completions }
|
2016-08-22 22:06:31 +03:00
|
|
|
</div>;
|
2016-08-17 14:57:19 +03:00
|
|
|
}
|
2016-06-17 02:28:09 +03:00
|
|
|
}
|