10686064489

Committed 03 Sep 2024 03:32PM UTC coverage: 82.667% (-0.004%) from 82.671%

Build # 10686064489

Build Type

Pull #399

github

Committed by

web-flow

Commit Message

Merge 87d459464 into e7cfda55c

Pull Request Pull Request #399: Refactoring code in src/middleware/admin.js

Run Details

9975 of 13488 branches covered (73.95%)

Branch coverage included in aggregate %.

27 of 38 new or added lines in 1 file covered. (71.05%)

2 existing lines in 2 files now uncovered.

22338 of 25600 relevant lines covered (87.26%)

1631.75 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

70.64

/src/middleware/admin.js

'use strict';


const nconf = require('nconf');

const user = require('../user');
const meta = require('../meta');
const plugins = require('../plugins');
const privileges = require('../privileges');
const helpers = require('./helpers');

const controllers = {
        admin: require('../controllers/admin'),
        helpers: require('../controllers/helpers'),
};

const middleware = module.exports;

middleware.buildHeader = helpers.try(async (req, res, next) => {
        res.locals.renderAdminHeader = true;
        if (req.method === 'GET') {
                await require('./index').applyCSRFasync(req, res);
        }

        res.locals.config = await controllers.admin.loadConfig(req);
        next();
});



middleware.checkPrivileges = helpers.try(async (req, res, next) => {
        if (isGuest(req, res)) return;
        const path = req.path.replace(/^(\/api)?(\/v3)?\/admin\/?/g, '');

        isAccessDenied(path, req, res, async (accessDenied) => {
                if (accessDenied) return;

                hasNoPassword(req, next, async (noPassword) => {
                        if (noPassword) return;

                        handleReLogin(req, res, next, async (reLoginHandled) => {
                                if (reLoginHandled) return;

                                redirectToLoginIfNeeded(req, res);
                        });
                });
        });
});

// helper fucntions
function isGuest(req, res) {
        if (req.uid <= 0) {
                controllers.helpers.notAllowed(req, res);
                return true;
        }
        return false;
}

function isAccessDenied(path, req, res, callback) {
        if (path) {
                const privilege = privileges.admin.resolve(path);
                privileges.admin.can(privilege, req.uid, async (err, canAccess) => {
                        if (err || !canAccess) {
                                controllers.helpers.notAllowed(req, res);
                                callback(true);
                        } else {
                                callback(false);
                        }
                });
        } else {
                privileges.admin.get(req.uid, async (err, privilegeSet) => {
                        if (err || !Object.values(privilegeSet).some(Boolean)) {
                                controllers.helpers.notAllowed(req, res);
                                callback(true);
                        } else {
                                callback(false);
                        }
                });
        }
}

function hasNoPassword(req, next, callback) {
        user.hasPassword(req.uid, (err, hasPassword) => {
                if (err || !hasPassword) {
                        next();
                        callback(true);
                } else {
                        callback(false);
                }
        });
}

function handleReLogin(req, res, next, callback) {
        const loginTime = req.session.meta ? req.session.meta.datetime : 0;
        const adminReloginDuration = meta.config.adminReloginDuration * 60000;
        const disabled = meta.config.adminReloginDuration === 0;

        if (disabled || (loginTime && parseInt(loginTime, 10) > Date.now() - adminReloginDuration)) {
                extendLogoutTimer(req.session.meta, loginTime, adminReloginDuration);
                next();
                callback(true);
        } else {
                callback(false);
        }
}

function extendLogoutTimer(meta, loginTime, adminReloginDuration) {
        const timeLeft = parseInt(loginTime, 10) - (Date.now() - adminReloginDuration);
        if (meta && timeLeft < Math.min(60000, adminReloginDuration)) {
                meta.datetime += Math.min(60000, adminReloginDuration);
        }
}

function redirectToLoginIfNeeded(req, res) {
        let returnTo = req.path.replace(/^\/api/, '');
        if (nconf.get('relative_path')) {
                returnTo = returnTo.replace(new RegExp(`^${nconf.get('relative_path')}`), '');
        }
        req.session.returnTo = returnTo;
        req.session.forceLogin = 1;
        plugins.hooks.fire('response:auth.relogin', { req, res });

        if (res.headersSent) return;

        if (res.locals.isAPI) {
                controllers.helpers.formatApiResponse(401, res);
        } else {
                res.redirect(`${nconf.get('relative_path')}/login?local=1`);
        }
}

