zulip/web/src/settings_linkifiers.ts

292 lines
10 KiB
TypeScript
Raw Normal View History

import $ from "jquery";
import assert from "minimalistic-assert";
import SortableJS from "sortablejs";
import z from "zod";
import render_confirm_delete_linkifier from "../templates/confirm_dialog/confirm_delete_linkifier.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 * as channel from "./channel";
import * as confirm_dialog from "./confirm_dialog";
import * as dialog_widget from "./dialog_widget";
import {$t_html} from "./i18n";
import * as ListWidget from "./list_widget";
import * as scroll_util from "./scroll_util";
import * as settings_ui from "./settings_ui";
import type {realm_schema} from "./state_data";
import {current_user, realm} from "./state_data";
import * as ui_report from "./ui_report";
type RealmLinkifiers = z.infer<typeof realm_schema>["realm_linkifiers"];
const configure_linkifier_api_response_schema = z.object({
id: z.number(),
});
const meta = {
2017-04-08 23:24:03 +02:00
loaded: false,
};
export function reset(): void {
meta.loaded = false;
}
export function maybe_disable_widgets(): void {
if (current_user.is_admin) {
return;
}
}
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 html_body = render_admin_linkifier_edit_form({
linkifier_id,
pattern: linkifier.pattern,
url_template: linkifier.url_template,
});
function submit_linkifier_form(): void {
const $change_linkifier_button = $(".dialog_submit_button");
$change_linkifier_button.prop("disabled", true);
const $modal = $("#dialog_widget_modal");
const url = "/json/realm/filters/" + encodeURIComponent(linkifier_id);
const pattern = $modal.find<HTMLInputElement>("input#edit-linkifier-pattern").val()!.trim();
const url_template = $modal
.find<HTMLInputElement>("input#edit-linkifier-url-template")
.val()!
.trim();
const data = {pattern, url_template};
const $pattern_status = $modal.find("#edit-linkifier-pattern-status").expectOne();
const $template_status = $modal.find("#edit-linkifier-template-status").expectOne();
const $dialog_error_element = $modal.find("#dialog_error").expectOne();
const opts = {
success_continuation() {
$change_linkifier_button.prop("disabled", false);
2023-10-10 14:32:20 +02:00
dialog_widget.close();
},
error_continuation(xhr: JQuery.jqXHR<unknown>) {
$change_linkifier_button.prop("disabled", false);
const parsed = z
.object({errors: z.record(z.array(z.string()).optional())})
.safeParse(xhr.responseJSON);
if (parsed.success) {
handle_linkifier_api_error(
parsed.data.errors,
$pattern_status,
$template_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,
);
}
dialog_widget.launch({
html_heading: $t_html({defaultMessage: "Edit linkfiers"}),
html_body,
on_click: submit_linkifier_form,
});
}
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,
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,
);
}
linkifier: Support URL templates for linkifiers. This swaps out url_format_string from all of our APIs and replaces it with url_template. Note that the documentation changes in the following commits will be squashed with this commit. We change the "url_format" key to "url_template" for the realm_linkifiers events in event_schema, along with updating LinkifierDict. "url_template" is the name chosen to normalize mixed usages of "url_format_string" and "url_format" throughout the backend. The markdown processor is updated to stop handling the format string interpolation and delegate the task template expansion to the uri_template library instead. This change affects many test cases. We mostly just replace "%(name)s" with "{name}", "url_format_string" with "url_template" to make sure that they still pass. There are some test cases dedicated for testing "%" escaping, which aren't relevant anymore and are subject to removal. But for now we keep most of them as-is, and make sure that "%" is always escaped since we do not use it for variable substitution any more. Since url_format_string is not populated anymore, a migration is created to remove this field entirely, and make url_template non-nullable since we will always populate it. Note that it is possible to have url_template being null after migration 0422 and before 0424, but in practice, url_template will not be None after backfilling and the backend now is always setting url_template. With the removal of url_format_string, RealmFilter model will now be cleaned with URL template checks, and the old checks for escapes are removed. We also modified RealmFilter.clean to skip the validation when the url_template is invalid. This avoids raising mulitple ValidationError's when calling full_clean on a linkifier. But we might eventually want to have a more centric approach to data validation instead of having the same validation in both the clean method and the validator. Fixes #23124. Signed-off-by: Zixuan James Li <p359101898@gmail.com>
2022-10-05 20:55:31 +02:00
if (errors.url_template !== undefined) {
ui_report.error(
$t_html({defaultMessage: "Failed: {error}"}, {error: errors.url_template[0]}),
undefined,
template_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 {
2017-04-08 23:24:03 +02:00
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) {
return render_admin_linkifier_list({
linkifier: {
pattern: linkifier.pattern,
url_template: linkifier.url_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) ||
linkifier: Support URL templates for linkifiers. This swaps out url_format_string from all of our APIs and replaces it with url_template. Note that the documentation changes in the following commits will be squashed with this commit. We change the "url_format" key to "url_template" for the realm_linkifiers events in event_schema, along with updating LinkifierDict. "url_template" is the name chosen to normalize mixed usages of "url_format_string" and "url_format" throughout the backend. The markdown processor is updated to stop handling the format string interpolation and delegate the task template expansion to the uri_template library instead. This change affects many test cases. We mostly just replace "%(name)s" with "{name}", "url_format_string" with "url_template" to make sure that they still pass. There are some test cases dedicated for testing "%" escaping, which aren't relevant anymore and are subject to removal. But for now we keep most of them as-is, and make sure that "%" is always escaped since we do not use it for variable substitution any more. Since url_format_string is not populated anymore, a migration is created to remove this field entirely, and make url_template non-nullable since we will always populate it. Note that it is possible to have url_template being null after migration 0422 and before 0424, but in practice, url_template will not be None after backfilling and the backend now is always setting url_template. With the removal of url_format_string, RealmFilter model will now be cleaned with URL template checks, and the old checks for escapes are removed. We also modified RealmFilter.clean to skip the validation when the url_template is invalid. This avoids raising mulitple ValidationError's when calling full_clean on a linkifier. But we might eventually want to have a more centric approach to data validation instead of having the same validation in both the clean method and the validator. Fixes #23124. Signed-off-by: Zixuan James Li <p359101898@gmail.com>
2022-10-05 20:55:31 +02:00
item.url_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($linkifiers_table[0], {
onUpdate: update_linkifiers_order,
handle: ".move-handle",
filter: "input",
preventOnFilter: false,
});
}
}
2017-04-08 23:24:03 +02:00
export function set_up(): void {
build_page();
maybe_disable_widgets();
}
export function build_page(): void {
2017-04-08 23:24:03 +02:00
meta.loaded = true;
// Populate linkifiers table
populate_linkifiers(realm.realm_linkifiers);
2017-04-08 23:24:03 +02:00
$(".admin_linkifiers_table").on("click", ".delete", function (e) {
2017-04-08 23:24:03 +02:00
e.preventDefault();
e.stopPropagation();
const $btn = $(this);
const html_body = render_confirm_delete_linkifier();
const url = "/json/realm/filters/" + encodeURIComponent($btn.attr("data-linkifier-id")!);
confirm_dialog.launch({
html_heading: $t_html({defaultMessage: "Delete linkifier?"}),
html_body,
id: "confirm_delete_linkifiers_modal",
on_click() {
dialog_widget.submit_api_request(channel.del, url, {});
},
loading_spinner: true,
2017-04-08 23:24:03 +02:00
});
});
$(".admin_linkifiers_table").on("click", ".edit", function (e) {
e.preventDefault();
e.stopPropagation();
const $btn = $(this);
const linkifier_id = Number.parseInt($btn.attr("data-linkifier-id")!, 10);
open_linkifier_edit_form(linkifier_id);
});
$(".organization form.admin-linkifier-form")
.off("submit")
.on("submit", function (e) {
e.preventDefault();
e.stopPropagation();
const $linkifier_status = $("#admin-linkifier-status");
const $pattern_status = $("#admin-linkifier-pattern-status");
const $template_status = $("#admin-linkifier-template-status");
const $add_linkifier_button = $(".new-linkifier-form button");
$add_linkifier_button.prop("disabled", true);
$linkifier_status.hide();
$pattern_status.hide();
$template_status.hide();
const linkifier: {[key in string]?: string} & {id?: number} = {};
for (const obj of $(this).serializeArray()) {
linkifier[obj.name] = obj.value;
}
void channel.post({
url: "/json/realm/filters",
data: $(this).serialize(),
success(data) {
const clean_data = configure_linkifier_api_response_schema.parse(data);
$("#linkifier_pattern").val("");
$("#linkifier_template").val("");
$add_linkifier_button.prop("disabled", false);
linkifier.id = clean_data.id;
ui_report.success(
$t_html({defaultMessage: "Custom linkifier added!"}),
$linkifier_status,
);
},
error(xhr) {
$add_linkifier_button.prop("disabled", false);
const parsed = z
.object({errors: z.record(z.array(z.string()).optional())})
.safeParse(xhr.responseJSON);
if (parsed.success) {
handle_linkifier_api_error(
parsed.data.errors,
$pattern_status,
$template_status,
$linkifier_status,
);
}
},
});
2017-04-08 23:24:03 +02:00
});
}