Zulip server and web application. Open-source team chat that helps teams stay productive and focused.
import {$} from "jquery";
import render_cannot_send_direct_message_error from "../templates/compose_banner/cannot_send_direct_message_error.hbs";
import render_compose_banner from "../templates/compose_banner/compose_banner.hbs";
import render_long_paste_options from "../templates/compose_banner/long_paste_options.hbs";
import render_stream_does_not_exist_error from "../templates/compose_banner/stream_does_not_exist_error.hbs";
import render_topics_required_error_banner from "../templates/compose_banner/topics_required_error_banner.hbs";
import render_unknown_zoom_user_error from "../templates/compose_banner/unknown_zoom_user_error.hbs";
import {$t} from "./i18n.ts";
import * as scroll_util from "./scroll_util.ts";
import * as stream_data from "./stream_data.ts";
import type {StreamSubscription} from "./sub_store.ts";
export let scroll_to_message_banner_message_id: number | null = null;
export function set_scroll_to_message_banner_message_id(val: number | null): void {
scroll_to_message_banner_message_id = val;
}
// banner types
export const WARNING = "warning";
export const ERROR = "error";
export const SUCCESS = "success";
export const INFO = "info";
const MESSAGE_SENT_CLASSNAMES = {
sent_scroll_to_view: "sent_scroll_to_view",
message_scheduled_success_compose_banner: "message_scheduled_success_compose_banner",
automatic_new_visibility_policy: "automatic_new_visibility_policy",
jump_to_sent_message_conversation: "jump_to_sent_message_conversation",
narrow_to_recipient: "narrow_to_recipient",
};
// Technically, unmute_topic_notification is a message sent banner, but
// it has distinct behavior / look - it has an associated action button,
// does not disappear on scroll - so we don't include it here, as it needs
// to be handled separately.
export const CLASSNAMES = {
...MESSAGE_SENT_CLASSNAMES,
non_interleaved_view_messages_fading: "non_interleaved_view_messages_fading",
interleaved_view_messages_fading: "interleaved_view_messages_fading",
topic_is_moved: "topic_is_moved",
convert_pasted_text_to_file: "convert_pasted_text_to_file",
// unmute topic notifications are styled like warnings but have distinct behaviour
unmute_topic_notification: "unmute_topic_notification warning-style",
// warnings
topic_resolved: "topic_resolved",
recipient_not_subscribed: "recipient_not_subscribed",
group_entirely_not_subscribed: "group_entirely_not_subscribed",
wildcard_warning: "wildcard_warning",
private_stream_warning: "private_stream_warning",
guest_in_dm_recipient_warning: "guest_in_dm_recipient_warning",
unscheduled_message: "unscheduled_message",
search_view: "search_view",
// errors
wildcards_not_allowed: "wildcards_not_allowed",
subscription_error: "subscription_error",
stream_does_not_exist: "stream_does_not_exist",
missing_stream: "missing_stream",
no_post_permissions: "no_post_permissions",
cannot_send_direct_message: "cannot_send_direct_message",
missing_private_message_recipient: "missing_private_message_recipient",
invalid_recipient: "invalid_recipient",
invalid_recipients: "invalid_recipients",
deactivated_user: "deactivated_user",
topic_missing: "topic_missing",
generic_compose_error: "generic_compose_error",
user_not_subscribed: "user_not_subscribed",
unknown_zoom_user: "unknown_zoom_user",
};
export function get_compose_banner_container($textarea: JQuery): JQuery {
return $textarea.attr("id") === "compose-textarea"
? $("#compose_banners")
: $textarea.closest(".message_edit_form").find(".edit_form_banners");
}
// This function provides a convenient way to add new elements
// to a banner container. The function accepts a container element
// as a parameter, to which a banner should be appended.
// Returns a boolean value indicating whether the append had succeeded.
export function append_compose_banner_to_banner_list(
$banner: JQuery,
$list_container: JQuery,
): boolean {
// Suppress a warning only when its own container already shows an
// error; an error elsewhere (e.g. the compose box) must not hide a
// warning targeting a different container.
if ($banner.hasClass("warning") && has_error($list_container)) {
return false;
}
scroll_util.get_content_element($list_container).append($banner);
return true;
}
export function update_or_append_banner(
$banner: JQuery,
banner_classname: string,
$list_container: JQuery,
): void {
const $existing_banner = $list_container.find(`.${CSS.escape(banner_classname)}`);
if ($existing_banner.length === 0) {
append_compose_banner_to_banner_list($banner, $list_container);
} else {
$existing_banner.replaceWith($banner);
}
}
export function clear_message_sent_banners(
include_unmute_banner = true,
skip_automatic_new_visibility_policy_banner = false,
): void {
for (const classname of Object.values(MESSAGE_SENT_CLASSNAMES)) {
if (
skip_automatic_new_visibility_policy_banner &&
classname === MESSAGE_SENT_CLASSNAMES.automatic_new_visibility_policy
) {
// Handles the case where this banner shouldn't be cleared in the
// race condition where the response from `POST /messages` for a
// not locally echoed message (composed from a different view) wins
// over the event received for the same.
// Otherwise, the response will lead to this banner, and the event
// will narrow the sender to the new conversation, leading to this
// banner being visible for a fraction of seconds.
continue;
}
$(`#compose_banners .${CSS.escape(classname)}`).remove();
}
if (include_unmute_banner) {
clear_unmute_topic_notifications();
}
scroll_to_message_banner_message_id = null;
}
// TODO: Replace with compose_ui.hide_compose_spinner() when it is converted to ts.
function hide_compose_spinner(): void {
$(".compose-submit-button .loader").hide();
$(".compose-submit-button span").show();
$(".compose-submit-button").removeClass("compose-button-disabled");
}
export function clear_errors(): void {
clear_validation_errors();
clear_upload_errors();
}
export function clear_validation_errors(): void {
$(`#compose_banners .${CSS.escape(ERROR)}:not(.upload_banner)`).remove();
}
export function clear_upload_errors(): void {
$(`#compose_banners .upload_banner.${CSS.escape(ERROR)}`).remove();
}
export function clear_warnings(): void {
$(`#compose_banners .${CSS.escape(WARNING)}`).remove();
}
export function clear_uploads(): void {
$("#compose_banners .upload_banner").remove();
$(`#compose_banners .${CSS.escape(CLASSNAMES.convert_pasted_text_to_file)}`).remove();
}
export function clear_unmute_topic_notifications(): void {
$(
`#compose_banners .${CLASSNAMES.unmute_topic_notification
.split(" ")
.map((classname) => CSS.escape(classname))
.join(".")}`,
).remove();
}
export function clear_search_view_banner(): void {
$(`#compose_banners .${CSS.escape(CLASSNAMES.search_view)}`).remove();
}
export function clear_non_interleaved_view_messages_fading_banner(): void {
$(`#compose_banners .${CSS.escape(CLASSNAMES.non_interleaved_view_messages_fading)}`).remove();
}
export function clear_interleaved_view_messages_fading_banner(): void {
$(`#compose_banners .${CSS.escape(CLASSNAMES.interleaved_view_messages_fading)}`).remove();
}
export function clear_all(): void {
scroll_util.get_content_element($(`#compose_banners`)).empty();
}
export function show_error_message(
message: string,
classname: string,
$container: JQuery,
$bad_input?: JQuery,
): void {
// Important: This API intentionally does not support passing an
// HTML message; doing so creates unnecessary XSS risk. If you
// want HTML in your compose banner, use a partial subclassing
// compose_banner and the append_compose_banner_to_banner_list
// API; See, for example, automatic_new_visibility_policy_banner.
//
// To prevent the same banner from appearing twice,
// we remove the banner with a matched classname.
$container.find(`.${CSS.escape(classname)}`).remove();
const new_row_html = render_compose_banner({
banner_type: ERROR,
stream_id: null,
topic_name: null,
banner_text: message,
button_text: null,
classname,
});
append_compose_banner_to_banner_list($(new_row_html), $container);
hide_compose_spinner();
if ($bad_input !== undefined) {
$bad_input.trigger("focus").trigger("select");
}
}
export function show_warning_message(
message: string,
classname: string,
$container: JQuery,
{
button_text = null,
stream_id = null,
topic_name = null,
}: {button_text?: string | null; stream_id?: number | null; topic_name?: string | null} = {},
): boolean {
// The warning counterpart of show_error_message: same classname-dedupe,
// and like that function it intentionally does not support HTML messages.
// Returns whether the banner was appended.
$container.find(`.${CSS.escape(classname)}`).remove();
const new_row_html = render_compose_banner({
banner_type: WARNING,
stream_id,
topic_name,
banner_text: message,
button_text,
classname,
});
return append_compose_banner_to_banner_list($(new_row_html), $container);
}
export function cannot_send_direct_message_error(error_message: string): void {
// If a banner with this classname already exists, avoid removing
// and re-creating it.
if ($(`#compose_banners .${CSS.escape(CLASSNAMES.cannot_send_direct_message)}`).length > 0) {
return;
}
const new_row_html = render_cannot_send_direct_message_error({
banner_type: ERROR,
error_message,
classname: CLASSNAMES.cannot_send_direct_message,
});
append_compose_banner_to_banner_list($(new_row_html), $("#compose_banners"));
hide_compose_spinner();
}
export function topic_missing_error(empty_string_topic_display_name: string): void {
const new_row_html = render_topics_required_error_banner({
banner_type: ERROR,
empty_string_topic_display_name,
classname: CLASSNAMES.topic_missing,
});
append_compose_banner_to_banner_list($(new_row_html), $("#compose_banners"));
hide_compose_spinner();
}
export function show_stream_does_not_exist_error(stream_name: string): void {
const new_row_html = render_stream_does_not_exist_error({
banner_type: ERROR,
channel_name: stream_name,
classname: CLASSNAMES.stream_does_not_exist,
});
append_compose_banner_to_banner_list($(new_row_html), $("#compose_banners"));
hide_compose_spinner();
// Open stream select dropdown.
$("#compose_select_recipient_widget").trigger("click");
}
export function show_stream_not_subscribed_error(
sub: StreamSubscription,
banner_text: string,
): void {
const new_row_html = render_compose_banner({
banner_type: ERROR,
banner_text,
button_text: stream_data.can_toggle_subscription(sub)
? $t({defaultMessage: "Subscribe"})
: null,
classname: 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,
});
append_compose_banner_to_banner_list($(new_row_html), $("#compose_banners"));
}
export function show_unknown_zoom_user_error(email: string): void {
// Remove any existing banners with this warning.
$(`#compose_banners .${CSS.escape(CLASSNAMES.unknown_zoom_user)}`).remove();
const new_row_html = render_unknown_zoom_user_error({
banner_type: ERROR,
email,
classname: CLASSNAMES.unknown_zoom_user,
});
append_compose_banner_to_banner_list($(new_row_html), $("#compose_banners"));
}
export function has_error($list_container: JQuery): boolean {
return $list_container.find(`.${CSS.escape(ERROR)}`).length > 0;
}
export function show_convert_pasted_text_to_file_banner({
show_paste_button,
convert_to_file_cb,
paste_to_compose_cb,
$textarea,
}: {
show_paste_button: boolean;
convert_to_file_cb: () => void;
paste_to_compose_cb: () => void;
$textarea: JQuery<HTMLTextAreaElement>;
}): JQuery {
const $banner_container = get_compose_banner_container($textarea);
const $new_row = $(
render_long_paste_options({
banner_type: INFO,
classname: CLASSNAMES.convert_pasted_text_to_file,
show_paste_button,
}),
);
$new_row.on("click", ".main-view-banner-action-button.convert-to-file", convert_to_file_cb);
$new_row.on("click", ".main-view-banner-action-button.paste-to-compose", paste_to_compose_cb);
update_or_append_banner($new_row, CLASSNAMES.convert_pasted_text_to_file, $banner_container);
return $new_row;
}