zulip/static/js/alert_words.js

71 lines
2.6 KiB
JavaScript

import _ from "lodash";
import * as people from "./people";
// For simplicity, we use a list for our internal
// data, since that matches what the server sends us.
let my_alert_words = [];
export function set_words(words) {
my_alert_words = words;
}
export function get_word_list() {
// People usually only have a couple alert
// words, so it's cheap to be defensive
// here and give a copy of the list to
// our caller (in case they want to sort it
// or something).
return [...my_alert_words];
}
export function has_alert_word(word) {
return my_alert_words.includes(word);
}
export function process_message(message) {
// Parsing for alert words is expensive, so we rely on the host
// to tell us there any alert words to even look for.
if (!message.alerted) {
return;
}
for (const word of my_alert_words) {
const clean = _.escapeRegExp(word);
const before_punctuation = "\\s|^|>|[\\(\\\".,';\\[]";
const after_punctuation = "\\s|$|<|[\\)\\\"\\?!:.,';\\]!]";
const regex = new RegExp(`(${before_punctuation})(${clean})(${after_punctuation})`, "ig");
message.content = message.content.replace(
regex,
(match, before, word, after, offset, content) => {
// Logic for ensuring that we don't muck up rendered HTML.
const pre_match = content.slice(0, offset);
// We want to find the position of the `<` and `>` only in the
// match and the string before it. So, don't include the last
// character of match in `check_string`. This covers the corner
// case when there is an alert word just before `<` or `>`.
const check_string = pre_match + match.slice(0, -1);
const in_tag = check_string.lastIndexOf("<") > check_string.lastIndexOf(">");
// Matched word is inside a HTML tag so don't perform any highlighting.
if (in_tag === true) {
return before + word + after;
}
return before + "<span class='alert-word'>" + word + "</span>" + after;
},
);
}
}
export function notifies(message) {
// We exclude ourselves from notifications when we type one of our own
// alert words into a message, just because that can be annoying for
// certain types of workflows where everybody on your team, including
// yourself, sets up an alert word to effectively mention the team.
return !people.is_current_user(message.sender_email) && message.alerted;
}
export const initialize = (params) => {
my_alert_words = params.alert_words;
};