zulip/static/js/muting_ui.js

var muting_ui = (function () {

var exports = {};

function timestamp_ms() {
    return (new Date()).getTime();
}

var last_topic_update = 0;

exports.rerender = function () {
    // Note: We tend to optimistically rerender muting preferences before
    // the back end actually acknowledges the mute.  This gives a more
    // immediate feel to the user, and if the back end fails temporarily,
    // re-doing a mute or unmute is a pretty recoverable thing.

    stream_list.update_streams_sidebar();
    if (current_msg_list.muting_enabled) {
        current_msg_list.update_muting_and_rerender();
    }
    if (current_msg_list !== home_msg_list) {
        home_msg_list.update_muting_and_rerender();
    }
};

exports.notify_with_undo_option = (function () {
    var meta = {
        stream: null,
        topic: null,
        hide_me_time: null,
        alert_hover_state: false,
        $mute: null,
    };
    var animate = {
        fadeOut: function () {
            if (meta.$mute) {
                meta.$mute.fadeOut(500).removeClass("show");
            }
        },
        fadeIn: function () {
            if (meta.$mute) {
                meta.$mute.fadeIn(500).addClass("show");
            }
        },
    };
    setInterval(function () {
        if (meta.hide_me_time < new Date().getTime() && !meta.alert_hover_state) {
            animate.fadeOut();
        }
    }, 100);

    return function (stream, topic) {
        var $exit = $("#unmute_muted_topic_notification .exit-me");

        if (!meta.$mute) {
            meta.$mute = $("#unmute_muted_topic_notification");

            $exit.click(function () {
                animate.fadeOut();
            });

            meta.$mute.find("#unmute").click(function () {
                // it should reference the meta variable and not get stuck with
                // a pass-by-value of stream, topic.
                exports.unmute(meta.stream, meta.topic);
                animate.fadeOut();
            });
        }

        meta.stream = stream;
        meta.topic = topic;
        // add a four second delay before closing up.
        meta.hide_me_time = new Date().getTime() + 4000;

        meta.$mute.find(".topic").text(topic);
        meta.$mute.find(".stream").text(stream);

        animate.fadeIn();

        // if the user mouses over the notification, don't hide it.
        meta.$mute.mouseenter(function () {
            meta.alert_hover_state = true;
        });

        // once the user's mouse leaves the notification, restart the countdown.
        meta.$mute.mouseleave(function () {
            meta.alert_hover_state = false;
            // add at least 2000ms but if more than that exists just keep the
            // current amount.
            meta.hide_me_time = Math.max(meta.hide_me_time, new Date().getTime() + 2000);
        });
    };
}());

exports.dismiss_mute_confirmation = function () {
    var $mute = $("#unmute_muted_topic_notification");
    if ($mute) {
        $mute.fadeOut(500).removeClass("show");
    }
};

exports.persist_mute = function (stream_id, topic_name) {
    var stream_name = stream_data.maybe_get_stream_name(stream_id);

    if (!stream_name) {
        blueslip.error('Trying to mute bogus stream id: ' + stream_id);
        return;
    }

    var data = {
        stream: stream_name,
        topic: topic_name,
        op: 'add',
    };
    last_topic_update = timestamp_ms();
    channel.patch({
        url: '/json/users/me/subscriptions/muted_topics',
        idempotent: true,
        data: data,
    });
};

exports.persist_unmute = function (stream_id, topic_name) {
    var stream_name = stream_data.maybe_get_stream_name(stream_id);

    if (!stream_name) {
        blueslip.error('Trying to unmute bogus stream id: ' + stream_id);
        return;
    }

    var data = {
        stream: stream_name,
        topic: topic_name,
        op: 'remove',
    };
    last_topic_update = timestamp_ms();
    channel.patch({
        url: '/json/users/me/subscriptions/muted_topics',
        idempotent: true,
        data: data,
    });
};

exports.handle_updates = function (muted_topics) {
    if (timestamp_ms() < last_topic_update + 1000) {
        // This topic update is either the one that we just rendered, or,
        // much less likely, it's coming from another device and would probably
        // be overwriting this device's preferences with stale data.
        return;
    }

    exports.update_muted_topics(muted_topics);
    exports.rerender();
};

exports.update_muted_topics = function (muted_topics) {
    muting.set_muted_topics(muted_topics);
    unread_ui.update_unread_counts();
};

exports.set_up_muted_topics_ui = function (muted_topics) {
    var muted_topics_table = $("#muted_topics_table tbody");
    muted_topics_table.empty();
    _.each(muted_topics, function (list) {
        var row = templates.render('muted_topic_ui_row', {stream: list[0], topic: list[1]});
        muted_topics_table.append(row);
    });
};

exports.mute = function (stream, topic) {
    // TODO: have callers pass in stream_id
    var stream_id = stream_data.get_stream_id(stream);

    if (!stream_id) {
        return;
    }

    stream_popover.hide_topic_popover();
    muting.add_muted_topic(stream_id, topic);
    unread_ui.update_unread_counts();
    exports.rerender();
    exports.persist_mute(stream_id, topic);
    exports.notify_with_undo_option(stream, topic);
    exports.set_up_muted_topics_ui(muting.get_muted_topics());
};

exports.unmute = function (stream, topic) {
    // TODO: have callers pass in stream_id
    var stream_id = stream_data.get_stream_id(stream);

    if (!stream_id) {
        return;
    }

    // we don't run a unmute_notify function because it isn't an issue as much
    // if someone accidentally unmutes a stream rather than if they mute it
    // and miss out on info.
    stream_popover.hide_topic_popover();
    muting.remove_muted_topic(stream_id, topic);
    unread_ui.update_unread_counts();
    exports.rerender();
    exports.persist_unmute(stream_id, topic);
    exports.set_up_muted_topics_ui(muting.get_muted_topics());
    exports.dismiss_mute_confirmation();
};

exports.toggle_mute = function (msg) {
    if (muting.is_topic_muted(msg.stream_id, msg.subject)) {
        exports.unmute(msg.stream, msg.subject);
    } else if (msg.type === 'stream') {
        exports.mute(msg.stream, msg.subject);
    }
};

exports.initialize = function () {
    exports.update_muted_topics(page_params.muted_topics);
};

return exports;
}());

if (typeof module !== 'undefined') {
    module.exports = muting_ui;
}
window.muting_ui = muting_ui;