mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-11-23 22:11:09 +03:00
Cleanup naming & order in admin controller
no issue There seemed to be no convention or order to the functions in the admin controller, so I have: - organised them - reordered them - added a small doc-block - reordered some routes - updated tests accordingly
This commit is contained in:
Hannah Wolfe
parent
aa15b464c8
commit
310fcab7ed
@ -43,7 +43,80 @@ function setSelected(list, name) {
|
||||
}
|
||||
|
||||
adminControllers = {
|
||||
'uploader': function (req, res) {
|
||||
// Route: index
|
||||
// Path: /ghost/
|
||||
// Method: GET
|
||||
'index': function (req, res) {
|
||||
/*jslint unparam:true*/
|
||||
function renderIndex() {
|
||||
res.render('content', {
|
||||
bodyClass: 'manage',
|
||||
adminNav: setSelected(adminNavbar, 'content')
|
||||
});
|
||||
}
|
||||
|
||||
when.join(
|
||||
updateCheck(res),
|
||||
when(renderIndex())
|
||||
// an error here should just get logged
|
||||
).otherwise(errors.logError);
|
||||
},
|
||||
'content': function (req, res) {
|
||||
/*jslint unparam:true*/
|
||||
res.render('content', {
|
||||
bodyClass: 'manage',
|
||||
adminNav: setSelected(adminNavbar, 'content')
|
||||
});
|
||||
},
|
||||
// Route: editor
|
||||
// Path: /ghost/editor(/:id)?/
|
||||
// Method: GET
|
||||
'editor': function (req, res) {
|
||||
if (req.params.id !== undefined) {
|
||||
res.render('editor', {
|
||||
bodyClass: 'editor',
|
||||
adminNav: setSelected(adminNavbar, 'content')
|
||||
});
|
||||
} else {
|
||||
res.render('editor', {
|
||||
bodyClass: 'editor',
|
||||
adminNav: setSelected(adminNavbar, 'add')
|
||||
});
|
||||
}
|
||||
},
|
||||
// Route: settings
|
||||
// path: /ghost/settings/(*/)?
|
||||
// Method: GET
|
||||
'settings': function (req, res, next) {
|
||||
// TODO: Centralise list/enumeration of settings panes, so we don't run into trouble in future.
|
||||
var allowedSections = ['', 'general', 'user'],
|
||||
section = req.url.replace(/(^\/ghost\/settings[\/]*|\/$)/ig, '');
|
||||
|
||||
if (allowedSections.indexOf(section) < 0) {
|
||||
return next();
|
||||
}
|
||||
|
||||
res.render('settings', {
|
||||
bodyClass: 'settings',
|
||||
adminNav: setSelected(adminNavbar, 'settings')
|
||||
});
|
||||
},
|
||||
// Route: debug
|
||||
// path: /ghost/debug/
|
||||
// Method: GET
|
||||
'debug': {
|
||||
index: function (req, res) {
|
||||
/*jslint unparam:true*/
|
||||
res.render('debug', {
|
||||
bodyClass: 'settings',
|
||||
adminNav: setSelected(adminNavbar, 'settings')
|
||||
});
|
||||
}
|
||||
},
|
||||
// Route: upload
|
||||
// Path: /ghost/upload/
|
||||
// Method: POST
|
||||
'upload': function (req, res) {
|
||||
var type = req.files.uploadimage.type,
|
||||
ext = path.extname(req.files.uploadimage.name).toLowerCase(),
|
||||
store = storage.get_storage();
|
||||
@ -63,7 +136,27 @@ adminControllers = {
|
||||
return res.send(500, e.message);
|
||||
});
|
||||
},
|
||||
'login': function (req, res) {
|
||||
// Route: signout
|
||||
// Path: /ghost/signout/
|
||||
// Method: GET
|
||||
'signout': function (req, res) {
|
||||
req.session.destroy();
|
||||
|
||||
var notification = {
|
||||
type: 'success',
|
||||
message: 'You were successfully signed out',
|
||||
status: 'passive',
|
||||
id: 'successlogout'
|
||||
};
|
||||
|
||||
return api.notifications.add(notification).then(function () {
|
||||
res.redirect(config().paths.subdir + '/ghost/signin/');
|
||||
});
|
||||
},
|
||||
// Route: signin
|
||||
// Path: /ghost/signin/
|
||||
// Method: GET
|
||||
'signin': function (req, res) {
|
||||
/*jslint unparam:true*/
|
||||
res.render('login', {
|
||||
bodyClass: 'ghost-login',
|
||||
@ -71,7 +164,10 @@ adminControllers = {
|
||||
adminNav: setSelected(adminNavbar, 'login')
|
||||
});
|
||||
},
|
||||
'auth': function (req, res) {
|
||||
// Route: doSignin
|
||||
// Path: /ghost/signin/
|
||||
// Method: POST
|
||||
'doSignin': function (req, res) {
|
||||
var currentTime = process.hrtime()[0],
|
||||
remoteAddress = req.connection.remoteAddress,
|
||||
denied = '';
|
||||
@ -107,18 +203,9 @@ adminControllers = {
|
||||
res.json(401, {error: 'Slow down, there are way too many login attempts!'});
|
||||
}
|
||||
},
|
||||
'changepw': function (req, res) {
|
||||
return api.users.changePassword({
|
||||
currentUser: req.session.user,
|
||||
oldpw: req.body.password,
|
||||
newpw: req.body.newpassword,
|
||||
ne2pw: req.body.ne2password
|
||||
}).then(function () {
|
||||
res.json(200, {msg: 'Password changed successfully'});
|
||||
}, function (error) {
|
||||
res.send(401, {error: error.message});
|
||||
});
|
||||
},
|
||||
// Route: signup
|
||||
// Path: /ghost/signup/
|
||||
// Method: GET
|
||||
'signup': function (req, res) {
|
||||
/*jslint unparam:true*/
|
||||
res.render('signup', {
|
||||
@ -127,7 +214,10 @@ adminControllers = {
|
||||
adminNav: setSelected(adminNavbar, 'login')
|
||||
});
|
||||
},
|
||||
'doRegister': function (req, res) {
|
||||
// Route: doSignup
|
||||
// Path: /ghost/signup/
|
||||
// Method: POST
|
||||
'doSignup': function (req, res) {
|
||||
var name = req.body.name,
|
||||
email = req.body.email,
|
||||
password = req.body.password;
|
||||
@ -172,6 +262,9 @@ adminControllers = {
|
||||
res.json(401, {error: error.message});
|
||||
});
|
||||
},
|
||||
// Route: forgotten
|
||||
// Path: /ghost/forgotten/
|
||||
// Method: GET
|
||||
'forgotten': function (req, res) {
|
||||
/*jslint unparam:true*/
|
||||
res.render('forgotten', {
|
||||
@ -180,7 +273,10 @@ adminControllers = {
|
||||
adminNav: setSelected(adminNavbar, 'login')
|
||||
});
|
||||
},
|
||||
'generateResetToken': function (req, res) {
|
||||
// Route: doForgotten
|
||||
// Path: /ghost/forgotten/
|
||||
// Method: POST
|
||||
'doForgotten': function (req, res) {
|
||||
var email = req.body.email;
|
||||
|
||||
api.users.generateResetToken(email).then(function (token) {
|
||||
@ -218,6 +314,9 @@ adminControllers = {
|
||||
res.json(401, {error: error.message});
|
||||
});
|
||||
},
|
||||
// Route: reset
|
||||
// Path: /ghost/reset/:token
|
||||
// Method: GET
|
||||
'reset': function (req, res) {
|
||||
// Validate the request token
|
||||
var token = req.params.token;
|
||||
@ -245,7 +344,10 @@ adminControllers = {
|
||||
});
|
||||
});
|
||||
},
|
||||
'resetPassword': function (req, res) {
|
||||
// Route: doReset
|
||||
// Path: /ghost/reset/:token
|
||||
// Method: POST
|
||||
'doReset': function (req, res) {
|
||||
var token = req.params.token,
|
||||
newPassword = req.param('newpassword'),
|
||||
ne2Password = req.param('ne2password');
|
||||
@ -265,77 +367,20 @@ adminControllers = {
|
||||
res.json(401, {error: err.message});
|
||||
});
|
||||
},
|
||||
'logout': function (req, res) {
|
||||
req.session.destroy();
|
||||
|
||||
var notification = {
|
||||
type: 'success',
|
||||
message: 'You were successfully signed out',
|
||||
status: 'passive',
|
||||
id: 'successlogout'
|
||||
};
|
||||
|
||||
return api.notifications.add(notification).then(function () {
|
||||
res.redirect(config().paths.subdir + '/ghost/signin/');
|
||||
// Route: doChangePassword
|
||||
// Path: /ghost/changepw/
|
||||
// Method: POST
|
||||
'doChangePassword': function (req, res) {
|
||||
return api.users.changePassword({
|
||||
currentUser: req.session.user,
|
||||
oldpw: req.body.password,
|
||||
newpw: req.body.newpassword,
|
||||
ne2pw: req.body.ne2password
|
||||
}).then(function () {
|
||||
res.json(200, {msg: 'Password changed successfully'});
|
||||
}, function (error) {
|
||||
res.send(401, {error: error.message});
|
||||
});
|
||||
},
|
||||
'index': function (req, res) {
|
||||
/*jslint unparam:true*/
|
||||
function renderIndex() {
|
||||
res.render('content', {
|
||||
bodyClass: 'manage',
|
||||
adminNav: setSelected(adminNavbar, 'content')
|
||||
});
|
||||
}
|
||||
|
||||
when.join(
|
||||
updateCheck(res),
|
||||
when(renderIndex())
|
||||
// an error here should just get logged
|
||||
).otherwise(errors.logError);
|
||||
},
|
||||
'editor': function (req, res) {
|
||||
if (req.params.id !== undefined) {
|
||||
res.render('editor', {
|
||||
bodyClass: 'editor',
|
||||
adminNav: setSelected(adminNavbar, 'content')
|
||||
});
|
||||
} else {
|
||||
res.render('editor', {
|
||||
bodyClass: 'editor',
|
||||
adminNav: setSelected(adminNavbar, 'add')
|
||||
});
|
||||
}
|
||||
},
|
||||
'content': function (req, res) {
|
||||
/*jslint unparam:true*/
|
||||
res.render('content', {
|
||||
bodyClass: 'manage',
|
||||
adminNav: setSelected(adminNavbar, 'content')
|
||||
});
|
||||
},
|
||||
'settings': function (req, res, next) {
|
||||
// TODO: Centralise list/enumeration of settings panes, so we don't run into trouble in future.
|
||||
var allowedSections = ['', 'general', 'user'],
|
||||
section = req.url.replace(/(^\/ghost\/settings[\/]*|\/$)/ig, '');
|
||||
|
||||
if (allowedSections.indexOf(section) < 0) {
|
||||
return next();
|
||||
}
|
||||
|
||||
res.render('settings', {
|
||||
bodyClass: 'settings',
|
||||
adminNav: setSelected(adminNavbar, 'settings')
|
||||
});
|
||||
},
|
||||
'debug': {
|
||||
index: function (req, res) {
|
||||
/*jslint unparam:true*/
|
||||
res.render('debug', {
|
||||
bodyClass: 'settings',
|
||||
adminNav: setSelected(adminNavbar, 'settings')
|
||||
});
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
@ -26,24 +26,24 @@ module.exports = function (server) {
|
||||
res.redirect(301, subdir + '/ghost/signin/');
|
||||
});
|
||||
|
||||
server.get('/ghost/signout/', admin.logout);
|
||||
server.get('/ghost/signin/', middleware.redirectToSignup, middleware.redirectToDashboard, admin.login);
|
||||
server.get('/ghost/signout/', admin.signout);
|
||||
server.get('/ghost/signin/', middleware.redirectToSignup, middleware.redirectToDashboard, admin.signin);
|
||||
server.post('/ghost/signin/', admin.doSignin);
|
||||
server.get('/ghost/signup/', middleware.redirectToDashboard, admin.signup);
|
||||
server.post('/ghost/signup/', admin.doSignup);
|
||||
server.get('/ghost/forgotten/', middleware.redirectToDashboard, admin.forgotten);
|
||||
server.post('/ghost/forgotten/', admin.generateResetToken);
|
||||
server.post('/ghost/forgotten/', admin.doForgotten);
|
||||
server.get('/ghost/reset/:token', admin.reset);
|
||||
server.post('/ghost/reset/:token', admin.resetPassword);
|
||||
server.post('/ghost/signin/', admin.auth);
|
||||
server.post('/ghost/signup/', admin.doRegister);
|
||||
server.post('/ghost/reset/:token', admin.doReset);
|
||||
server.post('/ghost/changepw/', admin.doChangePassword);
|
||||
|
||||
server.post('/ghost/changepw/', admin.changepw);
|
||||
server.get('/ghost/editor(/:id)/', admin.editor);
|
||||
server.get('/ghost/editor/', admin.editor);
|
||||
server.get('/ghost/content/', admin.content);
|
||||
server.get('/ghost/settings*', admin.settings);
|
||||
server.get('/ghost/debug/', admin.debug.index);
|
||||
|
||||
server.post('/ghost/upload/', middleware.busboy, admin.uploader);
|
||||
server.post('/ghost/upload/', middleware.busboy, admin.upload);
|
||||
|
||||
// redirect to /ghost and let that do the authentication to prevent redirects to /ghost//admin etc.
|
||||
server.get(/\/((ghost-admin|admin|wp-admin|dashboard|signin)\/?)$/, function (req, res) {
|
||||
|
||||
@ -9,7 +9,7 @@ var fs = require('fs-extra'),
|
||||
admin = require('../../server/controllers/admin');
|
||||
|
||||
describe('Admin Controller', function () {
|
||||
describe('uploader', function () {
|
||||
describe('upload', function () {
|
||||
|
||||
var req, res, store;
|
||||
|
||||
@ -43,7 +43,7 @@ describe('Admin Controller', function () {
|
||||
res.send = sinon.stub();
|
||||
req.files.uploadimage.name = 'INVALID.FILE';
|
||||
req.files.uploadimage.type = 'application/octet-stream';
|
||||
admin.uploader(req, res);
|
||||
admin.upload(req, res);
|
||||
res.send.calledOnce.should.be.true;
|
||||
res.send.args[0][0].should.equal(415);
|
||||
res.send.args[0][1].should.equal('Unsupported Media Type');
|
||||
@ -55,7 +55,7 @@ describe('Admin Controller', function () {
|
||||
res.send = sinon.stub();
|
||||
req.files.uploadimage.name = 'INVALID.jpg';
|
||||
req.files.uploadimage.type = 'application/octet-stream';
|
||||
admin.uploader(req, res);
|
||||
admin.upload(req, res);
|
||||
res.send.calledOnce.should.be.true;
|
||||
res.send.args[0][0].should.equal(415);
|
||||
res.send.args[0][1].should.equal('Unsupported Media Type');
|
||||
@ -80,7 +80,7 @@ describe('Admin Controller', function () {
|
||||
return done();
|
||||
});
|
||||
|
||||
admin.uploader(req, res);
|
||||
admin.upload(req, res);
|
||||
});
|
||||
|
||||
it('cannot upload jpg with incorrect extension', function (done) {
|
||||
@ -90,7 +90,7 @@ describe('Admin Controller', function () {
|
||||
return done();
|
||||
});
|
||||
|
||||
admin.uploader(req, res);
|
||||
admin.upload(req, res);
|
||||
});
|
||||
|
||||
it('can upload png', function (done) {
|
||||
@ -101,7 +101,7 @@ describe('Admin Controller', function () {
|
||||
return done();
|
||||
});
|
||||
|
||||
admin.uploader(req, res);
|
||||
admin.upload(req, res);
|
||||
});
|
||||
|
||||
it('can upload gif', function (done) {
|
||||
@ -112,7 +112,7 @@ describe('Admin Controller', function () {
|
||||
return done();
|
||||
});
|
||||
|
||||
admin.uploader(req, res);
|
||||
admin.upload(req, res);
|
||||
});
|
||||
|
||||
it('should send correct url', function (done) {
|
||||
@ -121,7 +121,7 @@ describe('Admin Controller', function () {
|
||||
return done();
|
||||
});
|
||||
|
||||
admin.uploader(req, res);
|
||||
admin.upload(req, res);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
Loading…
Reference in New Issue
Block a user