Skip to content

Node.js based forum software built for the modern web

15.7 KB
Raw Blame
'use strict';

const nconf = require('nconf');
const assert = require('assert');

const db = require('./mocks/databasemock');
const helpers = require('../src/helpers');
const languages = require('../src/languages');

describe('helpers', () => {
	it('should return false if item doesn\'t exist', (done) => {
		const flag = helpers.displayMenuItem({ navigation: [] }, 0);
		assert(!flag);
		done();
	});

	it('should return false if route is /users and user does not have view:users privilege', (done) => {
		const flag = helpers.displayMenuItem({
			navigation: [{ route: '/users' }],
			user: {
				privileges: {
					'view:users': false,
				},
			},
		}, 0);
		assert(!flag);
		done();
	});

	it('should return false if route is /tags and user does not have view:tags privilege', (done) => {
		const flag = helpers.displayMenuItem({
			navigation: [{ route: '/tags' }],
			user: {
				privileges: {
					'view:tags': false,
				},
			},
		}, 0);
		assert(!flag);
		done();
	});

	it('should return false if route is /groups and user does not have view:groups privilege', (done) => {
		const flag = helpers.displayMenuItem({
			navigation: [{ route: '/groups' }],
			user: {
				privileges: {
					'view:groups': false,
				},
			},
		}, 0);
		assert(!flag);
		done();
	});

	it('should return true if route is visible', (done) => {
		const flag = helpers.displayMenuItem({
			navigation: [{ route: '/recent' }],
			user: {
				privileges: {},
			},
		}, 0);
		assert(flag);
		done();
	});

	it('should stringify object', (done) => {
		const str = helpers.stringify({ a: 'herp < derp > and & quote "' });
		assert.equal(str, '{&quot;a&quot;:&quot;herp &lt; derp &gt; and &amp; quote \\&quot;&quot;}');
		done();
	});

	it('should escape html', (done) => {
		const str = helpers.escape('gdkfhgk < some > and & [[global:posts]] foo');
		assert.equal(str, 'gdkfhgk &lt; some &gt; and &amp; [[global:posts]] foo');
		done();
	});

	it('should build category icon', (done) => {
		assert.strictEqual(
			helpers.buildCategoryIcon({
				bgColor: '#ff0000',
				color: '#00ff00',
				backgroundImage: '/assets/uploads/image.png',
				imageClass: 'auto',
			}, 16, 'rounded-circle'),
			'<span class="icon d-inline-flex justify-content-center align-items-center align-middle rounded-circle" style="background-color: #ff0000; border-color: #ff0000 !important; color: #00ff00; background-image: url(/assets/uploads/image.png); background-size: auto; width:16; height: 16; font-size: 8px;"></span>'
		);
		assert.strictEqual(
			helpers.buildCategoryIcon({
				bgColor: '#ff0000',
				color: '#00ff00',
				backgroundImage: '/assets/uploads/image.png',
				imageClass: 'auto',
				icon: 'fa-book',
			}, '16px', 'rounded-circle'),
			'<span class="icon d-inline-flex justify-content-center align-items-center align-middle rounded-circle" style="background-color: #ff0000; border-color: #ff0000 !important; color: #00ff00; background-image: url(/assets/uploads/image.png); background-size: auto; width:16px; height: 16px; font-size: 8px;"><i class="fa fa-fw fa-book" style="line-height: 16px;"></i></span>'
		);
		done();
	});

	it('should build category label', (done) => {
		assert.strictEqual(
			helpers.buildCategoryLabel({
				bgColor: '#ff0000',
				color: '#00ff00',
				backgroundImage: '/assets/uploads/image.png',
				imageClass: 'auto',
				name: 'Category 1',
				slug: 'category-1',
			}, 'a', ''),
			`<a component="topic/category" href="${nconf.get('relative_path')}/category/category-1" class="badge px-1 text-truncate text-decoration-none " style="color: #00ff00;background-color: #ff0000;border-color: #ff0000!important; max-width: 70vw;">\n\t\t\t\n\t\t\tCategory 1\n\t\t</a>`
		);
		assert.strictEqual(
			helpers.buildCategoryLabel({
				bgColor: '#ff0000',
				color: '#00ff00',
				backgroundImage: '/assets/uploads/image.png',
				imageClass: 'auto',
				name: 'Category 1',
				icon: 'fa-book',
			}, 'span', 'rounded-1'),
			`<span component="topic/category"  class="badge px-1 text-truncate text-decoration-none rounded-1" style="color: #00ff00;background-color: #ff0000;border-color: #ff0000!important; max-width: 70vw;">\n\t\t\t<i class="fa fa-fw fa-book"></i>\n\t\t\tCategory 1\n\t\t</span>`,
		);
		done();
	});

	it('should return empty string if category is falsy', (done) => {
		assert.equal(helpers.buildCategoryIcon(null), '');
		assert.equal(helpers.buildCategoryLabel(null), '');
		assert.equal(helpers.generateCategoryBackground(null), '');
		done();
	});

	it('should generate category background', (done) => {
		const category = {
			bgColor: '#ff0000',
			color: '#00ff00',
			backgroundImage: '/assets/uploads/image.png',
			imageClass: 'auto',
		};
		const bg = helpers.generateCategoryBackground(category);
		assert.equal(bg, 'background-color: #ff0000; border-color: #ff0000 !important; color: #00ff00; background-image: url(/assets/uploads/image.png); background-size: auto;');
		done();
	});

	it('should return empty string if category has no children', (done) => {
		const category = {
			children: [],
		};
		const bg = helpers.generateChildrenCategories(category);
		assert.equal(bg, '');
		done();
	});

	it('should generate html for children', (done) => {
		const category = {
			children: [
				{
					link: '',
					bgColor: '#ff0000',
					color: '#00ff00',
					name: 'children',
					slug: 'children',
					icon: 'fa-users',
				},
			],
		};
		const html = helpers.generateChildrenCategories(category);
		assert.equal(html, `<span class="category-children"><span class="category-children-item"><div role="presentation" class="icon" style="background-color: #ff0000; border-color: #ff0000 !important; color: #00ff00;"><i class="fa fa-fw fa-users"></i></div><a href="${nconf.get('relative_path')}/category/children"><small>children</small></a></span></span>`);
		done();
	});

	it('should generate topic class', (done) => {
		const className = helpers.generateTopicClass({ locked: true, pinned: true, deleted: true, unread: true });
		assert.equal(className, 'locked pinned deleted unread');
		done();
	});

	it('should show leave button if isMember and group is not administrators', (done) => {
		const ctx = languages.getFull('en-GB');
		const btn = helpers.membershipBtn.call({ _i18n: ctx }, { displayName: 'some group', name: 'some group', isMember: true });
		assert.equal(btn, '<button class="btn btn-danger text-nowrap " data-action="leave" data-group="some group" ><i class="fa fa-times"></i> Leave Group</button>');
		done();
	});

	it('should show pending button if isPending and group is not administrators', (done) => {
		const ctx = languages.getFull('en-GB');
		const btn = helpers.membershipBtn.call({ _i18n: ctx }, { displayName: 'some group', name: 'some group', isPending: true });
		assert.equal(btn, '<button class="btn btn-warning text-nowrap disabled "><i class="fa fa-clock-o"></i> Invitation Pending</button>');
		done();
	});

	it('should show reject invite button if isInvited', (done) => {
		const ctx = languages.getFull('en-GB');
		const btn = helpers.membershipBtn.call({ _i18n: ctx }, { displayName: 'some group', name: 'some group', isInvited: true });
		assert.equal(btn, '<button class="btn btn-warning text-nowrap" data-action="rejectInvite" data-group="some group">Reject</button><button class="btn btn-success" data-action="acceptInvite" data-group="some group"><i class="fa fa-plus"></i> Accept Invitation</button>');
		done();
	});

	it('should show join button if join requests are not disabled and group is not administrators', (done) => {
		const ctx = languages.getFull('en-GB');
		const btn = helpers.membershipBtn.call({ _i18n: ctx }, { displayName: 'some group', name: 'some group', disableJoinRequests: false });
		assert.equal(btn, '<button class="btn btn-success text-nowrap " data-action="join" data-group="some group"><i class="fa fa-plus"></i> Join Group</button>');
		done();
	});

	it('should show nothing if group is administrators ', (done) => {
		const btn = helpers.membershipBtn({ displayName: 'administrators', name: 'administrators' });
		assert.equal(btn, '');
		done();
	});

	it('should spawn privilege states', (done) => {
		const privs = {
			find: true,
			read: true,
		};
		const types = {
			find: 'viewing',
			read: 'viewing',
		};
		const html = helpers.spawnPrivilegeStates(1, 'guests', privs, types);
		assert.equal(html, `
				<td data-privilege="find" data-value="true" data-type="viewing">
					<div class="form-check text-center">
						<input class="form-check-input float-none" autocomplete="off" type="checkbox" checked />
					</div>
				</td>
\t\t\t
				<td data-privilege="read" data-value="true" data-type="viewing">
					<div class="form-check text-center">
						<input class="form-check-input float-none" autocomplete="off" type="checkbox" checked />
					</div>
				</td>
			`);
		done();
	});

	it('should render digest avatar', (done) => {
		const block = { teaser: { user: { username: 'baris', picture: '/uploads/1.png' } } };
		const html = helpers.renderDigestAvatar(block);
		assert.equal(html, `<img style="vertical-align: middle; width: 32px; height: 32px; border-radius: 50%;" src="${block.teaser.user.picture}" title="${block.teaser.user.username}" />`);
		done();
	});

	it('should render digest avatar', (done) => {
		const block = { teaser: { user: { username: 'baris', 'icon:text': 'B', 'icon:bgColor': '#ff000' } } };
		const html = helpers.renderDigestAvatar(block);
		assert.equal(html, `<div style="vertical-align: middle; width: 32px; height: 32px; line-height: 32px; font-size: 16px; color: white; text-align: center; display: inline-block; border-radius: 50%; background-color: ${block.teaser.user['icon:bgColor']};">${block.teaser.user['icon:text']}</div>`);
		done();
	});

	it('should render digest avatar', (done) => {
		const block = { user: { username: 'baris', picture: '/uploads/1.png' } };
		const html = helpers.renderDigestAvatar(block);
		assert.equal(html, `<img style="vertical-align: middle; width: 32px; height: 32px; border-radius: 50%;" src="${block.user.picture}" title="${block.user.username}" />`);
		done();
	});

	it('should render digest avatar', (done) => {
		const block = { user: { username: 'baris', 'icon:text': 'B', 'icon:bgColor': '#ff000' } };
		const html = helpers.renderDigestAvatar(block);
		assert.equal(html, `<div style="vertical-align: middle; width: 32px; height: 32px; line-height: 32px; font-size: 16px; color: white; text-align: center; display: inline-block; border-radius: 50%; background-color: ${block.user['icon:bgColor']};">${block.user['icon:text']}</div>`);
		done();
	});

	it('shoud render user agent/browser icons', (done) => {
		const html = helpers.userAgentIcons({ platform: 'Linux', browser: 'Chrome' });
		assert.equal(html, '<i class="fa fa-fw fa-linux"></i><i class="fa fa-fw fa-chrome"></i>');
		done();
	});

	it('shoud render user agent/browser icons', (done) => {
		const html = helpers.userAgentIcons({ platform: 'Microsoft Windows', browser: 'Firefox' });
		assert.equal(html, '<i class="fa fa-fw fa-windows"></i><i class="fa fa-fw fa-firefox"></i>');
		done();
	});

	it('shoud render user agent/browser icons', (done) => {
		const html = helpers.userAgentIcons({ platform: 'Apple Mac', browser: 'Safari' });
		assert.equal(html, '<i class="fa fa-fw fa-apple"></i><i class="fa fa-fw fa-safari"></i>');
		done();
	});

	it('shoud render user agent/browser icons', (done) => {
		const html = helpers.userAgentIcons({ platform: 'Android', browser: 'IE' });
		assert.equal(html, '<i class="fa fa-fw fa-android"></i><i class="fa fa-fw fa-internet-explorer"></i>');
		done();
	});

	it('shoud render user agent/browser icons', (done) => {
		const html = helpers.userAgentIcons({ platform: 'iPad', browser: 'Edge' });
		assert.equal(html, '<i class="fa fa-fw fa-tablet"></i><i class="fa fa-fw fa-edge"></i>');
		done();
	});

	it('shoud render user agent/browser icons', (done) => {
		const html = helpers.userAgentIcons({ platform: 'iPhone', browser: 'unknow' });
		assert.equal(html, '<i class="fa fa-fw fa-mobile"></i><i class="fa fa-fw fa-question-circle"></i>');
		done();
	});

	it('shoud render user agent/browser icons', (done) => {
		const html = helpers.userAgentIcons({ platform: 'unknow', browser: 'unknown' });
		assert.equal(html, '<i class="fa fa-fw fa-question-circle"></i><i class="fa fa-fw fa-question-circle"></i>');
		done();
	});

	it('should generate replied to or wrote based on toPid', (done) => {
		const now = Date.now();
		const iso = new Date().toISOString();
		let post = { pid: 2, toPid: 1, timestamp: now, timestampISO: iso, parent: { displayname: 'baris' } };
		const txContext = {
			_i18n: {
				topic: {
					'wrote-ago': 'wrote <a href="%1" class="timeago text-muted" title="%2"></a>',
					'wrote-on': 'wrote on <a href="%1" class="timeago text-muted" title="%2"></a>',
					'replied-to-user-ago': 'replied to <a component="post/parent" data-topid="%1" href="%2">%3</a> <a href="%4" class="timeago text-muted" title="%5"></a>',
					'replied-to-user-on': 'replied to <a component="post/parent" data-topid="%1" href="%2">%3</a> on <a href="%4" class="timeago text-muted" title="%5"></a>',
				},
			},
		};
		const relative_path = nconf.get('relative_path');
		let str = helpers.generateWroteReplied.call(txContext, post, 1);
		assert.strictEqual(str, `replied to <a component="post/parent" data-topid="1" href="${relative_path}/post/1">baris</a> <a href="${relative_path}/post/2" class="timeago text-muted" title="${iso}"></a>`);

		post = { pid: 2, toPid: 1, timestamp: now, timestampISO: iso, parent: { displayname: 'baris' } };
		str = helpers.generateWroteReplied.call(txContext, post, -1);
		assert.strictEqual(str, `replied to <a component="post/parent" data-topid="1" href="${relative_path}/post/1">baris</a> on <a href="${relative_path}/post/2" class="timeago text-muted" title="${iso}"></a>`);

		post = { pid: 2, timestamp: now, timestampISO: iso, parent: { displayname: 'baris' } };
		str = helpers.generateWroteReplied.call(txContext, post, 1);
		assert.strictEqual(str, `wrote <a href="${relative_path}/post/2" class="timeago text-muted" title="${iso}"></a>`);

		str = helpers.generateWroteReplied.call(txContext, post, -1);
		assert.strictEqual(str, `wrote on <a href="${relative_path}/post/2" class="timeago text-muted" title="${iso}"></a>`);

		done();
	});

	it('should generate placeholder wave', (done) => {
		const items = [2, 'divider', 3];
		const str = helpers.generatePlaceholderWave(items);
		assert(str.includes('dropdown-divider'));
		assert(str.includes('col-2'));
		assert(str.includes('col-3'));
		done();
	});

	describe('buildAvatar', () => {
		it('should build avatar with picture', () => {
			const user = {
				uid: 1,
				displayname: 'john',
				picture: '/uploads/1.png',
				'icon:text': 'J',
				'icon:bgColor': '#ff0000',
			};
			const html = helpers.buildAvatar(user, 32, true);
			assert.strictEqual(html, `<img title="john" data-uid="1" class="avatar  avatar-rounded" alt="john" loading="lazy" component="avatar/picture" src="/uploads/1.png" style="--avatar-size: 32;" onError="this.remove()" /><span title="john" data-uid="1" class="avatar  avatar-rounded" component="avatar/icon" style="--avatar-size: 32; background-color: #ff0000">J</span>`);
		});

		it('should escape all attributes', () => {
			const user = {
				uid: '"remoteuid',
				displayname: '"remoteusername',
				picture: '"/uploads/1.png',
				'icon:text': '"icon',
				'icon:bgColor': '"#ff0000',
			};
			const html = helpers.buildAvatar(user, 32, true, '"custom-class', '"component');
			assert.strictEqual(html, `<img title="&quot;remoteusername" data-uid="&quot;remoteuid" class="avatar &quot;custom-class avatar-rounded" alt="&quot;remoteusername" loading="lazy" component="&quot;component" src="&quot;/uploads/1.png" style="--avatar-size: 32;" onError="this.remove()" /><span title="&quot;remoteusername" data-uid="&quot;remoteuid" class="avatar &quot;custom-class avatar-rounded" component="&quot;component" style="--avatar-size: 32; background-color: &quot;#ff0000">&quot;icon</span>`);
		});
	});
});