import $ from "jquery"; import * as resolved_topic from "../shared/src/resolved_topic"; import render_compose_banner from "../templates/compose_banner/compose_banner.hbs"; import render_not_subscribed_warning from "../templates/compose_banner/not_subscribed_warning.hbs"; import render_private_stream_warning from "../templates/compose_banner/private_stream_warning.hbs"; import render_wildcard_warning from "../templates/compose_banner/wildcard_warning.hbs"; import * as channel from "./channel"; import * as compose_banner from "./compose_banner"; import * as compose_pm_pill from "./compose_pm_pill"; import * as compose_state from "./compose_state"; import * as compose_ui from "./compose_ui"; import {$t} from "./i18n"; import {page_params} from "./page_params"; import * as peer_data from "./peer_data"; import * as people from "./people"; import * as settings_config from "./settings_config"; import * as settings_data from "./settings_data"; import * as stream_data from "./stream_data"; import * as sub_store from "./sub_store"; import * as util from "./util"; let user_acknowledged_wildcard = false; export let wildcard_mention_large_stream_threshold = 15; export function needs_subscribe_warning(user_id, stream_id) { // This returns true if all of these conditions are met: // * the user is valid // * the user is not already subscribed to the stream // * the user has no back-door way to see stream messages // (i.e. bots on public/private streams) // // You can think of this as roughly answering "is there an // actionable way to subscribe the user and do they actually // need it?". // // We expect the caller to already have verified that we're // sending to a valid stream and trying to mention the user. const user = people.get_by_user_id(user_id); if (!user) { return false; } if (user.is_bot) { // Bots may receive messages on public/private streams even if they are // not subscribed. return false; } if (stream_data.is_user_subscribed(stream_id, user_id)) { // If our user is already subscribed return false; } return true; } export function warn_if_private_stream_is_linked(linked_stream, $textarea) { // For PMs, we currently don't warn about links to private // streams, since you are specifically sharing the existence of // the private stream with someone. One could imagine changing // this policy if user feedback suggested it was useful. if (compose_state.get_message_type() !== "stream") { return; } const compose_stream = stream_data.get_sub(compose_state.stream_name()); if (compose_stream === undefined) { // We have an invalid stream name, don't warn about this here as // we show an error to the user when they try to send the message. return; } // If the stream we're linking to is not invite-only, then it's // public, and there is no need to warn about it, since all // members can already see all the public streams. // // Theoretically, we could still do a warning if there are any // guest users subscribed to the stream we're posting to; we may // change this policy if user feedback suggests it'd be an // improvement. if (!linked_stream.invite_only) { return; } // Don't warn if subscribers list of current compose_stream is // a subset of linked_stream's subscribers list, because // everyone will be subscribed to the linked stream and so // knows it exists. (But always warn Zephyr users, since // we may not know their stream's subscribers.) if ( peer_data.is_subscriber_subset(compose_stream.stream_id, linked_stream.stream_id) && !page_params.realm_is_zephyr_mirror_realm ) { return; } const new_row = render_private_stream_warning({ banner_type: compose_banner.WARNING, stream_name: linked_stream.name, classname: compose_banner.CLASSNAMES.private_stream_warning, }); const $container = compose_banner.get_compose_banner_container($textarea); compose_banner.append_compose_banner_to_banner_list(new_row, $container); } export function warn_if_mentioning_unsubscribed_user(mentioned, $textarea) { if (compose_state.get_message_type() !== "stream") { return; } // Disable for Zephyr mirroring realms, since we never have subscriber lists there if (page_params.realm_is_zephyr_mirror_realm) { return; } const user_id = mentioned.user_id; if (mentioned.is_broadcast) { return; // don't check if @all/@everyone/@stream } const stream_name = compose_state.stream_name(); if (!stream_name) { return; } const sub = stream_data.get_sub(stream_name); if (!sub) { return; } if (needs_subscribe_warning(user_id, sub.stream_id)) { const $banner_container = compose_banner.get_compose_banner_container($textarea); const $existing_invites_area = $banner_container.find( `.${CSS.escape(compose_banner.CLASSNAMES.recipient_not_subscribed)}`, ); const existing_invites = [...$existing_invites_area].map((user_row) => Number.parseInt($(user_row).data("user-id"), 10), ); const can_subscribe_other_users = settings_data.user_can_subscribe_other_users(); if (!existing_invites.includes(user_id)) { const context = { user_id, stream_id: sub.stream_id, banner_type: compose_banner.WARNING, button_text: can_subscribe_other_users ? $t({defaultMessage: "Subscribe them"}) : null, can_subscribe_other_users, name: mentioned.full_name, classname: compose_banner.CLASSNAMES.recipient_not_subscribed, }; const new_row = render_not_subscribed_warning(context); const $container = compose_banner.get_compose_banner_container($textarea); compose_banner.append_compose_banner_to_banner_list(new_row, $container); } } } // Called when clearing the compose box and similar contexts to clear // the warning for composing to a resolved topic, if present. Also clears // the state for whether this warning has already been shown in the // current narrow. export function clear_topic_resolved_warning() { compose_state.set_recipient_viewed_topic_resolved_banner(false); $(`#compose_banners .${CSS.escape(compose_banner.CLASSNAMES.topic_resolved)}`).remove(); } export function warn_if_topic_resolved(topic_changed) { if (compose_state.recipient_has_topics()) { return; } // This function is called with topic_changed=false on every // keypress when typing a message, so it should not do anything // expensive in that case. // // Pass topic_changed=true if this function was called in response // to a topic being edited. const topic_name = compose_state.topic(); if (!topic_changed && !resolved_topic.is_resolved(topic_name)) { // The resolved topic warning will only ever appear when // composing to a resolve topic, so we return early without // inspecting additional fields in this case. return; } const stream_name = compose_state.stream_name(); const message_content = compose_state.message_content(); const sub = stream_data.get_sub(stream_name); if (sub && message_content !== "" && resolved_topic.is_resolved(topic_name)) { if (compose_state.has_recipient_viewed_topic_resolved_banner()) { // We display the resolved topic banner at most once per narrow. return; } const button_text = settings_data.user_can_move_messages_to_another_topic() ? $t({defaultMessage: "Unresolve topic"}) : null; const context = { banner_type: compose_banner.WARNING, stream_id: sub.stream_id, topic_name, banner_text: $t({ defaultMessage: "You are sending a message to a resolved topic. You can send as-is or unresolve the topic first.", }), button_text, classname: compose_banner.CLASSNAMES.topic_resolved, }; const new_row = render_compose_banner(context); compose_banner.append_compose_banner_to_banner_list(new_row, $("#compose_banners")); compose_state.set_recipient_viewed_topic_resolved_banner(true); } else { clear_topic_resolved_warning(); } } function show_wildcard_warnings(opts) { const subscriber_count = peer_data.get_subscriber_count(opts.stream_id) || 0; const stream_name = sub_store.maybe_get_stream_name(opts.stream_id); const is_edit_container = opts.$banner_container.closest(".edit_form_banners").length > 0; const classname = compose_banner.CLASSNAMES.wildcard_warning; let button_text = opts.scheduling_message ? $t({defaultMessage: "Yes, schedule"}) : $t({defaultMessage: "Yes, send"}); if (is_edit_container) { button_text = $t({defaultMessage: "Yes, save"}); } const wildcard_template = render_wildcard_warning({ banner_type: compose_banner.WARNING, subscriber_count, stream_name, wildcard_mention: opts.wildcard_mention, button_text, hide_close_button: true, classname, scheduling_message: opts.scheduling_message, }); // only show one error for any number of @all or @everyone mentions if (opts.$banner_container.find(`.${CSS.escape(classname)}`).length === 0) { compose_banner.append_compose_banner_to_banner_list( wildcard_template, opts.$banner_container, ); } else { // if there is already a banner, replace it with the new one compose_banner.update_or_append_banner( wildcard_template, classname, opts.$banner_container, ); } user_acknowledged_wildcard = false; } export function clear_wildcard_warnings($banner_container) { const classname = compose_banner.CLASSNAMES.wildcard_warning; $banner_container.find(`.${CSS.escape(classname)}`).remove(); } export function set_user_acknowledged_wildcard_flag(value) { user_acknowledged_wildcard = value; } export function get_invalid_recipient_emails() { const private_recipients = util.extract_pm_recipients( compose_state.private_message_recipient(), ); const invalid_recipients = private_recipients.filter( (email) => !people.is_valid_email_for_compose(email), ); return invalid_recipients; } function check_unsubscribed_stream_for_send(stream_name, autosubscribe) { let result; if (!autosubscribe) { return "not-subscribed"; } // In the rare circumstance of the autosubscribe option, we // *Synchronously* try to subscribe to the stream before sending // the message. This is deprecated and we hope to remove it; see // #4650. channel.post({ url: "/json/subscriptions/exists", data: {stream: stream_name, autosubscribe: true}, async: false, success(data) { if (data.subscribed) { result = "subscribed"; } else { result = "not-subscribed"; } }, error(xhr) { if (xhr.status === 404) { result = "does-not-exist"; } else { result = "error"; } }, }); return result; } export function wildcard_mention_allowed() { if ( page_params.realm_wildcard_mention_policy === settings_config.wildcard_mention_policy_values.by_everyone.code ) { return true; } if ( page_params.realm_wildcard_mention_policy === settings_config.wildcard_mention_policy_values.nobody.code ) { return false; } if ( page_params.realm_wildcard_mention_policy === settings_config.wildcard_mention_policy_values.by_admins_only.code ) { return page_params.is_admin; } if ( page_params.realm_wildcard_mention_policy === settings_config.wildcard_mention_policy_values.by_moderators_only.code ) { return page_params.is_admin || page_params.is_moderator; } if ( page_params.realm_wildcard_mention_policy === settings_config.wildcard_mention_policy_values.by_full_members.code ) { if (page_params.is_admin) { return true; } const person = people.get_by_user_id(page_params.user_id); const current_datetime = new Date(Date.now()); const person_date_joined = new Date(person.date_joined); const days = (current_datetime - person_date_joined) / 1000 / 86400; return days >= page_params.realm_waiting_period_threshold && !page_params.is_guest; } return !page_params.is_guest; } export function set_wildcard_mention_large_stream_threshold(value) { wildcard_mention_large_stream_threshold = value; } export function validate_stream_message_mentions(opts) { const subscriber_count = peer_data.get_subscriber_count(opts.stream_id) || 0; // If the user is attempting to do a wildcard mention in a large // stream, check if they permission to do so. if ( opts.wildcard_mention !== null && subscriber_count > wildcard_mention_large_stream_threshold ) { if (!wildcard_mention_allowed()) { compose_banner.show_error_message( $t({ defaultMessage: "You do not have permission to use wildcard mentions in this stream.", }), compose_banner.CLASSNAMES.wildcards_not_allowed, opts.$banner_container, ); return false; } if (!user_acknowledged_wildcard) { show_wildcard_warnings(opts); $("#compose-send-button").prop("disabled", false); compose_ui.hide_compose_spinner(); return false; } } else { // the message no longer contains @all or @everyone clear_wildcard_warnings(opts.$banner_container); } // at this point, the user has either acknowledged the warning or removed @all / @everyone user_acknowledged_wildcard = false; return true; } export function validation_error(error_type, stream_name) { const $banner_container = $("#compose_banners"); switch (error_type) { case "does-not-exist": compose_banner.show_stream_does_not_exist_error(stream_name); return false; case "error": compose_banner.show_error_message( $t({defaultMessage: "Error checking subscription."}), compose_banner.CLASSNAMES.subscription_error, $banner_container, $("#compose_select_recipient_widget"), ); return false; case "not-subscribed": { if ( $(`#compose_banners .${CSS.escape(compose_banner.CLASSNAMES.user_not_subscribed)}`) .length ) { return false; } const sub = stream_data.get_sub(stream_name); const new_row = render_compose_banner({ banner_type: compose_banner.ERROR, banner_text: $t({ defaultMessage: "You're not subscribed to this stream. You will not be notified if other users reply to your message.", }), button_text: stream_data.can_toggle_subscription(sub) ? $t({defaultMessage: "Subscribe"}) : null, classname: compose_banner.CLASSNAMES.user_not_subscribed, // The message cannot be sent until the user subscribes to the stream, so // closing the banner would be more confusing than helpful. hide_close_button: true, }); compose_banner.append_compose_banner_to_banner_list(new_row, $banner_container); return false; } } return true; } export function validate_stream_message_address_info(stream_name) { if (stream_data.is_subscribed_by_name(stream_name)) { return true; } const autosubscribe = page_params.narrow_stream !== undefined; const error_type = check_unsubscribed_stream_for_send(stream_name, autosubscribe); return validation_error(error_type, stream_name); } function validate_stream_message(scheduling_message) { const stream_name = compose_state.stream_name(); const $banner_container = $("#compose_banners"); if (stream_name === "") { compose_banner.show_error_message( $t({defaultMessage: "Please specify a stream."}), compose_banner.CLASSNAMES.missing_stream, $banner_container, $("#compose_select_recipient_widget"), ); return false; } if (page_params.realm_mandatory_topics) { const topic = compose_state.topic(); // TODO: We plan to migrate the empty topic to only using the // `""` representation for i18n reasons, but have not yet done so. if (topic === "" || topic === "(no topic)") { compose_banner.show_error_message( $t({defaultMessage: "Topics are required in this organization."}), compose_banner.CLASSNAMES.topic_missing, $banner_container, $("#stream_message_recipient_topic"), ); return false; } } const sub = stream_data.get_sub(stream_name); if (!sub) { return validation_error("does-not-exist", stream_name); } if (!stream_data.can_post_messages_in_stream(sub)) { compose_banner.show_error_message( $t({ defaultMessage: "You do not have permission to post in this stream.", }), compose_banner.CLASSNAMES.no_post_permissions, $banner_container, ); return false; } const wildcard_mention = util.find_wildcard_mentions(compose_state.message_content()); if ( !validate_stream_message_address_info(stream_name) || !validate_stream_message_mentions({ stream_id: sub.stream_id, $banner_container, wildcard_mention, scheduling_message, }) ) { return false; } return true; } // The function checks whether the recipients are users of the realm or cross realm users (bots // for now) function validate_private_message() { const user_ids = compose_pm_pill.get_user_ids(); const $banner_container = $("#compose_banners"); if ( page_params.realm_private_message_policy === settings_config.private_message_policy_values.disabled.code && (user_ids.length !== 1 || !people.get_by_user_id(user_ids[0]).is_bot) ) { // Unless we're composing to a bot compose_banner.show_error_message( $t({defaultMessage: "Direct messages are disabled in this organization."}), compose_banner.CLASSNAMES.private_messages_disabled, $banner_container, $("#private_message_recipient"), ); return false; } if (compose_state.private_message_recipient().length === 0) { compose_banner.show_error_message( $t({defaultMessage: "Please specify at least one valid recipient."}), compose_banner.CLASSNAMES.missing_private_message_recipient, $banner_container, $("#private_message_recipient"), ); return false; } else if (page_params.realm_is_zephyr_mirror_realm) { // For Zephyr mirroring realms, the frontend doesn't know which users exist return true; } const invalid_recipients = get_invalid_recipient_emails(); let context = {}; if (invalid_recipients.length === 1) { context = {recipient: invalid_recipients.join(",")}; compose_banner.show_error_message( $t({defaultMessage: "The recipient {recipient} is not valid."}, context), compose_banner.CLASSNAMES.invalid_recipient, $banner_container, $("#private_message_recipient"), ); return false; } else if (invalid_recipients.length > 1) { context = {recipients: invalid_recipients.join(",")}; compose_banner.show_error_message( $t({defaultMessage: "The recipients {recipients} are not valid."}, context), compose_banner.CLASSNAMES.invalid_recipients, $banner_container, $("#private_message_recipient"), ); return false; } for (const user_id of user_ids) { if (!people.is_person_active(user_id)) { context = {full_name: people.get_by_user_id(user_id).full_name}; compose_banner.show_error_message( $t({defaultMessage: "You cannot send messages to deactivated users."}, context), compose_banner.CLASSNAMES.deactivated_user, $banner_container, $("#private_message_recipient"), ); return false; } } return true; } export function check_overflow_text() { // This function is called when typing every character in the // compose box, so it's important that it not doing anything // expensive. const text = compose_state.message_content(); const max_length = page_params.max_message_length; const $indicator = $("#compose_limit_indicator"); if (text.length > max_length) { $indicator.addClass("over_limit"); $("#compose-textarea").addClass("over_limit"); $indicator.text(text.length + "/" + max_length); compose_banner.show_error_message( $t( { defaultMessage: "Message length shouldn't be greater than {max_length} characters.", }, {max_length}, ), compose_banner.CLASSNAMES.message_too_long, $("#compose_banners"), ); $("#compose-send-button").prop("disabled", true); } else if (text.length > 0.9 * max_length) { $indicator.removeClass("over_limit"); $("#compose-textarea").removeClass("over_limit"); $indicator.text(text.length + "/" + max_length); $("#compose-send-button").prop("disabled", false); $(`#compose_banners .${CSS.escape(compose_banner.CLASSNAMES.message_too_long)}`).remove(); } else { $indicator.text(""); $("#compose-textarea").removeClass("over_limit"); $("#compose-send-button").prop("disabled", false); $(`#compose_banners .${CSS.escape(compose_banner.CLASSNAMES.message_too_long)}`).remove(); } return text.length; } export function validate_message_length() { if (compose_state.message_content().length > page_params.max_message_length) { $("#compose-textarea").addClass("flash"); setTimeout(() => $("#compose-textarea").removeClass("flash"), 1500); return false; } return true; } export function validate(scheduling_message) { const message_content = compose_state.message_content(); if (/^\s*$/.test(message_content)) { $("#compose-textarea").toggleClass("invalid", true); return false; } if ($("#zephyr-mirror-error").is(":visible")) { compose_banner.show_error_message( $t({ defaultMessage: "You need to be running Zephyr mirroring in order to send messages!", }), compose_banner.CLASSNAMES.zephyr_not_running, $("#compose_banners"), ); return false; } if (!validate_message_length()) { return false; } if (compose_state.get_message_type() === "private") { return validate_private_message(); } return validate_stream_message(scheduling_message); }