Zulip server and web application. Open-source team chat that helps teams stay productive and focused.
import {$} from "jquery";
import assert from "minimalistic-assert";
import {RE2JSSyntaxException} from "re2js";
import SortableJS from "sortablejs";
import * as z from "zod/mini";
import render_admin_linkifier_add_form from "../templates/settings/admin_linkifier_add_form.hbs";
import render_admin_linkifier_edit_form from "../templates/settings/admin_linkifier_edit_form.hbs";
import render_admin_linkifier_list from "../templates/settings/admin_linkifier_list.hbs";
import render_linkifier_alternative_url_template from "../templates/settings/linkifier_alternative_url_template.hbs";
import * as channel from "./channel.ts";
import * as confirm_dialog from "./confirm_dialog.ts";
import * as dialog_widget from "./dialog_widget.ts";
import {$t, $t_html} from "./i18n.ts";
import * as linkifiers from "./linkifiers.ts";
import * as ListWidget from "./list_widget.ts";
import * as markdown from "./markdown.ts";
import * as scroll_util from "./scroll_util.ts";
import * as settings_ui from "./settings_ui.ts";
import {current_user, realm} from "./state_data.ts";
import * as ui_report from "./ui_report.ts";
import * as ui_util from "./ui_util.ts";
import * as util from "./util.ts";
type RealmLinkifiers = typeof realm.realm_linkifiers;
const meta = {
loaded: false,
};
function maybe_unwrap_single_paragraph(html: string): string {
const trimmed = html.trim();
if (trimmed.startsWith("<p>") && trimmed.endsWith("</p>")) {
return trimmed.slice("<p>".length, -"</p>".length);
}
return html;
}
export function reset(): void {
meta.loaded = false;
}
export function maybe_disable_widgets(): void {
if (current_user.is_admin) {
return;
}
}
function add_alternative_url_template_row(
$container: JQuery,
value = "",
show_placeholder = false,
): void {
const row_html = render_linkifier_alternative_url_template({value, show_placeholder});
$container.append($(row_html));
}
function populate_alternative_url_templates($modal: JQuery, templates: string[]): void {
const $container = $modal.find("#linkifier-alternative-url-templates");
for (const template of templates) {
add_alternative_url_template_row($container, template);
}
// Always ensure there is one empty row at the end.
add_alternative_url_template_row($container);
}
function read_alternative_url_templates_from_form($modal: JQuery): string[] {
const templates: string[] = [];
$modal.find(".alternative-url-template-row input").each(function () {
const value = $(this).val();
if (typeof value === "string" && value.trim() !== "") {
templates.push(value.trim());
}
});
return templates;
}
// Compile the pattern client-side to catch regex syntax errors before
// submitting to the server. On failure, reports the error into
// $pattern_status and returns false.
function validate_linkifier_pattern(
pattern: string,
url_template: string,
$pattern_status: JQuery,
): boolean {
try {
linkifiers.compile_linkifier(pattern, url_template);
} catch (error) {
const detail = error instanceof RE2JSSyntaxException ? error.getDescription() : undefined;
ui_report.error(
detail === undefined
? $t_html({defaultMessage: "Failed: Bad regular expression"})
: $t_html({defaultMessage: "Failed: Bad regular expression: {detail}"}, {detail}),
undefined,
$pattern_status,
);
return false;
}
return true;
}
function open_linkifier_edit_form(linkifier_id: number): void {
const linkifiers_list = realm.realm_linkifiers;
const linkifier = linkifiers_list.find((linkifier) => linkifier.id === linkifier_id);
assert(linkifier !== undefined);
const modal_content_html = render_admin_linkifier_edit_form({
linkifier_id,
pattern: linkifier.pattern,
url_template: linkifier.url_template,
example_input: linkifier.example_input ?? "",
reverse_template: linkifier.reverse_template ?? "",
});
function submit_linkifier_form(dialog_widget_id: string): void {
const $modal = $(`#${CSS.escape(dialog_widget_id)}`);
const $change_linkifier_button = $modal.find(".dialog_submit_button");
$change_linkifier_button.prop("disabled", true);
const url = "/json/realm/filters/" + encodeURIComponent(linkifier_id);
const pattern = $modal.find<HTMLInputElement>("input#linkifier-pattern").val()!.trim();
const url_template = $modal
.find<HTMLInputElement>("input#linkifier-url-template")
.val()!
.trim();
const example_input = $modal
.find<HTMLInputElement>("input#linkifier-example-input")
.val()!
.trim();
const reverse_template = $modal
.find<HTMLInputElement>("input#linkifier-reverse-template")
.val()!
.trim();
const alternative_url_templates = read_alternative_url_templates_from_form($modal);
const data = {
pattern,
url_template,
example_input,
reverse_template,
alternative_url_templates: JSON.stringify(alternative_url_templates),
};
const $pattern_status = $modal.find("#linkifier-pattern-status").expectOne();
const $template_status = $modal.find("#linkifier-template-status").expectOne();
const $example_input_status = $modal.find("#linkifier-example-status").expectOne();
const $reverse_template_status = $modal.find("#linkifier-reverse-status").expectOne();
const $alternative_url_templates_status = $modal
.find("#linkifier-alternative-url-templates-status")
.expectOne();
const $dialog_error_element = $modal.find("#dialog_error").expectOne();
if (!validate_linkifier_pattern(pattern, url_template, $pattern_status)) {
$change_linkifier_button.prop("disabled", false);
return;
}
const opts = {
success_continuation() {
$change_linkifier_button.prop("disabled", false);
dialog_widget.close();
},
error_continuation(xhr: JQuery.jqXHR<unknown>) {
$change_linkifier_button.prop("disabled", false);
const parsed = z
.object({errors: z.record(z.string(), z.optional(z.array(z.string())))})
.safeParse(xhr.responseJSON);
if (parsed.success) {
handle_linkifier_api_error(
parsed.data.errors,
$pattern_status,
$template_status,
$example_input_status,
$reverse_template_status,
$alternative_url_templates_status,
$dialog_error_element,
);
} else {
// This must be `Linkifier not found` error.
ui_report.error(
$t_html({defaultMessage: "Failed"}),
xhr,
$dialog_error_element,
);
}
},
// Show the error message only on edit linkifier modal.
$error_msg_element: $(),
};
settings_ui.do_settings_change(
channel.patch,
url,
data,
$("#linkifier-field-status"),
opts,
);
}
const dialog_widget_id = dialog_widget.launch({
modal_title_html: $t_html({defaultMessage: "Edit linkifier"}),
help_link: "/help/add-a-custom-linkifier",
modal_content_html,
id: "edit-linkifier-modal",
on_click() {
submit_linkifier_form(dialog_widget_id);
},
on_shown() {
const $modal = $(`#${CSS.escape(dialog_widget_id)}`);
const $pattern_input = $modal.find<HTMLInputElement>("input#linkifier-pattern");
ui_util.place_caret_at_end(util.the($pattern_input));
populate_alternative_url_templates($modal, linkifier.alternative_url_templates ?? []);
},
});
}
function open_linkifier_add_form(): void {
const modal_content_html = render_admin_linkifier_add_form({
pattern: "",
url_template: "",
example_input: "",
reverse_template: "",
});
function submit_linkifier_form(dialog_widget_id: string): void {
const $modal = $(`#${CSS.escape(dialog_widget_id)}`);
const $linkifier_status = $modal.find("#add-linkifier-status").expectOne();
const $pattern_status = $modal.find("#linkifier-pattern-status").expectOne();
const $template_status = $modal.find("#linkifier-template-status").expectOne();
const $example_input_status = $modal.find("#linkifier-example-status").expectOne();
const $reverse_template_status = $modal.find("#linkifier-reverse-status").expectOne();
const $alternative_url_templates_status = $modal
.find("#linkifier-alternative-url-templates-status")
.expectOne();
const $add_linkifier_button = $modal.find(".dialog_submit_button").expectOne();
$add_linkifier_button.prop("disabled", true);
$linkifier_status.hide();
$pattern_status.hide();
$template_status.hide();
$example_input_status.hide();
$reverse_template_status.hide();
$alternative_url_templates_status.hide();
const pattern = $modal.find<HTMLInputElement>("input#linkifier-pattern").val()!.trim();
const url_template = $modal
.find<HTMLInputElement>("input#linkifier-url-template")
.val()!
.trim();
const example_input = $modal
.find<HTMLInputElement>("input#linkifier-example-input")
.val()!
.trim();
const reverse_template = $modal
.find<HTMLInputElement>("input#linkifier-reverse-template")
.val()!
.trim();
if (!validate_linkifier_pattern(pattern, url_template, $pattern_status)) {
$add_linkifier_button.prop("disabled", false);
return;
}
const alternative_url_templates = read_alternative_url_templates_from_form($modal);
void channel.post({
url: "/json/realm/filters",
data: {
pattern,
url_template,
example_input,
reverse_template,
alternative_url_templates: JSON.stringify(alternative_url_templates),
},
success() {
$add_linkifier_button.prop("disabled", false);
dialog_widget.close();
ui_report.success(
$t_html({defaultMessage: "Custom linkifier added!"}),
$("#linkifier-field-status").expectOne(),
);
},
error(xhr) {
$add_linkifier_button.prop("disabled", false);
const parsed = z
.object({errors: z.record(z.string(), z.optional(z.array(z.string())))})
.safeParse(xhr.responseJSON);
if (parsed.success) {
handle_linkifier_api_error(
parsed.data.errors,
$pattern_status,
$template_status,
$example_input_status,
$reverse_template_status,
$alternative_url_templates_status,
$linkifier_status,
);
}
},
});
}
const dialog_widget_id = dialog_widget.launch({
modal_title_html: $t_html({defaultMessage: "Add a new linkifier"}),
help_link: "/help/add-a-custom-linkifier",
modal_content_html,
modal_submit_button_text: $t({defaultMessage: "Add"}),
id: "add-linkifier-modal",
form_id: "add-linkifier-form-modal",
on_click() {
submit_linkifier_form(dialog_widget_id);
},
on_shown() {
const $modal = $(`#${CSS.escape(dialog_widget_id)}`);
const $pattern_input = $modal.find<HTMLInputElement>("input#linkifier-pattern");
ui_util.place_caret_at_end(util.the($pattern_input));
// Add one empty row for alternative URL templates.
const $container = $modal.find("#linkifier-alternative-url-templates");
// Placeholder is shown only in case of add linkifier modal first row.
add_alternative_url_template_row($container, "", true);
},
});
}
function update_linkifiers_order(): void {
const order: number[] = [];
$(".linkifier_row").each(function () {
order.push(Number.parseInt($(this).attr("data-linkifier-id")!, 10));
});
settings_ui.do_settings_change(
channel.patch,
"/json/realm/linkifiers",
{ordered_linkifier_ids: JSON.stringify(order)},
$("#linkifier-field-status").expectOne(),
);
}
function handle_linkifier_api_error(
errors: Record<string, string[] | undefined>,
pattern_status: JQuery,
template_status: JQuery,
example_input_status: JQuery,
reverse_template_status: JQuery,
alternative_url_templates_status: JQuery,
linkifier_status: JQuery,
): void {
// The endpoint uses the Django ValidationError system for error
// handling, which returns somewhat complicated error
// dictionaries. This logic parses them.
if (errors["pattern"] !== undefined) {
ui_report.error(
$t_html({defaultMessage: "Failed: {error}"}, {error: errors["pattern"][0]}),
undefined,
pattern_status,
);
}
if (errors["url_template"] !== undefined) {
ui_report.error(
$t_html({defaultMessage: "Failed: {error}"}, {error: errors["url_template"][0]}),
undefined,
template_status,
);
}
if (errors["example_input"] !== undefined) {
ui_report.error(
$t_html({defaultMessage: "Failed: {error}"}, {error: errors["example_input"][0]}),
undefined,
example_input_status,
);
}
if (errors["reverse_template"] !== undefined) {
ui_report.error(
$t_html({defaultMessage: "Failed: {error}"}, {error: errors["reverse_template"][0]}),
undefined,
reverse_template_status,
);
}
if (errors["alternative_url_templates"] !== undefined) {
ui_report.error(
$t_html(
{defaultMessage: "Failed: {error}"},
{error: errors["alternative_url_templates"][0]},
),
undefined,
alternative_url_templates_status,
);
}
if (errors["__all__"] !== undefined) {
ui_report.error(
$t_html({defaultMessage: "Failed: {error}"}, {error: errors["__all__"][0]}),
undefined,
linkifier_status,
);
}
}
export function populate_linkifiers(linkifiers_data: RealmLinkifiers): void {
if (!meta.loaded) {
return;
}
const $linkifiers_table = $("#admin_linkifiers_table").expectOne();
ListWidget.create($linkifiers_table, linkifiers_data, {
name: "linkifiers_list",
get_item: ListWidget.default_get_item,
modifier_html(linkifier, filter_value) {
const rendered_example_input_html = linkifier.example_input
? maybe_unwrap_single_paragraph(markdown.parse_non_message(linkifier.example_input))
: "";
return render_admin_linkifier_list({
linkifier: {
rendered_example_input_html,
pattern: linkifier.pattern,
url_template: linkifier.url_template,
reverse_template: linkifier.reverse_template ?? "",
id: linkifier.id,
},
can_modify: current_user.is_admin,
can_drag: filter_value.length === 0,
});
},
filter: {
$element: $linkifiers_table
.closest(".settings-section")
.find<HTMLInputElement>("input.search"),
predicate(item, value) {
return (
item.pattern.toLowerCase().includes(value) ||
item.url_template.toLowerCase().includes(value) ||
(item.example_input ?? "").toLowerCase().includes(value) ||
(item.reverse_template ?? "").toLowerCase().includes(value)
);
},
onupdate() {
scroll_util.reset_scrollbar($linkifiers_table);
},
},
$parent_container: $("#linkifier-settings").expectOne(),
$simplebar_container: $("#linkifier-settings .progressive-table-wrapper"),
});
if (current_user.is_admin) {
new SortableJS(util.the($linkifiers_table), {
onUpdate: update_linkifiers_order,
handle: ".move-handle",
filter: "input",
preventOnFilter: false,
});
}
}
export function set_up(): void {
build_page();
maybe_disable_widgets();
}
export function build_page(): void {
meta.loaded = true;
// Populate linkifiers table
populate_linkifiers(realm.realm_linkifiers);
$(".admin_linkifiers_table").on("click", ".delete", function (e) {
e.preventDefault();
e.stopPropagation();
const $button = $(this);
const url =
"/json/realm/filters/" +
encodeURIComponent($button.closest("tr").attr("data-linkifier-id")!);
confirm_dialog.launch({
modal_title_html: $t_html({defaultMessage: "Delete linkifier?"}),
modal_content_html: $t_html({defaultMessage: "This action cannot be undone."}),
is_compact: true,
id: "confirm_delete_linkifiers_modal",
on_click() {
dialog_widget.submit_api_request(channel.del, url, {});
},
loading_spinner: true,
});
});
$(".admin_linkifiers_table").on("click", ".edit", function (e) {
e.preventDefault();
e.stopPropagation();
const $button = $(this);
const linkifier_id = Number.parseInt($button.closest("tr").attr("data-linkifier-id")!, 10);
open_linkifier_edit_form(linkifier_id);
});
$("#linkifier-settings").on("click", "#add-linkifier-button", (e) => {
e.preventDefault();
e.stopPropagation();
open_linkifier_add_form();
});
// Auto-add a new empty row when user types in the last alternative
// URL template row, following the same pattern as profile field choices.
$(document).on(
"input",
"#linkifier-alternative-url-templates .alternative-url-template-row input",
function () {
const $row = $(this).closest(".alternative-url-template-row");
if ($row.next().hasClass("alternative-url-template-row")) {
return;
}
const $container = $row.parent();
add_alternative_url_template_row($container, "");
},
);
$(document).on("click", ".delete-alternative-url-template", function () {
$(this).closest(".alternative-url-template-row").remove();
});
}