Skip to content

C
converse.js
Commit 73d33e11 authored by Ariel Fuggini's avatar Ariel Fuggini Committed by GitHub
Browse files
Options

Makes mentions case-insensitive, plus parsing functionality refactor (#2061)

parent 2009a94b
Hide whitespace changes
Inline Side-by-side
Showing with 126 additions and 90 deletions
package-lock.json
View file @ 73d33e11
...@@ -13293,9 +13293,9 @@ ...@@ -13293,9 +13293,9 @@
} }
}, },
"lerna": { "lerna": {
"version": "3.22.1", "version": "3.22.0",
"resolved": "https://registry.npmjs.org/lerna/-/lerna-3.22.1.tgz", "resolved": "https://registry.npmjs.org/lerna/-/lerna-3.22.0.tgz",
"integrity": "sha512-vk1lfVRFm+UuEFA7wkLKeSF7Iz13W+N/vFd48aW2yuS7Kv0RbNm2/qcDPV863056LMfkRlsEe+QYOw3palj5Lg==", "integrity": "sha512-xWlHdAStcqK/IjKvjsSMHPZjPkBV1lS60PmsIeObU8rLljTepc4Sg/hncw4HWfQxPIewHAUTqhrxPIsqf9L2Eg==",
"dev": true, "dev": true,
"requires": { "requires": {
"@lerna/add": "3.21.0", "@lerna/add": "3.21.0",
...@@ -13311,9 +13311,9 @@ ...@@ -13311,9 +13311,9 @@
"@lerna/init": "3.21.0", "@lerna/init": "3.21.0",
"@lerna/link": "3.21.0", "@lerna/link": "3.21.0",
"@lerna/list": "3.21.0", "@lerna/list": "3.21.0",
"@lerna/publish": "3.22.1", "@lerna/publish": "3.22.0",
"@lerna/run": "3.21.0", "@lerna/run": "3.21.0",
"@lerna/version": "3.22.1", "@lerna/version": "3.22.0",
"import-local": "^2.0.0", "import-local": "^2.0.0",
"npmlog": "^4.1.2" "npmlog": "^4.1.2"
} }
......
package.json
View file @ 73d33e11
...@@ -117,5 +117,6 @@ ...@@ -117,5 +117,6 @@
"webpack-dev-server": "^3.11.0", "webpack-dev-server": "^3.11.0",
"webpack-merge": "^4.2.1", "webpack-merge": "^4.2.1",
"xss": "^1.0.6" "xss": "^1.0.6"
} },
"dependencies": {}
} }
spec/chatbox.js
View file @ 73d33e11
...@@ -906,7 +906,7 @@ describe("Chatboxes", function () { ...@@ -906,7 +906,7 @@ describe("Chatboxes", function () {
})); }));
}); });
describe("An inactive notifciation", function () { describe("An inactive notification", function () {
it("is sent if the user has stopped typing since 2 minutes", it("is sent if the user has stopped typing since 2 minutes",
mock.initConverse( mock.initConverse(
...@@ -1056,7 +1056,7 @@ describe("Chatboxes", function () { ...@@ -1056,7 +1056,7 @@ describe("Chatboxes", function () {
})); }));
}); });
describe("A gone notifciation", function () { describe("A gone notification", function () {
it("will be shown if received", it("will be shown if received",
mock.initConverse( mock.initConverse(
......
spec/muc_messages.js
View file @ 73d33e11
...@@ -1024,15 +1024,15 @@ describe("A Groupchat Message", function () { ...@@ -1024,15 +1024,15 @@ describe("A Groupchat Message", function () {
[text, references] = view.model.parseTextForReferences('hello @z3r0') [text, references] = view.model.parseTextForReferences('hello @z3r0')
expect(references.length).toBe(1); expect(references.length).toBe(1);
expect(text).toBe('hello z3r0'); expect(text).toBe('hello z3r0');
expect(JSON.stringify(references)) expect(references)
.toBe('[{"begin":6,"end":10,"value":"z3r0","type":"mention","uri":"xmpp:z3r0@montague.lit"}]'); .toEqual([{"begin":6,"end":10,"value":"z3r0","type":"mention","uri":"xmpp:z3r0@montague.lit"}]);
[text, references] = view.model.parseTextForReferences('hello @some1 @z3r0 @gibson @mr.robot, how are you?') [text, references] = view.model.parseTextForReferences('hello @some1 @z3r0 @gibson @mr.robot, how are you?')
expect(text).toBe('hello @some1 z3r0 gibson mr.robot, how are you?'); expect(text).toBe('hello @some1 z3r0 gibson mr.robot, how are you?');
expect(JSON.stringify(references)) expect(references)
.toBe('[{"begin":13,"end":17,"value":"z3r0","type":"mention","uri":"xmpp:z3r0@montague.lit"},'+ .toEqual([{"begin":13,"end":17,"value":"z3r0","type":"mention","uri":"xmpp:z3r0@montague.lit"},
'{"begin":18,"end":24,"value":"gibson","type":"mention","uri":"xmpp:gibson@montague.lit"},'+ {"begin":18,"end":24,"value":"gibson","type":"mention","uri":"xmpp:gibson@montague.lit"},
'{"begin":25,"end":33,"value":"mr.robot","type":"mention","uri":"xmpp:mr.robot@montague.lit"}]'); {"begin":25,"end":33,"value":"mr.robot","type":"mention","uri":"xmpp:mr.robot@montague.lit"}]);
[text, references] = view.model.parseTextForReferences('yo @gib') [text, references] = view.model.parseTextForReferences('yo @gib')
expect(text).toBe('yo @gib'); expect(text).toBe('yo @gib');
...@@ -1042,43 +1042,47 @@ describe("A Groupchat Message", function () { ...@@ -1042,43 +1042,47 @@ describe("A Groupchat Message", function () {
expect(text).toBe('yo @gibsonian'); expect(text).toBe('yo @gibsonian');
expect(references.length).toBe(0); expect(references.length).toBe(0);
[text, references] = view.model.parseTextForReferences('yo @GiBsOn')
expect(text).toBe('yo gibson');
expect(references.length).toBe(1);
[text, references] = view.model.parseTextForReferences('@gibson') [text, references] = view.model.parseTextForReferences('@gibson')
expect(text).toBe('gibson'); expect(text).toBe('gibson');
expect(references.length).toBe(1); expect(references.length).toBe(1);
expect(JSON.stringify(references)) expect(references)
.toBe('[{"begin":0,"end":6,"value":"gibson","type":"mention","uri":"xmpp:gibson@montague.lit"}]'); .toEqual([{"begin":0,"end":6,"value":"gibson","type":"mention","uri":"xmpp:gibson@montague.lit"}]);
[text, references] = view.model.parseTextForReferences('hi @Link Mauve how are you?') [text, references] = view.model.parseTextForReferences('hi @Link Mauve how are you?')
expect(text).toBe('hi Link Mauve how are you?'); expect(text).toBe('hi Link Mauve how are you?');
expect(references.length).toBe(1); expect(references.length).toBe(1);
expect(JSON.stringify(references)) expect(references)
.toBe('[{"begin":3,"end":13,"value":"Link Mauve","type":"mention","uri":"xmpp:Link-Mauve@montague.lit"}]'); .toEqual([{"begin":3,"end":13,"value":"Link Mauve","type":"mention","uri":"xmpp:Link-Mauve@montague.lit"}]);
[text, references] = view.model.parseTextForReferences('https://example.org/@gibson') [text, references] = view.model.parseTextForReferences('https://example.org/@gibson')
expect(text).toBe('https://example.org/@gibson'); expect(text).toBe('https://example.org/@gibson');
expect(references.length).toBe(0); expect(references.length).toBe(0);
expect(JSON.stringify(references)) expect(references)
.toBe('[]'); .toEqual([]);
[text, references] = view.model.parseTextForReferences('mail@gibson.com') [text, references] = view.model.parseTextForReferences('mail@gibson.com')
expect(text).toBe('mail@gibson.com'); expect(text).toBe('mail@gibson.com');
expect(references.length).toBe(0); expect(references.length).toBe(0);
expect(JSON.stringify(references)) expect(references)
.toBe('[]'); .toEqual([]);
[text, references] = view.model.parseTextForReferences( [text, references] = view.model.parseTextForReferences(
'https://linkmauve.fr@Link Mauve/ https://linkmauve.fr/@github/is_back gibson@gibson.com gibson@Link Mauve.fr') 'https://linkmauve.fr@Link Mauve/ https://linkmauve.fr/@github/is_back gibson@gibson.com gibson@Link Mauve.fr')
expect(text).toBe( expect(text).toBe(
'https://linkmauve.fr@Link Mauve/ https://linkmauve.fr/@github/is_back gibson@gibson.com gibson@Link Mauve.fr'); 'https://linkmauve.fr@Link Mauve/ https://linkmauve.fr/@github/is_back gibson@gibson.com gibson@Link Mauve.fr');
expect(references.length).toBe(0); expect(references.length).toBe(0);
expect(JSON.stringify(references)) expect(references)
.toBe('[]'); .toEqual([]);
[text, references] = view.model.parseTextForReferences('@gh0st where are you?') [text, references] = view.model.parseTextForReferences('@gh0st where are you?')
expect(text).toBe('gh0st where are you?'); expect(text).toBe('gh0st where are you?');
expect(references.length).toBe(1); expect(references.length).toBe(1);
expect(JSON.stringify(references)) expect(references)
.toBe('[{"begin":0,"end":5,"value":"gh0st","type":"mention","uri":"xmpp:lounge@montague.lit/gh0st"}]'); .toEqual([{"begin":0,"end":5,"value":"gh0st","type":"mention","uri":"xmpp:lounge@montague.lit/gh0st"}]);
done(); done();
})); }));
......
src/headless/converse-muc.js
View file @ 73d33e11
...@@ -15,6 +15,7 @@ import log from "./log"; ...@@ -15,6 +15,7 @@ import log from "./log";
import muc_utils from "./utils/muc"; import muc_utils from "./utils/muc";
import st from "./utils/stanza"; import st from "./utils/stanza";
import u from "./utils/form"; import u from "./utils/form";
import p from "./utils/parse-helpers";
export const ROLES = ['moderator', 'participant', 'visitor']; export const ROLES = ['moderator', 'participant', 'visitor'];
export const AFFILIATIONS = ['owner', 'admin', 'member', 'outcast', 'none']; export const AFFILIATIONS = ['owner', 'admin', 'member', 'outcast', 'none'];
...@@ -941,74 +942,61 @@ converse.plugins.add('converse-muc', { ...@@ -941,74 +942,61 @@ converse.plugins.add('converse-muc', {
])].filter(n => n); ])].filter(n => n);
}, },
getReferenceForMention (mention, index) { getAllKnownNicknamesRegex () {
const nicknames = this.getAllKnownNicknames(); const longNickString = this.getAllKnownNicknames().join('|');
const longest_match = u.getLongestSubstring(mention, nicknames); const escapedLongNickString = p.escapeRegexString(longNickString)
if (!longest_match) { return RegExp(`(?:\\s|^)@(${escapedLongNickString})(?![\\w@-])`, 'ig');
return null; },
}
if ((mention[longest_match.length] || '').match(/[A-Za-zäëïöüâêîôûáéíóúàèìòùÄËÏÖÜÂÊÎÔÛÁÉÍÓÚÀÈÌÒÙ0-9]/i)) {
// avoid false positives, i.e. mentions that have
// further alphabetical characters than our longest
// match.
return null;
}
let uri;
const occupant = this.occupants.findOccupant({'nick': longest_match}) ||
u.isValidJID(longest_match) && this.occupants.findOccupant({'jid': longest_match});
if (occupant) { getOccupantByJID (jid) {
uri = occupant.get('jid') || `${this.get('jid')}/${occupant.get('nick')}`; return this.occupants.findOccupant({ jid });
} else if (nicknames.includes(longest_match)) {
// TODO: show a warning to the user that the person is not currently in the chat
uri = `${this.get('jid')}/${longest_match}`;
} else {
return;
}
const obj = {
'begin': index,
'end': index + longest_match.length,
'value': longest_match,
'type': 'mention',
'uri': encodeURI(`xmpp:${uri}`)
};
return obj;
}, },
extractReference (text, index) { getOccupantByNickname (nick) {
for (let i=index; i<text.length; i++) { return this.occupants.findOccupant({ nick });
if (text[i] === '@' && (i === 0 || text[i - 1] === ' ')) {
const match = text.slice(i+1),
ref = this.getReferenceForMention(match, i);
if (ref) {
return [text.slice(0, i) + match, ref, i]
}
}
}
return;
}, },
parseTextForReferences (text) { parseTextForReferences (original_message) {
const refs = []; if (!original_message) return ['', []];
let index = 0; const findRegexInMessage = p.matchRegexInText(original_message);
while (index < (text || '').length) { const raw_mentions = findRegexInMessage(p.mention_regex);
const result = this.extractReference(text, index); if (!raw_mentions) return [original_message, []];
if (result) {
text = result[0]; // @ gets filtered out const known_nicknames = this.getAllKnownNicknames();
refs.push(result[1]); const known_nicknames_with_at_regex = this.getAllKnownNicknamesRegex();
index = result[2]; const getMatchesForNickRegex = nick_regex => [...findRegexInMessage(nick_regex)];
} else { const getNicknameFromRegex = p.findFirstMatchInArray(known_nicknames);
break;
} const uriFromNickname = nickname => {
const jid = this.get('jid');
const occupant = this.getOccupant(nickname) || this.getOccupant(jid);
const uri = (occupant && occupant.get('jid')) || `${jid}/${nickname}`;
return encodeURI(`xmpp:${uri}`);
};
const matchToReference = match => {
const at_sign_index = match[0].indexOf('@');
const begin = match.index + at_sign_index;
const end = begin + match[0].length - at_sign_index;
const value = getNicknameFromRegex(RegExp(match[1], 'i'));
const type = 'mention';
const uri = uriFromNickname(value);
return { begin, end, value, type, uri }
} }
return [text, refs];
const mentions = getMatchesForNickRegex(known_nicknames_with_at_regex);
const references = mentions.map(matchToReference);
const [updated_message, updated_references] = p.reduceTextFromReferences(
original_message,
references
);
return [updated_message, updated_references];
}, },
getOutgoingMessageAttributes (text, spoiler_hint) { getOutgoingMessageAttributes (original_message, spoiler_hint) {
const is_spoiler = this.get('composing_spoiler'); const is_spoiler = this.get('composing_spoiler');
var references; const [text, references] = this.parseTextForReferences(original_message);
[text, references] = this.parseTextForReferences(text);
const origin_id = u.getUniqueId(); const origin_id = u.getUniqueId();
const body = text ? u.httpToGeoUri(u.shortnameToUnicode(text), _converse) : undefined; const body = text ? u.httpToGeoUri(u.shortnameToUnicode(text), _converse) : undefined;
return { return {
...@@ -1393,13 +1381,13 @@ converse.plugins.add('converse-muc', { ...@@ -1393,13 +1381,13 @@ converse.plugins.add('converse-muc', {
/** /**
* @private * @private
* @method _converse.ChatRoom#getOccupant * @method _converse.ChatRoom#getOccupant
* @param { String } nick_or_jid - The nickname or JID of the occupant to be returned * @param { String } nickname_or_jid - The nickname or JID of the occupant to be returned
* @returns { _converse.ChatRoomOccupant } * @returns { _converse.ChatRoomOccupant }
*/ */
getOccupant (nick_or_jid) { getOccupant (nickname_or_jid) {
return (u.isValidJID(nick_or_jid) && return u.isValidJID(nickname_or_jid)
this.occupants.findWhere({'jid': nick_or_jid})) || ? this.getOccupantByJID(nickname_or_jid)
this.occupants.findWhere({'nick': nick_or_jid}); : this.getOccupantByNickname(nickname_or_jid);
}, },
/** /**
......
src/headless/utils/parse-helpers.js 0 → 100644
View file @ 73d33e11
/**
* @copyright 2020, the Converse.js contributors
* @license Mozilla Public License (MPLv2)
* @description Pure functions to help funcitonally parse messages.
* @todo Other parsing helpers can be made more abstract and placed here.
*/
const helpers = {};
// Captures all mentions, but includes a space before the @
helpers.mention_regex = /(?:\s|^)([@][\w_-]+(?:\.\w+)*)/ig;
helpers.matchRegexInText = text => regex => text.matchAll(regex);
const escapeRegexChars = (string, char) => string.replace(RegExp('\\' + char, 'ig'), '\\' + char);
helpers.escapeCharacters = characters => string =>
characters.split('').reduce(escapeRegexChars, string);
helpers.escapeRegexString = helpers.escapeCharacters('[\\^$.?*+(){}');
// `for` is ~25% faster than using `Array.find()`
helpers.findFirstMatchInArray = array => regex => {
for (let i = 0; i < array.length; i++) {
if (regex.test(array[i])) {
return array[i];
}
}
return null;
};
const reduceReferences = ([text, refs], ref, index) => {
let updated_text = text;
let { begin, end } = ref;
const { value } = ref;
begin = begin - index;
end = end - index - 1; // -1 to compensate for the removed @
updated_text = `${updated_text.slice(0, begin)}${value}${updated_text.slice(end + 1)}`;
return [updated_text, [...refs, { ...ref, begin, end }]]
}
helpers.reduceTextFromReferences = (text, refs) => refs.reduce(reduceReferences, [text, []]);
export default helpers;
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7