zulip/static/js/stream_list.js

638 lines
18 KiB
JavaScript

var stream_list = (function () {
var exports = {};
exports.update_count_in_dom = function (unread_count_elem, count) {
var count_span = unread_count_elem.find('.count');
var value_span = count_span.find('.value');
if (count === 0) {
count_span.hide();
if (count_span.parent().hasClass("subscription_block")) {
count_span.parent(".subscription_block").removeClass("stream-with-count");
}
value_span.text('');
return;
}
count_span.show();
if (count_span.parent().hasClass("subscription_block")) {
count_span.parent(".subscription_block").addClass("stream-with-count");
}
value_span.text(count);
};
exports.stream_sidebar = (function () {
var self = {};
self.rows = new Dict(); // stream id -> row widget
self.set_row = function (stream_id, widget) {
self.rows.set(stream_id, widget);
};
self.get_row = function (stream_id) {
return self.rows.get(stream_id);
};
self.has_row_for = function (stream_id) {
return self.rows.has(stream_id);
};
self.remove_row = function (stream_id) {
// This only removes the row from our data structure.
// Our caller should use build_stream_list() to re-draw
// the sidebar, so that we don't have to deal with edge
// cases like removing the last pinned stream (and removing
// the divider).
self.rows.del(stream_id);
};
return self;
}());
function get_search_term() {
var search_box = $(".stream-list-filter");
var search_term = search_box.expectOne().val().trim();
return search_term;
}
exports.remove_sidebar_row = function (stream_id) {
exports.stream_sidebar.remove_row(stream_id);
exports.build_stream_list();
exports.stream_cursor.redraw();
};
exports.create_initial_sidebar_rows = function () {
// This code is slightly opaque, but it ends up building
// up list items and attaching them to the "sub" data
// structures that are kept in stream_data.js.
var subs = stream_data.subscribed_subs();
_.each(subs, function (sub) {
exports.create_sidebar_row(sub);
});
};
exports.build_stream_list = function () {
// This function assumes we have already created the individual
// sidebar rows. Our job here is to build the bigger widget,
// which largely is a matter of arranging the individual rows in
// the right order.
var streams = stream_data.subscribed_streams();
if (streams.length === 0) {
return;
}
// The main logic to build the list is in stream_sort.js, and
// we get three lists of streams (pinned/normal/dormant).
var stream_groups = stream_sort.sort_groups(get_search_term());
if (stream_groups.same_as_before) {
return;
}
var parent = $('#stream_filters');
var elems = [];
function add_sidebar_li(stream) {
var sub = stream_data.get_sub(stream);
var sidebar_row = exports.stream_sidebar.get_row(sub.stream_id);
sidebar_row.update_whether_active();
elems.push(sidebar_row.get_li());
}
parent.empty();
_.each(stream_groups.pinned_streams, add_sidebar_li);
var any_pinned_streams = stream_groups.pinned_streams.length > 0;
var any_normal_streams = stream_groups.normal_streams.length > 0;
var any_dormant_streams = stream_groups.dormant_streams.length > 0;
if (any_pinned_streams && (any_normal_streams || any_dormant_streams)) {
elems.push('<hr class="stream-split">');
}
_.each(stream_groups.normal_streams, add_sidebar_li);
if (any_dormant_streams && any_normal_streams) {
elems.push('<hr class="stream-split">');
}
_.each(stream_groups.dormant_streams, add_sidebar_li);
parent.append(elems);
};
exports.get_stream_li = function (stream_id) {
var row = exports.stream_sidebar.get_row(stream_id);
if (!row) {
// Not all streams are in the sidebar, so we don't report
// an error here, and it's up for the caller to error if
// they expected otherwise.
return;
}
var li = row.get_li();
if (!li) {
blueslip.error('Cannot find li for id ' + stream_id);
return;
}
if (li.length > 1) {
blueslip.error('stream_li has too many elements for ' + stream_id);
return;
}
return li;
};
function zoom_in(options) {
popovers.hide_all();
topic_list.zoom_in();
$("#streams_list").expectOne().removeClass("zoom-out").addClass("zoom-in");
// Hide stream list titles and pinned stream splitter
$(".stream-filters-label").each(function () {
$(this).hide();
});
$(".stream-split").each(function () {
$(this).hide();
});
$("#stream_filters li.narrow-filter").each(function () {
var elt = $(this);
var stream_id = options.stream_id.toString();
if (elt.attr('data-stream-id') === stream_id) {
elt.show();
} else {
elt.hide();
}
});
}
function zoom_out(options) {
popovers.hide_all();
topic_list.zoom_out();
if (options.stream_li) {
exports.scroll_stream_into_view(options.stream_li);
}
exports.show_all_streams();
}
exports.show_all_streams = function () {
// Show stream list titles and pinned stream splitter
$(".stream-filters-label").each(function () {
$(this).show();
});
$(".stream-split").each(function () {
$(this).show();
});
$("#streams_list").expectOne().removeClass("zoom-in").addClass("zoom-out");
$("#stream_filters li.narrow-filter").show();
};
exports.set_in_home_view = function (stream_id, in_home) {
var li = exports.get_stream_li(stream_id);
if (!li) {
blueslip.error('passed in bad stream id ' + stream_id);
return;
}
if (in_home) {
li.removeClass("out_of_home_view");
} else {
li.addClass("out_of_home_view");
}
};
function build_stream_sidebar_li(sub) {
var name = sub.name;
var args = {name: name,
id: sub.stream_id,
uri: narrow.by_stream_uri(name),
not_in_home_view: (stream_data.in_home_view(sub.stream_id) === false),
invite_only: sub.invite_only,
color: stream_data.get_color(name),
pin_to_top: sub.pin_to_top,
};
args.dark_background = stream_color.get_color_class(args.color);
var list_item = $(templates.render('stream_sidebar_row', args));
return list_item;
}
function build_stream_sidebar_row(sub) {
var self = {};
var list_item = build_stream_sidebar_li(sub);
self.update_whether_active = function () {
if (stream_data.is_active(sub)) {
list_item.removeClass('inactive_stream');
} else {
list_item.addClass('inactive_stream');
}
};
self.get_li = function () {
return list_item;
};
self.remove = function () {
list_item.remove();
};
self.update_unread_count = function () {
var count = unread.num_unread_for_stream(sub.stream_id);
exports.update_count_in_dom(list_item, count);
};
self.update_unread_count();
exports.stream_sidebar.set_row(sub.stream_id, self);
}
exports.create_sidebar_row = function (sub) {
if (exports.stream_sidebar.has_row_for(sub.stream_id)) {
// already exists
blueslip.warn('Dup try to build sidebar row for stream ' + sub.stream_id);
return;
}
build_stream_sidebar_row(sub);
};
exports.redraw_stream_privacy = function (sub) {
var li = exports.get_stream_li(sub.stream_id);
if (!li) {
// We don't want to raise error here, if we can't find stream in subscription
// stream list. Cause we allow org admin to update stream privacy
// even if they don't subscribe to public stream.
return;
}
var div = li.find('.stream-privacy');
var dark_background = stream_color.get_color_class(sub.color);
var args = {
invite_only: sub.invite_only,
dark_background: dark_background,
};
var html = templates.render('stream_privacy', args);
div.html(html);
};
function set_stream_unread_count(stream_id, count) {
var unread_count_elem = exports.get_stream_li(stream_id);
if (!unread_count_elem) {
// This can happen for legitimate reasons, but we warn
// just in case.
blueslip.warn('stream id no longer in sidebar: ' + stream_id);
return;
}
exports.update_count_in_dom(unread_count_elem, count);
}
exports.update_streams_sidebar = function () {
exports.build_stream_list();
exports.stream_cursor.redraw();
if (! narrow_state.active()) {
return;
}
var filter = narrow_state.filter();
exports.update_stream_sidebar_for_narrow(filter);
};
exports.update_dom_with_unread_counts = function (counts) {
// counts.stream_count maps streams to counts
counts.stream_count.each(function (count, stream_id) {
set_stream_unread_count(stream_id, count);
});
// counts.topic_count maps streams to hashes of topics to counts
counts.topic_count.each(function (subject_hash, stream_id) {
subject_hash.each(function (count, subject) {
topic_list.set_count(stream_id, subject, count);
});
});
};
exports.rename_stream = function (sub) {
// The sub object is expected to already have the updated name
build_stream_sidebar_row(sub);
exports.update_streams_sidebar(); // big hammer
};
exports.refresh_pinned_or_unpinned_stream = function (sub) {
// Pinned/unpinned streams require re-ordering.
// We use kind of brute force now, which is probably fine.
build_stream_sidebar_row(sub);
exports.update_streams_sidebar();
// Only scroll pinned topics into view. If we're unpinning
// a topic, we may be literally trying to get it out of
// our sight.
if (sub.pin_to_top) {
var stream_li = exports.get_stream_li(sub.stream_id);
if (!stream_li) {
blueslip.error('passed in bad stream id ' + sub.stream_id);
return;
}
exports.scroll_stream_into_view(stream_li);
}
};
function clear_topics() {
topic_list.close();
exports.show_all_streams();
}
exports.get_sidebar_stream_topic_info = function (filter) {
var result = {
stream_id: undefined,
topic_selected: false,
};
var op_stream = filter.operands('stream');
if (op_stream.length === 0) {
return result;
}
var stream_name = op_stream[0];
var stream_id = stream_data.get_stream_id(stream_name);
if (!stream_id) {
return result;
}
if (!stream_data.id_is_subscribed(stream_id)) {
return result;
}
result.stream_id = stream_id;
var op_subject = filter.operands('topic');
result.topic_selected = (op_subject.length === 1);
return result;
};
function deselect_stream_items() {
$("ul#stream_filters li").removeClass('active-filter active-sub-filter');
}
exports.update_stream_sidebar_for_narrow = function (filter) {
var info = exports.get_sidebar_stream_topic_info(filter);
deselect_stream_items();
var stream_id = info.stream_id;
if (!stream_id) {
clear_topics();
return;
}
var stream_li = exports.get_stream_li(stream_id);
if (!stream_li) {
// It should be the case then when we have a subscribed
// stream, there will always be a stream list item
// corresponding to that stream in our sidebar. We have
// evidence that this assumption breaks down for some users,
// but we are not clear why it happens.
blueslip.error('No stream_li for subscribed stream ' + stream_id);
clear_topics();
return;
}
if (!info.topic_selected) {
stream_li.addClass('active-filter');
}
if (stream_id !== topic_list.active_stream_id()) {
clear_topics();
}
topic_list.rebuild(stream_li, stream_id);
return stream_li;
};
exports.handle_narrow_activated = function (filter) {
var stream_li = exports.update_stream_sidebar_for_narrow(filter);
if (stream_li) {
exports.scroll_stream_into_view(stream_li);
}
// Update scrollbar size.
ui.update_scrollbar($("#stream-filters-container"));
};
exports.handle_narrow_deactivated = function () {
deselect_stream_items();
clear_topics();
};
function focus_stream_filter(e) {
exports.stream_cursor.reset();
e.stopPropagation();
}
function keydown_enter_key() {
var stream_id = exports.stream_cursor.get_key();
if (stream_id === undefined) {
// This can happen for empty searches, no need to warn.
return;
}
var sub = stream_data.get_sub_by_id(stream_id);
if (sub === undefined) {
blueslip.error('Unknown stream_id for search/enter: ' + stream_id);
return;
}
if (overlays.is_active()) {
ui_util.change_tab_to('#home');
}
exports.clear_and_hide_search();
narrow.by('stream', sub.name, {trigger: 'sidebar enter key'});
}
function actually_update_streams_for_search() {
exports.update_streams_sidebar();
resize.resize_page_components();
exports.stream_cursor.reset();
}
var update_streams_for_search = _.throttle(actually_update_streams_for_search, 50);
exports.initialize = function () {
// TODO, Eventually topic_list won't be a big singleton,
// and we can create more component-based click handlers for
// each stream.
topic_list.set_click_handlers({
zoom_in: zoom_in,
zoom_out: zoom_out,
});
$(document).on('subscription_add_done.zulip', function (event) {
exports.create_sidebar_row(event.sub);
exports.build_stream_list();
exports.stream_cursor.redraw();
});
$(document).on('subscription_remove_done.zulip', function (event) {
exports.remove_sidebar_row(event.sub.stream_id);
});
$('#stream_filters').on('click', 'li .subscription_block', function (e) {
if (e.metaKey || e.ctrlKey) {
return;
}
if (overlays.is_active()) {
ui_util.change_tab_to('#home');
}
var stream_id = $(e.target).parents('li').attr('data-stream-id');
var sub = stream_data.get_sub_by_id(stream_id);
popovers.hide_all();
narrow.by('stream', sub.name, {trigger: 'sidebar'});
exports.clear_and_hide_search();
e.preventDefault();
e.stopPropagation();
});
$('#clear_search_stream_button').on('click', exports.clear_search);
$("#streams_header").expectOne().click(function (e) {
exports.toggle_filter_displayed(e);
});
exports.stream_cursor = list_cursor({
list: {
container: $('#stream-filters-container'),
find_li: function (opts) {
var stream_id = opts.key;
var li = exports.get_stream_li(stream_id);
return li;
},
first_key: stream_sort.first_stream_id,
prev_key: stream_sort.prev_stream_id,
next_key: stream_sort.next_stream_id,
},
highlight_class: 'highlighted_stream',
});
var $search_input = $('.stream-list-filter').expectOne();
keydown_util.handle({
elem: $search_input,
handlers: {
enter_key: function () {
keydown_enter_key();
return true;
},
up_arrow: function () {
exports.stream_cursor.prev();
return true;
},
down_arrow: function () {
exports.stream_cursor.next();
return true;
},
},
});
$search_input.on('click', focus_stream_filter);
$search_input.on('focusout', exports.stream_cursor.clear);
$search_input.on('input', update_streams_for_search);
};
exports.searching = function () {
return $('.stream-list-filter').expectOne().is(':focus');
};
exports.escape_search = function () {
var filter = $('.stream-list-filter').expectOne();
if (filter.val() === '') {
exports.clear_and_hide_search();
return;
}
filter.val('');
update_streams_for_search();
};
exports.clear_search = function () {
var filter = $('.stream-list-filter').expectOne();
if (filter.val() === '') {
exports.clear_and_hide_search();
return;
}
filter.val('');
filter.blur();
update_streams_for_search();
};
exports.initiate_search = function () {
var filter = $('.stream-list-filter').expectOne();
filter.parent().removeClass('notdisplayed');
if (!$(".app-main .column-left").hasClass("expanded")) {
popovers.hide_all();
stream_popover.show_streamlist_sidebar();
}
filter.focus();
exports.stream_cursor.reset();
};
exports.clear_and_hide_search = function () {
var filter = $('.stream-list-filter');
if (filter.val() !== '') {
filter.val('');
update_streams_for_search();
}
exports.stream_cursor.clear();
filter.blur();
filter.parent().addClass('notdisplayed');
};
exports.toggle_filter_displayed = function (e) {
if ($('#stream-filters-container .input-append.notdisplayed').length === 0) {
exports.clear_and_hide_search();
} else {
exports.initiate_search();
}
e.preventDefault();
};
exports.scroll_stream_into_view = function (stream_li) {
var container = $('#stream-filters-container');
if (stream_li.length !== 1) {
blueslip.error('Invalid stream_li was passed in');
return;
}
scroll_util.scroll_element_into_container(stream_li, container);
};
return exports;
}());
if (typeof module !== 'undefined') {
module.exports = stream_list;
}