'use strict'; module.exports = function (utils, Benchpress, relative_path) { Benchpress.setGlobal('true', true); Benchpress.setGlobal('false', false); const oneDayInMs = 24 * 60 * 60 * 1000; const helpers = { displayMenuItem, buildMetaTag, buildLinkTag, stringify, escape, stripTags, buildCategoryIcon, buildCategoryLabel, generateCategoryBackground, generateChildrenCategories, generateTopicClass, membershipBtn, spawnPrivilegeStates, localeToHTML, renderTopicImage, renderDigestAvatar, userAgentIcons, buildAvatar, increment, generateRepliedTo, generateWrote, isoTimeToLocaleString, shouldHideReplyContainer, humanReadableNumber, formattedNumber, register, __escape: identity, }; function identity(str) { return str; } function displayMenuItem(data, index) { const item = data.navigation[index]; if (!item) { return false; } if (item.route.match('/users') && data.user && !data.user.privileges['view:users']) { return false; } if (item.route.match('/tags') && data.user && !data.user.privileges['view:tags']) { return false; } if (item.route.match('/groups') && data.user && !data.user.privileges['view:groups']) { return false; } return true; } function buildMetaTag(tag) { const name = tag.name ? 'name="' + tag.name + '" ' : ''; const property = tag.property ? 'property="' + tag.property + '" ' : ''; const content = tag.content ? 'content="' + tag.content.replace(/\n/g, ' ') + '" ' : ''; return '\n\t'; } function buildLinkTag(tag) { const attributes = ['link', 'rel', 'as', 'type', 'href', 'sizes', 'title', 'crossorigin']; const [link, rel, as, type, href, sizes, title, crossorigin] = attributes.map(attr => (tag[attr] ? `${attr}="${tag[attr]}" ` : '')); return '\n\t'; } function stringify(obj) { // Turns the incoming object into a JSON string return JSON.stringify(obj).replace(/&/gm, '&').replace(//gm, '>') .replace(/"/g, '"'); } function escape(str) { return utils.escapeHTML(str); } function stripTags(str) { return utils.stripHTMLTags(str); } function buildCategoryIcon(category, size, rounded) { if (!category) { return ''; } return `${category.icon ? `` : ''}`; } function buildCategoryLabel(category, tag = 'a', className = '') { if (!category) { return ''; } const href = tag === 'a' ? `href="${relative_path}/category/${category.slug}"` : ''; return `<${tag} ${href} class="badge px-1 text-truncate text-decoration-none ${className}" style="color: ${category.color};background-color: ${category.bgColor};border-color: ${category.bgColor}!important; max-width: 70vw;"> ${category.icon && category.icon !== 'fa-nbb-none' ? `` : ''} ${category.name} `; } function generateCategoryBackground(category) { if (!category) { return ''; } const style = []; if (category.bgColor) { style.push('background-color: ' + category.bgColor); style.push(`border-color: ${category.bgColor}!important`); } if (category.color) { style.push('color: ' + category.color); } if (category.backgroundImage) { style.push('background-image: url(' + category.backgroundImage + ')'); if (category.imageClass) { style.push('background-size: ' + category.imageClass); } } return style.join('; ') + ';'; } function generateChildrenCategories(category) { let html = ''; if (!category || !category.children || !category.children.length) { return html; } category.children.forEach(function (child) { if (child && !child.isSection) { const link = child.link ? child.link : (relative_path + '/category/' + child.slug); html += '' + '' + '' + child.name + ''; } }); html = html ? ('' + html + '') : html; return html; } function generateTopicClass(topic) { const fields = ['locked', 'pinned', 'deleted', 'unread', 'scheduled']; return fields.filter(field => !!topic[field]).join(' '); } // Groups helpers function membershipBtn(groupObj, btnClass = '') { if (groupObj.isMember && groupObj.name !== 'administrators') { return ``; } if (groupObj.isPending && groupObj.name !== 'administrators') { return ``; } else if (groupObj.isInvited) { return ``; } else if (!groupObj.disableJoinRequests && groupObj.name !== 'administrators') { return ``; } return ''; } function spawnPrivilegeStates(member, privileges, types) { const states = []; for (const priv in privileges) { if (privileges.hasOwnProperty(priv)) { states.push({ name: priv, state: privileges[priv], type: types[priv], }); } } return states.map(function (priv) { const guestDisabled = ['groups:moderate', 'groups:posts:upvote', 'groups:posts:downvote', 'groups:local:login', 'groups:group:create']; const spidersEnabled = ['groups:find', 'groups:read', 'groups:topics:read', 'groups:view:users', 'groups:view:tags', 'groups:view:groups']; const globalModDisabled = ['groups:moderate']; const disabled = (member === 'guests' && (guestDisabled.includes(priv.name) || priv.name.startsWith('groups:admin:'))) || (member === 'spiders' && !spidersEnabled.includes(priv.name)) || (member === 'Global Moderators' && globalModDisabled.includes(priv.name)); return `
`; }).join(''); } function localeToHTML(locale, fallback) { locale = locale || fallback || 'en-GB'; return locale.replace('_', '-'); } function renderTopicImage(topicObj) { if (topicObj.thumb) { return ''; } return ''; } function renderDigestAvatar(block) { if (block.teaser) { if (block.teaser.user.picture) { return ''; } return '
' + block.teaser.user['icon:text'] + '
'; } if (block.user.picture) { return ''; } return '
' + block.user['icon:text'] + '
'; } function userAgentIcons(data) { let icons = ''; switch (data.platform) { case 'Linux': icons += ''; break; case 'Microsoft Windows': icons += ''; break; case 'Apple Mac': icons += ''; break; case 'Android': icons += ''; break; case 'iPad': icons += ''; break; case 'iPod': // intentional fall-through case 'iPhone': icons += ''; break; default: icons += ''; break; } switch (data.browser) { case 'Chrome': icons += ''; break; case 'Firefox': icons += ''; break; case 'Safari': icons += ''; break; case 'IE': icons += ''; break; case 'Edge': icons += ''; break; default: icons += ''; break; } return icons; } function buildAvatar(userObj, size, rounded, classNames, component) { /** * userObj requires: * - uid, picture, icon:bgColor, icon:text (getUserField w/ "picture" should return all 4), username * size: a picture size in the form of a value with units (e.g. 64px, 4rem, etc.) * rounded: true or false (optional, default false) * classNames: additional class names to prepend (optional, default none) * component: overrides the default component (optional, default none) */ // Try to use root context if passed-in userObj is undefined if (!userObj) { userObj = this; } const attributes = new Map([ ['alt', userObj.username], ['title', userObj.username], ['data-uid', userObj.uid], ['loading', 'lazy'], ['aria-label', `[[aria:user-avatar-for, ${userObj.username}]]`], ]); const styles = [`--avatar-size: ${size};`]; const attr2String = attributes => Array.from(attributes).reduce((output, [prop, value]) => { output += ` ${prop}="${value}"`; return output; }, ''); classNames = classNames || ''; attributes.set('class', `avatar ${classNames}${rounded ? ' avatar-rounded' : ''}`); let output = ''; if (userObj.picture) { attributes.set('component', component || 'avatar/picture'); output += ''; } attributes.set('component', component || 'avatar/icon'); styles.push('background-color: ' + userObj['icon:bgColor'] + ';'); output += '' + userObj['icon:text'] + ''; return output; } function increment(value, inc) { return String(value + parseInt(inc, 10)); } function generateRepliedTo(post, timeagoCutoff) { const displayname = post.parent && post.parent.displayname ? post.parent.displayname : '[[global:guest]]'; const isBeforeCutoff = post.timestamp < (Date.now() - (timeagoCutoff * oneDayInMs)); const langSuffix = isBeforeCutoff ? 'on' : 'ago'; return `[[topic:replied-to-user-${langSuffix}, ${post.toPid}, ${relative_path}/post/${post.toPid}, ${displayname}, ${relative_path}/post/${post.pid}, ${post.timestampISO}]]`; } function generateWrote(post, timeagoCutoff) { const isBeforeCutoff = post.timestamp < (Date.now() - (timeagoCutoff * oneDayInMs)); const langSuffix = isBeforeCutoff ? 'on' : 'ago'; return `[[topic:wrote-${langSuffix}, ${relative_path}/post/${post.pid}, ${post.timestampISO}]]`; } function isoTimeToLocaleString(isoTime, locale = 'en-GB') { return new Date(isoTime).toLocaleString([locale], { dateStyle: 'short', timeStyle: 'short', }).replace(/,/g, ','); } function shouldHideReplyContainer(post) { if (post.replies.count <= 0 || post.replies.hasSingleImmediateReply) { return true; } return false; } function humanReadableNumber(number, toFixed = 1) { return utils.makeNumberHumanReadable(number, toFixed); } function formattedNumber(number) { return utils.addCommas(number); } function register() { Object.keys(helpers).forEach(function (helperName) { Benchpress.registerHelper(helperName, helpers[helperName]); }); } return helpers; };