zulip/web/src/user_profile.js

560 lines
21 KiB
JavaScript

import {parseISO} from "date-fns";
import $ from "jquery";
import render_user_group_list_item from "../templates/user_group_list_item.hbs";
import render_user_profile_modal from "../templates/user_profile_modal.hbs";
import render_user_stream_list_item from "../templates/user_stream_list_item.hbs";
import * as browser_history from "./browser_history";
import * as buddy_data from "./buddy_data";
import * as channel from "./channel";
import * as components from "./components";
import * as dropdown_widget from "./dropdown_widget";
import * as hash_util from "./hash_util";
import {$t, $t_html} from "./i18n";
import * as ListWidget from "./list_widget";
import * as overlays from "./overlays";
import {page_params} from "./page_params";
import * as people from "./people";
import * as popovers from "./popovers";
import * as settings_account from "./settings_account";
import * as settings_bots from "./settings_bots";
import * as settings_profile_fields from "./settings_profile_fields";
import * as settings_users from "./settings_users";
import * as stream_data from "./stream_data";
import * as stream_ui_updates from "./stream_ui_updates";
import * as sub_store from "./sub_store";
import * as subscriber_api from "./subscriber_api";
import * as timerender from "./timerender";
import * as ui_report from "./ui_report";
import * as user_groups from "./user_groups";
import * as user_pill from "./user_pill";
import * as util from "./util";
let user_streams_list_widget;
let user_profile_subscribe_widget;
let toggler;
function compare_by_name(a, b) {
return util.strcmp(a.name, b.name);
}
export function get_user_id_if_user_profile_modal_open() {
if (overlays.is_modal_open() && overlays.active_modal() === "#user-profile-modal") {
const user_id = $("#user-profile-modal").data("user-id");
return user_id;
}
return undefined;
}
export function update_user_profile_streams_list_for_users(user_ids) {
const user_id = get_user_id_if_user_profile_modal_open();
if (user_id && user_ids.includes(user_id) && user_streams_list_widget !== undefined) {
const user_streams = stream_data.get_streams_for_user(user_id).subscribed;
user_streams.sort(compare_by_name);
user_streams_list_widget.replace_list_data(user_streams);
}
}
function initialize_bot_owner(element_id, bot_id) {
const user_pills = new Map();
const bot = people.get_by_user_id(bot_id);
const bot_owner = people.get_bot_owner_user(bot);
// Bot owner's pill displaying on bot's profile modal.
if (bot_owner) {
const $pill_container = $(element_id)
.find(
`.bot_owner_user_field[data-field-id="${CSS.escape(
bot_owner.user_id,
)}"] .pill-container`,
)
.expectOne();
const pills = user_pill.create_pills($pill_container);
user_pill.append_user(bot_owner, pills);
user_pills.set(bot_owner.user_id, pills);
}
return user_pills;
}
function render_user_profile_subscribe_widget() {
const opts = {
widget_name: "user_profile_subscribe",
get_options: get_user_unsub_streams,
item_click_callback: change_state_of_subscribe_button,
$events_container: $("#user-profile-modal"),
tippy_props: {
placement: "bottom-start",
},
};
user_profile_subscribe_widget = new dropdown_widget.DropdownWidget(opts);
user_profile_subscribe_widget.setup();
}
function change_state_of_subscribe_button(event, dropdown) {
dropdown.hide();
event.preventDefault();
event.stopPropagation();
user_profile_subscribe_widget.render();
const $subscribe_button = $("#user-profile-modal .add-subscription-button");
$subscribe_button.parent()[0]._tippy?.destroy();
$subscribe_button.prop("disabled", false);
}
function reset_subscribe_widget() {
$("#user-profile-modal .add-subscription-button").prop("disabled", true);
stream_ui_updates.initialize_disable_btn_hint_popover(
$("#user-profile-modal .add-subscription-button-wrapper"),
$t({defaultMessage: "Select a stream to subscribe"}),
);
$("#user_profile_subscribe_widget .dropdown_widget_value").text(
$t({defaultMessage: "Select a stream"}),
);
}
export function get_user_unsub_streams() {
const target_user_id = Number.parseInt($("#user-profile-modal").attr("data-user-id"), 10);
return stream_data
.get_streams_for_user(target_user_id)
.can_subscribe.filter((stream) => stream_data.can_subscribe_others(stream))
.map((stream) => ({
name: stream.name,
unique_id: stream.stream_id.toString(),
stream,
}))
.sort((a, b) => {
if (a.name.toLowerCase() < b.name.toLowerCase()) {
return -1;
}
if (a.name.toLowerCase() > b.name.toLowerCase()) {
return 1;
}
return 0;
});
}
function format_user_stream_list_item(stream, user) {
const show_unsubscribe_button =
people.can_admin_user(user) || stream_data.can_unsubscribe_others(stream);
const show_private_stream_unsub_tooltip =
people.is_my_user_id(user.user_id) && stream.invite_only;
return render_user_stream_list_item({
name: stream.name,
stream_id: stream.stream_id,
stream_color: stream.color,
invite_only: stream.invite_only,
is_web_public: stream.is_web_public,
show_unsubscribe_button,
show_private_stream_unsub_tooltip,
stream_edit_url: hash_util.stream_edit_url(stream),
});
}
function format_user_group_list_item(group) {
return render_user_group_list_item({
group_id: group.id,
name: group.name,
});
}
function render_user_stream_list(streams, user) {
streams.sort(compare_by_name);
const $container = $("#user-profile-modal .user-stream-list");
$container.empty();
user_streams_list_widget = ListWidget.create($container, streams, {
name: `user-${user.user_id}-stream-list`,
get_item: ListWidget.default_get_item,
modifier(item) {
return format_user_stream_list_item(item, user);
},
filter: {
$element: $("#user-profile-streams-tab .stream-search"),
predicate(item, value) {
return item && item.name.toLocaleLowerCase().includes(value);
},
},
$simplebar_container: $("#user-profile-modal .modal__body"),
});
}
function render_user_group_list(groups, user) {
groups.sort(compare_by_name);
const $container = $("#user-profile-modal .user-group-list");
$container.empty();
ListWidget.create($container, groups, {
name: `user-${user.user_id}-group-list`,
get_item: ListWidget.default_get_item,
modifier(item) {
return format_user_group_list_item(item);
},
$simplebar_container: $("#user-profile-modal .modal__body"),
});
}
function render_manage_profile_content(user) {
// Since we want the height of the profile modal to remain consistent when switching tabs,
// we need to restrict the height of the main body. This will ensure that the footer of
// the "Manage User" tab can adjust within the provided height without expanding the modal.
$("#user-profile-modal .modal__body").addClass("modal__body__manage_profile_height");
$("#user-profile-modal .manage-profile-tab-footer").addClass("modal__footer_wrapper");
const $container = $("#manage-profile-tab");
$container.empty();
if (user.is_bot) {
settings_bots.show_edit_bot_info_modal(user.user_id, $container);
} else {
settings_users.show_edit_user_info_modal(user.user_id, $container);
}
}
export function get_custom_profile_field_data(user, field, field_types) {
const field_value = people.get_custom_profile_data(user.user_id, field.id);
const field_type = field.type;
const profile_field = {};
if (!field_value) {
return profile_field;
}
if (!field_value.value) {
return profile_field;
}
profile_field.id = field.id;
profile_field.name = field.name;
profile_field.is_user_field = false;
profile_field.is_link = field_type === field_types.URL.id;
profile_field.is_external_account = field_type === field_types.EXTERNAL_ACCOUNT.id;
profile_field.type = field_type;
profile_field.display_in_profile_summary = field.display_in_profile_summary;
switch (field_type) {
case field_types.DATE.id:
profile_field.value = timerender.get_localized_date_or_time_for_format(
parseISO(field_value.value),
"dayofyear_year",
);
break;
case field_types.USER.id:
profile_field.is_user_field = true;
profile_field.value = field_value.value;
break;
case field_types.SELECT.id: {
const field_choice_dict = JSON.parse(field.field_data);
profile_field.value = field_choice_dict[field_value.value].text;
break;
}
case field_types.SHORT_TEXT.id:
case field_types.LONG_TEXT.id:
profile_field.value = field_value.value;
profile_field.rendered_value = field_value.rendered_value;
break;
case field_types.EXTERNAL_ACCOUNT.id:
profile_field.value = field_value.value;
profile_field.field_data = JSON.parse(field.field_data);
profile_field.subtype = profile_field.field_data.subtype;
profile_field.link = settings_profile_fields.get_external_account_link(profile_field);
break;
default:
profile_field.value = field_value.value;
}
return profile_field;
}
export function hide_user_profile() {
user_streams_list_widget = undefined;
overlays.close_modal_if_open("user-profile-modal");
}
function show_manage_user_tab(target) {
toggler.goto(target);
}
function initialize_user_type_fields(user) {
// Avoid duplicate pill fields, by removing existing ones.
$("#user-profile-modal .pill").remove();
if (!user.is_bot) {
settings_account.initialize_custom_user_type_fields(
"#user-profile-modal #content",
user.user_id,
false,
false,
);
} else {
initialize_bot_owner("#user-profile-modal #content", user.user_id);
}
}
export function show_user_profile(user, default_tab_key = "profile-tab") {
popovers.hide_all();
const field_types = page_params.custom_profile_field_types;
const profile_data = page_params.custom_profile_fields
.map((f) => get_custom_profile_field_data(user, f, field_types))
.filter((f) => f.name !== undefined);
const user_streams = stream_data.get_streams_for_user(user.user_id).subscribed;
// We only show the subscribe widget if the user is an admin, the user has opened their own profile,
// or if the user profile belongs to a bot whose owner has opened the user profile. However, we don't
// want to show the subscribe widget for generic bots since they are system bots and for deactivated users.
// Therefore, we also check for that condition.
const show_user_subscribe_widget =
(people.can_admin_user(user) || page_params.is_admin) &&
!user.is_system_bot &&
people.is_person_active(user.user_id);
const groups_of_user = user_groups.get_user_groups_of_user(user.user_id);
// We currently have the main UI for editing your own profile in
// settings, so can_manage_profile is artificially false for those.
const can_manage_profile =
(people.can_admin_user(user) || page_params.is_admin) &&
!user.is_system_bot &&
!people.is_my_user_id(user.user_id);
const args = {
user_id: user.user_id,
full_name: user.full_name,
email: user.delivery_email,
profile_data,
user_avatar: people.medium_avatar_url_for_person(user),
is_me: people.is_current_user(user.email),
is_bot: user.is_bot,
date_joined: timerender.get_localized_date_or_time_for_format(
parseISO(user.date_joined),
"dayofyear_year",
),
user_circle_class: buddy_data.get_user_circle_class(user.user_id),
last_seen: buddy_data.user_last_seen_time_status(user.user_id),
user_time: people.get_user_time(user.user_id),
user_type: people.get_user_type(user.user_id),
user_is_guest: user.is_guest,
show_user_subscribe_widget,
can_manage_profile,
};
if (user.is_bot) {
const is_system_bot = user.is_system_bot;
const bot_owner_id = user.bot_owner_id;
if (is_system_bot) {
args.is_system_bot = is_system_bot;
} else if (bot_owner_id) {
const bot_owner = people.get_by_user_id(bot_owner_id);
args.bot_owner = bot_owner;
}
args.bot_type = settings_bots.type_id_to_string(user.bot_type);
}
$("#user-profile-modal-holder").html(render_user_profile_modal(args));
overlays.open_modal("user-profile-modal", {autoremove: true});
$(".tabcontent").hide();
let default_tab = 0;
if (default_tab_key === "user-profile-streams-tab") {
default_tab = 1;
} else if (default_tab_key === "manage-profile-tab") {
default_tab = 3;
}
const opts = {
selected: default_tab,
child_wants_focus: true,
values: [
{label: $t({defaultMessage: "Profile"}), key: "profile-tab"},
{label: $t({defaultMessage: "Streams"}), key: "user-profile-streams-tab"},
{label: $t({defaultMessage: "User groups"}), key: "user-profile-groups-tab"},
],
callback(_name, key) {
$(".tabcontent").hide();
$(`#${CSS.escape(key)}`).show();
$("#user-profile-modal .modal__footer").hide();
$("#user-profile-modal .modal__body").removeClass("modal__body__manage_profile_height");
$("#user-profile-modal .manage-profile-tab-footer").removeClass(
"modal__footer_wrapper",
);
switch (key) {
case "profile-tab":
initialize_user_type_fields(user);
break;
case "user-profile-groups-tab":
render_user_group_list(groups_of_user, user);
break;
case "user-profile-streams-tab":
if (show_user_subscribe_widget) {
render_user_profile_subscribe_widget();
}
render_user_stream_list(user_streams, user);
break;
case "manage-profile-tab":
$("#user-profile-modal .modal__footer").show();
render_manage_profile_content(user);
break;
}
},
};
if (can_manage_profile) {
const manage_profile_label = user.is_bot
? $t({defaultMessage: "Manage bot"})
: $t({defaultMessage: "Manage user"});
const manage_profile_tab = {
label: manage_profile_label,
key: "manage-profile-tab",
};
opts.values.push(manage_profile_tab);
}
toggler = components.toggle(opts);
const $elem = toggler.get();
$elem.addClass("large allow-overflow");
$("#tab-toggle").append($elem);
if (show_user_subscribe_widget) {
reset_subscribe_widget();
}
}
function handle_remove_stream_subscription(target_user_id, sub, success, failure) {
if (people.is_my_user_id(target_user_id)) {
// Self unsubscribe.
channel.del({
url: "/json/users/me/subscriptions",
data: {subscriptions: JSON.stringify([sub.name])},
success,
error: failure,
});
} else {
subscriber_api.remove_user_id_from_stream(target_user_id, sub, success, failure);
}
}
export function register_click_handlers() {
$("body").on("click", ".info_popover_actions .view_full_user_profile", (e) => {
const user_id = popovers.elem_to_user_id($(e.target).parents("ul"));
const user = people.get_by_user_id(user_id);
show_user_profile(user);
e.stopPropagation();
e.preventDefault();
});
$("body").on("click", "#user-profile-modal .add-subscription-button", (e) => {
e.preventDefault();
const stream_id = Number.parseInt(user_profile_subscribe_widget.value(), 10);
const sub = sub_store.get(stream_id);
const target_user_id = Number.parseInt($("#user-profile-modal").attr("data-user-id"), 10);
const $alert_box = $("#user-profile-streams-tab .stream_list_info");
function addition_success(data) {
if (Object.keys(data.subscribed).length > 0) {
reset_subscribe_widget();
ui_report.success(
$t_html({defaultMessage: "Subscribed successfully!"}),
$alert_box,
1200,
);
} else {
ui_report.client_error(
$t_html({defaultMessage: "Already subscribed."}),
$alert_box,
1200,
);
}
}
function addition_failure(xhr) {
ui_report.error("", xhr, $alert_box, 1200);
}
subscriber_api.add_user_ids_to_stream(
[target_user_id],
sub,
addition_success,
addition_failure,
);
});
$("body").on("click", "#user-profile-modal .remove-subscription-button", (e) => {
e.preventDefault();
const $stream_row = $(e.currentTarget).closest("[data-stream-id]");
const stream_id = Number.parseInt($stream_row.attr("data-stream-id"), 10);
const sub = sub_store.get(stream_id);
const target_user_id = Number.parseInt($("#user-profile-modal").attr("data-user-id"), 10);
const $alert_box = $("#user-profile-streams-tab .stream_list_info");
function removal_success(data) {
if (data.removed.length > 0) {
ui_report.success(
$t_html({defaultMessage: "Unsubscribed successfully!"}),
$alert_box,
1200,
);
} else {
ui_report.client_error(
$t_html({defaultMessage: "Already not subscribed."}),
$alert_box,
1200,
);
}
}
function removal_failure() {
let error_message;
if (people.is_my_user_id(target_user_id)) {
error_message = $t(
{defaultMessage: "Error in unsubscribing from #{stream_name}"},
{stream_name: sub.name},
);
} else {
error_message = $t(
{defaultMessage: "Error removing user from #{stream_name}"},
{stream_name: sub.name},
);
}
ui_report.client_error(error_message, $alert_box, 1200);
}
if (sub.invite_only && people.is_my_user_id(target_user_id)) {
const new_hash = hash_util.stream_edit_url(sub);
hide_user_profile();
browser_history.go_to_location(new_hash);
return;
}
handle_remove_stream_subscription(target_user_id, sub, removal_success, removal_failure);
});
$("body").on("click", "#user-profile-modal #clear_stream_search", (e) => {
const $input = $("#user-profile-streams-tab .stream-search");
$input.val("");
// This is a hack to rerender complete
// stream list once the text is cleared.
$input.trigger("input");
e.stopPropagation();
e.preventDefault();
});
$("body").on(
"click",
"#user-profile-modal #name .user_profile_manage_others_edit_button",
(e) => {
show_manage_user_tab("manage-profile-tab");
e.stopPropagation();
e.preventDefault();
},
);
/* These click handlers are implemented as just deep links to the
* relevant part of the Zulip UI, so we don't want preventDefault,
* but we do want to close the modal when you click them. */
$("body").on("click", "#user-profile-modal #name .user_profile_manage_own_edit_button", () => {
hide_user_profile();
});
$("body").on("click", "#user-profile-modal .stream_list_item", () => {
hide_user_profile();
});
$("body").on("input", "#user-profile-streams-tab .stream-search", () => {
const $input = $("#user-profile-streams-tab .stream-search");
if ($input.val().trim().length > 0) {
$("#user-profile-streams-tab #clear_stream_search").show();
$input.css("margin-right", "-20px");
} else {
$("#user-profile-streams-tab #clear_stream_search").hide();
$input.css("margin-right", "0");
}
});
}