zulip/static/js/settings_org.js

1318 lines
48 KiB
JavaScript

import $ from "jquery";
import pygments_data from "../generated/pygments_data.json";
import render_settings_deactivate_realm_modal from "../templates/confirm_dialog/confirm_deactivate_realm.hbs";
import render_settings_admin_auth_methods_list from "../templates/settings/admin_auth_methods_list.hbs";
import render_settings_admin_realm_domains_list from "../templates/settings/admin_realm_domains_list.hbs";
import * as blueslip from "./blueslip";
import * as channel from "./channel";
import * as confirm_dialog from "./confirm_dialog";
import {csrf_token} from "./csrf";
import {DropdownListWidget} from "./dropdown_list_widget";
import {$t, $t_html} from "./i18n";
import * as loading from "./loading";
import * as overlays from "./overlays";
import {page_params} from "./page_params";
import * as realm_icon from "./realm_icon";
import * as realm_logo from "./realm_logo";
import {realm_user_settings_defaults} from "./realm_user_settings_defaults";
import * as settings_config from "./settings_config";
import * as settings_notifications from "./settings_notifications";
import * as settings_realm_user_settings_defaults from "./settings_realm_user_settings_defaults";
import * as settings_ui from "./settings_ui";
import * as stream_settings_data from "./stream_settings_data";
import * as ui_report from "./ui_report";
export let parse_time_limit;
const meta = {
loaded: false,
};
export function reset() {
meta.loaded = false;
}
export function maybe_disable_widgets() {
if (page_params.is_owner) {
return;
}
$(".organization-box [data-name='auth-methods']")
.find("input, button, select, checked")
.prop("disabled", true);
if (page_params.is_admin) {
$("#deactivate_realm_button").prop("disabled", true);
$("#org-message-retention").find("input, select").prop("disabled", true);
$("#id_realm_invite_to_realm_policy").prop("disabled", true);
return;
}
$(".organization-box [data-name='organization-profile']")
.find("input, textarea, button, select")
.prop("disabled", true);
$(".organization-box [data-name='organization-settings']")
.find("input, textarea, button, select")
.prop("disabled", true);
$(".organization-box [data-name='organization-settings']")
.find(".dropdown_list_reset_button")
.hide();
$(".organization-box [data-name='organization-settings']")
.find(".control-label-disabled")
.addClass("enabled");
$(".organization-box [data-name='organization-permissions']")
.find("input, textarea, button, select")
.prop("disabled", true);
$(".organization-box [data-name='organization-permissions']")
.find(".control-label-disabled")
.addClass("enabled");
}
export function get_sorted_options_list(option_values_object) {
const options_list = Object.keys(option_values_object).map((key) => ({
...option_values_object[key],
key,
}));
let comparator = (x, y) => x.order - y.order;
if (!options_list[0].order) {
comparator = (x, y) => {
const key_x = x.key.toUpperCase();
const key_y = y.key.toUpperCase();
if (key_x < key_y) {
return -1;
}
if (key_x > key_y) {
return 1;
}
return 0;
};
}
options_list.sort(comparator);
return options_list;
}
export function get_organization_settings_options() {
const options = {};
options.common_policy_values = get_sorted_options_list(settings_config.common_policy_values);
options.private_message_policy_values = get_sorted_options_list(
settings_config.private_message_policy_values,
);
options.wildcard_mention_policy_values = get_sorted_options_list(
settings_config.wildcard_mention_policy_values,
);
options.common_message_policy_values = get_sorted_options_list(
settings_config.common_message_policy_values,
);
options.invite_to_realm_policy_values = get_sorted_options_list(
settings_config.invite_to_realm_policy_values,
);
return options;
}
export function get_realm_time_limits_in_minutes(property) {
let val = (page_params[property] / 60).toFixed(1);
if (Number.parseFloat(val, 10) === Number.parseInt(val, 10)) {
val = Number.parseInt(val, 10);
}
return val.toString();
}
function get_property_value(property_name, for_realm_default_settings) {
if (for_realm_default_settings) {
// realm_user_default_settings are stored in a separate object.
if (property_name === "twenty_four_hour_time") {
return JSON.stringify(realm_user_settings_defaults.twenty_four_hour_time);
}
if (
property_name === "email_notifications_batching_period_seconds" ||
property_name === "email_notification_batching_period_edit_minutes"
) {
return realm_user_settings_defaults.email_notifications_batching_period_seconds;
}
return realm_user_settings_defaults[property_name];
}
if (property_name === "realm_message_content_edit_limit_minutes") {
return get_realm_time_limits_in_minutes("realm_message_content_edit_limit_seconds");
}
if (property_name === "realm_message_content_delete_limit_minutes") {
return get_realm_time_limits_in_minutes("realm_message_content_delete_limit_seconds");
}
if (property_name === "realm_waiting_period_setting") {
if (page_params.realm_waiting_period_threshold === 0) {
return "none";
}
if (page_params.realm_waiting_period_threshold === 3) {
return "three_days";
}
return "custom_days";
}
if (property_name === "realm_msg_edit_limit_setting") {
if (!page_params.realm_allow_message_editing) {
return "never";
}
for (const [value, elem] of settings_config.msg_edit_limit_dropdown_values) {
if (elem.seconds === page_params.realm_message_content_edit_limit_seconds) {
return value;
}
}
return "custom_limit";
}
if (property_name === "realm_message_retention_setting") {
if (page_params.realm_message_retention_days === settings_config.retain_message_forever) {
return "retain_forever";
}
return "retain_for_period";
}
if (property_name === "realm_msg_delete_limit_setting") {
if (page_params.realm_message_content_delete_limit_seconds === null) {
return "any_time";
}
for (const [value, elem] of settings_config.msg_delete_limit_dropdown_values) {
if (elem.seconds === page_params.realm_message_content_delete_limit_seconds) {
return value;
}
}
return "custom_limit";
}
if (property_name === "realm_org_join_restrictions") {
if (page_params.realm_emails_restricted_to_domains) {
return "only_selected_domain";
}
if (page_params.realm_disallow_disposable_email_addresses) {
return "no_disposable_email";
}
return "no_restriction";
}
return page_params[property_name];
}
export function extract_property_name(elem, for_realm_default_settings) {
if (for_realm_default_settings) {
// We use the name attribute, rather than the ID attribute,
// for realm_user_default_settings. This is because the
// display/notification settings elements do not always have
// IDs, and also the emojiset input is not compatible with the
// ID approach.
return elem.attr("name");
}
return elem.attr("id").split("-").join("_").replace("id_", "");
}
function get_subsection_property_elements(element) {
const subsection = $(element).closest(".org-subsection-parent");
if (subsection.hasClass("theme-settings")) {
// Because the emojiset widget has a unique radio button
// structure, it needs custom code.
const color_scheme_elem = subsection.find(".setting_color_scheme");
const emojiset_elem = subsection.find("input[name='emojiset']:checked");
const translate_emoticons_elem = subsection.find(".translate_emoticons");
return [color_scheme_elem, emojiset_elem, translate_emoticons_elem];
}
return Array.from(subsection.find(".prop-element"));
}
const simple_dropdown_properties = [
"realm_create_private_stream_policy",
"realm_create_public_stream_policy",
"realm_create_web_public_stream_policy",
"realm_invite_to_stream_policy",
"realm_user_group_edit_policy",
"realm_private_message_policy",
"realm_add_custom_emoji_policy",
"realm_invite_to_realm_policy",
"realm_wildcard_mention_policy",
"realm_move_messages_between_streams_policy",
"realm_edit_topic_policy",
];
function set_property_dropdown_value(property_name) {
$(`#id_${CSS.escape(property_name)}`).val(get_property_value(property_name));
}
export function change_element_block_display_property(elem_id, show_element) {
const elem = $(`#${CSS.escape(elem_id)}`);
if (show_element) {
elem.parent().show();
} else {
elem.parent().hide();
}
}
function set_realm_waiting_period_dropdown() {
const value = get_property_value("realm_waiting_period_setting");
$("#id_realm_waiting_period_setting").val(value);
change_element_block_display_property(
"id_realm_waiting_period_threshold",
value === "custom_days",
);
}
function set_video_chat_provider_dropdown() {
const chat_provider_id = page_params.realm_video_chat_provider;
$("#id_realm_video_chat_provider").val(chat_provider_id);
}
function set_giphy_rating_dropdown() {
const rating_id = page_params.realm_giphy_rating;
$("#id_realm_giphy_rating").val(rating_id);
}
function set_msg_edit_limit_dropdown() {
const value = get_property_value("realm_msg_edit_limit_setting");
$("#id_realm_msg_edit_limit_setting").val(value);
change_element_block_display_property(
"id_realm_message_content_edit_limit_minutes",
value === "custom_limit",
);
settings_ui.disable_sub_setting_onchange(value !== "never", "id_realm_edit_topic_policy", true);
}
function message_delete_limit_setting_enabled() {
// This function is used to check whether the time-limit setting
// should be enabled. The setting is disabled when delete_own_message_policy
// is set to 'admins only' as admins can delete messages irrespective of
// time limit.
if (
page_params.realm_delete_own_message_policy ===
settings_config.common_message_policy_values.by_admins_only.code
) {
return false;
}
return true;
}
function set_delete_own_message_policy_dropdown() {
const value = get_property_value("realm_delete_own_message_policy");
$("#id_realm_delete_own_message_policy").val(value);
settings_ui.disable_sub_setting_onchange(
message_delete_limit_setting_enabled(),
"id_realm_msg_delete_limit_setting",
true,
);
const limit_value = get_property_value("realm_msg_delete_limit_setting");
if (limit_value === "custom_limit") {
settings_ui.disable_sub_setting_onchange(
message_delete_limit_setting_enabled(),
"id_realm_message_content_delete_limit_minutes",
true,
);
}
}
function set_msg_delete_limit_dropdown() {
const value = get_property_value("realm_msg_delete_limit_setting");
$("#id_realm_msg_delete_limit_setting").val(value);
change_element_block_display_property(
"id_realm_message_content_delete_limit_minutes",
value === "custom_limit",
);
}
function set_message_retention_setting_dropdown() {
const value = get_property_value("realm_message_retention_setting");
$("#id_realm_message_retention_setting").val(value);
change_element_block_display_property(
"id_realm_message_retention_days",
value === "retain_for_period",
);
if (
get_property_value("realm_message_retention_days") ===
settings_config.retain_message_forever
) {
$("#id_realm_message_retention_days").val("");
}
}
function set_org_join_restrictions_dropdown() {
const value = get_property_value("realm_org_join_restrictions");
$("#id_realm_org_join_restrictions").val(value);
change_element_block_display_property(
"allowed_domains_label",
value === "only_selected_domain",
);
}
function set_message_content_in_email_notifications_visiblity() {
change_element_block_display_property(
"message_content_in_email_notifications_label",
page_params.realm_message_content_allowed_in_email_notifications,
);
}
function set_digest_emails_weekday_visibility() {
change_element_block_display_property(
"id_realm_digest_weekday",
page_params.realm_digest_emails_enabled,
);
}
function set_create_web_public_stream_dropdown_visibility() {
change_element_block_display_property(
"id_realm_create_web_public_stream_policy",
page_params.server_web_public_streams_enabled && page_params.realm_enable_spectator_access,
);
}
export function populate_realm_domains(realm_domains) {
if (!meta.loaded) {
return;
}
const domains_list = realm_domains.map((realm_domain) =>
realm_domain.allow_subdomains ? "*." + realm_domain.domain : realm_domain.domain,
);
let domains = domains_list.join(", ");
if (domains.length === 0) {
domains = $t({defaultMessage: "None"});
}
$("#allowed_domains_label").text($t({defaultMessage: "Allowed domains: {domains}"}, {domains}));
const realm_domains_table_body = $("#realm_domains_table tbody").expectOne();
realm_domains_table_body.find("tr").remove();
for (const realm_domain of realm_domains) {
realm_domains_table_body.append(
render_settings_admin_realm_domains_list({
realm_domain,
}),
);
}
}
function sort_object_by_key(obj) {
const keys = Object.keys(obj).sort();
const new_obj = {};
for (const key of keys) {
new_obj[key] = obj[key];
}
return new_obj;
}
export function populate_auth_methods(auth_methods) {
if (!meta.loaded) {
return;
}
const auth_methods_table = $("#id_realm_authentication_methods").expectOne();
auth_methods = sort_object_by_key(auth_methods);
let rendered_auth_method_rows = "";
for (const [auth_method, value] of Object.entries(auth_methods)) {
rendered_auth_method_rows += render_settings_admin_auth_methods_list({
method: auth_method,
enabled: value,
is_owner: page_params.is_owner,
});
}
auth_methods_table.html(rendered_auth_method_rows);
}
function update_dependent_subsettings(property_name) {
if (simple_dropdown_properties.includes(property_name)) {
set_property_dropdown_value(property_name);
return;
}
switch (property_name) {
case "realm_waiting_period_threshold":
set_realm_waiting_period_dropdown();
break;
case "realm_video_chat_provider":
set_video_chat_provider_dropdown();
break;
case "realm_msg_edit_limit_setting":
case "realm_message_content_edit_limit_minutes":
set_msg_edit_limit_dropdown();
break;
case "realm_message_retention_days":
set_message_retention_setting_dropdown();
break;
case "realm_msg_delete_limit_setting":
case "realm_message_content_delete_limit_minutes":
set_msg_delete_limit_dropdown();
break;
case "realm_delete_own_message_policy":
set_delete_own_message_policy_dropdown();
break;
case "realm_org_join_restrictions":
set_org_join_restrictions_dropdown();
break;
case "realm_message_content_allowed_in_email_notifications":
set_message_content_in_email_notifications_visiblity();
break;
case "realm_digest_emails_enabled":
settings_notifications.set_enable_digest_emails_visibility(
settings_notifications.user_settings_panel,
);
settings_notifications.set_enable_digest_emails_visibility(
settings_realm_user_settings_defaults.realm_default_settings_panel,
);
set_digest_emails_weekday_visibility();
break;
case "realm_enable_spectator_access":
set_create_web_public_stream_dropdown_visibility();
break;
}
}
export let default_code_language_widget = null;
export let notifications_stream_widget = null;
export let signup_notifications_stream_widget = null;
function discard_property_element_changes(elem, for_realm_default_settings) {
elem = $(elem);
const property_name = extract_property_name(elem, for_realm_default_settings);
const property_value = get_property_value(property_name, for_realm_default_settings);
switch (property_name) {
case "realm_authentication_methods":
populate_auth_methods(property_value);
break;
case "realm_notifications_stream_id":
notifications_stream_widget.render(property_value);
break;
case "realm_signup_notifications_stream_id":
signup_notifications_stream_widget.render(property_value);
break;
case "realm_default_code_block_language":
default_code_language_widget.render(property_value);
break;
case "emojiset":
// Because the emojiset widget has a unique radio button
// structure, it needs custom reset code.
elem.closest(".org-subsection-parent")
.find(`.setting_emojiset_choice[value='${CSS.escape(property_value)}'`)
.prop("checked", true);
break;
case "email_notifications_batching_period_seconds":
case "email_notification_batching_period_edit_minutes":
settings_notifications.set_notification_batching_ui(
$("#realm-user-default-settings"),
realm_user_settings_defaults.email_notifications_batching_period_seconds,
);
break;
default:
if (property_value !== undefined) {
set_input_element_value(elem, property_value);
} else {
blueslip.error("Element refers to unknown property " + property_name);
}
}
update_dependent_subsettings(property_name);
}
export function sync_realm_settings(property) {
if (!overlays.settings_open()) {
return;
}
const value = page_params[`realm_${property}`];
switch (property) {
case "notifications_stream_id":
notifications_stream_widget.render(value);
break;
case "signup_notifications_stream_id":
signup_notifications_stream_widget.render(value);
break;
case "default_code_block_language":
default_code_language_widget.render(value);
break;
}
switch (property) {
case "message_content_edit_limit_seconds":
property = "message_content_edit_limit_minutes";
break;
case "allow_message_editing":
property = "msg_edit_limit_setting";
break;
case "emails_restricted_to_domains":
case "disallow_disposable_email_addresses":
property = "org_join_restrictions";
break;
case "message_content_delete_limit_seconds":
property = "message_content_delete_limit_minutes";
break;
}
const element = $(`#id_realm_${CSS.escape(property)}`);
if (element.length) {
discard_property_element_changes(element);
}
}
export function change_save_button_state($element, state) {
function show_hide_element($element, show, fadeout_delay) {
if (show) {
$element.removeClass("hide").addClass(".show").fadeIn(300);
return;
}
setTimeout(() => {
$element.fadeOut(300);
}, fadeout_delay);
}
const $saveBtn = $element.find(".save-button");
const $textEl = $saveBtn.find(".save-discard-widget-button-text");
if (state !== "saving") {
$saveBtn.removeClass("saving");
}
if (state === "discarded") {
show_hide_element($element, false, 0);
return;
}
let button_text;
let data_status;
let is_show;
switch (state) {
case "unsaved":
button_text = $t({defaultMessage: "Save changes"});
data_status = "unsaved";
is_show = true;
$element.find(".discard-button").show();
break;
case "saved":
button_text = $t({defaultMessage: "Save changes"});
data_status = "";
is_show = false;
break;
case "saving":
button_text = $t({defaultMessage: "Saving"});
data_status = "saving";
is_show = true;
$element.find(".discard-button").hide();
$saveBtn.addClass("saving");
break;
case "failed":
button_text = $t({defaultMessage: "Save changes"});
data_status = "failed";
is_show = true;
break;
case "succeeded":
button_text = $t({defaultMessage: "Saved"});
data_status = "saved";
is_show = false;
break;
}
$textEl.text(button_text);
$saveBtn.attr("data-status", data_status);
show_hide_element($element, is_show, 800);
}
export function save_organization_settings(data, save_button, patch_url) {
const subsection_parent = save_button.closest(".org-subsection-parent");
const save_btn_container = subsection_parent.find(".save-button-controls");
const failed_alert_elem = subsection_parent.find(".subsection-failed-status p");
change_save_button_state(save_btn_container, "saving");
channel.patch({
url: patch_url,
data,
success() {
failed_alert_elem.hide();
change_save_button_state(save_btn_container, "succeeded");
},
error(xhr) {
change_save_button_state(save_btn_container, "failed");
save_button.hide();
ui_report.error($t_html({defaultMessage: "Save failed"}), xhr, failed_alert_elem);
},
});
}
function get_input_type(input_elem, input_type) {
if (["boolean", "string", "number"].includes(input_type)) {
return input_type;
}
return input_elem.data("setting-widget-type");
}
export function get_input_element_value(input_elem, input_type) {
input_elem = $(input_elem);
input_type = get_input_type(input_elem, input_type);
switch (input_type) {
case "boolean":
return input_elem.prop("checked");
case "string":
return input_elem.val().trim();
case "number":
return Number.parseInt(input_elem.val().trim(), 10);
case "radio-group":
if (input_elem.prop("checked")) {
return input_elem.val().trim();
}
return undefined;
default:
return undefined;
}
}
export function set_input_element_value(input_elem, value) {
const input_type = get_input_type(input_elem, typeof value);
if (input_type) {
if (input_type === "boolean") {
return input_elem.prop("checked", value);
} else if (input_type === "string" || input_type === "number") {
return input_elem.val(value);
}
}
blueslip.error(`Failed to set value of property ${extract_property_name(input_elem)}`);
return undefined;
}
export function set_up() {
build_page();
maybe_disable_widgets();
}
function get_auth_method_table_data() {
const new_auth_methods = {};
const auth_method_rows = $("#id_realm_authentication_methods").find("tr.method_row");
for (const method_row of auth_method_rows) {
new_auth_methods[$(method_row).data("method")] = $(method_row)
.find("input")
.prop("checked");
}
return new_auth_methods;
}
function get_email_notification_batching_setting_element_value() {
const select_elem_val = $("#realm-user-default-settings")
.find(".setting_email_notifications_batching_period_seconds")
.val();
if (select_elem_val !== "custom_period") {
return Number.parseInt(select_elem_val, 10);
}
const edit_elem_val = $("#realm_email_notification_batching_period_edit_minutes").val();
const setting_value_in_minutes = Number.parseInt(edit_elem_val, 10);
return setting_value_in_minutes * 60;
}
function check_property_changed(elem, for_realm_default_settings) {
elem = $(elem);
const property_name = extract_property_name(elem, for_realm_default_settings);
let current_val = get_property_value(property_name, for_realm_default_settings);
let changed_val;
switch (property_name) {
case "realm_authentication_methods":
current_val = sort_object_by_key(current_val);
current_val = JSON.stringify(current_val);
changed_val = get_auth_method_table_data();
changed_val = JSON.stringify(changed_val);
break;
case "realm_notifications_stream_id":
changed_val = Number.parseInt(notifications_stream_widget.value(), 10);
break;
case "realm_signup_notifications_stream_id":
changed_val = Number.parseInt(signup_notifications_stream_widget.value(), 10);
break;
case "realm_default_code_block_language":
changed_val = default_code_language_widget.value();
break;
case "email_notifications_batching_period_seconds":
case "email_notification_batching_period_edit_minutes": {
changed_val = get_email_notification_batching_setting_element_value();
break;
}
default:
if (current_val !== undefined) {
changed_val = get_input_element_value(elem, typeof current_val);
} else {
blueslip.error("Element refers to unknown property " + property_name);
}
}
return current_val !== changed_val;
}
export function save_discard_widget_status_handler(subsection, for_realm_default_settings) {
subsection.find(".subsection-failed-status p").hide();
subsection.find(".save-button").show();
const properties_elements = get_subsection_property_elements(subsection);
const show_change_process_button = properties_elements.some((elem) =>
check_property_changed(elem, for_realm_default_settings),
);
const save_btn_controls = subsection.find(".subsection-header .save-button-controls");
const button_state = show_change_process_button ? "unsaved" : "discarded";
change_save_button_state(save_btn_controls, button_state);
}
export function init_dropdown_widgets() {
const streams = stream_settings_data.get_streams_for_settings_page();
const notification_stream_options = {
data: streams.map((x) => ({
name: x.name,
value: x.stream_id.toString(),
})),
on_update: () => {
save_discard_widget_status_handler($("#org-notifications"));
},
default_text: $t({defaultMessage: "Disabled"}),
render_text: (x) => `#${x}`,
null_value: -1,
};
notifications_stream_widget = new DropdownListWidget({
widget_name: "realm_notifications_stream_id",
value: page_params.realm_notifications_stream_id,
...notification_stream_options,
});
signup_notifications_stream_widget = new DropdownListWidget({
widget_name: "realm_signup_notifications_stream_id",
value: page_params.realm_signup_notifications_stream_id,
...notification_stream_options,
});
default_code_language_widget = new DropdownListWidget({
widget_name: "realm_default_code_block_language",
data: Object.keys(pygments_data.langs).map((x) => ({
name: x,
value: x,
})),
value: page_params.realm_default_code_block_language,
on_update: () => {
save_discard_widget_status_handler($("#org-other-settings"));
},
default_text: $t({defaultMessage: "No language set"}),
});
}
export function register_save_discard_widget_handlers(
container,
patch_url,
for_realm_default_settings,
) {
container.on("change input", "input, select, textarea", (e) => {
e.preventDefault();
e.stopPropagation();
// This event handler detects whether after these input
// changes, any fields have different values from the current
// official values stored in the database and page_params. If
// they do, we transition to the "unsaved" state showing the
// save/discard widget; otherwise, we hide that widget (the
// "discarded" state).
if ($(e.target).hasClass("no-input-change-detection")) {
// This is to prevent input changes detection in elements
// within a subsection whose changes should not affect the
// visibility of the discard button
return false;
}
if ($(e.target).hasClass("setting_email_notifications_batching_period_seconds")) {
const show_elem = $(e.target).val() === "custom_period";
change_element_block_display_property(
"realm_email_notification_batching_period_edit_minutes",
show_elem,
);
}
const subsection = $(e.target).closest(".org-subsection-parent");
save_discard_widget_status_handler(subsection, for_realm_default_settings);
return undefined;
});
container.on("click", ".subsection-header .subsection-changes-discard button", (e) => {
e.preventDefault();
e.stopPropagation();
for (const elem of get_subsection_property_elements(e.target)) {
discard_property_element_changes(elem, for_realm_default_settings);
}
const save_btn_controls = $(e.target).closest(".save-button-controls");
change_save_button_state(save_btn_controls, "discarded");
});
parse_time_limit = function parse_time_limit(elem) {
return Math.floor(Number.parseFloat(elem.val(), 10).toFixed(1) * 60);
};
function get_complete_data_for_subsection(subsection) {
let data = {};
switch (subsection) {
case "msg_editing": {
const edit_limit_setting_value = $("#id_realm_msg_edit_limit_setting").val();
if (edit_limit_setting_value === "never") {
data.allow_message_editing = false;
} else if (edit_limit_setting_value === "custom_limit") {
data.message_content_edit_limit_seconds = parse_time_limit(
$("#id_realm_message_content_edit_limit_minutes"),
);
// Disable editing if the parsed time limit is 0 seconds
data.allow_message_editing = Boolean(data.message_content_edit_limit_seconds);
} else {
data.allow_message_editing = true;
data.message_content_edit_limit_seconds =
settings_config.msg_edit_limit_dropdown_values.get(
edit_limit_setting_value,
).seconds;
}
const delete_limit_setting_value = $("#id_realm_msg_delete_limit_setting").val();
switch (delete_limit_setting_value) {
case "any_time": {
data.message_content_delete_limit_seconds = JSON.stringify("unlimited");
break;
}
case "custom_limit": {
data.message_content_delete_limit_seconds = parse_time_limit(
$("#id_realm_message_content_delete_limit_minutes"),
);
break;
}
default: {
data.message_content_delete_limit_seconds =
settings_config.msg_delete_limit_dropdown_values.get(
delete_limit_setting_value,
).seconds;
}
}
data.delete_own_message_policy = $("#id_realm_delete_own_message_policy").val();
break;
}
case "notifications":
data.notifications_stream_id = Number.parseInt(
notifications_stream_widget.value(),
10,
);
data.signup_notifications_stream_id = Number.parseInt(
signup_notifications_stream_widget.value(),
10,
);
break;
case "message_retention": {
const message_retention_setting_value = $(
"#id_realm_message_retention_setting",
).val();
if (message_retention_setting_value === "retain_forever") {
data.message_retention_days = JSON.stringify("unlimited");
} else {
data.message_retention_days = JSON.stringify(
get_input_element_value($("#id_realm_message_retention_days")),
);
}
break;
}
case "other_settings": {
const code_block_language_value = default_code_language_widget.value();
// No need to JSON-encode, since this value is already a string.
data.default_code_block_language = code_block_language_value;
break;
}
case "org_join": {
const org_join_restrictions = $("#id_realm_org_join_restrictions").val();
switch (org_join_restrictions) {
case "only_selected_domain":
data.emails_restricted_to_domains = true;
data.disallow_disposable_email_addresses = false;
break;
case "no_disposable_email":
data.emails_restricted_to_domains = false;
data.disallow_disposable_email_addresses = true;
break;
case "no_restriction":
data.disallow_disposable_email_addresses = false;
data.emails_restricted_to_domains = false;
break;
}
const waiting_period_threshold = $("#id_realm_waiting_period_setting").val();
switch (waiting_period_threshold) {
case "none":
data.waiting_period_threshold = 0;
break;
case "three_days":
data.waiting_period_threshold = 3;
break;
case "custom_days":
data.waiting_period_threshold = $(
"#id_realm_waiting_period_threshold",
).val();
break;
}
break;
}
case "auth_settings":
data = {};
data.authentication_methods = JSON.stringify(get_auth_method_table_data());
break;
}
return data;
}
function populate_data_for_request(subsection) {
const data = {};
const properties_elements = get_subsection_property_elements(subsection);
for (let input_elem of properties_elements) {
input_elem = $(input_elem);
if (check_property_changed(input_elem, for_realm_default_settings)) {
if (
input_elem.hasClass("email_notification_batching_period_edit_minutes") ||
input_elem.hasClass("setting_email_notifications_batching_period_seconds")
) {
const setting_value = get_email_notification_batching_setting_element_value();
data.email_notifications_batching_period_seconds = setting_value;
continue;
}
const input_value = get_input_element_value(input_elem);
if (input_value !== undefined) {
let property_name;
if (for_realm_default_settings) {
// We use the name attribute, rather than the ID attribute,
// for realm_user_default_settings. This is because the
// display/notification settings elements do not always have
// IDs, and also the emojiset input is not compatible with the
// ID approach.
property_name = input_elem.attr("name");
} else {
property_name = input_elem.attr("id").replace("id_realm_", "");
}
data[property_name] = input_value;
}
}
}
return data;
}
container.on("click", ".subsection-header .subsection-changes-save button", (e) => {
e.preventDefault();
e.stopPropagation();
const save_button = $(e.currentTarget);
const subsection_elem = save_button.closest(".org-subsection-parent");
let extra_data = {};
if (!for_realm_default_settings) {
// The organization settings system has some coupled
// fields that must be submitted together, which is
// managed by the get_complete_data_for_subsection function.
const subsection_id = save_button.attr("id").replace("org-submit-", "");
const subsection = subsection_id.split("-").join("_");
extra_data = get_complete_data_for_subsection(subsection);
}
const data = {
...populate_data_for_request(subsection_elem),
...extra_data,
};
save_organization_settings(data, save_button, patch_url);
});
}
export function build_page() {
meta.loaded = true;
loading.make_indicator($("#admin_page_auth_methods_loading_indicator"));
// Initialize all the dropdown list widgets.
init_dropdown_widgets();
// Populate realm domains
populate_realm_domains(page_params.realm_domains);
// Populate authentication methods table
populate_auth_methods(page_params.realm_authentication_methods);
for (const property_name of simple_dropdown_properties) {
set_property_dropdown_value(property_name);
}
set_realm_waiting_period_dropdown();
set_video_chat_provider_dropdown();
set_giphy_rating_dropdown();
set_msg_edit_limit_dropdown();
set_msg_delete_limit_dropdown();
set_delete_own_message_policy_dropdown();
set_message_retention_setting_dropdown();
set_org_join_restrictions_dropdown();
set_message_content_in_email_notifications_visiblity();
set_digest_emails_weekday_visibility();
set_create_web_public_stream_dropdown_visibility();
register_save_discard_widget_handlers($(".admin-realm-form"), "/json/realm", false);
$(".org-subsection-parent").on("keydown", "input", (e) => {
e.stopPropagation();
if (e.key === "Enter") {
e.preventDefault();
$(e.target)
.closest(".org-subsection-parent")
.find(".subsection-changes-save button")
.trigger("click");
}
});
$("#id_realm_msg_edit_limit_setting").on("change", (e) => {
const msg_edit_limit_dropdown_value = e.target.value;
change_element_block_display_property(
"id_realm_message_content_edit_limit_minutes",
msg_edit_limit_dropdown_value === "custom_limit",
);
});
$("#id_realm_msg_delete_limit_setting").on("change", (e) => {
const msg_delete_limit_dropdown_value = e.target.value;
change_element_block_display_property(
"id_realm_message_content_delete_limit_minutes",
msg_delete_limit_dropdown_value === "custom_limit",
);
});
$("#id_realm_message_retention_setting").on("change", (e) => {
const message_retention_setting_dropdown_value = e.target.value;
change_element_block_display_property(
"id_realm_message_retention_days",
message_retention_setting_dropdown_value === "retain_for_period",
);
});
$("#id_realm_waiting_period_setting").on("change", function () {
const waiting_period_threshold = this.value;
change_element_block_display_property(
"id_realm_waiting_period_threshold",
waiting_period_threshold === "custom_days",
);
});
$("#id_realm_digest_emails_enabled").on("change", (e) => {
const digest_emails_enabled = $(e.target).is(":checked");
change_element_block_display_property(
"id_realm_digest_weekday",
digest_emails_enabled === true,
);
});
$("#id_realm_org_join_restrictions").on("change", (e) => {
const org_join_restrictions = e.target.value;
const node = $("#allowed_domains_label").parent();
if (org_join_restrictions === "only_selected_domain") {
node.show();
if (page_params.realm_domains.length === 0) {
overlays.open_modal("#realm_domains_modal");
}
} else {
node.hide();
}
});
$("#id_realm_org_join_restrictions").on("click", (e) => {
// This prevents the disappearance of modal when there are
// no allowed domains otherwise it gets closed due to
// the click event handler attached to `#settings_overlay_container`
e.stopPropagation();
});
function fade_status_element(elem) {
setTimeout(() => {
elem.fadeOut(500);
}, 1000);
}
$("#realm_domains_table").on("click", ".delete_realm_domain", function () {
const domain = $(this).parents("tr").find(".domain").text();
const url = "/json/realm/domains/" + domain;
const realm_domains_info = $(".realm_domains_info");
channel.del({
url,
success() {
ui_report.success(
$t_html({defaultMessage: "Deleted successfully!"}),
realm_domains_info,
);
fade_status_element(realm_domains_info);
},
error(xhr) {
ui_report.error($t_html({defaultMessage: "Failed"}), xhr, realm_domains_info);
fade_status_element(realm_domains_info);
},
});
});
$("#submit-add-realm-domain").on("click", () => {
const realm_domains_info = $(".realm_domains_info");
const widget = $("#add-realm-domain-widget");
const domain = widget.find(".new-realm-domain").val();
const allow_subdomains = widget.find(".new-realm-domain-allow-subdomains").prop("checked");
const data = {
domain,
allow_subdomains: JSON.stringify(allow_subdomains),
};
channel.post({
url: "/json/realm/domains",
data,
success() {
$("#add-realm-domain-widget .new-realm-domain").val("");
$("#add-realm-domain-widget .new-realm-domain-allow-subdomains").prop(
"checked",
false,
);
ui_report.success(
$t_html({defaultMessage: "Added successfully!"}),
realm_domains_info,
);
fade_status_element(realm_domains_info);
},
error(xhr) {
ui_report.error($t_html({defaultMessage: "Failed"}), xhr, realm_domains_info);
fade_status_element(realm_domains_info);
},
});
});
$("#realm_domains_table").on("change", ".allow-subdomains", function (e) {
e.stopPropagation();
const realm_domains_info = $(".realm_domains_info");
const domain = $(this).parents("tr").find(".domain").text();
const allow_subdomains = $(this).prop("checked");
const url = "/json/realm/domains/" + domain;
const data = {
allow_subdomains: JSON.stringify(allow_subdomains),
};
channel.patch({
url,
data,
success() {
if (allow_subdomains) {
ui_report.success(
$t_html(
{defaultMessage: "Update successful: Subdomains allowed for {domain}"},
{domain},
),
realm_domains_info,
);
} else {
ui_report.success(
$t_html(
{
defaultMessage:
"Update successful: Subdomains no longer allowed for {domain}",
},
{domain},
),
realm_domains_info,
);
}
fade_status_element(realm_domains_info);
},
error(xhr) {
ui_report.error($t_html({defaultMessage: "Failed"}), xhr, realm_domains_info);
fade_status_element(realm_domains_info);
},
});
});
function realm_icon_logo_upload_complete(spinner, upload_text, delete_button) {
spinner.css({visibility: "hidden"});
upload_text.show();
delete_button.show();
}
function realm_icon_logo_upload_start(spinner, upload_text, delete_button) {
spinner.css({visibility: "visible"});
upload_text.hide();
delete_button.hide();
}
function upload_realm_logo_or_icon(file_input, night, icon) {
const form_data = new FormData();
let widget;
let url;
form_data.append("csrfmiddlewaretoken", csrf_token);
for (const [i, file] of Array.prototype.entries.call(file_input[0].files)) {
form_data.append("file-" + i, file);
}
if (icon) {
url = "/json/realm/icon";
widget = "#realm-icon-upload-widget";
} else {
if (night) {
widget = "#realm-night-logo-upload-widget";
} else {
widget = "#realm-day-logo-upload-widget";
}
url = "/json/realm/logo";
form_data.append("night", JSON.stringify(night));
}
const spinner = $(`${widget} .upload-spinner-background`).expectOne();
const upload_text = $(`${widget} .image-upload-text`).expectOne();
const delete_button = $(`${widget} .image-delete-button`).expectOne();
const error_field = $(`${widget} .image_file_input_error`).expectOne();
realm_icon_logo_upload_start(spinner, upload_text, delete_button);
error_field.hide();
channel.post({
url,
data: form_data,
cache: false,
processData: false,
contentType: false,
success() {
realm_icon_logo_upload_complete(spinner, upload_text, delete_button);
},
error(xhr) {
realm_icon_logo_upload_complete(spinner, upload_text, delete_button);
ui_report.error("", xhr, error_field);
},
});
}
realm_icon.build_realm_icon_widget(upload_realm_logo_or_icon, null, true);
if (page_params.zulip_plan_is_not_limited) {
realm_logo.build_realm_logo_widget(upload_realm_logo_or_icon, false);
realm_logo.build_realm_logo_widget(upload_realm_logo_or_icon, true);
}
$("#deactivate_realm_button").on("click", (e) => {
e.preventDefault();
e.stopPropagation();
function do_deactivate_realm() {
channel.post({
url: "/json/realm/deactivate",
error(xhr) {
ui_report.error(
$t_html({defaultMessage: "Failed"}),
xhr,
$("#admin-realm-deactivation-status").expectOne(),
);
},
});
}
const html_body = render_settings_deactivate_realm_modal();
confirm_dialog.launch({
html_heading: $t_html({defaultMessage: "Deactivate organization"}),
help_link: "/help/deactivate-your-organization",
html_body,
on_click: do_deactivate_realm,
});
});
}