zulip/static/js/compose_fade.js

import _ from "lodash";

import {buddy_list} from "./buddy_list";
import * as compose_state from "./compose_state";
import * as floating_recipient_bar from "./floating_recipient_bar";
import * as message_viewport from "./message_viewport";
import * as people from "./people";
import * as rows from "./rows";
import * as stream_data from "./stream_data";
import * as util from "./util";

let focused_recipient;
let normal_display = false;

export function should_fade_message(message) {
    return !util.same_recipient(focused_recipient, message);
}

export function set_focused_recipient(msg_type) {
    if (msg_type === undefined) {
        focused_recipient = undefined;
    }

    // Construct focused_recipient as a mocked up element which has all the
    // fields of a message used by util.same_recipient()
    focused_recipient = {
        type: msg_type,
    };

    if (focused_recipient.type === "stream") {
        const stream_name = $("#stream_message_recipient_stream").val();
        focused_recipient.topic = $("#stream_message_recipient_topic").val();
        focused_recipient.stream = stream_name;
        const sub = stream_data.get_sub(stream_name);
        if (sub) {
            focused_recipient.stream_id = sub.stream_id;
        }
    } else {
        // Normalize the recipient list so it matches the one used when
        // adding the message (see message_store.add_message_metadata()).
        const reply_to = util.normalize_recipients(compose_state.private_message_recipient());
        focused_recipient.reply_to = reply_to;
        focused_recipient.to_user_ids = people.reply_to_to_user_ids_string(reply_to);
    }
}

function display_messages_normally() {
    const table = rows.get_table(current_msg_list.table_name);
    table.find(".recipient_row").removeClass("message-fade");

    normal_display = true;
    floating_recipient_bar.update();
}

function change_fade_state(elt, should_fade_group) {
    if (should_fade_group) {
        elt.addClass("message-fade");
    } else {
        elt.removeClass("message-fade");
    }
}

function fade_messages() {
    let i;
    let first_message;
    let first_row;
    let should_fade_group = false;
    const visible_groups = message_viewport.visible_groups(false);

    normal_display = false;

    // Update the visible messages first, before the compose box opens
    for (i = 0; i < visible_groups.length; i += 1) {
        first_row = rows.first_message_in_group(visible_groups[i]);
        first_message = current_msg_list.get(rows.id(first_row));
        should_fade_group = should_fade_message(first_message);

        change_fade_state($(visible_groups[i]), should_fade_group);
    }

    // Defer updating all message groups so that the compose box can open sooner
    setTimeout(
        (expected_msg_list, expected_recipient) => {
            const all_groups = rows.get_table(current_msg_list.table_name).find(".recipient_row");

            if (
                current_msg_list !== expected_msg_list ||
                !compose_state.composing() ||
                compose_state.private_message_recipient() !== expected_recipient
            ) {
                return;
            }

            should_fade_group = false;

            // Note: The below algorithm relies on the fact that all_elts is
            // sorted as it would be displayed in the message view
            for (i = 0; i < all_groups.length; i += 1) {
                const group_elt = $(all_groups[i]);
                should_fade_group = should_fade_message(rows.recipient_from_group(group_elt));
                change_fade_state(group_elt, should_fade_group);
            }

            floating_recipient_bar.update();
        },
        0,
        current_msg_list,
        compose_state.private_message_recipient(),
    );
}

export function would_receive_message(user_id) {
    if (focused_recipient.type === "stream") {
        const sub = stream_data.get_sub_by_id(focused_recipient.stream_id);
        if (!sub) {
            // If the stream isn't valid, there is no risk of a mix
            // yet, so we sort of "lie" and say they would receive a
            // message.
            return true;
        }

        return stream_data.is_user_subscribed(focused_recipient.stream_id, user_id);
    }

    // PM, so check if the given email is in the recipients list.
    return util.is_pm_recipient(user_id, focused_recipient);
}

const user_fade_config = {
    get_user_id(li) {
        return buddy_list.get_key_from_li({li});
    },
    fade(li) {
        return li.addClass("user-fade");
    },
    unfade(li) {
        return li.removeClass("user-fade");
    },
};

function update_user_row_when_fading(li, conf) {
    const user_id = conf.get_user_id(li);
    const would_receive = would_receive_message(user_id);

    if (would_receive || people.is_my_user_id(user_id)) {
        conf.unfade(li);
    } else {
        conf.fade(li);
    }
}

function display_users_normally(items, conf) {
    for (const li of items) {
        conf.unfade(li);
    }
}

function fade_users(items, conf) {
    for (const li of items) {
        update_user_row_when_fading(li, conf);
    }
}

function want_normal_display() {
    // If we're not composing show a normal display.
    if (focused_recipient === undefined) {
        return true;
    }

    // If the user really hasn't specified anything let, then we want a normal display
    if (focused_recipient.type === "stream") {
        // If a stream doesn't exist, there is no real chance of a mix, so fading
        // is just noise to the user.
        if (!stream_data.get_sub_by_id(focused_recipient.stream_id)) {
            return true;
        }

        // This is kind of debatable.  If the topic is empty, it could be that
        // the user simply hasn't started typing it yet, but disabling fading here
        // means the feature doesn't help realms where topics aren't mandatory
        // (which is most realms as of this writing).
        if (focused_recipient.topic === "") {
            return true;
        }
    }

    return focused_recipient.type === "private" && focused_recipient.reply_to === "";
}

function do_update_all() {
    const user_items = buddy_list.get_items();

    if (want_normal_display()) {
        if (!normal_display) {
            display_messages_normally();
            display_users_normally(user_items, user_fade_config);
        }
    } else {
        fade_messages();
        fade_users(user_items, user_fade_config);
    }
}

// This one only updates the users, not both, like update_faded_messages.
// This is for when new presence information comes in, redrawing the presence
// list.
export function update_faded_users() {
    const user_items = buddy_list.get_items();

    update_user_info(user_items, user_fade_config);
}

export function update_user_info(items, conf) {
    if (want_normal_display()) {
        display_users_normally(items, conf);
    } else {
        fade_users(items, conf);
    }
}

// This gets called on keyup events, hence the throttling.
export const update_all = _.debounce(do_update_all, 50);

export function start_compose(msg_type) {
    set_focused_recipient(msg_type);
    do_update_all();
}

export function clear_compose() {
    focused_recipient = undefined;
    display_messages_normally();
    update_faded_users();
}

export function update_message_list() {
    if (want_normal_display()) {
        display_messages_normally();
    } else {
        fade_messages();
    }
}

export function update_rendered_message_groups(message_groups, get_element) {
    if (want_normal_display()) {
        return;
    }

    // This loop is superficially similar to some code in fade_messages, but an
    // important difference here is that we look at each message individually, whereas
    // the other code takes advantage of blocks beneath recipient bars.
    for (const message_group of message_groups) {
        const elt = get_element(message_group);
        const first_message = message_group.message_containers[0].msg;
        const should_fade = should_fade_message(first_message);
        change_fade_state(elt, should_fade);
    }
}