2021-03-11 05:43:45 +01:00
|
|
|
import $ from "jquery";
|
2024-03-09 12:12:17 +01:00
|
|
|
import assert from "minimalistic-assert";
|
|
|
|
import SortableJS from "sortablejs";
|
|
|
|
import z from "zod";
|
2021-03-11 05:43:45 +01:00
|
|
|
|
2022-09-07 20:29:18 +02:00
|
|
|
import render_confirm_delete_linkifier from "../templates/confirm_dialog/confirm_delete_linkifier.hbs";
|
2021-04-14 23:33:54 +02:00
|
|
|
import render_admin_linkifier_edit_form from "../templates/settings/admin_linkifier_edit_form.hbs";
|
2021-04-22 18:41:20 +02:00
|
|
|
import render_admin_linkifier_list from "../templates/settings/admin_linkifier_list.hbs";
|
2020-08-01 03:43:15 +02:00
|
|
|
|
2021-02-28 01:21:57 +01:00
|
|
|
import * as channel from "./channel";
|
2022-09-07 20:29:18 +02:00
|
|
|
import * as confirm_dialog from "./confirm_dialog";
|
2021-07-05 20:30:47 +02:00
|
|
|
import * as dialog_widget from "./dialog_widget";
|
|
|
|
import {$t_html} from "./i18n";
|
2021-02-28 01:21:57 +01:00
|
|
|
import * as ListWidget from "./list_widget";
|
2023-04-25 18:01:02 +02:00
|
|
|
import * as scroll_util from "./scroll_util";
|
2021-04-14 23:33:54 +02:00
|
|
|
import * as settings_ui from "./settings_ui";
|
2024-03-09 12:12:17 +01:00
|
|
|
import type {realm_schema} from "./state_data";
|
2024-02-13 02:08:24 +01:00
|
|
|
import {current_user, realm} from "./state_data";
|
2021-02-28 01:21:57 +01:00
|
|
|
import * as ui_report from "./ui_report";
|
2021-02-28 00:36:14 +01:00
|
|
|
|
2024-03-09 12:12:17 +01:00
|
|
|
type RealmLinkifiers = z.infer<typeof realm_schema>["realm_linkifiers"];
|
|
|
|
|
|
|
|
const configure_linkifier_api_response_schema = z.object({
|
|
|
|
id: z.number(),
|
|
|
|
});
|
|
|
|
|
2019-11-02 00:06:25 +01:00
|
|
|
const meta = {
|
2017-04-08 23:24:03 +02:00
|
|
|
loaded: false,
|
|
|
|
};
|
|
|
|
|
2024-03-09 12:12:17 +01:00
|
|
|
export function reset(): void {
|
2017-04-17 16:51:27 +02:00
|
|
|
meta.loaded = false;
|
2021-02-28 01:21:57 +01:00
|
|
|
}
|
2017-04-17 16:51:27 +02:00
|
|
|
|
2024-03-09 12:12:17 +01:00
|
|
|
export function maybe_disable_widgets(): void {
|
2024-02-13 02:08:16 +01:00
|
|
|
if (current_user.is_admin) {
|
2018-12-08 17:37:57 +01:00
|
|
|
return;
|
|
|
|
}
|
2021-02-28 01:21:57 +01:00
|
|
|
}
|
2018-12-08 17:37:57 +01:00
|
|
|
|
2024-03-09 12:12:17 +01:00
|
|
|
function open_linkifier_edit_form(linkifier_id: number): void {
|
2024-02-13 02:08:24 +01:00
|
|
|
const linkifiers_list = realm.realm_linkifiers;
|
2021-04-14 23:33:54 +02:00
|
|
|
const linkifier = linkifiers_list.find((linkifier) => linkifier.id === linkifier_id);
|
2024-03-09 12:12:17 +01:00
|
|
|
assert(linkifier !== undefined);
|
2021-07-05 11:35:18 +02:00
|
|
|
const html_body = render_admin_linkifier_edit_form({
|
2021-04-14 23:33:54 +02:00
|
|
|
linkifier_id,
|
|
|
|
pattern: linkifier.pattern,
|
2022-10-05 22:52:26 +02:00
|
|
|
url_template: linkifier.url_template,
|
2021-04-14 23:33:54 +02:00
|
|
|
});
|
2021-06-09 10:01:20 +02:00
|
|
|
|
2024-03-09 12:12:17 +01:00
|
|
|
function submit_linkifier_form(): void {
|
2022-01-25 11:36:19 +01:00
|
|
|
const $change_linkifier_button = $(".dialog_submit_button");
|
|
|
|
$change_linkifier_button.prop("disabled", true);
|
2021-06-09 10:01:20 +02:00
|
|
|
|
2022-01-25 11:36:19 +01:00
|
|
|
const $modal = $("#dialog_widget_modal");
|
2021-06-09 10:01:20 +02:00
|
|
|
const url = "/json/realm/filters/" + encodeURIComponent(linkifier_id);
|
2024-03-09 12:12:17 +01:00
|
|
|
const pattern = $modal.find<HTMLInputElement>("input#edit-linkifier-pattern").val()!.trim();
|
|
|
|
const url_template = $modal
|
|
|
|
.find<HTMLInputElement>("input#edit-linkifier-url-template")
|
|
|
|
.val()!
|
|
|
|
.trim();
|
2022-10-05 22:52:26 +02:00
|
|
|
const data = {pattern, url_template};
|
2022-01-25 11:36:19 +01:00
|
|
|
const $pattern_status = $modal.find("#edit-linkifier-pattern-status").expectOne();
|
2022-10-05 22:52:26 +02:00
|
|
|
const $template_status = $modal.find("#edit-linkifier-template-status").expectOne();
|
2022-01-25 11:36:19 +01:00
|
|
|
const $dialog_error_element = $modal.find("#dialog_error").expectOne();
|
2021-06-09 10:01:20 +02:00
|
|
|
const opts = {
|
|
|
|
success_continuation() {
|
2022-01-25 11:36:19 +01:00
|
|
|
$change_linkifier_button.prop("disabled", false);
|
2023-10-10 14:32:20 +02:00
|
|
|
dialog_widget.close();
|
2021-06-09 10:01:20 +02:00
|
|
|
},
|
2024-03-09 12:12:17 +01:00
|
|
|
error_continuation(xhr: JQuery.jqXHR<unknown>) {
|
2022-01-25 11:36:19 +01:00
|
|
|
$change_linkifier_button.prop("disabled", false);
|
2024-05-05 09:48:22 +02:00
|
|
|
const parsed = z
|
|
|
|
.object({errors: z.record(z.array(z.string()).optional())})
|
|
|
|
.safeParse(xhr.responseJSON);
|
|
|
|
if (parsed.success) {
|
2021-06-09 10:01:20 +02:00
|
|
|
handle_linkifier_api_error(
|
2024-05-05 09:48:22 +02:00
|
|
|
parsed.data.errors,
|
2022-01-25 11:36:19 +01:00
|
|
|
$pattern_status,
|
2022-10-05 22:52:26 +02:00
|
|
|
$template_status,
|
2022-01-25 11:36:19 +01:00
|
|
|
$dialog_error_element,
|
2021-06-09 10:01:20 +02:00
|
|
|
);
|
|
|
|
} else {
|
|
|
|
// This must be `Linkifier not found` error.
|
2022-01-25 11:36:19 +01:00
|
|
|
ui_report.error(
|
|
|
|
$t_html({defaultMessage: "Failed"}),
|
|
|
|
xhr,
|
|
|
|
$dialog_error_element,
|
|
|
|
);
|
2021-06-09 10:01:20 +02:00
|
|
|
}
|
|
|
|
},
|
|
|
|
// Show the error message only on edit linkifier modal.
|
2022-01-25 11:36:19 +01:00
|
|
|
$error_msg_element: $(),
|
2021-06-09 10:01:20 +02:00
|
|
|
};
|
|
|
|
settings_ui.do_settings_change(
|
|
|
|
channel.patch,
|
|
|
|
url,
|
|
|
|
data,
|
|
|
|
$("#linkifier-field-status"),
|
|
|
|
opts,
|
|
|
|
);
|
|
|
|
}
|
2021-04-14 23:33:54 +02:00
|
|
|
|
2021-07-05 20:30:47 +02:00
|
|
|
dialog_widget.launch({
|
|
|
|
html_heading: $t_html({defaultMessage: "Edit linkfiers"}),
|
2021-07-05 11:35:18 +02:00
|
|
|
html_body,
|
2021-06-09 10:01:20 +02:00
|
|
|
on_click: submit_linkifier_form,
|
|
|
|
});
|
2021-04-14 23:33:54 +02:00
|
|
|
}
|
|
|
|
|
2024-03-09 12:12:17 +01:00
|
|
|
function update_linkifiers_order(): void {
|
|
|
|
const order: number[] = [];
|
2023-08-10 06:20:27 +02:00
|
|
|
$(".linkifier_row").each(function () {
|
2024-03-09 12:12:17 +01:00
|
|
|
order.push(Number.parseInt($(this).attr("data-linkifier-id")!, 10));
|
2023-08-10 06:20:27 +02:00
|
|
|
});
|
|
|
|
settings_ui.do_settings_change(
|
|
|
|
channel.patch,
|
|
|
|
"/json/realm/linkifiers",
|
|
|
|
{ordered_linkifier_ids: JSON.stringify(order)},
|
|
|
|
$("#linkifier-field-status").expectOne(),
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
2024-03-09 12:12:17 +01:00
|
|
|
function handle_linkifier_api_error(
|
2024-05-05 09:48:22 +02:00
|
|
|
errors: Record<string, string[] | undefined>,
|
2024-03-09 12:12:17 +01:00
|
|
|
pattern_status: JQuery,
|
|
|
|
template_status: JQuery,
|
|
|
|
linkifier_status: JQuery,
|
|
|
|
): void {
|
2021-03-25 15:05:19 +01:00
|
|
|
// The endpoint uses the Django ValidationError system for error
|
|
|
|
// handling, which returns somewhat complicated error
|
|
|
|
// dictionaries. This logic parses them.
|
|
|
|
if (errors.pattern !== undefined) {
|
2024-05-05 19:46:42 +02:00
|
|
|
ui_report.error(
|
|
|
|
$t_html({defaultMessage: "Failed: {error}"}, {error: errors.pattern[0]}),
|
|
|
|
undefined,
|
|
|
|
pattern_status,
|
|
|
|
);
|
2021-03-25 15:05:19 +01:00
|
|
|
}
|
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) {
|
2024-05-05 19:46:42 +02:00
|
|
|
ui_report.error(
|
|
|
|
$t_html({defaultMessage: "Failed: {error}"}, {error: errors.url_template[0]}),
|
|
|
|
undefined,
|
|
|
|
template_status,
|
|
|
|
);
|
2021-03-25 15:05:19 +01:00
|
|
|
}
|
|
|
|
if (errors.__all__ !== undefined) {
|
2024-05-05 19:46:42 +02:00
|
|
|
ui_report.error(
|
|
|
|
$t_html({defaultMessage: "Failed: {error}"}, {error: errors.__all__[0]}),
|
|
|
|
undefined,
|
|
|
|
linkifier_status,
|
|
|
|
);
|
2021-03-25 15:05:19 +01:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2024-03-09 12:12:17 +01:00
|
|
|
export function populate_linkifiers(linkifiers_data: RealmLinkifiers): void {
|
2017-04-08 23:24:03 +02:00
|
|
|
if (!meta.loaded) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2022-01-25 11:36:19 +01:00
|
|
|
const $linkifiers_table = $("#admin_linkifiers_table").expectOne();
|
|
|
|
ListWidget.create($linkifiers_table, linkifiers_data, {
|
2019-08-16 07:53:04 +02:00
|
|
|
name: "linkifiers_list",
|
2023-05-01 13:44:40 +02:00
|
|
|
get_item: ListWidget.default_get_item,
|
2023-09-16 00:03:52 +02:00
|
|
|
modifier_html(linkifier, filter_value) {
|
2021-03-13 18:15:14 +01:00
|
|
|
return render_admin_linkifier_list({
|
|
|
|
linkifier: {
|
2021-03-30 12:51:54 +02:00
|
|
|
pattern: linkifier.pattern,
|
2022-10-05 22:52:26 +02:00
|
|
|
url_template: linkifier.url_template,
|
2021-03-30 12:51:54 +02:00
|
|
|
id: linkifier.id,
|
2019-07-09 21:24:00 +02:00
|
|
|
},
|
2024-02-13 02:08:16 +01:00
|
|
|
can_modify: current_user.is_admin,
|
2023-08-15 01:01:19 +02:00
|
|
|
can_drag: filter_value.length === 0,
|
2019-08-16 07:53:04 +02:00
|
|
|
});
|
|
|
|
},
|
|
|
|
filter: {
|
2024-03-09 12:12:17 +01:00
|
|
|
$element: $linkifiers_table
|
|
|
|
.closest(".settings-section")
|
|
|
|
.find<HTMLInputElement>("input.search"),
|
2020-07-20 22:18:43 +02:00
|
|
|
predicate(item, value) {
|
2020-07-15 00:34:28 +02:00
|
|
|
return (
|
2021-03-30 12:51:54 +02:00
|
|
|
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)
|
2020-07-15 00:34:28 +02:00
|
|
|
);
|
2019-08-16 07:53:04 +02:00
|
|
|
},
|
2020-07-20 22:18:43 +02:00
|
|
|
onupdate() {
|
2023-04-25 18:01:02 +02:00
|
|
|
scroll_util.reset_scrollbar($linkifiers_table);
|
2019-08-16 07:53:04 +02:00
|
|
|
},
|
|
|
|
},
|
2022-01-25 11:36:19 +01:00
|
|
|
$parent_container: $("#linkifier-settings").expectOne(),
|
|
|
|
$simplebar_container: $("#linkifier-settings .progressive-table-wrapper"),
|
2020-04-11 16:23:29 +02:00
|
|
|
});
|
2023-08-10 06:20:27 +02:00
|
|
|
|
2024-02-13 02:08:16 +01:00
|
|
|
if (current_user.is_admin) {
|
2024-03-09 12:12:17 +01:00
|
|
|
new SortableJS($linkifiers_table[0], {
|
2023-08-10 06:20:27 +02:00
|
|
|
onUpdate: update_linkifiers_order,
|
2023-09-21 22:52:36 +02:00
|
|
|
handle: ".move-handle",
|
2023-08-10 06:20:27 +02:00
|
|
|
filter: "input",
|
|
|
|
preventOnFilter: false,
|
|
|
|
});
|
|
|
|
}
|
2021-02-28 01:21:57 +01:00
|
|
|
}
|
2017-04-08 23:24:03 +02:00
|
|
|
|
2024-03-09 12:12:17 +01:00
|
|
|
export function set_up(): void {
|
2021-02-28 01:21:57 +01:00
|
|
|
build_page();
|
|
|
|
maybe_disable_widgets();
|
|
|
|
}
|
2018-12-08 18:16:37 +01:00
|
|
|
|
2024-03-09 12:12:17 +01:00
|
|
|
export function build_page(): void {
|
2017-04-08 23:24:03 +02:00
|
|
|
meta.loaded = true;
|
|
|
|
|
2021-03-13 18:15:14 +01:00
|
|
|
// Populate linkifiers table
|
2024-02-13 02:08:24 +01:00
|
|
|
populate_linkifiers(realm.realm_linkifiers);
|
2017-04-08 23:24:03 +02:00
|
|
|
|
2021-03-13 18:15:14 +01:00
|
|
|
$(".admin_linkifiers_table").on("click", ".delete", function (e) {
|
2017-04-08 23:24:03 +02:00
|
|
|
e.preventDefault();
|
|
|
|
e.stopPropagation();
|
2022-01-25 11:36:19 +01:00
|
|
|
const $btn = $(this);
|
2022-09-07 20:29:18 +02:00
|
|
|
const html_body = render_confirm_delete_linkifier();
|
2024-03-09 12:12:17 +01:00
|
|
|
const url = "/json/realm/filters/" + encodeURIComponent($btn.attr("data-linkifier-id")!);
|
2022-09-07 20:29:18 +02:00
|
|
|
|
|
|
|
confirm_dialog.launch({
|
|
|
|
html_heading: $t_html({defaultMessage: "Delete linkifier?"}),
|
|
|
|
html_body,
|
|
|
|
id: "confirm_delete_linkifiers_modal",
|
2024-03-09 12:12:17 +01:00
|
|
|
on_click() {
|
|
|
|
dialog_widget.submit_api_request(channel.del, url, {});
|
|
|
|
},
|
2022-09-07 20:29:18 +02:00
|
|
|
loading_spinner: true,
|
2017-04-08 23:24:03 +02:00
|
|
|
});
|
|
|
|
});
|
|
|
|
|
2021-04-14 23:33:54 +02:00
|
|
|
$(".admin_linkifiers_table").on("click", ".edit", function (e) {
|
|
|
|
e.preventDefault();
|
|
|
|
e.stopPropagation();
|
|
|
|
|
2022-01-25 11:36:19 +01:00
|
|
|
const $btn = $(this);
|
2024-03-09 12:12:17 +01:00
|
|
|
const linkifier_id = Number.parseInt($btn.attr("data-linkifier-id")!, 10);
|
2021-06-09 10:01:20 +02:00
|
|
|
open_linkifier_edit_form(linkifier_id);
|
2021-04-14 23:33:54 +02:00
|
|
|
});
|
|
|
|
|
2021-03-13 18:15:14 +01:00
|
|
|
$(".organization form.admin-linkifier-form")
|
2020-07-15 00:34:28 +02:00
|
|
|
.off("submit")
|
|
|
|
.on("submit", function (e) {
|
|
|
|
e.preventDefault();
|
|
|
|
e.stopPropagation();
|
2022-01-25 11:36:19 +01:00
|
|
|
const $linkifier_status = $("#admin-linkifier-status");
|
|
|
|
const $pattern_status = $("#admin-linkifier-pattern-status");
|
2022-10-05 22:52:26 +02:00
|
|
|
const $template_status = $("#admin-linkifier-template-status");
|
2022-01-25 11:36:19 +01:00
|
|
|
const $add_linkifier_button = $(".new-linkifier-form button");
|
|
|
|
$add_linkifier_button.prop("disabled", true);
|
|
|
|
$linkifier_status.hide();
|
|
|
|
$pattern_status.hide();
|
2022-10-05 22:52:26 +02:00
|
|
|
$template_status.hide();
|
2024-03-09 12:12:17 +01:00
|
|
|
const linkifier: {[key in string]?: string} & {id?: number} = {};
|
2020-07-15 00:34:28 +02:00
|
|
|
|
|
|
|
for (const obj of $(this).serializeArray()) {
|
2021-03-13 18:15:14 +01:00
|
|
|
linkifier[obj.name] = obj.value;
|
2020-07-15 00:34:28 +02:00
|
|
|
}
|
|
|
|
|
2024-03-09 12:12:17 +01:00
|
|
|
void channel.post({
|
2020-07-15 00:34:28 +02:00
|
|
|
url: "/json/realm/filters",
|
|
|
|
data: $(this).serialize(),
|
2020-07-20 22:18:43 +02:00
|
|
|
success(data) {
|
2024-03-09 12:12:17 +01:00
|
|
|
const clean_data = configure_linkifier_api_response_schema.parse(data);
|
2021-03-13 18:15:14 +01:00
|
|
|
$("#linkifier_pattern").val("");
|
2022-10-05 22:52:26 +02:00
|
|
|
$("#linkifier_template").val("");
|
2022-01-25 11:36:19 +01:00
|
|
|
$add_linkifier_button.prop("disabled", false);
|
2024-03-09 12:12:17 +01:00
|
|
|
linkifier.id = clean_data.id;
|
2021-04-13 05:18:25 +02:00
|
|
|
ui_report.success(
|
|
|
|
$t_html({defaultMessage: "Custom linkifier added!"}),
|
2022-01-25 11:36:19 +01:00
|
|
|
$linkifier_status,
|
2021-04-13 05:18:25 +02:00
|
|
|
);
|
2020-07-15 00:34:28 +02:00
|
|
|
},
|
2020-07-20 22:18:43 +02:00
|
|
|
error(xhr) {
|
2022-01-25 11:36:19 +01:00
|
|
|
$add_linkifier_button.prop("disabled", false);
|
2024-05-05 09:48:22 +02:00
|
|
|
const parsed = z
|
|
|
|
.object({errors: z.record(z.array(z.string()).optional())})
|
|
|
|
.safeParse(xhr.responseJSON);
|
|
|
|
if (parsed.success) {
|
2023-07-18 20:19:22 +02:00
|
|
|
handle_linkifier_api_error(
|
2024-05-05 09:48:22 +02:00
|
|
|
parsed.data.errors,
|
2023-07-18 20:19:22 +02:00
|
|
|
$pattern_status,
|
|
|
|
$template_status,
|
|
|
|
$linkifier_status,
|
|
|
|
);
|
|
|
|
}
|
2020-07-15 00:34:28 +02:00
|
|
|
},
|
|
|
|
});
|
2017-04-08 23:24:03 +02:00
|
|
|
});
|
2021-02-28 01:21:57 +01:00
|
|
|
}
|