Node.js based forum software built for the modern web
'use strict';
const nconf = require('nconf');
const mime = require('mime').default;
const meta = require('../meta');
const user = require('../user');
const plugins = require('../plugins');
const privilegesHelpers = require('../privileges/helpers');
const helpers = require('./helpers');
const utils = require('../utils');
const Controllers = module.exports;
Controllers.ping = require('./ping');
Controllers['well-known'] = require('./well-known');
Controllers.activitypub = require('./activitypub');
Controllers.home = require('./home');
Controllers.topics = require('./topics');
Controllers.posts = require('./posts');
Controllers.categories = require('./categories');
Controllers.category = require('./category');
Controllers.unread = require('./unread');
Controllers.recent = require('./recent');
Controllers.popular = require('./popular');
Controllers.top = require('./top');
Controllers.tags = require('./tags');
Controllers.search = require('./search');
Controllers.user = require('./user');
Controllers.users = require('./users');
Controllers.groups = require('./groups');
Controllers.accounts = require('./accounts');
Controllers.authentication = require('./authentication');
Controllers.api = require('./api');
Controllers.admin = require('./admin');
Controllers.globalMods = require('./globalmods');
Controllers.mods = require('./mods');
Controllers.sitemap = require('./sitemap');
Controllers.osd = require('./osd');
Controllers['service-worker'] = require('./service-worker');
Controllers['404'] = require('./404');
Controllers.errors = require('./errors');
Controllers.composer = require('./composer');
Controllers.intents = require('./intents');
Controllers.write = require('./write');
Controllers.reset = async function (req, res) {
if (meta.config['password:disableEdit']) {
return helpers.notAllowed(req, res);
}
res.locals.metaTags = {
...res.locals.metaTags,
name: 'robots',
content: 'noindex',
};
const renderReset = function (code, valid) {
res.render('reset_code', {
valid: valid,
displayExpiryNotice: req.session.passwordExpired,
code: code,
minimumPasswordLength: meta.config.minimumPasswordLength,
minimumPasswordStrength: meta.config.minimumPasswordStrength,
breadcrumbs: helpers.buildBreadcrumbs([
{
text: '[[reset_password:reset-password]]',
url: '/reset',
},
{
text: '[[reset_password:update-password]]',
},
]),
title: '[[pages:reset]]',
});
delete req.session.passwordExpired;
};
if (req.params.code) {
req.session.reset_code = req.params.code;
}
if (req.session.reset_code) {
// Validate and save to local variable before removing from session
const valid = await user.reset.validate(req.session.reset_code);
renderReset(req.session.reset_code, valid);
delete req.session.reset_code;
} else {
res.render('reset', {
code: null,
breadcrumbs: helpers.buildBreadcrumbs([{
text: '[[reset_password:reset-password]]',
}]),
title: '[[pages:reset]]',
});
}
};
Controllers.login = async function (req, res) {
const data = { loginFormEntry: [] };
const loginStrategies = require('../routes/authentication').getLoginStrategies();
const registrationType = meta.config.registrationType || 'normal';
const allowLoginWith = (meta.config.allowLoginWith || 'username-email');
let errorText;
if (req.query.error === 'csrf-invalid') {
errorText = '[[error:csrf-invalid]]';
} else if (req.query.error) {
errorText = req.query.error;
}
if (req.headers['x-return-to']) {
req.session.returnTo = helpers.normalizeReturnToPath(req.headers['x-return-to']) || '/';
} else if (req.session.returnTo) {
const normalizedReturnTo = helpers.normalizeReturnToPath(req.session.returnTo);
if (normalizedReturnTo) {
req.session.returnTo = normalizedReturnTo;
}
}
data.alternate_logins = loginStrategies.length > 0;
data.osw_logins = !!meta.config.activitypubEnabled;
data.authentication = loginStrategies;
data.allowRegistration = registrationType === 'normal';
data.allowLoginWith = `[[login:${allowLoginWith}]]`;
data.breadcrumbs = helpers.buildBreadcrumbs([{
text: '[[global:login]]',
}]);
data.error = req.flash('error')[0] || errorText;
data.title = '[[pages:login]]';
data.allowPasswordReset = !meta.config['password:disableEdit'];
const loginPrivileges = await privilegesHelpers.getGroupPrivileges(0, ['groups:local:login']);
const hasLoginPrivilege = !!loginPrivileges.find(privilege => privilege.privileges['groups:local:login']);
data.allowLocalLogin = hasLoginPrivilege || parseInt(req.query.local, 10) === 1;
if (!data.allowLocalLogin && !data.allowRegistration && data.alternate_logins && data.authentication.length === 1) {
return helpers.redirect(res, { external: data.authentication[0].url });
}
// Re-auth challenge, pre-fill username
if (req.loggedIn) {
const userData = await user.getUserFields(req.uid, ['username']);
data.username = userData.username;
data.reauthNotice = !!req.session.forceLogin;
}
res.render('login', data);
};
Controllers.register = async function (req, res, next) {
const registrationType = meta.config.registrationType || 'normal';
if (registrationType === 'disabled') {
return setImmediate(next);
}
let errorText;
if (req.query.error === 'csrf-invalid') {
errorText = '[[error:csrf-invalid]]';
}
try {
if (registrationType === 'invite-only' || registrationType === 'admin-invite-only') {
try {
await user.verifyInvitation(req.query);
} catch (e) {
return res.render('400', {
error: e.message,
});
}
}
if (req.headers['x-return-to']) {
req.session.returnTo = helpers.normalizeReturnToPath(req.headers['x-return-to']) || '/';
}
const loginStrategies = require('../routes/authentication').getLoginStrategies();
res.render('register', {
'register_window:spansize': loginStrategies.length ? 'col-md-6' : 'col-md-12',
alternate_logins: !!loginStrategies.length,
osw_logins: !!meta.config.activitypubEnabled,
authentication: loginStrategies,
minimumUsernameLength: meta.config.minimumUsernameLength,
maximumUsernameLength: meta.config.maximumUsernameLength,
minimumPasswordLength: meta.config.minimumPasswordLength,
minimumPasswordStrength: meta.config.minimumPasswordStrength,
breadcrumbs: helpers.buildBreadcrumbs([{
text: '[[register:register]]',
}]),
regFormEntry: [],
error: req.flash('error')[0] || errorText,
title: '[[pages:register]]',
});
} catch (err) {
next(err);
}
};
// GET /register/complete
Controllers.registerInterstitial = async function (req, res, next) {
if (!req.session.hasOwnProperty('registration')) {
return res.redirect(`${nconf.get('relative_path')}/register`);
}
try {
const data = await user.interstitials.get(req, req.session.registration);
if (!data.interstitials.length) {
// No interstitials, redirect to home
const returnTo = req.session.returnTo || req.session.registration.returnTo;
delete req.session.registration;
return helpers.redirect(res, returnTo || '/');
}
const errors = req.flash('errors');
const renders = data.interstitials.map(
interstitial => req.app.renderAsync(interstitial.template, { ...interstitial.data || {}, errors })
);
const sections = await Promise.all(renders);
res.render('registerComplete', {
title: '[[pages:registration-complete]]',
register: data.userData.register,
sections,
errors,
});
} catch (err) {
next(err);
}
};
Controllers.confirmEmail = async (req, res) => {
function renderPage(opts = {}) {
res.render('confirm', {
title: '[[pages:confirm]]',
...opts,
});
}
if (req.method === 'HEAD') {
return renderPage();
}
try {
await user.email.confirmByCode(req.params.code, req.session.id);
if (req.session.registration) {
// After confirmation, no need to send user back to email change form
delete req.session.registration.updateEmail;
}
renderPage();
} catch (e) {
if (e.message === '[[error:invalid-data]]' || e.message === '[[error:confirm-email-expired]]') {
renderPage({ error: true });
return;
}
throw e;
}
};
Controllers.robots = function (req, res) {
res.set('Content-Type', 'text/plain');
if (meta.config['robots:txt']) {
res.send(meta.config['robots:txt']);
} else {
res.send(`${'User-agent: *\n' +
'Disallow: '}${nconf.get('relative_path')}/admin/\n` +
`Disallow: ${nconf.get('relative_path')}/reset/\n` +
`Disallow: ${nconf.get('relative_path')}/compose\n` +
`Sitemap: ${nconf.get('url')}/sitemap.xml`);
}
};
Controllers.manifest = async function (req, res) {
const manifest = {
name: meta.config.title || 'NodeBB',
short_name: meta.config['title:short'] || meta.config.title || 'NodeBB',
...(meta.config.description && { description: meta.config.description }),
start_url: nconf.get('url'),
display: 'standalone',
orientation: 'portrait',
theme_color: meta.config.themeColor || '#ffffff',
background_color: meta.config.backgroundColor || '#ffffff',
icons: [],
};
if (meta.config['brand:screenshot']) {
const width = meta.config['brand:screenshot:width'];
const height = meta.config['brand:screenshot:height'];
const sizes = width && height ? `${width}x${height}` : '';
const screenshotSrc = utils.cacheBustedUrl(
meta.config['brand:screenshot'],
meta.config['brand:screenshot:updatedAt']
);
manifest.screenshots = [
{
src: `${nconf.get('relative_path')}${screenshotSrc}`,
sizes: sizes || '',
type: mime.getType(meta.config['brand:screenshot']),
},
];
} else {
manifest.screenshots = [
{
src: `${nconf.get('relative_path')}/assets/images/screenshot-default.png`,
sizes: '446x778',
type: 'image/png',
form_factor: 'narrow',
label: 'Default home page of a vanilla NodeBB installation.',
},
];
}
const custom = meta.config['brand:touchIcon'];
const basePath = custom ?
`${nconf.get('relative_path')}/assets/uploads/system` :
`${nconf.get('relative_path')}/assets/images/touch`;
const sizes = [36, 48, 72, 96, 144, 192, 512];
const densities = [0.75, 1, 1.5, 2, 3, 4, 10];
sizes.forEach((size, index) => {
const src = custom ?
utils.cacheBustedUrl(`touchicon-${size}.png`, meta.config['brand:touchIcon:updatedAt']) :
`${size}.png`;
manifest.icons.push({
src: `${basePath}/${src}`,
sizes: `${size}x${size}`,
type: 'image/png',
density: densities[index],
});
});
if (meta.config['brand:maskableIcon']) {
const maskableIconSrc = utils.cacheBustedUrl(
`/assets/uploads/system/maskableicon-orig.png`,
meta.config['brand:maskableIcon:updatedAt']
);
manifest.icons.push({
src: `${nconf.get('relative_path')}${maskableIconSrc}`,
sizes: '512x512',
type: 'image/png',
purpose: 'maskable',
});
} else if (meta.config['brand:touchIcon']) {
manifest.icons.push({
src: `${nconf.get('relative_path')}/assets/uploads/system/touchicon-orig.png`,
sizes: '512x512',
type: 'image/png',
purpose: 'maskable',
});
}
const data = await plugins.hooks.fire('filter:manifest.build', {
req: req,
res: res,
manifest: manifest,
});
res.status(200).json(data.manifest);
};
Controllers.outgoing = function (req, res, next) {
const url = req.query.url || '';
let parsed;
try {
parsed = new URL(url);
} catch (err) {
return next();
}
const allowedProtocols = [
'http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher',
'nntp', 'feed', 'telnet', 'mms', 'rtsp', 'svn', 'tel', 'fax', 'xmpp', 'webcal',
];
if (!url || !parsed.protocol || !allowedProtocols.includes(parsed.protocol.slice(0, -1))) {
return next();
}
res.render('outgoing', {
outgoing: url,
title: meta.config.title,
breadcrumbs: helpers.buildBreadcrumbs([{
text: '[[notifications:outgoing-link]]',
}]),
});
};
Controllers.termsOfUse = async function (req, res, next) {
if (!meta.config.termsOfUse) {
return next();
}
const termsOfUse = await plugins.hooks.fire('filter:parse.post', {
postData: {
content: meta.config.termsOfUse || '',
},
});
res.render('tos', {
termsOfUse: termsOfUse.postData.content,
});
};