thelounge/client/js/utils.js

"use strict";

const $ = require("jquery");
const escape = require("css.escape");
const {vueApp} = require("./vue");

var serverHash = -1; // eslint-disable-line no-var

module.exports = {
	// Same value as media query in CSS that forces sidebars to become overlays
	mobileViewportPixels: 768,
	findCurrentNetworkChan,
	serverHash,
	confirmExit,
	scrollIntoViewNicely,
	hasRoleInChannel,
	move,
	synchronizeNotifiedState,
	requestIdleCallback,
};

function findCurrentNetworkChan(name) {
	name = name.toLowerCase();

	return vueApp.activeChannel.network.channels.find((c) => c.name.toLowerCase() === name);
}

// Given a channel element will determine if the lounge user or a given nick is one of the supplied roles.
function hasRoleInChannel(channel, roles, nick) {
	if (!channel || !roles) {
		return false;
	}

	const channelID = channel.attr("data-id");
	const network = $("#sidebar .network").has(`.chan[data-id="${channelID}"]`);
	const target = nick || network.attr("data-nick");
	const user = channel.find(`.names .user[data-name="${escape(target)}"]`).first();
	return user.parent().is("." + roles.join(", ."));
}

// Reusable scrollIntoView parameters for channel list / user list
function scrollIntoViewNicely(el) {
	// Ideally this would use behavior: "smooth", but that does not consistently work in e.g. Chrome
	// https://github.com/iamdustan/smoothscroll/issues/28#issuecomment-364061459
	el.scrollIntoView({block: "center", inline: "nearest"});
}

const favicon = $("#favicon");

function synchronizeNotifiedState() {
	updateTitle();

	let hasAnyHighlights = false;

	for (const network of vueApp.networks) {
		for (const chan of network.channels) {
			if (chan.highlight > 0) {
				hasAnyHighlights = true;
				break;
			}
		}
	}

	toggleNotificationMarkers(hasAnyHighlights);
}

function toggleNotificationMarkers(newState) {
	if (vueApp.$store.state.isNotified !== newState) {
		// Toggles a dot on the menu icon when there are unread notifications
		vueApp.$store.commit("isNotified", newState);

		// Toggles the favicon to red when there are unread notifications
		const old = favicon.prop("href");
		favicon.prop("href", favicon.data("other"));
		favicon.data("other", old);
	}
}

function updateTitle() {
	let title = vueApp.appName;

	if (vueApp.activeChannel) {
		title = `${vueApp.activeChannel.channel.name} — ${title}`;
	}

	// add highlight count to title
	let alertEventCount = 0;

	for (const network of vueApp.networks) {
		for (const channel of network.channels) {
			alertEventCount += channel.highlight;
		}
	}

	if (alertEventCount > 0) {
		title = `(${alertEventCount}) ${title}`;
	}

	document.title = title;
}

function confirmExit() {
	if ($(document.body).hasClass("public")) {
		window.onbeforeunload = function() {
			return "Are you sure you want to navigate away from this page?";
		};
	}
}

function move(array, old_index, new_index) {
	if (new_index >= array.length) {
		let k = new_index - array.length;

		while (k-- + 1) {
			this.push(undefined);
		}
	}

	array.splice(new_index, 0, array.splice(old_index, 1)[0]);
	return array;
}

function requestIdleCallback(callback, timeout) {
	if (window.requestIdleCallback) {
		// During an idle period the user agent will run idle callbacks in FIFO order
		// until either the idle period ends or there are no more idle callbacks eligible to be run.
		window.requestIdleCallback(callback, {timeout});
	} else {
		callback();
	}
}