const util = require("./util"); // Read https://zulip.readthedocs.io/en/latest/subsystems/hashchange-system.html function preserve_state(send_after_reload, save_pointer, save_narrow, save_compose) { if (!localstorage.supported()) { // If local storage is not supported by the browser, we can't // save the browser's position across reloads (since there's // no secure way to pass that state in a signed fashion to the // next instance of the browser client). // // So we jure return here and let the reload proceed without // having preserved state. We keep the hash the same so we'll // at least save their narrow state. blueslip.log("Can't preserve state; no local storage."); return; } if (send_after_reload === undefined) { send_after_reload = 0; } let url = "#reload:send_after_reload=" + Number(send_after_reload); url += "+csrf_token=" + encodeURIComponent(csrf_token); if (save_compose) { const msg_type = compose_state.get_message_type(); if (msg_type === 'stream') { url += "+msg_type=stream"; url += "+stream=" + encodeURIComponent(compose_state.stream_name()); url += "+topic=" + encodeURIComponent(compose_state.topic()); } else if (msg_type === 'private') { url += "+msg_type=private"; url += "+recipient=" + encodeURIComponent(compose_state.private_message_recipient()); } if (msg_type) { url += "+msg=" + encodeURIComponent(compose_state.message_content()); } } if (save_pointer) { const pointer = home_msg_list.selected_id(); if (pointer !== -1) { url += "+pointer=" + pointer; } } if (save_narrow) { const row = home_msg_list.selected_row(); if (!narrow_state.active()) { if (row.length > 0) { url += "+offset=" + row.offset().top; } } else { url += "+offset=" + home_msg_list.pre_narrow_offset; const narrow_pointer = message_list.narrowed.selected_id(); if (narrow_pointer !== -1) { url += "+narrow_pointer=" + narrow_pointer; } const narrow_row = message_list.narrowed.selected_row(); if (narrow_row.length > 0) { url += "+narrow_offset=" + narrow_row.offset().top; } } } let oldhash = window.location.hash; if (oldhash.length !== 0 && oldhash[0] === '#') { oldhash = oldhash.slice(1); } url += "+oldhash=" + encodeURIComponent(oldhash); const ls = localstorage(); // Delete all the previous preserved states. ls.removeRegex('reload:\\d+'); // To protect the browser against CSRF type attacks, the reload // logic uses a random token (to distinct this browser from // others) which is passed via the URL to the browser (post // reloading). The token is a key into local storage, where we // marshall and store the URL. // // TODO: Remove the now-unnecessary URL-encoding logic above and // just pass the actual data structures through local storage. const token = util.random_int(0, 1024 * 1024 * 1024 * 1024); ls.set("reload:" + token, url); window.location.replace("#reload:" + token); } // Check if we're doing a compose-preserving reload. This must be // done before the first call to get_events exports.initialize = function () { const location = window.location.toString(); const hash_fragment = location.substring(location.indexOf('#') + 1); // hash_fragment should be e.g. `reload:12345123412312` if (hash_fragment.search("reload:") !== 0) { return; } // Using the token, recover the saved pre-reload data from local // storage. Afterwards, we clear the reload entry from local // storage to avoid a local storage space leak. const ls = localstorage(); let fragment = ls.get(hash_fragment); if (fragment === undefined) { // Since this can happen sometimes with hand-reloading, it's // not really worth throwing an exception if these don't // exist, but be log it so that it's available for future // debugging if an exception happens later. blueslip.info("Invalid hash change reload token"); hashchange.changehash(""); return; } ls.remove(hash_fragment); fragment = fragment.replace(/^reload:/, ""); const keyvals = fragment.split("+"); const vars = {}; for (const str of keyvals) { const pair = str.split("="); vars[pair[0]] = decodeURIComponent(pair[1]); } if (vars.msg !== undefined) { const send_now = parseInt(vars.send_after_reload, 10); try { // TODO: preserve focus const topic = util.get_reload_topic(vars); compose_actions.start(vars.msg_type, {stream: vars.stream || '', topic: topic || '', private_message_recipient: vars.recipient || '', content: vars.msg || ''}); if (send_now) { compose.finish(); } } catch (err) { // We log an error if we can't open the compose box, but otherwise // we continue, since this is not critical. blueslip.warn(err.toString()); } } const pointer = parseInt(vars.pointer, 10); if (pointer) { page_params.initial_pointer = pointer; } const offset = parseInt(vars.offset, 10); if (offset) { page_params.initial_offset = offset; } const narrow_pointer = parseInt(vars.narrow_pointer, 10); if (narrow_pointer) { page_params.initial_narrow_pointer = narrow_pointer; } const narrow_offset = parseInt(vars.narrow_offset, 10); if (narrow_offset) { page_params.initial_narrow_offset = narrow_offset; } activity.new_user_input = false; hashchange.changehash(vars.oldhash); }; function do_reload_app(send_after_reload, save_pointer, save_narrow, save_compose, message) { if (reload_state.is_in_progress()) { blueslip.log("do_reload_app: Doing nothing since reload_in_progress"); return; } // TODO: we should completely disable the UI here if (save_pointer || save_narrow || save_compose) { try { preserve_state(send_after_reload, save_pointer, save_narrow, save_compose); } catch (ex) { blueslip.error('Failed to preserve state', undefined, ex.stack); } } if (message === undefined) { message = "Reloading ..."; } // TODO: We need a better API for showing messages. ui_report.message(message, $("#reloading-application")); blueslip.log('Starting server requested page reload'); reload_state.set_state_to_in_progress(); // Sometimes the window.location.reload that we attempt has no // immediate effect (likely by browsers trying to save power by // skipping requested reloads), which can leave the Zulip app in a // broken state and cause lots of confusing tracebacks. So, we // set ourselves to try reloading a bit later, both periodically // and when the user focuses the window. $(window).on('focus', () => { blueslip.log("Retrying on-focus page reload"); window.location.reload(true); }); setInterval(() => { blueslip.log("Retrying page reload due to 30s timer"); window.location.reload(true); }, 30000); try { server_events.cleanup_event_queue(); } catch (ex) { blueslip.error('Failed to cleanup before reloading', undefined, ex.stack); } window.location.reload(true); } exports.initiate = function (options) { options = { immediate: false, save_pointer: true, save_narrow: true, save_compose: true, send_after_reload: false, ...options, }; if (options.save_pointer === undefined || options.save_narrow === undefined || options.save_compose === undefined) { blueslip.error("reload.initiate() called without explicit save options."); } if (options.immediate) { do_reload_app(options.send_after_reload, options.save_pointer, options.save_narrow, options.save_compose, options.message); } if (reload_state.is_pending()) { return; } reload_state.set_state_to_pending(); // We're now planning to execute a reload of the browser, usually // to get an updated version of the Zulip webapp code. Because in // most cases all browsers will be receiving this notice at the // same or similar times, we need to randomize the time that we do // this in order to avoid a thundering herd overloading the server. // // Additionally, we try to do this reload at a time the user will // not notice. So completely idle clients will reload first; // those will an open compose box will wait until the message has // been sent (or until it's clear the user isn't likely to send it). // // And then we unconditionally reload sometime after 30 minutes // even if there is continued activity, because we don't support // old JavaScript versions against newer servers and eventually // letting that situation continue will lead to users seeing bugs. // // It's a little odd that how this timeout logic works with // compose box resets including the random variance, but that // makes it simple to reason about: We know that reloads will be // spread over at least 5 minutes in all cases. let idle_control; const random_variance = util.random_int(0, 1000 * 60 * 5); const unconditional_timeout = 1000 * 60 * 30 + random_variance; const composing_idle_timeout = 1000 * 60 * 7 + random_variance; const basic_idle_timeout = 1000 * 60 * 1 + random_variance; let compose_started_handler; function reload_from_idle() { do_reload_app(false, options.save_pointer, options.save_narrow, options.save_compose, options.message); } // Make sure we always do a reload eventually after // unconditional_timeout. Because we save cursor location and // compose state when reloading, we expect this to not be // particularly disruptive. setTimeout(reload_from_idle, unconditional_timeout); const compose_done_handler = function () { // If the user sends their message or otherwise closes // compose, we return them to the not-composing timeouts. idle_control.cancel(); idle_control = $(document).idle({idle: basic_idle_timeout, onIdle: reload_from_idle}); $(document).off('compose_canceled.zulip compose_finished.zulip', compose_done_handler); $(document).on('compose_started.zulip', compose_started_handler); }; compose_started_handler = function () { // If the user stops being idle and starts composing a // message, switch to the compose-open timeouts. idle_control.cancel(); idle_control = $(document).idle({idle: composing_idle_timeout, onIdle: reload_from_idle}); $(document).off('compose_started.zulip', compose_started_handler); $(document).on('compose_canceled.zulip compose_finished.zulip', compose_done_handler); }; if (compose_state.composing()) { idle_control = $(document).idle({idle: composing_idle_timeout, onIdle: reload_from_idle}); $(document).on('compose_canceled.zulip compose_finished.zulip', compose_done_handler); } else { idle_control = $(document).idle({idle: basic_idle_timeout, onIdle: reload_from_idle}); $(document).on('compose_started.zulip', compose_started_handler); } }; window.addEventListener('beforeunload', () => { // When navigating away from the page do not try to reload. // The polling get_events call will fail after we delete the event queue. // When that happens we reload the page to correct the problem. If this // happens before the navigation is complete the user is kept captive at // zulip. blueslip.log("Setting reload_in_progress in beforeunload handler"); reload_state.set_state_to_in_progress(); }); window.reload = exports;