1	'use strict';
2
3
4	const nconf = require('nconf');	1✔
5
6	const user = require('../user');	1✔
7	const meta = require('../meta');	1✔
8	const plugins = require('../plugins');	1✔
9	const privileges = require('../privileges');	1✔
10	const helpers = require('./helpers');	1✔
11
12	const controllers = {	1✔
13	admin: require('../controllers/admin'),
14	helpers: require('../controllers/helpers'),
15	};
16
17	const middleware = module.exports;	1✔
18
19	middleware.buildHeader = helpers.try(async (req, res, next) => {	1✔
20	res.locals.renderAdminHeader = true;	16✔
21	if (req.method === 'GET') {	16!
22	await require('./index').applyCSRFasync(req, res);	16✔
23	}
24
25	res.locals.config = await controllers.admin.loadConfig(req);	16✔
26	next();	16✔
27	});
28
29
30
31	middleware.checkPrivileges = helpers.try(async (req, res, next) => {	1✔
32	if (isGuest(req, res)) return;	185!
33	const path = req.path.replace(/^(\/api)?(\/v3)?\/admin\/?/g, '');	185✔
34
35	isAccessDenied(path, req, res, async (accessDenied) => {	185✔
36	if (accessDenied) return;	185✔
37
38	hasNoPassword(req, next, async (noPassword) => {	152✔
39	if (noPassword) return;	152!
40
41	handleReLogin(req, res, next, async (reLoginHandled) => {	152✔
42	if (reLoginHandled) return;	152!
43
NEW 44	redirectToLoginIfNeeded(req, res);	×
45	});
46	});
47	});
48	});
49
50	// helper fucntions
51	function isGuest(req, res) {
52	if (req.uid <= 0) {	185!
NEW 53	controllers.helpers.notAllowed(req, res);	×
NEW 54	return true;	×
55	}
56	return false;	185✔
57	}
58
59	function isAccessDenied(path, req, res, callback) {
60	if (path) {	185✔
61	const privilege = privileges.admin.resolve(path);	158✔
62	privileges.admin.can(privilege, req.uid, async (err, canAccess) => {	158✔
63	if (err \|\| !canAccess) {	158✔
64	controllers.helpers.notAllowed(req, res);	20✔
65	callback(true);	20✔
66	} else {
67	callback(false);	138✔
68	}
69	});
70	} else {
71	privileges.admin.get(req.uid, async (err, privilegeSet) => {	27✔
72	if (err \|\| !Object.values(privilegeSet).some(Boolean)) {	27✔
73	controllers.helpers.notAllowed(req, res);	13✔
74	callback(true);	13✔
75	} else {
76	callback(false);	14✔
77	}
78	});
79	}
80	}
81
82	function hasNoPassword(req, next, callback) {
83	user.hasPassword(req.uid, (err, hasPassword) => {	152✔
84	if (err \|\| !hasPassword) {	152!
NEW 85	next();	×
NEW 86	callback(true);	×
87	} else {
88	callback(false);	152✔
89	}
90	});
91	}
92
93	function handleReLogin(req, res, next, callback) {
94	const loginTime = req.session.meta ? req.session.meta.datetime : 0;	152!
95	const adminReloginDuration = meta.config.adminReloginDuration * 60000;	152✔
96	const disabled = meta.config.adminReloginDuration === 0;	152✔
97
98	if (disabled \|\| (loginTime && parseInt(loginTime, 10) > Date.now() - adminReloginDuration)) {	152!
99	extendLogoutTimer(req.session.meta, loginTime, adminReloginDuration);	152✔
100	next();	152✔
101	callback(true);	152✔
102	} else {
NEW 103	callback(false);	×
104	}
105	}
106
107	function extendLogoutTimer(meta, loginTime, adminReloginDuration) {
108	const timeLeft = parseInt(loginTime, 10) - (Date.now() - adminReloginDuration);	152✔
109	if (meta && timeLeft < Math.min(60000, adminReloginDuration)) {	152!
NEW 110	meta.datetime += Math.min(60000, adminReloginDuration);	×
111	}
112	}
113
114	function redirectToLoginIfNeeded(req, res) {
NEW 115	let returnTo = req.path.replace(/^\/api/, '');	×
116	if (nconf.get('relative_path')) {	×
NEW 117	returnTo = returnTo.replace(new RegExp(`^${nconf.get('relative_path')}`), '');	×
118	}
119	req.session.returnTo = returnTo;	×
UNCOV 120	req.session.forceLogin = 1;	×
NEW 121	plugins.hooks.fire('response:auth.relogin', { req, res });	×
122
NEW 123	if (res.headersSent) return;	×
124
125	if (res.locals.isAPI) {	×
126	controllers.helpers.formatApiResponse(401, res);	×
127	} else {
128	res.redirect(`${nconf.get('relative_path')}/login?local=1`);	×
129	}
130	}

CMU-313 / NodeBB / 10686064489

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous