const util = require("./util"); let jwindow; const dimensions = {}; let in_stoppable_autoscroll = false; // Includes both scroll and arrow events. Negative means scroll up, // positive means scroll down. exports.last_movement_direction = 1; exports.set_last_movement_direction = function (value) { exports.last_movement_direction = value; }; exports.at_top = function () { return exports.scrollTop() <= 0; }; exports.message_viewport_info = function () { // Return a structure that tells us details of the viewport // accounting for fixed elements like the top navbar. // // The message_header is NOT considered to be part of the visible // message pane, which should make sense for callers, who will // generally be concerned about whether actual message content is // visible. const res = {}; const element_just_above_us = $(".floating_recipient"); const element_just_below_us = $("#compose"); res.visible_top = element_just_above_us.offset().top + element_just_above_us.safeOuterHeight(); res.visible_bottom = element_just_below_us.position().top; res.visible_height = res.visible_bottom - res.visible_top; return res; }; exports.at_bottom = function () { const bottom = exports.scrollTop() + exports.height(); const full_height = exports.message_pane.prop("scrollHeight"); // We only know within a pixel or two if we're // exactly at the bottom, due to browser quirkiness, // and we err on the side of saying that we are at // the bottom. return bottom + 2 >= full_height; }; // This differs from at_bottom in that it only requires the bottom message to // be visible, but you may be able to scroll down further. exports.bottom_message_visible = function () { const last_row = rows.last_visible(); if (last_row.length) { const message_bottom = last_row[0].getBoundingClientRect().bottom; const bottom_of_feed = $("#compose")[0].getBoundingClientRect().top; return bottom_of_feed > message_bottom; } return false; }; exports.is_below_visible_bottom = function (offset) { return offset > exports.scrollTop() + exports.height() - $("#compose").height(); }; exports.is_scrolled_up = function () { // Let's determine whether the user was already dealing // with messages off the screen, which can guide auto // scrolling decisions. const last_row = rows.last_visible(); if (last_row.length === 0) { return false; } const offset = exports.offset_from_bottom(last_row); return offset > 0; }; exports.offset_from_bottom = function (last_row) { // A positive return value here means the last row is // below the bottom of the feed (i.e. obscured by the compose // box or even further below the bottom). const message_bottom = last_row.offset().top + last_row.height(); const info = exports.message_viewport_info(); return message_bottom - info.visible_bottom; }; exports.set_message_position = function (message_top, message_height, viewport_info, ratio) { // message_top = offset of the top of a message that you are positioning // message_height = height of the message that you are positioning // viewport_info = result of calling message_viewport.message_viewport_info // ratio = fraction indicating how far down the screen the msg should be let how_far_down_in_visible_page = viewport_info.visible_height * ratio; // special case: keep large messages fully on the screen if (how_far_down_in_visible_page + message_height > viewport_info.visible_height) { how_far_down_in_visible_page = viewport_info.visible_height - message_height; // Next handle truly gigantic messages. We just say that the top of the // message goes to the top of the viewing area. Realistically, gigantic // messages should either be condensed, socially frowned upon, or scrolled // with the mouse. if (how_far_down_in_visible_page < 0) { how_far_down_in_visible_page = 0; } } const hidden_top = viewport_info.visible_top - exports.scrollTop(); const message_offset = how_far_down_in_visible_page + hidden_top; const new_scroll_top = message_top - message_offset; message_scroll.suppress_selection_update_on_next_scroll(); exports.scrollTop(new_scroll_top); }; function in_viewport_or_tall(rect, top_of_feed, bottom_of_feed, require_fully_visible) { if (require_fully_visible) { return ( rect.top > top_of_feed && // Message top is in view and (rect.bottom < bottom_of_feed || // message is fully in view or (rect.height > bottom_of_feed - top_of_feed && rect.top < bottom_of_feed)) ); // message is tall. } return rect.bottom > top_of_feed && rect.top < bottom_of_feed; } function add_to_visible( candidates, visible, top_of_feed, bottom_of_feed, require_fully_visible, row_to_id, ) { for (const row of candidates) { const row_rect = row.getBoundingClientRect(); // Mark very tall messages as read once we've gotten past them if (in_viewport_or_tall(row_rect, top_of_feed, bottom_of_feed, require_fully_visible)) { visible.push(row_to_id(row)); } else { break; } } } const top_of_feed = new util.CachedValue({ compute_value: function () { return $(".floating_recipient").offset().top + $(".floating_recipient").safeOuterHeight(); }, }); const bottom_of_feed = new util.CachedValue({ compute_value: function () { return $("#compose")[0].getBoundingClientRect().top; }, }); function _visible_divs( selected_row, row_min_height, row_to_output, div_class, require_fully_visible, ) { // Note that when using getBoundingClientRect() we are getting offsets // relative to the visible window, but when using jQuery's offset() we are // getting offsets relative to the full scrollable window. You can't try to // compare heights from these two methods. const height = bottom_of_feed.get() - top_of_feed.get(); const num_neighbors = Math.floor(height / row_min_height); // We do this explicitly without merges and without recalculating // the feed bounds to keep this computation as cheap as possible. const visible = []; const above_pointer = selected_row.prevAll("div." + div_class).slice(0, num_neighbors); const below_pointer = selected_row.nextAll("div." + div_class).slice(0, num_neighbors); add_to_visible( selected_row, visible, top_of_feed.get(), bottom_of_feed.get(), require_fully_visible, row_to_output, ); add_to_visible( above_pointer, visible, top_of_feed.get(), bottom_of_feed.get(), require_fully_visible, row_to_output, ); add_to_visible( below_pointer, visible, top_of_feed.get(), bottom_of_feed.get(), require_fully_visible, row_to_output, ); return visible; } exports.visible_groups = function (require_fully_visible) { const selected_row = current_msg_list.selected_row(); if (selected_row === undefined || selected_row.length === 0) { return []; } const selected_group = rows.get_message_recipient_row(selected_row); function get_row(row) { return row; } // Being simplistic about this, the smallest group is about 75 px high. return _visible_divs(selected_group, 75, get_row, "recipient_row", require_fully_visible); }; exports.visible_messages = function (require_fully_visible) { const selected_row = current_msg_list.selected_row(); function row_to_id(row) { return current_msg_list.get(rows.id($(row))); } // Being simplistic about this, the smallest message is 25 px high. return _visible_divs(selected_row, 25, row_to_id, "message_row", require_fully_visible); }; exports.scrollTop = function viewport_scrollTop(target_scrollTop) { const orig_scrollTop = exports.message_pane.scrollTop(); if (target_scrollTop === undefined) { return orig_scrollTop; } let ret = exports.message_pane.scrollTop(target_scrollTop); const new_scrollTop = exports.message_pane.scrollTop(); const space_to_scroll = $("#bottom_whitespace").offset().top - exports.height(); // Check whether our scrollTop didn't move even though one could have scrolled down if ( space_to_scroll > 0 && target_scrollTop > 0 && orig_scrollTop === 0 && new_scrollTop === 0 ) { // Chrome has a bug where sometimes calling // window.scrollTop(x) has no effect, resulting in the browser // staying at 0 -- and afterwards if you call // window.scrollTop(x) again, it will still do nothing. To // fix this, we need to first scroll to some other place. blueslip.info( "ScrollTop did nothing when scrolling to " + target_scrollTop + ", fixing...", ); // First scroll to 1 in order to clear the stuck state exports.message_pane.scrollTop(1); // And then scroll where we intended to scroll to ret = exports.message_pane.scrollTop(target_scrollTop); if (exports.message_pane.scrollTop() === 0) { blueslip.info( "ScrollTop fix did not work when scrolling to " + target_scrollTop + "! space_to_scroll was " + space_to_scroll, ); } } return ret; }; function make_dimen_wrapper(dimen_name, dimen_func) { dimensions[dimen_name] = new util.CachedValue({ compute_value: function () { return dimen_func.call(exports.message_pane); }, }); return function viewport_dimension_wrapper(...args) { if (args.length !== 0) { dimensions[dimen_name].reset(); return dimen_func.apply(exports.message_pane, args); } return dimensions[dimen_name].get(); }; } exports.height = make_dimen_wrapper("height", $(exports.message_pane).height); exports.width = make_dimen_wrapper("width", $(exports.message_pane).width); exports.stop_auto_scrolling = function () { if (in_stoppable_autoscroll) { exports.message_pane.stop(); } }; exports.is_narrow = function () { // This basically returns true when we hide the right sidebar for // the left_side_userlist skinny mode. It would be nice to have a less brittle // test for this. See the "@media (max-width: 1165px)" section in // media.scss. return window.innerWidth <= 1165; }; exports.system_initiated_animate_scroll = function (scroll_amount) { message_scroll.suppress_selection_update_on_next_scroll(); const viewport_offset = exports.scrollTop(); in_stoppable_autoscroll = true; exports.message_pane.animate({ scrollTop: viewport_offset + scroll_amount, always: function () { in_stoppable_autoscroll = false; }, }); }; exports.user_initiated_animate_scroll = function (scroll_amount) { message_scroll.suppress_selection_update_on_next_scroll(); in_stoppable_autoscroll = false; // defensive const viewport_offset = exports.scrollTop(); exports.message_pane.animate({ scrollTop: viewport_offset + scroll_amount, }); }; exports.recenter_view = function (message, opts) { opts = opts || {}; // Barnowl-style recentering: if the pointer is too high, move it to // the 1/2 marks. If the pointer is too low, move it to the 1/7 mark. // See keep_pointer_in_view() for related logic to keep the pointer onscreen. const viewport_info = exports.message_viewport_info(); const top_threshold = viewport_info.visible_top; const bottom_threshold = viewport_info.visible_bottom; const message_top = message.offset().top; const message_height = message.safeOuterHeight(true); const message_bottom = message_top + message_height; const is_above = message_top < top_threshold; const is_below = message_bottom > bottom_threshold; if (opts.from_scroll) { // If the message you're trying to center on is already in view AND // you're already trying to move in the direction of that message, // don't try to recenter. This avoids disorienting jumps when the // pointer has gotten itself outside the threshold (e.g. by // autoscrolling). if (is_above && exports.last_movement_direction >= 0) { return; } if (is_below && exports.last_movement_direction <= 0) { return; } } if (is_above || opts.force_center) { exports.set_message_position(message_top, message_height, viewport_info, 1 / 2); } else if (is_below) { exports.set_message_position(message_top, message_height, viewport_info, 1 / 7); } }; exports.keep_pointer_in_view = function () { // See message_viewport.recenter_view() for related logic to keep the pointer onscreen. // This function mostly comes into place for mouse scrollers, and it // keeps the pointer in view. For people who purely scroll with the // mouse, the pointer is kind of meaningless to them, but keyboard // users will occasionally do big mouse scrolls, so this gives them // a pointer reasonably close to the middle of the screen. let candidate; let next_row = current_msg_list.selected_row(); if (next_row.length === 0) { return; } const info = exports.message_viewport_info(); const top_threshold = info.visible_top + (1 / 10) * info.visible_height; const bottom_threshold = info.visible_top + (9 / 10) * info.visible_height; function message_is_far_enough_down() { if (exports.at_top()) { return true; } const message_top = next_row.offset().top; // If the message starts after the very top of the screen, we just // leave it alone. This avoids bugs like #1608, where overzealousness // about repositioning the pointer can cause users to miss messages. if (message_top >= info.visible_top) { return true; } // If at least part of the message is below top_threshold (10% from // the top), then we also leave it alone. const bottom_offset = message_top + next_row.safeOuterHeight(true); if (bottom_offset >= top_threshold) { return true; } // If we got this far, the message is not "in view." return false; } function message_is_far_enough_up() { return exports.at_bottom() || next_row.offset().top <= bottom_threshold; } function adjust(in_view, get_next_row) { // return true only if we make an actual adjustment, so // that we know to short circuit the other direction if (in_view(next_row)) { return false; // try other side } while (!in_view(next_row)) { candidate = get_next_row(next_row); if (candidate.length === 0) { break; } next_row = candidate; } return true; } if (!adjust(message_is_far_enough_down, rows.next_visible)) { adjust(message_is_far_enough_up, rows.prev_visible); } current_msg_list.select_id(rows.id(next_row), {from_scroll: true}); }; exports.initialize = function () { jwindow = $(window); exports.message_pane = $(".app"); // This handler must be placed before all resize handlers in our application jwindow.resize(() => { dimensions.height.reset(); dimensions.width.reset(); top_of_feed.reset(); bottom_of_feed.reset(); }); $(document).on("compose_started compose_canceled compose_finished", () => { bottom_of_feed.reset(); }); }; window.message_viewport = exports;