mirror of
https://github.com/zulip/zulip.git
synced 2025-11-04 05:53:43 +00:00
288 lines
8.6 KiB
JavaScript
288 lines
8.6 KiB
JavaScript
var hashchange = (function () {
|
|
|
|
var exports = {};
|
|
|
|
var expected_hash;
|
|
var changing_hash = false;
|
|
|
|
// Some browsers zealously URI-decode the contents of
|
|
// window.location.hash. So we hide our URI-encoding
|
|
// by replacing % with . (like MediaWiki).
|
|
|
|
exports.encodeHashComponent = function (str) {
|
|
return encodeURIComponent(str)
|
|
.replace(/\./g, '%2E')
|
|
.replace(/%/g, '.');
|
|
};
|
|
|
|
exports.encode_operand = function (operator, operand) {
|
|
if ((operator === 'pm-with') || (operator === 'sender')) {
|
|
var slug = people.emails_to_slug(operand);
|
|
if (slug) {
|
|
return slug;
|
|
}
|
|
}
|
|
|
|
return exports.encodeHashComponent(operand);
|
|
};
|
|
|
|
function decodeHashComponent(str) {
|
|
return decodeURIComponent(str.replace(/\./g, '%'));
|
|
}
|
|
|
|
exports.decode_operand = function (operator, operand) {
|
|
if ((operator === 'pm-with') || (operator === 'sender')) {
|
|
var emails = people.slug_to_emails(operand);
|
|
if (emails) {
|
|
return emails;
|
|
}
|
|
}
|
|
|
|
return decodeHashComponent(operand);
|
|
};
|
|
|
|
function set_hash(hash) {
|
|
var location = window.location;
|
|
|
|
if (history.pushState) {
|
|
if (hash === '' || hash.charAt(0) !== '#') {
|
|
hash = '#' + hash;
|
|
}
|
|
|
|
// IE returns pathname as undefined and missing the leading /
|
|
var pathname = location.pathname;
|
|
if (pathname === undefined) {
|
|
pathname = '/';
|
|
} else if (pathname === '' || pathname.charAt(0) !== '/') {
|
|
pathname = '/' + pathname;
|
|
}
|
|
|
|
// Build a full URL to not have same origin problems
|
|
var url = location.protocol + '//' + location.host + pathname + hash;
|
|
history.pushState(null, null, url);
|
|
} else {
|
|
location.hash = hash;
|
|
}
|
|
}
|
|
|
|
exports.changehash = function (newhash) {
|
|
if (changing_hash) {
|
|
return;
|
|
}
|
|
$(document).trigger($.Event('zuliphashchange.zulip'));
|
|
set_hash(newhash);
|
|
favicon.reset();
|
|
};
|
|
|
|
// Encodes an operator list into the
|
|
// corresponding hash: the # component
|
|
// of the narrow URL
|
|
exports.operators_to_hash = function (operators) {
|
|
var hash = '#';
|
|
|
|
if (operators !== undefined) {
|
|
hash = '#narrow';
|
|
_.each(operators, function (elem) {
|
|
// Support legacy tuples.
|
|
var operator = elem.operator;
|
|
var operand = elem.operand;
|
|
|
|
var sign = elem.negated ? '-' : '';
|
|
hash += '/' + sign + hashchange.encodeHashComponent(operator)
|
|
+ '/' + hashchange.encode_operand(operator, operand);
|
|
});
|
|
}
|
|
|
|
return hash;
|
|
};
|
|
|
|
exports.save_narrow = function (operators) {
|
|
if (changing_hash) {
|
|
return;
|
|
}
|
|
var new_hash = exports.operators_to_hash(operators);
|
|
exports.changehash(new_hash);
|
|
};
|
|
|
|
exports.parse_narrow = function (hash) {
|
|
var i;
|
|
var operators = [];
|
|
for (i=1; i<hash.length; i+=2) {
|
|
// We don't construct URLs with an odd number of components,
|
|
// but the user might write one.
|
|
try {
|
|
var operator = decodeHashComponent(hash[i]);
|
|
var operand = exports.decode_operand(operator, hash[i+1] || '');
|
|
var negated = false;
|
|
if (operator[0] === '-') {
|
|
negated = true;
|
|
operator = operator.slice(1);
|
|
}
|
|
operators.push({negated: negated, operator: operator, operand: operand});
|
|
} catch (err) {
|
|
return undefined;
|
|
}
|
|
}
|
|
return operators;
|
|
};
|
|
|
|
function activate_home_tab() {
|
|
ui.change_tab_to("#home");
|
|
narrow.deactivate();
|
|
floating_recipient_bar.update();
|
|
}
|
|
|
|
// Returns true if this function performed a narrow
|
|
function do_hashchange(from_reload) {
|
|
// If window.location.hash changed because our app explicitly
|
|
// changed it, then we don't need to do anything.
|
|
// (This function only neds to jump into action if it changed
|
|
// because e.g. the back button was pressed by the user)
|
|
//
|
|
// The second case is for handling the fact that some browsers
|
|
// automatically convert '#' to '' when you change the hash to '#'.
|
|
if (window.location.hash === expected_hash ||
|
|
(expected_hash !== undefined &&
|
|
window.location.hash.replace(/^#/, '') === '' &&
|
|
expected_hash.replace(/^#/, '') === '')) {
|
|
return false;
|
|
}
|
|
|
|
$(document).trigger($.Event('zuliphashchange.zulip'));
|
|
|
|
// NB: In Firefox, window.location.hash is URI-decoded.
|
|
// Even if the URL bar says #%41%42%43%44, the value here will
|
|
// be #ABCD.
|
|
var hash = window.location.hash.split("/");
|
|
switch (hash[0]) {
|
|
case "#narrow":
|
|
ui.change_tab_to("#home");
|
|
var operators = exports.parse_narrow(hash);
|
|
if (operators === undefined) {
|
|
// If the narrow URL didn't parse, clear
|
|
// window.location.hash and send them to the home tab
|
|
set_hash('');
|
|
activate_home_tab();
|
|
return false;
|
|
}
|
|
var narrow_opts = {
|
|
select_first_unread: true,
|
|
change_hash: false, // already set
|
|
trigger: 'hash change',
|
|
};
|
|
if (from_reload !== undefined && page_params.initial_narrow_pointer !== undefined) {
|
|
narrow_opts.from_reload = true;
|
|
narrow_opts.first_unread_from_server = true;
|
|
}
|
|
narrow.activate(operators, narrow_opts);
|
|
floating_recipient_bar.update();
|
|
return true;
|
|
case "":
|
|
case "#":
|
|
activate_home_tab();
|
|
break;
|
|
case "#subscriptions":
|
|
ui.change_tab_to("#subscriptions");
|
|
break;
|
|
case "#administration":
|
|
ui.change_tab_to("#administration");
|
|
break;
|
|
case "#settings":
|
|
ui.change_tab_to("#settings");
|
|
break;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
// -- -- -- -- -- -- READ THIS BEFORE TOUCHING ANYTHING BELOW -- -- -- -- -- -- //
|
|
// HOW THE HASH CHANGE MECHANISM WORKS:
|
|
// When going from a normal view (eg. `narrow/is/private`) to a settings panel
|
|
// (eg. `settings/your-bots`) it should trigger the `should_ignore` function and
|
|
// return `true` for the current state -- we want to ignore hash changes from
|
|
// within the settings page, as they will be handled by the settings page itself.
|
|
//
|
|
// There is then an `exit_settings` function that allows the hash to change exactly
|
|
// once without triggering any events. This allows the hash to reset back from
|
|
// a settings page to the previous view available before the settings page
|
|
// (eg. narrow/is/private). This saves the state, scroll position, and makes the
|
|
// hash change functionally inert.
|
|
// -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- - -- //
|
|
var ignore = {
|
|
flag: false,
|
|
prev: null,
|
|
};
|
|
|
|
function get_main_hash(hash) {
|
|
return hash.replace(/^#/, "").split(/\//)[0];
|
|
}
|
|
|
|
function should_ignore(hash) {
|
|
// an array of hashes to ignore (eg. ["subscriptions", "settings", "administration"]).
|
|
var ignore_list = ["subscriptions"];
|
|
var main_hash = get_main_hash(hash);
|
|
|
|
return (ignore_list.indexOf(main_hash) > -1);
|
|
}
|
|
|
|
function hide_overlays() {
|
|
subs.close();
|
|
}
|
|
|
|
function hashchanged(from_reload, e) {
|
|
var old_hash;
|
|
if (e) {
|
|
old_hash = "#" + e.oldURL.split(/#/).slice(1).join("");
|
|
ignore.last = old_hash;
|
|
}
|
|
|
|
var base = get_main_hash(window.location.hash);
|
|
if (should_ignore(window.location.hash)) {
|
|
if (!should_ignore(old_hash || "#")) {
|
|
if (base === "subscriptions") {
|
|
subs.launch();
|
|
}
|
|
|
|
ignore.prev = old_hash;
|
|
}
|
|
} else if (!should_ignore(window.location.hash) && !ignore.flag) {
|
|
hide_overlays();
|
|
changing_hash = true;
|
|
var ret = do_hashchange(from_reload);
|
|
changing_hash = false;
|
|
return ret;
|
|
// once we unignore the hash, we have to set the hash back to what it was
|
|
// originally (eg. '#narrow/stream/Denmark' instead of '#settings'). We
|
|
// therefore ignore the hash change once more while we change it back for
|
|
// no iterruptions.
|
|
} else if (ignore.flag) {
|
|
ignore.flag = false;
|
|
}
|
|
}
|
|
|
|
exports.initialize = function () {
|
|
// jQuery doesn't have a hashchange event, so we manually wrap
|
|
// our event handler
|
|
window.onhashchange = blueslip.wrap_function(function (e) {
|
|
hashchanged(false, e);
|
|
});
|
|
hashchanged(true);
|
|
};
|
|
|
|
exports.exit_settings = function (callback) {
|
|
if (should_ignore(window.location.hash)) {
|
|
ui.blur_active_element();
|
|
ignore.flag = true;
|
|
window.location.hash = ignore.prev || "#";
|
|
if (typeof callback === "function") {
|
|
callback();
|
|
}
|
|
}
|
|
};
|
|
|
|
return exports;
|
|
|
|
}());
|
|
if (typeof module !== 'undefined') {
|
|
module.exports = hashchange;
|
|
}
|